# php_manual

id: IntlChar::getBidiPairedBracket
type: function
doc:
<comment>Description:</comment>
  Get the paired bracket character for a code point
  
  Maps the specified character to its paired bracket character.
  
  For <return>Bidi_Paired_Bracket_Type!=None</return>, this is the same as <strong>IntlChar::charMirror()</strong>. Otherwise
  <strong>$codepoint</strong> itself is returned.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Returns the paired bracket code point, or <strong>$codepoint</strong> itself if there is no such mapping.
         
         Tipul întors va fi <info>integer</info>, doar dacă code point nu a fost transmis
         ca <info>string</info> UTF-8, în care caz va fi întors un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET</info>
   * <info>IntlChar::PROPERTY_BIDI_PAIRED_BRACKET_TYPE</info>


id: IntlChar::getBlockCode
type: function
doc:
<comment>Description:</comment>
  Get the Unicode allocation block containing a code point
  
  Returns the Unicode allocation block that contains the character.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  Returns the block value for <strong>$codepoint</strong>. See the <return>IntlChar::BLOCK_CODE_*</return> constants for possible
       return values.


id: IntlChar::getCombiningClass
type: function
doc:
<comment>Description:</comment>
  Get the combining class of a code point
  
  Returns the combining class of the code point.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>int</info>  Returns the combining class of the character.


id: IntlChar::getFC_NFKC_Closure
type: function
doc:
<comment>Description:</comment>
  Get the FC_NFKC_Closure property for a code point
  
  Gets the FC_NFKC_Closure property string for a character.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>string</info>  Returns the FC_NFKC_Closure property string for the <strong>$codepoint</strong>, or an empty string if
          there is none.


id: IntlChar::getIntPropertyMaxValue
type: function
doc:
<comment>Description:</comment>
  Get the max value for a Unicode property
  
  Gets the maximum value for an enumerated/integer/binary Unicode property.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                  <return>IntlChar::PROPERTY_*</return>).

<comment>Return:</comment>
  <info>int</info>  The maximum value returned by <strong>IntlChar::getIntPropertyValue()</strong> for a Unicode property. <return>\<=0</return> if the property selector is out of range.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyMinValue
type: function
doc:
<comment>Description:</comment>
  Get the min value for a Unicode property
  
  Gets the minimum value for an enumerated/integer/binary Unicode property.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                  <return>IntlChar::PROPERTY_*</return>).

<comment>Return:</comment>
  <info>int</info>  The minimum value returned by <strong>IntlChar::getIntPropertyValue()</strong> for a Unicode property. <return>0</return> if
       the property selector is out of range.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getIntPropertyValue
type: function
doc:
<comment>Description:</comment>
  Get the value for a Unicode property for a code point
  
  Gets the property value for an enumerated or integer Unicode property for a code point. Also
  returns binary and mask property values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)
  <info>int  </info>  <strong>$property </strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                     <return>IntlChar::PROPERTY_*</return>).

<comment>Return:</comment>
  <info>int</info>  Returns the numeric value that is directly the property value or, for enumerated properties,
       corresponds to the numeric value of the enumerated constant of the respective property value
       enumeration type.
       
       Returns <return>0</return> or <return>1</return> (for <info>false</info>/<info>true</info>) for binary Unicode properties.
       
       Returns a bit-mask for mask properties.
       
       Returns <return>0</return> if <strong>$property</strong> is out of bounds or if the Unicode version does not have data for the
       property at all, or not for this code point.

<comment>See Also:</comment>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <strong>IntlChar::getIntPropertyMinValue()</strong>
   * <strong>IntlChar::getIntPropertyMaxValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::getNumericValue
type: function
doc:
<comment>Description:</comment>
  Get the numeric value for a Unicode code point
  
  Gets the numeric value for a Unicode code point as defined in the Unicode Character Database.
  
  For characters without any numeric values in the Unicode Character Database, this function will
  return <info>IntlChar::NO_NUMERIC_VALUE</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>float</info>  Numeric value of <strong>$codepoint</strong>, or <info>IntlChar::NO_NUMERIC_VALUE</info> if none is defined. This
         constant was added in PHP 7.0.6, prior to this version the literal value (<info>float</info>)<return>-123456789</return>
         may be used instead.


id: IntlChar::getPropertyEnum
type: function
doc:
<comment>Description:</comment>
  Get the property constant value for a given property name
  
  Returns the property constant value for a given property name, as specified in the Unicode
  database file PropertyAliases.txt. Short, long, and any other variants are recognized.
  
  In addition, this function maps the synthetic names "gcm" / "General_Category_Mask" to the
  property <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>. These names are not in PropertyAliases.txt.
  
  This function compliments <strong>IntlChar::getPropertyName()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  The property name to be matched. The name is compared using "loose matching" as
                  described in PropertyAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Returns an <return>IntlChar::PROPERTY_</return> constant value, or <info>IntlChar::PROPERTY_INVALID_CODE</info> if the
       given name does not match any property.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyName()</strong>


id: IntlChar::getPropertyName
type: function
doc:
<comment>Description:</comment>
  Get the Unicode name for a property
  
  Returns the Unicode name for a given property, as given in the Unicode database file
  PropertyAliases.txt.
  
  In addition, this function maps the property <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info> to the
  synthetic names "gcm" / "General_Category_Mask". These names are not in PropertyAliases.txt.
  
  This function compliments <strong>IntlChar::getPropertyEnum()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$property  </strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                    <return>IntlChar::PROPERTY_*</return>).
                    
                    <info>IntlChar::PROPERTY_INVALID_CODE</info> should not be used. Also, if <strong>$property</strong> is out of
                    range, <info>false</info> is returned.
  <info>int</info>  <strong>$nameChoice</strong>  Selector for which name to get. If out of range, <info>false</info> is returned.
                    
                    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 <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the name, or <info>false</info> if either the <strong>$property</strong> or the <strong>$nameChoice</strong> is out of range.
          
          If a given <strong>$nameChoice</strong> returns <info>false</info>, then all larger values of <strong>$nameChoice</strong> will return
          <info>false</info>, with one exception: if <info>false</info> is returned for <info>IntlChar::SHORT_PROPERTY_NAME</info>, then
          <info>IntlChar::LONG_PROPERTY_NAME</info> (and higher) may still return a non-<info>false</info> value.

<comment>See Also:</comment>
   * <strong>IntlChar::getPropertyEnum()</strong>


id: IntlChar::getPropertyValueEnum
type: function
doc:
<comment>Description:</comment>
  Get the property value for a given value name
  
  Returns the property value integer for a given value name, as specified in the Unicode database
  file PropertyValueAliases.txt. Short, long, and any other variants are recognized.
  
  Some of the names in PropertyValueAliases.txt will only be recognized with
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, not <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. These include:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int   </info>  <strong>$property</strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                     <return>IntlChar::PROPERTY_*</return>).
                     
                     If out of range, or this method doesn't work with the given value,
                     <info>IntlChar::PROPERTY_INVALID_CODE</info> is returned.
  <info>string</info>  <strong>$name    </strong>  The value name to be matched.  The name is compared using "loose matching" as
                     described in PropertyValueAliases.txt.

<comment>Return:</comment>
  <info>int</info>  Returns the corresponding value integer, or <info>IntlChar::PROPERTY_INVALID_CODE</info> if the given name
       does not match any value of the given property, or if the property is invalid.


id: IntlChar::getPropertyValueName
type: function
doc:
<comment>Description:</comment>
  Get the Unicode name for a property value
  
  Returns the Unicode name for a given property value, as given in the Unicode database file
  PropertyValueAliases.txt.
  
  Some of the names in PropertyValueAliases.txt can only be retrieved using
  <info>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</info>, not <info>IntlChar::PROPERTY_GENERAL_CATEGORY</info>. These include:
  "C" / "Other""L" / "Letter""LC" / "Cased_Letter""M" / "Mark""N" / "Number""P" / "Punctuation""S" /
  "Symbol" "Z" / "Separator"

<comment>Param:</comment>
  <info>int</info>  <strong>$property  </strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                    <return>IntlChar::PROPERTY_*</return>).
                    
                    If out of range, or this method doesn't work with the given value, <info>false</info> is
                    returned.
  <info>int</info>  <strong>$value     </strong>  Selector for a value for the given property. If out of range, <info>false</info> is returned.
                    
                    In general, valid values range from <return>0</return> up to some maximum. There are a couple
                    exceptions: <info>IntlChar::PROPERTY_BLOCK</info> values begin at the non-zero value
                    <info>IntlChar::BLOCK_CODE_BASIC_LATIN</info> <info>IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</info>
                    values are not contiguous and range from 0..240.
  <info>int</info>  <strong>$nameChoice</strong>  Selector for which name to get. If out of range, <info>false</info> is returned.
                    
                    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 <info>IntlChar::LONG_PROPERTY_NAME</info>.

<comment>Return:</comment>
  <info>string</info>  Returns the name, or <info>false</info> if either the <strong>$property</strong> or the <strong>$nameChoice</strong> is out of range.
          
          If a given <strong>$nameChoice</strong> returns <info>false</info>, then all larger values of <strong>$nameChoice</strong> will return
          <info>false</info>, with one exception: if <info>false</info> is returned for <info>IntlChar::SHORT_PROPERTY_NAME</info>, then
          <info>IntlChar::LONG_PROPERTY_NAME</info> (and higher) may still return a non-<info>false</info> value.


id: IntlChar::getUnicodeVersion
type: function
doc:
<comment>Description:</comment>
  Get the Unicode version
  
  Gets the Unicode version information.
  
  The version array is filled in with the version information for the Unicode standard that is
  currently used by ICU. For example, Unicode version 3.1.1 is represented as an array with the
  values <return>[3, 1, 1, 0]</return>.

<comment>Return:</comment>
  <info>array</info>  An array containing the Unicode version number.

<comment>See Also:</comment>
   * <strong>IntlChar::charAge()</strong>


id: IntlChar::hasBinaryProperty
type: function
doc:
<comment>Description:</comment>
  Check a binary Unicode property for a code point
  
  Checks a binary Unicode property for a code point.
  
  Unicode, especially in version 3.2, defines many more properties than the original set in
  UnicodeData.txt.
  
  The properties APIs are intended to reflect Unicode properties as defined in the Unicode Character
  Database (UCD) and Unicode Technical Reports (UTR). For details about the properties see
  http://www.unicode.org/ucd/. For names of Unicode properties see the UCD file PropertyAliases.txt.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)
  <info>int  </info>  <strong>$property </strong>  Proprietatea Unicode spre a fi căutată (a se vedea constantele
                     <return>IntlChar::PROPERTY_*</return>).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> or <info>false</info> according to the binary Unicode property value for <strong>$codepoint</strong>. Also
        <info>false</info> if <strong>$property</strong> is out of bounds or if the Unicode version does not have data for the
        property at all, or not for this code point.

<comment>See Also:</comment>
   * <strong>IntlChar::getIntPropertyValue()</strong>
   * <strong>IntlChar::getUnicodeVersion()</strong>


id: IntlChar::isIDIgnorable
type: function
doc:
<comment>Description:</comment>
  Check if code point is an ignorable character
  
  Determines if the specified character should be regarded as an ignorable character in an
  identifier.
  
  <info>true</info> for characters with general category "Cf" (format controls) as well as non-whitespace ISO
  controls (U+0000..U+0008, U+000E..U+001B, U+007F..U+009F).
  
  Note that Unicode just recommends to ignore Cf (format controls).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is ignorable in identifiers, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::isIDPart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible in an identifier
  
  Determines if the specified character is permissible in an identifier.
  
  <info>true</info> for characters with general categories "L" (letters), "Nl" (letter numbers), "Nd" (decimal
  digits), "Mc" and "Mn" (combining marks), "Pc" (connecting punctuation), and u_isIDIgnorable(c).
  
  This is almost the same as Unicode's ID_Continue (<info>IntlChar::PROPERTY_ID_CONTINUE</info>) except that
  Unicode recommends to ignore Cf which is less than <strong>IntlChar::isIDIgnorable()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is the code point may occur in an identifier, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDStart()</strong>
   * <info>IntlChar::PROPERTY_ID_CONTINUE</info>


id: IntlChar::isIDStart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible as the first character in an identifier
  
  Determines if the specified character is permissible as the first character in an identifier
  according to Unicode (The Unicode Standard, Version 3.0, chapter 5.16 Identifiers).
  
  <info>true</info> for characters with general categories "L" (letters) and "Nl" (letter numbers).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> may start an identifier, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <info>IntlChar::PROPERTY_ID_START</info>


id: IntlChar::isISOControl
type: function
doc:
<comment>Description:</comment>
  Check if code point is an ISO control code
  
  Determines whether the specified code point is an ISO control code.
  
  <info>true</info> for U+0000..U+001f and U+007f..U+009f (general category "Cc").

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an ISO control code, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>


id: IntlChar::isJavaIDPart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible in a Java identifier
  
  Determines if the specified character is permissible in a Java identifier.
  
  In addition to <strong>IntlChar::isIDPart()</strong>, <info>true</info> for characters with general category "Sc" (currency
  symbols).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> may occur in a Java identifier, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDIgnorable()</strong>
   * <strong>IntlChar::isIDPart()</strong>
   * <strong>IntlChar::isJavaIDStart()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isJavaIDStart
type: function
doc:
<comment>Description:</comment>
  Check if code point is permissible as the first character in a Java identifier
  
  Determines if the specified character is permissible as the start of a Java identifier.
  
  In addition to <strong>IntlChar::isIDStart()</strong>, <info>true</info> for characters with general categories "Sc" (currency
  symbols) and "Pc" (connecting punctuation).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> may start a Java identifier, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isIDStart()</strong>
   * <strong>IntlChar::isJavaIDPart()</strong>
   * <strong>IntlChar::isalpha()</strong>


id: IntlChar::isJavaSpaceChar
type: function
doc:
<comment>Description:</comment>
  Check if code point is a space character according to Java
  
  Determine if the specified code point is a space character according to Java.
  
  <info>true</info> for characters with general categories "Z" (separators), which does not include control codes
  (e.g., TAB or Line Feed).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a space character according to Java, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isMirrored
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Bidi_Mirrored property
  
  Determines whether the code point has the Bidi_Mirrored property.
  
  This property is set for characters that are commonly used in Right-To-Left contexts and need to
  be displayed with a "mirrored" glyph.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Bidi_Mirrored property, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::charMirror()</strong>
   * <info>IntlChar::PROPERTY_BIDI_MIRRORED</info>


id: IntlChar::isUAlphabetic
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Alphabetic Unicode property
  
  Check if a code point has the Alphabetic Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_ALPHABETIC)</return>

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Alphabetic Unicode property, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_ALPHABETIC</info>


id: IntlChar::isULowercase
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Lowercase Unicode property
  
  Check if a code point has the Lowercase Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_LOWERCASE)</return>
  
  This is different than <strong>IntlChar::islower()</strong> and will return <info>true</info> for more characters.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Lowercase Unicode property, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>


id: IntlChar::isUUppercase
type: function
doc:
<comment>Description:</comment>
  Check if code point has the Uppercase Unicode property
  
  Check if a code point has the Uppercase Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_UPPERCASE)</return>
  
  This is different than <strong>IntlChar::isupper()</strong> and will return <info>true</info> for more characters.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the Uppercase Unicode property, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>


id: IntlChar::isUWhiteSpace
type: function
doc:
<comment>Description:</comment>
  Check if code point has the White_Space Unicode property
  
  Check if a code point has the White_Space Unicode property.
  
  This is the same as <return>IntlChar::hasBinaryProperty($codepoint, IntlChar::PROPERTY_WHITE_SPACE)</return>
  
  This is different from both <strong>IntlChar::isspace()</strong> and <strong>IntlChar::isWhitespace()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> has the White_Space Unicode property, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::hasBinaryProperty()</strong>
   * <info>IntlChar::PROPERTY_WHITE_SPACE</info>


id: IntlChar::isWhitespace
type: function
doc:
<comment>Description:</comment>
  Check if code point is a whitespace character according to ICU
  
  Determines if the specified code point is a whitespace character according to ICU.
  
  A character is considered to be a ICU whitespace character if and only if it satisfies one of the
  following criteria: It is a Unicode Separator character (categories "Z" = "Zs" or "Zl" or "Zp"),
  but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP).It
  is U+0009 HORIZONTAL TABULATION.It is U+000A LINE FEED.It is U+000B VERTICAL TABULATION.It is
  U+000C FORM FEED.It is U+000D CARRIAGE RETURN.It is U+001C FILE SEPARATOR.It is U+001D GROUP
  SEPARATOR.It is U+001E RECORD SEPARATOR.It is U+001F UNIT SEPARATOR.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a whitespace character according to ICU, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::isalnum
type: function
doc:
<comment>Description:</comment>
  Check if code point is an alphanumeric character
  
  Determines whether the specified code point is an alphanumeric character (letter or digit).  <info>true</info>
  for characters with general categories "L" (letters) and "Nd" (decimal digit numbers).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an alphanumeric character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isalpha
type: function
doc:
<comment>Description:</comment>
  Check if code point is a letter character
  
  Determines whether the specified code point is a letter character.  <info>true</info> for general categories
  "L" (letters).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a letter character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isbase
type: function
doc:
<comment>Description:</comment>
  Check if code point is a base character
  
  Determines whether the specified code point is a base character.  <info>true</info> for general categories "L"
  (letters), "N" (numbers), "Mc" (spacing combining marks), and "Me" (enclosing marks).
  
  This is different from the Unicode definition in chapter 3.5, conformance clause D13, which
  defines base characters to be all characters (not Cn) that do not graphically combine with
  preceding characters (M) and that are neither control (Cc) or format (Cf) characters.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a base character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::isblank
type: function
doc:
<comment>Description:</comment>
  Check if code point is a "blank" or "horizontal space" character
  
  Determines whether the specified code point is a "blank" or "horizontal space", a character that
  visibly separates words on a line.
  
  The following are equivalent definitions: <info>true</info> for Unicode White_Space characters except for
  "vertical space controls" where "vertical space controls" are the following characters: U+000A
  (LF) U+000B (VT) U+000C (FF) U+000D (CR) U+0085 (NEL) U+2028 (LS) U+2029 (PS) <info>true</info> for U+0009
  (TAB) and characters with general category "Zs" (space separators) except Zero Width Space (ZWSP,
  U+200B).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is either a "blank" or "horizontal space" character, <info>false</info> if
        not.

<comment>See Also:</comment>
   * <strong>IntlChar::isspace()</strong>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>
   * <strong>IntlChar::isWhitespace()</strong>


id: IntlChar::iscntrl
type: function
doc:
<comment>Description:</comment>
  Check if code point is a control character
  
  Determines whether the specified code point is a control character.
  
  A control character is one of the following: ISO 8-bit control character (U+0000..U+001f and
  U+007f..U+009f)<info>IntlChar::CHAR_CATEGORY_CONTROL_CHAR</info> (Cc)<info>IntlChar::CHAR_CATEGORY_FORMAT_CHAR</info>
  (Cf)<info>IntlChar::CHAR_CATEGORY_LINE_SEPARATOR</info> (Zl)<info>IntlChar::CHAR_CATEGORY_PARAGRAPH_SEPARATOR</info> (Zp)

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a control character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isprint()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::isdefined
type: function
doc:
<comment>Description:</comment>
  Check whether the code point is defined
  
  Determines whether the specified code point is "defined", which usually means that it is assigned
  a character.
  
  <info>true</info> for general categories other than "Cn" (other, not assigned).
  
  Note that non-character code points (e.g., U+FDD0) are not "defined" (they are Cn), but surrogate
  code points are "defined" (Cs).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a defined character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>


id: IntlChar::isdigit
type: function
doc:
<comment>Description:</comment>
  Check if code point is a digit character
  
  Determines whether the specified code point is a digit character.
  
  <info>true</info> for characters with general category "Nd" (decimal digit numbers). Beginning with Unicode 4,
  this is the same as testing for the Numeric_Type of Decimal.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a digit character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isalpha()</strong>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isxdigit()</strong>


id: IntlChar::isgraph
type: function
doc:
<comment>Description:</comment>
  Check if code point is a graphic character
  
  Determines whether the specified code point is a "graphic" character (printable, excluding
  spaces).
  
  <info>true</info> for all characters except those with general categories "Cc" (control codes), "Cf" (format
  controls), "Cs" (surrogates), "Cn" (unassigned), and "Z" (separators).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a "graphic" character, <info>false</info> if not.


id: IntlChar::islower
type: function
doc:
<comment>Description:</comment>
  Check if code point is a lowercase letter
  
  Determines whether the specified code point has the general category "Ll" (lowercase letter).
  
  This misses some characters that are also lowercase but have a different general category value.
  In order to include those, use <strong>IntlChar::isULowercase()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an Ll lowercase letter, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_LOWERCASE</info>


id: IntlChar::isprint
type: function
doc:
<comment>Description:</comment>
  Check if code point is a printable character
  
  Determines whether the specified code point is a printable character.
  
  <info>true</info> for general categories other than "C" (controls).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a printable character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::iscntrl()</strong>
   * <info>IntlChar::PROPERTY_DEFAULT_IGNORABLE_CODE_POINT</info>


id: IntlChar::ispunct
type: function
doc:
<comment>Description:</comment>
  Check if code point is punctuation character
  
  Determines whether the specified code point is a punctuation character.
  
  <info>true</info> for characters with general categories "P" (punctuation).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a punctuation character, <info>false</info> if not.


id: IntlChar::isspace
type: function
doc:
<comment>Description:</comment>
  Check if code point is a space character
  
  Determines if the specified character is a space character or not.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a space character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isJavaSpaceChar()</strong>
   * <strong>IntlChar::isWhitespace()</strong>
   * <strong>IntlChar::isUWhiteSpace()</strong>


id: IntlChar::istitle
type: function
doc:
<comment>Description:</comment>
  Check if code point is a titlecase letter
  
  Determines whether the specified code point is a titlecase letter.
  
  <info>true</info> for general category "Lt" (titlecase letter).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a titlecase letter, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isupper()</strong>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::totitle()</strong>


id: IntlChar::isupper
type: function
doc:
<comment>Description:</comment>
  Check if code point has the general category "Lu" (uppercase letter)
  
  Determines whether the specified code point has the general category "Lu" (uppercase letter).
  
  This misses some characters that are also uppercase but have a different general category value.
  In order to include those, use <strong>IntlChar::isUUppercase()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is an Lu uppercase letter, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::islower()</strong>
   * <strong>IntlChar::istitle()</strong>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <info>IntlChar::PROPERTY_UPPERCASE</info>


id: IntlChar::isxdigit
type: function
doc:
<comment>Description:</comment>
  Check if code point is a hexadecimal digit
  
  Determines whether the specified code point is a hexadecimal digit.
  
  <info>true</info> for characters with general category "Nd" (decimal digit numbers) as well as Latin letters
  a-f and A-F in both ASCII and Fullwidth ASCII. (That is, for letters with code points 0041..0046,
  0061..0066, FF21..FF26, FF41..FF46.)
  
  This is equivalent to <return>IntlChar::digit($codepoint, 16) &gt;= 0</return>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$codepoint</strong> is a hexadecimal character, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>IntlChar::isdigit()</strong>


id: IntlChar::ord
type: function
doc:
<comment>Description:</comment>
  Return Unicode code point value of character
  
  Returns the Unicode code point value of the given character.
  
  This function compliments <strong>IntlChar::chr()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$character</strong>  A Unicode character.

<comment>Return:</comment>
  <info>int</info>  Returns the Unicode code point value as an integer.

<comment>See Also:</comment>
   * <strong>IntlChar::isalnum()</strong>
   * <strong>IntlChar::isdigit()</strong>
   * <strong>IntlChar::chr()</strong>
   * <strong>ord()</strong>


id: IntlChar::tolower
type: function
doc:
<comment>Description:</comment>
  Make Unicode character lowercase
  
  The given character is mapped to its lowercase equivalent. If the character has no lowercase
  equivalent, the original character itself is returned.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Returns the Simple_Lowercase_Mapping of the code point, if any; otherwise the code point
         itself.
         
         Tipul întors va fi <info>integer</info>, doar dacă code point nu a fost transmis
         ca <info>string</info> UTF-8, în care caz va fi întors un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::totitle()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_strtolower()</strong>


id: IntlChar::totitle
type: function
doc:
<comment>Description:</comment>
  Make Unicode character titlecase
  
  The given character is mapped to its titlecase equivalent. If the character has no titlecase
  equivalent, the original character itself is returned.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Returns the Simple_Titlecase_Mapping of the code point, if any; otherwise the code point
         itself.
         
         Tipul întors va fi <info>integer</info>, doar dacă code point nu a fost transmis
         ca <info>string</info> UTF-8, în care caz va fi întors un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::toupper()</strong>
   * <strong>mb_convert_case()</strong>


id: IntlChar::toupper
type: function
doc:
<comment>Description:</comment>
  Make Unicode character uppercase
  
  The given character is mapped to its uppercase equivalent. If the character has no uppercase
  equivalent, the character itself is returned.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$codepoint</strong>  Valoarea codepoint de tip <info>integer</info> (de ex. <return>0x2603</return>
                     pentru U+2603 SNOWMAN) sau caracterul codificat ca
                     <info>string</info> în UTF-8 (de ex. <return>"\u{2603}"</return>)

<comment>Return:</comment>
  <info>mixed</info>  Returns the Simple_Uppercase_Mapping of the code point, if any; otherwise the code point
         itself.
         
         Tipul întors va fi <info>integer</info>, doar dacă code point nu a fost transmis
         ca <info>string</info> UTF-8, în care caz va fi întors un <info>string</info>.

<comment>See Also:</comment>
   * <strong>IntlChar::tolower()</strong>
   * <strong>IntlChar::totitle()</strong>
   * <strong>mb_strtoupper()</strong>


id: IntlCodePointBreakIterator
type: class
doc:
<comment>Description:</comment>
  This break iterator identifies the boundaries between UTF-8 code points.


id: IntlCodePointBreakIterator::getLastCodePoint
type: function
doc:
<comment>Description:</comment>
  Get last code point passed over after advancing or receding the iterator
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>int</info>  


id: IntlDateFormatter
type: class
doc:
<comment>Description:</comment>
  Date Formatter is a concrete class that enables locale-dependent formatting/parsing  of dates
  using pattern strings and/or canned patterns.
  
  This class represents the ICU date formatting functionality.  It allows users to display dates in
  a localized format or to parse strings  into PHP date values using pattern strings and/or canned
  patterns.


id: IntlDateFormatter::FULL
type: constant
doc:
<comment>Description:</comment>
  Completely specified style (Tuesday, April 12, 1952 AD or 3:30:42pm PST)


id: IntlDateFormatter::RELATIVE_FULL
type: constant
doc:
<comment>Description:</comment>
  The same as <info>IntlDateFormatter::FULL</info>, but yesterday, today, and tomorrow show as <return>yesterday</return>, <return>today</return>,
  and <return>tomorrow</return>, respectively.  Available as of PHP 8.0.0, for <strong>$dateType</strong> only.


id: IntlDateFormatter::RELATIVE_LONG
type: constant
doc:
<comment>Description:</comment>
  The same as <info>IntlDateFormatter::LONG</info>, but yesterday, today, and tomorrow show as <return>yesterday</return>, <return>today</return>,
  and <return>tomorrow</return>, respectively.  Available as of PHP 8.0.0, for <strong>$dateType</strong> only.


id: IntlDateFormatter::RELATIVE_MEDIUM
type: constant
doc:
<comment>Description:</comment>
  The same as <info>IntlDateFormatter::MEDIUM</info>, but yesterday, today, and tomorrow show as <return>yesterday</return>,
  <return>today</return>, and <return>tomorrow</return>, respectively.  Available as of PHP 8.0.0, for <strong>$dateType</strong> only.


id: IntlDateFormatter::RELATIVE_SHORT
type: constant
doc:
<comment>Description:</comment>
  The same as <info>IntlDateFormatter::SHORT</info>, but yesterday, today, and tomorrow show as <return>yesterday</return>, <return>today</return>,
  and <return>tomorrow</return>, respectively.  Available as of PHP 8.0.0, for <strong>$dateType</strong> only.


id: IntlDateFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a date formatter
  
  Stil obiect-orientat
  
  Stil obiect-orientat (constructor)
  
  Stil procedural
  
  Create a date formatter.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale  </strong>  Locale to use when formatting or parsing or <info>null</info> to use the value specified in
                     the ini setting intl.default_locale.
  <info>int   </info>  <strong>$datetype</strong>  Date type to use (<info>none</info>, <info>short</info>, <info>medium</info>, <info>long</info>, <info>full</info>).  This is one of the
                     IntlDateFormatter constants.  It can also be <info>null</info>, in which case ICUʼs default
                     date type will be used.
  <info>int   </info>  <strong>$timetype</strong>  Time type to use (<info>none</info>, <info>short</info>, <info>medium</info>, <info>long</info>, <info>full</info>).  This is one of the
                     IntlDateFormatter constants.  It can also be <info>null</info>, in which case ICUʼs default
                     time type will be used.
  <info>mixed </info>  <strong>$timezone</strong>  Time zone ID. The default (and the one used if <info>null</info> is given) is the one
                     returned by <strong>date_default_timezone_get()</strong> or, if applicable, that of the
                     <class>IntlCalendar</class> object passed for the <strong>$calendar</strong> parameter. This ID must be a valid
                     identifier on ICUʼs database or an ID representing an explicit offset, such as
                     <return>GMT-05:30</return>.
                     
                     This can also be an <class>IntlTimeZone</class> or a <class>DateTimeZone</class> object.
  <info>mixed </info>  <strong>$calendar</strong>  Calendar to use for formatting or parsing. The default value is <info>null</info>, which
                     corresponds to <info>IntlDateFormatter::GREGORIAN</info>. This can either be one of the
                     IntlDateFormatter calendar constants or an <class>IntlCalendar</class>. Any <class>IntlCalendar</class>
                     object passed will be clone; it will not be changed by the <class>IntlDateFormatter</class>.
                     This will determine the calendar type used (gregorian, islamic, persian, etc.)
                     and, if <info>null</info> is given for the <strong>$timezone</strong> parameter, also the timezone used.
  <info>string</info>  <strong>$pattern </strong>  Optional pattern to use when formatting or parsing. Possible patterns are
                     documented at http://userguide.icu-project.org/formatparse/datetime.

<comment>Return:</comment>
  <info>IntlDateFormatter</info>  The created <class>IntlDateFormatter</class> or <info>false</info> in case of failure.

<comment>See Also:</comment>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::format
type: function
doc:
<comment>Description:</comment>
  Format the date/time value as a string
  
  Stil obiect-orientat
  
  Stil procedural
  
  Formats the time value as a string.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt  </strong>  The date formatter resource.
  <info>mixed            </info>  <strong>$value</strong>  Value to format. This may be a <class>DateTimeInterface</class> object, an
                             <class>IntlCalendar</class> object, a <info>numeric</info> type representing a (possibly
                             fractional) number of seconds since epoch or an <info>array</info> in the format
                             output by <strong>localtime()</strong>.
                             
                             If a <class>DateTime</class> or an <class>IntlCalendar</class> 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, <strong>IntlDateFormatter::setTimeZone()</strong> must be called before
                             with the objectʼs timezone. Alternatively, the static function
                             <strong>IntlDateFormatter::formatObject()</strong> may be used instead.

<comment>Return:</comment>
  <info>string</info>  The formatted string or, if an error occurred, <info>false</info>.

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>
   * <strong>datefmt_format_object()</strong>


id: IntlDateFormatter::formatObject
type: function
doc:
<comment>Description:</comment>
  Formats an object
  
  Stil obiect-orientat
  
  Stil procedural
  
  This function allows formatting an <class>IntlCalendar</class> or <class>DateTime</class> object without first explicitly
  creating a <class>IntlDateFormatter</class> object.
  
  The temporary <class>IntlDateFormatter</class> that will be created will take the timezone from the passed in
  object. The timezone database bundled with PHP will not be used – ICU's will be used instead. The
  timezone identifier used in <class>DateTime</class> objects must therefore also exist in ICU's database.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  An object of type <class>IntlCalendar</class> or <class>DateTime</class>. The timezone information in the
                   object will be used.
  <info>mixed </info>  <strong>$format</strong>  How to format the date/time. This can either be an <info>array</info> with two elements (first
                   the date style, then the time style, these being one of the constants
                   <info>IntlDateFormatter::NONE</info>, <info>IntlDateFormatter::SHORT</info>, <info>IntlDateFormatter::MEDIUM</info>,
                   <info>IntlDateFormatter::LONG</info>, <info>IntlDateFormatter::FULL</info>), an <info>int</info> with the value of one
                   of these constants (in which case it will be used both for the time and the date)
                   or a <info>string</info> with the format described in the ICU documentation. If <info>null</info>, the
                   default style will be used.
  <info>string</info>  <strong>$locale</strong>  The locale to use, or <info>null</info> to use the default one.

<comment>Return:</comment>
  <info>stringfalse</info>  A string with result sau <info>false</info> în cazul eșecului.


id: IntlDateFormatter::getCalendar
type: function
doc:
<comment>Description:</comment>
  Get the calendar type used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource

<comment>Return:</comment>
  <info>int</info>  The calendar type being used by the formatter. Either <info>IntlDateFormatter::TRADITIONAL</info> or
       <info>IntlDateFormatter::GREGORIAN</info>.

<comment>See Also:</comment>
   * <strong>datefmt_get_calendar_object()</strong>
   * <strong>datefmt_set_calendar()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getCalendarObject
type: function
doc:
<comment>Description:</comment>
  Get copy of formatterʼs calendar object
  
  Stil obiect-orientat
  
  Stil procedural
  
  Obtain a copy of the calendar object used internally by this formatter. This calendar will have a
  type (as in gregorian, japanese, buddhist, roc, persian, islamic, etc.) and a timezone that match
  the type and timezone used by the formatter. The date/time of the object is unspecified.

<comment>Return:</comment>
  <info>IntlCalendar</info>  A copy of the internal calendar object used by this formatter.

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getCalendar()</strong>
   * <strong>IntlDateFormatter::setCalendar()</strong>
   * <class>IntlCalendar</class>


id: IntlDateFormatter::getDateType
type: function
doc:
<comment>Description:</comment>
  Get the datetype used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns date type used by the formatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>int</info>  The current date type value of the formatter.

