# functions

name: IntlCalendar.getMinimum
purpose: Get the global minimum value for a field
manual_id: intlcalendar.getminimum
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing a value for the given
   field in the fieldʼs unit or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getNow
purpose: Get number representing the current time
manual_id: intlcalendar.getnow
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: float
return_description:
<p class="para">
   A <span class="type">float</span> representing a number of milliseconds since the epoch,
   not counting leap seconds.
  </p>


name: IntlCalendar.getRepeatedWallTimeOption
purpose: Get behavior for handling repeating wall time
manual_id: intlcalendar.getrepeatedwalltimeoption
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: int
return_description:
<p class="para">
   One of the constants <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.walltime-first">IntlCalendar::WALLTIME_FIRST</a></code></strong> or
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.walltime-last">IntlCalendar::WALLTIME_LAST</a></code></strong>.
  </p>


name: IntlCalendar.getSkippedWallTimeOption
purpose: Get behavior for handling skipped wall time
manual_id: intlcalendar.getskippedwalltimeoption
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: int
return_description:
<p class="para">
   One of the constants <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.walltime-first">IntlCalendar::WALLTIME_FIRST</a></code></strong>,
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.walltime-last">IntlCalendar::WALLTIME_LAST</a></code></strong> or
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.walltime-next-valid">IntlCalendar::WALLTIME_NEXT_VALID</a></code></strong>.
  </p>


name: IntlCalendar.getTime
purpose: Get time currently represented by the object
manual_id: intlcalendar.gettime
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   A <span class="type">float</span> representing the number of milliseconds elapsed since the
   reference time (1 Jan 1970 00:00:00 UTC), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: IntlCalendar.getTimeZone
purpose: Get the objectʼs timezone
manual_id: intlcalendar.gettimezone
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="classname">IntlTimeZone</span> object corresponding to the one used
   internally in this object.  Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getType
purpose: Get the calendar type
manual_id: intlcalendar.gettype
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> representing the calendar type, such as
   <code class="literal">&#039;gregorian&#039;</code>, <code class="literal">&#039;islamic&#039;</code>, etc.
  </p>


name: IntlCalendar.getWeekendTransition
purpose: Get time of the day at which weekend begins or ends
manual_id: intlcalendar.getweekendtransition
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   The number of milliseconds into the day at which the weekend begins or
   ends or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.inDaylightTime
purpose: Whether the objectʼs time is in Daylight Savings Time
manual_id: intlcalendar.indaylighttime
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the date is in Daylight Savings Time, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">On failure <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned. To detect error conditions use <span class="function">intl_get_error_code</span>, or set up Intl to throw <a href="intl.configuration.html#ini.intl.use-exceptions" class="link">exceptions</a>.</p>


name: IntlCalendar.isEquivalentTo
purpose: Whether another calendar is equal but for a different time
manual_id: intlcalendar.isequivalentto
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Assuming there are no argument errors, returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the calendars are
   equivalent except possibly for their set time.
  </p>


name: IntlCalendar.isLenient
purpose: Whether date/time interpretation is in lenient mode
manual_id: intlcalendar.islenient
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   A <span class="type">bool</span> representing whether the calendar is set to lenient mode.
  </p>


name: IntlCalendar.isSet
purpose: Whether a field is set
manual_id: intlcalendar.isset
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Assuming there are no argument errors, returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the field is set.
  </p>


name: IntlCalendar.isWeekend
purpose: Whether a certain date/time is in the weekend
manual_id: intlcalendar.isweekend
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   A <span class="type">bool</span> indicating whether the given or this objectʼs time occurs
   in a weekend.
  </p>
  <p class="para">On failure <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned. To detect error conditions use <span class="function">intl_get_error_code</span>, or set up Intl to throw <a href="intl.configuration.html#ini.intl.use-exceptions" class="link">exceptions</a>.</p>


name: IntlCalendar.setMinimalDaysInFirstWeek
purpose: Set minimal number of days the first week in a year or month can have
manual_id: intlcalendar.setminimaldaysinfirstweek
version: PHP 5 >= 5.5.1, PHP 7, PHP 8
return_type: true
errors:
<p class="para">
   <span class="classname">ValueError</span> if <code class="parameter">days</code> is out of range
   (less than <code class="literal">1</code> or more than <code class="literal">7</code>).
  </p>


name: IntlCalendar.setTime
purpose: Set the calendar time in milliseconds since the epoch
manual_id: intlcalendar.settime
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: float
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.toDateTime
purpose: Convert an IntlCalendar into a DateTime object
manual_id: intlcalendar.todatetime
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a2
return_type: false
return_description:
<p class="para">
   A <span class="classname">DateTime</span> object with the same timezone as this
   object (though using PHPʼs database instead of ICUʼs) and the same time,
   except for the smaller precision (second precision instead of millisecond).
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlGregorianCalendar.createFromDate
purpose: Create a new IntlGregorianCalendar instance from date
manual_id: intlgregoriancalendar.createfromdate
version: PHP 8 >= 8.3.0
return_type: static
return_description:
<p class="para">
   Returns a new <span class="classname">IntlGregorianCalendar</span> instance.
  </p>


name: IntlGregorianCalendar.isLeapYear
purpose: Determine if the given year is a leap year
manual_id: intlgregoriancalendar.isleapyear
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> for leap years, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise and on failure.
  </p>


name: IntlTimeZone.createTimeZoneIDEnumeration
purpose: Get an enumeration over system time zone IDs with the given filter conditions
manual_id: intltimezone.createtimezoneidenumeration
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <span class="classname">IntlIterator</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlTimeZone.getCanonicalID
manual_id: intltimezone.getcanonicalid
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description: <p class="para"> </p>
purpose:
Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone ID


name: IntlTimeZone.getIDForWindowsID
purpose: Translate a Windows timezone into a system timezone
manual_id: intltimezone.getidforwindowsid
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the system timezone or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlTimeZone.getRegion
purpose: Get the region code associated with the given system time zone ID
manual_id: intltimezone.getregion
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return region or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlTimeZone.getUnknown
purpose: Get the "unknown" time zone
manual_id: intltimezone.getunknown
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: IntlTimeZone
return_description:
<p class="para">
   Returns <span class="classname">IntlTimeZone</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlTimeZone.getWindowsID
purpose: Translate a system timezone into a Windows timezone
manual_id: intltimezone.getwindowsid
version: PHP 7 >= 7.1.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the Windows timezone or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.create
purpose: Create a date formatter
manual_id: intldateformatter.create
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The created <span class="classname">IntlDateFormatter</span> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of
   failure.
  </p>


name: IntlDateFormatter.format
purpose: Format the date/time value as a string
manual_id: intldateformatter.format
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The formatted string or, if an error occurred, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.   
  </p>


name: IntlDateFormatter.formatObject
purpose: Formats an object
manual_id: intldateformatter.formatobject
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL intl >= 3.0.0
return_type: false
return_description:
<p class="para">
   A string with result or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getCalendar
purpose: Get the calendar type used for the IntlDateFormatter
manual_id: intldateformatter.getcalendar
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The <a href="class.intldateformatter.html#intl.intldateformatter-constants.calendartypes" class="link">calendar
   type</a> being used by the formatter. Either
   <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.traditional">IntlDateFormatter::TRADITIONAL</a></code></strong> or
   <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.gregorian">IntlDateFormatter::GREGORIAN</a></code></strong>.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getDateType
purpose: Get the datetype used for the IntlDateFormatter
manual_id: intldateformatter.getdatetype
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The current <a href="class.intldateformatter.html#intl.intldateformatter-constants" class="link">date type</a> value of the formatter,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getLocale
purpose: Get the locale used by formatter
manual_id: intldateformatter.getlocale
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The locale of this formatter,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getPattern
purpose: Get the pattern used for the IntlDateFormatter
manual_id: intldateformatter.getpattern
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The pattern string being used to format/parse,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getTimeZoneId
purpose: Get the timezone-id used for the IntlDateFormatter
manual_id: intldateformatter.gettimezoneid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   ID string for the time zone used by this formatter,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getCalendarObject
purpose: Get copy of formatterʼs calendar object
manual_id: intldateformatter.getcalendarobject
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL intl >= 3.0.0
return_type: null
return_description:
<p class="para">
   A copy of the internal calendar object used by this formatter,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if none has been set,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.getTimeZone
purpose: Get formatterʼs timezone
manual_id: intldateformatter.gettimezone
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL intl >= 3.0.0
return_type: false
return_description:
<p class="para">
   The associated <span class="classname">IntlTimeZone</span>
   object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDateFormatter.isLenient
purpose: Get the lenient used for the IntlDateFormatter
manual_id: intldateformatter.islenient
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if parser is lenient, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if parser is strict. By default the parser is lenient.
  </p>


name: IntlDateFormatter.localtime
purpose: Parse string to a field-based time value
manual_id: intldateformatter.localtime
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Localtime compatible array of integers  : contains 24 hour clock value in tm_hour field,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>


name: IntlDateFormatter.parse
purpose: Parse string to a timestamp value
manual_id: intldateformatter.parse
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Timestamp of parsed value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if value cannot be parsed.
  </p>


name: IntlDateFormatter.setPattern
purpose: Set the pattern used for the IntlDateFormatter
manual_id: intldateformatter.setpattern
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Bad formatstrings are usually the cause of the failure.
  </p>


name: ResourceBundle.create
purpose: Create a resource bundle
manual_id: resourcebundle.create
version: PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: null
return_description:
<p class="para">
   Returns <span class="classname">ResourceBundle</span> object or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: ResourceBundle.get
purpose: Get data from the bundle
manual_id: resourcebundle.get
version: PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: mixed
return_description:
<p class="para">
   Returns the data located at the index or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error. Strings, integers and binary data strings
   are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are
   returned as <span class="classname">ResourceBundle</span> object.
  </p>


name: ResourceBundle.getLocales
purpose: Get supported locales
manual_id: resourcebundle.locales
version: PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: false
return_description:
<p class="para">
   Returns the list of locales supported by the bundle, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Spoofchecker.areConfusable
purpose: Checks if given strings can be confused
manual_id: spoofchecker.areconfusable
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if two given strings can be confused, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Spoofchecker.isSuspicious
purpose: Checks if a given text contains any suspicious characters
manual_id: spoofchecker.issuspicious
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there are suspicious characters, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: Transliterator.create
purpose: Create a transliterator
manual_id: transliterator.create
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">Transliterator</span> object on success,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: Transliterator.createInverse
purpose: Create an inverse transliterator
manual_id: transliterator.createinverse
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">Transliterator</span> object on success,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure
  </p>


name: Transliterator.getErrorCode
purpose: Get last error code
manual_id: transliterator.geterrorcode
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: false
return_description:
<p class="para">
   The error code on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if none exists, or on failure.
  </p>


name: Transliterator.getErrorMessage
purpose: Get last error message
manual_id: transliterator.geterrormessage
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: false
return_description:
<p class="para">
   The error message on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if none exists, or on failure.
  </p>


name: Transliterator.listIDs
purpose: Get transliterator IDs
manual_id: transliterator.listids
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> of registered transliterator IDs on success,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Transliterator.transliterate
purpose: Transliterate a string
manual_id: transliterator.transliterate
version: PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0
return_type: false
return_description:
<p class="para">
   The transformed string on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlDatePatternGenerator.create
purpose: Creates a new IntlDatePatternGenerator instance
manual_id: intldatepatterngenerator.create
version: PHP 8 >= 8.1.0
return_type: null
return_description:
<p class="para">
   Returns an <span class="classname">IntlDatePatternGenerator</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlDatePatternGenerator.getBestPattern
purpose: Determines the most suitable date/time format
manual_id: intldatepatterngenerator.getbestpattern
version: PHP 8 >= 8.1.0
return_type: false
return_description:
<p class="para">
   Returns a format, accepted by  <span class="methodname">DateTimeInterface::format</span> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: UConverter.transcode
purpose: Convert a string from one character encoding to another
manual_id: uconverter.transcode
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   Returns the converted string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: grapheme_extract
manual_id: function.grapheme-extract
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
purpose:
Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8

return_description:
<p class="para">
   A string starting at offset <code class="parameter">offset</code> and ending on a default grapheme cluster
   boundary that conforms to the <code class="parameter">size</code> and <code class="parameter">type</code> specified,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: grapheme_stripos
purpose: Find position (in grapheme units) of first occurrence of a case-insensitive string
manual_id: function.grapheme-stripos
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the position as an integer. If <code class="parameter">needle</code> is not found, <span class="function">grapheme_stripos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: grapheme_stristr
manual_id: function.grapheme-stristr
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
purpose:
Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack

return_description:
<p class="para">
   Returns the portion of <code class="parameter">haystack</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">needle</code> is not found.
  </p>


name: grapheme_strlen
purpose: Get string length in grapheme units
manual_id: function.grapheme-strlen
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The length of the string on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. 
  </p>


name: grapheme_strpos
purpose: Find position (in grapheme units) of first occurrence of a string
manual_id: function.grapheme-strpos
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the position as an integer. If <code class="parameter">needle</code> is not found, <span class="function">grapheme_strpos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: grapheme_strripos
purpose: Find position (in grapheme units) of last occurrence of a case-insensitive string
manual_id: function.grapheme-strripos
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the position as an integer. If <code class="parameter">needle</code> is not found, <span class="function">grapheme_strripos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: grapheme_strrpos
purpose: Find position (in grapheme units) of last occurrence of a string
manual_id: function.grapheme-strrpos
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the position as an integer. If <code class="parameter">needle</code> is not found, <span class="function">grapheme_strrpos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: grapheme_substr
purpose: Return part of a string
manual_id: function.grapheme-substr
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the extracted part of <code class="parameter">string</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: idn_to_ascii
purpose: Convert domain name to IDNA ASCII form
manual_id: function.idn-to-ascii
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.2, PECL idn >= 0.1
return_type: false
return_description:
<p class="para">
   The domain name encoded in ASCII-compatible form,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: idn_to_utf8
purpose: Convert domain name from IDNA ASCII to Unicode
manual_id: function.idn-to-utf8
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.2, PECL idn >= 0.1
return_type: false
return_description:
<p class="para">
   The domain name in Unicode, encoded in UTF-8,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: IntlChar.charAge
purpose: Get the "age" of the code point
manual_id: intlchar.charage
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The Unicode version number, as an <span class="type">array</span>.
   For example, version <em>1.3.31.2</em> would be represented as <code class="literal">[1, 3, 31, 2]</code>.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.charDigitValue
purpose: Get the decimal digit value of a decimal digit character
manual_id: intlchar.chardigitvalue
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The decimal digit value of <code class="parameter">codepoint</code>,
   or <code class="literal">-1</code> if it is not a decimal digit character. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.charDirection
purpose: Get bidirectional category value for a code point
manual_id: intlchar.chardirection
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The bidirectional category value; one of the following constants:
   <ul class="simplelist">
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-left-to-right">IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-right-to-left">IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-european-number">IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-european-number-separator">IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-european-number-terminator">IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-arabic-number">IntlChar::CHAR_DIRECTION_ARABIC_NUMBER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-common-number-separator">IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-block-separator">IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-segment-separator">IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-white-space-neutral">IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-other-neutral">IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-left-to-right-embedding">IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-left-to-right-override">IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-right-to-left-arabic">IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-right-to-left-embedding">IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-right-to-left-override">IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-pop-directional-format">IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-dir-non-spacing-mark">IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-boundary-neutral">IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-first-strong-isolate">IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-left-to-right-isolate">IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-right-to-left-isolate">IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-pop-directional-isolate">IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-direction-char-direction-count">IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT</a></code></strong></li>
   </ul>

   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.charFromName
purpose: Find Unicode character by name and return its code point value
manual_id: intlchar.charfromname
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The Unicode value of the code point with the given name (as an <span class="type">int</span>), or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there is no such code point.
  </p>


name: IntlChar.charMirror
purpose: Get the "mirror-image" character for a code point
manual_id: intlchar.charmirror
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns another Unicode code point that may serve as a mirror-image substitute, or <code class="parameter">codepoint</code>
   itself if there is no such mapping or <code class="parameter">codepoint</code> does not have the
   <em>Bidi_Mirrored</em> property.
  </p>
  <p class="para">The return type is <span class="type">int</span> unless the code point was passed as a UTF-8 <span class="type">string</span>, in which case a <span class="type">string</span> is returned. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.</p>


name: IntlChar.charName
purpose: Retrieve the name of a Unicode character
manual_id: intlchar.charname
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The corresponding name, or an empty string if there is no name for this character,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there is no such code point.
  </p>


name: IntlChar.charType
purpose: Get the general category value for a code point
manual_id: intlchar.chartype
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the general category type, which may be one of the following constants:
   <ul class="simplelist">
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-unassigned">IntlChar::CHAR_CATEGORY_UNASSIGNED</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-general-other-types">IntlChar::CHAR_CATEGORY_GENERAL_OTHER_TYPES</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-uppercase-letter">IntlChar::CHAR_CATEGORY_UPPERCASE_LETTER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-lowercase-letter">IntlChar::CHAR_CATEGORY_LOWERCASE_LETTER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-titlecase-letter">IntlChar::CHAR_CATEGORY_TITLECASE_LETTER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-modifier-letter">IntlChar::CHAR_CATEGORY_MODIFIER_LETTER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-other-letter">IntlChar::CHAR_CATEGORY_OTHER_LETTER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-non-spacing-mark">IntlChar::CHAR_CATEGORY_NON_SPACING_MARK</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-enclosing-mark">IntlChar::CHAR_CATEGORY_ENCLOSING_MARK</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-combining-spacing-mark">IntlChar::CHAR_CATEGORY_COMBINING_SPACING_MARK</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-decimal-digit-number">IntlChar::CHAR_CATEGORY_DECIMAL_DIGIT_NUMBER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-letter-number">IntlChar::CHAR_CATEGORY_LETTER_NUMBER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-other-number">IntlChar::CHAR_CATEGORY_OTHER_NUMBER</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-space-separator">IntlChar::CHAR_CATEGORY_SPACE_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-line-separator">IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-paragraph-separator">IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-control-char">IntlChar::CHAR_CATEGORY_CONTROL_CHAR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-format-char">IntlChar::CHAR_CATEGORY_FORMAT_CHAR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-private-use-char">IntlChar::CHAR_CATEGORY_PRIVATE_USE_CHAR</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-surrogate">IntlChar::CHAR_CATEGORY_SURROGATE</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-dash-punctuation">IntlChar::CHAR_CATEGORY_DASH_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-start-punctuation">IntlChar::CHAR_CATEGORY_START_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-end-punctuation">IntlChar::CHAR_CATEGORY_END_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-connector-punctuation">IntlChar::CHAR_CATEGORY_CONNECTOR_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-other-punctuation">IntlChar::CHAR_CATEGORY_OTHER_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-math-symbol">IntlChar::CHAR_CATEGORY_MATH_SYMBOL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-currency-symbol">IntlChar::CHAR_CATEGORY_CURRENCY_SYMBOL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-modifier-symbol">IntlChar::CHAR_CATEGORY_MODIFIER_SYMBOL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-other-symbol">IntlChar::CHAR_CATEGORY_OTHER_SYMBOL</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-initial-punctuation">IntlChar::CHAR_CATEGORY_INITIAL_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-final-punctuation">IntlChar::CHAR_CATEGORY_FINAL_PUNCTUATION</a></code></strong></li>
    <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-category-char-category-count">IntlChar::CHAR_CATEGORY_CHAR_CATEGORY_COUNT</a></code></strong></li>
   </ul>
  </p>


name: IntlChar.chr
purpose: Return Unicode character by code point value
manual_id: intlchar.chr
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A string containing the single character specified by the Unicode code point value, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.digit
purpose: Get the decimal digit value of a code point for a given radix
manual_id: intlchar.digit
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the numeric value represented by the character in the specified radix,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is no value or if the value exceeds the radix. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: IntlChar.foldCase
purpose: Perform case folding on a code point
manual_id: intlchar.foldcase
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the <em>Simple_Case_Folding</em> of the code point, if any; otherwise the code point itself on success,
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.forDigit
purpose: Get character representation for a given digit and radix
manual_id: intlchar.fordigit
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The character representation (as a <span class="type">string</span>) of the specified digit in the specified radix.
  </p>


name: IntlChar.getBidiPairedBracket
purpose: Get the paired bracket character for a code point
manual_id: intlchar.getbidipairedbracket
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the paired bracket code point, or <code class="parameter">codepoint</code> itself if there is no such mapping. Returns
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <p class="para">The return type is <span class="type">int</span> unless the code point was passed as a UTF-8 <span class="type">string</span>, in which case a <span class="type">string</span> is returned. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.</p>


name: IntlChar.getBlockCode
purpose: Get the Unicode allocation block containing a code point
manual_id: intlchar.getblockcode
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the block value for <code class="parameter">codepoint</code>.
   See the <code class="literal">IntlChar::BLOCK_CODE_*</code> constants for possible return values. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.getCombiningClass
purpose: Get the combining class of a code point
manual_id: intlchar.getcombiningclass
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the combining class of the character. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.getFC_NFKC_Closure
purpose: Get the FC_NFKC_Closure property for a code point
manual_id: intlchar.getfc-nfkc-closure
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the FC_NFKC_Closure property string for the <code class="parameter">codepoint</code>, or an empty string if there is none.
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlChar.getIntPropertyMaxValue
purpose: Get the max value for a Unicode property
manual_id: intlchar.getintpropertymaxvalue
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The maximum value returned by <span class="function">IntlChar::getIntPropertyValue</span> for a Unicode property.
   <code class="literal">&lt;=0</code> if the property selector is out of range.
  </p>


name: IntlChar.getIntPropertyMinValue
purpose: Get the min value for a Unicode property
manual_id: intlchar.getintpropertyminvalue
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The minimum value returned by <span class="function">IntlChar::getIntPropertyValue</span> for a Unicode property.
   <code class="literal">0</code> if the property selector is out of range.
  </p>


name: IntlChar.getIntPropertyValue
purpose: Get the value for a Unicode property for a code point
manual_id: intlchar.getintpropertyvalue
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the numeric value that is directly the property value or, for enumerated properties, corresponds to the
   numeric value of the enumerated constant of the respective property value enumeration type. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <p class="para">
   Returns <code class="literal">0</code> or <code class="literal">1</code> (for <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>/<strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>) for binary Unicode properties.
  </p>
  <p class="para">
   Returns a bit-mask for mask properties.
  </p>
  <p class="para">
   Returns <code class="literal">0</code> if <code class="parameter">property</code> is out of bounds or if the Unicode version does not
   have data for the property at all, or not for this code point.
  </p>


name: IntlChar.getNumericValue
purpose: Get the numeric value for a Unicode code point
manual_id: intlchar.getnumericvalue
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Numeric value of <code class="parameter">codepoint</code>,
   or <strong><code><a href="class.intlchar.html#intlchar.constants.no-numeric-value">IntlChar::NO_NUMERIC_VALUE</a></code></strong> if none is defined. This
   constant was added in PHP 7.0.6, prior to this version the literal value
   (<span class="type">float</span>)<code class="literal">-123456789</code> may be used instead. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.getPropertyEnum
purpose: Get the property constant value for a given property name
manual_id: intlchar.getpropertyenum
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an <code class="literal">IntlChar::PROPERTY_</code> constant value,
   or <strong><code><a href="class.intlchar.html#intlchar.constants.property-invalid-code">IntlChar::PROPERTY_INVALID_CODE</a></code></strong> if the given name does not match any property.
  </p>


name: IntlChar.getPropertyName
purpose: Get the Unicode name for a property
manual_id: intlchar.getpropertyname
version: PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if either the <code class="parameter">property</code> or the <code class="parameter">type</code>
   is out of range.
  </p>
  <p class="para">
   If a given <code class="parameter">type</code> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, then all larger values of
   <code class="parameter">type</code> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, with one exception: if <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned for
   <strong><code><a href="class.intlchar.html#intlchar.constants.short-property-name">IntlChar::SHORT_PROPERTY_NAME</a></code></strong>, then <strong><code><a href="class.intlchar.html#intlchar.constants.long-property-name">IntlChar::LONG_PROPERTY_NAME</a></code></strong>
   (and higher) may still return a non-<strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> value.
  </p>


name: IntlChar.getPropertyValueEnum
purpose: Get the property value for a given value name
manual_id: intlchar.getpropertyvalueenum
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the corresponding value integer, or <strong><code><a href="class.intlchar.html#intlchar.constants.property-invalid-code">IntlChar::PROPERTY_INVALID_CODE</a></code></strong> if the given name
   does not match any value of the given property, or if the property is invalid.
  </p>


name: IntlChar.getPropertyValueName
purpose: Get the Unicode name for a property value
manual_id: intlchar.getpropertyvaluename
version: PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the name, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if either the <code class="parameter">property</code> or the <code class="parameter">type</code>
   is out of range. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <p class="para">
   If a given <code class="parameter">type</code> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, then all larger values of <code class="parameter">type</code>
   will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, with one exception: if <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned for <strong><code><a href="class.intlchar.html#intlchar.constants.short-property-name">IntlChar::SHORT_PROPERTY_NAME</a></code></strong>,
   then <strong><code><a href="class.intlchar.html#intlchar.constants.long-property-name">IntlChar::LONG_PROPERTY_NAME</a></code></strong> (and higher) may still return a non-<strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> value.
  </p>


name: IntlChar.hasBinaryProperty
purpose: Check a binary Unicode property for a code point
manual_id: intlchar.hasbinaryproperty
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> according to the binary Unicode property value for <code class="parameter">codepoint</code>.
   Also <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">property</code> is out of bounds or if the Unicode version does not have data for
   the property at all, or not for this code point. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isalnum
