# php_manual

id: max
type: function
doc:
<comment>Description:</comment>
  Localiza o maior valor
  
  Forma alternativa (não suportada com argumentos nomeados):
  
  Se o primeiro e único parâmetro for um array, <strong>max()</strong> retorna o maior valor do array. Se no mínimo
  dois parâmetros forem fornecidos, <strong>max()</strong> retorna o maior desses valores.
  
  Valores de diferentes tipos serão comparados utilizando as  regras padrões de comparação. Por
  exemplo, uma <info>string</info> não numérica será comparada a um <info>int</info> como se fosse <return>0</return>, mas várias <info>string</info>s não
  numéricas serão comparadas alfanumericamente. O valor real retornado terá o tipo do original, sem
  nenhuma conversão aplicada.
  
  Cuidado ao passar argumentos de tipos diferentes, pois <strong>max()</strong> pode produzir resultados
  imprevisíveis.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>        Qualquer valor comparável. 
  <info>mixed</info>  <strong>$values</strong>       Quaisquer valores comparáveis. 
  <info>array</info>  <strong>$value_array</strong>  Um array contendo os valores.

<comment>Return:</comment>
  <info>mixed</info>  <strong>max()</strong> retorna o parâmetro considerado o "maior" de acordo com as comparações padrões. Se
         vários valores de tipos diferentes forem considerados iguais (por exemplo, <return>0</return> e <return>'abc'</return>) então
         o primeiro fornecido à função será retornado.

<comment>See Also:</comment>
   * <strong>min()</strong>
   * <strong>count()</strong>


id: mb_check_encoding
type: function
doc:
<comment>Description:</comment>
  Check if strings are valid for the specified encoding
  
  Checks if the specified byte stream is valid for the specified encoding. If <strong>$value</strong> is of type
  <info>array</info>, all keys and values are validated recursively. It is useful to prevent so-called "Invalid
  Encoding Attack".

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$value</strong>     The byte stream or <info>array</info> to check. If it is omitted, this function
                                checks all the input from the beginning of the request.
                                
                                As of PHP 8.1.0, omitting this parameter or passing <info>null</info> is
                                deprecated.
  <info>string|null</info>        <strong>$encoding</strong>  The expected encoding.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: mb_chr
type: function
doc:
<comment>Description:</comment>
  Return character by Unicode code point value
  
  Returns a string containing the character specified by the Unicode code point value, encoded in
  the specified encoding.
  
  This function complements <strong>mb_ord()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$codepoint</strong>  A Unicode codepoint value, e.g. <return>128024</return> for U+1F418 ELEPHANT
  <info>string|null</info>  <strong>$encoding</strong>   O parâmetro <strong>$encoding</strong>
                           é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                           codificação
                           de caracteres interna será usado.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the requested character, if it can be represented in the
                specified encoding  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ord()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>chr()</strong>


id: mb_convert_case
type: function
doc:
<comment>Description:</comment>
  Perform case folding on a string
  
  Performs case folding on a <info>string</info>, converted in the way specified by <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being converted.
  <info>int</info>          <strong>$mode</strong>      The mode of the conversion. It can be one of  <info>MB_CASE_UPPER</info>,
                          <info>MB_CASE_LOWER</info>,  <info>MB_CASE_TITLE</info>, <info>MB_CASE_FOLD</info>, <info>MB_CASE_UPPER_SIMPLE</info>,
                          <info>MB_CASE_LOWER_SIMPLE</info>, <info>MB_CASE_TITLE_SIMPLE</info>, <info>MB_CASE_FOLD_SIMPLE</info>.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  A case folded version of <strong>$string</strong> converted in the way specified by <strong>$mode</strong>.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_strtoupper()</strong>
   * <strong>strtolower()</strong>
   * <strong>strtoupper()</strong>
   * <strong>ucfirst()</strong>
   * <strong>ucwords()</strong>


id: mb_convert_encoding
type: function
doc:
<comment>Description:</comment>
  Convert a string from one character encoding to another
  
  Converts <strong>$string</strong> from <strong>$from_encoding</strong>, or the current internal encoding, to <strong>$to_encoding</strong>. If
  <strong>$string</strong> is an <info>array</info>, all its <info>string</info> values will be converted recursively.

<comment>Param:</comment>
  <info>array|string</info>       <strong>$string</strong>         The <info>string</info> or <info>array</info> to be converted.
  <info>string</info>             <strong>$to_encoding</strong>    The desired encoding of the result.
  <info>array|string|null</info>  <strong>$from_encoding</strong>  The current encoding used to interpret <strong>$string</strong>. Multiple
                                     encodings may be specified as an <info>array</info> or comma separated list,
                                     in which case the correct encoding will be guessed using the
                                     same algorithm as <strong>mb_detect_encoding()</strong>.
                                     
                                     If <strong>$from_encoding</strong> is omitted or <info>null</info>, the
                                     mbstring.internal_encoding setting will be used if set,
                                     otherwise the default_charset setting.
                                     
                                     See supported encodings for valid values of <strong>$to_encoding</strong> and
                                     <strong>$from_encoding</strong>.

<comment>Return:</comment>
  <info>array|string|false</info>  The encoded <info>string</info> or <info>array</info> on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_detect_order()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: mb_convert_kana
type: function
doc:
<comment>Description:</comment>
  Convert "kana" one from another ("zen-kaku", "han-kaku" and more)
  
  Performs a "han-kaku" - "zen-kaku" conversion for <info>string</info> <strong>$string</strong>.  This function is only useful
  for Japanese.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being converted.
  <info>string</info>       <strong>$mode</strong>      The conversion option.
                          
                          Specify with a combination of following options. Applicable Conversion
                          OptionsOptionMeaning<return>r</return> Convert "zen-kaku" alphabets to "han-kaku" <return>R</return> Convert
                          "han-kaku" alphabets to "zen-kaku" <return>n</return> Convert "zen-kaku" numbers to
                          "han-kaku" <return>N</return> Convert "han-kaku" numbers to "zen-kaku" <return>a</return> Convert "zen-kaku"
                          alphabets and numbers to "han-kaku" <return>A</return> Convert "han-kaku" alphabets and
                          numbers to "zen-kaku" (Characters included in "a", "A" options are U+0021
                          - U+007E excluding U+0022, U+0027, U+005C, U+007E) <return>s</return> Convert "zen-kaku"
                          space to "han-kaku" (U+3000 -&gt; U+0020) <return>S</return> Convert "han-kaku" space to
                          "zen-kaku" (U+0020 -&gt; U+3000) <return>k</return> Convert "zen-kaku kata-kana" to
                          "han-kaku kata-kana" <return>K</return> Convert "han-kaku kata-kana" to "zen-kaku
                          kata-kana" <return>h</return> Convert "zen-kaku hira-gana" to "han-kaku kata-kana" <return>H</return>
                          Convert "han-kaku kata-kana" to "zen-kaku hira-gana" <return>c</return> Convert "zen-kaku
                          kata-kana" to "zen-kaku hira-gana" <return>C</return> Convert "zen-kaku hira-gana" to
                          "zen-kaku kata-kana" <return>V</return> Collapse voiced sound notation and convert them
                          into a character. Use with "K","H"
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.


id: mb_convert_variables
type: function
doc:
<comment>Description:</comment>
  Convert character code in variable(s)
  
  Converts  character encoding of variables <strong>$var</strong> and <strong>$vars</strong> in encoding <strong>$from_encoding</strong> to encoding
  <strong>$to_encoding</strong>.
  
  <strong>mb_convert_variables()</strong> join strings in Array or Object to detect encoding, since encoding
  detection tends to fail for short strings. Therefore, it is impossible to mix encoding in single
  array or object.

<comment>Param:</comment>
  <info>string</info>        <strong>$to_encoding</strong>    The encoding that the <info>string</info> is being converted to.
  <info>array|string</info>  <strong>$from_encoding</strong>  <strong>$from_encoding</strong> is specified as an <info>array</info>  or comma separated <info>string</info>,
                                it tries to detect encoding from <strong>$from-coding</strong>. When <strong>$from_encoding</strong>
                                is omitted, <return>detect_order</return> is used.
  <info>mixed</info>         <strong>$var</strong>            <strong>$var</strong> is the reference to the variable being converted. String, Array
                                and Object are accepted. <strong>mb_convert_variables()</strong> assumes all
                                parameters have the same encoding.
  <info>mixed</info>         <strong>$vars</strong>           Additional <strong>$var</strong>s.

<comment>Return:</comment>
  <info>string|false</info>  The character encoding before conversion for success,  or <info>false</info> for failure.


id: mb_decode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Decode string in MIME header field
  
  Decodes encoded-word <info>string</info> <strong>$string</strong> in MIME header.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The <info>string</info> being decoded.

<comment>Return:</comment>
  <info>string</info>  The decoded <info>string</info> in internal character encoding.

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


id: mb_decode_numericentity
type: function
doc:
<comment>Description:</comment>
  Decode HTML numeric string reference to character
  
  Convert numeric string reference of <info>string</info> <strong>$string</strong> in a specified block to character.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being decoded.
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> is an <info>array</info> that specifies  the code area to convert.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.
  <info></info>             <strong>$is_hex</strong>    This parameter is not used.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_detect_encoding
type: function
doc:
<comment>Description:</comment>
  Detect character encoding
  
  Detects the most likely character encoding for <info>string</info> <strong>$string</strong> from an ordered list of candidates.
  
  Automatic detection of the intended character encoding can never be entirely reliable; without
  some additional information, it is similar to decoding an encrypted string without the key. It is
  always preferable to use an indication of character encoding stored or transmitted with the data,
  such as a "Content-Type" HTTP header.
  
  This function is most useful with multibyte encodings, where not all sequences of bytes form a
  valid string. If the input string contains such a sequence, that encoding will be rejected, and
  the next encoding checked.

<comment>Param:</comment>
  <info>string</info>             <strong>$string</strong>     The <info>string</info> being inspected.
  <info>array|string|null</info>  <strong>$encodings</strong>  A list of character encodings to try, in order. The list may be
                                 specified as an array of strings, or a single string separated by
                                 commas.
                                 
                                 If <strong>$encodings</strong> is omitted or <info>null</info>, the current detect_order (set
                                 with the  mbstring.detect_order configuration option, or
                                 <strong>mb_detect_order()</strong> function) will be used.
  <info>bool</info>               <strong>$strict</strong>     Controls the behaviour when <strong>$string</strong> is not valid in any of the
                                 listed <strong>$encodings</strong>. If <strong>$strict</strong> is set to <info>false</info>, the closest matching
                                 encoding will be returned; if <strong>$strict</strong> is set to <info>true</info>, <info>false</info> will be
                                 returned.
                                 
                                 The default value for <strong>$strict</strong> can be set with the
                                 mbstring.strict_detection configuration option.

<comment>Return:</comment>
  <info>string|false</info>  The detected character encoding, or <info>false</info> if the string is not valid in any of the
                listed encodings.

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


id: mb_detect_order
type: function
doc:
<comment>Description:</comment>
  Set/Get character encoding detection order
  
  Sets the automatic character encoding detection order to <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> is an <info>array</info> or  comma separated list of character
                                encoding. See supported encodings.
                                
                                If <strong>$encoding</strong> is omitted or <info>null</info>, it returns the current character
                                encoding detection order as array.
                                
                                This setting affects <strong>mb_detect_encoding()</strong> and <strong>mb_send_mail()</strong>.
                                
                                <return>mbstring</return> currently implements the following encoding detection
                                filters. If there is an invalid byte sequence for the following
                                encodings, encoding detection will fail.
                                
                                <return>UTF-8</return>, <return>UTF-7</return>, <return>ASCII</return>, <return>EUC-JP</return>,<return>SJIS</return>, <return>eucJP-win</return>, <return>SJIS-win</return>, <return>JIS</return>,
                                <return>ISO-2022-JP</return>
                                
                                For <return>ISO-8859-*</return>, <return>mbstring</return> always detects as <return>ISO-8859-*</return>.
                                
                                For <return>UTF-16</return>, <return>UTF-32</return>, <return>UCS2</return> and <return>UCS4</return>, encoding detection will fail
                                always.

<comment>Return:</comment>
  <info>array|bool</info>  When setting the encoding detection order, <info>true</info> is returned on success or <info>false</info> on
              failure.
              
              When getting the encoding detection order, an ordered array of the encodings is
              returned.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_send_mail()</strong>


id: mb_encode_mimeheader
type: function
doc:
<comment>Description:</comment>
  Encode string for MIME header
  
  Encodes a given <info>string</info> <strong>$string</strong> by the MIME header encoding scheme.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>             The <info>string</info> being encoded. Its encoding should be same as
                                   <strong>mb_internal_encoding()</strong>.
  <info>string|null</info>  <strong>$charset</strong>            <strong>$charset</strong> specifies the name of the character set in which <strong>$string</strong>
                                   is represented in. The default value is determined by the current
                                   NLS setting (<return>mbstring.language</return>).
  <info>string|null</info>  <strong>$transfer_encoding</strong>  <strong>$transfer_encoding</strong> specifies the scheme of MIME encoding. It
                                   should be either <return>"B"</return> (Base64) or <return>"Q"</return> (Quoted-Printable). Falls
                                   back to <return>"B"</return> if not given.
  <info>string</info>       <strong>$newline</strong>            <strong>$newline</strong> specifies the EOL (end-of-line) marker with which
                                   <strong>mb_encode_mimeheader()</strong> performs line-folding (a RFC term, the act
                                   of breaking a line longer than a certain length into multiple
                                   lines. The length is currently hard-coded to 74 characters).
                                   Falls back to <return>"\r\n"</return> (CRLF) if not given.
  <info>int</info>          <strong>$indent</strong>             Indentation of the first line (number of characters in the header
                                   before <strong>$string</strong>).

<comment>Return:</comment>
  <info>string</info>  A converted version of the <info>string</info> represented in ASCII.

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


id: mb_encode_numericentity
type: function
doc:
<comment>Description:</comment>
  Encode character to HTML numeric string reference
  
  Converts specified character codes in <info>string</info> <strong>$string</strong> from character code to HTML numeric character
  reference.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being encoded.
  <info>array</info>        <strong>$map</strong>       <strong>$map</strong> is array specifies code area to convert.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.
  <info>bool</info>         <strong>$hex</strong>       Whether the returned entity reference should be in hexadecimal notation
                          (otherwise it is in decimal notation).

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_encoding_aliases
type: function
doc:
<comment>Description:</comment>
  Get aliases of a known encoding type
  
  Returns an array of aliases for a known <strong>$encoding</strong> type.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  The encoding type being checked, for aliases.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of encoding aliases.

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


id: mb_ereg
type: function
doc:
<comment>Description:</comment>
  Regular expression match with multibyte support
  
  Executes the regular expression match with multibyte support.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The search pattern.
  <info>string</info>  <strong>$string</strong>   The search <info>string</info>.
  <info>array</info>   <strong>$matches</strong>  If matches are found for parenthesized substrings of <strong>$pattern</strong> and the function
                    is called with the third argument <strong>$matches</strong>, the matches will be stored in the
                    elements of the array <strong>$matches</strong>. If no matches are found, <strong>$matches</strong> is set to an
                    empty array.
                    
                    $matches[1] will contain the substring which starts at the first left
                    parenthesis; $matches[2] will contain the substring starting at the second, and
                    so on. $matches[0] will contain a copy of the complete string matched.

<comment>Return:</comment>
  <info>bool</info>  Returns whether <strong>$pattern</strong> matches <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi()</strong>


id: mb_ereg_match
type: function
doc:
<comment>Description:</comment>
  Regular expression match for multibyte string
  
  A regular expression match for a multibyte string <strong>$pattern</strong> is only matched at the beginning of
  <strong>$string</strong>.
  
  <strong>$pattern</strong> is only matched at the beginning of <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>       <strong>$string</strong>   The <info>string</info> being evaluated.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$string</strong> matches the regular expression <strong>$pattern</strong>, <info>false</info> if not.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_ereg_replace
type: function
doc:
<comment>Description:</comment>
  Replace regular expression with multibyte support
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with <strong>$replacement</strong>

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      The regular expression pattern.
                             
                             Multibyte characters may be used in <strong>$pattern</strong>.
  <info>string</info>       <strong>$replacement</strong>  The replacement text.
  <info>string</info>       <strong>$string</strong>       The <info>string</info> being checked.
  <info>string|null</info>  <strong>$options</strong>      The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> on success, or <info>false</info> on error. If <strong>$string</strong> is not valid for
                     the current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_eregi_replace()</strong>


id: mb_ereg_replace_callback
type: function
doc:
<comment>Description:</comment>
  Perform a regular expression search and replace with multibyte support using a callback
    
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with the output of <strong>$callback</strong>
  function.
  
  The behavior of this function is almost identical to <strong>mb_ereg_replace()</strong>,  except for the fact that
  instead of <strong>$replacement</strong> parameter, one should specify a <strong>$callback</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>   The regular expression pattern.
                          
                          Multibyte characters may be used in <strong>$pattern</strong>.
  <info>callable</info>     <strong>$callback</strong>  A callback that will be called and passed an array of matched elements in
                          the  <strong>$subject</strong> string. The callback should return the replacement string.
                          
                          You'll often need the <strong>$callback</strong> function for a <strong>mb_ereg_replace_callback()</strong>
                          in just one place. In this case you can use an anonymous function to
                          declare the callback within the call to <strong>mb_ereg_replace_callback()</strong>. By
                          doing it this way you have all information for the call in one place and
                          do not clutter the function namespace with a callback function's name not
                          used anywhere else.
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being checked.
  <info>string|null</info>  <strong>$options</strong>   The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> on success, or <info>false</info> on error. If <strong>$string</strong> is not valid for
                     the current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>
   * Anonymous functions


id: mb_ereg_search
type: function
doc:
<comment>Description:</comment>
  Multibyte regular expression match for predefined multibyte string
  
  Performs a multibyte regular expression match for a predefined multibyte string.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>bool</info>  <strong>mb_ereg_search()</strong> returns <info>true</info> if the multibyte string matches with the regular expression,
        or <info>false</info> otherwise. The <info>string</info> for matching is set by  <strong>mb_ereg_search_init()</strong>. If <strong>$pattern</strong> is
        not specified, the previous one is used.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_getpos
type: function
doc:
<comment>Description:</comment>
  Returns start point for next regular expression match
  
  Returns the start point for the next regular expression match.

<comment>Return:</comment>
  <info>int</info>  <strong>mb_ereg_search_getpos()</strong> returns the point to start regular expression match for
       <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. The position is represented by
       bytes from the head of string.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_setpos()</strong>


id: mb_ereg_search_getregs
type: function
doc:
<comment>Description:</comment>
  Retrieve the result from the last multibyte regular expression match
  
  Retrieve the result from the last multibyte regular expression match

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> including the sub-string of matched part by last <strong>mb_ereg_search()</strong>,
               <strong>mb_ereg_search_pos()</strong>, <strong>mb_ereg_search_regs()</strong>. If there are some matches, the first
               element will have the matched sub-string, the second element will have the first part
               grouped with brackets,  the third element will have the second part grouped with
               brackets, and so on. It returns <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_init
type: function
doc:
<comment>Description:</comment>
  Setup string and regular expression for a multibyte regular expression match
  
  <strong>mb_ereg_search_init()</strong> sets <strong>$string</strong> and <strong>$pattern</strong> for a multibyte regular expression. These values
  are used for <strong>mb_ereg_search()</strong>, <strong>mb_ereg_search_pos()</strong>, and <strong>mb_ereg_search_regs()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>   The search string.
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_regs()</strong>


id: mb_ereg_search_pos
type: function
doc:
<comment>Description:</comment>
  Returns position and length of a matched part of the multibyte regular expression for a predefined
  multibyte string
  
  Returns position and length of a matched part of the multibyte regular expression  for a
  predefined multibyte string
  
  The string for match is specified by <strong>mb_ereg_search_init()</strong>. If it is not specified, the previous
  one will be used.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>array|false</info>  An <info>array</info> containing two elements. The first element is the offset, in bytes, where
               the match begins relative to the start of the search string, and the second element
               is the length in bytes of the match.
               
               If an error occurs, <info>false</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_regs
type: function
doc:
<comment>Description:</comment>
  Returns the matched part of a multibyte regular expression
  
  Returns the matched part of a multibyte regular expression.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$pattern</strong>  The search pattern.
  <info>string|null</info>  <strong>$options</strong>  The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>array|false</info>  <strong>mb_ereg_search_regs()</strong> executes the multibyte regular expression match, and if there
               are some matched part, it returns an <info>array</info> including substring of matched part as
               first element, the first grouped part with brackets as second element, the second
               grouped part as third element, and so on.  It returns <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_ereg_search_setpos
type: function
doc:
<comment>Description:</comment>
  Set start point of next regular expression match
  
  <strong>mb_ereg_search_setpos()</strong> sets the starting point of a match for <strong>mb_ereg_search()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The position to set. If it is negative, it counts from the end of the string.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_search_init()</strong>


id: mb_eregi
type: function
doc:
<comment>Description:</comment>
  Regular expression match ignoring case with multibyte support
  
  Executes the case insensitive regular expression match with multibyte support.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>  <strong>$string</strong>   The <info>string</info> being searched.
  <info>array</info>   <strong>$matches</strong>  If matches are found for parenthesized substrings of <strong>$pattern</strong> and the function
                    is called with the third argument <strong>$matches</strong>, the matches will be stored in the
                    elements of the array <strong>$matches</strong>. If no matches are found, <strong>$matches</strong> is set to an
                    empty array.
                    
                    $matches[1] will contain the substring which starts at the first left
                    parenthesis; $matches[2] will contain the substring starting at the second, and
                    so on. $matches[0] will contain a copy of the complete string matched.

<comment>Return:</comment>
  <info>bool</info>  Returns whether <strong>$pattern</strong> matches <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_eregi_replace
type: function
doc:
<comment>Description:</comment>
  Replace regular expression with multibyte support ignoring case
  
  Scans <strong>$string</strong> for matches to <strong>$pattern</strong>, then replaces the matched text with <strong>$replacement</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$pattern</strong>      The regular expression pattern.  Multibyte characters may be used. The
                             case will be ignored.
  <info>string</info>       <strong>$replacement</strong>  The replacement text.
  <info>string</info>       <strong>$string</strong>       The searched <info>string</info>.
  <info>string|null</info>  <strong>$options</strong>      The search option. See <strong>mb_regex_set_options()</strong> for explanation.

<comment>Return:</comment>
  <info>string|false|null</info>  The resultant <info>string</info> or <info>false</info> on error.  If <strong>$string</strong> is not valid for the
                     current encoding, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg_replace()</strong>


id: mb_get_info
type: function
doc:
<comment>Description:</comment>
  Get internal settings of mbstring
  
  <strong>mb_get_info()</strong> returns the internal setting parameters of mbstring.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  If <strong>$type</strong> is not specified or is specified as <return>"all"</return>, <return>"internal_encoding"</return>,
                 <return>"http_input"</return>, <return>"http_output"</return>, <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>,
                 <return>"mail_header_encoding"</return>, <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>,
                 <return>"encoding_translation"</return>, <return>"language"</return>, <return>"detect_order"</return>, <return>"substitute_character"</return> and
                 <return>"strict_detection"</return> will be returned.
                 
                 If <strong>$type</strong> is specified as <return>"internal_encoding"</return>, <return>"http_input"</return>, <return>"http_output"</return>,
                 <return>"http_output_conv_mimetypes"</return>, <return>"mail_charset"</return>, <return>"mail_header_encoding"</return>,
                 <return>"mail_body_encoding"</return>, <return>"illegal_chars"</return>, <return>"encoding_translation"</return>, <return>"language"</return>,
                 <return>"detect_order"</return>, <return>"substitute_character"</return> or <return>"strict_detection"</return> the specified setting
                 parameter will be returned.

<comment>Return:</comment>
  <info>array|string|int|false</info>  An <info>array</info> of type information if <strong>$type</strong>  is not specified, otherwise a
                          specific <strong>$type</strong>, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_http_output()</strong>


id: mb_http_input
type: function
doc:
<comment>Description:</comment>
  Detect HTTP input character encoding
  
  Detects the HTTP input character encoding.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$type</strong>  Input string specifies the input type.  <return>"G"</return> for GET, <return>"P"</return> for POST, <return>"C"</return> for
                      COOKIE, <return>"S"</return> for string, <return>"L"</return> for list, and <return>"I"</return> for the whole list (will return
                      <info>array</info>).  If type is omitted, it returns the last input type processed.

<comment>Return:</comment>
  <info>array|string|false</info>  The character encoding name, as per the <strong>$type</strong>, or an array of character
                      encoding names, if <strong>$type</strong> is <return>"I"</return>. If <strong>mb_http_input()</strong> does not process specified
                      HTTP input, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_http_output
type: function
doc:
<comment>Description:</comment>
  Set/Get HTTP output character encoding
  
  Set/Get the HTTP output character encoding. Output after this function is called will be converted
  from the set internal encoding to <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  If <strong>$encoding</strong> is set, <strong>mb_http_output()</strong> sets the HTTP output character
                          encoding to <strong>$encoding</strong>.
                          
                          If <strong>$encoding</strong> is omitted, <strong>mb_http_output()</strong> returns the current HTTP output
                          character encoding.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is omitted, <strong>mb_http_output()</strong> returns the current HTTP output character
               encoding. Otherwise,  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_http_input()</strong>
   * <strong>mb_detect_order()</strong>


id: mb_internal_encoding
type: function
doc:
<comment>Description:</comment>
  Set/Get internal character encoding
  
  Set/Get the internal character encoding

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  <strong>$encoding</strong> is the character encoding name  used for the HTTP input
                          character encoding conversion, HTTP output  character encoding conversion,
                          and the default character encoding  for string functions defined by the
                          mbstring module. You should notice that the internal encoding is totally
                          different from the one for multibyte regex.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is set, then  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
               In this case, the character encoding for multibyte regex is NOT changed. If <strong>$encoding</strong>
               is omitted, then  the current character encoding name is returned.

<comment>See Also:</comment>
   * <strong>mb_http_input()</strong>
   * <strong>mb_http_output()</strong>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_regex_encoding()</strong>


id: mb_language
type: function
doc:
<comment>Description:</comment>
  Set/Get current language
  
  Set/Get the current language.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$language</strong>  Used for encoding e-mail messages. The valid languages are listed in the
                          following table. <strong>mb_send_mail()</strong> uses this setting to encode e-mail.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$language</strong> is set and <strong>$language</strong> is valid, it returns <info>true</info>. Otherwise, it returns
               <info>false</info>.  When <strong>$language</strong> is omitted or <info>null</info>, it returns the language name as a <info>string</info>.

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


id: mb_list_encodings
type: function
doc:
<comment>Description:</comment>
  Returns an array of all supported encodings
  
  Returns an array containing all supported encodings.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array.

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


id: mb_ord
type: function
doc:
<comment>Description:</comment>
  Get Unicode code point of character
  
  Returns the Unicode code point value of the given character.
  
  This function complements <strong>mb_chr()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A string
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int|false</info>  The Unicode code point for the first character of <return>string</return>  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_chr()</strong>
   * <strong>IntlChar::ord()</strong>
   * <strong>ord()</strong>


id: mb_output_handler
type: function
doc:
<comment>Description:</comment>
  Callback function converts character encoding in output buffer
  
  <strong>mb_output_handler()</strong> is <strong>ob_start()</strong> callback function. <strong>mb_output_handler()</strong> converts characters in
  the output buffer from internal character encoding to HTTP output character encoding.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The contents of the output buffer.
  <info>int</info>     <strong>$status</strong>  The status of the output buffer.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.

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


id: mb_parse_str
type: function
doc:
<comment>Description:</comment>
  Parse GET/POST/COOKIE data and set global variable
  
  Parses GET/POST/COOKIE data and sets global variables. Since PHP does not provide raw POST/COOKIE
  data, it can only be used for GET data for now. It parses URL encoded data, detects encoding,
  converts coding to internal encoding and set values to the <strong>$result</strong> <info>array</info> or global variables.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The URL encoded data.
  <info>array</info>   <strong>$result</strong>  An <info>array</info> containing decoded and character encoded converted values.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_detect_order()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_preferred_mime_name
type: function
doc:
<comment>Description:</comment>
  Get MIME charset string
  
  Get a MIME charset <info>string</info> for a specific encoding.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  The encoding being checked.

<comment>Return:</comment>
  <info>string|false</info>  The MIME <return>charset</return> <info>string</info> for character encoding <strong>$encoding</strong>, or <info>false</info> if no charset is
                preferred for the given <strong>$encoding</strong>.


id: mb_regex_encoding
type: function
doc:
<comment>Description:</comment>
  Set/Get character encoding for multibyte regex
  
  Set/Get character encoding for a multibyte regex.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string|bool</info>  If <strong>$encoding</strong> is set, then  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
               In this case, the internal character encoding is NOT changed. If <strong>$encoding</strong> is
               omitted, then  the current character encoding name for a multibyte regex is returned.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_regex_set_options
type: function
doc:
<comment>Description:</comment>
  Set/Get the default options for mbregex functions
  
  Sets the default options described by <strong>$options</strong>  for multibyte regex functions.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$options</strong>  The options to set. This is a string where each  character is an option. To
                         set a mode, the mode  character must be the last one set, however there
                         can only be set one mode but multiple options.
                         
                         The <return>"e"</return> option has no effect when set through <strong>mb_regex_set_options()</strong>. Use
                         it with <strong>mb_ereg_replace()</strong> or <strong>mb_eregi_replace()</strong>.

<comment>Return:</comment>
  <info>string</info>  The previous options. If <strong>$options</strong> is omitted or <info>null</info>,  it returns the <info>string</info> that
          describes the current options.

<comment>See Also:</comment>
   * <strong>mb_split()</strong>
   * <strong>mb_ereg()</strong>
   * <strong>mb_eregi()</strong>


id: mb_scrub
type: function
doc:
<comment>Description:</comment>
  Replace ill-formed byte sequences with the substitute character
  
  Perform a character set conversion from the specified encoding, or the default encoding if no
  encoding was specified, to the same encoding. This has the effect of replacing any invalid byte
  sequences with the substitute character.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The input string.
  <info>string|null</info>  <strong>$encoding</strong>  The encoding used to interpret <strong>$string</strong>. If it is omitted or <info>null</info>, the
                          mbstring.internal_encoding setting will be used if set, otherwise the
                          default_charset setting will be used.

<comment>Return:</comment>
  <info>string</info>  The <info>string</info> result with invalid byte sequences replaced.


id: mb_send_mail
type: function
doc:
<comment>Description:</comment>
  Send encoded mail
  
  Sends email. Headers and messages are converted and encoded according to the <strong>mb_language()</strong>
  setting. It's a wrapper function for <strong>mail()</strong>, so see also <strong>mail()</strong> for details.

<comment>Param:</comment>
  <info>string</info>        <strong>$to</strong>                  The mail addresses being sent to. Multiple recipients may be
                                     specified by putting a comma between each address in <strong>$to</strong>.  This
                                     parameter is not automatically encoded.
  <info>string</info>        <strong>$subject</strong>             The subject of the mail.
  <info>string</info>        <strong>$message</strong>             The message of the mail.
  <info>array|string</info>  <strong>$additional_headers</strong>  <info>String</info> or <info>array</info> to be inserted at the end of the email header.
                                     
                                     This is typically used to add extra headers (From, Cc, and
                                     Bcc). Multiple extra headers should be separated with a CRLF
                                     (\r\n). Validate parameter not to be injected unwanted headers
                                     by attackers.
                                     
                                     If an <info>array</info> is passed, its keys are the header names and its
                                     values are the respective header values.
                                     
                                     When sending mail, the mail must contain a <return>From</return> header. This
                                     can be set with the  <strong>$additional_headers</strong> parameter, or a
                                     default can be set in php.ini.
                                     
                                     Failing to do this will result in an error message similar to
                                     <return>Warning: mail(): "sendmail_from" not set in php.ini or custom
                                     "From:" header missing</return>. The <return>From</return> header sets also <return>Return-Path</return>
                                     under Windows.
                                     
                                     If messages are not received, try using a LF (\n) only. Some
                                     Unix mail transfer agents (most notably qmail) replace LF by
                                     CRLF automatically (which leads to doubling CR if CRLF is
                                     used). This should be a last resort, as it does not comply with
                                     RFC 2822.
  <info>string|null</info>   <strong>$additional_params</strong>   <strong>$additional_params</strong> is a MTA command line parameter. It is
                                     useful when setting the correct Return-Path header when using
                                     sendmail.
                                     
                                     This parameter is escaped by <strong>escapeshellcmd()</strong> internally to
                                     prevent command execution. <strong>escapeshellcmd()</strong> prevents command
                                     execution, but allows to add additional parameters. For
                                     security reason, this parameter should be validated.
                                     
                                     Since <strong>escapeshellcmd()</strong> is applied automatically, some
                                     characters that are allowed as email addresses by internet RFCs
                                     cannot be used. Programs that are required to use these
                                     characters <strong>mail()</strong> cannot be used.
                                     
                                     The user that the webserver runs as should be added as a
                                     trusted user to the sendmail configuration to prevent a
                                     'X-Warning' header from being added to the message when the
                                     envelope sender (-f) is set using this method. For sendmail
                                     users, this file is /etc/mail/trusted-users.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mail()</strong>
   * <strong>mb_encode_mimeheader()</strong>
   * <strong>mb_language()</strong>