<comment>See Also:</comment>
   * <strong>datefmt_get_timetype()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get the error code from last operation
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the error code from last operation. Returns error code from the last number formatting
  operation.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>int</info>  The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR.

<comment>See Also:</comment>
   * <strong>datefmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: IntlDateFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get the error text from the last operation
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the error text from the last operation.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>string</info>  Description of the last error.

<comment>See Also:</comment>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: IntlDateFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Get the locale used by formatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get locale used by the formatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt </strong>  The formatter resource
  <info>                 </info>  <strong>$hich</strong>  You can choose between valid and actual locale ( <info>Locale::VALID_LOCALE</info>,
                            <info>Locale::ACTUAL_LOCALE</info>, respectively). The default is the actual locale.

<comment>Return:</comment>
  <info>string</info>  the locale of this formatter  or 'false' if error

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Get the pattern used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get pattern used by the formatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>string</info>  The pattern string being used to format/parse.

<comment>See Also:</comment>
   * <strong>datefmt_set_pattern()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getTimeType
type: function
doc:
<comment>Description:</comment>
  Get the timetype used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Return time type used by the formatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>int</info>  The current date type value of the formatter.

<comment>See Also:</comment>
   * <strong>datefmt_get_datetype()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::getTimeZone
type: function
doc:
<comment>Description:</comment>
  Get formatterʼs timezone
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an <class>IntlTimeZone</class> object representing the timezone that will be used by this object to
  format dates and times. When formatting <class>IntlCalendar</class> and <class>DateTime</class> objects with this
  <class>IntlDateFormatter</class>, the timezone used will be the one returned by this method, not the one
  associated with the objects being formatted.

<comment>Return:</comment>
  <info>IntlTimeZonefalse</info>  The associated <class>IntlTimeZone</class> object sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getTimeZoneId()</strong>
   * <strong>IntlDateFormatter::setTimeZone()</strong>
   * <class>IntlTimeZone</class>


id: IntlDateFormatter::getTimeZoneId
type: function
doc:
<comment>Description:</comment>
  Get the timezone-id used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the timezone-id used for the IntlDateFormatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>string</info>  ID string for the time zone used by this formatter.

<comment>See Also:</comment>
   * <strong>datefmt_set_timezone_id()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::isLenient
type: function
doc:
<comment>Description:</comment>
  Get the lenient used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Check if the parser is strict or lenient in interpreting inputs that do not match the pattern
  exactly.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt</strong>  The formatter resource.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if parser is lenient, <info>false</info> if parser is strict. By default the parser is lenient.

<comment>See Also:</comment>
   * <strong>datefmt_set_lenient()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::localtime
type: function
doc:
<comment>Description:</comment>
  Parse string to a field-based time value
  
  Stil obiect-orientat
  
  Stil procedural
  
  Converts string $value to a field-based time value ( an array of various fields), starting at
  $parse_pos and consuming as much of the input value as possible.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt     </strong>  The formatter resource
  <info>string           </info>  <strong>$value   </strong>  string to convert to a time
  <info>int              </info>  <strong>$position</strong>  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.

<comment>Return:</comment>
  <info>array</info>  Localtime compatible array of integers  : contains 24 hour clock value in tm_hour field

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_parse()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Parse string to a timestamp value
  
  Stil obiect-orientat
  
  Stil procedural
  
  Converts string $value to an incremental time value, starting at  $parse_pos and consuming as much
  of the input value as possible.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt     </strong>  The formatter resource
  <info>string           </info>  <strong>$value   </strong>  string to convert to a time
  <info>int              </info>  <strong>$position</strong>  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 (and
                                the error occurred). This variable will contain the end position if
                                the parse fails. If $parse_pos &gt; strlen($value), the parse fails
                                immediately.

<comment>Return:</comment>
  <info>int</info>  timestamp parsed value, or <info>false</info> if value can't be parsed.

<comment>See Also:</comment>
   * <strong>datefmt_create()</strong>
   * <strong>datefmt_format()</strong>
   * <strong>datefmt_localtime()</strong>
   * <strong>datefmt_get_error_code()</strong>
   * <strong>datefmt_get_error_message()</strong>


id: IntlDateFormatter::setCalendar
type: function
doc:
<comment>Description:</comment>
  Sets the calendar type used by the formatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Sets the calendar or calendar type used by the formatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt  </strong>  The formatter resource.
  <info>mixed            </info>  <strong>$which</strong>  This can either be: the calendar type to use (default is
                             <info>IntlDateFormatter::GREGORIAN</info>, which is also used if <info>null</info> is specified)
                             or an <class>IntlCalendar</class> object.
                             
                             Any <class>IntlCalendar</class> object passed in will be cloned; no modifications will
                             be made to the argument object.
                             
                             The timezone of the formatter will only be kept if an <class>IntlCalendar</class>
                             object is not passed, otherwise the new timezone will be that of the
                             passed object.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>datefmt_get_calendar()</strong>
   * <strong>datefmt_get_calendar_object()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setLenient
type: function
doc:
<comment>Description:</comment>
  Set the leniency of the parser
  
  Stil obiect-orientat
  
  Stil procedural
  
  Define if the parser is strict or lenient in interpreting inputs that do not match the pattern
  exactly. Enabling lenient parsing allows the parser to accept otherwise flawed date or  time
  patterns, parsing as much as possible to obtain a value. Extra space, unrecognized tokens, or
  invalid values ("February 30th") are not accepted.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt    </strong>  The formatter resource
  <info>bool             </info>  <strong>$lenient</strong>  Sets whether the parser is lenient or not, default is <info>true</info> (lenient).

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>datefmt_is_lenient()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Set the pattern used for the IntlDateFormatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Set the pattern used for the IntlDateFormatter.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt    </strong>  The formatter resource.
  <info>string           </info>  <strong>$pattern</strong>  New pattern string to use. Possible patterns are documented at
                               http://userguide.icu-project.org/formatparse/datetime.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Bad formatstrings are usually the cause of the
        failure.

<comment>See Also:</comment>
   * <strong>datefmt_get_pattern()</strong>
   * <strong>datefmt_create()</strong>


id: IntlDateFormatter::setTimeZone
type: function
doc:
<comment>Description:</comment>
  Sets formatterʼs timezone
  
  Stil obiect-orientat
  
  Stil procedural
  
  Sets the timezone used for the IntlDateFormatter. object.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt </strong>  The formatter resource.
  <info>mixed            </info>  <strong>$zone</strong>  The timezone to use for this formatter. This can be specified in the
                            following forms:
                            
                            <info>null</info>, in which case the default timezone will be used, as specified in
                            the ini setting date.timezone or through the function
                            <strong>date_default_timezone_set()</strong> and as returned by
                            <strong>date_default_timezone_get()</strong>.
                            
                            An <class>IntlTimeZone</class>, which will be used directly.
                            
                            A <class>DateTimeZone</class>. Its identifier will be extracted and an ICU timezone
                            object will be created; the timezone will be backed by ICUʼs database,
                            not PHPʼs.
                            
                            A <info>string</info>, which should be a valid ICU timezone identifier. See
                            <strong>IntlTimeZone::createTimeZoneIDEnumeration()</strong>. Raw offsets such as
                            <return>"GMT+08:30"</return> are also accepted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>IntlDateFormatter::getTimeZone()</strong>


id: IntlDateFormatter::setTimeZoneId
type: function
doc:
<comment>Description:</comment>
  Sets the time zone to use
  
  Stil obiect-orientat
  
  Stil procedural
  
  Sets the time zone to use.

<comment>Param:</comment>
  <info>IntlDateFormatter</info>  <strong>$fmt </strong>  The formatter resource.
  <info>string           </info>  <strong>$zone</strong>  The time zone ID string of the time zone to use. If <info>null</info> or the empty
                            string, the default time zone for the runtime is used.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>datefmt_get_timezone_id()</strong>
   * <strong>datefmt_create()</strong>


id: IntlException
type: class
doc:
<comment>Description:</comment>
  This class is used for generating exceptions when errors occur inside intl functions. Such
  exceptions are only generated when intl.use_exceptions is enabled.


id: IntlGregorianCalendar::__construct
type: function
doc:
<comment>Description:</comment>
  Create the Gregorian Calendar class
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>IntlTimeZone</info>  <strong>$tz            </strong>  
  <info>string      </info>  <strong>$locale        </strong>  
  <info>int         </info>  <strong>$timeZoneOrYear</strong>  
  <info>int         </info>  <strong>$localeOrMonth </strong>  
  <info>int         </info>  <strong>$dayOfMonth    </strong>  
  <info>int         </info>  <strong>$hour          </strong>  
  <info>int         </info>  <strong>$minute        </strong>  
  <info>int         </info>  <strong>$second        </strong>  


id: IntlGregorianCalendar::getGregorianChange
type: function
doc:
<comment>Description:</comment>
  Get the Gregorian Calendar change date
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>floatfalse</info>  Returns the change date sau <info>false</info> în cazul eșecului.


id: IntlGregorianCalendar::isLeapYear
type: function
doc:
<comment>Description:</comment>
  Determine if the given year is a leap year
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>  

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> for leap years, <info>false</info> otherwise and on failure.


id: IntlGregorianCalendar::setGregorianChange
type: function
doc:
<comment>Description:</comment>
  Set the Gregorian Calendar the change date
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>float</info>  <strong>$date</strong>  

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: IntlIterator
type: class
doc:
<comment>Description:</comment>
  This class represents iterator objects throughout the intl extension whenever the iterator cannot
  be identified with any other object provided by the extension. The distinct iterator object used
  internally by the <return>foreach</return> construct can only be obtained (in the relevant part here) from objects,
  so objects of this class serve the purpose of providing the hook through which this internal
  object can be obtained. As a convenience, this class also implements the <class>Iterator</class> interface,
  allowing the collection of values to be navigated using the methods defined in that interface.
  Both these methods and the internal iterator objects provided to <return>foreach</return> are backed by the same
  state (e.g. the position of the iterator and its current value).
  
  Subclasses may provide richer functionality.


id: IntlIterator::current
type: function
doc:
<comment>Description:</comment>
  Get the current element
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>mixed</info>  


id: IntlIterator::key
type: function
doc:
<comment>Description:</comment>
  Get the current key
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  


id: IntlIterator::next
type: function
doc:
<comment>Description:</comment>
  Move forward to the next element
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>void</info>  


id: IntlIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator to the first element
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>void</info>  


id: IntlIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check if current position is valid
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>bool</info>  


id: IntlPartsIterator
type: class
doc:
<comment>Description:</comment>
  Objects of this class can be obtained from <class>IntlBreakIterator</class> objects. While the break iterators
  provide a sequence of boundary positions when iterated, <class>IntlPartsIterator</class> objects provide, as a
  convenience, the text fragments comprehended between two successive boundaries.
  
  The keys may represent the offset of the left boundary, right boundary, or they may just the
  sequence of non-negative integers. See <strong>IntlBreakIterator::getPartsIterator()</strong>.


id: IntlPartsIterator::getBreakIterator
type: function
doc:
<comment>Description:</comment>
  Get IntlBreakIterator backing this parts iterator
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>IntlBreakIterator</info>  


id: IntlRuleBasedBreakIterator
type: class
doc:
<comment>Description:</comment>
  A subclass of <class>IntlBreakIterator</class> that encapsulates ICU break iterators whose behavior is specified
  using a set of rules. This is the most common kind of break iterators.
  
  These rules are described in the ICU Boundary Analysis User Guide.


id: IntlRuleBasedBreakIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Create iterator from ruleset
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$rules      </strong>  
  <info>string</info>  <strong>$areCompiled</strong>  


id: IntlRuleBasedBreakIterator::getBinaryRules
type: function
doc:
<comment>Description:</comment>
  Get the binary form of compiled rules
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  


id: IntlRuleBasedBreakIterator::getRuleStatus
type: function
doc:
<comment>Description:</comment>
  Get the largest status value from the break rules that determined the current break position
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>int</info>  


id: IntlRuleBasedBreakIterator::getRuleStatusVec
type: function
doc:
<comment>Description:</comment>
  Get the status values from the break rules that determined the current break position
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>array</info>  


id: IntlRuleBasedBreakIterator::getRules
type: function
doc:
<comment>Description:</comment>
  Get the rule set used to create this object
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::countEquivalentIDs
type: function
doc:
<comment>Description:</comment>
  Get the number of IDs in the equivalency group that includes the given ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId</strong>  

<comment>Return:</comment>
  <info>int</info>  


id: IntlTimeZone::createDefault
type: function
doc:
<comment>Description:</comment>
  Create a new copy of the default timezone for this host
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::createEnumeration
type: function
doc:
<comment>Description:</comment>
  Get an enumeration over time zone IDs associated with the
    given country or offset
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$countryOrRawOffset</strong>  

<comment>Return:</comment>
  <info>IntlIterator</info>  


id: IntlTimeZone::createTimeZone
type: function
doc:
<comment>Description:</comment>
  Create a timezone object for the given ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId</strong>  

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::createTimeZoneIDEnumeration
type: function
doc:
<comment>Description:</comment>
  Get an enumeration over system time zone IDs with the given filter conditions
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>int   </info>  <strong>$zoneType </strong>  
  <info>string</info>  <strong>$region   </strong>  
  <info>int   </info>  <strong>$rawOffset</strong>  

<comment>Return:</comment>
  <info>IntlIteratorfalse</info>  Returns <class>IntlIterator</class> sau <info>false</info> în cazul eșecului.


id: IntlTimeZone::fromDateTimeZone
type: function
doc:
<comment>Description:</comment>
  Create a timezone object from DateTimeZone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$zoneId</strong>  

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::getCanonicalID
type: function
doc:
<comment>Description:</comment>
  Get the canonical system timezone ID or the normalized custom time zone ID for the given time zone
  ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId    </strong>  
  <info>bool  </info>  <strong>$isSystemID</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::getDSTSavings
type: function
doc:
<comment>Description:</comment>
  Get the amount of time to be added to local standard time to get local wall clock time
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>int</info>  


id: IntlTimeZone::getDisplayName
type: function
doc:
<comment>Description:</comment>
  Get a name of this time zone suitable for presentation to the user
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>bool  </info>  <strong>$isDaylight</strong>  
  <info>int   </info>  <strong>$style     </strong>  
  <info>string</info>  <strong>$locale    </strong>  

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::getEquivalentID
type: function
doc:
<comment>Description:</comment>
  Get an ID in the equivalency group that includes the given ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId</strong>  
  <info>int   </info>  <strong>$index </strong>  

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::getGMT
type: function
doc:
<comment>Description:</comment>
  Create GMT (UTC) timezone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  


id: IntlTimeZone::getID
type: function
doc:
<comment>Description:</comment>
  Get timezone ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::getIDForWindowsID
type: function
doc:
<comment>Description:</comment>
  Translate a Windows timezone into a system timezone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Translates a Windows timezone (e.g. "Pacific Standard Time") into a system timezone (e.g.
  "America/Los_Angeles").
  
  This function requires ICU version ≥ 52.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  
  <info>string</info>  <strong>$region  </strong>  

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the system timezone sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * IntlTimeZone::getWindowsID


id: IntlTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Get the time zone raw and GMT offset for the given moment in time
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>float</info>  <strong>$date     </strong>  
  <info>bool </info>  <strong>$local    </strong>  
  <info>int  </info>  <strong>$rawOffset</strong>  
  <info>int  </info>  <strong>$dstOffset</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: IntlTimeZone::getRawOffset
type: function
doc:
<comment>Description:</comment>
  Get the raw GMT offset (before taking daylight savings time into account
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>int</info>  


id: IntlTimeZone::getRegion
type: function
doc:
<comment>Description:</comment>
  Get the region code associated with the given system time zone ID
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$zoneId</strong>  

<comment>Return:</comment>
  <info>stringfalse</info>  Return region sau <info>false</info> în cazul eșecului.


id: IntlTimeZone::getTZDataVersion
type: function
doc:
<comment>Description:</comment>
  Get the timezone data version currently used by ICU
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  


id: IntlTimeZone::getUnknown
type: function
doc:
<comment>Description:</comment>
  Get the "unknown" time zone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>IntlTimeZone</info>  Returns <class>IntlTimeZone</class> or <info>null</info> on failure.


id: IntlTimeZone::getWindowsID
type: function
doc:
<comment>Description:</comment>
  Translate a system timezone into a Windows timezone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Translates a system timezone (e.g. "America/Los_Angeles") into a Windows timezone (e.g. "Pacific
  Standard Time").
  
  This function requires ICU version ≥ 52.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the Windows timezone sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * IntlTimeZone::getIDForWindowsID


id: IntlTimeZone::hasSameRules
type: function
doc:
<comment>Description:</comment>
  Check if this zone has the same rules and offset as another zone
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>IntlTimeZone</info>  <strong>$otherTimeZone</strong>  

<comment>Return:</comment>
  <info>bool</info>  


id: IntlTimeZone::toDateTimeZone
type: function
doc:
<comment>Description:</comment>
  Convert to DateTimeZone object
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>DateTimeZone</info>  


id: IntlTimeZone::useDaylightTime
type: function
doc:
<comment>Description:</comment>
  Check if this time zone uses daylight savings time
  
  Stil obiect-orientat (method):
  
  Stil procedural:
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>bool</info>  


id: Iterator
type: class
doc:
<comment>Description:</comment>
  Interface for external iterators or objects that can be iterated themselves internally.


id: Iterator::current
type: function
doc:
<comment>Description:</comment>
  Return the current element
  
  Returns the current element.

<comment>Return:</comment>
  <info>mixed</info>  Can return any type.


id: Iterator::key
type: function
doc:
<comment>Description:</comment>
  Return the key of the current element
  
  Returns the key of the current element.

<comment>Return:</comment>
  <info>scalar</info>  Returns <info>scalar</info> on success, or <info>null</info> on failure.


id: Iterator::next
type: function
doc:
<comment>Description:</comment>
  Move forward to next element
  
  Moves the current position to the next element.
  
  This method is called after each foreach loop.

<comment>Return:</comment>
  <info>void</info>  Any returned value is ignored.


id: Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the Iterator to the first element
  
  Rewinds back to the first element of the Iterator.
  
  This is the first method called when starting a foreach loop. It will not be executed after
  foreach loops.

<comment>Return:</comment>
  <info>void</info>  Any returned value is ignored.


id: Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Checks if current position is valid
  
  This method is called after Iterator::rewind and Iterator::next to check if the current position
  is valid.

<comment>Return:</comment>
  <info>bool</info>  The return value will be casted to <info>bool</info> and then evaluated. Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: IteratorAggregate::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator.

<comment>Return:</comment>
  <info>Traversable</info>  An instance of an object implementing <class>Iterator</class> or <class>Traversable</class>


id: IteratorIterator
type: class
doc:
<comment>Description:</comment>
  This iterator wrapper allows the conversion of anything that is Traversable into an Iterator. It
  is important to understand that most classes that do not implement Iterators have reasons as most
  likely they do not allow the full Iterator feature set. If so, techniques should be provided to
  prevent misuse, otherwise expect exceptions or fatal errors.


id: IteratorIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Create an iterator from anything that is traversable
  
  Creates an iterator from anything that is traversable.

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>  The traversable iterator.

<comment>Return:</comment>
  <info>unknown</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * <class>Traversable</class>


id: IteratorIterator::current
type: function
doc:
<comment>Description:</comment>
  Get the current value
  
  Get the value of the current element.

<comment>Return:</comment>
  <info>mixed</info>  The value of the current element.

<comment>See Also:</comment>
   * IteratorIterator::key


id: IteratorIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Get the inner iterator
  
  Get the inner iterator.

<comment>Return:</comment>
  <info>Traversable</info>  The inner iterator as passed to IteratorIterator::__construct.

<comment>See Also:</comment>
   * <class>Iterator</class>
   * <class>OuterIterator</class>


id: IteratorIterator::key
type: function
doc:
<comment>Description:</comment>
  Get the key of the current element
  
  Get the key of the current element.

<comment>Return:</comment>
  <info>mixed</info>  The key of the current element.

<comment>See Also:</comment>
   * IteratorIterator::current


id: IteratorIterator::next
type: function
doc:
<comment>Description:</comment>
  Forward to the next element
  
  Forward to the next element.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * IteratorIterator::rewind
   * IteratorIterator::valid


id: IteratorIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind to the first element
  
  Rewinds to the first element.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * IteratorIterator::next
   * IteratorIterator::valid


id: IteratorIterator::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the iterator is valid
  
  Checks if the iterator is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the iterator is valid, otherwise <info>false</info>

<comment>See Also:</comment>
   * <strong>iterator_count()</strong>
   * IteratorIterator::current


id: JSON_BIGINT_AS_STRING
type: constant
doc:
<comment>Description:</comment>
  Decodifică numere întregi mari ca șiruri de caractere cu valoarea lor originală. Disponibilă
  începând cu PHP 5.4.0.


id: JSON_ERROR_CTRL_CHAR
type: constant
doc:
<comment>Description:</comment>
  Eroare în caracterul de control, posibil a fost codificat greșit. Disponibilă începând cu PHP
  5.3.0.


id: JSON_ERROR_DEPTH
type: constant
doc:
<comment>Description:</comment>
  A fost depășită adâncimea maximă a stivei. Disponibilă începând cu PHP 5.3.0.


id: JSON_ERROR_INF_OR_NAN
type: constant
doc:
<comment>Description:</comment>
  Valoarea transmisă funcției <strong>json_encode()</strong> include <info>NAN</info> sau <info>INF</info>. Dacă a fost indicată opțiunea
  <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, în locul acestor numere speciale va fi codificat <return>0</return>. Disponibilă
  începând cu PHP 5.5.0.


id: JSON_ERROR_INVALID_PROPERTY_NAME
type: constant
doc:
<comment>Description:</comment>
  În șirul de caractere transmis funcției <strong>json_decode()</strong> a fost găsită o cheie ce începe cu
  caracterul \u0000, la decodificarea unui obiect JSON într-un obiect PHP. Disponibilă începând cu
  PHP 7.0.0.


id: JSON_ERROR_RECURSION
type: constant
doc:
<comment>Description:</comment>
  Obiectul sau tabloul transmis funcției <strong>json_encode()</strong> include referințe recursive și de aceea nu
  pot fi codificate. Dacă a fost indicată opțiunea <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, în locul
  referințelor recursive va fi codificat <info>null</info>. Disponibilă începând cu PHP 5.5.0.


id: JSON_ERROR_STATE_MISMATCH
type: constant
doc:
<comment>Description:</comment>
  Are loc în cazul unei valori ce depășește limita de jos, sau când modurile nu coincid. Disponibilă
  începând cu PHP 5.3.0.


id: JSON_ERROR_UNSUPPORTED_TYPE
type: constant
doc:
<comment>Description:</comment>
  O valoare de tip nesusținut a fost transmisă funcției <strong>json_encode()</strong>, cum ar fi o resource. Dacă a
  fost indicată opțiunea <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info>, în locul valorii nesusținute va fi codificat
  <info>null</info>. Disponibilă începând cu PHP 5.5.0.


id: JSON_ERROR_UTF16
type: constant
doc:
<comment>Description:</comment>
  În șirul JSON transmis către <strong>json_decode()</strong> a fost găsit un surogat UTF-16 singur, fără pereche.
  Disponibilă începând cu PHP 7.0.0.


id: JSON_ERROR_UTF8
type: constant
doc:
<comment>Description:</comment>
  Caractere UTF-8 eronate, posibil codificate incorect. Disponibilă începând cu PHP 5.3.3.


id: JSON_FORCE_OBJECT
type: constant
doc:
<comment>Description:</comment>
  Întoarce un obiect în loc de tablou când este utilizat un tablou non-associativ. Util în special
  când receptorul rezultatului se așteaptă la un obiect, iar tabloul este vid. Disponibilă începând
  cu PHP 5.3.0.


id: JSON_HEX_AMP
type: constant
doc:
<comment>Description:</comment>
  Toate & sunt convertite în \u0026. Disponibilă începând cu PHP 5.3.0.


id: JSON_HEX_APOS
type: constant
doc:
<comment>Description:</comment>
  Toate ' sunt convertite în \u0027. Disponibilă începând cu PHP 5.3.0.


id: JSON_HEX_QUOT
type: constant
doc:
<comment>Description:</comment>
  Toate " sunt convertite în \u0022. Disponibilă începând cu PHP 5.3.0.


id: JSON_HEX_TAG
type: constant
doc:
<comment>Description:</comment>
  Toate \< și &gt; sunt convertite în \u003C și \u003E. Disponibilă începând cu PHP 5.3.0.


id: JSON_INVALID_UTF8_IGNORE
type: constant
doc:
<comment>Description:</comment>
  Ignorează caracterele UTF-8 nevalide. Disponibilă începând cu PHP 7.2.0.


id: JSON_INVALID_UTF8_SUBSTITUTE
type: constant
doc:
<comment>Description:</comment>
  Convertește caracterele UTF-8 nevalide în \0xfffd (Caracterul Unicode 'REPLACEMENT CHARACTER')
  Disponibil începând cu PHP 7.2.0.


id: JSON_NUMERIC_CHECK
type: constant
doc:
<comment>Description:</comment>
  Codifică șiruri numerice ca numere. Disponibilă începând cu PHP 5.3.3.


id: JSON_OBJECT_AS_ARRAY
type: constant
doc:
<comment>Description:</comment>
  Decodifică obiecte JSON ca tablouri PHP. Această opțiune poate fi adăugată automat apelând
  <strong>json_decode()</strong> cu al doilea parametru egal cu <info>true</info>. Disponibilă începând cu PHP 5.4.0.


id: JSON_PARTIAL_OUTPUT_ON_ERROR
type: constant
doc:
<comment>Description:</comment>
  Substituie unele valori ce nu pot fi codificate, în loc să eșueze. Disponibilă începând cu PHP
  5.5.0.


id: JSON_PRESERVE_ZERO_FRACTION
type: constant
doc:
<comment>Description:</comment>
  Asigură ca valorile <info>float</info> să fie întotdeauna codificate ca valori float. Disponibilă începând cu
  PHP 5.6.6.


id: JSON_PRETTY_PRINT
type: constant
doc:
<comment>Description:</comment>
  Folosește spații în datele întoarse pentru a le formata. Disponibilă începând cu PHP 5.4.0.


id: JSON_THROW_ON_ERROR
type: constant
doc:
<comment>Description:</comment>
  Emite <class>JsonException</class> dacă are loc o eroare în loc să seteze starea de eroare globală care este
  obținută cu <strong>json_last_error()</strong> și <strong>json_last_error_msg()</strong>. <info>JSON_PARTIAL_OUTPUT_ON_ERROR</info> are
  precedență față de <info>JSON_THROW_ON_ERROR</info>. Disponibilă începând cu PHP 7.3.0.


id: JSON_UNESCAPED_LINE_TERMINATORS
type: constant
doc:
<comment>Description:</comment>
  Sfârșiturile liniilor sunt păstrate fără schimbare atunci când este indicată
  <info>JSON_UNESCAPED_UNICODE</info>. Ea are același comportament ca și până la versiunea PHP 7.1 fără această
  constantă. Disponibilă începând cu PHP 7.1.0.


id: JSON_UNESCAPED_SLASHES
type: constant
doc:
<comment>Description:</comment>
  Nu evadează caracterele <return>/</return>. Disponibilă începând cu PHP 5.4.0.


id: JSON_UNESCAPED_UNICODE
type: constant
doc:
<comment>Description:</comment>
  Codifică caracterele Unicode pe mai mulți baiți așa cum sunt (implicit se efectuează evadarea de
  tip \uXXXX). Disponibilă începând cu PHP 5.4.0.


id: JsonSerializable
type: class
doc:
<comment>Description:</comment>
  Obiectele care implementează JsonSerializable pot personaliza reprezentarea JSON în urma apelării
  funcției <strong>json_encode()</strong>.


id: JsonSerializable::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Specify data which should be serialized to JSON
  
  Serializes the object to a value that can be serialized natively by <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong>, which is a value of any type other
         than a resource.


id: Judy
type: class
doc:
<comment>Description:</comment>
  The Judy class implements the ArrayAccess 
  interface and the Iterator interface. 
  This class, once instantiated, can be accessed like a PHP 
  array.
  
  A PHP Judy object (or Judy Array) can be one of the following type :
  Judy::BITSETJudy::INT_TO_INTJudy::INT_TO_MIXEDJudy::STRING_TO_INTJudy::STRING_TO_MIXED
  
  <info>Judy array example</info>
  ]]>


id: Judy::BITSET
type: constant
doc:
<comment>Description:</comment>
  Define the Judy Array as a Bitset with keys as Integer and Values as a Boolean


id: Judy::INT_TO_INT
type: constant
doc:
<comment>Description:</comment>
  Define the Judy Array with key/values as Integer, and Integer only.


id: Judy::INT_TO_MIXED
type: constant
doc:
<comment>Description:</comment>
  Define the Judy Array with keys as Integer and Values of any type.


id: Judy::STRING_TO_INT
type: constant
doc:
<comment>Description:</comment>
  Define the Judy Array with keys as a String and Values as Integer, and Integer only.


id: Judy::STRING_TO_MIXED
type: constant
doc:
<comment>Description:</comment>
  Define the Judy Array with keys as a String and Values of any type.


id: Judy::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Judy object
  
  Construct a new Judy object. A Judy object can be accessed like a PHP Array.

<comment>Param:</comment>
  <info>int</info>  <strong>$judy_type</strong>  The Judy type to be used.

<comment>Return:</comment>
  <info>unknown</info>  Return the new Judy instance.


id: Judy::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct a Judy object
  
  Destruct a Judy object.

<comment>Return:</comment>
  <info>void</info>  


id: Judy::byCount
type: function
doc:
<comment>Description:</comment>
  Locate the Nth index present in the Judy array
  
  Locate the Nth index present in the <class>Judy</class> array.

<comment>Param:</comment>
  <info>int</info>  <strong>$nth_index</strong>  Nth index to return. If nth_index equal 1, then it will return the first index in
                   the array.

<comment>Return:</comment>
  <info>int</info>  Return the index at the given Nth position.


id: Judy::count
type: function
doc:
<comment>Description:</comment>
  Count the number of elements in the Judy array
  
  Count the number of elements in the <class>Judy</class> array.

<comment>Param:</comment>
  <info>int</info>  <strong>$index_start</strong>  Start counting from the given index. Default is first index.
  <info>int</info>  <strong>$index_end  </strong>  Stop counting when reaching this index. Default is last index.

<comment>Return:</comment>
  <info>int</info>  Return the number of elements.


id: Judy::first
type: function
doc:
<comment>Description:</comment>
  Search for the first index in the Judy array
  
  Search (inclusive) for the first index present that is equal to or greater than the passed Index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                 the search.

<comment>Return:</comment>
  <info>mixed</info>  Return the corresponding index in the array.


id: Judy::firstEmpty
type: function
doc:
<comment>Description:</comment>
  Search for the first absent index in the Judy array
  
  Search (inclusive) for the first absent index that is equal to or greater than the passed Index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                 the search.

<comment>Return:</comment>
  <info>int</info>  Return the corresponding index in the array.


id: Judy::free
type: function
doc:
<comment>Description:</comment>
  Free the entire Judy array
  
  Free the entire <class>Judy</class> array.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>int</info>  


id: Judy::getType
type: function
doc:
<comment>Description:</comment>
  Return the type of the current Judy array
  
  Return an integer corresponding to the Judy type  of the current object.

<comment>Return:</comment>
  <info>int</info>  Return an integer corresponding to a Judy type.


id: Judy::last
type: function
doc:
<comment>Description:</comment>
  Search for the last index in the Judy array
  
  Search (inclusive) for the last index present that is equal to or less than the passed Index.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                  the search.

<comment>Return:</comment>
  <info>void</info>  Return the corresponding index in the array.


id: Judy::lastEmpty
type: function
doc:
<comment>Description:</comment>
  Search for the last absent index in the Judy array
  
  Search (inclusive) for the last absent index that is equal to or less than the passed Index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start the
               search.

<comment>Return:</comment>
  <info>int</info>  Return the corresponding index in the array.


id: Judy::memoryUsage
type: function
doc:
<comment>Description:</comment>
  Return the memory used by the Judy array
  
  Return the memory used by the <class>Judy</class> array.

<comment>Return:</comment>
  <info>int</info>  Return the memory used in bytes.


id: Judy::next
type: function
doc:
<comment>Description:</comment>
  Search for the next index in the Judy array
  
  Search (exclusive) for the next index present that is greater than the passed Index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                 the search.

<comment>Return:</comment>
  <info>mixed</info>  Return the corresponding index in the array.


id: Judy::nextEmpty
type: function
doc:
<comment>Description:</comment>
  Search for the next absent index in the Judy array
  
  Search (exclusive) for the next absent index that is greater than the passed Index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start the
               search.

<comment>Return:</comment>
  <info>int</info>  Return the corresponding index in the array.


id: Judy::offsetExists
type: function
doc:
<comment>Description:</comment>
  Whether a offset exists
  
  Whether or not an offset exists.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  An offset to check for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success or <info>false</info> on failure.


id: Judy::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset to retrieve
  
  Returns the value at specified offset.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  The offset to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  Can return all value types.


id: Judy::offsetSet
type: function
doc:
<comment>Description:</comment>
  Offset to set
  
  Assigns a value to the specified offset.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  The offset to assign the value to.
  <info>mixed</info>  <strong>$value </strong>  The value to set.

<comment>Return:</comment>
  <info>bool</info>  No value is returned.


id: Judy::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Offset to unset
  
  Unsets an offset.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  The offset to unset.

<comment>Return:</comment>
  <info>bool</info>  No value is returned.


id: Judy::prev
type: function
doc:
<comment>Description:</comment>
  Search for the previous index in the Judy array
  
  Search (exclusive) for the previous index present that is less than the passed Index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                 the search.

<comment>Return:</comment>
  <info>mixed</info>  Return the corresponding index in the array.


id: Judy::prevEmpty
type: function
doc:
<comment>Description:</comment>
  Search for the previous absent index in the Judy array
  
  Search (exclusive) for the previous index absent that is less than the passed Index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index can be an integer or a string corresponding to the index where to start
                 the search.

<comment>Return:</comment>
  <info>int</info>  Return the corresponding index in the array.


id: Judy::size
type: function
doc:
<comment>Description:</comment>
  Return the size of the current Judy array
  
  Această metodă este pseudonim pentru:  Judy::count.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>void</info>  Return an integer.


id: LATT_NOINFERIORS
type: constant
doc:
<comment>Description:</comment>
  Această cutie poștală nu are "descendenți" (nu sunt cutii poștale mai jos de aceasta).