purpose: Check if code point is an alphanumeric character
manual_id: intlchar.isalnum
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is an alphanumeric character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isalpha
purpose: Check if code point is a letter character
manual_id: intlchar.isalpha
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a letter character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isbase
purpose: Check if code point is a base character
manual_id: intlchar.isbase
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a base character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isblank
purpose: Check if code point is a "blank" or "horizontal space" character
manual_id: intlchar.isblank
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is either a &quot;blank&quot; or &quot;horizontal space&quot; character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.iscntrl
purpose: Check if code point is a control character
manual_id: intlchar.iscntrl
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a control character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isdefined
purpose: Check whether the code point is defined
manual_id: intlchar.isdefined
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a defined character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isdigit
purpose: Check if code point is a digit character
manual_id: intlchar.isdigit
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a digit character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isgraph
purpose: Check if code point is a graphic character
manual_id: intlchar.isgraph
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a &quot;graphic&quot; character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isIDIgnorable
purpose: Check if code point is an ignorable character
manual_id: intlchar.isidignorable
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is ignorable in identifiers, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isIDPart
purpose: Check if code point is permissible in an identifier
manual_id: intlchar.isidpart
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is the code point may occur in an identifier, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isIDStart
purpose: Check if code point is permissible as the first character in an identifier
manual_id: intlchar.isidstart
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> may start an identifier, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isISOControl
purpose: Check if code point is an ISO control code
manual_id: intlchar.isisocontrol
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is an ISO control code, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isJavaIDPart
purpose: Check if code point is permissible in a Java identifier
manual_id: intlchar.isjavaidpart
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> may occur in a Java identifier, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isJavaIDStart
purpose: Check if code point is permissible as the first character in a Java identifier
manual_id: intlchar.isjavaidstart
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> may start a Java identifier, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isJavaSpaceChar
purpose: Check if code point is a space character according to Java
manual_id: intlchar.isjavaspacechar
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a space character according to Java, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.islower
purpose: Check if code point is a lowercase letter
manual_id: intlchar.islower
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is an Ll lowercase letter, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isMirrored
purpose: Check if code point has the Bidi_Mirrored property
manual_id: intlchar.ismirrored
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> has the Bidi_Mirrored property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isprint
purpose: Check if code point is a printable character
manual_id: intlchar.isprint
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a printable character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.ispunct
purpose: Check if code point is punctuation character
manual_id: intlchar.ispunct
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a punctuation character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isspace
purpose: Check if code point is a space character
manual_id: intlchar.isspace
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a space character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.istitle
purpose: Check if code point is a titlecase letter
manual_id: intlchar.istitle
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a titlecase letter, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isUAlphabetic
purpose: Check if code point has the Alphabetic Unicode property
manual_id: intlchar.isualphabetic
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> has the Alphabetic Unicode property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isULowercase
purpose: Check if code point has the Lowercase Unicode property
manual_id: intlchar.isulowercase
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> has the Lowercase Unicode property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isupper
purpose: Check if code point has the general category "Lu" (uppercase letter)
manual_id: intlchar.isupper
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is an Lu uppercase letter, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isUUppercase
purpose: Check if code point has the Uppercase Unicode property
manual_id: intlchar.isuuppercase
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> has the Uppercase Unicode property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isUWhiteSpace
purpose: Check if code point has the White_Space Unicode property
manual_id: intlchar.isuwhitespace
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> has the White_Space Unicode property, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isWhitespace
purpose: Check if code point is a whitespace character according to ICU
manual_id: intlchar.iswhitespace
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a whitespace character according to ICU, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.isxdigit
purpose: Check if code point is a hexadecimal digit
manual_id: intlchar.isxdigit
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">codepoint</code> is a hexadecimal character, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: IntlChar.tolower
purpose: Make Unicode character lowercase
manual_id: intlchar.tolower
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the Simple_Lowercase_Mapping of the code point, if any;
   otherwise the code point itself. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <p class="para">The return type is <span class="type">int</span> unless the code point was passed as a UTF-8 <span class="type">string</span>, in which case a <span class="type">string</span> is returned. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.</p>


name: IntlChar.totitle
purpose: Make Unicode character titlecase
manual_id: intlchar.totitle
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the Simple_Titlecase_Mapping of the code point, if any;
   otherwise the code point itself. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>
  <p class="para">The return type is <span class="type">int</span> unless the code point was passed as a UTF-8 <span class="type">string</span>, in which case a <span class="type">string</span> is returned. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.</p>


name: IntlChar.toupper
purpose: Make Unicode character uppercase
manual_id: intlchar.toupper
version: PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns the Simple_Uppercase_Mapping of the code point, if any;
   otherwise the code point itself.
  </p>
  <p class="para">The return type is <span class="type">int</span> unless the code point was passed as a UTF-8 <span class="type">string</span>, in which case a <span class="type">string</span> is returned. Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.</p>


name: intl_error_name
purpose: Get symbolic name for a given error code
manual_id: function.intl-error-name
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: string
return_description:
<p class="para">
   The returned string will be the same as the name of the error code
   constant.
  </p>


name: intl_is_failure
purpose: Check whether the given error code indicates failure
manual_id: function.intl-is-failure
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if it the code indicates some failure, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   in case of success or a warning.
  </p>


name: mb_chr
purpose: Return character by Unicode code point value
manual_id: function.mb-chr
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   A string containing the requested character, if it can be represented in the specified
   encoding  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_convert_case
purpose: Perform case folding on a string
manual_id: function.mb-convert-case
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A case folded version of <code class="parameter">string</code> converted in the
   way specified by <code class="parameter">mode</code>.
  </p>


name: mb_convert_encoding
purpose: Convert a string from one character encoding to another
manual_id: function.mb-convert-encoding
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The encoded <span class="type">string</span> or <span class="type">array</span> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">to_encoding</code> or
   <code class="parameter">from_encoding</code> is an invalid encoding.
   Prior to PHP 8.0.0, a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was emitted instead.
  </p>


name: mb_convert_kana
purpose: Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
manual_id: function.mb-convert-kana
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> The converted <span class="type">string</span>. </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if the combination of
   different <code class="parameter">mode</code>s is invalid.
   For example <code class="literal">&quot;sS&quot;</code>.
  </p>


name: mb_convert_variables
purpose: Convert character code in variable(s)
manual_id: function.mb-convert-variables
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The character encoding before conversion for success, 
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for failure.
  </p>


name: mb_decode_mimeheader
purpose: Decode string in MIME header field
manual_id: function.mb-decode-mimeheader
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The decoded <span class="type">string</span> in internal character encoding.
  </p>


name: mb_detect_encoding
purpose: Detect character encoding
manual_id: function.mb-detect-encoding
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The detected character encoding, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the string is not valid
   in any of the listed encodings.
  </p>


name: mb_detect_order
purpose: Set/Get character encoding detection order
manual_id: function.mb-detect-order
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   When setting the encoding detection order, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> is returned on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   When getting the encoding detection order, an ordered array of the encodings is returned.
  </p>


name: mb_encode_mimeheader
purpose: Encode string for MIME header
manual_id: function.mb-encode-mimeheader
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A converted version of the <span class="type">string</span> represented in ASCII.
  </p>


name: mb_encoding_aliases
purpose: Get aliases of a known encoding type
manual_id: function.mb-encoding-aliases
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description: <p class="para"> Returns a numerically indexed array of encoding aliases. </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if
   <code class="parameter">encoding</code> is unknown.
  </p>


name: mb_ereg_match
purpose: Regular expression match for multibyte string
manual_id: function.mb-ereg-match
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="simpara">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <code class="parameter">string</code> matches the regular expression
   <code class="parameter">pattern</code>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: mb_ereg_replace_callback
purpose: Perform a regular expression search and replace with multibyte support using a callback
manual_id: function.mb-ereg-replace-callback
version: PHP 5 >= 5.4.1, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The resultant <span class="type">string</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   If <code class="parameter">string</code> is not valid for the current encoding, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   is returned.
  </p>


name: mb_ereg_search_getpos
purpose: Returns start point for next regular expression match
manual_id: function.mb-ereg-search-getpos
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="simpara">
   <span class="function">mb_ereg_search_getpos</span> returns
   the point to start regular expression match for
   <span class="function">mb_ereg_search</span>,
   <span class="function">mb_ereg_search_pos</span>,
   <span class="function">mb_ereg_search_regs</span>. The position is
   represented by bytes from the head of string.
  </p>


name: mb_ereg_search_getregs
purpose: Retrieve the result from the last multibyte regular expression match
manual_id: function.mb-ereg-search-getregs
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="simpara">
   An <span class="type">array</span>
   including the sub-string of matched part by last
   <span class="function">mb_ereg_search</span>,
   <span class="function">mb_ereg_search_pos</span>,
   <span class="function">mb_ereg_search_regs</span>. If there are some
   matches, the first element will have the matched sub-string, the
   second element will have the first part grouped with brackets, 
   the third element will have the second part grouped with
   brackets, and so on. It returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: mb_ereg_search_init
purpose: Setup string and regular expression for a multibyte regular expression match
manual_id: function.mb-ereg-search-init
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="simpara">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_ereg_search_pos
manual_id: function.mb-ereg-search-pos
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
purpose:
Returns position and length of a matched part of the multibyte regular expression for a predefined multibyte string

return_description:
<p class="simpara">
   An <span class="type">array</span> containing two elements. The first element is the
   offset, in bytes, where the match begins relative to the start of the
   search string, and the second element is the length in bytes of the match.
  </p>
  <p class="simpara">
   If an error occurs, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: mb_ereg_search_regs
purpose: Returns the matched part of a multibyte regular expression
manual_id: function.mb-ereg-search-regs
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="simpara">
   <span class="function">mb_ereg_search_regs</span> executes the multibyte
   regular expression match, and if there are some matched part, it
   returns an <span class="type">array</span> including substring of matched part as first
   element, the first grouped part with brackets as second element,
   the second grouped part as third element, and so on. 
   It returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: mb_ereg_search
purpose: Multibyte regular expression match for predefined multibyte string
manual_id: function.mb-ereg-search
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="simpara">
   <span class="function">mb_ereg_search</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the
   multibyte string matches with the regular expression, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise. The <span class="type">string</span> for matching is set by 
   <span class="function">mb_ereg_search_init</span>. If
   <code class="parameter">pattern</code> is not specified, the previous one
   is used.
  </p>


name: mb_ereg
purpose: Regular expression match with multibyte support
manual_id: function.mb-ereg
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns whether <code class="parameter">pattern</code> matches <code class="parameter">string</code>.
  </p>


name: mb_eregi_replace
purpose: Replace regular expression with multibyte support ignoring case
manual_id: function.mb-eregi-replace
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The resultant <span class="type">string</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. 
   If <code class="parameter">string</code> is not valid for the current encoding, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   is returned.
  </p>


name: mb_get_info
purpose: Get internal settings of mbstring
manual_id: function.mb-get-info
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> of type information if <code class="parameter">type</code> 
   is not specified, otherwise a specific <code class="parameter">type</code>,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_http_input
purpose: Detect HTTP input character encoding
manual_id: function.mb-http-input
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The character encoding name, as per the <code class="parameter">type</code>,
   or an array of character encoding names, if <code class="parameter">type</code> is <code class="literal">&quot;I&quot;</code>.
   If <span class="function">mb_http_input</span> does not process specified
   HTTP input, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mb_http_output
purpose: Set/Get HTTP output character encoding
manual_id: function.mb-http-output
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">encoding</code> is omitted,
   <span class="function">mb_http_output</span> returns the current HTTP output
   character encoding. Otherwise, 
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_internal_encoding
purpose: Set/Get internal character encoding
manual_id: function.mb-internal-encoding
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">encoding</code> is set, then 
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   In this case, the character encoding for multibyte regex is NOT changed.
   If <code class="parameter">encoding</code> is omitted, then 
   the current character encoding name is returned.
  </p>

errors:
<p class="para">
   As of PHP 8.0.0, a <span class="classname">ValueError</span> is thrown if the
   value of <code class="parameter">encoding</code> is an invalid encoding.
   Prior to PHP 8.0.0, a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was emitted instead.
  </p>


name: mb_language
purpose: Set/Get current language
manual_id: function.mb-language
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">language</code> is set and
   <code class="parameter">language</code> is valid, it returns
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. Otherwise, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. 
   When <code class="parameter">language</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, it returns the language
   name as a <span class="type">string</span>.
  </p>


name: mb_ord
purpose: Get Unicode code point of character
manual_id: function.mb-ord
version: PHP 7 >= 7.2.0, PHP 8
return_type: false
return_description:
<p class="para">
   The Unicode code point for the first character of <code class="literal">string</code>  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_preferred_mime_name
purpose: Get MIME charset string
manual_id: function.mb-preferred-mime-name
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The MIME <code class="literal">charset</code> <span class="type">string</span> for character encoding
   <code class="parameter">encoding</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no charset is preferred for the given <code class="parameter">encoding</code>.
  </p>


name: mb_regex_encoding
purpose: Set/Get character encoding for multibyte regex
manual_id: function.mb-regex-encoding
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="simpara">
   If <code class="parameter">encoding</code> is set, then 
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. 
   In this case, the internal character encoding is NOT changed.
   If <code class="parameter">encoding</code> is omitted, then 
   the current character encoding name for a multibyte regex is returned.
  </p>


name: mb_regex_set_options
purpose: Set/Get the default options for mbregex functions
manual_id: function.mb-regex-set-options
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The previous options. If <code class="parameter">options</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, 
   it returns the <span class="type">string</span> that describes the current options.
  </p>


name: mb_scrub
purpose: Replace ill-formed byte sequences with the substitute character
manual_id: function.mb-scrub
version: PHP 7 >= 7.2.0, PHP 8
return_type: string
return_description:
<p class="para">
   The <span class="type">string</span> result with invalid byte sequences replaced.
  </p>


name: mb_split
purpose: Split multibyte string using regular expression
manual_id: function.mb-split
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   The result as an <span class="type">array</span>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mb_strcut
purpose: Get part of string
manual_id: function.mb-strcut
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <span class="function">mb_strcut</span> returns the portion of
   <code class="parameter">string</code> specified by the
   <code class="parameter">start</code> and
   <code class="parameter">length</code> parameters.
  </p>


name: mb_strimwidth
purpose: Get truncated string with specified width
manual_id: function.mb-strimwidth
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The truncated <span class="type">string</span>. If <code class="parameter">trim_marker</code> is set,
   <code class="parameter">trim_marker</code> replaces the last chars to match the <code class="parameter">width</code>.
  </p>


name: mb_stripos
purpose: Finds position of first occurrence of a string within another, case insensitive
manual_id: function.mb-stripos
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return the numeric position of the first occurrence of
   <code class="parameter">needle</code> in the <code class="parameter">haystack</code>
   string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">needle</code> is not found.
  </p>


name: mb_stristr
purpose: Finds first occurrence of a string within another, case insensitive
manual_id: function.mb-stristr
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the portion of <code class="parameter">haystack</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">needle</code> is not found.
  </p>


name: mb_strlen
purpose: Get string length
manual_id: function.mb-strlen
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the number of characters in
   <span class="type">string</span> <code class="parameter">string</code> having character encoding
   <code class="parameter">encoding</code>. A multi-byte character is
   counted as 1.
  </p>

errors:
<p class="para">
   If the encoding is unknown, an error of level
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is generated.
  </p>


name: mb_strpos
purpose: Find position of first occurrence of string in a string
manual_id: function.mb-strpos
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the numeric position of
   the first occurrence of <code class="parameter">needle</code> in the
   <code class="parameter">haystack</code> <span class="type">string</span>. If
   <code class="parameter">needle</code> is not found, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mb_strrchr
purpose: Finds the last occurrence of a character in a string within another
manual_id: function.mb-strrchr
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the portion of <code class="parameter">haystack</code>.
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">needle</code> is not found.
  </p>


name: mb_strripos
purpose: Finds position of last occurrence of a string within another, case insensitive
manual_id: function.mb-strripos
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return the numeric position of
   the last occurrence of <code class="parameter">needle</code> in the
   <code class="parameter">haystack</code> string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if <code class="parameter">needle</code> is not found.
  </p>


name: mb_strrpos
purpose: Find position of last occurrence of a string in a string
manual_id: function.mb-strrpos
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the numeric position of
   the last occurrence of <code class="parameter">needle</code> in the
   <code class="parameter">haystack</code> <span class="type">string</span>. If
   <code class="parameter">needle</code> is not found, it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mb_strtolower
purpose: Make a string lowercase
manual_id: function.mb-strtolower
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <code class="parameter">string</code> with all alphabetic characters converted to lowercase.
  </p>


name: mb_strtoupper
purpose: Make a string uppercase
manual_id: function.mb-strtoupper
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <code class="parameter">string</code> with all alphabetic characters converted to uppercase.
  </p>


name: mb_strwidth
purpose: Return width of string
manual_id: function.mb-strwidth
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The width of <span class="type">string</span> <code class="parameter">string</code>.
  </p>


name: mb_substitute_character
purpose: Set/Get substitution character
manual_id: function.mb-substitute-character
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   If <code class="parameter">substitute_character</code> is set, it returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> for success,
   otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. 
   If <code class="parameter">substitute_character</code> is not set, it returns the current
   setting.
  </p>


name: mb_substr_count
purpose: Count the number of substring occurrences
manual_id: function.mb-substr-count
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The number of times the
   <code class="parameter">needle</code> substring occurs in the
   <code class="parameter">haystack</code> <span class="type">string</span>.
  </p>


name: mb_substr
purpose: Get part of string
manual_id: function.mb-substr
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <span class="function">mb_substr</span> returns the portion of
   <code class="parameter">string</code> specified by the
   <code class="parameter">start</code> and
   <code class="parameter">length</code> parameters.
  </p>


name: pspell_check
purpose: Check a word
manual_id: function.pspell-check
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the spelling is correct, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: pspell_new_config
purpose: Load a new dictionary with settings based on a given config
manual_id: function.pspell-new-config
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">PSpell\Dictionary</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: pspell_new_personal
purpose: Load a new dictionary with personal wordlist
manual_id: function.pspell-new-personal
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">PSpell\Dictionary</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: recode_file
purpose: Recode from file to file according to recode request
manual_id: function.recode-file
version: PHP 4, PHP 5, PHP 7 < 7.4.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, if unable to comply, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: recode_string
purpose: Recode a string according to a recode request
manual_id: function.recode-string
version: PHP 4, PHP 5, PHP 7 < 7.4.0
return_type: string
return_description:
<p class="para">
   Returns the recoded <span class="type">string</span> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, if unable to 
   perform the recode request.
  </p>


name: exif_imagetype
purpose: Determine the type of an image
manual_id: function.exif-imagetype
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    When a correct signature is found, the appropriate constant value will be
    returned otherwise the return value is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. The return value is the
    same value that <span class="function">getimagesize</span> returns in index 2 but
    <span class="function">exif_imagetype</span> is much faster.
   </p>
   <p class="para">
    The following constants are defined, and represent possible 
    <span class="function">exif_imagetype</span> return values:
    <table class="doctable table">
    <caption><strong>Imagetype Constants</strong></caption>
     
      <thead>
       <tr>
        <th>Value</th>
        <th>Constant</th>
       </tr>

      </thead>

      <tbody class="tbody">
       <tr>
        <td>1</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-gif">IMAGETYPE_GIF</a></code></strong></td>
       </tr>

       <tr>
        <td>2</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-jpeg">IMAGETYPE_JPEG</a></code></strong></td>
       </tr>

       <tr>
        <td>3</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-png">IMAGETYPE_PNG</a></code></strong></td>
       </tr>

       <tr>
        <td>4</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-swf">IMAGETYPE_SWF</a></code></strong></td>
       </tr>
        
       <tr>
        <td>5</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-psd">IMAGETYPE_PSD</a></code></strong></td>
       </tr>
        
       <tr>
        <td>6</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-bmp">IMAGETYPE_BMP</a></code></strong></td>
       </tr>
        
       <tr>
        <td>7</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-tiff-ii">IMAGETYPE_TIFF_II</a></code></strong> (intel byte order)</td>
       </tr>
        
       <tr>
        <td>8</td>
        <td>
         <strong><code><a href="image.constants.html#constant.imagetype-tiff-mm">IMAGETYPE_TIFF_MM</a></code></strong> (motorola byte order)
        </td>
       </tr>
      
       <tr>
        <td>9</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-jpc">IMAGETYPE_JPC</a></code></strong></td>
       </tr>
      
       <tr>
        <td>10</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-jp2">IMAGETYPE_JP2</a></code></strong></td>
       </tr>
      
       <tr>
        <td>11</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-jpx">IMAGETYPE_JPX</a></code></strong></td>
       </tr>

       <tr>
        <td>12</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-jb2">IMAGETYPE_JB2</a></code></strong></td>
       </tr>

       <tr>
        <td>13</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-swc">IMAGETYPE_SWC</a></code></strong></td>
       </tr>

       <tr>
        <td>14</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-iff">IMAGETYPE_IFF</a></code></strong></td>
       </tr>

       <tr>
        <td>15</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-wbmp">IMAGETYPE_WBMP</a></code></strong></td>
       </tr>

       <tr>
        <td>16</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-xbm">IMAGETYPE_XBM</a></code></strong></td>
       </tr>

       <tr>
        <td>17</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-ico">IMAGETYPE_ICO</a></code></strong></td>
       </tr>

       <tr>
        <td>18</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-webp">IMAGETYPE_WEBP</a></code></strong></td>
       </tr>

       <tr>
        <td>19</td>
        <td><strong><code><a href="image.constants.html#constant.imagetype-avif">IMAGETYPE_AVIF</a></code></strong></td>
       </tr>

      </tbody>
          
    </table>
       
   </p>

   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
     <span class="function">exif_imagetype</span> will emit an <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong>
     and return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it is unable to read enough bytes from the file to
     determine the image type.
     
    </p>
   </p></blockquote>


name: exif_read_data
purpose: Reads the EXIF headers from an image file
manual_id: function.exif-read-data
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   It returns an associative <span class="type">array</span> where the array indexes are 
   the header names and the array values are the values associated with 
   those headers. If no data can be returned, 
   <span class="function">exif_read_data</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>

errors:
<p class="para">
   Errors of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> and/or <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong>
   may be raised for unsupported tags or other potential error conditions, but the
   function still tries to read all comprehensible information.
  </p>


name: exif_tagname
purpose: Get the header name for an index
manual_id: function.exif-tagname
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the header name, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">index</code> is
   not a defined EXIF tag id.
  </p>


name: exif_thumbnail
purpose: Retrieve the embedded thumbnail of an image
manual_id: function.exif-thumbnail
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the embedded thumbnail, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the image contains no 
   thumbnail.
  </p>


name: gd_info
purpose: Retrieve information about the currently installed GD library
manual_id: function.gd-info
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Elements of array returned by <span class="function">gd_info</span></strong></caption>
    
     <thead>
      <tr>
       <th>Attribute</th>
       <th>Meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>GD Version</td>
       <td><span class="type">string</span> value describing the installed
        <code class="literal">libgd</code> version.</td>
      </tr>

      <tr>
       <td>FreeType Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if FreeType Support is installed.</td>
      </tr>

      <tr>
       <td>FreeType Linkage</td>
       <td><span class="type">string</span> value describing the way in which
        FreeType was linked. Expected values are: &#039;with freetype&#039;,
        &#039;with TTF library&#039;, and &#039;with unknown library&#039;.  This element will
        only be defined if <code class="literal">FreeType Support</code> evaluated to
        <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.</td>
      </tr>

      <tr>
       <td>GIF Read Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if support for <em>reading</em> <code class="literal">GIF</code>
        images is included.</td>
      </tr>

      <tr>
       <td>GIF Create Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if support for <em>creating</em> <code class="literal">GIF</code>
        images is included.</td>
      </tr>

      <tr>
       <td>JPEG Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">JPEG</code> support is included.</td>
      </tr>

      <tr>
       <td>PNG Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">PNG</code> support is included.</td>
      </tr>

      <tr>
       <td>WBMP Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">WBMP</code> support is included.</td>
      </tr>

      <tr>
       <td>XBM Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">XBM</code> support is included.</td>
      </tr>

      <tr>
       <td>WebP Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">WebP</code> support is included.</td>
      </tr>

      <tr>
       <td>AVIF Support</td>
       <td><span class="type">bool</span> value.  <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        if <code class="literal">AVIF</code> support is included.
        Available as of PHP 8.1.0.</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: getimagesize
purpose: Get the size of an image
manual_id: function.getimagesize
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array with up to 7 elements. Not all image types will include
   the <code class="literal">channels</code> and <code class="literal">bits</code> elements.
  </p>
  <p class="para">
   Index 0 and 1 contains respectively the width and the height of the image.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Some formats may contain no image or may contain multiple images. In these
    cases, <span class="function">getimagesize</span> might not be able to properly
    determine the image size. <span class="function">getimagesize</span> will return
    zero for width and height in these cases.
   </p>
  </p></blockquote>
  <p class="para">
   Index 2 is one of the <a href="image.constants.html" class="link">IMAGETYPE_XXX constants</a> indicating 
   the type of the image.
  </p>
  <p class="para">
   Index 3 is a text string with the correct 
   <code class="literal">height=&quot;yyy&quot; width=&quot;xxx&quot;</code> string that can be used
   directly in an <acronym class="acronym">IMG</acronym> tag.
  </p>
  <p class="para">
   <code class="literal">mime</code> is the correspondant MIME type of the image.
   This information can be used to deliver images with the correct HTTP 
   <code class="literal">Content-type</code> header:
   <div class="example" id="example-10">
    <p><strong>Example # <span class="function">getimagesize</span> and MIME types</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$size </span><span style="color: #007700">= </span><span style="color: #0000BB">getimagesize</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">, </span><span style="color: #DD0000">"rb"</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$size </span><span style="color: #007700">&amp;&amp; </span><span style="color: #0000BB">$fp</span><span style="color: #007700">) {<br />    </span><span style="color: #0000BB">header</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-type: </span><span style="color: #007700">{</span><span style="color: #0000BB">$size</span><span style="color: #007700">[</span><span style="color: #DD0000">'mime'</span><span style="color: #007700">]}</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br />    </span><span style="color: #0000BB">fpassthru</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br />    exit;<br />} else {<br />    </span><span style="color: #FF8000">// error<br /></span><span style="color: #007700">}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <p class="para">
   <code class="literal">channels</code> will be 3 for RGB pictures and 4 for CMYK
   pictures.
  </p>
  <p class="para">
   <code class="literal">bits</code> is the number of bits for each color.
  </p>
  <p class="para">
   For some image types, the presence of <code class="literal">channels</code> and
   <code class="literal">bits</code> values can be a bit
   confusing. As an example, <acronym class="acronym">GIF</acronym> always uses 3 channels
   per pixel, but the number of bits per pixel cannot be calculated for an
   animated <acronym class="acronym">GIF</acronym> with a global color table.
  </p>
  <p class="para">
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>

errors:
<p class="para">
   If accessing the <code class="parameter">filename</code> image is impossible
   <span class="function">getimagesize</span> will generate an error of level
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>. On read error,
   <span class="function">getimagesize</span> will generate an error of level
   <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong>.
  </p>


name: image_type_to_extension
purpose: Get file extension for image type
manual_id: function.image-type-to-extension
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A string with the extension corresponding to the given image type,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: image_type_to_mime_type
manual_id: function.image-type-to-mime-type
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
purpose:
Get Mime-Type for image-type returned by getimagesize,   exif_read_data, exif_thumbnail, exif_imagetype

return_description:
<p class="para">
   The returned values are as follows
   <table class="doctable table">
   <caption><strong>Returned values Constants</strong></caption>
    
     <thead>
      <tr>
       <th><code class="parameter">image_type</code></th>
       <th>Returned value</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-gif">IMAGETYPE_GIF</a></code></strong></td>
       <td><code class="literal">image/gif</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-jpeg">IMAGETYPE_JPEG</a></code></strong></td>
       <td><code class="literal">image/jpeg</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-png">IMAGETYPE_PNG</a></code></strong></td>
       <td><code class="literal">image/png</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-swf">IMAGETYPE_SWF</a></code></strong></td>
       <td><code class="literal">application/x-shockwave-flash</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-psd">IMAGETYPE_PSD</a></code></strong></td>
       <td><code class="literal">image/psd</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-bmp">IMAGETYPE_BMP</a></code></strong></td>
       <td><code class="literal">image/bmp</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-tiff-ii">IMAGETYPE_TIFF_II</a></code></strong> (intel byte order)</td>
       <td><code class="literal">image/tiff</code></td>
      </tr>

      <tr>
       <td>
        <strong><code><a href="image.constants.html#constant.imagetype-tiff-mm">IMAGETYPE_TIFF_MM</a></code></strong> (motorola byte order)
       </td>
       <td><code class="literal">image/tiff</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-jpc">IMAGETYPE_JPC</a></code></strong></td>
       <td><code class="literal">application/octet-stream</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-jp2">IMAGETYPE_JP2</a></code></strong></td>
       <td><code class="literal">image/jp2</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-jpx">IMAGETYPE_JPX</a></code></strong></td>
       <td><code class="literal">application/octet-stream</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-jb2">IMAGETYPE_JB2</a></code></strong></td>
       <td><code class="literal">application/octet-stream</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-swc">IMAGETYPE_SWC</a></code></strong></td>
       <td><code class="literal">application/x-shockwave-flash</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-iff">IMAGETYPE_IFF</a></code></strong></td>
       <td><code class="literal">image/iff</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-wbmp">IMAGETYPE_WBMP</a></code></strong></td>
       <td><code class="literal">image/vnd.wap.wbmp</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-xbm">IMAGETYPE_XBM</a></code></strong></td>
       <td><code class="literal">image/xbm</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-ico">IMAGETYPE_ICO</a></code></strong></td>
       <td><code class="literal">image/vnd.microsoft.icon</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-webp">IMAGETYPE_WEBP</a></code></strong></td>
       <td><code class="literal">image/webp</code></td>
      </tr>

      <tr>
       <td><strong><code><a href="image.constants.html#constant.imagetype-avif">IMAGETYPE_AVIF</a></code></strong></td>
       <td><code class="literal">image/avif</code></td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: image2wbmp