id: mb_split
type: function
doc:
<comment>Description:</comment>
  Split multibyte string using regular expression
  
  Split a multibyte <strong>$string</strong> using regular expression <strong>$pattern</strong> and returns the result as an <info>array</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  The regular expression pattern.
  <info>string</info>  <strong>$string</strong>   The <info>string</info> being split.
  <info>int</info>     <strong>$limit</strong>    If optional parameter <strong>$limit</strong> is specified,  it will be split in <strong>$limit</strong> elements
                    as maximum.

<comment>Return:</comment>
  <info>array|false</info>  The result as an <info>array</info>,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mb_regex_encoding()</strong>
   * <strong>mb_ereg()</strong>


id: mb_str_pad
type: function
doc:
<comment>Description:</comment>
  Pad a multibyte string to a certain length with another multibyte string
  
  This function returns the <strong>$string</strong> padded on the left, the right, or both sides to the specified
  padding length, where the length is measured in Unicode codepoints. If the optional argument
  <strong>$pad_string</strong> is not supplied, the <strong>$string</strong> is padded with spaces, otherwise it is padded with
  characters from <strong>$pad_string</strong> up to the limit.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>      The input string.
  <info>int</info>          <strong>$length</strong>      If the value of <strong>$length</strong> is negative, less than, or equal to the length
                            of the input string, no padding takes place, and <strong>$string</strong> will be
                            returned.
  <info>string</info>       <strong>$pad_string</strong>  The <strong>$pad_string</strong> may be truncated if the required number of padding
                            characters can't be evenly divided by the <strong>$pad_string</strong>'s length.
  <info>int</info>          <strong>$pad_type</strong>    Optional argument <strong>$pad_type</strong> can be <info>STR_PAD_RIGHT</info>, <info>STR_PAD_LEFT</info>, or
                            <info>STR_PAD_BOTH</info>. By default <info>STR_PAD_RIGHT</info>.
  <info>string|null</info>  <strong>$encoding</strong>    O parâmetro <strong>$encoding</strong>
                            é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                            codificação
                            de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  Returns the padded string.


id: mb_str_split
type: function
doc:
<comment>Description:</comment>
  Given a multibyte string, return an array of its characters
  
  This function will return an array of strings, it is a version of <strong>str_split()</strong> with support for
  encodings of variable character size as well as fixed-size encodings of 1,2 or 4 byte characters.
  If the <strong>$length</strong> parameter is specified, the string is broken down into chunks of the specified
  length in characters (not bytes). The <strong>$encoding</strong> parameter can be optionally specified and it is
  good practice to do so.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> to split into characters or chunks.
  <info>int</info>          <strong>$length</strong>    If specified, each element of the returned array will be composed of
                          multiple characters instead of a single character.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.
                          
                          A string specifying one of the supported encodings.

<comment>Return:</comment>
  <info>array</info>  <strong>mb_str_split()</strong> returns an array of strings.

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


id: mb_strcut
type: function
doc:
<comment>Description:</comment>
  Get part of string
  
  <strong>mb_strcut()</strong> extracts a substring from a string similarly to <strong>mb_substr()</strong>, but operates on bytes
  instead of characters. If the cut position happens to be between two bytes of a multi-byte
  character, the cut is performed starting from the first byte of that character. This is also the
  difference to the <strong>substr()</strong> function, which would simply cut the string between the bytes and thus
  result in a malformed byte sequence.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being cut.
  <info>int</info>          <strong>$start</strong>     If <strong>$start</strong> is non-negative, the returned string will start at the <strong>$start</strong>'th
                          byte position in <strong>$string</strong>, counting from zero. For instance, in the string
                          '<return>abcdef</return>', the byte at position <return>0</return> is '<return>a</return>', the byte at position <return>2</return> is '<return>c</return>',
                          and so forth.
                          
                          If <strong>$start</strong> is negative, the returned string will start at the <strong>$start</strong>'th
                          byte counting back from the end of <strong>$string</strong>. However, if the magnitude of a
                          negative <strong>$start</strong> is greater than the length of the string, the returned
                          portion will start from the beginning of <strong>$string</strong>.
  <info>int|null</info>     <strong>$length</strong>    Length in bytes. If omitted or <return>NULL</return> is passed, extract all bytes to the
                          end of the string.
                          
                          If <strong>$length</strong> is negative, the returned string will end at the <strong>$length</strong>'th
                          byte counting back from the end of <strong>$string</strong>. However, if the magnitude of a
                          negative <strong>$length</strong> is greater than the number of characters after the <strong>$start</strong>
                          position, an empty string will be returned.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_strcut()</strong> returns the portion of <strong>$string</strong> specified by the <strong>$start</strong> and <strong>$length</strong> parameters.

<comment>See Also:</comment>
   * <strong>mb_substr()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_strimwidth
type: function
doc:
<comment>Description:</comment>
  Get truncated string with specified width
  
  Truncates <info>string</info> <strong>$string</strong> to specified <strong>$width</strong>, where halfwidth characters count as <return>1</return>, and fullwidth
  characters count as <return>2</return>. See http://www.unicode.org/reports/tr11/ for details regarding East Asian
  character widths.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>       The <info>string</info> being decoded.
  <info>int</info>          <strong>$start</strong>        The start position offset. Number of characters from the beginning of
                             string (first character is 0), or if start is negative, number of
                             characters from the end of the string.
  <info>int</info>          <strong>$width</strong>        The width of the desired trim. If negative width is specified, count
                             from the end of the string.  Passing negative width is deprecated as of
                             PHP 8.3.0.
                             
                             Passing negative width is deprecated as of PHP 8.3.0.
  <info>string</info>       <strong>$trim_marker</strong>  A string that is added to the end of string  when string is truncated.
  <info>string|null</info>  <strong>$encoding</strong>     O parâmetro <strong>$encoding</strong>
                             é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                             codificação
                             de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  The truncated <info>string</info>. If <strong>$trim_marker</strong> is set, <strong>$trim_marker</strong> replaces the last chars to
          match the <strong>$width</strong>.

<comment>See Also:</comment>
   * <strong>mb_strwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_stripos
type: function
doc:
<comment>Description:</comment>
  Finds position of first occurrence of a string within another, case insensitive
  
  <strong>mb_stripos()</strong> returns the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong>
  string. Unlike <strong>mb_strpos()</strong>,  <strong>mb_stripos()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it returns
  <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The string from which to get the position of the first occurrence of
                          <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>
  <info>int</info>          <strong>$offset</strong>    The position in <strong>$haystack</strong> to start searching. A negative offset counts
                          from the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  Character encoding name to use. If it is omitted, internal character
                          encoding is used.

<comment>Return:</comment>
  <info>int|false</info>  Return the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string,
             or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stripos()</strong>
   * <strong>strpos()</strong>
   * <strong>mb_strpos()</strong>


id: mb_stristr
type: function
doc:
<comment>Description:</comment>
  Finds first occurrence of a string within another, case insensitive
  
  <strong>mb_stristr()</strong> finds the first occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. Unlike <strong>mb_strstr()</strong>,  <strong>mb_stristr()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it
  returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the first occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of  <strong>$haystack</strong> from the beginning to the first
                               occurrence of <strong>$needle</strong> (excluding needle). If set to <info>false</info>, it returns
                               all of <strong>$haystack</strong> from the first occurrence of <strong>$needle</strong> to the end
                               (including needle).
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_strstr()</strong>


id: mb_strlen
type: function
doc:
<comment>Description:</comment>
  Get string length
  
  Gets the length of a <info>string</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being checked for length.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int</info>  Returns the number of characters in <info>string</info> <strong>$string</strong> having character encoding <strong>$encoding</strong>. A
       multi-byte character is counted as 1.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>grapheme_strlen()</strong>
   * <strong>iconv_strlen()</strong>
   * <strong>strlen()</strong>


id: mb_strpos
type: function
doc:
<comment>Description:</comment>
  Find position of first occurrence of string in a string
  
  Finds position of the first occurrence of a <info>string</info> in a <info>string</info>.
  
  Performs a multi-byte safe <strong>strpos()</strong> operation based on number of characters. The first character's
  position is 0, the second character position is 1, and so on.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked.
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>. In contrast with <strong>strpos()</strong>, numeric values
                          are not applied as the ordinal value of a character.
  <info>int</info>          <strong>$offset</strong>    The search offset. If it is not specified, 0 is used. A negative offset
                          counts from the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int|false</info>  Returns the numeric position of the first occurrence of <strong>$needle</strong> in the <strong>$haystack</strong>
             <info>string</info>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strpos()</strong>


id: mb_strrchr
type: function
doc:
<comment>Description:</comment>
  Finds the last occurrence of a character in a string within another
  
  <strong>mb_strrchr()</strong> finds the last occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of <strong>$haystack</strong> from the beginning to the last
                               occurrence of <strong>$needle</strong>. If set to <info>false</info>, it returns all of <strong>$haystack</strong>
                               from the last occurrence of <strong>$needle</strong> to the end,
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>. or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>strrchr()</strong>
   * <strong>mb_strstr()</strong>
   * <strong>mb_strrichr()</strong>


id: mb_strrichr
type: function
doc:
<comment>Description:</comment>
  Finds the last occurrence of a character in a string within another, case insensitive
  
  <strong>mb_strrichr()</strong> finds the last occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. Unlike <strong>mb_strrchr()</strong>, <strong>mb_strrichr()</strong> is case-insensitive. If <strong>$needle</strong> is not found, it
  returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of <strong>$haystack</strong> from the beginning to the last
                               occurrence of <strong>$needle</strong>. If set to <info>false</info>, it returns all of <strong>$haystack</strong>
                               from the last occurrence of <strong>$needle</strong> to the end,
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>. or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>mb_stristr()</strong>
   * <strong>mb_strrchr()</strong>


id: mb_strripos
type: function
doc:
<comment>Description:</comment>
  Finds position of last occurrence of a string within another, case insensitive
  
  <strong>mb_strripos()</strong> performs multi-byte safe <strong>strripos()</strong> operation based on number of characters. <strong>$needle</strong>
  position is counted from the beginning of <strong>$haystack</strong>. First character's position is 0. Second
  character position is 1.  Unlike <strong>mb_strrpos()</strong>, <strong>mb_strripos()</strong> is case-insensitive.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The string from which to get the position of the last occurrence of
                          <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The string to find in <strong>$haystack</strong>
  <info>int</info>          <strong>$offset</strong>    The position in <strong>$haystack</strong> to start searching
  <info>string|null</info>  <strong>$encoding</strong>  Character encoding name to use. If it is omitted, internal character
                          encoding is used.

<comment>Return:</comment>
  <info>int|false</info>  Return the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> string,
             or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>strripos()</strong>
   * <strong>strrpos()</strong>
   * <strong>mb_strrpos()</strong>


id: mb_strrpos
type: function
doc:
<comment>Description:</comment>
  Find position of last occurrence of a string in a string
  
  Performs a multibyte safe <strong>strrpos()</strong> operation based on the  number of characters. <strong>$needle</strong> position
  is counted from the beginning of <strong>$haystack</strong>. First character's position is 0. Second character
  position is 1.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked, for the last occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>    The <info>string</info> to find in <strong>$haystack</strong>.
  <info>int</info>          <strong>$offset</strong>    May be specified to begin searching an arbitrary number of characters into
                          the <info>string</info>.  Negative values will stop searching at an arbitrary point
                          prior to the end of the <info>string</info>.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int|false</info>  Returns the numeric position of the last occurrence of <strong>$needle</strong> in the <strong>$haystack</strong> <info>string</info>.
             If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_internal_encoding()</strong>
   * <strong>strrpos()</strong>


id: mb_strstr
type: function
doc:
<comment>Description:</comment>
  Finds first occurrence of a string within another
  
  <strong>mb_strstr()</strong> finds the first occurrence of <strong>$needle</strong> in <strong>$haystack</strong> and returns the portion of
  <strong>$haystack</strong>. If <strong>$needle</strong> is not found, it returns <info>false</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>       The string from which to get the first occurrence of <strong>$needle</strong>
  <info>string</info>       <strong>$needle</strong>         The string to find in <strong>$haystack</strong>
  <info>bool</info>         <strong>$before_needle</strong>  Determines which portion of <strong>$haystack</strong> this function returns.  If set
                               to <info>true</info>, it returns all of  <strong>$haystack</strong> from the beginning to the first
                               occurrence of <strong>$needle</strong> (excluding needle). If set to <info>false</info>, it returns
                               all of <strong>$haystack</strong> from the first occurrence of <strong>$needle</strong> to the end
                               (including needle).
  <info>string|null</info>  <strong>$encoding</strong>       Character encoding name to use. If it is omitted, internal character
                               encoding is used.

<comment>Return:</comment>
  <info>string|false</info>  Returns the portion of <strong>$haystack</strong>, or <info>false</info> if <strong>$needle</strong> is not found.

<comment>See Also:</comment>
   * <strong>stristr()</strong>
   * <strong>strstr()</strong>
   * <strong>mb_stristr()</strong>


id: mb_strtolower
type: function
doc:
<comment>Description:</comment>
  Torna uma string minúscula
  
  Retorna <strong>$string</strong> com todos os caracteres alfabéticos convertidos em minúsculas.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A <info>string</info> a ser convertida em minúsculas.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> com todos os caracteres alfabéticos convertidos em minúsculas.

<comment>See Also:</comment>
   * <strong>mb_strtoupper()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtolower()</strong>


id: mb_strtoupper
type: function
doc:
<comment>Description:</comment>
  Make a string uppercase
  
  Returns <strong>$string</strong> with all alphabetic characters converted to uppercase.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being uppercased.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  <strong>$string</strong> with all alphabetic characters converted to uppercase.

<comment>See Also:</comment>
   * <strong>mb_strtolower()</strong>
   * <strong>mb_convert_case()</strong>
   * <strong>strtoupper()</strong>


id: mb_strwidth
type: function
doc:
<comment>Description:</comment>
  Return width of string
  
  Returns the width of <info>string</info> <strong>$string</strong>, where halfwidth characters count as <return>1</return>, and fullwidth
  characters count as <return>2</return>. See http://www.unicode.org/reports/tr11/ for details regarding East Asian
  character widths.
  
  The fullwidth characters are: <return>U+1100</return>-<return>U+115F</return>, <return>U+11A3</return>-<return>U+11A7</return>, <return>U+11FA</return>-<return>U+11FF</return>, <return>U+2329</return>-<return>U+232A</return>,
  <return>U+2E80</return>-<return>U+2E99</return>, <return>U+2E9B</return>-<return>U+2EF3</return>, <return>U+2F00</return>-<return>U+2FD5</return>, <return>U+2FF0</return>-<return>U+2FFB</return>, <return>U+3000</return>-<return>U+303E</return>, <return>U+3041</return>-<return>U+3096</return>,
  <return>U+3099</return>-<return>U+30FF</return>, <return>U+3105</return>-<return>U+312D</return>, <return>U+3131</return>-<return>U+318E</return>, <return>U+3190</return>-<return>U+31BA</return>, <return>U+31C0</return>-<return>U+31E3</return>, <return>U+31F0</return>-<return>U+321E</return>,
  <return>U+3220</return>-<return>U+3247</return>, <return>U+3250</return>-<return>U+32FE</return>, <return>U+3300</return>-<return>U+4DBF</return>, <return>U+4E00</return>-<return>U+A48C</return>, <return>U+A490</return>-<return>U+A4C6</return>, <return>U+A960</return>-<return>U+A97C</return>,
  <return>U+AC00</return>-<return>U+D7A3</return>, <return>U+D7B0</return>-<return>U+D7C6</return>, <return>U+D7CB</return>-<return>U+D7FB</return>, <return>U+F900</return>-<return>U+FAFF</return>, <return>U+FE10</return>-<return>U+FE19</return>, <return>U+FE30</return>-<return>U+FE52</return>,
  <return>U+FE54</return>-<return>U+FE66</return>, <return>U+FE68</return>-<return>U+FE6B</return>, <return>U+FF01</return>-<return>U+FF60</return>, <return>U+FFE0</return>-<return>U+FFE6</return>, <return>U+1B000</return>-<return>U+1B001</return>, <return>U+1F200</return>-<return>U+1F202</return>,
  <return>U+1F210</return>-<return>U+1F23A</return>, <return>U+1F240</return>-<return>U+1F248</return>, <return>U+1F250</return>-<return>U+1F251</return>, <return>U+20000</return>-<return>U+2FFFD</return>, <return>U+30000</return>-<return>U+3FFFD</return>. All other
  characters are halfwidth characters.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> being decoded.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int</info>  The width of <info>string</info> <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>mb_strimwidth()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substitute_character
type: function
doc:
<comment>Description:</comment>
  Set/Get substitution character
  
  Specifies a substitution character when input character encoding is invalid or character code does
  not exist in output character encoding. Invalid characters may be substituted <return>"none"</return> (no output),
  <info>string</info> or <info>int</info> value (Unicode character code value).
  
  This setting affects <strong>mb_convert_encoding()</strong>, <strong>mb_convert_variables()</strong>, <strong>mb_output_handler()</strong>, and
  <strong>mb_send_mail()</strong>.