id: LATT_NOSELECT
type: constant
doc:
<comment>Description:</comment>
  Acesta este doar un container, nu o cutie poștală - nu îl puteți deschide.


id: LATT_UNMARKED
type: constant
doc:
<comment>Description:</comment>
  Aceasstă cutie poștală nu este marcată. Utilizat numai de UW-IMAPD.


id: LDAP_CONTROL_ASSERT
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Assertion (RFC 4528). Available as of PHP 7.3.0.


id: LDAP_CONTROL_AUTHZID_REQUEST
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Authorization Identity Request (RFC 3829). Available as of PHP 7.3.0.


id: LDAP_CONTROL_AUTHZID_RESPONSE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Authorization Identity Response (RFC 3829). Available as of PHP 7.3.0.


id: LDAP_CONTROL_DONTUSECOPY
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Don't Use Copy (RFC 6171). Available as of PHP 7.3.0.


id: LDAP_CONTROL_MANAGEDSAIT
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Manage DSA IT (RFC 3296). Available as of PHP 7.3.0.


id: LDAP_CONTROL_PAGEDRESULTS
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Paged results (RFC 2696). Available as of PHP 7.3.0.


id: LDAP_CONTROL_PASSWORDPOLICYREQUEST
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Password Policy Request. Available as of PHP 7.3.0.


id: LDAP_CONTROL_PASSWORDPOLICYRESPONSE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Password Policy Response. Available as of PHP 7.3.0.


id: LDAP_CONTROL_POST_READ
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Post read (RFC 4527). Available as of PHP 7.3.0.


id: LDAP_CONTROL_PRE_READ
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Pre read (RFC 4527). Available as of PHP 7.3.0.


id: LDAP_CONTROL_PROXY_AUTHZ
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Proxied Authorization (RFC 4370). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SORTREQUEST
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Sort request (RFC 2891). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SORTRESPONSE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Sort response (RFC 2891). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SUBENTRIES
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Subentries (RFC 3672). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SYNC
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Content Synchronization Operation (RFC 4533). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SYNC_DONE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Content Synchronization Operation Done (RFC 4533). Available as of PHP 7.3.0.


id: LDAP_CONTROL_SYNC_STATE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Content Synchronization Operation State (RFC 4533). Available as of PHP 7.3.0.


id: LDAP_CONTROL_VALUESRETURNFILTER
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Filter returned values (RFC 3876). Available as of PHP 7.3.0.


id: LDAP_CONTROL_VLVREQUEST
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Virtual List View Request. Available as of PHP 7.3.0.


id: LDAP_CONTROL_VLVRESPONSE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Virtual List View Response. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_DOMAIN_SCOPE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Domain Scope. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_EXTENDED_DN
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Extended DN. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_INCREMENTAL_VALUES
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Incremental Values. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_PERMISSIVE_MODIFY
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Permissive Modify. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_SEARCH_OPTIONS
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Search Options. Available as of PHP 7.3.0.


id: LDAP_CONTROL_X_TREE_DELETE
type: constant
doc:
<comment>Description:</comment>
  Control Constant - Active Directory Tree Delete. Available as of PHP 7.3.0.


id: LDAP_OPT_CLIENT_CONTROLS
type: constant
doc:
<comment>Description:</comment>
  Specifies a default list of client controls to be processed with each request.


id: LDAP_OPT_NETWORK_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Option for <strong>ldap_set_option()</strong> to allow setting network timeout. (Available as of PHP 5.3.0)


id: LDAP_OPT_REFERRALS
type: constant
doc:
<comment>Description:</comment>
  Specifies whether to automatically follow referrals returned by the LDAP server.


id: LDAP_OPT_RESTART
type: constant
doc:
<comment>Description:</comment>
  Determines whether or not the connection should be implicitly restarted.


id: LDAP_OPT_SERVER_CONTROLS
type: constant
doc:
<comment>Description:</comment>
  Specifies a default list of server controls to be sent with each request.


id: LDAP_OPT_SIZELIMIT
type: constant
doc:
<comment>Description:</comment>
  Specifies the maximum number of entries that can be returned on a search operation.
  
  The actual size limit for operations is also bounded by the server's configured maximum number of
  return entries. The lesser of these two settings is the actual size limit.


id: LDAP_OPT_TIMELIMIT
type: constant
doc:
<comment>Description:</comment>
  Specifies the number of seconds to wait for search results.
  
  The actual time limit for operations is also bounded by the server's configured maximum time. The
  lesser of these two settings is the actual time limit.


id: LDAP_OPT_X_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Specifies the number of seconds a connection needs to remain idle before TCP starts sending
  keepalive probes.


id: LDAP_OPT_X_KEEPALIVE_INTERVAL
type: constant
doc:
<comment>Description:</comment>
  Specifies the interval in seconds between individual keepalive probes.


id: LDAP_OPT_X_KEEPALIVE_PROBES
type: constant
doc:
<comment>Description:</comment>
  Specifies the maximum number of keepalive probes TCP should send before dropping the connection.


id: LDAP_OPT_X_TLS_CRLCHECK
type: constant
doc:
<comment>Description:</comment>
  Specifies the CRL evaluation strategy. This must be one of:
  <info>LDAP_OPT_X_TLS_CRL_NONE</info>,<info>LDAP_OPT_X_TLS_CRL_PEER</info>, <info>LDAP_OPT_X_TLS_CRL_ALL</info>.
  
  This option is only valid for OpenSSL.


id: LDAP_OPT_X_TLS_CRLFILE
type: constant
doc:
<comment>Description:</comment>
  Specifies the full-path of the CRL file.
  
  This option is only valid for GnuTLS.


id: LDAP_OPT_X_TLS_DHFILE
type: constant
doc:
<comment>Description:</comment>
  Specifies the full-path  of the file containing the parameters for Diffie-Hellman ephemeral key
  exchange.
  
  This option is ignored by GnuTLS and Mozilla NSS.


id: LDAP_OPT_X_TLS_PROTOCOL_MIN
type: constant
doc:
<comment>Description:</comment>
  Specifies the minimum protocol version. This can be one of:
  <info>LDAP_OPT_X_TLS_PROTOCOL_SSL2</info>,<info>LDAP_OPT_X_TLS_PROTOCOL_SSL3</info>, <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_0</info>,
  <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_1</info>, <info>LDAP_OPT_X_TLS_PROTOCOL_TLS1_2</info>


id: LDAP_OPT_X_TLS_RANDOM_FILE
type: constant
doc:
<comment>Description:</comment>
  Sets/gets the random file when one of the system default ones are not available.


id: LDAP_OPT_X_TLS_REQUIRE_CERT
type: constant
doc:
<comment>Description:</comment>
  Specifies the certificate checking checking strategy. This must be one of:
  <info>LDAP_OPT_X_TLS_NEVER</info>,<info>LDAP_OPT_X_TLS_HARD</info>, <info>LDAP_OPT_X_TLS_DEMAND</info>,
  <info>LDAP_OPT_X_TLS_ALLOW</info>, <info>LDAP_OPT_X_TLS_TRY</info>. (Available as of PHP 7.0.0)


id: LIBXML_BIGLINES
type: constant
doc:
<comment>Description:</comment>
  Allows line numbers greater than 65535 to be reported correctly.
  
  Only available as of PHP 7.0.0 with Libxml &gt;= 2.9.0


id: LIBXML_COMPACT
type: constant
doc:
<comment>Description:</comment>
  Activate small nodes allocation optimization. This may speed up your application without needing
  to change the code.
  
  Only available in Libxml &gt;= 2.6.21


id: LIBXML_HTML_NODEFDTD
type: constant
doc:
<comment>Description:</comment>
  Sets HTML_PARSE_NODEFDTD flag, which prevents a default doctype being added when one is not found.
  
  Only available in Libxml &gt;= 2.7.8 (as of PHP &gt;= 5.4.0)


id: LIBXML_HTML_NOIMPLIED
type: constant
doc:
<comment>Description:</comment>
  Sets HTML_PARSE_NOIMPLIED flag, which turns off the automatic adding of implied html/body...
  elements.
  
  Only available in Libxml &gt;= 2.7.7 (as of PHP &gt;= 5.4.0)


id: LIBXML_NOEMPTYTAG
type: constant
doc:
<comment>Description:</comment>
  Expand empty tags (e.g. <return>\<br/&gt;</return> to <return>\<br&gt;\</br&gt;</return>)
  
  This option is currently just available in the  and  functions.


id: LIBXML_NOENT
type: constant
doc:
<comment>Description:</comment>
  Substitute entities
  
  Enabling entity substitution may facilitate XML External Entity (XXE) attacks.


id: LIBXML_NOXMLDECL
type: constant
doc:
<comment>Description:</comment>
  Drop the XML declaration when saving a document
  
  Only available in Libxml &gt;= 2.6.21


id: LIBXML_PARSEHUGE
type: constant
doc:
<comment>Description:</comment>
  Sets XML_PARSE_HUGE flag, which relaxes any hardcoded limit from the parser. This affects  limits
  like maximum depth of a document or the entity recursion, as well as limits of the  size of text
  nodes.
  
  Only available in Libxml &gt;= 2.7.0 (as of PHP &gt;= 5.3.2 and PHP &gt;= 5.2.12)


id: LIBXML_PEDANTIC
type: constant
doc:
<comment>Description:</comment>
  Sets XML_PARSE_PEDANTIC flag, which enables pedantic error reporting.
  
  Available as of PHP &gt;= 5.4.0


id: LIBXML_SCHEMA_CREATE
type: constant
doc:
<comment>Description:</comment>
  Create default/fixed value nodes during XSD schema validation
  
  Only available in Libxml &gt;= 2.6.14 (as of PHP &gt;= 5.5.2)


id: LOG_AUTH
type: constant
doc:
<comment>Description:</comment>
  security/authorization messages (use <info>LOG_AUTHPRIV</info> instead in systems where that constant is
  defined)


id: LOG_CONS
type: constant
doc:
<comment>Description:</comment>
  if there is an error while sending data to the system logger, write directly to the system console


id: LOG_ODELAY
type: constant
doc:
<comment>Description:</comment>
  (default) delay opening the connection until the first message is logged


id: LimitIterator
type: class
doc:
<comment>Description:</comment>
  The <class>LimitIterator</class> class allows iteration over  a limited subset of items in an <class>Iterator</class>.


id: LimitIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a LimitIterator
  
  Constructs a new <class>LimitIterator</class> from an  <strong>$iterator</strong> with a given starting  <strong>$offset</strong> and maximum
  <strong>$count</strong>.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The <class>Iterator</class> to limit.
  <info>int     </info>  <strong>$offset  </strong>  Optional offset of the limit.
  <info>int     </info>  <strong>$count   </strong>  Optional count of the limit.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>LimitIterator</class>.

<comment>See Also:</comment>
   * LimitIterator examples


id: LimitIterator::current
type: function
doc:
<comment>Description:</comment>
  Get current element
  
  Gets the current element of the inner <class>Iterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current element or <info>null</info> if there is none.

<comment>See Also:</comment>
   * LimitIterator::key
   * LimitIterator::next
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Get inner iterator
  
  Gets the inner <class>Iterator</class>.

<comment>Return:</comment>
  <info>Iterator</info>  The inner iterator passed to LimitIterator::__construct.

<comment>See Also:</comment>
   * LimitIterator::__construct
   * IteratorIterator::getInnerIterator


id: LimitIterator::getPosition
type: function
doc:
<comment>Description:</comment>
  Return the current position
  
  Gets the current zero-based position of the inner <class>Iterator</class>.

<comment>Return:</comment>
  <info>int</info>  The current position.

<comment>See Also:</comment>
   * FilterIterator::key


id: LimitIterator::key
type: function
doc:
<comment>Description:</comment>
  Get current key
  
  Gets the key for the current item in the inner <class>Iterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  Returns the key for the current item.

<comment>See Also:</comment>
   * LimitIterator::getPosition
   * LimitIterator::current
   * LimitIterator::next
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::next
type: function
doc:
<comment>Description:</comment>
  Move the iterator forward
  
  Moves the iterator forward.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::rewind
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator to the specified starting offset
  
  Rewinds the iterator to the starting offset specified in LimitIterator::__construct.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::next
   * LimitIterator::seek
   * LimitIterator::valid


id: LimitIterator::seek
type: function
doc:
<comment>Description:</comment>
  Seek to the given position
  
  Moves the iterator to the offset specified by <strong>$position</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The position to seek to.

<comment>Return:</comment>
  <info>int</info>  Returns the offset position after seeking.

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::rewind
   * LimitIterator::next
   * LimitIterator::valid


id: LimitIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current element is valid
  
  Checks whether the current element is valid.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * LimitIterator::current
   * LimitIterator::key
   * LimitIterator::rewind
   * LimitIterator::next
   * LimitIterator::seek


id: Locale
type: class
doc:
<comment>Description:</comment>
  A "Locale" is an identifier used to get language, culture, or regionally-specific behavior from an
  API. PHP locales are organized and identified the same way that the CLDR locales used by ICU (and
  many vendors of Unix-like operating systems, the Mac, Java, and so forth) use. Locales are
  identified using RFC 4646 language tags (which use hyphen, not underscore) in addition to the more
  traditional underscore-using identifiers. Unless otherwise noted the functions in this class are
  tolerant of both formats.
  
  Examples of identifiers include: en-US (English, United States)zh-Hant-TW (Chinese, Traditional
  Script, Taiwan)fr-CA, fr-FR (French for Canada and France respectively)
  
  The Locale class (and related procedural functions) are used to interact with locale
  identifiers--to verify that an ID is well-formed, valid, etc. The extensions used by CLDR in UAX
  #35 (and inherited by ICU) are valid and used wherever they would be in ICU normally.
  
  Locales cannot be instantiated as objects. All of the functions/methods provided are static.
  
  The null or empty string obtains the "root" locale. The "root" locale is equivalent to
  "en_US_POSIX" in CLDR. Language tags (and thus locale identifiers) are case insensitive. There
  exists a canonicalization function to make case match the specification.


id: Locale::DEFAULT_LOCALE
type: constant
doc:
<comment>Description:</comment>
  Used as locale parameter with the methods of the various locale affected classes, such as
  NumberFormatter. This constant would make the methods to use default locale.


id: Locale::acceptFromHttp
type: function
doc:
<comment>Description:</comment>
  Tries to find out best available locale based on HTTP "Accept-Language" header
  
  Stil obiect-orientat
  
  Stil procedural
  
  Tries to find locale that can satisfy the language list that is requested by the HTTP
  "Accept-Language" header.

<comment>Param:</comment>
  <info>string</info>  <strong>$header</strong>  The string containing the "Accept-Language" header according to format in RFC
                   2616.

<comment>Return:</comment>
  <info>string</info>  The corresponding locale identifier.

<comment>See Also:</comment>
   * <strong>locale_lookup()</strong>


id: Locale::canonicalize
type: function
doc:
<comment>Description:</comment>
  Canonicalize the locale string
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  

<comment>Return:</comment>
  <info>string</info>  


id: Locale::composeLocale
type: function
doc:
<comment>Description:</comment>
  Returns a correctly ordered and delimited locale ID
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns a correctly ordered and delimited locale ID the keys identify the particular locale ID
  subtags, and the values are the associated subtag values.

<comment>Param:</comment>
  <info>array</info>  <strong>$subtags</strong>  an array containing a list of key-value pairs, where the keys identify the
                   particular locale ID subtags, and the values are the associated subtag values.
                   The 'variant' and 'private' subtags can take maximum 15 values whereas 'extlang'
                   can take maximum 3 values.e.g. Variants are allowed with the suffix ranging from
                   0-14. Hence the keys for the input array can be variant0, variant1,
                   ...,variant14. In the returned locale id, the subtag is ordered by suffix
                   resulting in variant0 followed by variant1 followed by variant2 and so on.  The
                   'variant', 'private' and 'extlang' multiple values can be specified both as array
                   under specific key (e.g. 'variant') and as multiple numbered keys (e.g.
                   'variant0', 'variant1', etc.).
                   
                   The 'variant' and 'private' subtags can take maximum 15 values whereas 'extlang'
                   can take maximum 3 values.e.g. Variants are allowed with the suffix ranging from
                   0-14. Hence the keys for the input array can be variant0, variant1,
                   ...,variant14. In the returned locale id, the subtag is ordered by suffix
                   resulting in variant0 followed by variant1 followed by variant2 and so on.
                   
                   The 'variant', 'private' and 'extlang' multiple values can be specified both as
                   array under specific key (e.g. 'variant') and as multiple numbered keys (e.g.
                   'variant0', 'variant1', etc.).

<comment>Return:</comment>
  <info>string</info>  The corresponding locale identifier.

<comment>See Also:</comment>
   * <strong>locale_parse()</strong>


id: Locale::filterMatches
type: function
doc:
<comment>Description:</comment>
  Checks if a language tag filter matches with locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Checks if a $langtag filter matches with $locale according to RFC 4647's basic filtering algorithm

<comment>Param:</comment>
  <info>string</info>  <strong>$langtag     </strong>  The language tag to check
  <info>string</info>  <strong>$locale      </strong>  The language range to check against
  <info>bool  </info>  <strong>$canonicalize</strong>  If true, the arguments will be converted to canonical form before matching.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if $locale matches $langtag <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>locale_lookup()</strong>


id: Locale::getAllVariants
type: function
doc:
<comment>Description:</comment>
  Gets the variants for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the variants for the input locale

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the variants from

<comment>Return:</comment>
  <info>array</info>  The <info>array</info> containing the list of all variants subtag for the locale  or <info>null</info> if not present

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_region()</strong>


id: Locale::getDefault
type: function
doc:
<comment>Description:</comment>
  Gets the default locale value from the INTL global 'default_locale'
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the default locale value. At the PHP initialization this value is set to
  'intl.default_locale' value from php.ini if that value exists or  from ICU's function
  uloc_getDefault().

<comment>Return:</comment>
  <info>string</info>  The current runtime locale

<comment>See Also:</comment>
   * <strong>locale_set_default()</strong>


id: Locale::getDisplayLanguage
type: function
doc:
<comment>Description:</comment>
  Returns an appropriately localized display name for language of the inputlocale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an appropriately localized display name for language of the input locale. If is <info>null</info> then
  the default locale is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale   </strong>  The locale to return a display language for
  <info>string</info>  <strong>$in_locale</strong>  Optional format locale to use to display the language name

<comment>Return:</comment>
  <info>string</info>  display name of the language for the $locale in the format appropriate for $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayName
type: function
doc:
<comment>Description:</comment>
  Returns an appropriately localized display name for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an appropriately localized display name for the input locale. If $locale is <info>null</info> then the
  default locale is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale   </strong>  The locale to return a display name for.
  <info>string</info>  <strong>$in_locale</strong>  optional format locale

<comment>Return:</comment>
  <info>string</info>  Display name of the locale in the format appropriate for $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayRegion
type: function
doc:
<comment>Description:</comment>
  Returns an appropriately localized display name for region of the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an appropriately localized display name for region of the input locale. If is <info>null</info> then
  the default locale is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale   </strong>  The locale to return a display region for.
  <info>string</info>  <strong>$in_locale</strong>  Optional format locale to use to display the region name

<comment>Return:</comment>
  <info>string</info>  display name of the region for the $locale in the format appropriate for $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayScript
type: function
doc:
<comment>Description:</comment>
  Returns an appropriately localized display name for script of the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an appropriately localized display name for script of the input locale. If is <info>null</info> then
  the default locale is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale   </strong>  The locale to return a display script for
  <info>string</info>  <strong>$in_locale</strong>  Optional format locale to use to display the script name

<comment>Return:</comment>
  <info>string</info>  Display name of the script for the $locale in the format appropriate for $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_region()</strong>
   * <strong>locale_get_display_variant()</strong>


id: Locale::getDisplayVariant
type: function
doc:
<comment>Description:</comment>
  Returns an appropriately localized display name for variants of the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns an appropriately localized display name for variants of the input locale. If is <info>null</info> then
  the default locale is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale   </strong>  The locale to return a display variant for
  <info>string</info>  <strong>$in_locale</strong>  Optional format locale to use to display the variant name

<comment>Return:</comment>
  <info>string</info>  Display name of the variant for the $locale in the format appropriate for $in_locale.

<comment>See Also:</comment>
   * <strong>locale_get_display_name()</strong>
   * <strong>locale_get_display_language()</strong>
   * <strong>locale_get_display_script()</strong>
   * <strong>locale_get_display_region()</strong>


id: Locale::getKeywords
type: function
doc:
<comment>Description:</comment>
  Gets the keywords for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the keywords for the input locale.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the keywords from

<comment>Return:</comment>
  <info>array</info>  Associative <info>array</info> containing the keyword-value pairs for this locale

<comment>See Also:</comment>
   * <strong>locale_get_all_variants()</strong>


id: Locale::getPrimaryLanguage
type: function
doc:
<comment>Description:</comment>
  Gets the primary language for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the primary language for the input locale

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the primary language code from

<comment>Return:</comment>
  <info>string</info>  The language code associated with the language or <info>null</info> in case of error.

<comment>See Also:</comment>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_region()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::getRegion
type: function
doc:
<comment>Description:</comment>
  Gets the region for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the region for the input locale.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the region code from

<comment>Return:</comment>
  <info>string</info>  The region subtag for the locale or <info>null</info> if not present

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_script()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::getScript
type: function
doc:
<comment>Description:</comment>
  Gets the script for the input locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Gets the script for the input locale.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the script code from

<comment>Return:</comment>
  <info>string</info>  The script subtag for the locale or <info>null</info> if not present

<comment>See Also:</comment>
   * <strong>locale_get_primary_language()</strong>
   * <strong>locale_get_region()</strong>
   * <strong>locale_get_all_variants()</strong>


id: Locale::lookup
type: function
doc:
<comment>Description:</comment>
  Searches the language tag list for the best match to the language
  
  Stil obiect-orientat
  
  Stil procedural
  
  Searches the items in <strong>$langtag</strong> for the best match to  the language range specified in <strong>$locale</strong>
  according to RFC 4647's lookup algorithm.

<comment>Param:</comment>
  <info>array </info>  <strong>$langtag     </strong>  An <info>array</info> containing a list of language tags to compare to  <strong>$locale</strong>. Maximum
                         100 items allowed.
  <info>string</info>  <strong>$locale      </strong>  The locale to use as the language range when matching.
  <info>bool  </info>  <strong>$canonicalize</strong>  If true, the arguments will be converted to canonical form before matching.
  <info>string</info>  <strong>$default     </strong>  The locale to use if no match is found.

<comment>Return:</comment>
  <info>string</info>  The closest matching language tag or default value.

<comment>See Also:</comment>
   * <strong>locale_filter_matches()</strong>


id: Locale::parseLocale
type: function
doc:
<comment>Description:</comment>
  Returns a key-value array of locale ID subtag elements
  
  Stil obiect-orientat
  
  Stil procedural
  
  Returns a key-value array of locale ID subtag elements.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  The locale to extract the subtag array from. Note: The 'variant' and 'private'
                   subtags can take maximum 15 values whereas 'extlang' can take maximum 3 values.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing a list of key-value pairs, where the keys identify the
         particular locale ID subtags, and the values are the associated subtag values. The array
         will be ordered as the locale id subtags e.g. in the locale id if variants are
         '-varX-varY-varZ' then the returned array will have variant0=&gt;varX , variant1=&gt;varY ,
         variant2=&gt;varZ
         
         Returns <info>null</info> when the length of <strong>$locale</strong> exceeds <info>INTL_MAX_LOCALE_LEN</info>.

<comment>See Also:</comment>
   * <strong>locale_compose()</strong>


id: Locale::setDefault
type: function
doc:
<comment>Description:</comment>
  Sets the default runtime locale
  
  Stil obiect-orientat
  
  Stil procedural
  
  Sets the default runtime locale to $locale. This changes the value of INTL global 'default_locale'
  locale identifier. UAX #35 extensions are accepted.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  Is a BCP 47 compliant language tag.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>locale_get_default()</strong>


id: Lua::__call
type: function
doc:
<comment>Description:</comment>
  Call Lua functions
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>callable</info>  <strong>$lua_func</strong>  Function name in lua
  <info>array   </info>  <strong>$args    </strong>  Arguments passed to the Lua function
  <info>int     </info>  <strong>$use_self</strong>  Whether to use <return>self</return>

<comment>Return:</comment>
  <info>mixed</info>  Returns result of the called function, <info>null</info> for wrong arguments or <info>false</info> on other failure.

<comment>See Also:</comment>
   * __call()


id: Lua::__construct
type: function
doc:
<comment>Description:</comment>
  Lua constructor
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$lua_script_file</strong>  


id: Lua::assign
type: function
doc:
<comment>Description:</comment>
  Assign a PHP variable to Lua
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>mixed</info>  Returns $this or <info>null</info> on failure.


id: Lua::eval
type: function
doc:
<comment>Description:</comment>
  Evaluate a string as Lua code
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$statements</strong>  

<comment>Return:</comment>
  <info>mixed</info>  Returns result of evaled code, <info>null</info> for wrong arguments or <info>false</info> on other failure.


id: Lua::getVersion
type: function
doc:
<comment>Description:</comment>
  The getversion purpose
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  Returns Lua::LUA_VERSION.


id: Lua::include
type: function
doc:
<comment>Description:</comment>
  Parse a Lua script file
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  

<comment>Return:</comment>
  <info>mixed</info>  Returns result of included code, <info>null</info> for wrong arguments or <info>false</info> on other failure.


id: Lua::registerCallback
type: function
doc:
<comment>Description:</comment>
  Register a PHP function to Lua
  
  Register a PHP function to Lua as a function named "$name"

<comment>Param:</comment>
  <info>string  </info>  <strong>$name    </strong>  
  <info>callable</info>  <strong>$function</strong>  A valid PHP function callback

<comment>Return:</comment>
  <info>mixed</info>  Returns $this, <info>null</info> for wrong arguments or <info>false</info> on other failure.


id: LuaClosure
type: class
doc:
<comment>Description:</comment>
  LuaClosure is a wrapper class for LUA_TFUNCTION which could be return from calling to Lua
  function.


id: LuaClosure::__invoke
type: function
doc:
<comment>Description:</comment>
  Invoke luaclosure
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  

<comment>Return:</comment>
  <info>void</info>  


id: LuaSandbox
type: class
doc:
<comment>Description:</comment>
  The LuaSandbox class creates a Lua environment and allows for execution of Lua code.


id: LuaSandbox::PERCENT
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in percentages of the total.


id: LuaSandbox::SAMPLES
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in samples.


id: LuaSandbox::SECONDS
type: constant
doc:
<comment>Description:</comment>
  Used with LuaSandbox::getProfilerFunctionReport to return timings in seconds.


id: LuaSandbox::callFunction
type: function
doc:
<comment>Description:</comment>
  Call a function in a Lua global variable
  
  Calls a function in a Lua global variable.
  
  If the name contains "." characters, the function is located via recursive table accesses, as if
  the name were a Lua expression.
  
  If the variable does not exist, or is not a function, false will be returned and a warning issued.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Lua variable name.
  <info>mixed </info>  <strong>$args</strong>  Arguments to the function.

<comment>Return:</comment>
  <info>arraybool</info>  Returns an <info>array</info> of values returned by the Lua function, which may be empty, or <return>false</return>
             in case of failure.


id: LuaSandbox::disableProfiler
type: function
doc:
<comment>Description:</comment>
  Disable the profiler
  
  Disables the profiler.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LuaSandbox::enableProfiler
   * LuaSandbox::getProfilerFunctionReport


id: LuaSandbox::enableProfiler
type: function
doc:
<comment>Description:</comment>
  Enable the profiler.
  
  Enables the profiler. Profiling will begin when Lua code is entered.
  
  The profiler periodically samples the Lua environment to record the running function. Testing
  indicates that at least on Linux, setting a period less than 1ms will lead to a high overrun count
  but no performance problems.

<comment>Param:</comment>
  <info>float</info>  <strong>$period</strong>  Sampling period in seconds.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean indicating whether the profiler is enabled.

<comment>See Also:</comment>
   * LuaSandbox::disableProfiler
   * LuaSandbox::getProfilerFunctionReport


id: LuaSandbox::getCPUUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the current CPU time usage of the Lua environment
  
  Fetches the current CPU time usage of the Lua environment.
  
  This includes time spent in PHP callbacks.

<comment>Return:</comment>
  <info>float</info>  Returns the current CPU time usage in seconds.
         
         On Windows, this function always returns zero. On operating systems that do not support
         <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, this function will return the
         elapsed wall-clock time, not CPU time.

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::setCPULimit


id: LuaSandbox::getMemoryUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the current memory usage of the Lua environment
  
  Fetches the current memory usage of the Lua environment.

<comment>Return:</comment>
  <info>int</info>  Returns the current memory usage in bytes.

<comment>See Also:</comment>
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::getPeakMemoryUsage
type: function
doc:
<comment>Description:</comment>
  Fetch the peak memory usage of the Lua environment
  
  Fetches the peak memory usage of the Lua environment.

<comment>Return:</comment>
  <info>int</info>  Returns the peak memory usage in bytes.

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::getProfilerFunctionReport
type: function
doc:
<comment>Description:</comment>
  Fetch profiler data
  
  For a profiling instance previously started by LuaSandbox::enableProfiler, get a report of the
  cost of each function.
  
  The measurement unit used for the cost is determined by the $units parameter:
  
  <info>LuaSandbox::SAMPLES</info>Measure in number of samples.<info>LuaSandbox::SECONDS</info>Measure in seconds of CPU
  time.<info>LuaSandbox::PERCENT</info>Measure percentage of CPU time.
  
  Measure in number of samples.
  
  Measure in seconds of CPU time.
  
  Measure percentage of CPU time.

<comment>Param:</comment>
  <info>int</info>  <strong>$units</strong>  Measurement unit constant.

<comment>Return:</comment>
  <info>array</info>  Returns profiler measurements, sorted in descending order, as an associative <info>array</info>. Keys
         are the Lua function names (with source file and line defined in angle brackets), values
         are the measurements as <info>int</info> or <info>float</info>.
         
         On Windows, this function always returns an empty array. On operating systems that do not
         support <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, this function will report
         the elapsed wall-clock time, not CPU time.


id: LuaSandbox::getVersionInfo
type: function
doc:
<comment>Description:</comment>
  Return the versions of LuaSandbox and Lua
  
  Returns the versions of LuaSandbox and Lua.

<comment>Return:</comment>
  <info>array</info>  Returns an array with two keys:
         
         elementtypedescriptionLuaSandbox<info>string</info>The version of the LuaSandbox extension.Lua<info>string</info>The
         library name and version as defined by the LUA_RELEASE macro, for example, "Lua 5.1.5".


id: LuaSandbox::loadBinary
type: function
doc:
<comment>Description:</comment>
  Load a precompiled binary chunk into the Lua environment
  
  Loads data generated by LuaSandboxFunction::dump.

<comment>Param:</comment>
  <info>string</info>  <strong>$code     </strong>  Data from LuaSandboxFunction::dump.
  <info>string</info>  <strong>$chunkName</strong>  Name for the loaded function.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class>.

<comment>See Also:</comment>
   * LuaSandbox::loadString


id: LuaSandbox::loadString
type: function
doc:
<comment>Description:</comment>
  Load Lua code into the Lua environment
  
  Loads Lua code into the Lua environment.
  
  This is the equivalent of standard Lua's <return>loadstring()</return> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$code     </strong>  Lua code.
  <info>string</info>  <strong>$chunkName</strong>  Name for the loaded chunk, for use in error traces.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class> which, when executed, will execute the passed
                      $code.

<comment>See Also:</comment>
   * LuaSandbox::registerLibrary
   * LuaSandbox::wrapPhpFunction


id: LuaSandbox::pauseUsageTimer
type: function
doc:
<comment>Description:</comment>
  Pause the CPU usage timer
  
  Pauses the CPU usage timer.
  
  This only has effect when called from within a callback from Lua. When execution returns to Lua,
  the timer will be automatically unpaused. If a new call into Lua is made, the timer will be
  unpaused for the duration of that call.
  
  If a PHP callback calls into Lua again with timer not paused, and then that Lua function calls
  into PHP again, the second PHP call will not be able to pause the timer. The logic is that even
  though the second PHP call would avoid counting the CPU usage against the limit, the first call
  still counts it.

<comment>Return:</comment>
  <info>bool</info>  Returns a <info>bool</info> indicating whether the timer is now paused.

<comment>See Also:</comment>
   * LuaSandbox::setCPULimit
   * LuaSandbox::unpauseUsageTimer


id: LuaSandbox::registerLibrary
type: function
doc:
<comment>Description:</comment>
  Register a set of PHP functions as a Lua library
  
  Registers a set of PHP functions as a Lua library, so that Lua can call the relevant PHP code.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>string</info>  <strong>$libname  </strong>  The name of the library. In the Lua state, the global variable of this name
                      will be set to the table of functions. If the table already exists, the new
                      functions will be added to it.
  <info>array </info>  <strong>$functions</strong>  An <info>array</info>, where each key is a function name, and each value is a corresponding
                      PHP <info>callable</info>.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LuaSandbox::loadString
   * LuaSandbox::wrapPhpFunction


id: LuaSandbox::setCPULimit
type: function
doc:
<comment>Description:</comment>
  Set the CPU time limit for the Lua environment
  
  Sets the CPU time limit for the Lua environment.
  
  If the total user and system time used by the environment after the call to this method exceeds
  this limit, a <class>LuaSandboxTimeoutError</class> exception is thrown.
  
  Time used in PHP callbacks is included in the limit.
  
  Setting the time limit from a callback while Lua is running causes the timer to be reset, or
  started if it was not already running.
  
  On Windows, the CPU limit will be ignored. On operating systems that do not support
  <info>CLOCK_THREAD_CPUTIME_ID</info>, such as FreeBSD and Mac OS X, wall-clock time rather than CPU time will
  be limited.

<comment>Param:</comment>
  <info>floatbool</info>  <strong>$limit</strong>  Limit as a <info>float</info> in seconds, or <return>false</return> for no limit.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LuaSandbox::getCPUUsage
   * LuaSandbox::setMemoryLimit


