# params

function_name: xdiff_file_diff
name: minimal
type: bool
description:
<p class="para">
       Set this parameter to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if you want to minimalize size of the result
       (can take a long time). 
      </p>


function_name: xdiff_file_merge3
name: new_file1
type: string
description:
<p class="para">
       Path to the second file. It acts as modified version of <code class="parameter">old_file</code>.
      </p>


function_name: xdiff_file_merge3
name: new_file2
type: string
description:
<p class="para">
       Path to the third file. It acts as modified version of <code class="parameter">old_file</code>.
      </p>


function_name: xdiff_file_merge3
name: dest
type: string
description:
<p class="para">
       Path of the resulting file, containing merged changed from both <code class="parameter">new_file1</code> and
       <code class="parameter">new_file2</code>.
      </p>


function_name: xdiff_file_patch
name: patch
type: string
description:
<p class="para">
       The unified patch file. It has to be created using <span class="function">xdiff_string_diff</span>, 
       <span class="function">xdiff_file_diff</span> functions or compatible tools.
      </p>


function_name: xdiff_file_patch
name: flags
type: int
initializer: DIFF_PATCH_NORMAL
description:
<p class="para">
       Can be either <strong><code><a href="xdiff.constants.html#constant.xdiff-patch-normal">XDIFF_PATCH_NORMAL</a></code></strong> (default mode,
       normal patch) or <strong><code><a href="xdiff.constants.html#constant.xdiff-patch-reverse">XDIFF_PATCH_REVERSE</a></code></strong> (reversed
       patch).
      </p>
      <p class="para">
       Starting from version 1.5.0, you can also use binary OR to enable
       <strong><code>XDIFF_PATCH_IGNORESPACE</code></strong> flag.
      </p>


function_name: xdiff_string_bdiff_size
name: patch
type: string
description:
<p class="para">
       The binary patch created by <span class="function">xdiff_string_bdiff</span> or 
       <span class="function">xdiff_string_rabdiff</span> function.
      </p>


function_name: xdiff_string_diff
name: context
type: int
initializer: 3
description:
<p class="para">
       Indicates how many lines of context you want to include in the diff
       result.
      </p>


function_name: xdiff_string_diff
name: minimal
type: bool
description:
<p class="para">
       Set this parameter to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if you want to minimalize the size of the
       result (can take a long time).
      </p>


function_name: xdiff_string_merge3
name: new_data1
type: string
description:
<p class="para">
       Second string with data. It acts as modified version of <code class="parameter">old_data</code>.
      </p>


function_name: xdiff_string_merge3
name: new_data2
type: string
description:
<p class="para">
       Third string with data. It acts as modified version of <code class="parameter">old_data</code>.
      </p>


function_name: xdiff_string_patch
name: patch
type: string
description:
<p class="para">
       The unified patch string. It has to be created using <span class="function">xdiff_string_diff</span>, 
       <span class="function">xdiff_file_diff</span> functions or compatible tools.
      </p>


function_name: xdiff_string_patch
name: flags
type: int
description:
<p class="para">
       <code class="parameter">flags</code> can be either
       <strong><code><a href="xdiff.constants.html#constant.xdiff-patch-normal">XDIFF_PATCH_NORMAL</a></code></strong> (default mode, normal patch)
       or <strong><code><a href="xdiff.constants.html#constant.xdiff-patch-reverse">XDIFF_PATCH_REVERSE</a></code></strong> (reversed patch).
      </p>
      <p class="para">
       Starting from version 1.5.0, you can also use binary OR to enable
       <strong><code>XDIFF_PATCH_IGNORESPACE</code></strong> flag.
      </p>


function_name: enchant_broker_describe
name: broker
type: EnchantBroker
description:
<p class="para">
       An Enchant broker returned by <span class="function">enchant_broker_init</span>.
      </p>


function_name: enchant_broker_free_dict
name: dictionary
type: EnchantDictionary
description:
<p class="para">
       An Enchant dictionary returned by <span class="function">enchant_broker_request_dict</span>
       or <span class="function">enchant_broker_request_pwl_dict</span>.
      </p>


function_name: enchant_broker_get_dict_path
name: type
type: int
description:
<p class="para">
       The type of the dictionaries, i.e. <strong><code><a href="enchant.constants.html#constant.enchant-myspell">ENCHANT_MYSPELL</a></code></strong>
       or <strong><code><a href="enchant.constants.html#constant.enchant-ispell">ENCHANT_ISPELL</a></code></strong>.
      </p>


function_name: enchant_broker_request_pwl_dict
name: filename
type: string
description:
<p class="para">
       Path to the PWL file.
       If there is no such file, a new one will be created if possible.
      </p>


function_name: enchant_broker_set_ordering
name: tag
type: string
description:
<p class="para">
       Language tag. The special &quot;*&quot; tag can be used as a language tag
       to declare a default ordering for any language that does not
       explicitly declare an ordering.
      </p>


function_name: enchant_dict_quick_check
name: suggestions
type: array
description:
<p class="para">
       If the word is not correctly spelled, this variable will
       contain an array of suggestions.
      </p>


function_name: Gender\Gender.country
name: country
type: int
description:
<p class="para">
      A country ID specified by a <span class="classname">Gender\Gender</span> class
      constant.
     </p>


function_name: Gender\Gender.isNick
name: country
type: int
description:
<p class="para">
            Country id identified by Gender class constant. If ommited ANY_COUNTRY is used.
          </p>


function_name: bind_textdomain_codeset
name: codeset
type: null
description:
<p class="para">
       The code set.
       If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the currently set encoding is returned.
      </p>


function_name: bindtextdomain
name: directory
type: null
description:
<p class="para">
       The directory path.
       An empty string means the current directory.
       If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the currently set directory is returned.
      </p>


function_name: ngettext
name: count
type: int
description:
<p class="para">
       The number (e.g. item count) to determine the translation for the
       respective grammatical number.
      </p>


function_name: textdomain
name: domain
type: null
description:
<p class="para">
       The new message domain, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to get the current setting without
       changing it
      </p>


function_name: iconv_get_encoding
name: type
type: string
initializer: "all"
description:
<p class="para">
       The value of the optional <code class="parameter">type</code> can be:
       <ul class="simplelist">
        <li>all</li>
        <li>input_encoding</li>
        <li>output_encoding</li>
        <li>internal_encoding</li>
       </ul>
      </p>


function_name: iconv_mime_decode_headers
name: mode
type: int
description:
<p class="para">
       <code class="parameter">mode</code> determines the behaviour in the event
       <span class="function">iconv_mime_decode_headers</span> encounters a malformed
       <code class="literal">MIME</code> header field. You can specify any combination
       of the following bitmasks.
       <table class="doctable table">
        <caption><strong>Bitmasks acceptable to <span class="function">iconv_mime_decode_headers</span></strong></caption>
        
         <thead>
          <tr>
           <th>Value</th>
           <th>Constant</th>
           <th>Description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>1</td>
           <td>ICONV_MIME_DECODE_STRICT</td>
           <td>
            If set, the given header is decoded in full conformance with the
            standards defined in <a href="http://www.faqs.org/rfcs/rfc2047" class="link external">&raquo;&nbsp;RFC2047</a>.
            This option is disabled by default because there are a lot of
            broken mail user agents that don&#039;t follow the specification and don&#039;t
            produce correct <code class="literal">MIME</code> headers.
           </td>
          </tr>

          <tr>
           <td>2</td>
           <td>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</td>
           <td>
            If set, <span class="function">iconv_mime_decode_headers</span>
            attempts to ignore any grammatical errors and continue to process
            a given header.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: iconv_mime_decode_headers
name: encoding
type: null
description:
<p class="para">
       The optional <code class="parameter">encoding</code> parameter specifies the
       character set to represent the result by. If omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>
       will be used.
      </p>


function_name: iconv_mime_decode
name: mode
type: int
description:
<p class="para">
       <code class="parameter">mode</code> determines the behaviour in the event
       <span class="function">iconv_mime_decode</span> encounters a malformed
       <code class="literal">MIME</code> header field. You can specify any combination
       of the following bitmasks.
       <table class="doctable table">
        <caption><strong>Bitmasks acceptable to <span class="function">iconv_mime_decode</span></strong></caption>
        
         <thead>
          <tr>
           <th>Value</th>
           <th>Constant</th>
           <th>Description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>1</td>
           <td>ICONV_MIME_DECODE_STRICT</td>
           <td>
            If set, the given header is decoded in full conformance with the
            standards defined in <a href="http://www.faqs.org/rfcs/rfc2047" class="link external">&raquo;&nbsp;RFC2047</a>.
            This option is disabled by default because there are a lot of
            broken mail user agents that don&#039;t follow the specification and don&#039;t
            produce correct <code class="literal">MIME</code> headers.
           </td>
          </tr>

          <tr>
           <td>2</td>
           <td>ICONV_MIME_DECODE_CONTINUE_ON_ERROR</td>
           <td>
            If set, <span class="function">iconv_mime_decode_headers</span>
            attempts to ignore any grammatical errors and continue to process
            a given header.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: iconv_mime_encode
name: options
type: array
initializer: []
description:
<p class="para">
       You can control the behaviour of <span class="function">iconv_mime_encode</span>
       by specifying an associative array that contains configuration items
       to the optional third parameter <code class="parameter">options</code>.
       The items supported by <span class="function">iconv_mime_encode</span> are
       listed below. Note that item names are treated case-sensitive.
       <table class="doctable table">
        <caption><strong>Configuration items supported by <span class="function">iconv_mime_encode</span></strong></caption>
        
         <thead>
          <tr>
           <th>Item</th>
           <th>Type</th>
           <th>Description</th>
           <th>Default value</th>
           <th>Example</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>scheme</td>
           <td><span class="type">string</span></td>
           <td>
            Specifies the method to encode a field value by. The value of
            this item may be either &quot;B&quot; or &quot;Q&quot;, where &quot;B&quot; stands for
            <code class="literal">base64</code> encoding scheme and &quot;Q&quot; stands for
            <code class="literal">quoted-printable</code> encoding scheme.
           </td>
           <td>B</td>
           <td>B</td>
          </tr>

          <tr>
           <td>input-charset</td>
           <td><span class="type">string</span></td>
           <td>
            Specifies the character set in which the first parameter
            <code class="parameter">field_name</code> and the second parameter
            <code class="parameter">field_value</code> are presented. If not given,
            <span class="function">iconv_mime_encode</span> assumes those parameters
            are presented to it in the
            <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>
            ini setting.
           </td>
           <td>
            <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>
           </td>
           <td>ISO-8859-1</td>
          </tr>

          <tr>
           <td>output-charset</td>
           <td><span class="type">string</span></td>
           <td>
            Specifies the character set to use to compose the
            <code class="literal">MIME</code> header.
           </td>
           <td>
            <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>
           </td>
           <td>UTF-8</td>
          </tr>

          <tr>
           <td>line-length</td>
           <td><span class="type">int</span></td>
           <td>
            Specifies the maximum length of the header lines. The resulting
            header is &quot;folded&quot; to a set of multiple lines in case
            the resulting header field would be longer than the value of this
            parameter, according to
            <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC2822 - Internet Message Format</a>.
            If not given, the length will be limited to 76 characters.
           </td>
           <td>76</td>
           <td>996</td>
          </tr>

          <tr>
           <td>line-break-chars</td>
           <td><span class="type">string</span></td>
           <td>
            Specifies the sequence of characters to append to each line
            as an end-of-line sign when &quot;folding&quot; is performed on a long header
            field. If not given, this defaults to &quot;\r\n&quot;
            (<code class="literal">CR</code> <code class="literal">LF</code>). Note that
            this parameter is always treated as an ASCII string regardless
            of the value of <code class="literal">input-charset</code>.
           </td>
           <td>\r\n</td>
           <td>\n</td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: iconv_set_encoding
name: type
type: string
description:
<p class="para">
       The value of <code class="parameter">type</code> can be any one of these:
       <ul class="simplelist">
        <li>input_encoding</li>
        <li>output_encoding</li>
        <li>internal_encoding</li>
       </ul>
      </p>


function_name: iconv_strlen
name: encoding
type: null
description:
<p class="para">
       If <code class="parameter">encoding</code> parameter is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       <code class="parameter">string</code> is assumed to be encoded in
       <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>.
      </p>


function_name: iconv_strpos
name: offset
type: int
description:
<p class="para">
       The optional <code class="parameter">offset</code> parameter specifies
       the position from which the search should be performed.
       If the offset is negative, it is counted from the end of the string.
      </p>


function_name: iconv_strpos
name: encoding
type: null
description:
<p class="para">
       If <code class="parameter">encoding</code> parameter is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       <code class="parameter">string</code> are assumed to be encoded in
       <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>.
      </p>


function_name: iconv_substr
name: offset
type: int
description:
<p class="para">
       If <code class="parameter">offset</code> is non-negative,
       <span class="function">iconv_substr</span> cuts the portion out of
       <code class="parameter">string</code> beginning at <code class="parameter">offset</code>&#039;th
       character, counting from zero.
      </p>
      <p class="para">
       If <code class="parameter">offset</code> is negative,
       <span class="function">iconv_substr</span> cuts out the portion beginning
       at the position, <code class="parameter">offset</code> characters
       away from the end of <code class="parameter">string</code>.
      </p>


function_name: iconv_substr
name: length
type: null
description:
<p class="para">
       If <code class="parameter">length</code> is given and is positive, the return
       value will contain at most <code class="parameter">length</code> characters
       of the portion that begins at <code class="parameter">offset</code>
       (depending on the length of <code class="parameter">string</code>).
      </p>
      <p class="para">
       If negative <code class="parameter">length</code> is passed,
       <span class="function">iconv_substr</span> cuts the portion out of
       <code class="parameter">string</code> from the <code class="parameter">offset</code>&#039;th
       character up to the character that is
       <code class="parameter">length</code> characters away from the end of the string.
       In case <code class="parameter">offset</code> is also negative, the start position
       is calculated beforehand according to the rule explained above.
      </p>


function_name: iconv_substr
name: encoding
type: null
description:
<p class="para">
       If <code class="parameter">encoding</code> parameter is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       <code class="parameter">string</code> are assumed to be encoded in
       <a href="iconv.configuration.html" class="link">iconv.internal_encoding</a>.
      </p>
      <p class="para">
       Note that <code class="parameter">offset</code> and <code class="parameter">length</code>
       parameters are always deemed to represent offsets that are
       calculated on the basis of the character set determined by
       <code class="parameter">encoding</code>, whilst the counterpart
       <span class="function">substr</span> always takes these for byte offsets.
      </p>


function_name: iconv
name: from_encoding
type: string
description:
<p class="para">
       The current encoding used to interpret <code class="parameter">string</code>.
      </p>


function_name: iconv
name: to_encoding
type: string
description:
<p class="para">
       The desired encoding of the result.
      </p>
      <p class="para">
       If the string <code class="literal">//TRANSLIT</code> is appended to
       <code class="parameter">to_encoding</code>, then transliteration is activated. This
       means that when a character can&#039;t be represented in the target charset,
       it may be approximated through one or several similarly looking
       characters. If the string <code class="literal">//IGNORE</code> is appended,
       characters that cannot be represented in the target charset are silently
       discarded. Otherwise, <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong> is generated and the function
       will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
      </p>
      <div class="caution"><strong class="caution">Caution</strong>
       <p class="para">
        If and how <code class="literal">//TRANSLIT</code> works exactly depends on the
        system&#039;s iconv() implementation (cf. <strong><code><a href="iconv.constants.html#constant.iconv-impl">ICONV_IMPL</a></code></strong>).
        Some implementations are known to ignore <code class="literal">//TRANSLIT</code>,
        so the conversion is likely to fail for characters which are illegal for
        the <code class="parameter">to_encoding</code>.
       </p>
      </div>


function_name: Collator.asort
name: flags
type: int
initializer: Collator::SORT_REGULAR
description:
<p class="para">
          <strong><code><a href="class.collator.html#collator.constants.sort-string">Collator::SORT_STRING</a></code></strong>
          - compare items as strings
         </p>


function_name: Collator.__construct
name: locale
type: string
description:
<p class="para">
       The locale whose collation rules should be used. Special values for
       locales can be passed in - if an empty <span class="type">string</span> is passed for the locale, the
       default locale&#039;s collation rules will be used. If <code class="literal">&quot;root&quot;</code> is passed,
       <a href="https://www.unicode.org/reports/tr10/" class="link external">&raquo;&nbsp;UCA</a> rules will be used.
      </p>
      <p class="para">
       The <code class="parameter">locale</code> attribute is typically the most important attribute for
       correct sorting and matching, according to the user expectations in
       different countries and regions. The default
       <a href="https://www.unicode.org/reports/tr10/" class="link external">&raquo;&nbsp;UCA</a>
       ordering will only sort a few languages such as Dutch and Portuguese
       correctly (&quot;correctly&quot; meaning according to the normal expectations for
       users of the languages). Otherwise, you need to supply the locale to
       UCA in order to properly collate text for a given language. Thus a
       locale needs to be supplied so as to choose a collator that is
       correctly tailored for that locale. The choice of a locale will
       automatically preset the values for all of the attributes to something
       that is reasonable for that locale. Thus most of the time the other
       attributes do not need to be explicitly set. In some cases, the choice
       of locale will make a difference in string comparison performance
       and/or sort key length.
       
      </p>


function_name: Collator.create
name: locale
type: string
description:
<p class="para">
       The locale containing the required collation rules. Special values for
       locales can be passed in - if an empty <span class="type">string</span> is passed for the locale, the
       default locale collation rules will be used. If
       <code class="literal">&quot;root&quot;</code> is passed, <a href="https://www.unicode.org/reports/tr10/" class="link external">&raquo;&nbsp;UCA</a> rules will be used.
      </p>


function_name: Collator.getLocale
name: type
type: int
description:
<p class="para">
       You can choose between valid and actual locale (
       <strong><code><a href="class.locale.html#locale.constants.valid-locale">Locale::VALID_LOCALE</a></code></strong> and 
       <strong><code><a href="class.locale.html#locale.constants.actual-locale">Locale::ACTUAL_LOCALE</a></code></strong>,
       respectively).
      </p>


function_name: Collator.setStrength
name: strength
type: int
description:
<p class="para">
          <strong><code><a href="class.collator.html#collator.constants.default-strength">Collator::DEFAULT_STRENGTH</a></code></strong>
         </p>


function_name: NumberFormatter.create
name: locale
type: string
description:
<p class="para">
       Locale in which the number would be formatted (locale name, e.g. en_CA).
      </p>


function_name: NumberFormatter.create
name: style
type: int
description:
<p class="para">
       Style of the formatting, one of the
       <a href="class.numberformatter.html#intl.numberformatter-constants.unumberformatstyle" class="link">
        format style</a> constants. If
       <strong><code><a href="class.numberformatter.html#numberformatter.constants.pattern-decimal">NumberFormatter::PATTERN_DECIMAL</a></code></strong>
       or <strong><code><a href="class.numberformatter.html#numberformatter.constants.pattern-rulebased">NumberFormatter::PATTERN_RULEBASED</a></code></strong>
       is passed then the number format is opened using the given pattern,
       which must conform to the syntax described in
       <a href="https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classDecimalFormat.html" class="link external">&raquo;&nbsp;ICU DecimalFormat
       documentation</a> or
       <a href="https://unicode-org.github.io/icu/userguide/format_parse/numbers/rbnf.html" class="link external">&raquo;&nbsp;ICU RuleBasedNumberFormat
       documentation</a>, respectively.
      </p>


function_name: NumberFormatter.formatCurrency
name: currency
type: string
description:
<p class="para">
       The 3-letter ISO 4217 currency code indicating the currency to use.
      </p>


function_name: NumberFormatter.format
name: num
type: float
description:
<p class="para">
       The value to format. Can be <span class="type">int</span> or <span class="type">float</span>,
       other values will be converted to a numeric value.
      </p>


function_name: NumberFormatter.format
name: type
type: int
initializer: NumberFormatter::TYPE_DEFAULT
description:
<p class="para">
       The
       <a href="class.numberformatter.html#intl.numberformatter-constants.types" class="link">
        formatting type</a> to use.
       Note that <strong><code><a href="class.numberformatter.html#numberformatter.constants.type-currency">NumberFormatter::TYPE_CURRENCY</a></code></strong> is not supported;
       use  <span class="methodname">NumberFormatter::formatCurrency</span> instead.
      </p>


function_name: NumberFormatter.getAttribute
name: attribute
type: int
description:
<p class="para">
       Attribute specifier - one of the
       <a href="class.numberformatter.html#intl.numberformatter-constants.unumberformatattribute" class="link">
        numeric attribute</a> constants.
      </p>


function_name: NumberFormatter.getLocale
name: type
type: int
description:
<p class="para">
       You can choose between valid and actual locale (
       <strong><code><a href="class.locale.html#locale.constants.valid-locale">Locale::VALID_LOCALE</a></code></strong>,
       <strong><code><a href="class.locale.html#locale.constants.actual-locale">Locale::ACTUAL_LOCALE</a></code></strong>,
       respectively). The default is the actual locale.
      </p>


function_name: NumberFormatter.getSymbol
name: symbol
type: int
description:
<p class="para">
       Symbol specifier, one of the
       <a href="class.numberformatter.html#intl.numberformatter-constants.unumberformatsymbol" class="link">
        format symbol</a> constants.
      </p>


function_name: NumberFormatter.getTextAttribute
name: attribute
type: int
description:
<p class="para">
       Attribute specifier - one of the
       <a href="class.numberformatter.html#intl.numberformatter-constants.unumberformattextattribute" class="link">
        text attribute</a> constants.
      </p>


function_name: NumberFormatter.parseCurrency
name: currency
type: string
description:
<p class="para">
       Parameter to receive the currency name (3-letter ISO 4217 currency
       code).
      </p>


function_name: NumberFormatter.parseCurrency
name: offset
type: int
description:
<p class="para">
       Offset in the string at which to begin parsing. On return, this value
       will hold the offset at which parsing ended.
      </p>


function_name: NumberFormatter.parse
name: type
type: int
initializer: NumberFormatter::TYPE_DOUBLE
description:
<p class="para">
       The
       <a href="class.numberformatter.html#intl.numberformatter-constants.types" class="link">
        formatting type</a> to use. By default,
       <strong><code><a href="class.numberformatter.html#numberformatter.constants.type-double">NumberFormatter::TYPE_DOUBLE</a></code></strong> is used.
       Note that <strong><code><a href="class.numberformatter.html#numberformatter.constants.type-currency">NumberFormatter::TYPE_CURRENCY</a></code></strong> is not supported;
       use  <span class="methodname">NumberFormatter::parseCurrency</span> instead.
      </p>


function_name: NumberFormatter.setPattern
name: pattern
type: string
description:
<p class="para">
       Pattern in syntax described in
       <a href="https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/classDecimalFormat.html" class="link external">&raquo;&nbsp;ICU DecimalFormat
       documentation</a>.
      </p>


function_name: NumberFormatter.setTextAttribute
name: attribute
type: int
description:
<p class="para">
       Attribute specifier - one of the
       <a href="class.numberformatter.html#intl.numberformatter-constants.unumberformattextattribute" class="link">text attribute</a>
       constants.
      </p>


function_name: Locale.acceptFromHttp
name: header
type: string
description:
<p class="para">
       The string containing the &quot;Accept-Language&quot; header according to format in RFC 2616.
      </p>