purpose: Output image to browser or file
manual_id: function.image2wbmp
version: PHP 4 >= 4.0.5, PHP 5, PHP 7
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="caution"><strong class="caution">Caution</strong><p class="simpara">However, if libgd fails to output the image, this function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.</p></div>


name: imageaffine
purpose: Return an image containing the affine transformed src image, using an optional clipping area
manual_id: function.imageaffine
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return affined image object on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imageaffinematrixconcat
purpose: Concatenate two affine transformation matrices
manual_id: function.imageaffinematrixconcat
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An affine transformation matrix (an array with keys
   <code class="literal">0</code> to <code class="literal">5</code> and float values)
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagecolorallocate
purpose: Allocate a color for an image
manual_id: function.imagecolorallocate
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A color identifier or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the allocation failed.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: imagecolorat
purpose: Get the index of the color of a pixel
manual_id: function.imagecolorat
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the index of the color  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: imagecolorclosest
purpose: Get the index of the closest color to the specified color
manual_id: function.imagecolorclosest
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the index of the closest color, in the palette of the image, to
   the specified one
  </p>


name: imagecolorclosesthwb
purpose: Get the index of the color which has the hue, white and blackness
manual_id: function.imagecolorclosesthwb
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an integer with the index of the color which has 
   the hue, white and blackness nearest the given color.
  </p>


name: imagecolorexact
purpose: Get the index of the specified color
manual_id: function.imagecolorexact
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the index of the specified color in the palette, or -1 if the
   color does not exist.
  </p>


name: imagecolorexactalpha
purpose: Get the index of the specified color + alpha
manual_id: function.imagecolorexactalpha
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the index of the specified color+alpha in the palette of the
   image, or -1 if the color does not exist in the image&#039;s palette.
  </p>


name: imagecolorset
purpose: Set the color for the specified palette index
manual_id: function.imagecolorset
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The function returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagecolorsforindex
purpose: Get the colors for an index
manual_id: function.imagecolorsforindex
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array with red, green, blue and alpha keys that
   contain the appropriate values for the specified color index.
  </p>


name: imagecolorstotal
purpose: Find out the number of colors in an image's palette
manual_id: function.imagecolorstotal
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of colors in the specified image&#039;s palette or 0 for
   truecolor images.
  </p>


name: imagecolortransparent
purpose: Define a color as transparent
manual_id: function.imagecolortransparent
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The identifier of the new (or current, if none is specified)
   transparent color is returned. If <code class="parameter">color</code>
   is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, and the image has no transparent color, the
   returned identifier will be <code class="literal">-1</code>.
  </p>


name: imagecreate
purpose: Create a new palette based image
manual_id: function.imagecreate
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">Returns an image object on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on errors.</p>


name: imagecreatefromavif
purpose: Create a new image from file or URL
manual_id: function.imagecreatefromavif
version: PHP 8 >= 8.1.0
return_type: false
return_description:
<p class="para">
   Returns an image object on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on errors.
  </p>


name: imagecreatefromstring
purpose: Create a new image from the image stream in the string
manual_id: function.imagecreatefromstring
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An image object will be returned on success. <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if
   the image type is unsupported, the data is not in a recognised format,
   or the image is corrupt and cannot be loaded.
  </p>

errors:
<p class="para">
   <span class="function">imagecreatefromstring</span> raises an E_WARNING level error,
   if the data is not in a recognized format.
  </p>


name: imagecrop
purpose: Crop an image to the given rectangle
manual_id: function.imagecrop
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return cropped image object on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagecropauto
purpose: Crop an image automatically using one of the available modes
manual_id: function.imagecropauto
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a cropped image object on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned if the whole image was cropped.
  </p>


name: imageftbbox
purpose: Give the bounding box of a text using fonts via freetype2
manual_id: function.imageftbbox
version: PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">imageftbbox</span> returns an array with 8
   elements representing four points making the bounding box of the
   text:
   <table class="doctable informaltable">
    
     <tbody class="tbody">
      <tr>
       <td>0</td>
       <td>lower left corner, X position</td>
      </tr>

      <tr>
       <td>1</td>
       <td>lower left corner, Y position</td>
      </tr>

      <tr>
       <td>2</td>
       <td>lower right corner, X position</td>
      </tr>

      <tr>
       <td>3</td>
       <td>lower right corner, Y position</td>
      </tr>

      <tr>
       <td>4</td>
       <td>upper right corner, X position</td>
      </tr>

      <tr>
       <td>5</td>
       <td>upper right corner, Y position</td>
      </tr>

      <tr>
       <td>6</td>
       <td>upper left corner, X position</td>
      </tr>

      <tr>
       <td>7</td>
       <td>upper left corner, Y position</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   The points are relative to the <em>text</em> regardless of the
   <code class="parameter">angle</code>, so &quot;upper left&quot; means in the top left-hand 
   corner seeing the text horizontally.
  </p>
  <p class="para">
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: imagefttext
purpose: Write text to the image using fonts using FreeType 2
manual_id: function.imagefttext
version: PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns an array defining the four points of the box, starting in the lower left and moving counter-clockwise:
   <table class="doctable informaltable">
    
     <tbody class="tbody">
      <tr>
       <td>0</td>
       <td>lower left x-coordinate</td>
      </tr>

      <tr>
       <td>1</td>
       <td>lower left y-coordinate</td>
      </tr>

      <tr>
       <td>2</td>
       <td>lower right x-coordinate</td>
      </tr>

      <tr>
       <td>3</td>
       <td>lower right y-coordinate</td>
      </tr>

      <tr>
       <td>4</td>
       <td>upper right x-coordinate</td>
      </tr>

      <tr>
       <td>5</td>
       <td>upper right y-coordinate</td>
      </tr>

      <tr>
       <td>6</td>
       <td>upper left x-coordinate</td>
      </tr>

      <tr>
       <td>7</td>
       <td>upper left y-coordinate</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: imagegetclip
purpose: Get the clipping rectangle
manual_id: function.imagegetclip
version: PHP 7 >= 7.2.0, PHP 8
return_type: array
return_description:
<p class="para">
   The function returns an indexed array with the coordinates of the clipping
   rectangle which has the following entries:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">x-coordinate of the upper left corner</span>
    </li>
    <li class="listitem">
     <span class="simpara">y-coordinate of the upper left corner</span>
    </li>
    <li class="listitem">
     <span class="simpara">x-coordinate of the lower right corner</span>
    </li>
    <li class="listitem">
     <span class="simpara">y-coordinate of the lower right corner</span>
    </li>
   </ul>
  </p>


name: imagegrabscreen
purpose: Captures the whole screen
manual_id: function.imagegrabscreen
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an image object on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagegrabwindow
purpose: Captures a window
manual_id: function.imagegrabwindow
version: PHP 5 >= 5.2.2, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an image object on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   E_NOTICE is issued if <code class="parameter">handle</code> is invalid
   window handle.
   E_WARNING is issued if the Windows API is too old.
  </p>


name: imageinterlace
purpose: Enable or disable interlace
manual_id: function.imageinterlace
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the interlace bit is set for the image, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: imageistruecolor
purpose: Finds whether an image is a truecolor image
manual_id: function.imageistruecolor
version: PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the <code class="parameter">image</code> is truecolor, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: imageloadfont
purpose: Load a new font
manual_id: function.imageloadfont
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">GdFont</span> instance, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagepalettetotruecolor
purpose: Converts a palette based image to true color
manual_id: function.imagepalettetotruecolor
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the convertion was complete, or if the source image already 
   is a true color image, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: imageresolution
purpose: Get or set the resolution of the image
manual_id: function.imageresolution
version: PHP 7 >= 7.2.0, PHP 8
return_type: bool
return_description:
<p class="para">
   When used as getter,
   it returns an indexed array of the horizontal and vertical resolution on
   success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   When used as setter, it returns
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagerotate
purpose: Rotate an image with a given angle
manual_id: function.imagerotate
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an image object for the rotated image,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagescale
purpose: Scale an image using the given new width and height
manual_id: function.imagescale
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return the scaled image object on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imagettfbbox
purpose: Give the bounding box of a text using TrueType fonts
manual_id: function.imagettfbbox
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">imagettfbbox</span> returns an array with 8
   elements representing four points making the bounding box of the
   text on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
   <table class="doctable informaltable">
    
     <thead>
      <tr>
       <th>key</th>
       <th>contents</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>0</td>
       <td>lower left corner, X position</td>
      </tr>

      <tr>
       <td>1</td>
       <td>lower left corner, Y position</td>
      </tr>

      <tr>
       <td>2</td>
       <td>lower right corner, X position</td>
      </tr>

      <tr>
       <td>3</td>
       <td>lower right corner, Y position</td>
      </tr>

      <tr>
       <td>4</td>
       <td>upper right corner, X position</td>
      </tr>

      <tr>
       <td>5</td>
       <td>upper right corner, Y position</td>
      </tr>

      <tr>
       <td>6</td>
       <td>upper left corner, X position</td>
      </tr>

      <tr>
       <td>7</td>
       <td>upper left corner, Y position</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   The points are relative to the <em>text</em> regardless of the
   <code class="parameter">angle</code>, so &quot;upper left&quot; means in the top left-hand 
   corner seeing the text horizontally.
  </p>


name: imagettftext
purpose: Write text to the image using TrueType fonts
manual_id: function.imagettftext
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array with 8 elements representing four points making the
   bounding box of the text. The order of the points is lower left, lower 
   right, upper right, upper left. The points are relative to the text
   regardless of the angle, so &quot;upper left&quot; means in the top left-hand 
   corner when you see the text horizontally.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: imagetypes
purpose: Return the image types supported by this PHP build
manual_id: function.imagetypes
version: PHP 4 >= 4.0.2, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns a bit-field corresponding to the image formats supported by the
   version of GD linked into PHP.  The following bits are returned,
   <strong><code><a href="image.constants.html#constant.img-avif">IMG_AVIF</a></code></strong> | <strong><code><a href="image.constants.html#constant.img-bmp">IMG_BMP</a></code></strong> |
   <strong><code><a href="image.constants.html#constant.img-gif">IMG_GIF</a></code></strong> | <strong><code><a href="image.constants.html#constant.img-jpg">IMG_JPG</a></code></strong> |
   <strong><code><a href="image.constants.html#constant.img-png">IMG_PNG</a></code></strong> | <strong><code><a href="image.constants.html#constant.img-wbmp">IMG_WBMP</a></code></strong> | 
   <strong><code><a href="image.constants.html#constant.img-xpm">IMG_XPM</a></code></strong> | <strong><code><a href="image.constants.html#constant.img-webp">IMG_WEBP</a></code></strong>.
  </p>


name: iptcembed
purpose: Embeds binary IPTC data into a JPEG image
manual_id: function.iptcembed
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If <code class="parameter">spool</code> is less than 2, the JPEG will be returned,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. Otherwise returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: iptcparse
purpose: Parse a binary IPTC block into single tags
manual_id: function.iptcparse
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array using the tagmarker as an index and the value as the
   value. It returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error or if no IPTC data was found. 
  </p>


name: Gmagick.charcoalimage
purpose: Simulates a charcoal drawing
manual_id: gmagick.charcoalimage
version: PECL gmagick >= Unknown
return_type: Gmagick
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   The <span class="classname">Gmagick</span> object with charcoal simulation.
  </p>


name: Gmagick.getcopyright
purpose: Returns the GraphicsMagick API copyright as a string
manual_id: gmagick.getcopyright
version: PECL gmagick >= Unknown
return_type: string
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns a string containing the copyright notice of GraphicsMagick and
   Magickwand C API.
  </p>


name: Gmagick.getimageblueprimary
purpose: Returns the chromaticy blue primary point
manual_id: gmagick.getimageblueprimary
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Array consisting of &quot;x&quot; and &quot;y&quot; coordinates of point.
  </p>


name: Gmagick.getimagebordercolor
purpose: Returns the image border color
manual_id: gmagick.getimagebordercolor
version: PECL gmagick >= Unknown
return_type: GmagickPixel
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   <span class="classname">GmagickPixel</span> object representing the color of the border.
  </p>


name: Gmagick.getimageextrema
purpose: Gets the extrema for the image
manual_id: gmagick.getimageextrema
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns an associative array with the keys &quot;min&quot; and &quot;max&quot;.
  </p>


name: Gmagick.getimagegreenprimary
purpose: Returns the chromaticy green primary point
manual_id: gmagick.getimagegreenprimary
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns an array with the keys &quot;x&quot; and &quot;y&quot; on success. 
  </p>


name: Gmagick.getimagehistogram
purpose: Gets the image histogram
manual_id: gmagick.getimagehistogram
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns the image histogram as an array of <span class="classname">GmagickPixel</span> objects. 
  </p>


name: Gmagick.getimagematte
purpose: Check if the image has a matte channel
manual_id: gmagick.getimagematte
version: PECL gmagick >= Unknown
return_type: int
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the image has a matte channel, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Gmagick.getimageredprimary
purpose: Returns the chromaticity red primary point
manual_id: gmagick.getimageredprimary
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns the chromaticity red primary point as an array with the keys &quot;x&quot; and &quot;y&quot;. 
  </p>


name: Gmagick.getimagewhitepoint
purpose: Returns the chromaticity white point
manual_id: gmagick.getimagewhitepoint
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns the chromaticity white point as an associative array with the keys &quot;x&quot; and &quot;y&quot;.
  </p>


name: Gmagick.getquantumdepth
purpose: Returns the Gmagick quantum depth as a string
manual_id: gmagick.getquantumdepth
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns the <span class="classname">Gmagick</span> quantum depth as a string. 
  </p>


name: Gmagick.getsamplingfactors
purpose: Gets the horizontal and vertical sampling factor
manual_id: gmagick.getsamplingfactors
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns an associative array with the horizontal and vertical sampling factors of the image. 
  </p>


name: Gmagick.getsize
purpose: Returns the size associated with the Gmagick object
manual_id: gmagick.getsize
version: PECL gmagick >= Unknown
return_type: array
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns the size associated with the <span class="classname">Gmagick</span> object as an array with the keys &quot;columns&quot; and &quot;rows&quot;. 
  </p>


name: Gmagick.hasnextimage
purpose: Checks if the object has more images
manual_id: gmagick.hasnextimage
version: PECL gmagick >= Unknown
return_type: mixed
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the object has more images when traversing the list in the forward direction, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are none. 
  </p>


name: Gmagick.haspreviousimage
purpose: Checks if the object has a previous image
manual_id: gmagick.haspreviousimage
version: PECL gmagick >= Unknown
return_type: mixed
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the object has more images when traversing the list in the reverse direction, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are none. 
  </p>


name: Gmagick.medianfilterimage
purpose: Applies a digital filter
manual_id: gmagick.medianfilterimage
version: PECL gmagick >= Unknown
return_type: void
errors: <p class="para"> Throws an <span class="classname">GmagickException</span> on error. </p>
return_description:
<p class="para">
   <span class="classname">Gmagick</span> object with median filter applied.
  </p>


name: GmagickDraw.getfillcolor
purpose: Returns the fill color
manual_id: gmagickdraw.getfillcolor
version: PECL gmagick >= Unknown
return_type: GmagickPixel
return_description:
<p class="para">
   The <span class="classname">GmagickPixel</span> fill color used for drawing filled objects.
  </p>


name: GmagickDraw.getfillopacity
purpose: Returns the opacity used when drawing
manual_id: gmagickdraw.getfillopacity
version: PECL gmagick >= Unknown
return_type: float
return_description:
<p class="para">
   Returns the opacity used when drawing using the fill color or fill texture. Fully opaque is 1.0. 
  </p>


name: GmagickDraw.getfont
purpose: Returns the font
manual_id: gmagickdraw.getfont
version: PECL gmagick >= Unknown
return_type: mixed
return_description:
<p class="para">
   Returns a string on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no font is set. 
  </p>


name: GmagickDraw.getfontsize
purpose: Returns the font pointsize
manual_id: gmagickdraw.getfontsize
version: PECL gmagick >= Unknown
return_type: float
return_description:
<p class="para">
   Returns the font size associated with the current
   <span class="classname">GmagickDraw</span> object. 
  </p>


name: GmagickDraw.getfontstyle
purpose: Returns the font style
manual_id: gmagickdraw.getfontstyle
version: PECL gmagick >= Unknown
return_type: int
return_description:
<p class="para">
   Returns the font style constant (STYLE_) associated with the
   <span class="classname">GmagickDraw</span> object or <code class="literal">0</code> if no style
   is set.
  </p>


name: GmagickDraw.getstrokecolor
purpose: Returns the color used for stroking object outlines
manual_id: gmagickdraw.getstrokecolor
version: PECL gmagick >= Unknown
return_type: GmagickPixel
return_description:
<p class="para">
   Returns an <span class="classname">GmagickPixel</span> object which describes the color.
  </p>


name: GmagickDraw.gettextencoding
purpose: Returns the code set used for text annotations
manual_id: gmagickdraw.gettextencoding
version: PECL gmagick >= Unknown
return_type: mixed
return_description:
<p class="para">
   Returns a string specifying the code set or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if text encoding is not set. 
  </p>


name: GmagickPixel.getcolor
purpose: Returns the color
manual_id: gmagickpixel.getcolor
version: PECL gmagick >= Unknown
return_type: array
return_description:
<p class="para">
   A <span class="type">string</span> or an <span class="type">array</span> of channel values, each normalized if <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> is given as <code class="parameter">normalize_array</code>. Throws <span class="classname">GmagickPixelException</span> on error.
  </p>


name: GmagickPixel.getcolorcount
purpose: Returns the color count associated with this color
manual_id: gmagickpixel.getcolorcount
version: PECL gmagick >= Unknown
return_type: int
return_description:
<p class="para">
   Returns the color count as an integer on success, throws <span class="classname">GmagickPixelException</span> on failure. 
  </p>


name: GmagickPixel.getcolorvalue
purpose: Gets the normalized value of the provided color channel
manual_id: gmagickpixel.getcolorvalue
version: PECL gmagick >= Unknown
return_type: float
return_description:
<p class="para">
   The value of the channel, as a normalized floating-point number, throwing <span class="classname">GmagickPixelException</span> on error. 
  </p>


name: Imagick.adaptiveBlurImage
purpose: Adds adaptive blur filter to image
manual_id: imagick.adaptiveblurimage
version: PECL imagick 2, PECL imagick 3
return_type: bool
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
  </p>


name: Imagick.compareImageChannels
purpose: Returns the difference in one or more images
manual_id: imagick.compareimagechannels
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Array consisting of <code class="literal">new_wand</code> and
   <code class="literal">distortion</code>.
  </p>


name: Imagick.compareImages
purpose: Compares an image to a reconstructed image
manual_id: imagick.compareimages
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an array containing a reconstructed image and the difference between images.
  </p>


name: Imagick.getColorspace
purpose: Gets the colorspace
manual_id: imagick.getcolorspace
version: PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns an integer which can be compared against <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a>.
  </p>


name: Imagick.getCopyright
purpose: Returns the ImageMagick API copyright as a string
manual_id: imagick.getcopyright
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns a string containing the copyright notice of Imagemagick and
   Magickwand C API.
  </p>


name: Imagick.getFont
purpose: Gets font
manual_id: imagick.getfont
version: PECL imagick 2 >= 2.1.0, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns the string containing the font name or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not font is set.
  </p>


name: Imagick.getGravity
purpose: Gets the gravity
manual_id: imagick.getgravity
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns the gravity property. Refer to the list of 
   <a href="imagick.constants.html#imagick.constants.gravity" class="link">gravity constants</a>.
  </p>


name: Imagick.getImageAlphaChannel
purpose: Checks if the image has an alpha channel
manual_id: imagick.getimagealphachannel
version: PECL imagick 2 >= 2.3.0, PECL imagick 3
return_type: bool
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the image has an alpha channel value and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not,
   i.e. the image is <acronym class="acronym">RGB</acronym> rather than <acronym class="acronym">RGBA</acronym>
   or <acronym class="acronym">CMYK</acronym> rather than <acronym class="acronym">CMYKA</acronym>.
  </p>


name: Imagick.getImageChannelDistortions
purpose: Gets channel distortions
manual_id: imagick.getimagechanneldistortions
version: PECL imagick 2 >= 2.3.0, PECL imagick 3
return_type: float
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns a <span class="type">float</span> describing the channel distortion.
  </p>


name: Imagick.getImageChannelKurtosis
purpose: The getImageChannelKurtosis purpose
manual_id: imagick.getimagechannelkurtosis
version: PECL imagick 2 >= 2.3.0, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an array with <code class="literal">kurtosis</code> and <code class="literal">skewness</code>
   members.
  </p>


name: Imagick.getImageChannelMean
purpose: Gets the mean and standard deviation
manual_id: imagick.getimagechannelmean
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an array with <code class="literal">&quot;mean&quot;</code> and <code class="literal">&quot;standardDeviation&quot;</code>
   members.
  </p>


name: Imagick.getImageColors
purpose: Gets the number of unique colors in the image
manual_id: imagick.getimagecolors
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">int</span>, the number of unique colors in the image.
  </p>


name: Imagick.getImageDistortion
purpose: Compares an image to a reconstructed image
manual_id: imagick.getimagedistortion
version: PECL imagick 2, PECL imagick 3
return_type: float
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns the distortion metric used on the image (or the best guess
   thereof).
  </p>


name: Imagick.getImageGravity
purpose: Gets the image gravity
manual_id: imagick.getimagegravity
version: PECL imagick 2 >= 2.3.0, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns the images gravity property. Refer to the list of 
   <a href="imagick.constants.html#imagick.constants.gravity" class="link">gravity constants</a>.
  </p>


name: Imagick.getImageGreenPrimary
purpose: Returns the chromaticy green primary point
manual_id: imagick.getimagegreenprimary
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an array with the keys &quot;x&quot; and &quot;y&quot; on success, throws an
   ImagickException on failure.
  </p>


name: Imagick.getImageInterlaceScheme
purpose: Gets the image interlace scheme
manual_id: imagick.getimageinterlacescheme
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns the interlace scheme as an integer on success.
   Throw an
<span class="classname">ImagickException</span> on error.   
  </p>


name: Imagick.getImagePage
purpose: Returns the page geometry
manual_id: imagick.getimagepage
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns the page geometry associated with the image in an array with the
   keys &quot;width&quot;, &quot;height&quot;, &quot;x&quot;, and &quot;y&quot;.
  </p>


name: Imagick.getImageProperty
purpose: Returns the named image property
manual_id: imagick.getimageproperty
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns a string containing the image property, false if a
   property with the given name does not exist.
  </p>


name: Imagick.getImageRedPrimary
purpose: Returns the chromaticity red primary point
manual_id: imagick.getimageredprimary
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
    Returns the chromaticity red primary point as an array with the keys &quot;x&quot;
    and &quot;y&quot;.
    Throw an
<span class="classname">ImagickException</span> on error.
  </p>


name: Imagick.getImageRenderingIntent
purpose: Gets the image rendering intent
manual_id: imagick.getimagerenderingintent
version: PECL imagick 2, PECL imagick 3
return_type: int
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns the image <a href="imagick.constants.html#imagick.constants.renderingintent" class="link">rendering intent</a>.
  </p>


name: Imagick.getImagesBlob
purpose: Returns all image sequences as a blob
manual_id: imagick.getimagesblob
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns a string containing the images. On failure, throws
   ImagickException.
  </p>


name: Imagick.getImageTotalInkDensity
purpose: Gets the image total ink density
manual_id: imagick.getimagetotalinkdensity
version: PECL imagick 2, PECL imagick 3
return_type: float
return_description:
<p class="para">
    Returns the image total ink density of the image.
    Throw an
<span class="classname">ImagickException</span> on error.
  </p>


name: Imagick.getImageType
purpose: Gets the potential image type
manual_id: imagick.getimagetype
version: PECL imagick 2, PECL imagick 3
return_type: int
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns the potential image type.
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-undefined">imagick::IMGTYPE_UNDEFINED</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-bilevel">imagick::IMGTYPE_BILEVEL</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-grayscale">imagick::IMGTYPE_GRAYSCALE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-grayscalematte">imagick::IMGTYPE_GRAYSCALEMATTE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-palette">imagick::IMGTYPE_PALETTE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-palettematte">imagick::IMGTYPE_PALETTEMATTE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-truecolor">imagick::IMGTYPE_TRUECOLOR</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-truecolormatte">imagick::IMGTYPE_TRUECOLORMATTE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-colorseparation">imagick::IMGTYPE_COLORSEPARATION</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-colorseparationmatte">imagick::IMGTYPE_COLORSEPARATIONMATTE</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imagick.constants.html#imagick.constants.imgtype-optimize">imagick::IMGTYPE_OPTIMIZE</a></code></strong>
     </span>
    </li>
   </ul>
  </p>


name: Imagick.getImageWhitePoint
purpose: Returns the chromaticity white point
manual_id: imagick.getimagewhitepoint
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns the chromaticity white point as an associative array with the keys
   &quot;x&quot; and &quot;y&quot;.
  </p>


name: Imagick.getInterlaceScheme
purpose: Gets the object interlace scheme
manual_id: imagick.getinterlacescheme
version: PECL imagick 2, PECL imagick 3
return_type: int
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Gets the wand <a href="imagick.constants.html#imagick.constants.interlace" class="link">interlace
   scheme</a>.
  </p>


name: Imagick.getPage
purpose: Returns the page geometry
manual_id: imagick.getpage
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns the page geometry associated with the Imagick object in
   an associative array with the keys &quot;width&quot;, &quot;height&quot;, &quot;x&quot;, and &quot;y&quot;,
   throwing ImagickException on error.
  </p>


name: Imagick.getQuantumDepth
purpose: Gets the quantum depth
manual_id: imagick.getquantumdepth
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an array with <code class="literal">&quot;quantumDepthLong&quot;</code> and <code class="literal">&quot;quantumDepthString&quot;</code>
   members.
  </p>


name: Imagick.getQuantumRange
purpose: Returns the Imagick quantum range
manual_id: imagick.getquantumrange
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an associative array containing the quantum range as an
   <span class="type">int</span> (<code class="literal">&quot;quantumRangeLong&quot;</code>) and as a 
   <span class="type">string</span> (<code class="literal">&quot;quantumRangeString&quot;</code>).
  </p>