id: LuaSandbox::setMemoryLimit
type: function
doc:
<comment>Description:</comment>
  Set the memory limit for the Lua environment
  
  Sets the memory limit for the Lua environment.
  
  If this limit is exceeded, a <class>LuaSandboxMemoryError</class> exception is thrown.

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  Memory limit in bytes.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LuaSandbox::getMemoryUsage
   * LuaSandbox::getPeakMemoryUsage
   * LuaSandbox::setCPULimit


id: LuaSandbox::unpauseUsageTimer
type: function
doc:
<comment>Description:</comment>
  Unpause the timer paused by LuaSandbox::pauseUsageTimer
  
  Unpauses the timer paused by LuaSandbox::pauseUsageTimer.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * LuaSandbox::pauseUsageTimer
   * LuaSandbox::setCPULimit


id: LuaSandbox::wrapPhpFunction
type: function
doc:
<comment>Description:</comment>
  Wrap a PHP callable in a LuaSandboxFunction
  
  Wraps a PHP callable in a <class>LuaSandboxFunction</class>, so it can be passed into Lua as an anonymous
  function.
  
  The function must return either an array of values (which may be empty), or <info>null</info> which is
  equivalent to returning the empty array.
  
  Exceptions will be raised as errors in Lua, however only <class>LuaSandboxRuntimeError</class> exceptions may be
  caught inside Lua with <return>pcall()</return> or <return>xpcall()</return>.
  
  For more information about calling Lua functions and the return values, see
  LuaSandboxFunction::call.

<comment>Param:</comment>
  <info>callable</info>  <strong>$function</strong>  Callable to wrap.

<comment>Return:</comment>
  <info>LuaSandboxFunction</info>  Returns a <class>LuaSandboxFunction</class>.

<comment>See Also:</comment>
   * LuaSandbox::loadString
   * LuaSandbox::registerLibrary


id: LuaSandboxErrorError
type: class
doc:
<comment>Description:</comment>
  Exception thrown when Lua encounters an error inside an error handler.


id: LuaSandboxFatalError
type: class
doc:
<comment>Description:</comment>
  Uncatchable LuaSandbox exceptions.
  
  These may not be caught inside Lua using <return>pcall()</return> or <return>xpcall()</return>.


id: LuaSandboxFunction
type: class
doc:
<comment>Description:</comment>
  Represents a Lua function, allowing it to be called from PHP.
  
  A LuaSandboxFunction may be obtained as a return value from Lua, as a parameter passed to a
  callback from Lua, or by using LuaSandbox::wrapPhpFunction, LuaSandbox::loadString, or
  LuaSandbox::loadBinary.


id: LuaSandboxFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Unused
  
  <class>LuaSandboxFunction</class> are obtained as a return value from Lua, as a parameter passed to a callback
  from Lua, or by using LuaSandbox::wrapPhpFunction, LuaSandbox::loadString, or
  LuaSandbox::loadBinary. They cannot be constructed directly.


id: LuaSandboxFunction::call
type: function
doc:
<comment>Description:</comment>
  Call a Lua function
  
  Calls a Lua function.
  
  Errors considered to be the fault of the PHP code will result in the function returning <return>false</return> and
  <info>E_WARNING</info> being raised, for example, a <info>resource</info> type being used as an argument. Lua errors will
  result in a <class>LuaSandboxRuntimeError</class> exception being thrown.
  
  PHP and Lua types are converted as follows:
  
  PHP <info>null</info> is Lua <return>nil</return>, and vice versa. PHP <info>int</info>s and <info>float</info>s are converted to Lua numbers. Infinity
  and <info>NAN</info> are supported.  Lua numbers without a fractional part between approximately <return>-2**53</return> and
  <return>2**53</return> are converted to PHP <info>int</info>s, with others being converted to PHP <info>float</info>s. PHP <info>bool</info>s are Lua
  booleans, and vice versa.PHP <info>string</info>s are Lua strings, and vice versa. Lua functions are PHP
  <class>LuaSandboxFunction</class> objects, and vice versa. General PHP <info>callable</info>s are not supported.  PHP <info>array</info>s
  are converted to Lua tables, and vice versa.  Note that Lua typically indexes arrays from 1, while
  PHP indexes arrays from 0. No adjustment is made for these differing conventions. Self-referential
  arrays are not supported in either direction.PHP references are dereferenced. Lua <return>__pairs</return> and
  <return>__ipairs</return> are processed. <return>__index</return> is ignored.  When converting from PHP to Lua, integer keys between
  <return>-2**53</return> and <return>2**53</return> are represented as Lua numbers. All other keys are represented as Lua strings.
  When converting from Lua to PHP, keys other than strings and numbers will result in an error, as
  will collisions when converting numbers to strings or vice versa (since PHP considers things like
  <return>$a[0]</return> and <return>$a["0"]</return> as being equivalent).  All other types are unsupported and will raise an
  error/exception, including general PHP <info>object</info>s and Lua userdata and thread types.
  
  PHP <info>null</info> is Lua <return>nil</return>, and vice versa.
  
  PHP <info>int</info>s and <info>float</info>s are converted to Lua numbers. Infinity and <info>NAN</info> are supported.
  
  Lua numbers without a fractional part between approximately <return>-2**53</return> and <return>2**53</return> are converted to PHP
  <info>int</info>s, with others being converted to PHP <info>float</info>s.
  
  PHP <info>bool</info>s are Lua booleans, and vice versa.
  
  PHP <info>string</info>s are Lua strings, and vice versa.
  
  Lua functions are PHP <class>LuaSandboxFunction</class> objects, and vice versa. General PHP <info>callable</info>s are not
  supported.
  
  PHP <info>array</info>s are converted to Lua tables, and vice versa.
  
   Note that Lua typically indexes arrays from 1, while PHP indexes arrays from 0. No adjustment is
  made for these differing conventions. Self-referential arrays are not supported in either
  direction.PHP references are dereferenced. Lua <return>__pairs</return> and <return>__ipairs</return> are processed. <return>__index</return> is
  ignored.  When converting from PHP to Lua, integer keys between <return>-2**53</return> and <return>2**53</return> are represented
  as Lua numbers. All other keys are represented as Lua strings.  When converting from Lua to PHP,
  keys other than strings and numbers will result in an error, as will collisions when converting
  numbers to strings or vice versa (since PHP considers things like <return>$a[0]</return> and <return>$a["0"]</return> as being
  equivalent).
  
  Note that Lua typically indexes arrays from 1, while PHP indexes arrays from 0. No adjustment is
  made for these differing conventions.
  
  Self-referential arrays are not supported in either direction.
  
  PHP references are dereferenced.
  
  Lua <return>__pairs</return> and <return>__ipairs</return> are processed. <return>__index</return> is ignored.
  
  When converting from PHP to Lua, integer keys between <return>-2**53</return> and <return>2**53</return> are represented as Lua
  numbers. All other keys are represented as Lua strings.
  
  When converting from Lua to PHP, keys other than strings and numbers will result in an error, as
  will collisions when converting numbers to strings or vice versa (since PHP considers things like
  <return>$a[0]</return> and <return>$a["0"]</return> as being equivalent).
  
  All other types are unsupported and will raise an error/exception, including general PHP <info>object</info>s
  and Lua userdata and thread types.
  
  Lua functions inherently return a list of results. So on success, this method returns an <info>array</info>
  containing all of the values returned by Lua, with <info>int</info> keys starting from zero. Lua may return no
  results, in which case an empty array is returned.

<comment>Param:</comment>
  <info>string</info>  <strong>$args</strong>  Arguments passed to the function.

<comment>Return:</comment>
  <info>arraybool</info>  Returns an <info>array</info> of values returned by the function, which may be empty, or <return>false</return> on
             error.


id: LuaSandboxFunction::dump
type: function
doc:
<comment>Description:</comment>
  Dump the function as a binary blob
  
  Dumps the function as a binary blob.

<comment>Return:</comment>
  <info>string</info>  Returns a string that may be passed to LuaSandbox::loadBinary.


id: LuaSandboxRuntimeError
type: class
doc:
<comment>Description:</comment>
  Catchable LuaSandbox runtime exceptions.
  
  These may be caught inside Lua using <return>pcall()</return> or <return>xpcall()</return>.


id: MB_CASE_FOLD
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie deplină a caracterelor minuscule și majuscule, ceea ce elimină distincțiile
  caracterelor prezente în șir. Aceasta se folosește pentru potrivirea caracterelor indiferent de
  tipul lor (minuscule sau majuscule). Aceasta poate modifica lungimea șirului de caractere.
  Disponibilă începând cu PHP 7.3.


id: MB_CASE_FOLD_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie simplă a caracterelor minuscule și majuscule, ceea ce elimină distincțiile
  caracterelor prezente în șir. Aceasta se folosește pentru potrivirea caracterelor indiferent de
  tipul lor (minuscule sau majuscule). Aceasta nu modifică lungimea șirului de caractere. Utilizată
  intern de extensia MBString la operațiuni insensibile la litere minuscule sau majuscule.
  Disponibilă începând cu PHP 7.3.


id: MB_CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  Efectuează un transfer deplin la litere minuscule. Aceasta poate modifica lungimea șirului de
  caractere. Acesta e modul utilizat de mb_strtolower().


id: MB_CASE_LOWER_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie simplă în caractere minuscule. Aceasta nu modifică lungimea șirului de
  caractere. Disponibilă începând cu PHP 7.3.


id: MB_CASE_TITLE
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie deplină de tip "title-case" bazată pe proprietățile Unicode derivate Cased
  și CaseIgnorable. În particular aceasta îmbunătățește lucrul cu apostroafele. Aceasta poate
  modifica lungimea șirului de caractere.


id: MB_CASE_TITLE_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie simplă de tip "title-case". Aceasta nu modifică lungimea șirului de
  caractere. Disponibilă începând cu PHP 7.3.


id: MB_CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  Efectuează un transfer deplin la litere majuscule. Aceasta poate modifica lungimea șirului de
  caractere. Acesta e modul utilizat de mb_strtoupper().


id: MB_CASE_UPPER_SIMPLE
type: constant
doc:
<comment>Description:</comment>
  Efectuează o conversie simplă în caractere majuscule. Aceasta nu modifică lungimea șirului de
  caractere. Disponibilă începând cu PHP 7.3.


id: MB_ONIGURUMA_VERSION
type: constant
doc:
<comment>Description:</comment>
  Versiunea Oniguruma, de ex. <return>6.9.4</return>. Disponibilă începând cu PHP 7.4.


id: MK_E_UNAVAILABLE
type: constant
doc:
<comment>Description:</comment>
  -2147221021
  
  iMoniker COM status code, return on errors where the function call  failed due to unavailability.
  
  As of PHP 7.0.0, the value is <return>2147746275</return> on x64.


id: MYSQLND_MEMCACHE_DEFAULT_REGEXP
type: constant
doc:
<comment>Description:</comment>
  Default regular expression (PCRE style) used for matching <return>SELECT</return> statements that will be mapped
  into a MySQL Memcache Plugin access point, if possible.
  
  It is also possible to use <strong>mysqlnd_memcache_set()</strong>, but the default approach is using this regular
  expression for pattern matching.


id: MYSQLND_MS_LAST_USED_SWITCH
type: constant
doc:
<comment>Description:</comment>
  SQL hint used to send a query to the last used MySQL server. The last used MySQL server can either
  be a master or a slave server in a MySQL replication setup.


id: MYSQLND_MS_MASTER_SWITCH
type: constant
doc:
<comment>Description:</comment>
  SQL hint used to send a query to the MySQL replication master server.


id: MYSQLND_MS_QOS_CONSISTENCY_EVENTUAL
type: constant
doc:
<comment>Description:</comment>
  Use to request the service level eventual consistency from the <strong>mysqlnd_ms_set_qos()</strong>. Eventual
  consistency is the default quality of service when reading from an asynchronous MySQL replication
  slave. Data returned in this service level may or may not be stale, depending on whether the
  selected slaves happen to have replicated the latest changes from the MySQL replication master or
  not.


id: MYSQLND_MS_QOS_CONSISTENCY_SESSION
type: constant
doc:
<comment>Description:</comment>
  Use to request the service level session consistency from the <strong>mysqlnd_ms_set_qos()</strong>. Session
  consistency is defined as read your writes. The client is guaranteed to see his latest changes.


id: MYSQLND_MS_QOS_CONSISTENCY_STRONG
type: constant
doc:
<comment>Description:</comment>
  Use to request the service level strong consistency from the <strong>mysqlnd_ms_set_qos()</strong>. Strong
  consistency is used to ensure all clients see each others changes.


id: MYSQLND_MS_QOS_OPTION_AGE
type: constant
doc:
<comment>Description:</comment>
  Used as a service level option with <strong>mysqlnd_ms_set_qos()</strong> to parameterize eventual consistency.


id: MYSQLND_MS_QOS_OPTION_GTID
type: constant
doc:
<comment>Description:</comment>
  Used as a service level option with <strong>mysqlnd_ms_set_qos()</strong> to parameterize session consistency.


id: MYSQLND_MS_QUERY_USE_LAST_USED
type: constant
doc:
<comment>Description:</comment>
  If <strong>mysqlnd_ms_is_select()</strong> returns <info>MYSQLND_MS_QUERY_USE_LAST_USED</info> for a given query, the built-in
  read/write split mechanism recommends sending the query to the last used server.


id: MYSQLND_MS_QUERY_USE_MASTER
type: constant
doc:
<comment>Description:</comment>
  If <strong>mysqlnd_ms_is_select()</strong> returns <info>MYSQLND_MS_QUERY_USE_MASTER</info> for a given query, the built-in
  read/write split mechanism recommends sending the query to a MySQL replication master server.


id: MYSQLND_MS_QUERY_USE_SLAVE
type: constant
doc:
<comment>Description:</comment>
  If <strong>mysqlnd_ms_is_select()</strong> returns <info>MYSQLND_MS_QUERY_USE_SLAVE</info> for a given query, the built-in
  read/write split mechanism recommends sending the query to a MySQL replication slave server.


id: MYSQLND_MS_SLAVE_SWITCH
type: constant
doc:
<comment>Description:</comment>
  SQL hint used to send a query to one of the MySQL replication slave servers.


id: MYSQLND_QC_CONDITION_META_SCHEMA_PATTERN
type: constant
doc:
<comment>Description:</comment>
  Used as a parameter of <strong>mysqlnd_qc_set_cache_condition()</strong> to set conditions for schema based
  automatic caching.


id: MYSQLND_QC_DISABLE_SWITCH
type: constant
doc:
<comment>Description:</comment>
  SQL hint used to disable caching of a query if <return>mysqlnd_qc.cache_by_default = 1</return>.


id: MYSQLND_QC_SERVER_ID_SWITCH
type: constant
doc:
<comment>Description:</comment>
  This SQL hint should not be used in general.
  
  It is needed by PECL/mysqlnd_ms to group cache entries for one statement but originating from
  different physical connections. If the hint is used connection settings such as user, hostname and
  charset are not considered for generating a cache key of a query. Instead the given value and the
  query string are used as input to the hashing function that generates the key.
  
  PECL/mysqlnd_ms may, if instructed, cache results from MySQL Replication slaves. Because it can
  hold many connections to the slave the cache key shall not be formed from the user, hostname or
  other settings that may vary for the various slave connections. Instead, PECL/mysqlnd_ms provides
  an identifier which refers to the group of slave connections that shall be enabled to share cache
  entries no matter which physical slave connection was to generate the cache entry.
  
  Use of this feature outside of PECL/mysqlnd_ms is not recommended.


id: MYSQLND_UH_MYSQLND_CLOSE_LAST
type: constant
doc:
<comment>Description:</comment>
  No practical meaning. Last entry marker of internal C data structure list.


id: MYSQLND_UH_MYSQLND_OPT_INT_AND_FLOAT_NATIVE
type: constant
doc:
<comment>Description:</comment>
  Option: make mysqlnd return integer and float columns as long even when using the MySQL Client
  Server text protocol. Only available with a custom build of mysqlnd.


id: MYSQLND_UH_MYSQLND_OPT_LOCAL_INFILE
type: constant
doc:
<comment>Description:</comment>
  Option: Whether to allow <return>LOAD DATA LOCAL INFILE</return> use.


id: MYSQLND_UH_MYSQLND_OPT_MAX_ALLOWED_PACKET
type: constant
doc:
<comment>Description:</comment>
  Option: maximum allowed packet size. Available as of <return>PHP 5.4.0</return>.


id: MYSQL_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Coloanele sunt întoarse într-un tablou având în calitate de indice denumirea câmpului.


id: MYSQL_BOTH
type: constant
doc:
<comment>Description:</comment>
  Coloanele sunt întoarse într-un tablou având atât un indice numeric, cât și denumirea câmpului în
  calitate de indice.


id: MYSQL_CLIENT_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  Permite o inactivitate cu durata de interactive_timeout secunde (în loc de wait_timeout) înainte
  de a închide conexiunea.


id: MYSQL_CLIENT_SSL
type: constant
doc:
<comment>Description:</comment>
  Utilizează criptarea SSL. Acest fanion este disponibil numai începând cu versiunea 4.x sau
  ulterioară a bibliotecii-client MySQL. Versiunea 3.23.x este inclusă atât în PHP 4, cât și în
  binarele Windows ale PHP 5.


id: MYSQL_NUM
type: constant
doc:
<comment>Description:</comment>
  Coloanele sunt întoarse într-un tablou având un indice numeric către câmpuri. Acest indice începe
  cu 0, primul câmp din rezultat.


id: Memcache::add
type: function
doc:
<comment>Description:</comment>
  Add an item to the server
  
  <strong>Memcache::add()</strong> stores variable <strong>$var</strong> with <strong>$key</strong> only if such  key doesn't exist at the server yet.
  Also you can use <strong>memcache_add()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  The key that will be associated with the item.
  <info>mixed </info>  <strong>$var   </strong>  The variable to store. Strings and integers are stored as is, other types are
                   stored serialized.
  <info>int   </info>  <strong>$flag  </strong>  Use <info>MEMCACHE_COMPRESSED</info> to store the item compressed (uses zlib).
  <info>int   </info>  <strong>$expire</strong>  Expiration time of the item. If it's equal to zero, the item will never expire.
                   You can also use Unix timestamp or a number of seconds starting from current
                   time, but in the latter case the number of seconds may not exceed 2592000 (30
                   days).

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Returns <info>false</info> if such key already exist. For the
        rest <strong>Memcache::add()</strong> behaves similarly to <strong>Memcache::set()</strong>.

<comment>See Also:</comment>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::addServer
type: function
doc:
<comment>Description:</comment>
  Add a memcached server to connection pool
  
  <strong>Memcache::addServer()</strong> adds a server to the connection pool.  You can also use the
  <strong>memcache_add_server()</strong> function.
  
  When using this method (as opposed to <strong>Memcache::connect()</strong> and  <strong>Memcache::pconnect()</strong>) the network
  connection is not established  until actually needed. Thus there is no overhead in adding a large
  number of servers  to the pool, even though they might not all be used.
  
  Failover may occur at any stage in any of the methods, as long as other  servers are available the
  request the user won't notice. Any kind of  socket or Memcached server level errors (except
  out-of-memory) may trigger  the failover. Normal client errors such as adding an existing key will
  not  trigger a failover.
  
  This function has been added to Memcache version 2.0.0.

<comment>Param:</comment>
  <info>string  </info>  <strong>$host            </strong>  Point to the host where memcached is listening for connections. This
                               parameter may also specify other transports like
                               <return>unix:///path/to/memcached.sock</return> to use UNIX domain sockets, in this
                               case <strong>$port</strong> must also be set to <return>0</return>.
  <info>int     </info>  <strong>$port            </strong>  Point to the port where memcached is listening for connections. Set
                               this parameter to <return>0</return> when using UNIX domain sockets.
                               
                               Please note: <strong>$port</strong> defaults to memcache.default_port if not
                               specified. For this reason it is wise to specify the port explicitly
                               in this method call.
  <info>bool    </info>  <strong>$persistent      </strong>  Controls the use of a persistent connection. Default to <info>true</info>.
  <info>int     </info>  <strong>$weight          </strong>  Number of buckets to create for this server which in turn control its
                               probability of it being selected. The probability is relative to the
                               total weight of all servers.
  <info>int     </info>  <strong>$timeout         </strong>  Value in seconds which will be used for connecting to the daemon.
                               Think twice before changing the default value of 1 second - you can
                               lose all the advantages of caching if your connection is too slow.
  <info>int     </info>  <strong>$retry_interval  </strong>  Controls how often a failed server will be retried, the default value
                               is 15 seconds. Setting this parameter to -1 disables automatic retry.
                               Neither this nor the <strong>$persistent</strong> parameter has any  effect when the
                               extension is loaded dynamically via <strong>dl()</strong>.
                               
                               Each failed connection struct has its own timeout and before it has
                               expired  the struct will be skipped when selecting backends to serve
                               a request. Once  expired the connection will be successfully
                               reconnected or marked as failed  for another <strong>$retry_interval</strong> seconds.
                               The typical  effect is that each web server child will retry the
                               connection about every <strong>$retry_interval</strong> seconds when serving a page.
  <info>bool    </info>  <strong>$status          </strong>  Controls if the server should be flagged as online. Setting this
                               parameter to <info>false</info> and <strong>$retry_interval</strong> to -1 allows a failed  server
                               to be kept in the pool so as not to affect the key distribution
                               algorithm. Requests for this server will then failover or fail
                               immediately  depending on the <strong>$memcache.allow_failover</strong> setting.
                               Default to <info>true</info>, meaning the server should be considered online.
  <info>callable</info>  <strong>$failure_callback</strong>  Allows the user to specify a callback function to run upon
                               encountering an  error. The callback is run before failover is
                               attempted. The function takes  two parameters, the hostname and port
                               of the failed server.
  <info>int     </info>  <strong>$timeoutms       </strong>  

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::connect()</strong>
   * <strong>Memcache::pconnect()</strong>
   * <strong>Memcache::close()</strong>
   * <strong>Memcache::setServerParams()</strong>
   * <strong>Memcache::getServerStatus()</strong>


id: Memcache::close
type: function
doc:
<comment>Description:</comment>
  Close memcached server connection
  
  <strong>Memcache::close()</strong> closes connection to memcached server. This function doesn't close persistent
  connections, which are closed only during web-server shutdown/restart. Also you can use
  <strong>memcache_close()</strong> function.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::connect()</strong>
   * <strong>Memcache::pconnect()</strong>


id: Memcache::connect
type: function
doc:
<comment>Description:</comment>
  Open memcached server connection
  
  <strong>Memcache::connect()</strong> establishes a connection to the memcached server. The connection, which was
  opened using <strong>Memcache::connect()</strong> will be automatically closed at the end of script execution. Also
  you can close it with <strong>Memcache::close()</strong>. Also you can use <strong>memcache_connect()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$host   </strong>  Point to the host where memcached is listening for connections. This parameter
                    may also specify other transports like <return>unix:///path/to/memcached.sock</return> to use
                    UNIX domain sockets, in this case <strong>$port</strong> must also be set to <return>0</return>.
  <info>int   </info>  <strong>$port   </strong>  Point to the port where memcached is listening for connections. Set this
                    parameter to <return>0</return> when using UNIX domain sockets.
                    
                    Please note: <strong>$port</strong> defaults to memcache.default_port if not specified. For this
                    reason it is wise to specify the port explicitly in this method call.
  <info>int   </info>  <strong>$timeout</strong>  Value in seconds which will be used for connecting to the daemon. Think twice
                    before changing the default value of 1 second - you can lose all the advantages
                    of caching if your connection is too slow.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::pconnect()</strong>
   * <strong>Memcache::close()</strong>


id: Memcache::decrement
type: function
doc:
<comment>Description:</comment>
  Decrement item's value
  
  <strong>Memcache::decrement()</strong> decrements value of the  item by <strong>$value</strong>. Similarly to
  <strong>Memcache::increment()</strong>, current value of the item is being converted to numerical and after that
  <strong>$value</strong> is subtracted.   New item's value will not be less than zero.   Do not use
  <strong>Memcache::decrement()</strong> with item, which was stored compressed, because consequent call to
  <strong>Memcache::get()</strong> will fail.  <strong>Memcache::decrement()</strong> does not create an item if it didn't exist. Also
  you can use <strong>memcache_decrement()</strong> function.
  
  New item's value will not be less than zero.
  
  Do not use <strong>Memcache::decrement()</strong> with item, which was stored compressed, because consequent call
  to  <strong>Memcache::get()</strong> will fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  Key of the item do decrement.
  <info>int   </info>  <strong>$value</strong>  Decrement the item by <strong>$value</strong>.

<comment>Return:</comment>
  <info>intfalse</info>  Returns item's new value on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::increment()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::delete
type: function
doc:
<comment>Description:</comment>
  Delete item from the server
  
  <strong>Memcache::delete()</strong> deletes an item with the <strong>$key</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The key associated with the item to delete.
  <info>int   </info>  <strong>$timeout</strong>  This deprecated parameter is not supported, and defaults to <return>0</return> seconds. Do not
                    use this parameter.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::flush
type: function
doc:
<comment>Description:</comment>
  Flush all existing items at the server
  
  <strong>Memcache::flush()</strong> immediately invalidates all  existing items. <strong>Memcache::flush()</strong> doesn't actually
  free any resources, it only marks all the items as expired, so occupied memory will be overwritten
  by new items. Also you can use <strong>memcache_flush()</strong> function.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: Memcache::get
type: function
doc:
<comment>Description:</comment>
  Retrieve item from the server
  
  <strong>Memcache::get()</strong> returns previously stored data of an item, if such <strong>$key</strong> exists on the server at
  this moment.
  
  You can pass array of keys to <strong>Memcache::get()</strong> to get array of values. The result array will
  contain only found key-value pairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  The key or array of keys to fetch.
  <info>int   </info>  <strong>$flags</strong>  If present, flags fetched along with the values will be written to this parameter.
                  These flags are the same as the ones given to for example <strong>Memcache::set()</strong>. The
                  lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to
                  indicate compression and serialization status).

<comment>Return:</comment>
  <info>string</info>  Returns the value associated with the <strong>$key</strong> or an array of found key-value pairs when <strong>$key</strong>
          is an <info>array</info>. Returns <info>false</info> on failure, <strong>$key</strong> is not found or <strong>$key</strong> is an empty <info>array</info>.


id: Memcache::getExtendedStats
type: function
doc:
<comment>Description:</comment>
  Get statistics from all servers in pool
  
  <strong>Memcache::getExtendedStats()</strong> returns a two-dimensional associative array with server statistics.
  Array keys correspond to  host:port of server and values contain the individual server statistics.
  A failed server will have its corresponding entry set to <info>false</info>. You can also use the
  <strong>memcache_get_extended_stats()</strong> function.
  
  This function has been added to Memcache version 2.0.0.

<comment>Param:</comment>
  <info>string</info>  <strong>$type  </strong>  The type of statistics to fetch. Valid values are {reset,  malloc, maps,
                   cachedump, slabs, items, sizes}. According to the memcached protocol spec these
                   additional arguments "are  subject to change for the convenience of memcache
                   developers".
  <info>int   </info>  <strong>$slabid</strong>  Used in conjunction with <strong>$type</strong> set to  cachedump to identify the slab to dump
                   from. The cachedump command ties up the server and is strictly to be used for
                   debugging purposes.
  <info>int   </info>  <strong>$limit </strong>  Used in conjunction with <strong>$type</strong> set to  cachedump to limit the number of entries
                   to dump.

<comment>Return:</comment>
  <info>array</info>  Returns a two-dimensional associative array of server statistics or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>Memcache::getVersion()</strong>
   * <strong>Memcache::getStats()</strong>


id: Memcache::getServerStatus
type: function
doc:
<comment>Description:</comment>
  Returns server status
  
  <strong>Memcache::getServerStatus()</strong> returns a the servers  online/offline status. You can also use
  <strong>memcache_get_server_status()</strong>  function.
  
  This function has been added to Memcache version 2.1.0.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Point to the host where memcached is listening for connections.
  <info>int   </info>  <strong>$port</strong>  Point to the port where memcached is listening for connections.

<comment>Return:</comment>
  <info>int</info>  Returns a the servers status. 0 if server is failed, non-zero otherwise

<comment>See Also:</comment>
   * <strong>Memcache::addServer()</strong>
   * <strong>Memcache::setServerParams()</strong>


id: Memcache::getStats
type: function
doc:
<comment>Description:</comment>
  Get statistics of the server
  
  <strong>Memcache::getStats()</strong> returns an associative array  with server's statistics. Array keys correspond
  to stats parameters and  values to parameter's values. Also you can use <strong>memcache_get_stats()</strong>
  function.

<comment>Param:</comment>
  <info>string</info>  <strong>$type  </strong>  The type of statistics to fetch. Valid values are {reset,  malloc, maps,
                   cachedump, slabs, items, sizes}. According to the memcached protocol spec these
                   additional arguments "are  subject to change for the convenience of memcache
                   developers".
  <info>int   </info>  <strong>$slabid</strong>  Used in conjunction with <strong>$type</strong> set to  cachedump to identify the slab to dump
                   from. The cachedump command ties up the server and is strictly to be used for
                   debugging purposes.
  <info>int   </info>  <strong>$limit </strong>  Used in conjunction with <strong>$type</strong> set to  cachedump to limit the number of entries
                   to dump.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an associative array of server statistics sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::getVersion()</strong>
   * <strong>Memcache::getExtendedStats()</strong>


id: Memcache::getVersion
type: function
doc:
<comment>Description:</comment>
  Return version of the server
  
  <strong>Memcache::getVersion()</strong> returns a string with server's version number. Also you can use
  <strong>memcache_get_version()</strong> function.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns a string of server version number sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::getExtendedStats()</strong>
   * <strong>Memcache::getStats()</strong>


id: Memcache::increment
type: function
doc:
<comment>Description:</comment>
  Increment item's value
  
  <strong>Memcache::increment()</strong> increments value of an item by the specified <strong>$value</strong>. If item specified by
  <strong>$key</strong> was not numeric and cannot be converted to a number, it will change its value to <strong>$value</strong>.
  <strong>Memcache::increment()</strong> does not create an item if it doesn't already exist.  Do not use
  <strong>Memcache::increment()</strong> with items that have been   stored compressed because subsequent calls to
  <strong>Memcache::get()</strong> will fail.  Also you can use <strong>memcache_increment()</strong> function.
  
  Do not use <strong>Memcache::increment()</strong> with items that have been   stored compressed because subsequent
  calls to  <strong>Memcache::get()</strong> will fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  Key of the item to increment.
  <info>int   </info>  <strong>$value</strong>  Increment the item by <strong>$value</strong>.

<comment>Return:</comment>
  <info>intfalse</info>  Returns new items value on success  sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::decrement()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::pconnect
type: function
doc:
<comment>Description:</comment>
  Open memcached server persistent connection
  
  <strong>Memcache::pconnect()</strong> is similar to <strong>Memcache::connect()</strong> with the difference, that  the connection
  it establishes is persistent. This connection is not closed after the end of script execution and
  by <strong>Memcache::close()</strong> function. Also you can use <strong>memcache_pconnect()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$host   </strong>  Point to the host where memcached is listening for connections. This parameter
                    may also specify other transports like <return>unix:///path/to/memcached.sock</return> to use
                    UNIX domain sockets, in this case <strong>$port</strong> must also be set to <return>0</return>.
  <info>int   </info>  <strong>$port   </strong>  Point to the port where memcached is listening for connections. Set this
                    parameter to <return>0</return> when using UNIX domain sockets.
  <info>int   </info>  <strong>$timeout</strong>  Value in seconds which will be used for connecting to the daemon. Think twice
                    before changing the default value of 1 second - you can lose all the advantages
                    of caching if your connection is too slow.

<comment>Return:</comment>
  <info>mixed</info>  Returns a Memcache object sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::connect()</strong>


id: Memcache::replace
type: function
doc:
<comment>Description:</comment>
  Replace value of the existing item
  
  <strong>Memcache::replace()</strong> should be used to replace value of existing item with <strong>$key</strong>. In case if item
  with such key doesn't exists, <strong>Memcache::replace()</strong> returns <info>false</info>. For the rest <strong>Memcache::replace()</strong>
  behaves similarly to <strong>Memcache::set()</strong>. Also you can use <strong>memcache_replace()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  The key that will be associated with the item.
  <info>mixed </info>  <strong>$var   </strong>  The variable to store. Strings and integers are stored as is, other types are
                   stored serialized.
  <info>int   </info>  <strong>$flag  </strong>  Use <info>MEMCACHE_COMPRESSED</info> to store the item compressed (uses zlib).
  <info>int   </info>  <strong>$expire</strong>  Expiration time of the item. If it's equal to zero, the item will never expire.
                   You can also use Unix timestamp or a number of seconds starting from current
                   time, but in the latter case the number of seconds may not exceed 2592000 (30
                   days).

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::set()</strong>
   * <strong>Memcache::add()</strong>


id: Memcache::set
type: function
doc:
<comment>Description:</comment>
  Store data at the server
  
  <strong>Memcache::set()</strong> stores an item  <strong>$var</strong> with <strong>$key</strong> on the  memcached server. Parameter <strong>$expire</strong> is
  expiration  time in seconds. If it's 0, the item never expires (but memcached server  doesn't
  guarantee this item to be stored all the time, it could be deleted  from the cache to make place
  for other items). You can use <info>MEMCACHE_COMPRESSED</info> constant as  <strong>$flag</strong> value if you want to use
  on-the-fly compression (uses zlib).  Remember that resource variables (i.e. file and connection
  descriptors) cannot be stored in the cache, because they cannot be adequately represented in
  serialized state.  Also you can use <strong>memcache_set()</strong> function.
  
  Remember that resource variables (i.e. file and connection descriptors) cannot be stored in the
  cache, because they cannot be adequately represented in serialized state.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  The key that will be associated with the item.
  <info>mixed </info>  <strong>$var   </strong>  The variable to store. Strings and integers are stored as is, other types are
                   stored serialized.
  <info>int   </info>  <strong>$flag  </strong>  Use <info>MEMCACHE_COMPRESSED</info> to store the item compressed (uses zlib).
  <info>int   </info>  <strong>$expire</strong>  Expiration time of the item. If it's equal to zero, the item will never expire.
                   You can also use Unix timestamp or a number of seconds starting from current
                   time, but in the latter case the number of seconds may not exceed 2592000 (30
                   days).

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::add()</strong>
   * <strong>Memcache::replace()</strong>