<comment>Param:</comment>
  <info>string|int|null</info>  <strong>$substitute_character</strong>  Specify the Unicode value as an <info>int</info>,  or as one of the
                                          following <info>string</info>s: <return>"none"</return>: no output <return>"long"</return>: Output
                                          character code value (Example: <return>U+3000</return>, <return>JIS+7E7E</return>) <return>"entity"</return>:
                                          Output character entity (Example: <return>&#x200;</return>)
                                          
                                          <return>"none"</return>: no output
                                          
                                          <return>"long"</return>: Output character code value (Example: <return>U+3000</return>,
                                          <return>JIS+7E7E</return>)
                                          
                                          <return>"entity"</return>: Output character entity (Example: <return>&#x200;</return>)

<comment>Return:</comment>
  <info>string|int|bool</info>  If <strong>$substitute_character</strong> is set, it returns <info>true</info> for success, otherwise returns
                   <info>false</info>.  If <strong>$substitute_character</strong> is not set, it returns the current setting.


id: mb_substr
type: function
doc:
<comment>Description:</comment>
  Get part of string
  
  Performs a multi-byte safe <strong>substr()</strong> operation based on number of characters. Position is counted
  from the beginning of <strong>$string</strong>. First character's position is 0. Second character position is 1,
  and so on.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The <info>string</info> to extract the substring from.
  <info>int</info>          <strong>$start</strong>     If <strong>$start</strong> is non-negative, the returned string will start at the <strong>$start</strong>'th
                          position in <strong>$string</strong>, counting from zero. For instance, in the string
                          '<return>abcdef</return>', the character at position <return>0</return> is '<return>a</return>', the character at position <return>2</return>
                          is '<return>c</return>', and so forth.
                          
                          If <strong>$start</strong> is negative, the returned string will start at the <strong>$start</strong>'th
                          character from the end of <strong>$string</strong>.
  <info>int|null</info>     <strong>$length</strong>    Maximum number of characters to use from <strong>$string</strong>. If omitted or <return>NULL</return> is
                          passed, extract all characters to the end of the string.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>string</info>  <strong>mb_substr()</strong> returns the portion of <strong>$string</strong> specified by the <strong>$start</strong> and <strong>$length</strong> parameters.

<comment>See Also:</comment>
   * <strong>mb_strcut()</strong>
   * <strong>mb_internal_encoding()</strong>


id: mb_substr_count
type: function
doc:
<comment>Description:</comment>
  Count the number of substring occurrences
  
  Counts the number of times the <strong>$needle</strong> substring occurs in the <strong>$haystack</strong> <info>string</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The <info>string</info> being checked.
  <info>string</info>       <strong>$needle</strong>    The <info>string</info> being found.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro <strong>$encoding</strong>
                          é a codificação de caracteres. Se for omitido ou <info>null</info>, o valor da
                          codificação
                          de caracteres interna será usado.

<comment>Return:</comment>
  <info>int</info>  The number of times the <strong>$needle</strong> substring occurs in the <strong>$haystack</strong> <info>string</info>.

<comment>See Also:</comment>
   * <strong>mb_strpos()</strong>
   * <strong>mb_substr()</strong>
   * <strong>substr_count()</strong>


id: mcrypt_create_iv
type: function
doc:
<comment>Description:</comment>
  Creates an initialization vector (IV) from a random source
  
  Creates an initialization vector (IV) from a random source.
  
  The IV is only meant to give an alternative seed to the encryption routines. This IV does not need
  to be secret at all, though it can be desirable. You even can send it along with your ciphertext
  without losing security.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>    The size of the IV.
  <info>int</info>  <strong>$source</strong>  The source of the IV. The source can be <info>MCRYPT_RAND</info> (system random number
                generator), <info>MCRYPT_DEV_RANDOM</info> (read data from /dev/random) and <info>MCRYPT_DEV_URANDOM</info>
                (read data from /dev/urandom). Prior to 5.3.0, <info>MCRYPT_RAND</info> was the only one
                supported on Windows.
                
                Note that the default value of this parameter was <info>MCRYPT_DEV_RANDOM</info> prior to PHP
                5.6.0.
                
                Note that <info>MCRYPT_DEV_RANDOM</info> may block until more entropy is available.

<comment>Return:</comment>
  <info>string</info>  Returns the initialization vector, or <info>false</info> on error.

<comment>See Also:</comment>
   * http://www.ciphersbyritter.com/GLOSSARY.HTM#IV
   * http://www.quadibloc.com/crypto/co0409.htm
   * Chapter 9.3 of Applied Cryptography by Schneier (ISBN 0-471-11709-9)
   * <strong>random_bytes()</strong>


id: mcrypt_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts crypttext with given parameters
  
  Decrypts the <strong>$data</strong> and returns the unencrypted data.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$key</strong>     The key with which the data was encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be decrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
  <info>string</info>  <strong>$mode</strong>    Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                   "cbc", "cfb", "ofb", "nofb" ou "stream".
  <info>string</info>  <strong>$iv</strong>      Usado para a inicialização nos modos CBC, CFB, OFB e em alguns algoritmos no modo
                   STREAM. Se o tamanho do IV fornecido não for suportado pelo modo de encadeamento
                   ou nenhum IV for fornecido, mas o modo de encadeamento exigir um, a função
                   emitirá um aviso e retornará <info>false</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the decrypted data as a string  ou <info>false</info> em caso de falha.

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


id: mcrypt_enc_get_algorithms_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened algorithm
  
  This function returns the name of the algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>string</info>  Returns the name of the opened algorithm as a string.


id: mcrypt_enc_get_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the opened algorithm
  
  Gets the blocksize of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the specified algorithm in bytes.


id: mcrypt_enc_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV of the opened algorithm
  
  This function returns the size of the IV of the algorithm specified by the encryption descriptor
  in bytes. An IV is used in cbc, cfb and ofb modes, and in some algorithms in stream mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the IV, or 0 if the IV is ignored by the algorithm.


id: mcrypt_enc_get_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported key size of the algorithm in bytes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum supported key size of the algorithm in bytes.


id: mcrypt_enc_get_modes_name
type: function
doc:
<comment>Description:</comment>
  Returns the name of the opened mode
  
  This function returns the name of the mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>string</info>  Returns the name as a string.


id: mcrypt_enc_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Gets the supported key sizes of the opened algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the algorithm specified by the encryption
         descriptor. If it returns an empty array then all key sizes between 1 and
         <strong>mcrypt_enc_get_key_size()</strong> are supported by the algorithm.


id: mcrypt_enc_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  Checks whether the algorithm of the opened mode is a block algorithm
  
  Tells whether the algorithm of the opened mode is a block algorithm.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the algorithm is a block algorithm or <info>false</info> if it is a stream one.


id: mcrypt_enc_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the encryption of the opened mode works on blocks
  
  Tells whether the algorithm of the opened mode works on blocks (e.g. <info>false</info> for stream, and <info>true</info>
  for cbc, cfb, ofb)..

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns <info>false</info>.


id: mcrypt_enc_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Checks whether the opened mode outputs blocks
  
  Tells whether the opened mode outputs blocks (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and
  stream).

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the mode outputs blocks of bytes, or <info>false</info> if it outputs just bytes.


id: mcrypt_enc_self_test
type: function
doc:
<comment>Description:</comment>
  Runs a self test on the opened module
  
  This function runs the self test on the algorithm specified by the descriptor <strong>$td</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>int</info>  Returns <return>0</return> on success and a negative <info>int</info> on failure.


id: mcrypt_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts plaintext with given parameters
  
  Encrypts the data and returns it.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$key</strong>     The key with which the data will be encrypted. If the provided key size is not
                   supported by the cipher, the function will emit a warning and return <info>false</info>
  <info>string</info>  <strong>$data</strong>    The data that will be encrypted with the given <strong>$cipher</strong> and <strong>$mode</strong>. If the size of
                   the data is not n * blocksize, the data will be padded with '<return>\0</return>'.
                   
                   The returned crypttext can be larger than the size of the data that was given by
                   <strong>$data</strong>.
  <info>string</info>  <strong>$mode</strong>    Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                   "cbc", "cfb", "ofb", "nofb" ou "stream".
  <info>string</info>  <strong>$iv</strong>      Usado para a inicialização nos modos CBC, CFB, OFB e em alguns algoritmos no modo
                   STREAM. Se o tamanho do IV fornecido não for suportado pelo modo de encadeamento
                   ou nenhum IV for fornecido, mas o modo de encadeamento exigir um, a função
                   emitirá um aviso e retornará <info>false</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the encrypted data as a string  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mcrypt_decrypt()</strong>
   * <strong>mcrypt_module_open()</strong>


id: mcrypt_generic
type: function
doc:
<comment>Description:</comment>
  This function encrypts data
  
  This function encrypts data. The data is padded with "<return>\0</return>" to make sure the length of the data is n
  * blocksize. This function returns the encrypted data. Note that the length of the returned string
  can in fact be longer than the input, due to the padding of the data.
  
  If you want to store the encrypted data in a database make sure to store the entire string as
  returned by mcrypt_generic, or the string will not entirely decrypt properly.  If your original
  string is 10 characters long and the block size is 8 (use <strong>mcrypt_enc_get_block_size()</strong> to determine
  the blocksize), you would need at least 16 characters in your database field. Note the string
  returned by <strong>mdecrypt_generic()</strong> will be 16 characters as well...use rtrim($str, "\0") to remove the
  padding.
  
  If you are for example storing the data in a MySQL database remember that varchar fields
  automatically have trailing spaces removed during insertion. As encrypted data can end in a space
  (ASCII 32), the data will be damaged by this removal.  Store data in a tinyblob/tinytext (or
  larger) field instead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    The encryption descriptor.
                   
                   The encryption handle should always be initialized with <strong>mcrypt_generic_init()</strong>
                   with a key and an IV before calling this function. Where the encryption is done,
                   you should free the encryption buffers by calling <strong>mcrypt_generic_deinit()</strong>. See
                   <strong>mcrypt_module_open()</strong> for an example.
  <info>string</info>    <strong>$data</strong>  The data to encrypt.

<comment>Return:</comment>
  <info>string</info>  Returns the encrypted data.

<comment>See Also:</comment>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_generic_deinit
type: function
doc:
<comment>Description:</comment>
  This function deinitializes an encryption module
  
  This function terminates encryption specified by the encryption descriptor (<strong>$td</strong>). It clears all
  buffers, but does not close the module.  You need to call <strong>mcrypt_module_close()</strong> yourself. (But PHP
  does this for you at the end of the script.)

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mcrypt_module_open()</strong>
   * <strong>mcrypt_generic_init()</strong>


id: mcrypt_generic_init
type: function
doc:
<comment>Description:</comment>
  This function initializes all buffers needed for encryption
  
  You need to call this function before every call to <strong>mcrypt_generic()</strong> or <strong>mdecrypt_generic()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>   The encryption descriptor.
  <info>string</info>    <strong>$key</strong>  The maximum length of the key should be the one obtained by calling
                  <strong>mcrypt_enc_get_key_size()</strong> and every value smaller than this is legal.
  <info>string</info>    <strong>$iv</strong>   The IV should normally have the size of the algorithms block size, but you must
                  obtain the size by calling <strong>mcrypt_enc_get_iv_size()</strong>. IV is ignored in ECB. IV MUST
                  exist in CFB, CBC, STREAM, nOFB and OFB modes. It needs to be random and unique
                  (but not secret). The same IV must be used for encryption/decryption. If you do
                  not want to use it you should set it to zeros, but this is not recommended.

<comment>Return:</comment>
  <info>int</info>  The function returns a negative value on error: -3 when the key length was incorrect, -4 when
       there was a memory allocation problem and any other return value is an unknown error. If an
       error occurs a warning will be displayed accordingly. <info>false</info> is returned if incorrect
       parameters were passed.

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


id: mcrypt_get_block_size
type: function
doc:
<comment>Description:</comment>
  Gets the block size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_block_size()</strong> is used to get the size of a block of the specified <strong>$cipher</strong> (in
  combination with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_block_size()</strong> function as this uses the resource
  returned by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$mode</strong>    Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                   "cbc", "cfb", "ofb", "nofb" ou "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the algorithm block size in bytes  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mcrypt_get_key_size()</strong>
   * <strong>mcrypt_enc_get_block_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_get_cipher_name
type: function
doc:
<comment>Description:</comment>
  Gets the name of the specified cipher
  
  <strong>mcrypt_get_cipher_name()</strong> is used to get the name of the specified cipher.
  
  <strong>mcrypt_get_cipher_name()</strong> takes the cipher number as an argument (libmcrypt 2.2.x) or takes the
  cipher name as an argument (libmcrypt 2.4.x or higher) and returns the name of the cipher or
  <info>false</info>, if the cipher does not exist.

<comment>Param:</comment>
  <info>int</info>  <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.

<comment>Return:</comment>
  <info>string</info>  This function returns the name of the cipher or <info>false</info> if the cipher does not exist.


id: mcrypt_get_iv_size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the IV belonging to a specific cipher/mode combination
  
  Gets the size of the IV belonging to a specific  <strong>$cipher</strong>/<strong>$mode</strong> combination.
  
  It is more useful to use the <strong>mcrypt_enc_get_iv_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$mode</strong>    Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                   "cbc", "cfb", "ofb", "nofb" ou "stream".
                   
                   The IV is ignored in ECB mode as this mode does not require it. You will need to
                   have the same IV (think: starting point) both at encryption and decryption
                   stages, otherwise your encryption will fail.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the Initialization Vector (IV) in bytes. On error the function returns
       <info>false</info>. If the IV is ignored in the specified cipher/mode combination zero is returned.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_iv_size()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: mcrypt_get_key_size
type: function
doc:
<comment>Description:</comment>
  Gets the key size of the specified cipher
  
  The first prototype is when linked against libmcrypt 2.2.x, the second when linked against
  libmcrypt 2.4.x or 2.5.x.
  
  <strong>mcrypt_get_key_size()</strong> is used to get the size of a key of the specified <strong>$cipher</strong> (in combination
  with an encryption mode).
  
  It is more useful to use the <strong>mcrypt_enc_get_key_size()</strong> function as this uses the resource returned
  by <strong>mcrypt_module_open()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$cipher</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$mode</strong>    Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                   "cbc", "cfb", "ofb", "nofb" ou "stream".

<comment>Return:</comment>
  <info>int|false</info>  Returns the maximum supported key size of the algorithm in bytes ou <info>false</info> em caso de
             falha.

<comment>See Also:</comment>
   * <strong>mcrypt_get_block_size()</strong>
   * <strong>mcrypt_enc_get_key_size()</strong>
   * <strong>mcrypt_encrypt()</strong>


id: mcrypt_list_algorithms
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported ciphers
  
  Gets the list of all supported algorithms in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all algorithms are located. If not specified, the
                    value of the <return>mcrypt.algorithms_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported algorithms.


id: mcrypt_list_modes
type: function
doc:
<comment>Description:</comment>
  Gets an array of all supported modes
  
  Gets the list of all supported modes in the <strong>$lib_dir</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$lib_dir</strong>  Specifies the directory where all modes are located. If not specified, the value
                    of the <return>mcrypt.modes_dir</return> php.ini directive is used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with all the supported modes.


id: mcrypt_module_close
type: function
doc:
<comment>Description:</comment>
  Closes the mcrypt module
  
  Closes the specified encryption handle.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>  The encryption descriptor.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mcrypt_module_get_algo_block_size
type: function
doc:
<comment>Description:</comment>
  Returns the blocksize of the specified algorithm
  
  Gets the blocksize of the specified algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  Returns the block size of the algorithm specified in bytes.


id: mcrypt_module_get_algo_key_size
type: function
doc:
<comment>Description:</comment>
  Returns the maximum supported keysize of the opened mode
  
  Gets the maximum supported keysize of the opened mode.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm name.
  <info>string</info>  <strong>$lib_dir</strong>    This optional parameter can contain the location where the mode module is on
                      the system.

<comment>Return:</comment>
  <info>int</info>  This function returns the maximum supported key size of the algorithm specified in bytes.


id: mcrypt_module_get_supported_key_sizes
type: function
doc:
<comment>Description:</comment>
  Returns an array with the supported keysizes of the opened algorithm
  
  Returns an array with the key sizes supported by the specified algorithm. If it returns an empty
  array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are supported by the
  algorithm.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to be used.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the key sizes supported by the specified algorithm. If it returns an
         empty array then all key sizes between 1 and <strong>mcrypt_module_get_algo_key_size()</strong> are
         supported by the algorithm.

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


id: mcrypt_module_is_block_algorithm
type: function
doc:
<comment>Description:</comment>
  This function checks whether the specified algorithm is a block algorithm
  
  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it is a
  stream one.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  The algorithm to check.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified algorithm is a block algorithm, or <info>false</info> if it
        is a stream one.


id: mcrypt_module_is_block_algorithm_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified module is a block algorithm or not
  
  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it returns
  <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     The mode to check.
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode is for use with block algorithms, otherwise it
        returns <info>false</info>. (e.g. <info>false</info> for stream, and <info>true</info> for cbc, cfb, ofb).


id: mcrypt_module_is_block_mode
type: function
doc:
<comment>Description:</comment>
  Returns if the specified mode outputs blocks or not
  
  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just bytes.
  (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).

<comment>Param:</comment>
  <info>string</info>  <strong>$mode</strong>     Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes strings: "ecb",
                    "cbc", "cfb", "ofb", "nofb" ou "stream".
  <info>string</info>  <strong>$lib_dir</strong>  The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                    module is on the system.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the mode outputs blocks of bytes or <info>false</info> if it outputs just
        bytes. (e.g. <info>true</info> for cbc and ecb, and <info>false</info> for cfb and stream).


id: mcrypt_module_open
type: function
doc:
<comment>Description:</comment>
  Opens the module of the algorithm and the mode to be used
  
  This function opens the module of the algorithm and the mode to be used. The name of the algorithm
  is specified in algorithm, e.g. <return>"twofish"</return> or is one of the <info>MCRYPT_ciphername</info> constants.  The
  module is closed by calling <strong>mcrypt_module_close()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>            Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como
                                string.
  <info>string</info>  <strong>$algorithm_directory</strong>  The <strong>$algorithm_directory</strong> parameter is used to locate the encryption
                                module. When you supply a directory name, it is used.  When you set
                                it to an empty string (<return>""</return>), the value set by the
                                <return>mcrypt.algorithms_dir</return> php.ini directive is used. When it is not set,
                                the default directory that is used is the one that was compiled into
                                libmcrypt (usually /usr/local/lib/libmcrypt).
  <info>string</info>  <strong>$mode</strong>                 Uma das constantes <info>MCRYPT_MODE_nome_do_modo</info> ou uma das seguintes
                                strings: "ecb", "cbc", "cfb", "ofb", "nofb" ou "stream".
  <info>string</info>  <strong>$mode_directory</strong>       The <strong>$mode_directory</strong> parameter is used to locate the encryption
                                module. When you supply a directory name, it is used.  When you set
                                it to an empty string (<return>""</return>), the value set by the <return>mcrypt.modes_dir</return>
                                php.ini directive is used. When it is not set, the default directory
                                that is used is the one that was compiled-in into libmcrypt (usually
                                /usr/local/lib/libmcrypt).

<comment>Return:</comment>
  <info>resource</info>  Normally it returns an encryption descriptor, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mcrypt_module_close()</strong>
   * <strong>mcrypt_generic()</strong>
   * <strong>mdecrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: mcrypt_module_self_test
type: function
doc:
<comment>Description:</comment>
  This function runs a self test on the specified module
  
  This function runs the self test on the algorithm specified.

<comment>Param:</comment>
  <info>string</info>  <strong>$algorithm</strong>  Uma das constantes <info>MCRYPT_nome_da_cifra</info> ou o nome do algoritmo como string.
  <info>string</info>  <strong>$lib_dir</strong>    The optional <strong>$lib_dir</strong> parameter can contain the location where the algorithm
                      module is on the system.

<comment>Return:</comment>
  <info>bool</info>  The function returns <info>true</info> if the self test succeeds, or <info>false</info> when it fails.


id: md5
type: function
doc:
<comment>Description:</comment>
  Calculate the md5 hash of a string
  
  Calculates the MD5 hash of <strong>$string</strong> using the RSA Data Security, Inc. MD5 Message-Digest Algorithm,
  and returns that hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string.
  <info>bool</info>    <strong>$binary</strong>  If the optional <strong>$binary</strong> is set to <info>true</info>, then the md5 digest is instead returned
                   in raw binary format with a length of 16.

<comment>Return:</comment>
  <info>string</info>  Returns the hash as a 32-character hexadecimal number.

<comment>See Also:</comment>
   * <strong>md5_file()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>
   * <strong>sha1()</strong>
   * <strong>hash()</strong>
   * <strong>crypt()</strong>
   * <strong>password_hash()</strong>


id: md5_file
type: function
doc:
<comment>Description:</comment>
  Calculates the md5 hash of a given file
  
  Calculates the MD5 hash of the file specified by the <strong>$filename</strong> parameter using the RSA Data
  Security, Inc.  MD5 Message-Digest Algorithm, and returns that hash. The hash is a 32-character
  hexadecimal number.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename
  <info>bool</info>    <strong>$binary</strong>    When <info>true</info>, returns the digest in raw binary format with a length of 16.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string on success, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>md5()</strong>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>


id: mdecrypt_generic
type: function
doc:
<comment>Description:</comment>
  Decrypts data
  
  This function decrypts data. Note that the length of the returned string can in fact be longer
  than the unencrypted string, due to the padding of the data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$td</strong>    An encryption descriptor returned by <strong>mcrypt_module_open()</strong>
  <info>string</info>    <strong>$data</strong>  Encrypted data.

<comment>Return:</comment>
  <info>string</info>  Returns decrypted string.

<comment>See Also:</comment>
   * <strong>mcrypt_generic()</strong>
   * <strong>mcrypt_generic_init()</strong>
   * <strong>mcrypt_generic_deinit()</strong>


id: memcache_debug
type: function
doc:
<comment>Description:</comment>
  Turn debug output on/off
  
  <strong>memcache_debug()</strong> turns on debug output if parameter <strong>$on_off</strong> is equal to <info>true</info> and turns off if it's
  <info>false</info>. <strong>memcache_debug()</strong> is accessible only if PHP was built with --enable-debug option and always
  returns <info>true</info> in this case. Otherwise, this function has no effect and always returns <info>false</info>.
  
  <strong>memcache_debug()</strong> is accessible only if PHP was built with --enable-debug option and always returns
  <info>true</info> in this case. Otherwise, this function has no effect and always returns <info>false</info>.

<comment>Param:</comment>
  <info>bool</info>  <strong>$on_off</strong>  Turns debug output on if equals to <info>true</info>. Turns debug output off if equals to <info>false</info>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if PHP was built with --enable-debug option, otherwise returns <info>false</info>.


id: memory_get_peak_usage
type: function
doc:
<comment>Description:</comment>
  Returns the peak of memory allocated by PHP
  
  Returns the peak of memory, in bytes, that's been allocated to your PHP script.

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  Set this to <info>true</info> to get the real size of memory allocated from system. If not
                     set or <info>false</info> only the memory used by <return>emalloc()</return> is reported.

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

<comment>See Also:</comment>
   * <strong>memory_get_usage()</strong>
   * <strong>memory_reset_peak_usage()</strong>
   * memory_limit


id: memory_get_usage
type: function
doc:
<comment>Description:</comment>
  Returns the amount of memory allocated to PHP
  
  Returns the amount of memory, in bytes, that's currently being allocated to your PHP script.

<comment>Param:</comment>
  <info>bool</info>  <strong>$real_usage</strong>  Set this to <info>true</info> to get total memory allocated from system, including unused
                     pages.  If not set or <info>false</info> only the used memory is reported.

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

<comment>See Also:</comment>
   * <strong>memory_get_peak_usage()</strong>
   * memory_limit


id: memory_reset_peak_usage
type: function
doc:
<comment>Description:</comment>
  Reset the peak memory usage
  
  Resets the peak memory usage returned by the <strong>memory_get_peak_usage()</strong> function.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: metaphone
type: function
doc:
<comment>Description:</comment>
  Calculate the metaphone key of a string
  
  Calculates the metaphone key of <strong>$string</strong>.
  
  Similar to <strong>soundex()</strong> metaphone creates the same key for similar sounding words. It's more accurate
  than <strong>soundex()</strong> as it knows the basic rules of English pronunciation.  The metaphone generated keys
  are of variable length.
  
  Metaphone was developed by Lawrence Philips \<lphilips at verity dot com&gt;. It is described in ["Practical Algorithms for Programmers", Binstock & Rex, Addison Wesley, 1995].

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>        The input string.
  <info>int</info>     <strong>$max_phonemes</strong>  This parameter restricts the returned metaphone key to  <strong>$max_phonemes</strong>
                         characters in length. However, the resulting phonemes are always
                         transcribed completely, so the resulting string length may be slightly
                         longer than <strong>$max_phonemes</strong>. The default value of <return>0</return> means no restriction.

<comment>Return:</comment>
  <info>string</info>  Returns the metaphone key as a string.


id: method_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se o método da classe existe
  
  Verifica se o método da classe existe no <strong>$object_or_class</strong> fornecido.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  Uma instância de objeto ou um nome de classe
  <info>string</info>         <strong>$method</strong>           O nome do método

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se método informado no parâmetro <strong>$method</strong> foi definido para o <strong>$object_or_class</strong>
        informado, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>is_callable()</strong>
   * <strong>class_exists()</strong>


id: mhash
type: function
doc:
<comment>Description:</comment>
  Computa a hash
  
  <strong>mhash()</strong> aplica a função hash especificada por <strong>$algo</strong> ao parâmetro <strong>$data</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$algo</strong>  O ID da hash. Uma das constantes <info>MHASH_hashname</info>.
  <info>string</info>       <strong>$data</strong>  A entrada do usuário, como uma string.
  <info>string|null</info>  <strong>$key</strong>   Se especificado, a função irá retornar o HMAC resultante. HMAC é o hashing com
                      chave para autenticações de mensagens, ou simplesmente um resumo de mensagem
                      que depende da chave especificada. Nem todos os algoritmos suportados em mhash
                      podem ser usados em modo HMAC.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o hash resultante (também chamado resumo ou digest) ou HMAC como uma string,
                ou <info>false</info> em caso de erro.


id: mhash_count
type: function
doc:
<comment>Description:</comment>
  Obtém o ID de hash mais alto disponível
  
  Obtém o ID de hash mais alto disponível.

<comment>Return:</comment>
  <info>int</info>  Retorna  o ID de hash mais alto disponível. Hashes são numeradas de 0 até este ID de hash.


id: mhash_get_block_size
type: function
doc:
<comment>Description:</comment>
  Obtém o tamanho de bloco da hash especificada
  
  Obtém o tamanho de um bloco da hash informada em <strong>$algo</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  O ID da hash. Uma das constantes <info>MHASH_hashname</info>.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o tamanho em bytes ou <info>false</info>, se a hash em <strong>$algo</strong> não existir.


id: mhash_get_hash_name
type: function
doc:
<comment>Description:</comment>
  Obtém o nome da hash especificada
  
  Obtém o nome da hash especificada em <strong>$algo</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  O ID da hash. Uma das constantes <info>MHASH_hashname</info>.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome da hash ou <info>false</info>, se a hash não existir.


id: mhash_keygen_s2k
type: function
doc:
<comment>Description:</comment>
  Gera uma chave
  
  Gera um chave de acordo com o parâmetro <strong>$algo</strong> a partir de uma senha de usuário informada em
  <strong>$password</strong>.
  
  Este é o algoritmo Salted S2K como especificado no documento OpenPGP (RFC 2440).
  
  Tenha em mente que senhas fornecidas pelos usuários não são adequadas para uso como chaves em
  algoritmos criptográficos, pois os usuários normalmente escolhem chaves que podem ser escritas no
  teclado. Estas senhas usam somente 6 a 7 bits por caractere (ou menos). É altamente recomendado
  usar algum tipo de transformação (como esta função) na chave informada pelo usuário.

<comment>Param:</comment>
  <info>int</info>     <strong>$algo</strong>      O ID da hash usada para criar a chave. Um das constantes <info>MHASH_hashname</info>.
  <info>string</info>  <strong>$password</strong>  Uma senha fornecida pelo usuário.
  <info>string</info>  <strong>$salt</strong>      Deve ser diferente e aleatório o suficiente para cada chave gerada de forma que
                     sejam criadas chaves diferentes. Como <strong>$salt</strong> precisa ser conhecido quando se
                     verifica as chaves, é uma boa prática concatenar a chave a ele. Salt tem um
                     comprimento fixo de 8 bytes e será completado com zeros forem fornecidos menos
                     bytes.
  <info>int</info>     <strong>$length</strong>    O tamanho da chave, em bytes.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a chave gerada como uma string, ou <info>false</info> em caso de erro.


id: microtime
type: function
doc:
<comment>Description:</comment>
  Retorna um timestamp Unix com microsegundos
  
  A função <strong>microtime()</strong> retorna o timestamp atual com microssegundos. Esta função está disponível
  apenas em sistemas operacionais que suportam a chamada de sistema gettimeofday().
  
  Por questões de performance, utilize <strong>hrtime()</strong>.

<comment>Param:</comment>
  <info>bool</info>  <strong>$as_float</strong>  Se utilizada e definida como <info>true</info>, a função <strong>microtime()</strong> retorna um <info>float</info> em vez
                   de uma <info>string</info>, como descrito na seção de valores de retorno a seguir.

<comment>Return:</comment>
  <info>string|float</info>  Por padrão, a função <strong>microtime()</strong> retorna uma <info>string</info> no formato "msec sec", onde <return>sec</return>
                é o número de segundos desde a Unix epoch (0:00:00 January 1,1970 GMT), e <return>msec</return>
                mensura os microssegundos que se passaram desde <return>sec</return> e também é expressada em
                segundos, na forma de frações decimais.
                
                Se o parâmetro opcional <strong>$as_float</strong> for definido para <info>true</info> então a função <strong>microtime()</strong>
                retornará um <info>float</info>, que representa a hora atual em segundos desde Unix epoch com
                precisão de microssegundos.

<comment>See Also:</comment>
   * <strong>time()</strong>
   * <strong>hrtime()</strong>


id: mime_content_type
type: function
doc:
<comment>Description:</comment>
  Detecta o tipo de conteúdo MIME de um arquivo
  
  Retorna o tipo de conteúdo MIME de um arquivo conforme determinado usando informações do arquivo
  magic.mime.

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$filename</strong>  Caminho para o arquivo.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o tipo de conteúdo no formato MIME, como <return>text/plain</return> ou
                <return>application/octet-stream</return>, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>finfo_file()</strong>
   * <strong>finfo_buffer()</strong>


id: min
type: function
doc:
<comment>Description:</comment>
  Encontra o menor valor
  
  Forma alternativa (não suportada com argumentos nomeados):
  
  Se o primeiro e único argumento é um array, <strong>min()</strong> retorna o menor valor no array. Se no mínimo
  dois parâmetros são fornecidos, <strong>min()</strong> retorna o menor deles.
  
  Valores de tipos diferentes serão comparados utilizando  as regras padrões de comparação. Por
  exemplo, uma <info>string</info> não numérica será comparada com um inteiro <info>int</info> como se fosse <return>0</return>, mas várias
  <info>string</info>s não numéricos serão comparadas alfanumericamente. O valor real retornado terá o tipo do
  original, sem nenhuma conversão aplicada.
  
  Cuidado ao passar argumentos de tipos diferentes, pois <strong>min()</strong> pode produzir resultados
  imprevisíveis.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>        Qualquer valor comparável. 
  <info>mixed</info>  <strong>$values</strong>       Quaisquer valores comparáveis. 
  <info>array</info>  <strong>$value_array</strong>  Um array contendo os valores.

<comment>Return:</comment>
  <info>mixed</info>  <strong>min()</strong> retorna o valor considerado o "menor" de acordo com as comparações padrão. Se valores
         de diferentes tipos forem avaliados como iguais (por exemplo <return>0</return> e <return>'abc'</return>) então o primeiro
         valor fornecido à função será retornado.

<comment>See Also:</comment>
   * <strong>max()</strong>
   * <strong>count()</strong>


id: mkdir
type: function
doc:
<comment>Description:</comment>
  Cria um diretório
  
  Tenta criar o diretório especificado pelo parâmetro <strong>$directory</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$directory</strong>    O caminho do diretório. Uma URL pode ser usada como um
                               nome de arquivo com esta função se os wrappers fopen estiverem
                               habilitados.
                               Consulte a função <strong>fopen()</strong> para mais detalhes sobre como especificar
                               o nome do arquivo. Consulte os  para obter links para informações
                               sobre as capacidades de cada wrapper, notas de uso
                               e informações sobre quaisquer variáveis predefinidas que eles possam
                               fornecer.
                               
                               Uma URL pode ser usada como um
                               nome de arquivo com esta função se os wrappers fopen estiverem
                               habilitados.
                               Consulte a função <strong>fopen()</strong> para mais detalhes sobre como especificar
                               o nome do arquivo. Consulte os  para obter links para informações
                               sobre as capacidades de cada wrapper, notas de uso
                               e informações sobre quaisquer variáveis predefinidas que eles possam
                               fornecer.
  <info>int</info>            <strong>$permissions</strong>  A permissão padrão é o octal 0777, que significa o acesso mais
                               abrangente possível. Para mais informações sobre permissões, leia os
                               detalhes na página da função <strong>chmod()</strong>.
                               
                               O parâmetro <strong>$permissions</strong> é ignorado no Windows.
                               
                               Note que provavelmente será desejado especificar <strong>$permissions</strong> como um
                               número octal, o que significa que ele deve ser precedido por zero.
                               <strong>$permissions</strong> também é modificado      inicial. O mode é também
                               modificado pela umaks atual, pela umask atual, que pode ser
                               modificada usando <strong>umask()</strong>.
  <info>bool</info>           <strong>$recursive</strong>    Se for <info>true</info>, quaisquer diretórios acima do especificado em <strong>$directory</strong>
                               serão criados, com as mesmas permissões.
  <info>resource|null</info>  <strong>$context</strong>      Um <info>resource</info> de
                               contexto de stream.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Se o diretório a ser criado já existir, será considerado um erro e <info>false</info> será retornado. Use
        <strong>is_dir()</strong> ou <strong>file_exists()</strong> para verificar se o diretório já existe antes de tentar criá-lo.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>rmdir()</strong>
   * <strong>umask()</strong>


id: mktime
type: function
doc:
<comment>Description:</comment>
  Obtém um timestamp Unix de uma data
  
  Retorna o timestamp Unix correspondente aos argumentos informados. Este timestamp é um inteiro
  longo contendo o número de segundos entre a Era Unix (January 1 1970 00:00:00 GMT), e o tempo
  especificado.
  
  Quaisquer argumentos opcionais omitidos ou <info>null</info> serão definidos para os valores correntes de
  acordo com a data e horário locais.
  
  Favor notar que os argumentos estão em uma ordem não usual: <strong>$month</strong>, <strong>$day</strong>, <strong>$year</strong>, e não na ordem
  mais razoável <strong>$year</strong>, <strong>$month</strong>, <strong>$day</strong>.
  
  Chamar <strong>mktime()</strong> sem argumentos não é suportado, e irá resultar em um <class>ArgumentCountError</class>. <strong>time()</strong>
  pode ser usada para obter o timestamp atual.

<comment>Param:</comment>
  <info>int</info>       <strong>$hour</strong>    O número da hora relativa ao início de determinado dia do <strong>$month</strong>, <strong>$day</strong> e <strong>$year</strong>.
                     Valores negativos referenciam a hora anterior a meia noite do dia em questão.
                     Valores maiores que 23 referenciam a hora correspondente no(s) próximo(s)
                     dia(s).
  <info>int|null</info>  <strong>$minute</strong>  O número de minutos relativos ao início da <strong>$hour</strong>. Valores negativos referenciam
                     minutos da hora anterior. Valores maiores que 23 referenciam os minutos
                     correspondentes a(s) próxima(s) horas(s).
  <info>int|null</info>  <strong>$second</strong>  O número de segundos relativos ao início do <strong>$minute</strong>. Valores negativos
                     referenciam segundos do minuto anterior. Valores maiores que 23 referenciam os
                     segundos correspondentes ao(s) próximo(s) minuto(s).
  <info>int|null</info>  <strong>$month</strong>   O número do mês relativo ao fim do anterior. Valores de 1 a 12 referenciam o
                     calendário normal de meses do ano em questão. Valores menores que 1 (valores
                     negativos, inclusos) referenciam meses do ano anterior em ordem reversa, então
                     0 é Dezembro, -1 Novembro, e etc. Valores maiores que 12 referenciam meses
                     correspondentes ao(s) próximo(s) ano(s).
  <info>int|null</info>  <strong>$day</strong>     O número do dia relativo ao final do mês anterior. Valores de 1 a 28, 29, 30 e
                     31 (dependendo do mês) corresponde a dias normais no mês. Valores menores que 1
                     (valores negativos, inclusos) corresponde a dias no mês anterior, então 0 é o
                     último dia do mês anterior, -1 é o dia anterior a este, e etc. Valores maiores
                     que o número de dias do mês, referenciam dias correspondentes ao(s) próximo(s)
                     mês(es).
  <info>int|null</info>  <strong>$year</strong>    O número do ano. Pode conter dois ou quatro dígitos, com os valores entre 0-69
                     significando 2000-2069 e 70-100 para 1970-2000. Em sistemas aonde o time_t é um
                     inteiro assinado de 32 bit, como é mais comum, o faixa de valores para <strong>$year</strong> é
                     algo entre 1901 e 2038.

<comment>Return:</comment>
  <info>int|false</info>  A função <strong>mktime()</strong> retorna o timestamp Unix dos argumentos informados ou <info>false</info> se o
             timestamp não couber em um inteiro do PHP.

<comment>See Also:</comment>
   * The <class>DateTimeImmutable</class> class
   * <strong>checkdate()</strong>
   * <strong>gmmktime()</strong>
   * <strong>date()</strong>
   * <strong>time()</strong>


id: money_format
type: function
doc:
<comment>Description:</comment>
  Formata um número como uma string de moeda
  
  <strong>money_format()</strong> retorna uma versão formatada de um <strong>$number</strong>.  Esta função engloba a biblioteca de
  função do C <strong>strfmon()</strong>, com a diferença que esta implementação converte apenas um número por vez.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  A especificação do formato consistem da seguinte sequência: a <return>%</return> characterflags
                   opcionaislargura de campo opcionalprecisão da esquerda opcionalprecisão da
                   direita opcionalconversão de caractere requerida
                   
                   a <return>%</return> character
                   
                   flags opcionais
                   
                   largura de campo opcional
                   
                   precisão da esquerda opcional
                   
                   precisão da direita opcional
                   
                   conversão de caractere requerida
                   
                   Uma ou mais, das flags opcionais abaixo podem ser usadas: <return>=</return>f O caracter <return>=</return> seguido
                   por um caractere (único byte) f para ser usado como o caracter númerico de
                   preenchimento. O caractere de preenchimento padrão é o espaço. <return>^</return> Desabilite o uso
                   de agrupamento de caractere (como definido pela localidade atual). <return>+</return> ou <return>(</return>
                   Especifique o estilo de formatação para números positivos e negativos. Se <return>+</return> é
                   usado, o equivalente da localidade para <return>+</return> e <return>-</return> será usado. Se <return>(</return> é usado, quantias
                   negativas são fechadas em parêntesis. se nenhuma especificação é dada, o padrão
                   será <return>+</return>. <return>!</return> Suprima o símbolo atual da string de saída. <return>-</return> Se presente, isso fará
                   todos os campos esquerda-justificados (arrumados para a direita), em oposição ao
                   padrão que é para campos serem direita-justificados (arrumados para a esquerda).
                   
                   O caracter <return>=</return> seguido por um caractere (único byte) f para ser usado como o
                   caracter númerico de preenchimento. O caractere de preenchimento padrão é o
                   espaço.
                   
                   Desabilite o uso de agrupamento de caractere (como definido pela localidade
                   atual).
                   
                   Especifique o estilo de formatação para números positivos e negativos. Se <return>+</return> é
                   usado, o equivalente da localidade para <return>+</return> e <return>-</return> será usado. Se <return>(</return> é usado, quantias
                   negativas são fechadas em parêntesis. se nenhuma especificação é dada, o padrão
                   será <return>+</return>.
                   
                   Suprima o símbolo atual da string de saída.
                   
                   Se presente, isso fará todos os campos esquerda-justificados (arrumados para a
                   direita), em oposição ao padrão que é para campos serem direita-justificados
                   (arrumados para a esquerda).
                   
                   w Uma string de dígito decimal especificando uma largura de campo mínima. O campo
                   será direita-justificado a menos que o flag <return>-</return> seja usado. Valor padrão é 0 (zero)
                   por definição.
                   
                   Uma string de dígito decimal especificando uma largura de campo mínima. O campo
                   será direita-justificado a menos que o flag <return>-</return> seja usado. Valor padrão é 0 (zero)
                   por definição.
                   
                   <return>#</return>n O número máximo de dígitos (n) esperado para a esquerda do caracatere
                   decimal(ex. ponto decimal). Isso é usado normalmente para manter a saída
                   formatada alinhada nas mesmas colunas, usando o caractere de preenchimento se o
                   número de dígitos é menor do que n. Se o número de dígitos atual é maior do que
                   n, então esta especificação é ignorada.  Se agrupamento foi suprimido usando a
                   flag <return>^</return>, separatores de agrupamento serão inseridos antes dos caracteres  de
                   preenchimento (se algum) são adicionados, mesmo se o caractere de preenchimento é
                   um dígito.  Para garantir alinhamento, quaisquer caracteres aparecendo, antes ou
                   depois do número em saída formatada, como moeda ou simbolos de sinal, são
                   arrumado conforme necessário, com caracteres de espaço para fazer seus formatos
                   positivos e negativos num comprimento igual.
                   
                   O número máximo de dígitos (n) esperado para a esquerda do caracatere decimal(ex.
                   ponto decimal). Isso é usado normalmente para manter a saída formatada alinhada
                   nas mesmas colunas, usando o caractere de preenchimento se o número de dígitos é
                   menor do que n. Se o número de dígitos atual é maior do que n, então esta
                   especificação é ignorada.
                   
                   Se agrupamento foi suprimido usando a flag <return>^</return>, separatores de agrupamento serão
                   inseridos antes dos caracteres  de preenchimento (se algum) são adicionados,
                   mesmo se o caractere de preenchimento é um dígito.
                   
                   Para garantir alinhamento, quaisquer caracteres aparecendo, antes ou depois do
                   número em saída formatada, como moeda ou simbolos de sinal, são arrumado conforme
                   necessário, com caracteres de espaço para fazer seus formatos positivos e
                   negativos num comprimento igual.
                   
                   <return>.</return>p Um período seguido por um número de dígitos (p) depois do caractere decimal.
                   Se o valor de p é 0 (zero), o caractere decimal e os digitos à sua direita serão
                   omitidos. Se nenhuma precisão de direita é incluida, o padrão será ditado pela
                   localidade atual em uso. A quantia sendo formatada é arredondada para o número de
                   dígitos especificados a priori para ser formatado.
                    
                   
                   Um período seguido por um número de dígitos (p) depois do caractere decimal. Se o
                   valor de p é 0 (zero), o caractere decimal e os digitos à sua direita serão
                   omitidos. Se nenhuma precisão de direita é incluida, o padrão será ditado pela
                   localidade atual em uso. A quantia sendo formatada é arredondada para o número de
                   dígitos especificados a priori para ser formatado.
                   
                   <return>i</return> O número é formatado de acordo com o formato de moeda internacional da
                   localidade (ex para a localidade de EUA: USD 1,234.56). <return>n</return> O número é formatado de
                   acordo com o formato de moeda nacional da localidade (ex: para a localidade
                   de_DE: DM1.234,56). <return>%</return> Retorna o caractere <return>%</return>.
                   
                   O número é formatado de acordo com o formato de moeda internacional da localidade
                   (ex para a localidade de EUA: USD 1,234.56).
                   
                   O número é formatado de acordo com o formato de moeda nacional da localidade (ex:
                   para a localidade de_DE: DM1.234,56).
                   
                   Retorna o caractere <return>%</return>.
  <info>float</info>   <strong>$number</strong>  O número para ser formatado.

<comment>Return:</comment>
  <info>string</info>  Retorna a string formatada. Os caracteres antes e depois da string de formatação serão
          retornados sem modificação. O parâmetro <strong>$number</strong> com dígitos inválidos causa o retorno de
          <info>null</info> e o lançamento de um <info>E_WARNING</info>.

<comment>See Also:</comment>
   * <strong>setlocale()</strong>
   * <strong>sscanf()</strong>
   * <strong>sprintf()</strong>
   * <strong>printf()</strong>
   * <strong>number_format()</strong>


id: move_uploaded_file
type: function
doc:
<comment>Description:</comment>
  Move um arquivo enviado para uma nova localização
  
  Esta função faz uma verificação para garantir que o arquivo designado por <strong>$from</strong> é um arquivo de
  envio válido (que tenha sido enviado pelo mecanismo de envio POST HTTP do PHP). Se o arquivo for
  válido, ele será movido para o nome de arquivo dado por <strong>$to</strong>.
  
  Este tipo de verificação é especialmente imporante se existir alguma chance de que qualquer coisa
  feita com os arquivos enviados possa revelar seus conteúdos ao usuário, ou mesmo para outros
  usuários no mesmo sistema.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  O nome do arquivo enviado.
  <info>string</info>  <strong>$to</strong>    O destino do arquivo movido.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso.
        
        Se <strong>$from</strong> não for um arquivo enviado válido, nenhuma ação ocorrerá e <strong>move_uploaded_file()</strong>
        retornará <info>false</info>.
        
        Se <strong>$from</strong> for um arquivo enviado válido, mas não puder ser movido por alguma razão, nenhuma
        ação ocorrerá e <strong>move_uploaded_file()</strong> retornará <info>false</info>. Adicionalmente, um alerta será
        emitido.

<comment>See Also:</comment>
   * <strong>is_uploaded_file()</strong>
   * <strong>rename()</strong>
   * Consulteja Gerenciando envio de arquivos para um exemplo de uso básico


id: mqseries_back
type: function
doc:
<comment>Description:</comment>
  MQSeries MQBACK
  
  The <strong>mqseries_back()</strong> (MQBACK) call indicates to the queue manager that all the message gets and
  puts that have occurred since the last syncpoint are to be backed out. Messages put as part of a
  unit of work are deleted; messages retrieved as part of a unit of work are reinstated on the
  queue.
  
  Using <strong>mqseries_back()</strong> only works in conjunction with <strong>mqseries_begin()</strong> and only function when
  connecting directly to a Queueu manager. Not via the mqclient interface.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_begin()</strong>


id: mqseries_begin
type: function
doc:
<comment>Description:</comment>
  MQseries MQBEGIN
  
  The <strong>mqseries_begin()</strong> (MQBEGIN) call begins a unit of work that is coordinated by the queue
  manager, and that may involve external resource managers.
  
  Using <strong>mqseries_begin()</strong> starts the unit of work. Either <strong>mqseries_back()</strong> or <strong>mqseries_cmit()</strong> ends the
  unit of work.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_back()</strong>
   * <strong>mqseries_cmit()</strong>


id: mqseries_close
type: function
doc:
<comment>Description:</comment>
  MQSeries MQCLOSE
  
  The <strong>mqseries_close()</strong> (MQCLOSE) call relinquishes access to an object, and is the inverse of the
  <strong>mqseries_open()</strong> (MQOPEN) call.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info></info>          <strong>$hObj</strong>      Object handle.
                       
                       This handle represents the object to be used.
  <info>int</info>       <strong>$options</strong>   
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_open()</strong>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>


id: mqseries_cmit
type: function
doc:
<comment>Description:</comment>
  MQSeries MQCMIT
  
  The <strong>mqseries_cmit()</strong> (MQCMIT) call indicates to the queue manager that the application has reached
  a syncpoint, and that all of the message gets and puts that have occurred since the last syncpoint
  are to be made permanent. Messages put as part of a unit of work are made available to other
  applications; messages retrieved as part of a unit of work are deleted.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_begin()</strong>
   * <strong>mqseries_back()</strong>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>


id: mqseries_conn
type: function
doc:
<comment>Description:</comment>
  MQSeries MQCONN
  
  The <strong>mqseries_conn()</strong> (MQCONN) call connects an application program to a queue manager. It provides
  a queue manager connection handle, which is used by the application on subsequent message queuing
  calls.

<comment>Param:</comment>
  <info>string</info>    <strong>$qManagerName</strong>  Name of queue manager.
                           
                           Name of the queue manager the application wishes to connect.
  <info></info>          <strong>$hConn</strong>         Connection handle.
                           
                           This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>      Completion code.
  <info>resource</info>  <strong>$reason</strong>        Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: mqseries_connx
type: function
doc:
<comment>Description:</comment>
  MQSeries MQCONNX
  
  The <strong>mqseries_connx()</strong> (MQCONNX) call connects an application program to a queue manager. It
  provides a queue manager connection handle, which is used by the application on subsequent MQ
  calls.
  
  The <strong>mqseries_connx()</strong> call is like the  <strong>mqseries_conn()</strong> (MQCONN) call, except that MQCONNX  allows
  options to be specified to control the way that the call works.

<comment>Param:</comment>
  <info>string</info>    <strong>$qManagerName</strong>  Name of queue manager.
                           
                           Name of the queue manager the application wishes to connect.
  <info></info>          <strong>$connOps</strong>       Options that control the action of function
                           
                           See also the MQCNO structure.
  <info></info>          <strong>$hConn</strong>         Connection handle.
                           
                           This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>      Completion code.
  <info>resource</info>  <strong>$reason</strong>        Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: mqseries_disc
type: function
doc:
<comment>Description:</comment>
  MQSeries MQDISC
  
  The <strong>mqseries_disc()</strong> (MQDISC) call breaks the connection between the queue manager and the
  application program, and is the inverse of the <strong>mqseries_conn()</strong> (MQCONN) or <strong>mqseries_connx()</strong>
  (MQCONNX) call.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>


id: mqseries_get
type: function
doc:
<comment>Description:</comment>
  MQSeries MQGET
  
  The <strong>mqseries_get()</strong> (MQGET) call retrieves a message from a local queue that has been opened using
  the <strong>mqseries_open()</strong> (MQOPEN) call

<comment>Param:</comment>
  <info>resource</info>  <strong>$hConn</strong>         Connection handle.
                           
                           This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$hObj</strong>          Object handle.
                           
                           This handle represents the object to be used.
  <info>array</info>     <strong>$md</strong>            Message descriptor (MQMD).
  <info>array</info>     <strong>$gmo</strong>           Get message options (MQGMO).
  <info>int</info>       <strong>$bufferLength</strong>  Expected length of the result buffer
  <info>string</info>    <strong>$msg</strong>           Buffer holding the message that was retrieved from the object.
  <info>int</info>       <strong>$data_length</strong>   Actual buffer length
  <info>resource</info>  <strong>$compCode</strong>      Completion code.
  <info>resource</info>  <strong>$reason</strong>        Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_open()</strong>
   * <strong>mqseries_put()</strong>


id: mqseries_inq
type: function
doc:
<comment>Description:</comment>
  MQSeries MQINQ
  
  The <strong>mqseries_inq()</strong> (MQINQ) call returns an array of integers and a set of character strings
  containing the attributes of an object.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>           Connection handle.
                             
                             This handle represents the connection to the queue manager.
  <info></info>          <strong>$hObj</strong>            Object handle.
                             
                             This handle represents the object to be used.
  <info>int</info>       <strong>$selectorCount</strong>   Count of selectors.
  <info>array</info>     <strong>$selectors</strong>       Array of attribute selectors.
  <info></info>          <strong>$intAttrLength</strong>   Count of integer attributes.
  <info>resource</info>  <strong>$intAttr</strong>         Array of integer attributes.
  <info>int</info>       <strong>$charAttrLength</strong>  Length of character attributes buffer.
  <info>resource</info>  <strong>$charAttr</strong>        Character attributes.
  <info>resource</info>  <strong>$compCode</strong>        Completion code.
  <info>resource</info>  <strong>$reason</strong>          Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_open()</strong>


id: mqseries_open
type: function
doc:
<comment>Description:</comment>
  MQSeries MQOPEN
  
  The <strong>mqseries_open()</strong> (MQOPEN) call establishes access to an object.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>array</info>     <strong>$objDesc</strong>   Object descriptor. (MQOD)
  <info></info>          <strong>$options</strong>   Options that control the action of the function.
  <info></info>          <strong>$hObj</strong>      Object handle.
                       
                       This handle represents the object to be used.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: mqseries_put
type: function
doc:
<comment>Description:</comment>
  MQSeries MQPUT
  
  The <strong>mqseries_put()</strong> (MQPUT) call puts a message on a queue or distribution list. The queue or
  distribution list must already be open.

<comment>Param:</comment>
  <info>resource</info>  <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$hObj</strong>      Object handle.
                       
                       This handle represents the object to be used.
  <info>array</info>     <strong>$md</strong>        Message descriptor (MQMD).
  <info>array</info>     <strong>$pmo</strong>       Put message options (MQPMO).
  <info>string</info>    <strong>$message</strong>   The actual message to put onto the queue.
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_open()</strong>
   * <strong>mqseries_get()</strong>


id: mqseries_put1
type: function
doc:
<comment>Description:</comment>
  MQSeries MQPUT1
  
  The <strong>mqseries_put1()</strong> (MQPUT1) call puts one message on a queue. The queue need not be open.
  
  You can use both the <strong>mqseries_put()</strong> and <strong>mqseries_put1()</strong> calls to put messages on a queue; which
  call to use depends on the circumstances. Use the <strong>mqseries_put()</strong> (MQPUT) call to place multiple
  messages on the same queue. Use the <strong>mqseries_put1()</strong> (MQPUT1) call to put only one message on a
  queue. This call encapsulates the MQOPEN, MQPUT, and MQCLOSE calls into a single call, minimizing
  the number of calls that must be issued.

<comment>Param:</comment>
  <info></info>          <strong>$hConn</strong>     Connection handle.
                       
                       This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$objDesc</strong>   Object descriptor. (MQOD)
                       
                       This is a structure which identifies the queue to which the message is added.
  <info>resource</info>  <strong>$msgDesc</strong>   Message descriptor (MQMD).
  <info>resource</info>  <strong>$pmo</strong>       Put message options (MQPMO).
  <info>resource</info>  <strong>$compCode</strong>  Completion code.
  <info>resource</info>  <strong>$reason</strong>    Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mqseries_conn()</strong>
   * <strong>mqseries_connx()</strong>
   * <strong>mqseries_open()</strong>
   * <strong>mqseries_get()</strong>


id: mqseries_set
type: function
doc:
<comment>Description:</comment>
  MQSeries MQSET
  
  The <strong>mqseries_set()</strong> (MQSET) call is used to change the attributes of an object represented by a
  handle. The object must be a queue.

<comment>Param:</comment>
  <info>resource</info>  <strong>$hConn</strong>           Connection handle.
                             
                             This handle represents the connection to the queue manager.
  <info>resource</info>  <strong>$hObj</strong>            Object handle.
                             
                             This handle represents the object to be used.
  <info>int</info>       <strong>$selectorCount</strong>   Count of selectors.
  <info>array</info>     <strong>$selectors</strong>       Array of attribute selectors.
  <info>int</info>       <strong>$intAttrCount</strong>    Count of integer attributes.
  <info>array</info>     <strong>$intAttrs</strong>        Array of integer attributes.
  <info>int</info>       <strong>$charAttrLength</strong>  Length of character attributes buffer.
  <info>array</info>     <strong>$charAttrs</strong>       Character attributes.
  <info>resource</info>  <strong>$compCode</strong>        Completion code.
  <info>resource</info>  <strong>$reason</strong>          Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: mqseries_strerror
type: function
doc:
<comment>Description:</comment>
  Returns the error message corresponding to a result code (MQRC)
  
  <strong>mqseries_strerror()</strong> returns the message that correspond to the reason result code.

<comment>Param:</comment>
  <info>int</info>  <strong>$reason</strong>  Reason code qualifying the compCode.

<comment>Return:</comment>
  <info>string</info>  string representation of the reason code message.


id: msg_get_queue
type: function
doc:
<comment>Description:</comment>
  Create or attach to a message queue
  
  <strong>msg_get_queue()</strong> returns an id that can be used to access the System V message queue with the given
  <strong>$key</strong>. The first call creates the message queue with the optional <strong>$permissions</strong>. A second call to
  <strong>msg_get_queue()</strong> for the same <strong>$key</strong> will return a different message queue identifier, but both
  identifiers access the same underlying message queue.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>          Message queue numeric ID
  <info>int</info>  <strong>$permissions</strong>  Queue permissions. Default to 0666. If the message queue already exists, the
                     <strong>$permissions</strong> will be ignored.

<comment>Return:</comment>
  <info>SysvMessageQueue|false</info>  Returns <class>SysvMessageQueue</class> instance that can be used to access the System V
                          message queue, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_send()</strong>
   * <strong>msg_stat_queue()</strong>
   * <strong>msg_set_queue()</strong>


id: msg_queue_exists
type: function
doc:
<comment>Description:</comment>
  Check whether a message queue exists
  
  Checks whether the message queue <strong>$key</strong> exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Queue key.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_stat_queue()</strong>


id: msg_receive
type: function
doc:
<comment>Description:</comment>
  Receive a message from a message queue
  
  <strong>msg_receive()</strong> will receive the first message from the specified <strong>$queue</strong> of the type specified by
  <strong>$desired_message_type</strong>.

<comment>Param:</comment>
  <info>SysvMessageQueue</info>  <strong>$queue</strong>                  The message queue.
  <info>int</info>               <strong>$desired_message_type</strong>   If <strong>$desired_message_type</strong> is 0, the message from the
                                            front of the queue is returned. If <strong>$desired_message_type</strong>
                                            is greater than 0, then the first message of that type
                                            is returned. If <strong>$desired_message_type</strong> is less than 0,
                                            the first message on the queue with a type less than or
                                            equal to the absolute value of <strong>$desired_message_type</strong>
                                            will be read. If no messages match the criteria, your
                                            script will wait until a suitable message arrives on the
                                            queue.  You can prevent the script from blocking by
                                            specifying <info>MSG_IPC_NOWAIT</info> in the <strong>$flags</strong> parameter.
  <info>int</info>               <strong>$received_message_type</strong>  The type of the message that was received will be stored
                                            in this parameter.
  <info>int</info>               <strong>$max_message_size</strong>       The maximum size of message to be accepted is specified
                                            by the <strong>$max_message_size</strong>; if the message in the queue is
                                            larger than this size the function will fail (unless you
                                            set <strong>$flags</strong> as described below).
  <info>mixed</info>             <strong>$message</strong>                The received message will be stored in <strong>$message</strong>, unless
                                            there were errors receiving the message.
  <info>bool</info>              <strong>$unserialize</strong>            If set to <info>true</info>, the message is treated as though it was
                                            serialized using the same mechanism as the session
                                            module. The message will be unserialized and then
                                            returned to your script. This allows you to easily
                                            receive arrays or complex object structures from other
                                            PHP scripts, or if you are using the WDDX serializer,
                                            from any WDDX compatible source.
                                            
                                            If <strong>$unserialize</strong> is <info>false</info>, the message will be returned
                                            as a binary-safe string.
  <info>int</info>               <strong>$flags</strong>                  The optional <strong>$flags</strong> allows you to pass flags to the
                                            low-level msgrcv system call.  It defaults to 0, but you
                                            may specify one or more of the following values (by
                                            adding or ORing them together). Flag values for
                                            msg_receive<info>MSG_IPC_NOWAIT</info>If there are no messages of the
                                            <strong>$desired_message_type</strong>, return immediately and do not
                                            wait.  The function will fail and return an integer
                                            value corresponding to <info>MSG_ENOMSG</info>. <info>MSG_EXCEPT</info>Using this
                                            flag in combination with a <strong>$desired_message_type</strong> greater
                                            than 0 will cause the function to receive the first
                                            message that is not equal to
                                            <strong>$desired_message_type</strong>.<info>MSG_NOERROR</info> If the message is
                                            longer than <strong>$max_message_size</strong>, setting this flag will
                                            truncate the message to <strong>$max_message_size</strong> and will not
                                            signal an error.
  <info>int</info>               <strong>$error_code</strong>             If the function fails, the optional <strong>$error_code</strong> will be
                                            set to the value of the system errno variable.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Upon successful completion the message queue data structure is updated as follows: <return>msg_lrpid</return>
        is set to the process-ID of the calling process, <return>msg_qnum</return> is decremented by 1 and <return>msg_rtime</return>
        is set to the current time.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_send()</strong>
   * <strong>msg_stat_queue()</strong>
   * <strong>msg_set_queue()</strong>


id: msg_remove_queue
type: function
doc:
<comment>Description:</comment>
  Destroy a message queue
  
  <strong>msg_remove_queue()</strong> destroys the message queue specified by the <strong>$queue</strong>.  Only use this function
  when all processes have finished working with the message queue and you need to release the system
  resources held by it.

<comment>Param:</comment>
  <info>SysvMessageQueue</info>  <strong>$queue</strong>  The message queue.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>msg_get_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_stat_queue()</strong>
   * <strong>msg_set_queue()</strong>


id: msg_send
type: function
doc:
<comment>Description:</comment>
  Send a message to a message queue
  
  <strong>msg_send()</strong> sends a <strong>$message</strong> of type <strong>$message_type</strong> (which MUST be greater than 0) to the message
  queue specified by <strong>$queue</strong>.

<comment>Param:</comment>
  <info>SysvMessageQueue</info>       <strong>$queue</strong>         The message queue.
  <info>int</info>                    <strong>$message_type</strong>  The type of the message (MUST be greater than 0)
  <info>string|int|float|bool</info>  <strong>$message</strong>       The body of the message.
                                        
                                        If <strong>$serialize</strong> set to <info>false</info> is supplied, MUST be of type:
                                        <info>string</info>, <info>int</info>, <info>float</info>  or <info>bool</info>. In other case a warning will be
                                        issued.
  <info>bool</info>                   <strong>$serialize</strong>     The optional <strong>$serialize</strong> controls how the <strong>$message</strong> is sent.
                                        <strong>$serialize</strong> defaults to <info>true</info> which means that the <strong>$message</strong> is
                                        serialized using the same mechanism as the session module
                                        before being sent to the queue.  This allows complex arrays
                                        and objects to be sent to other PHP scripts, or if you are
                                        using the WDDX serializer, to any WDDX compatible client.
  <info>bool</info>                   <strong>$blocking</strong>      If the message is too large to fit in the queue, your script
                                        will wait until another process reads messages from the
                                        queue and frees enough space for your message to be sent.
                                        This is called blocking; you can prevent blocking by setting
                                        the optional <strong>$blocking</strong> parameter to <info>false</info>, in which case
                                        <strong>msg_send()</strong> will immediately return <info>false</info> if the message is
                                        too big for the queue, and set the optional <strong>$error_code</strong> to
                                        <info>MSG_EAGAIN</info>, indicating that you should try to send your
                                        message again a little later on.
  <info>int</info>                    <strong>$error_code</strong>    If the function fails, the optional errorcode will be set to
                                        the value of the system errno variable.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Upon successful completion the message queue data structure is updated as follows:
        <strong>$msg_lspid</strong> is set to the process-ID of the calling process, <strong>$msg_qnum</strong> is incremented by 1
        and <strong>$msg_stime</strong> is set to the current time.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_stat_queue()</strong>
   * <strong>msg_set_queue()</strong>


id: msg_set_queue
type: function
doc:
<comment>Description:</comment>
  Set information in the message queue data structure
  
  <strong>msg_set_queue()</strong> allows you to change the values of the msg_perm.uid, msg_perm.gid, msg_perm.mode
  and msg_qbytes fields of the underlying message queue data structure.
  
  Changing the data structure will require that PHP be running as the same user that created the
  queue, owns the queue (as determined by the existing msg_perm.xxx fields), or be running with root
  privileges. root privileges are required to raise the msg_qbytes values above the system defined
  limit.

<comment>Param:</comment>
  <info>SysvMessageQueue</info>  <strong>$queue</strong>  The message queue.
  <info>array</info>             <strong>$data</strong>   You specify the values you require by setting the value of the keys that
                            you require in the <strong>$data</strong> array.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_stat_queue()</strong>
   * <strong>msg_get_queue()</strong>


id: msg_stat_queue
type: function
doc:
<comment>Description:</comment>
  Returns information from the message queue data structure
  
  <strong>msg_stat_queue()</strong> returns the message queue meta data for the message queue specified by the
  <strong>$queue</strong>. This is useful, for example, to determine which process sent the message that was just
  received.

<comment>Param:</comment>
  <info>SysvMessageQueue</info>  <strong>$queue</strong>  The message queue.

<comment>Return:</comment>
  <info>array|false</info>  On success, the return value is an array whose keys and values have the following
               meanings: Array structure for msg_stat_queue<return>msg_perm.uid</return> The uid of the owner of the
               queue. <return>msg_perm.gid</return> The gid of the owner of the queue. <return>msg_perm.mode</return> The file access
               mode of the queue. <return>msg_stime</return> The time that the last message was sent to the queue.
               <return>msg_rtime</return> The time that the last message was received from the queue. <return>msg_ctime</return> The
               time that the queue was last changed. <return>msg_qnum</return> The number of messages waiting to be
               read from the queue. <return>msg_qbytes</return> The maximum number of bytes allowed in one message
               queue. On Linux, this value may be read and modified via /proc/sys/kernel/msgmnb.
               <return>msg_lspid</return> The pid of the process that sent the last message to the queue. <return>msg_lrpid</return>
               The pid of the process that received the last message from the queue.
               
               Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>msg_remove_queue()</strong>
   * <strong>msg_receive()</strong>
   * <strong>msg_get_queue()</strong>
   * <strong>msg_set_queue()</strong>


id: mt_getrandmax
type: function
doc:
<comment>Description:</comment>
  Show largest possible random value
  
  Returns the maximum value that can be returned by a call to <strong>mt_rand()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum random value returned by a call to <strong>mt_rand()</strong> without arguments, which is
       the maximum value that can be used for its <strong>$max</strong> parameter without the result being scaled up
       (and therefore less random).

<comment>See Also:</comment>
   * <strong>mt_rand()</strong>
   * <strong>mt_srand()</strong>
   * <strong>getrandmax()</strong>


id: mt_rand
type: function
doc:
<comment>Description:</comment>
  Generate a random value via the Mersenne Twister Random Number Generator
  
  Many random number generators of older libcs have dubious or unknown characteristics and are slow.
  The <strong>mt_rand()</strong> function is a drop-in replacement for the older <strong>rand()</strong>. It uses a random number
  generator with known characteristics using the Mersenne Twister, which will produce random numbers
  four times faster than what the average libc rand() provides.
  
  If called without the optional <strong>$min</strong>, <strong>$max</strong> arguments <strong>mt_rand()</strong> returns a pseudo-random value
  between 0 and <strong>mt_getrandmax()</strong>.  If you want a random number between 5 and 15 (inclusive), for
  example, use <return>mt_rand(5, 15)</return>.
  
  Esta função não gera valores criptograficamente seguros e não deve ser usada para propósitos
  criptográficos ou fins que exijam que os valores retornados sejam impossíveis de adivinhar.
  
  Se aleatoriedade criptograficamente segura for necessária, a classe <class>Random\Randomizer</class> pode ser
  usada com o mecanismo <class>Random\Engine\Secure</class>. Para casos de uso simples, as funções <strong>random_int()</strong> e
  <strong>random_bytes()</strong> fornecem uma API conveniente e segura que é garantida pelo CSPRNG do sistema
  operacional.

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  Optional lowest value to be returned (default: 0)
  <info>int</info>  <strong>$max</strong>  Optional highest value to be returned (default: <strong>mt_getrandmax()</strong>)

<comment>Return:</comment>
  <info>int</info>  A random integer value between <strong>$min</strong> (or 0) and <strong>$max</strong> (or <strong>mt_getrandmax()</strong>, inclusive), or <info>false</info>
       if <strong>$max</strong> is less than <strong>$min</strong>.

<comment>See Also:</comment>
   * <strong>mt_srand()</strong>
   * <strong>mt_getrandmax()</strong>
   * <strong>random_int()</strong>
   * <strong>random_bytes()</strong>


id: mt_srand
type: function
doc:
<comment>Description:</comment>
  Seeds the Mersenne Twister Random Number Generator
  
  Seeds the random number generator with <strong>$seed</strong> or with a random value if no <strong>$seed</strong> is given.
  
  Não é necessário
  inicializar o gerador de números aleatórios com <strong>srand()</strong> ou
  <strong>mt_srand()</strong>, pois isso é feito automaticamente.
  
  Como o mecanismo Mt19937 (“Mersenne Twister”) aceita apenas um único inteiro de 32 bits como
  semente, o número de sequências aleatórias possíveis é limitado a apenas 232 (ou seja,
  4.294.967.296), embora o Mt19937 possua um gigantesco período de 219937-1.
  
  Ao depender da geração aleatória implícita ou explícita de sementes, as duplicações aparecerão
  muito mais cedo. Sementes duplicadas são esperadas com probabilidade de 50% depois de menos de
  80.000 sementes geradas aleatoriamente de acordo com o problema do aniversário. Uma probabilidade
  de 10% de uma semente duplicada acontece depois de gerar aleatoriamente cerca de 30.000 sementes.
  
  Isso torna o Mt19937 inadequado para aplicações em que sequências duplicadas não devem ocorrer com
  mais do que uma probabilidade desprezível. Se a geração reproduzível de sementes for necessária,
  ambos os mecanismos <class>Random\Engine\Xoshiro256StarStar</class> e <class>Random\Engine\PcgOneseq128XslRr64</class> suportam
  sementes muito maiores que são improváveis de colidir aleatoriamente. Se a reprodutibilidade não
  for necessária, o mecanismo <class>Random\Engine\Secure</class> fornece aleatoriedade criptograficamente segura.

<comment>Param:</comment>
  <info>int</info>  <strong>$seed</strong>  An arbitrary <info>int</info> seed value.
  <info>int</info>  <strong>$mode</strong>  Use one of the following constants to specify the implementation of the algorithm to
              use. <info>MT_RAND_MT19937</info>: The correct Mt19937 implementation, available as of PHP 7.1.0.
              <info>MT_RAND_PHP</info> Uses an incorrect Mersenne Twister implementation which was used as the
              default up till PHP 7.1.0. This mode is available for backward compatibility.
              
              Este recurso tornou-se
              OBSOLETO a partir do PHP 8.3.0. O uso deste recurso
              é fortemente desencorajado.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mt_rand()</strong>
   * <strong>mt_getrandmax()</strong>
   * <strong>srand()</strong>


id: mysql_affected_rows
type: function
doc:
<comment>Description:</comment>
  Obtém o número de linhas afetadas na operação anterior do MySQL
  
  Obtém o número de linhas afetadas pelo último INSERT, UPDATE, REPLACE ou DELETE associado ao
  <strong>$link_identifier</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>int</info>  Retona o número de linas afetadas em caso de sucesso, e -1 se a última consulta falhou.
       
       Se a última consulta foi um DELETE sem a claúsula WHERE, todos os registros terão sido
       excluídos da tabela mas esta função irá retornar zero em versões do MySQL anteriores a 4.1.2.
       
       Ao usar UPDATE, o MySQL não irá atualizar colunas aonde o novo valor é o mesmo que o valor
       anterior. Isto cria a possibilidade de que <strong>mysql_affected_rows()</strong> possa não ser igual ao
       número de linhas encontradas, apenas o número de linhas que literalmente foram afetadas pela
       consulta.
       
       O comando REPLACE primeiro exclui o registro com a mesma chave primária e então insere o novo
       registro. Esta função retorna o número de registros excluídos mais o número de registros
       inseridos.
       
       No caso de consultas "INSERT ... ON DUPLICATE KEY UPDATE", o valor retornado será <return>1</return> se um
       insert foi executado, ou <return>2</return> para um update de uma linha existente.

<comment>See Also:</comment>
   * <strong>mysql_num_rows()</strong>
   * <strong>mysql_info()</strong>


id: mysql_client_encoding
type: function
doc:
<comment>Description:</comment>
  Returns the name of the character set
  
  Retrieves the <return>character_set</return> variable from MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string</info>  Returns the default character set name for the current connection.

<comment>See Also:</comment>
   * <strong>mysql_set_charset()</strong>
   * <strong>mysql_real_escape_string()</strong>


id: mysql_close
type: function
doc:
<comment>Description:</comment>
  Fecha a conexão MySQL
  
  <strong>mysql_close()</strong> fecha a conexão não persistente ao servidor MySQL que está associado ao
  identificador de conexão especificado. Se <strong>$link_identifier</strong> não for especificado, a última conexão
  aberta é usada.
  
  Conexões MySQL não persistentes abertas e conjuntos de resultados são automaticamente destruídos
  quando um
  script PHP termina sua execução. Portanto, embora seja opcional fechar conexões
  abertas e liberar conjuntos de resultados, isso é recomendado.
  Isso retornará imediatamente os recursos usados ao PHP e MySQL, o que pode
  melhorar o desempenho. Para obter informações relacionadas, consulte a página
  liberando recursos.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se nenhuma conexão for encontrada ou
                              estabelecida, um erro de nível <info>E_WARNING</info> será
                              gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_connect()</strong>
   * <strong>mysql_free_result()</strong>


id: mysql_connect
type: function
doc:
<comment>Description:</comment>
  Open a connection to a MySQL Server
  
  Opens or reuses a connection to a MySQL server.

<comment>Param:</comment>
  <info>string</info>  <strong>$server</strong>        The MySQL server. It can also include a port number. e.g.  "hostname:port"
                         or a path to a local socket e.g. ":/path/to/socket" for  the localhost.
                         
                         If the PHP directive  mysql.default_host is undefined (default), then the
                         default  value is 'localhost:3306'. In modo seguro do SQL, this parameter
                         is ignored and value 'localhost:3306' is always used.
  <info>string</info>  <strong>$username</strong>      The username. Default value is defined by mysql.default_user. In modo
                         seguro do SQL, this parameter is ignored and the name of the user that owns
                         the server process is used.
  <info>string</info>  <strong>$password</strong>      The password. Default value is defined by mysql.default_password. In modo
                         seguro do SQL, this parameter is ignored and empty password is used.
  <info>bool</info>    <strong>$new_link</strong>      If a second call is made to <strong>mysql_connect()</strong> with the same arguments, no new
                         link will be established, but instead, the link identifier of the already
                         opened link will be returned. The <strong>$new_link</strong> parameter modifies this
                         behavior and makes <strong>mysql_connect()</strong> always open  a new link, even if
                         <strong>mysql_connect()</strong> was called  before with the same parameters. In modo seguro
                         do SQL, this parameter is ignored.
  <info>int</info>     <strong>$client_flags</strong>  The <strong>$client_flags</strong> parameter can be a combination  of the following
                         constants: 128 (enable <return>LOAD DATA LOCAL</return> handling), <info>MYSQL_CLIENT_SSL</info>,
                         <info>MYSQL_CLIENT_COMPRESS</info>,  <info>MYSQL_CLIENT_IGNORE_SPACE</info> or
                         <info>MYSQL_CLIENT_INTERACTIVE</info>. Read the section about  for further information.
                         In modo seguro do SQL, this parameter is ignored.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a MySQL link identifier on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_pconnect()</strong>
   * <strong>mysql_close()</strong>


id: mysql_create_db
type: function
doc:
<comment>Description:</comment>
  Cria um banco de dados MySQL
  
  <strong>mysql_create_db()</strong> tenta criar um novo banco de dados no servidor associado com o identificador de
  conexão especificado.

<comment>Param:</comment>
  <info>string</info>    <strong>$database_name</strong>    O nome do banco de dados a ser criado.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_query()</strong>
   * <strong>mysql_select_db()</strong>


id: mysql_data_seek
type: function
doc:
<comment>Description:</comment>
  Move o ponteiro interno do resultado
  
  <strong>mysql_data_seek()</strong> move o ponteiro interno da linha de um resultado MySQL associado ao
  identificador de resultado informado para o número da linha especificada. A próxima chamada a uma
  função MySQL que retorna resultado, como <strong>mysql_fetch_assoc()</strong>, irá retornar esta linha.
  
  <strong>$row_number</strong> começa em 0. O <strong>$row_number</strong> deve ser um valor no intervalo de 0 a <strong>mysql_num_rows()</strong> - 1.
  Entretanto, se o conjunto de reseultados for vazio (<strong>mysql_num_rows()</strong> == 0), uma busca para 0 irá
  falhar com um <info>E_WARNING</info> e <strong>mysql_data_seek()</strong> iá retornar <info>false</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>      O <info>resource</info> do resultado que
                         está sendo avaliado. Este resultado vem de uma chamada a
                         <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$row_number</strong>  O número de linha desejado para o ponteiro de resultado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_query()</strong>
   * <strong>mysql_num_rows()</strong>
   * <strong>mysql_fetch_row()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_fetch_array()</strong>
   * <strong>mysql_fetch_object()</strong>


id: mysql_db_name
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do banco de dados a partir da chamada à mysql_list_dbs
  
  Obtém o nome do banco de dados a partir de uma chamada à <strong>mysql_list_dbs()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O ponteiro de resultado de uma chamada à <strong>mysql_list_dbs()</strong>.
  <info>int</info>       <strong>$row</strong>     O índice dentro do conjunto de resultados.
  <info>mixed</info>     <strong>$field</strong>   O nome do campo.

<comment>Return:</comment>
  <info>string</info>  Retorna o nome do banco de dados em caso de sucesso, e <info>false</info> em caso de falha. Se for
          retornado <info>false</info>, utilize <strong>mysql_error()</strong> para determinar a natureza do erro.

<comment>See Also:</comment>
   * <strong>mysql_list_dbs()</strong>
   * <strong>mysql_tablename()</strong>


id: mysql_db_query
type: function
doc:
<comment>Description:</comment>
  Selects a database and executes a query on it
  
  <strong>mysql_db_query()</strong> selects a database, and executes a  query on it.

<comment>Param:</comment>
  <info>string</info>    <strong>$database</strong>         The name of the database that will be selected.
  <info>string</info>    <strong>$query</strong>            The MySQL query.
                              
                              Data inside the query should be properly escaped.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource|bool</info>  Returns a positive MySQL result resource to the query result, or <info>false</info> on error.
                 The function also returns <info>true</info>/<info>false</info> for <return>INSERT</return>/<return>UPDATE</return>/<return>DELETE</return> queries to indicate
                 success/failure.

<comment>See Also:</comment>
   * <strong>mysql_query()</strong>
   * <strong>mysql_select_db()</strong>


id: mysql_drop_db
type: function
doc:
<comment>Description:</comment>
  Drop (exclui) um banco de dados MySQL
  
  <strong>mysql_drop_db()</strong> tenta executar um drop (remover) todo um banco de dados do servidor associado ao
  identificador de conexão especificado. Esta função está obsoleta, é preferível usar <strong>mysql_query()</strong>
  para realilar um comando <return>DROP DATABASE</return>.

<comment>Param:</comment>
  <info>string</info>    <strong>$database_name</strong>    O nome do banco de dados que será excluído.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysql_errno
type: function
doc:
<comment>Description:</comment>
  Retorna o valor numérico da mensagem de erro da operação MySQL anterior
  
  Retorna o número do erro da última função MySQL.
  
  Erros vindos do banco de dados MySQL não geram mais avisos. Ao invés disso, use <strong>mysql_errno()</strong> para
  obter o código do erro. Note que esta função retorna o código apenas da função MySQL mais
  recentemente usada (não incluindo <strong>mysql_error()</strong> e <strong>mysql_errno()</strong>), assim se você quiser usá-la,
  tenha certeza de verificar o valor antes de executar outra função MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de erro da última função MySQL, ou <return>0</return> (zero) se não houve erro.

<comment>See Also:</comment>
   * <strong>mysql_error()</strong>
   * códigos de erro MySQL


id: mysql_error
type: function
doc:
<comment>Description:</comment>
  Retorna o texto da mensagem de erro da operação MySQL anterior
  
  Retorna o texto do último erro de funções MySQL. Erros vindos do banco de dados MySQL não geram
  mais avisos. Ao invés, use <strong>mysql_error()</strong> para obter o texto do erro. Note que esta função apenas
  retorna o texto do erro da função MySQL mais recentemente executada (não incluindo <strong>mysql_error()</strong> e
  <strong>mysql_errno()</strong>), assim se você quiser usa-la, tenha certeza de obter o valor antes de utilizar
  outra função MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string</info>  Retorna o texto do erro da ultima função MySQL, ou <return>''</return> (uma string vazia) se não houve
          erro.

<comment>See Also:</comment>
   * <strong>mysql_errno()</strong>
   * códigos de erro MySQL


id: mysql_escape_string
type: function
doc:
<comment>Description:</comment>
  Escapa uma string para usá-la em uma função mysql_query
  
  Esta função escapará a string <strong>$unescaped_string</strong>, de modo que seja seguro usá-la em uma função
  <strong>mysql_query()</strong>. Esta função está obsoleta.
  
  Esta função é idêntica a <strong>mysql_real_escape_string()</strong> exceto que <strong>mysql_real_escape_string()</strong> recebe
  um manipulador de conexão e escapa a string de acordo com o conjunto de caracteres atual.
  <strong>mysql_escape_string()</strong> não recebe um manipulador de conexão e não respeita a configuração atual do
  conjunto de caracteres.

<comment>Param:</comment>
  <info>string</info>  <strong>$unescaped_string</strong>  A string que deve ser escapada.

<comment>Return:</comment>
  <info>string</info>  Retorna a string escapada.

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


id: mysql_fetch_array
type: function
doc:
<comment>Description:</comment>
  Fetch a result row as an associative array, a numeric array, or both
  
  Returns an array that corresponds to the fetched row and moves the internal data pointer ahead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>       O <info>resource</info> do resultado que
                          está sendo avaliado. Este resultado vem de uma chamada a
                          <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$result_type</strong>  The type of array that is to be fetched. It's a constant and can take the
                          following values: <info>MYSQL_ASSOC</info>,  <info>MYSQL_NUM</info>, and <info>MYSQL_BOTH</info>.

<comment>Return:</comment>
  <info>array</info>  Returns an array of strings that corresponds to the fetched row, or <info>false</info> if there are no
         more rows. The type of returned array depends on how <strong>$result_type</strong> is defined. By using
         <info>MYSQL_BOTH</info> (default), you'll get an array with both  associative and number indices. Using
         <info>MYSQL_ASSOC</info>, you  only get associative indices (as <strong>mysql_fetch_assoc()</strong>  works), using
         <info>MYSQL_NUM</info>, you only get number indices  (as <strong>mysql_fetch_row()</strong> works).
         
         If two or more columns of the result have the same field names, the last column will take
         precedence. To access the other column(s) of the same name, you must use the numeric index
         of the column or make an alias for the column. For aliased columns, you cannot access the
         contents with the original column name.

<comment>See Also:</comment>
   * <strong>mysql_fetch_row()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_data_seek()</strong>
   * <strong>mysql_query()</strong>


id: mysql_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha do resultado como um array associativo
  
  Retorna uma matriz associativa que corresponde a linha obtida e move o ponteiro interno dos dados
  adiante. <strong>mysql_fetch_assoc()</strong> é equivalente a utilizar <strong>mysql_fetch_array()</strong> com MYSQL_ASSOC para o
  segunto parâmetro, que é opcional. Ela apenas retorna um array associativo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna uma matriz associativa de strings que corresponde a linha obtida, ou <info>false</info> se não
         houverem mais linhas.
         
         Se duas ou mais colunas do resultado tiverem o mesmo nome de campo, a ultima coluna terá
         precedencia. Para acessar as outras coluna(s) com o mesmo nome, você precisa acessar os
         outros resultados usando índices numéricos com <strong>mysql_fetch_row()</strong> ou adicionar alias
         (apelidos). Veja o exemplo em <strong>mysql_fetch_array()</strong> para uma descrição sobre alias.

<comment>See Also:</comment>
   * <strong>mysql_fetch_row()</strong>
   * <strong>mysql_fetch_array()</strong>
   * <strong>mysql_data_seek()</strong>
   * <strong>mysql_query()</strong>
   * <strong>mysql_error()</strong>


id: mysql_fetch_field
type: function
doc:
<comment>Description:</comment>
  Get column information from a result and return as an object
  
  Returns an object containing field information. This function can be used  to obtain information
  about fields in the provided query result.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  The numerical field offset. If the field offset is not specified, the
                           next field that was not yet retrieved by this function is retrieved.  The
                           <strong>$field_offset</strong> starts at <return>0</return>.

<comment>Return:</comment>
  <info>object</info>  Returns an <info>object</info> containing field information. The properties  of the object are:
          
           name - column name  table - name of the table the column belongs to, which is the alias
          name if one is defined  max_length - maximum length of the column  not_null - 1 if the
          column cannot be <info>null</info>  primary_key - 1 if the column is a primary key  unique_key - 1 if
          the column is a unique key  multiple_key - 1 if the column is a non-unique key  numeric -
          1 if the column is numeric  blob - 1 if the column is a BLOB  type - the type of the
          column  unsigned - 1 if the column is unsigned  zerofill - 1 if the column is zero-filled
          
          name - column name
          
          table - name of the table the column belongs to, which is the alias name if one is defined
          
          max_length - maximum length of the column
          
          not_null - 1 if the column cannot be <info>null</info>
          
          primary_key - 1 if the column is a primary key
          
          unique_key - 1 if the column is a unique key
          
          multiple_key - 1 if the column is a non-unique key
          
          numeric - 1 if the column is numeric
          
          blob - 1 if the column is a BLOB
          
          type - the type of the column
          
          unsigned - 1 if the column is unsigned
          
          zerofill - 1 if the column is zero-filled

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


id: mysql_fetch_lengths
type: function
doc:
<comment>Description:</comment>
  Obtém o tamanho de cada saída de um resultado
  
  Retorna um array que corresponde aos tamanhos de cada campo na ultima linha obtida pelo MySQL.
  
  <strong>mysql_fetch_lengths()</strong> guarda o tamanho de cada coluna do resultado na última linha retornada por
  <strong>mysql_fetch_row()</strong>, <strong>mysql_fetch_assoc()</strong>, <strong>mysql_fetch_array()</strong>, e <strong>mysql_fetch_object()</strong> em um array,
  começando no índice 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Um <info>array</info> de tamanhos em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_field_len()</strong>
   * <strong>mysql_fetch_row()</strong>
   * <strong>strlen()</strong>


id: mysql_fetch_object
type: function
doc:
<comment>Description:</comment>
  Obtém o resultado de uma linha como um objeto
  
  Retorna um objeto com propriedades que correspondem a linha obtida e move o ponteiro interno dos
  dados adiante.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>      O <info>resource</info> do resultado que
                         está sendo avaliado. Este resultado vem de uma chamada a
                         <strong>mysql_query()</strong>.
  <info>string</info>    <strong>$class_name</strong>  O nome de classe para instanciar, definir as propriedades e retornar. Se
                         não for especificado, um objeto <class>stdClass</class> é retornado.
  <info>array</info>     <strong>$params</strong>      Um <info>array</info> opcional de parâmetros para passar para o construtor do objeto
                         <strong>$class_name</strong>.

<comment>Return:</comment>
  <info>object</info>  Retorna um <info>object</info> com propriedades strings que correspondem a linha obtida, ou <info>false</info> se
          não houverem mais linhas.

<comment>See Also:</comment>
   * <strong>mysql_fetch_array()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_fetch_row()</strong>
   * <strong>mysql_data_seek()</strong>
   * <strong>mysql_query()</strong>


id: mysql_fetch_row
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha como um array numérico
  
  Retorna um array numérico que corresponde a linha obtida e move o ponteiro interno dos dados
  adiante.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna um array numérico de strings que corresponde linha obtida, ou <info>false</info> se não houverem
         mais linhas.
         
         <strong>mysql_fetch_row()</strong> obtém uma linha de dados do resultado associado ao identificador do
         resultado especificado. A linha é retornada como um array. Cada coluna do resultado é
         armazenado em um índice do array, começando no índice 0.

<comment>See Also:</comment>
   * <strong>mysql_fetch_array()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_fetch_object()</strong>
   * <strong>mysql_data_seek()</strong>
   * <strong>mysql_fetch_lengths()</strong>
   * <strong>mysql_result()</strong>


id: mysql_field_flags
type: function
doc:
<comment>Description:</comment>
  Get the flags associated with the specified field in a result
  
  <strong>mysql_field_flags()</strong> returns the field flags of the specified field. The flags are reported as a
  single word per flag separated by a single space, so that you can split the returned value using
  <strong>explode()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string of flags associated with the result ou <info>false</info> em caso de falha.
                
                The following flags are reported, if your version of MySQL is current enough to
                support them: <return>"not_null"</return>,  <return>"primary_key"</return>, <return>"unique_key"</return>,  <return>"multiple_key"</return>, <return>"blob"</return>,
                <return>"unsigned"</return>, <return>"zerofill"</return>, <return>"binary"</return>, <return>"enum"</return>,  <return>"auto_increment"</return> and <return>"timestamp"</return>.

<comment>See Also:</comment>
   * <strong>mysql_field_type()</strong>
   * <strong>mysql_field_len()</strong>


id: mysql_field_len
type: function
doc:
<comment>Description:</comment>
  Retorna o tamanho do campo especificado
  
  <strong>mysql_field_len()</strong> retorna o tamanho do campo especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>int|false</info>  O tamanho do campo especificado em sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_fetch_lengths()</strong>
   * <strong>strlen()</strong>


id: mysql_field_name
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do campo especificado em um resultado
  
  <strong>mysql_field_name()</strong> retorna o nome do campo do índice especificado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>string|false</info>  O nome do campo do índice especificado emj caso de sucesso ou <info>false</info> em caso de
                falha.

<comment>See Also:</comment>
   * <strong>mysql_field_type()</strong>
   * <strong>mysql_field_len()</strong>


id: mysql_field_seek
type: function
doc:
<comment>Description:</comment>
  Define o ponteiro do resultado para o índice de campo especificado
  
  Move para o índice do campo especificado. Se a próxima chamada a <strong>mysql_fetch_field()</strong> não incluir
  um índice, o índice de campo especificado em <strong>mysql_field_seek()</strong> será retornado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysql_field_table
type: function
doc:
<comment>Description:</comment>
  Obtém o nome da tabela na qual o campo especificado esta
  
  Retorna o nome da tabela na qual o campo especificado está.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>string</info>  O nome da tabela em caso de sucesso.

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


id: mysql_field_type
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo do campo especificado em um resultado
  
  <strong>mysql_field_type()</strong> é similar a função <strong>mysql_field_name()</strong>. Os argumentos são idênticos, mas é o
  tipo do campo que é retornado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        O <info>resource</info> do resultado que
                           está sendo avaliado. Este resultado vem de uma chamada a
                           <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$field_offset</strong>  O deslocamento numérico do campo.
                           <strong>$field_offset</strong> começa em <return>0</return>. Se
                           <strong>$field_offset</strong> não existir, um erro de nível
                           <info>E_WARNING</info> também será emitido.

<comment>Return:</comment>
  <info>string</info>  O tipo de campo retornado será um de <return>"int"</return>, <return>"real"</return>, <return>"string"</return>, <return>"blob"</return> e outros como
          detalhado na  documentação do MySQL.

<comment>See Also:</comment>
   * <strong>mysql_field_name()</strong>
   * <strong>mysql_field_len()</strong>


id: mysql_free_result
type: function
doc:
<comment>Description:</comment>
  Free result memory
  
  <strong>mysql_free_result()</strong> will free all memory associated with the result identifier <strong>$result</strong>.
  
  <strong>mysql_free_result()</strong> only needs to be called if you are concerned about how much memory is being
  used for queries that return large result sets.  All associated result memory is automatically
  freed at the end of the script's execution.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        If a non-resource is used for the <strong>$result</strong>, an error of level E_WARNING will be emitted.
        It's worth noting that <strong>mysql_query()</strong> only returns a <info>resource</info> for SELECT, SHOW, EXPLAIN, and
        DESCRIBE queries.

<comment>See Also:</comment>
   * <strong>mysql_query()</strong>
   * <strong>is_resource()</strong>


id: mysql_get_client_info
type: function
doc:
<comment>Description:</comment>
  Obtém informações do cliente MySQL
  
  <strong>mysql_get_client_info()</strong> retorna uma string que representa a versão da biblioteca do cliente.

<comment>Return:</comment>
  <info>string</info>  A versão do cliente MySQL.

<comment>See Also:</comment>
   * <strong>mysql_get_host_info()</strong>
   * <strong>mysql_get_proto_info()</strong>
   * <strong>mysql_get_server_info()</strong>


id: mysql_get_host_info
type: function
doc:
<comment>Description:</comment>
  Obtém informações do servidor MySQL
  
  Descreve o tipo de conexão em uso para a conexão, incluindo o nome do servidor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string descrevendo o tipo da conexão MySQL em uso para a conexão ou
                <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_get_client_info()</strong>
   * <strong>mysql_get_proto_info()</strong>
   * <strong>mysql_get_server_info()</strong>


id: mysql_get_proto_info
type: function
doc:
<comment>Description:</comment>
  Obtém informações do protocolo MySQL
  
  Obtém o protocolo MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o protocolo MySQL em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_get_client_info()</strong>
   * <strong>mysql_get_host_info()</strong>
   * <strong>mysql_get_server_info()</strong>


id: mysql_get_server_info
type: function
doc:
<comment>Description:</comment>
  Obtém informações do servidor MySQL
  
  Obtém a versão do servidor MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a versão do servidor MySQL em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_get_client_info()</strong>
   * <strong>mysql_get_host_info()</strong>
   * <strong>mysql_get_proto_info()</strong>
   * <strong>phpversion()</strong>


id: mysql_info
type: function
doc:
<comment>Description:</comment>
  Obtém informação sobre a consulta mais recente
  
  Retorna informação detalhada sobre a última consulta.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string</info>  Retorna informação sobre o comando em caso de sucesso, ou <info>false</info> em caso de falha. Confira
          o exemplo abaixo para ver quais comandos disponibilizam a informação e qual pode ser o
          valor retornado. Comandos que não estão listados irão retornar <info>false</info>.

<comment>See Also:</comment>
   * <strong>mysql_affected_rows()</strong>
   * <strong>mysql_insert_id()</strong>
   * <strong>mysql_stat()</strong>


id: mysql_insert_id
type: function
doc:
<comment>Description:</comment>
  Obtém o ID gerado pela operação INSERT anterior
  
  Obtém o ID gerado para uma coluna AUTO_INCREMENT pela consulta anterior (normalmente INSERT).

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>int</info>  O ID gerado para uma coluna AUTO_INCREMENT pela consulta anterior em caso de sucesso, <return>0</return> se a
       consulta anterior não gerou um valor AUTO_INCREMENT, ou <info>false</info> se não foi estabelecido conexão
       com o MySQL.

<comment>See Also:</comment>
   * <strong>mysql_query()</strong>
   * <strong>mysql_info()</strong>


id: mysql_list_dbs
type: function
doc:
<comment>Description:</comment>
  Lista os bancos de dados disponíveis em um servidor MySQL
  
  Retorna um ponteiro de resultado contendo os bancos de dados disponíveis atualmente no servidor
  MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource</info>  Retorna um ponteiro de resultado <info>resource</info> em caso de sucesso, ou <info>false</info> em caso de falha.
            Use a função <strong>mysql_tablename()</strong> para lidar com este ponteiro de resultado, ou qualquer
            função para tabelas com resultados, como <strong>mysql_fetch_array()</strong>.

<comment>See Also:</comment>
   * <strong>mysql_db_name()</strong>
   * <strong>mysql_select_db()</strong>


id: mysql_list_fields
type: function
doc:
<comment>Description:</comment>
  Lista os campos de uma tabela MySQL
  
  Obtém informações sobre a tabela informada.
  
  Esta função está obsoleta. É preferrível usar <strong>mysql_query()</strong> para realizar uma consulta SQL <return>SHOW
  COLUMNS FROM table [LIKE 'name']</return>.

<comment>Param:</comment>
  <info>string</info>    <strong>$database_name</strong>    O nome do banco de dados que está sendo consultado.
  <info>string</info>    <strong>$table_name</strong>       O nome da tabela que esta sendo consultada.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource</info>  Um ponteiro de recurso <info>resource</info> em caso de sucesso, ou <info>false</info> em caso de falha.
            
            O ponteiro de resultado pode ser usado com <strong>mysql_field_flags()</strong>, <strong>mysql_field_len()</strong>,
            <strong>mysql_field_name()</strong> e <strong>mysql_field_type()</strong>.

<comment>See Also:</comment>
   * <strong>mysql_field_flags()</strong>
   * <strong>mysql_info()</strong>


id: mysql_list_processes
type: function
doc:
<comment>Description:</comment>
  Lista os processos MySQL
  
  Obtém as threads atuais do servidor MySQL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource|false</info>  Um ponteiro de resultado <info>resource</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_thread_id()</strong>
   * <strong>mysql_stat()</strong>


id: mysql_list_tables
type: function
doc:
<comment>Description:</comment>
  List tables in a MySQL database
  
  Retrieves a list of table names from a MySQL database.
  
  This function is deprecated. It is preferable to use  <strong>mysql_query()</strong> to issue an SQL <return>SHOW TABLES
  [FROM db_name] [LIKE 'pattern']</return> statement instead.

<comment>Param:</comment>
  <info>string</info>    <strong>$database</strong>         The name of the database
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource|false</info>  A result pointer <info>resource</info> on success ou <info>false</info> em caso de falha.
                  
                  Use the <strong>mysql_tablename()</strong> function to traverse this result pointer, or any
                  function for result tables, such as <strong>mysql_fetch_array()</strong>.

<comment>See Also:</comment>
   * <strong>mysql_list_dbs()</strong>
   * <strong>mysql_tablename()</strong>


id: mysql_num_fields
type: function
doc:
<comment>Description:</comment>
  Obtém o numero de campos em um resultado
  
  Obtém o numero de campos de uma consulta.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o numero de capos em um conjunto de resultados <info>resource</info> em caso de sucesso ou
             <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_select_db()</strong>
   * <strong>mysql_query()</strong>
   * <strong>mysql_fetch_field()</strong>
   * <strong>mysql_num_rows()</strong>


id: mysql_num_rows
type: function
doc:
<comment>Description:</comment>
  Obtém o número de linhas em um resultado
  
  Obtém o numero de linhas de um conjunto de resultados. Este comando é valido apenas para comandos
  como SELECT ou SHOW que realmente retornam um conjunto de resultados. Para obter o numero de
  linhas afetadas por uma consulta INSERT, UPDATE, REPLACE ou DELETE, use <strong>mysql_affected_rows()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  O numero de linhas em um conjunto de resultados em caso de sucesso ou <info>false</info> em caso de
             falha.

<comment>See Also:</comment>
   * <strong>mysql_affected_rows()</strong>
   * <strong>mysql_connect()</strong>
   * <strong>mysql_data_seek()</strong>
   * <strong>mysql_select_db()</strong>
   * <strong>mysql_query()</strong>


id: mysql_pconnect
type: function
doc:
<comment>Description:</comment>
  Open a persistent connection to a MySQL server
  
  Establishes a persistent connection to a MySQL server.
  
  <strong>mysql_pconnect()</strong> acts very much like <strong>mysql_connect()</strong> with two major differences.
  
  First, when connecting, the function would first try to find a (persistent) link that's already
  open with the same host, username and password.  If one is found, an identifier for it will be
  returned instead of opening a new connection.
  
  Second, the connection to the SQL server will not be closed when the execution of the script ends.
  Instead, the link will remain open for future use (<strong>mysql_close()</strong> will not close links established
  by <strong>mysql_pconnect()</strong>).
  
  This type of link is therefore called 'persistent'.

<comment>Param:</comment>
  <info>string</info>  <strong>$server</strong>        The MySQL server. It can also include a port number. e.g.  "hostname:port"
                         or a path to a local socket e.g. ":/path/to/socket" for  the localhost.
                         
                         If the PHP directive  mysql.default_host is undefined (default), then the
                         default  value is 'localhost:3306'
  <info>string</info>  <strong>$username</strong>      The username. Default value is the name of the user that owns the server
                         process.
  <info>string</info>  <strong>$password</strong>      The password. Default value is an empty password.
  <info>int</info>     <strong>$client_flags</strong>  The <strong>$client_flags</strong> parameter can be a combination  of the following
                         constants: 128 (enable <return>LOAD DATA LOCAL</return> handling), <info>MYSQL_CLIENT_SSL</info>,
                         <info>MYSQL_CLIENT_COMPRESS</info>,  <info>MYSQL_CLIENT_IGNORE_SPACE</info> or
                         <info>MYSQL_CLIENT_INTERACTIVE</info>.

<comment>Return:</comment>
  <info>resource</info>  Returns a MySQL persistent link identifier on success, or <info>false</info> on  failure.

<comment>See Also:</comment>
   * <strong>mysql_connect()</strong>
   * Persistent
    Database Connections


id: mysql_ping
type: function
doc:
<comment>Description:</comment>
  Pinga uma conexão com o servidor ou reconecta se não houver conexão
  
  Confere se a conexão com o servidor está funcionando ou não. Se ela tiver caído, tenta realizar
  uma conexão automática. Esta função pode ser usada em scripts que permanecem inativos por um longo
  tempo, para verificar se o servidor fechou ou não a conexão e reconectar se necessário.
  
  A reconexão automática está desabilitada por padrão em versões do Mysql  &gt;= 5.0.3.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se a conexão com o servidor MySQL está funcionando, se não retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>mysql_thread_id()</strong>
   * <strong>mysql_list_processes()</strong>


id: mysql_query
type: function
doc:
<comment>Description:</comment>
  Send a MySQL query
  
  <strong>mysql_query()</strong> sends a unique query (multiple queries are not supported) to the currently active
  database on the server that's associated with the specified <strong>$link_identifier</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>            An SQL query
                              
                              The query string should not end with a semicolon. Data inside the
                              query should be properly escaped.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>mixed</info>  For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset, <strong>mysql_query()</strong>
         returns a <info>resource</info> on success, or <info>false</info> on error.
         
         For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, <strong>mysql_query()</strong> returns
         <info>true</info> on success or <info>false</info> on error.
         
         The returned result resource should be passed to <strong>mysql_fetch_array()</strong>, and other functions
         for dealing with result tables, to access the returned data.
         
         Use <strong>mysql_num_rows()</strong> to find out how many rows were returned for a SELECT statement or
         <strong>mysql_affected_rows()</strong> to find out how many rows were affected by a DELETE, INSERT, REPLACE,
         or UPDATE statement.
         
         <strong>mysql_query()</strong> will also fail and return <info>false</info> if the user does not have permission to
         access the table(s) referenced by the query.

<comment>See Also:</comment>
   * <strong>mysql_connect()</strong>
   * <strong>mysql_error()</strong>
   * <strong>mysql_real_escape_string()</strong>
   * <strong>mysql_result()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_unbuffered_query()</strong>


id: mysql_real_escape_string
type: function
doc:
<comment>Description:</comment>
  Escapes special characters in a string for use in an SQL statement
  
  Escapes special characters in the <strong>$unescaped_string</strong>,  taking into account the current character
  set of the connection so that it  is safe to place it in a <strong>mysql_query()</strong>. If binary data  is to be
  inserted, this function must be used.
  
  <strong>mysql_real_escape_string()</strong> calls MySQL's library function mysql_real_escape_string, which prepends
  backslashes to the following characters: <return>\x00</return>, <return>\n</return>, <return>\r</return>, <return>\</return>, <return>'</return>, <return>"</return> and <return>\x1a</return>.
  
  This function must always (with few exceptions) be used to make data safe before sending a query
  to MySQL.
  
  The character set must be set either at the server level, or with the API function
  <strong>mysql_set_charset()</strong> for it to affect <strong>mysql_real_escape_string()</strong>. See the concepts section on
  character sets for more information.

<comment>Param:</comment>
  <info>string</info>    <strong>$unescaped_string</strong>  The string that is to be escaped.
  <info>resource</info>  <strong>$link_identifier</strong>   A conexão MySQL. Se o
                               identificador da conexão não for especificado, a última conexão
                               aberta por
                               <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                               haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse
                               sido chamada
                               sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                               erro de nível
                               <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string</info>  Returns the escaped string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>mysql_set_charset()</strong>
   * <strong>mysql_client_encoding()</strong>


id: mysql_result
type: function
doc:
<comment>Description:</comment>
  Get result data
  
  Retrieves the contents of one cell from a MySQL result set.
  
  When working on large result sets, you should consider using one of the functions that fetch an
  entire row (specified below).  As these functions return the contents of multiple cells in one
  function call, they're MUCH quicker than <strong>mysql_result()</strong>.  Also, note that specifying a numeric
  offset for the field argument is much quicker than specifying a fieldname or tablename.fieldname
  argument.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  O <info>resource</info> do resultado que
                     está sendo avaliado. Este resultado vem de uma chamada a
                     <strong>mysql_query()</strong>.
  <info>int</info>       <strong>$row</strong>     The row number from the result that's being retrieved. Row numbers  start at <return>0</return>.
  <info>mixed</info>     <strong>$field</strong>   The name or offset of the field being retrieved.
                     
                     It can be the field's offset, the field's name, or the field's table  dot field
                     name (tablename.fieldname). If the column name has been aliased ('select foo as
                     bar from...'), use the alias instead of the  column name. If undefined, the
                     first field is retrieved.

<comment>Return:</comment>
  <info>string</info>  The contents of one cell from a MySQL result set on success, or  <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>mysql_fetch_row()</strong>
   * <strong>mysql_fetch_array()</strong>
   * <strong>mysql_fetch_assoc()</strong>
   * <strong>mysql_fetch_object()</strong>


id: mysql_select_db
type: function
doc:
<comment>Description:</comment>
  Select a MySQL database
  
  Sets the current active database on the server that's associated with the  specified link
  identifier. Every subsequent call to  <strong>mysql_query()</strong> will be made on the active database.

<comment>Param:</comment>
  <info>string</info>    <strong>$database_name</strong>    The name of the database that is to be selected.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_connect()</strong>
   * <strong>mysql_pconnect()</strong>
   * <strong>mysql_query()</strong>


id: mysql_set_charset
type: function
doc:
<comment>Description:</comment>
  Sets the client character set
  
  Sets the default character set for the current connection.

<comment>Param:</comment>
  <info>string</info>    <strong>$charset</strong>          A valid character set name.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Setting character sets in MySQL
   * List of character sets that MySQL supports
   * <strong>mysql_client_encoding()</strong>


id: mysql_stat
type: function
doc:
<comment>Description:</comment>
  Get current system status
  
  <strong>mysql_stat()</strong> returns the current server status.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>string</info>  Returns a string with the status for uptime, threads, queries, open tables, flush tables
          and queries per second. For a complete list of other status variables, you have to use the
          <return>SHOW STATUS</return> SQL command. If <strong>$link_identifier</strong> is invalid, <info>null</info> is returned.

<comment>See Also:</comment>
   * <strong>mysql_get_server_info()</strong>
   * <strong>mysql_list_processes()</strong>


id: mysql_tablename
type: function
doc:
<comment>Description:</comment>
  Get table name of field
  
  Retrieves the table name from a <strong>$result</strong>.
  
  This function is deprecated. It is preferable to use  <strong>mysql_query()</strong> to issue an SQL <return>SHOW TABLES
  [FROM db_name] [LIKE 'pattern']</return> statement instead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  A result pointer <info>resource</info> that's returned from   <strong>mysql_list_tables()</strong>.
  <info>int</info>       <strong>$i</strong>       The integer index (row/table number)

<comment>Return:</comment>
  <info>string|false</info>  The name of the table on success ou <info>false</info> em caso de falha.
                
                Use the <strong>mysql_tablename()</strong> function to traverse this result pointer, or any function
                for result tables, such as <strong>mysql_fetch_array()</strong>.

<comment>See Also:</comment>
   * <strong>mysql_list_tables()</strong>
   * <strong>mysql_field_table()</strong>
   * <strong>mysql_db_name()</strong>


id: mysql_thread_id
type: function
doc:
<comment>Description:</comment>
  Return the current thread ID
  
  Retrieves the current thread ID. If the connection is lost, and a reconnect  with <strong>mysql_ping()</strong> is
  executed, the thread ID will  change. This means only retrieve the thread ID when needed.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>int|false</info>  The thread ID on success ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysql_ping()</strong>
   * <strong>mysql_list_processes()</strong>


id: mysql_unbuffered_query
type: function
doc:
<comment>Description:</comment>
  Send an SQL query to MySQL without fetching and buffering the result rows
  
  <strong>mysql_unbuffered_query()</strong> sends the SQL query <strong>$query</strong> to MySQL without automatically fetching and
  buffering the result rows as <strong>mysql_query()</strong> does.  This saves a considerable amount of memory with
  SQL queries that produce large result sets, and you can start working on the result set
  immediately after the first row has been retrieved as you don't have to wait until the complete
  SQL query has been performed.  To use <strong>mysql_unbuffered_query()</strong> while multiple database connections
  are open, you must specify the optional parameter <strong>$link_identifier</strong> to identify which connection
  you want to use.

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>            The SQL query to execute.
                              
                              Data inside the query should be properly escaped.
  <info>resource</info>  <strong>$link_identifier</strong>  A conexão MySQL. Se o
                              identificador da conexão não for especificado, a última conexão aberta
                              por
                              <strong>mysql_connect()</strong> será usada. Se não houver uma conexão anterior,
                              haverá uma tentativa de criar uma como se <strong>mysql_connect()</strong> tivesse sido
                              chamada
                              sem argumentos. Se nenhuma conexão for encontrada ou estabelecida, um
                              erro de nível
                              <info>E_WARNING</info> será gerado.

<comment>Return:</comment>
  <info>resource</info>  For SELECT, SHOW, DESCRIBE or EXPLAIN statements, <strong>mysql_unbuffered_query()</strong>  returns a
            <info>resource</info> on success, or <info>false</info> on error.
            
            For other type of SQL statements, UPDATE, DELETE, DROP, etc, <strong>mysql_unbuffered_query()</strong>
            returns <info>true</info> on success or <info>false</info> on error.

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


id: mysql_xdevapi\Client::close
type: function
doc:
<comment>Description:</comment>
  Close client
  
  Close all client connections with the server.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if connections are closed.


id: mysql_xdevapi\Table
type: class
doc:
<comment>Description:</comment>
  Provides access to the table through INSERT/SELECT/UPDATE/DELETE statements.


id: mysqli::__construct
type: function
doc:
<comment>Description:</comment>
  Abre uma nova conexão com o servidor MySQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Abre uma conexão com o servidor MySQL.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$hostname</strong>  Pode ser um nome de host ou um endereço IP. Ao passar <info>null</info>, o valor é
                          recuperado de mysqli.default_host. Quando possível, serão usados pipes em
                          vez do protocolo TCP/IP. O protocolo TCP/IP é usado se um nome de host e
                          um número de porta forem fornecidos juntos, por ex. <return>localhost:3308</return>.
                          
                          Prefixar o host com <return>p:</return> abre uma conexão persistente. <strong>mysqli_change_user()</strong>
                          é chamado automaticamente em conexões abertas a partir do pool de
                          conexões.
  <info>string|null</info>  <strong>$username</strong>  O nome de usuário do MySQL ou <info>null</info> para assumir o nome de usuário com base
                          na opção ini mysqli.default_user.
  <info>string|null</info>  <strong>$password</strong>  A senha do MySQL ou <info>null</info> para assumir a senha com base na opção ini
                          mysqli.default_pw.
  <info>string|null</info>  <strong>$database</strong>  O banco de dados padrão a ser utilizado ao realizar consultas ou <info>null</info>.
  <info>int|null</info>     <strong>$port</strong>      O número da porta para tentar conectar ao servidor MySQL ou <info>null</info> para
                          assumir a porta com base na opção ini mysqli.default_port.
  <info>string|null</info>  <strong>$socket</strong>    O socket ou pipe nomeado que deve ser usado ou <info>null</info> para assumir o socket
                          com base na opção ini mysqli.default_socket.
                          
                          A especificação do parâmetro <strong>$socket</strong> não determinará explicitamente o tipo
                          de conexão a ser usada ao conectar-se ao servidor MySQL. A maneira com a
                          qual a conexão é feita com o banco de dados MySQL é determinada pelo
                          parâmetro <strong>$hostname</strong>.

<comment>Return:</comment>
  <info>bool</info>  <strong>mysqli_connect()</strong> retorna um objeto que representa a conexão com um servidor MySQL, ou <info>false</info>
        em caso de falha.
        
        mysqli::connect retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Antes do PHP
        8.1.0, ele retornava <info>null</info> em caso de sucesso.

<comment>See Also:</comment>
   * <strong>mysqli_real_connect()</strong>
   * <strong>mysqli_options()</strong>
   * <strong>mysqli_connect_errno()</strong>
   * <strong>mysqli_connect_error()</strong>
   * <strong>mysqli_close()</strong>


id: mysqli::autocommit
type: function
doc:
<comment>Description:</comment>
  Ativa ou desativa a gravação automática das modificações no banco de dados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Ativa ou desativa o modo de gravação automática nas consultas para a conexão do banco de dados.
  
  Para determinar o estado atual da gravação automática use o comando SQL <return>SELECT @@autocommit</return>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>   Somente no estilo procedural: Um objeto <class>mysqli</class>
                   retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>bool</info>    <strong>$enable</strong>  Habilitar ou não a gravação automática.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_begin_transaction()</strong>
   * <strong>mysqli_commit()</strong>
   * <strong>mysqli_rollback()</strong>


id: mysqli::begin_transaction
type: function
doc:
<comment>Description:</comment>
  Inicia uma transação
  
  Estilo orientado a objetos
  
  Estilo procedural:
  
  Inicia uma transação. Requer o mecanismo InnoDB (é ativado por padrão). Para detalhes adicionais
  sobre como as transações do MySQL funcionam, consulte
  http://dev.mysql.com/doc/mysql/en/commit.html.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                       retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>          <strong>$flags</strong>  As flags válidas são:
                       
                       <info>MYSQLI_TRANS_START_READ_ONLY</info>: Inicia a transação como "START TRANSACTION READ
                       ONLY". Requer MySQL 5.6 e superior.
                       
                       <info>MYSQLI_TRANS_START_READ_WRITE</info>: Inicia a transação como "START TRANSACTION
                       READ WRITE". Requer MySQL 5.6 e superior.
                       
                       <info>MYSQLI_TRANS_START_WITH_CONSISTENT_SNAPSHOT</info>: Inicia a transação como "START
                       TRANSACTION WITH CONSISTENT SNAPSHOT".
  <info>string|null</info>  <strong>$name</strong>   Nome do ponto de salvamento para a transação.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_autocommit()</strong>
   * <strong>mysqli_commit()</strong>
   * <strong>mysqli_rollback()</strong>


id: mysqli::change_user
type: function
doc:
<comment>Description:</comment>
  Modifica o usuário para a conexão com o banco de dados especificada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Muda o usuário na conexão com o banco de dados especificado e define o banco atual.
  
  Para conseguir mudar usuários com sucesso, os parâmetors <strong>$username</strong> e <strong>$password</strong> fornecidos devem
  ser válidos e este usuário deve ter permissões suficientes para acessar o banco de dados desejado.
  Se por qualquer motivo a autorização falhar, a autenticação do usuário atual irá permanecer.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>     Somente no estilo procedural: Um objeto <class>mysqli</class>
                          retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>       <strong>$username</strong>  O nome do usuário MySQL.
  <info>string</info>       <strong>$password</strong>  A senha MySQL.
  <info>string|null</info>  <strong>$database</strong>  O banco de dados a ser designado.
                          
                          Se desejado, o valor <info>null</info> pode ser passado, resultando somente em mudança
                          de usuário e não selecionando o banco. Para selecionar o banco neste caso,
                          utilize a função <strong>mysqli_select_db()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_connect()</strong>
   * <strong>mysqli_select_db()</strong>


id: mysqli::character_set_name
type: function
doc:
<comment>Description:</comment>
  Retorna o conjunto de caracteres atual da conexão com o banco de dados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o conjunto de caracteres atual da conexão com o banco de dados.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string</info>  O conjunto de caracteres atual da conexão

<comment>See Also:</comment>
   * <strong>mysqli_set_charset()</strong>
   * <strong>mysqli_real_escape_string()</strong>


id: mysqli::close
type: function
doc:
<comment>Description:</comment>
  Fecha uma conexão ao banco de dados previamente aberta
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Fecha uma conexão ao banco de dados previamente aberta.
  
  Conexões MySQL não persistentes e conjuntos de resultados são automaticamente fechados quando seus
  objetos são destruídos. Fechar as conexões e liberar os conjuntos de resultados explicitamente é
  opcional. Entretanto, é uma boa prática fechar a conexão assim que o script termina de executar
  todas as suas operações de banco de dados, se ele ainda tiver muito processamento a realizar
  depois de obter os resultados.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * mysqli::__construct
   * <strong>mysqli_init()</strong>
   * <strong>mysqli_real_connect()</strong>
   * <strong>mysqli_free_result()</strong>


id: mysqli::commit
type: function
doc:
<comment>Description:</comment>
  Grava a transação atual
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Grava a transação atual para a conexão do banco de dados.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                       retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>          <strong>$flags</strong>  Uma máscara de bits de constantes <info>MYSQLI_TRANS_COR_*</info>.
  <info>string|null</info>  <strong>$name</strong>   Se fornecido, <return>COMMIT/*name*/</return> é executado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_autocommit()</strong>
   * <strong>mysqli_begin_transaction()</strong>
   * <strong>mysqli_rollback()</strong>
   * <strong>mysqli_savepoint()</strong>


id: mysqli::debug
type: function
doc:
<comment>Description:</comment>
  Realiza operações de depuração
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Realiza operações de depuração usando a biblioteca Fred Fish.

<comment>Param:</comment>
  <info>string</info>  <strong>$options</strong>  Uma string representando a operação de depuração a ser executada
                    
                    A string de opções de depuração é uma sequência de campos separados por dois
                    pontos (:) desta maneira: <return>::]]></return> Cada campo consiste de um caractere de opção
                    mandatório seguido por uma <return>,</return> opcional e uma lista de modificadores: separados
                    por vírgula: <return>opção[,modificador,modificador,...,modificador]</return>
                    
                    Caracteres de Opção ReconhecidosCaractere de
                    <strong>$options</strong>DescriçãoO<info>MYSQLND_DEBUG_FLUSH</info>A/a<info>MYSQLND_DEBUG_APPEND</info>F<info>MYSQLND_DEBUG_DUMP_FILE</info>i<info>MYSQLND_DEBUG_DUMP_PID</info>L<info>MYSQLND_DEBUG_DUMP_LINE</info>m<info>MYSQLND_DEBUG_TRACE_MEMORY_CALLS</info>n<info>MYSQLND_DEBUG_DUMP_LEVEL</info>osaída
                    para
                    arquivoT<info>MYSQLND_DEBUG_DUMP_TIME</info>t<info>MYSQLND_DEBUG_DUMP_TRACE</info>x<info>MYSQLND_DEBUG_PROFILE_CALLS</info>

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>mysqli_dump_debug_info()</strong>
   * <strong>mysqli_report()</strong>


id: mysqli::dump_debug_info
type: function
doc:
<comment>Description:</comment>
  Descarrega informação de debug no log
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função é projetada para ser executada por um usuário com privilégio SUPER e é usada para
  descarregar informações de depuração no log, para o servidor MySQL, relacionadas à conexão.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysqli::escape_string
type: function
doc:
<comment>Description:</comment>
  Sinônimo de mysqli_real_escape_string
  
  Esta função é um apelido para:  <strong>mysqli_real_escape_string()</strong>.


id: mysqli::execute_query
type: function
doc:
<comment>Description:</comment>
  Prepara, vincula parâmetros e executa a instrução SQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Prepara a consulta SQL, associa parâmetros e a executa. O método mysqli::execute_query é um atalho
  para mysqli::prepare, mysqli_stmt::bind_param, mysqli_stmt::execute e mysqli_stmt::get_result.
  
  O modelo de instrução pode conter zero ou mais marcadores de parâmetro de ponto de interrogação
  (<return>?</return>) também chamados de espaços reservados. Os valores dos parâmetros devem ser fornecidos como um
  <info>array</info> usando o parâmetro <strong>$params</strong>.
  
  Uma instrução preparada é criada, mas nunca é exposta fora da função. É impossível acessar as
  propriedades da instrução como faria com o objeto <class>mysqli_stmt</class>. Devido a essa limitação, as
  informações de status são copiadas para o objeto <class>mysqli</class> e estão disponíveis usando seus métodos,
  por exemplo <strong>mysqli_affected_rows()</strong> ou <strong>mysqli_error()</strong>.
  
  No caso em que uma instrução é passada para <strong>mysqli_execute_query()</strong> que é maior que
  <return>max_allowed_packet</return> do servidor, os códigos de erro retornados são diferentes dependendo do sistema
  operacional. O comportamento é o seguinte:
  
  No Linux retorna um código de erro de 1153. A mensagem de erro significa que o pacote é maior que
  <return>max_allowed_packet</return> bytes.
  
  No Windows retorna um código de erro 2006. Essa mensagem de erro significa que o servidor foi
  desativado.

<comment>Param:</comment>
  <info>mysqli</info>      <strong>$mysql</strong>   Somente no estilo procedural: Um objeto <class>mysqli</class>
                       retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>      <strong>$query</strong>   A consulta, como uma string. Deve consistir em uma única instrução SQL.
                       
                       A instrução SQL pode conter zero ou mais marcadores de parâmetro
                       representados por caracteres de ponto de interrogação (<return>?</return>) nas posições
                       apropriadas.
                       
                       Os marcadores são válidos apenas em determinados locais nas instruções SQL.
                       Por exemplo, eles são permitidos na lista <return>VALUES()</return> de uma instrução <return>INSERT</return>
                       (para especificar valores de coluna para uma linha) ou em uma comparação com
                       uma coluna em uma cláusula <return>WHERE</return> para especificar um valor de comparação. No
                       entanto, eles não são permitidos para identificadores (como nomes de tabelas
                       ou colunas).
  <info>array|null</info>  <strong>$params</strong>  Um <info>array</info> opcional com tantos elementos quantos forem os parâmetros vinculados
                       na instrução SQL que está sendo executada. Cada valor é tratado como uma
                       <info>string</info>.

<comment>Return:</comment>
  <info>mysqli_result|bool</info>  Retorna <info>false</info> em caso de falha. Para consultas bem-sucedidas que produzem um
                      conjunto de resultados, como <return>SELECT, SHOW, DESCRIBE</return> ou <return>EXPLAIN</return>, retorna um
                      objeto <class>mysqli_result</class>. Para outras consultas bem-sucedidas, retorna <info>true</info>.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_execute()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>
   * <strong>mysqli_stmt_get_result()</strong>


id: mysqli::get_charset
type: function
doc:
<comment>Description:</comment>
  Retorna um objeto de conjunto de caracteres
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um objeto de conjunto de caracteres fornecendo várias propriedades do conjunto de
  caracteres ativo atual.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>object|null</info>  A função retorna um objeto de conjunto de caracteres com as seguintes propriedades:
               <strong>$charset</strong>Nome do conjunto de caracteres<strong>$collation</strong>Nome do agrupamento<strong>$dir</strong>Diretório do
               qual a descrição do conjunto de caracteres foi obtida (?) ou "" para conjuntos de
               caracteres integrados<strong>$min_length</strong>Comprimento mínimo de caracteres em
               bytes<strong>$max_length</strong>Comprimento máximo de caracteres em bytes<strong>$number</strong>Número interno do
               conjunto de caracteres<strong>$state</strong>Status do conjunto de caracteres (?)
               
               Nome do conjunto de caracteres
               
               Nome do agrupamento
               
               Diretório do qual a descrição do conjunto de caracteres foi obtida (?) ou "" para
               conjuntos de caracteres integrados
               
               Comprimento mínimo de caracteres em bytes
               
               Comprimento máximo de caracteres em bytes
               
               Número interno do conjunto de caracteres
               
               Status do conjunto de caracteres (?)

<comment>See Also:</comment>
   * <strong>mysqli_character_set_name()</strong>
   * <strong>mysqli_set_charset()</strong>


id: mysqli::get_client_info
type: function
doc:
<comment>Description:</comment>
  Obtém informação do cliente MySQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string que representa a versão de biblioteca do cliente MySQL.

<comment>Return:</comment>
  <info>string</info>  Uma string que representa a versão da biblioteca do cliente MySQL.

<comment>See Also:</comment>
   * <strong>mysqli_get_client_version()</strong>
   * <strong>mysqli_get_server_info()</strong>
   * <strong>mysqli_get_server_version()</strong>


id: mysqli::get_connection_stats
type: function
doc:
<comment>Description:</comment>
  Retorna estatísticas sobre a conexão do cliente
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna estatísticas sobre a conexão do cliente.
  
  Disponível apenas com o mysqlnd.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>array</info>  Retorna uma matriz com estatísticas de conexão.

<comment>See Also:</comment>
   * Stats description


id: mysqli::get_server_info
type: function
doc:
<comment>Description:</comment>
  Retorna a versão do servidor MySQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string representando a versão do servidor MySQL ao qual a extensão MySQLi está
  conectada.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string</info>  Uma string de caracteres representando a versão do servidor.

<comment>See Also:</comment>
   * <strong>mysqli_get_client_info()</strong>
   * <strong>mysqli_get_client_version()</strong>
   * <strong>mysqli_get_server_version()</strong>


id: mysqli::get_warnings
type: function
doc:
<comment>Description:</comment>
  Obtém o resultado de SHOW WARNINGS
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mysqli_warning|false</info>  


id: mysqli::init
type: function
doc:
<comment>Description:</comment>
  Inicializa o MySQLi e retorna um objeto a ser utilizado com mysqli_real_connect()
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Aloca ou inicializa um objeto MYSQL adequado para as funções <strong>mysqli_options()</strong> e
  <strong>mysqli_real_connect()</strong>.
  
  Chamadas subsequentes a quaisquer funções mysqli (exceto <strong>mysqli_options()</strong> e <strong>mysqli_ssl_set()</strong>) irão
  falhar até que <strong>mysqli_real_connect()</strong> seja chamada.

<comment>Return:</comment>
  <info>bool|null</info>  mysqli::init retorna <info>null</info> em caso de sucesso,  ou <info>false</info> em caso de falha. <strong>mysqli_init()</strong>
             retorna um objeto em caso de sucesso,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_options()</strong>
   * <strong>mysqli_close()</strong>
   * <strong>mysqli_real_connect()</strong>
   * <strong>mysqli_connect()</strong>


id: mysqli::kill
type: function
doc:
<comment>Description:</comment>
  Solicita ao servidor o encerramento de um thread do MySQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função é usada para solicitar ao servidor o encerramento de uma thread do MySQL especificada
  pelo parâmetro <strong>$process_id</strong>. Este valor deve ser recuperado chamando a função <strong>mysqli_thread_id()</strong>.
  
  Para encerrar a execução de uma consulta, você deve usar o comando SQL <return>KILL QUERY processid</return>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysqli::more_results
type: function
doc:
<comment>Description:</comment>
  Verifica se há mais algum resultado de uma consulta múltipla
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Indica se um ou mais conjuntos de resultados estão disponíveis de uma chamada anterior a
  <strong>mysqli_multi_query()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se um ou mais conjuntos de resultados (incluindo erros) estão disponíveis de
        uma chamada anterior a <strong>mysqli_multi_query()</strong>, caso contrário <info>false</info>.

<comment>See Also:</comment>
   * <strong>mysqli_multi_query()</strong>
   * <strong>mysqli_next_result()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli::multi_query
type: function
doc:
<comment>Description:</comment>
  Executa uma ou mais consultas no banco de dados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Executa uma ou múltiplas consultas que são concatenadas com ponto-e-vírgula.
  
  Se a consulta contiver qualquer entrada de
  variável, instruções
  preparadas parametrizadas devem ser usadas. Alternativamente, os
  dados devem ser formatados corretamente e todas as strings devem ser escapadas usando
  a função <strong>mysqli_real_escape_string()</strong>.
  
  Consultas são enviadas de forma assíncrona em uma única chamada ao banco, mas o banco de dados
  processa-as sequencialmente. mysqli_multi_query espera pela finalização da primeira consulta antes
  de retornar o controle ao PHP. O servidor MySQL então processará a próxima consulta na sequência.
  Uma vez que o resultado seguinte ficar pronto, o MySQL esperará pela próxima execução de
  <strong>mysqli_next_result()</strong> pelo PHP.
  
  É recomendado usar do-while para processar consultas múltiplas. A conexão estará ocupada enquanto
  todas as consultas tiverem concluído e seus resultados enviados ao PHP. Nenhuma outra declaração
  pode ser emitida na mesma conexão até que todas as consultas sejam processadas. Para proceder à
  consulta seguinte, use <strong>mysqli_next_result()</strong>. Se a consulta seguinte ainda não estiver pronta,
  mysqli esperará pela resposta do servidor MySQL. Para verificar se há mais resultados, use
  <strong>mysqli_more_results()</strong>.
  
  Para consultas que produzem um conjnto de resultados, como em <return>SELECT, SHOW, DESCRIBE</return> ou <return>EXPLAIN</return>,
  <strong>mysqli_use_result()</strong> ou <strong>mysqli_store_result()</strong> podem ser usadas para recuperar o conjunto. Para
  consultas que não produzem um conjunto de resultados, as mesmas funções podem ser usadas para
  recuperar informação como o número de linhas afetadas.
  
  Executar declarações <return>CALL</return> para procedimentos armazenados pode produzir múltiplos conjuntos de
  resultados. Se o procedimento armazenado contiver declarações <return>SELECT</return>, os conjuntos são retornados
  na ordem em que são produzidos enquando o procedimento é executado. Em geral, a função que chama
  não sabe quantos conjuntos de resultados um procedimento irá retornar e deve estar preparada para
  recuperar múltiplos conjuntos. O resultado final do procedimento é um resultado de estado que não
  inclui nenhum conjunto. O estado indica se o procedimento teve sucesso ou se ocorreu um erro.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$query</strong>  Uma string contendo as consultas que serão executadas. Consultas múltiplas devem
                  ser separadas por ponto-e-vírgula (;).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>false</info> se a primeira consulta falhar. Para recuperar erros subsequentes de outras
        consultas, deve-se chamar <strong>mysqli_next_result()</strong> primeiro.

<comment>See Also:</comment>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_use_result()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_next_result()</strong>
   * <strong>mysqli_more_results()</strong>


id: mysqli::next_result
type: function
doc:
<comment>Description:</comment>
  Prepara o próximo resultado de multi_query
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Prepara o próximo conjunto de resultado de uma chamada anterior a <strong>mysqli_multi_query()</strong> que pode
  ser recuperado por <strong>mysqli_store_result()</strong> ou <strong>mysqli_use_result()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Também retorna <info>false</info> se a
        declaração seguinte resultou em erro, diferentemente de mysqli_more_results.

<comment>See Also:</comment>
   * <strong>mysqli_multi_query()</strong>
   * <strong>mysqli_more_results()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli::options
type: function
doc:
<comment>Description:</comment>
  Define opções
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Usado para definir opções extras de conexão e afetar o comportamento de uma conexão.
  
  Esta função pode ser chamada várias vezes para definir várias opções.
  
  <strong>mysqli_options()</strong> deve ser chamado depois de <strong>mysqli_init()</strong> e antes de <strong>mysqli_real_connect()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>      <strong>$mysql</strong>   Somente no estilo procedural: Um objeto <class>mysqli</class>
                       retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>         <strong>$option</strong>  A opção que você deseja definir. Pode ser um dos seguintes valores: Valid
                       optionsNameDescription<info>MYSQLI_OPT_CONNECT_TIMEOUT</info>Tempo limite de conexão em
                       segundos<info>MYSQLI_OPT_READ_TIMEOUT</info>Tempo limite do resultado da execução do
                       comando em segundos. Disponível a partir do PHP
                       7.2.0.<info>MYSQLI_OPT_LOCAL_INFILE</info>Ativar/desativar o uso de <return>LOAD LOCAL
                       INFILE</return><info>MYSQLI_INIT_COMMAND</info>Comando para executar depois ao conectar ao servidor
                       MySQL<info>MYSQLI_SET_CHARSET_NAME</info>O conjunto de caracteres a ser definido como
                       padrão..<info>MYSQLI_READ_DEFAULT_FILE</info> Lê as opções do arquivo de opções nomeadas
                       em vez de my.cnf Não suportado por mysqlnd. <info>MYSQLI_READ_DEFAULT_GROUP</info> Leia as
                       opções do grupo nomeado de my.cnf ou o arquivo especificado com
                       <info>MYSQL_READ_DEFAULT_FILE</info>. Não suportado pelo mysqlnd. <info>MYSQLI_SERVER_PUBLIC_KEY</info>
                       Arquivo de chave pública RSA usado com a autenticação baseada em SHA-256.
                       <info>MYSQLI_OPT_NET_CMD_BUFFER_SIZE</info> O tamanho do buffer interno de comando/rede.
                       Válido apenas para mysqlnd. <info>MYSQLI_OPT_NET_READ_BUFFER_SIZE</info> Tamanho máximo do
                       bloco de leitura em bytes ao ler o corpo de um pacote de comando do MySQL.
                       Válido apenas para mysqlnd. <info>MYSQLI_OPT_INT_AND_FLOAT_NATIVE</info> Converte colunas
                       de números inteiros e pontos flutuantes de volta para números PHP ao usar
                       instruções não preparadas. Válido apenas para mysqlnd.
                       <info>MYSQLI_OPT_SSL_VERIFY_SERVER_CERT</info> Se deve-se verificar ou não o certificado
                       do servidor.
  <info>string|int</info>  <strong>$value</strong>   O valor da opção.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_init()</strong>
   * <strong>mysqli_real_connect()</strong>


id: mysqli::ping
type: function
doc:
<comment>Description:</comment>
  Faz ping em uma conexão de servidor ou tenta reconectar se a conexão cair
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Verifica se a conexão com o servidor está funcionando. Se ele estiver inativo e a opção global
  mysqli.reconnect estiver habilitada, uma reconexão automática será tentada.
  
  A configuração mysqli.reconnect do php.ini é ignorada pelo driver mysqlnd, então a reconexão
  automática nunca é tentada.
  
  Esta função pode ser utilizada por clientes que ficam muito tempo ociosos, para verificar se o
  servidor encerrou a conexão e reconectar se necessário.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: mysqli::poll
type: function
doc:
<comment>Description:</comment>
  Sondagem de conexões
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Faz sondagem de conexões. Este método pode ser usado como static.
  
  Disponível apenas com o mysqlnd.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$read</strong>          Lista de conexões a verificar por resultados marcantes que possam ser
                             lidos.
  <info>array|null</info>  <strong>$error</strong>         Lista de conexões nas quais um erro ocorreu, por exemplo, falha na
                             consulta ou conexão perdida.
  <info>array</info>       <strong>$reject</strong>        Lista de conexões rejeitadas porque nenhuma consulta assícrona foi
                             executada para que a função pudesse sondar os resultados.
  <info>int</info>         <strong>$seconds</strong>       Número máximo de segundos a esperar, deve ser não negativo.
  <info>int</info>         <strong>$microseconds</strong>  Número máximo de microssegundos a esperar, deve ser não negativo.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o número de conexões prontas em caso de sucesso, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_reap_async_query()</strong>


id: mysqli::prepare
type: function
doc:
<comment>Description:</comment>
  Prepara uma instrução SQL para execução
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Prepara a consulta SQL e retorna um identificador de instrução a ser usado para outras operações
  na instrução. A consulta deve consistir em uma única instrução SQL.
  
  O modelo de instrução pode conter zero ou mais marcadores de parâmetro de ponto de interrogação
  (<return>?</return>) também chamados de espaços reservados. Os marcadores de parâmetro devem ser vinculados às
  variáveis do aplicativo usando <strong>mysqli_stmt_bind_param()</strong> antes de executar a instrução.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$query</strong>  A consulta, como uma string. Deve consistir em uma única instrução SQL.
                  
                  A instrução SQL pode conter zero ou mais marcadores de parâmetro representados por
                  caracteres de ponto de interrogação (<return>?</return>) nas posições apropriadas.
                  
                  Os marcadores são válidos apenas em determinados locais nas instruções SQL. Por
                  exemplo, eles são permitidos na lista <return>VALUES()</return> de uma instrução <return>INSERT</return> (para
                  especificar valores de coluna para uma linha) ou em uma comparação com uma coluna
                  em uma cláusula <return>WHERE</return> para especificar um valor de comparação. No entanto, eles
                  não são permitidos para identificadores (como nomes de tabelas ou colunas).

<comment>Return:</comment>
  <info>mysqli_stmt|false</info>  <strong>mysqli_prepare()</strong> retorna um objeto de instrução ou <info>false</info> se ocorreu um erro.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_execute()</strong>
   * <strong>mysqli_stmt_fetch()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>
   * <strong>mysqli_stmt_bind_result()</strong>
   * <strong>mysqli_stmt_get_result()</strong>
   * <strong>mysqli_stmt_close()</strong>


id: mysqli::query
type: function
doc:
<comment>Description:</comment>
  Executa uma consulta no banco de dados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Executa uma <strong>$query</strong> no banco de dados.
  
  Se a consulta contiver qualquer entrada de
  variável, instruções
  preparadas parametrizadas devem ser usadas. Alternativamente, os
  dados devem ser formatados corretamente e todas as strings devem ser escapadas usando
  a função <strong>mysqli_real_escape_string()</strong>.
  
  Para consultas não-DML (não INSERT, UPDATE ou DELETE), esta função é semelhante a chamar
  <strong>mysqli_real_query()</strong> seguido por <strong>mysqli_use_result()</strong> ou <strong>mysqli_store_result()</strong>.
  
  No caso em que uma instrução é passada para <strong>mysqli_query()</strong> que é maior que <return>max_allowed_packet</return> do
  servidor, os códigos de erro retornados são diferentes dependendo se você está usando MySQL Native
  Driver (<return>mysqlnd</return>)ou MySQL Client Library (<return>libmysqlclient</return>). O comportamento é o seguinte:
  
  <return>mysqlnd</return> no Linux retorna um código de erro de 1153. A mensagem de erro significa que recebi um
  pacote maior que <return>max_allowed_packet</return> bytes.
  
  <return>mysqlnd</return> no Windows retorna um código de erro 2006. Esta mensagem de erro significa que o server
  has gone away.
  
  <return>libmysqlclient</return> em todas as plataformas retorna um código de erro 2006. Essa mensagem de erro
  significa que o servidor foi desativado.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>        Somente no estilo procedural: Um objeto <class>mysqli</class>
                        retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$query</strong>        A string de consulta.
  <info>int</info>     <strong>$result_mode</strong>  O modo de resultado pode ser uma das 3 constantes que indicam como o
                        resultado será retornado do servidor MySQL.
                        
                        <info>MYSQLI_STORE_RESULT</info> (padrão) - retorna um objeto <class>mysqli_result</class>com conjunto
                        de resultados em buffer.
                        
                        <info>MYSQLI_USE_RESULT</info> - retorna um objeto <class>mysqli_result</class> com conjunto de
                        resultados sem buffer. Enquanto houver registros pendentes esperando para
                        serem buscados, a linha de conexão estará ocupada e todas as chamadas
                        subseqüentes retornarão o erro <return>Commands out of sync</return>. Para evitar o erro,
                        todos os registros devem ser buscados no servidor ou o conjunto de
                        resultados deve ser descartado chamando <strong>mysqli_free_result()</strong>.
                        
                        <info>MYSQLI_ASYNC</info> (disponível com mysqlnd) - a consulta é executada de forma
                        assíncrona e nenhum conjunto de resultados é retornado imediatamente.
                        <strong>mysqli_poll()</strong> é então usado para obter resultados de tais consultas. Usado
                        em combinação com a constante <info>MYSQLI_STORE_RESULT</info> ou <info>MYSQLI_USE_RESULT</info>.

<comment>Return:</comment>
  <info>mysqli_result|bool</info>  Retorna <info>false</info> em caso de falha. Para consultas bem-sucedidas que produzem um
                      conjunto de resultados, como <return>SELECT, SHOW, DESCRIBE</return> ou <return>EXPLAIN</return>, <strong>mysqli_query()</strong>
                      retornará um objeto <class>mysqli_result</class>. Para outras consultas bem-sucedidas,
                      <strong>mysqli_query()</strong> retornará <info>true</info>.

<comment>See Also:</comment>
   * <strong>mysqli_execute_query()</strong>
   * <strong>mysqli_real_query()</strong>
   * <strong>mysqli_multi_query()</strong>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_free_result()</strong>


id: mysqli::real_connect
type: function
doc:
<comment>Description:</comment>
  Abre uma conexão com um servidor mysql
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Estabeleça uma conexão com um mecanismo de banco de dados MySQL.
  
  Esta função difere de <strong>mysqli_connect()</strong>:
  
  <strong>mysqli_real_connect()</strong> precisa de um objeto válido que deve ser criado pela função <strong>mysqli_init()</strong>.
  
  Com a função <strong>mysqli_options()</strong> pode-se definir várias opções de conexão.
  
  Existe um parâmetro <strong>$flags</strong>.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>     Somente no estilo procedural: Um objeto <class>mysqli</class>
                          retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string|null</info>  <strong>$hostname</strong>  Pode ser um nome de host ou um endereço IP. Ao passar <info>null</info>, o valor é
                          recuperado de mysqli.default_host. Quando possível, serão usados pipes em
                          vez do protocolo TCP/IP. O protocolo TCP/IP é usado se um nome de host e
                          um número de porta forem fornecidos juntos, por ex. <return>localhost:3308</return>.
  <info>string|null</info>  <strong>$username</strong>  O nome de usuário do MySQL, ou <info>null</info> para assumir o nome de usuário com
                          base na opção ini mysqli.default_user.
  <info>string|null</info>  <strong>$password</strong>  A senha do MySQL, ou <info>null</info> para assumir a senha com base na opção ini
                          mysqli.default_pw.
  <info>string|null</info>  <strong>$database</strong>  O banco de dados padrão a ser usado ao realizar consultas ou <info>null</info>.
  <info>int|null</info>     <strong>$port</strong>      O número da porta para tentar conectar ao servidor MySQL ou <info>null</info> para
                          assumir a porta com base na opção mysqli.default_port.
  <info>string|null</info>  <strong>$socket</strong>    O socket ou pipe nomeado que deve ser usado ou <info>null</info> para assumir o socket
                          com base na opção ini mysqli.default_socket.
                          
                          A especificação do parâmetro <strong>$socket</strong> não determinará explicitamente o tipo
                          de conexão a ser usada ao conectar-se ao servidor MySQL. A forma como a
                          conexão é feita com o banco de dados MySQL é determinada pelo parâmetro
                          <strong>$hostname</strong>.
  <info>int</info>          <strong>$flags</strong>     Com o parâmetro <strong>$flags</strong>, pode-se definir diferentes opções de conexão:
                          
                          Por motivos de segurança, a opção <info>MULTI_STATEMENT</info> não é suportado no PHP.
                          Se for desejado executar várias consultas, use a função
                          <strong>mysqli_multi_query()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_connect()</strong>
   * <strong>mysqli_init()</strong>
   * <strong>mysqli_options()</strong>
   * <strong>mysqli_ssl_set()</strong>
   * <strong>mysqli_close()</strong>


id: mysqli::real_escape_string
type: function
doc:
<comment>Description:</comment>
  Escape caracteres especiais em uma string para uso em uma instrução SQL, levando em consideração o
  conjunto de caracteres atual da conexão
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função é usada para criar uma string SQL legal que você pode usar em uma instrução SQL. A
  string fornecida é codificada para produzir uma string SQL com escape, levando em consideração o
  conjunto de caracteres atual da conexão.
  
  O conjunto de caracteres deve ser definido no nível do servidor ou com a função API
  <strong>mysqli_set_charset()</strong> para que afete <strong>mysqli_real_escape_string()</strong>. Consulte a seção de conceitos
  sobre conjuntos de caracteres para obter mais informações.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>   Somente no estilo procedural: Um objeto <class>mysqli</class>
                   retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$string</strong>  A string a ser escapada.
                   
                   Os caracteres codificados são <return>NUL (ASCII 0)</return>, <return>\n</return>, <return>\r</return>, <return>\</return>, <return>'</return>, <return>"</return>, e CTRLZ.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string com escape.

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


id: mysqli::real_query
type: function
doc:
<comment>Description:</comment>
  Executa uma consulta SQL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Executa uma única consulta no banco de dados cujo resultado pode ser recuperado ou armazenado
  usando as funções <strong>mysqli_store_result()</strong> ou <strong>mysqli_use_result()</strong>.
  
  Se a consulta contiver qualquer entrada de
  variável, instruções
  preparadas parametrizadas devem ser usadas. Alternativamente, os
  dados devem ser formatados corretamente e todas as strings devem ser escapadas usando
  a função <strong>mysqli_real_escape_string()</strong>.
  
  Para determinar se uma determinada consulta deve retornar um conjunto de resultados ou não,
  consulte <strong>mysqli_field_count()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$query</strong>  A string de consulta.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli::reap_async_query
type: function
doc:
<comment>Description:</comment>
  Obtenha o resultado da consulta assíncrona
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtenha o resultado da consulta assíncrona.
  
  Disponível apenas com o mysqlnd.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>mysqli_result|bool</info>  Retorna <info>false</info> em caso de falha. Para consultas bem-sucedidas que produzem um
                      conjunto de resultados, como <return>SELECT, SHOW, DESCRIBE</return> ou <return>EXPLAIN</return>,
                      <strong>mysqli_reap_async_query()</strong> retornará um objeto <class>mysqli_result</class>. Para outras
                      consultas bem-sucedidas, <strong>mysqli_reap_async_query()</strong> retornará <info>true</info>.

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


id: mysqli::refresh
type: function
doc:
<comment>Description:</comment>
  Atualiza
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Libera tabelas ou caches ou redefine as informações do servidor de replicação.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>     <strong>$flags</strong>  As opções para atualizar, usando as constantes MYSQLI_REFRESH_* conforme
                  documentado na documentação das MySQLi constantes.
                  
                  Veja também a documentação oficial do MySQL Refresh.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> se a atualização foi bem-sucedida, caso contrário, <info>false</info>

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


id: mysqli::release_savepoint
type: function
doc:
<comment>Description:</comment>
  Remove o ponto de salvamento nomeado do conjunto de pontos de salvamento da transação atual
  
  Estilo orientado a objetos
  
  Estilo procedural:
  
  Esta função é idêntica à execução de $mysqli-&gt;query("RELEASE SAVEPOINT `$name`");. Esta função
  não aciona commit ou rollback.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$name</strong>   O identificador do ponto de salvamento.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysqli::rollback
type: function
doc:
<comment>Description:</comment>
  Reverte a transação atual
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Reverte a transação atual para o banco de dados.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                       retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>          <strong>$flags</strong>  Uma máscara de bits das constantes <info>MYSQLI_TRANS_COR_*</info>.
  <info>string|null</info>  <strong>$name</strong>   Se fornecido, então <return>ROLLBACK/*name*/</return> é executado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_begin_transaction()</strong>
   * <strong>mysqli_commit()</strong>
   * <strong>mysqli_autocommit()</strong>
   * <strong>mysqli_release_savepoint()</strong>


id: mysqli::savepoint
type: function
doc:
<comment>Description:</comment>
  Define um ponto de salvamento de transação nomeado
  
  Estilo orientado a objetos
  
  Estilo procedural:
  
  Esta função é idêntica à execução de $mysqli-&gt;query("SAVEPOINT `$name`");

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$name</strong>   O identificador do ponto de salvamento.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysqli::select_db
type: function
doc:
<comment>Description:</comment>
  Seleciona o banco de dados padrão para consultas de banco de dados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Seleciona o banco de dados padrão a ser usado ao executar consultas na conexão do banco de dados.
  
  Esta função deve ser usada apenas para alterar o banco de dados padrão para a conexão. Você pode
  selecionar o banco de dados padrão com o 4º parâmetro em <strong>mysqli_connect()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>     Somente no estilo procedural: Um objeto <class>mysqli</class>
                     retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$database</strong>  O nome do banco de dados.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_connect()</strong>
   * <strong>mysqli_real_connect()</strong>


id: mysqli::set_charset
type: function
doc:
<comment>Description:</comment>
  Define o conjunto de caracteres do cliente
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Define o conjunto de caracteres a ser usado ao enviar dados de e para o servidor de banco de
  dados.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>    Somente no estilo procedural: Um objeto <class>mysqli</class>
                    retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string</info>  <strong>$charset</strong>  O conjunto de caracteres desejado.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_character_set_name()</strong>
   * <strong>mysqli_real_escape_string()</strong>
   * Conceitos do conjunto de caracteres do MySQL
   * Lista de conjuntos de caracteres que o MySQL suporta


id: mysqli::set_opt
type: function
doc:
<comment>Description:</comment>
  Sinônimo de mysqli_options
  
  Esta função é um apelido para:  <strong>mysqli_options()</strong>.


id: mysqli::ssl_set
type: function
doc:
<comment>Description:</comment>
  Usado para estabelecer conexões seguras usando SSL
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Usado para estabelecer conexões seguras usando SSL. Deve ser chamado antes de
  <strong>mysqli_real_connect()</strong>. Esta função não faz nada, a menos que o suporte OpenSSL esteja ativado.

<comment>Param:</comment>
  <info>mysqli</info>       <strong>$mysql</strong>           Somente no estilo procedural: Um objeto <class>mysqli</class>
                                retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>string|null</info>  <strong>$key</strong>             O nome do caminho para o arquivo de chave.
  <info>string|null</info>  <strong>$certificate</strong>     O nome do caminho para o arquivo de certificado.
  <info>string|null</info>  <strong>$ca_certificate</strong>  O nome do caminho para o arquivo de autoridade de certificação.
  <info>string|null</info>  <strong>$ca_path</strong>         O nome do caminho para um diretório que contém certificados SSL CA
                                confiáveis no formato PEM.
  <info>string|null</info>  <strong>$cipher_algos</strong>    Uma lista de cifras permitidas a serem usadas para criptografia SSL.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>. Se a configuração do SSL estiver incorreta, <strong>mysqli_real_connect()</strong>
        retornará um erro quando você tentar se conectar.

<comment>See Also:</comment>
   * <strong>mysqli_options()</strong>
   * <strong>mysqli_real_connect()</strong>


id: mysqli::stat
type: function
doc:
<comment>Description:</comment>
  Obtém o status atual do sistema
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  <strong>mysqli_stat()</strong> retorna uma string contendo informações semelhantes àquelas fornecidas pelo comando
  'mysqladmin status'. Isso inclui o tempo de atividade em segundos e o número de threads em
  execução, perguntas, recarregamentos e tabelas abertas.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string|false</info>  Uma string que descreve o status do servidor. <info>false</info> se ocorreu um erro.

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


id: mysqli::stmt_init
type: function
doc:
<comment>Description:</comment>
  Inicializa uma instrução e retorna um objeto para uso com mysqli_stmt_prepare
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Aloca e inicializa um objeto de instrução adequado para <strong>mysqli_stmt_prepare()</strong>.
  
  Qualquer chamada subseqüente para qualquer função mysqli_stmt falhará até que
  <strong>mysqli_stmt_prepare()</strong> seja chamado.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>mysqli_stmt|false</info>  Retorna um objeto.

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


id: mysqli::store_result
type: function
doc:
<comment>Description:</comment>
  Transfere um conjunto de resultados da última consulta
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Transfere o conjunto de resultados da última consulta na conexão do banco de dados representada
  pelo parâmetro <strong>$mysql</strong> para ser usado com a função <strong>mysqli_data_seek()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>     <strong>$mode</strong>   A opção que você deseja definir. A partir do PHP 8.1, este parâmetro não tem
                  efeito. Pode ser um dos seguintes valores: Valid
                  optionsNomeDescrição<info>MYSQLI_STORE_RESULT_COPY_DATA</info>Copia os resultados do buffer
                  mysqlnd interno nas variáveis PHP buscadas. Por padrão, o mysqlnd usará uma lógica
                  de referência para evitar copiar e duplicar os resultados mantidos na memória.
                  Para certos conjuntos de resultados, por exemplo, conjuntos de resultados com
                  muitas linhas pequenas, a abordagem de cópia pode reduzir o uso geral de memória
                  porque as variáveis PHP que contêm resultados podem ser liberadas mais cedo
                  (disponível apenas com mysqlnd)

<comment>Return:</comment>
  <info>mysqli_result|false</info>  Retorna um objeto de resultado armazenado em buffer ou <info>false</info> se ocorreu um
                       erro.
                       
                       <strong>mysqli_store_result()</strong> retorna <info>false</info>  caso a consulta não retorne um conjunto
                       de resultados (se a consulta for, por exemplo, uma instrução INSERT). Esta
                       função também retorna <info>false</info>  se a leitura do conjunto de resultados falhou.
                       Você pode verificar se houve um erro verificando se <strong>mysqli_error()</strong> não
                       retorna uma string vazia, se <strong>mysqli_errno()</strong> retorna um valor diferente de
                       zero ou se <strong>mysqli_field_count()</strong> retorna um valor diferente de zero. Além
                       disso, a possível razão para esta função retornar <info>false</info> após uma chamada
                       bem-sucedida para <strong>mysqli_query()</strong> pode ser um conjunto de resultados muito
                       grande (a memória para ele não pode ser alocada). Se <strong>mysqli_field_count()</strong>
                       retornar um valor diferente de zero, a instrução deve ter produzido um
                       conjunto de resultados não vazio.

<comment>See Also:</comment>
   * <strong>mysqli_real_query()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli::thread_safe
type: function
doc:
<comment>Description:</comment>
  Retorna se a segurança de thread é dada ou não
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Informa se a biblioteca cliente é compilada como thread-safe.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> se a biblioteca cliente for thread-safe, caso contrário, <info>false</info>.


id: mysqli::use_result
type: function
doc:
<comment>Description:</comment>
  Iniciar uma recuperação de conjunto de resultados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Usado para iniciar a recuperação de um conjunto de resultados da última consulta executada usando
  a função <strong>mysqli_real_query()</strong> na conexão com o banco de dados.
  
  Esta ou a função <strong>mysqli_store_result()</strong> deve ser chamada antes que os resultados de uma consulta
  possam ser recuperados, e uma ou outra deve ser chamada para evitar que a próxima consulta nessa
  conexão com o banco de dados falhe.
  
  A função <strong>mysqli_use_result()</strong> não transfere todo o conjunto de resultados do banco de dados e,
  portanto, não pode ser usada funções como <strong>mysqli_data_seek()</strong> para mover para uma linha específica
  dentro do conjunto. Para usar esta funcionalidade, o conjunto de resultados deve ser armazenado
  usando <strong>mysqli_store_result()</strong>. Não se deve usar <strong>mysqli_use_result()</strong> se for feito muito
  processamento no lado do cliente, pois isso irá sobrecarregar o servidor e evitar que outras
  threads atualizem quaisquer tabelas das quais os dados estão sendo buscados.

<comment>Return:</comment>
  <info>mysqli_result|false</info>  Retorna um objeto de resultado sem buffer ou <info>false</info> se ocorreu um erro.

<comment>See Also:</comment>
   * <strong>mysqli_real_query()</strong>
   * <strong>mysqli_store_result()</strong>


id: mysqli_affected_rows
type: function
doc:
<comment>Description:</comment>
  Retorna o número de linhas afetadas pela operação MySQL anterior
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de linhas afetadas pelo último comando <return>INSERT</return>, <return>UPDATE</return>, <return>REPLACE</return> ou <return>DELETE</return>.
  Funciona como <strong>mysqli_num_rows()</strong> para consultas <return>SELECT</return>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int|string</info>  Um inteiro maior do que zero indica o número de linhas afetadas ou obtidas. Zero
              indica que nenhum registro foi atualizado por uma declaração <return>UPDATE</return>, nenhuma linha
              correspondeu à claúsula <return>WHERE</return> na consulta ou que nenhuma consulta foi executada ainda.
              <return>-1</return> indica que a consulta retornou um erro ou que <strong>mysqli_affected_rows()</strong> foi chamada
              para uma consulta <return>SELECT</return> sem buffer.
              
              Se o número de linhas afetadas for maior do que o maior valor inteiro (<info>PHP_INT_MAX</info>), o
              número de linhas afetadas será retornado como uma string.

<comment>See Also:</comment>
   * <strong>mysqli_num_rows()</strong>
   * <strong>mysqli_info()</strong>


id: mysqli_connect
type: function
doc:
<comment>Description:</comment>
  Sinônimo de mysqli::__construct
  
  Esta função é um apelido para:  mysqli::__construct
  
  Se o modo de exceção mysqli não estiver habilitado e uma conexão falhar, então <strong>mysqli_connect()</strong>
  retornará <info>false</info> ao invés de um objeto. A função <strong>mysqli_connect_error()</strong> pode ser usada para buscar
  o erro de conexão.


id: mysqli_connect_errno
type: function
doc:
<comment>Description:</comment>
  Retorna o código de erro da última chamada de conexão
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o código de erro da última tentativa de conexão.

<comment>Return:</comment>
  <info>int</info>  Um código de erro para a última tentativa de conexão, se tiver falhado. Zero significa que
       nenhum erro ocorreu.

<comment>See Also:</comment>
   * <strong>mysqli_connect()</strong>
   * <strong>mysqli_connect_error()</strong>
   * <strong>mysqli_errno()</strong>
   * <strong>mysqli_error()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: mysqli_connect_error
type: function
doc:
<comment>Description:</comment>
  Retorna uma descrição do último erro de conexão
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a mensagem de erro da última tentativa de conexão.

<comment>Return:</comment>
  <info>string|null</info>  Uma string que descreve o erro. <info>null</info> é retornado se nenhum erro tiver ocorrido.

<comment>See Also:</comment>
   * <strong>mysqli_connect()</strong>
   * <strong>mysqli_connect_errno()</strong>
   * <strong>mysqli_errno()</strong>
   * <strong>mysqli_error()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: mysqli_data_seek
type: function
doc:
<comment>Description:</comment>
  Ajusta o ponteiro do resultado para uma linha arbritária no resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A função <strong>mysqli_data_seek()</strong> move o ponteiro para uma posição arbritrária especificada pelo
  parâmetro <strong>$offset</strong> no conjunto de resultados.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$offset</strong>  O deslocamento de linha. deve estar entre zero e o número total de linhas
                          menos uma (0..<strong>mysqli_num_rows()</strong> - 1).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_fetch_row()</strong>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_assoc()</strong>
   * <strong>mysqli_fetch_object()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_num_rows()</strong>


id: mysqli_driver
type: class
doc:
<comment>Description:</comment>
  A classe <class>mysqli_driver</class> é uma instância do padrão monostate, ou seja, existe apenas um driver que
  pode ser acessado por meio de uma quantidade arbitrária de instâncias <class>mysqli_driver</class>.


id: mysqli_driver::embedded_server_end
type: function
doc:
<comment>Description:</comment>
  Para o servidor incorporado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: mysqli_driver::embedded_server_start
type: function
doc:
<comment>Description:</comment>
  Inicializa e dispara o servidor incorporado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: mysqli_errno
type: function
doc:
<comment>Description:</comment>
  Retorna o código de erro para a chamada de função mais recente
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o último código de erro para a chamada de função MySQLi mais recente que pode ter sucesso
  ou falhar.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Um valor de código de erro para a última chamada, se ela falhou. Zero significa que nenhum
       erro ocorreu.

<comment>See Also:</comment>
   * <strong>mysqli_connect_errno()</strong>
   * <strong>mysqli_connect_error()</strong>
   * <strong>mysqli_error()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: mysqli_error
type: function
doc:
<comment>Description:</comment>
  Retorna uma string descrevendo o último erro
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a última mensagem de erro da chamada de função MySQLi mais recente que possa ter sucesso
  ou falhar.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string</info>  Uma string que descreve o erro. Uma string vazia se não houve erro.

<comment>See Also:</comment>
   * <strong>mysqli_connect_errno()</strong>
   * <strong>mysqli_connect_error()</strong>
   * <strong>mysqli_errno()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: mysqli_error_list
type: function
doc:
<comment>Description:</comment>
  Retorna uma lista de erros do último comando executado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma matriz de erros para a chamada de função MySQLi mais recente que pode ser bem-sucedida
  ou falhar.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>array</info>  Uma lista de erros, cada um como um <info>array</info> associativo contendo errno, error e sqlstate.

<comment>See Also:</comment>
   * <strong>mysqli_connect_errno()</strong>
   * <strong>mysqli_connect_error()</strong>
   * <strong>mysqli_error()</strong>
   * <strong>mysqli_sqlstate()</strong>


id: mysqli_execute
type: function
doc:
<comment>Description:</comment>
  Sinônimo de mysqli_stmt_execute
  
  Esta função é um apelido para:  <strong>mysqli_stmt_execute()</strong>.

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


id: mysqli_fetch_all
type: function
doc:
<comment>Description:</comment>
  Recebe todas as linhas de resultado como array associativo, numérico, ou ambos
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um array bidimensional com todas as linhas do resultado como um array associativo,
  numérico, ou ambos.
  
  Antes do PHP 8.1.0, disponível somente com mysqlnd.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$mode</strong>    Este parâmetro opcional é uma constante que indica que tipo de array deve
                          ser produzido a partir dos dados da linha atual. Os valores possíveis para
                          este parâmetro são as constantes <info>MYSQLI_ASSOC</info>, <info>MYSQLI_NUM</info> ou <info>MYSQLI_BOTH</info>.

<comment>Return:</comment>
  <info>array</info>  Retorna um array de arrays associativos ou numéricos com as linhas do resultado.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_column()</strong>
   * <strong>mysqli_query()</strong>


id: mysqli_fetch_array
type: function
doc:
<comment>Description:</comment>
  Recebe a próxima linha de resultado como array associativo, numérico, ou ambos
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Recebe uma linha de dados do conjunto de resultados e retorna-a como um array. Cada chamada
  subsequente a esta função retornará a linha seguinte dentro do conjunto de resultados, ou <info>null</info> se
  não houver mais linhas.
  
  Além de armazenar os dados nos índices numéricos do array resultante, esta função também pode
  armazenar os dados em índices associativos usando os nomes dos campos do conjunto de resultados
  como chaves.
  
  Se duas ou mais colunas do resultado tiverem o mesmo nome, a última coluna terá precedência e irá
  sobrescrever os dados anteriores. Para acessar múltiplas colunas com o mesmo nome, deve ser usada
  a versão da linha indexada numericamente.
  
  Os nomes de campos retornados por esta função
  diferenciam maiúsculas e minúsculas.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$mode</strong>    O segundo arqumento é uma constante que indica qual tipo de array deve ser
                          produzido a partir dos dados da linha atual. Os valores possíveis para
                          este parâmetro são as constantes <info>MYSQLI_ASSOC</info>, <info>MYSQLI_NUM</info> ou <info>MYSQLI_BOTH</info>.
                          
                          Ao usar a constante <info>MYSQLI_ASSOC</info>, esta função irá se comportar de modo
                          idêntico à função <strong>mysqli_fetch_assoc()</strong>, enquanyo <info>MYSQLI_NUM</info> irá se
                          comportar de modo idêntico à função <strong>mysqli_fetch_row()</strong>. A opção final
                          <info>MYSQLI_BOTH</info> irá criar um único array com os atributos de ambas.

<comment>Return:</comment>
  <info>array|null|false</info>  Retorna um array que representa a linha recebida, <info>null</info> se não houver mais linhas
                    no resultado,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_assoc()</strong>
   * <strong>mysqli_fetch_column()</strong>
   * <strong>mysqli_fetch_row()</strong>
   * <strong>mysqli_fetch_object()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Obtém a próxima linha do conjunto de resultados como um array associativo
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtém uma linha de dados do conjunto de resultados e retorna-o como um array associativo. Cada
  chamada subsequente desta função retornará a linha seguinte do conjunto de resultados, ou <info>null</info> se
  não houver mais linhas.
  
  Se duas ou mais colunas do resultado tiverem o mesmo nome, a última coluna terá precedência e irá
  sobrescrever qualquer dado anterior. Para acessar múltiplas colunas com o mesmo nome,
  <strong>mysqli_fetch_row()</strong> pode ser usada para obter o array indexado numericamente, ou apelidos podem ser
  usados na lista de seleção da consulta SQL para dar nomes diferentes às colunas.
  
  Os nomes de campos retornados por esta função
  diferenciam maiúsculas e minúsculas.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>array|null|false</info>  Retorna um array associativo que representa a linha obtida, onde cada chave no
                    array representa o nome de uma das colunas do conjunto de resultados; <info>null</info> se
                    não houver mais linhas no conjunto de resultados,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_column()</strong>
   * <strong>mysqli_fetch_row()</strong>
   * <strong>mysqli_fetch_object()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_fetch_column
type: function
doc:
<comment>Description:</comment>
  Recebe uma única coluna da próxima linha de um resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Recebe uma linha de dados do resultado e retorna a coluna indexada a partir de 0. Cada chamada
  subsequente desta função retornará o valor da linha seguinte dentro do conjunto de resultados, ou
  <info>false</info> se não houver mais linhas.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$column</strong>  Número da coluna que se deseja receber da linha, sendo que a primeira é
                          indexada em 0. Se nenhum valor for fornecido, a primeira coluna será
                          retornada.

<comment>Return:</comment>
  <info>null|int|float|string|false</info>  Retorna uma única coluna da próxima linha de um conjunto de
                               resultados ou <info>false</info> se não houver mais linhas.
                               
                               Não há como retornar outra coluna da mesma linha se esta função for
                               usada para obter dados.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_all()</strong>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_assoc()</strong>
   * <strong>mysqli_fetch_object()</strong>
   * <strong>mysqli_fetch_row()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_fetch_field
type: function
doc:
<comment>Description:</comment>
  Retorna o próximo campo no conjunto de resultados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a definição de uma coluna de um conjunto de resultados como um objeto. Utilize esta função
  repetidamente para obter informação sobre todas as colunas no conjunto de resultados.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>object|false</info>  Retorna um objeto que contém informações sobre a definição do campo ou <info>false</info> se
                nenhuma informação de campos estiver disponível.
                
                Propriedades do objetoPropriedadeDescriçãonameO nome da colunaorgnameNome original
                da coluna se foi especificado um apelidotableO nome da tabela à qual este campo
                pertence (se não calculada)orgtableNome da tabela original se foi especificado um
                apelidodefReservado para o valor padrão, atualmente sempre igual a ""dbO nome do
                banco de dadoscatalogO nome do catálogo, sempre igual a "def"max_lengthO tamanho
                máximo do campo para o conjunto de resultados.lengthA largura do campo, como
                especificada na definição da tabela.charsetnrO número do conjunto de caracteres para
                o campo.flagsUm inteiro representando os bits de opções para o campo.typeO tipo de
                dados usado para este campodecimalsO número de decimais usadas (para campos
                inteiros)

<comment>See Also:</comment>
   * <strong>mysqli_num_fields()</strong>
   * <strong>mysqli_fetch_field_direct()</strong>
   * <strong>mysqli_fetch_fields()</strong>
   * <strong>mysqli_field_seek()</strong>


id: mysqli_fetch_field_direct
type: function
doc:
<comment>Description:</comment>
  Recebe metadados para um único campo
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um objeto que contém informação de definição de campo a partir do conjunto de resultados
  especificado.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$index</strong>   O número do campo. Este valor deve estar na faixa de <return>0</return> a <return>número de campos
                          - 1</return>.

<comment>Return:</comment>
  <info>object|false</info>  Retorna um objeto que contém informação de definição de campo ou <info>false</info> se nenhuma
                informação de campo para o valor especificado em <strong>$index</strong> estiver disponível.
                
                Atributos de objetosAtributoDescriçãonameO nome da coluna.orgnameNome original da
                coluna se um apelido foi especificado.tableO nome da tabela à qual este campo
                pertence (se não calculado).orgtableNome original da tabela se um apelido foi
                especificado.defO valor padrão para este campo, representado como uma
                string.max_lengthA largura máxima do campo no resultado. A partir do PHP 8.1, este
                valor é sempre <return>0</return>.lengthA largura do campo, como especificada na definição da
                tabela.charsetnrO número do conjunto de caracteres para o campo.flagsUm inteiro
                representando os bits de opções para o campo.typeO tipo de dados usado para este
                campo.decimalsO número de decimais usadas (para campos numéricos)

<comment>See Also:</comment>
   * <strong>mysqli_num_fields()</strong>
   * <strong>mysqli_fetch_field()</strong>
   * <strong>mysqli_fetch_fields()</strong>


id: mysqli_fetch_fields
type: function
doc:
<comment>Description:</comment>
  Retorna um array de objetos representando os campos em um conjunto de resultados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função serve para o mesmo propósito que a função <strong>mysqli_fetch_field()</strong> com uma simples
  diferença, ao invés de retornar um objeto de cada vez para cada campo, as colunas são retornadas
  como um array de objetos.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna um array de objetos contendo informações de definições de campo.
         
         Propriedades dos objetosPropriedadeDescriçãonameO nome da colunaorgnameO nome original da
         coluna se foi especificado um apelidotableO nome da tabela à qual o campo pertence (se não
         calculado)orgtableNome da tabela original se foi especificado um apelidomax_lengthA largura
         máxima do campo para o conjunto de resultados. A partir do PHP 8.1, este valor é sempre
         <return>0</return>.length A largura do campo, em bytes, como especificada na definição da tabela. Note que
         este número (bytes) pode ser diferente do valor na definição da tabela (caracteres),
         dependendo do conjunto de caracteres sendo utilizado. Por exemplo, o conjunto de caracteres
         utf8 tem 3 bytes por caractere, por isso varchar(10) retornará um comprimento de 30 for
         utf8 (10*3), mas retornará 10 para latin1 (10*1). charsetnrO número (id) do conjunto de
         caracteres do campo.flagsUm inteiro representando bits de opções para o campo.typeO tipo de
         dados usado para este campodecimalsO número de decimais usadas (para campos inteiros)

<comment>See Also:</comment>
   * <strong>mysqli_num_fields()</strong>
   * <strong>mysqli_fetch_field_direct()</strong>
   * <strong>mysqli_fetch_field()</strong>


id: mysqli_fetch_lengths
type: function
doc:
<comment>Description:</comment>
  Retorna os comprimentos das colunas da linha atual do resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A função <strong>mysqli_fetch_lengths()</strong> retorna um array que contém os comprimentos de cada coluna da
  linha atual dentro do conjunto de resultados.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Um array de números inteiros que representam o tamanho de cada coluna (não incluindo
               caracteres nulos de terminação). <info>false</info> se ocorrer um erro.
               
               <strong>mysqli_fetch_lengths()</strong> é válida apenas para a linha atual do resultado. Retorna <info>false</info>
               se for chamada antes de se chamar mysqli_fetch_row, mysqli_fetch_array,
               mysqli_fetch_object ou após ter recebido todas as linhas do resultado.


id: mysqli_fetch_object
type: function
doc:
<comment>Description:</comment>
  Recebe a próxima linha de um resultado como um objeto
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Recebe uma linha de dados do resultado e retorna-a como um objeto, onde cada propriedade
  representa o nome da coluna do resultado. Cada chamada subsequente a esta função retornará a linha
  seguinte dentro do conjunto de resultados, ou <info>null</info> se não houver mais linhas.
  
  Se duas ou mais colunas do resultado tiverem o mesmo nome, a última coluna terá precedência e irá
  sobrescrever os dados anteriores. Para acessar múltiplas colunas com o mesmo nome,
  <strong>mysqli_fetch_row()</strong> pode ser usada para receber o array indexado numericamente, ou apelidos podem
  ser usados na lista de seleção da consulta SQL para dar nomes diferentes às colunas.
  
  Esta função define as propriedades do objeto antes de chamar o construtor do objeto.
  
  Os nomes de campos retornados por esta função
  diferenciam maiúsculas e minúsculas.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>            Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                                    retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                                    <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>string</info>         <strong>$class</strong>             O nome da classe a instanciar, definir propriedades e retornar.
                                    Se não especificada, um objeto <class>stdClass</class> é retornado.
  <info>array</info>          <strong>$constructor_args</strong>  Um <info>array</info> opcional de parâmetros para passar ao construtor de
                                    objetos da classe definida em <strong>$class</strong>.

<comment>Return:</comment>
  <info>object|null|false</info>  Retorna um objeto que representa a linha recebida, onde cada propriedade
                     representa o nome da coluna do resultado, <info>null</info> se não houver mais colunas no
                     resultado,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_assoc()</strong>
   * <strong>mysqli_fetch_column()</strong>
   * <strong>mysqli_fetch_row()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_fetch_row
type: function
doc:
<comment>Description:</comment>
  Obtém a próxima linha de um resultado como um array enumerado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtém uma linha de dados do conjunto de resultado e retorna-o como um array enumerado, onde cada
  coluna é armazenada em um deslocamento do array iniciando de 0 (zero). Cada chamada subsequente a
  esta função retornará a próxima linha no conjunto de resultados, ou <info>null</info> se não houver mais
  linhas.
  
  Esta função define campos NULL como o
  valor <info>null</info> do PHP.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>array|null|false</info>  Retorna um array representando a linha obtida, <info>null</info> se não houver mais linhas no
                    conjunto de resultados,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_fetch_assoc()</strong>
   * <strong>mysqli_fetch_column()</strong>
   * <strong>mysqli_fetch_object()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_field_count
type: function
doc:
<comment>Description:</comment>
  Retorna o número de campos para a consulta mais recente
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de campos para a consulta mais recente na conexão representada pelo parâmetro
  <strong>$mysql</strong>. Esta função pode ser útil quando a função <strong>mysqli_store_result()</strong> é usada para determinar se
  a consulta deveria ou não ter produzido um conjunto não vazio de resultados sem conhecer a
  natureza da consulta.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Um inteiro representando o número de campos em um conjunto de resultados.


id: mysqli_field_seek
type: function
doc:
<comment>Description:</comment>
  Move o ponteiro do resultado para um campo especificado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Define o cursor de campo para o índice especificado. A próxima chamada a <strong>mysqli_fetch_field()</strong>
  retornará a definição de campo da coluna associada com este índice.
  
  Para mover o ponteiro para o início de uma linha, passe um índice de valor zero.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.
  <info>int</info>            <strong>$index</strong>   O número do campo. Este valor precisa estar num intervalo de <return>0</return> a <return>número de
                          campos - 1</return>.

<comment>Return:</comment>
  <info>bool</info>  Sempre retorna <info>true</info>.

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


id: mysqli_field_tell
type: function
doc:
<comment>Description:</comment>
  Obtém o deslocamento atual de campo de um ponteiro de resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a posição do cursor de campo usado na última chamada a <strong>mysqli_fetch_field()</strong>. Este valor
  pode ser usado como um argumento para <strong>mysqli_field_seek()</strong>.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna o deslocamento atual do cursor de campos.

<comment>See Also:</comment>
   * <strong>mysqli_fetch_field()</strong>
   * <strong>mysqli_field_seek()</strong>


id: mysqli_free_result
type: function
doc:
<comment>Description:</comment>
  Libera memória associada a um resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Libera a memória associada ao resultado.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_stmt_get_result()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli_get_client_stats
type: function
doc:
<comment>Description:</comment>
  Retorna as estatísticas do cliente por processo
  
  Retorna as estatísticas do cliente por processo.
  
  Disponível apenas com o mysqlnd.

<comment>Return:</comment>
  <info>array</info>  Retorna uma matriz com estatísticas do cliente.

<comment>See Also:</comment>
   * Descrição das estatísticas


id: mysqli_get_client_version
type: function
doc:
<comment>Description:</comment>
  Retorna a versão do cliente MySQL como um inteiro
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna a versão do cliente como um inteiro.

<comment>Return:</comment>
  <info>int</info>  Um número que representa a versão da biblioteca de cliente MySQL no formato:
       <return>versão_principal*10000 + versão_menor *100 + sub_versão</return>. Por exemplo, 4.1.0 é retornado como
       40100.
       
       Isto é útil para determinar rapidamente a versão da biblioteca de cliente para saber se
       alguma funcionalidade existe.

<comment>See Also:</comment>
   * <strong>mysqli_get_client_info()</strong>
   * <strong>mysqli_get_server_info()</strong>
   * <strong>mysqli_get_server_version()</strong>


id: mysqli_get_host_info
type: function
doc:
<comment>Description:</comment>
  Retorna uma string representando o tipo de conexão utilizada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string descrevendo a conexão representada pelo parâmetro <strong>$mysql</strong> (incluindo o nome de
  host servidor).

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string</info>  Uma string de caracteres representando o nome de host do servidor e o tipo de conexão.

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


id: mysqli_get_links_stats
type: function
doc:
<comment>Description:</comment>
  Retorna informações sobre links abertos e em cache
  
  <strong>mysqli_get_links_stats()</strong> retorna informações sobre links MySQL abertos e em cache.

<comment>Return:</comment>
  <info>array</info>  <strong>mysqli_get_links_stats()</strong> retorna um array associativo com três elementos, digitados da
         seguinte forma: <strong>$total</strong> Um <info>int</info> que indica o número total de links abertos em qualquer
         estado. <strong>$active_plinks</strong> Um <info>int</info>  representando o número de conexões persistentes ativas.
         <strong>$cached_plinks</strong> Um <info>int</info> representando o número de conexões persistentes inativas.
         
         Um <info>int</info> que indica o número total de links abertos em qualquer estado.
         
         Um <info>int</info>  representando o número de conexões persistentes ativas.
         
         Um <info>int</info> representando o número de conexões persistentes inativas.


id: mysqli_get_proto_info
type: function
doc:
<comment>Description:</comment>
  Retorna a versão do protocolo MySQL usada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um inteiro representando a versão do protocolo MySQL usada pela conexão representada pelo
  parâmetro <strong>$mysql</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro representando a versão do protocolo.

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


id: mysqli_get_server_version
type: function
doc:
<comment>Description:</comment>
  Retorna a versão do servidor MySQL como um inteiro
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A função <strong>mysqli_get_server_version()</strong> retorna a versão do servidor ao qual se está conectado
  (representado pelo parâmetro <strong>$mysql</strong>) como um inteiro.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int</info>  Um inteiro representando a versão do servidor.
       
       A forma deste número de versão é <return>versão_principal * 10000 + versão_menor * 100 + sub_versão</return>
       (ex. a versão 4.1.0 é 40100).

<comment>See Also:</comment>
   * <strong>mysqli_get_client_info()</strong>
   * <strong>mysqli_get_client_version()</strong>
   * <strong>mysqli_get_server_info()</strong>


id: mysqli_info
type: function
doc:
<comment>Description:</comment>
  Recupera informação sobre a recente consulta executada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  A função <strong>mysqli_info()</strong> retorna uma string contendo informação sobre a última consulta executada. A
  natureza desta string é fornecida abaixo:
  
  Possíveis valores de retorno de mysqli_infoTipo de consultaExemplo da string de resultadoINSERT
  INTO...SELECT...Records: 100 Duplicates: 0 Warnings: 0INSERT INTO...VALUES
  (...),(...),(...)Records: 3 Duplicates: 0 Warnings: 0LOAD DATA INFILE ...Records: 1 Deleted: 0
  Skipped: 0 Warnings: 0ALTER TABLE ...Records: 3 Duplicates: 0 Warnings: 0UPDATE ...Rows matched:
  40 Changed: 40 Warnings: 0
  
  Consultas que não se encaixam em um dos formatos acima não são suportadas. Nesta situação,
  <strong>mysqli_info()</strong> irá retornar uma string vazia.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string|null</info>  Uma string de caracteres representando informação adicional sobre a mais recente
               consulta executada.

<comment>See Also:</comment>
   * <strong>mysqli_affected_rows()</strong>
   * <strong>mysqli_warning_count()</strong>
   * <strong>mysqli_num_rows()</strong>


id: mysqli_insert_id
type: function
doc:
<comment>Description:</comment>
  Retorna o valor gerado para uma coluna AUTO_INCREMENT pela última consulta
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o ID gerado por uma consulta <return>INSERT</return> ou <return>UPDATE</return> em uma tabela que tenha o atributo
  <return>AUTO_INCREMENT</return>. No caso de uma declaração <return>INSERT</return> de múltiplas linhas, ela retorna o primeiro valor
  gerado automaticamente que foi inserido com sucesso.
  
  Realizar uma declaração <return>INSERT</return> ou <return>UPDATE</return> usando a função MYSQL <return>LAST_INSERT_ID()</return> também irá
  modificar o valor retornado por <strong>mysqli_insert_id()</strong>. Se <return>LAST_INSERT_ID(expr)</return> foi usado para gerar o
  valor de <return>AUTO_INCREMENT</return>, ela retorna o valor da última <return>expr</return> no lugar do valor <return>AUTO_INCREMENT</return>
  gerado.
  
  Retorna <return>0</return> se a declaração anterior não modificou um valor <return>AUTO_INCREMENT</return>. <strong>mysqli_insert_id()</strong> deve
  ser chamada imediatamente após a declaração que gerou o valor.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>int|string</info>  O valor do campo <return>AUTO_INCREMENT</return> que foi atualizado pela consulta anterior. Retorna
              zero se não houve consulta anterior na conexão ou se a consulta não atualizou um valor
              <return>AUTO_INCREMENT</return>.
              
              Apenas declarações emitidas com a conexão atual afetam o valor de retorno. O valor não
              é afetado por declarações emitidas usando outras conexões ou clientes.
              
              Se o número é maior que o máximo valor de um inteiro, ele será retornado como uma
              string.


id: mysqli_num_fields
type: function
doc:
<comment>Description:</comment>
  Obtém o número de campos no conjunto de resultados
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtém o número de campos no conjunto de resultados.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>int</info>  Um valor do tipo <info>int</info> que representa o número de campos.

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


id: mysqli_num_rows
type: function
doc:
<comment>Description:</comment>
  Obtém o número de linhas no resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de linhas no resultado.
  
  O comportamento de <strong>mysqli_num_rows()</strong> depende se estão sendo usados resultados com buffer ou sem
  buffer. A função retorna <return>0</return> para resultado sem buffer a menos que todas as linhas já tiverem sido
  recebidas do servidor.

<comment>Param:</comment>
  <info>mysqli_result</info>  <strong>$result</strong>  Somente no estilo procedural: Um objeto <class>mysqli_result</class>
                          retornado por <strong>mysqli_query()</strong>, <strong>mysqli_store_result()</strong>,
                          <strong>mysqli_use_result()</strong> ou <strong>mysqli_stmt_get_result()</strong>.

<comment>Return:</comment>
  <info>int|string</info>  Um <info>int</info> que representa o número de linhas recebidas. Retorna <return>0</return> em modo sem buffer a
              menos que todas as linhas tenham sido recebidas do servidor.
              
              Se o número de linhas for maior que <info>PHP_INT_MAX</info>,
              o número será retornado como uma <info>string</info>.

<comment>See Also:</comment>
   * <strong>mysqli_affected_rows()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>
   * <strong>mysqli_query()</strong>
   * <strong>mysqli_stmt_num_rows()</strong>


id: mysqli_report
type: function
doc:
<comment>Description:</comment>
  Sinônimo de mysqli_driver->report_mode
  
  Esta função é um apelido para:  mysqli_driver-&gt;report_mode


id: mysqli_result
type: class
doc:
<comment>Description:</comment>
  Representa o conjunto de resultados da consulta feita ao banco de dados.


id: mysqli_result::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um objeto mysqli_result
  
  Este método constrói um novo objeto <class>mysqli_result</class>.
  
  Pode ser usado para criar o objeto <class>mysqli_result</class> após a chamada à função <strong>mysqli_real_query()</strong> ou
  <strong>mysqli_multi_query()</strong>. Construir o objeto manualmente é equivalente a chamar a função
  <strong>mysqli_store_result()</strong> ou <strong>mysqli_use_result()</strong>.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>        Somente no estilo procedural: Um objeto <class>mysqli</class>
                        retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>
  <info>int</info>     <strong>$result_mode</strong>  O modo de resultado pode ser uma de 2 constantes que indicam como o
                        resultado será retornado do servidor MySQL.
                        
                        <info>MYSQLI_STORE_RESULT</info> (padrão) - cria um objeto <class>mysqli_result</class> com resultado em
                        buffer.
                        
                        <info>MYSQLI_USE_RESULT</info> - cria um objeto<class>mysqli_result</class> com resultado sem buffer.
                        Enquanto houver registros pendentes esperando ser recebidos, a linha de
                        conexão estará ocupada e todas as chamadas subsequentes retornarão o erro
                        <return>Commands out of sync</return> (comandos fora de sincronismo). Para evitar o erro,
                        todos os registros devem ser recebidos do servidor ou o resultado deve ser
                        descartado através da função <strong>mysqli_free_result()</strong>. A conexão precisa
                        permanecer aberta para que as linhas sejam recebidas.

<comment>See Also:</comment>
   * <strong>mysqli_multi_query()</strong>
   * <strong>mysqli_real_query()</strong>
   * <strong>mysqli_store_result()</strong>
   * <strong>mysqli_use_result()</strong>


id: mysqli_result::getIterator
type: function
doc:
<comment>Description:</comment>
  Obtém um iterador externo
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>Iterator</info>  


id: mysqli_sql_exception::getSqlState
type: function
doc:
<comment>Description:</comment>
  Retorna o código de erro SQLSTATE
  
  Retorna uma string contendo o código de erro SQLSTATE para o último erro. O código de erro
  consiste em cinco caracteres. Os valores são especificados por ANSI SQL e ODBC. Para obter uma
  lista de valores possíveis, consulte http://dev.mysql.com/doc/mysql/en/error-handling.html.
  
  Observe que nem todos os erros do MySQL ainda estão mapeados para SQLSTATE. O valor <return>HY000</return> (erro
  geral) é usado para erros não mapeados.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string contendo o código de erro SQLSTATE para o último erro. O código de erro
          consiste em cinco caracteres.


id: mysqli_sqlstate
type: function
doc:
<comment>Description:</comment>
  Retorna o erro SQLSTATE da operação MySQL anterior
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string contendo o código de erro SQLSTATE para o último erro. O código de erro
  consiste em cinco caracteres. <return>'00000'</return> significa nenhum erro. Os valores são especificados por ANSI
  SQL e ODBC. Para obter uma lista de valores possíveis, consulte
  http://dev.mysql.com/doc/mysql/en/error-handling.html.
  
  Observe que nem todos os erros do MySQL ainda estão mapeados para SQLSTATE. O valor <return>HY000</return> (erro
  geral) é usado para erros não mapeados.

<comment>Param:</comment>
  <info>mysqli</info>  <strong>$mysql</strong>  Somente no estilo procedural: Um objeto <class>mysqli</class>
                  retornado por <strong>mysqli_connect()</strong> ou <strong>mysqli_init()</strong>

<comment>Return:</comment>
  <info>string</info>  Retorna uma string contendo o código de erro SQLSTATE para o último erro. O código de erro
          consiste em cinco caracteres. <return>'00000'</return> significa nenhum erro.

<comment>See Also:</comment>
   * <strong>mysqli_errno()</strong>
   * <strong>mysqli_error()</strong>


id: mysqli_stmt::__construct
type: function
doc:
<comment>Description:</comment>
  Constrói um novo objeto mysqli_stmt
  
  Este método constrói um novo objeto <class>mysqli_stmt</class>.

<comment>Param:</comment>
  <info></info>             <strong>$link</strong>   Om objeto <class>mysqli</class> válido.
  <info>string|null</info>  <strong>$query</strong>  A consulta, como uma string. Se este parâmetro for <info>null</info>, o construtor se
                       comporta de forma idêntica a <strong>mysqli_stmt_init()</strong>, caso contrário se comporta
                       como <strong>mysqli_prepare()</strong>.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_init()</strong>


id: mysqli_stmt::attr_get
type: function
doc:
<comment>Description:</comment>
  Usado para obter o valor atual de um atributo de instrução
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Obtém o valor atual de um atributo de instrução.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>int</info>          <strong>$attribute</strong>  O atributo que se deseja obter.

<comment>Return:</comment>
  <info>int</info>  Retorna o valor do atributo.


id: mysqli_stmt::attr_set
type: function
doc:
<comment>Description:</comment>
  Usado para modificar o comportamento de uma instrução preparada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Usada para modificar o comportamento de uma instrução preparada. Esta função pode ser chamada
  múltiplas vezes para definir vários atributos.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>int</info>          <strong>$attribute</strong>  O atributo que se deseja definir. Pode ser um dos seguintes valores:
                           Valores de atributosCaractereDescriçãoMYSQLI_STMT_ATTR_UPDATE_MAX_LENGTH
                           Definir para <info>true</info> faz com que <strong>mysqli_stmt_store_result()</strong> atualize o valor
                           do metadado <return>MYSQL_FIELD-&gt;max_length</return>. MYSQLI_STMT_ATTR_CURSOR_TYPE Tipo
                           de cursor a ser aberto para a instrução quando <strong>mysqli_stmt_execute()</strong> for
                           chamada. <strong>$value</strong> pode ser <return>MYSQLI_CURSOR_TYPE_NO_CURSOR</return> (o padrão) ou
                           <return>MYSQLI_CURSOR_TYPE_READ_ONLY</return>. MYSQLI_STMT_ATTR_PREFETCH_ROWS Número de
                           linhas a receber do servidor de cada vez ao usar um cursor. <strong>$value</strong> pode
                           estar na faixa de 1 até o máximo valor de um inteiro longo sem sinal. O
                           padrão é 1.
                           
                           Se a opção <return>MYSQLI_STMT_ATTR_CURSOR_TYPE</return> for usada com
                           <return>MYSQLI_CURSOR_TYPE_READ_ONLY</return>, um cursor é aberto para a instrução quando
                           <strong>mysqli_stmt_execute()</strong> é chamada. Se já houver um cursor aberto de uma
                           chamada anterior de <strong>mysqli_stmt_execute()</strong>, o cursor é fechado antes que
                           um novo seja aberto. <strong>mysqli_stmt_reset()</strong> também fecha qualquer cursor
                           aberto antes de preparar a instrução para re-execução.
                           <strong>mysqli_stmt_free_result()</strong> fecha qualquer cursor aberto.
                           
                           Se for aberto um cursor para uma instrução preparada, a função
                           <strong>mysqli_stmt_store_result()</strong> é desnecessária.
  <info>int</info>          <strong>$value</strong>      O valor a designar para o atributo.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * Conector/MySQL mysql_stmt_attr_set()


id: mysqli_stmt::bind_param
type: function
doc:
<comment>Description:</comment>
  Liga variáveis a uma declaração preparada como parâmetros
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Liga variáveis para os marcadores de parâmetros na declaração SQL preparada por <strong>mysqli_prepare()</strong>
  ou <strong>mysqli_stmt_prepare()</strong>.
  
  Se o tamanho de dados de um variável exceder o tamanho de pacote máximo permitido
  (max_allowed_packet), deve-se especificar <return>b</return> em <strong>$types</strong> e usar <strong>mysqli_stmt_send_long_data()</strong> para
  enviar os dados em pacotes.
  
  Deve-se ter cuidado ao usar <strong>mysqli_stmt_bind_param()</strong> em conjunto com <strong>call_user_func_array()</strong>. Note
  que <strong>mysqli_stmt_bind_param()</strong> requer que os parâmetros sejam passados por referência, enquanto que
  <strong>call_user_func_array()</strong> pode aceitar como parâmetro uma lista de variáveis que podem representar
  referências ou valores.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>string</info>       <strong>$types</strong>      Uma string que contém um ou mais caracteres que especificam os tipos para
                           as variáveis correspondentes ligadas: Caracteres de especificação de
                           tipoCaractereDescriçãoivariável correspondente tem tipo <info>int</info>dvariável
                           correspondente tem tipo <info>float</info>svariável correspondente tem tipo
                           <info>string</info>bvariável correspondente é um blob e será enviada em pacotes
  <info>mixed</info>        <strong>$var</strong>        O número de variáveis e o comprimento da string que o parâmetro <strong>$types</strong>
                           deve corresponder aos parâmetros na declaração.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_bind_result()</strong>
   * <strong>mysqli_stmt_execute()</strong>
   * <strong>mysqli_stmt_fetch()</strong>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_send_long_data()</strong>
   * <strong>mysqli_stmt_errno()</strong>
   * <strong>mysqli_stmt_error()</strong>


id: mysqli_stmt::bind_result
type: function
doc:
<comment>Description:</comment>
  Liga variáveis a uma declaração preparada para armazenamento de resultado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Liga colunas no conjunto de resultados a variáveis.
  
  Quando <strong>mysqli_stmt_fetch()</strong> é chamada para obter dados, o protocolo cliente/servidor MySQL coloca
  os dados das colunas ligadas nas variáveis expecificadas <strong>$var</strong>/<strong>$vars</strong>.
  
  Uma coluna pode ser ligada ou religada a qualquer tempo, mesmo depois que um conjunto de
  resultados tenha sido parcialmente recebido. A nova ligação tem efeito na próxima vez que
  <strong>mysqli_stmt_fetch()</strong> for chamada.
  
  Todas as colunas precisam ser ligadas depois da chamada a <strong>mysqli_stmt_execute()</strong> e antes da chamada
  a <strong>mysqli_stmt_fetch()</strong>.
  
  Dependendo dos tipos das colunas, variáveis ligadas podem silenciosamente ser alteradas para O
  tipo PHP correspondente.
  
  Esta função é útil para resultados simples. Para receber conjuntos de resultados iteráveis, ou
  obter cada linha como um array ou objeto, use a função <strong>mysqli_stmt_get_result()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>mixed</info>        <strong>$var</strong>        A primeira variável a ser ligada.
  <info>mixed</info>        <strong>$vars</strong>       Mais variáveis a serem ligadas.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_get_result()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>
   * <strong>mysqli_stmt_execute()</strong>
   * <strong>mysqli_stmt_fetch()</strong>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_prepare()</strong>


id: mysqli_stmt::close
type: function
doc:
<comment>Description:</comment>
  Fecha uma instrução preparada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Fecha uma instrução preparada. <strong>mysqli_stmt_close()</strong> também desaloca da memória o manipulador da
  instrução. Se a instrução atual tem resultados pendentes ou não lidos, esta função as cancela de
  forma que a próxima consulta possa ser executada.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>true</info>  Sempre retorna <info>true</info>.

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


id: mysqli_stmt::data_seek
type: function
doc:
<comment>Description:</comment>
  Ajusta o ponteiro de resultado para uma linha arbitrária no resultado com buffer
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função move o ponteiro do conjunto de resultados com buffer para uma linha arbitrária
  especificada pelo parâmetro <strong>$offset</strong>.
  
  Esta função funciona somente com o conjunto de resultados interno com buffer.
  <strong>mysqli_stmt_store_result()</strong> precisa ser chamada antes de <strong>mysqli_stmt_data_seek()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>int</info>          <strong>$offset</strong>     Precisa ser entre zero e o número total de linhas menos um (0..
                           <strong>mysqli_stmt_num_rows()</strong> - 1).

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_store_result()</strong>
   * <strong>mysqli_stmt_num_rows()</strong>
   * <strong>mysqli_data_seek()</strong>


id: mysqli_stmt::execute
type: function
doc:
<comment>Description:</comment>
  Executa uma instrução preparada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Executa uma instrução previamente preparada. A instrução precisa ser preparada com sucesso antes
  da execução, usando a função <strong>mysqli_prepare()</strong> ou a função <strong>mysqli_stmt_prepare()</strong>, ou ainda passando
  o segundo argumento para o método mysqli_stmt::__construct.
  
  Se a instrução for <return>UPDATE</return>, <return>DELETE</return> ou <return>INSERT</return>, o número total de linhas afetadas pode ser
  determinado usando-se a função <strong>mysqli_stmt_affected_rows()</strong>. Se a consulta retorna um resultado,
  ele pode ser recebido pela função <strong>mysqli_stmt_get_result()</strong> ou linha por linha diretamente da
  instrução usando a função <strong>mysqli_stmt_fetch()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>array|null</info>   <strong>$params</strong>     Um <info>array</info> opcional listando tantos elementos quantos forem os parâmetros
                           vinculados na instrução SQL sendo executada. Cada valor é tratado como
                           uma <info>string</info>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_execute_query()</strong>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>
   * <strong>mysqli_stmt_get_result()</strong>


id: mysqli_stmt::fetch
type: function
doc:
<comment>Description:</comment>
  Recebe resultados de uma instrução preparada nas variáveis vinculadas
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Recebe o resultado de uma instrução preparada nas variáveis vinculadas por
  <strong>mysqli_stmt_bind_result()</strong>.
  
  Observe que todas as colunas precisam estar vinculadas pela aplicação antes de chamar a função
  <strong>mysqli_stmt_fetch()</strong>.
  
  Os dados são transferidos sem buffer quando não se chama a função <strong>mysqli_stmt_store_result()</strong>, o
  que pode reduzir o desempenho (mas reduz o consumo de memória).

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

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

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_errno()</strong>
   * <strong>mysqli_stmt_error()</strong>
   * <strong>mysqli_stmt_bind_result()</strong>


id: mysqli_stmt::free_result
type: function
doc:
<comment>Description:</comment>
  Libera memória do resultado armazenado para o manipulador de instrução informado
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Libera a memória do resultado associado à instrução, que foi alocada por
  <strong>mysqli_stmt_store_result()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: mysqli_stmt::get_result
type: function
doc:
<comment>Description:</comment>
  Obtém um resultado de uma instrução preparada como um objeto mysqli_result
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Recebe um resultado de uma instrução preparada como um objeto <class>mysqli_result</class>. Os dados serão
  transportados do servidor MySQL para o PHP. Este método deve ser chamado somente para consultas
  que produzem um conjunto de resultados.
  
  Disponível apenas com o mysqlnd.
  
  Esta função não pode ser usada junto com a função <strong>mysqli_stmt_store_result()</strong>. Ambas estas funções
  recebem o conjunto completo de resultados do servidor MySQL.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>mysqli_result|false</info>  Retorna <info>false</info> em caso de falha. Para consultas bem sucedidas que produzem um
                       resultado, como <return>SELECT, SHOW, DESCRIBE</return> ou <return>EXPLAIN</return>, <strong>mysqli_stmt_get_result()</strong>
                       retornará um objeto <class>mysqli_result</class>. Para outras consultas bem sucedidas,
                       <strong>mysqli_stmt_get_result()</strong> retornará <info>false</info>. A função <strong>mysqli_stmt_errno()</strong> pode
                       ser usada para distinguir entre os dois motivos para <info>false</info>; devido a um
                       problema de software, antes do PHP 7.4.13, <strong>mysqli_errno()</strong> tinha de ser usada
                       para este propósito.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_result_metadata()</strong>
   * <strong>mysqli_stmt_fetch()</strong>
   * <strong>mysqli_fetch_array()</strong>
   * <strong>mysqli_stmt_store_result()</strong>


id: mysqli_stmt::more_results
type: function
doc:
<comment>Description:</comment>
  Verifica se há mais resultados de uma consulta múltipla
  
  Estilo orientado a objetos
  
  Estilo procedural:
  
  Verifica se há mais resultados de uma consulta múltipla.
  
  Disponível apenas com o mysqlnd.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se houver mais resultados, caso contrário retorna <info>false</info>.

<comment>See Also:</comment>
   * mysqli_stmt::next_result
   * mysqli::multi_query


id: mysqli_stmt::next_result
type: function
doc:
<comment>Description:</comment>
  Lê o próximo resultado de uma consulta múltipla
  
  Estilo orientado a objetos
  
  Estilo procedural:
  
  Lê o próximo resultado de uma consulta múltipla.
  
  Antes do PHP 8.1.0, disponível somente com mysqlnd.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * mysqli_stmt::more_results
   * mysqli::multi_query


id: mysqli_stmt::num_rows
type: function
doc:
<comment>Description:</comment>
  Retorna o número de linhas recebidas pelo servidor
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de linhas em buffer na instrução. Esta função somente funcionará depois que
  <strong>mysqli_stmt_store_result()</strong> for chamara para fazer buffer do conjunto inteiro de resultados no
  manipulador da instrução.
  
  Esta função retorna <return>0</return> a menos que todas as linhas tenham sido recebidas do servidor.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>int|string</info>  Um <info>int</info> que representa o número de linhas em buffer. Retorna <return>0</return> em modo sem buffer a
              menos que todas as linhas tenham sido recebidas do servidor.
              
              Se o número de linhas for maior que <info>PHP_INT_MAX</info>,
              o número será retornado como uma <info>string</info>.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_store_result()</strong>
   * <strong>mysqli_stmt_affected_rows()</strong>
   * <strong>mysqli_prepare()</strong>


id: mysqli_stmt::prepare
type: function
doc:
<comment>Description:</comment>
  Prepara uma declaração SQL para execução
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Prepara uma declaração para execução. A consulta deve consistir de uma única declaração SQL.
  
  O modelo de declaração pode conter zero ou mais marcadores de parâmetro que são os pontos de
  interrogação (<return>?</return>), também chamados de espaços reservados. Os marcadores de parâmetros devem ser
  ligados às variáveis da aplicação usando <strong>mysqli_stmt_bind_param()</strong> antes da execução da declaração.
  
  No caso de uma declaração passada a <strong>mysqli_stmt_prepare()</strong> ser mais longa que o parâmetro
  <return>max_allowed_packet</return> do servidor, os códigos de erro retornados serão diferentes dependendo se está
  sendo utilizando o driver nativo MySQL (<return>mysqlnd</return>) ou a biblioteca cliente do MySQL
  (<return>libmysqlclient</return>). O comportamento é o seguinte:
  
  <return>mysqlnd</return> no Linux retorna o código de erro 1153. A mensagem de erro diz got a packet bigger than
  (recebido pacote maior que) <return>max_allowed_packet</return> bytes.
  
  <return>mysqlnd</return> no Windos retorna o código de erro 2006. Esta mensagem de erro diz server has gone away
  (servidor se foi).
  
  <return>libmysqlclient</return> em todas as plataformas a retorna o código de erro 2006. Esta mensagem de erro diz
  server has gone away (servidor se foi).

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>string</info>       <strong>$query</strong>      A consulta, como uma string. Deve consistir de uma única declaração SQL.
                           
                           A declaração SQL pode conter zero ou mais marcadores de parâmetros
                           representados por caracteres de ponto de interrogação (<return>?</return>) nas posições
                           apropriadas.
                           
                           Os marcadores são permitidos somente em alguns lugares das declarações
                           SQL. Por exemplo, eles são permitidos na lista <return>VALUES()</return> de Uma declaração
                           <return>INSERT</return> (para especificar valores de colunas para uma linha), ou em uma
                           comparação com uma coluna em uma cláusula <return>WHERE</return> para especificar um valor
                           de comparação. Entretanto, não são permitidos para identificadores (como
                           tabelas ou nomes de colunas).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_init()</strong>
   * <strong>mysqli_stmt_execute()</strong>
   * <strong>mysqli_stmt_fetch()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>
   * <strong>mysqli_stmt_bind_result()</strong>
   * <strong>mysqli_stmt_get_result()</strong>
   * <strong>mysqli_stmt_close()</strong>


id: mysqli_stmt::reset
type: function
doc:
<comment>Description:</comment>
  Redefine uma instrução preparada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Redefine uma instrução preparada no cliente e no servidor para um estado pós-preparação.
  
  A função redefine a instrução no servidor, os dados enviados por <strong>mysqli_stmt_send_long_data()</strong>, os
  resultados sem buffer e os erros atuais. Ela não limpa vinculações de variáveis ou resultados
  armazenados. Resultados armazenados serão limpos ao executar a instrução preparada (ou ao
  fechá-la).
  
  Para preparar uma instrução com outra consulta, utilize a função <strong>mysqli_stmt_prepare()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: mysqli_stmt::result_metadata
type: function
doc:
<comment>Description:</comment>
  Retorna os metadados de resultado de uma instrução preparada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Se uma instrução passada a <strong>mysqli_prepare()</strong> for do tipo que produz um conjunto de resultados,
  <strong>mysqli_stmt_result_metadata()</strong> retornará o objeto de resultado que pode ser usado para processar a
  meta informação como o número total de campos e informações individual dos campos.
  
  Este ponteiro de conjunto de resultados pode ser passado como argumento para qualquer das funções
  baseadas em campo que processam metadados de resultados, como:
  <strong>mysqli_num_fields()</strong><strong>mysqli_fetch_field()</strong><strong>mysqli_fetch_field_direct()</strong><strong>mysqli_fetch_fields()</strong><strong>mysqli_field_count()</strong><strong>mysqli_field_seek()</strong><strong>mysqli_field_tell()</strong><strong>mysqli_free_result()</strong>
  
  <strong>mysqli_num_fields()</strong>
  
  <strong>mysqli_fetch_field()</strong>
  
  <strong>mysqli_fetch_field_direct()</strong>
  
  <strong>mysqli_fetch_fields()</strong>
  
  <strong>mysqli_field_count()</strong>
  
  <strong>mysqli_field_seek()</strong>
  
  <strong>mysqli_field_tell()</strong>
  
  <strong>mysqli_free_result()</strong>
  
  A estrutura do resultado deve ser liberada da memória quando seu uso tiver sido concluído, o que
  pode ser feito passando-a para a função <strong>mysqli_free_result()</strong>
  
  O resultado retornado por <strong>mysqli_stmt_result_metadata()</strong> contém somente metadados. Não contém
  nenhum resultado de registros do banco. Os registros são obtidos usando-se o manipulador da
  instrução com a função <strong>mysqli_stmt_fetch()</strong>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>mysqli_result|false</info>  Retorna um objeto de resultado ou <info>false</info> se um erro ocorrer.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_free_result()</strong>


id: mysqli_stmt::send_long_data
type: function
doc:
<comment>Description:</comment>
  Envia dados em blocos
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Permite enviar dados de parâmetros ao servidor em pedaços (ou blocos), por exemplo, se o tamanho
  de um BLOB exceder o tamanho de <return>max_allowed_packet</return>. Esta função pode ser chamada múltiplas vezes
  para enviar as partes de um valor de dados binários ou de caracteres para uma coluna, que precisa
  ser do tipo TEXT ou BLOB.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.
  <info>int</info>          <strong>$param_num</strong>  Indica a qual parâmetro os dados serão associados. Parêmetros são
                           numerados a partir de 0.
  <info>string</info>       <strong>$data</strong>       Uma string contendo os dados que devem ser enviados.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_bind_param()</strong>


id: mysqli_stmt::store_result
type: function
doc:
<comment>Description:</comment>
  Armazena um conjunto de resultados em um buffer interno
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Esta função deve ser chamada, para consultas que produzem com sucesso um conjunto de resultados
  (ex.: <return>SELECT, SHOW, DESCRIBE, EXPLAIN</return>), seomente se o resultado completo precisa ser mantido em
  buffer no PHP. Cada chamada subsequente a <strong>mysqli_stmt_fetch()</strong> retornará dados em buffer.
  
  É desnecessário chamar <strong>mysqli_stmt_store_result()</strong> para outras conultas, mas se isto for feito, não
  irá causar dano ou qualquer perda notável de desempenho em qualquer caso. Pode-se detectar se a
  consulta produziu resultado verificando se a função <strong>mysqli_stmt_result_metadata()</strong> retorna <info>false</info>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>mysqli_prepare()</strong>
   * <strong>mysqli_stmt_result_metadata()</strong>
   * <strong>mysqli_stmt_fetch()</strong>


id: mysqli_stmt_affected_rows
type: function
doc:
<comment>Description:</comment>
  Retorna o número total de linhas modificadas, apagadas, inseridas ou
     correspondidas pela última instrução executada
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de linhas afetadas por consultas <return>INSERT</return>, <return>UPDATE</return> ou <return>DELETE</return>. Funciona como
  <strong>mysqli_stmt_num_rows()</strong> para instruções <return>SELECT</return>.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>int|string</info>  Um inteiro maior que zero indica o número de linhas afetadas ou recebidas. Zero indica
              que nenhum registro foi atualizado para uma instrução <return>UPDATE</return>, nenhuma linha
              correspondeu à cláusula <return>WHERE</return> na consulta ou que nenhuma consulta foi executada. <return>-1</return>
              indica que a consulta retornou um erro ou que, para uma consulta <return>SELECT</return>,
              <strong>mysqli_stmt_affected_rows()</strong> foi chamada antes de <strong>mysqli_stmt_store_result()</strong>.
              
              Se o número de linhas afetadas for maior que o máximo valor inteiro do PHP, o número
              de linhas afetadas será retornado como uma string.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_num_rows()</strong>
   * <strong>mysqli_stmt_store_result()</strong>


id: mysqli_stmt_errno
type: function
doc:
<comment>Description:</comment>
  Retorna o código de erro para a chamada de instrução mais recente
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o código de erro para a função de instrução mais recentemente chamada, que possa ter
  sucesso ou falhar.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Um valor de código de erro. Zero significa que não houve erro.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_error()</strong>
   * <strong>mysqli_stmt_sqlstate()</strong>


id: mysqli_stmt_error
type: function
doc:
<comment>Description:</comment>
  Retorna uma descrição em string para o último erro de instrução
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna uma string contendo a mensagem de erro para a função de instrução mais recentemente
  chamada, que possa ter sucesso ou falhar.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>string</info>  Uma string que descreve o erro. Uma string vazia se nenhum erro ocorreu.

<comment>See Also:</comment>
   * <strong>mysqli_stmt_errno()</strong>
   * <strong>mysqli_stmt_sqlstate()</strong>


id: mysqli_stmt_error_list
type: function
doc:
<comment>Description:</comment>
  Retorna uma lista de erros da última instrução executada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna um array de erros para a função de instrução mais recente que possa ter sucesso ou falhar.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>array</info>  Uma lista de erros, cada um como um <info>array</info> associativo contendo o número do erro (errno), o
         erro (error) e o estado SQL (sqlstate).

<comment>See Also:</comment>
   * <strong>mysqli_stmt_error()</strong>
   * <strong>mysqli_stmt_errno()</strong>
   * <strong>mysqli_stmt_sqlstate()</strong>


id: mysqli_stmt_field_count
type: function
doc:
<comment>Description:</comment>
  Retorna o número de colunas na instrução informada
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Retorna o número de colunas na instrução preparada.

<comment>Param:</comment>
  <info>mysqli_stmt</info>  <strong>$statement</strong>  Somente no estilo procedural: Um objeto <class>mysqli_stmt</class>
                           retornado por <strong>mysqli_stmt_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retorna um inteiro que representa o número de colunas.

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