name: Imagick.getSamplingFactors
purpose: Gets the horizontal and vertical sampling factor
manual_id: imagick.getsamplingfactors
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Returns an associative array with the horizontal and vertical sampling
   factors of the image.
  </p>


name: Imagick.getSize
purpose: Returns the size associated with the Imagick object
manual_id: imagick.getsize
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns the size associated with the Imagick object as an array with the
   keys &quot;columns&quot; and &quot;rows&quot;.
  </p>


name: Imagick.hasNextImage
purpose: Checks if the object has more images
manual_id: imagick.hasnextimage
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the object has more images when traversing the list in the
   forward direction, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are none.
  </p>


name: Imagick.hasPreviousImage
purpose: Checks if the object has a previous image
manual_id: imagick.haspreviousimage
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the object has more images when traversing the list in the
   reverse direction, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are none.
  </p>


name: Imagick.identifyFormat
purpose: Formats a string with image details
manual_id: imagick.identifyformat
version: PECL imagick 3 >= 3.3.0
return_type: false
return_description:
<p class="para">
   Returns format or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Imagick.identifyImage
purpose: Identifies an image and fetches attributes
manual_id: imagick.identifyimage
version: PECL imagick 2, PECL imagick 3
return_type: array
errors: <p class="para"> Throws ImagickException on error. </p>
return_description:
<p class="para">
   Identifies an image and returns the attributes.  Attributes include
   the image width, height, size, and others.
  </p>


name: Imagick.montageImage
purpose: Creates a composite image
manual_id: imagick.montageimage
version: PECL imagick 2, PECL imagick 3
return_type: Imagick
return_description:
<p class="para">
   Creates a composite image and returns it as a new <span class="classname">Imagick</span> object.
  </p>


name: Imagick.morphImages
purpose: Method morphs a set of images
manual_id: imagick.morphimages
version: PECL imagick 2, PECL imagick 3
return_type: Imagick
return_description:
<p class="para">
  This method returns a new Imagick object on success.
  Throw an
<span class="classname">ImagickException</span> on error.
  </p>


name: ImagickDraw.clone
purpose: Makes an exact copy of the specified ImagickDraw object
manual_id: imagickdraw.clone
version: PECL imagick 2, PECL imagick 3
return_type: ImagickDraw
return_description:
<p class="para">
   returns an exact copy of the specified <span class="classname">ImagickDraw</span> object.
  </p>


name: ImagickDraw.getClipPath
purpose: Obtains the current clipping path ID
manual_id: imagickdraw.getclippath
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns a string containing the clip path ID or false if no clip path exists.
  </p>


name: ImagickDraw.getClipRule
purpose: Returns the current polygon fill rule
manual_id: imagickdraw.getcliprule
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.fillrule" class="link">FILLRULE</a> constant
   (<code class="literal">imagick::FILLRULE_*</code>). 
  </p>


name: ImagickDraw.getFillRule
purpose: Returns the fill rule
manual_id: imagickdraw.getfillrule
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.fillrule" class="link">FILLRULE</a> constant
   (<code class="literal">imagick::FILLRULE_*</code>).
  </p>


name: ImagickDraw.getFontFamily
purpose: Returns the font family
manual_id: imagickdraw.getfontfamily
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns the font family currently selected or false if font family is not set. 
  </p>


name: ImagickDraw.getFontSize
purpose: Returns the font pointsize
manual_id: imagickdraw.getfontsize
version: PECL imagick 2, PECL imagick 3
return_type: float
return_description:
<p class="para">
   Returns the font size associated with the current <span class="classname">ImagickDraw</span> object.
  </p>


name: ImagickDraw.getFontStyle
purpose: Returns the font style
manual_id: imagickdraw.getfontstyle
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.styles" class="link">STYLE</a> constant
   (<code class="literal">imagick::STYLE_*</code>) associated with the <span class="classname">ImagickDraw</span> object 
   or 0 if no style is set.
  </p>


name: ImagickDraw.getFontWeight
purpose: Returns the font weight
manual_id: imagickdraw.getfontweight
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">int</span> on success and 0 if no weight is set.
  </p>


name: ImagickDraw.getGravity
purpose: Returns the text placement gravity
manual_id: imagickdraw.getgravity
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.gravity" class="link">GRAVITY</a> constant
   (<code class="literal">imagick::GRAVITY_*</code>) on success and 0 if no gravity is set.
  </p>


name: ImagickDraw.getStrokeAntialias
purpose: Returns the current stroke antialias setting
manual_id: imagickdraw.getstrokeantialias
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if antialiasing is on and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it is off.
  </p>


name: ImagickDraw.getStrokeColor
purpose: Returns the color used for stroking object outlines
manual_id: imagickdraw.getstrokecolor
version: PECL imagick 2, PECL imagick 3
return_type: ImagickPixel
return_description:
<p class="para">
   Returns an <span class="classname">ImagickPixel</span> object which describes the color.
  </p>


name: ImagickDraw.getStrokeLineCap
purpose: Returns the shape to be used at the end of open subpaths when they are stroked
manual_id: imagickdraw.getstrokelinecap
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.linecap" class="link">LINECAP</a> constant
   (<code class="literal">imagick::LINECAP_*</code>), or 0 if stroke linecap is not set.
  </p>


name: ImagickDraw.getStrokeLineJoin
purpose: Returns the shape to be used at the corners of paths when they are stroked
manual_id: imagickdraw.getstrokelinejoin
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.linejoin" class="link">LINEJOIN</a> constant
   (<code class="literal">imagick::LINEJOIN_*</code>), or 0 if stroke line join is not set.
  </p>


name: ImagickDraw.getStrokeMiterLimit
purpose: Returns the stroke miter limit
manual_id: imagickdraw.getstrokemiterlimit
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns an int describing the miter limit
   and 0 if no miter limit is set.
  </p>


name: ImagickDraw.getTextAlignment
purpose: Returns the text alignment
manual_id: imagickdraw.gettextalignment
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.align" class="link">ALIGN</a> constant
   (<code class="literal">imagick::ALIGN_*</code>), and 0 if no align is set.
  </p>


name: ImagickDraw.getTextAntialias
purpose: Returns the current text antialias setting
manual_id: imagickdraw.gettextantialias
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if text is antialiased and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: ImagickDraw.getTextDecoration
purpose: Returns the text decoration
manual_id: imagickdraw.gettextdecoration
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns a <a href="imagick.constants.html#imagick.constants.decoration" class="link">DECORATION</a> constant
   (<code class="literal">imagick::DECORATION_*</code>), and 0 if no decoration is set.
  </p>


name: ImagickDraw.getTextEncoding
purpose: Returns the code set used for text annotations
manual_id: imagickdraw.gettextencoding
version: PECL imagick 2, PECL imagick 3
return_type: string
return_description:
<p class="para">
   Returns a string specifying the code set
   or false if text encoding is not set.
  </p>


name: ImagickDraw.getTextUnderColor
purpose: Returns the text under color
manual_id: imagickdraw.gettextundercolor
version: PECL imagick 2, PECL imagick 3
return_type: ImagickPixel
return_description:
<p class="para">
   Returns an <span class="classname">ImagickPixel</span> object describing the color.
  </p>


name: ImagickDraw.pushPattern
manual_id: imagickdraw.pushpattern
version: PECL imagick 2, PECL imagick 3
return_type: bool
purpose:
Indicates that subsequent commands up to a ImagickDraw::opPattern() command comprise the definition of a named pattern


name: ImagickPixel.__construct
purpose: The ImagickPixel constructor
manual_id: imagickpixel.construct
version: PECL imagick 2, PECL imagick 3
return_description:
<p class="para">
   Returns an ImagickPixel object on success, throwing ImagickPixelException on
   failure.
  </p>


name: ImagickPixel.getColorCount
purpose: Returns the color count associated with this color
manual_id: imagickpixel.getcolorcount
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns the color count as an integer on success, throws
  ImagickPixelException on failure.
  </p>


name: ImagickPixel.getColorQuantum
purpose: Returns the color of the pixel in an array as Quantum values
manual_id: imagickpixel.getcolorquantum
return_type: array
return_description:
<p class="para">
   Returns an array with keys <code class="literal">&quot;r&quot;</code>, <code class="literal">&quot;g&quot;</code>,
   <code class="literal">&quot;b&quot;</code>, <code class="literal">&quot;a&quot;</code>.
  </p>


name: ImagickPixel.getColorValue
purpose: Gets the normalized value of the provided color channel
manual_id: imagickpixel.getcolorvalue
version: PECL imagick 2, PECL imagick 3
return_type: float
return_description:
<p class="para">
   The value of the channel, as a normalized floating-point number, throwing
   ImagickPixelException on error.
  </p>


name: ImagickPixel.getColorValueQuantum
purpose: Gets the quantum value of a color in the ImagickPixel
manual_id: imagickpixel.getcolorvaluequantum
version: PECL imagick 2 >= 2.3.0, PECL imagick 3
return_type: float
return_description:
<p class="para">
   The quantum value of the color element. Float if ImageMagick was compiled with HDRI, otherwise an int.
  </p>


name: ImagickPixel.getHSL
purpose: Returns the normalized HSL color of the ImagickPixel object
manual_id: imagickpixel.gethsl
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns the HSL value in an array with the keys &quot;hue&quot;,
   &quot;saturation&quot;, and &quot;luminosity&quot;. Throws ImagickPixelException on failure.
  </p>


name: ImagickPixel.setColor
purpose: Sets the color
manual_id: imagickpixel.setcolor
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the specified color was set, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: ImagickPixelIterator.getCurrentIteratorRow
purpose: Returns the current row of ImagickPixel objects
manual_id: imagickpixeliterator.getcurrentiteratorrow
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns a row as an array of ImagickPixel objects that can themselves be iterated.
  </p>


name: ImagickPixelIterator.getIteratorRow
purpose: Returns the current pixel iterator row
manual_id: imagickpixeliterator.getiteratorrow
version: PECL imagick 2, PECL imagick 3
return_type: int
return_description:
<p class="para">
   Returns the integer offset of the row, throwing
   ImagickPixelIteratorException on error.
  </p>


name: ImagickPixelIterator.getNextIteratorRow
purpose: Returns the next row of the pixel iterator
manual_id: imagickpixeliterator.getnextiteratorrow
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns the next row as an array of ImagickPixel objects, throwing
   ImagickPixelIteratorException on error.
  </p>


name: ImagickPixelIterator.getPreviousIteratorRow
purpose: Returns the previous row
manual_id: imagickpixeliterator.getpreviousiteratorrow
version: PECL imagick 2, PECL imagick 3
return_type: array
return_description:
<p class="para">
   Returns the previous row as an array of ImagickPixelWand objects from the
   ImagickPixelIterator, throwing ImagickPixelIteratorException on error.
  </p>


name: ImagickPixelIterator.newPixelIterator
purpose: Returns a new pixel iterator
manual_id: imagickpixeliterator.newpixeliterator
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success. Throwing ImagickPixelIteratorException.
  </p>


name: ImagickPixelIterator.newPixelRegionIterator
purpose: Returns a new pixel iterator
manual_id: imagickpixeliterator.newpixelregioniterator
version: PECL imagick 2, PECL imagick 3
return_type: bool
return_description:
<p class="para">
   Returns a new ImagickPixelIterator on success; on failure, throws
   ImagickPixelIteratorException.
  </p>


name: imap_8bit
purpose: Convert an 8bit string to a quoted-printable string
manual_id: function.imap-8bit
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a quoted-printable string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_alerts
purpose: Returns all IMAP alert messages that have occurred
manual_id: function.imap-alerts
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of all of the IMAP alert messages generated or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   no alert messages are available.
  </p>


name: imap_base64
purpose: Decode BASE64 encoded text
manual_id: function.imap-base64
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the decoded message as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_binary
purpose: Convert an 8bit string to a base64 string
manual_id: function.imap-binary
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a base64 encoded string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_body
purpose: Read the message body
manual_id: function.imap-body
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the body of the specified message, as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_bodystruct
purpose: Read the structure of a specified body section of a specific message
manual_id: function.imap-bodystruct
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the information in an object,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   For a detailed description
   of the object structure and properties see 
   <span class="function">imap_fetchstructure</span>.
  </p>


name: imap_check
purpose: Check current mailbox
manual_id: function.imap-check
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the information in an object with following properties:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <strong><code>Date</code></strong> - current system time formatted according to <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC2822</a>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>Driver</code></strong> - protocol used to access this mailbox:
      <acronym class="acronym">POP3</acronym>, <acronym class="acronym">IMAP</acronym>, <acronym class="acronym">NNTP</acronym>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>Mailbox</code></strong> - the mailbox name
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>Nmsgs</code></strong> - number of messages in the mailbox
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code>Recent</code></strong> - number of recent messages in the mailbox
     </span>
    </li>
   </ul>
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_clearflag_full
purpose: Clears flags on messages
manual_id: function.imap-clearflag-full
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: true
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">options</code> is invalid.
  </p>


name: imap_close
purpose: Close an IMAP stream
manual_id: function.imap-close
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: true
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">flags</code>
   is invalid.
  </p>


name: imap_errors
purpose: Returns all of the IMAP errors that have occurred
manual_id: function.imap-errors
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns an array of all of the IMAP error messages
   generated since the last <span class="function">imap_errors</span> call,
   or the beginning of the page. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no error messages are
   available. 
  </p>


name: imap_fetch_overview
purpose: Read an overview of the information in the headers of the given message
manual_id: function.imap-fetch-overview
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of objects describing one message header each.
   The object will only define a property if it exists. The possible
   properties are:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <code class="literal">subject</code> - the messages subject
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">from</code> - who sent it
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">to</code> - recipient
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">date</code> - when was it sent
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">message_id</code> - Message-ID
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">references</code> - is a reference to this message id
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">in_reply_to</code> - is a reply to this message id
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">size</code> - size in bytes
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">uid</code> - UID the message has in the mailbox
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">msgno</code> - message sequence number in the mailbox
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">recent</code> - this message is flagged as recent
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">flagged</code> -  this message is flagged
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">answered</code> -  this message is flagged as answered
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">deleted</code> -  this message is flagged for deletion
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">seen</code> -  this message is flagged as already read
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">draft</code> -  this message is flagged as being a draft
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <code class="literal">udate</code> -  the UNIX timestamp of the arrival date
     </span>
    </li>
   </ul>
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_fetchbody
purpose: Fetch a particular section of the body of the message
manual_id: function.imap-fetchbody
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a particular section of the body of the specified messages as a
   text string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_fetchheader
purpose: Returns header for a message
manual_id: function.imap-fetchheader
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the header of the specified message as a text string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_fetchmime
purpose: Fetch MIME headers for a particular section of the message
manual_id: function.imap-fetchmime
version: PHP 5 >= 5.3.6, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the MIME headers of a particular section of the body of the specified messages as a
   text string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_fetchstructure
purpose: Read the structure of a particular message
manual_id: function.imap-fetchstructure
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an object with properties listed in the table below,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>
     Returned Object for <span class="function">imap_fetchstructure</span>
    </strong></caption>
    
     <tbody class="tbody">
      <tr>
       <td>type</td>
       <td>Primary body type</td>
      </tr>

      <tr>
       <td>encoding</td>
       <td>Body transfer encoding</td>
      </tr>

      <tr>
       <td>ifsubtype</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is a subtype string</td>
      </tr>

      <tr>
       <td>subtype</td>
       <td><acronym class="acronym">MIME</acronym> subtype</td>
      </tr>

      <tr>
       <td>ifdescription</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is a description string</td>
      </tr>

      <tr>
       <td>description</td>
       <td>Content description string</td>
      </tr>

      <tr>
       <td>ifid</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is an identification string</td>
      </tr>

      <tr>
       <td>id</td>
       <td>Identification string</td>
      </tr>

      <tr>
       <td>lines</td>
       <td>Number of lines</td>
      </tr>

      <tr>
       <td>bytes</td>
       <td>Number of bytes</td>
      </tr>

      <tr>
       <td>ifdisposition</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is a disposition string</td>
      </tr>

      <tr>
       <td>disposition</td>
       <td>Disposition string</td>
      </tr>

      <tr>
       <td>ifdparameters</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the <var class="varname">dparameters</var> array exists</td>
      </tr>

      <tr>
       <td>dparameters</td>
       <td>An array of objects where each object has an
        <code class="literal">&quot;attribute&quot;</code> and a <code class="literal">&quot;value&quot;</code>
        property corresponding to the parameters on the
        <code class="literal">Content-disposition</code> <acronym class="acronym">MIME</acronym>
        header.</td>
      </tr>

      <tr>
       <td>ifparameters</td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the parameters array exists</td>
      </tr>

      <tr>
       <td>parameters</td>
       <td>An array of objects where each object has an
        <code class="literal">&quot;attribute&quot;</code> and a <code class="literal">&quot;value&quot;</code>
        property.</td>
      </tr>

      <tr>
       <td>parts</td>
       <td>An array of objects identical in structure to the top-level
       object, each of which corresponds to a <acronym class="acronym">MIME</acronym> body
       part.</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Primary body type (value may vary with used library, use of constants is recommended)</strong></caption>
    
     <thead>
      <tr><th>Value</th><th>Type</th><th>Constant</th></tr>

     </thead>

     <tbody class="tbody">
      <tr><td>0</td><td>text</td><td>TYPETEXT</td></tr>

      <tr><td>1</td><td>multipart</td><td>TYPEMULTIPART</td></tr>

      <tr><td>2</td><td>message</td><td>TYPEMESSAGE</td></tr>

      <tr><td>3</td><td>application</td><td>TYPEAPPLICATION</td></tr>

      <tr><td>4</td><td>audio</td><td>TYPEAUDIO</td></tr>

      <tr><td>5</td><td>image</td><td>TYPEIMAGE</td></tr>

      <tr><td>6</td><td>video</td><td>TYPEVIDEO</td></tr>

      <tr><td>7</td><td>model</td><td>TYPEMODEL</td></tr>

      <tr><td>8</td><td>other</td><td>TYPEOTHER</td></tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Transfer encodings (value may vary with used library, use of constants is recommended)</strong></caption>
    
     <thead>
      <tr><th>Value</th><th>Type</th><th>Constant</th></tr>

     </thead>

     <tbody class="tbody">
      <tr><td>0</td><td>7bit</td><td>ENC7BIT</td></tr>

      <tr><td>1</td><td>8bit</td><td>ENC8BIT</td></tr>

      <tr><td>2</td><td>Binary</td><td>ENCBINARY</td></tr>

      <tr><td>3</td><td>Base64</td><td>ENCBASE64</td></tr>

      <tr><td>4</td><td>Quoted-Printable</td><td>ENCQUOTEDPRINTABLE</td></tr>

      <tr><td>5</td><td>other</td><td>ENCOTHER</td></tr>

     </tbody>
    
   </table>

  </p>


name: imap_get_quota
purpose: Retrieve the quota level settings, and usage statics per mailbox
manual_id: function.imap-get-quota
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array with integer values limit and usage for the given
   mailbox.  The value of limit represents the total amount of space
   allowed for this mailbox.  The usage value represents the mailboxes
   current level of capacity.  Will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in the case of failure.
  </p>
  <p class="para">
   As of PHP 4.3, the function more properly reflects the
   functionality as dictated by the <a href="http://www.faqs.org/rfcs/rfc2087" class="link external">&raquo;&nbsp;RFC2087</a>.
   The array return value has changed to support an unlimited number of returned 
   resources (i.e.  messages, or sub-folders) with each named resource receiving
   an individual array key.  Each key value then contains an another array with
   the usage and limit values within it.
  </p>
  <p class="para">
   For backwards compatibility reasons, the original access methods are
   still available for use, although it is suggested to update.
  </p>


name: imap_get_quotaroot
purpose: Retrieve the quota settings per user
manual_id: function.imap-get-quotaroot
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of integer values pertaining to the specified user
   mailbox.  All values contain a key based upon the resource name, and a
   corresponding array with the usage and limit values within.
  </p>
  <p class="para">
   This function will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in the case of call failure, and an
   array of information about the connection upon an un-parsable response
   from the server.
  </p>


name: imap_getacl
purpose: Gets the ACL for a given mailbox
manual_id: function.imap-getacl
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array of &quot;folder&quot; =&gt; &quot;acl&quot; pairs,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_getmailboxes
purpose: Read the list of mailboxes, returning detailed information on each one
manual_id: function.imap-getmailboxes
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of objects containing mailbox information. Each
   object has the attributes <code class="parameter">name</code>, specifying
   the full name of the mailbox; <code class="parameter">delimiter</code>,
   which is the hierarchy delimiter for the part of the hierarchy
   this mailbox is in; and
   <code class="parameter">attributes</code>. <code class="parameter">Attributes</code>
   is a bitmask that can be tested against:
   <ul class="itemizedlist">
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-noinferiors">LATT_NOINFERIORS</a></code></strong> - This mailbox not contains, and may not contain any
      &quot;children&quot; (there are no mailboxes below this one). Calling 
      <span class="function">imap_createmailbox</span> will not work on this mailbox.
     </p>
    </li>
   <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-noselect">LATT_NOSELECT</a></code></strong> - This is only a container,
      not a mailbox - you cannot open it.
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-marked">LATT_MARKED</a></code></strong> - This mailbox is marked. This means that it may 
      contain new messages since the last time it was checked. Not provided by all IMAP
      servers.
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-unmarked">LATT_UNMARKED</a></code></strong> - This mailbox is not marked, does not contain new
      messages.  If either <strong><code>MARKED</code></strong> or <strong><code>UNMARKED</code></strong> is
      provided, you can assume the IMAP server  supports this feature for this mailbox.
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-referral">LATT_REFERRAL</a></code></strong> - This container has a referral to a remote mailbox.
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-haschildren">LATT_HASCHILDREN</a></code></strong> - This mailbox has selectable inferiors.
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      <strong><code><a href="imap.constants.html#constant.latt-hasnochildren">LATT_HASNOCHILDREN</a></code></strong> - This mailbox has no selectable inferiors.
     </p>
    </li>
   </ul>
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_getsubscribed
purpose: List all the subscribed mailboxes
manual_id: function.imap-getsubscribed
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of objects containing mailbox information. Each
   object has the attributes <code class="parameter">name</code>, specifying
   the full name of the mailbox; <code class="parameter">delimiter</code>,
   which is the hierarchy delimiter for the part of the hierarchy
   this mailbox is in; and
   <code class="parameter">attributes</code>. <code class="parameter">Attributes</code>
   is a bitmask that can be tested against:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-noinferiors">LATT_NOINFERIORS</a></code></strong> - This mailbox has no
      &quot;children&quot; (there are no mailboxes below this one).
     </span>
    </li>
   <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-noselect">LATT_NOSELECT</a></code></strong> - This is only a container,
      not a mailbox - you cannot open it.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-marked">LATT_MARKED</a></code></strong> - This mailbox is marked.
      Only used by UW-IMAPD.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-unmarked">LATT_UNMARKED</a></code></strong> - This mailbox is not marked.
      Only used by UW-IMAPD.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-referral">LATT_REFERRAL</a></code></strong> - This container has a referral to a remote mailbox.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-haschildren">LATT_HASCHILDREN</a></code></strong> - This mailbox has selectable inferiors.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      <strong><code><a href="imap.constants.html#constant.latt-hasnochildren">LATT_HASNOCHILDREN</a></code></strong> - This mailbox has no selectable inferiors.
     </span>
    </li>
   </ul>
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_headerinfo
purpose: Read the header of the message
manual_id: function.imap-headerinfo
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error or, if successful, the information in an object with following properties:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      toaddress - full to: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      to - an array of objects from the To: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fromaddress - full from: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      from - an array of objects from the From: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      ccaddress - full cc: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      cc - an array of objects from the Cc: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      bccaddress - full bcc: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      bcc - an array of objects from the Bcc: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      reply_toaddress - full Reply-To: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      reply_to - an array of objects from the Reply-To: line, with the following
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      senderaddress - full sender: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      sender - an array of objects from the Sender: line, with the following 
      properties: <code class="literal">personal</code>, <code class="literal">adl</code>,
      <code class="literal">mailbox</code>, and <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      return_pathaddress - full Return-Path: line, up to 1024 characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      return_path - an array of objects from the Return-Path: line, with the
      following properties: <code class="literal">personal</code>, 
      <code class="literal">adl</code>, <code class="literal">mailbox</code>, and 
      <code class="literal">host</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      remail - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      date - The message date as found in its headers
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Date - Same as date
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      subject - The message subject
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Subject - Same as subject 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      in_reply_to - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      message_id - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      newsgroups - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      followup_to - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      references - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Recent - <code class="literal">R</code> if recent and seen, <code class="literal">N</code>
      if recent and not seen, &#039; &#039; if not recent.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Unseen - <code class="literal">U</code> if not seen AND not recent, &#039; &#039; if seen
      OR not seen and recent
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Flagged - <code class="literal">F</code> if flagged, &#039; &#039; if not flagged
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Answered - <code class="literal">A</code> if answered, &#039; &#039; if unanswered
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Deleted - <code class="literal">D</code> if deleted, &#039; &#039; if not deleted
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Draft - <code class="literal">X</code> if draft, &#039; &#039; if not draft
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Msgno - The message number
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      MailDate - 
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      Size - The message size
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      udate - mail message date in Unix time
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fetchfrom - from line formatted to fit <code class="parameter">from_length</code>
      characters
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      fetchsubject - subject line formatted to fit 
      <code class="parameter">subject_length</code> characters
     </span>
    </li>
   </ul>
  </p>


name: imap_headers
purpose: Returns headers for all messages in a mailbox
manual_id: function.imap-headers
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of string formatted with header info. One
   element per mail message.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_is_open
purpose: Check if the IMAP stream is still valid
manual_id: function.imap-is-open
version: PHP 8 >= 8.2.1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream is still valid, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: imap_last_error
purpose: Gets the last IMAP error that occurred during this page request
manual_id: function.imap-last-error
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the full text of the last IMAP error message that occurred on the
   current page. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no error messages are available.
  </p>


name: imap_list
purpose: Read the list of mailboxes
manual_id: function.imap-list
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array containing the names of the mailboxes or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in case of failure.
  </p>


name: imap_listscan
purpose: Returns the list of mailboxes that matches the given text
manual_id: function.imap-listscan
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array containing the names of the mailboxes that have
   <code class="parameter">content</code> in the text of the mailbox,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_lsub
purpose: List all the subscribed mailboxes
manual_id: function.imap-lsub
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of all the subscribed mailboxes,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_mail_compose
purpose: Create a MIME message based on given envelope and body sections
manual_id: function.imap-mail-compose
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the MIME message as <span class="type">string</span>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_mailboxmsginfo
purpose: Get information about the current mailbox
manual_id: function.imap-mailboxmsginfo
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: stdClass
return_description:
<p class="para">
   Returns the information in an object with following properties:
   <table class="doctable table">
    <caption><strong>Mailbox properties</strong></caption>
    
     <tbody class="tbody">
      <tr>
       <td>Date</td>
       <td>date of last change (current datetime)</td>
      </tr>

      <tr>
       <td>Driver</td>
       <td>driver</td>
      </tr>

      <tr>
       <td>Mailbox</td>
       <td>name of the mailbox</td>
      </tr>

      <tr>
       <td>Nmsgs</td>
       <td>number of messages</td>
      </tr>

      <tr>
       <td>Recent</td>
       <td>number of recent messages</td>
      </tr>

      <tr>
       <td>Unread</td>
       <td>number of unread messages</td>
      </tr>

      <tr>
       <td>Deleted</td>
       <td>number of deleted messages</td>
      </tr>

      <tr>
       <td>Size</td>
       <td>mailbox size</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: imap_mime_header_decode