id: Memcache::setCompressThreshold
type: function
doc:
<comment>Description:</comment>
  Enable automatic compression of large values
  
  <strong>Memcache::setCompressThreshold()</strong> enables automatic compression of large values. You can also use
  the <strong>memcache_set_compress_threshold()</strong> function.
  
  This function has been added to Memcache version 2.0.0.

<comment>Param:</comment>
  <info>int</info>  <strong>$threshold </strong>  Controls the minimum value length before attempting to compress automatically.
  <info>   </info>  <strong>$min_saving</strong>  Specifies the minimum amount of savings to actually store the value compressed.
                    The supplied value must be between 0 and 1. Default value is 0.2 giving a
                    minimum 20% compression savings.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: Memcache::setServerParams
type: function
doc:
<comment>Description:</comment>
  Changes server parameters and status at runtime
  
  <strong>Memcache::setServerParams()</strong> changes server parameters at runtime. You can also use the
  <strong>memcache_set_server_params()</strong> function.
  
  This function has been added to Memcache version 2.1.0.

<comment>Param:</comment>
  <info>string  </info>  <strong>$host            </strong>  Point to the host where memcached is listening for connections.
  <info>int     </info>  <strong>$port            </strong>  Point to the port where memcached is listening for connections.
  <info>int     </info>  <strong>$timeout         </strong>  Value in seconds which will be used for connecting to the daemon.
                               Think twice before changing the default value of 1 second - you can
                               lose all the advantages of caching if your connection is too slow.
  <info>int     </info>  <strong>$retry_interval  </strong>  Controls how often a failed server will be retried, the default value
                               is 15 seconds. Setting this parameter to -1 disables automatic retry.
                               Neither this nor the <strong>$persistent</strong> parameter has any  effect when the
                               extension is loaded dynamically via <strong>dl()</strong>.
  <info>bool    </info>  <strong>$status          </strong>  Controls if the server should be flagged as online. Setting this
                               parameter to <info>false</info> and <strong>$retry_interval</strong> to -1 allows a failed  server
                               to be kept in the pool so as not to affect the key distribution
                               algorithm. Requests for this server will then failover or fail
                               immediately  depending on the <strong>$memcache.allow_failover</strong> setting.
                               Default to <info>true</info>, meaning the server should be considered online.
  <info>callable</info>  <strong>$failure_callback</strong>  Allows the user to specify a callback function to run upon
                               encountering an  error. The callback is run before failover is
                               attempted. The function takes  two parameters, the hostname and port
                               of the failed server.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>Memcache::addServer()</strong>
   * <strong>Memcache::getServerStatus()</strong>


id: Memcached::DISTRIBUTION_CONSISTENT
type: constant
doc:
<comment>Description:</comment>
  Consistent hashing key distribution algorithm (based on libketama).


id: Memcached::GET_EXTENDED
type: constant
doc:
<comment>Description:</comment>
  A flag for <strong>Memcached::get()</strong>, <strong>Memcached::getMulti()</strong> and <strong>Memcached::getMultiByKey()</strong> to ensure that
  the CAS token values are returned as well.
  
  Available as of Memcached 3.0.0.


id: Memcached::GET_PRESERVE_ORDER
type: constant
doc:
<comment>Description:</comment>
  A flag for <strong>Memcached::getMulti()</strong> and <strong>Memcached::getMultiByKey()</strong> to ensure that the keys are
  returned in the same order as they were requested in. Non-existing keys get a default value of
  NULL.


id: Memcached::HAVE_IGBINARY
type: constant
doc:
<comment>Description:</comment>
  Indicates whether igbinary serializer support is available.
  
  Type: <return>boolean</return>.


id: Memcached::HAVE_JSON
type: constant
doc:
<comment>Description:</comment>
  Indicates whether JSON serializer support is available.
  
  Type: <return>boolean</return>.


id: Memcached::HAVE_MSGPACK
type: constant
doc:
<comment>Description:</comment>
  Indicates whether msgpack serializer support is available.
  
  Type: <return>boolean</return>.
  
  Available as of Memcached 3.0.0.


id: Memcached::HAVE_SASL
type: constant
doc:
<comment>Description:</comment>
  Type: <return>boolean</return>.
  
  Available as of Memcached 3.0.0.


id: Memcached::OPT_BINARY_PROTOCOL
type: constant
doc:
<comment>Description:</comment>
  Enable the use of the binary protocol. Please note that you cannot toggle this option on an open
  connection.
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::OPT_BUFFER_WRITES
type: constant
doc:
<comment>Description:</comment>
  Enables or disables buffered I/O. Enabling buffered I/O causes storage commands to "buffer"
  instead of being sent. Any action that retrieves data causes this buffer to be sent to the remote
  connection. Quitting the connection or closing down the connection will also cause the buffered
  data to be pushed to the remote connection.
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::OPT_CACHE_LOOKUPS
type: constant
doc:
<comment>Description:</comment>
  Enables or disables caching of DNS lookups.
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::OPT_COMPRESSION
type: constant
doc:
<comment>Description:</comment>
  Enables or disables payload compression. When enabled, item values longer than a certain threshold
  (currently 100 bytes) will be compressed during storage and decompressed during retrieval
  transparently.
  
  Type: <return>boolean</return>, default: <info>true</info>.


id: Memcached::OPT_CONNECT_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  In non-blocking mode this set the value of the timeout during socket connection, in milliseconds.
  
  Type: <return>integer</return>, default: <return>1000</return>.


id: Memcached::OPT_DISTRIBUTION
type: constant
doc:
<comment>Description:</comment>
  Specifies the method of distributing item keys to the servers. Currently supported methods are
  modulo and consistent hashing. Consistent hashing delivers better distribution and allows servers
  to be added to the cluster with minimal cache losses.
  
  Type: <return>integer</return>, default: <info>Memcached::DISTRIBUTION_MODULA.</info>


id: Memcached::OPT_HASH
type: constant
doc:
<comment>Description:</comment>
  Specifies the hashing algorithm used for the item keys. The valid values are supplied via
  <info>Memcached::HASH_*</info> constants. Each hash algorithm has its advantages and its disadvantages. Go with
  the default if you don't know or don't care.
  
  Type: <return>integer</return>, default: <info>Memcached::HASH_DEFAULT</info>


id: Memcached::OPT_LIBKETAMA_COMPATIBLE
type: constant
doc:
<comment>Description:</comment>
  Enables or disables compatibility with libketama-like behavior. When enabled, the item key hashing
  algorithm is set to MD5 and distribution is set to be weighted consistent hashing distribution.
  This is useful because other libketama-based clients (Python, Ruby, etc.) with the same server
  configuration will be able to access the keys transparently.
  
  It is highly recommended to enable this option if you want to use consistent hashing, and it may
  be enabled by default in future releases.
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::OPT_NO_BLOCK
type: constant
doc:
<comment>Description:</comment>
  Enables or disables asynchronous I/O. This is the fastest transport available for storage
  functions.
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::OPT_POLL_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Timeout for connection polling, in milliseconds.
  
  Type: <return>integer</return>, default: <return>1000</return>.


id: Memcached::OPT_PREFIX_KEY
type: constant
doc:
<comment>Description:</comment>
  This can be used to create a "domain" for your item keys. The value specified here will be
  prefixed to each of the keys. It cannot be longer than <return>128</return> characters and will reduce the maximum
  available key size. The prefix is applied only to the item keys, not to the server keys.
  
  Type: <return>string</return>, default: <return>""</return>.


id: Memcached::OPT_RECV_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Socket reading timeout, in microseconds. In cases where you cannot use non-blocking I/O this will
  allow you to still have timeouts on the reading of data.
  
  Type: <return>integer</return>, default: <return>0</return>.


id: Memcached::OPT_RETRY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  The amount of time, in seconds, to wait until retrying a failed connection attempt.
  
  Type: <return>integer</return>, default: <return>0</return>.


id: Memcached::OPT_SEND_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Socket sending timeout, in microseconds. In cases where you cannot use non-blocking I/O this will
  allow you to still have timeouts on the sending of data.
  
  Type: <return>integer</return>, default: <return>0</return>.


id: Memcached::OPT_SERIALIZER
type: constant
doc:
<comment>Description:</comment>
  Specifies the serializer to use for serializing non-scalar values. The valid serializers are
  <info>Memcached::SERIALIZER_PHP</info> or <info>Memcached::SERIALIZER_IGBINARY</info>. The latter is supported only when
  memcached is configured with <return>--enable-memcached-igbinary</return> option and the <return>igbinary</return> extension is
  loaded.
  
  Type: <return>integer</return>, default: <info>Memcached::SERIALIZER_PHP</info>.


id: Memcached::OPT_SERVER_FAILURE_LIMIT
type: constant
doc:
<comment>Description:</comment>
  Specifies the failure limit for server connection attempts. The server will be removed after this
  many continuous connection failures.
  
  Type: <return>integer</return>, default: <return>0</return>.


id: Memcached::OPT_SOCKET_RECV_SIZE
type: constant
doc:
<comment>Description:</comment>
  The maximum socket receive buffer in bytes.
  
  Type: <return>integer</return>, default: varies by platform/kernel configuration.


id: Memcached::OPT_SOCKET_SEND_SIZE
type: constant
doc:
<comment>Description:</comment>
  The maximum socket send buffer in bytes.
  
  Type: <return>integer</return>, default: varies by platform/kernel configuration.


id: Memcached::OPT_TCP_NODELAY
type: constant
doc:
<comment>Description:</comment>
  Enables or disables the no-delay feature for connecting sockets (may be faster in some
  environments).
  
  Type: <return>boolean</return>, default: <info>false</info>.


id: Memcached::RES_DATA_EXISTS
type: constant
doc:
<comment>Description:</comment>
  Failed to do compare-and-swap: item you are trying to store has been modified since you last
  fetched it.


id: Memcached::RES_NOTFOUND
type: constant
doc:
<comment>Description:</comment>
  Item with this key was not found (with "get" operation or "cas" operations).


id: Memcached::RES_NOTSTORED
type: constant
doc:
<comment>Description:</comment>
  Item was not stored: but not because of an error. This normally means that either the condition
  for an "add" or a "replace" command wasn't met, or that the item is in a delete queue.


id: Memcached::RES_PAYLOAD_FAILURE
type: constant
doc:
<comment>Description:</comment>
  Payload failure: could not compress/decompress or serialize/unserialize the value.


id: Memcached::SERIALIZER_IGBINARY
type: constant
doc:
<comment>Description:</comment>
  The igbinary serializer. Instead of textual representation it stores PHP data structures in a
  compact binary form, resulting in space and time gains.


id: Memcached::__construct
type: function
doc:
<comment>Description:</comment>
  Create a Memcached instance
  
  Creates a Memcached instance representing the connection to the memcache servers.

<comment>Param:</comment>
  <info>string</info>  <strong>$persistent_id</strong>  By default the Memcached instances are destroyed at the end of the
                          request. To create an instance that persists between requests, use
                          <strong>$persistent_id</strong> to specify a unique ID for the instance. All instances
                          created with the same <strong>$persistent_id</strong> will share the same connection.

<comment>Return:</comment>
  <info>unknown</info>  A Memcached object.


id: Memcached::add
type: function
doc:
<comment>Description:</comment>
  Add an item under a new key
  
  <strong>Memcached::add()</strong> is similar to Memcached::set, but the operation fails if the <strong>$key</strong> already exists
  on the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key already exists.

<comment>See Also:</comment>
   * Memcached::addByKey
   * Memcached::set
   * Memcached::replace


id: Memcached::addByKey
type: function
doc:
<comment>Description:</comment>
  Add an item under a new key on a specific server
  
  <strong>Memcached::addByKey()</strong> is functionally equivalent to Memcached::add, except that the free-form
  <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server. This is useful if you need to keep a
  bunch of related keys on a certain server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key already exists.

<comment>See Also:</comment>
   * Memcached::add
   * Memcached::set
   * Memcached::replace


id: Memcached::addServer
type: function
doc:
<comment>Description:</comment>
  Add a server to the server pool
  
  <strong>Memcached::addServer()</strong> adds the specified server to the server pool. No connection is established
  to the server at this time, but if you are using consistent key distribution option (via
  <info>Memcached::DISTRIBUTION_CONSISTENT</info> or <info>Memcached::OPT_LIBKETAMA_COMPATIBLE</info>), some of the internal
  data structures will have to be updated. Thus, if you need to add multiple servers, it is better
  to use Memcached::addServers as the update then happens only once.
  
  The same server may appear multiple times in the server pool, because no duplication checks are
  made. This is not advisable; instead, use the <strong>$weight</strong> option to increase the selection weighting
  of this server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host  </strong>  The hostname of the memcache server. If the hostname is invalid, data-related
                   operations will set  <info>Memcached::RES_HOST_LOOKUP_FAILURE</info> result code. As of
                   version 2.0.0b1, this parameter may also specify the path of a unix socket
                   filepath ex. <return>/path/to/memcached.sock</return> to use UNIX domain sockets, in this case
                   <strong>$port</strong> must also be set to <return>0</return>.
  <info>int   </info>  <strong>$port  </strong>  The port on which memcache is running. Usually, this is <return>11211</return>. As of version
                   2.0.0b1, set this parameter to <return>0</return> when  using UNIX domain sockets.
  <info>int   </info>  <strong>$weight</strong>  The weight of the server relative to the total weight of all the servers in the
                   pool. This controls the probability of the server being selected for operations.
                   This is used only with consistent distribution option and usually corresponds to
                   the amount of memory available to memcache on that server.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::addServers
   * Memcached::resetServerList


id: Memcached::addServers
type: function
doc:
<comment>Description:</comment>
  Add multiple servers to the server pool
  
  <strong>Memcached::addServers()</strong> adds <strong>$servers</strong> to the server pool. Each entry in <strong>$servers</strong> is supposed to be
  an array containing hostname, port, and, optionally, weight of the server. No connection is
  established to the servers at this time.
  
  The same server may appear multiple times in the server pool, because no duplication checks are
  made. This is not advisable; instead, use the <strong>$weight</strong> option to increase the selection weighting
  of this server.

<comment>Param:</comment>
  <info></info>  <strong>$array</strong>  Array of the servers to add to the pool.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::addServer
   * Memcached::resetServerList


id: Memcached::append
type: function
doc:
<comment>Description:</comment>
  Append data to an existing item
  
  <strong>Memcached::append()</strong> appends the given <strong>$value</strong> string to the value of an existing item. The reason
  that <strong>$value</strong> is forced to be a string is that appending mixed types is not well-defined.
  
  If the <info>Memcached::OPT_COMPRESSION</info> is enabled, the operation will fail and a warning will be
  issued, because appending compressed data to a value that is potentially already compressed is not
  possible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  Cheia sub care se stochează valoarea.
  <info>string</info>  <strong>$value</strong>  The string to append.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::appendByKey
   * Memcached::prepend


id: Memcached::appendByKey
type: function
doc:
<comment>Description:</comment>
  Append data to an existing item on a specific server
  
  <strong>Memcached::appendByKey()</strong> is functionally equivalent to Memcached::append, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>string</info>  <strong>$value     </strong>  The string to append.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::append
   * Memcached::prepend


id: Memcached::cas
type: function
doc:
<comment>Description:</comment>
  Compare and swap an item
  
  <strong>Memcached::cas()</strong> performs a "check and set" operation, so that the item will be stored only if no
  other client has updated it since it was last fetched by this client. The check is done via the
  <strong>$cas_token</strong> parameter which is a unique 64-bit value assigned to the existing item by memcache. See
  the documentation for  Memcached::get* methods for how to obtain this token. Note that the token
  is represented as a double due to the limitations of PHP's integer space.

<comment>Param:</comment>
  <info>float </info>  <strong>$cas_token </strong>  Unique value associated with the existing item. Generated by memcache.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_DATA_EXISTS</info> if the item you are trying to store has been modified since you
        last fetched it.

<comment>See Also:</comment>
   * Memcached::casByKey


id: Memcached::casByKey
type: function
doc:
<comment>Description:</comment>
  Compare and swap an item on a specific server
  
  <strong>Memcached::casByKey()</strong> is functionally equivalent to Memcached::cas, except that the free-form
  <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server. This is useful if you need to keep a
  bunch of related keys on a certain server.

<comment>Param:</comment>
  <info>float </info>  <strong>$cas_token </strong>  Unique value associated with the existing item. Generated by memcache.
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_DATA_EXISTS</info> if the item you are trying to store has been modified since you
        last fetched it.

<comment>See Also:</comment>
   * Memcached::cas


id: Memcached::decrement
type: function
doc:
<comment>Description:</comment>
  Decrement numeric item's value
  
  <strong>Memcached::decrement()</strong> decrements a numeric item's value by the specified <strong>$offset</strong>. If the item's
  value is not numeric, an error will result. If the operation would decrease the value below 0, the
  new value will be 0. <strong>Memcached::decrement()</strong> will set the item to the <strong>$initial_value</strong> parameter if
  the key doesn't exist.

<comment>Param:</comment>
  <info>string</info>  <strong>$key          </strong>  The key of the item to decrement.
  <info>int   </info>  <strong>$offset       </strong>  The amount by which to decrement the item's value.
  <info>int   </info>  <strong>$initial_value</strong>  The value to set the item to if it doesn't currently exist.
  <info>int   </info>  <strong>$expiry       </strong>  The expiry time to set on the item.

<comment>Return:</comment>
  <info>intfalse</info>  Returns item's new value on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::increment
   * Memcached::incrementByKey
   * Memcached::decrementByKey


id: Memcached::decrementByKey
type: function
doc:
<comment>Description:</comment>
  Decrement numeric item's value, stored on a specific server
  
  <strong>Memcached::decrementByKey()</strong> decrements a numeric item's value by the specified <strong>$offset</strong>. If the
  item's value is not numeric, an error will result. If the operation would decrease the value below
  0, the new value will be 0. <strong>Memcached::decrementByKey()</strong> will set the item to the <strong>$initial_value</strong>
  parameter if the key doesn't exist.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key   </strong>  Cheia ce identifică serverul pe care se
                          înscrie, sau de pe care se citește valoarea. În loc de a efectua hash
                          asupra
                          cheii nemijlocite a elementului, se efectuaează hash asupra cheii
                          serverului,
                          atunci când se decide cu care server memcached să se comunice. Aceasta
                          permite
                          ca elementele asociate să fie grupate împreună pe un singur server pentru
                          a mări
                          eficiența operațiilor multiple.
  <info>string</info>  <strong>$key          </strong>  The key of the item to decrement.
  <info>int   </info>  <strong>$offset       </strong>  The amount by which to decrement the item's value.
  <info>int   </info>  <strong>$initial_value</strong>  The value to set the item to if it doesn't currently exist.
  <info>int   </info>  <strong>$expiry       </strong>  The expiry time to set on the item.

<comment>Return:</comment>
  <info>intfalse</info>  Returns item's new value on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::increment
   * Memcached::incrementByKey


id: Memcached::delete
type: function
doc:
<comment>Description:</comment>
  Delete an item
  
  <strong>Memcached::delete()</strong> deletes the <strong>$key</strong> from the server. The <strong>$time</strong> parameter is the amount of time in
  seconds (or Unix time until which) the client wishes the server to refuse <return>add</return> and <return>replace</return> commands
  for this key. For this amount of time, the item is put into a delete queue, which means that it
  won't possible to retrieve it by the <return>get</return> command, but <return>add</return> and <return>replace</return> command with this key will
  also fail (the <return>set</return> command will succeed, however). After the time passes, the item is finally
  deleted from server memory. The parameter <strong>$time</strong> defaults to 0 (which means that the item will be
  deleted immediately and further storage commands with this key will succeed).

<comment>Param:</comment>
  <info>string</info>  <strong>$key </strong>  The key to be deleted.
  <info>int   </info>  <strong>$time</strong>  The amount of time the server will wait to delete the item.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTFOUND</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::deleteByKey
   * Memcached::deleteMulti


id: Memcached::deleteByKey
type: function
doc:
<comment>Description:</comment>
  Delete an item from a specific server
  
  <strong>Memcached::deleteByKey()</strong> is functionally equivalent to Memcached::delete, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  The key to be deleted.
  <info>int   </info>  <strong>$time      </strong>  The amount of time the server will wait to delete the item.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTFOUND</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteMulti
   * Memcached::deleteMultiByKey


id: Memcached::deleteMulti
type: function
doc:
<comment>Description:</comment>
  Delete multiple items
  
  <strong>Memcached::deleteMulti()</strong> deletes the array of <strong>$keys</strong> from the server. The <strong>$time</strong> parameter is the
  amount of time in seconds (or Unix time until which) the client wishes the server to refuse <return>add</return>
  and <return>replace</return> commands for these keys. For this amount of time, the item is put into a delete queue,
  which means that it won't be possible to retrieve it by the <return>get</return> command, but <return>add</return> and <return>replace</return>
  command with these keys will also fail (the <return>set</return> command will succeed, however). After the time
  passes, the item is finally deleted from server memory. The parameter <strong>$time</strong> defaults to 0 (which
  means that the item will be deleted immediately and further storage commands with these keys will
  succeed).

<comment>Param:</comment>
  <info>array</info>  <strong>$keys</strong>  The keys to be deleted.
  <info>int  </info>  <strong>$time</strong>  The amount of time the server will wait to delete the items.

<comment>Return:</comment>
  <info>array</info>  Returns array indexed by <strong>$keys</strong> and where values are indicating whether operation succeeded
         or not. The Memcached::getResultCode will return <info>Memcached::RES_NOTFOUND</info> if the key does
         not exist.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteByKey
   * Memcached::deleteMultiByKey


id: Memcached::deleteMultiByKey
type: function
doc:
<comment>Description:</comment>
  Delete multiple items from a specific server
  
  <strong>Memcached::deleteMultiByKey()</strong> is functionally equivalent to Memcached::deleteMulti, except that
  the free-form <strong>$server_key</strong> can be used to map the <strong>$keys</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>array </info>  <strong>$keys      </strong>  The keys to be deleted.
  <info>int   </info>  <strong>$time      </strong>  The amount of time the server will wait to delete the items.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTFOUND</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::delete
   * Memcached::deleteByKey
   * Memcached::deleteMulti


id: Memcached::fetch
type: function
doc:
<comment>Description:</comment>
  Fetch the next result
  
  <strong>Memcached::fetch()</strong> retrieves the next result from the last request.

<comment>Return:</comment>
  <info>array</info>  Returns the next result or <info>false</info> otherwise. The Memcached::getResultCode will return
         <info>Memcached::RES_END</info> if result set is exhausted.

<comment>See Also:</comment>
   * Memcached::fetchAll
   * Memcached::getDelayed


id: Memcached::fetchAll
type: function
doc:
<comment>Description:</comment>
  Fetch all the remaining results
  
  <strong>Memcached::fetchAll()</strong> retrieves all the remaining results from the last request.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns the results sau <info>false</info> în cazul eșecului. Utilizați
              Memcached::getResultCode
              dacă e necesar.

<comment>See Also:</comment>
   * Memcached::fetch
   * Memcached::getDelayed


id: Memcached::flush
type: function
doc:
<comment>Description:</comment>
  Invalidate all items in the cache
  
  <strong>Memcached::flush()</strong> invalidates all existing cache items immediately (by default) or after the
  <strong>$delay</strong> specified. After invalidation none of the items will be returned in response to a retrieval
  command (unless it's stored again under the same key after <strong>Memcached::flush()</strong> has invalidated the
  items). The flush does not actually free all the memory taken up by the existing items; that will
  happen gradually as new items are stored.

<comment>Param:</comment>
  <info>int</info>  <strong>$delay</strong>  Number of seconds to wait before invalidating the items.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.


id: Memcached::get
type: function
doc:
<comment>Description:</comment>
  Retrieve an item
  
  <strong>Memcached::get()</strong> returns the item that was previously stored under the <strong>$key</strong>. If the item is found
  and the <strong>$flags</strong> is given <info>Memcached::GET_EXTENDED</info>, it will also return the CAS token value for the
  item. See Memcached::cas for how to use CAS tokens. Read-through caching callback may be specified
  via <strong>$cache_cb</strong> parameter.

<comment>Param:</comment>
  <info>string  </info>  <strong>$key     </strong>  The key of the item to retrieve.
  <info>callable</info>  <strong>$cache_cb</strong>  Read-through caching callback or <info>null</info>.
  <info>        </info>  <strong>$flags   </strong>  Flags to control the returned result. When <info>Memcached::GET_EXTENDED</info> is given,
                       the function will also return the CAS token.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value stored in the cache or <info>false</info> otherwise. If the <strong>$flags</strong> is set to
         <info>Memcached::GET_EXTENDED</info>, an array containing the value and the CAS token is returned
         instead of only the value. The Memcached::getResultCode will return <info>Memcached::RES_NOTFOUND</info>
         if the key does not exist.

<comment>See Also:</comment>
   * Memcached::getByKey
   * Memcached::getMulti
   * Memcached::getDelayed


id: Memcached::getAllKeys
type: function
doc:
<comment>Description:</comment>
  Gets the keys stored on all the servers
  
  <strong>Memcached::getAllKeys()</strong> queries each memcache server and retrieves an array of all keys stored on
  them at that point in time. This is not an atomic operation, so it isn't a truly consistent
  snapshot of the keys at point in time. As memcache doesn't guarantee to return all keys you also
  cannot assume that all keys have been returned.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns the keys stored on all the servers on success sau <info>false</info> în cazul eșecului.


id: Memcached::getByKey
type: function
doc:
<comment>Description:</comment>
  Retrieve an item from a specific server
  
  <strong>Memcached::getByKey()</strong> is functionally equivalent to Memcached::get, except that the free-form
  <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server.

<comment>Param:</comment>
  <info>string  </info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                         înscrie, sau de pe care se citește valoarea. În loc de a efectua hash
                         asupra
                         cheii nemijlocite a elementului, se efectuaează hash asupra cheii
                         serverului,
                         atunci când se decide cu care server memcached să se comunice. Aceasta
                         permite
                         ca elementele asociate să fie grupate împreună pe un singur server pentru a
                         mări
                         eficiența operațiilor multiple.
  <info>string  </info>  <strong>$key       </strong>  The key of the item to fetch.
  <info>callable</info>  <strong>$cache_cb  </strong>  Read-through caching callback or <info>null</info>
  <info>int     </info>  <strong>$flags     </strong>  Flags to control the returned result. When value of <info>Memcached::GET_EXTENDED</info>
                         is given will return the CAS token.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value stored in the cache or <info>false</info> otherwise. The Memcached::getResultCode will
         return <info>Memcached::RES_NOTFOUND</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::get
   * Memcached::getMulti
   * Memcached::getDelayed


id: Memcached::getDelayed
type: function
doc:
<comment>Description:</comment>
  Request multiple items
  
  <strong>Memcached::getDelayed()</strong> issues a request to memcache for multiple items the keys of which are
  specified in the <strong>$keys</strong> array. The method does not wait for response and returns right away. When
  you are ready to collect the items, call either Memcached::fetch or Memcached::fetchAll. If
  <strong>$with_cas</strong> is true, the CAS token values will also be requested.
  
  Instead of fetching the results explicitly, you can specify a result callback via <strong>$value_cb</strong>
  parameter.

<comment>Param:</comment>
  <info>array   </info>  <strong>$keys    </strong>  Array of keys to request.
  <info>bool    </info>  <strong>$with_cas</strong>  Whether to request CAS token values also.
  <info>callable</info>  <strong>$value_cb</strong>  The result callback or <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::getDelayedByKey
   * Memcached::fetch
   * Memcached::fetchAll


id: Memcached::getDelayedByKey
type: function
doc:
<comment>Description:</comment>
  Request multiple items from a specific server
  
  <strong>Memcached::getDelayedByKey()</strong> is functionally equivalent to Memcached::getDelayed, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$keys</strong> to a specific server.

<comment>Param:</comment>
  <info>string  </info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                         înscrie, sau de pe care se citește valoarea. În loc de a efectua hash
                         asupra
                         cheii nemijlocite a elementului, se efectuaează hash asupra cheii
                         serverului,
                         atunci când se decide cu care server memcached să se comunice. Aceasta
                         permite
                         ca elementele asociate să fie grupate împreună pe un singur server pentru a
                         mări
                         eficiența operațiilor multiple.
  <info>array   </info>  <strong>$keys      </strong>  Array of keys to request.
  <info>bool    </info>  <strong>$with_cas  </strong>  Whether to request CAS token values also.
  <info>callable</info>  <strong>$value_cb  </strong>  The result callback or <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::getDelayed
   * Memcached::fetch
   * Memcached::fetchAll


id: Memcached::getMulti
type: function
doc:
<comment>Description:</comment>
  Retrieve multiple items
  
  <strong>Memcached::getMulti()</strong> is similar to Memcached::get, but instead of a single key item, it retrieves
  multiple items the keys of which are specified in the <strong>$keys</strong> array.  Before v3.0 a second argument
  cas_tokens</strong> was in use. It was filled with the CAS token values for the found items. The cas_tokens</strong>
  parameter was removed in v3.0 of the extension. It was replaced with a new flag
  <info>Memcached::GET_EXTENDED</info> that needs is to be used as the value for <strong>$flags</strong>.
  
  Before v3.0 a second argument cas_tokens</strong> was in use. It was filled with the CAS token values for
  the found items. The cas_tokens</strong> parameter was removed in v3.0 of the extension. It was replaced
  with a new flag <info>Memcached::GET_EXTENDED</info> that needs is to be used as the value for <strong>$flags</strong>.
  
  The <strong>$flags</strong> parameter can be used to specify additional options for <strong>Memcached::getMulti()</strong>.
  <info>Memcached::GET_PRESERVE_ORDER</info> ensures that the keys are returned in the same order as they were
  requested in. <info>Memcached::GET_EXTENDED</info> ensures that the CAS tokens will be fetched too.

<comment>Param:</comment>
  <info>array</info>  <strong>$keys </strong>  Array of keys to retrieve.
  <info>int  </info>  <strong>$flags</strong>  The flags for the get operation.

<comment>Return:</comment>
  <info>mixed</info>  Returns the array of found items sau <info>false</info> în cazul eșecului. Utilizați
         Memcached::getResultCode
         dacă e necesar.

<comment>See Also:</comment>
   * Memcached::getMultiByKey
   * Memcached::get
   * Memcached::getDelayed


id: Memcached::getMultiByKey
type: function
doc:
<comment>Description:</comment>
  Retrieve multiple items from a specific server
  
  <strong>Memcached::getMultiByKey()</strong> is functionally equivalent to Memcached::getMulti, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$keys</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>array </info>  <strong>$keys      </strong>  Array of keys to retrieve.
  <info>int   </info>  <strong>$flags     </strong>  The flags for the get operation.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns the array of found items sau <info>false</info> în cazul eșecului. Utilizați
              Memcached::getResultCode
              dacă e necesar.

<comment>See Also:</comment>
   * Memcached::getMulti
   * Memcached::get
   * Memcached::getDelayed


id: Memcached::getOption
type: function
doc:
<comment>Description:</comment>
  Retrieve a Memcached option value
  
  This method returns the value of a Memcached <strong>$option</strong>. Some options correspond to the ones defined
  by libmemcached, and some are specific to the extension. See Memcached Constants for more
  information.

<comment>Param:</comment>
  <info>int</info>  <strong>$option</strong>  One of the <return>Memcached::OPT_*</return> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the requested option, or <info>false</info> on error.

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOption
   * Memcached Constants


id: Memcached::getResultCode
type: function
doc:
<comment>Description:</comment>
  Return the result code of the last operation
  
  <strong>Memcached::getResultCode()</strong> returns one of the <info>Memcached::RES_*</info> constants that is the result of the
  last executed Memcached method.

<comment>Return:</comment>
  <info>int</info>  Result code of the last Memcached operation.


id: Memcached::getResultMessage
type: function
doc:
<comment>Description:</comment>
  Return the message describing the result of the last operation
  
  <strong>Memcached::getResultMessage()</strong> returns a string that describes the result code of the last executed
  Memcached method.

<comment>Return:</comment>
  <info>string</info>  Message describing the result of the last Memcached operation.


id: Memcached::getServerByKey
type: function
doc:
<comment>Description:</comment>
  Map a key to a server
  
  <strong>Memcached::getServerByKey()</strong> returns the server that would be selected by a particular <strong>$server_key</strong>
  in all the <strong>Memcached::*ByKey()</strong> operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing three keys of <return>host</return>, <return>port</return>, and <return>weight</return> on success or <info>false</info> on
         failure. Utilizați
         Memcached::getResultCode
         dacă e necesar.


id: Memcached::getServerList
type: function
doc:
<comment>Description:</comment>
  Get the list of the servers in the pool
  
  <strong>Memcached::getServerList()</strong> returns the list of all servers that are in its server pool.

<comment>Return:</comment>
  <info>array</info>  The list of all servers in the server pool.


id: Memcached::getStats
type: function
doc:
<comment>Description:</comment>
  Get server pool statistics
  
  <strong>Memcached::getStats()</strong> returns an array containing the state of all available memcache servers. See
  memcache protocol specification for details on these statistics.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of server statistics, one entry per server,  sau <info>false</info> în cazul eșecului.


id: Memcached::getVersion
type: function
doc:
<comment>Description:</comment>
  Get server pool version info
  
  <strong>Memcached::getVersion()</strong> returns an array containing the version info for all available memcache
  servers.

<comment>Return:</comment>
  <info>array</info>  Array of server versions, one entry per server.


id: Memcached::increment
type: function
doc:
<comment>Description:</comment>
  Increment numeric item's value
  
  <strong>Memcached::increment()</strong> increments a numeric item's value by the specified <strong>$offset</strong>. If the item's
  value is not numeric, an error will result. <strong>Memcached::increment()</strong> will set the item to the
  <strong>$initial_value</strong> parameter if the key doesn't exist.

<comment>Param:</comment>
  <info>string</info>  <strong>$key          </strong>  The key of the item to increment.
  <info>int   </info>  <strong>$offset       </strong>  The amount by which to increment the item's value.
  <info>int   </info>  <strong>$initial_value</strong>  The value to set the item to if it doesn't currently exist.
  <info>int   </info>  <strong>$expiry       </strong>  The expiry time to set on the item.

<comment>Return:</comment>
  <info>intfalse</info>  Returns new item's value on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::decrementByKey
   * Memcached::incrementByKey