function_name: Locale.composeLocale
name: subtags
type: array
description:
<p class="para">
       An <span class="type">array</span> containing a list of key-value pairs, where the keys identify
       the particular locale ID subtags, and the values are the associated
       subtag values.
       <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
         The <code class="literal">&#039;variant&#039;</code> and <code class="literal">&#039;private&#039;</code> subtags can take maximum 15 values
         whereas <code class="literal">&#039;extlang&#039;</code> can take maximum 3 values. For instance, variants are allowed
         with the suffix ranging from 0-14. Hence the keys for the input array
         can be <code class="literal">variant0</code>, <code class="literal">variant1</code>, …,<code class="literal">variant14</code>. In the returned locale id,
         the subtag is ordered by suffix resulting in <code class="literal">variant0</code> followed by
         <code class="literal">variant1</code> followed by <code class="literal">variant2</code> and so on.
        </p>
        <p class="para">
         Alternatively, the <code class="literal">&#039;variant&#039;</code>, <code class="literal">&#039;private&#039;</code> and <code class="literal">&#039;extlang&#039;</code> values can be specified
         as array under specific key (e.g. <code class="literal">&#039;variant&#039;</code>).
         In this case no limits on the number of recognized subtags apply.
        </p>
       </p></blockquote>
      </p>


function_name: Locale.filterMatches
name: canonicalize
type: bool
description:
<p class="para">
      If true, the arguments will be converted to canonical form before
      matching.
     </p>


function_name: Locale.lookup
name: languageTag
type: array
description:
<p class="para">
       An <span class="type">array</span> containing a list of language tags to compare to
       <code class="parameter">locale</code>. Maximum 100 items allowed.
      </p>


function_name: Locale.lookup
name: canonicalize
type: bool
description:
<p class="para">
           If true, the arguments will be converted to canonical form before
           matching.
         </p>


function_name: Locale.parseLocale
name: locale
type: string
description:
<p class="para">
       The locale to extract the subtag array from. Note: The &#039;variant&#039; and
       &#039;private&#039; subtags can take maximum 15 values whereas &#039;extlang&#039; can take
       maximum 3 values.
      </p>


function_name: Normalizer.getRawDecomposition
name: string
type: string
description:
<p class="para">
      The input string, which should be a single, UTF-8 encoded, code point.
     </p>


function_name: MessageFormatter.create
name: pattern
type: string
description:
<p class="para">
       The pattern string to stick arguments into. 
       The pattern uses an &#039;apostrophe-friendly&#039; syntax;
       see <a href="https://unicode-org.github.io/icu/userguide/format_parse/messages/#quotingescaping" class="link external">&raquo;&nbsp;Quoting/Escaping</a> for details.
      </p>


function_name: MessageFormatter.formatMessage
name: pattern
type: string
description:
<p class="para">
       The pattern <span class="type">string</span> to insert things into.
       The pattern uses an &#039;apostrophe-friendly&#039; syntax;
       see <a href="https://unicode-org.github.io/icu/userguide/format_parse/messages/#quotingescaping" class="link external">&raquo;&nbsp;Quoting/Escaping</a> for details.
      </p>


function_name: MessageFormatter.formatMessage
name: values
type: array
description:
<p class="para">
       The <span class="type">array</span> of values to insert into the format <span class="type">string</span>
      </p>


function_name: MessageFormatter.parseMessage
name: pattern
type: string
description:
<p class="para">
       The pattern with which to parse the <code class="parameter">message</code>.
      </p>


function_name: MessageFormatter.parseMessage
name: message
type: string
description:
<p class="para">
       The <span class="type">string</span> to parse, conforming to the <code class="parameter">pattern</code>.
      </p>


function_name: MessageFormatter.setPattern
name: pattern
type: string
description:
<p class="para">
       The pattern <span class="type">string</span> to use in this message formatter.
       The pattern uses an &#039;apostrophe-friendly&#039; syntax;
       see <a href="https://unicode-org.github.io/icu/userguide/format_parse/messages/#quotingescaping" class="link external">&raquo;&nbsp;Quoting/Escaping</a> for details.
      </p>


function_name: IntlCalendar.add
name: field
type: int
description:
<p class="para">
 One of the <span class="classname">IntlCalendar</span> date/time <a href="class.intlcalendar.html#intlcalendar.constants" class="link">field constants</a>. These are integer
 values between <code class="literal">0</code> and
 <strong><code>IntlCalendar::FIELD_COUNT</code></strong>.
</p>


function_name: IntlCalendar.add
name: value
type: int
description:
<p class="para">
      The signed amount to add to the current field. If the amount is positive,
      the instant will be moved forward; if it is negative, the instant will be
      moved into the past. The unit is implicit to the field type. For instance,
      hours for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-hour-of-day">IntlCalendar::FIELD_HOUR_OF_DAY</a></code></strong>.
     </p>


function_name: IntlCalendar.after
name: other
type: IntlCalendar
description:
<p class="para">
      The calendar whose time will be checked against the primary objectʼs time.
     </p>


function_name: IntlCalendar.createInstance
name: timezone
type: null
description:
<p class="para">
   A <span class="type">string</span>, which should be a valid ICU timezone identifier.
   See <span class="function">IntlTimeZone::createTimeZoneIDEnumeration</span>. Raw
   offsets such as <code class="literal">&quot;GMT+08:30&quot;</code> are also accepted.
  </p>


function_name: IntlCalendar.createInstance
name: locale
type: null
description:
<p class="para">
      A locale to use or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to use <a href="intl.configuration.html#ini.intl.default-locale" class="link">the default locale</a>.
     </p>


function_name: IntlCalendar.fieldDifference
name: timestamp
type: float
description:
<p class="para">
      The time against which to compare the quantity represented by the
      <code class="parameter">field</code>. For the result to be positive, the time
      given for this parameter must be ahead of the time of the object the
      method is being invoked on.
     </p>


function_name: IntlCalendar.fieldDifference
name: field
type: int
description:
<p class="para">
      The field that represents the quantity being compared.
     </p>
     

<p class="para">
 One of the <span class="classname">IntlCalendar</span> date/time <a href="class.intlcalendar.html#intlcalendar.constants" class="link">field constants</a>. These are integer
 values between <code class="literal">0</code> and
 <strong><code>IntlCalendar::FIELD_COUNT</code></strong>.
</p>


function_name: IntlCalendar.fromDateTime
name: datetime
type: string
description:
<p class="para">
      A <span class="classname">DateTime</span> object or a <span class="type">string</span> that
      can be passed to <span class="function">DateTime::__construct</span>.
     </p>


function_name: IntlCalendar.getDayOfWeekType
name: dayOfWeek
type: int
description:
<p class="para">
      One of the constants <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-sunday">IntlCalendar::DOW_SUNDAY</a></code></strong>,
      <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-monday">IntlCalendar::DOW_MONDAY</a></code></strong>, …,
      <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-saturday">IntlCalendar::DOW_SATURDAY</a></code></strong>.
     </p>


function_name: IntlCalendar.getKeywordValuesForLocale
name: keyword
type: string
description:
<p class="para">
      The locale keyword for which relevant values are to be queried. Only
      <code class="literal">&#039;calendar&#039;</code> is supported.
     </p>


function_name: IntlCalendar.getKeywordValuesForLocale
name: onlyCommon
type: bool
description:
<p class="para">
      Whether to show only the values commonly used for the specified locale.
     </p>


function_name: IntlCalendar.getLocale
name: type
type: int
description:
<p class="para">
      Whether to fetch the actual locale (the locale from which the calendar
      data originates, with <strong><code><a href="class.locale.html#locale.constants.actual-locale">Locale::ACTUAL_LOCALE</a></code></strong>) or the
      valid locale, i.e., the most specific locale supported by ICU relatively
      to the requested locale – see <strong><code><a href="class.locale.html#locale.constants.valid-locale">Locale::VALID_LOCALE</a></code></strong>.
      From the most general to the most specific, the locales are ordered in
      this fashion – actual locale, valid locale, requested locale.
     </p>


function_name: IntlCalendar.isWeekend
name: timestamp
type: null
description:
<p class="para">
      An optional timestamp representing the number of milliseconds since the
      epoch, excluding leap seconds. If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, this objectʼs current time is
      used instead.
     </p>


function_name: IntlCalendar.roll
name: value
type: bool
description:
<p class="para">
      The (signed) amount to add to the field, <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> for rolling up (adding
      <code class="literal">1</code>), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for rolling down (subtracting
      <code class="literal">1</code>).
     </p>


function_name: IntlCalendar.set
name: year
type: int
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-year">IntlCalendar::FIELD_YEAR</a></code></strong>.
     </p>


function_name: IntlCalendar.set
name: month
type: int
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-month">IntlCalendar::FIELD_MONTH</a></code></strong>.
      The month sequence is zero-based, i.e., January is represented by 0,
      February by 1, …, December is 11 and Undecember (if the calendar has
      it) is 12.
     </p>


function_name: IntlCalendar.set
name: dayOfMonth
type: int
initializer: NULL
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-day-of-month">IntlCalendar::FIELD_DAY_OF_MONTH</a></code></strong>.
     </p>


function_name: IntlCalendar.set
name: hour
type: int
initializer: NULL
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-hour-of-day">IntlCalendar::FIELD_HOUR_OF_DAY</a></code></strong>. 
     </p>


function_name: IntlCalendar.set
name: minute
type: int
initializer: NULL
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-minute">IntlCalendar::FIELD_MINUTE</a></code></strong>.
      </p>


function_name: IntlCalendar.set
name: second
type: int
initializer: NULL
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-second">IntlCalendar::FIELD_SECOND</a></code></strong>.  
     </p>


function_name: IntlCalendar.setDateTime
name: hour
type: int
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-hour-of-day">IntlCalendar::FIELD_HOUR_OF_DAY</a></code></strong>.
     </p>


function_name: IntlCalendar.setDateTime
name: minute
type: int
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-minute">IntlCalendar::FIELD_MINUTE</a></code></strong>.
     </p>


function_name: IntlCalendar.setDateTime
name: second
type: null
description:
<p class="para">
      The new value for <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.field-second">IntlCalendar::FIELD_SECOND</a></code></strong>.
     </p>


function_name: IntlCalendar.setLenient
name: lenient
type: bool
description:
<p class="para">
      Use <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> to activate the lenient mode; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
     </p>


function_name: IntlCalendar.setRepeatedWallTimeOption
name: option
type: int
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>


function_name: IntlCalendar.setSkippedWallTimeOption
name: option
type: int
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>


function_name: IntlCalendar.setTime
name: timestamp
type: float
description:
<p class="para">
      An instant represented by the number of number of milliseconds between
      such instant and the epoch, ignoring leap seconds.
     </p>


function_name: IntlGregorianCalendar.createFromDate
name: year
type: int
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_YEAR</code></strong>.
     </p>


function_name: IntlGregorianCalendar.createFromDate
name: month
type: int
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_MONTH</code></strong>.
      The month sequence is zero-based, i.e., January is represented by 0,
      February by 1, …, December is 11 and Undecember (if the calendar has
      it) is 12.
     </p>


function_name: IntlGregorianCalendar.createFromDate
name: dayOfMonth
type: int
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_DAY_OF_MONTH</code></strong>.
     </p>


function_name: IntlGregorianCalendar.createFromDateTime
name: hour
type: int
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_HOUR_OF_DAY</code></strong>.
     </p>


function_name: IntlGregorianCalendar.createFromDateTime
name: minute
type: int
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_MINUTE</code></strong>.
     </p>


function_name: IntlGregorianCalendar.createFromDateTime
name: second
type: null
description:
<p class="para">
      The new value for <strong><code>IntlGregorianCalendar::FIELD_SECOND</code></strong>.
     </p>


function_name: IntlDateFormatter.create
name: locale
type: null
description:
<p class="para">
       Locale to use when formatting or parsing or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to use the value
       specified in the ini setting <a href="intl.configuration.html#ini.intl.default-locale" class="link">intl.default_locale</a>.
      </p>


function_name: IntlDateFormatter.create
name: dateType
type: int
initializer: IntlDateFormatter::FULL
description:
<p class="para">
       Format of the date determined by one of the
       <a href="class.intldateformatter.html#intl.intldateformatter-constants" class="link">IntlDateFormatter
       constants</a>. The default value is
       <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.full">IntlDateFormatter::FULL</a></code></strong>.
      </p>


function_name: IntlDateFormatter.create
name: timeType
type: int
initializer: IntlDateFormatter::FULL
description:
<p class="para">
       Format of the time determined by one of the
       <a href="class.intldateformatter.html#intl.intldateformatter-constants" class="link">IntlDateFormatter
       constants</a>. The default value is
       <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.full">IntlDateFormatter::FULL</a></code></strong>.
      </p>


function_name: IntlDateFormatter.create
name: timezone
type: null
description:
<p class="para">
       Time zone ID. The default (and the one used if <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is given) is the
       one returned by <span class="function">date_default_timezone_get</span> or, if
       applicable, that of the <span class="classname">IntlCalendar</span> object passed
       for the <code class="parameter">calendar</code> parameter. This ID must be a
       valid identifier on ICUʼs database or an ID representing an
       explicit offset, such as <code class="literal">GMT-05:30</code>.
      </p>
      <p class="para">
       This can also be an <span class="classname">IntlTimeZone</span> or a
       <span class="classname">DateTimeZone</span> object.
      </p>


function_name: IntlDateFormatter.create
name: calendar
type: null
description:
<p class="para">
       Calendar to use for formatting or parsing. The default value is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       which corresponds to <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.gregorian">IntlDateFormatter::GREGORIAN</a></code></strong>.
       This can either be one of the
       <a href="class.intldateformatter.html#intl.intldateformatter-constants.calendartypes" class="link">IntlDateFormatter
       calendar constants</a> or an <span class="classname">IntlCalendar</span>. Any
       <span class="classname">IntlCalendar</span> object passed will be clone; it will
       not be changed by the <span class="classname">IntlDateFormatter</span>. This will
       determine the calendar type used (gregorian, islamic, persian, etc.) and,
       if <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is given for the <code class="parameter">timezone</code> parameter,
       also the timezone used.
      </p>


function_name: IntlDateFormatter.create
name: pattern
type: null
description:
<p class="para">
       Optional pattern to use when formatting or parsing.
       Possible patterns are documented at <a href="https://unicode-org.github.io/icu/userguide/format_parse/datetime/" class="link external">&raquo;&nbsp;https://unicode-org.github.io/icu/userguide/format_parse/datetime/</a>.
      </p>


function_name: IntlDateFormatter.format
name: datetime
type: float
description:
<p class="para">
       Value to format. This may be a <span class="classname">DateTimeInterface</span> object, an
       <span class="classname">IntlCalendar</span> object, a <span class="type">numeric</span> type
       representing a (possibly fractional) number of seconds since epoch or an
       <span class="type">array</span> in the format output by
       <span class="function">localtime</span>.
      </p>
      <p class="para">
       If a <span class="classname">DateTime</span> or an
       <span class="classname">IntlCalendar</span> object is passed, its timezone is not
       considered. The object will be formatted using the formaterʼs configured
       timezone. If one wants to use the timezone of the object to be formatted,
       <span class="function">IntlDateFormatter::setTimeZone</span> must be called before
       with the objectʼs timezone. Alternatively, the static function
       <span class="function">IntlDateFormatter::formatObject</span> may be used instead.
      </p>


function_name: IntlDateFormatter.formatObject
name: datetime
type: DateTimeInterface
description:
<p class="para">
      An object of type <span class="classname">IntlCalendar</span> or
      <span class="classname">DateTime</span>. The timezone information in the object
      will be used.
     </p>


function_name: IntlDateFormatter.formatObject
name: format
type: null
description:
<p class="para">
      How to format the date/time. This can either be an <span class="type">array</span> with
      two elements (first the date style, then the time style, these being one
      of the constants <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.none">IntlDateFormatter::NONE</a></code></strong>,
      <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.short">IntlDateFormatter::SHORT</a></code></strong>,
      <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.medium">IntlDateFormatter::MEDIUM</a></code></strong>,
      <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.long">IntlDateFormatter::LONG</a></code></strong>,
      <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.full">IntlDateFormatter::FULL</a></code></strong>), an <span class="type">int</span> with
      the value of one of these constants (in which case it will be used both
      for the time and the date) or a <span class="type">string</span> with the format
      described in <a href="https://unicode-org.github.io/icu/userguide/format_parse/datetime/#datetime-format-syntax" class="link external">&raquo;&nbsp;the ICU
      documentation</a>. If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the default style will be used.
     </p>


function_name: IntlDateFormatter.formatObject
name: locale
type: null
description:
<p class="para">
      The locale to use, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to use the <a href="intl.configuration.html#ini.intl.default-locale" class="link">default one</a>.
     </p>


function_name: IntlDateFormatter.localtime
name: offset
type: int
description:
<p class="para">
       Position at which to start the parsing in $value (zero-based).
       If no error occurs before $value is consumed, $parse_pos will contain -1
       otherwise it will contain the position at which parsing ended .
       If $parse_pos &gt; strlen($value), the parse fails immediately.  
      </p>


function_name: IntlDateFormatter.parse
name: offset
type: int
description:
<p class="para">
       Position at which to start the parsing in <code class="parameter">string</code> (zero-based).
       If no error occurs before <code class="parameter">string</code> is consumed, <code class="parameter">offset</code> will contain -1
       otherwise it will contain the position at which parsing ended (and the error occurred).
       This variable will contain the end position if the parse fails.
       If <code class="parameter">offset</code> &gt; <code class="code">strlen($string)</code>, the parse fails immediately.
     </p>


function_name: IntlDateFormatter.setCalendar
name: calendar
type: null
description:
<p class="para">
       This can either be: the <a href="class.intldateformatter.html#intl.intldateformatter-constants.calendartypes" class="link">calendar
       type</a> to use (default is
       <strong><code><a href="class.intldateformatter.html#intldateformatter.constants.gregorian">IntlDateFormatter::GREGORIAN</a></code></strong>, which is also used if
       <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is specified) or an
       <span class="classname">IntlCalendar</span> object.
     </p>
     <p class="para">
      Any <span class="classname">IntlCalendar</span> object passed in will be cloned;
      no modifications will be made to the argument object.
     </p>
     <p class="para">
      The timezone of the formatter will only be kept if an
      <span class="classname">IntlCalendar</span> object is not passed, otherwise the
      new timezone will be that of the passed object.
     </p>


function_name: IntlDateFormatter.setLenient
name: lenient
type: bool
description:
<p class="para">
       Sets whether the parser is lenient or not, default is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> (lenient).
      </p>


function_name: IntlDateFormatter.setPattern
name: pattern
type: string
description:
<p class="para">
       New pattern string to use.
       Possible patterns are documented at <a href="https://unicode-org.github.io/icu/userguide/format_parse/datetime/" class="link external">&raquo;&nbsp;https://unicode-org.github.io/icu/userguide/format_parse/datetime/</a>.
      </p>


function_name: ResourceBundle.create
name: locale
type: null
description:
<p class="para">
       Locale for which the resources should be loaded (locale name, e.g. en_CA).
      </p>


function_name: ResourceBundle.create
name: bundle
type: null
description:
<p class="para">
       The directory where the data is stored or the name of the .dat file.
      </p>


function_name: ResourceBundle.create
name: fallback
type: bool
description:
<p class="para">
       Whether locale should match exactly or fallback to parent locale is allowed.
      </p>


function_name: ResourceBundle.getLocales
name: bundle
type: string
description:
<p class="para">
       Path of ResourceBundle for which to get available locales, or
       empty string for default locales list.
      </p>


function_name: Spoofchecker.areConfusable
name: errorCode
type: int
description:
<p class="para">
      This variable is set by-reference to <span class="type">int</span> containing an error, if there
      was any.
     </p>


function_name: Spoofchecker.setChecks
name: checks
type: int
description:
<p class="para">
      The checks that will be performed by  <span class="methodname">SpoofChecker::isSuspicious</span>.
      A bitmask of
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.single-script-confusable">Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.mixed-script-confusable">Spoofchecker::MIXED_SCRIPT_CONFUSABLE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.whole-script-confusable">Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.any-case">Spoofchecker::ANY_CASE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.single-script">Spoofchecker::SINGLE_SCRIPT</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.invisible">Spoofchecker::INVISIBLE</a></code></strong>, or
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.char-limit">Spoofchecker::CHAR_LIMIT</a></code></strong>.
      Defaults to all checks as of ICU 58; prior to that version,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.single-script">Spoofchecker::SINGLE_SCRIPT</a></code></strong> was excluded.
     </p>


function_name: Spoofchecker.setRestrictionLevel
name: level
type: int
description:
<p class="para">
      The restriction level of  <span class="methodname">SpoofChecker::isSuspicious</span>.
      One of
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.ascii">Spoofchecker::ASCII</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.single-script-restrictive">Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.highly-restrictive">Spoofchecker::HIGHLY_RESTRICTIVE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.moderately-restrictive">Spoofchecker::MODERATELY_RESTRICTIVE</a></code></strong>,
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.minimally-restrictive">Spoofchecker::MINIMALLY_RESTRICTIVE</a></code></strong>, or
      <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.unrestrictive">Spoofchecker::UNRESTRICTIVE</a></code></strong>.
      Defaults to <strong><code><a href="class.spoofchecker.html#spoofchecker.constants.highly-restrictive">Spoofchecker::HIGHLY_RESTRICTIVE</a></code></strong>.
     </p>


function_name: Transliterator.create
name: id
type: string
description:
<p class="para">
      The ID. A list of all registered transliterator IDs can be retrieved by using
       <span class="methodname">Transliterator::listIDs</span>.
     </p>


function_name: Transliterator.create
name: direction
type: int
initializer: Transliterator::FORWARD
description:
<p class="para">
      The direction, defaults to 
      <a href="class.transliterator.html#transliterator.constants.forward" class="link">Transliterator::FORWARD</a>.
      May also be set to
      <a href="class.transliterator.html#transliterator.constants.reverse" class="link">Transliterator::REVERSE</a>.
     </p>


function_name: Transliterator.createFromRules
name: rules
type: string
description:
<p class="para">
      The rules as defined in Transform Rules Syntax of UTS #35: Unicode LDML.
     </p>


function_name: Transliterator.transliterate
name: start
type: int
description:
<p class="para">
      The start index (in UTF-16 code units) from which the string will start
      to be transformed, inclusive. Indexing starts at 0. The text before will
      be left as is.
     </p>


function_name: Transliterator.transliterate
name: end
type: int
initializer: -1
description:
<p class="para">
      The end index (in UTF-16 code units) until which the string will be
      transformed, exclusive. Indexing starts at 0. The text after will be
      left as is.
     </p>


function_name: Transliterator.transliterate
name: transliterator
type: string
description:
<p class="para">
      In the procedural version, either a <span class="classname">Transliterator</span>
      or a <span class="type">string</span> from which a
      <span class="classname">Transliterator</span> can be built.
     </p>


function_name: IntlBreakIterator.getPartsIterator
name: type
type: string
initializer: IntlPartsIterator::KEY_SEQUENTIAL
description:
<p class="para">
      Optional key type. Possible values are:
      <ul class="simplelist">
       <li>
        <strong><code><a href="class.intlpartsiterator.html#intlpartsiterator.constants.key-sequential">IntlPartsIterator::KEY_SEQUENTIAL</a></code></strong>
        - The default. Sequentially increasing integers used as key.
       </li>
       <li>
        <strong><code><a href="class.intlpartsiterator.html#intlpartsiterator.constants.key-left">IntlPartsIterator::KEY_LEFT</a></code></strong>
        - Byte offset left of current part used as key.
       </li>
       <li>
        <strong><code><a href="class.intlpartsiterator.html#intlpartsiterator.constants.key-right">IntlPartsIterator::KEY_RIGHT</a></code></strong>
        - Byte offset right of current part used as key.
       </li>
      </ul>
     </p>


function_name: IntlDatePatternGenerator.create
name: locale
type: null
description:
<p class="para">
      The locale.
      If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is passed, uses the ini setting <a href="intl.configuration.html#ini.intl.default-locale" class="link">intl.default_locale</a>.
     </p>


function_name: UConverter.transcode
name: fromEncoding
type: string
description:
<p class="para">
      The current encoding used to interpret <code class="parameter">str</code>.
     </p>


function_name: UConverter.transcode
name: options
type: null
description:
<p class="para">
      An optional <span class="type">array</span>, which may contain the following keys:
      <ul class="simplelist">
       <li>
        <code class="literal">&#039;to_subst&#039;</code> - the substitution character to use
        in place of any character of <code class="parameter">str</code> which cannot
        be encoded in <code class="parameter">toEncoding</code>. If specified, it must
        represent a single character in the target encoding.
       </li>
      </ul>
     </p>


function_name: grapheme_extract
name: size
type: int
description:
<p class="para">
       Maximum number items - based on the <code class="parameter">type</code> - to return.
      </p>


function_name: grapheme_extract
name: type
type: int
description:
<p class="para">
       Defines the type of units referred to by the <code class="parameter">size</code> parameter:
      </p>
       <p class="para">
        <ul class="simplelist">
         <li>GRAPHEME_EXTR_COUNT (default) -<code class="parameter">size</code> is the number of default
         grapheme clusters to extract.</li>
         <li>GRAPHEME_EXTR_MAXBYTES -<code class="parameter">size</code> is the maximum number of bytes
         returned.</li>
         <li>GRAPHEME_EXTR_MAXCHARS - <code class="parameter">size</code> is the maximum number of UTF-8
         characters returned.</li>
        </ul>
       </p>


function_name: grapheme_extract
name: offset
type: int
description:
<p class="para">
       Starting position in <code class="parameter">haystack</code> in bytes - if given, it must be zero or a
       positive value that is less than or equal to the length of <code class="parameter">haystack</code> in
       bytes, or a negative value that counts from the end of <code class="parameter">haystack</code>.
       If <code class="parameter">offset</code> does not point to the first byte of a UTF-8
       character, the start position is moved to the next character boundary.
      </p>


function_name: grapheme_extract
name: next
type: int
description:
<p class="para">
       Reference to a value that will be set to the next starting position.
       When the call returns, this may point to the first byte position past the end of the string.
      </p>


function_name: grapheme_stripos
name: offset
type: int
description:
<p class="para">
       The optional <code class="parameter">offset</code> parameter allows you to specify where in <code class="parameter">haystack</code> to
       start searching as an offset in grapheme units (not bytes or characters).
       If the offset is negative, it is treated relative to the end of the string.
       The position returned is still relative to the beginning of <code class="parameter">haystack</code>
       regardless of the value of <code class="parameter">offset</code>.
      </p>


function_name: grapheme_stristr
name: beforeNeedle
type: bool
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, <span class="function">grapheme_stristr</span> returns the part of the
       <code class="parameter">haystack</code> before the first occurrence of the needle (excluding <code class="parameter">needle</code>).
      </p>


function_name: grapheme_strlen
name: string
type: string
description:
<p class="para">
       The string being measured for length. It must be a valid UTF-8 string.
      </p>


function_name: grapheme_strripos
name: offset
type: int
description:
<p class="para">
       The optional <code class="parameter">offset</code> parameter allows you to specify where in <code class="parameter">haystack</code> to
       start searching as an offset in grapheme units (not bytes or characters).
       The position returned is still relative to the beginning of <code class="parameter">haystack</code>
       regardless of the value of <code class="parameter">offset</code>.
      </p>


function_name: grapheme_strstr
name: beforeNeedle
type: bool
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, <span class="function">grapheme_strstr</span> returns the part of the
       <code class="parameter">haystack</code> before the first occurrence of the <code class="parameter">needle</code> (excluding the <code class="parameter">needle</code>).
      </p>


function_name: grapheme_substr
name: offset
type: int
description:
<p class="para">
       Start position in default grapheme units.
       If <code class="parameter">offset</code> is non-negative, the returned string will start at the
       <code class="parameter">offset</code>&#039;th position in <code class="parameter">string</code>, counting from zero. If <code class="parameter">offset</code> is negative,
       the returned string will start at the <code class="parameter">offset</code>&#039;th grapheme unit from the 
       end of string.
      </p>


function_name: grapheme_substr
name: length
type: null
description:
<p class="para">
       Length in grapheme units.
       If <code class="parameter">length</code> is given and is positive, the string returned will contain
       at most <code class="parameter">length</code> grapheme units beginning from <code class="parameter">offset</code> (depending on the 
       length of string). If <code class="parameter">length</code> is given and is negative, then
       that many grapheme units will be omitted from the end of string (after the
       start position has been calculated when <code class="parameter">offset</code> is negative). If <code class="parameter">offset</code>
       denotes a position beyond this truncation, an empty string will be returned.
      </p>


function_name: idn_to_ascii
name: flags
type: int
description:
<p class="para">
       Conversion options - combination of IDNA_* constants
       (except IDNA_ERROR_* constants).
      </p>


function_name: idn_to_ascii
name: variant
type: int
description:
<p class="para">
       Either <strong><code><a href="intl.constants.html#constant.intl-idna-variant-2003">INTL_IDNA_VARIANT_2003</a></code></strong> (deprecated as of PHP 7.2.0) for IDNA 2003 or
       <strong><code><a href="intl.constants.html#constant.intl-idna-variant-uts46">INTL_IDNA_VARIANT_UTS46</a></code></strong> (only available as of ICU 4.6) for UTS #46.
      </p>


function_name: idn_to_ascii
name: idna_info
type: array
description:
<p class="para">
       This parameter can be used only if
       <strong><code><a href="intl.constants.html#constant.intl-idna-variant-uts46">INTL_IDNA_VARIANT_UTS46</a></code></strong> was used for
       <code class="parameter">variant</code>. In that case, it will be filled with an
       array with the keys <code class="literal">&#039;result&#039;</code>, the possibly illegal
       result of the transformation,
       <code class="literal">&#039;isTransitionalDifferent&#039;</code>, a boolean indicating
       whether the usage of the transitional mechanisms of UTS #46 either has
       or would have changed the result and <code class="literal">&#039;errors&#039;</code>,
       which is an <span class="type">int</span> representing a bitset of the error
       constants IDNA_ERROR_*.
      </p>


function_name: IntlChar.charAge
name: codepoint
type: string
description:
<p class="para">The <span class="type">int</span> codepoint value (e.g. <code class="literal">0x2603</code> for <em>U+2603 SNOWMAN</em>), or the character encoded as a UTF-8 <span class="type">string</span> (e.g. <code class="literal">&quot;\u{2603}&quot;</code>)</p>


function_name: IntlChar.charFromName
name: type
type: int
initializer: IntlChar::UNICODE_CHAR_NAME
description:
<p class="para">
      Which set of names to use for the lookup. Can be any of these constants:
      <ul class="simplelist">
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.unicode-char-name">IntlChar::UNICODE_CHAR_NAME</a></code></strong> (default)</li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.unicode-10-char-name">IntlChar::UNICODE_10_CHAR_NAME</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.extended-char-name">IntlChar::EXTENDED_CHAR_NAME</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-name-alias">IntlChar::CHAR_NAME_ALIAS</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-name-choice-count">IntlChar::CHAR_NAME_CHOICE_COUNT</a></code></strong></li>
      </ul>
     </p>


function_name: IntlChar.enumCharNames
name: end
type: string
description:
<p class="para">
      One more than the last code point in the enumeration range (the first one after the range).
     </p>


function_name: IntlChar.enumCharNames
name: callback
type: callable
description:
<p class="para">
      The function that is to be called for each character name.  The following three arguments will be passed into it:
      <ul class="simplelist">
       <li><span class="type">int</span> <code class="literal">$codepoint</code> - The numeric code point value</li>
       <li><span class="type">int</span> <code class="literal">$nameChoice</code> - The same value as the <code class="parameter">type</code> parameter below</li>
       <li><span class="type">string</span> <code class="literal">$name</code> - The name of the character</li>
      </ul>
     </p>


function_name: IntlChar.enumCharNames
name: type
type: int
initializer: IntlChar::UNICODE_CHAR_NAME
description:
<p class="para">
      Selector for which kind of names to enumerate.  Can be any of these constants:
      <ul class="simplelist">
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.unicode-char-name">IntlChar::UNICODE_CHAR_NAME</a></code></strong> (default)</li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.unicode-10-char-name">IntlChar::UNICODE_10_CHAR_NAME</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.extended-char-name">IntlChar::EXTENDED_CHAR_NAME</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-name-alias">IntlChar::CHAR_NAME_ALIAS</a></code></strong></li>
       <li><strong><code><a href="class.intlchar.html#intlchar.constants.char-name-choice-count">IntlChar::CHAR_NAME_CHOICE_COUNT</a></code></strong></li>
      </ul>
     </p>


function_name: IntlChar.enumCharTypes
name: callback
type: callable
description:
<p class="para">
      The function that is to be called for each contiguous range of code points with the same general category.
      The following three arguments will be passed into it:
      <ul class="simplelist">
       <li><span class="type">int</span> <code class="literal">$start</code> - The starting code point of the range</li>
       <li><span class="type">int</span> <code class="literal">$end</code> - The ending code point of the range</li>
       <li><span class="type">int</span> <code class="literal">$name</code> - The category type (one of the <code class="literal">IntlChar::CHAR_CATEGORY_*</code> constants)</li>
      </ul>
     </p>


function_name: IntlChar.foldCase
name: options
type: int
initializer: IntlChar::FOLD_CASE_DEFAULT
description:
<p class="para">
      Either <strong><code><a href="class.intlchar.html#intlchar.constants.fold-case-default">IntlChar::FOLD_CASE_DEFAULT</a></code></strong> (default)
      or <strong><code><a href="class.intlchar.html#intlchar.constants.fold-case-exclude-special-i">IntlChar::FOLD_CASE_EXCLUDE_SPECIAL_I</a></code></strong>.
     </p>


function_name: IntlChar.getIntPropertyMaxValue
name: property
type: int
description:
<p class="para">The Unicode property to lookup (see the <code class="literal">IntlChar::PROPERTY_*</code> constants).</p>


function_name: IntlChar.getPropertyEnum
name: alias
type: string
description:
<p class="para">
      The property name to be matched. The name is compared using &quot;loose matching&quot; as described in PropertyAliases.txt.
     </p>


function_name: IntlChar.getPropertyName
name: property
type: int
description:
<p class="para">The Unicode property to lookup (see the <code class="literal">IntlChar::PROPERTY_*</code> constants).</p>
     <p class="para">
      <strong><code><a href="class.intlchar.html#intlchar.constants.property-invalid-code">IntlChar::PROPERTY_INVALID_CODE</a></code></strong> should not be used.
      Also, if <code class="parameter">property</code> is out of range, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
     </p>


function_name: IntlChar.getPropertyName
name: type
type: int
initializer: IntlChar::LONG_PROPERTY_NAME
description:
<p class="para">
      Selector for which name to get. If out of range, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
     </p>
     <p class="para">
      All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names;
      if present these will be returned by adding 1, 2, etc. to <strong><code><a href="class.intlchar.html#intlchar.constants.long-property-name">IntlChar::LONG_PROPERTY_NAME</a></code></strong>.
     </p>


function_name: IntlChar.getPropertyValueEnum
name: property
type: int
description:
<p class="para">The Unicode property to lookup (see the <code class="literal">IntlChar::PROPERTY_*</code> constants).</p>
     <p class="para">
      If out of range, or this method doesn&#039;t work with the given value,
      <strong><code><a href="class.intlchar.html#intlchar.constants.property-invalid-code">IntlChar::PROPERTY_INVALID_CODE</a></code></strong> is returned.
     </p>


function_name: IntlChar.getPropertyValueEnum
name: name
type: string
description:
<p class="para">
      The value name to be matched.  The name is compared using &quot;loose matching&quot; as described in PropertyValueAliases.txt.
     </p>


function_name: IntlChar.getPropertyValueName
name: property
type: int
description:
<p class="para">The Unicode property to lookup (see the <code class="literal">IntlChar::PROPERTY_*</code> constants).</p>
     <p class="para">
      If out of range, or this method doesn&#039;t work with the given value, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
     </p>


function_name: IntlChar.getPropertyValueName
name: value
type: int
description:
<p class="para">
      Selector for a value for the given property. If out of range, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
     </p>
     <p class="para">
      In general, valid values range from <code class="literal">0</code> up to some maximum. There are a couple exceptions:
      <ul class="simplelist">
       <li>
        <strong><code><a href="class.intlchar.html#intlchar.constants.property-block">IntlChar::PROPERTY_BLOCK</a></code></strong> values begin at the non-zero value <strong><code><a href="class.intlchar.html#intlchar.constants.block-code-basic-latin">IntlChar::BLOCK_CODE_BASIC_LATIN</a></code></strong>
       </li>
       <li>
        <strong><code><a href="class.intlchar.html#intlchar.constants.property-canonical-combining-class">IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</a></code></strong> values are not contiguous and range from 0..240.
       </li>
      </ul>
     </p>


function_name: IntlChar.getPropertyValueName
name: type
type: int
initializer: IntlChar::LONG_PROPERTY_NAME
description:
<p class="para">
      Selector for which name to get. If out of range, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
     </p>
     <p class="para">
      All values have a long name. Most have a short name, but some do not. Unicode allows for additional names;
      if present these will be returned by adding 1, 2, etc. to <strong><code><a href="class.intlchar.html#intlchar.constants.long-property-name">IntlChar::LONG_PROPERTY_NAME</a></code></strong>.
     </p>


function_name: intl_is_failure
name: errorCode
type: int
description:
<p class="para">
       is a value that returned by functions:
       <span class="function">intl_get_error_code</span>,
       <span class="function">collator_get_error_code</span> .
      </p>


function_name: mb_check_encoding
name: value
type: null
description:
<p class="para">
        The byte stream or <span class="type">array</span> to check. If it is omitted, this function checks
        all the input from the beginning of the request.
      </p>

      <div class="warning"><strong class="warning">Warning</strong>
        <p class="para">
          As of PHP 8.1.0, omitting this parameter or passing <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is deprecated.
        </p>
      </div>


function_name: mb_chr
name: codepoint
type: int
description:
<p class="para">
      A Unicode codepoint value, e.g. <code class="literal">128024</code> for <em>U+1F418 ELEPHANT</em>
     </p>


function_name: mb_chr
name: encoding
type: null
description:
<p class="para">The <code class="parameter">encoding</code>
parameter is the character encoding. If it is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the internal character
encoding value will be used.</p>


function_name: mb_convert_case
name: mode
type: int
description:
<p class="para">
       The mode of the conversion. It can be one of 
       <strong><code><a href="mbstring.constants.html#constant.mb-case-upper">MB_CASE_UPPER</a></code></strong>, 
       <strong><code><a href="mbstring.constants.html#constant.mb-case-lower">MB_CASE_LOWER</a></code></strong>, 
       <strong><code><a href="mbstring.constants.html#constant.mb-case-title">MB_CASE_TITLE</a></code></strong>,
       <strong><code><a href="mbstring.constants.html#constant.mb-case-fold">MB_CASE_FOLD</a></code></strong>,
       <strong><code><a href="mbstring.constants.html#constant.mb-case-upper-simple">MB_CASE_UPPER_SIMPLE</a></code></strong>,
       <strong><code><a href="mbstring.constants.html#constant.mb-case-lower-simple">MB_CASE_LOWER_SIMPLE</a></code></strong>,
       <strong><code><a href="mbstring.constants.html#constant.mb-case-title-simple">MB_CASE_TITLE_SIMPLE</a></code></strong>,
       <strong><code><a href="mbstring.constants.html#constant.mb-case-fold-simple">MB_CASE_FOLD_SIMPLE</a></code></strong>.
      </p>


function_name: mb_convert_encoding
name: string
type: string
description:
<p class="para">
       The <span class="type">string</span> or <span class="type">array</span> to be converted.
      </p>


function_name: mb_convert_encoding
name: from_encoding
type: null
description:
<p class="para">
       The current encoding used to interpret <code class="parameter">string</code>.
       Multiple encodings may be specified as an <span class="type">array</span> or comma separated
       list, in which case the correct encoding will be guessed using the
       same algorithm as <span class="function">mb_detect_encoding</span>.
      </p>
      <p class="para">
       If <code class="parameter">from_encoding</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the
       <a href="mbstring.configuration.html#ini.mbstring.internal-encoding" class="link">mbstring.internal_encoding setting</a>
       will be used if set, otherwise the <a href="ini.core.html#ini.default-charset" class="link">default_charset setting</a>.
      </p>
      <p class="para">
       See <a href="mbstring.supported-encodings.html" class="link">supported encodings</a>
       for valid values of <code class="parameter">to_encoding</code>
       and <code class="parameter">from_encoding</code>.
      </p>


function_name: mb_convert_kana
name: mode
type: string
initializer: "KV"
description:
<p class="para">
       The conversion option.
      </p>
      <p class="para">
       Specify with a combination of following options.
       <table class="doctable table">
        <caption><strong>Applicable Conversion Options</strong></caption>
        
         <thead>
          <tr>
           <th>Option</th>
           <th>Meaning</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><code class="literal">r</code></td>
           <td>
            Convert &quot;zen-kaku&quot; alphabets to &quot;han-kaku&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">R</code></td>
           <td>
            Convert &quot;han-kaku&quot; alphabets to &quot;zen-kaku&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">n</code></td>
           <td>
            Convert &quot;zen-kaku&quot; numbers to &quot;han-kaku&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">N</code></td>
           <td>
            Convert &quot;han-kaku&quot; numbers to &quot;zen-kaku&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">a</code></td>
           <td>
            Convert &quot;zen-kaku&quot; alphabets and numbers to &quot;han-kaku&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">A</code></td>
           <td>
            Convert &quot;han-kaku&quot; alphabets and numbers to &quot;zen-kaku&quot;
            (Characters included in &quot;a&quot;, &quot;A&quot; options are
            U+0021 - U+007E excluding U+0022, U+0027, U+005C, U+007E)
           </td>
          </tr>

          <tr>
           <td><code class="literal">s</code></td>
           <td>
            Convert &quot;zen-kaku&quot; space to &quot;han-kaku&quot; (U+3000 -&gt; U+0020)
           </td>
          </tr>

          <tr>
           <td><code class="literal">S</code></td>
           <td>
            Convert &quot;han-kaku&quot; space to &quot;zen-kaku&quot; (U+0020 -&gt; U+3000)
           </td>
          </tr>

          <tr>
           <td><code class="literal">k</code></td>
           <td>
            Convert &quot;zen-kaku kata-kana&quot; to &quot;han-kaku kata-kana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">K</code></td>
           <td>
            Convert &quot;han-kaku kata-kana&quot; to &quot;zen-kaku kata-kana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">h</code></td>
           <td>
            Convert &quot;zen-kaku hira-gana&quot; to &quot;han-kaku kata-kana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">H</code></td>
           <td>
            Convert &quot;han-kaku kata-kana&quot; to &quot;zen-kaku hira-gana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">c</code></td>
           <td>
           Convert &quot;zen-kaku kata-kana&quot; to &quot;zen-kaku hira-gana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">C</code></td>
           <td>
            Convert &quot;zen-kaku hira-gana&quot; to &quot;zen-kaku kata-kana&quot;
           </td>
          </tr>

          <tr>
           <td><code class="literal">V</code></td>
           <td>
            Collapse voiced sound notation and convert them into a character. Use with &quot;K&quot;,&quot;H&quot;
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: mb_convert_variables
name: to_encoding
type: string
description:
<p class="para">
       The encoding that the <span class="type">string</span> is being converted to.
      </p>


function_name: mb_convert_variables
name: from_encoding
type: string
description:
<p class="para">
       <code class="parameter">from_encoding</code> is specified as an <span class="type">array</span> 
       or comma separated <span class="type">string</span>, it tries to detect encoding from
       <code class="parameter">from-coding</code>. When <code class="parameter">from_encoding</code> 
       is omitted, <code class="literal">detect_order</code> is used.
      </p>


function_name: mb_convert_variables
name: var
type: mixed
description:
<p class="para">
       <code class="parameter">var</code> is the reference to the
       variable being converted. String, Array and Object are accepted.
       <span class="function">mb_convert_variables</span> assumes all parameters
       have the same encoding.
      </p>


function_name: mb_decode_numericentity
name: map
type: array
description:
<p class="para">
       <code class="parameter">map</code> is an <span class="type">array</span> that specifies 
       the code area to convert.
      </p>


function_name: mb_detect_encoding
name: encodings
type: null
description:
<p class="para">
       A list of character encodings to try, in order. The list may be specified as
       an array of strings, or a single string separated by commas.
      </p>
      <p class="para">
       If <code class="parameter">encodings</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       the current detect_order (set with the <a href="mbstring.configuration.html#ini.mbstring.detect-order" class="link">
       mbstring.detect_order</a> configuration option, or <span class="function">mb_detect_order</span>
       function) will be used.
      </p>


function_name: mb_detect_encoding
name: strict
type: bool
description:
<p class="para">
       Controls the behaviour when <code class="parameter">string</code>
       is not valid in any of the listed <code class="parameter">encodings</code>.
       If <code class="parameter">strict</code> is set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, the closest matching
       encoding will be returned; if <code class="parameter">strict</code> is set to <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> will be returned.
      </p>
      <p class="para">
       The default value for <code class="parameter">strict</code> can be set
       with the <a href="mbstring.configuration.html#ini.mbstring.strict-detection" class="link">
       mbstring.strict_detection</a> configuration option.
      </p>


function_name: mb_detect_order
name: encoding
type: null
description:
<p class="para">
       <code class="parameter">encoding</code> is an <span class="type">array</span> or 
       comma separated list of character encoding. See <a href="mbstring.supported-encodings.html" class="link">supported encodings</a>.
      </p>
      <p class="para">
       If <code class="parameter">encoding</code> is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, it returns
       the current character encoding detection order as array.
      </p>
      <p class="para">
       This setting affects <span class="function">mb_detect_encoding</span> and
       <span class="function">mb_send_mail</span>.
      </p>
      <p class="para">
       <code class="literal">mbstring</code> currently implements the following
       encoding detection filters. If there is an invalid byte sequence
       for the following encodings, encoding detection will fail.
      </p>
      <p class="simpara">
       <code class="literal">UTF-8</code>, <code class="literal">UTF-7</code>,
       <code class="literal">ASCII</code>,
       <code class="literal">EUC-JP</code>,<code class="literal">SJIS</code>,
       <code class="literal">eucJP-win</code>, <code class="literal">SJIS-win</code>,
       <code class="literal">JIS</code>, <code class="literal">ISO-2022-JP</code> 
      </p>
      <p class="para">
       For <code class="literal">ISO-8859-*</code>, <code class="literal">mbstring</code>
       always detects as <code class="literal">ISO-8859-*</code>.
      </p>
      <p class="para">
       For <code class="literal">UTF-16</code>, <code class="literal">UTF-32</code>,
       <code class="literal">UCS2</code> and <code class="literal">UCS4</code>, encoding
       detection will fail always.
      </p>


function_name: mb_encode_mimeheader
name: string
type: string
description:
<p class="para">
       The <span class="type">string</span> being encoded.
       Its encoding should be same as <span class="function">mb_internal_encoding</span>.
      </p>


function_name: mb_encode_mimeheader
name: charset
type: null
description:
<p class="para">
       <code class="parameter">charset</code> specifies the name of the character set
       in which <code class="parameter">string</code> is represented in. The default value
       is determined by the current NLS setting (<code class="literal">mbstring.language</code>).
      </p>


function_name: mb_encode_mimeheader
name: transfer_encoding
type: null
description:
<p class="para">
       <code class="parameter">transfer_encoding</code> specifies the scheme of MIME
       encoding. It should be either <code class="literal">&quot;B&quot;</code> (Base64) or
       <code class="literal">&quot;Q&quot;</code> (Quoted-Printable). Falls back to
       <code class="literal">&quot;B&quot;</code> if not given.
      </p>


function_name: mb_encode_mimeheader
name: newline
type: string
initializer: "\r\n"
description:
<p class="para">
       <code class="parameter">newline</code> specifies the EOL (end-of-line) marker
       with which <span class="function">mb_encode_mimeheader</span> performs
       line-folding (a <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC</a> term,
       the act of breaking a line longer than a certain length into multiple
       lines. The length is currently hard-coded to 74 characters).
       Falls back to <code class="literal">&quot;\r\n&quot;</code> (CRLF) if not given.
      </p>


function_name: mb_encode_mimeheader
name: indent
type: int
description:
<p class="para">
       Indentation of the first line (number of characters in the header
       before <code class="parameter">string</code>).
      </p>


function_name: mb_encode_numericentity
name: map
type: array
description:
<p class="para">
       <code class="parameter">map</code> is array specifies code area to
       convert.
      </p>


function_name: mb_encode_numericentity
name: hex
type: bool
description:
<p class="para">
       Whether the returned entity reference should be in hexadecimal notation
       (otherwise it is in decimal notation).
      </p>


function_name: mb_ereg_match
name: options
type: null
description:
<p class="para">
       The search option. See <span class="function">mb_regex_set_options</span> for explanation.
      </p>


function_name: mb_ereg_replace_callback
name: pattern
type: string
description:
<p class="para">
       The regular expression pattern.
      </p>
      <p class="para">
       Multibyte characters may be used in <code class="parameter">pattern</code>.
      </p>


function_name: mb_ereg_replace_callback
name: callback
type: callable
description:
<p class="para">
        A callback that will be called and passed an array of matched elements
        in the  <code class="parameter">string</code> string. The callback should
       return the replacement string.
      </p>
      <p class="para">
        You&#039;ll often need the <code class="parameter">callback</code> function
        for a <span class="function">mb_ereg_replace_callback</span> in just one place.
        In this case you can use an
        <a href="functions.anonymous.html" class="link">anonymous function</a> to
        declare the callback within the call to
        <span class="function">mb_ereg_replace_callback</span>. By doing it this way
        you have all information for the call in one place and do not
        clutter the function namespace with a callback function&#039;s name
        not used anywhere else.        
      </p>


function_name: mb_ereg_replace
name: options
type: null
description:
<p class="simpara">
       The search option. See <span class="function">mb_regex_set_options</span> for explanation.
      </p>


function_name: mb_ereg_search_setpos
name: offset
type: int
description:
<p class="para">
       The position to set. If it is negative, it counts from the end of the string.
      </p>


function_name: mb_ereg
name: matches
type: array
description:
<p class="para">
       If matches are found for parenthesized substrings of
       <code class="parameter">pattern</code> and the function is called with the
       third argument <code class="parameter">matches</code>, the matches will be stored
       in the elements of the array <code class="parameter">matches</code>.
       If no matches are found, <code class="parameter">matches</code> is set to an empty
       array.
      </p>
      <p class="para">
       <var class="varname">$matches[1]</var> will contain the substring which starts at
       the first left parenthesis; <var class="varname">$matches[2]</var> will contain
       the substring starting at the second, and so on.
       <var class="varname">$matches[0]</var> will contain a copy of the complete string
       matched.
      </p>


function_name: mb_eregi_replace
name: pattern
type: string
description:
<p class="para">
       The regular expression pattern.  Multibyte characters may be used. The case will be ignored.
      </p>


function_name: mb_get_info
name: type
type: string
initializer: "all"
description:
<p class="para">
       If <code class="parameter">type</code> is not specified or is specified as <code class="literal">&quot;all&quot;</code>,
       <code class="literal">&quot;internal_encoding&quot;</code>, <code class="literal">&quot;http_input&quot;</code>,
       <code class="literal">&quot;http_output&quot;</code>, <code class="literal">&quot;http_output_conv_mimetypes&quot;</code>,
       <code class="literal">&quot;mail_charset&quot;</code>, <code class="literal">&quot;mail_header_encoding&quot;</code>,
       <code class="literal">&quot;mail_body_encoding&quot;</code>, <code class="literal">&quot;illegal_chars&quot;</code>,
       <code class="literal">&quot;encoding_translation&quot;</code>, <code class="literal">&quot;language&quot;</code>,
       <code class="literal">&quot;detect_order&quot;</code>, <code class="literal">&quot;substitute_character&quot;</code>
       and <code class="literal">&quot;strict_detection&quot;</code>
       will be returned. 
      </p>
      <p class="para">
       If <code class="parameter">type</code> is specified as
       <code class="literal">&quot;internal_encoding&quot;</code>, <code class="literal">&quot;http_input&quot;</code>,
       <code class="literal">&quot;http_output&quot;</code>, <code class="literal">&quot;http_output_conv_mimetypes&quot;</code>,
       <code class="literal">&quot;mail_charset&quot;</code>, <code class="literal">&quot;mail_header_encoding&quot;</code>,
       <code class="literal">&quot;mail_body_encoding&quot;</code>, <code class="literal">&quot;illegal_chars&quot;</code>,
       <code class="literal">&quot;encoding_translation&quot;</code>, <code class="literal">&quot;language&quot;</code>,
       <code class="literal">&quot;detect_order&quot;</code>, <code class="literal">&quot;substitute_character&quot;</code>
       or <code class="literal">&quot;strict_detection&quot;</code>
       the specified setting parameter will be returned.
      </p>


function_name: mb_http_input
name: type
type: null
description:
<p class="para">
       Input string specifies the input type. 
       <code class="literal">&quot;G&quot;</code> for GET, <code class="literal">&quot;P&quot;</code> for POST, <code class="literal">&quot;C&quot;</code> for COOKIE, <code class="literal">&quot;S&quot;</code> for string, <code class="literal">&quot;L&quot;</code> for list, and
       <code class="literal">&quot;I&quot;</code> for the whole list (will return <span class="type">array</span>). 
       If type is omitted, it returns the last input type processed. 
      </p>


function_name: mb_http_output
name: encoding
type: null
description:
<p class="para">
       If <code class="parameter">encoding</code> is set,
       <span class="function">mb_http_output</span> sets the HTTP output character
       encoding to <code class="parameter">encoding</code>.
      </p>
      <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.
      </p>


function_name: mb_internal_encoding
name: encoding
type: null
description:
<p class="para">
       <code class="parameter">encoding</code> is the character encoding name 
       used for the HTTP input character encoding conversion, HTTP output 
       character encoding conversion, and the default character encoding 
       for string functions defined by the mbstring module.
       You should notice that the internal encoding is totally different from the one for multibyte regex.
      </p>


function_name: mb_language
name: language
type: null
description:
<p class="para">
       Used for encoding e-mail messages.
       The valid languages are listed in the following table.
       <span class="function">mb_send_mail</span> uses this setting to encode e-mail.
      </p>
      <table class="doctable informaltable">
       
        <thead>
         <tr>
          <th>Language</th>
          <th>Charset</th>
          <th>Encoding</th>
          <th>Alias</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>German/de</td>
          <td>ISO-8859-15</td>
          <td>Quoted-Printable</td>
          <td>Deutsch</td>
         </tr>

         <tr>
          <td>English/en</td>
          <td>ISO-8859-1</td>
          <td>Quoted-Printable</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Armenian/hy</td>
          <td>ArmSCII-8</td>
          <td>Quoted-Printable</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Japanese/ja</td>
          <td>ISO-2022-JP</td>
          <td>BASE64</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Korean/ko</td>
          <td>ISO-2022-KR</td>
          <td>BASE64</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>neutral</td>
          <td>UTF-8</td>
          <td>BASE64</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Russian/ru</td>
          <td>KOI8-R</td>
          <td>Quoted-Printable</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Turkish/tr</td>
          <td>ISO-8859-9</td>
          <td>Quoted-Printable</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Ukrainian/ua</td>
          <td>KOI8-U</td>
          <td>Quoted-Printable</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>uni</td>
          <td>UTF-8</td>
          <td>BASE64</td>
          <td>universal</td>
         </tr>

         <tr>
          <td>Simplified Chinese/zh-cn</td>
          <td>HZ</td>
          <td>BASE64</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>Traditional Chinese/zh-tw</td>
          <td>BIG-5</td>
          <td>BASE64</td>
          <td class="empty">&nbsp;</td>
         </tr>

        </tbody>
       
      </table>


function_name: mb_parse_str
name: result
type: array
description:
<p class="para">
       An <span class="type">array</span> containing decoded and character encoded converted values.
      </p>


function_name: mb_regex_set_options
name: options
type: null
description:
<p class="para">
       The options to set. This is a string where each 
       character is an option. To set a mode, the mode 
       character must be the last one set, however there 
       can only be set one mode but multiple options.
      </p>

      <table class="doctable table">
       <caption><strong>Regex options</strong></caption>
       
        <thead>
         <tr>
          <th>Option</th>
          <th>Meaning</th>
          <th>Changelog</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>i</td>
          <td>Ambiguity match on</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>x</td>
          <td>Enables extended pattern form</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>m</td>
          <td><code class="literal">&#039;.&#039;</code> matches with newlines</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>s</td>
          <td><code class="literal">&#039;^&#039;</code> -&gt; <code class="literal">&#039;\A&#039;</code>, <code class="literal">&#039;$&#039;</code> -&gt; <code class="literal">&#039;\Z&#039;</code></td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>p</td>
          <td>Same as both the <code class="literal">m</code> and <code class="literal">s</code> options</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>l</td>
          <td>Finds longest matches</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>n</td>
          <td>Ignores empty matches</td>
          <td class="empty">&nbsp;</td>
         </tr>

         <tr>
          <td>e</td>
          <td><span class="function">eval</span> resulting code</td>
          <td>Deprecated as of PHP 7.1.0 and removed as of PHP 8.0.0</td>
         </tr>

        </tbody>
       
      </table>

      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        The <code class="literal">&quot;e&quot;</code> option has no effect when set through <span class="function">mb_regex_set_options</span>.
        Use it with <span class="function">mb_ereg_replace</span> or <span class="function">mb_eregi_replace</span>.
       </p>
      </p></blockquote>
      <table class="doctable table">
       <caption><strong>Regex syntax modes (only one may be set)</strong></caption>
       
        <thead>
         <tr>
          <th>Mode</th>
          <th>Meaning</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>j</td>
          <td>Java (Sun java.util.regex)</td>
         </tr>

         <tr>
          <td>u</td>
          <td>GNU regex</td>
         </tr>

         <tr>
          <td>g</td>
          <td>grep</td>
         </tr>

         <tr>
          <td>c</td>
          <td>Emacs</td>
         </tr>

         <tr>
          <td>r</td>
          <td>Ruby</td>
         </tr>

         <tr>
          <td>z</td>
          <td>Perl</td>
         </tr>

         <tr>
          <td>b</td>
          <td>POSIX Basic regex</td>
         </tr>

         <tr>
          <td>d</td>
          <td>POSIX Extended regex</td>
         </tr>

        </tbody>
       
      </table>


function_name: mb_scrub
name: encoding
type: null
description:
<p class="para">
      The encoding used to interpret <code class="parameter">string</code>.
      If it is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the
      <a href="mbstring.configuration.html#ini.mbstring.internal-encoding" class="link">mbstring.internal_encoding setting</a>
      will be used if set, otherwise the <a href="ini.core.html#ini.default-charset" class="link">default_charset setting</a>
      will be used.
     </p>


function_name: mb_send_mail
name: to
type: string
description:
<p class="para">
       The mail addresses being sent to. Multiple
       recipients may be specified by putting a comma between each
       address in <code class="parameter">to</code>. 
       This parameter is not automatically encoded.
      </p>


function_name: mb_send_mail
name: additional_headers
type: string
initializer: []
description:
<p class="para">
       <span class="type">String</span> or <span class="type">array</span> to be inserted at the end of the email header.
      </p>
      <p class="para">
       This is typically used to add extra headers (From, Cc, and Bcc).
       Multiple extra headers should be separated with a CRLF (\r\n).
       Validate parameter not to be injected unwanted headers by attackers.
      </p>
      <p class="para">
       If an <span class="type">array</span> is passed, its keys are the header names and its
       values are the respective header values.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        When sending mail, the mail <em>must</em> contain
        a <code class="literal">From</code> header. This can be set with the 
        <code class="parameter">additional_headers</code> parameter, or a default
        can be set in <var class="filename">php.ini</var>.
       </p>
       <p class="para">
        Failing to do this will result in an error
        message similar to <code class="literal">Warning: mail(): &quot;sendmail_from&quot; not
        set in php.ini or custom &quot;From:&quot; header missing</code>.
        The <code class="literal">From</code> header sets also
        <code class="literal">Return-Path</code> under Windows.
       </p>
      </p></blockquote>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        If messages are not received, try using a LF (\n) only.
        Some Unix mail transfer agents (most notably
        <a href="http://cr.yp.to/qmail.html" class="link external">&raquo;&nbsp;qmail</a>) replace LF by CRLF
        automatically (which leads to doubling CR if CRLF is used).
        This should be a last resort, as it does not comply with
        <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC 2822</a>.
       </p>
      </p></blockquote>


function_name: mb_send_mail
name: additional_params
type: null
description:
<p class="para">
       <code class="parameter">additional_params</code> is a MTA command line
       parameter. It is useful when setting the correct Return-Path
       header when using sendmail.
      </p>
      <p class="para">
       This parameter is escaped by <span class="function">escapeshellcmd</span> internally
       to prevent command execution. <span class="function">escapeshellcmd</span> prevents
       command execution, but allows to add additional parameters. For security reason,
       this parameter should be validated.
      </p>
      <p class="para">
       Since <span class="function">escapeshellcmd</span> is applied automatically, some characters
       that are allowed as email addresses by internet RFCs cannot be used. Programs
       that are required to use these characters <span class="function">mail</span> cannot be used.
      </p>
      <p class="para">
       The user that the webserver runs as should be added as a trusted user to the
       sendmail configuration to prevent a &#039;X-Warning&#039; header from being added
       to the message when the envelope sender (-f) is set using this method.
       For sendmail users, this file is <var class="filename">/etc/mail/trusted-users</var>.
      </p>


function_name: mb_split
name: limit
type: int
initializer: -1
description:
<p class="simpara">
       If optional parameter <code class="parameter">limit</code> is specified, 
       it will be split in <code class="parameter">limit</code> elements as
       maximum.
      </p>


function_name: mb_str_pad
name: length
type: int
description:
<p class="para">
       If the value of <code class="parameter">length</code> is negative,
       less than, or equal to the length of the input string, no padding
       takes place, and <code class="parameter">string</code> will be returned.
      </p>


function_name: mb_str_pad
name: pad_string
type: string
initializer: " "
description:
<blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        The <code class="parameter">pad_string</code> may be truncated if the
        required number of padding characters can&#039;t be evenly divided by the
        <code class="parameter">pad_string</code>&#039;s length.
       </p>
      </p></blockquote>


function_name: mb_str_pad
name: pad_type
type: int
description:
<p class="para">
       Optional argument <code class="parameter">pad_type</code> can be
       <strong><code><a href="string.constants.html#constant.str-pad-right">STR_PAD_RIGHT</a></code></strong>, <strong><code><a href="string.constants.html#constant.str-pad-left">STR_PAD_LEFT</a></code></strong>,
       or <strong><code><a href="string.constants.html#constant.str-pad-both">STR_PAD_BOTH</a></code></strong>.
       By default <strong><code><a href="string.constants.html#constant.str-pad-right">STR_PAD_RIGHT</a></code></strong>.
      </p>


function_name: mb_str_split
name: string
type: string
description:
<p class="para">
       The <span class="type">string</span> to split into characters or chunks.
      </p>


function_name: mb_str_split
name: length
type: int
initializer: 1
description:
<p class="para">
        If specified, each element of the returned array will be composed of multiple characters instead of a single character.
      </p>


function_name: mb_str_split
name: encoding
type: null
description:
<p class="para">The <code class="parameter">encoding</code>
parameter is the character encoding. If it is omitted or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the internal character
encoding value will be used.</p>
      <p class="para">
        A string specifying one of the supported encodings.
      </p>


function_name: mb_strcut
name: start
type: int
description:
<p class="para">
       If <code class="parameter">start</code> is non-negative, the returned string
       will start at the <code class="parameter">start</code>&#039;th <em>byte</em> position in
       <code class="parameter">string</code>, counting from zero. For instance,
       in the string &#039;<code class="literal">abcdef</code>&#039;, the byte at
       position <code class="literal">0</code> is &#039;<code class="literal">a</code>&#039;, the
       byte at position <code class="literal">2</code> is
       &#039;<code class="literal">c</code>&#039;, and so forth.
      </p>
      <p class="para">
       If <code class="parameter">start</code> is negative, the returned string
       will start at the <code class="parameter">start</code>&#039;th byte
       counting back from the end of <code class="parameter">string</code>. However, if the
       magnitude of a negative <code class="parameter">start</code> is greater than the
       length of the string, the returned portion will start from the beginning of
       <code class="parameter">string</code>.
      </p>


function_name: mb_strcut
name: length
type: null
description:
<p class="para">
       Length in <em>bytes</em>. If omitted or <code class="literal">NULL</code>
       is passed, extract all bytes to the end of the string.
      </p>
      <p class="para">
       If <code class="parameter">length</code> is negative, the returned string will
       end at the <code class="parameter">length</code>&#039;th byte counting back from the
       end of <code class="parameter">string</code>. However, if the magnitude of a negative
       <code class="parameter">length</code> is greater than the number of characters
       after the <code class="parameter">start</code> position, an empty string will
       be returned.
      </p>


function_name: mb_strimwidth
name: start
type: int
description:
<p class="para">
       The start position offset. Number of
       characters from the beginning of string (first character is 0),
       or if start is negative, number of characters from the end of the string.
      </p>


function_name: mb_strimwidth
name: width
type: int
description:
<p class="para">
       The width of the desired trim.
       If negative width is specified, count from the end of the string.
       <blockquote class="note"><p><strong class="note">Note</strong>: 
        <p class="para">
         Passing negative width is deprecated as of PHP 8.3.0.
        </p>
       </p></blockquote>
      </p>


function_name: mb_strimwidth
name: trim_marker
type: string
initializer: ""
description:
<p class="para">
       A string that is added to the end of string 
       when string is truncated.
      </p>


function_name: mb_stripos
name: haystack
type: string
description:
<p class="para">
       The string from which to get the position of the first occurrence
       of <code class="parameter">needle</code>
      </p>


function_name: mb_stripos
name: offset
type: int
description:
<p class="para">
       The position in <code class="parameter">haystack</code>
       to start searching.
       A negative offset counts from the end of the string.
      </p>


function_name: mb_stripos
name: encoding
type: null
description:
<p class="para">
       Character encoding name to use.
       If it is omitted, internal character encoding is used.
      </p>


function_name: mb_stristr
name: haystack
type: string
description:
<p class="para">
       The string from which to get the first occurrence
       of <code class="parameter">needle</code>
      </p>


function_name: mb_stristr
name: before_needle
type: bool
description:
<p class="para">
       Determines which portion of <code class="parameter">haystack</code>
       this function returns. 
       If set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, it returns all of  <code class="parameter">haystack</code>
       from the beginning to the first occurrence of <code class="parameter">needle</code> (excluding needle).
       If set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, it returns all of <code class="parameter">haystack</code>
       from the first occurrence of <code class="parameter">needle</code> to the end (including needle).
      </p>


function_name: mb_strpos
name: needle
type: string
description:
<p class="para">
       The string to find in <code class="parameter">haystack</code>. In contrast
       with <span class="function">strpos</span>, numeric values are not applied
       as the ordinal value of a character.
      </p>


function_name: mb_strpos
name: offset
type: int
description:
<p class="para">
       The search offset. If it is not specified, 0 is used.
       A negative offset counts from the end of the string.
      </p>


function_name: mb_strrchr
name: haystack
type: string
description:
<p class="para">
       The string from which to get the last occurrence
       of <code class="parameter">needle</code>
      </p>


function_name: mb_strrchr
name: before_needle
type: bool
description:
<p class="para">
       Determines which portion of <code class="parameter">haystack</code>
       this function returns. 
       If set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, it returns all of <code class="parameter">haystack</code>
       from the beginning to the last occurrence of <code class="parameter">needle</code>.
       If set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, it returns all of <code class="parameter">haystack</code>
       from the last occurrence of <code class="parameter">needle</code> to the end,
      </p>


function_name: mb_strripos
name: haystack
type: string
description:
<p class="para">
       The string from which to get the position of the last occurrence
       of <code class="parameter">needle</code>
      </p>


function_name: mb_strripos
name: offset
type: int
description:
<p class="para">
       The position in <code class="parameter">haystack</code>
       to start searching
      </p>


function_name: mb_strrpos
name: haystack
type: string
description:
<p class="para">
       The <span class="type">string</span> being checked, for the last occurrence
       of <code class="parameter">needle</code>
      </p>


function_name: mb_strrpos
name: needle
type: string
description:
<p class="para">
       The <span class="type">string</span> to find in <code class="parameter">haystack</code>.
      </p>


function_name: mb_strrpos
name: offset
type: int
description:
<p class="simpara">
       May be specified to begin searching an arbitrary number of characters into
       the <span class="type">string</span>.  Negative values will stop searching at an arbitrary point
       prior to the end of the <span class="type">string</span>.
      </p>


function_name: mb_substitute_character
name: substitute_character
type: null
description:
<p class="simpara">
          <code class="literal">&quot;entity&quot;</code>: Output character entity (Example:
          <code class="literal">&amp;#x200;</code>)
         </p>


function_name: mb_substr
name: string
type: string
description:
<p class="para">
       The <span class="type">string</span> to extract the substring from.
      </p>


function_name: mb_substr
name: start
type: int
description:
<p class="para">
       If <code class="parameter">start</code> is non-negative, the returned string
       will start at the <code class="parameter">start</code>&#039;th position in
       <code class="parameter">string</code>, counting from zero. For instance,
       in the string &#039;<code class="literal">abcdef</code>&#039;, the character at
       position <code class="literal">0</code> is &#039;<code class="literal">a</code>&#039;, the
       character at position <code class="literal">2</code> is
       &#039;<code class="literal">c</code>&#039;, and so forth.
      </p>
      <p class="para">
       If <code class="parameter">start</code> is negative, the returned string
       will start at the <code class="parameter">start</code>&#039;th character
       from the end of <code class="parameter">string</code>.
      </p>


function_name: mb_substr
name: length
type: null
description:
<p class="para">
       Maximum number of characters to use from <code class="parameter">string</code>. If
       omitted or <code class="literal">NULL</code> is passed, extract all characters to
       the end of the string.
      </p>


function_name: pspell_config_create
name: language
type: string
description:
<p class="para">
       The language parameter is the language code which consists of the
       two letter ISO 639 language code and an optional two letter ISO
       3166 country code after a dash or underscore.
      </p>


function_name: pspell_config_create
name: spelling
type: string
initializer: ""
description:
<p class="para">
       The spelling parameter is the requested spelling for languages
       with more than one spelling such as English. Known values are
       &#039;american&#039;, &#039;british&#039;, and &#039;canadian&#039;.
      </p>


function_name: pspell_config_create
name: jargon
type: string
initializer: ""
description:
<p class="para">
       The jargon parameter contains extra information to distinguish
       two different words lists that have the same language and
       spelling parameters.
      </p>


function_name: pspell_config_create
name: encoding
type: string
initializer: ""
description:
<p class="para">
       The encoding parameter is the encoding that words are expected to
       be in.  Valid values are &#039;utf-8&#039;, &#039;iso8859-*&#039;, &#039;koi8-r&#039;,
       &#039;viscii&#039;, &#039;cp1252&#039;, &#039;machine unsigned 16&#039;, &#039;machine unsigned
       32&#039;. This parameter is largely untested, so be careful when
       using.
      </p>


function_name: pspell_config_ignore
name: min_length
type: int
description:
<p class="para">
       Words less than <code class="parameter">min_length</code> characters will be skipped.
      </p>


function_name: pspell_config_mode
name: mode
type: int
description:
<p class="simpara">
          <strong><code><a href="pspell.constants.html#constant.pspell-bad-spellers">PSPELL_BAD_SPELLERS</a></code></strong> - Slow mode (a lot of
          suggestions)
         </p>


function_name: pspell_config_personal
name: filename
type: string
description:
<p class="para">
       The personal wordlist. If the file does not exist, it will be created.
       The file should be writable by whoever PHP runs as (e.g. nobody).    
      </p>


function_name: pspell_config_repl
name: filename
type: string
description:
<p class="para">
       The file should be writable by whoever PHP runs as (e.g. nobody).
      </p>


function_name: pspell_config_runtogether
name: allow
type: bool
description:
<p class="para">
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if run-together words should be treated as legal compounds,
       <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
      </p>


function_name: pspell_config_save_repl
name: save
type: bool
description:
<p class="para">
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if replacement pairs should be saved, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
      </p>


function_name: pspell_new_config
name: config
type: PSpell\Config
description:
<p class="para">
       The <code class="parameter">config</code> parameter is the one returned by
       <span class="function">pspell_config_create</span> when the config was created.
      </p>


function_name: pspell_new_personal
name: filename
type: string
description:
<p class="para">
       The file where words added to the personal list will be stored.
       It should be an absolute filename beginning with &#039;/&#039; because otherwise
       it will be relative to $HOME, which is &quot;/root&quot; for most systems, and
       is probably not what you want.
      </p>


function_name: pspell_new_personal
name: language
type: string
description:
<p class="para">
       The language code which consists of the two letter ISO 639 language
       code and an optional two letter ISO 3166 country code after a dash
       or underscore.
      </p>


function_name: pspell_new_personal
name: spelling
type: string
initializer: ""
description:
<p class="para">
       The requested spelling for languages with more than one spelling such
       as English. Known values are &#039;american&#039;, &#039;british&#039;, and &#039;canadian&#039;.
      </p>


function_name: pspell_new_personal
name: jargon
type: string
initializer: ""
description:
<p class="para">
       Extra information to distinguish two different words lists that have
       the same language and spelling parameters.
      </p>


function_name: pspell_new_personal
name: encoding
type: string
initializer: ""
description:
<p class="para">
       The encoding that words are expected to be in.  Valid values are
       <code class="literal">utf-8</code>, <code class="literal">iso8859-*</code>, 
       <code class="literal">koi8-r</code>, <code class="literal">viscii</code>, 
       <code class="literal">cp1252</code>, <code class="literal">machine unsigned 16</code>, 
       <code class="literal">machine unsigned 32</code>. 
      </p>


function_name: pspell_new_personal
name: mode
type: int
description:
<p class="simpara">
          <strong><code><a href="pspell.constants.html#constant.pspell-run-together">PSPELL_RUN_TOGETHER</a></code></strong> - Consider run-together words
          as legal compounds.  That is, &quot;thecat&quot; will be a legal compound,
          although there should be a space between the two words. Changing this
          setting only affects the results returned by
          <span class="function">pspell_check</span>; <span class="function">pspell_suggest</span>
          will still return suggestions.
         </p>


function_name: pspell_store_replacement
name: correct
type: string
description:
<p class="para">
       The fixed spelling for the <code class="parameter">misspelled</code> word.
      </p>


function_name: recode_file
name: input
type: resource
description:
<p class="para">
       A local file handle <span class="type">resource</span> for 
       the <code class="parameter">input</code>
      </p>


function_name: recode_file
name: output
type: resource
description:
<p class="para">
       A local file handle <span class="type">resource</span> for 
       the <code class="parameter">output</code>
      </p>


function_name: exif_read_data
name: file
type: string
description:
<p class="para">
       The location of the image file. This can either be a path to the file
       (stream wrappers are also supported as usual)
       or a stream <span class="type">resource</span>.
      </p>


function_name: exif_read_data
name: required_sections
type: null
description:
<p class="para">
       Is a comma separated list of sections that need to be present in file 
       to produce a result <span class="type">array</span>.  If none of the requested 
       sections could be found the return value is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
       <table class="doctable informaltable">
        
         <tbody class="tbody">
          <tr>
           <td>FILE</td>
           <td>FileName, FileSize, FileDateTime, SectionsFound</td>
          </tr>

          <tr>
           <td>COMPUTED</td>
           <td>
            html, Width, Height, IsColor, and more if available.  Height and 
            Width are computed the same way <span class="function">getimagesize</span>
            does so their values must not be part of any header returned. 
            Also, <code class="literal">html</code> is a height/width text string to be used inside normal 
            <acronym class="acronym">HTML</acronym>.
           </td>
          </tr>

          <tr>
           <td>ANY_TAG</td>
           <td>Any information that has a Tag e.g. <code class="literal">IFD0</code>, <code class="literal">EXIF</code>, ...</td>
          </tr>

          <tr>
           <td>IFD0</td>
           <td>
            All tagged data of IFD0. In normal imagefiles this contains
            image size and so forth.
           </td>
          </tr>

          <tr>
           <td>THUMBNAIL</td>
           <td>
            A file is supposed to contain a thumbnail if it has a second <code class="literal">IFD</code>.
            All tagged information about the embedded thumbnail is stored in 
            this section.
           </td>
          </tr>

          <tr>
           <td>COMMENT</td>
           <td>Comment headers of JPEG images.</td>
          </tr>

          <tr>
           <td>EXIF</td>
           <td>
            The EXIF section is a sub section of <code class="literal">IFD0</code>. It contains
            more detailed information about an image. Most of these entries
            are digital camera related.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: exif_read_data
name: as_arrays
type: bool
description:
<p class="para">
       Specifies whether or not each section becomes an array. The 
       <code class="parameter">required_sections</code> <code class="literal">COMPUTED</code>,
       <code class="literal">THUMBNAIL</code>, and <code class="literal">COMMENT</code> 
       always become arrays as they may contain values whose names conflict
       with other sections.
      </p>


function_name: exif_read_data
name: read_thumbnail
type: bool
description:
<p class="para">
       When set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> the thumbnail itself is read.  Otherwise, only the
       tagged data is read.
      </p>


function_name: exif_thumbnail
name: file
type: string
description:
<p class="para">
       The location of the image file. This can either be a path to the file 
       or a stream <span class="type">resource</span>.
      </p>


function_name: exif_thumbnail
name: image_type
type: int
description:
<p class="para">
       The returned image type of the returned thumbnail.  This is either
       <acronym class="acronym">TIFF</acronym> or <acronym class="acronym">JPEG</acronym>.
      </p>


function_name: getimagesize
name: filename
type: string
description:
<p class="para">
        This parameter specifies the file you wish to retrieve information
        about. It can reference a local file or (configuration permitting) a
        remote file using one of the <a href="wrappers.html" class="link">supported streams</a>.
      </p>


function_name: getimagesize
name: image_info
type: array
description:
<p class="para">
       This optional parameter allows you to extract some extended
       information from the image file. Currently, this will return the
       different <acronym class="acronym">JPG</acronym> APP markers as an associative array.
       Some programs use these APP markers to embed text information in 
       images. A very common one is to embed 
       <a href="http://www.iptc.org/" class="link external">&raquo;&nbsp;IPTC</a> information in the APP13 marker.
       You can use the <span class="function">iptcparse</span> function to parse the
       binary APP13 marker into something readable.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        The <code class="parameter">image_info</code> only supports
        <acronym class="acronym">JFIF</acronym> files.
       </p>
      </p></blockquote>


function_name: image_type_to_extension
name: include_dot
type: bool
description:
<p class="para">
       Whether to prepend a dot to the extension or not. Default to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
      </p>


function_name: image2wbmp
name: image
type: resource
description:
<p class="para">
       An image resource, returned by one of the image creation functions,
       such as <span class="function">imagecreatetruecolor</span>.
      </p>


function_name: image2wbmp
name: filename
type: string
description:
<p class="para">
       Path to the saved file. If not given, the raw image stream will be
       output directly.
      </p>


function_name: image2wbmp
name: foreground
type: int
description:
<p class="para">
       You can set the foreground color with this parameter by setting an
       identifier obtained from <span class="function">imagecolorallocate</span>.
       The default foreground color is black.
      </p>


function_name: imageaffine
name: image
type: GdImage
description:
<p class="para">A <span class="classname">GdImage</span> object, returned by one of the image creation functions,
such as <span class="function">imagecreatetruecolor</span>.</p>


function_name: imageaffine
name: clip
type: null
description:
<p class="para">
      Array with keys &quot;x&quot;, &quot;y&quot;, &quot;width&quot; and &quot;height&quot;; or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
     </p>


function_name: imageaffinematrixconcat
name: matrix1
type: array
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).
     </p>


function_name: imageaffinematrixget
name: options
type: float
description:
<p class="para">
      If <code class="parameter">type</code> is <strong><code><a href="image.constants.html#constant.img-affine-translate">IMG_AFFINE_TRANSLATE</a></code></strong>
      or <strong><code><a href="image.constants.html#constant.img-affine-scale">IMG_AFFINE_SCALE</a></code></strong>,
      <code class="parameter">options</code> has to be an <span class="type">array</span> with keys <code class="literal">x</code>
      and <code class="literal">y</code>, both having <span class="type">float</span> values.
     </p>
     <p class="para">
      If <code class="parameter">type</code> is <strong><code><a href="image.constants.html#constant.img-affine-rotate">IMG_AFFINE_ROTATE</a></code></strong>,
      <strong><code><a href="image.constants.html#constant.img-affine-shear-horizontal">IMG_AFFINE_SHEAR_HORIZONTAL</a></code></strong> or <strong><code><a href="image.constants.html#constant.img-affine-shear-vertical">IMG_AFFINE_SHEAR_VERTICAL</a></code></strong>,
      <code class="parameter">options</code> has to be a <span class="type">float</span> specifying the angle.
     </p>


function_name: imagealphablending
name: enable
type: bool
description:
<p class="para">
       Whether to enable the blending mode or not. On true color images 
       the default value is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise the default value is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
      </p>


function_name: imagearc
name: end_angle
type: int
description:
<p class="para">
       The arc end angle, in degrees.
       0° is located at the three-o&#039;clock position, and the arc is drawn
       clockwise.
      </p>


function_name: imagearc
name: color
type: int
description:
<p class="para">
       A color identifier created with <span class="function">imagecolorallocate</span>.
      </p>


function_name: imageavif
name: file
type: null
description:
<p class="para">
       The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the raw image stream will be output directly.
      </p>


function_name: imageavif
name: quality
type: int
initializer: -1
description:
<p class="para">
       <code class="parameter">quality</code> is optional, and ranges from 0 (worst quality, smaller file)
       to 100 (best quality, larger file).
       If <code class="literal">-1</code> is provided, the default value <code class="literal">30</code> is used.
      </p>


function_name: imageavif
name: speed
type: int
initializer: -1
description:
<p class="para">
       <code class="parameter">speed</code> is optional, and ranges from 0 (slow, smaller file)
       to 10 (fast, larger file).
       If <code class="literal">-1</code> is provided, the default value <code class="literal">6</code> is used.
      </p>


function_name: imagebmp
name: file
type: null
description:
<p class="para">The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the raw image stream will be output directly.</p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is invalid if the <code class="parameter">compressed</code> arguments is
        not used.
       </p>
      </p></blockquote>


function_name: imagebmp
name: compressed
type: bool
description:
<p class="para">
       Whether the BMP should be compressed with run-length encoding (RLE), or not.
      </p>


function_name: imagechar
name: font
type: int
description:
<p class="para">Can be 1, 2, 3, 4, 5 for built-in
fonts in latin2 encoding (where higher numbers corresponding to larger fonts) or <span class="classname">GdFont</span> instance,
returned by <span class="function">imageloadfont</span>.</p>


function_name: imagecolorallocatealpha
name: alpha
type: int
description:
<p class="para">
       A value between <code class="literal">0</code> and <code class="literal">127</code>.
       <code class="literal">0</code> indicates completely opaque while 
       <code class="literal">127</code> indicates completely transparent.
      </p>


function_name: imagecolormatch
name: image2
type: GdImage
description:
<p class="para">
       A palette image object pointing to an image that has the same
       size as <code class="parameter">image1</code>.
      </p>


function_name: imageconvolution
name: divisor
type: float
description:
<p class="para">
       The divisor of the result of the convolution, used for normalization.
      </p>


function_name: imagecopymerge
name: pct
type: int
description:
<p class="para">
       The two images will be merged according to <code class="parameter">pct</code>
       which can range from 0 to 100.  When <code class="parameter">pct</code> = 0,
       no action is taken, when 100 this function behaves identically
       to <span class="function">imagecopy</span> for pallete images, except for
       ignoring alpha components, while it implements alpha transparency
       for true colour images.
      </p>


function_name: imagecopymergegray
name: pct
type: int
description:
<p class="para">
        The <code class="parameter">src_image</code> will be changed to grayscale according 
        to <code class="parameter">pct</code> where 0 is fully grayscale and 100 is 
        unchanged. When <code class="parameter">pct</code> = 100 this function behaves 
        identically to <span class="function">imagecopy</span> for pallete images, except for
        ignoring alpha components, while
        it implements alpha transparency for true colour images.
      </p>


function_name: imagecreatefromavif
name: filename
type: string
description:
<p class="para">
        Path to the <acronym class="acronym">AVIF</acronym> raster image.
      </p>


function_name: imagecrop
name: rectangle
type: array
description:
<p class="para">
      The cropping rectangle as <span class="type">array</span> with keys
      <code class="literal">x</code>, <code class="literal">y</code>, <code class="literal">width</code> and
      <code class="literal">height</code>.
     </p>


function_name: imagecropauto
name: mode
type: int
description:
<p class="simpara">
         Crops an image using the given <code class="parameter">threshold</code> and
         <code class="parameter">color</code>.
        </p>


function_name: imagecropauto
name: threshold
type: float
initializer: 0.5
description:
<p class="para">
      Specifies the tolerance in percent to be used while comparing the image
      color and the color to crop. The method used to calculate the color
      difference is based on the color distance in the RGB(a) cube.
     </p>
     <p class="para">
      Used only in <strong><code>IMG_CROP_THRESHOLD</code></strong> mode.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <span class="simpara">
       Before PHP 7.4.0, the bundled libgd used a somewhat different algorithm,
       so the same <code class="parameter">threshold</code> yielded different results
       for system and bundled libgd.
      </span>
     </p></blockquote>


function_name: imagecropauto
name: color
type: int
initializer: -1
description:
<p class="para">
      Either an RGB color value or a palette index.
     </p>
     <p class="para">
      Used only in <strong><code>IMG_CROP_THRESHOLD</code></strong> mode.
     </p>


function_name: imagedashedline
name: y1
type: int
description:
<p class="para">
       Upper left y coordinate 0, 0 is the top left corner of the image.
      </p>


function_name: imagedashedline
name: color
type: int
description:
<p class="para">
       The fill color. A color identifier created with <span class="function">imagecolorallocate</span>.
      </p>


function_name: imageellipse
name: color
type: int
description:
<p class="para">
       The color of the ellipse. A color identifier created with <span class="function">imagecolorallocate</span>.
      </p>


function_name: imagefilledarc
name: style
type: int
description:
<p class="simpara"><strong><code><a href="image.constants.html#constant.img-arc-edged">IMG_ARC_EDGED</a></code></strong></p>


function_name: imagefilledpolygon
name: points
type: array
description:
<p class="para">
       An array containing the <code class="literal">x</code> and <code class="literal">y</code>
       coordinates of the polygons vertices consecutively.
      </p>


function_name: imagefilledpolygon
name: num_points
type: int
description:
<p class="para">
       Total number of points (vertices), which must be at least 3.
      </p>
      <p class="simpara">
       If this parameter is omitted as per the second signature, <code class="parameter">points</code>
       must have an even number of elements, and <code class="parameter">num_points</code> is
       assumed to be <code class="code">count($points)/2</code>.
      </p>


function_name: imagefilltoborder
name: border_color
type: int
description:
<p class="para">
       The border color. A color identifier created with <span class="function">imagecolorallocate</span>.
      </p>


function_name: imagefilter
name: filter
type: int
description:
<p class="simpara">
          <strong><code><a href="image.constants.html#constant.img-filter-brightness">IMG_FILTER_BRIGHTNESS</a></code></strong>: Changes the brightness
          of the image. Use <code class="parameter">args</code> to set the level of
          brightness. The range for the brightness is -255 to 255.
         </p>


function_name: imagefilter
name: args
type: bool
description:
<p class="simpara">
          <strong><code><a href="image.constants.html#constant.img-filter-scatter">IMG_FILTER_SCATTER</a></code></strong>: Effect substraction level. 
          This must not be higher or equal to the addition level set with 
          <code class="parameter">arg2</code>.
         </p>


function_name: imageflip
name: mode
type: int
description:
<p class="para">
       Flip mode, this can be one of the <strong><code>IMG_FLIP_*</code></strong> constants:
      </p>
      <p class="para">
       <table class="doctable informaltable">
        
         <thead>
          <tr>
           <th>Constant</th>
           <th>Meaning</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="image.constants.html#constant.img-flip-horizontal">IMG_FLIP_HORIZONTAL</a></code></strong></td>
           <td>
            Flips the image horizontally.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="image.constants.html#constant.img-flip-vertical">IMG_FLIP_VERTICAL</a></code></strong></td>
           <td>
            Flips the image vertically.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="image.constants.html#constant.img-flip-both">IMG_FLIP_BOTH</a></code></strong></td>
           <td>
            Flips the image both horizontally and vertically.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: imageftbbox
name: angle
type: float
description:
<p class="para">
       Angle in degrees in which <code class="parameter">string</code> will be 
       measured.
      </p>


function_name: imageftbbox
name: font_filename
type: string
description:
<p class="para">
       The name of the TrueType font file (can be a URL). Depending on
       which version of the GD library that PHP is using, it may attempt to
       search for files that do not begin with a leading &#039;/&#039; by appending
       &#039;.ttf&#039; to the filename and searching along a library-defined font path.
      </p>


function_name: imageftbbox
name: options
type: array
initializer: []
description:
<p class="para">
       <table class="doctable table">
       <caption><strong>Possible array indexes for <code class="parameter">options</code></strong></caption>
        
         <thead>
          <tr>
           <th>Key</th>
           <th>Type</th>
           <th>Meaning</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><code class="literal">linespacing</code></td>
           <td><span class="type">float</span></td>
           <td>Defines drawing linespacing</td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: imagefttext
name: angle
type: float
description:
<p class="para"> 
       The angle in degrees, with 0 degrees being left-to-right reading text.
       Higher values represent a counter-clockwise rotation. For example, a 
       value of 90 would result in bottom-to-top reading text.
      </p>


function_name: imagefttext
name: x
type: int
description:
<p class="para">
       The coordinates given by <code class="parameter">x</code> and
       <code class="parameter">y</code> will define the basepoint of the first
       character (roughly the lower-left corner of the character). This
       is different from the <span class="function">imagestring</span>, where
       <code class="parameter">x</code> and <code class="parameter">y</code> define the
       upper-left corner of the first character. For example, &quot;top left&quot;
       is 0, 0.
      </p>


function_name: imagefttext
name: y
type: int
description:
<p class="para">
       The y-ordinate. This sets the position of the fonts baseline, not the
       very bottom of the character.
      </p>


function_name: imagefttext
name: color
type: int
description:
<p class="para">
       The index of the desired color for the text, see 
       <span class="function">imagecolorexact</span>.
      </p>


function_name: imagefttext
name: font_filename
type: string
description:
<p class="para">
       The path to the TrueType font you wish to use.
      </p>
      <p class="para">
       Depending on which version of the GD library PHP is using, <em>when
       <code class="parameter">font_filename</code> does not begin with a leading
       <code class="literal">/</code> then <code class="literal">.ttf</code> will be appended</em>
       to the filename and the library will attempt to search for that
       filename along a library-defined font path.
      </p>
      <p class="para">
       In many cases where a font resides in the same directory as the script using it
       the following trick will alleviate any include problems.
       <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// Set the environment variable for GD<br /></span><span style="color: #0000BB">putenv</span><span style="color: #007700">(</span><span style="color: #DD0000">'GDFONTPATH=' </span><span style="color: #007700">. </span><span style="color: #0000BB">realpath</span><span style="color: #007700">(</span><span style="color: #DD0000">'.'</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// Name the font to be used (note the lack of the .ttf extension)<br /></span><span style="color: #0000BB">$font </span><span style="color: #007700">= </span><span style="color: #DD0000">'SomeFont'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
       </div>

      </p>


function_name: imagegd2
name: file
type: null
description:
<p class="para">The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the raw image stream will be output directly.</p>


function_name: imagegd2
name: mode
type: int
description:
<p class="para">
       Either <strong><code><a href="image.constants.html#constant.img-gd2-raw">IMG_GD2_RAW</a></code></strong> or 
       <strong><code><a href="image.constants.html#constant.img-gd2-compressed">IMG_GD2_COMPRESSED</a></code></strong>. Default is 
       <strong><code><a href="image.constants.html#constant.img-gd2-raw">IMG_GD2_RAW</a></code></strong>.
      </p>


function_name: imagejpeg
name: quality
type: int
initializer: -1
description:
<p class="para">
       <code class="parameter">quality</code> is optional, and ranges from 0 (worst
       quality, smaller file) to 100 (best quality, biggest file). The 
       default (<code class="literal">-1</code>) uses the default IJG quality value (about 75).
      </p>


function_name: imageline
name: color
type: int
description:
<p class="para">
       The line color. A color identifier created with <span class="function">imagecolorallocate</span>.
      </p>


function_name: imageloadfont
name: filename
type: string
description:
<p class="para">
       The font file format is currently binary and architecture
       dependent.  This means you should generate the font files on the
       same type of CPU as the machine you are running PHP on.
      </p>
      <p class="para">
       <table class="doctable table">
        <caption><strong>Font file format</strong></caption>
        
         <thead>
         <tr>
          <th>byte position</th>
          <th>C data type</th>
          <th>description</th>
         </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>byte 0-3</td>
           <td>int</td>
           <td>number of characters in the font</td>
          </tr>

          <tr>
           <td>byte 4-7</td>
           <td>int</td>
           <td>
            value of first character in the font (often 32 for space)
           </td>
          </tr>

          <tr>
           <td>byte 8-11</td>
           <td>int</td>
           <td>pixel width of each character</td>
          </tr>

          <tr>
           <td>byte 12-15</td>
           <td>int</td>
           <td>pixel height of each character</td>
          </tr>

          <tr>
           <td>byte 16-</td>
           <td>char</td>
           <td>
            array with character data, one byte per pixel in each
            character, for a total of (nchars*width*height) bytes.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: imageopenpolygon
name: points
type: array
description:
<p class="para">
       An array containing the polygon&#039;s vertices, e.g.:
       <table class="doctable informaltable">
        
         <tbody class="tbody">
          <tr>
           <td>points[0]</td>
           <td>= x0</td>
          </tr>

          <tr>
           <td>points[1]</td>
           <td>= y0</td>
          </tr>

          <tr>
           <td>points[2]</td>
           <td>= x1</td>
          </tr>

          <tr>
           <td>points[3]</td>
           <td>= y1</td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: imagepng
name: file
type: null
description:
<p class="para">The path or an open stream resource (which is automatically closed after this function returns) to save the file to. If not set or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the raw image stream will be output directly.</p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is invalid if the <code class="parameter">quality</code> and
        <code class="parameter">filters</code> arguments are not used.
       </p>
      </p></blockquote>


function_name: imagepng
name: quality
type: int
initializer: -1
description:
<p class="para">
       Compression level: from 0 (no compression) to 9.
       The default (<code class="literal">-1</code>) uses the zlib compression default.
       For more information see the <a href="http://www.zlib.net/manual.html" class="link external">&raquo;&nbsp;zlib manual</a>.
      </p>


function_name: imagepng
name: filters
type: int
initializer: -1
description:
<p class="para">
       Allows reducing the PNG file size. It is a bitmask field which may be
       set to any combination of the <code class="literal">PNG_FILTER_XXX</code> 
       constants. <strong><code><a href="image.constants.html#constant.png-no-filter">PNG_NO_FILTER</a></code></strong> or 
       <strong><code><a href="image.constants.html#constant.png-all-filters">PNG_ALL_FILTERS</a></code></strong> may also be used to respectively
       disable or activate all filters.
       The default value (<code class="literal">-1</code>) disables filtering.
      </p>
      <div class="caution"><strong class="caution">Caution</strong>
       <p class="simpara">
        The <code class="parameter">filters</code> parameter is ignored by system libgd.
       </p>
      </div>


function_name: imagerectangle
name: y1
type: int
description:
<p class="para">
       Upper left y coordinate
       0, 0 is the top left corner of the image.
      </p>


function_name: imagerotate
name: angle
type: float
description:
<p class="para">
       Rotation angle, in degrees. The rotation angle is interpreted as the
       number of degrees to rotate the image anticlockwise.
      </p>


function_name: imagesavealpha
name: enable
type: bool
description:
<p class="para">
       Whether to save the alpha channel or not. Defaults to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. 
      </p>


function_name: imagescale
name: height
type: int
initializer: -1
description:
<p class="para">
      The height to scale the image to. If omitted or negative, the aspect
      ratio will be preserved.
     </p>


function_name: imagescale
name: mode
type: int
description:
<p class="para">
      One of <strong><code><a href="image.constants.html#constant.img-nearest-neighbour">IMG_NEAREST_NEIGHBOUR</a></code></strong>,
      <strong><code><a href="image.constants.html#constant.img-bilinear-fixed">IMG_BILINEAR_FIXED</a></code></strong>,
      <strong><code><a href="image.constants.html#constant.img-bicubic">IMG_BICUBIC</a></code></strong>,
      <strong><code><a href="image.constants.html#constant.img-bicubic-fixed">IMG_BICUBIC_FIXED</a></code></strong> or anything else (will use two
      pass).
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <span class="simpara">
        <strong><code><a href="image.constants.html#constant.img-weighted4">IMG_WEIGHTED4</a></code></strong> is not yet supported.
       </span>
      </p></blockquote>
     </p>


function_name: imagesetinterpolation
name: method
type: int
description:
<p class="simpara">
          <strong><code><a href="image.constants.html#constant.img-triangle">IMG_TRIANGLE</a></code></strong>: Triangle interpolation.
         </p>


function_name: imagesetstyle
name: style
type: array
description:
<p class="para">
       An array of pixel colors. You can use the 
       <strong><code><a href="image.constants.html#constant.img-color-transparent">IMG_COLOR_TRANSPARENT</a></code></strong> constant to add a 
       transparent pixel.
       Note that <code class="parameter">style</code> must not be an empty <span class="type">array</span>.
      </p>


function_name: imagetruecolortopalette
name: dither
type: bool
description:
<p class="para">
       Indicates if the image should be dithered - if it is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> then
       dithering will be used which will result in a more speckled image but
       with better color approximation.
      </p>


function_name: imagetruecolortopalette
name: num_colors
type: int
description:
<p class="para">
       Sets the maximum number of colors that should be retained in the palette.
      </p>


function_name: imagettfbbox
name: angle
type: float
description:
<p class="para">
       Angle in degrees in which <code class="parameter">string</code> will be measured.
      </p>


function_name: imagettftext
name: angle
type: float
description:
<p class="para">
       The angle in degrees, with 0 degrees being left-to-right reading text.
       Higher values represent a counter-clockwise rotation. For example, a 
       value of 90 would result in bottom-to-top reading text.
      </p>


function_name: imagettftext
name: color
type: int
description:
<p class="para">
       The color index. Using the negative of a color index has the effect of
       turning off antialiasing. See <span class="function">imagecolorallocate</span>.
      </p>


function_name: imagettftext
name: text
type: string
description:
<p class="para">
       The text string in UTF-8 encoding.
      </p>
      <p class="para">
       May include decimal numeric character references (of the form:
       &amp;#8364;) to access characters in a font beyond position 127.
       The hexadecimal format (like &amp;#xA9;) is supported.
       Strings in UTF-8 encoding can be passed directly.
      </p>
      <p class="para">
       Named entities, such as &amp;copy;, are not supported. Consider using 
       <span class="function">html_entity_decode</span>
       to decode these named entities into UTF-8 strings.
      </p>
      <p class="para">
       If a character is used in the string which is not supported by the
       font, a hollow rectangle will replace the character.
      </p>


function_name: imagewebp
name: quality
type: int
initializer: -1
description:
<p class="para">
       <code class="parameter">quality</code> ranges from 0 (worst
       quality, smaller file) to 100 (best quality, biggest file).
      </p>


function_name: imagexbm
name: filename
type: null
description:
<p class="para">The path to save the file to, given as <span class="type">string</span>. If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the raw image stream will be output directly.</p>
      <p class="para">
       The <code class="parameter">filename</code> (without the .xbm extension) is also
       used for the C identifiers of the <acronym class="acronym">XBM</acronym>, whereby non
       alphanumeric characters of the current locale are substituted by
       underscores. If <code class="parameter">filename</code> is set to <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>,
       <code class="literal">image</code> is used to build the C identifiers.
      </p>


function_name: imagexbm
name: foreground_color
type: null
description:
<p class="para">
       You can set the foreground color with this parameter by setting an
       identifier obtained from <span class="function">imagecolorallocate</span>.
       The default foreground color is black. All other colors are treated as
       background.
      </p>


function_name: iptcembed
name: spool
type: int
description:
<p class="para">
       Spool flag. If the spool flag is less than 2 then the JPEG will be 
       returned as a string. Otherwise the JPEG will be printed to STDOUT.
      </p>


function_name: Gmagick.addnoiseimage
name: noise_type
type: int
description:
<p class="para">
       The type of the noise. Refer to this list of <a href="gmagick.constants.html#gmagick.constants.noise" class="link">noise constants</a>. 
      </p>


function_name: Gmagick.annotateimage
name: GmagickDraw
type: GmagickDraw
description:
<p class="para">
       The <span class="classname">GmagickDraw</span> object that contains settings for drawing the text.
      </p>


function_name: Gmagick.borderimage
name: color
type: GmagickPixel
description:
<p class="para">
       <span class="classname">GmagickPixel</span> object or a string containing the border color.
      </p>


function_name: Gmagick.charcoalimage
name: radius
type: float
description:
<p class="para">
       The radius of the Gaussian, in pixels, not counting the center pixel.
      </p>


function_name: Gmagick.compositeimage
name: source
type: Gmagick
description:
<p class="para">
       <span class="classname">Gmagick</span> object which holds the composite image.
      </p>


function_name: Gmagick.frameimage
name: color
type: GmagickPixel
description:
<p class="para">
       <span class="classname">GmagickPixel</span> object or a float representing the matte color.
      </p>


function_name: Gmagick.levelimage
name: channel
type: int
initializer: Gmagick::CHANNEL_DEFAULT
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. 
To apply to more than one channel, combine channeltype constants using bitwise
 operators. Refer to this list of <a href="gmagick.constants.html#gmagick.constants.channel" class="link">channel constants</a>.
      </p>


function_name: Gmagick.mapimage
name: dither
type: bool
description:
<p class="para">
       Set this integer value to something other than zero to dither the mapped image.
      </p>


function_name: Gmagick.profileimage
name: name
type: string
description:
<p class="para">
        Name of profile to add or remove: ICC, IPTC, or generic profile.
      </p>


function_name: Gmagick.quantizeimage
name: colorspace
type: int
description:
<p class="para">
       Perform color reduction in this colorspace, typically RGBColorspace.
      </p>


function_name: Gmagick.quantizeimage
name: treeDepth
type: int
description:
<p class="para">
       Normally, this integer value is zero or one. A zero or one tells Quantize 
to choose a optimal tree depth of Log4(number_colors).% A tree of this depth generally 
allows the best representation of the reference image with the least amount of memory
 and the fastest computational speed. In some cases, such as an image with low color
 dispersion (a few number of colors), a value other than Log4(number_colors) is required. 
To expand the color tree completely, use a value of 8.
      </p>


function_name: Gmagick.quantizeimage
name: dither
type: bool
description:
<p class="para">
       A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve.
      </p>


function_name: Gmagick.quantizeimage
name: measureError
type: bool
description:
<p class="para">
       A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.
      </p>


function_name: Gmagick.queryformats
name: pattern
type: string
initializer: "*"
description:
<p class="para">
       Specifies a <span class="type">string</span> containing a pattern.
      </p>


function_name: Gmagick.raiseimage
name: raise
type: bool
description:
<p class="para">
       A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.
      </p>


function_name: Gmagick.resampleimage
name: blur
type: float
description:
<p class="para">
       The blur factor where larger than 1 is blurry, smaller than 1  is sharp.
      </p>


function_name: Gmagick.resizeimage
name: blur
type: float
description:
<p class="para">
       The blur factor where larger than 1 is blurry, lesser than 1 is sharp.
      </p>


function_name: Gmagick.separateimagechannel
name: channel
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.channel" class="link">Channel</a> constant
       (<code class="literal">Gmagick::CHANNEL_*</code>).
      </p>


function_name: Gmagick.setimagecolorspace
name: colorspace
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.colorspace" class="link">Colorspace</a> constant
       (<code class="literal">Gmagick::COLORSPACE_*</code>).
      </p>


function_name: Gmagick.setimageinterlacescheme
name: interlace
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.interlace" class="link">Interlace</a> constant
       (<code class="literal">Gmagick::INTERLACE_*</code>).
      </p>


function_name: Gmagick.setimagerenderingintent
name: rendering_intent
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.renderingintent" class="link">Rendering Intent</a> constant
       (<code class="literal">Gmagick::RENDERINGINTENT_*</code>).
      </p>


function_name: Gmagick.setimagetype
name: imgType
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.imagetype" class="link">Image type</a> constant
       (<code class="literal">Gmagick::IMGTYPE_*</code>).
      </p>


function_name: Gmagick.setimageunits
name: resolution
type: int
description:
<p class="para">
       One of the <a href="gmagick.constants.html#gmagick.constants.resolution" class="link">Resolution</a> constant
       (<code class="literal">Gmagick::RESOLUTION_*</code>).
      </p>


function_name: Gmagick.setsamplingfactors
name: factors
type: array
description:
<p class="para">
       An array of <span class="type">float</span>s representing the sampling factor for each color component (in RGB order).
      </p>


function_name: Gmagick.trimimage
name: fuzz
type: float
description:
<p class="para">
       By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. This parameter represents the variation on the quantum range. 
      </p>


function_name: GmagickDraw.setfillcolor
name: color
type: mixed
description:
<p class="para">
       <span class="classname">GmagickPixel</span> or <span class="type">string</span> indicating color to use for filling.
      </p>


function_name: GmagickDraw.setstrokecolor
name: color
type: mixed
description:
<p class="para">
       <span class="classname">GmagickPixel</span> or <span class="type">string</span> representing the color for the stroke.
      </p>


function_name: GmagickPixel.__construct
name: color
type: string
description:
<p class="para">
       The optional color string to use as the initial value of this object. 
      </p>


function_name: GmagickPixel.getcolor
name: as_array
type: bool
description:
<p class="para">
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> to indicate return of <span class="type">array</span> instead of <span class="type">string</span>.
      </p>


function_name: GmagickPixel.getcolor
name: normalize_array
type: bool
description:
<p class="para">
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> to normalize the color values.
      </p>


function_name: GmagickPixel.getcolorvalue
name: color
type: int
description:
<p class="para">
       The channel to check, specified as one of the Gmagick channel constants. 
      </p>


function_name: GmagickPixel.setcolor
name: color
type: string
description:
<p class="para">
       The color definition to use in order to initialise the <span class="classname">GmagickPixel</span> object. 
      </p>


function_name: Imagick.adaptiveBlurImage
name: radius
type: float
description:
<p class="para">
       The radius of the Gaussian, in pixels, not counting the center pixel.
       Provide a value of 0 and the radius will be chosen automagically.
      </p>


function_name: Imagick.adaptiveBlurImage
name: channel
type: int
initializer: Imagick::CHANNEL_DEFAULT
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a> using bitwise operators. Defaults to <strong><code><a href="imagick.constants.html#imagick.constants.channel-default">Imagick::CHANNEL_DEFAULT</a></code></strong>. Refer to this list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>
      </p>


function_name: Imagick.adaptiveSharpenImage
name: radius
type: float
description:
<p class="para">
       The radius of the Gaussian, in pixels, not counting the center pixel. Use 0 for auto-select.
      </p>


function_name: Imagick.addNoiseImage
name: noise_type
type: int
description:
<p class="para">
       The type of the noise. Refer to this list of
       <a href="imagick.constants.html#imagick.constants.noise" class="link">noise constants</a>.
      </p>


function_name: Imagick.annotateImage
name: draw_settings
type: ImagickDraw
description:
<p class="para">
       The ImagickDraw object that contains settings for drawing the text
      </p>


function_name: Imagick.appendImages
name: stack
type: bool
description:
<p class="para">
       Whether to stack the images vertically.
       By default (or if <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is specified) images are stacked left-to-right.
       If <code class="parameter">stack</code> is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, images are stacked top-to-bottom.
      </p>


function_name: Imagick.blurImage
name: channel
type: int
description:
<p class="para">
       The <a href="imagick.constants.html#imagick.constants.channel" class="link">Channeltype</a>
       constant. When not supplied, all channels are blurred.
      </p>


function_name: Imagick.charcoalImage
name: radius
type: float
description:
<p class="para">
       The radius of the Gaussian, in pixels, not counting the center pixel
      </p>


function_name: Imagick.clipPathImage
name: inside
type: bool
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> later operations take effect inside clipping path.
       Otherwise later operations take effect outside clipping path.
      </p>


function_name: Imagick.clutImage
name: channel
type: int
initializer: Imagick::CHANNEL_DEFAULT
description:
<p class="para">
       The <a href="imagick.constants.html#imagick.constants.channel" class="link">Channeltype</a>
       constant. When not supplied, default channels are replaced.
      </p>


function_name: Imagick.colorFloodfillImage
name: fuzz
type: float
description:
<p class="para">
       The amount of fuzz. For example, set fuzz to 10 and the color red at
       intensities of 100 and 102 respectively are now interpreted as the
       same color for the purposes of the floodfill.
      </p>


function_name: Imagick.colorizeImage
name: opacity
type: mixed
description:
<p class="para">
       ImagickPixel object or an float containing the opacity value. 
       1.0 is fully opaque and 0.0 is fully transparent.
      </p>


function_name: Imagick.combineImages
name: channelType
type: int
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. Refer to this
       list of  <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>.
      </p>


function_name: Imagick.compareImageChannels
name: channelType
type: int
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. Refer to this
       list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>.
      </p>


function_name: Imagick.compareImageChannels
name: metricType
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.metric" class="link">metric type constants</a>.
      </p>


function_name: Imagick.compareImageLayers
name: method
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.layermethod" class="link">layer method constants</a>.
      </p>


function_name: Imagick.compareImages
name: metric
type: int
description:
<p class="para">
       Provide a valid metric type constant. Refer to this
       list of  <a href="imagick.constants.html#imagick.constants.metric" class="link">metric constants</a>.
      </p>


function_name: Imagick.compositeImage
name: channel
type: int
initializer: Imagick::CHANNEL_DEFAULT
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. Refer to this list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>.
      </p>


function_name: Imagick.__construct
name: files
type: mixed
description:
<p class="para">
      The path to an image to load or an array of paths. Paths can include
      wildcards for file names, or can be URLs.
     </p>


function_name: Imagick.contrastStretchImage
name: channel
type: int
initializer: Imagick::CHANNEL_DEFAULT
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. <strong><code><a href="imagick.constants.html#imagick.constants.channel-all">Imagick::CHANNEL_ALL</a></code></strong>. Refer to this
       list of  <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>.
      </p>


function_name: Imagick.count
name: mode
type: int
description:
<p class="para">
      An unused argument. Currently there is a non-particularly well defined feature in PHP where calling count() on a countable object might (or might not) require this method to accept a parameter. This parameter is here to be conformant with the interface of countable, even though the param is not used.
     </p>


function_name: Imagick.distortImage
name: method
type: int
description:
<p class="para">
       The method of image distortion. See <a href="imagick.constants.html#imagick.constants.distortion" class="link">distortion constants</a>
      </p>


function_name: Imagick.exportImagePixels
name: map
type: string
description:
<p class="para">
       Ordering of the exported pixels. For example <code class="literal">&quot;RGB&quot;</code>. 
       Valid characters for the map are R, G, B, A, O, C, Y, M, K, I and P.    
      </p>


function_name: Imagick.exportImagePixels
name: STORAGE
type: int
description:
<p class="para">
       Refer to this list of <a href="imagick.constants.html#imagick.constants.pixel" class="link">pixel type constants</a>
      </p>


function_name: Imagick.filter
name: ImagickKernel
type: ImagickKernel
description:
<p class="para">
      An instance of ImagickKernel that represents either a single kernel or a linked series of kernels.
     </p>


function_name: Imagick.filter
name: channel
type: int
initializer: Imagick::CHANNEL_UNDEFINED
description:
<p class="para">
      Provide any channel constant that is valid for your channel mode. To apply to more than one channel, combine <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a> using bitwise operators. Defaults to <strong><code><a href="imagick.constants.html#imagick.constants.channel-default">Imagick::CHANNEL_DEFAULT</a></code></strong>. Refer to this list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>
     </p>


function_name: Imagick.floodFillPaintImage
name: fuzz
type: float
description:
<p class="para">
       The amount of fuzz. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.
      </p>


function_name: Imagick.floodFillPaintImage
name: target
type: mixed
description:
<p class="para">
       ImagickPixel object or a string containing the target color to paint
      </p>


function_name: Imagick.floodFillPaintImage
name: invert
type: bool
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> paints any pixel that does not match the target color.
      </p>


function_name: Imagick.forwardFourierTransformImage
name: magnitude
type: bool
description:
<p class="para">
      If true, return as magnitude / phase pair otherwise a real / imaginary image pair.
     </p>


function_name: Imagick.functionImage
name: function
type: int
description:
<p class="para">
       Refer to this list of <a href="imagick.constants.html#imagick.constants.function" class="link">function constants</a>
      </p>


function_name: Imagick.gaussianBlurImage
name: radius
type: float
description:
<p class="para">
      The radius of the Gaussian, in pixels, not counting the center pixel.
      </p>


function_name: Imagick.getImageChannelDistortion
name: metric
type: int
description:
<p class="para">
      One of the <a href="imagick.constants.html#imagick.constants.metric" class="link">metric type constants</a>.
      </p>


function_name: Imagick.getImageChannelDistortions
name: metric
type: int
description:
<p class="para">
       Refer to this list of <a href="imagick.constants.html#imagick.constants.metric" class="link">metric type constants</a>.
      </p>


function_name: Imagick.getImageProfiles
name: include_values
type: bool
description:
<p class="para">
      Whether to return only profile names. If <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> then only profile names will be returned.
      </p>


function_name: Imagick.getImageProperties
name: include_values
type: bool
description:
<p class="para">
      Whether to return only property names. If <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> then only property names will be returned.
      </p>


function_name: Imagick.getResource
name: type
type: int
description:
<p class="para">
      Refer to the list of <a href="imagick.constants.html#imagick.constants.resourcetypes" class="link">resourcetype constants</a>.
      </p>


function_name: Imagick.getResourceLimit
name: type
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.resourcetypes" class="link">resourcetype constants</a>.
       The unit depends on the type of the resource being limited.
      </p>


function_name: Imagick.identifyFormat
name: embedText
type: string
description:
<p class="para">
      A string containing formatting sequences e.g. &quot;Trim box: %@ number of unique colors: %k&quot;.
     </p>


function_name: Imagick.identifyImage
name: appendRawOutput
type: bool
description:
<p class="para">
         If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> then the raw output is appended to the array.
      </p>


function_name: Imagick.importImagePixels
name: map
type: string
description:
<p class="para">
       Map of pixel ordering as a string. This can be for example <code class="literal">RGB</code>.
       The value can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), 
       O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.
      </p>


function_name: Imagick.importImagePixels
name: storage
type: int
description:
<p class="para">
       The pixel storage method. 
       Refer to this list of <a href="imagick.constants.html#imagick.constants.pixel" class="link">pixel constants</a>.
      </p>


function_name: Imagick.inverseFourierTransformImage
name: complement
type: Imagick
description:
<p class="para">
      The second image to combine with this one to form either the magnitude / phase or real / imaginary image pair.
     </p>


function_name: Imagick.inverseFourierTransformImage
name: magnitude
type: bool
description:
<p class="para">
      If true, combine as magnitude / phase pair otherwise a real / imaginary image pair.
     </p>


function_name: Imagick.liquidRescaleImage
name: delta_x
type: float
description:
<p class="para">
       How much the seam can traverse on x-axis. 
       Passing 0 causes the seams to be straight.
      </p>


function_name: Imagick.liquidRescaleImage
name: rigidity
type: float
description:
<p class="para">
       Introduces a bias for non-straight seams. This parameter is 
       typically 0.
      </p>


function_name: Imagick.matteFloodfillImage
name: alpha
type: float
description:
<p class="para">
       The level of transparency: 1.0 is fully opaque and 0.0 is fully
       transparent.
      </p>


function_name: Imagick.matteFloodfillImage
name: fuzz
type: float
description:
<p class="para">
       The fuzz member of image defines how much tolerance is acceptable to
       consider two colors as the same.
      </p>


function_name: Imagick.matteFloodfillImage
name: bordercolor
type: mixed
description:
<p class="para">
      An <span class="classname">ImagickPixel</span> object or string representing the border color.
      </p>


function_name: Imagick.mergeImageLayers
name: layer_method
type: int
description:
<p class="para">
       One of the <strong><code>Imagick::LAYERMETHOD_*</code></strong> constants
      </p>


function_name: Imagick.montageImage
name: thumbnail_geometry
type: string
description:
<p class="para">
       Preferred image size and border size of each thumbnail
       (e.g. 120x120+4+3).
      </p>


function_name: Imagick.montageImage
name: mode
type: int
description:
<p class="para">
       Thumbnail framing mode, see <a href="imagick.constants.html#imagick.constants.montagemode" class="link">Montage Mode constants</a>.
      </p>


function_name: Imagick.montageImage
name: frame
type: string
description:
<p class="para">
       Surround the image with an ornamental border (e.g. 15x15+3+3). The
       frame color is that of the thumbnail&#039;s matte color.
      </p>


function_name: Imagick.morphology
name: morphologyMethod
type: int
description:
<p class="para">
      Which morphology method to use one of the \Imagick::MORPHOLOGY_* constants.
     </p>


function_name: Imagick.morphology
name: iterations
type: int
description:
<p class="para">
      The number of iteration to apply the morphology function. A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.
     </p>


function_name: Imagick.motionBlurImage
name: channel
type: int
initializer: Imagick::CHANNEL_DEFAULT
description:
<p class="para">
       Provide any channel constant that is valid for your channel mode. To
       apply to more than one channel, combine channeltype constants using
       bitwise operators. Refer to this
       list of <a href="imagick.constants.html#imagick.constants.channel" class="link">channel constants</a>.
       The channel argument affects only if Imagick is compiled against ImageMagick version
       6.4.4 or greater.
      </p>


function_name: Imagick.paintOpaqueImage
name: target
type: mixed
description:
<p class="para">
       Change this target color to the fill color within the image. An
       ImagickPixel object or a string representing the target color.
      </p>


function_name: Imagick.paintTransparentImage
name: target
type: mixed
description:
<p class="para">
      Change this target color to specified opacity value within the image.
      </p>


function_name: Imagick.paintTransparentImage
name: alpha
type: float
description:
<p class="para">
       The level of transparency: 1.0 is fully opaque and 0.0 is fully 
       transparent.
      </p>


function_name: Imagick.previewImages
name: preview
type: int
description:
<p class="para">
       Preview type. See <a href="imagick.constants.html#imagick.constants.preview" class="link">Preview type constants</a>
      </p>


function_name: Imagick.remapImage
name: DITHER
type: int
description:
<p class="para">
       Refer to this list of <a href="imagick.constants.html#imagick.constants.dithermethod" class="link">dither method constants</a>
      </p>


function_name: Imagick.resetImagePage
name: page
type: string
description:
<p class="para">
       The page definition. For example <code class="literal">7168x5147+0+0</code>
      </p>


function_name: Imagick.resizeImage
name: filter
type: int
description:
<p class="para">
       Refer to the list of <a href="imagick.constants.html#imagick.constants.filters" class="link">filter constants</a>.
      </p>


function_name: Imagick.rotateImage
name: degrees
type: float
description:
<p class="para">
       Rotation angle, in degrees. The rotation angle is interpreted as the
       number of degrees to rotate the image clockwise.
      </p>


function_name: Imagick.segmentImage
name: COLORSPACE
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a>.
      </p>


function_name: Imagick.segmentImage
name: cluster_threshold
type: float
description:
<p class="para">
       A percentage describing minimum number of pixels 
       contained in hexedra before it is considered valid.
      </p>


function_name: Imagick.separateImageChannel
name: channel
type: int
description:
<p class="para">
       Which &#039;channel&#039; to return. For colorspaces other than RGB, you can still use the CHANNEL_RED, CHANNEL_GREEN, CHANNEL_BLUE constants to indicate the 1st, 2nd and 3rd channels.
      </p>


function_name: Imagick.setColorspace
name: COLORSPACE
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a>
      </p>


function_name: Imagick.setCompression
name: compression
type: int
description:
<p class="para">
       The compression type. See the <a href="imagick.constants.html" class="link">Imagick::COMPRESSION_*</a> constants.
      </p>


function_name: Imagick.setCompressionQuality
name: quality
type: int
description:
<p class="para">
       An <span class="type">int</span> between 1 and 100, 1 = high compression, 100 low compression.
      </p>


function_name: Imagick.setGravity
name: gravity
type: int
description:
<p class="para">
       The gravity property. Refer to the list of 
       <a href="imagick.constants.html#imagick.constants.gravity" class="link">gravity constants</a>.
      </p>


function_name: Imagick.setImageAlphaChannel
name: mode
type: int
description:
<p class="para">
       One of the <strong><code>Imagick::ALPHACHANNEL_*</code></strong> constants
      </p>


function_name: Imagick.setImageColorspace
name: colorspace
type: int
description:
<p class="para">
        One of the <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a>
      </p>


function_name: Imagick.setImageDelay
name: delay
type: int
description:
<p class="para">
       The amount of time expressed in &#039;ticks&#039; that the image should be
       displayed for. For animated GIFs there are 100 ticks per second, so a
       value of 20 would be 20/100 of a second aka 1/5th of a second.
      </p>


function_name: Imagick.setImageFormat
name: format
type: string
description:
<p class="para">
       String presentation of the image format. Format support
       depends on the ImageMagick installation.
      </p>


function_name: Imagick.setImageInterpolateMethod
name: method
type: int
description:
<p class="para">
       The method is one of the <strong><code>Imagick::INTERPOLATE_*</code></strong> constants
      </p>


function_name: Imagick.setImageIterations
name: iterations
type: int
description:
<p class="para">
       The number of iterations the image should loop over. Set to &#039;0&#039; to loop
       continuously.
      </p>


function_name: Imagick.setImageOrientation
name: orientation
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.orientation" class="link">orientation constants</a>
      </p>


function_name: Imagick.setImageTicksPerSecond
name: ticks_per_second
type: int
description:
<p class="para">
       The duration for which an image should be displayed expressed in ticks
       per second.
      </p>


function_name: Imagick.setProgressMonitor
name: callback
type: callable
description:
<p class="para">
      The progress function to call. It should return true if image processing should continue, or false if it should be cancelled. The offset parameter indicates the progress and the span parameter indicates the total amount of work needed to be done.
     </p>
     
     <div class="methodsynopsis dc-description"><span class="type">bool</span> <span class="methodname">
       <span class="replaceable">callback</span>
      </span>(<span class="methodparam">
       <span class="type">mixed</span> <code class="parameter">$offset</code>
      </span>, <span class="methodparam">
       <span class="type">mixed</span>
        <code class="parameter">$span</code>
      </span>)</div>


     <div class="caution"><strong class="caution">Caution</strong>
      <p class="para">
       The values passed to the callback function are not consistent. In particular the span parameter can increase during image processing. Because of this calculating the percentage complete of an image operation is not trivial.
      </p>
     </div>


function_name: Imagick.setResourceLimit
name: type
type: int
description:
<p class="para">
       Refer to the list of <a href="imagick.constants.html#imagick.constants.resourcetypes" class="link">resourcetype constants</a>.
      </p>


function_name: Imagick.sigmoidalContrastImage
name: alpha
type: float
description:
<p class="para">
       The amount of contrast to apply. 1 is very little, 5 is a significant amount, 20 is extreme.
      </p>


function_name: Imagick.sigmoidalContrastImage
name: beta
type: float
description:
<p class="para">
       Where the midpoint of the gradient will be. This value should be in the range 0 to 1 - mutliplied by the quantum value for ImageMagick.
      </p>


function_name: Imagick.sparseColorImage
name: SPARSE_METHOD
type: int
description:
<p class="para">
       Refer to this list of <a href="imagick.constants.html#imagick.constants.sparsecolormethod" class="link">sparse method constants</a>
      </p>


function_name: Imagick.sparseColorImage
name: arguments
type: array
description:
<p class="para">
       An array containing the coordinates. 
       The array is in format <code class="literal">array(1,1, 2,45)</code>
      </p>


function_name: Imagick.transformImage
name: crop
type: string
description:
<p class="para">
       A crop geometry string. This geometry defines a subregion of the image to crop.
      </p>


function_name: Imagick.transformImage
name: geometry
type: string
description:
<p class="para">
       An image geometry string. This geometry defines the final size of the image.
      </p>


function_name: Imagick.transformImageColorspace
name: colorspace
type: int
description:
<p class="para">
       The colorspace the image should be transformed to, one of the <a href="imagick.constants.html#imagick.constants.colorspace" class="link">COLORSPACE constants</a> e.g. Imagick::COLORSPACE_CMYK.
     </p>


function_name: Imagick.transparentPaintImage
name: alpha
type: float
description:
<p class="para">
       The level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.
      </p>


function_name: Imagick.trimImage
name: fuzz
type: float
description:
<p class="para">
       By default target must match a particular pixel color exactly.
       However, in many cases two colors may differ by a small amount.
       The fuzz member of image defines how much tolerance is acceptable
       to consider two colors as the same. This parameter represents the variation
       on the quantum range.
      </p>


function_name: Imagick.writeImage
name: filename
type: string
initializer: NULL
description:
<p class="para">
       Filename where to write the image. The extension of the filename
       defines the type of the file. 
       Format can be forced regardless of file extension using format: prefix,
       for example &quot;jpg:test.png&quot;.
      </p>


function_name: Imagick.writeImageFile
name: format
type: string
description:
<p class="para">
       The image format.
       The list of valid format specifiers depends on the compiled feature set of
       ImageMagick, and can be queried at runtime via  <span class="methodname">Imagick::queryFormats</span>.
      </p>


function_name: ImagickDraw.bezier
name: coordinates
type: array
description:
<p class="para">
       Multidimensional array like array( array( &#039;x&#039; =&gt; 1, &#039;y&#039; =&gt; 2 ), 
       array( &#039;x&#039; =&gt; 3, &#039;y&#039; =&gt; 4 ) )
      </p>


function_name: ImagickDraw.color
name: paintMethod
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.paint" class="link">PAINT</a> constant
       (<code class="literal">imagick::PAINT_*</code>).
      </p>


function_name: ImagickDraw.composite
name: compose
type: int
description:
<p class="para">
       composition operator.
       One of the <a href="imagick.constants.html#imagick.constants.compositeop" class="link">Composite Operator</a> constant
       (<code class="literal">imagick::COMPOSITE_*</code>).
      </p>


function_name: ImagickDraw.composite
name: compositeWand
type: Imagick
description:
<p class="para">
       the <span class="classname">Imagick</span> object where composition image is taken from.
      </p>


function_name: ImagickDraw.polygon
name: coordinates
type: array
description:
<p class="para">
       multidimensional array like array( array( &#039;x&#039; =&gt; 3, &#039;y&#039; =&gt; 4 ), array( &#039;x&#039; =&gt; 2, &#039;y&#039; =&gt; 6 ) );
      </p>


function_name: ImagickDraw.polyline
name: coordinates
type: array
description:
<p class="para">
       array of x and y coordinates: array( array( &#039;x&#039; =&gt; 4, &#039;y&#039; =&gt; 6 ), array( &#039;x&#039; =&gt; 8, &#039;y&#039; =&gt; 10 ) ) 
      </p>


function_name: ImagickDraw.setClipRule
name: fill_rule
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.fillrule" class="link">FILLRULE</a> constant
       (<code class="literal">imagick::FILLRULE_*</code>).
      </p>


function_name: ImagickDraw.setFontStretch
name: fontStretch
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.stretch" class="link">STRETCH</a> constant
       (<code class="literal">imagick::STRETCH_*</code>).
      </p>


function_name: ImagickDraw.setFontStyle
name: style
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.styles" class="link">STYLE</a> constant
       (<code class="literal">imagick::STYLE_*</code>).
      </p>


function_name: ImagickDraw.setGravity
name: gravity
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.gravity" class="link">GRAVITY</a> constant
       (<code class="literal">imagick::GRAVITY_*</code>).
      </p>


function_name: ImagickDraw.setStrokeLineCap
name: linecap
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.linecap" class="link">LINECAP</a> constant
       (<code class="literal">imagick::LINECAP_*</code>).
      </p>


function_name: ImagickDraw.setStrokeLineJoin
name: linejoin
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.linejoin" class="link">LINEJOIN</a> constant
       (<code class="literal">imagick::LINEJOIN_*</code>).
      </p>


function_name: ImagickDraw.setTextAlignment
name: alignment
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.align" class="link">ALIGN</a> constant
       (<code class="literal">imagick::ALIGN_*</code>).
      </p>


function_name: ImagickDraw.setTextDecoration
name: decoration
type: int
description:
<p class="para">
       One of the <a href="imagick.constants.html#imagick.constants.decoration" class="link">DECORATION</a> constant
       (<code class="literal">imagick::DECORATION_*</code>).
      </p>


function_name: ImagickPixel.__construct
name: color
type: string
description:
<p class="para">
       The optional color string to use as the initial value of this object.
      </p>


function_name: ImagickPixel.getColor
name: normalized
type: int
description:
<p class="para">
       Normalize the color values. Possible values are <code class="literal">0</code>,
       <code class="literal">1</code> or <code class="literal">2</code>.
      </p>

      <table class="doctable table">
       <caption><strong>
        List of possible values for <code class="parameter">normalized</code>
       </strong></caption>
       
        <thead>
         <tr>
          <th><code class="parameter">normalized</code></th>
          <th>Description</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>
           <code class="literal">0</code>
          </td>
          <td>
           The RGB values are returned as <span class="type">int</span>s in the range <code class="literal">0</code>
           to <code class="literal">255</code> (inclusive.)
           The alpha value is returned as <span class="type">int</span> and is either <code class="literal">0</code>
           or <code class="literal">1</code>.
          </td>
         </tr>

         <tr>
          <td>
           <code class="literal">1</code>
          </td>
          <td>
           The RGBA values are returned as <span class="type">float</span>s in the range <code class="literal">0</code>
           to <code class="literal">1</code> (inclusive.)
          </td>
         </tr>

         <tr>
          <td>
           <code class="literal">2</code>
          </td>
          <td>
           The RGBA values are returned as <span class="type">int</span>s in the range <code class="literal">0</code>
           to <code class="literal">255</code> (inclusive.)
          </td>
         </tr>

        </tbody>
       
      </table>


function_name: ImagickPixel.getColorValue
name: color
type: int
description:
<p class="para">
       The color to get the value of, specified as one of the Imagick color
       constants. This can be one of the RGB colors, CMYK colors, alpha and
       opacity e.g (Imagick::COLOR_BLUE, Imagick::COLOR_MAGENTA).
      </p>


function_name: ImagickPixel.isPixelSimilar
name: fuzz
type: float
description:
<p class="para">
       The maximum distance within which to consider these colors as similar.
       The theoretical maximum for this value is the square root of three
       (1.732).
      </p>


function_name: ImagickPixel.setColor
name: color
type: string
description:
<p class="para">
       The color definition to use in order to initialise the
       ImagickPixel object.
      </p>


function_name: ImagickPixel.setColorValue
name: color
type: int
description:
<p class="para">
       One of the Imagick color constants e.g. \Imagick::COLOR_GREEN or \Imagick::COLOR_ALPHA.
      </p>


function_name: ImagickPixel.setColorValueQuantum
name: value
type: float
description:
<p class="para">
      The quantum value to set the color element to. This should be a float if ImageMagick was compiled with HDRI otherwise an int in the range 0 to Imagick::getQuantum().
     </p>


function_name: ImagickPixel.setHSL
name: hue
type: float
description:
<p class="para">
       The normalized value for hue, described as a fractional arc
       (between 0 and 1) of the hue circle, where the zero value is
       red.
      </p>


function_name: ImagickPixel.setHSL
name: luminosity
type: float
description:
<p class="para">
       The normalized value for luminosity, on a scale from black at
       0 to white at 1, with the full HS value at 0.5 luminosity.
      </p>


function_name: ImagickKernel.scale
name: normalizeFlag
type: int
description:
<p class="para">
       <ul class="simplelist">
        <li>Imagick::NORMALIZE_KERNEL_NONE</li>
        <li>Imagick::NORMALIZE_KERNEL_VALUE</li>
        <li>Imagick::NORMALIZE_KERNEL_CORRELATE</li>
        <li>Imagick::NORMALIZE_KERNEL_PERCENT</li>
       </ul>
      </p>


function_name: imap_append
name: folder
type: string
description:
<p class="para">
       The mailbox name, see <span class="function">imap_open</span> for more
       information
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_append
name: message
type: string
description:
<p class="para">
       The message to be append, as a string
      </p>
      <p class="para">
       When talking to the Cyrus IMAP server, you must use &quot;\r\n&quot; as
       your end-of-line terminator instead of &quot;\n&quot; or the operation will
       fail
      </p>


function_name: imap_append
name: options
type: null
description:
<p class="para">
       If provided, the <code class="parameter">options</code> will also be written
       to the <code class="parameter">folder</code>
      </p>


function_name: imap_append
name: internal_date
type: null
description:
<p class="para">
       If this parameter is set, it will set the INTERNALDATE on the appended message.  The parameter should be a date string that conforms to the rfc2060 specifications for a date_time value.
      </p>


function_name: imap_body
name: message_num
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.ft-internal">FT_INTERNAL</a></code></strong> - The return string is in internal format, will
          not canonicalize to CRLF.
         </p>


function_name: imap_body
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.ft-uid">FT_UID</a></code></strong> - The <code class="parameter">message_num</code> is a UID
         </p>


function_name: imap_clearflag_full
name: sequence
type: string
description:
<p class="para">
       A sequence of message numbers. You can enumerate desired messages
       with the <code class="literal">X,Y</code> syntax, or retrieve all messages 
       within an interval with the <code class="literal">X:Y</code> syntax
      </p>


function_name: imap_clearflag_full
name: flag
type: string
description:
<p class="para">
       The flags which you can unset are &quot;\\Seen&quot;, &quot;\\Answered&quot;, &quot;\\Flagged&quot;,
       &quot;\\Deleted&quot;, and &quot;\\Draft&quot; (as defined by <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC2060</a>)
      </p>


function_name: imap_clearflag_full
name: options
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.st-uid">ST_UID</a></code></strong> - The sequence argument contains UIDs
          instead of sequence numbers
         </p>


function_name: imap_close
name: flags
type: int
description:
<p class="para">
       If set to <strong><code><a href="imap.constants.html#constant.cl-expunge">CL_EXPUNGE</a></code></strong>, the function will silently
       expunge the mailbox before closing, removing all messages marked for
       deletion. You can achieve the same thing by using
       <span class="function">imap_expunge</span>
      </p>


function_name: imap_createmailbox
name: mailbox
type: string
description:
<p class="para">
       The mailbox name, see <span class="function">imap_open</span> for more
       information. Names containing international characters should be
       encoded by <span class="function">imap_utf7_encode</span>
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_delete
name: message_nums
type: string
description:
<p class="para">
       A <span class="type">string</span> representing one or more messages in IMAP4-style sequence format
       (<code class="literal">&quot;n&quot;</code>, <code class="literal">&quot;n:m&quot;</code>, or combination of these
       delimited by commas).
      </p>


function_name: imap_delete
name: flags
type: int
description:
<p class="para">
       You can set the <strong><code><a href="imap.constants.html#constant.ft-uid">FT_UID</a></code></strong> which tells the function
       to treat the <code class="parameter">message_nums</code> argument as a
       <code class="literal">UID</code>.
      </p>


function_name: imap_fetch_overview
name: sequence
type: string
description:
<p class="para">
       A message sequence description. You can enumerate desired messages
       with the <code class="literal">X,Y</code> syntax, or retrieve all messages 
       within an interval with the <code class="literal">X:Y</code> syntax
      </p>


function_name: imap_fetch_overview
name: flags
type: int
description:
<p class="para">
       <code class="parameter">sequence</code> will contain a sequence of message
       indices or UIDs, if this parameter is set to 
       <strong><code><a href="imap.constants.html#constant.ft-uid">FT_UID</a></code></strong>. 
      </p>


function_name: imap_fetchbody
name: message_num
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.ft-internal">FT_INTERNAL</a></code></strong> - The return string is in
          internal format, will not canonicalize to CRLF.
         </p>


function_name: imap_fetchbody
name: section
type: string
description:
<p class="para">
       The part number. It is a string of integers delimited by period which
       index into a body part list as per the IMAP4 specification
      </p>


function_name: imap_fetchheader
name: message_num
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.ft-prefetchtext">FT_PREFETCHTEXT</a></code></strong> - The RFC822.TEXT
          should be pre-fetched at the same time.  This avoids an
          extra RTT on an <acronym class="acronym">IMAP</acronym> connection if a full message text is
          desired (e.g. in a &quot;save to local file&quot; operation)
         </p>


function_name: imap_fetchheader
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.ft-uid">FT_UID</a></code></strong> - The <code class="parameter">message_num</code>
          argument is a UID
         </p>


function_name: imap_fetchstructure
name: flags
type: int
description:
<p class="para">
       This optional parameter only has a single option, 
       <strong><code><a href="imap.constants.html#constant.ft-uid">FT_UID</a></code></strong>, which tells the function to treat the
       <code class="parameter">message_num</code> argument as a 
       <code class="literal">UID</code>.
      </p>


function_name: imap_gc
name: flags
type: int
description:
<p class="para">
       Specifies the cache to purge. It may one or a combination
       of the following constants: 
       <strong><code><a href="imap.constants.html#constant.imap-gc-elt">IMAP_GC_ELT</a></code></strong> (message cache elements), 
       <strong><code><a href="imap.constants.html#constant.imap-gc-env">IMAP_GC_ENV</a></code></strong> (envelope and bodies),
       <strong><code><a href="imap.constants.html#constant.imap-gc-texts">IMAP_GC_TEXTS</a></code></strong> (texts).
      </p>


function_name: imap_get_quota
name: quota_root
type: string
description:
<p class="para">
       <code class="parameter">quota_root</code> should normally be in the form of
       <code class="literal">user.name</code> where name is the mailbox you wish to
       retrieve information about.
      </p>


function_name: imap_get_quotaroot
name: mailbox
type: string
description:
<p class="para">
       <code class="parameter">mailbox</code> should normally be in the form of
       which mailbox (i.e. INBOX).
      </p>


function_name: imap_getmailboxes
name: reference
type: string
description:
<p class="para">
       <code class="parameter">reference</code> should normally be just the server
       specification as described in <span class="function">imap_open</span>
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_getmailboxes
name: pattern
type: string
description:
<p class="para">Specifies where in the mailbox hierarchy
to start searching.</p><p class="para">There are two special characters you can
pass as part of the <code class="parameter">pattern</code>:
&#039;<code class="literal">*</code>&#039; and &#039;<code class="literal">%</code>&#039;.
&#039;<code class="literal">*</code>&#039; means to return all mailboxes. If you pass
<code class="parameter">pattern</code> as &#039;<code class="literal">*</code>&#039;, you will
get a list of the entire mailbox hierarchy.
&#039;<code class="literal">%</code>&#039;
means to return the current level only.
&#039;<code class="literal">%</code>&#039; as the <code class="parameter">pattern</code>
parameter will return only the top level
mailboxes; &#039;<code class="literal">~/mail/%</code>&#039; on <code class="literal">UW_IMAPD</code> will return every mailbox in the <var class="filename">~/mail</var> directory, but none in subfolders of that directory.</p>


function_name: imap_headerinfo
name: from_length
type: int
description:
<p class="para">
       Number of characters for the <code class="literal">fetchfrom</code> property.
       Must be greater than or equal to zero.
      </p>


function_name: imap_headerinfo
name: subject_length
type: int
description:
<p class="para">
       Number of characters for the <code class="literal">fetchsubject</code> property
       Must be greater than or equal to zero.
      </p>


function_name: imap_list
name: reference
type: string
description:
<p class="para">
       <code class="parameter">reference</code> should normally be just the server
       specification as described in <span class="function">imap_open</span>.
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_listscan
name: reference
type: string
description:
<p class="para">
       <code class="parameter">reference</code> should normally be just the server 
       specification as described in <span class="function">imap_open</span>
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_mail_compose
name: envelope
type: array
description:
<p class="para">
       An associative array of header fields. Valid keys are: <code class="literal">&quot;remail&quot;</code>,
       <code class="literal">&quot;return_path&quot;</code>, <code class="literal">&quot;date&quot;</code>, <code class="literal">&quot;from&quot;</code>, <code class="literal">&quot;reply_to&quot;</code>, <code class="literal">&quot;in_reply_to&quot;</code>, <code class="literal">&quot;subject&quot;</code>,
       <code class="literal">&quot;to&quot;</code>, <code class="literal">&quot;cc&quot;</code>, <code class="literal">&quot;bcc&quot;</code> and <code class="literal">&quot;message_id&quot;</code>, which set the respective message headers to the given <span class="type">string</span>.
       To set additional headers, the key <code class="literal">&quot;custom_headers&quot;</code> is supported, which expects
       an array of those headers, e.g. <code class="code">[&quot;User-Agent: My Mail Client&quot;]</code>.
      </p>


function_name: imap_mail_compose
name: bodies
type: array
description:
<p class="para">
       An indexed array of bodies. The first body is the main body of the message;
       only if it has a type of <strong><code><a href="imap.constants.html#constant.typemultipart">TYPEMULTIPART</a></code></strong>, further bodies
       are processed; these bodies constitute the bodies of the parts.
      </p>
      <p class="para">
       <table class="doctable table">
        <caption><strong>Body Array Structure</strong></caption>
        
         <thead>
          <tr>
           <th>Key</th>
           <th>Type</th>
           <th>Description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><code class="literal">type</code></td>
           <td><span class="type">int</span></td>
           <td>
            The MIME type.
            One of <strong><code><a href="imap.constants.html#constant.typetext">TYPETEXT</a></code></strong> (default), <strong><code><a href="imap.constants.html#constant.typemultipart">TYPEMULTIPART</a></code></strong>,
            <strong><code><a href="imap.constants.html#constant.typemessage">TYPEMESSAGE</a></code></strong>, <strong><code><a href="imap.constants.html#constant.typeapplication">TYPEAPPLICATION</a></code></strong>,
            <strong><code><a href="imap.constants.html#constant.typeaudio">TYPEAUDIO</a></code></strong>, <strong><code><a href="imap.constants.html#constant.typeimage">TYPEIMAGE</a></code></strong>,
            <strong><code><a href="imap.constants.html#constant.typemodel">TYPEMODEL</a></code></strong> or <strong><code><a href="imap.constants.html#constant.typeother">TYPEOTHER</a></code></strong>.
           </td>
          </tr>

          <tr>
           <td><code class="literal">encoding</code></td>
           <td><span class="type">int</span></td>
           <td>
            The <code class="literal">Content-Transfer-Encoding</code>.
            One of <strong><code><a href="imap.constants.html#constant.enc7bit">ENC7BIT</a></code></strong> (default), <strong><code><a href="imap.constants.html#constant.enc8bit">ENC8BIT</a></code></strong>,
            <strong><code><a href="imap.constants.html#constant.encbinary">ENCBINARY</a></code></strong>, <strong><code><a href="imap.constants.html#constant.encbase64">ENCBASE64</a></code></strong>,
            <strong><code><a href="imap.constants.html#constant.encquotedprintable">ENCQUOTEDPRINTABLE</a></code></strong> or <strong><code><a href="imap.constants.html#constant.encother">ENCOTHER</a></code></strong>.
           </td>
          </tr>

          <tr>
           <td><code class="literal">charset</code></td>
           <td><span class="type">string</span></td>
           <td>The charset parameter of the MIME type.</td>
          </tr>

          <tr>
           <td><code class="literal">type.parameters</code></td>
           <td><span class="type">array</span></td>
           <td>An associative <span class="type">array</span> of <code class="literal">Content-Type</code> parameter names and their values.</td>
          </tr>

          <tr>
           <td><code class="literal">subtype</code></td>
           <td><span class="type">string</span></td>
           <td>The MIME subtype, e.g. <code class="literal">&#039;jpeg&#039;</code> for <strong><code><a href="imap.constants.html#constant.typeimage">TYPEIMAGE</a></code></strong>.</td>
          </tr>

          <tr>
           <td><code class="literal">id</code></td>
           <td><span class="type">string</span></td>
           <td>The <code class="literal">Content-ID</code>.</td>
          </tr>

          <tr>
           <td><code class="literal">description</code></td>
           <td><span class="type">string</span></td>
           <td>The <code class="literal">Content-Description</code>.</td>
          </tr>

          <tr>
           <td><code class="literal">disposition.type</code></td>
           <td><span class="type">string</span></td>
           <td>The <code class="literal">Content-Disposition</code>, e.g. <code class="literal">&#039;attachment&#039;</code>.</td>
          </tr>

          <tr>
           <td><code class="literal">disposition</code></td>
           <td><span class="type">array</span></td>
           <td>An associative <span class="type">array</span> of <code class="literal">Content-Disposition</code> parameter names and values.</td>
          </tr>

          <tr>
           <td><code class="literal">contents.data</code></td>
           <td><span class="type">string</span></td>
           <td>The payload.</td>
          </tr>

          <tr>
           <td><code class="literal">lines</code></td>
           <td><span class="type">int</span></td>
           <td>The size of the payload in lines.</td>
          </tr>

          <tr>
           <td><code class="literal">bytes</code></td>
           <td><span class="type">int</span></td>
           <td>The size of the payload in bytes.</td>
          </tr>

          <tr>
           <td><code class="literal">md5</code></td>
           <td><span class="type">string</span></td>
           <td>The MD5 checksum of the payload.</td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: imap_mail_copy
name: message_nums
type: string
description:
<p class="para">
       <code class="parameter">message_nums</code> is a range not just message
       numbers (as described in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC2060</a>).
      </p>


function_name: imap_mail_copy
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.cp-move">CP_MOVE</a></code></strong> - Delete the messages from
          the current mailbox after copying. If this flag is set, the function
          behaves identically to <span class="function">imap_mail_move</span>.
         </p>


function_name: imap_mail_move
name: message_nums
type: string
description:
<p class="para">
       <code class="parameter">message_nums</code> is a range not just message numbers
       (as described in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC2060</a>).
      </p>


function_name: imap_mail_move
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.cp-uid">CP_UID</a></code></strong> - the sequence numbers contain UIDS
         </p>


function_name: imap_mail
name: message
type: string
description:
<p class="para">
       The mail body, see <span class="function">imap_mail_compose</span>
      </p>


function_name: imap_mail
name: bcc
type: null
description:
<p class="para">
       The receivers specified in <code class="parameter">bcc</code> will get the
       mail, but are excluded from the headers.
      </p>


function_name: imap_mail
name: return_path
type: null
description:
<p class="para">
       Use this parameter to specify return path upon mail delivery failure.
       This is useful when using PHP as a mail client for multiple users.
      </p>


function_name: imap_open
name: mailbox
type: string
description:
<p class="simpara">
          <code class="literal">mailbox_name</code> - remote mailbox name, default is INBOX
         </p>


function_name: imap_open
name: password
type: string
description:
<p class="para">
       The password associated with the <code class="parameter">user</code>
      </p>


function_name: imap_open
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.op-secure">OP_SECURE</a></code></strong> - Don&#039;t do non-secure authentication
         </p>


function_name: imap_open
name: options
type: array
initializer: []
description:
<p class="simpara">
          <code class="literal">DISABLE_AUTHENTICATOR</code> - Disable authentication properties
         </p>


function_name: imap_renamemailbox
name: from
type: string
description:
<p class="para">
       The old mailbox name, see <span class="function">imap_open</span> for more
       information
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_renamemailbox
name: to
type: string
description:
<p class="para">
       The new mailbox name, see <span class="function">imap_open</span> for more
       information
      </p>
      <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
Passing untrusted data to this parameter is <em>insecure</em>, unless
<a href="imap.configuration.html#ini.imap.enable-insecure-rsh" class="link">imap.enable_insecure_rsh</a> is disabled.
</p></div>


function_name: imap_reopen
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.cl-expunge">CL_EXPUNGE</a></code></strong> - Expunge mailbox automatically upon mailbox close
          (see also <span class="function">imap_delete</span> and
          <span class="function">imap_expunge</span>)
         </p>


function_name: imap_savebody
name: file
type: int
description:
<p class="para">
       The path to the saved file as a string, or a valid file descriptor
       returned by <span class="function">fopen</span>.
      </p>


function_name: imap_search
name: flags
type: int
description:
<p class="para">
       Valid values for <code class="parameter">flags</code> are 
       <strong><code><a href="imap.constants.html#constant.se-uid">SE_UID</a></code></strong>, which causes the returned array to
       contain UIDs instead of messages sequence numbers.
      </p>


function_name: imap_set_quota
name: quota_root
type: string
description:
<p class="para">
       The mailbox to have a quota set. This should follow the IMAP standard
       format for a mailbox: <code class="literal">user.name</code>.
      </p>


function_name: imap_set_quota
name: mailbox_size
type: int
description:
<p class="para">
       The maximum size (in KB) for the <code class="parameter">quota_root</code>
      </p>


function_name: imap_setacl
name: rights
type: string
description:
<p class="para">
       The rights to give to the user. Passing an empty string will delete
       acl.
      </p>


function_name: imap_setflag_full
name: flag
type: string
description:
<p class="para">
       The flags which you can set are <code class="literal">\Seen</code>, 
       <code class="literal">\Answered</code>, <code class="literal">\Flagged</code>,
       <code class="literal">\Deleted</code>, and <code class="literal">\Draft</code> as
       defined by <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC2060</a>.
      </p>


function_name: imap_sort
name: criteria
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.sortsize">SORTSIZE</a></code></strong> - size of message in octets
         </p>


function_name: imap_sort
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.se-noprefetch">SE_NOPREFETCH</a></code></strong> - Don&#039;t prefetch searched messages
         </p>


function_name: imap_sort
name: search_criteria
type: null
description:
<p class="para">
       IMAP2-format search criteria string. For details see
       <span class="function">imap_search</span>.
      </p>


function_name: imap_status
name: flags
type: int
description:
<p class="simpara">
          <strong><code><a href="imap.constants.html#constant.sa-all">SA_ALL</a></code></strong> - set all of the above
         </p>


function_name: imap_timeout
name: timeout_type
type: int
description:
<p class="para">
       One of the following:
       <strong><code><a href="imap.constants.html#constant.imap-opentimeout">IMAP_OPENTIMEOUT</a></code></strong>,
       <strong><code><a href="imap.constants.html#constant.imap-readtimeout">IMAP_READTIMEOUT</a></code></strong>,
       <strong><code><a href="imap.constants.html#constant.imap-writetimeout">IMAP_WRITETIMEOUT</a></code></strong>, or
       <strong><code><a href="imap.constants.html#constant.imap-closetimeout">IMAP_CLOSETIMEOUT</a></code></strong>.
      </p>


function_name: imap_utf7_decode
name: string
type: string
description:
<p class="para">
       A modified UTF-7 encoding string, as defined in <a href="http://www.faqs.org/rfcs/rfc2060" class="link external">&raquo;&nbsp;RFC 2060</a>, section 5.1.3.
      </p>


function_name: imap_utf8
name: mime_encoded_text
type: string
description:
<p class="para">
       A MIME encoded string. MIME encoding method and the UTF-8 
       specification are described in <a href="http://www.faqs.org/rfcs/rfc2047" class="link external">&raquo;&nbsp;RFC2047</a> and <a href="http://www.faqs.org/rfcs/rfc2044" class="link external">&raquo;&nbsp;RFC2044</a> respectively.
      </p>


function_name: mail
name: to
type: string
description:
<p class="para">
       Receiver, or receivers of the mail.
      </p>
      <p class="para">
       The formatting of this string must comply with
       <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC 2822</a>. Some examples are:
       <ul class="simplelist">
        <li>user@example.com</li>
        <li>user@example.com, anotheruser@example.com</li>
        <li>User <user@example.com></li>
        <li>User <user@example.com>, Another User <anotheruser@example.com></li>
       </ul>
      </p>


function_name: mail
name: subject
type: string
description:
<p class="para">
       Subject of the email to be sent.
      </p>
      <div class="caution"><strong class="caution">Caution</strong>
       <p class="para">
        Subject must satisfy <a href="http://www.faqs.org/rfcs/rfc2047" class="link external">&raquo;&nbsp;RFC 2047</a>.
       </p>
      </div>


function_name: mail
name: message
type: string
description:
<p class="para">
       Message to be sent.
      </p>
      <p class="para">
       Each line should be separated with a CRLF (\r\n). Lines should not be
       larger than 70 characters.
      </p>
      <div class="caution"><strong class="caution">Caution</strong>
       <p class="para">
        (Windows only) When PHP is talking to a SMTP server directly, if a full
        stop is found on the start of a line, it is removed. To counter-act this,
        replace these occurrences with a double dot.
        <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$text </span><span style="color: #007700">= </span><span style="color: #0000BB">str_replace</span><span style="color: #007700">(</span><span style="color: #DD0000">"\n."</span><span style="color: #007700">, </span><span style="color: #DD0000">"\n.."</span><span style="color: #007700">, </span><span style="color: #0000BB">$text</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
        </div>

       </p>
      </div>


function_name: mail
name: additional_headers
type: string
initializer: []
description:
<p class="para">
       <span class="type">String</span> or <span class="type">array</span> to be inserted at the end of the email header.
      </p>
      <p class="para">
       This is typically used to add extra headers (From, Cc, and Bcc).
       Multiple extra headers should be separated with a CRLF (\r\n).
       If outside data are used to compose this header, the data should be sanitized
       so that no unwanted headers could be injected. 
      </p>
      <p class="para">
       If an <span class="type">array</span> is passed, its keys are the header names and its
       values are the respective header values.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        When sending mail, the mail <em>must</em> contain
        a <code class="literal">From</code> header. This can be set with the
        <code class="parameter">additional_headers</code> parameter, or a default
        can be set in <var class="filename">php.ini</var>.
       </p>
       <p class="para">
        Failing to do this will result in an error
        message similar to <code class="literal">Warning: mail(): &quot;sendmail_from&quot; not
        set in php.ini or custom &quot;From:&quot; header missing</code>.
        The <code class="literal">From</code> header sets also
        <code class="literal">Return-Path</code> when sending directly via SMTP (Windows only).
       </p>
      </p></blockquote>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        If messages are not received, try using a LF (\n) only.
        Some Unix mail transfer agents (most notably
        <a href="http://cr.yp.to/qmail.html" class="link external">&raquo;&nbsp;qmail</a>) replace LF by CRLF
        automatically (which leads to doubling CR if CRLF is used).
        This should be a last resort, as it does not comply with
        <a href="http://www.faqs.org/rfcs/rfc2822" class="link external">&raquo;&nbsp;RFC 2822</a>.
       </p>
      </p></blockquote>


function_name: mail
name: additional_params
type: string
initializer: ""
description:
<p class="para">
       The <code class="parameter">additional_params</code> parameter
       can be used to pass additional flags as command line options to the
       program configured to be used when sending mail, as defined by the
       <code class="literal">sendmail_path</code> configuration setting. For example,
       this can be used to set the envelope sender address when using
       sendmail with the <code class="literal">-f</code> sendmail option.
      </p>
      <p class="para">
       This parameter is escaped by <span class="function">escapeshellcmd</span> internally
       to prevent command execution. <span class="function">escapeshellcmd</span> prevents
       command execution, but allows to add additional parameters. For security reasons,
       it is recommended for the user to sanitize this parameter to avoid adding unwanted
       parameters to the shell command.
      </p>
      <p class="para">
       Since <span class="function">escapeshellcmd</span> is applied automatically, some characters
       that are allowed as email addresses by internet RFCs cannot be used. 
       <span class="function">mail</span> can not allow such characters, so in programs where the use of
       such characters is required, alternative means of sending emails (such as using a framework
       or a library) is recommended. 
      </p>
      <p class="para">
       The user that the webserver runs as should be added as a trusted user to the
       sendmail configuration to prevent a &#039;X-Warning&#039; header from being added
       to the message when the envelope sender (-f) is set using this method.
       For sendmail users, this file is <var class="filename">/etc/mail/trusted-users</var>.
      </p>


function_name: mailparse_msg_extract_part_file
name: mimemail
type: resource
description:
<p class="para">
       A valid <code class="literal">MIME</code> resource, created with
       <span class="function">mailparse_msg_create</span>.
      </p>


function_name: mailparse_msg_extract_part_file
name: callbackfunc
type: callable
description:
<p class="para">
       If set, this must be either a valid callback that will be passed the
       extracted section, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to make this function return the
       extracted section.
      </p>
      <p class="para">
       If not specified, the contents will be sent to &quot;stdout&quot;.
      </p>


function_name: mailparse_msg_free
name: mimemail
type: resource
description:
<p class="para">
       A valid <code class="literal">MIME</code> resource allocated by
       <span class="function">mailparse_msg_create</span> or 
       <span class="function">mailparse_msg_parse_file</span>.
      </p>


function_name: mailparse_msg_parse_file
name: filename
type: string
description:
<p class="para">
       Path to the file holding the message.
       The file is opened and streamed through the parser.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        The message contained in <code class="parameter">filename</code> is supposed to end with a newline
        (<code class="literal">CRLF</code>); otherwise the last line of the message will not be parsed.
       </p>
      </p></blockquote>


function_name: mailparse_msg_parse
name: data
type: string
description:
<blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        The final chunk of <code class="parameter">data</code> is supposed to end with a newline
        (<code class="literal">CRLF</code>); otherwise the last line of the message will not be parsed.
       </p>
      </p></blockquote>


function_name: mailparse_rfc822_parse_addresses
name: addresses
type: string
description:
<p class="para">
       A string containing addresses, like in:
       <code class="literal">Wez Furlong &lt;wez@example.com&gt;, doe@example.com</code>
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        This string must not include the header name.
       </p>
      </p></blockquote>


function_name: mailparse_stream_encode
name: destfp
type: resource
description:
<p class="para">
       The destination file handle in which the encoded data will be written.
      </p>


function_name: mailparse_stream_encode
name: encoding
type: string
description:
<p class="para">
       One of the character encodings supported by the
       <a href="ref.mbstring.html" class="link">mbstring</a> module.
      </p>


function_name: bcadd
name: scale
type: null
description:
<p class="para">This optional parameter is used to set the number
of digits after the decimal place in the result. If omitted, it will default to the scale set
globally with the <span class="function">bcscale</span> function, or fallback to <code class="literal">0</code> if
this has not been set.</p>


function_name: bccomp
name: scale
type: null
description:
<p class="para">
       The optional <code class="parameter">scale</code> parameter is used to set the
       number of digits after the decimal place which will be used in the
       comparison.  
      </p>


function_name: bcpow
name: exponent
type: string
description:
<p class="para">
       The exponent, as a string. If the exponent is non-integral, it is truncated.
       The valid range of the exponent is platform specific, but is at least
       <code class="literal">-2147483648</code> to <code class="literal">2147483647</code>.
      </p>


function_name: bcpowmod
name: exponent
type: string
description:
<p class="para">
       The exponent, as an non-negative, integral string (i.e. the scale has to be zero).
      </p>


function_name: bcpowmod
name: modulus
type: string
description:
<p class="para">
       The modulus, as an integral string (i.e. the scale has to be zero).
      </p>


function_name: gmp_abs
name: num
type: string
description:
<p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_add
name: num1
type: string
description:
<p class="para">
       The first summand (augent).
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_add
name: num2
type: string
description:
<p class="para">
       The second summand (addend).
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_clrbit
name: index
type: int
description:
<p class="para">
       The index of the bit to clear.  Index 0 represents the least significant bit.
      </p>


function_name: gmp_div_q
name: num1
type: string
description:
<p class="para">
       The number being divided.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_div_q
name: num2
type: string
description:
<p class="para">
       The number that <code class="parameter">num1</code> is being divided by.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_div_q
name: rounding_mode
type: int
description:
<p class="simpara">
          <strong><code><a href="gmp.constants.html#constant.gmp-round-minusinf">GMP_ROUND_MINUSINF</a></code></strong>: The result is
          rounded towards <code class="literal">-infinity</code>.
         </p>


function_name: gmp_div_qr
name: rounding_mode
type: int
description:
<p class="para">
       See the <span class="function">gmp_div_q</span> function for description
       of the <code class="parameter">rounding_mode</code> argument.
      </p>


function_name: gmp_export
name: word_size
type: int
initializer: 1
description:
<p class="para">
       Default value is 1. The number of bytes in each chunk of binary data. This is mainly used in conjunction with the options parameter.
      </p>


function_name: gmp_export
name: flags
type: int
initializer: GMP_MSW_FIRST | GMP_NATIVE_ENDIAN
description:
<p class="para">
       Default value is <strong><code><a href="gmp.constants.html#constant.gmp-msw-first">GMP_MSW_FIRST</a></code></strong> | <strong><code><a href="gmp.constants.html#constant.gmp-native-endian">GMP_NATIVE_ENDIAN</a></code></strong>.
      </p>


function_name: gmp_fact
name: num
type: string
description:
<p class="para">
       The factorial number.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_hamdist
name: num1
type: string
description:
<p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p> 
      <p class="para">
       It should be positive.
      </p>


function_name: gmp_init
name: num
type: string
description:
<p class="para">
       An integer or a string. The string representation can be decimal, 
       hexadecimal or octal.
      </p>


function_name: gmp_init
name: base
type: int
description:
<p class="para">
       The base.
      </p>
      <p class="para">
       The base may vary from 2 to 62. If base is 0 (default value), the
       actual base is determined from the leading characters: if the first
       two characters are <code class="literal">0x</code> or <code class="literal">0X</code>,
       hexadecimal is assumed, if the first two characters are <code class="literal">0b</code> or <code class="literal">0B</code>,
       binary is assumed, otherwise if the first character is <code class="literal">0</code>,
       octal is assumed, otherwise decimal is assumed.
       For bases up to 36, case is ignored; upper-case and lower-case letters have the same value.
       For bases 37 to 62, upper-case letter represent the usual 10 to 35 while lower-case letter represent 36 to 61.
      </p>


function_name: gmp_jacobi
name: num2
type: string
description:
<p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p> 
      <p class="para">
       Should be odd and must be positive.
      </p>


function_name: gmp_mod
name: num2
type: string
description:
<p class="para">
       The modulo that is being evaluated.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_mul
name: num1
type: string
description:
<p class="para">
       A number that will be multiplied by <code class="parameter">num2</code>.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_mul
name: num2
type: string
description:
<p class="para">
       A number that will be multiplied by <code class="parameter">num1</code>.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_perfect_square
name: num
type: string
description:
<p class="para">
       The number being checked as a perfect square.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_pow
name: num
type: string
description:
<p class="para">
       The base number.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_pow
name: exponent
type: int
description:
<p class="para">
       The positive power to raise the <code class="parameter">num</code>.
      </p>


function_name: gmp_powm
name: exponent
type: string
description:
<p class="para">
       The positive power to raise the <code class="parameter">num</code>.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_powm
name: modulus
type: string
description:
<p class="para">
       The modulo.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_prob_prime
name: num
type: string
description:
<p class="para">
       The number being checked as a prime.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_prob_prime
name: repetitions
type: int
initializer: 10
description:
<p class="para">
       Reasonable values
       of <code class="parameter">repetitions</code> vary from 5 to 10 (default being
       10); a higher value lowers the probability for a non-prime to
       pass as a &quot;probable&quot; prime.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_random_seed
name: seed
type: string
description:
<p class="para">
       The seed to be set for the <span class="function">gmp_random</span>,
       <span class="function">gmp_random_bits</span>, and
       <span class="function">gmp_random_range</span> functions.
      </p>

      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_random
name: limiter
type: int
initializer: 20
description:
<p class="para">
       The limiter.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_scan0
name: num1
type: string
description:
<p class="para">
       The number to scan.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_setbit
name: index
type: int
description:
<p class="para">
       The index of the bit to set.  Index 0 represents the least significant bit.
      </p>


function_name: gmp_setbit
name: value
type: bool
description:
<p class="para">
       True to set the bit (set it to 1/on); false to clear the bit (set it to 0/off).
      </p>


function_name: gmp_sign
name: num
type: string
description:
<p class="para">
       Either a <span class="classname">GMP</span> object, or a numeric
       string provided that it is possible to convert the latter to an
       <span class="type">int</span>.
      </p>


function_name: gmp_sqrtrem
name: num
type: string
description:
<p class="para">
       The number being square rooted.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_strval
name: num
type: string
description:
<p class="para">
       The GMP number that will be converted to a string.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_strval
name: base
type: int
initializer: 10
description:
<p class="para">
       The base of the returned number. The default base is 10. 
       Allowed values for the base are from 2 to 62 and -2 to -36.
      </p>


function_name: gmp_sub
name: num1
type: string
description:
<p class="para">
       The number being subtracted from.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: gmp_sub
name: num2
type: string
description:
<p class="para">
       The number subtracted from <code class="parameter">num1</code>.
      </p>
      <p class="para">A <span class="classname">GMP</span> object, an <span class="type">int</span> or a numeric <span class="type">string</span>.</p>


function_name: GMP.__construct
name: num
type: string
description:
<p class="para">
       An integer or a string. The string representation can be decimal,
       hexadecimal or octal.
      </p>


function_name: base_convert
name: num
type: string
description:
<p class="para">
       The number to convert. Any invalid characters in
       <code class="parameter">num</code> are silently ignored.
       As of PHP 7.4.0 supplying any invalid characters is deprecated.
      </p>


function_name: bindec
name: binary_string
type: string
description:
<p class="para">
       The binary string to convert.
       Any invalid characters in <code class="parameter">binary_string</code> are silently ignored.
       As of PHP 7.4.0 supplying any invalid characters is deprecated.
      </p>


function_name: decbin
name: num
type: int
description:
<p class="para">
       Decimal value to convert
      </p>

      <table class="doctable table">
       <caption><strong>Range of inputs on 32-bit machines</strong></caption>
       
        <col />
        <col />
        <col />
        <thead>
         <tr>
          <th>positive <code class="parameter">num</code></th>
          <th>negative <code class="parameter">num</code></th>
          <th>return value</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>0</td>
          <td class="empty">&nbsp;</td>
          <td>0</td>
         </tr>

         <tr>
          <td>1</td>
          <td class="empty">&nbsp;</td>
          <td>1</td>
         </tr>

         <tr>
          <td>2</td>
          <td class="empty">&nbsp;</td>
          <td>10</td>
         </tr>

         <tr>
          <td colspan="3">... normal progression ...</td>
         </tr>

         <tr>
          <td>2147483646</td>
          <td class="empty">&nbsp;</td>
          <td>1111111111111111111111111111110</td>
         </tr>

         <tr>
          <td>2147483647 (largest signed integer)</td>
          <td class="empty">&nbsp;</td>
          <td>1111111111111111111111111111111 (31 1&#039;s)</td>
         </tr>

         <tr>
          <td>2147483648</td>
          <td>-2147483648</td>
          <td>10000000000000000000000000000000</td>
         </tr>

         <tr>
          <td colspan="3">... normal progression ...</td>
         </tr>

         <tr>
          <td>4294967294</td>
          <td>-2</td>
          <td>11111111111111111111111111111110</td>
         </tr>

         <tr>
          <td>4294967295 (largest unsigned integer)</td>
          <td>-1</td>
          <td>11111111111111111111111111111111 (32 1&#039;s)</td>
         </tr>

        </tbody>
       
      </table>


      <table class="doctable table">
       <caption><strong>Range of inputs on 64-bit machines</strong></caption>
       
        <col />
        <col />
        <col />
        <thead>
         <tr>
          <th>positive <code class="parameter">num</code></th>
          <th>negative <code class="parameter">num</code></th>
          <th>return value</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>0</td>
          <td class="empty">&nbsp;</td>
          <td>0</td>
         </tr>

         <tr>
          <td>1</td>
          <td class="empty">&nbsp;</td>
          <td>1</td>
         </tr>

         <tr>
          <td>2</td>
          <td class="empty">&nbsp;</td>
          <td>10</td>
         </tr>

         <tr>
          <td colspan="3">... normal progression ...</td>
         </tr>

         <tr>
          <td>9223372036854775806</td>
          <td class="empty">&nbsp;</td>
          <td>111111111111111111111111111111111111111111111111111111111111110</td>
         </tr>

         <tr>
          <td>9223372036854775807 (largest signed integer)</td>
          <td class="empty">&nbsp;</td>
          <td>111111111111111111111111111111111111111111111111111111111111111 (63 1&#039;s)</td>
         </tr>

         <tr>
          <td class="empty">&nbsp;</td>
          <td>-9223372036854775808</td>
          <td>1000000000000000000000000000000000000000000000000000000000000000</td>
         </tr>

         <tr>
          <td colspan="3">... normal progression ...</td>
         </tr>

         <tr>
          <td class="empty">&nbsp;</td>
          <td>-2</td>
          <td>1111111111111111111111111111111111111111111111111111111111111110</td>
         </tr>

         <tr>
          <td class="empty">&nbsp;</td>
          <td>-1</td>
          <td>1111111111111111111111111111111111111111111111111111111111111111 (64 1&#039;s)</td>
         </tr>

        </tbody>
       
      </table>


function_name: dechex
name: num
type: int
description:
<p class="para">
       The decimal value to convert.
      </p>
      <p class="para">
       As PHP&#039;s <span class="type">int</span> type is signed, but
       <span class="function">dechex</span> deals with unsigned integers, negative
       integers will be treated as though they were unsigned.
      </p>


function_name: log
name: base
type: float
description:
<p class="para">
       The optional logarithmic base to use 
       (defaults to &#039;e&#039; and so to the natural logarithm).
      </p>


function_name: max
name: value
type: mixed
description:
<p class="para">
       Any <a href="language.operators.comparison.html" class="link">comparable</a>
       value.
      </p>


function_name: max
name: values
type: mixed
description:
<p class="para">
       Any <a href="language.operators.comparison.html" class="link">comparable</a>
       values.
      </p>


function_name: octdec
name: octal_string
type: string
description:
<p class="para">
       The octal string to convert.
       Any invalid characters in <code class="parameter">octal_string</code> are silently ignored.
       As of PHP 7.4.0 supplying any invalid characters is deprecated.
      </p>


function_name: round
name: precision
type: int
description:
<p class="para">
       The optional number of decimal digits to round to.
      </p>
      <p class="para">
       If the <code class="parameter">precision</code> is positive, <code class="parameter">num</code> is
       rounded to <code class="parameter">precision</code> significant digits after the decimal point.
      </p>
      <p class="para">
       If the <code class="parameter">precision</code> is negative, <code class="parameter">num</code> is
       rounded to <code class="parameter">precision</code> significant digits before the decimal point,
       i.e. to the nearest multiple of <code class="code">pow(10, -$precision)</code>, e.g. for a
       <code class="parameter">precision</code> of -1 <code class="parameter">num</code> is rounded to tens,
       for a <code class="parameter">precision</code> of -2 to hundreds, etc.
      </p>


function_name: round
name: mode
type: int
description:
<p class="para">
       Use one of the following constants to specify the mode in which rounding occurs.
       <table class="doctable informaltable">
        
         <thead>
          <tr>
           <th>Constants</th>
           <th>Description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="math.constants.html#constant.php-round-half-up">PHP_ROUND_HALF_UP</a></code></strong></td>
           <td>
            Rounds <code class="parameter">num</code> away from zero when it is half way there,
            making 1.5 into 2 and -1.5 into -2.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="math.constants.html#constant.php-round-half-down">PHP_ROUND_HALF_DOWN</a></code></strong></td>
           <td>
            Rounds <code class="parameter">num</code> towards zero when it is half way there,
            making 1.5 into 1 and -1.5 into -1.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="math.constants.html#constant.php-round-half-even">PHP_ROUND_HALF_EVEN</a></code></strong></td>
           <td>
            Rounds <code class="parameter">num</code> towards the nearest even value when it is half way
            there, making both 1.5 and 2.5 into 2.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="math.constants.html#constant.php-round-half-odd">PHP_ROUND_HALF_ODD</a></code></strong></td>
           <td>
            Rounds <code class="parameter">num</code> towards the nearest odd value when it is half way
            there, making 1.5 into 1 and 2.5 into 3.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: stats_dens_pmf_hypergeometric
name: n1
type: float
description:
<p class="para">
       The number of success, at which the probability mass is calculated
      </p>


function_name: stats_rand_gen_gamma
name: a
type: float
description:
<p class="para">
       location parameter of Gamma distribution (<code class="parameter">a</code>
       &gt; 0).
      </p>


function_name: stats_rand_gen_gamma
name: r
type: float
description:
<p class="para">
       shape parameter of Gamma distribution (<code class="parameter">r</code> &gt;
       0).
      </p>


function_name: stats_standard_deviation
name: a
type: array
description:
<p class="para">
       The array of data to find the standard deviation for. Note that all 
       values of the array will be cast to <span class="type">float</span>.
      </p>


function_name: stats_standard_deviation
name: sample
type: bool
description:
<p class="para">
       Indicates if <code class="parameter">a</code> represents a sample of the 
       population; defaults to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
      </p>


function_name: trader_apo
name: mAType
type: int
description:
<p class="para">
      Type of Moving Average. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_bbands
name: nbDevUp
type: float
description:
<p class="para">
      Deviation multiplier for upper band. Valid range from <a href="trader.constants.html#constant.trader-real-min" class="link">TRADER_REAL_MIN</a> to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_bbands
name: nbDevDn
type: float
description:
<p class="para">
      Deviation multiplier for lower band. Valid range from <a href="trader.constants.html#constant.trader-real-min" class="link">TRADER_REAL_MIN</a> to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_get_unstable_period
name: functionId
type: int
description:
<p class="para">
      Function ID the factor to be read for. <a href="trader.constants.html" class="link">TRADER_FUNC_UNST_*</a> series of constants should be used.
     </p>


function_name: trader_macd
name: signalPeriod
type: int
description:
<p class="para">
      Smoothing for the signal line (nb of period). Valid range from 1 to 100000.
     </p>


function_name: trader_macdext
name: fastMAType
type: int
description:
<p class="para">
      Type of Moving Average for fast MA. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_macdext
name: slowMAType
type: int
description:
<p class="para">
      Type of Moving Average for slow MA. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_macdext
name: signalMAType
type: int
description:
<p class="para">
      Type of Moving Average for signal line. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_mama
name: fastLimit
type: float
description:
<p class="para">
      Upper limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.
     </p>


function_name: trader_mama
name: slowLimit
type: float
description:
<p class="para">
      Lower limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.
     </p>


function_name: trader_mavp
name: minPeriod
type: int
description:
<p class="para">
      Value less than minimum will be changed to Minimum period. Valid range from 2 to 100000
     </p>


function_name: trader_mavp
name: maxPeriod
type: int
description:
<p class="para">
      Value higher than minimum will be changed to Maximum period. Valid range from 2 to 100000
     </p>


function_name: trader_sar
name: acceleration
type: float
description:
<p class="para">
      Acceleration Factor used up to the Maximum value. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sar
name: maximum
type: float
description:
<p class="para">
      Acceleration Factor Maximum value. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: startValue
type: float
description:
<p class="para">
       Start value and direction. 0 for Auto, &gt;0 for Long, &lt;0 for Short. Valid range from <a href="trader.constants.html#constant.trader-real-min" class="link">TRADER_REAL_MIN</a> to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: offsetOnReverse
type: float
description:
<p class="para">
      Percent offset added/removed to initial stop on short/long reversal. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationInitLong
type: float
description:
<p class="para">
      Acceleration Factor initial value for the Long direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationLong
type: float
description:
<p class="para">
      Acceleration Factor for the Long direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationMaxLong
type: float
description:
<p class="para">
      Acceleration Factor maximum value for the Long direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationInitShort
type: float
description:
<p class="para">
      Acceleration Factor initial value for the Short direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationShort
type: float
description:
<p class="para">
      Acceleration Factor for the Short direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_sarext
name: accelerationMaxShort
type: float
description:
<p class="para">
      Acceleration Factor maximum value for the Short direction. Valid range from 0 to <a href="trader.constants.html#constant.trader-real-max" class="link">TRADER_REAL_MAX</a>.
     </p>


function_name: trader_set_compat
name: compatId
type: int
description:
<p class="para">
      Compatibility Id. <a href="trader.constants.html" class="link">TRADER_COMPATIBILITY_*</a> series of constants should be used. 
     </p>


function_name: trader_set_unstable_period
name: functionId
type: int
description:
<p class="para">
      Function ID the factor should be set for. <a href="trader.constants.html" class="link">TRADER_FUNC_UNST_*</a> constant series can be used to affect the corresponding function. 
     </p>


function_name: trader_stoch
name: fastK_Period
type: int
description:
<p class="para">
      Time period for building the Fast-K line. Valid range from 1 to 100000.
     </p>


function_name: trader_stoch
name: slowK_Period
type: int
description:
<p class="para">
      Smoothing for making the Slow-K line. Valid range from 1 to 100000, usually set to 3.
     </p>


function_name: trader_stoch
name: slowK_MAType
type: int
description:
<p class="para">
      Type of Moving Average for Slow-K. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_stoch
name: slowD_Period
type: int
description:
<p class="para">
      Smoothing for making the Slow-D line. Valid range from 1 to 100000.
     </p>


function_name: trader_stoch
name: slowD_MAType
type: int
description:
<p class="para">
      Type of Moving Average for Slow-D. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: trader_stochf
name: fastD_Period
type: int
description:
<p class="para">
      Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually set to 3.
     </p>


function_name: trader_stochf
name: fastD_MAType
type: int
description:
<p class="para">
      Type of Moving Average for Fast-D. <a href="trader.constants.html" class="link">TRADER_MA_TYPE_*</a> series of constants should be used.
     </p>


function_name: fdf_add_doc_javascript
name: fdf_document
type: resource
description:
<p class="para">
       The FDF document handle, returned by <span class="function">fdf_create</span>,
       <span class="function">fdf_open</span> or <span class="function">fdf_open_string</span>.
      </p>


function_name: fdf_add_doc_javascript
name: script_code
type: string
description:
<p class="para">
       The script code. It is strongly suggested to use <code class="literal">\r</code>
       for linebreaks within the script code.
      </p>


function_name: fdf_error
name: error_code
type: int
initializer: -1
description:
<p class="para">
       An error code obtained with <span class="function">fdf_errno</span>.
       If not provided, this function uses the internal error code set by the
       last operation.
      </p>


function_name: fdf_get_ap
name: face
type: int
description:
<p class="para">
       The possible values are <strong><code><a href="fdf.constants.html#constant.fdfnormalap">FDFNormalAP</a></code></strong>, 
       <strong><code><a href="fdf.constants.html#constant.fdfrolloverap">FDFRolloverAP</a></code></strong> and <strong><code><a href="fdf.constants.html#constant.fdfdownap">FDFDownAP</a></code></strong>.
      </p>


function_name: fdf_get_attachment
name: savepath
type: string
description:
<p class="para">
       May be the name of a plain file or an existing directory in which the
       file is to be created under its original name. Any existing file under
       the same name will be overwritten.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        There seems to be no other way to find out the original filename but
        to store the file using a directory as 
        <code class="parameter">savepath</code> and check for the basename it was
        stored under.
       </p>
      </p></blockquote>


function_name: fdf_get_value
name: which
type: int
initializer: -1
description:
<p class="para">
       Elements of an array field can be retrieved by passing this optional
       parameter, starting at zero. For non-array fields, this parameter will
       be ignored.
      </p>


function_name: fdf_next_field_name
name: fieldname
type: string
description:
<p class="para">
       Name of the FDF field, as a string. If not given, the first field will
       be assumed.
      </p>


function_name: fdf_open_string
name: fdf_data
type: string
description:
<p class="para">
       The data as returned from a PDF form or created using 
       <span class="function">fdf_create</span> and 
       <span class="function">fdf_save_string</span>.
      </p>


function_name: fdf_open
name: filename
type: string
description:
<p class="para">
       Path to the FDF file. This file must contain the data as returned from
       a PDF form or created using <span class="function">fdf_create</span> and
       <span class="function">fdf_save</span>.
      </p>


function_name: fdf_save
name: filename
type: string
description:
<p class="para">
       If provided, the resulting FDF will be written in this parameter.
       Otherwise, this function will write the FDF to the default PHP output
       stream.
      </p>


function_name: fdf_set_ap
name: face
type: int
description:
<p class="para">
       The possible values <strong><code><a href="fdf.constants.html#constant.fdfnormalap">FDFNormalAP</a></code></strong>,
       <strong><code><a href="fdf.constants.html#constant.fdfrolloverap">FDFRolloverAP</a></code></strong> and
       <strong><code><a href="fdf.constants.html#constant.fdfdownap">FDFDownAP</a></code></strong>.
      </p>


function_name: fdf_set_encoding
name: encoding
type: string
description:
<p class="para">
       The encoding name. The following values are supported: 
       &quot;<code class="literal">Shift-JIS</code>&quot;, &quot;<code class="literal">UHC</code>&quot;,
       &quot;<code class="literal">GBK</code>&quot; and &quot;<code class="literal">BigFive</code>&quot;.
      </p>
      <p class="para">
       An empty string resets the encoding to the default 
       <code class="literal">PDFDocEncoding/Unicode</code> scheme.
      </p>


function_name: fdf_set_file
name: target_frame
type: string
description:
<p class="para">
       Use this parameter to specify the frame in which the document will be
       displayed. You can also set the default value for this parameter using
       <span class="function">fdf_set_target_frame</span>.
      </p>


function_name: fdf_set_value
name: value
type: mixed
description:
<p class="para">
       This parameter will be stored as a string unless it is an array. In
       this case all array elements will be stored as a value array.
      </p>


function_name: fdf_set_value
name: isName
type: int
description:
<blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        In older versions of the FDF toolkit last parameter determined if the
        field value was to be converted to a PDF Name (= 1) or set to a PDF
        String (= 0).
       </p>
       <p class="para">
        The value is no longer used in the current toolkit version 5.0. For
        compatibility reasons it is still supported as an optional parameter,
        but ignored internally.
       </p>
      </p></blockquote>


function_name: fdf_set_version
name: version
type: string
description:
<p class="para">
       The version number. For the current FDF toolkit 5.0, this may be
       either <code class="literal">1.2</code>, <code class="literal">1.3</code> or
       <code class="literal">1.4</code>.
      </p>


function_name: gnupg_adddecryptkey
name: identifier
type: resource
description:
<p class="para">The gnupg identifier, from a call to
<span class="function">gnupg_init</span> or <span class="classname">gnupg</span>.</p>


function_name: gnupg_decryptverify
name: plaintext
type: string
description:
<p class="para">
       The parameter <code class="parameter">plaintext</code> gets filled with the decrypted
       text.
      </p>


function_name: gnupg_gettrustlist
name: pattern
type: string
description:
<p class="para">
       Expression to limit the list of trust items to only the ones matching the pattern.
      </p>


function_name: gnupg_init
name: options
type: null
description:
<p class="para">
       Must be an associative array. It is used to change the default configuration
       of the crypto engine.
       <table class="doctable table">
        <caption><strong>Configuration overrides</strong></caption>
        
         <thead>
          <tr>
           <th>key</th>
           <th>type</th>
           <th>description</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>file_name</td>
           <td><span class="type">string</span></td>
           <td>
            It is the file name of the executable program implementing this protocol
            which is usually path of the <code class="literal">gpg</code> executable.
           </td>
          </tr>

          <tr>
           <td>home_dir</td>
           <td><span class="type">string</span></td>
           <td>
            It is the directory name of the configuration directory. It also overrides
            <code class="literal">GNUPGHOME</code> environment variable that is used for the same
            purpose.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: gnupg_setarmor
name: armor
type: int
description:
<p class="para">
       Pass a non-zero integer-value to this function to enable armored-output
       (default).
       Pass 0 to disable armored output.
      </p>


function_name: gnupg_seterrormode
name: errormode
type: int
description:
<p class="para">
       The error mode.
      </p>
      <p class="para">
       <code class="parameter">errormode</code> takes a constant indicating what type of
       error_reporting should be used. The possible values are
       <strong><code><a href="gnupg.constants.html#constant.gnupg-error-warning">GNUPG_ERROR_WARNING</a></code></strong>,
       <strong><code><a href="gnupg.constants.html#constant.gnupg-error-exception">GNUPG_ERROR_EXCEPTION</a></code></strong> and
       <strong><code><a href="gnupg.constants.html#constant.gnupg-error-silent">GNUPG_ERROR_SILENT</a></code></strong>.
       By default <strong><code><a href="gnupg.constants.html#constant.gnupg-error-silent">GNUPG_ERROR_SILENT</a></code></strong> is used.
      </p>


function_name: gnupg_verify
name: signature
type: string
description:
<p class="para">
       The signature.
       To verify a clearsigned text, set signature to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
      </p>


function_name: gnupg_verify
name: plaintext
type: string
description:
<p class="para">
       The plain text.
       If this optional parameter is passed, it is
       filled with the plain text.
      </p>


function_name: wkhtmltox\PDF\Converter.__construct
name: settings
type: array
description:
<p class="para">
      <table class="doctable table">
       
       
        <thead>
         <tr>
          <th>Name</th>
          <th>Description</th>
          <th>Values</th>
          <th>Changelog</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>size.pageSize</td>
          <td>paper size of output document</td>
          <td>A4</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>size.width</td>
          <td>with of the output document</td>
          <td>210mm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>size.height</td>
          <td>height of the output document</td>
          <td>297mm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>orientation</td>
          <td>orientation of the output document</td>
          <td>
           <table class="doctable table">
            
            
             <tbody class="tbody">
              <tr>
               <td>Landscape</td>
              </tr>

              <tr>
               <td>Portrait</td>
              </tr>

             </tbody>
            
           </table>

          </td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>colorMode</td>
          <td>color mode of the output document</td>
          <td>
           <table class="doctable table">
            
            
             <tbody class="tbody">
              <tr>
               <td>Color</td>
              </tr>

              <tr>
               <td>Greyscale</td>
              </tr>

             </tbody>
            
           </table>

          </td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>resolution</td>
          <td>resoluition of the output document</td>
          <td>most likely has no effect</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>dpi</td>
          <td>dpi to use while printing</td>
          <td>80</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>pageOffset</td>
          <td>integer added to page numbers generating headers, footers, and toc</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>copies</td>
          <td class="empty">&nbsp;</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>collate</td>
          <td>collate copies</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>outline</td>
          <td>generate PDF outline</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>outlineDepth</td>
          <td>maximum depth of outline</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>dumpOutline</td>
          <td>path of file to dump outline XML</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>out</td>
          <td>path of output file, if &quot;-&quot; stdout is used</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>documentTitle</td>
          <td>title for the output document</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>useCompression</td>
          <td>enable or disable lossless compression</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>margin.top</td>
          <td>size of the top margin</td>
          <td>2cm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>margin.bottom</td>
          <td>size of the bottom margin</td>
          <td>2cm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>margin.left</td>
          <td>size of the left margin</td>
          <td>2cm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>margin.right</td>
          <td>size of the right margin</td>
          <td>2cm</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>imageDPI</td>
          <td>maximum DPI for images in the output document</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>imageQuality</td>
          <td>the jpeg compression factor for images in the output document</td>
          <td>94</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
           <td>load.cookieJar</td>
           <td>path of file used to load and store cookies</td>
           <td>/tmp/cookies.txt</td>
           <td>&gt;= 0.1.0</td>
         </tr>

        </tbody>
       
      </table>

     </p>


function_name: wkhtmltox\PDF\Object.__construct
name: settings
type: array
description:
<p class="para">
      <table class="doctable table">
       
       
        <thead>
         <tr>
          <th>Name</th>
          <th>Description</th>
          <th>Values</th>
          <th>Changelog</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>page</td>
          <td>URL or path of the HTML to convert</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>useExternalLinks</td>
          <td>set true to convert external links in the input into external PDF links in the output</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>useLocalLinks</td>
          <td>set true to convert internal links in the input into internal PDF links in the output</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>produceForms</td>
          <td>set true to turn HTML forms into PDF forms</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>replacements</td>
          <td>undocumented</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>includeInOutline</td>
          <td>set true to include sections from this object in the outline and toc</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>pagesCount</td>
          <td>set true to make page count in toc inclusive of the number of pages in this object</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>tocXsl</td>
          <td>set to style sheet to convert this object into a toc object</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.useDottedLines</td>
          <td>set true to use dotted lines in toc</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.captionText</td>
          <td>the caption text for toc</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.forwardLinks</td>
          <td>set true to create links from toc to content</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.backLinks</td>
          <td>set true to create links from content to toc</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.indentation</td>
          <td>indentation for toc</td>
          <td>2em</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>toc.fontScale</td>
          <td>the factor to scale down the font at every toc level</td>
          <td>0.8</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.fontSize</td>
          <td>font size for use in header</td>
          <td>13</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.fontName</td>
          <td>name of font for use in header</td>
          <td>times</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.left</td>
          <td>text for left of header</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.center</td>
          <td>text for center of header</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.right</td>
          <td>text for right of header</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.line</td>
          <td>enable or disable horizontal rule under header</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.spacing</td>
          <td>space between header and content</td>
          <td>1.8</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>header.htmlUrl</td>
          <td>URL or path of HTML to use in header</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.fontSize</td>
          <td>font size for use in footer</td>
          <td>13</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.fontName</td>
          <td>name of font for use in footer</td>
          <td>times</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.left</td>
          <td>text for left of footer</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.center</td>
          <td>text for center of footer</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.right</td>
          <td>text for right of footer</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.line</td>
          <td>enable or disable horizontal rule under footer</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.spacing</td>
          <td>space between footer and content</td>
          <td>1.8</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>footer.htmlUrl</td>
          <td>URL or path of HTML to use in footer</td>
          <td class="empty">&nbsp;</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
  <td>load.username</td>
  <td>user name to use when loging into a website</td>
  <td>bart</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.password</td>
  <td>the password to used when logging into a website</td>
  <td>elbarto</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.jsdelay</td>
  <td>the amount of time in milliseconds to wait after a page is loaded until it is captured</td>
  <td>1200</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.zoomFactor</td>
  <td>how much zoom should be applied to the content</td>
  <td>2.2</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.customHeaders</td>
  <td>custom headers to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.repertCustomHeaders</td>
  <td>set true to send with all requests</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.cookies</td>
  <td>cookie string to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.post</td>
  <td>post string to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.blockLocalFileAccess</td>
  <td>disallow local and piped files to access other local files</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.stopSlowScript</td>
  <td>stop slow running javascript</td>
  <td>boolean</td>
  <td class="empty">&nbsp;</td>
</tr>

<tr>
  <td>load.debugJavascript</td>
  <td>allow javascript to raise warnings</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.loadErrorHandling</td>
  <td>set error handling strategy</td>
  <td>
   <table class="doctable table">
    
    
     <tbody class="tbody">
      <tr>
       <td>abort</td>
       <td>abort the convertion process</td>
      </tr>

      <tr>
       <td>skip</td>
       <td>do not add the object to the final output</td>
      </tr>

      <tr>
       <td>ignore</td>
       <td>try to add the object to the final output</td>
      </tr>

     </tbody>
    
   </table>

  </td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.proxy</td>
  <td class="empty">&nbsp;</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>


         <tr>
  <td>web.background</td>
  <td>include background image in output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.loadImages</td>
  <td>include images in output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enableJavascript</td>
  <td>enable or disable javascript</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enableIntelligentShrinking</td>
  <td>enable to attempt to fit more content on page, only applies to PDF output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.minimumFontSize</td>
  <td>the minimum font size allowed</td>
  <td>9</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.printMediaType</td>
  <td>print content using print media type instead of screen media type</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.defaultEncoding</td>
  <td>content to use where no encoding is specified</td>
  <td>utf-8</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.userStyleSheet</td>
  <td>URL or path to a user specified style sheet</td>
  <td>/path/to/style.css</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enablePlugins</td>
  <td>enable or disable NS plugins</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>


        </tbody>
       
      </table>

     </p>


function_name: wkhtmltox\Image\Converter.__construct
name: settings
type: array
description:
<p class="para">
      <table class="doctable table">
       
       
        <thead>
         <tr>
          <th>Name</th>
          <th>Description</th>
          <th>Values</th>
          <th>Changelog</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>in</td>
          <td>URL or path of the input file, if &quot;-&quot; stdin is used</td>
          <td>/path/to/markup.html</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>out</td>
          <td>path of output file, if &quot;-&quot; stdout is used, by default an internal buffer is used</td>
          <td>/path/to/output.png</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>fmt</td>
          <td>output format to use</td>
          <td>
           <table class="doctable table">
            
            
             <tbody class="tbody">
              <tr>
               <td>&quot;&quot;</td>
               <td>default</td>
              </tr>

              <tr>
               <td>jpg</td>
               <td>output as JPEG</td>
              </tr>

              <tr>
               <td>png</td>
               <td>output as PNG</td>
              </tr>

              <tr>
               <td>bmp</td>
               <td>output as bitmap</td>
              </tr>

              <tr>
               <td>svg</td>
               <td>output as SVG</td>
              </tr>

             </tbody>
            
           </table>

          </td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>transparent</td>
          <td>when outputting a PNG or SVG, make the white background transparent</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>screenWidth</td>
          <td>the with of the screen used to render in pixels</td>
          <td>800</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>smartWidth</td>
          <td>when true, screenWidth is expanded to the content width</td>
          <td>boolean</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>quality</td>
          <td>compression factor to use when outputting a JPEG image</td>
          <td>94</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>crop.left</td>
          <td>left/x coordinate of the window to capture in pixels</td>
          <td>200</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>crop.top</td>
          <td>top/y coordinate of the window to capture in pixels</td>
          <td>200</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>crop.width</td>
          <td>width of the window to capture in pixels</td>
          <td>200</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
          <td>crop.height</td>
          <td>height of the window to capture in pixels</td>
          <td>200</td>
          <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
           <td>load.cookieJar</td>
           <td>path of file used to load and store cookies</td>
           <td>/tmp/cookies.txt</td>
           <td>&gt;= 0.1.0</td>
         </tr>

         <tr>
  <td>load.username</td>
  <td>user name to use when loging into a website</td>
  <td>bart</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.password</td>
  <td>the password to used when logging into a website</td>
  <td>elbarto</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.jsdelay</td>
  <td>the amount of time in milliseconds to wait after a page is loaded until it is captured</td>
  <td>1200</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.zoomFactor</td>
  <td>how much zoom should be applied to the content</td>
  <td>2.2</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.customHeaders</td>
  <td>custom headers to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.repertCustomHeaders</td>
  <td>set true to send with all requests</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.cookies</td>
  <td>cookie string to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.post</td>
  <td>post string to send when requesting the main web page</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.blockLocalFileAccess</td>
  <td>disallow local and piped files to access other local files</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.stopSlowScript</td>
  <td>stop slow running javascript</td>
  <td>boolean</td>
  <td class="empty">&nbsp;</td>
</tr>

<tr>
  <td>load.debugJavascript</td>
  <td>allow javascript to raise warnings</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.loadErrorHandling</td>
  <td>set error handling strategy</td>
  <td>
   <table class="doctable table">
    
    
     <tbody class="tbody">
      <tr>
       <td>abort</td>
       <td>abort the convertion process</td>
      </tr>

      <tr>
       <td>skip</td>
       <td>do not add the object to the final output</td>
      </tr>

      <tr>
       <td>ignore</td>
       <td>try to add the object to the final output</td>
      </tr>

     </tbody>
    
   </table>

  </td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>load.proxy</td>
  <td class="empty">&nbsp;</td>
  <td class="empty">&nbsp;</td>
  <td>&gt;= 0.1.0</td>
</tr>


         <tr>
  <td>web.background</td>
  <td>include background image in output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.loadImages</td>
  <td>include images in output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enableJavascript</td>
  <td>enable or disable javascript</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enableIntelligentShrinking</td>
  <td>enable to attempt to fit more content on page, only applies to PDF output</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.minimumFontSize</td>
  <td>the minimum font size allowed</td>
  <td>9</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.printMediaType</td>
  <td>print content using print media type instead of screen media type</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.defaultEncoding</td>
  <td>content to use where no encoding is specified</td>
  <td>utf-8</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.userStyleSheet</td>
  <td>URL or path to a user specified style sheet</td>
  <td>/path/to/style.css</td>
  <td>&gt;= 0.1.0</td>
</tr>

<tr>
  <td>web.enablePlugins</td>
  <td>enable or disable NS plugins</td>
  <td>boolean</td>
  <td>&gt;= 0.1.0</td>
</tr>


        </tbody>
       
      </table>

     </p>


function_name: ps_add_bookmark
name: psdoc
type: resource
description:
<p class="para">
       Resource identifier of the postscript file
       as returned by <span class="function">ps_new</span>.
      </p>


function_name: ps_add_bookmark
name: parent
type: int
description:
<p class="para">
       A bookmark previously created by this function which
       is used as the parent of the new bookmark.
      </p>


function_name: ps_add_bookmark
name: open
type: int
description:
<p class="para">
       If <code class="parameter">open</code> is unequal to zero the bookmark will
       be shown open by the pdf viewer.
      </p>


function_name: ps_add_launchlink
name: filename
type: string
description:
<p class="para">
       The path of the program to be started, when the link is clicked on.
      </p>


function_name: ps_add_locallink
name: dest
type: string
description:
<p class="para">
       The parameter <code class="parameter">dest</code> determines how the document
       is being viewed. It can be <code class="literal">fitpage</code>,
       <code class="literal">fitwidth</code>, <code class="literal">fitheight</code>, or
       <code class="literal">fitbbox</code>.
      </p>


function_name: ps_add_note
name: icon
type: string
description:
<p class="para">
       The icon shown if the note is folded. This parameter can be set
       to <code class="literal">comment</code>, <code class="literal">insert</code>,
       <code class="literal">note</code>, <code class="literal">paragraph</code>,
       <code class="literal">newparagraph</code>, <code class="literal">key</code>, or
       <code class="literal">help</code>.
      </p>


function_name: ps_add_note
name: open
type: int
description:
<p class="para">
       If <code class="parameter">open</code> is unequal to zero the note will
       be shown unfolded after opening the document with a pdf viewer.
      </p>


function_name: ps_add_pdflink
name: filename
type: string
description:
<p class="para">
       The name of the pdf document to be opened when clicking on
       this link.
      </p>


function_name: ps_add_weblink
name: url
type: string
description:
<p class="para">
       The url of the hyperlink to be opened when clicking on
       this link, e.g. <code class="literal">http://www.php.net</code>.
      </p>


function_name: ps_close_image
name: imageid
type: int
description:
<p class="para">
       Resource identifier of the image as returned by
       <span class="function">ps_open_image</span> or
       <span class="function">ps_open_image_file</span>.
      </p>


function_name: ps_findfont
name: encoding
type: string
description:
<p class="para">
       <span class="function">ps_findfont</span> will try to load the file passed in
       the parameter <code class="parameter">encoding</code>. Encoding files are of
       the same syntax as those used by <strong class="command">dvips(1)</strong>. They
       contain a font encoding vector (which is currently not used but must be
       present) and a list of extra ligatures to extend the list of ligatures
       derived from the afm file.
      </p>
      <p class="para">
       <code class="parameter">encoding</code> can be <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> or the empty string if
       the default encoding (TeXBase1) shall be used.
      </p>
      <p class="para">
       If the encoding is set to <code class="literal">builtin</code> then there
       will be no reencoding and the font specific encoding will be used. This
       is very useful with symbol fonts.
      </p>


function_name: ps_findfont
name: embed
type: bool
description:
<p class="para">
       If set to a value &gt;0 the font will be embedded into the document. This
       requires the font outline (.pfb file) to be present.
      </p>


function_name: ps_get_parameter
name: modifier
type: float
description:
<p class="para">
       An identifier needed if a parameter of a resource is requested,
       e.g. the size of an image. In such a case the resource id is
       passed.
      </p>


function_name: ps_get_value
name: modifier
type: float
description:
<p class="para">
       The parameter <code class="parameter">modifier</code> specifies the resource
       for which the value is to be retrieved. This can be the id of a font or
       an image.
      </p>


function_name: ps_hyphenate
name: text
type: string
description:
<p class="para">
       <code class="parameter">text</code> should not contain any non alpha
       characters. Possible positions for breaks are returned in an array of
       interger numbers. Each number is the position of the char in 
       <code class="parameter">text</code> after which a hyphenation can take place.
      </p>


function_name: ps_open_file
name: filename
type: string
description:
<p class="para">
       The name of the postscript file.
       If <code class="parameter">filename</code> is not passed the document will be
       created in memory and all output will go straight to the browser.
      </p>


function_name: ps_open_image_file
name: type
type: string
description:
<p class="para">
       The type of the image. Possible values are <code class="literal">png</code>,
       <code class="literal">jpeg</code>, or <code class="literal">eps</code>.
      </p>


function_name: ps_open_image
name: components
type: int
description:
<p class="para">
       The number of components for each pixel. This can be
       1 (gray scale images), 3 (rgb images), or 4 (cmyk, rgba images).
      </p>


function_name: ps_place_image
name: imageid
type: int
description:
<p class="para">
       The resource identifier of the image as returned by 
       <span class="function">ps_open_image</span> or
       <span class="function">ps_open_image_file</span>.
      </p>


function_name: ps_place_image
name: scale
type: float
description:
<p class="para">
       The scaling factor for the image. A scale of 1.0 will result
       in a resolution of 72 dpi, because each pixel is equivalent to
       1 point.
      </p>


function_name: ps_set_border_style
name: style
type: string
description:
<p class="para">
       <code class="parameter">style</code> can be <code class="literal">solid</code> or
       <code class="literal">dashed</code>.
      </p>


function_name: ps_set_info
name: key
type: string
description:
<p class="para">
       The name of the information field to set. The values which can be
       set are <code class="literal">Keywords</code>, <code class="literal">Subject</code>,
       <code class="literal">Title</code>, <code class="literal">Creator</code>,
       <code class="literal">Author</code>, <code class="literal">BoundingBox</code>, and
       <code class="literal">Orientation</code>. Be aware that some of them has a
       meaning to PostScript viewers.
      </p>


function_name: ps_set_parameter
name: name
type: string
description:
<p class="para">
       For a list of possible names see <span class="function">ps_get_parameter</span>.
      </p>


function_name: ps_setcolor
name: type
type: string
description:
<p class="para">
       The parameter <code class="parameter">type</code> can be 
       <code class="literal">both</code>, <code class="literal">fill</code>, or
       <code class="literal">fillstroke</code>.
      </p>


function_name: ps_setcolor
name: colorspace
type: string
description:
<p class="para">
       The colorspace should be one of <code class="literal">gray</code>,
       <code class="literal">rgb</code>, <code class="literal">cmyk</code>, 
       <code class="literal">spot</code>, <code class="literal">pattern</code>. Depending on the
       colorspace either only the first, the first three or all parameters
       will be used.
      </p>


function_name: ps_setcolor
name: c1
type: float
description:
<p class="para">
       Depending on the colorspace this is either the red component (rgb),
       the cyan component (cmyk), the gray value (gray), the identifier of
       the spot color or the identifier of the pattern.
      </p>


function_name: ps_setcolor
name: c2
type: float
description:
<p class="para">
       Depending on the colorspace this is either the green component (rgb),
       the magenta component (cmyk).
      </p>


function_name: ps_setcolor
name: c3
type: float
description:
<p class="para">
       Depending on the colorspace this is either the blue component (rgb),
       the yellow component (cmyk).
      </p>


function_name: ps_setcolor
name: c4
type: float
description:
<p class="para">
       This must only be set in cmyk colorspace and specifies the black
       component.
      </p>


function_name: ps_setflat
name: value
type: float
description:
<p class="para">
       The <code class="parameter">value</code> must be between 0.2 and 1.
      </p>


function_name: ps_setfont
name: fontid
type: int
description:
<p class="para">
       The font identifier as returned by <span class="function">ps_findfont</span>.
      </p>


function_name: ps_setlinecap
name: type
type: int
description:
<p class="para">
       The type of line ends. Possible values are
       <code class="literal">PS_LINECAP_BUTT</code>,
       <code class="literal">PS_LINECAP_ROUND</code>, or
       <code class="literal">PS_LINECAP_SQUARED</code>.
      </p>


function_name: ps_setlinejoin
name: type
type: int
description:
<p class="para">
       The way lines are joined. Possible values are
       <code class="literal">PS_LINEJOIN_MITER</code>,
       <code class="literal">PS_LINEJOIN_ROUND</code>, or
       <code class="literal">PS_LINEJOIN_BEVEL</code>.
      </p>


function_name: ps_setmiterlimit
name: value
type: float
description:
<p class="para">
       The maximum ratio between the miter length and the line width. Larger
       values (&gt; 10) will result in very long spikes when two lines meet
       in a small angle. Keep the default unless you know what you are doing.
      </p>


function_name: ps_setpolydash
name: arr
type: float
description:
<p class="para">
       <code class="parameter">arr</code> is a list of length elements alternately for
       the black and white portion.
      </p>


function_name: ps_shading_pattern
name: shadingid
type: int
description:
<p class="para">
       The identifier of a shading previously created with
       <span class="function">ps_shading</span>.
      </p>


function_name: ps_shading
name: type
type: string
description:
<p class="para">
       The type of shading can be either <code class="literal">radial</code> or
       <code class="literal">axial</code>. Each shading starts with the current fill
       color and ends with the given color values passed in the parameters
       <code class="parameter">c1</code> to <code class="parameter">c4</code>
       (see <span class="function">ps_setcolor</span> for their meaning).
      </p>


function_name: ps_shading
name: optlist
type: string
description:
<p class="para">
       If the shading is of type <code class="literal">radial</code> the
       <code class="parameter">optlist</code> must also contain the parameters
       <code class="literal">r0</code> and <code class="literal">r1</code> with the radius of the
       start and end circle.
      </p>


function_name: ps_show_boxed
name: hmode
type: string
description:
<p class="para">
       The parameter <code class="parameter">hmode</code> can be <code class="literal">justify</code>,
       <code class="literal">fulljustify</code>, <code class="literal">right</code>, <code class="literal">left</code>, or <code class="literal">center</code>.
       The difference of <code class="literal">justify</code> and <code class="literal">fulljustify</code> just affects the last line of the box. In
       <code class="literal">fulljustify</code> mode the last line will be left and right justified unless
       this is also the last line of paragraph. In <code class="literal">justify</code> mode it will always
       be left justified.
      </p>


function_name: ps_show_boxed
name: feature
type: string
description:
<p class="para">
        Set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> in order to turn hyphenation on. This requires a
        dictionary to be set with the parameter <code class="parameter">hyphendict</code>. Defaults to
        <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
       </p>


function_name: ps_show_xy
name: x
type: float
description:
<p class="para">
       x-coordinate of the lower left corner of the box surrounding the text.
      </p>


function_name: ps_show_xy
name: y
type: float
description:
<p class="para">
       y-coordinate of the lower left corner of the box surrounding the text.
      </p>


function_name: ps_string_geometry
name: fontid
type: int
description:
<p class="para">
       The identifier of the font to be used. If not font is specified
       the current font will be used.
      </p>


function_name: ps_string_geometry
name: size
type: float
initializer: 0.0
description:
<p class="para">
       The size of the font. If no size is specified the current size
       is used.
      </p>


function_name: ps_symbol_name
name: ord
type: int
description:
<p class="para">
       The parameter <code class="parameter">ord</code> is the position of the glyph
       in the font encoding vector.
      </p>


function_name: rpmaddtag
name: tag
type: int
description:
<p class="para">
      One of RPMTAG_* constant, see the <a href="rpminfo.constants.html" class="link">rpminfo constants</a> page.
     </p>


function_name: rpmdbinfo
name: full
type: bool
description:
<p class="para">
      If <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> all information headers for the file are retrieved, else only a minimal set.
     </p>


function_name: rpmdbsearch
name: rpmtag
type: int
initializer: RPMTAG_NAME
description:
<p class="para">
      Search criterion, one of RPMTAG_* constant, see the <a href="rpminfo.constants.html" class="link">rpminfo constants</a> page.
     </p>


function_name: rpmdbsearch
name: rpmmire
type: int
initializer: -1
description:
<p class="para">
      Pattern type, one of RPMMIRE_* constant, see the <a href="rpminfo.constants.html" class="link">rpminfo constants</a> page.
      When &lt; 0 the criterion must equals the value, and database index is used if possible.
     </p>


function_name: rpminfo
name: error
type: string
description:
<p class="para">
      If provided, will receive the possible error message, and will avoid a runtime warning.
     </p>


function_name: rpmvercmp
name: operator
type: null
description:
<p class="para">
      An optional operator. The possible operators
      are: <code class="literal">&lt;</code>, <code class="literal">lt</code>,
      <code class="literal">&lt;=</code>, <code class="literal">le</code>, <code class="literal">&gt;</code>,
      <code class="literal">gt</code>, <code class="literal">&gt;=</code>, <code class="literal">ge</code>,
      <code class="literal">==</code>, <code class="literal">=</code>, <code class="literal">eq</code>,
      <code class="literal">!=</code>, <code class="literal">&lt;&gt;</code>, <code class="literal">ne</code>
      respectively.
     </p>
     <p class="para">
      This parameter is case-sensitive, values should be lowercase.
     </p>


function_name: eio_busy
name: pri
type: int
initializer: EIO_PRI_DEFAULT
description:
<p class="para">The request priority: <strong><code><a href="eio.constants.html#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong>, <strong><code><a href="eio.constants.html#constant.eio-pri-min">EIO_PRI_MIN</a></code></strong>, <strong><code><a href="eio.constants.html#constant.eio-pri-max">EIO_PRI_MAX</a></code></strong>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> passed, <code class="parameter">pri</code> internally is set to
<strong><code><a href="eio.constants.html#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong>.
</p>


function_name: eio_busy
name: data
type: mixed
initializer: NULL
description:
<p class="para">
     Arbitrary variable passed to <code class="parameter">callback</code>.
     </p>


function_name: eio_cancel
name: req
type: resource
description:
<p class="para">is optional request resource which can be used with functions like <span class="function">eio_get_last_error</span></p>


function_name: eio_chmod
name: path
type: string
description:
<p class="para">
     Path to the target file or directory
     <div class="warning"><strong class="warning">Warning</strong><p class="simpara">Avoid relative
paths</p></div>

     </p>


function_name: eio_chmod
name: callback
type: callable
initializer: NULL
description:
<p class="para">
<code class="parameter">callback</code> function is called when the request is done.
It should match the following prototype: <div class="example-contents"><div class="phpcode"><code><span style="color: #000000">void callback(mixed $data, int $result[, resource $req]);</span></code></div></div>

<dl>

<dt><code class="parameter">data</code></dt>
<dd><p class="para">is custom data passed to the request.</p></dd>


<dt><code class="parameter">result</code></dt>
<dd><p class="para">request-specific result value; basically, the value returned by corresponding
system call.</p></dd>


<dt><code class="parameter">req</code></dt>
<dd><p class="para">is optional request resource which can be used with functions like <span class="function">eio_get_last_error</span></p></dd>

</dl>
</p>


function_name: eio_chown
name: path
type: string
description:
<p class="para">
     Path to file or directory.
     <div class="warning"><strong class="warning">Warning</strong><p class="simpara">Avoid relative
paths</p></div>

     </p>


function_name: eio_custom
name: execute
type: callable
description:
<p class="para">
      Specifies the request function that should match the following prototype:

      <div class="example-contents"><div class="cdata"><pre>
      mixed execute(mixed data);
      </pre></div></div>

      <code class="parameter">callback</code> is event completion callback that should match the following
      prototype:
      <div class="example-contents"><div class="cdata"><pre>
      void callback(mixed data, mixed result);
      </pre></div></div>


     <code class="parameter">data</code> is the data passed to
     <code class="parameter">execute</code> via <code class="parameter">data</code> argument
      without modifications
      <code class="parameter">result</code> value returned by <code class="parameter">execute</code>
     </p>


function_name: eio_fallocate
name: fd
type: mixed
description:
<p class="para">
     Stream, Socket resource, or numeric file descriptor, e.g. returned by <span class="function">eio_open</span>.
     </p>


function_name: eio_fallocate
name: mode
type: int
description:
<p class="para">Currently only one flag is supported for mode:
     <strong><code><a href="eio.constants.html#constant.eio-falloc-fl-keep-size">EIO_FALLOC_FL_KEEP_SIZE</a></code></strong> (the same as POSIX constant
       <strong><code>FALLOC_FL_KEEP_SIZE</code></strong>).
     </p>


function_name: eio_futime
name: fd
type: mixed
description:
<p class="para">
     Stream, Socket resource, or numeric file descriptor, e.g. returned by <span class="function">eio_open</span>
     </p>


function_name: eio_grp_add
name: grp
type: resource
description:
<p class="para">
     The request group resource returned by <span class="function">eio_grp</span>
     </p>


function_name: eio_grp_cancel
name: grp
type: resource
description:
<p class="para">
     The request group resource returned by <span class="function">eio_grp</span>.
     </p>


function_name: eio_mknod
name: mode
type: int
description:
<p class="para">
      Specifies both the permissions to use and the type of node to be
      created. It should be a combination (using bitwise OR) of one of the
      file types listed below and the permissions for the new node(e.g. 0640).

      Possible file types are: <strong><code><a href="eio.constants.html#constant.eio-s-ifreg">EIO_S_IFREG</a></code></strong>(regular file),
      <strong><code><a href="eio.constants.html#constant.eio-s-ifchr">EIO_S_IFCHR</a></code></strong>(character file),
      <strong><code><a href="eio.constants.html#constant.eio-s-ifblk">EIO_S_IFBLK</a></code></strong>(block special file),
      <strong><code><a href="eio.constants.html#constant.eio-s-ififo">EIO_S_IFIFO</a></code></strong>(FIFO - named pipe) and
      <strong><code><a href="eio.constants.html#constant.eio-s-ifsock">EIO_S_IFSOCK</a></code></strong>(UNIX domain socket).

      To specify permissions <em>EIO_S_I*</em> constants could be
      used.
     </p>


function_name: eio_mknod
name: dev
type: int
description:
<p class="para">
     If  the  file type is <strong><code><a href="eio.constants.html#constant.eio-s-ifchr">EIO_S_IFCHR</a></code></strong> or
     <strong><code><a href="eio.constants.html#constant.eio-s-ifblk">EIO_S_IFBLK</a></code></strong> then dev specifies the major and minor
     numbers of the newly created device special file. Otherwise
     <code class="parameter">dev</code> ignored. See <em>mknod(2) man page for
     details</em>.
     </p>


function_name: eio_open
name: path
type: string
description:
<p class="para">
     Path of the file to be opened.
     <div class="warning"><strong class="warning">Warning</strong><p class="simpara">
     In some SAPIs(e.g. <em>PHP-FPM</em>) it could fail, if you
     don&#039;t specify full path.
     </p></div>
     </p>


function_name: eio_open
name: flags
type: int
description:
<p class="para">One of <em>EIO_O_*</em> constants, or their
    combinations. <em>EIO_O_*</em> constants have the same
    meaning, as their corresponding <em>O_*</em> counterparts
    defined in <code class="literal">fnctl.h</code> C header file. Default is
    <strong><code><a href="eio.constants.html#constant.eio-o-rdwr">EIO_O_RDWR</a></code></strong>.
    </p>


function_name: eio_open
name: mode
type: int
description:
<p class="para">One of <em>EIO_S_I*</em> constants, or their combination
    (via bitwise OR operator). The constants have the same meaning as their
    <em>S_I*</em> counterparts defined in <a href="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_stat.h.html" class="link external">&raquo;&nbsp;sys/stat.h</a>
    C header file. Required, if a file is created. Otherwise ignored.
     </p>


function_name: eio_open
name: data
type: mixed
initializer: NULL
description:
<p class="para">
      Arbitrary variable passed to <code class="parameter">callback</code>.
     </p>


function_name: eio_sendfile
name: out_fd
type: mixed
description:
<p class="para">
     Output stream, Socket resource, or file descriptor. Should be opened for writing.
     </p>


function_name: eio_sendfile
name: in_fd
type: mixed
description:
<p class="para">
     Input stream, Socket resource, or file descriptor. Should be opened for reading.
     </p>


function_name: eio_sync_file_range
name: nbytes
type: int
description:
<p class="para">
     Specifies the length of the range to be synchronized, in bytes. If
     <code class="parameter">nbytes</code> is zero, then all bytes from <code class="parameter">offset</code> through
     to the end of file are synchronized.
     </p>


function_name: eio_sync_file_range
name: flags
type: int
description:
<p class="para">
     A bit-mask. Can include any of the following values:
     <strong><code><a href="eio.constants.html#constant.eio-sync-file-range-wait-before">EIO_SYNC_FILE_RANGE_WAIT_BEFORE</a></code></strong>,
     <strong><code><a href="eio.constants.html#constant.eio-sync-file-range-write">EIO_SYNC_FILE_RANGE_WRITE</a></code></strong>,
     <strong><code><a href="eio.constants.html#constant.eio-sync-file-range-wait-after">EIO_SYNC_FILE_RANGE_WAIT_AFTER</a></code></strong>. These flags have
     the same meaning as their <em>SYNC_FILE_RANGE_*</em>
     counterparts(see <code class="literal">SYNC_FILE_RANGE(2)</code> man page).
     </p>


function_name: Ev.feedSignal
name: signum
type: int
description:
<p class="para">
      Signal number. See
      <code class="literal">signal(7)</code>
      man page for detals. You can use constants exported by
      <code class="literal">pcntl</code>
      extension.
     </p>


function_name: Ev.feedSignalEvent
name: signum
type: int
description:
<p class="para">
      Signal number. See
      <code class="literal">signal(7)</code>
      man page for detals. See also constants exported by
      <code class="literal">pcntl</code>
      extension.
     </p>


function_name: Ev.run
name: flags
type: int
description:
<p class="para">
      Optional parameter
      <code class="parameter">flags</code>
      can be one of the following:
      <table class="doctable table">
       <caption><strong>
         List for possible values of <code class="parameter">flags</code>
       </strong></caption>
       
        <thead>
         <tr>
          <th>
           <code class="parameter">flags</code>
          </th>
          <th>Description</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td>
           <code class="literal">0</code>
          </td>
          <td>The default behavior described above</td>
         </tr>

         <tr>
          <td>
           <strong><code><a href="class.ev.html#ev.constants.run-once">Ev::RUN_ONCE</a></code></strong>
          </td>
          <td>Block at most one(wait, but don&#039;t loop)</td>
         </tr>

         <tr>
          <td>
           <strong><code><a href="class.ev.html#ev.constants.run-nowait">Ev::RUN_NOWAIT</a></code></strong>
          </td>
          <td>Don&#039;t block at all(fetch/handle events, but don&#039;t wait)</td>
         </tr>

        </tbody>
       
      </table>

     </p>
     <p class="para">
      See
      <a href="class.ev.html#ev.constants.run-flags" class="link">the run flag
       constants</a>
      .
     </p>


function_name: Ev.stop
name: how
type: int
description:
<p class="para">
      One of
      <em>Ev::BREAK_*</em>
      <a href="class.ev.html#ev.constants.break-flags" class="link">constants</a>
      .
     </p>


function_name: EvCheck.__construct
name: callback
type: callable
description:
<p class="para">
      See
      <a href="ev.watcher-callbacks.html" class="link">Watcher callbacks</a>
      .
     </p>


function_name: EvCheck.__construct
name: priority
type: int
description:
<p class="para">
      <a href="class.ev.html#ev.constants.watcher-pri" class="link">Watcher priority</a>
     </p>


function_name: EvChild.__construct
name: pid
type: int
description:
<p class="para">
      Wait for status changes of process PID(or any process if PID is
      specified as
      <code class="literal">0</code>
      ).
     </p>


function_name: EvChild.__construct
name: trace
type: bool
description:
<p class="para">
      If <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, only activate the watcher when the process terminates.
      Otherwise(<strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>) additionally activate the watcher when the process is
      stopped or continued.
     </p>


function_name: EvChild.createStopped
name: pid
type: int
description:
<p class="para">
      The same as for
       <span class="methodname">EvChild::__construct</span>
     </p>


function_name: EvEmbed.__construct
name: other
type: object
description:
<p class="para">
      Instance of
      <span class="classname">EvLoop</span>
      . The loop to embed, this loop must be embeddable(see
       <span class="methodname">Ev::embeddableBackends</span>
      ).
     </p>


function_name: EvEmbed.createStopped
name: other
type: object
description:
<p class="para">
      The same as for
       <span class="methodname">EvEmbed::__construct</span>
     </p>


function_name: EvIo.__construct
name: fd
type: mixed
description:
<p class="para">
      Can be a stream opened with
      <span class="function">fopen</span>
      or similar functions, numeric file descriptor, or socket.
     </p>


function_name: EvIo.__construct
name: events
type: int
description:
<p class="para">
      <strong><code><a href="class.ev.html#ev.constants.read">Ev::READ</a></code></strong>
      and/or
      <strong><code><a href="class.ev.html#ev.constants.write">Ev::WRITE</a></code></strong>
      . See
      <a href="class.ev.html#ev.constants.watcher-revents" class="link">the bit masks</a>
      .
     </p>


function_name: EvIo.createStopped
name: fd
type: mixed
description:
<p class="para">
      The same as for
       <span class="methodname">EvIo::__construct</span>
     </p>


function_name: EvLoop.__construct
name: flags
type: int
description:
<p class="para">
      One of the
      <a href="class.ev.html#ev.constants.loop-flags" class="link">event loop flags</a>
     </p>


function_name: EvLoop.__construct
name: io_interval
type: float
initializer: 0.0
description:
<p class="para">
      See
      <a href="class.evloop.html#evloop.props.io-interval" class="link">io_interval</a>
     </p>


function_name: EvLoop.__construct
name: timeout_interval
type: float
initializer: 0.0
description:
<p class="para">
      See
      <a href="class.evloop.html#evloop.props.timeout-interval" class="link">timeout_interval</a>
     </p>


function_name: EvPeriodic.__construct
name: offset
type: float
description:
<p class="para">
      See
      <a href="ev.periodic-modes.html" class="link">Periodic watcher operation modes</a>
     </p>


function_name: EvPeriodic.__construct
name: reschedule_cb
type: callable
description:
<p class="para">
      Reschedule callback. You can pass <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>. See
      <a href="ev.periodic-modes.html" class="link">Periodic watcher operation
     modes</a>
     </p>


function_name: EvPeriodic.set
name: offset
type: float
description:
<p class="para">
      The same meaning as for
       <span class="methodname">EvPeriodic::__construct</span>
      . See
      <a href="ev.periodic-modes.html" class="link">Periodic watcher operation modes</a>
     </p>


function_name: EvSignal.__construct
name: signum
type: int
description:
<p class="para">
      Signal number. See constants exported by
      <em>pcntl</em>
      extension. See also
      <code class="literal">signal(7)</code>
      man page.
     </p>


function_name: EvSignal.set
name: signum
type: int
description:
<p class="para">
      Signal number. The same as for
       <span class="methodname">EvSignal::__construct</span>
     </p>


function_name: EvStat.__construct
name: interval
type: float
description:
<p class="para">
      Hint on how quickly a change is expected to be detected and should
      normally be specified as
      <code class="literal">0.0</code>
      to let
      <em>libev</em>
      choose a suitable value.
     </p>


function_name: EvTimer.__construct
name: after
type: float
description:
<p class="para">
      Configures the timer to trigger after
      <code class="parameter">after</code>
      seconds.
     </p>


function_name: EvTimer.__construct
name: repeat
type: float
description:
<p class="para">
      If repeat is
      <code class="literal">0.0</code>
      , then it will automatically be stopped once the timeout is reached. If
      it is positive, then the timer will automatically be configured to
      trigger again every repeat seconds later, until stopped manually.
     </p>


function_name: EvWatcher.feed
name: revents
type: int
description:
<p class="para">
      Bit mask of watcher
      <a href="class.ev.html#ev.constants.watcher-revents" class="link">received events</a>
      .
     </p>


function_name: EvWatcher.keepalive
name: value
type: bool
description:
<p class="para">
      With keepalive
      <code class="parameter">value</code>
      set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> the watcher won&#039;t keep
       <span class="methodname">Ev::run</span>
      /
       <span class="methodname">EvLoop::run</span>
      from returning even though the watcher is active.
     </p>


function_name: expect_expectl
name: expect
type: resource
description:
<p class="para">
       An Expect stream, previously opened with
       <span class="function">expect_popen</span>.
      </p>


function_name: expect_expectl
name: cases
type: array
description:
<p class="para">
       An array of expect cases. Each expect case is an indexed array,
       as described in the following table:
       <table class="doctable table">
        <caption><strong>Expect Case Array</strong></caption>
        
         <thead>
          <tr>
           <th>Index Key</th>
           <th>Value Type</th>
           <th>Description</th>
           <th>Is Mandatory</th>
           <th>Default Value</th>
          </tr>

         </thead>

         <tbody class="tbody">
          <tr>
           <td>0</td>
           <td>string</td>
           <td>pattern, that will be matched against the output from the stream</td>
           <td>yes</td>
           <td class="empty">&nbsp;</td>
          </tr>

          <tr>
           <td>1</td>
           <td>mixed</td>
           <td>value, that will be returned by this function, if the pattern matches</td>
           <td>yes</td>
           <td class="empty">&nbsp;</td>
          </tr>

          <tr>
           <td>2</td>
           <td>integer</td>
           <td>
            pattern type, one of:
            <a href="expect.constants.html#constant.exp-glob" class="link"><strong><code><a href="expect.constants.html#constant.exp-glob">EXP_GLOB</a></code></strong></a>,
            <a href="expect.constants.html#constant.exp-exact" class="link"><strong><code><a href="expect.constants.html#constant.exp-exact">EXP_EXACT</a></code></strong></a>
            or
            <a href="expect.constants.html#constant.exp-regexp" class="link"><strong><code><a href="expect.constants.html#constant.exp-regexp">EXP_REGEXP</a></code></strong></a>
           </td>
           <td>no</td>
           <td><a href="expect.constants.html#constant.exp-glob" class="link"><strong><code><a href="expect.constants.html#constant.exp-glob">EXP_GLOB</a></code></strong></a></td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: pcntl_alarm
name: seconds
type: int
description:
<p class="para">
       The number of seconds to wait. If <code class="parameter">seconds</code> is
       zero, no new alarm is created.
      </p>


function_name: pcntl_exec
name: path
type: string
description:
<p class="para">
       <code class="parameter">path</code> must be the path to a binary executable or a
       script with a valid path pointing to an executable in the shebang (
       #!/usr/local/bin/perl for example) as the first line.  See your system&#039;s
       man execve(2) page for additional information.
      </p>


function_name: pcntl_exec
name: args
type: array
initializer: []
description:
<p class="para">
       <code class="parameter">args</code> is an array of argument strings passed to the
       program.
      </p>


function_name: pcntl_exec
name: env_vars
type: array
initializer: []
description:
<p class="para">
       <code class="parameter">env_vars</code> is an array of strings which are passed as
       environment to the program.  The array is in the format of name =&gt; value,
       the key being the name of the environmental variable and the value being
       the value of that variable.
      </p>


function_name: pcntl_getpriority
name: process_id
type: null
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, the process id of the current process is used.
      </p>


function_name: pcntl_getpriority
name: mode
type: int
description:
<p class="para">
       One of <strong><code><a href="pcntl.constants.html#constant.prio-pgrp">PRIO_PGRP</a></code></strong>, <strong><code><a href="pcntl.constants.html#constant.prio-user">PRIO_USER</a></code></strong>,
       <strong><code><a href="pcntl.constants.html#constant.prio-process">PRIO_PROCESS</a></code></strong>,
       <strong><code><a href="pcntl.constants.html#constant.prio-darwin-bg">PRIO_DARWIN_BG</a></code></strong> or <strong><code><a href="pcntl.constants.html#constant.prio-darwin-thread">PRIO_DARWIN_THREAD</a></code></strong>.
      </p>


function_name: pcntl_rfork
name: flags
type: int
description:
<p class="para">
       The <code class="parameter">flags</code> parameter determines which resources of the invoking process (parent)
       are shared by the new process (child) or initialized to their default values.
      </p>
      <p class="para">
       <code class="parameter">flags</code> is the logical OR of some subset of:
       <ul class="simplelist">
        <li>
         <strong><code>RFPROC</code></strong>: If set a new process is created;
         otherwise changes affect the current process.
        </li>
        <li>
         <strong><code>RFNOWAIT</code></strong>: If set, the child process will be dissociated from the parent.
         Upon exit the child will not leave a status for the parent to collect.
        </li>
        <li>
         <strong><code>RFFDG</code></strong>: If set, the invoker's file descriptor table is copied;
         otherwise the two processes share a single table.
        </li>
        <li>
         <strong><code>RFCFDG</code></strong>: If set, the new process starts with a clean file descriptor table.
         Is mutually exclusive with <strong><code>RFFDG</code></strong>.
        </li>
        <li>
         <strong><code>RFLINUXTHPN</code></strong>: If set, the kernel will return SIGUSR1 instead of SIGCHILD upon thread exit for the child.
         This is intended to do Linux clone exit parent notification.
        </li>
       </ul>
      </p>


function_name: pcntl_setpriority
name: priority
type: int
description:
<p class="para">
       <code class="parameter">priority</code> is generally a value in the range
       <code class="literal">-20</code> to <code class="literal">20</code>. The default priority
       is <code class="literal">0</code> while a lower numerical value causes more
       favorable scheduling.  Because priority levels can differ between
       system types and kernel versions, please see your system&#039;s setpriority(2)
       man page for specific details.
      </p>


function_name: pcntl_signal
name: handler
type: int
description:
<p class="para">
       The signal handler. This may be either a <span class="type">callable</span>, which
       will be invoked to handle the signal, or either of the two global
       constants <strong><code><a href="pcntl.constants.html#constant.sig-ign">SIG_IGN</a></code></strong> or <strong><code><a href="pcntl.constants.html#constant.sig-dfl">SIG_DFL</a></code></strong>,
       which will ignore the signal or restore the default signal handler
       respectively. 
      </p>
      <p class="para">
       If a <span class="type">callable</span> is given, it must implement the following
       signature:
      </p>
      <p class="para">
       <div class="methodsynopsis dc-description"><span class="type">void</span> <span class="methodname"><span class="replaceable">handler</span></span>(<span class="methodparam"><span class="type">int</span> <code class="parameter">$signo</code></span>, <span class="methodparam"><span class="type">mixed</span> <code class="parameter">$siginfo</code></span>)</div>

       <dl>
        
         <dt><code class="parameter">signal</code></dt>
         <dd>
          <span class="simpara">
           The signal being handled.
          </span>
         </dd>
        
        
         <dt><code class="parameter">siginfo</code></dt>
         <dd>
          <span class="simpara">
           If operating systems supports siginfo_t structures, this will be an array of signal information dependent on the signal.
          </span>
         </dd>
        
       </dl>
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        Note that when you set a handler to an object method, that object&#039;s
        reference count is increased which makes it persist until you either
        change the handler to something else, or your script ends.
       </p>
      </p></blockquote>


function_name: pcntl_signal
name: restart_syscalls
type: bool
description:
<p class="para">
       Specifies whether system call restarting should be used when this
       signal arrives.
      </p>


function_name: pcntl_sigprocmask
name: mode
type: int
description:
<p class="para">
       Sets the behavior of <span class="function">pcntl_sigprocmask</span>. Possible
       values: 
       <ul class="simplelist">
        <li><strong><code><a href="pcntl.constants.html#constant.sig-block">SIG_BLOCK</a></code></strong>: Add the signals to the
         currently blocked signals.</li>
        <li><strong><code><a href="pcntl.constants.html#constant.sig-unblock">SIG_UNBLOCK</a></code></strong>: Remove the signals from the
         currently blocked signals.</li>
        <li><strong><code><a href="pcntl.constants.html#constant.sig-setmask">SIG_SETMASK</a></code></strong>: Replace the currently
         blocked signals by the given list of signals.</li>
       </ul>
      </p>


function_name: pcntl_sigprocmask
name: old_signals
type: array
description:
<p class="para">
       The <code class="parameter">old_signals</code> parameter is set to an array
       containing the list of the previously blocked signals.
      </p>


function_name: pcntl_sigtimedwait
name: info
type: array
initializer: []
description:
<p class="para">
       The <code class="parameter">info</code> is set to an array containing
       information about the signal. See
       <span class="function">pcntl_sigwaitinfo</span>.
      </p>


function_name: pcntl_sigwaitinfo
name: info
type: array
initializer: []
description:
<p class="para">
       The <code class="parameter">info</code> parameter is set to an array containing
       information about the signal.
      </p>
      <p class="para">
       The following elements are set for all signals:
       <ul class="simplelist">
        <li>signo: Signal number</li>
        <li>errno: An error number</li>
        <li>code: Signal code</li>
       </ul>
      </p>
      <p class="para">
       The following elements may be set for the <strong><code><a href="pcntl.constants.html#constant.sigchld">SIGCHLD</a></code></strong> signal:
       <ul class="simplelist">
        <li>status: Exit value or signal</li>
        <li>utime: User time consumed</li>
        <li>stime: System time consumed</li>
        <li>pid: Sending process ID</li>
        <li>uid: Real user ID of sending process</li>
       </ul>
      </p>
      <p class="para">
       The following elements may be set for the <strong><code><a href="pcntl.constants.html#constant.sigill">SIGILL</a></code></strong>,
       <strong><code><a href="pcntl.constants.html#constant.sigfpe">SIGFPE</a></code></strong>, <strong><code><a href="pcntl.constants.html#constant.sigsegv">SIGSEGV</a></code></strong> and
       <strong><code><a href="pcntl.constants.html#constant.sigbus">SIGBUS</a></code></strong> signals:
       <ul class="simplelist">
        <li>addr: Memory location which caused fault</li>
       </ul>
      </p>
      <p class="para">
       The following element may be set for the <strong><code><a href="pcntl.constants.html#constant.sigpoll">SIGPOLL</a></code></strong>
       signal:
       <ul class="simplelist">
        <li>band: Band event</li>
        <li>fd: File descriptor number</li>
       </ul>
      </p>


function_name: pcntl_unshare
name: flags
type: int
description:
<p class="para">
       The <code class="parameter">flags</code> parameter is a bitmask that specifies which parts of the execution context should be unshared.
       This parameter is specified by ORing together zero or more of the <code class="literal">CLONE_*</code> constants:
       <ul class="simplelist">
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newns">CLONE_NEWNS</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newipc">CLONE_NEWIPC</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newuts">CLONE_NEWUTS</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newnet">CLONE_NEWNET</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newpid">CLONE_NEWPID</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newuser">CLONE_NEWUSER</a></code></strong></li>
        <li><strong><code><a href="pcntl.constants.html#constant.clone-newcgroup">CLONE_NEWCGROUP</a></code></strong></li>
       </ul>
      </p>


function_name: pcntl_wait
name: status
type: int
description:
<p class="para">
       <span class="function">pcntl_wait</span> will store status information
       in the <code class="parameter">status</code> parameter which can be
       evaluated using the following functions:
       <span class="function">pcntl_wifexited</span>,
       <span class="function">pcntl_wifstopped</span>,
       <span class="function">pcntl_wifsignaled</span>,
       <span class="function">pcntl_wexitstatus</span>,
       <span class="function">pcntl_wtermsig</span> and
       <span class="function">pcntl_wstopsig</span>.
      </p>


function_name: pcntl_wait
name: flags
type: int
description:
<p class="para">
       If wait3 is available on your system (mostly BSD-style systems), you can
       provide the optional <code class="parameter">flags</code> parameter.  If this
       parameter is not provided, wait will be used for the system call.  If
       wait3 is not available, providing a value for <code class="parameter">flags</code>
       will have no effect. The value of <code class="parameter">flags</code>
       is the value of zero or more of the following two constants
       <code class="literal">OR</code>&#039;ed together:
       <table class="doctable table">
        <caption><strong>Possible values for <code class="parameter">flags</code></strong></caption>
        
         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="pcntl.constants.html#constant.wnohang">WNOHANG</a></code></strong></td>
           <td>
            Return immediately if no child has exited.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="pcntl.constants.html#constant.wuntraced">WUNTRACED</a></code></strong></td>
           <td>
            Return for children which are stopped, and whose status has
            not been reported.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: pcntl_waitpid
name: process_id
type: int
description:
<p class="para">
       The value of <code class="parameter">process_id</code> can be one of the following:
       <table class="doctable table">
        <caption><strong>possible values for <code class="parameter">process_id</code></strong></caption>
        
         <tbody class="tbody">
          <tr>
           <td><code class="literal">&lt; -1</code></td>
           <td>
            wait for any child process whose process group ID is equal to
            the absolute value of <code class="parameter">process_id</code>.
           </td>
          </tr>

          <tr>
           <td><code class="literal">-1</code></td>
           <td>
            wait for any child process; this is the same behaviour that
            the wait function exhibits.
           </td>
          </tr>

          <tr>
           <td><code class="literal">0</code></td>
           <td>
            wait for any child process whose process group ID is equal to
            that of the calling process.
           </td>
          </tr>

          <tr>
           <td><code class="literal">&gt; 0</code></td>
           <td>
            wait for the child whose process ID is equal to the value of
            <code class="parameter">process_id</code>.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        Specifying <code class="literal">-1</code> as the <code class="parameter">process_id</code> is
        equivalent to the functionality <span class="function">pcntl_wait</span> provides
        (minus <code class="parameter">flags</code>).
       </p>
      </p></blockquote>


function_name: pcntl_waitpid
name: status
type: int
description:
<p class="para">
       <span class="function">pcntl_waitpid</span> will store status information
       in the <code class="parameter">status</code> parameter which can be
       evaluated using the following functions:
       <span class="function">pcntl_wifexited</span>,
       <span class="function">pcntl_wifstopped</span>,
       <span class="function">pcntl_wifsignaled</span>,
       <span class="function">pcntl_wexitstatus</span>,
       <span class="function">pcntl_wtermsig</span> and
       <span class="function">pcntl_wstopsig</span>.
      </p>


function_name: pcntl_waitpid
name: flags
type: int
description:
<p class="para">
       The value of <code class="parameter">flags</code> is the value of zero
       or more of the following two global constants
       <code class="literal">OR</code>&#039;ed together:
       <table class="doctable table">
        <caption><strong>possible values for <code class="parameter">flags</code></strong></caption>
        
         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="pcntl.constants.html#constant.wnohang">WNOHANG</a></code></strong></td>
           <td>
            return immediately if no child has exited.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="pcntl.constants.html#constant.wuntraced">WUNTRACED</a></code></strong></td>
           <td>
            return for children which are stopped, and whose status has
            not been reported.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: pcntl_wexitstatus
name: status
type: int
description:
<p class="para">The <code class="parameter">status</code>
parameter is the status parameter supplied to a successful
call to <span class="function">pcntl_waitpid</span>.</p>


function_name: posix_access
name: flags
type: int
description:
<p class="para">
        A mask consisting of one or more of <strong><code><a href="posix.constants.access.html#constant.posix-f-ok">POSIX_F_OK</a></code></strong>,
        <strong><code><a href="posix.constants.access.html#constant.posix-r-ok">POSIX_R_OK</a></code></strong>, <strong><code><a href="posix.constants.access.html#constant.posix-w-ok">POSIX_W_OK</a></code></strong> and
        <strong><code><a href="posix.constants.access.html#constant.posix-x-ok">POSIX_X_OK</a></code></strong>.
       </p>
       <p class="para">
        <strong><code><a href="posix.constants.access.html#constant.posix-r-ok">POSIX_R_OK</a></code></strong>, <strong><code><a href="posix.constants.access.html#constant.posix-w-ok">POSIX_W_OK</a></code></strong> and
        <strong><code><a href="posix.constants.access.html#constant.posix-x-ok">POSIX_X_OK</a></code></strong> request checking whether the file
        exists and has read, write and execute permissions, respectively.
        <strong><code><a href="posix.constants.access.html#constant.posix-f-ok">POSIX_F_OK</a></code></strong> just requests checking for the
        existence of the file.
       </p>


function_name: posix_fpathconf
name: file_descriptor
type: int
description:
<p class="para">
   The file descriptor, which is expected to be either a file
   <span class="type">resource</span> or an <span class="type">int</span>. An <span class="type">int</span>
   will be assumed to be a file descriptor that can be passed directly to
   the underlying system call.
  </p>


function_name: posix_fpathconf
name: name
type: int
description:
<p class="para">
       The name of the configurable limit, one of the following.
       <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-link-max">POSIX_PC_LINK_MAX</a></code></strong>, <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-max-canon">POSIX_PC_MAX_CANON</a></code></strong>,
       <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-max-input">POSIX_PC_MAX_INPUT</a></code></strong>, <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-name-max">POSIX_PC_NAME_MAX</a></code></strong>,
       <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-path-max">POSIX_PC_PATH_MAX</a></code></strong>, <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-pipe-buf">POSIX_PC_PIPE_BUF</a></code></strong>,
       <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-chown-restricted">POSIX_PC_CHOWN_RESTRICTED</a></code></strong>, <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-no-trunc">POSIX_PC_NO_TRUNC</a></code></strong>,
       <strong><code><a href="posix.constants.pathconf.html#constant.posix-pc-alloc-size-min">POSIX_PC_ALLOC_SIZE_MIN</a></code></strong>, <strong><code>POSIX_PC_SYMLINK_MAX</code></strong>.
      </p>


function_name: posix_getrlimit
name: resource
type: null
description:
<p class="para">
       If <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> all resource limits will be fetched.
       Otherwise, the only limits of the resource type provided will be returned.
      </p>


function_name: posix_getsid
name: process_id
type: int
description:
<p class="para">
       The process identifier. If set to 0, the current process is
       assumed.  If an invalid <code class="parameter">process_id</code> is
       specified, then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned and an error is set which
       can be checked with <span class="function">posix_get_last_error</span>.
      </p>


function_name: posix_kill
name: signal
type: int
description:
<p class="para">
       One of the <a href="pcntl.constants.html" class="link">PCNTL signals constants</a>.
      </p>


function_name: posix_mkfifo
name: permissions
type: int
description:
<p class="para">
       The second parameter <code class="parameter">permissions</code> has to be given in
       octal notation (e.g. 0644). The permission of the newly created
       <code class="literal">FIFO</code> also depends on the setting of the current
       <span class="function">umask</span>. The permissions of the created file are
       (mode &amp; ~umask).
      </p>


function_name: posix_mknod
name: flags
type: int
description:
<p class="para">
       This parameter is constructed by a bitwise OR between file type (one of
       the following constants: <strong><code><a href="posix.constants.mknod.html#constant.posix-s-ifreg">POSIX_S_IFREG</a></code></strong>,
       <strong><code><a href="posix.constants.mknod.html#constant.posix-s-ifchr">POSIX_S_IFCHR</a></code></strong>, <strong><code><a href="posix.constants.mknod.html#constant.posix-s-ifblk">POSIX_S_IFBLK</a></code></strong>,
       <strong><code><a href="posix.constants.mknod.html#constant.posix-s-ififo">POSIX_S_IFIFO</a></code></strong> or
       <strong><code><a href="posix.constants.mknod.html#constant.posix-s-ifsock">POSIX_S_IFSOCK</a></code></strong>) and permissions.
      </p>


function_name: posix_mknod
name: major
type: int
description:
<p class="para">
       The major device kernel identifier (required to pass when using
       <strong><code>S_IFCHR</code></strong> or <strong><code>S_IFBLK</code></strong>).
      </p>


function_name: posix_setrlimit
name: resource
type: int
description:
<p class="para">
       The
       <a href="posix.constants.setrlimit.html" class="link">resource limit constant</a>
       corresponding to the limit that is being set.
      </p>


function_name: posix_setrlimit
name: soft_limit
type: int
description:
<p class="para">
       The soft limit, in whatever unit the resource limit requires, or
       <strong><code><a href="posix.constants.setrlimit.html#constant.posix-rlimit-infinity">POSIX_RLIMIT_INFINITY</a></code></strong>.
      </p>


function_name: posix_setrlimit
name: hard_limit
type: int
description:
<p class="para">
       The hard limit, in whatever unit the resource limit requires, or
       <strong><code><a href="posix.constants.setrlimit.html#constant.posix-rlimit-infinity">POSIX_RLIMIT_INFINITY</a></code></strong>.
      </p>


function_name: posix_strerror
name: error_code
type: int
description:
<p class="para">
       A POSIX error number, returned by 
       <span class="function">posix_get_last_error</span>. If set to 0, then the
       string &quot;Success&quot; is returned.
      </p>


function_name: posix_sysconf
name: conf_id
type: int
description:
<p class="para">
       Identifier of the variable with the following constants
       <strong><code><a href="posix.constants.sysconf.html#constant.posix-sc-arg-max">POSIX_SC_ARG_MAX</a></code></strong>, <strong><code><a href="posix.constants.sysconf.html#constant.posix-sc-pagesize">POSIX_SC_PAGESIZE</a></code></strong>
       <strong><code><a href="posix.constants.sysconf.html#constant.posix-sc-nprocessors-conf">POSIX_SC_NPROCESSORS_CONF</a></code></strong>, <strong><code><a href="posix.constants.sysconf.html#constant.posix-sc-nprocessors-onln">POSIX_SC_NPROCESSORS_ONLN</a></code></strong>
      </p>


function_name: exec
name: output
type: array
description:
<p class="para">
       If the <code class="parameter">output</code> argument is present, then the
       specified array will be filled with every line of output from the
       command.  Trailing whitespace, such as <code class="literal">\n</code>, is not
       included in this array.  Note that if the array already contains some
       elements, <span class="function">exec</span> will append to the end of the array.
       If you do not want the function to append elements, call
       <span class="function">unset</span> on the array before passing it to
       <span class="function">exec</span>.
      </p>


function_name: exec
name: result_code
type: int
description:
<p class="para">
       If the <code class="parameter">result_code</code> argument is present
       along with the <code class="parameter">output</code> argument, then the
       return status of the executed command will be written to this
       variable.
      </p>


function_name: passthru
name: result_code
type: int
description:
<p class="para">
       If the <code class="parameter">result_code</code> argument is present, the 
       return status of the Unix command will be placed here.
      </p>


function_name: proc_close
name: process
type: resource
description:
<p class="para">
       The <span class="function">proc_open</span> <span class="type">resource</span> that will
       be closed.
      </p>


function_name: proc_get_status
name: process
type: resource
description:
<p class="para">
       The <span class="function">proc_open</span> <span class="type">resource</span> that will
       be evaluated.
      </p>


function_name: proc_nice
name: priority
type: int
description:
<p class="para">
       The new priority value, the value of this may differ on platforms.
      </p>
      <p class="para">
       On Unix, a low value, such as <code class="literal">-20</code> means high priority 
       whereas positive values have a lower priority.
      </p>
      <p class="para">
       For Windows the <code class="parameter">priority</code> parameter has the 
       following meaning:
      </p>
      <table class="doctable informaltable">
       
        <thead>
         <tr>
          <th>Priority class</th>
          <th>Possible values</th>
         </tr>

        </thead>

        <tbody class="tbody">
         <tr>
          <td style="vertical-align: top;">High priority</td>
          <td style="vertical-align: top;">
           <code class="parameter">priority</code> <code class="literal">&lt; -9</code>
          </td>
         </tr>

         <tr>
          <td style="vertical-align: top;">Above normal priority</td>
          <td style="vertical-align: top;">
           <code class="parameter">priority</code> <code class="literal">&lt; -4</code>
          </td>
         </tr>

         <tr>
          <td style="vertical-align: top;">Normal priority</td>
          <td style="vertical-align: top;">
           <code class="parameter">priority</code> <code class="literal">&lt; 5</code> &amp; 
           <code class="parameter">priority</code> <code class="literal">&gt; -5</code>
          </td>
         </tr>

         <tr>
          <td style="vertical-align: top;">Below normal priority</td>
          <td style="vertical-align: top;">
           <code class="parameter">priority</code> <code class="literal">&gt; 5</code>
          </td>
         </tr>

         <tr>
          <td style="vertical-align: top;">Idle priority</td>
          <td style="vertical-align: top;">
           <code class="parameter">priority</code> <code class="literal">&gt; 9</code>
          </td>
         </tr>

        </tbody>
       
      </table>


function_name: proc_open
name: command
type: string
description:
<p class="para">
       The commandline to execute as <span class="type">string</span>. Special characters have to be properly escaped,
       and proper quoting has to be applied.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <span class="simpara">
        On <em>Windows</em>, unless <code class="literal">bypass_shell</code> is set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> in
        <code class="parameter">options</code>, the <code class="parameter">command</code> is
        passed to <strong class="command">cmd.exe</strong> (actually, <code class="literal">%ComSpec%</code>)
        with the <code class="literal">/c</code> flag as <em>unquoted</em> string
        (i.e. exactly as has been given to <span class="function">proc_open</span>).
        This can cause <strong class="command">cmd.exe</strong> to remove enclosing quotes from
        <code class="parameter">command</code> (for details see the <strong class="command">cmd.exe</strong> documentation),
        resulting in unexpected, and potentially even dangerous behavior, because
        <strong class="command">cmd.exe</strong> error messages may contain (parts of) the passed
        <code class="parameter">command</code> (see example below).
       </span>
      </p></blockquote>
      <p class="para">
       As of PHP 7.4.0, <code class="parameter">command</code> may be passed as <span class="type">array</span> of command parameters.
       In this case the process will be opened directly (without going through a shell)
       and PHP will take care of any necessary argument escaping.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        On Windows, the argument escaping of the <span class="type">array</span> elements assumes that the
        command line parsing of the executed command is compatible with the parsing
        of command line arguments done by the VC runtime.
       </p>
      </p></blockquote>


function_name: proc_open
name: descriptor_spec
type: array
description:
<p class="para">
       An indexed array where the key represents the descriptor number and the
       value represents how PHP will pass that descriptor to the child
       process. 0 is stdin, 1 is stdout, while 2 is stderr.
      </p>
      <p class="para">
       Each element can be:
       <ul class="simplelist">
        <li>An array describing the pipe to pass to the process. The first
         element is the descriptor type and the second element is an option for
         the given type. Valid types are <code class="literal">pipe</code> (the second
         element is either <code class="literal">r</code> to pass the read end of the pipe
         to the process, or <code class="literal">w</code> to pass the write end) and
         <code class="literal">file</code> (the second element is a filename).
         Note that anything else than <code class="literal">w</code> is treated like <code class="literal">r</code>.
        </li>
        <li>
         A stream resource representing a real file descriptor (e.g. opened file,
         a socket, <strong><code><a href="reserved.constants.html#constant.stdin">STDIN</a></code></strong>).
        </li>
       </ul>
      </p>
      <p class="para">
       The file descriptor numbers are not limited to 0, 1 and 2 - you may
       specify any valid file descriptor number and it will be passed to the
       child process. This allows your script to interoperate with other
       scripts that run as &quot;co-processes&quot;. In particular, this is useful for
       passing passphrases to programs like PGP, GPG and openssl in a more
       secure manner. It is also useful for reading status information
       provided by those programs on auxiliary file descriptors.
      </p>


function_name: proc_open
name: pipes
type: array
description:
<p class="para">
       Will be set to an indexed array of file pointers that correspond to
       PHP&#039;s end of any pipes that are created.
      </p>


function_name: proc_open
name: cwd
type: null
description:
<p class="para">
       The initial working dir for the command. This must be an
       <strong>absolute</strong> directory path, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
       if you want to use the default value (the working dir of the current
       PHP process)
      </p>


function_name: proc_open
name: env_vars
type: null
description:
<p class="para">
       An array with the environment variables for the command that will be
       run, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> to use the same environment as the current PHP process
      </p>


function_name: proc_open
name: options
type: null
description:
<p class="para">
       Allows you to specify additional options. Currently supported options
       include:
       <ul class="simplelist">
        <li>
         <code class="literal">suppress_errors</code> (windows only): suppresses errors
         generated by this function when it's set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        </li>
        <li>
         <code class="literal">bypass_shell</code> (windows only): bypass
         <code class="literal">cmd.exe</code> shell when set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        </li>
        <li>
         <code class="literal">blocking_pipes</code> (windows only): force
         blocking pipes when set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        </li>
        <li>
         <code class="literal">create_process_group</code> (windows only): allow the
         child process to handle <code class="literal">CTRL</code> events when set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
        </li>
        <li>
         <code class="literal">create_new_console</code> (windows only): the new process
         has a new console, instead of inheriting its parent's console
        </li>
       </ul>
      </p>


function_name: proc_terminate
name: signal
type: int
initializer: 15
description:
<p class="para">
       This optional parameter is only useful on <acronym class="acronym">POSIX</acronym>
       operating systems; you may specify a signal to send to the process
       using the <code class="literal">kill(2)</code> system call.  The default is
       <code class="literal">SIGTERM</code>.
      </p>


function_name: system
name: result_code
type: int
description:
<p class="para">
       If the <code class="parameter">result_code</code> argument is present, then the
       return status of the executed command will be written to this
       variable.
      </p>


function_name: parallel\run
name: task
type: Closure
description:
<p class="para">
      A <span class="classname">Closure</span> with specific characteristics.
     </p>


function_name: parallel\run
name: argv
type: array
description:
<p class="para">
      An <span class="type">array</span> of arguments with specific characteristics to be passed to <code class="parameter">task</code> at execution time.
     </p>


function_name: parallel\Channel.__construct
name: capacity
type: int
description:
<p class="para">
      May be <span class="type">Channel::Infinite</span> or a positive integer
     </p>


function_name: Threaded.synchronized
name: args
type: mixed
description:
<p class="para">
  Variable length list of arguments to use as function arguments to the block
     </p>


function_name: Thread.start
name: options
type: int
description:
<p class="para">
  An optional mask of inheritance constants, by default PTHREADS_INHERIT_ALL
     </p>


function_name: Worker.collect
name: collector
type: Callable
description:
<p class="para">
      A Callable collector that returns a boolean on whether the task can be
      collected or not. Only in rare cases should a custom collector need to
      be used.
     </p>


function_name: Worker.stack
name: work
type: Threaded
description:
<p class="para">
      A <span class="classname">Threaded</span> object to be executed by the worker.
     </p>


function_name: Pool.__construct
name: class
type: string
description:
<p class="para">
      The class for new Workers. If no class is given, then it defaults to the
      <span class="classname">Worker</span> class.
     </p>


function_name: Pool.__construct
name: ctor
type: array
description:
<p class="para">
      An array of arguments to be passed to new workers&#039; constructors
     </p>


function_name: Pool.submitTo
name: worker
type: int
description:
<p class="para">
      The worker to stack the task onto, indexed from <code class="literal">0</code>.
     </p>


function_name: msg_get_queue
name: permissions
type: int
initializer: 0666
description:
<p class="para">
       Queue permissions. Default to 0666. If the message queue already
       exists, the <code class="parameter">permissions</code> will be ignored.
      </p>


function_name: msg_receive
name: desired_message_type
type: int
description:
<p class="para">
       If <code class="parameter">desired_message_type</code> is 0, the message from the front
       of the queue is returned. If <code class="parameter">desired_message_type</code> is
       greater than 0, then the first message of that type is returned.
       If <code class="parameter">desired_message_type</code> is less than 0, the first
       message on the queue with a type less than or equal to the
       absolute value of <code class="parameter">desired_message_type</code> will be read.
       If no messages match the criteria, your script will wait until a suitable
       message arrives on the queue.  You can prevent the script from blocking
       by specifying <strong><code><a href="sem.constants.html#constant.msg-ipc-nowait">MSG_IPC_NOWAIT</a></code></strong> in the
       <code class="parameter">flags</code> parameter.
      </p>


function_name: msg_receive
name: received_message_type
type: int
description:
<p class="para">
       The type of the message that was received will be stored in this
       parameter.
      </p>


function_name: msg_receive
name: max_message_size
type: int
description:
<p class="para">
       The maximum size of message to be accepted is specified by the
       <code class="parameter">max_message_size</code>; if the message in the queue is larger
       than this size the function will fail (unless you set
       <code class="parameter">flags</code> as described below).
      </p>


function_name: msg_receive
name: message
type: mixed
description:
<p class="para">
       The received message will be stored in <code class="parameter">message</code>,
       unless there were errors receiving the message.
      </p>


function_name: msg_receive
name: unserialize
type: bool
description:
<p class="para">
       If set to
       <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, the message is treated as though it was serialized using the
       same mechanism as the session module. The message will be unserialized
       and then returned to your script. This allows you to easily receive
       arrays or complex object structures from other PHP scripts, or if you
       are using the WDDX serializer, from any WDDX compatible source.
      </p>
      <p class="para">
       If <code class="parameter">unserialize</code> is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, the message will be
       returned as a binary-safe string.
      </p>


function_name: msg_receive
name: flags
type: int
description:
<p class="para">
       The optional <code class="parameter">flags</code> allows you to pass flags to the
       low-level msgrcv system call.  It defaults to 0, but you may specify one
       or more of the following values (by adding or ORing them together).
       <table class="doctable table">
        <caption><strong>Flag values for msg_receive</strong></caption>
        
         <tbody class="tbody">
          <tr>
           <td><strong><code><a href="sem.constants.html#constant.msg-ipc-nowait">MSG_IPC_NOWAIT</a></code></strong></td>
           <td>If there are no messages of the
            <code class="parameter">desired_message_type</code>, return immediately and do not
            wait.  The function will fail and return an integer value
            corresponding to <strong><code><a href="sem.constants.html#constant.msg-enomsg">MSG_ENOMSG</a></code></strong>.
           </td>
          </tr>

          <tr>
           <td><strong><code><a href="sem.constants.html#constant.msg-except">MSG_EXCEPT</a></code></strong></td>
           <td>Using this flag in combination with a
            <code class="parameter">desired_message_type</code> greater than 0 will cause the
            function to receive the first message that is not equal to
            <code class="parameter">desired_message_type</code>.</td>
          </tr>

          <tr>
           <td><strong><code><a href="sem.constants.html#constant.msg-noerror">MSG_NOERROR</a></code></strong></td>
           <td>
            If the message is longer than <code class="parameter">max_message_size</code>,
            setting this flag will truncate the message to
            <code class="parameter">max_message_size</code> and will not signal an error.
           </td>
          </tr>

         </tbody>
        
       </table>

      </p>


function_name: msg_receive
name: error_code
type: int
description:
<p class="para">
       If the function fails, the optional <code class="parameter">error_code</code>
       will be set to the value of the system errno variable.
      </p>


function_name: msg_send
name: message
type: bool
description:
<p class="para">
       The body of the message.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        If <code class="parameter">serialize</code> set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is supplied,
        MUST be of type: <span class="type">string</span>, <span class="type">int</span>, <span class="type">float</span> 
        or <span class="type">bool</span>. In other case a warning will be issued.
       </p>
      </p></blockquote>


function_name: msg_send
name: serialize
type: bool
description:
<p class="para">
       The optional <code class="parameter">serialize</code> controls how the
       <code class="parameter">message</code> is sent.  <code class="parameter">serialize</code>
       defaults to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> which means that the <code class="parameter">message</code> is
       serialized using the same mechanism as the session module before being
       sent to the queue.  This allows complex arrays and objects to be sent to
       other PHP scripts, or if you are using the WDDX serializer, to any WDDX
       compatible client.
      </p>


function_name: msg_send
name: blocking
type: bool
description:
<p class="para">
       If the message is too large to fit in the queue, your script will wait
       until another process reads messages from the queue and frees enough
       space for your message to be sent.
       This is called blocking; you can prevent blocking by setting the
       optional <code class="parameter">blocking</code> parameter to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, in which
       case <span class="function">msg_send</span> will immediately return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
       message is too big for the queue, and set the optional
       <code class="parameter">error_code</code> to <strong><code><a href="sem.constants.html#constant.msg-eagain">MSG_EAGAIN</a></code></strong>,
       indicating that you should try to send your message again a little
       later on.
      </p>


function_name: msg_send
name: error_code
type: int
description:
<p class="para">
       If the function fails, the optional errorcode will be set to the value of the system errno variable.
      </p>


function_name: msg_set_queue
name: data
type: array
description:
<p class="para">
       You specify the values you require by setting the value of the keys
       that you require in the <code class="parameter">data</code> array.
      </p>


function_name: sem_acquire
name: semaphore
type: SysvSemaphore
description:
<p class="para">
       <code class="parameter">semaphore</code> is a semaphore
       obtained from <span class="function">sem_get</span>.
      </p>


function_name: sem_acquire
name: non_blocking
type: bool
description:
<p class="para">
       Specifies if the process shouldn&#039;t wait for the semaphore to be acquired.
       If set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, the call will return
       <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> immediately if a semaphore cannot be immediately
       acquired.
      </p>


function_name: sem_get
name: max_acquire
type: int
initializer: 1
description:
<p class="para">
       The number of processes that can acquire the semaphore simultaneously
       is set to <code class="parameter">max_acquire</code>.
      </p>


function_name: sem_get
name: permissions
type: int
initializer: 0666
description:
<p class="para">
       The semaphore permissions. Actually this value is
       set only if the process finds it is the only process currently
       attached to the semaphore.
      </p>


function_name: sem_get
name: auto_release
type: bool
description:
<p class="para">
       Specifies if the semaphore should be automatically released on request
       shutdown.
      </p>


function_name: sem_release
name: semaphore
type: SysvSemaphore
description:
<p class="para">
       A Semaphore as returned by
       <span class="function">sem_get</span>.
      </p>


function_name: sem_remove
name: semaphore
type: SysvSemaphore
description:
<p class="para">
       A semaphore as returned
       by <span class="function">sem_get</span>.
      </p>


function_name: shm_attach
name: size
type: null
description:
<p class="para">
       The memory size. If not provided, default to the
       <code class="literal">sysvshm.init_mem</code> in the <var class="filename">php.ini</var>, otherwise 10000
       bytes.
      </p>


function_name: shm_detach
name: shm
type: SysvSharedMemory
description:
<p class="para">
       A shared memory segment obtained from <span class="function">shm_attach</span>.
      </p>


function_name: shm_put_var
name: value
type: mixed
description:
<p class="para">
       The variable. All <a href="language.types.html" class="link">variable types</a>
       that <span class="function">serialize</span> supports may be used: generally
       this means all types except for resources and some internal objects
       that cannot be serialized.
      </p>


function_name: shmop_close
name: shmop
type: Shmop
description:
<p class="para">
       The shared memory block resource created by 
       <span class="function">shmop_open</span>
      </p>


function_name: shmop_open
name: key
type: int
description:
<p class="para">
       System&#039;s id for the shared memory block.
       Can be passed as a decimal or hex.
      </p>


function_name: shmop_open
name: mode
type: string
description:
<p class="simpara">
          &quot;n&quot; create a new memory segment (sets IPC_CREATE|IPC_EXCL)
          use this flag when you want to create a new shared memory segment
          but if one already exists with the same flag, fail. This is useful
          for security purposes, using this you can prevent race condition
          exploits.
         </p>


function_name: shmop_open
name: permissions
type: int
description:
<p class="para">
       The permissions that you wish to assign to your memory segment, those
       are the same as permission for a file. Permissions need to be passed
       in octal form, like for example <code class="literal">0644</code>
      </p>


function_name: shmop_read
name: shmop
type: Shmop
description:
<p class="para">
       The shared memory block identifier created by 
       <span class="function">shmop_open</span>
      </p>


function_name: shmop_read
name: offset
type: int
description:
<p class="para">
       Offset from which to start reading; must be greater than or equal to zero
       and less than or equal to the actual size of the shared memory segment.
      </p>


function_name: shmop_read
name: size
type: int
description:
<p class="para">
       The number of bytes to read; must be greater than or equal to zero,
       and the sum of <code class="parameter">offset</code> and <code class="parameter">size </code>
       must be less than or equal to the actual size of the shared memory segment.
       <code class="literal">0</code> reads <code class="code">shmop_size($shmid) - $start</code> bytes.
      </p>


function_name: shmop_write
name: offset
type: int
description:
<p class="para">
       Specifies where to start writing data inside the shared memory
       segment. The offset must be greater than or equal to zero
       and less than or equal to the actual size of the shared memory segment.
      </p>


function_name: SyncMutex.__construct
name: name
type: string
description:
<p class="para">
      The name of the mutex if this is a named mutex object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>


function_name: SyncMutex.lock
name: wait
type: int
initializer: -1
description:
<p class="para">
      The number of milliseconds to wait for the exclusive lock.
      A value of -1 is infinite.
     </p>


function_name: SyncMutex.unlock
name: all
type: bool
description:
<p class="para">
      Specifies whether or not to set the internal counter to zero and therefore release the lock.
     </p>


function_name: SyncSemaphore.__construct
name: name
type: string
description:
<p class="para">
      The name of the semaphore if this is a named semaphore object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>


function_name: SyncSemaphore.__construct
name: initialval
type: int
initializer: 1
description:
<p class="para">
      The initial value of the semaphore. This is the number of locks that may be obtained.
     </p>


function_name: SyncSemaphore.__construct
name: autounlock
type: bool
description:
<p class="para">
      Specifies whether or not to automatically unlock the semaphore at the
      conclusion of the PHP script.
     </p>
     <div class="warning"><strong class="warning">Warning</strong>
      <p class="para">
       If an object is: A named semaphore with an autounlock of <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, the object is
       locked, and the PHP script concludes before the object is unlocked, then the
       underlying semaphore will end up in an inconsistent state.
      </p>
     </div>


function_name: SyncSemaphore.lock
name: wait
type: int
initializer: -1
description:
<p class="para">
      The number of milliseconds to wait for the semaphore.
      A value of -1 is infinite.
     </p>


function_name: SyncEvent.__construct
name: name
type: string
description:
<p class="para">
      The name of the event if this is a named event object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>


function_name: SyncEvent.__construct
name: manual
type: bool
description:
<p class="para">
      Specifies whether or not the event object must be reset manually.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       Manual reset event objects allow all waiting processes through until the
       object is reset.
      </p>
     </p></blockquote>


function_name: SyncEvent.__construct
name: prefire
type: bool
description:
<p class="para">
      Specifies whether or not to prefire (signal) the event object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       Only has impact if the calling process/thread is the first to create the object.
      </p>
     </p></blockquote>


function_name: SyncEvent.wait
name: wait
type: int
initializer: -1
description:
<p class="para">
      The number of milliseconds to wait for the event to be fired.
      A value of -1 is infinite.
     </p>


function_name: SyncReaderWriter.__construct
name: name
type: string
description:
<p class="para">
      The name of the reader-writer if this is a named reader-writer object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <span class="simpara">
       On Windows, <code class="parameter">name</code> must not contain backslashes.
      </span>
     </p></blockquote>


function_name: SyncReaderWriter.__construct
name: autounlock
type: int
initializer: 1
description:
<p class="para">
      Specifies whether or not to automatically unlock the reader-writer at the
      conclusion of the PHP script.
     </p>
     <div class="warning"><strong class="warning">Warning</strong>
      <p class="para">
       If an object is:  A named reader-writer with an autounlock of FALSE, the
       object is locked for either reading or writing, and the PHP script concludes
       before the object is unlocked, then the underlying objects will end up in an
       inconsistent state.
      </p>
     </div>


function_name: SyncReaderWriter.readlock
name: wait
type: int
initializer: -1
description:
<p class="para">
      The number of milliseconds to wait for a lock.
      A value of -1 is infinite.
     </p>


function_name: SyncSharedMemory.__construct
name: name
type: string
description:
<p class="para">
      The name of the shared memory object.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the name already exists, it must be able to be opened by the current user
       that the process is running as or an exception will be thrown with a meaningless
       error message.
      </p>
     </p></blockquote>


function_name: SyncSharedMemory.__construct
name: size
type: int
description:
<p class="para">
      The size, in bytes, of shared memory to reserve.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       The amount of memory cannot be resized later.  Request sufficient storage up front.
      </p>
     </p></blockquote>


function_name: SyncSharedMemory.read
name: start
type: int
description:
<p class="para">
 The start/offset, in bytes, to begin reading.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
 If the value is negative, the starting position will begin at the specified
 number of bytes from the end of the shared memory segment.
      </p>
     </p></blockquote>


function_name: SyncSharedMemory.read
name: length
type: int
description:
<p class="para">
 The number of bytes to read.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
 If unspecified, reading will stop at the end of the shared memory segment.
      </p>
      <p class="para">
 If the value is negative, reading will stop the specified number of bytes
 from the end of the shared memory segment.
      </p>
     </p></blockquote>


function_name: SyncSharedMemory.write
name: string
type: string
description:
<p class="para">
      The data to write to shared memory.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the size of the data exceeds the size of the shared memory, the number of
       bytes written returned will be less than the length of the input.
      </p>
     </p></blockquote>


function_name: SyncSharedMemory.write
name: start
type: int
description:
<p class="para">
      The start/offset, in bytes, to begin writing.
     </p>
     <blockquote class="note"><p><strong class="note">Note</strong>: 
      <p class="para">
       If the value is negative, the starting position will begin at the specified
       number of bytes from the end of the shared memory segment.
      </p>
     </p></blockquote>


function_name: geoip_database_info
name: database
type: int
initializer: GEOIP_COUNTRY_EDITION
description:
<p class="para">
       The database type as an integer. You can use the
       <a href="geoip.constants.html" class="link">various constants</a> defined with
       this extension (ie: GEOIP_*_EDITION).
      </p>


function_name: geoip_id_by_name
name: hostname
type: string
description:
<p class="para">
       The hostname or IP address whose connection type is to be looked-up.
      </p>


function_name: geoip_region_name_by_code
name: country_code
type: string
description:
<p class="para">
       The two-letter country code (see
       <span class="function">geoip_country_code_by_name</span>)
      </p>


function_name: geoip_region_name_by_code
name: region_code
type: string
description:
<p class="para">
       The two-letter (or digit) region code (see 
       <span class="function">geoip_region_by_name</span>)
      </p>


function_name: fann_cascadetrain_on_data
name: neurons_between_reports
type: int
description:
<p class="para">
      The number of neurons between printing a status report. A value of zero means no reports should be printed.
     </p>


function_name: fann_cascadetrain_on_data
name: desired_error
type: float
description:
<p class="para">
      The desired <span class="function">fann_get_MSE</span> or <span class="function">fann_get_bit_fail</span>,
      depending on which stop function is chosen by <span class="function">fann_set_train_stop_function</span>
     </p>


function_name: fann_cascadetrain_on_file
name: desired_error
type: float
description:
<p class="para">
      The desired <span class="function">fann_get_MSE</span> or <span class="function">fann_get_bit_fail</span>,
      depending on which stop function is chosen by <span class="function">fann_set_train_stop_function</span>.
     </p>


function_name: fann_create_shortcut_array
name: num_layers
type: int
description:
<p class="para">
      The total number of layers including the input and the output layer.
     </p>


function_name: fann_create_sparse_array
name: connection_rate
type: float
description:
<p class="para">
      The connection rate controls how many connections there will be in the network. If the connection rate
      is set to 1, the network will be fully connected, but if it is set to 0.5 only half of the connections
      will be set. A connection rate of 1 will yield the same result as <span class="function">fann_create_standard</span>.
     </p>


function_name: fann_create_train_from_callback
name: user_function
type: callable
description:
<p class="para">
      The user supplied function with following parameters:
      <ul class="simplelist">
       <li><code class="literal">num</code> - The number of the training data set</li>
       <li><code class="literal">num_input</code> - The number of inputs per training data</li>
       <li><code class="literal">num_output</code> - The number of ouputs per training data</li>
      </ul>
     </p>
     <p class="para">
      The function should return an associative array with keys <code class="literal">input</code> and <code class="literal">output</code> and
      two array values of input and output.
     </p>


function_name: fann_get_errno
name: errdat
type: resource
description:
<p class="para">Either neural network <span class="type">resource</span> or neural network trainining data <span class="type">resource</span>.</p>


function_name: fann_read_train_from_file
name: filename
type: string
description:
<p class="para">
      The input file in the following format:
     </p>
     <div class="example-contents">
<div class="txtcode"><pre class="txtcode">num_train_data num_input num_output
inputdata separated by space
outputdata separated by space

.
.
.

inputdata separated by space
outputdata separated by space</pre>
</div>
     </div>


function_name: fann_set_activation_function_hidden
name: activation_function
type: int
description:
<p class="para">
      The <a href="fann.constants.html#constants.fann-activation-funcs" class="link">activation functions</a> constant.
     </p>


function_name: fann_set_callback
name: callback
type: callable
description:
<p class="para">
      The supplied callback function takes following parameters:
      <ul class="simplelist">
       <li><code class="literal">ann</code> - The neural network <span class="type">resource</span></li>
       <li><code class="literal">train</code> - The train data <span class="type">resource</span>
        or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if called from <span class="function">fann_train_on_file</span></li>
       <li><code class="literal">max_epochs</code> - The maximum number of epochs the training should continue</li>
       <li><code class="literal">epochs_between_reports</code> - The number of epochs between calling this function</li>
       <li><code class="literal">desired_error</code> - The desired <span class="function">fann_get_MSE</span> or
        <span class="function">fann_get_bit_fail</span>, depending on the stop function chosen by
        <span class="function">fann_set_train_stop_function</span></li>
       <li><code class="literal">epochs</code> - The current epoch</li>
      </ul>
     </p>
     <p class="para">
      The callback should return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. If it returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, the training will terminate.
     </p>


function_name: fann_set_input_scaling_params
name: new_input_min
type: float
description:
<p class="para">
      The desired lower bound in input data after scaling (not strictly followed)
     </p>


function_name: fann_set_input_scaling_params
name: new_input_max
type: float
description:
<p class="para">
      The desired upper bound in input data after scaling (not strictly followed)
     </p>


function_name: fann_set_output_scaling_params
name: new_output_min
type: float
description:
<p class="para">
      The desired lower bound in output data after scaling (not strictly followed)
     </p>


function_name: fann_set_output_scaling_params
name: new_output_max
type: float
description:
<p class="para">
      The desired upper bound in output data after scaling (not strictly followed)
     </p>


function_name: fann_set_train_error_function
name: error_function
type: int
description:
<p class="para">
      The <a href="fann.constants.html#constants.fann-errorfunc" class="link">error function</a> constant
     </p>


function_name: fann_set_train_stop_function
name: stop_function
type: int
description:
<p class="para">
      The <a href="fann.constants.html#constants.fann-stopfunc" class="link">stop function</a> constant.
     </p>


function_name: fann_set_training_algorithm
name: training_algorithm
type: int
description:
<p class="para">
      <a href="fann.constants.html#constants.fann-train" class="link">Training algorithm</a> constant
     </p>


function_name: fann_test
name: input
type: array
description:
<p class="para">
      An array of inputs. This array must be exactly <span class="function">fann_get_num_input</span> long.
     </p>


function_name: fann_test
name: desired_output
type: array
description:
<p class="para">
      An array of desired outputs. This array must be exactly <span class="function">fann_get_num_output</span> long.
     </p>


function_name: fann_train_on_data
name: epochs_between_reports
type: int
description:
<p class="para">
      The number of epochs between calling a callback function. A value of zero means that user function is not called.
     </p>


function_name: fann_train_on_data
name: desired_error
type: float
description:
<p class="para">
      The desired <span class="function">fann_get_MSE</span> or <span class="function">fann_get_bit_fail</span>, depending on the stop function
      chosen by <span class="function">fann_set_train_stop_function</span>
     </p>


function_name: fann_train_on_file
name: epochs_between_reports
type: int
description:
<p class="para">
      The number of epochs between calling a user function. A value of zero means that user function is not called.
     </p>


function_name: igbinary_serialize
name: value
type: mixed
description:
<p class="para">
       The value to be serialized. <span class="function">igbinary_serialize</span>
       handles all types, except the <span class="type">resource</span>-type and some <span class="type">object</span>s (see note below).
       Even <span class="type">array</span>s that contain references to itself can be processed by <span class="function">igbinary_serialize</span>.
       Circular references inside the <span class="type">array</span> or <span class="type">object</span> that is being serializend will also be stored.
       Any other reference will be lost.
      </p>
      <p class="para">
       When serializing objects, igbinary will attempt to call the member functions
       <a href="language.oop5.magic.html#object.serialize" class="link">__serialize()</a> or
       <a href="language.oop5.magic.html#object.sleep" class="link">__sleep()</a> prior to serialization.
       This is to allow the object to do any last minute clean-up, etc. prior
       to being serialized. Likewise, when the object is restored using
       <span class="function">igbinary_unserialize</span> the <a href="language.oop5.magic.html#object.unserialize" class="link">__unserialize()</a> or
       <a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</a> member function is called.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <p class="para">
        Private members of <span class="type">object</span>s have the class name prepended to the member
        name; protected members have a <code class="literal">&#039;*&#039;</code> prepended to the member name.
        These prepended values have null bytes on either side.
       </p>
      </p></blockquote>


function_name: igbinary_unserialize
name: str
type: string
description:
<p class="para">
      The serialized string generated by <span class="function">igbinary_serialize</span>.
     </p>
     <p class="para">
      If the value being unserialized is an <span class="type">object</span>, after successfully
      reconstructing the object igbinary will automatically attempt to call the
      <a href="language.oop5.magic.html#object.unserialize" class="link">__unserialize()</a> or
      <a href="language.oop5.magic.html#object.wakeup" class="link">__wakeup()</a> methods (if one exists).
     </p>
     <p class="para">
      <blockquote class="note"><p><strong class="note">Note</strong>: 
       <strong>unserialize_callback_func directive</strong><br />
       <p class="para">
        It is possible to set a callback function which will be called,
        if an undefined class should be instantiated during unserializing.
        (to prevent getting an incomplete <span class="type">object</span> <code class="literal">__PHP_Incomplete_Class</code>.)
        The <var class="filename">php.ini</var>, <span class="function">ini_set</span> or <var class="filename">.htaccess</var> can be used
        to define <a href="var.configuration.html#ini.unserialize-callback-func" class="link">unserialize_callback_func</a>.
        Everytime an undefined class should be instantiated, it will be called.
        To disable this feature this setting should be emptied.
       </p>
      </p></blockquote>
     </p>