purpose: Decode MIME header elements
manual_id: function.imap-mime-header-decode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The decoded elements are returned in an array of objects, where each
   object has two properties, <code class="literal">charset</code> and 
   <code class="literal">text</code>.
  </p>
  <p class="para">
   If the element hasn&#039;t been encoded, and in other words is in
   plain US-ASCII, the <code class="literal">charset</code> property of that element is
   set to <code class="literal">default</code>.
  </p>
  <p class="para">
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_msgno
purpose: Gets the message sequence number for the given UID
manual_id: function.imap-msgno
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the message sequence number for the given 
   <code class="parameter">message_uid</code>.
  </p>


name: imap_mutf7_to_utf8
purpose: Decode a modified UTF-7 string to UTF-8
manual_id: function.imap-mutf7-to-utf8
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <code class="parameter">string</code> converted to UTF-8,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_num_msg
purpose: Gets the number of messages in the current mailbox
manual_id: function.imap-num-msg
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Return the number of messages in the current mailbox, as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: imap_num_recent
purpose: Gets the number of recent messages in current mailbox
manual_id: function.imap-num-recent
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of recent messages in the current mailbox, as an
   integer.
  </p>


name: imap_open
purpose: Open an IMAP stream to a mailbox
manual_id: function.imap-open
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">IMAP\Connection</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_ping
purpose: Check if the IMAP stream is still active
manual_id: function.imap-ping
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream is still alive, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: imap_qprint
purpose: Convert a quoted-printable string to an 8 bit string
manual_id: function.imap-qprint
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an 8 bits string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_reopen
purpose: Reopen IMAP stream to new mailbox
manual_id: function.imap-reopen
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the stream is reopened, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: imap_rfc822_parse_adrlist
purpose: Parses an address string
manual_id: function.imap-rfc822-parse-adrlist
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of objects. The objects properties are:
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      mailbox  - the mailbox name (username)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      host - the host name
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      personal - the personal name
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      adl - at domain source route
     </span>
    </li>
   </ul>
  </p>


name: imap_rfc822_parse_headers
purpose: Parse mail headers from a string
manual_id: function.imap-rfc822-parse-headers
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: stdClass
return_description:
<p class="para">
   Returns an object similar to the one returned by
   <span class="function">imap_header</span>, except for the flags and other 
   properties that come from the IMAP server.
   </p>


name: imap_rfc822_write_address
purpose: Returns a properly formatted email address given the mailbox, host, and personal info
manual_id: function.imap-rfc822-write-address
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string properly formatted email address as defined in <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC2822</a>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>


name: imap_search
purpose: This function returns an array of messages matching the given search criteria
manual_id: function.imap-search
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of message numbers or UIDs.
  </p>
  <p class="para">
   Return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not understand the search
   <code class="parameter">criteria</code> or no messages have been found.
  </p>


name: imap_setflag_full
purpose: Sets flags on messages
manual_id: function.imap-setflag-full
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: true
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">options</code>
   is invalid.
  </p>


name: imap_sort
purpose: Gets and sort messages
manual_id: function.imap-sort
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of message numbers sorted by the given
   parameters,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: imap_status
purpose: Returns status information on a mailbox
manual_id: function.imap-status
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns an object containing status information,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The object has the following properties: <code class="literal">messages</code>,
   <code class="literal">recent</code>, <code class="literal">unseen</code>, 
   <code class="literal">uidnext</code>, and <code class="literal">uidvalidity</code>.  
  </p>
  <p class="para">
   <code class="literal">flags</code> is also set, which contains a bitmask which can
   be checked against any of the above constants.
  </p>


name: imap_thread
purpose: Returns a tree of threaded message
manual_id: function.imap-thread
version: PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">imap_thread</span> returns an associative array containing
   a tree of messages threaded by <code class="literal">REFERENCES</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   on error.
  </p>
  <p class="para">
   Every message in the current mailbox will be represented by three entries
   in the resulting array:
   <ul class="itemizedlist">
    <li class="listitem"><p class="para">
     <var class="varname">$thread[&quot;XX.num&quot;]</var> - current message number
    </p></li>
    <li class="listitem"><p class="para">
     <var class="varname">$thread[&quot;XX.next&quot;]</var>
    </p></li>
    <li class="listitem"><p class="para">
     <var class="varname">$thread[&quot;XX.branch&quot;]</var>
    </p></li>
   </ul>
  </p>


name: imap_timeout
purpose: Set or fetch imap timeout
manual_id: function.imap-timeout
version: PHP 4 >= 4.3.3, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   If the <code class="parameter">timeout</code> parameter is set, this function
   returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   If <code class="parameter">timeout</code>  is not provided or evaluates to -1,
   the current timeout value of <code class="parameter">timeout_type</code> is
   returned as an integer.
  </p>


name: imap_utf7_decode
purpose: Decodes a modified UTF-7 encoded string
manual_id: function.imap-utf7-decode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string that is encoded in ISO-8859-1 and consists of the same
   sequence of characters in <code class="parameter">string</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if <code class="parameter">string</code> contains invalid modified UTF-7 sequence
   or <code class="parameter">string</code> contains a character that is not part of
   ISO-8859-1 character set.
  </p>


name: imap_utf7_encode
purpose: Converts ISO-8859-1 string to modified UTF-7 text
manual_id: function.imap-utf7-encode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns <code class="parameter">string</code> encoded with the modified UTF-7
   encoding as defined in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC 2060</a>, 
   section 5.1.3.
  </p>


name: imap_utf8_to_mutf7
purpose: Encode a UTF-8 string to modified UTF-7
manual_id: function.imap-utf8-to-mutf7
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <code class="parameter">string</code> converted to modified UTF-7,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mail
purpose: Send mail
manual_id: function.mail
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the mail was successfully accepted for delivery, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">
   It is important to note that just because the mail was accepted for delivery,
   it does NOT mean the mail will actually reach the intended destination.
  </p>


name: mailparse_determine_best_xfer_encoding
purpose: Gets the best way of encoding
manual_id: function.mailparse-determine-best-xfer-encoding
version: PECL mailparse >= 0.9.0
return_type: string
return_description:
<p class="para">
   Returns one of the character encodings supported by the
   <a href="ref.mbstring.html" class="link">mbstring</a> module.
  </p>


name: mailparse_msg_extract_part_file
purpose: Extracts/decodes a message section
manual_id: function.mailparse-msg-extract-part-file
version: PECL mailparse >= 0.9.0
return_type: string
return_description:
<p class="para">
   If <code class="parameter">callbackfunc</code> is not <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on
   success.
  </p>
  <p class="para">
   If <code class="parameter">callbackfunc</code> is set to <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, returns the
   extracted section as a string.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: mailparse_msg_parse_file
purpose: Parses a file
manual_id: function.mailparse-msg-parse-file
version: PECL mailparse >= 0.9.0
return_type: resource
return_description:
<p class="para">
   Returns a <code class="literal">MIME</code> resource representing the structure, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: mailparse_rfc822_parse_addresses
purpose: Parse RFC 822 compliant addresses
manual_id: function.mailparse-rfc822-parse-addresses
version: PECL mailparse >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns an array of associative arrays with the following keys for each
   recipient:
   <table class="doctable informaltable">
    
     <tbody class="tbody">
      <tr>
       <td><code class="literal">display</code></td>
       <td>
        The recipient name, for display purpose. If this part is not set for a
        recipient, this key will hold the same value as 
        <code class="literal">address</code>.
       </td>
      </tr>

      <tr>
       <td><code class="literal">address</code></td>
       <td>The email address</td>
      </tr>

      <tr>
       <td><code class="literal">is_group</code></td>
       <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the recipient is a newsgroup, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: mailparse_uudecode_all
purpose: Scans the data from fp and extract each embedded uuencoded file
manual_id: function.mailparse-uudecode-all
version: PECL mailparse >= 0.9.0
return_type: array
return_description:
<p class="para">
   Returns an array of associative arrays listing filename information.
   <table class="doctable informaltable">
    
     <tbody class="tbody">
      <tr>
       <td><code class="literal">filename</code></td>
       <td>Path to the temporary file name created</td>
      </tr>

      <tr>
       <td><code class="literal">origfilename</code></td>
       <td>The original filename, for uuencoded parts only</td>
      </tr>

     </tbody>
    
   </table>

   The first filename entry is the message body. The next entries are the
   decoded uuencoded files.
  </p>


name: bccomp
purpose: Compare two arbitrary precision numbers
manual_id: function.bccomp
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 0 if the two operands are equal, 1 if the
   <code class="parameter">num1</code> is larger than the 
   <code class="parameter">num2</code>, -1 otherwise.
  </p>


name: bcdiv
purpose: Divide two arbitrary precision numbers
manual_id: function.bcdiv
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the result of the division as a string, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if 
   <code class="parameter">num2</code> is <code class="literal">0</code>.
  </p>


name: bcmod
purpose: Get modulus of an arbitrary precision number
manual_id: function.bcmod
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the modulus as a string, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if 
   <code class="parameter">num2</code> is <code class="literal">0</code>.
  </p>


name: bcpowmod
purpose: Raise an arbitrary precision number to another, reduced by a specified modulus
manual_id: function.bcpowmod
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the result as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">modulus</code>
   is <code class="literal">0</code> or <code class="parameter">exponent</code> is negative.
  </p>


name: bcscale
purpose: Set or get default scale parameter for all bc math functions
manual_id: function.bcscale
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the old scale when used as setter. Otherwise the current scale is returned.
  </p>


name: bcsqrt
purpose: Get the square root of an arbitrary precision number
manual_id: function.bcsqrt
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> Returns the square root as a well-formed BCMath numeric string. </p>
errors:
<p class="para">
   This function throws a <span class="classname">ValueError</span> in the following cases:
   <ul class="simplelist">
    <li><code class="parameter">num</code> is not a well-formed BCMath numeric string</li>
    <li><code class="parameter">num</code> is less than <code class="literal">0</code></li>
    <li><code class="parameter">scale</code> is outside the valid range</li>
   </ul>
  </p>


name: gmp_abs
purpose: Absolute value
manual_id: function.gmp-abs
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   Returns the absolute value of <code class="parameter">num</code>, as a GMP number.
  </p>


name: gmp_and
purpose: Bitwise AND
manual_id: function.gmp-and
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   A GMP number representing the bitwise <code class="literal">AND</code> comparison.
  </p>


name: gmp_binomial
purpose: Calculates binomial coefficient
manual_id: function.gmp-binomial
version: PHP 7 >= 7.3.0, PHP 8
return_type: GMP
return_description: <p class="para"> Returns the binomial coefficient C(n, k). </p>
errors:
<p class="para">
   Throws <span class="classname">ValueError</span> if <code class="parameter">k</code> is negative.
   Prior to PHP 8.0.0, <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was issued instead.
  </p>


name: gmp_cmp
purpose: Compare numbers
manual_id: function.gmp-cmp
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns a positive value if <code class="literal">a &gt; b</code>, zero if
   <code class="literal">a = b</code> and a negative value if <code class="literal">a &lt;
   b</code>.
  </p>


name: gmp_com
purpose: Calculates one's complement
manual_id: function.gmp-com
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   Returns the one&#039;s complement of <code class="parameter">num</code>, as a GMP number.
  </p>


name: gmp_div_qr
purpose: Divide numbers and get quotient and remainder
manual_id: function.gmp-div-qr
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span>, with the first
   element being <code class="literal">[n/d]</code> (the integer result of the
   division) and the second being <code class="literal">(n - [n/d] * d)</code>
   (the remainder of the division).
  </p>


name: gmp_gcd
purpose: Calculate GCD
manual_id: function.gmp-gcd
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   A positive GMP number that divides into both
   <code class="parameter">num1</code> and <code class="parameter">num2</code>.
  </p>


name: gmp_hamdist
purpose: Hamming distance
manual_id: function.gmp-hamdist
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The hamming distance between <code class="parameter">num1</code> and <code class="parameter">num2</code>, as an <span class="type">int</span>.
  </p>


name: gmp_intval
purpose: Convert GMP number to integer
manual_id: function.gmp-intval
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The <span class="type">int</span> value of <code class="parameter">num</code>.
  </p>


name: gmp_invert
purpose: Inverse by modulo
manual_id: function.gmp-invert
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A GMP number on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an inverse does not exist.
  </p>


name: gmp_kronecker
purpose: Kronecker symbol
manual_id: function.gmp-kronecker
version: PHP 7 >= 7.3.0, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the Kronecker symbol of <code class="parameter">num1</code> and
   <code class="parameter">num2</code>
  </p>


name: gmp_nextprime
purpose: Find next prime number
manual_id: function.gmp-nextprime
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   Return the next prime number greater than <code class="parameter">num</code>,
   as a GMP number.
  </p>


name: gmp_perfect_power
purpose: Perfect power check
manual_id: function.gmp-perfect-power
version: PHP 7 >= 7.3.0, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">num</code> is a perfect power, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: gmp_perfect_square
purpose: Perfect square check
manual_id: function.gmp-perfect-square
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">num</code> is a perfect square,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: gmp_popcount
purpose: Population count
manual_id: function.gmp-popcount
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The population count of <code class="parameter">num</code>, as an <span class="type">int</span>.
  </p>


name: gmp_pow
purpose: Raise number into power
manual_id: function.gmp-pow
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   The new (raised) number, as a GMP number. The case of 
   <code class="literal">0^0</code> yields 1.
  </p>


name: gmp_prob_prime
purpose: Check if number is "probably prime"
manual_id: function.gmp-prob-prime
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   If this function returns 0, <code class="parameter">num</code> is
   definitely not prime. If it returns 1, then
   <code class="parameter">num</code> is &quot;probably&quot; prime.  If it returns 2,
   then <code class="parameter">num</code> is surely prime. 
  </p>


name: gmp_random_bits
purpose: Random number
manual_id: function.gmp-random-bits
version: PHP 5 >= 5.6.3, PHP 7, PHP 8
return_type: GMP
return_description: <p class="para"> A random GMP number. </p>
errors:
<p class="para">
   If <code class="parameter">bits</code> is less than <code class="literal">1</code>,
   a <span class="exceptionname">ValueError</span> will be thrown.
  </p>


name: gmp_random_range
purpose: Get a uniformly selected integer
manual_id: function.gmp-random-range
version: PHP 5 >= 5.6.3, PHP 7, PHP 8
return_type: GMP
return_description:
<p class="para">
   Returns a <span class="classname">GMP</span> object which contains
   a uniformly selected integer from the closed interval
   [<code class="parameter">min</code>, <code class="parameter">max</code>]. Both
   <code class="parameter">min</code> and <code class="parameter">max</code> are
   possible return values.
  </p>

errors:
<p class="para">
   If <code class="parameter">max</code> is less than <code class="parameter">min</code>,
   a <span class="exceptionname">ValueError</span> will be thrown.
  </p>


name: gmp_random_seed
purpose: Sets the RNG seed
manual_id: function.gmp-random-seed
version: PHP 7, PHP 8
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">seed</code>
   is invalid.
  </p>


name: gmp_rootrem
purpose: Take the integer part and remainder of nth root
manual_id: function.gmp-rootrem
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   A two element array, where the first element is the integer component of
   the root, and the second element is the remainder, both represented as GMP
   numbers.
  </p>


name: gmp_scan0
purpose: Scan for 0
manual_id: function.gmp-scan0
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the index of the found bit, as an <span class="type">int</span>. The
   index starts from 0.
  </p>


name: gmp_scan1
purpose: Scan for 1
manual_id: function.gmp-scan1
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the index of the found bit, as an <span class="type">int</span>.
   If no set bit is found, -1 is returned.
  </p>


name: gmp_sign
purpose: Sign of number
manual_id: function.gmp-sign
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns 1 if <code class="parameter">num</code> is positive,
   -1 if <code class="parameter">num</code> is negative,
   and 0 if <code class="parameter">num</code> is zero.
  </p>


name: gmp_sqrtrem
purpose: Square root with remainder
manual_id: function.gmp-sqrtrem
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns array where first element is the integer square root of
   <code class="parameter">num</code> and the second is the remainder
   (i.e., the difference between <code class="parameter">num</code> and the
   first element squared).
  </p>


name: gmp_testbit
purpose: Tests if a bit is set
manual_id: function.gmp-testbit
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the bit is set in <code class="parameter">num</code>, 
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>

errors:
<p class="para">
   An <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is issued when 
   <code class="parameter">index</code> is less than zero, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned.
  </p>


name: abs
purpose: Absolute value
manual_id: function.abs
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The absolute value of <code class="parameter">num</code>. If the
   argument <code class="parameter">num</code> is
   of type <span class="type">float</span>, the return type is also <span class="type">float</span>,
   otherwise it is <span class="type">int</span> (as <span class="type">float</span> usually has a
   bigger value range than <span class="type">int</span>).
  </p>


name: atan2
purpose: Arc tangent of two variables
manual_id: function.atan2
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The arc tangent of <code class="parameter">y</code>/<code class="parameter">x</code> 
   in radians.
  </p>


name: base_convert
purpose: Convert a number between arbitrary bases
manual_id: function.base-convert
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   <code class="parameter">num</code> converted to base <code class="parameter">to_base</code>
  </p>


name: ceil
purpose: Round fractions up
manual_id: function.ceil
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   <code class="parameter">num</code> rounded up to the next highest
   integer.
   The return value of <span class="function">ceil</span> is still of type
   <span class="type">float</span> as the value range of <span class="type">float</span> is 
   usually bigger than that of <span class="type">int</span>.
  </p>


name: expm1
manual_id: function.expm1
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: float
purpose:
Returns exp($num) - 1, computed in a way that is accurate even   when the value of number is close to zero

return_description:
<p class="para">
   <code class="literal">e</code> to the power of <code class="parameter">num</code>, minus one.
  </p>


name: fdiv
purpose: Divides two numbers, according to IEEE 754
manual_id: function.fdiv
version: PHP 8
return_type: float
return_description:
<p class="para">
   The floating point result of
   <code class="parameter">num1</code>/<code class="parameter">num2</code>
  </p>


name: floor
purpose: Round fractions down
manual_id: function.floor
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   <code class="parameter">num</code> rounded to the next lowest integer.
   The return value of <span class="function">floor</span> is still of type
   <span class="type">float</span>.
  </p>


name: fmod
purpose: Returns the floating point remainder (modulo) of the division of the arguments
manual_id: function.fmod
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The floating point remainder of 
   <code class="parameter">num1</code>/<code class="parameter">num2</code>
  </p>


name: intdiv
purpose: Integer division
manual_id: function.intdiv
version: PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The integer quotient of the division of <code class="parameter">num1</code> by <code class="parameter">num2</code>.
  </p>

errors:
<p class="para">
    If <code class="parameter">num2</code> is <code class="literal">0</code>, a <span class="classname">DivisionByZeroError</span>
    exception is thrown. If the <code class="parameter">num1</code> is <strong><code><a href="reserved.constants.html#constant.php-int-min">PHP_INT_MIN</a></code></strong>
    and the <code class="parameter">num2</code> is <code class="literal">-1</code>, then an
    <span class="classname">ArithmeticError</span> exception is thrown.
  </p>


name: is_finite
purpose: Checks whether a float is finite
manual_id: function.is-finite
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">num</code> is none of <strong><code><a href="math.constants.html#constant.nan">NAN</a></code></strong>,
   <strong><code><a href="math.constants.html#constant.inf">INF</a></code></strong>, -<strong><code><a href="math.constants.html#constant.inf">INF</a></code></strong>, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: is_infinite
purpose: Checks whether a float is infinite
manual_id: function.is-infinite
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">num</code> is either <strong><code><a href="math.constants.html#constant.inf">INF</a></code></strong>
   or -<strong><code><a href="math.constants.html#constant.inf">INF</a></code></strong>, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: is_nan
purpose: Checks whether a float is NAN
manual_id: function.is-nan
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">num</code> is <strong><code><a href="math.constants.html#constant.nan">NAN</a></code></strong>, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: log1p
manual_id: function.log1p
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: float
return_description: <p class="para"> log(1 + <code class="parameter">num</code>) </p>
purpose:
Returns log(1 + number), computed in a way that is accurate even when   the value of number is close to zero


name: log
purpose: Natural logarithm
manual_id: function.log
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The logarithm of <code class="parameter">num</code> to 
   <code class="parameter">base</code>, if given, or the
   natural logarithm.  
  </p>