id: Memcached::incrementByKey
type: function
doc:
<comment>Description:</comment>
  Increment numeric item's value, stored on a specific server
  
  <strong>Memcached::incrementByKey()</strong> increments a numeric item's value by the specified <strong>$offset</strong>. If the
  item's value is not numeric, an error will result. <strong>Memcached::incrementByKey()</strong> will set the item
  to the <strong>$initial_value</strong> parameter if the key doesn't exist.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key   </strong>  Cheia ce identifică serverul pe care se
                          înscrie, sau de pe care se citește valoarea. În loc de a efectua hash
                          asupra
                          cheii nemijlocite a elementului, se efectuaează hash asupra cheii
                          serverului,
                          atunci când se decide cu care server memcached să se comunice. Aceasta
                          permite
                          ca elementele asociate să fie grupate împreună pe un singur server pentru
                          a mări
                          eficiența operațiilor multiple.
  <info>string</info>  <strong>$key          </strong>  The key of the item to increment.
  <info>int   </info>  <strong>$offset       </strong>  The amount by which to increment the item's value.
  <info>int   </info>  <strong>$initial_value</strong>  The value to set the item to if it doesn't currently exist.
  <info>int   </info>  <strong>$expiry       </strong>  The expiry time to set on the item.

<comment>Return:</comment>
  <info>intfalse</info>  Returns new item's value on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::decrement
   * Memcached::decrementByKey
   * Memcached::increment


id: Memcached::isPersistent
type: function
doc:
<comment>Description:</comment>
  Check if a persitent connection to memcache is being used
  
  <strong>Memcached::isPersistent()</strong> checks if the connections to the memcache servers are persistent
  connections.

<comment>Return:</comment>
  <info>bool</info>  Returns true if Memcache instance uses a persistent connection, false otherwise.

<comment>See Also:</comment>
   * Memcached::isPristine


id: Memcached::isPristine
type: function
doc:
<comment>Description:</comment>
  Check if the instance was recently created
  
  <strong>Memcached::isPristine()</strong> checks if the Memcache instance was recently created.

<comment>Return:</comment>
  <info>bool</info>  Returns the true if instance is recently created, false otherwise.

<comment>See Also:</comment>
   * Memcached::isPersistent


id: Memcached::prepend
type: function
doc:
<comment>Description:</comment>
  Prepend data to an existing item
  
  <strong>Memcached::prepend()</strong> prepends the given <strong>$value</strong> string to the value of an existing item. The reason
  that <strong>$value</strong> is forced to be a string is that prepending mixed types is not well-defined.
  
  If the <info>Memcached::OPT_COMPRESSION</info> is enabled, the operation will fail and a warning will be
  issued, because prepending compressed data to a value that is potentially already compressed is
  not possible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  The key of the item to prepend the data to.
  <info>string</info>  <strong>$value</strong>  The string to prepend.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::prependByKey
   * Memcached::append


id: Memcached::prependByKey
type: function
doc:
<comment>Description:</comment>
  Prepend data to an existing item on a specific server
  
  <strong>Memcached::prependByKey()</strong> is functionally equivalent to Memcached::prepend, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  The key of the item to prepend the data to.
  <info>string</info>  <strong>$value     </strong>  The string to prepend.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::prepend
   * Memcached::append


id: Memcached::quit
type: function
doc:
<comment>Description:</comment>
  Close any open connections
  
  <strong>Memcached::quit()</strong> closes any open connections to the memcache servers.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: Memcached::replace
type: function
doc:
<comment>Description:</comment>
  Replace the item under an existing key
  
  <strong>Memcached::replace()</strong> is similar to Memcached::set, but the operation fails if the <strong>$key</strong> does not
  exist on the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::replaceByKey
   * Memcached::set
   * Memcached::add


id: Memcached::replaceByKey
type: function
doc:
<comment>Description:</comment>
  Replace the item under an existing key on a specific server
  
  <strong>Memcached::replaceByKey()</strong> is functionally equivalent to Memcached::replace, except that the
  free-form <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server. This is useful if you need
  to keep a bunch of related keys on a certain server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. The Memcached::getResultCode will return
        <info>Memcached::RES_NOTSTORED</info> if the key does not exist.

<comment>See Also:</comment>
   * Memcached::replace
   * Memcached::set
   * Memcached::add


id: Memcached::resetServerList
type: function
doc:
<comment>Description:</comment>
  Clears all servers from the server list
  
  <strong>Memcached::resetserverlist()</strong> removes all memcache servers from the known server list, resetting it
  back to empty.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::addServer
   * Memcached::addServers


id: Memcached::set
type: function
doc:
<comment>Description:</comment>
  Store an item
  
  <strong>Memcached::set()</strong> stores the <strong>$value</strong> on a memcache server under the specified <strong>$key</strong>. The <strong>$expiration</strong>
  parameter can be used to control when the value is considered expired.
  
  The value can be any valid PHP type except for resources, because those cannot be represented in a
  serialized form. If the <info>Memcached::OPT_COMPRESSION</info> option is turned on, the serialized value will
  also be compressed before storage.

<comment>Param:</comment>
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::setByKey
   * Memcached::add
   * Memcached::replace


id: Memcached::setByKey
type: function
doc:
<comment>Description:</comment>
  Store an item on a specific server
  
  <strong>Memcached::setByKey()</strong> is functionally equivalent to Memcached::set, except that the free-form
  <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server. This is useful if you need to keep a
  bunch of related keys on a certain server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>mixed </info>  <strong>$value     </strong>  Valoarea pentru a fi stocată.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::set


id: Memcached::setMulti
type: function
doc:
<comment>Description:</comment>
  Store multiple items
  
  <strong>Memcached::setMulti()</strong> is similar to Memcached::set, but instead of a single key/value item, it
  works on multiple items specified in <strong>$items</strong>. The <strong>$expiration</strong> time applies to all the items at
  once.

<comment>Param:</comment>
  <info>array</info>  <strong>$items     </strong>  Un tablou cu perechi de chei/valori pentru
                      a fi stocate pe server.
  <info>int  </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                      Accesați 
                      Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::setMultiByKey
   * Memcached::set


id: Memcached::setMultiByKey
type: function
doc:
<comment>Description:</comment>
  Store multiple items on a specific server
  
  <strong>Memcached::setMultiByKey()</strong> is functionally equivalent to Memcached::setMulti, except that the
  free-form <strong>$server_key</strong> can be used to map the keys from <strong>$items</strong> to a specific server. This is useful
  if you need to keep a bunch of related keys on a certain server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>array </info>  <strong>$items     </strong>  Un tablou cu perechi de chei/valori pentru
                       a fi stocate pe server.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::setMulti
   * Memcached::set


id: Memcached::setOption
type: function
doc:
<comment>Description:</comment>
  Set a Memcached option
  
  This method sets the value of a Memcached <strong>$option</strong>. Some options correspond to the ones defined by
  libmemcached, and some are specific to the extension. See Memcached Constants for more
  information.
  
  The options listed below require values specified via constants. <return>Memcached::OPT_HASH</return> requires
  <return>Memcached::HASH_*</return> values. <return>Memcached::OPT_DISTRIBUTION</return> requires <return>Memcached::DISTRIBUTION_*</return> values.
  
  <return>Memcached::OPT_HASH</return> requires <return>Memcached::HASH_*</return> values.
  
  <return>Memcached::OPT_DISTRIBUTION</return> requires <return>Memcached::DISTRIBUTION_*</return> values.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOptions
   * Memcached Constants


id: Memcached::setOptions
type: function
doc:
<comment>Description:</comment>
  Set Memcached options
  
  <strong>Memcached::setOptions()</strong> is a variation of the Memcached::setOption that takes an array of options
  to be set.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  An associative array of options where the key is the option to set and the value
                   is the new value for the option.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Memcached::getOption
   * Memcached::setOption
   * Memcached Constants


id: Memcached::setSaslAuthData
type: function
doc:
<comment>Description:</comment>
  Set the credentials to use for authentication
  
  <strong>Memcached::setSaslAuthData()</strong> sets the username and password that should be used for SASL
  authentication with the memcache servers.
  
  This method is only available when the memcached extension is built with SASL support. Please
  refer to Memcached setup for how to do this.

<comment>Param:</comment>
  <info>string</info>  <strong>$username</strong>  The username to use for authentication.
  <info>string</info>  <strong>$password</strong>  The password to use for authentication.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: Memcached::touch
type: function
doc:
<comment>Description:</comment>
  Set a new expiration on an item
  
  <strong>Memcached::touch()</strong> sets a new expiration value on the given key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::touchByKey


id: Memcached::touchByKey
type: function
doc:
<comment>Description:</comment>
  Set a new expiration on an item on a specific server
  
  <strong>Memcached::touchByKey()</strong> is functionally equivalent to Memcached::touch, except that the free-form
  <strong>$server_key</strong> can be used to map the <strong>$key</strong> to a specific server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server_key</strong>  Cheia ce identifică serverul pe care se
                       înscrie, sau de pe care se citește valoarea. În loc de a efectua hash asupra
                       cheii nemijlocite a elementului, se efectuaează hash asupra cheii serverului,
                       atunci când se decide cu care server memcached să se comunice. Aceasta
                       permite
                       ca elementele asociate să fie grupate împreună pe un singur server pentru a
                       mări
                       eficiența operațiilor multiple.
  <info>string</info>  <strong>$key       </strong>  Cheia sub care se stochează valoarea.
  <info>int   </info>  <strong>$expiration</strong>  Timpul expirării, implicit este 0.
                       Accesați 
                       Timpurile de expirare pentru informații suplimentare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. Utilizați
        Memcached::getResultCode
        dacă e necesar.

<comment>See Also:</comment>
   * Memcached::touch


id: MessageFormatter
type: class
doc:
<comment>Description:</comment>
  MessageFormatter is a concrete class that enables users to produce concatenated, language-neutral
  messages. The methods supplied in this class are used to build all the messages that are seen by
  end users.
  
  The MessageFormatter class assembles messages from various fragments (such as text fragments,
  numbers, and dates) supplied by the program. Because of the MessageFormatter class, the program
  does not need to know the order of the fragments. The class uses the formatting specifications for
  the fragments to assemble them into a message that is contained in a single string within a
  resource bundle. For example, MessageFormatter enables you to print the phrase "Finished printing
  x out of y files..." in a manner that still allows for flexibility in translation.
  
  Previously, an end user message was created as a sentence and handled as a string. This procedure
  created problems for localizers because the sentence structure, word order, number format and so
  on are very different from language to language. The language-neutral way to create messages keeps
  each part of the message separate and provides keys to the data. Using these keys, the
  MessageFormatter class can concatenate the parts of the message, localize them, and display a
  well-formed string to the end user.
  
  MessageFormatter takes a set of objects, formats them, and then inserts the formatted strings into
  the pattern at the appropriate places. Choice formats can be used in conjunction with
  MessageFormatter to handle plurals, match numbers, and select from an array of items. Typically,
  the message format will come from resources and the arguments will be dynamically set at runtime.


id: MessageFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new Message Formatter
  
  Stil obiect-orientat (method)
  
  Stil obiect-orientat (constructor):
  
  Stil procedural
  
  Constructs a new Message Formatter

<comment>Param:</comment>
  <info>string</info>  <strong>$locale </strong>  The locale to use when formatting arguments
  <info>string</info>  <strong>$pattern</strong>  The pattern string to stick arguments into.  The pattern uses an
                    'apostrophe-friendly' syntax; it is run through umsg_autoQuoteApostrophe  before
                    being interpreted.

<comment>Return:</comment>
  <info>MessageFormatter</info>  The formatter <info>object</info>

<comment>See Also:</comment>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::format
type: function
doc:
<comment>Description:</comment>
  Format the message
  
  Stil obiect-orientat
  
  Stil procedural
  
  Format the message by substituting the data into the format string according to the locale rules

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt </strong>  The message formatter
  <info>array           </info>  <strong>$args</strong>  Arguments to insert into the format string

<comment>Return:</comment>
  <info>string</info>  The formatted string, or <info>false</info> if an error occurred

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::formatMessage
type: function
doc:
<comment>Description:</comment>
  Quick format message
  
  Stil obiect-orientat
  
  Stil procedural
  
  Quick formatting function that formats the string without having to explicitly create the
  formatter object. Use this function when the format operation is done only once and does not need
  and parameters or state to be kept.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale </strong>  The locale to use for formatting locale-dependent parts
  <info>string</info>  <strong>$pattern</strong>  The pattern <info>string</info> to insert things into. The pattern uses an
                    'apostrophe-friendly' syntax; it is run through umsg_autoQuoteApostrophe  before
                    being interpreted.
  <info>array </info>  <strong>$args   </strong>  The <info>array</info> of values to insert into the format <info>string</info>

<comment>Return:</comment>
  <info>string</info>  The formatted pattern string or <info>false</info> if an error occurred

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_parse()</strong>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>msgfmt_get_error_message()</strong>


id: MessageFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get the error code from last operation
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the error code from last operation.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  The message formatter

<comment>Return:</comment>
  <info>int</info>  The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR.

<comment>See Also:</comment>
   * <strong>msgfmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: MessageFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get the error text from the last operation
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the error text from the last operation.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  The message formatter

<comment>Return:</comment>
  <info>string</info>  Description of the last error.

<comment>See Also:</comment>
   * <strong>msgfmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: MessageFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Get the locale for which the formatter was created
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the locale for which the formatter was created.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  The formatter resource

<comment>Return:</comment>
  <info>string</info>  The locale name

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>


id: MessageFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Get the pattern used by the formatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Get the pattern used by the formatter

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt</strong>  The message formatter

<comment>Return:</comment>
  <info>string</info>  The pattern <info>string</info> for this message formatter

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_set_pattern()</strong>


id: MessageFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Parse input string according to pattern
  
  Stil obiect-orientat
  
  Stil procedural
  
  Parses input <info>string</info> and return any extracted items as an <info>array</info>.

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt  </strong>  The message formatter
  <info>string          </info>  <strong>$value</strong>  The <info>string</info> to parse

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing the items extracted, or <info>false</info> on error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format()</strong>
   * <strong>msgfmt_parse_message()</strong>


id: MessageFormatter::parseMessage
type: function
doc:
<comment>Description:</comment>
  Quick parse input string
  
  Stil obiect-orientat
  
  Stil procedural
  
  Parses input string without explicitly creating the formatter object. Use this function when the
  format operation is done only once and does not need and parameters or state to be kept.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale </strong>  The locale to use for parsing locale-dependent parts
  <info>string</info>  <strong>$pattern</strong>  The pattern with which to parse the <strong>$value</strong>.
  <info>string</info>  <strong>$source </strong>  The <info>string</info> to parse, conforming to the <strong>$pattern</strong>.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing items extracted, or <info>false</info> on error

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_format_message()</strong>
   * <strong>msgfmt_parse()</strong>


id: MessageFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Set the pattern used by the formatter
  
  Stil obiect-orientat
  
  Stil procedural
  
  Set the pattern used by the formatter

<comment>Param:</comment>
  <info>MessageFormatter</info>  <strong>$fmt    </strong>  The message formatter
  <info>string          </info>  <strong>$pattern</strong>  The pattern <info>string</info> to use in this message formatter. The pattern uses
                              an 'apostrophe-friendly' syntax; it is run through
                              umsg_autoQuoteApostrophe  before being interpreted.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * <strong>msgfmt_create()</strong>
   * <strong>msgfmt_get_pattern()</strong>


id: Mongo
type: class
doc:
<comment>Description:</comment>
  A connection between PHP and MongoDB.
  
  This class extends <class>MongoClient</class> and provides access to several deprecated methods.
  
  For backwards compatibility, it also defaults the <return>"w"</return> option of its constructor argument to <return>0</return>,
  which does not require write operations to be acknowledged by the server. See
  <strong>MongoClient::__construct()</strong> for more information.
  
  This class has been DEPRECATED as of version 1.3.0. Relying on this feature is highly discouraged.
  Please use <class>MongoClient</class> instead.


id: Mongo::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  This method overwrites the <class>MongoClient</class> constructor and turns off acknowledged writes.
  
  Please see MongoClient::__construct for description of the parameters.


id: Mongo::connectUtil
type: function
doc:
<comment>Description:</comment>
  Connects with a database server
  
  This is an internal function that you should never call yourself.

<comment>Return:</comment>
  <info>bool</info>  If the connection was successful.


id: Mongo::getPoolSize
type: function
doc:
<comment>Description:</comment>
  Get pool size for connection pools
  
  This feature has been DEPRECATED as of version 1.2.3. Relying on this feature is highly
  discouraged.  Please use <strong>MongoPool::getSize()</strong> instead.

<comment>Return:</comment>
  <info>int</info>  Returns the current pool size.

<comment>See Also:</comment>
   * <strong>Mongo::setPoolSize()</strong>
   * <strong>Mongo::poolDebug()</strong>
   * The connection documentation.


id: Mongo::getSlave
type: function
doc:
<comment>Description:</comment>
  Returns the address being used by this for slaveOkay reads
  
  This finds the address of the secondary currently being used for reads. It is a read-only method:
  it does not change anything about the internal state of the object.
  
  When you create a connection to the database, the driver will not immediately decide on a
  secondary to use. Thus, after you connect, this function will return <info>null</info> even if there are
  secondaries available. When you first do a query with slaveOkay set, at that point the driver will
  choose a secondary for this connection. At that point, this function will return the chosen
  secondary.
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Return:</comment>
  <info>string</info>  The address of the secondary this connection is using for reads.
          
          This returns <info>null</info> if this is not connected to a replica set or not yet initialized.

<comment>See Also:</comment>
   * <strong>MongoCursor::info()</strong>


id: Mongo::getSlaveOkay
type: function
doc:
<comment>Description:</comment>
  Get slaveOkay setting for this connection
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Return:</comment>
  <info>bool</info>  Returns the value of slaveOkay for this instance.

<comment>See Also:</comment>
   * 
   * MongoClient::getReadPreference


id: Mongo::poolDebug
type: function
doc:
<comment>Description:</comment>
  Returns information about all connection pools
  
  This feature has been DEPRECATED as of version 1.2.3. Relying on this feature is highly
  discouraged.  Please use <strong>MongoPool::info()</strong> instead.
  
  Returns an array of information about all connection pools.

<comment>Return:</comment>
  <info>array</info>  Each connection pool has an identifier, which starts with the host. For each pool, this
         function shows the following fields: <strong>$in use</strong> The number of connections currently being used
         by <class>MongoClient</class> instances. <strong>$in pool</strong> The number of connections currently in the pool (not
         being used). <strong>$remaining</strong> The number of connections that could be created by this pool. For
         example, suppose a pool had 5 connections remaining and 3 connections in the pool.  We
         could create 8 new instances of <class>MongoClient</class> before we exhausted this pool (assuming no
         instances of <class>MongoClient</class> went out of scope, returning their connections to the pool).  A
         negative number means that this pool will spawn unlimited connections.  Before a pool is
         created, you can change the max number of connections by calling <strong>Mongo::setPoolSize()</strong>. Once
         a pool is showing up in the output of this function, its size cannot be changed. <strong>$timeout</strong>
         The socket timeout for connections in this pool. This is how long connections in this pool
         will attempt to connect to a server before giving up.
         
         The number of connections currently being used by <class>MongoClient</class> instances.
         
         The number of connections currently in the pool (not being used).
         
         The number of connections that could be created by this pool. For example, suppose a pool
         had 5 connections remaining and 3 connections in the pool.  We could create 8 new instances
         of <class>MongoClient</class> before we exhausted this pool (assuming no instances of <class>MongoClient</class> went out
         of scope, returning their connections to the pool).
         
         A negative number means that this pool will spawn unlimited connections.
         
         Before a pool is created, you can change the max number of connections by calling
         <strong>Mongo::setPoolSize()</strong>. Once a pool is showing up in the output of this function, its size
         cannot be changed.
         
         The socket timeout for connections in this pool. This is how long connections in this pool
         will attempt to connect to a server before giving up.


id: Mongo::setPoolSize
type: function
doc:
<comment>Description:</comment>
  Set the size for future connection pools
  
  This method has been DEPRECATED as of version 1.2.3. Relying on this feature is highly
  discouraged.  Please use <strong>MongoPool::setSize()</strong> instead.
  
  Sets the max number of connections new pools will be able to create.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The max number of connections future pools will be able to create. Negative numbers
              mean that the pool will spawn an infinite number of connections.

<comment>Return:</comment>
  <info>bool</info>  Returns the former value of pool size.

<comment>See Also:</comment>
   * <strong>Mongo::getPoolSize()</strong>
   * <strong>Mongo::poolDebug()</strong>
   * The connection documentation.


id: Mongo::setSlaveOkay
type: function
doc:
<comment>Description:</comment>
  Change slaveOkay setting for this connection
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Param:</comment>
  <info>bool</info>  <strong>$ok</strong>  If reads should be sent to secondary members of a replica set for all possible queries
             using this <class>MongoClient</class> instance.

<comment>Return:</comment>
  <info>bool</info>  Returns the former value of slaveOkay for this instance.

<comment>See Also:</comment>
   * 
   * MongoClient::setReadPreference


id: Mongo::switchSlave
type: function
doc:
<comment>Description:</comment>
  Choose a new secondary for slaveOkay reads
  
  This choses a random secondary for a connection to read from.  It is called automatically by the
  driver and should not need to be used.  It calls <strong>MongoClient::getHosts()</strong> (to refresh the status of
  hosts) and <strong>Mongo::getSlave()</strong> (to get the return value).
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Return:</comment>
  <info>string</info>  The address of the secondary this connection is using for reads. This may be the same as
          the previous address as addresses are randomly chosen. It may return only one address if
          only one secondary (or only the primary) is available.
          
          For example, if we had a three member replica set with a primary, secondary, and arbiter
          this method would always return the address of the secondary. If the secondary became
          unavailable, this method would always return the address of the primary.  If the primary
          also became unavailable, this method would throw an exception, as an arbiter cannot handle
          reads.

<comment>See Also:</comment>
   * 


id: MongoBinData
type: class
doc:
<comment>Description:</comment>
  An object that can be used to store or retrieve binary data from the database.
  
  The maximum size of a single object that can be inserted into the database is 16MB. For data that
  is larger than this (movies, music, Henry Kissinger's autobiography), use <class>MongoGridFS</class>. For data
  that is smaller than 16MB, you may find it easier to embed it within the document using
  <class>MongoBinData</class>.
  
  For example, to embed an image in a document, one could write:
  
  This class contains a type field, which currently gives no additional functionality in the PHP
  driver or the database. There are seven predefined types, which are defined as class constants
  below. For backwards compatibility, the PHP driver uses <info>MongoBinData::BYTE_ARRAY</info> as the default;
  however, this may change to <info>MongoBinData::GENERIC</info> in the future. Users are encouraged to specify a
  type in <strong>MongoBinData::__construct()</strong>.


id: MongoBinData::BYTE_ARRAY
type: constant
doc:
<comment>Description:</comment>
  Generic binary data (deprecated in favor of <info>MongoBinData::GENERIC</info>).


id: MongoBinData::UUID
type: constant
doc:
<comment>Description:</comment>
  Universally unique identifier (deprecated in favor of <info>MongoBinData::UUID_RFC4122</info>).


id: MongoBinData::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new binary data object
  
  Creates a new binary data object.
  
  There are seven types of binary data currently recognized by the BSON spec, which are defined as
  class constants. For backwards compatibility, the PHP driver uses <info>MongoBinData::BYTE_ARRAY</info> as the
  default; however, this may change to <info>MongoBinData::GENERIC</info> in the future. Users are encouraged to
  specify a type instead of relying on the default.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Binary data.
  <info>int   </info>  <strong>$type</strong>  Data type.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new binary data object.


id: MongoBinData::__toString
type: function
doc:
<comment>Description:</comment>
  The string representation of this binary data object

<comment>Return:</comment>
  <info>string</info>  Returns the string "\<Mongo Binary Data&gt;".  To access the contents of a  <class>MongoBinData</class>, use the <return>bin</return> field.


id: MongoClient
type: class
doc:
<comment>Description:</comment>
  A connection manager for PHP and MongoDB.
  
  This class is used to create and manage connections. A typical use is: <class>MongoClient</class> basic usagefoo;
  // get the database named "foo"
  
  ?>
  ]]>
  
  See <strong>MongoClient::__construct()</strong> and the section on connecting for more information about creating
  connections.


id: MongoClient::VERSION
type: constant
doc:
<comment>Description:</comment>
  PHP driver version. May be suffixed with "dev", "+" or "-" if it is in-between versions.


id: MongoClient::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new database connection object
  
  If no parameters are passed, this connects to "localhost:27017" (or whatever was specified in
  php.ini for mongo.default_host and mongo.default_port).
  
  <strong>$server</strong> should have the form: 
  
  The connection string always starts with <return>mongodb://</return>, to indicate it is a connection string in this
  form.
  
  If <return>username</return> and <return>password</return> are specified, the constructor will attempt to authenticate the
  connection with the database before returning.  Username and password are optional and must be
  followed by an <return>@</return>, if specified.
  
  At least one host must be given (port optional, always defaulting to 27017) and as many hosts as
  desired may be connected to. Host names are comma-separated and the constructor will return
  successfully if it connected to at least one host. If it could not connect to any of the hosts, it
  will throw a <class>MongoConnectionException</class>. Please see the Replica Sets section for information on how
  to connect to Replica Sets.
  
  If you specified a username and password, you may specify a database to authenticate with.  If <return>db</return>
  is not specified, "admin" will be used.
  
  An optional query string may be used to specify extra options. The same options are supported
  through the <strong>$options</strong> array as well, and are therefore redescribed there. See the examples below on
  how to set those options.
  
  One part of the options governs how the driver reads from secondary nodes in a replica set
  environment. Extra information on how these read preferences work is available as well through the
  read preferences documentation page.

<comment>Param:</comment>
  <info>string</info>  <strong>$server        </strong>  The server name.
  <info>array </info>  <strong>$options       </strong>  An array of options for the connection. Currently available options
                           include: <return>"authMechanism"</return> Available mechanisms are:
                           authMechanismDescriptionAvailabilityMONGODB-CRAuthenticate using
                           Challenge Response mechanism. This is the default value.All MongoDB
                           versionsMONGODB-X509Authenticates using X509 certificatesMongoDB 2.6.
                           Only available when  is enabledPLAINAuthenticates using unencrypted plain
                           username+password. Must be used over SSL connections. Generally used by
                           MongoDB to login via 3rd party LDAP serverMongoDB Enterprise 2.4. The
                           Driver must be compiled against CyrusSASL2GSSAPIAuthenticates via
                           kerberos systemsMongoDB Enterprise 2.4. The Driver must be compiled
                           against CyrusSASL2SCRAM-SHA-1Authenticates using SCRAM-SHA-1MongoDB 3.0.
                           <return>"authSource"</return> Should be set to the database name where the user is defined
                           it. <return>"connect"</return> If the constructor should connect before returning.
                           Default is <info>true</info>. When set to <info>false</info> the driver will automatically connect
                           to the server whenever it is necessary to do a query. Alternatively, you
                           can run <strong>MongoClient::connect()</strong> manually.  This option is not supported
                           through the connection string. <return>"connectTimeoutMS"</return> How long a connection
                           can take to be opened before timing out in milliseconds. Defaults to
                           <return>60000</return> (60 seconds).  If <return>-1</return> is specified, no connection timeout will be
                           applied and PHP will use default_socket_timeout. <return>"db"</return> The database to
                           authenticate against can be specified here, instead of including it in
                           the host list.  This overrides a database given in the host list. <return>"fsync"</return>
                           When <return>"fsync"</return> is set, all write operations will block until the database
                           has flushed the changes to disk. This makes the write operations slower,
                           but it guarantees that writes have succeeded and that the operations can
                           be recovered in case of total system failure.  If the MongoDB server has
                           journaling enabled, this option is identical to "journal". If journaling
                           is not enabled, this option ensures that write operations will be synced
                           to database files on disk.  If journaling is enabled, users are strongly
                           encouraged to use the <return>"journal"</return> option instead of <return>"fsync"</return>. Do not use
                           <return>"fsync"</return> and <return>"journal"</return> simultaneously, as that will result in an error.
                           <return>"journal"</return> When <return>"journal"</return> is set, all write operations will block until
                           the database has flushed the changes to the journal on disk. This makes
                           the write operations slower, but it guarantees that writes have succeeded
                           and that the operations can be recovered in case of total system failure.
                           If this option is used and journaling is disabled, MongoDB 2.6+ will
                           raise an error and the write will fail; older server versions will simply
                           ignore the option. <return>"gssapiServiceName"</return> Sets the Kerberos service
                           principal. Only applicable when authMechanism=GSSAPI. Defaults to
                           "mongodb". <return>"password"</return> The password can be specified here, instead of
                           including it in the host list.  This is especially useful if a password
                           has a "@" in it. This overrides a password set in the host list.
                           <return>"readPreference"</return> Specifies the read preference type. Read preferences
                           provide you with control from which secondaries data can be read from.
                           Allowed values are: <info>MongoClient::RP_PRIMARY</info>,
                           <info>MongoClient::RP_PRIMARY_PREFERRED</info>, <info>MongoClient::RP_SECONDARY</info>,
                           <info>MongoClient::RP_SECONDARY_PREFERRED</info> and <info>MongoClient::RP_NEAREST</info>.  See the
                           documentation on read preferences for more information.
                           <return>"readPreferenceTags"</return> Specifies the read preference tags as an array of
                           strings. Tags can be used in combination with the <return>readPreference</return> option
                           to further control which secondaries data might be read from.  See the
                           documentation on read preferences for more information. <return>"replicaSet"</return> The
                           name of the replica set to connect to.  If this is given, the primary
                           will be automatically be determined. This means that the driver may end
                           up connecting to a server that was not even listed. See the replica set
                           example below for details. <return>"secondaryAcceptableLatencyMS"</return> When reading
                           from a secondary (using ReadPreferences), do not read from secondaries
                           known to be more then <return>secondaryAcceptableLatencyMS</return> away from us. Defaults
                           to <return>15</return> <return>"socketTimeoutMS"</return> How long a socket operation (read or write) can
                           take before timing out in milliseconds. Defaults to <return>30000</return> (30 seconds).
                           If <return>-1</return> is specified, socket operations may block indefinitely. This option
                           may also be set on a per-operation basis using MongoCursor::timeout for
                           queries or the <return>"socketTimeoutMS"</return> option for write methods.  This is a
                           client-side timeout. If a write operation times out, there is no way to
                           know if the server actually handled the write or not, as a
                           <class>MongoCursorTimeoutException</class> will be thrown in lieu of returning a write
                           result. <return>"ssl"</return> A boolean to specify whether you want to enable SSL for the
                           connections to MongoDB. Extra options such as certificates can be set
                           with . <return>"username"</return> The username can be specified here, instead of
                           including it in the host list.  This is especially useful if a username
                           has a ":" in it. This overrides a username set in the host list. <return>"w"</return> The
                           <return>w</return> option specifies the Write Concern for the driver, which determines how
                           long the driver blocks when writing. The default value is <return>1</return>.  This option
                           is applicable when connecting to both single servers and replica sets. A
                           positive value controls how many nodes must acknowledge the write
                           instruction before the driver continues. A value of <return>1</return> would require the
                           single server or primary (in a replica set) to acknowledge the write
                           operation. A value of <return>3</return> would cause the driver to block until the write
                           has been applied to the primary as well as two secondary servers (in a
                           replica set).  A string value is used to control which tag sets are taken
                           into account for write concerns. <return>"majority"</return> is special and ensures that
                           the write operation has been applied to the majority (more than 50%) of
                           the participating nodes. <return>"wTimeoutMS"</return> This option specifies the time
                           limit, in milliseconds, for write concern acknowledgement. It is only
                           applicable for write operations where <return>"w"</return> is greater than <return>1</return>, as the
                           timeout pertains to replication. If the write concern is not satisfied
                           within the time limit, a <class>MongoCursorException</class> will be thrown. A value of
                           <return>0</return> may be specified to block indefinitely. The default value is <return>10000</return> (ten
                           seconds).
                           
                           <return>"authMechanism"</return>
                           
                           Available mechanisms are:
                           authMechanismDescriptionAvailabilityMONGODB-CRAuthenticate using
                           Challenge Response mechanism. This is the default value.All MongoDB
                           versionsMONGODB-X509Authenticates using X509 certificatesMongoDB 2.6.
                           Only available when  is enabledPLAINAuthenticates using unencrypted plain
                           username+password. Must be used over SSL connections. Generally used by
                           MongoDB to login via 3rd party LDAP serverMongoDB Enterprise 2.4. The
                           Driver must be compiled against CyrusSASL2GSSAPIAuthenticates via
                           kerberos systemsMongoDB Enterprise 2.4. The Driver must be compiled
                           against CyrusSASL2SCRAM-SHA-1Authenticates using SCRAM-SHA-1MongoDB 3.0.
                           
                           <return>"authSource"</return>
                           
                           Should be set to the database name where the user is defined it.
                           
                           <return>"connect"</return>
                           
                           If the constructor should connect before returning.  Default is <info>true</info>.
                           When set to <info>false</info> the driver will automatically connect to the server
                           whenever it is necessary to do a query. Alternatively, you can run
                           <strong>MongoClient::connect()</strong> manually.
                           
                           This option is not supported through the connection string.
                           
                           <return>"connectTimeoutMS"</return>
                           
                           How long a connection can take to be opened before timing out in
                           milliseconds. Defaults to <return>60000</return> (60 seconds).
                           
                           If <return>-1</return> is specified, no connection timeout will be applied and PHP will
                           use default_socket_timeout.
                           
                           <return>"db"</return>
                           
                           The database to authenticate against can be specified here, instead of
                           including it in the host list.  This overrides a database given in the
                           host list.
                           
                           <return>"fsync"</return>
                           
                           When <return>"fsync"</return> is set, all write operations will block until the database
                           has flushed the changes to disk. This makes the write operations slower,
                           but it guarantees that writes have succeeded and that the operations can
                           be recovered in case of total system failure.
                           
                           If the MongoDB server has journaling enabled, this option is identical to
                           "journal". If journaling is not enabled, this option ensures that write
                           operations will be synced to database files on disk.
                           
                           If journaling is enabled, users are strongly encouraged to use the
                           <return>"journal"</return> option instead of <return>"fsync"</return>. Do not use <return>"fsync"</return> and <return>"journal"</return>
                           simultaneously, as that will result in an error.
                           
                           <return>"journal"</return>
                           
                           When <return>"journal"</return> is set, all write operations will block until the database
                           has flushed the changes to the journal on disk. This makes the write
                           operations slower, but it guarantees that writes have succeeded and that
                           the operations can be recovered in case of total system failure.
                           
                           If this option is used and journaling is disabled, MongoDB 2.6+ will
                           raise an error and the write will fail; older server versions will simply
                           ignore the option.
                           
                           <return>"gssapiServiceName"</return>
                           
                           Sets the Kerberos service principal. Only applicable when
                           authMechanism=GSSAPI. Defaults to "mongodb".
                           
                           <return>"password"</return>
                           
                           The password can be specified here, instead of including it in the host
                           list.  This is especially useful if a password has a "@" in it. This
                           overrides a password set in the host list.
                           
                           <return>"readPreference"</return>
                           
                           Specifies the read preference type. Read preferences provide you with
                           control from which secondaries data can be read from.
                           
                           Allowed values are: <info>MongoClient::RP_PRIMARY</info>,
                           <info>MongoClient::RP_PRIMARY_PREFERRED</info>, <info>MongoClient::RP_SECONDARY</info>,
                           <info>MongoClient::RP_SECONDARY_PREFERRED</info> and <info>MongoClient::RP_NEAREST</info>.
                           
                           See the documentation on read preferences for more information.
                           
                           <return>"readPreferenceTags"</return>
                           
                           Specifies the read preference tags as an array of strings. Tags can be
                           used in combination with the <return>readPreference</return> option to further control
                           which secondaries data might be read from.
                           
                           See the documentation on read preferences for more information.
                           
                           <return>"replicaSet"</return>
                           
                           The name of the replica set to connect to.  If this is given, the primary
                           will be automatically be determined. This means that the driver may end
                           up connecting to a server that was not even listed. See the replica set
                           example below for details.
                           
                           <return>"secondaryAcceptableLatencyMS"</return>
                           
                           When reading from a secondary (using ReadPreferences), do not read from
                           secondaries known to be more then <return>secondaryAcceptableLatencyMS</return> away from
                           us. Defaults to <return>15</return>
                           
                           <return>"socketTimeoutMS"</return>
                           
                           How long a socket operation (read or write) can take before timing out in
                           milliseconds. Defaults to <return>30000</return> (30 seconds).
                           
                           If <return>-1</return> is specified, socket operations may block indefinitely. This option
                           may also be set on a per-operation basis using MongoCursor::timeout for
                           queries or the <return>"socketTimeoutMS"</return> option for write methods.
                           
                           This is a client-side timeout. If a write operation times out, there is
                           no way to know if the server actually handled the write or not, as a
                           <class>MongoCursorTimeoutException</class> will be thrown in lieu of returning a write
                           result.
                           
                           <return>"ssl"</return>
                           
                           A boolean to specify whether you want to enable SSL for the connections
                           to MongoDB. Extra options such as certificates can be set with .
                           
                           <return>"username"</return>
                           
                           The username can be specified here, instead of including it in the host
                           list.  This is especially useful if a username has a ":" in it. This
                           overrides a username set in the host list.
                           
                           <return>"w"</return>
                           
                           The <return>w</return> option specifies the Write Concern for the driver, which determines
                           how long the driver blocks when writing. The default value is <return>1</return>.
                           
                           This option is applicable when connecting to both single servers and
                           replica sets. A positive value controls how many nodes must acknowledge
                           the write instruction before the driver continues. A value of <return>1</return> would
                           require the single server or primary (in a replica set) to acknowledge
                           the write operation. A value of <return>3</return> would cause the driver to block until
                           the write has been applied to the primary as well as two secondary
                           servers (in a replica set).
                           
                           A string value is used to control which tag sets are taken into account
                           for write concerns. <return>"majority"</return> is special and ensures that the write
                           operation has been applied to the majority (more than 50%) of the
                           participating nodes.
                           
                           <return>"wTimeoutMS"</return>
                           
                           This option specifies the time limit, in milliseconds, for write concern
                           acknowledgement. It is only applicable for write operations where <return>"w"</return> is
                           greater than <return>1</return>, as the timeout pertains to replication. If the write
                           concern is not satisfied within the time limit, a <class>MongoCursorException</class>
                           will be thrown. A value of <return>0</return> may be specified to block indefinitely. The
                           default value is <return>10000</return> (ten seconds).
                           
                           The following options are deprecated and should no longer be used:
                           <return>"slaveOkay"</return> Deprecated. Please use the read preference options. <return>"timeout"</return>
                           Deprecated alias for <return>"connectTimeoutMS"</return>. <return>"wTimeout"</return> Deprecated alias for
                           <return>"wTimeoutMS"</return>.
                           
                           <return>"slaveOkay"</return>
                           
                           Deprecated. Please use the read preference options.
                           
                           <return>"timeout"</return>
                           
                           Deprecated alias for <return>"connectTimeoutMS"</return>.
                           
                           <return>"wTimeout"</return>
                           
                           Deprecated alias for <return>"wTimeoutMS"</return>.
  <info>array </info>  <strong>$driver_options</strong>  An array of options for the MongoDB driver. Options include setting
                           connection context options for SSL or logging callbacks. <return>"context"</return> The
                           Stream Context to attach to all new connections. This allows you  for
                           example to configure SSL certificates and are described at SSL context
                           options. See the  Connecting over SSL tutorial.
                           
                           <return>"context"</return>
                           
                           The Stream Context to attach to all new connections. This allows you  for
                           example to configure SSL certificates and are described at SSL context
                           options. See the  Connecting over SSL tutorial.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new database connection object.


id: MongoClient::__get
type: function
doc:
<comment>Description:</comment>
  Gets a database
  
  This is the cleanest way of getting a database. If the database name has any special characters,
  <strong>MongoClient::selectDB()</strong> will need to be used; however, this should be sufficient for most cases.
  selectDB("foo");
  $db = $mongo->foo;
  
  ?>
  ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$dbname</strong>  The database name.

<comment>Return:</comment>
  <info>MongoDB</info>  Returns a new db object.


id: MongoClient::__toString
type: function
doc:
<comment>Description:</comment>
  String representation of this connection

<comment>Return:</comment>
  <info>string</info>  Returns hostname and port for this connection.


id: MongoClient::close
type: function
doc:
<comment>Description:</comment>
  Closes this connection
  
  The <strong>MongoClient::close()</strong> method forcefully closes a connection to the database, even if persistent
  connections are being used. You should never have to do this under normal circumstances.

<comment>Param:</comment>
  <info>boolstring</info>  <strong>$connection</strong>  If connection is not given, or <info>false</info> then connection that would be
                           selected for writes would be closed. In a single-node configuration, that
                           is then the whole connection, but if you are connected to a replica set,
                           close() will only close the connection to the primary server.
                           
                           If connection is <info>true</info> then all connections as known by the connection
                           manager will be closed. This can include connections that are not
                           referenced in the connection string used to create the object that you
                           are calling close on.
                           
                           If connection is a string argument, then it will only close the
                           connection identified by this hash. Hashes are identifiers for a
                           connection and can be obtained by calling <strong>MongoClient::getConnections()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns if the connection was successfully closed.

<comment>See Also:</comment>
   * <strong>MongoClient::getConnections()</strong>


id: MongoClient::connect
type: function
doc:
<comment>Description:</comment>
  Connects to a database server

<comment>Return:</comment>
  <info>bool</info>  If the connection was successful.


id: MongoClient::dropDB
type: function
doc:
<comment>Description:</comment>
  Drops a database [deprecated]
  
  Use <strong>MongoDB::drop()</strong> instead.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$db</strong>  The database to drop. Can be a MongoDB object or the name of the database.

<comment>Return:</comment>
  <info>array</info>  Returns the database response.


id: MongoClient::getConnections
type: function
doc:
<comment>Description:</comment>
  Return info about all open connections
  
  Returns an array of all open connections, and information about each of the servers

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of open connections.


id: MongoClient::getHosts
type: function
doc:
<comment>Description:</comment>
  Updates status for all associated hosts
  
  This method is only useful with a connection to a replica set. It returns the status of all of the
  hosts in the set. Without a replica set, it will just return an array with one element containing
  the host that you are connected to.
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Return:</comment>
  <info>array</info>  Returns an array of information about the hosts in the set. Includes each host's hostname,
         its health (1 is healthy), its state (1 is primary, 2 is secondary, 0 is anything else),
         the amount of time it took to ping the server, and when the last ping occurred. For
         example, on a three-member replica set, it might look something like:

<comment>See Also:</comment>
   * <strong>MongoClient::getConnections()</strong>


id: MongoClient::getReadPreference
type: function
doc:
<comment>Description:</comment>
  Get the read preference for this connection

<comment>Return:</comment>
  <info>array</info>  Această funcție întoarce un tablou ce descrie preferința de citire. Tabloul
         conține tipul (<return>type</return>) valorilor pentru șirul cu modul
         preferinței de citire (ce corespunde constantelor <class>MongoClient</class>),
         și <return>tagsets</return> conținând lista tuturor criteriilor setului de
         etichete. Dacă nu a fost specificat nici un set de etichete, <return>tagsets</return>
         nu va fi prezent în tablou.

<comment>See Also:</comment>
   * The read preferences documentation.
   * <strong>MongoClient::setReadPreference()</strong>


id: MongoClient::getWriteConcern
type: function
doc:
<comment>Description:</comment>
  Get the write concern for this connection

<comment>Return:</comment>
  <info>array</info>  Această funcție întoarce un tablou ce descrie gradul de participare la înscriere.
         Tabloul conține valorile <return>w</return> pentru un nivel de confirmare
         întreg sau ca șir de caractere și <return>wtimeout</return> ce denotă numărul
         maximal de milisecunde de așteptare până când serverul satisface gradul de
         participare la înscriere.

<comment>See Also:</comment>
   * The write concern documentation.
   * <strong>MongoClient::setWriteConcern()</strong>


id: MongoClient::killCursor
type: function
doc:
<comment>Description:</comment>
  Kills a specific cursor on the server
  
  In certain situations it might be needed to kill a cursor on the server. Usually cursors time out
  after 10 minutes of inactivity, but it is possible to create an immortal cursor with
  MongoCursor::immortal that never times out. In order to be able to kill such an immortal cursor,
  you can call this method with the information supplied by MongoCursor::info.

<comment>Param:</comment>
  <info>string       </info>  <strong>$server_hash</strong>  The server hash that has the cursor. This can be obtained through
                               MongoCursor::info.
  <info>intMongoInt64</info>  <strong>$id         </strong>  The ID of the cursor to kill. You can either supply an <info>int</info> containing
                               the 64 bit cursor ID, or an object of the <class>MongoInt64</class> class. The
                               latter is necessary on 32 bit platforms (and Windows).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the method attempted to kill a cursor, and <info>false</info> if there was something
        wrong with the arguments (such as a wrong <strong>$server_hash</strong>). The return status does not reflect
        where the cursor was actually killed as the server does not provide that information.


id: MongoClient::listDBs
type: function
doc:
<comment>Description:</comment>
  Lists all of the databases available

<comment>Return:</comment>
  <info>array</info>  Returns an associative array containing three fields.  The first field is <return>databases</return>, which
         in turn contains an array.  Each element of the array is an associative array corresponding
         to a database, giving th database's name, size, and if it's empty.  The other two fields
         are <return>totalSize</return> (in bytes) and <return>ok</return>, which is 1 if this method ran successfully.


id: MongoClient::selectCollection
type: function
doc:
<comment>Description:</comment>
  Gets a database collection

<comment>Param:</comment>
  <info>string</info>  <strong>$db        </strong>  The database name.
  <info>string</info>  <strong>$collection</strong>  The collection name.

<comment>Return:</comment>
  <info>MongoCollection</info>  Returns a new collection object.


id: MongoClient::selectDB
type: function
doc:
<comment>Description:</comment>
  Gets a database

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The database name.

<comment>Return:</comment>
  <info>MongoDB</info>  Returns a new database object.


id: MongoClient::setReadPreference
type: function
doc:
<comment>Description:</comment>
  Set the read preference for this connection

<comment>Param:</comment>
  <info>string</info>  <strong>$read_preference</strong>  Modul preferinței de citire:
                            <info>MongoClient::RP_PRIMARY</info>,
                            <info>MongoClient::RP_PRIMARY_PREFERRED</info>,
                            <info>MongoClient::RP_SECONDARY</info>,
                            <info>MongoClient::RP_SECONDARY_PREFERRED</info> sau
                            <info>MongoClient::RP_NEAREST</info>.
  <info>array </info>  <strong>$tags           </strong>  Un tablou din zero sau mai multe seturi de etichete, unde fiecare
                            set de etichete este la rândul său un tablou de criterii utilizate
                            pentru a
                            potrivi etichetele pe membrii setului de replicare.

<comment>Return:</comment>
  <info>bool</info>  Întoarce <info>true</info> în caz de succes, sau <info>false</info> în caz contrar.

<comment>See Also:</comment>
   * The read preferences documentation.
   * <strong>MongoClient::getReadPreference()</strong>


id: MongoClient::setWriteConcern
type: function
doc:
<comment>Description:</comment>
  Set the write concern for this connection

<comment>Param:</comment>
  <info>mixed</info>  <strong>$w       </strong>  Gradul de participare la înscriere. Aceasta poate fi un întreg
                    ce denotă numărul de servere necesare pentru a confirma operațiunea de
                    înscriere,
                    sau un mod scris ca șir de caractere (de ex. "majority").
  <info>int  </info>  <strong>$wtimeout</strong>  Numărul maximal de milisecunde de așteptare până când serverul
                    satisface gradul de participare la înscriere.

<comment>Return:</comment>
  <info>bool</info>  Întoarce <info>true</info> în caz de succes, sau <info>false</info> în caz contrar.

<comment>See Also:</comment>
   * The write concern documentation.
   * <strong>MongoClient::getWriteConcern()</strong>


id: MongoCode
type: class
doc:
<comment>Description:</comment>
  Represents JavaScript code for the database.
  
  MongoCode objects are composed of two parts: a string of code and an optional scope.  The string
  of code must be valid JavaScript.  The scope is a associative array of variable name/value pairs.


id: MongoCode::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new code object

<comment>Param:</comment>
  <info>string</info>  <strong>$code </strong>  A string of code.
  <info>array </info>  <strong>$scope</strong>  The scope to use for the code.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new code object.


id: MongoCode::__toString
type: function
doc:
<comment>Description:</comment>
  Returns this code as a string

<comment>Return:</comment>
  <info>string</info>  This code, the scope is not returned.


id: MongoCollection
type: class
doc:
<comment>Description:</comment>
  Represents a MongoDB collection.
  
  Collection names can use any character in the ASCII set.  Some valid  collection names are "",
  "...",  "my collection", and "*&#@".
  
  User-defined collection names cannot contain the $ symbol.  There are  certain system collections
  which use a $ in their names (e.g.,  local.oplog.$main), but it is a reserved character.  If you
  attempt to  create and use a collection with a $ in the name, MongoDB will assert.


id: MongoCollection::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new collection

<comment>Param:</comment>
  <info>MongoDB</info>  <strong>$db  </strong>  Parent database.
  <info>string </info>  <strong>$name</strong>  Name for this collection.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new collection object.


id: MongoCollection::__get
type: function
doc:
<comment>Description:</comment>
  Gets a collection
  
  A concise syntax for getting a collection with a dot-separated name.  If a collection name
  contains strange characters, you may have to use <strong>MongoDB::selectCollection()</strong> instead.
  selectDB("foo")->selectCollection("bar.baz");
  $collection = $mongo->foo->bar->baz;
  
  ?>
  ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The next string in the collection name.

<comment>Return:</comment>
  <info>MongoCollection</info>  Returns the collection.


id: MongoCollection::__toString
type: function
doc:
<comment>Description:</comment>
  String representation of this collection

<comment>Return:</comment>
  <info>string</info>  Returns the full name of this collection.


id: MongoCollection::aggregate
type: function
doc:
<comment>Description:</comment>
  Perform an aggregation using the aggregation framework
  
  The MongoDB aggregation framework provides a means to calculate aggregated values without having
  to use MapReduce. While MapReduce is powerful, it is often more difficult than necessary for many
  simple aggregation tasks, such as totaling or averaging field values.
  
  This method accepts either a variable amount of pipeline operators, or a single array of operators
  constituting the pipeline.

<comment>Param:</comment>
  <info>array</info>  <strong>$pipeline</strong>  An array of pipeline operators.
  <info>array</info>  <strong>$options </strong>  Options for the aggregation command. Valid options include:
                    
                    <return>"allowDiskUse"</return>
                    
                    Allow aggregation stages to write to temporary files
                    
                    <return>"cursor"</return>
                    
                    Options controlling the creation of the cursor object. This option causes the
                    command to return a result document suitable for constructing a
                    <class>MongoCommandCursor</class>. If you need to use this option, you should consider using
                    MongoCollection::aggregateCursor.
                    
                    <return>"explain"</return>
                    
                    Return information on the processing of the pipeline.
                    
                    <return>"maxTimeMS"</return>
                    
                    Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                    operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                    terminată pe server în timpul rezervat, va fi emisă o
                    <class>MongoExecutionTimeoutException</class>.
  <info>array</info>  <strong>$op      </strong>  First pipeline operator.
  <info>array</info>  <strong>$ops     </strong>  Additional pipeline operators.

<comment>Return:</comment>
  <info>array</info>  The result of the aggregation as an array. The ok will be set to <return>1</return> on success, <return>0</return> on
         failure.

<comment>See Also:</comment>
   * MongoCollection::aggregateCursor
   * The MongoDB aggregation framework


id: MongoCollection::aggregateCursor
type: function
doc:
<comment>Description:</comment>
  Execute an aggregation pipeline command and retrieve results through a cursor
  
  With this method you can execute Aggregation Framework pipelines and retrieve the results through
  a cursor, instead of getting just one document back as you would with MongoCollection::aggregate.
  This method returns a <class>MongoCommandCursor</class> object. This cursor object implements the <class>Iterator</class>
  interface just like the <class>MongoCursor</class> objects that are returned by the MongoCollection::find method.
  
  The resulting <class>MongoCommandCursor</class> will inherit this collection's read preference.
  MongoCommandCursor::setReadPreference may be used to change the read preference before iterating
  on the cursor.

<comment>Param:</comment>
  <info>     </info>  <strong>$pipeline</strong>  The Aggregation Framework pipeline to execute.
  <info>array</info>  <strong>$options </strong>  Options for the aggregation command. Valid options include:
                    
                    <return>"allowDiskUse"</return>
                    
                    Allow aggregation stages to write to temporary files
                    
                    <return>"cursor"</return>
                    
                    It is possible to configure how many initial documents the server should return
                    with the first result set. The default initial batch size is <return>101</return>. You can change
                    it by adding the <return>batchSize</return> option:
                    
                    This option only configures the size of the first batch. To configure the size
                    of future batches, please use the MongoCommandCursor::batchSize method on the
                    returned <class>MongoCommandCursor</class> object.
                    
                    <return>"explain"</return>
                    
                    Return information on the processing of the pipeline. This option may cause the
                    command to return a result document that is unsuitable for constructing a
                    <class>MongoCommandCursor</class>. If you need to use this option, you should consider using
                    MongoCollection::aggregate.
                    
                    <return>"maxTimeMS"</return>
                    
                    Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                    operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                    terminată pe server în timpul rezervat, va fi emisă o
                    <class>MongoExecutionTimeoutException</class>.

<comment>Return:</comment>
  <info>MongoCommandCursor</info>  Returns a <class>MongoCommandCursor</class> object. Because this implements the <class>Iterator</class>
                      interface you can  iterate over each of the results as returned by the command
                      query. The <class>MongoCommandCursor</class> also implements the <class>MongoCursorInterface</class>
                      interface which adds the MongoCommandCursor::batchSize,
                      MongoCommandCursor::dead, MongoCommandCursor::info methods.

<comment>See Also:</comment>
   * MongoDB::command
   * <class>MongoCommandCursor</class>
   * MongoCommandCursor::batchSize
   * MongoCollection::aggregate
   * The MongoDB aggregation framework


id: MongoCollection::batchInsert
type: function
doc:
<comment>Description:</comment>
  Inserts multiple documents into this collection

<comment>Param:</comment>
  <info>array</info>  <strong>$a      </strong>  An array of arrays or objects. If any objects are used, they may not have
                   protected or private properties.
                   
                   If the documents to insert do not have an <return>_id</return> key or property, a new <class>MongoId</class>
                   instance will be created and assigned to it. See <strong>MongoCollection::insert()</strong> for
                   additional information on this behavior.
  <info>array</info>  <strong>$options</strong>  An array of options for the batch of insert operations. Currently available
                   options include: <return>"continueOnError"</return> Boolean, defaults to <info>false</info>. If set, the
                   database will not stop processing a bulk insert if one fails (eg due to duplicate
                   IDs). This makes bulk insert behave similarly to a series of single inserts,
                   except that calling <strong>MongoDB::lastError()</strong> will have an error set if any insert
                   fails, not just the last one. If multiple errors occur, only the most recent will
                   be reported by <strong>MongoDB::lastError()</strong>.  Please note that <return>continueOnError</return> affects
                   errors on the database side only. If you try to insert a document that has errors
                   (for example it contains a key with an empty name), then the document is not even
                   transferred to the database as the driver detects this error and bails out.
                   <return>continueOnError</return> has no effect on errors detected in the documents by the driver.
                   <return>"fsync"</return>O valoare boolean-ă, valoarea
                   implicită este <info>false</info>. Dacă jurnalizarea e activată, ea funcționează exact ca
                   <return>"j"</return>. Dacă jurnalizarea nu este acticvată, atunci se forțează
                   sincronizarea pe disc a operațiunii de inserare înainte de a întoarce succes.
                   Dacă are valoarea <info>true</info>, se presupune efectuarea
                   unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                   <return>0</return>.Dacă jurnalizarea este activată, utilizatorii sunt încurajați să
                   utilizeze opțiunea <return>"j"</return> în loc de <return>"fsync"</return>.
                   Nu utilizați <return>"fsync"</return> și <return>"j"</return> simultan,
                   deoarece aceasta va rezulta în eroare.<return>"j"</return>O valoare boolean-ă, cu valoarea
                   implicită <info>false</info>. Forțează sincronizarea cu jurnalul a operațiunii de inserare,
                   înainte de a întoarce succes. Dacă are valoarea <info>true</info>, se presupune efectuarea
                   unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                   <return>0</return>.Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată,
                   MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi ale
                   serverului pur și simplu vor ignora opțiunea.<return>"socketTimeoutMS"</return>Această opțiune
                   specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).<return>"w"</return>Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.<return>"wTimeoutMS"</return>Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   <return>"continueOnError"</return>
                   
                   Boolean, defaults to <info>false</info>. If set, the database will not stop processing a bulk
                   insert if one fails (eg due to duplicate IDs). This makes bulk insert behave
                   similarly to a series of single inserts, except that calling <strong>MongoDB::lastError()</strong>
                   will have an error set if any insert fails, not just the last one. If multiple
                   errors occur, only the most recent will be reported by <strong>MongoDB::lastError()</strong>.
                   
                   Please note that <return>continueOnError</return> affects errors on the database side only. If you
                   try to insert a document that has errors (for example it contains a key with an
                   empty name), then the document is not even transferred to the database as the
                   driver detects this error and bails out. <return>continueOnError</return> has no effect on errors
                   detected in the documents by the driver.
                   
                   <return>"fsync"</return>
                   
                   O valoare boolean-ă, valoarea
                   implicită este <info>false</info>. Dacă jurnalizarea e activată, ea funcționează exact ca
                   <return>"j"</return>. Dacă jurnalizarea nu este acticvată, atunci se forțează
                   sincronizarea pe disc a operațiunii de inserare înainte de a întoarce succes.
                   Dacă are valoarea <info>true</info>, se presupune efectuarea
                   unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                   <return>0</return>.
                   
                   Dacă jurnalizarea este activată, utilizatorii sunt încurajați să
                   utilizeze opțiunea <return>"j"</return> în loc de <return>"fsync"</return>.
                   Nu utilizați <return>"fsync"</return> și <return>"j"</return> simultan,
                   deoarece aceasta va rezulta în eroare.
                   
                   <return>"j"</return>
                   
                   O valoare boolean-ă, cu valoarea
                   implicită <info>false</info>. Forțează sincronizarea cu jurnalul a operațiunii de inserare,
                   înainte de a întoarce succes. Dacă are valoarea <info>true</info>, se presupune efectuarea
                   unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                   <return>0</return>.
                   
                   Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată,
                   MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi ale
                   serverului pur și simplu vor ignora opțiunea.
                   
                   <return>"socketTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).
                   
                   <return>"w"</return>
                   
                   Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.
                   
                   <return>"wTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   The following options are deprecated and should no longer be used:
                   <return>"safe"</return>Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.<return>"timeout"</return>Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.<return>"wtimeout"</return>Un pseudonim
                   învechit pentru
                   <return>"wTimeoutMS"</return>.
                   
                   <return>"safe"</return>
                   
                   Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.
                   
                   <return>"timeout"</return>
                   
                   Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.
                   
                   <return>"wtimeout"</return>
                   
                   Un pseudonim învechit pentru
                   <return>"wTimeoutMS"</return>.

<comment>Return:</comment>
  <info>mixed</info>  If the <return>w</return> parameter is set to acknowledge the write, returns an associative array with the
         status of the inserts ("ok") and any error that may have occurred ("err").  Otherwise,
         returns <info>true</info> if the batch insert was successfully sent, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoCollection::insert()</strong>
   * <strong>MongoCollection::update()</strong>
   * <strong>MongoCollection::find()</strong>
   * <strong>MongoCollection::remove()</strong>
   * MongoDB core docs on insert.


id: MongoCollection::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of documents in this collection

<comment>Param:</comment>
  <info>array</info>  <strong>$query  </strong>  Associative array or object with fields to match.
  <info>array</info>  <strong>$options</strong>  An array of options for the index creation. Currently available options include:
                   DenumireTipDescrierehint<info>mixed</info> Index to use for the query. If a string is passed,
                   it should correspond to an index name. If an array or object is passed, it should
                   correspond to the specification used to create the index (i.e. the first argument
                   to <strong>MongoCollection::createIndex()</strong>). This option is only supported in MongoDB
                   2.6+.limit<info>int</info>The maximum number of matching documents to return.maxTimeMS<info>int</info>
                   Specifies a cumulative time limit in milliseconds for processing the operation
                   (does not include idle time). If the operation is not completed within the
                   timeout period, a <class>MongoExecutionTimeoutException</class> will be thrown. This option is
                   only supported in MongoDB 2.6+.skip<info>int</info>The number of matching documents to skip
                   before returning results.
                   
                   Index to use for the query. If a string is passed, it should correspond to an
                   index name. If an array or object is passed, it should correspond to the
                   specification used to create the index (i.e. the first argument to
                   <strong>MongoCollection::createIndex()</strong>).
                   
                   This option is only supported in MongoDB 2.6+.
                   
                   Specifies a cumulative time limit in milliseconds for processing the operation
                   (does not include idle time). If the operation is not completed within the
                   timeout period, a <class>MongoExecutionTimeoutException</class> will be thrown.
                   
                   This option is only supported in MongoDB 2.6+.

<comment>Return:</comment>
  <info>int</info>  Returns the number of documents matching the query.


id: MongoCollection::createDBRef
type: function
doc:
<comment>Description:</comment>
  Creates a database reference

<comment>Param:</comment>
  <info>mixed</info>  <strong>$document_or_id</strong>  If an array or object is given, its <return>_id</return> field will be used as the
                          reference ID. If a <class>MongoId</class> or scalar is given, it will be used as the
                          reference ID.

<comment>Return:</comment>
  <info>array</info>  Returns a database reference array.
         
         If an array without an <return>_id</return> field was provided as the <return>document_or_id</return> parameter, <info>null</info> will be
         returned.

<comment>See Also:</comment>
   * MongoCollection::getDBRef


id: MongoCollection::createIndex
type: function
doc:
<comment>Description:</comment>
  Creates an index on the specified field(s) if it does not already exist
    
  
  Creates an index on the specified field(s) if it does not already exist. Fields may be indexed
  with a direction (e.g. ascending or descending) or a special type (e.g. text, geospatial, hashed).
  
  This method will use the createIndexes database command when communicating with MongoDB 2.6+. For
  previous database versions, the method will perform an insert operation on the special
  <return>system.indexes</return> collection.

<comment>Param:</comment>
  <info>array</info>  <strong>$keys   </strong>  An array specifying the index's fields as its keys. For each field, the value is
                   either the index direction or index type. If specifying direction, specify <return>1</return> for
                   ascending or <return>-1</return> for descending.
  <info>array</info>  <strong>$options</strong>  An array of options for the index creation. We pass all given options straight to
                   the server, but a non-exhaustive list of currently available options include:
                   <return>"unique"</return>Specificați <info>true</info> pentru a crea
                   un indice unic. Valoarea implicită este <info>false</info>. Această opțiune se aplică doar
                   pentru indici ascendenți/descendenți.Când MongoDB indexează un câmp,
                   dacă un document nu are valoare pentru acel câmp, o valoare <info>null</info> este indexată.
                   Dacă mai multe documente nu conțin câmpul, un indice unic va respinge toate
                   documentele în afară de primul. Opiunea <return>"sparse"</return> poate fi
                   utilizată pentru a depăși aceasta, deoarece ea va preveni indexarea documentelor
                   fără valoarea câmpului.<return>"sparse"</return>Specificați <info>true</info> pentru a crea un indice
                   distribuit, ce indexează doar
                   documente ce conțin un anumit câmp. Valoarea implicită e
                   <info>false</info>.<return>"expireAfterSeconds"</return>Valoarea acestei opțiuni ar trebui să specifice numărul
                   de secunde după
                   care un document ar trebui să fie considerat expirat și automat eliminat din
                   colecție. Această opțiune este compatibilă doar cu indici pe un singur câmp, unde
                   câmpul va conține valori <class>MongoDate</class>.Această facilitate este
                   disponibilă în MongoDB 2.2+. A se vedea
                   Expirarea Datelor din Colecții prin Stabilirea TTL
                   pentru informații suplimentare.<return>"name"</return>Un nume opțional care identifică
                   univoc indicele.Implicit driver-ul va genera
                   un nume al indicelui bazat pe câmpurile lui și ordinea de sortare sau tip. De
                   exemplu, un indice compus <return>array("x" =&gt; 1, "y" =&gt; -1)</return> va fi
                   numit <return>"x_1_y_-1"</return> și un indice geospațial
                   <return>array("loc" =&gt; "2dsphere")</return> va fi numit <return>"loc_2dsphere"</return>.
                   Pentru indici cu mai multe câmpuri este posibil ca numele generat să depășească
                   limita pentru denumirile indicilor
                   din MongoDB. Opțiunea <return>"name"</return> poate fi folosită în acest caz
                   pentru a furniza un nume mai scurt.<return>"background"</return>Calculează indicele în fundal,
                   pentru ca aceasta să nu
                   blocheze alte activități ale bazei de date. Specificați <info>true</info> pentru a calcula
                   în fundal. Valoarea implicită e <info>false</info>.Înainte de MongoDB 2.6.0,
                   calculele indicilor erau executate ca operațiuni în prim plan, indiferent de
                   această opțiune. A se vedea
                   Calcularea Indicilor cu Seturi de Replici
                   pentru informații suplimentare.<return>"socketTimeoutMS"</return>Această opțiune specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).
                   
                   <return>"unique"</return>
                   
                   Specificați <info>true</info> pentru a crea
                   un indice unic. Valoarea implicită este <info>false</info>. Această opțiune se aplică doar
                   pentru indici ascendenți/descendenți.
                   
                   Când MongoDB indexează un câmp,
                   dacă un document nu are valoare pentru acel câmp, o valoare <info>null</info> este indexată.
                   Dacă mai multe documente nu conțin câmpul, un indice unic va respinge toate
                   documentele în afară de primul. Opiunea <return>"sparse"</return> poate fi
                   utilizată pentru a depăși aceasta, deoarece ea va preveni indexarea documentelor
                   fără valoarea câmpului.
                   
                   <return>"sparse"</return>
                   
                   Specificați <info>true</info> pentru a crea un indice distribuit, ce indexează doar
                   documente ce conțin un anumit câmp. Valoarea implicită e <info>false</info>.
                   
                   <return>"expireAfterSeconds"</return>
                   
                   Valoarea acestei opțiuni ar trebui să specifice numărul de secunde după
                   care un document ar trebui să fie considerat expirat și automat eliminat din
                   colecție. Această opțiune este compatibilă doar cu indici pe un singur câmp, unde
                   câmpul va conține valori <class>MongoDate</class>.
                   
                   Această facilitate este
                   disponibilă în MongoDB 2.2+. A se vedea
                   Expirarea Datelor din Colecții prin Stabilirea TTL
                   pentru informații suplimentare.
                   
                   <return>"name"</return>
                   
                   Un nume opțional care identifică
                   univoc indicele.
                   
                   Implicit driver-ul va genera
                   un nume al indicelui bazat pe câmpurile lui și ordinea de sortare sau tip. De
                   exemplu, un indice compus <return>array("x" =&gt; 1, "y" =&gt; -1)</return> va fi
                   numit <return>"x_1_y_-1"</return> și un indice geospațial
                   <return>array("loc" =&gt; "2dsphere")</return> va fi numit <return>"loc_2dsphere"</return>.
                   Pentru indici cu mai multe câmpuri este posibil ca numele generat să depășească
                   limita pentru denumirile indicilor
                   din MongoDB. Opțiunea <return>"name"</return> poate fi folosită în acest caz
                   pentru a furniza un nume mai scurt.
                   
                   <return>"background"</return>
                   
                   Calculează indicele în fundal, pentru ca aceasta să nu
                   blocheze alte activități ale bazei de date. Specificați <info>true</info> pentru a calcula
                   în fundal. Valoarea implicită e <info>false</info>.
                   
                   Înainte de MongoDB 2.6.0,
                   calculele indicilor erau executate ca operațiuni în prim plan, indiferent de
                   această opțiune. A se vedea
                   Calcularea Indicilor cu Seturi de Replici
                   pentru informații suplimentare.
                   
                   <return>"socketTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).
                   
                   The following option may be used with MongoDB 2.6+: <return>"maxTimeMS"</return>Specifică o limită
                   de timp cumulativă în milisecunde pentru procesarea
                   operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                   terminată pe server în timpul rezervat, va fi emisă o
                   <class>MongoExecutionTimeoutException</class>.
                   
                   <return>"maxTimeMS"</return>
                   
                   Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                   operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                   terminată pe server în timpul rezervat, va fi emisă o
                   <class>MongoExecutionTimeoutException</class>.
                   
                   The following options may be used with MongoDB versions before 2.8:
                   <return>"dropDups"</return>Specificați <info>true</info> pentru a forța
                   crearea unui indice unic, când colecția poate conține dubluri pentru o cheie.
                   MongoDB va indexa prima apariție a cheii și va elimina toate documentele din
                   colecție care conțin următoarele apariții ale acelei chei. Valoarea implicită e
                   <info>false</info>.<return>"dropDups"</return>
                   poate să elimine date din baza dumneavoastră de date. Folosiți cu mare precauție.
                   Această opțiune
                   nu este susținută de MongoDB 2.8+. Crearea indicelui va eșua dacă colecția
                   conține
                   dubluri.
                   
                   <return>"dropDups"</return>
                   
                   Specificați <info>true</info> pentru a forța
                   crearea unui indice unic, când colecția poate conține dubluri pentru o cheie.
                   MongoDB va indexa prima apariție a cheii și va elimina toate documentele din
                   colecție care conțin următoarele apariții ale acelei chei. Valoarea implicită e
                   <info>false</info>.
                   
                   <return>"dropDups"</return>
                   poate să elimine date din baza dumneavoastră de date. Folosiți cu mare precauție.
                   
                   Această opțiune
                   nu este susținută de MongoDB 2.8+. Crearea indicelui va eșua dacă colecția
                   conține
                   dubluri.
                   
                   The following options may be used with MongoDB versions before 2.6: <return>"w"</return>Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.<return>"wTimeoutMS"</return>Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   <return>"w"</return>
                   
                   Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.
                   
                   <return>"wTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   The following options are deprecated and should no longer be used:
                   <return>"safe"</return>Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.<return>"timeout"</return>Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.<return>"wtimeout"</return>Un pseudonim
                   învechit pentru
                   <return>"wTimeoutMS"</return>.
                   
                   <return>"safe"</return>
                   
                   Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.
                   
                   <return>"timeout"</return>
                   
                   Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.
                   
                   <return>"wtimeout"</return>
                   
                   Un pseudonim învechit pentru
                   <return>"wTimeoutMS"</return>.