name: max
purpose: Find highest value
manual_id: function.max
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <span class="function">max</span> returns the parameter value considered &quot;highest&quot; according to standard
   comparisons. If multiple values of different types evaluate as equal (e.g. <code class="literal">0</code>
   and <code class="literal">&#039;abc&#039;</code>) the first provided to the function will be returned.
  </p>

errors:
<p class="para">
   If an empty array is passed, <span class="function">max</span> throws a <span class="classname">ValueError</span>.
  </p>


name: min
purpose: Find lowest value
manual_id: function.min
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   <span class="function">min</span> returns the parameter value considered &quot;lowest&quot; according to standard
   comparisons. If multiple values of different types evaluate as equal (e.g. <code class="literal">0</code>
   and <code class="literal">&#039;abc&#039;</code>) the first provided to the function will be returned.
  </p>

errors:
<p class="para">
   If an empty array is passed, <span class="function">min</span> throws a <span class="classname">ValueError</span>.
  </p>


name: octdec
purpose: Octal to decimal
manual_id: function.octdec
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The decimal representation of <code class="parameter">octal_string</code>
  </p>


name: pow
purpose: Exponential expression
manual_id: function.pow
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   <code class="parameter">num</code> raised to the power of <code class="parameter">exponent</code>.
   If both arguments are non-negative integers and the result can be represented
   as an integer, the result will be returned with <span class="type">int</span> type,
   otherwise it will be returned as a <span class="type">float</span>.
  </p>


name: round
purpose: Rounds a float
manual_id: function.round
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The value rounded to the given <code class="parameter">precision</code> as a <span class="type">float</span>.
  </p>


name: sqrt
purpose: Square root
manual_id: function.sqrt
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   The square root of <code class="parameter">num</code>
   or the special value <strong><code><a href="math.constants.html#constant.nan">NAN</a></code></strong> for negative numbers.
  </p>


name: stats_absolute_deviation
purpose: Returns the absolute deviation of an array of values
manual_id: function.stats-absolute-deviation
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the absolute deviation of the values in <code class="parameter">a</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">a</code> is empty or is not an array.
  </p>


name: stats_cdf_beta
purpose: Calculates any one parameter of the beta distribution given values for the others
manual_id: function.stats-cdf-beta
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, alpha, or beta, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_binomial
purpose: Calculates any one parameter of the binomial distribution given values for the others
manual_id: function.stats-cdf-binomial
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, n, or p, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_cauchy
purpose: Calculates any one parameter of the Cauchy distribution given values for the others
manual_id: function.stats-cdf-cauchy
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, x0, or gamma, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_chisquare
purpose: Calculates any one parameter of the chi-square distribution given values for the others
manual_id: function.stats-cdf-chisquare
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, or k, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_exponential
purpose: Calculates any one parameter of the exponential distribution given values for the others
manual_id: function.stats-cdf-exponential
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, or lambda, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_f
purpose: Calculates any one parameter of the F distribution given values for the others
manual_id: function.stats-cdf-f
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, d1, or d2, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_gamma
purpose: Calculates any one parameter of the gamma distribution given values for the others
manual_id: function.stats-cdf-gamma
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, k, or theta, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_laplace
purpose: Calculates any one parameter of the Laplace distribution given values for the others
manual_id: function.stats-cdf-laplace
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, mu, or b, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_logistic
purpose: Calculates any one parameter of the logistic distribution given values for the others
manual_id: function.stats-cdf-logistic
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, mu, or s, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_negative_binomial
purpose: Calculates any one parameter of the negative binomial distribution given values for the others
manual_id: function.stats-cdf-negative-binomial
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, r, or p, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_noncentral_chisquare
purpose: Calculates any one parameter of the non-central chi-square distribution given values for the others
manual_id: function.stats-cdf-noncentral-chisquare
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, k, or lambda, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_noncentral_f
purpose: Calculates any one parameter of the non-central F distribution given values for the others
manual_id: function.stats-cdf-noncentral-f
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, nu1, nu2, or lambda, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_noncentral_t
purpose: Calculates any one parameter of the non-central t-distribution give values for the others
manual_id: function.stats-cdf-noncentral-t
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, nu, or mu, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_normal
purpose: Calculates any one parameter of the normal distribution given values for the others
manual_id: function.stats-cdf-normal
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, mu, or sigma, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_t
purpose: Calculates any one parameter of the t-distribution given values for the others
manual_id: function.stats-cdf-t
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, or nu, determined by <code class="parameter">which</code>.
  </p>


name: stats_cdf_uniform
purpose: Calculates any one parameter of the uniform distribution given values for the others
manual_id: function.stats-cdf-uniform
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns CDF, x, a, or b, determined by <code class="parameter">which</code>.
  </p>


name: stats_covariance
purpose: Computes the covariance of two data sets
manual_id: function.stats-covariance
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the covariance of <code class="parameter">a</code> and <code class="parameter">b</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stats_dens_beta
purpose: Probability density function of the beta distribution
manual_id: function.stats-dens-beta
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   The probability density at <code class="parameter">x</code> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for failure.
  </p>


name: stats_dens_pmf_binomial
purpose: Probability mass function of the binomial distribution
manual_id: function.stats-dens-pmf-binomial
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   The probability mass at <code class="parameter">x</code> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for failure.
  </p>


name: stats_dens_pmf_hypergeometric
purpose: Probability mass function of the hypergeometric distribution
manual_id: function.stats-dens-pmf-hypergeometric
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   The probability mass at <code class="parameter">n1</code> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for failure.
  </p>


name: stats_harmonic_mean
purpose: Returns the harmonic mean of an array of values
manual_id: function.stats-harmonic-mean
version: PECL stats >= 1.0.0
return_type: number
return_description:
<p class="para">
   Returns the harmonic mean of the values in <code class="parameter">a</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">a</code> is empty or is not an array.
  </p>


name: stats_kurtosis
purpose: Computes the kurtosis of the data in the array
manual_id: function.stats-kurtosis
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the kurtosis of the values in <code class="parameter">a</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">a</code> is empty or is not an array.
  </p>


name: stats_skew
purpose: Computes the skewness of the data in the array
manual_id: function.stats-skew
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the skewness of the values in <code class="parameter">a</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">a</code> is empty or is not an array.
  </p>


name: stats_standard_deviation
purpose: Returns the standard deviation
manual_id: function.stats-standard-deviation
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the standard deviation on success; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   Raises an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> when there are fewer than 2 
   values in <code class="parameter">a</code>.
  </p>


name: stats_stat_correlation
purpose: Returns the Pearson correlation coefficient of two data sets
manual_id: function.stats-stat-correlation
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the Pearson correlation coefficient between <code class="parameter">arr1</code> and <code class="parameter">arr2</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stats_stat_independent_t
purpose: Returns the t-value from the independent two-sample t-test
manual_id: function.stats-stat-independent-t
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the t-value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if failure.
  </p>


name: stats_stat_innerproduct
purpose: Returns the inner product of two vectors
manual_id: function.stats-stat-innerproduct
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the inner product of <code class="parameter">arr1</code> and <code class="parameter">arr2</code>,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: stats_variance
purpose: Returns the variance
manual_id: function.stats-variance
version: PECL stats >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the variance on success; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: trader_errno
purpose: Get error code
manual_id: function.trader-errno
version: PECL trader >= 0.3.0
return_type: int
return_description:
<p class="para">Returns the error code identified by one of the <a href="trader.constants.html" class="link">TRADER_ERR_*</a> constants.</p>


name: trader_get_compat
purpose: Get compatibility mode
manual_id: function.trader-get-compat
version: PECL trader >= 0.2.2
return_type: int
return_description:
<p class="para">Returns the compatibility mode id which can be identified by <a href="trader.constants.html" class="link">TRADER_COMPATIBILITY_*</a> series of constants.
  </p>


name: fdf_create
purpose: Create a new FDF document
manual_id: function.fdf-create
version: PHP 4, PHP 5 < 5.3.0, PECL fdf SVN
return_type: resource
return_description:
<p class="para">
   Returns a FDF document handle, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fdf_error
purpose: Return error description for FDF error code
manual_id: function.fdf-error
version: PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
return_type: string
return_description:
<p class="para">
   Returns the error message as a string, or the string 
   <code class="literal">no error</code> if nothing went wrong.
  </p>


name: fdf_get_attachment
purpose: Extracts uploaded file embedded in the FDF
manual_id: function.fdf-get-attachment
version: PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
return_type: array
return_description:
<p class="para">
   The returned array contains the following fields:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara"><code class="parameter">path</code> - path were the file got stored</span>
    </li>
    <li class="listitem">
     <span class="simpara"><code class="parameter">size</code> - size of the stored file in bytes</span>
    </li>
    <li class="listitem">
     <span class="simpara"><code class="parameter">type</code> - mimetype if given in the FDF</span>
    </li>
   </ul>
  </p>


name: fdf_get_encoding
purpose: Get the value of the /Encoding key
manual_id: function.fdf-get-encoding
version: PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
return_type: string
return_description:
<p class="para">
   Returns the encoding as a string. An empty string is returned if the
   default <code class="literal">PDFDocEncoding/Unicode</code> scheme is used.
  </p>


name: fdf_get_version
purpose: Gets version number for FDF API or file
manual_id: function.fdf-get-version
version: PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
return_type: string
return_description:
<p class="para">
   Returns the version as a string. For the current FDF toolkit 5.0 the API
   version number is <code class="literal">5.0</code> and the document version number
   is either <code class="literal">1.2</code>, <code class="literal">1.3</code> or 
   <code class="literal">1.4</code>.
  </p>


name: fdf_save_string
purpose: Returns the FDF document as a string
manual_id: function.fdf-save-string
version: PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL fdf SVN
return_type: string
return_description:
<p class="para">
   Returns the document as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: gnupg_decrypt
purpose: Decrypts a given text
manual_id: function.gnupg-decrypt
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   On success, this function returns the decrypted text.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_decryptverify
purpose: Decrypts and verifies a given text
manual_id: function.gnupg-decryptverify
version: PECL gnupg >= 0.2
return_type: false
return_description:
<p class="para">
   On success, this function returns information about the signature and
   fills the <code class="parameter">plaintext</code> parameter with the decrypted text.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_encrypt
purpose: Encrypts a given text
manual_id: function.gnupg-encrypt
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
    On success, this function returns the encrypted text.
    On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_encryptsign
purpose: Encrypts and signs a given text
manual_id: function.gnupg-encryptsign
version: PECL gnupg >= 0.2
return_type: false
return_description:
<p class="para">
   On success, this function returns the encrypted and signed text.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_export
purpose: Exports a key
manual_id: function.gnupg-export
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   On success, this function returns the keydata.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_getengineinfo
purpose: Returns the engine info
manual_id: function.gnupg-getengineinfo
version: PECL gnupg >= 1.5
return_type: array
return_description:
<p class="para">
   Returns an array with engine info consting of <code class="literal">protocol</code>,
   <code class="literal">file_name</code> and <code class="literal">home_dir</code>.
  </p>


name: gnupg_geterror
purpose: Returns the errortext, if a function fails
manual_id: function.gnupg-geterror
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   Returns an errortext, if an error has occurred, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_getprotocol
purpose: Returns the currently active protocol for all operations
manual_id: function.gnupg-getprotocol
version: PECL gnupg >= 0.1
return_type: int
return_description:
<p class="para">
   Returns the currently active protocol, which can be one of
   <strong><code><a href="gnupg.constants.html#constant.gnupg-protocol-openpgp">GNUPG_PROTOCOL_OpenPGP</a></code></strong> or
   <strong><code><a href="gnupg.constants.html#constant.gnupg-protocol-cms">GNUPG_PROTOCOL_CMS</a></code></strong>.
  </p>


name: gnupg_gettrustlist
purpose: Search the trust items
manual_id: function.gnupg-gettrustlist
version: PECL gnupg >= 0.5
return_type: null
return_description:
<p class="para">
   On success, this function returns an array of trust items.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: gnupg_import
purpose: Imports a key
manual_id: function.gnupg-import
version: PECL gnupg >= 0.3
return_type: false
return_description:
<p class="para">
   On success, this function returns and info-array about the importprocess.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_init
purpose: Initialize a connection
manual_id: function.gnupg-init
version: PECL gnupg >= 0.4
return_type: resource
return_description:
<p class="para">
   A GnuPG <span class="type">resource</span> connection used by other GnuPG functions.
  </p>


name: gnupg_keyinfo
purpose: Returns an array with information about all keys that matches the given pattern
manual_id: function.gnupg-keyinfo
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   Returns an array with information about all keys that matches the given
   pattern or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, if an error has occurred.
  </p>


name: gnupg_listsignatures
purpose: List key signatures
manual_id: function.gnupg-listsignatures
version: PECL gnupg >= 0.5
return_type: null
return_description:
<p class="para">
   On success, this function returns an array of key signatures.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: gnupg_sign
purpose: Signs a given text
manual_id: function.gnupg-sign
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   On success, this function returns the signed text or the signature.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: gnupg_verify
purpose: Verifies a signed text
manual_id: function.gnupg-verify
version: PECL gnupg >= 0.1
return_type: false
return_description:
<p class="para">
   On success, this function returns information about the signature.
   On failure, this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: wkhtmltox\PDF\Converter.convert
purpose: Perform PDF conversion
manual_id: wkhtmltox-pdf-converter.convert
version: wkhtmltox >= 0.1.0
return_type: null
return_description:
<p class="para">
   Where the return value is used, it will be populated with the contents of the conversion buffer
  </p>


name: wkhtmltox\Image\Converter.getVersion
purpose: Determine version of Converter
manual_id: wkhtmltox-image-converter.getversion
version: wkhtmltox >= 0.3.2
return_type: string
return_description:
<p class="para">
   Returns a version string
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    This is not yet implemented by libwkhtmltox
   </p>
  </div>


name: ps_add_bookmark
purpose: Add bookmark to current page
manual_id: function.ps-add-bookmark
version: PECL ps >= 1.1.0
return_type: int
return_description:
<p class="para">
   The returned value is a reference for the bookmark. It is only used if
   the bookmark shall be used as a parent. The value is greater zero if
   the function succeeds. In case of an error zero will
   be returned.
  </p>


name: ps_begin_pattern
purpose: Start a new pattern
manual_id: function.ps-begin-pattern
version: PECL ps >= 1.2.0
return_type: false
return_description:
<p class="para">
   The identifier of the pattern  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ps_close_image
purpose: Closes image and frees memory
manual_id: function.ps-close-image
version: PECL ps >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ps_findfont
purpose: Loads a font
manual_id: function.ps-findfont
version: PECL ps >= 1.1.0
return_type: int
return_description:
<p class="para">
   Returns the identifier of the font or zero in case of an error. The
   identifier is a positive number.
  </p>


name: ps_get_parameter
purpose: Gets certain parameters
manual_id: function.ps-get-parameter
version: PECL ps >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the value of the parameter  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ps_get_value
purpose: Gets certain values
manual_id: function.ps-get-value
version: PECL ps >= 1.1.0
return_type: float
return_description:
<p class="para">
   Returns the value of the parameter or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: ps_hyphenate
purpose: Hyphenates a word
manual_id: function.ps-hyphenate
version: PECL ps >= 1.1.1
return_type: false
return_description:
<p class="para">
   An array of integers indicating the position of possible breaks in
   the text  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ps_new
purpose: Creates a new PostScript document object
manual_id: function.ps-new
version: PECL ps >= 1.1.0
return_type: false
return_description:
<p class="para">
   Resource of PostScript document or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. The return value
   is passed to all other functions as the first argument.
  </p>


name: ps_open_image_file
purpose: Opens image from file
manual_id: function.ps-open-image-file
version: PECL ps >= 1.1.0
return_type: int
return_description:
<p class="para">
   Returns identifier of image or zero in case of an error. The identifier is
   a positive number greater than 0.
  </p>


name: ps_shading
purpose: Creates a shading for later use
manual_id: function.ps-shading
version: PECL ps >= 1.3.0
return_type: false
return_description:
<p class="para">
   Returns the identifier of the pattern  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ps_string_geometry
purpose: Gets geometry of a string
manual_id: function.ps-string-geometry
version: PECL ps >= 1.2.0
return_type: array
return_description:
<p class="para">
   An array of the dimensions of a string. The element &#039;width&#039; contains the
   width of the string as returned by <span class="function">ps_stringwidth</span>. The
   element &#039;descender&#039; contains the maximum descender and &#039;ascender&#039; the
   maximum ascender of the string.
  </p>


name: rpmdbinfo
purpose: Get information from installed RPM
manual_id: function.rpmdbinfo
version: PECL rpminfo >= 0.2.0
return_type: null
return_description:
<p class="para">
   An <span class="type">array</span> of <span class="type">array</span> of information or NULL on error.   
  </p>


name: rpmgetsymlink
purpose: Get target of a symlink
manual_id: function.rpmgetsymlink
version: PECL rpminfo >= 1.1.0
return_type: null
return_description:
<p class="para">
   A <span class="type">string</span> with target of the symlink, NULL on error, or an empty string if not a symlink.
  </p>


name: rpmvercmp
purpose: RPM version comparison
manual_id: function.rpmvercmp
version: PECL rpminfo >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns &lt; 0 if evr1 is less than evr2, &gt; 0 if evr1 is greater than evr2, and 0 if they are equal.
  </p>
  <p class="para">
   When using the optional <code class="parameter">operator</code> argument, the
   function will return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the relationship is the one specified
   by the operator, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: eio_busy
purpose: Artificially increase load. Could be useful in tests, benchmarking
manual_id: function.eio-busy
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_busy</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_chmod
purpose: Change file/directory permissions
manual_id: function.eio-chmod
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_chmod</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_chown
purpose: Change file/directory permissions
manual_id: function.eio-chown
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_chown</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_close
purpose: Close file
manual_id: function.eio-close
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_close</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_custom
purpose: Execute custom request like any other eio_* call
manual_id: function.eio-custom
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_custom</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_dup2
purpose: Duplicate a file descriptor
manual_id: function.eio-dup2
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_dup2</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_event_loop
purpose: Polls libeio until all requests proceeded
manual_id: function.eio-event-loop
version: PECL eio >= 0.0.1dev
return_type: bool
return_description:
<p class="para">
   <span class="function">eio_event_loop</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_fallocate
purpose: Allows the caller to directly manipulate the allocated disk space for a file
manual_id: function.eio-fallocate
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_fallocate</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_fchmod
purpose: Change file permissions
manual_id: function.eio-fchmod
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_fchmod</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_fdatasync
purpose: Synchronize a file's in-core state with storage device
manual_id: function.eio-fdatasync
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_fdatasync</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_fstatvfs
purpose: Get file system statistics
manual_id: function.eio-fstatvfs
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_fstatvfs</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_fsync
purpose: Synchronize a file's in-core state with storage device
manual_id: function.eio-fsync
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_fsync</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_ftruncate
purpose: Truncate a file
manual_id: function.eio-ftruncate
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_ftruncate</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_futime
purpose: Change file last access and modification times
manual_id: function.eio-futime
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_futime</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_get_event_stream
purpose: Get stream representing a variable used in internal communications with libeio
manual_id: function.eio-get-event-stream
version: PECL eio >= 0.3.1b
return_type: mixed
return_description:
<p class="para">
   <span class="function">eio_get_event_stream</span> returns stream on success;
   otherwise, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
  </p>


name: eio_get_last_error
purpose: Returns string describing the last error associated with a request resource
manual_id: function.eio-get-last-error
version: PECL eio >= 1.0.0
return_type: string
return_description:
<p class="para">
   <span class="function">eio_get_last_error</span> returns string describing the last error associated with the request resource specified by <code class="parameter">req</code>.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em>EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>


name: eio_grp
purpose: Creates a request group
manual_id: function.eio-grp
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_grp</span> returns request group resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_lstat
purpose: Get file status
manual_id: function.eio-lstat
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_lstat</span> returns request resource on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: eio_mkdir
purpose: Create directory
manual_id: function.eio-mkdir
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_mkdir</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_mknod
purpose: Create a special or ordinary file
manual_id: function.eio-mknod
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_mknod</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_nop
purpose: Does nothing, except go through the whole request cycle
manual_id: function.eio-nop
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_nop</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_npending
purpose: Returns number of finished, but unhandled requests
manual_id: function.eio-npending
version: PECL eio >= 0.0.1dev
return_type: int
return_description:
<p class="para">
   <span class="function">eio_npending</span> returns number of finished, but unhandled
   requests.
  </p>


name: eio_nready
purpose: Returns number of not-yet handled requests
manual_id: function.eio-nready
version: PECL eio >= 0.0.1dev
return_type: int
return_description:
<p class="para">
   <span class="function">eio_nready</span> returns number of not-yet handled requests
  </p>


name: eio_nreqs
purpose: Returns number of requests to be processed
manual_id: function.eio-nreqs
version: PECL eio >= 0.0.1dev
return_type: int
return_description:
<p class="para">
   <span class="function">eio_nreqs</span> returns number of requests to be processed.
  </p>


name: eio_nthreads
purpose: Returns number of threads currently in use
manual_id: function.eio-nthreads
version: PECL eio >= 0.0.1dev
return_type: int
return_description:
<p class="para">
   <span class="function">eio_nthreads</span> returns number of threads currently in
   use.
  </p>


name: eio_open
purpose: Opens a file
manual_id: function.eio-open
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_open</span> returns file descriptor in
   <code class="parameter">result</code> argument of <code class="parameter">callback</code>
   on success; otherwise, <code class="parameter">result</code> is equal to <strong><code>-1</code></strong>.
  </p>


name: eio_poll
purpose: Can be to be called whenever there are pending requests that need finishing
manual_id: function.eio-poll
version: PECL eio >= 0.0.1dev
return_type: int
return_description:
<p class="para">
  If any request invocation returns a non-zero value, returns that value.
  Otherwise, it returns <code class="literal">0</code>.
  </p>


name: eio_read
purpose: Read from a file descriptor at given offset
manual_id: function.eio-read
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
  <span class="function">eio_read</span> stores read bytes in
  <code class="parameter">result</code> argument of <code class="parameter">callback</code>
  function.
  </p>


name: eio_readahead
purpose: Perform file readahead into page cache
manual_id: function.eio-readahead
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_readahead</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_readdir
purpose: Reads through a whole directory
manual_id: function.eio-readdir
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_readdir</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. 
   Sets <code class="parameter">result</code> argument of
   <code class="parameter">callback</code> function according to
   <code class="parameter">flags</code>:
  </p>

  <p class="para">
   <dl>

    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-readdir-dents">EIO_READDIR_DENTS</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
       <span class="function">eio_readdir</span> flag. If specified, the result argument of the callback
       becomes an array with the following keys:
       <code class="literal">&#039;names&#039;</code> - array of directory names
       <code class="literal">&#039;dents&#039;</code> - array of <code class="literal">struct
       eio_dirent</code>-like arrays having the following keys each:
       <code class="literal">&#039;name&#039;</code> - the directory name;
       <code class="literal">&#039;type&#039;</code> - one of <em>EIO_DT_*</em>
       constants;
       <code class="literal">&#039;inode&#039;</code> - the inode number, if available, otherwise
       unspecified;
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-readdir-dirs-first">EIO_READDIR_DIRS_FIRST</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      When this flag is specified, the names will be returned in an order
      where likely directories come first, in optimal stat order.
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-readdir-stat-order">EIO_READDIR_STAT_ORDER</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      When this flag is specified, then the names will be returned in an order
      suitable for <code class="literal">stat</code>&#039;ing each one. When planning to
      <span class="function">stat</span> all files in the given directory, the
      returned order will likely be
      fastest.
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-readdir-found-unknown">EIO_READDIR_FOUND_UNKNOWN</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">

      </span>
     </dd>
    


   </dl>
  </p>

  <p class="para">Node types:
   <dl>


    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-unknown">EIO_DT_UNKNOWN</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Unknown node type(very common). Further <span class="function">stat</span> needed.
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-fifo">EIO_DT_FIFO</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      FIFO node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-chr">EIO_DT_CHR</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-mpc">EIO_DT_MPC</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Multiplexed char device (v7+coherent) node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-dir">EIO_DT_DIR</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Directory node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-nam">EIO_DT_NAM</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Xenix special named file node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-blk">EIO_DT_BLK</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-mpb">EIO_DT_MPB</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Multiplexed block device (v7+coherent)
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-reg">EIO_DT_REG</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-nwk">EIO_DT_NWK</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-cmp">EIO_DT_CMP</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      HP-UX network special node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-lnk">EIO_DT_LNK</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Link node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-sock">EIO_DT_SOCK</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Socket node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-door">EIO_DT_DOOR</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Solaris door node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-wht">EIO_DT_WHT</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Node type
      </span>
     </dd>
    
    
     <dt>
      <strong><code><a href="eio.constants.html#constant.eio-dt-max">EIO_DT_MAX</a></code></strong>
      (<span class="type">int</span>)
     </dt>
     <dd>
      <span class="simpara">
      Highest node type value
      </span>
     </dd>
    
 
 
 
   </dl>
  </p>


name: eio_readlink
purpose: Read value of a symbolic link
manual_id: function.eio-readlink
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_readlink</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_rename
purpose: Change the name or location of a file
manual_id: function.eio-rename
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_rename</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_rmdir
purpose: Remove a directory
manual_id: function.eio-rmdir
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_rmdir</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_seek
manual_id: function.eio-seek
version: PECL eio >= 0.5.0b
return_type: resource
purpose:
Repositions the offset of the open file associated with the fd argument to the argument offset according to the directive whence

return_description:
<p class="para">
   <span class="function">eio_seek</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_sendfile
purpose: Transfer data between file descriptors
manual_id: function.eio-sendfile
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_sendfile</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_stat
purpose: Get file status
manual_id: function.eio-stat
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_stat</span> returns request resource on success or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. On success assigns <code class="parameter">result</code> argument of
   <code class="parameter">callback</code> to an array.
  </p>


name: eio_statvfs
purpose: Get file system statistics
manual_id: function.eio-statvfs
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
  <span class="function">eio_statvfs</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. 
   On success assigns <code class="parameter">result</code> argument of
  <code class="parameter">callback</code> to an array.
  </p>


name: eio_symlink
purpose: Create a symbolic link
manual_id: function.eio-symlink
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_symlink</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_sync_file_range
purpose: Sync a file segment with disk
manual_id: function.eio-sync-file-range
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_sync_file_range</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_sync
purpose: Commit buffer cache to disk
manual_id: function.eio-sync
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_sync</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_syncfs
purpose: Calls Linux' syncfs syscall, if available
manual_id: function.eio-syncfs
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_syncfs</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_unlink
purpose: Delete a name and possibly the file it refers to
manual_id: function.eio-unlink
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_unlink</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_utime
purpose: Change file last access and modification times
manual_id: function.eio-utime
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_utime</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: eio_write
purpose: Write to file
manual_id: function.eio-write
version: PECL eio >= 0.0.1dev
return_type: resource
return_description:
<p class="para">
   <span class="function">eio_write</span> returns request resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Ev.backend
purpose: Returns an integer describing the backend used by libev
manual_id: ev.backend
version: PECL ev >= 0.2.0
return_type: int
return_description:
<p class="para">
   Returns an integer(bit mask) describing the backend used by
   <em>libev</em>
   .
  </p>


name: Ev.depth
purpose: Returns recursion depth
manual_id: ev.depth
version: PECL ev >= 0.2.0
return_type: int
return_description:
<p class="para">
   <span class="function">ev_depth</span>
   returns recursion depth of the default loop.
  </p>


name: Ev.embeddableBackends
purpose: Returns the set of backends that are embeddable in other event loops
manual_id: ev.embeddablebackends
version: PECL ev >= 0.2.0
return_type: int
return_description:
<p class="para">
   Returns a bit mask which can containing
   <a href="class.ev.html#ev.constants.watcher-backends" class="link">backend flags</a>
   combined using bitwise
   <em>OR</em>
   operator.
  </p>


name: Ev.now
purpose: Returns the time when the last iteration of the default event loop has started
manual_id: ev.now
version: PECL ev >= 0.2.0
return_type: float
return_description:
<p class="para">
   Returns number of seconds(fractional) representing the time when the last
   iteration of the default event loop has started.
  </p>


name: Ev.nowUpdate
manual_id: ev.nowupdate
version: PECL ev >= 0.2.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
purpose:
Establishes the current time by querying the kernel, updating the time    returned by Ev::now in the progress


name: EvLoop.backend
purpose: Returns an integer describing the backend used by libev
manual_id: evloop.backend
version: PECL ev >= 0.2.0
return_type: int
return_description:
<p class="para">
   Returns an integer describing the backend used by libev. See
    <span class="methodname">Ev::backend</span>
   .
  </p>


name: EvLoop.nowUpdate
manual_id: evloop.nowupdate
version: PECL ev >= 0.2.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
purpose:
Establishes the current time by querying the kernel, updating the time    returned by EvLoop::now in the progress


name: EvPeriodic.at
purpose: Returns the absolute time that this watcher is supposed to trigger next
manual_id: evperiodic.at
version: PECL ev >= 0.2.0
return_type: float
return_description:
<p class="para">
   Returns the absolute time this watcher is supposed to trigger next in
   seconds.
  </p>


name: EvStat.attr
purpose: Returns the values most recently detected by Ev
manual_id: evstat.attr
version: PECL ev >= 0.2.0
return_type: array
return_description:
<p class="para">
   Returns array with the values most recently detect by Ev(without actual
   <code class="literal">stat</code>
   &#039;ing):
   <table class="doctable table">
    <caption><strong>
    List for item keys of the array returned by  <span class="methodname">EvStat::attr</span>
    </strong></caption>
    
     <thead>
      <tr>
       <th>Key</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>
        <code class="literal">&#039;dev&#039;</code>
       </td>
       <td>ID of device containing file</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;ino&#039;</code>
       </td>
       <td>inode number</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;mode&#039;</code>
       </td>
       <td>protection</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;nlink&#039;</code>
       </td>
       <td>number of hard links</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;uid&#039;</code>
       </td>
       <td>user ID of owner</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;size&#039;</code>
       </td>
       <td>total size, in bytes</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;gid&#039;</code>
       </td>
       <td>group ID of owner</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;rdev&#039;</code>
       </td>
       <td>device ID (if special file)</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;blksize&#039;</code>
       </td>
       <td>blocksize for file system I/O</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;blocks&#039;</code>
       </td>
       <td>number of 512B blocks allocated</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;atime&#039;</code>
       </td>
       <td>time of last access</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;ctime&#039;</code>
       </td>
       <td>time of last status change</td>
      </tr>

      <tr>
       <td>
        <code class="literal">&#039;mtime&#039;</code>
       </td>
       <td>time of last modification</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   See
   <code class="literal">stat(2)</code>
   man page for details.
  </p>


name: EvStat.prev
purpose: Returns the previous set of values returned by EvStat::attr
manual_id: evstat.prev
version: PECL ev >= 0.2.0
return_type: void
return_description:
<p class="para">
   Returns an array with the same structure as the array returned by
    <span class="methodname">EvStat::attr</span>
   . The array contains previously detected values.
  </p>


name: EvStat.stat
purpose: Initiates the stat call
manual_id: evstat.stat
version: PECL ev >= 0.2.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   <var class="varname">path</var>
   exists. Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: EvWatcher.clear
purpose: Clear watcher pending status
manual_id: evwatcher.clear
version: PECL ev >= 0.2.0
return_type: int
return_description:
<p class="para">
   In case if the watcher is pending, returns
   <var class="varname">revents</var>
   bitset as if the
   <a href="ev.watcher-callbacks.html" class="link">watcher callback</a>
   had been invoked. Otherwise returns
   <code class="literal">0</code>
   .
  </p>


name: EvWatcher.getLoop
purpose: Returns the loop responsible for the watcher
manual_id: evwatcher.getloop
version: PECL ev >= 0.2.0
return_type: EvLoop
return_description:
<p class="para">
   Returns
   <span class="classname">EvLoop</span>
   event loop object responsible for the watcher.
  </p>


name: expect_expectl
manual_id: function.expect-expectl
version: PECL expect >= 0.1.0
return_type: int
purpose:
Waits until the output from a process matches one  of the patterns, a specified time period has passed, or an EOF is seen

return_description:
<p class="para">
   Returns value associated with the pattern that was matched.
  </p>
  <p class="para">
   On failure this function returns:
   <a href="expect.constants.html#constant.exp-eof" class="link"><strong><code><a href="expect.constants.html#constant.exp-eof">EXP_EOF</a></code></strong></a>,
   <a href="expect.constants.html#constant.exp-timeout" class="link"><strong><code><a href="expect.constants.html#constant.exp-timeout">EXP_TIMEOUT</a></code></strong></a>
   or
   <a href="expect.constants.html#constant.exp-fullbuffer" class="link"><strong><code><a href="expect.constants.html#constant.exp-fullbuffer">EXP_FULLBUFFER</a></code></strong></a>
  </p>


name: expect_popen
purpose: Execute command via Bourne shell, and open the PTY stream to the process
manual_id: function.expect-popen
version: PECL expect >= 0.1.0
return_type: resource
return_description:
<p class="para">
   Returns an open PTY stream to the processes <code class="literal">stdio</code>,
   <code class="literal">stdout</code>, and <code class="literal">stderr</code>.
  </p>
  <p class="para">
   On failure this function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: pcntl_alarm
purpose: Set an alarm clock for delivery of a signal
manual_id: function.pcntl-alarm
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the time in seconds that any previously scheduled alarm had
   remaining before it was to be delivered, or <code class="literal">0</code> if there
   was no previously scheduled alarm.
  </p>


name: pcntl_async_signals
purpose: Enable/disable asynchronous signal handling or return the old setting
manual_id: function.pcntl-async-signals
version: PHP 7 >= 7.1.0, PHP 8
return_type: bool
return_description:
<p class="para">
   When used as getter (<code class="parameter">enable</code> parameter is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>) it returns
   whether asynchronous signal handling is enabled. When used as setter (<code class="parameter">enable</code>
   parameter is not <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>), it returns whether asynchronous signal
   handling was enabled <em>before</em> the function call.
  </p>


name: pcntl_fork
purpose: Forks the currently running process
manual_id: function.pcntl-fork
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   On success, the PID of the child process is returned in the
   parent&#039;s thread of execution, and a 0 is returned in the child&#039;s
   thread of execution.  On failure, a -1 will be returned in the
   parent&#039;s context, no child process will be created, and a PHP
   error is raised.
  </p>


name: pcntl_getpriority
purpose: Get the priority of any process
manual_id: function.pcntl-getpriority
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">pcntl_getpriority</span> returns the priority of the process
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.  A lower numerical value causes more favorable
   scheduling.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: pcntl_rfork
purpose: Manipulates process resources
manual_id: function.pcntl-rfork
version: PHP 8 >= 8.1.0
return_type: int
return_description:
<p class="para">
   On success, the PID of the child process is returned in the
   parent&#039;s thread of execution, and a <code class="literal">0</code> is returned in the child&#039;s
   thread of execution. 
   On failure, a <code class="literal">-1</code> will be returned in the
   parent&#039;s context, no child process will be created, and a PHP error is raised.
  </p>


name: pcntl_signal_get_handler
purpose: Get the current handler for specified signal
manual_id: function.pcntl-signal-get-handler
version: PHP 7 >= 7.1.0, PHP 8
return_type: int
return_description:
<p class="para">
   This function may return an integer value that refers to <strong><code><a href="pcntl.constants.html#constant.sig-dfl">SIG_DFL</a></code></strong> or <strong><code><a href="pcntl.constants.html#constant.sig-ign">SIG_IGN</a></code></strong>.
   If a custom handler has been set, that <span class="type">callable</span> is returned.
  </p>


name: pcntl_sigtimedwait
purpose: Waits for signals, with a timeout
manual_id: function.pcntl-sigtimedwait
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">pcntl_sigtimedwait</span> returns a signal number on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pcntl_sigwaitinfo
purpose: Waits for signals
manual_id: function.pcntl-sigwaitinfo
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a signal number on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pcntl_unshare
purpose: Dissociates parts of the process execution context
manual_id: function.pcntl-unshare
version: PHP 7 >= 7.4.0, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <code class="literal">0</code> on success, <code class="literal">-1</code> otherwise.
   On failure it sets an error code, that can be retrieved with <span class="function">pcntl_get_last_error</span>.
  </p>


name: pcntl_wait
purpose: Waits on or returns the status of a forked child
manual_id: function.pcntl-wait
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   <span class="function">pcntl_wait</span> returns the process ID of the
   child which exited, -1 on error or zero if WNOHANG was provided as an
   option (on wait3-available systems) and no child was available.
  </p>


name: pcntl_waitpid
purpose: Waits on or returns the status of a forked child
manual_id: function.pcntl-waitpid
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   <span class="function">pcntl_waitpid</span> returns the process ID of the
   child which exited, -1 on error or zero if <strong><code><a href="pcntl.constants.html#constant.wnohang">WNOHANG</a></code></strong> was used and no
   child was available
  </p>


name: pcntl_wexitstatus
purpose: Returns the return code of a terminated child
manual_id: function.pcntl-wexitstatus
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the return code.
   If the functionality is not supported by the OS, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: pcntl_wifexited
purpose: Checks if status code represents a normal exit
manual_id: function.pcntl-wifexited
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the child status code represents a normal exit, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: pcntl_wifsignaled
purpose: Checks whether the status code represents a termination due to a signal
manual_id: function.pcntl-wifsignaled
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the child process exited because of a signal which was
   not caught, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: pcntl_wifstopped
purpose: Checks whether the child process is currently stopped
manual_id: function.pcntl-wifstopped
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the child process which caused the return is
   currently stopped, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: pcntl_wstopsig
purpose: Returns the signal which caused the child to stop
manual_id: function.pcntl-wstopsig
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the signal number.
   If the functionality is not supported by the OS, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: posix_ctermid
purpose: Get path name of controlling terminal
manual_id: function.posix-ctermid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Upon successful completion, returns <span class="type">string</span> of the pathname to 
   the current controlling terminal.  Otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned and errno
   is set, which can be checked with <span class="function">posix_get_last_error</span>.
  </p>


name: posix_fpathconf
purpose: Returns the value of a configurable limit
manual_id: function.posix-fpathconf
version: PHP 8 >= 8.3.0
return_type: false
return_description:
<p class="para">
   Returns the configurable limit or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>

errors:
<p class="para">
   Throws a <span class="classname">ValueError</span>
   when <code class="parameter">resource</code> is invalid.
  </p>


name: posix_get_last_error
purpose: Retrieve the error number set by the last posix function that failed
manual_id: function.posix-get-last-error
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the errno (error number) set by the last posix function that
   failed.  If no errors exist, 0 is returned. 
  </p>


name: posix_getcwd
purpose: Pathname of current directory
manual_id: function.posix-getcwd
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="type">string</span> of the absolute pathname on success.  
   On error, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and sets errno which can be checked with
   <span class="function">posix_get_last_error</span>.
  </p>


name: posix_getgrgid
purpose: Return info about a group by group id
manual_id: function.posix-getgrgid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The array elements returned are:
   <table class="doctable table">
    <caption><strong>The group information array</strong></caption>
    
     <thead>
      <tr>
       <th>Element</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>name</td>
       <td>
        The name element contains the name of the group. This is
        a short, usually less than 16 character &quot;handle&quot; of the
        group, not the real, full name.
       </td>
      </tr>

      <tr>
       <td>passwd</td>
       <td>
        The passwd element contains the group&#039;s password in an
        encrypted format. Often, for example on a system employing
        &quot;shadow&quot; passwords, an asterisk is returned instead.
       </td>
      </tr>

      <tr>
       <td>gid</td>
       <td>
        Group ID, should be the same as the
        <code class="parameter">group_id</code> parameter used when calling the
        function, and hence redundant.
       </td>
      </tr>

      <tr>
       <td>members</td>
       <td>
        This consists of an <span class="type">array</span> of
        <span class="type">string</span>&#039;s for all the members in the group.
       </td>
      </tr>

     </tbody>
    
   </table>

   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_getgrnam
purpose: Return info about a group by name
manual_id: function.posix-getgrnam
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">array</span> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The array elements returned are:
   <table class="doctable table">
    <caption><strong>The group information array</strong></caption>
    
     <thead>
      <tr>
       <th>Element</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>name</td>
       <td>
        The name element contains the name of the group. This is
        a short, usually less than 16 character &quot;handle&quot; of the
        group, not the real, full name.  This should be the same as
        the <code class="parameter">name</code> parameter used when
        calling the function, and hence redundant.
       </td>
      </tr>

      <tr>
       <td>passwd</td>
       <td>
        The passwd element contains the group&#039;s password in an
        encrypted format. Often, for example on a system employing
        &quot;shadow&quot; passwords, an asterisk is returned instead.
       </td>
      </tr>

      <tr>
       <td>gid</td>
       <td>
        Group ID of the group in numeric form.
       </td>
      </tr>

      <tr>
       <td>members</td>
       <td>
        This consists of an <span class="type">array</span> of
        <span class="type">string</span>&#039;s for all the members in the group.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: posix_getgroups
purpose: Return the group set of the current process
manual_id: function.posix-getgroups
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array of integers containing the numeric group ids of the group
   set of the current process,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_getlogin
purpose: Return login name
manual_id: function.posix-getlogin
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the login name of the user, as a <span class="type">string</span>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_getpwnam
purpose: Return info about a user by username
manual_id: function.posix-getpwnam
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   On success an array with the following elements is returned, else 
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned:
   <table class="doctable table">
    <caption><strong>The user information array</strong></caption>
    
     <thead>
      <tr>
       <th>Element</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>name</td>
       <td>
        The name element contains the username of the user. This is
        a short, usually less than 16 character &quot;handle&quot; of the
        user, not the real, full name. This should be the same as
        the <code class="parameter">username</code> parameter used when
        calling the function, and hence redundant.
       </td>
      </tr>

      <tr>
       <td>passwd</td>
       <td>
        The passwd element contains the user&#039;s password in an
        encrypted format. Often, for example on a system employing
        &quot;shadow&quot; passwords, an asterisk is returned instead.
       </td>
      </tr>

      <tr>
       <td>uid</td>
       <td>
        User ID of the user in numeric form.
       </td>
      </tr>

      <tr>
       <td>gid</td>
       <td>
        The group ID of the user. Use the function
        <span class="function">posix_getgrgid</span> to resolve the group
        name and a list of its members.
       </td>
      </tr>

      <tr>
       <td>gecos</td>
       <td>
        GECOS is an obsolete term that refers to the finger
        information field on a Honeywell batch processing system.
        The field, however, lives on, and its contents have been
        formalized by POSIX. The field contains a comma separated
        list containing the user&#039;s full name, office phone, office
        number, and home phone number. On most systems, only the
        user&#039;s full name is available.
       </td>
      </tr>

      <tr>
       <td>dir</td>
       <td>
        This element contains the absolute path to the home
        directory of the user.
       </td>
      </tr>

      <tr>
       <td>shell</td>
       <td>
        The shell element contains the absolute path to the
        executable of the user&#039;s default shell.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: posix_getpwuid
purpose: Return info about a user by user id
manual_id: function.posix-getpwuid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array with the following elements:
   <table class="doctable table">
    <caption><strong>The user information array</strong></caption>
    
     <thead>
      <tr>
       <th>Element</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>name</td>
       <td>
        The name element contains the username of the user. This is
        a short, usually less than 16 character &quot;handle&quot; of the
        user, not the real, full name.
       </td>
      </tr>

      <tr>
       <td>passwd</td>
       <td>
        The passwd element contains the user&#039;s password in an
        encrypted format. Often, for example on a system employing
        &quot;shadow&quot; passwords, an asterisk is returned instead.
       </td>
      </tr>

      <tr>
       <td>uid</td>
       <td>
        User ID, should be the same as the
        <code class="parameter">user_id</code> parameter used when calling the
        function, and hence redundant.
       </td>
      </tr>

      <tr>
       <td>gid</td>
       <td>
        The group ID of the user. Use the function
        <span class="function">posix_getgrgid</span> to resolve the group
        name and a list of its members.
       </td>
      </tr>

      <tr>
       <td>gecos</td>
       <td>
        GECOS is an obsolete term that refers to the finger
        information field on a Honeywell batch processing system.
        The field, however, lives on, and its contents have been
        formalized by POSIX. The field contains a comma separated
        list containing the user&#039;s full name, office phone, office
        number, and home phone number. On most systems, only the
        user&#039;s full name is available.
       </td>
      </tr>

      <tr>
       <td>dir</td>
       <td>
        This element contains the absolute path to the
        home directory of the user.
       </td>
      </tr>

      <tr>
       <td>shell</td>
       <td>
        The shell element contains the absolute path to the
        executable of the user&#039;s default shell.
       </td>
      </tr>

     </tbody>
    
   </table>

   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_getrlimit
purpose: Return info about system resource limits
manual_id: function.posix-getrlimit
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative <span class="type">array</span> of elements for each
   limit that is defined. Each limit has a soft and a hard limit.
   <table class="doctable table">
    <caption><strong>List of possible limits returned</strong></caption>
    
     <thead>
      <tr>
       <th>Limit name</th>
       <th>Limit description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>core</td>
       <td>
        The maximum size of the core file.  When 0, not core files are
        created.  When core files are larger than this size, they will
        be truncated at this size.
       </td>
      </tr>

      <tr>
       <td>totalmem</td>
       <td>
        The maximum size of the memory of the process, in bytes.
       </td>
      </tr>

      <tr>
       <td>virtualmem</td>
       <td>
        The maximum size of the virtual memory for the process, in bytes.
       </td>
      </tr>
 
      <tr>
       <td>data</td>
       <td>
        The maximum size of the data segment for the process, in bytes.
       </td>
      </tr>

      <tr>
       <td>stack</td>
       <td>
        The maximum size of the process stack, in bytes.
       </td>
      </tr>

      <tr>
       <td>rss</td>
       <td>
        The maximum number of virtual pages resident in RAM
       </td>
      </tr>

      <tr>
       <td>maxproc</td>
       <td>
        The maximum number of processes that can be created for the
        real user ID of the calling process.
       </td>
      </tr>

      <tr>
       <td>memlock</td>
       <td>
        The maximum number of bytes of memory that may be locked into RAM.
       </td>
      </tr>

      <tr>
       <td>cpu</td>
       <td>
        The amount of time the process is allowed to use the CPU.
       </td>
      </tr>

      <tr>
       <td>filesize</td>
       <td>
        The maximum size of the data segment for the process, in bytes.
       </td>
      </tr>

      <tr>
       <td>openfiles</td>
       <td>
        One more than the maximum number of open file descriptors.
       </td>
      </tr>

     </tbody>
    
   </table>

   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_getsid
purpose: Get the current sid of the process
manual_id: function.posix-getsid
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the identifier, as an <span class="type">int</span>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_isatty
purpose: Determine if a file descriptor is an interactive terminal
manual_id: function.posix-isatty
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">file_descriptor</code> is an open descriptor connected
   to a terminal and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: posix_pathconf
purpose: Returns the value of a configurable limit
manual_id: function.posix-pathconf
version: PHP 8 >= 8.3.0
return_type: false
return_description:
<p class="para">
   Returns the configurable limit or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>

errors:
<p class="para">
   Throws a <span class="classname">ValueError</span>
   when <code class="parameter">path</code> is empty.
  </p>


name: posix_sysconf
purpose: Returns system runtime information
manual_id: function.posix-sysconf
version: PHP 8 >= 8.3.0
return_type: int
return_description:
<p class="para">
   Returns the numeric value related to <code class="parameter">conf_id</code>
  </p>


name: posix_times
purpose: Get process times
manual_id: function.posix-times
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a hash of strings with information about the current
   process CPU usage. The indices of the hash are:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      ticks - the number of clock ticks that have elapsed since
      reboot.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      utime - user time used by the current process.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      stime - system time used by the current process.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      cutime - user time used by current process and children.
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      cstime - system time used by current process and children.
     </span>
    </li>
   </ul>
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: posix_ttyname
purpose: Determine terminal device name
manual_id: function.posix-ttyname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   On success, returns a <span class="type">string</span> of the absolute path of the
   <code class="parameter">file_descriptor</code>. On failure, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>

errors:
<p class="para">
   On invalid <code class="parameter">file_descriptor</code> integer values
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is raised.
  </p>


name: posix_uname
purpose: Get system name
manual_id: function.posix-uname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a hash of strings with information about the
   system. The indices of the hash are
   <ul class="itemizedlist">
    <li class="listitem"><span class="simpara">
      sysname - operating system name (e.g. Linux)
     </span></li>
    <li class="listitem"><span class="simpara">
      nodename - system name (e.g. valiant)
     </span></li>
    <li class="listitem"><span class="simpara">
      release - operating system release (e.g. 2.2.10)
     </span></li>
    <li class="listitem"><span class="simpara">
      version - operating system version (e.g. #4 Tue Jul 20
      17:01:36 MEST 1999)
     </span></li>
    <li class="listitem"><span class="simpara">
      machine - system architecture (e.g. i586)
     </span></li>
    <li class="listitem"><span class="simpara">
      domainname - DNS domainname (e.g. example.com)
     </span></li>
   </ul>
  </p>
  <p class="para">
   domainname is a GNU extension and not part of POSIX.1, so this
   field is only available on GNU systems or when using the GNU
   libc.
  </p>
  <p class="para">
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: exec
purpose: Execute an external program
manual_id: function.exec
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The last line from the result of the command.  If you need to execute a 
   command and have all the data from the command passed directly back without 
   any interference, use the <span class="function">passthru</span> function.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   To get the output of the executed command, be sure to set and use the
   <code class="parameter">output</code> parameter.
  </p>

errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if <span class="function">exec</span>
   is unable to execute the <code class="parameter">command</code>.
  </p>
  <p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">command</code>
   is empty or contains null bytes.
  </p>


name: passthru
purpose: Execute an external program and display raw output
manual_id: function.passthru
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   Will emit an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> if <span class="function">passthru</span>
   is unable to execute the <code class="parameter">command</code>.
  </p>
  <p class="para">
   Throws a <span class="classname">ValueError</span> if <code class="parameter">command</code>
   is empty or contains null bytes.
  </p>


name: proc_get_status
purpose: Get information about a process opened by proc_open
manual_id: function.proc-get-status
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of collected information.
   The returned array contains the following elements:
  </p>
  <p class="para">
  <table class="doctable informaltable">
   
    <thead>
     <tr><th>element</th><th>type</th><th>description</th></tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>command</td>
      <td><span class="type">string</span></td>
      <td>
       The command string that was passed to <span class="function">proc_open</span>.
      </td>
     </tr>

     <tr>
      <td>pid</td>
      <td><span class="type">int</span></td>
      <td>process id</td>
     </tr>

     <tr>
      <td>running</td>
      <td><span class="type">bool</span></td>
      <td>
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the process is still running, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it has
       terminated.
      </td>
     </tr>

     <tr>
      <td>signaled</td>
      <td><span class="type">bool</span></td>
      <td>
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the child process has been terminated by
       an uncaught signal. Always set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on Windows.
      </td>
     </tr>

     <tr>
      <td>stopped</td>
      <td><span class="type">bool</span></td>
      <td>
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the child process has been stopped by a
       signal. Always set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on Windows.
      </td>
     </tr>

     <tr>
      <td>exitcode</td>
      <td><span class="type">int</span></td>
      <td>
       The exit code returned by the process (which is only
       meaningful if <code class="literal">running</code> is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>).
       Only first call of this function return real value, next calls return
       <code class="literal">-1</code>.
      </td>
     </tr>

     <tr>
      <td>termsig</td>
      <td><span class="type">int</span></td>
      <td>
       The number of the signal that caused the child process to terminate
       its execution (only meaningful if <code class="literal">signaled</code> is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>).
      </td>
     </tr>

     <tr>
      <td>stopsig</td>
      <td><span class="type">int</span></td>
      <td>
       The number of the signal that caused the child process to stop its
       execution (only meaningful if <code class="literal">stopped</code> is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>).
      </td>
     </tr>

    </tbody>
   
  </table>

  </p>


name: proc_nice
purpose: Change the priority of the current process
manual_id: function.proc-nice
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   If an error occurs, like the user lacks permission to change the priority, 
   an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is also generated.
  </p>


name: proc_open
purpose: Execute a command and open file pointers for input/output
manual_id: function.proc-open
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a resource representing the process, which should be freed using
   <span class="function">proc_close</span> when you are finished with it. On failure
   returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: shell_exec
purpose: Execute command via shell and return the complete output as a string
manual_id: function.shell-exec
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A <span class="type">string</span> containing the output from the executed command, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the pipe
   cannot be established or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if an error occurs or the command produces no output.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    This function can return <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> both when an error occurs or the program
    produces no output. It is not possible to detect execution failures using
    this function. <span class="function">exec</span> should be used when access to the
    program exit code is required.
   </p>
  </p></blockquote>

errors:
<p class="para">
   An <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is generated
   when the pipe cannot be established.
  </p>


name: system
purpose: Execute an external program and display the output
manual_id: function.system
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the last line of the command output on success, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   on failure.
  </p>


name: parallel\bootstrap
purpose: Bootstrapping
manual_id: parallel.bootstrap
version: 1.0.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    Shall throw <span class="type">parallel\Runtime\Error\Bootstrap</span> if previously called for this process.
   </p>
  </div>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    Shall throw <span class="type">parallel\Runtime\Error\Bootstrap</span> if called after <span class="function">parallel\run</span>.
   </p>
  </div>


name: parallel\run
purpose: Execution
manual_id: parallel.run
version: 1.0.0
return_type: null
return_description:
<div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    The return <span class="type">parallel\Future</span> must not be ignored when the task contains a return or throw statement.
   </p>
  </div>


name: parallel\Events.poll
purpose: Polling
manual_id: parallel-events.poll
version: 0.9.0
return_type: null
return_description:
<p class="para">
    Should there be no targets remaining, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> shall be returned
   </p>
   <p class="para">
    Should this be a non-blocking loop, and blocking would occur, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> shall be returned
   </p>
   <p class="para">
    Otherwise, the <span class="classname">parallel\Events\Event</span> returned describes the event.
   </p>


name: Threaded.isRunning
purpose: State Detection
manual_id: thread.isrunning
version: PECL pthreads >= 2.0.0
return_type: bool
return_description:
<p class="para">
  A boolean indication of state
  <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
     A object is considered running while executing the run method
    </p>
   </p></blockquote>
  </p>


name: Worker.collect
purpose: Collect references to completed tasks
manual_id: worker.collect
version: PECL pthreads >= 3.0.0
return_type: int
return_description:
<p class="para">
   The number of remaining tasks on the worker&#039;s stack to be collected.
  </p>


name: Worker.getStacked
purpose: Gets the remaining stack size
manual_id: worker.getstacked
version: PECL pthreads >= 2.0.0
return_type: int
return_description:
<p class="para">
   Returns the number of tasks currently waiting to be executed by the worker
  </p>


name: ftok
purpose: Convert a pathname and a project identifier to a System V IPC key
manual_id: function.ftok
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   On success the return value will be the created key value, otherwise
   <code class="literal">-1</code> is returned.
  </p>


name: msg_get_queue
purpose: Create or attach to a message queue
manual_id: function.msg-get-queue
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <span class="classname">SysvMessageQueue</span> instance that can be used to access the System V message queue,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: msg_receive
purpose: Receive a message from a message queue
manual_id: function.msg-receive
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Upon successful completion the message queue data structure is updated as
   follows: <code class="literal">msg_lrpid</code> is set to the process-ID of the
   calling process, <code class="literal">msg_qnum</code> is decremented by 1 and
   <code class="literal">msg_rtime</code> is set to the current time.
  </p>


name: msg_send
purpose: Send a message to a message queue
manual_id: function.msg-send
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Upon successful completion the message queue data structure is updated as
   follows: <code class="parameter">msg_lspid</code> is set to the process-ID of the
   calling process, <code class="parameter">msg_qnum</code> is incremented by 1 and
   <code class="parameter">msg_stime</code> is set to the current time.
  </p>


name: msg_stat_queue
purpose: Returns information from the message queue data structure
manual_id: function.msg-stat-queue
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success, the return value is an array whose keys and values have the following
   meanings:
   <table class="doctable table">
    <caption><strong>Array structure for msg_stat_queue</strong></caption>
    
     <tbody class="tbody">
      <tr>
       <td><code class="literal">msg_perm.uid</code></td>
       <td>
        The uid of the owner of the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_perm.gid</code></td>
       <td>
        The gid of the owner of the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_perm.mode</code></td>
       <td>
        The file access mode of the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_stime</code></td>
       <td>
        The time that the last message was sent to the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_rtime</code></td>
       <td>
        The time that the last message was received from the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_ctime</code></td>
       <td>
        The time that the queue was last changed.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_qnum</code></td>
       <td>
        The number of messages waiting to be read from the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_qbytes</code></td>
       <td>
        The maximum number of bytes allowed in one message queue. On
        Linux, this value may be read and modified via
        <var class="filename">/proc/sys/kernel/msgmnb</var>.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_lspid</code></td>
       <td>
        The pid of the process that sent the last message to the queue.
       </td>
      </tr>

      <tr>
       <td><code class="literal">msg_lrpid</code></td>
       <td>
        The pid of the process that received the last message from the queue.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: sem_get
purpose: Get a semaphore id
manual_id: function.sem-get
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a positive semaphore identifier on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>


name: shm_attach
purpose: Creates or open a shared memory segment
manual_id: function.shm-attach
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="classname">SysvSharedMemory</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: shm_has_var
purpose: Check whether a specific entry exists
manual_id: function.shm-has-var
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the entry exists, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: shmop_open
purpose: Create or open shared memory block
manual_id: function.shmop-open
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success <span class="function">shmop_open</span> will return a <span class="classname">Shmop</span> instance that you can
   use to access the shared memory segment you&#039;ve created. <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is
   returned on failure.
  </p>

errors:
<p class="para">
   If <code class="parameter">mode</code> is invalid, or <code class="parameter">size</code> is less than or equal to zero,
   a <span class="classname">ValueError</span> is thrown.
   On other failures, <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
  </p>


name: shmop_read
purpose: Read data from shared memory block
manual_id: function.shmop-read
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the data or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   If <code class="parameter">offset</code> or <code class="parameter">size</code> are out of range,
   a <span class="classname">ValueError</span> is thrown.
  </p>


name: shmop_size
purpose: Get size of shared memory block
manual_id: function.shmop-size
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an int, which represents the number of bytes the shared memory
   block occupies.
  </p>


name: shmop_write
purpose: Write data into shared memory block
manual_id: function.shmop-write
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> The size of the written <code class="parameter">data</code>. </p>
errors:
<p class="para">
   If <code class="parameter">offset</code> is out of range, or a read-only shared memory segment
   should be written to, a <span class="classname">ValueError</span> is thrown.
  </p>


name: SyncSharedMemory.__construct
purpose: Constructs a new SyncSharedMemory object
manual_id: syncsharedmemory.construct
version: PECL sync >= 1.1.0
return_description: <p class="para"> The new <span class="classname">SyncSharedMemory</span> object. </p>
errors:
<p class="para">
   An exception is thrown if the shared memory object cannot be created or opened.
  </p>


name: SyncSharedMemory.size
purpose: Returns the size of the named shared memory
manual_id: syncsharedmemory.size
version: PECL sync >= 1.1.0
return_type: int
return_description:
<p class="para">
   An integer containing the size of the shared memory. This will be the same size that was passed to the constructor.
  </p>


name: geoip_asnum_by_name
purpose: Get the Autonomous System Numbers (ASN)
manual_id: function.geoip-asnum-by-name
version: PECL geoip >= 1.1.0
return_type: string
return_description:
<p class="para">
   Returns the ASN on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address
   cannot be found in the database.
  </p>


name: geoip_continent_code_by_name
purpose: Get the two letter continent code
manual_id: function.geoip-continent-code-by-name
version: PECL geoip >= 1.0.3
return_type: string
return_description:
<p class="para">
   Returns the two letter continent code on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   address cannot be found in the database.
  </p>
  <table class="doctable table">
   <caption><strong>Continent codes</strong></caption>
   
    <thead>
     <tr>
      <th>Code</th>
      <th>Continent name</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td><code class="literal">AF</code></td>
      <td>Africa</td>
     </tr>

     <tr>
      <td><code class="literal">AN</code></td>
      <td>Antarctica</td>
     </tr>

     <tr>
      <td><code class="literal">AS</code></td>
      <td>Asia</td>
     </tr>

     <tr>
      <td><code class="literal">EU</code></td>
      <td>Europe</td>
     </tr>

     <tr>
      <td><code class="literal">NA</code></td>
      <td>North america</td>
     </tr>

     <tr>
      <td><code class="literal">OC</code></td>
      <td>Oceania</td>
     </tr>

     <tr>
      <td><code class="literal">SA</code></td>
      <td>South america</td>
     </tr>

    </tbody>
   
  </table>


name: geoip_country_code_by_name
purpose: Get the two letter country code
manual_id: function.geoip-country-code-by-name
version: PECL geoip >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns the two letter ISO country code on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   if the address cannot be found in the database.
  </p>


name: geoip_country_code3_by_name
purpose: Get the three letter country code
manual_id: function.geoip-country-code3-by-name
version: PECL geoip >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns the three letter country code on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> 
   if the address cannot be found in the database.
  </p>


name: geoip_country_name_by_name
purpose: Get the full country name
manual_id: function.geoip-country-name-by-name
version: PECL geoip >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns the country name on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address cannot 
   be found in the database.
  </p>


name: geoip_database_info
purpose: Get GeoIP Database information
manual_id: function.geoip-database-info
version: PECL geoip >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns the corresponding database version, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: geoip_db_avail
purpose: Determine if GeoIP Database is available
manual_id: function.geoip-db-avail
version: PECL geoip >= 1.0.1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> is database exists, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not found, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: geoip_db_filename
purpose: Returns the filename of the corresponding GeoIP Database
manual_id: function.geoip-db-filename
version: PECL geoip >= 1.0.1
return_type: string
return_description:
<p class="para">
   Returns the filename of the corresponding database, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: geoip_domain_by_name
purpose: Get the second level domain name
manual_id: function.geoip-domain-by-name
version: PECL geoip >= 1.1.0
return_type: string
return_description:
<p class="para">
   Returns the domain name on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address
   cannot be found in the database.
  </p>


name: geoip_isp_by_name
purpose: Get the Internet Service Provider (ISP) name
manual_id: function.geoip-isp-by-name
version: PECL geoip >= 1.0.2
return_type: string
return_description:
<p class="para">
   Returns the ISP name on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address
   cannot be found in the database.
  </p>


name: geoip_netspeedcell_by_name
purpose: Get the Internet connection speed
manual_id: function.geoip-netspeedcell-by-name
version: PECL geoip >= 1.1.0
return_type: string
return_description:
<p class="para">
   Returns the connection speed on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address
   cannot be found in the database.
  </p>


name: geoip_org_by_name
purpose: Get the organization name
manual_id: function.geoip-org-by-name
version: PECL geoip >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns the organization name on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address
   cannot be found in the database.
  </p>


name: geoip_record_by_name
purpose: Returns the detailed City information found in the GeoIP Database
manual_id: function.geoip-record-by-name
version: PECL geoip >= 0.2.0
return_type: float
return_description:
<p class="para">
   Returns the associative array on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the address 
   cannot be found in the database.
  </p>


name: geoip_region_name_by_code
purpose: Returns the region name for some country and region code combo
manual_id: function.geoip-region-name-by-code
version: PECL geoip >= 1.0.4
return_type: string
return_description:
<p class="para">
   Returns the region name on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the country and region code
   combo cannot be found.
  </p>


name: geoip_time_zone_by_country_and_region
purpose: Returns the time zone for some country and region code combo
manual_id: function.geoip-time-zone-by-country-and-region
version: PECL geoip >= 1.0.4
return_type: string
return_description:
<p class="para">
   Returns the time zone on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the country and region code
   combo cannot be found.
  </p>


name: fann_cascadetrain_on_data
purpose: Trains on an entire dataset, for a period of time using the Cascade2 training algorithm
manual_id: function.fann-cascadetrain-on-data
version: PECL fann >= 1.0.0
return_type: bool
return_description:
<p class="para">Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.</p>


name: fann_cascadetrain_on_file
manual_id: function.fann-cascadetrain-on-file
version: PECL fann >= 1.0.0
return_type: bool
purpose:
Trains on an entire dataset read from file, for a period of time using the Cascade2 training algorithm

return_description:
<p class="para">Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.</p>


name: fann_copy
purpose: Creates a copy of a fann structure
manual_id: function.fann-copy
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para">
   Returns a copy of neural network resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: fann_create_from_file
purpose: Constructs a backpropagation neural network from a configuration file
manual_id: function.fann-create-from-file
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para"> Returns a neural network <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.</p>


name: fann_create_shortcut_array
manual_id: function.fann-create-shortcut-array
version: PECL fann >= 1.0.0
return_type: resource
purpose:
Creates a standard backpropagation neural network which is not fully connectected and has shortcut connections

return_description:
<p class="para">
   Returns a neural network resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_create_sparse_array
manual_id: function.fann-create-sparse-array
version: PECL fann >= 1.0.0
return_type: resource
purpose:
Creates a standard backpropagation neural network, which is not fully connected using an array of layer sizes

return_description:
<p class="para">
   Returns a neural network resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_create_train_from_callback
purpose: Creates the training data struct from a user supplied function
manual_id: function.fann-create-train-from-callback
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para"> Returns a train data <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.</p>


name: fann_get_activation_function
purpose: Returns the activation function
manual_id: function.fann-get-activation-function
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   <a href="fann.constants.html#constants.fann-train" class="link">Learning functions</a> constant or -1
   if the neuron is not defined in the neural network, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_activation_steepness
purpose: Returns the activation steepness for supplied neuron and layer number
manual_id: function.fann-get-activation-steepness
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_bit_fail_limit
purpose: Returns the bit fail limit used during training
manual_id: function.fann-get-bit-fail-limit
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The bit fail limit, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_bit_fail
purpose: The number of fail bits
manual_id: function.fann-get-bit-fail
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of bits fail, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_activation_functions_count
purpose: Returns the number of cascade activation functions
manual_id: function.fann-get-cascade-activation-functions-count
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of cascade activation functions, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_activation_functions
purpose: Returns the cascade activation functions
manual_id: function.fann-get-cascade-activation-functions
version: PECL fann >= 1.0.0
return_type: array
return_description:
<p class="para">
   The cascade activation functions, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_activation_steepnesses_count
purpose: The number of activation steepnesses
manual_id: function.fann-get-cascade-activation-steepnesses-count
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of activation steepnesses, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_activation_steepnesses
purpose: Returns the cascade activation steepnesses
manual_id: function.fann-get-cascade-activation-steepnesses
version: PECL fann >= 1.0.0
return_type: array
return_description:
<p class="para">
   The cascade activation steepnesses, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_candidate_change_fraction
purpose: Returns the cascade candidate change fraction
manual_id: function.fann-get-cascade-candidate-change-fraction
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The cascade candidate change fraction, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_candidate_limit
purpose: Return the candidate limit
manual_id: function.fann-get-cascade-candidate-limit
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The candidate limit, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_candidate_stagnation_epochs
purpose: Returns the number of cascade candidate stagnation epochs
manual_id: function.fann-get-cascade-candidate-stagnation-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of cascade candidate stagnation epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_max_cand_epochs
purpose: Returns the maximum candidate epochs
manual_id: function.fann-get-cascade-max-cand-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The maximum candidate epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_max_out_epochs
purpose: Returns the maximum out epochs
manual_id: function.fann-get-cascade-max-out-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The maximum out epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_min_cand_epochs
purpose: Returns the minimum candidate epochs
manual_id: function.fann-get-cascade-min-cand-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The minimum candidate epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_min_out_epochs
purpose: Returns the minimum out epochs
manual_id: function.fann-get-cascade-min-out-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The minimum out epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_num_candidate_groups
purpose: Returns the number of candidate groups
manual_id: function.fann-get-cascade-num-candidate-groups
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of candidate groups, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_num_candidates
purpose: Returns the number of candidates used during training
manual_id: function.fann-get-cascade-num-candidates
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of candidates used during training, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_output_change_fraction
purpose: Returns the cascade output change fraction
manual_id: function.fann-get-cascade-output-change-fraction
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The cascade output change fraction, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_output_stagnation_epochs
purpose: Returns the number of cascade output stagnation epochs
manual_id: function.fann-get-cascade-output-stagnation-epochs
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of cascade output stagnation epochs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_cascade_weight_multiplier
purpose: Returns the weight multiplier
manual_id: function.fann-get-cascade-weight-multiplier
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The weight multiplier, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_connection_rate
purpose: Get the connection rate used when the network was created
manual_id: function.fann-get-connection-rate
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The connection rate used when the network was created, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_errno
purpose: Returns the last error number
manual_id: function.fann-get-errno
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The error number, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_errstr
purpose: Returns the last errstr
manual_id: function.fann-get-errstr
version: PECL fann >= 1.0.0
return_type: string
return_description:
<p class="para">
   The last error string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_learning_momentum
purpose: Returns the learning momentum
manual_id: function.fann-get-learning-momentum
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.</p>
  <p class="para">
   The learning momentum, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_learning_rate
purpose: Returns the learning rate
manual_id: function.fann-get-learning-rate
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The learning rate, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_MSE
purpose: Reads the mean square error from the network
manual_id: function.fann-get-mse
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The mean square error, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_network_type
purpose: Get the type of neural network it was created as
manual_id: function.fann-get-network-type
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
    <a href="fann.constants.html#constants.fann-nettype" class="link">Network type</a> constant, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_num_input
purpose: Get the number of input neurons
manual_id: function.fann-get-num-input
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   Number of input neurons, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: fann_get_num_layers
purpose: Get the number of layers in the neural network
manual_id: function.fann-get-num-layers
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The number of leayers in the neural network, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_num_output
purpose: Get the number of output neurons
manual_id: function.fann-get-num-output
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   Number of output neurons, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: fann_get_quickprop_decay
manual_id: function.fann-get-quickprop-decay
version: PECL fann >= 1.0.0
return_type: float
purpose:
Returns the decay which is a factor that weights should decrease in each iteration during quickprop training

return_description:
<p class="para">
   The decay, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_quickprop_mu
purpose: Returns the mu factor
manual_id: function.fann-get-quickprop-mu
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The mu factor, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_rprop_decrease_factor
purpose: Returns the increase factor used during RPROP training
manual_id: function.fann-get-rprop-decrease-factor
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The decrease factor, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_rprop_delta_max
purpose: Returns the maximum step-size
manual_id: function.fann-get-rprop-delta-max
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The maximum step-size, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_rprop_delta_min
purpose: Returns the minimum step-size
manual_id: function.fann-get-rprop-delta-min
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The minimum step-size, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_rprop_delta_zero
purpose: Returns the initial step-size
manual_id: function.fann-get-rprop-delta-zero
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The initial step-size, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_rprop_increase_factor
purpose: Returns the increase factor used during RPROP training
manual_id: function.fann-get-rprop-increase-factor
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The increase factor, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_sarprop_step_error_shift
purpose: Returns the sarprop step error shift
manual_id: function.fann-get-sarprop-step-error-shift
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The sarprop step error shift , or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_sarprop_step_error_threshold_factor
purpose: Returns the sarprop step error threshold factor
manual_id: function.fann-get-sarprop-step-error-threshold-factor
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
    The sarprop step error threshold factor, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_sarprop_temperature
purpose: Returns the sarprop temperature
manual_id: function.fann-get-sarprop-temperature
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The sarprop temperature, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_sarprop_weight_decay_shift
purpose: Returns the sarprop weight decay shift
manual_id: function.fann-get-sarprop-weight-decay-shift
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The sarprop weight decay shift, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_total_connections
purpose: Get the total number of connections in the entire network
manual_id: function.fann-get-total-connections
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   Total number of connections in the entire network, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: fann_get_total_neurons
purpose: Get the total number of neurons in the entire network
manual_id: function.fann-get-total-neurons
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   Total number of neurons in the entire network, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_train_error_function
purpose: Returns the error function used during training
manual_id: function.fann-get-train-error-function
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The <a href="fann.constants.html#constants.fann-errorfunc" class="link">error function</a> constant, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_train_stop_function
purpose: Returns the stop function used during training
manual_id: function.fann-get-train-stop-function
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   The <a href="fann.constants.html#constants.fann-stopfunc" class="link">stop function</a> constant, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_get_training_algorithm
purpose: Returns the training algorithm
manual_id: function.fann-get-training-algorithm
version: PECL fann >= 1.0.0
return_type: int
return_description:
<p class="para">
   <a href="fann.constants.html#constants.fann-train" class="link">Training algorithm</a> constant, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_length_train_data
purpose: Returns the number of training patterns in the train data
manual_id: function.fann-length-train-data
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para">
   Number of elements in the train data <span class="type">resource</span>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_merge_train_data
purpose: Merges the train data
manual_id: function.fann-merge-train-data
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para">
   New merged train data <span class="type">resource</span>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_num_input_train_data
purpose: Returns the number of inputs in each of the training patterns in the train data
manual_id: function.fann-num-input-train-data
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para">
    The number of inputs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_num_output_train_data
purpose: Returns the number of outputs in each of the training patterns in the train data
manual_id: function.fann-num-output-train-data
version: PECL fann >= 1.0.0
return_type: resource
return_description:
<p class="para">
   The number of outputs, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_run
purpose: Will run input through the neural network
manual_id: function.fann-run
version: PECL fann >= 1.0.0
return_type: array
return_description:
<p class="para">
   Array of output values, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: fann_test_data
purpose: Test a set of training data and calculates the MSE for the training data
manual_id: function.fann-test-data
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The updated MSE, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: fann_test
purpose: Test with a set of inputs, and a set of desired outputs
manual_id: function.fann-test
version: PECL fann >= 1.0.0
return_type: array
return_description:
<p class="para">Returns test outputs on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.</p>


name: fann_train_epoch
purpose: Train one epoch with a set of training data
manual_id: function.fann-train-epoch
version: PECL fann >= 1.0.0
return_type: float
return_description:
<p class="para">
   The MSE, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: igbinary_serialize
purpose: Generates a compact, storable binary representation of a value
manual_id: function.igbinary-serialize
version: PECL igbinary >= 1.1.1
return_type: false
return_description:
<p class="para">
   Returns a string containing a byte-stream representation of
   <code class="parameter">value</code> that can be stored anywhere.
  </p>
  <p class="para">
   Note that this is a binary string which can include any byte value, and needs
   to be stored and handled as such. For example,
   <span class="function">igbinary_serialize</span> output should generally be stored in a <code class="literal">BLOB</code>
   field in a database, rather than a <code class="literal">CHAR</code> or <code class="literal">TEXT</code> field.
  </p>


name: igbinary_unserialize
purpose: Creates a PHP value from a stored representation from igbinary_serialize
manual_id: function.igbinary-unserialize
version: PECL igbinary >= 1.1.1
return_type: mixed
return_description:
<p class="para">
   The converted value is returned, and can be a <span class="type">bool</span>,
   <span class="type">int</span>, <span class="type">float</span>, <span class="type">string</span>,
   <span class="type">array</span>, <span class="type">object</span>, or <span class="type">null</span>.
  </p>
  <p class="para">
   In case the passed string is not unserializeable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned and
   <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong> or <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is issued.
  </p>

errors:
<p class="para">
   Objects may throw <span class="classname">Throwable</span>s in their unserialization handlers.
  </p>


name: JsonSerializable.jsonSerialize
purpose: Specify data which should be serialized to JSON
manual_id: jsonserializable.jsonserialize
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span>,
   which is a value of any type other than a <a href="language.types.resource.html" class="link">resource</a>.
  </p>


name: json_decode
purpose: Decodes a JSON string
manual_id: function.json-decode
version: PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL json >= 1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns the value encoded in <code class="parameter">json</code> as an appropriate
   PHP type. Unquoted values <code class="literal">true</code>, <code class="literal">false</code>
   and <code class="literal">null</code> are returned as <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> respectively. <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned if the
   <code class="parameter">json</code> cannot be decoded or if the encoded data is
   deeper than the nesting limit.
  </p>

errors:
<p class="para">
   If <code class="parameter">depth</code> is outside the allowed range,
   a <span class="classname">ValueError</span> is thrown as of PHP 8.0.0,
   while previously, an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was raised.
  </p>


name: json_encode
purpose: Returns the JSON representation of a value
manual_id: function.json-encode
version: PHP 5 >= 5.2.0, PHP 7, PHP 8, PECL json >= 1.2.0
return_type: object
return_description:
<p class="para">
   Returns a JSON encoded <span class="type">string</span> on success  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: json_last_error_msg
purpose: Returns the error string of the last json_encode() or json_decode() call
manual_id: function.json-last-error-msg
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the error message on success, or <code class="literal">&quot;No error&quot;</code> if no
   error has occurred.
  </p>


name: json_last_error
purpose: Returns the last error occurred
manual_id: function.json-last-error
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an integer, the value can be one of the following 
   constants: 
  </p>
  <table class="doctable table">
   <caption><strong>JSON error codes</strong></caption>
   
    <thead>
     <tr>
      <th>Constant</th>
      <th>Meaning</th>
      <th>Availability</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-none">JSON_ERROR_NONE</a></code></strong></td>
      <td>No error has occurred</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-depth">JSON_ERROR_DEPTH</a></code></strong></td>
      <td>The maximum stack depth has been exceeded</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-state-mismatch">JSON_ERROR_STATE_MISMATCH</a></code></strong></td>
      <td>Invalid or malformed JSON</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-ctrl-char">JSON_ERROR_CTRL_CHAR</a></code></strong></td>
      <td>Control character error, possibly incorrectly encoded</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-syntax">JSON_ERROR_SYNTAX</a></code></strong></td>
      <td>Syntax error</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-utf8">JSON_ERROR_UTF8</a></code></strong></td>
      <td>Malformed UTF-8 characters, possibly incorrectly encoded</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-recursion">JSON_ERROR_RECURSION</a></code></strong></td>
      <td>One or more recursive references in the value to be encoded</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-inf-or-nan">JSON_ERROR_INF_OR_NAN</a></code></strong></td>
      <td>
       One or more
       <a href="language.types.float.html#language.types.float.nan" class="link"><strong><code><a href="math.constants.html#constant.nan">NAN</a></code></strong></a>
       or <a href="function.is-infinite.html" class="link"><strong><code><a href="math.constants.html#constant.inf">INF</a></code></strong></a>
       values in the value to be encoded
      </td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-unsupported-type">JSON_ERROR_UNSUPPORTED_TYPE</a></code></strong></td>
      <td>A value of a type that cannot be encoded was given</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-invalid-property-name">JSON_ERROR_INVALID_PROPERTY_NAME</a></code></strong></td>
      <td>A property name that cannot be encoded was given</td>
      <td class="empty">&nbsp;</td>
     </tr>

     <tr>
      <td><strong><code><a href="json.constants.html#constant.json-error-utf16">JSON_ERROR_UTF16</a></code></strong></td>
      <td>Malformed UTF-16 characters, possibly incorrectly encoded</td>
      <td class="empty">&nbsp;</td>
     </tr>

    </tbody>
   
  </table>


name: json_validate
purpose: Checks if a string contains valid JSON
manual_id: function.json-validate
version: PHP 8 >= 8.3.0
return_type: string
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the given string is syntactically valid JSON, otherwise
   returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>

errors:
<p class="para">
   If <code class="parameter">depth</code> is outside the allowed range,
   a <span class="classname">ValueError</span> is thrown.
  </p>
  <p class="para">
   If <code class="parameter">flags</code> is not a valid flag,
   a <span class="classname">ValueError</span> is thrown.
  </p>


name: simdjson_decode
purpose: Decodes a JSON string
manual_id: function.simdjson-decode
version: PECL simdjson >= 2.0.0
return_type: mixed
return_description:
<p class="para">
   Returns the value encoded in <code class="parameter">json</code> in appropriate
   PHP type. Values <code class="literal">true</code>, <code class="literal">false</code> and
   <code class="literal">null</code> are returned as <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   respectively.
  </p>

errors:
<p class="para">
   If <code class="parameter">json</code> is invalid, a <span class="classname">SimdJsonException</span> is thrown as of PECL simdjson 2.1.0,
   while previously, a <span class="classname">RuntimeException</span> was thrown.
  </p>
  <p class="para">
   If <code class="parameter">depth</code> is outside the allowed range,
   a <span class="classname">SimdJsonValueError</span> is thrown as of PECL simdjson 3.0.0,
   while previously, an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was raised.
  </p>


name: simdjson_is_valid
purpose: Check if a JSON string is valid
manual_id: function.simdjson-is-valid
version: PECL simdjson >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">json</code> is a valid JSON
   string, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>

errors:
<p class="para">
   If <code class="parameter">json</code> is longer than 4 GiB, a <span class="classname">SimdJsonException</span> is thrown as of PECL simdjson 2.1.0,
   while previously, a <span class="classname">RuntimeException</span> was thrown.
  </p>
  <p class="para">
   If <code class="parameter">depth</code> is outside the allowed range,
   a <span class="classname">SimdJsonValueError</span> is thrown as of PECL simdjson 3.0.0,
   while previously, an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was raised.
  </p>


name: simdjson_key_count
purpose: Returns the value at a JSON pointer.
manual_id: function.simdjson-key-count
version: PECL simdjson >= 2.0.0
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">int</span> with the number of elements of the value at the given JSON pointer.
  </p>


name: simdjson_key_exists
purpose: Check if the JSON contains the value referred to by a JSON pointer.
manual_id: function.simdjson-key-exists
version: PECL simdjson >= 2.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the JSON pointer is valid and refers to a value found within a valid JSON string.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the JSON is valid but does not contain the JSON pointer.
  </p>


name: simdjson_key_value
purpose: Decodes the value of a JSON string located at the requested JSON pointer.
manual_id: function.simdjson-key-value
version: PECL simdjson >= 2.0.0
return_type: mixed
return_description:
<p class="para">
   Returns the part of the value encoded in <code class="parameter">json</code>
   that <code class="parameter">key</code> refers to in appropriate
   PHP type. Values <code class="literal">true</code>, <code class="literal">false</code> and
   <code class="literal">null</code> are returned as <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   respectively.
  </p>

errors:
<p class="para">
   If <code class="parameter">json</code> or <code class="parameter">key</code> is invalid,
   or <code class="parameter">key</code> could not be found within <code class="parameter">json</code>,
   a <span class="classname">SimdJsonException</span> is thrown as of PECL simdjson 2.1.0,
   while previously, a <span class="classname">RuntimeException</span> was thrown.
  </p>
  <p class="para">
   If <code class="parameter">depth</code> is outside the allowed range,
   a <span class="classname">SimdJsonValueError</span> is thrown as of PECL simdjson 3.0.0,
   while previously, an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> was raised.
  </p>


name: Lua.assign
purpose: Assign a PHP variable to Lua
manual_id: lua.assign
version: PECL lua >=0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns <var class="varname">$this</var> or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: Lua.call
purpose: Call Lua functions
manual_id: lua.call
version: PECL lua >=0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns result of the called function, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for wrong arguments or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on other failure.
  </p>


name: Lua.eval
purpose: Evaluate a string as Lua code
manual_id: lua.eval
version: PECL lua >=0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns result of evaled code, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for wrong arguments or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   other failure.
  </p>


name: Lua.include
purpose: Parse a Lua script file
manual_id: lua.include
version: PECL lua >=0.9.0
return_type: mixed
return_description:
<p class="para">
   Returns result of included code, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for wrong arguments or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   other failure.
  </p>


name: Lua.registerCallback
purpose: Register a PHP function to Lua
manual_id: lua.registercallback
return_type: mixed
return_description:
<p class="para">
   Returns <var class="varname">$this</var>, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for wrong arguments or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   other failure.
  </p>


name: LuaSandbox.callFunction
purpose: Call a function in a Lua global variable
manual_id: luasandbox.callfunction
version: PECL luasandbox >= 1.0.0
return_type: bool
return_description:
<p class="para">
   Returns an <span class="type">array</span> of values returned by the Lua function, which may be empty,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: LuaSandbox.getCPUUsage
purpose: Fetch the current CPU time usage of the Lua environment
manual_id: luasandbox.getcpuusage
version: PECL luasandbox >= 1.0.0
return_type: float
return_description:
<p class="para">
   Returns the current CPU time usage in seconds.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    On Windows, this function always returns zero. On operating systems that do
    not support <strong><code>CLOCK_THREAD_CPUTIME_ID</code></strong>, such as FreeBSD
    and Mac OS X, this function will return the elapsed wall-clock time, not
    CPU time.
   </p>
  </p></blockquote>


name: LuaSandbox.getProfilerFunctionReport
purpose: Fetch profiler data
manual_id: luasandbox.getprofilerfunctionreport
version: PECL luasandbox >= 1.1.0
return_type: array
return_description:
<p class="para">
   Returns profiler measurements, sorted in descending order, as an associative
   <span class="type">array</span>. Keys are the Lua function names (with source file and line
   defined in angle brackets), values are the measurements as <span class="type">int</span>
   or <span class="type">float</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    On Windows, this function always returns an empty array. On operating systems that do
    not support <strong><code>CLOCK_THREAD_CPUTIME_ID</code></strong>, such as FreeBSD
    and Mac OS X, this function will report the elapsed wall-clock time, not
    CPU time.
   </p>
  </p></blockquote>


name: LuaSandbox.getVersionInfo
purpose: Return the versions of LuaSandbox and Lua
manual_id: luasandbox.getversioninfo
version: PECL luasandbox >= 1.6.0
return_type: array
return_description:
<p class="para">
   Returns an array with two keys:
  </p>
  <p class="para">
   <table class="doctable informaltable">
    
     <thead>
      <tr><th>element</th><th>type</th><th>description</th></tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>LuaSandbox</td>
       <td><span class="type">string</span></td>
       <td>The version of the LuaSandbox extension.</td>
      </tr>

      <tr>
       <td>Lua</td>
       <td><span class="type">string</span></td>
       <td>The library name and version as defined by the LUA_RELEASE macro, for example, &quot;Lua 5.1.5&quot;.</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: LuaSandbox.loadString
purpose: Load Lua code into the Lua environment
manual_id: luasandbox.loadstring
version: PECL luasandbox >= 1.0.0
return_type: LuaSandboxFunction
return_description:
<p class="para">
   Returns a <span class="classname">LuaSandboxFunction</span> which, when executed, will execute the passed <var class="varname">$code</var>.
  </p>


name: LuaSandbox.pauseUsageTimer
purpose: Pause the CPU usage timer
manual_id: luasandbox.pauseusagetimer
version: PECL luasandbox >= 1.4.0
return_type: bool
return_description:
<p class="para">
   Returns a <span class="type">bool</span> indicating whether the timer is now paused.
  </p>


name: LuaSandboxFunction.call
purpose: Call a Lua function
manual_id: luasandboxfunction.call
version: PECL luasandbox >= 1.0.0
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">array</span> of values returned by the function, which may be empty,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: LuaSandboxFunction.dump
purpose: Dump the function as a binary blob
manual_id: luasandboxfunction.dump
version: PECL luasandbox >= 1.0.0
return_type: string
return_description:
<p class="para">
   Returns a string that may be passed to  <span class="methodname">LuaSandbox::loadBinary</span>.
  </p>


name: connection_status
purpose: Returns connection status bitfield
manual_id: function.connection-status
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the connection status bitfield, which can be used against the
   <a href="misc.constants.html" class="link"><strong><code>CONNECTION_<span class="replaceable">*</span></code></strong></a>
   constants to determine the connection status.
  </p>


name: constant
purpose: Returns the value of a constant
manual_id: function.constant
version: PHP 4 >= 4.0.4, PHP 5, PHP 7, PHP 8
return_type: mixed
return_description: <p class="para"> Returns the value of the constant. </p>
errors:
<p class="para">
   If the constant is not defined, an <span class="classname">Error</span> exception is thrown.
   Prior to PHP 8.0.0, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error was generated in that case.
  </p>


name: defined
purpose: Checks whether a constant with the given name exists
manual_id: function.defined
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the named constant given by <code class="parameter">constant_name</code>
   has been defined, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