<comment>Return:</comment>
  <info>bool</info>  Returns an array containing the status of the index creation. The array contains whether the
        operation succeeded (<return>"ok"</return>), the number of indexes before and after the operation
        (<return>"numIndexesBefore"</return> and <return>"numIndexesAfter"</return>), and whether the collection that the index
        belongs to has been created (<return>"createdCollectionAutomatically"</return>). If the index already existed
        and did not need to be created, a <return>"note"</return> field may be present in lieu of <return>"numIndexesAfter"</return>.
        
        With MongoDB 2.4 and earlier, a status document is only returned if the write concern is at
        least <return>1</return>. Otherwise, <info>true</info> is returned. The fields in the status document are different,
        except for the <return>"ok"</return> field, which signals whether the index creation was successful.
        Additional fields are described in the documentation for <strong>MongoCollection::insert()</strong>.

<comment>See Also:</comment>
   * MongoCollection::deleteIndex
   * MongoCollection::deleteIndexes
   * 
    The MongoDB
    index and
    index type
    documentation.
   


id: MongoCollection::deleteIndex
type: function
doc:
<comment>Description:</comment>
  Deletes an index from this collection
  
  This method is identical to:
  
  Each index is given a unique name when it is created. This is often generated by the driver based
  on the index key(s) and order/type, but custom names may also be specified with
  <strong>MongoCollection::createIndex()</strong>'s <return>"name"</return> option).
  
  Unfortunately, <strong>MongoCollection::deleteIndex()</strong> cannot delete custom-named indexes due to a
  backwards compatibility issue. When a string argument is provided, it is assumed to be the single
  field name in an ascending index (e.g. the name <return>"x_1"</return> would be used for the argument <return>"x"</return>). If an
  array or object is provided, an index name is generated just as if that argument was passed to
  <strong>MongoCollection::createIndex()</strong>.
  
  In order to delete a custom-named index with the PHP driver, the <return>deleteIndexes</return> database command
  must be used. For instance, an index named "myIndex" could be deleted with the PHP driver by
  running:
  
  To determine the name of an index with the PHP driver, you can query the <return>system.indexes</return> collection
  of a database and look for the <return>"name"</return> field of each result. The <return>"ns"</return> field will indicate the
  collection to which each index belongs.

<comment>Param:</comment>
  <info>stringarray</info>  <strong>$keys</strong>  An array specifying the index's fields as its keys. For each field, the value
                      is either the index direction or index type. If specifying direction, specify
                      <return>1</return> for ascending or <return>-1</return> for descending.
                      
                      If a string is provided, it is assumed to be the single field name in an
                      ascending index.

<comment>Return:</comment>
  <info>array</info>  Returns the database response.

<comment>See Also:</comment>
   * MongoCollection::createIndex
   * MongoCollection::deleteIndexes
   * MongoCollection::toIndexString
   * 
    The MongoDB
    index and
    index type
    documentation.
   


id: MongoCollection::deleteIndexes
type: function
doc:
<comment>Description:</comment>
  Delete all indices for this collection

<comment>Return:</comment>
  <info>array</info>  Returns the database response.

<comment>See Also:</comment>
   * MongoCollection::createIndex
   * MongoCollection::deleteIndex


id: MongoCollection::distinct
type: function
doc:
<comment>Description:</comment>
  Retrieve a list of distinct values for the given key across a collection
  
  The distinct command returns a list of distinct values for the given key across a collection.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  The key to use.
  <info>array </info>  <strong>$query</strong>  An optional query parameters

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an array of distinct values,  sau <info>false</info> în cazul eșecului


id: MongoCollection::drop
type: function
doc:
<comment>Description:</comment>
  Drops this collection
  
  Drops this collection and deletes its indices.

<comment>Return:</comment>
  <info>array</info>  Returns the database response.


id: MongoCollection::ensureIndex
type: function
doc:
<comment>Description:</comment>
  Creates an index on the specified field(s) if it does not already exist
    
  
  This method is deprecated since version 1.5.0. Please use MongoCollection::createIndex instead.
  
  Creates an index on the specified field(s) if it does not already exist. Fields may be indexed
  with a direction (e.g. ascending or descending) or a special type (e.g. text, geospatial, hashed).
  
  This method will use the createIndexes database command when communicating with MongoDB 2.6+. For
  previous database versions, the method will perform an insert operation on the special
  <return>system.indexes</return> collection.

<comment>Param:</comment>
  <info>     </info>  <strong>$keys   </strong>  An array specifying the index's fields as its keys. For each field, the value is
                   either the index direction or index type. If specifying direction, specify <return>1</return> for
                   ascending or <return>-1</return> for descending.
  <info>array</info>  <strong>$options</strong>  An array of options for the index creation. Currently available options include:
                   <return>"unique"</return>Specificați <info>true</info> pentru a crea
                   un indice unic. Valoarea implicită este <info>false</info>. Această opțiune se aplică doar
                   pentru indici ascendenți/descendenți.Când MongoDB indexează un câmp,
                   dacă un document nu are valoare pentru acel câmp, o valoare <info>null</info> este indexată.
                   Dacă mai multe documente nu conțin câmpul, un indice unic va respinge toate
                   documentele în afară de primul. Opiunea <return>"sparse"</return> poate fi
                   utilizată pentru a depăși aceasta, deoarece ea va preveni indexarea documentelor
                   fără valoarea câmpului.<return>"sparse"</return>Specificați <info>true</info> pentru a crea un indice
                   distribuit, ce indexează doar
                   documente ce conțin un anumit câmp. Valoarea implicită e
                   <info>false</info>.<return>"expireAfterSeconds"</return>Valoarea acestei opțiuni ar trebui să specifice numărul
                   de secunde după
                   care un document ar trebui să fie considerat expirat și automat eliminat din
                   colecție. Această opțiune este compatibilă doar cu indici pe un singur câmp, unde
                   câmpul va conține valori <class>MongoDate</class>.Această facilitate este
                   disponibilă în MongoDB 2.2+. A se vedea
                   Expirarea Datelor din Colecții prin Stabilirea TTL
                   pentru informații suplimentare.<return>"name"</return>Un nume opțional care identifică
                   univoc indicele.Implicit driver-ul va genera
                   un nume al indicelui bazat pe câmpurile lui și ordinea de sortare sau tip. De
                   exemplu, un indice compus <return>array("x" =&gt; 1, "y" =&gt; -1)</return> va fi
                   numit <return>"x_1_y_-1"</return> și un indice geospațial
                   <return>array("loc" =&gt; "2dsphere")</return> va fi numit <return>"loc_2dsphere"</return>.
                   Pentru indici cu mai multe câmpuri este posibil ca numele generat să depășească
                   limita pentru denumirile indicilor
                   din MongoDB. Opțiunea <return>"name"</return> poate fi folosită în acest caz
                   pentru a furniza un nume mai scurt.<return>"background"</return>Calculează indicele în fundal,
                   pentru ca aceasta să nu
                   blocheze alte activități ale bazei de date. Specificați <info>true</info> pentru a calcula
                   în fundal. Valoarea implicită e <info>false</info>.Înainte de MongoDB 2.6.0,
                   calculele indicilor erau executate ca operațiuni în prim plan, indiferent de
                   această opțiune. A se vedea
                   Calcularea Indicilor cu Seturi de Replici
                   pentru informații suplimentare.<return>"socketTimeoutMS"</return>Această opțiune specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).
                   
                   <return>"unique"</return>
                   
                   Specificați <info>true</info> pentru a crea
                   un indice unic. Valoarea implicită este <info>false</info>. Această opțiune se aplică doar
                   pentru indici ascendenți/descendenți.
                   
                   Când MongoDB indexează un câmp,
                   dacă un document nu are valoare pentru acel câmp, o valoare <info>null</info> este indexată.
                   Dacă mai multe documente nu conțin câmpul, un indice unic va respinge toate
                   documentele în afară de primul. Opiunea <return>"sparse"</return> poate fi
                   utilizată pentru a depăși aceasta, deoarece ea va preveni indexarea documentelor
                   fără valoarea câmpului.
                   
                   <return>"sparse"</return>
                   
                   Specificați <info>true</info> pentru a crea un indice distribuit, ce indexează doar
                   documente ce conțin un anumit câmp. Valoarea implicită e <info>false</info>.
                   
                   <return>"expireAfterSeconds"</return>
                   
                   Valoarea acestei opțiuni ar trebui să specifice numărul de secunde după
                   care un document ar trebui să fie considerat expirat și automat eliminat din
                   colecție. Această opțiune este compatibilă doar cu indici pe un singur câmp, unde
                   câmpul va conține valori <class>MongoDate</class>.
                   
                   Această facilitate este
                   disponibilă în MongoDB 2.2+. A se vedea
                   Expirarea Datelor din Colecții prin Stabilirea TTL
                   pentru informații suplimentare.
                   
                   <return>"name"</return>
                   
                   Un nume opțional care identifică
                   univoc indicele.
                   
                   Implicit driver-ul va genera
                   un nume al indicelui bazat pe câmpurile lui și ordinea de sortare sau tip. De
                   exemplu, un indice compus <return>array("x" =&gt; 1, "y" =&gt; -1)</return> va fi
                   numit <return>"x_1_y_-1"</return> și un indice geospațial
                   <return>array("loc" =&gt; "2dsphere")</return> va fi numit <return>"loc_2dsphere"</return>.
                   Pentru indici cu mai multe câmpuri este posibil ca numele generat să depășească
                   limita pentru denumirile indicilor
                   din MongoDB. Opțiunea <return>"name"</return> poate fi folosită în acest caz
                   pentru a furniza un nume mai scurt.
                   
                   <return>"background"</return>
                   
                   Calculează indicele în fundal, pentru ca aceasta să nu
                   blocheze alte activități ale bazei de date. Specificați <info>true</info> pentru a calcula
                   în fundal. Valoarea implicită e <info>false</info>.
                   
                   Înainte de MongoDB 2.6.0,
                   calculele indicilor erau executate ca operațiuni în prim plan, indiferent de
                   această opțiune. A se vedea
                   Calcularea Indicilor cu Seturi de Replici
                   pentru informații suplimentare.
                   
                   <return>"socketTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru comunicarea prin socket. Dacă serverul nu
                   răspunde în limita intervalului de timp, se va emite o
                   <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                   de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                   <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                   nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                   <return>30000</return> (30 secunde).
                   
                   The following option may be used with MongoDB 2.6+: <return>"maxTimeMS"</return>Specifică o limită
                   de timp cumulativă în milisecunde pentru procesarea
                   operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                   terminată pe server în timpul rezervat, va fi emisă o
                   <class>MongoExecutionTimeoutException</class>.
                   
                   <return>"maxTimeMS"</return>
                   
                   Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                   operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                   terminată pe server în timpul rezervat, va fi emisă o
                   <class>MongoExecutionTimeoutException</class>.
                   
                   The following options may be used with MongoDB versions before 2.8:
                   <return>"dropDups"</return>Specificați <info>true</info> pentru a forța
                   crearea unui indice unic, când colecția poate conține dubluri pentru o cheie.
                   MongoDB va indexa prima apariție a cheii și va elimina toate documentele din
                   colecție care conțin următoarele apariții ale acelei chei. Valoarea implicită e
                   <info>false</info>.<return>"dropDups"</return>
                   poate să elimine date din baza dumneavoastră de date. Folosiți cu mare precauție.
                   Această opțiune
                   nu este susținută de MongoDB 2.8+. Crearea indicelui va eșua dacă colecția
                   conține
                   dubluri.
                   
                   <return>"dropDups"</return>
                   
                   Specificați <info>true</info> pentru a forța
                   crearea unui indice unic, când colecția poate conține dubluri pentru o cheie.
                   MongoDB va indexa prima apariție a cheii și va elimina toate documentele din
                   colecție care conțin următoarele apariții ale acelei chei. Valoarea implicită e
                   <info>false</info>.
                   
                   <return>"dropDups"</return>
                   poate să elimine date din baza dumneavoastră de date. Folosiți cu mare precauție.
                   
                   Această opțiune
                   nu este susținută de MongoDB 2.8+. Crearea indicelui va eșua dacă colecția
                   conține
                   dubluri.
                   
                   The following options may be used with MongoDB versions before 2.6: <return>"w"</return>Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.<return>"wTimeoutMS"</return>Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   <return>"w"</return>
                   
                   Vedeți
                   WriteConcerns. Valoarea implicită
                   pentru <class>MongoClient</class> este <return>1</return>.
                   
                   <return>"wTimeoutMS"</return>
                   
                   Această opțiune specifică
                   limita de timp în milisecunde pentru confirmarea
                   write concern. Aceasta este aplicabilă
                   doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                   deoarece expirarea timpului ține de replicare. Dacă "write concern" nu este
                   satisfăcută în limita intervalului de timp, se va emite o <class>MongoCursorException</class>.
                   Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                   perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                   este <return>10000</return> (zece secunde).
                   
                   The following options are deprecated and should no longer be used:
                   <return>"safe"</return>Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.<return>"timeout"</return>Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.<return>"wtimeout"</return>Un pseudonim
                   învechit pentru
                   <return>"wTimeoutMS"</return>.
                   
                   <return>"safe"</return>
                   
                   Învechită. Utilizați opțiunea
                   WriteConcern
                   <return>w</return>.
                   
                   <return>"timeout"</return>
                   
                   Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.
                   
                   <return>"wtimeout"</return>
                   
                   Un pseudonim învechit pentru
                   <return>"wTimeoutMS"</return>.

<comment>Return:</comment>
  <info>bool</info>  Returns an array containing the status of the index creation. The array contains whether the
        operation succeeded (<return>"ok"</return>), the number of indexes before and after the operation
        (<return>"numIndexesBefore"</return> and <return>"numIndexesAfter"</return>), and whether the collection that the index
        belongs to has been created (<return>"createdCollectionAutomatically"</return>). If the index already existed
        and did not need to be created, a <return>"note"</return> field may be present in lieu of <return>"numIndexesAfter"</return>.
        
        With MongoDB 2.4 and earlier, a status document is only returned if the write concern is at
        least <return>1</return>. Otherwise, <info>true</info> is returned. The fields in the status document are different,
        except for the <return>"ok"</return> field, which signals whether the index creation was successful.
        Additional fields are described in the documentation for <strong>MongoCollection::insert()</strong>.

<comment>See Also:</comment>
   * MongoCollection::createIndex
   * MongoCollection::deleteIndex
   * MongoCollection::deleteIndexes
   * 
    The MongoDB
    index and
    index type
    documentation.
   


id: MongoCollection::find
type: function
doc:
<comment>Description:</comment>
  Queries this collection, returning a MongoCursor
    for the result set

<comment>Param:</comment>
  <info>array</info>  <strong>$query </strong>  The fields for which to search. MongoDB's query language is quite extensive. The
                  PHP driver will in almost all cases pass the query straight through to the server,
                  so reading the MongoDB core docs on find is a good idea.
                  
                  Please make sure that for all special query operators (starting with <return>$</return>) you use
                  single quotes so that PHP doesn't try to replace <return>"$exists"</return> with the value of the
                  variable <return>$exists</return>.
  <info>array</info>  <strong>$fields</strong>  Fields of the results to return. The array is in the format <return>array('fieldname'
                  =&gt; true, 'fieldname2' =&gt; true)</return>. The <return>_id</return> field is always returned.

<comment>Return:</comment>
  <info>MongoCursor</info>  Returns a cursor for the search results.

<comment>See Also:</comment>
   * <strong>MongoCollection::findOne()</strong>
   * <strong>MongoCollection::insert()</strong>
   * MongoDB core docs on find.


id: MongoCollection::findAndModify
type: function
doc:
<comment>Description:</comment>
  Update a document and return it
  
  The findAndModify command atomically modifies and returns a single document. By default, the
  returned document does not include the modifications made on the update. To return the document
  with the modifications made on the update, use the new option.

<comment>Param:</comment>
  <info>array</info>  <strong>$query  </strong>  The query criteria to search for.
  <info>array</info>  <strong>$update </strong>  The update criteria.
  <info>array</info>  <strong>$fields </strong>  Optionally only return these fields.
  <info>array</info>  <strong>$options</strong>  An array of options to apply, such as remove the match document from the DB and
                   return it. OptionDescrieresort<info>array</info> Determines which document the operation will
                   modify if the query selects multiple documents. findAndModify will modify the
                   first document in the sort order specified by this argument. remove<info>bool</info> Optional
                   if update field exists. When <info>true</info>, removes the selected document. The default is
                   <info>false</info>. update<info>array</info> Optional if remove field exists. Performs an update of the
                   selected document. new<info>bool</info> Optional. When <info>true</info>, returns the modified document
                   rather than the original. The findAndModify method ignores the new option for
                   remove operations. The default is <info>false</info>. upsert<info>bool</info> Optional. Used in conjunction
                   with the update field. When <info>true</info>, the findAndModify command creates a new
                   document if the query returns no documents. The default is false. In MongoDB 2.2,
                   the findAndModify command returns <info>null</info> when upsert is <info>true</info>.

<comment>Return:</comment>
  <info>array</info>  Returns the original document, or the modified document when new is set.

<comment>See Also:</comment>
   * The MongoDB findAndModify command docs


id: MongoCollection::findOne
type: function
doc:
<comment>Description:</comment>
  Queries this collection, returning a single element
  
  As opposed to <strong>MongoCollection::find()</strong>, this method will return only the first result from the
  result set, and not a <class>MongoCursor</class> that can be iterated over.

<comment>Param:</comment>
  <info>array</info>  <strong>$query  </strong>  The fields for which to search. MongoDB's query language is quite extensive. The
                   PHP driver will in almost all cases pass the query straight through to the
                   server, so reading the MongoDB core docs on find is a good idea.
                   
                   Please make sure that for all special query operaters (starting with <return>$</return>) you use
                   single quotes so that PHP doesn't try to replace <return>"$exists"</return> with the value of the
                   variable <return>$exists</return>.
  <info>array</info>  <strong>$fields </strong>  Fields of the results to return. The array is in the format <return>array('fieldname'
                   =&gt; true, 'fieldname2' =&gt; true)</return>. The <return>_id</return> field is always returned.
  <info>array</info>  <strong>$options</strong>  This parameter is an associative array of the form  <return>array("name" =&gt; \<value&gt;, ...)</return>. Currently supported options are:
                   
                   <return>"maxTimeMS"</return>
                   
                   Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                   operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu este
                   terminată pe server în timpul rezervat, va fi emisă o
                   <class>MongoExecutionTimeoutException</class>.

<comment>Return:</comment>
  <info>array</info>  Returns record matching the search or <info>null</info>.

<comment>See Also:</comment>
   * <strong>MongoCollection::find()</strong>
   * <strong>MongoCollection::insert()</strong>
   * MongoDB core docs on find.


id: MongoCollection::getDBRef
type: function
doc:
<comment>Description:</comment>
  Fetches the document pointed to by a database reference

<comment>Param:</comment>
  <info>array</info>  <strong>$ref</strong>  A database reference.

<comment>Return:</comment>
  <info>array</info>  Returns the database document pointed to by the reference.

<comment>See Also:</comment>
   * MongoCollection::createDBRef


id: MongoCollection::getIndexInfo
type: function
doc:
<comment>Description:</comment>
  Returns information about indexes on this collection

<comment>Return:</comment>
  <info>array</info>  This function returns an array in which each element describes an index. Elements will
         contain the values <return>name</return> for the name of the index, <return>ns</return> for the namespace (a combination of
         the database and collection name), and <return>key</return> for a list of all fields in the index and their
         ordering. Additional values may be present for special indexes, such as <return>unique</return> or <return>sparse</return>.


id: MongoCollection::getName
type: function
doc:
<comment>Description:</comment>
  Returns this collection's name

<comment>Return:</comment>
  <info>string</info>  Returns the name of this collection.


id: MongoCollection::getReadPreference
type: function
doc:
<comment>Description:</comment>
  Get the read preference for this collection

<comment>Return:</comment>
  <info>array</info>  Această funcție întoarce un tablou ce descrie preferința de citire. Tabloul
         conține tipul (<return>type</return>) valorilor pentru șirul cu modul
         preferinței de citire (ce corespunde constantelor <class>MongoClient</class>),
         și <return>tagsets</return> conținând lista tuturor criteriilor setului de
         etichete. Dacă nu a fost specificat nici un set de etichete, <return>tagsets</return>
         nu va fi prezent în tablou.

<comment>See Also:</comment>
   * The read preferences documentation.
   * <strong>MongoCollection::setReadPreference()</strong>


id: MongoCollection::getSlaveOkay
type: function
doc:
<comment>Description:</comment>
  Get slaveOkay setting for this collection
  
  See the query section of this manual for information on distributing reads to secondaries.

<comment>Return:</comment>
  <info>bool</info>  Returns the value of slaveOkay for this instance.

<comment>See Also:</comment>
   * 
   * MongoCollection::getReadPreference


id: MongoCollection::getWriteConcern
type: function
doc:
<comment>Description:</comment>
  Get the write concern for this collection

<comment>Return:</comment>
  <info>array</info>  Această funcție întoarce un tablou ce descrie gradul de participare la înscriere.
         Tabloul conține valorile <return>w</return> pentru un nivel de confirmare
         întreg sau ca șir de caractere și <return>wtimeout</return> ce denotă numărul
         maximal de milisecunde de așteptare până când serverul satisface gradul de
         participare la înscriere.

<comment>See Also:</comment>
   * The write concern documentation.
   * <strong>MongoCollection::setWriteConcern()</strong>


id: MongoCollection::group
type: function
doc:
<comment>Description:</comment>
  Performs an operation similar to SQL's GROUP BY command

<comment>Param:</comment>
  <info>mixed    </info>  <strong>$keys   </strong>  Fields to group by.  If an array or non-code object is passed, it will be the
                       key used to group results.
                       
                       1.0.4+: If <strong>$keys</strong> is an instance of  <class>MongoCode</class>, <strong>$keys</strong> will be treated as a
                       function that returns the key to group by (see the "Passing a  <strong>$keys</strong>
                       function" example below).
  <info>array    </info>  <strong>$initial</strong>  Initial value of the aggregation counter object.
  <info>MongoCode</info>  <strong>$reduce </strong>  A function that takes two arguments (the current document and the
                       aggregation to this point) and does the aggregation.
  <info>array    </info>  <strong>$options</strong>  Optional parameters to the group command.  Valid options include:
                       
                       <return>"condition"</return>
                       
                       Criteria for including a document in the aggregation.
                       
                       <return>"finalize"</return>
                       
                       Function called once per unique key that takes the final output of the reduce
                       function.
                       
                       <return>"maxTimeMS"</return>
                       
                       Specifică o limită de timp cumulativă în milisecunde pentru procesarea
                       operațiunii pe server (nu include timpul de așteptare). Dacă operațiunea nu
                       este
                       terminată pe server în timpul rezervat, va fi emisă o
                       <class>MongoExecutionTimeoutException</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the result.


id: MongoCollection::insert
type: function
doc:
<comment>Description:</comment>
  Inserts a document into the collection
  
  All strings sent to the database must be UTF-8.  If a string is not UTF-8, a  <class>MongoException</class> will
  be thrown.  To insert  (or query for) a non-UTF-8 string, use <class>MongoBinData</class>.

<comment>Param:</comment>
  <info>arrayobject</info>  <strong>$document</strong>  An array or object. If an object is used, it may not have protected or
                          private properties.
                          
                          If the parameter does not have an <return>_id</return> key or property, a new <class>MongoId</class>
                          instance will be created and assigned to it. This special behavior does
                          not mean that the parameter is passed by reference.
  <info>array      </info>  <strong>$options </strong>  An array of options for the insert operation. Currently available options
                          include: <return>"fsync"</return>O valoare boolean-ă, valoarea
                          implicită este <info>false</info>. Dacă jurnalizarea e activată, ea funcționează exact
                          ca
                          <return>"j"</return>. Dacă jurnalizarea nu este acticvată, atunci se forțează
                          sincronizarea pe disc a operațiunii de inserare înainte de a întoarce
                          succes.
                          Dacă are valoarea <info>true</info>, se presupune efectuarea
                          unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                          <return>0</return>.Dacă jurnalizarea este activată, utilizatorii sunt încurajați să
                          utilizeze opțiunea <return>"j"</return> în loc de <return>"fsync"</return>.
                          Nu utilizați <return>"fsync"</return> și <return>"j"</return> simultan,
                          deoarece aceasta va rezulta în eroare.<return>"j"</return>O valoare boolean-ă, cu valoarea
                          implicită <info>false</info>. Forțează sincronizarea cu jurnalul a operațiunii de
                          inserare,
                          înainte de a întoarce succes. Dacă are valoarea <info>true</info>, se presupune
                          efectuarea
                          unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                          <return>0</return>.Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată,
                          MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi
                          ale
                          serverului pur și simplu vor ignora opțiunea.<return>"socketTimeoutMS"</return>Această
                          opțiune specifică
                          limita de timp în milisecunde pentru comunicarea prin socket. Dacă
                          serverul nu
                          răspunde în limita intervalului de timp, se va emite o
                          <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                          de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                          <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                          nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                          <return>30000</return> (30 secunde).<return>"w"</return>Vedeți
                          WriteConcerns. Valoarea implicită
                          pentru <class>MongoClient</class> este <return>1</return>.<return>"wTimeoutMS"</return>Această opțiune specifică
                          limita de timp în milisecunde pentru confirmarea
                          write concern. Aceasta este aplicabilă
                          doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                          deoarece expirarea timpului ține de replicare. Dacă "write concern" nu
                          este
                          satisfăcută în limita intervalului de timp, se va emite o
                          <class>MongoCursorException</class>.
                          Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                          perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                          este <return>10000</return> (zece secunde).
                          
                          <return>"fsync"</return>
                          
                          O valoare boolean-ă, valoarea
                          implicită este <info>false</info>. Dacă jurnalizarea e activată, ea funcționează exact
                          ca
                          <return>"j"</return>. Dacă jurnalizarea nu este acticvată, atunci se forțează
                          sincronizarea pe disc a operațiunii de inserare înainte de a întoarce
                          succes.
                          Dacă are valoarea <info>true</info>, se presupune efectuarea
                          unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                          <return>0</return>.
                          
                          Dacă jurnalizarea este activată, utilizatorii sunt încurajați să
                          utilizeze opțiunea <return>"j"</return> în loc de <return>"fsync"</return>.
                          Nu utilizați <return>"fsync"</return> și <return>"j"</return> simultan,
                          deoarece aceasta va rezulta în eroare.
                          
                          <return>"j"</return>
                          
                          O valoare boolean-ă, cu valoarea
                          implicită <info>false</info>. Forțează sincronizarea cu jurnalul a operațiunii de
                          inserare,
                          înainte de a întoarce succes. Dacă are valoarea <info>true</info>, se presupune
                          efectuarea
                          unei inserări cu confirmare și setarea <return>w</return> va fi modificată în
                          <return>0</return>.
                          
                          Dacă această opțiune e utilizată, iar jurnalizarea e dezactivată,
                          MongoDB 2.6+ va emite o eroare și înscrierea va eșua; versiunile mai vechi
                          ale
                          serverului pur și simplu vor ignora opțiunea.
                          
                          <return>"socketTimeoutMS"</return>
                          
                          Această opțiune specifică
                          limita de timp în milisecunde pentru comunicarea prin socket. Dacă
                          serverul nu
                          răspunde în limita intervalului de timp, se va emite o
                          <class>MongoCursorTimeoutException</class> și nu va fi nici o posibilitate
                          de a determina dacă serverul a efectuat înscrierea, sau nu. Valoarea
                          <return>-1</return> poate fi specificată pentru a suspenda pentru o perioadă
                          nedefinită. Valoarea implicită pentru <class>MongoClient</class> este
                          <return>30000</return> (30 secunde).
                          
                          <return>"w"</return>
                          
                          Vedeți
                          WriteConcerns. Valoarea implicită
                          pentru <class>MongoClient</class> este <return>1</return>.
                          
                          <return>"wTimeoutMS"</return>
                          
                          Această opțiune specifică
                          limita de timp în milisecunde pentru confirmarea
                          write concern. Aceasta este aplicabilă
                          doar atunci când <return>"w"</return> este mai mare decât <return>1</return>,
                          deoarece expirarea timpului ține de replicare. Dacă "write concern" nu
                          este
                          satisfăcută în limita intervalului de timp, se va emite o
                          <class>MongoCursorException</class>.
                          Valoarea <return>0</return> poate fi specificată pentru a suspenda pentru o
                          perioadă nedefinită. Valoarea implicită pentru <class>MongoClient</class>
                          este <return>10000</return> (zece secunde).
                          
                          The following options are deprecated and should no longer be used:
                          <return>"safe"</return>Învechită. Utilizați opțiunea
                          WriteConcern
                          <return>w</return>.<return>"timeout"</return>Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.<return>"wtimeout"</return>Un
                          pseudonim învechit pentru
                          <return>"wTimeoutMS"</return>.
                          
                          <return>"safe"</return>
                          
                          Învechită. Utilizați opțiunea
                          WriteConcern
                          <return>w</return>.
                          
                          <return>"timeout"</return>
                          
                          Un pseudonim învechit pentru <return>"socketTimeoutMS"</return>.
                          
                          <return>"wtimeout"</return>
                          
                          Un pseudonim învechit pentru
                          <return>"wTimeoutMS"</return>.

<comment>Return:</comment>
  <info>boolarray</info>  Returns an array containing the status of the insertion if the <return>"w"</return> option is set.
             Otherwise, returns <info>true</info> if the inserted array is not empty (a <class>MongoException</class> will be
             thrown if the inserted array is empty).
             
             If an array is returned, the following keys may be present: <strong>$ok</strong> This should almost
             always be 1 (unless last_error itself failed). <strong>$err</strong> If this field is non-null, an error
             occurred on the previous operation. If this field is set, it will be a string
             describing the error that occurred.  <strong>$code</strong> If a database error occurred, the relevant
             error code will be passed back to the client.  <strong>$errmsg</strong> This field is set if something
             goes wrong with a database command. It is coupled with <return>ok</return> being 0. For example, if <return>w</return> is
             set and times out, errmsg will be set to "timed out waiting for slaves" and <return>ok</return> will be
             0.  If this field is set, it will be a string describing the error that occurred.  <strong>$n</strong>
             If the last operation was an update, upsert, or a remove, the number of documents
             affected will be returned. For insert operations, this value is always <return>0</return>. <strong>$wtimeout</strong> If
             the previous option timed out waiting for replication.  <strong>$waited</strong> How long the operation
             waited before timing out.  <strong>$wtime</strong> If <return>w</return> was set and the operation succeeded, how long it
             took to replicate to <return>w</return> servers.  <strong>$upserted</strong> If an upsert occurred, this field will
             contain the new record's <return>_id</return> field. For upserts, either this field or <return>updatedExisting</return>
             will be present (unless an error occurred).  <strong>$updatedExisting</strong> If an upsert updated an
             existing element, this field will be true. For upserts, either this field or upserted
             will be present (unless an error occurred).
             
             This should almost always be 1 (unless last_error itself failed).
             
             If this field is non-null, an error occurred on the previous operation. If this field
             is set, it will be a string describing the error that occurred.
             
             If a database error occurred, the relevant error code will be passed back to the
             client.
             
             This field is set if something goes wrong with a database command. It is coupled with
             <return>ok</return> being 0. For example, if <return>w</return> is set and times out, errmsg will be set to "timed out
             waiting for slaves" and <return>ok</return> will be 0.  If this field is set, it will be a string
             describing the error that occurred.
             
             If the last operation was an update, upsert, or a remove, the number of documents
             affected will be returned. For insert operations, this value is always <return>0</return>.
             
             If the previous option timed out waiting for replication.
             
             How long the operation waited before timing out.
             
             If <return>w</return> was set and the operation succeeded, how long it took to replicate to <return>w</return> servers.
             
             If an upsert occurred, this field will contain the new record's <return>_id</return> field. For upserts,
             either this field or <return>updatedExisting</return> will be present (unless an error occurred).
             
             If an upsert updated an existing element, this field will be true. For upserts, either
             this field or upserted will be present (unless an error occurred).

<comment>See Also:</comment>
   * <strong>MongoCollection::batchInsert()</strong>
   * <strong>MongoCollection::update()</strong>
   * <strong>MongoCollection::find()</strong>
   * <strong>MongoCollection::remove()</strong>
   * MongoDB core docs on insert.


