# php_manual

id: ftp_ssl_connect
type: function
doc:
<comment>Description:</comment>
  Opens a Secure SSL-FTP connection
  
  <strong>ftp_ssl_connect()</strong> opens an explicit SSL-FTP connection to the specified <strong>$hostname</strong>. That implies
  that <strong>ftp_ssl_connect()</strong> will succeed even if the server is not configured for SSL-FTP, or its
  certificate is invalid. Only when <strong>ftp_login()</strong> is called, the client will send the appropriate AUTH
  FTP command, so <strong>ftp_login()</strong> will fail in the mentioned cases.
  
  Before PHP 7.0.0, <strong>ftp_ssl_connect()</strong> was only available if both the ftp module and the OpenSSL
  support have been built statically into php; this means that on Windows this function had been
  undefined in the official PHP builds. To have this function available on Windows, it had been
  necessary to compile own PHP binaries.
  
  <strong>ftp_ssl_connect()</strong> is not intended for use with sFTP. To use sFTP with PHP, please see <strong>ssh2_sftp()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The FTP server address. This parameter shouldn't have any trailing  slashes and
                     shouldn't be prefixed with <return>ftp://</return>.
  <info>int</info>     <strong>$port</strong>      This parameter specifies an alternate port to connect to. If it is omitted or
                     set to zero, then the default FTP port, 21, will be used.
  <info>int</info>     <strong>$timeout</strong>   This parameter specifies the timeout for all subsequent network operations. If
                     omitted, the default value is 90 seconds. The timeout can be changed and
                     queried at any time with <strong>ftp_set_option()</strong> and <strong>ftp_get_option()</strong>.

<comment>Return:</comment>
  <info>FTP\Connection|false</info>  Returns an <class>FTP\Connection</class> instance on success, ou <info>false</info> em caso de falha.

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


id: ftp_systype
type: function
doc:
<comment>Description:</comment>
  Retorna o identificador de tipo de sistema do servidor FTP remoto
  
  Retorna o identificador de tipo de sistema do servidor FTP remoto.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  Uma instância de <class>FTP\Connection</class>.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o tipo do sistema remoto ou <info>false</info> em caso de erro.


id: ftruncate
type: function
doc:
<comment>Description:</comment>
  Trunca um arquivo a um tamanho especificado
  
  Toma o ponteiro de arquivo <strong>$stream</strong> e trunca o arquivo para o comprimento definido em <strong>$size</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro do arquivo.
                     
                     O fluxo <strong>$stream</strong> deve estar aberto para escrita.
  <info>int</info>       <strong>$size</strong>    O tamanho para o qual será truncado.
                     
                     Se o parâmetro <strong>$size</strong> for maior que o arquivo, o arquivo será estendido com
                     bytes nulos.
                     
                     Se o parâmetro <strong>$size</strong> for menor que o arquivo, o arquivo será truncado para este
                     tamanho.

<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>fopen()</strong>
   * <strong>fseek()</strong>


id: func_get_arg
type: function
doc:
<comment>Description:</comment>
  Retorna um item de uma lista de argumentos
  
  Obtém o argumento especificado de uma lista de argumentos de uma função definida pelo usuário.
  
  Esta função pode ser usada juntamente com <strong>func_get_args()</strong> e <strong>func_num_args()</strong> para permitir que
  funções definidas pelo usuário aceitem listas de argumentos com comprimento variável.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  O índice do argumento. Argumentos de função são contados iniciando de zero.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o argumento especificado, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * Sintaxe <return>...</return>
   * <strong>func_get_args()</strong>
   * <strong>func_num_args()</strong>


id: func_get_args
type: function
doc:
<comment>Description:</comment>
  Returns an array comprising a function's argument list
  
  Gets an array of the function's argument list.
  
  This function may be used in conjunction with  <strong>func_get_arg()</strong> and <strong>func_num_args()</strong> to allow
  user-defined functions to accept variable-length argument lists.

<comment>Return:</comment>
  <info>array</info>  Returns an array in which each element is a copy of the corresponding member of the current
         user-defined function's argument list.

<comment>See Also:</comment>
   * <return>...</return> syntax
   * <strong>func_get_arg()</strong>
   * <strong>func_num_args()</strong>
   * ReflectionFunctionAbstract::getParameters


id: func_num_args
type: function
doc:
<comment>Description:</comment>
  Returns the number of arguments passed to the function
  
  Gets the number of arguments passed to the function.
  
  This function may be used in conjunction with  <strong>func_get_arg()</strong> and <strong>func_get_args()</strong> to allow
  user-defined functions to accept variable-length argument lists.

<comment>Return:</comment>
  <info>int</info>  Returns the number of arguments passed into the current user-defined function.

<comment>See Also:</comment>
   * <return>...</return> syntax
   * <strong>func_get_arg()</strong>
   * <strong>func_get_args()</strong>
   * ReflectionFunctionAbstract::getNumberOfParameters


id: function_exists
type: function
doc:
<comment>Description:</comment>
  Retorna true se a função informada estiver definida
  
  Verifica a lista de funções definidas, tanto as internas quanto as definidas pelo usuário,
  procurando por <strong>$function</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$function</strong>  O nome da função, como uma string.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$function</strong> existir e for uma função, <info>false</info> caso contrário.
        
        Esta função retornará <info>false</info> para instruções de linguagem, como <strong>include_once()</strong> e <strong>echo()</strong>.

<comment>See Also:</comment>
   * <strong>method_exists()</strong>
   * <strong>is_callable()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>class_exists()</strong>
   * <strong>extension_loaded()</strong>


id: fwrite
type: function
doc:
<comment>Description:</comment>
  Escrita binary-safe em arquivos
  
  <strong>fwrite()</strong> grava o conteúdo de <strong>$data</strong> no ponteiro de arquivo informado em <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Um <info>resource</info> de ponteiro do sistema de arquivos
                     que normalmente é criado usando <strong>fopen()</strong>.
  <info>string</info>    <strong>$data</strong>    A string a ser escrita.
  <info>int|null</info>  <strong>$length</strong>  Se <strong>$length</strong> for um <info>int</info>, a escrita irá parar depois que<strong>$length</strong> forem escritos, ou
                     o o fim de <strong>$data</strong> for alcançado, o que ocorrer primeiro.

<comment>Return:</comment>
  <info>int|false</info>  <strong>fwrite()</strong> retorna o número de bytes escritos,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>pack()</strong>


id: gc_collect_cycles
type: function
doc:
<comment>Description:</comment>
  Forces collection of any existing garbage cycles
  
  Forces collection of any existing garbage cycles.

<comment>Return:</comment>
  <info>int</info>  Returns number of collected cycles.

<comment>See Also:</comment>
   * Garbage Collection


id: gc_disable
type: function
doc:
<comment>Description:</comment>
  Deactivates the circular reference collector
  
  Deactivates the circular reference collector, setting zend.enable_gc to <return>0</return>.

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

<comment>See Also:</comment>
   * Garbage Collection


id: gc_enable
type: function
doc:
<comment>Description:</comment>
  Activates the circular reference collector
  
  Activates the circular reference collector, setting zend.enable_gc to <return>1</return>.

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

<comment>See Also:</comment>
   * Garbage Collection


id: gc_enabled
type: function
doc:
<comment>Description:</comment>
  Returns status of the circular reference collector
  
  Returns status of the circular reference collector.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the garbage collector is enabled, <info>false</info> otherwise.

<comment>See Also:</comment>
   * Garbage Collection


id: gc_mem_caches
type: function
doc:
<comment>Description:</comment>
  Reclaims memory used by the Zend Engine memory manager
   
  
  Reclaims memory used by the Zend Engine memory manager.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes freed.

<comment>See Also:</comment>
   * Garbage Collection


id: gc_status
type: function
doc:
<comment>Description:</comment>
  Gets information about the garbage collector
  
  Gets information about the current state of the garbage collector.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with the following elements:
         <return>"runs"</return><return>"collected"</return><return>"threshold"</return><return>"roots"</return>
         
         <return>"runs"</return>
         
         <return>"collected"</return>
         
         <return>"threshold"</return>
         
         <return>"roots"</return>

<comment>See Also:</comment>
   * Garbage Collection


id: gd_info
type: function
doc:
<comment>Description:</comment>
  Obtém informações sobre a biblioteca GD instalada atualmente
  
  Obtém informação sobre a versão e as capacidades da biblioteca GD instalada.

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo.
         
         Elementos de array retornados por <strong>gd_info()</strong>AtributoSignificadoGD VersionValor <info>string</info>
         descrevendo a versão da <return>libgd</return> instalada.FreeType SupportValor <info>bool</info>. <info>true</info> se o suporte
         FreeType estiver instalado.FreeType LinkageValor <info>string</info> dewscrevendo a maneira que FreeType
         foi linkado. Os valores esperados são: 'with freetype', 'with TTF library', e 'with unknown
         library'. Este elemento será definido apenas se <return>FreeType Support</return> for <info>true</info>.GIF Read
         SupportValor <info>bool</info>. <info>true</info> se o suporte para ler imagens <return>GIF</return> estiver incluso.GIF Create
         SupportValor <info>bool</info>. <info>true</info> se o suporte para criação de imagens <return>GIF</return> estiver incluso.JPEG
         SupportValor <info>bool</info>. <info>true</info> se o suporte a <return>JPEG</return> estiver incluso.PNG SupportValor <info>bool</info>. <info>true</info> se
         o suporte a <return>PNG</return> estiver incluso.WBMP SupportValor <info>bool</info>. <info>true</info> se o suporte a <return>WBMP</return> estiver
         incluso.XBM SupportValor <info>bool</info>. <info>true</info> se o suporte a <return>XBM</return> estiver incluso.WebP SupportValor
         <info>bool</info>. <info>true</info> se o suporte a <return>WebP</return> estiver incluso.AVIF SupportValor <info>bool</info>. <info>true</info> se o suporte a
         <return>AVIF</return> estiver incluso. Disponível a partir do PHP 8.1.0.

<comment>See Also:</comment>
   * <strong>imagepng()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagegif()</strong>
   * <strong>imagewbmp()</strong>
   * <strong>imagewebp()</strong>
   * <strong>imageavif()</strong>
   * <strong>imagetypes()</strong>


id: geoip_asnum_by_name
type: function
doc:
<comment>Description:</comment>
  Get the Autonomous System Numbers (ASN)
  
  The <strong>geoip_asnum_by_name()</strong> function will return the Autonomous System Numbers (ASN) associated with
  an IP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address.

<comment>Return:</comment>
  <info>string</info>  Returns the ASN on success, or <info>false</info> if the address cannot be found in the database.


id: geoip_continent_code_by_name
type: function
doc:
<comment>Description:</comment>
  Get the two letter continent code
  
  The <strong>geoip_continent_code_by_name()</strong> function will return the two letter continent code
  corresponding to a hostname or an IP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose location is to be looked-up.

<comment>Return:</comment>
  <info>string</info>  Returns the two letter continent code on success, or <info>false</info> if the address cannot be found
          in the database.

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


id: geoip_country_code3_by_name
type: function
doc:
<comment>Description:</comment>
  Get the three letter country code
  
  The <strong>geoip_country_code3_by_name()</strong> function will return the three letter country code corresponding
  to a hostname or an IP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose location is to be looked-up.

<comment>Return:</comment>
  <info>string</info>  Returns the three letter country code on success, or <info>false</info>  if the address cannot be found
          in the database.

<comment>See Also:</comment>
   * <strong>geoip_country_code_by_name()</strong>
   * <strong>geoip_country_name_by_name()</strong>


id: geoip_country_code_by_name
type: function
doc:
<comment>Description:</comment>
  Get the two letter country code
  
  The <strong>geoip_country_code_by_name()</strong> function will return the two letter country code corresponding to
  a hostname or an IP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose location is to be looked-up.

<comment>Return:</comment>
  <info>string</info>  Returns the two letter ISO country code on success, or <info>false</info>  if the address cannot be
          found in the database.

<comment>See Also:</comment>
   * <strong>geoip_country_code3_by_name()</strong>
   * <strong>geoip_country_name_by_name()</strong>


id: geoip_country_name_by_name
type: function
doc:
<comment>Description:</comment>
  Get the full country name
  
  The <strong>geoip_country_name_by_name()</strong> function will return the full country name corresponding to a
  hostname or an IP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose location is to be looked-up.

<comment>Return:</comment>
  <info>string</info>  Returns the country name on success, or <info>false</info> if the address cannot  be found in the
          database.

<comment>See Also:</comment>
   * <strong>geoip_country_code_by_name()</strong>
   * <strong>geoip_country_code3_by_name()</strong>


id: geoip_database_info
type: function
doc:
<comment>Description:</comment>
  Get GeoIP Database information
  
  The <strong>geoip_database_info()</strong> function returns the corresponding GeoIP Database version as it is
  defined inside the binary file.
  
  If this function is called without arguments, it returns the version of the GeoIP Free Country
  Edition.

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  The database type as an integer. You can use the various constants defined with
                  this extension (ie: GEOIP_*_EDITION).

<comment>Return:</comment>
  <info>string</info>  Returns the corresponding database version, or <info>null</info> on error.


id: geoip_db_avail
type: function
doc:
<comment>Description:</comment>
  Determine if GeoIP Database is available
  
  The <strong>geoip_db_avail()</strong> function returns if the corresponding GeoIP Database is available and can be
  opened on disk.
  
  It does not indicate if the file is a proper database, only if it is readable.

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  The database type as an integer. You can use the various constants defined with
                  this extension (ie: GEOIP_*_EDITION).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> is database exists, <info>false</info> if not found, or <info>null</info> on error.


id: geoip_db_filename
type: function
doc:
<comment>Description:</comment>
  Returns the filename of the corresponding GeoIP Database
  
  The <strong>geoip_db_filename()</strong> function returns the filename of the corresponding GeoIP Database.
  
  It does not indicate if the file exists or not on disk, only where the library is looking for the
  database.

<comment>Param:</comment>
  <info>int</info>  <strong>$database</strong>  The database type as an integer. You can use the various constants defined with
                  this extension (ie: GEOIP_*_EDITION).

<comment>Return:</comment>
  <info>string</info>  Returns the filename of the corresponding database, or <info>null</info> on error.


id: geoip_db_get_all_info
type: function
doc:
<comment>Description:</comment>
  Returns detailed information about all GeoIP database types
  
  The <strong>geoip_db_get_all_info()</strong> function will return  detailed information as a multi-dimensional
  array about all the  GeoIP database types.
  
  This function is available even if no databases are installed. It will simply list them as
  non-available.
  
  The names of the different keys of the returning associative array are as follows:
  
   "available" -- Boolean, indicate if DB is available (see <strong>geoip_db_avail()</strong>)  "description" -- The
  database description  "filename" -- The database filename on disk (see <strong>geoip_db_filename()</strong>)
  
  "available" -- Boolean, indicate if DB is available (see <strong>geoip_db_avail()</strong>)
  
  "description" -- The database description
  
  "filename" -- The database filename on disk (see <strong>geoip_db_filename()</strong>)

<comment>Return:</comment>
  <info>array</info>  Returns the associative array.


id: geoip_domain_by_name
type: function
doc:
<comment>Description:</comment>
  Get the second level domain name
  
  The <strong>geoip_domain_by_name()</strong> function will return the second level domain names associated with a
  hostname or an IP address.
  
  This function is currently only available to users who have bought a commercial GeoIP Domain
  Edition. A warning will be issued if the proper database cannot be  located.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address.

<comment>Return:</comment>
  <info>string</info>  Returns the domain name on success, or <info>false</info> if the address cannot be found in the
          database.


id: geoip_id_by_name
type: function
doc:
<comment>Description:</comment>
  Get the Internet connection type
  
  The <strong>geoip_id_by_name()</strong> function will return the Internet  connection type corresponding to a
  hostname or an IP address.
  
  The return value is numeric and can be compared to the following constants:
  
   GEOIP_UNKNOWN_SPEED  GEOIP_DIALUP_SPEED  GEOIP_CABLEDSL_SPEED  GEOIP_CORPORATE_SPEED 
  
  GEOIP_UNKNOWN_SPEED
  
  GEOIP_DIALUP_SPEED
  
  GEOIP_CABLEDSL_SPEED
  
  GEOIP_CORPORATE_SPEED

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose connection type is to be looked-up.

<comment>Return:</comment>
  <info>int</info>  Returns the connection type.


id: geoip_isp_by_name
type: function
doc:
<comment>Description:</comment>
  Get the Internet Service Provider (ISP) name
  
  The <strong>geoip_isp_by_name()</strong> function will return the name of the Internet Service Provider (ISP) that
  an IP is assigned to.
  
  This function is currently only available to users who have bought a commercial GeoIP ISP Edition.
  A warning will be issued if the proper database cannot be  located.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address.

<comment>Return:</comment>
  <info>string</info>  Returns the ISP name on success, or <info>false</info> if the address cannot be found in the database.


id: geoip_netspeedcell_by_name
type: function
doc:
<comment>Description:</comment>
  Get the Internet connection speed
  
  The <strong>geoip_netspeedcell_by_name()</strong> function will return the Internet  connection type and speed
  corresponding to a hostname or an IP address.
  
  This function is only available if using GeoIP Library version 1.4.8 or newer.
  
  This function is currently only available to users who have bought a commercial GeoIP NetSpeedCell
  Edition. A warning will be issued if the proper database cannot be  located.
  
  The return value is a string, common values are:
  
   Cable/DSL  Dialup  Cellular  Corporate 
  
  Cable/DSL
  
  Dialup
  
  Cellular
  
  Corporate

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address.

<comment>Return:</comment>
  <info>string</info>  Returns the connection speed on success, or <info>false</info> if the address cannot be found in the
          database.


id: geoip_org_by_name
type: function
doc:
<comment>Description:</comment>
  Get the organization name
  
  The <strong>geoip_org_by_name()</strong> function will return the name of the organization that an IP is assigned
  to.
  
  This function is currently only available to users who have bought a commercial GeoIP
  Organization, ISP or AS Edition. A warning will be issued if the proper  database cannot be
  located.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address.

<comment>Return:</comment>
  <info>string</info>  Returns the organization name on success, or <info>false</info> if the address cannot be found in the
          database.


id: geoip_record_by_name
type: function
doc:
<comment>Description:</comment>
  Returns the detailed City information found in the GeoIP Database
  
  The <strong>geoip_record_by_name()</strong> function will return the record information corresponding to a hostname
  or an IP address.
  
  This function is available for both GeoLite City Edition and commercial GeoIP City Edition. A
  warning will be issued if the proper database cannot be located.
  
  The names of the different keys of the returning associative array are as follows:
  
   "continent_code" -- Two letter continent code (as of version 1.0.4 with  libgeoip 1.4.3 or newer)
  "country_code" -- Two letter country code (see <strong>geoip_country_code_by_name()</strong>)  "country_code3" --
  Three letter country code (see <strong>geoip_country_code3_by_name()</strong>)  "country_name" -- The country name
  (see <strong>geoip_country_name_by_name()</strong>)  "region" -- The region code (ex: CA for California)  "city" --
  The city.  "postal_code" -- The Postal Code, FSA or Zip Code.  "latitude" -- The Latitude as
  signed <info>float</info>.  "longitude" -- The Longitude as signed <info>float</info>.  "dma_code" -- Designated Market Area
  code (USA and Canada only)  "area_code" -- The PSTN area code (ex: 212)
  
  "continent_code" -- Two letter continent code (as of version 1.0.4 with  libgeoip 1.4.3 or newer)
  
  "country_code" -- Two letter country code (see <strong>geoip_country_code_by_name()</strong>)
  
  "country_code3" -- Three letter country code (see <strong>geoip_country_code3_by_name()</strong>)
  
  "country_name" -- The country name (see <strong>geoip_country_name_by_name()</strong>)
  
  "region" -- The region code (ex: CA for California)
  
  "city" -- The city.
  
  "postal_code" -- The Postal Code, FSA or Zip Code.
  
  "latitude" -- The Latitude as signed <info>float</info>.
  
  "longitude" -- The Longitude as signed <info>float</info>.
  
  "dma_code" -- Designated Market Area code (USA and Canada only)
  
  "area_code" -- The PSTN area code (ex: 212)

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose record is to be looked-up.

<comment>Return:</comment>
  <info>array</info>  Returns the associative array on success, or <info>false</info> if the address  cannot be found in the
         database.


id: geoip_region_by_name
type: function
doc:
<comment>Description:</comment>
  Get the country code and region
  
  The <strong>geoip_region_by_name()</strong> function will return the country and region corresponding to a hostname
  or an IP address.
  
  This function is currently only available to users who have bought a commercial GeoIP Region
  Edition. A warning will be issued if the proper database cannot be located.
  
  The names of the different keys of the returning associative array are as follows:
  
   "country_code" -- Two letter country code (see <strong>geoip_country_code_by_name()</strong>)  "region" -- The
  region code (ex: CA for California)
  
  "country_code" -- Two letter country code (see <strong>geoip_country_code_by_name()</strong>)
  
  "region" -- The region code (ex: CA for California)

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The hostname or IP address whose region is to be looked-up.

<comment>Return:</comment>
  <info>array</info>  Returns the associative array on success, or <info>false</info> if the address  cannot be found in the
         database.


id: geoip_region_name_by_code
type: function
doc:
<comment>Description:</comment>
  Returns the region name for some country and region code combo
  
  The <strong>geoip_region_name_by_code()</strong> function will return the region name corresponding to a country
  and region code combo.
  
  In the United States, the region code corresponds to the two-letter abbreviation of each state. In
  Canada, the region code corresponds to the two-letter province or territory code as attributed by
  Canada Post.
  
  For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions. You can check
  http://www.maxmind.com/app/fips10_4 for a detailed list of FIPS 10-4 codes.
  
  This function is always available if using GeoIP Library version 1.4.1 or newer. The data is taken
  directly from the GeoIP Library and not from any database.

<comment>Param:</comment>
  <info>string</info>  <strong>$country_code</strong>  The two-letter country code (see <strong>geoip_country_code_by_name()</strong>)
  <info>string</info>  <strong>$region_code</strong>   The two-letter (or digit) region code (see  <strong>geoip_region_by_name()</strong>)

<comment>Return:</comment>
  <info>string</info>  Returns the region name on success, or <info>false</info> if the country and region code combo cannot
          be found.


id: geoip_setup_custom_directory
type: function
doc:
<comment>Description:</comment>
  Set a custom directory for the GeoIP database
  
  The <strong>geoip_setup_custom_directory()</strong> function will change the default directory of the GeoIP
  database. This is equivalent to changing geoip.custom_directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The full path of where the GeoIP database is on disk.

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


id: geoip_time_zone_by_country_and_region
type: function
doc:
<comment>Description:</comment>
  Returns the time zone for some country and region code combo
  
  The <strong>geoip_time_zone_by_country_and_region()</strong> function will return the time zone corresponding to a
  country and region code combo.
  
  In the United States, the region code corresponds to the two-letter abbreviation of each state. In
  Canada, the region code corresponds to the two-letter province or territory code as attributed by
  Canada Post.
  
  For the rest of the world, GeoIP uses FIPS 10-4 codes to represent regions. You can check
  http://www.maxmind.com/app/fips10_4 for a detailed list of FIPS 10-4 codes.
  
  This function is always available if using GeoIP Library version 1.4.1 or newer. The data is taken
  directly from the GeoIP Library and not from any database.

<comment>Param:</comment>
  <info>string</info>  <strong>$country_code</strong>  The two-letter country code (see <strong>geoip_country_code_by_name()</strong>)
  <info>string</info>  <strong>$region_code</strong>   The two-letter (or digit) region code (see  <strong>geoip_region_by_name()</strong>)

<comment>Return:</comment>
  <info>string</info>  Returns the time zone on success, or <info>false</info> if the country and region code combo cannot be
          found.


id: getSession
type: function
doc:
<comment>Description:</comment>
  Connect to a MySQL server
  
  Connects to the MySQL server.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  The URI to the MySQL server, such as <return>mysqlx://user:password@host</return>.
                
                URI format:
                
                scheme://[user[:[password]]@]target[:port][?attribute1=value1&attribute2=value2...
                
                <return>scheme</return>: required, the connection protocol
                
                In mysql_xdevapi it is always 'mysqlx' (for X Protocol)
                
                <return>user</return>: optional, the MySQL user account for authentication
                
                <return>password</return>: optional, the MySQL user's password for authentication
                
                <return>target</return>: required, the server instance the connection refers to:
                
                * TCP connection (host name, IPv4 address, or IPv6 address)
                
                * Unix socket path (local file path)
                
                * Windows named-pipe (local file path)
                
                <return>port</return>: optional, network port of MySQL server.
                
                by default port for X Protocol is 33060
                
                <return>?attribute=value</return>: this element is optional and specifies a data dictionary  that
                contains different options, including:
                
                The <return>auth</return> (authentication mechanism) attribute as it relates to encrypted
                connections. For additional information, see Command Options for Encrypted
                Connections. The following 'auth' values are supported: <return>plain</return>, <return>mysql41</return>, <return>external</return>,
                and <return>sha256_mem</return>.
                
                The <return>connect-timeout</return> attribute affects the connection and not subsequent operations.
                It is set per connection whether on a single or multiple hosts.
                
                Pass in a positive integer to define the connection timeout in seconds, or pass in 0
                (zero) to disable the timeout (infinite). Not defining connect-timeout uses the
                default value of 10.
                
                Related, the MYSQLX_CONNECTION_TIMEOUT (timeout in seconds) and
                MYSQLX_TEST_CONNECTION_TIMEOUT (used while running tests) environment variables can
                be set and used instead of connect-timeout in the URI. The connect-timeout URI
                option has precedence over these environment variables.
                
                The optional <return>compression</return> attribute accepts these values:  <return>preferred</return> (client
                negotiates with server to find a supported algorithm; connection is uncompressed if
                a mutually supported algorithm is not found),  <return>required</return> (like "preferred", but
                connection is terminated if a mutually supported algorithm is not found), or
                <return>disabled</return> (connection is uncompressed). Defaults to <return>preferred</return>.
                
                This option was added in version 8.0.20.
                
                The optional <return>compression-algorithms</return> attribute defines  the desired compression
                algorithms (and their preferred usage order):  <return>zstd_stream</return> (alias: zstd),
                <return>lz4_message</return> (alias: lz4), or <return>deflate_stream</return> (aliases: deflate or zlib). By default,
                the order used (depending on system availability) is lz4_message, zstd_stream, then
                deflate_stream. For example, passing in compression-algorithms=[lz4,zstd_stream]
                uses lz4 if it's available, otherwise zstd_stream is used. If both are unavailable
                then behavior depends on the compression value e.g., if compression=required then
                it'll fail with an error.
                
                This option was added in version 8.0.22.
                
                For related information, see MySQL Shell's Connecting using a URI String.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A <class>Session</class> object.


id: get_browser
type: function
doc:
<comment>Description:</comment>
  Diz o que o navegador do usuário é capaz fazer
  
  Tenta determinar as capacidades do navegador do usuário, consultando as informações do navegador
  no arquivo browscap.ini.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$user_agent</strong>    O agente do usuário (navegador) a ser analisado. Por padrão, o valor
                              do cabeçalho HTTP User-Agent é usado; no entanto, pode-se alterar isso
                              (ou seja, procurar informações sobre outro navegador) passando este
                              parâmetro.
                              
                              Pode-se ignorar esse parâmetro com um valor <info>null</info>.
  <info>bool</info>         <strong>$return_array</strong>  Se definido como <info>true</info>, esta função retornará um <info>array</info>, em vez de um
                              <info>object</info>.

<comment>Return:</comment>
  <info>object|array|false</info>  As informações são retornadas num objeto ou array que conterá vários elementos
                      de dados representando, por exemplo, os números de versão principal e
                      secundário e a string de ID; valores <info>true</info>/<info>false</info> para recursos como frames,
                      JavaScript e cookies; e assim por diante.
                      
                      O valor <return>cookies</return> significa simplesmente que o navegador é capaz de aceitar
                      cookies e não significa que o usuário habilitou ou não o navegador para
                      aceitar cookies. A única maneira de testar se os cookies são aceitos é definir
                      um com <strong>setcookie()</strong>, recarregar, e verificar o valor.
                      
                      Retorna <info>false</info> quando nenhuma informação puder ser obtida, como quando de
                      configuração browscap no php.ini não tiver sido configurada.


id: get_called_class
type: function
doc:
<comment>Description:</comment>
  O nome da classe da qual o método estático foi chamado
  
  Obtém o nome da classe da qual o método estático foi chamado.

<comment>Return:</comment>
  <info>string</info>  Retorna o nome da classe.

<comment>See Also:</comment>
   * <strong>get_parent_class()</strong>
   * <strong>get_class()</strong>
   * <strong>is_subclass_of()</strong>


id: get_cfg_var
type: function
doc:
<comment>Description:</comment>
  Gets the value of a PHP configuration option
  
  Gets the value of a PHP configuration <strong>$option</strong>.
  
  This function will not return configuration information set when the PHP was compiled, or read
  from an Apache configuration file.
  
  To check whether the system is using a configuration file, try retrieving the value of the
  cfg_file_path configuration setting. If this is available, a configuration file is being used.

<comment>Param:</comment>
  <info>string</info>  <strong>$option</strong>  The configuration option name.

<comment>Return:</comment>
  <info>string|array|false</info>  Returns the current value of the PHP configuration variable specified by
                      <strong>$option</strong>, or <info>false</info> if an error occurs.

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>ini_get_all()</strong>


id: get_class
type: function
doc:
<comment>Description:</comment>
  Retorna o nome da classe de um objeto
  
  Obtém o nome da classe do <strong>$object</strong> informado.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  O objeto testado. Este parâmetro pode ser omitido quando dentro de uma classe.
                   
                   Passar explicitamente <info>null</info> no parâmetro <strong>$object</strong> não é mais permitido a partir do
                   PHP 7.2.0 e emite um <info>E_WARNING</info>. A partir do 8.0.0, um <class>TypeError</class> é emitido quando
                   <info>null</info> é usado.

<comment>Return:</comment>
  <info>string</info>  Retorna o nome da classe da qual <strong>$object</strong> é uma instância.
          
          Se <strong>$object</strong> for omitido quando dentro de uma classe, o nome desta classe é retornado.
          
          Se <strong>$object</strong> for uma instância de uma classe que existe em um espaço de nomes, o nome da
          classe qualificado com espaço de nomes é retornado.

<comment>See Also:</comment>
   * <strong>get_called_class()</strong>
   * <strong>get_parent_class()</strong>
   * <strong>gettype()</strong>
   * <strong>get_debug_type()</strong>
   * <strong>is_subclass_of()</strong>


id: get_class_methods
type: function
doc:
<comment>Description:</comment>
  Obtém o nome dos métodos da classe
  
  Obtém o nome dos métodos da classe.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  O nome da classe ou a instância do objeto

<comment>Return:</comment>
  <info>array</info>  Retorna um array de nome de métodos definidos para a classe especificada por
         <strong>$object_or_class</strong>.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>get_class_vars()</strong>
   * <strong>get_object_vars()</strong>


id: get_class_vars
type: function
doc:
<comment>Description:</comment>
  Obtém as propriedades padrão da classe
  
  Obtém as propriedades padrão de uma dada classe.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  O nome da classe

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo das propriedades declaradas visíveis no escopo atual, com seu
         valor padrão. Os elementos do array resultante estão na forma de <return>varname =&gt; value</return>. Em
         caso de um erro, retornará <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_class_methods()</strong>
   * <strong>get_object_vars()</strong>


id: get_current_user
type: function
doc:
<comment>Description:</comment>
  Gets the name of the owner of the current PHP script
  
  Returns the name of the owner of the current PHP script.

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

<comment>See Also:</comment>
   * <strong>getmyuid()</strong>
   * <strong>getmygid()</strong>
   * <strong>getmypid()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getlastmod()</strong>


id: get_debug_type
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do tipo de uma variável de forma adequada a depuração
  
  Retorna o nome resolvido da variável PHP  <strong>$value</strong>. Esta função resolverá objetos ao nome da classe
  deles, recursos ao nome do tipo de recurso deles, e valores escalares ao nome comum deles como
  seria usado em declarações de tipo.
  
  Este função difere de <strong>gettype()</strong> pelo fato de retornar nomes de tipo que são mais consistentes com
  o uso real, ao invés daqueles exsitentes por razões históricas.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  A variáver a ter o tipo verificado.

<comment>Return:</comment>
  <info>string</info>  Valores possíveis para a string de retorno são:
           Tipo + EstadoValor de RetornoNotasnulo<return>"null"</return>-Booleanos (verdadeiro ou
          falso)<return>"bool"</return>-Inteiros<return>"int"</return>-Números de ponto
          flutuante<return>"float"</return>-Strings<return>"string"</return>-Arrays<return>"array"</return>-Recursos<return>"resource (resourcename)"</return>-Recursos
          (Fechados)<return>"resource (closed)"</return>Exemplo: um fluxo de arquivo depois de ter sido fechado com
          fclose.Objetos de Classes com Nome O nome completo da classe incluindo seu espaço de
          nomes, ex.: <return>Foo\Bar</return> -Objetos de Classes Anônimas<return>"class@anonymous"</return> Classes anônimas são
          aquelas criadas através da sintaxe $x = new class { ... }

<comment>See Also:</comment>
   * <strong>gettype()</strong>
   * <strong>get_class()</strong>


id: get_declared_classes
type: function
doc:
<comment>Description:</comment>
  Retorna um array com os nomes das classes definidas
  
  Obtém as classes declaradas.

<comment>Return:</comment>
  <info>array</info>  Retorna um array de nomes das classes declaradas no script atual.
         
         Note que, dependendo de quais bibliotecas você tenha compilado ou carregado no PHP, classes
         adicionais podem estar presentes. Isto significa que não será possível definir classes de
         usuário usando estes nomes. Há uma lista de classes pré-definidas na seção Classes
         Pré-definidas dos apêndices.

<comment>See Also:</comment>
   * <strong>class_exists()</strong>
   * <strong>get_declared_interfaces()</strong>
   * <strong>get_defined_functions()</strong>


id: get_declared_interfaces
type: function
doc:
<comment>Description:</comment>
  Retorna um array com todas as interfaces declaradas
  
  Retorna as interfaces declaradas.

<comment>Return:</comment>
  <info>array</info>  Essa função retorna um array com os nomes de interfaces declaradas no script atual.

<comment>See Also:</comment>
   * <strong>interface_exists()</strong>
   * <strong>get_declared_classes()</strong>
   * <strong>class_implements()</strong>


id: get_declared_traits
type: function
doc:
<comment>Description:</comment>
  Retorna um array de todas as Traits declaradas

<comment>Return:</comment>
  <info>array</info>  Retorna um array com todos os nomes das Traits declaradas em seus valores.

<comment>See Also:</comment>
   * <strong>class_uses()</strong>
   * <strong>trait_exists()</strong>


id: get_defined_constants
type: function
doc:
<comment>Description:</comment>
  Returns an associative array with the names of all the constants and their values
  
  Returns the names and values of all the constants currently defined. This includes those created
  by extensions as well as those created with the <strong>define()</strong> function.

<comment>Param:</comment>
  <info>bool</info>  <strong>$categorize</strong>  Causing this function to return a multi-dimensional array with categories in
                     the keys of the first dimension and constants and their values in the second
                     dimension.
                     ]]>O exemplo acima produzirá
                     algo semelhante a: Array ( [E_ERROR] => 1 [E_WARNING] => 2 [E_PARSE] => 4
                     [E_NOTICE] => 8 [E_CORE_ERROR] => 16 [E_CORE_WARNING] => 32 [E_COMPILE_ERROR]
                     => 64 [E_COMPILE_WARNING] => 128 [E_USER_ERROR] => 256 [E_USER_WARNING] => 512
                     [E_USER_NOTICE] => 1024 [E_ALL] => 2047 [TRUE] => 1 )
                      [pcre] => Array ( [PREG_PATTERN_ORDER] => 1 [PREG_SET_ORDER] => 2
                     [PREG_OFFSET_CAPTURE] => 256 [PREG_SPLIT_NO_EMPTY] => 1
                     [PREG_SPLIT_DELIM_CAPTURE] => 2 [PREG_SPLIT_OFFSET_CAPTURE] => 4
                     [PREG_GREP_INVERT] => 1 )
                      [user] => Array ( [MY_CONSTANT] => 1 )
                     
                     )
                     ]]>
                     
                     O exemplo acima produzirá
                     algo semelhante a:

<comment>Return:</comment>
  <info>array</info>  Returns an array of constant name =&gt; constant value array, optionally groupped by
         extension name registering the constant.

<comment>See Also:</comment>
   * <strong>defined()</strong>
   * <strong>constant()</strong>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_vars()</strong>


id: get_defined_functions
type: function
doc:
<comment>Description:</comment>
  Retorna um array com todas as funções definidas
  
  Obtém um array com todas as funções definidas.

<comment>Param:</comment>
  <info>bool</info>  <strong>$exclude_disabled</strong>  Opção para definir se funções desabilitadas devem ser excluídas do valor
                           de retorno.

<comment>Return:</comment>
  <info>array</info>  Retorna um array multidimensional contendo uma lista de todas as funções definidas, tanto
         as internas quanto as definidas pelo usuário. As funções internas podem ser acessadas em
         $arr["internal"], e as definidas por usuário em $arr["user"] (veja exemplo abaixo).

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>get_defined_vars()</strong>
   * <strong>get_defined_constants()</strong>
   * <strong>get_declared_classes()</strong>


id: get_defined_vars
type: function
doc:
<comment>Description:</comment>
  Retorna um array com todas variáveis definidas
    
  
  Essa função retorna um array multimensional contendo uma lista com todas as variáveis definidas,
  incluindo variáveis de ambiente, servidor ou variáveis definidas pelo usuário, dentro do escopo
  que <strong>get_defined_vars()</strong> foi chamada.

<comment>Return:</comment>
  <info>array</info>  Um array multidimensional com todas as variáveis.

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_constants()</strong>


id: get_extension_funcs
type: function
doc:
<comment>Description:</comment>
  Retorna um array com os nomes das funções de um módulo
  
  Esta função retorna os nomes de todas as funções definidas no módulo indicado por <strong>$extension</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  O nome do módulo.
                      
                      Este parâmetro precisa estar em minúsculas.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array com todas as funções, ou <info>false</info> se <strong>$extension</strong> não for uma extensão
               válida.

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * ReflectionExtension::getFunctions


id: get_headers
type: function
doc:
<comment>Description:</comment>
  Retorna todos os cabeçalhos enviados pelo servidor em resposta a uma requisição HTTP
  
  <strong>get_headers()</strong> retorna um array com os cabeçalhos enviados pelo servidor em resposta a uma
  requisição HTTP.

<comment>Param:</comment>
  <info>string</info>         <strong>$url</strong>          A URL alvo.
  <info>bool</info>           <strong>$associative</strong>  Se o parâmetro opcional <strong>$associative</strong> estiver definido como true,
                               <strong>get_headers()</strong> avalia a resposta e define as chaves do array.
  <info>resource|null</info>  <strong>$context</strong>      Um recurso de contexto válido criado com <strong>stream_context_create()</strong>, ou
                               <info>null</info> para usar o contexto padrão

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array indexado ou associativo com os cabeçalhos, ou <info>false</info> em caso de
               falha.

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


id: get_html_translation_table
type: function
doc:
<comment>Description:</comment>
  Returns the translation table used by htmlspecialchars and htmlentities
  
  <strong>get_html_translation_table()</strong> will return the translation table that is used internally for
  <strong>htmlspecialchars()</strong> and <strong>htmlentities()</strong>.
  
  Special characters can be encoded in several ways. E.g. <return>"</return> can be encoded as , <return>&#34;</return> or <return>&#x22</return>.
  <strong>get_html_translation_table()</strong> returns only the form used by <strong>htmlspecialchars()</strong> and <strong>htmlentities()</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$table</strong>     Which table to return. Either <info>HTML_ENTITIES</info> or <info>HTML_SPECIALCHARS</info>.
  <info>int</info>     <strong>$flags</strong>     A bitmask of one or more of the following flags, which specify which quotes the
                     table will contain as well as which document type the table is for. The default
                     is <return>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</return>. Available <strong>$flags</strong>
                     constantsConstant NameDescription<info>ENT_COMPAT</info>Table will contain entities for
                     double-quotes, but not for single-quotes.<info>ENT_QUOTES</info>Table will contain entities
                     for both double and single quotes.<info>ENT_NOQUOTES</info>Table will neither contain
                     entities for single quotes nor for double quotes.<info>ENT_SUBSTITUTE</info> Replace invalid
                     code unit sequences with a Unicode Replacement Character U+FFFD (UTF-8) or
                     &#xFFFD; (otherwise) instead of returning an empty string. <info>ENT_HTML401</info>Table for
                     HTML 4.01.<info>ENT_XML1</info>Table for XML 1.<info>ENT_XHTML</info>Table for XHTML.<info>ENT_HTML5</info>Table for
                     HTML 5.
  <info>string</info>  <strong>$encoding</strong>  Encoding to use. If omitted, the default value for this argument is UTF-8.
                     
                     Os seguintes conjuntos de caracteres são suportados: Conjuntos de caracteres
                     suportadosConjunto de caracteresApelidosDescriçãoISO-8859-1ISO8859-1 Western
                     European, Latin-1. ISO-8859-5ISO8859-5 Conjunto de caracteres cirílicos pouco
                     usado (Latim/Cirílico). ISO-8859-15ISO8859-15 Western European, Latin-9.
                     Adiciona o símbolo do Euro, letras Francesas e Filandesas faltando no Latin-1
                     (ISO-8859-1). UTF-8 Código de multi-byte 8-bit Unicode compatível com ASCII.
                     cp866ibm866, 866 Conjunto de caracteres do DOS específico para o Russo.
                     cp1251Windows-1251, win-1251, 1251 Conjunto de caracteres do Windows específico
                     para o Russo. cp1252Windows-1252, 1252 Conjunto de caracteres do Windows
                     específico para a Europa Ocidental. KOI8-Rkoi8-ru, koi8r Russo. BIG5950 Chinês
                     Tradicional, usado principalmente em Taiwan. GB2312936 Chins Simplificado,
                     conjunto de caracteres padrão nacional. BIG5-HKSCS Big5 com extenções de Hong
                     Kong, Chinês Tradicional. Shift_JISSJIS, SJIS-win, cp932, 932 Japonês
                     EUC-JPEUCJP, eucJP-win Japonês MacRoman Conjunto de caracteres que era usado
                     pelo Mac OS. <return>''</return> Uma string vazia ativa a detecção a partir de codificação de
                     script (multibyte Zend), conjunto padrão de caracteres e localidade atual
                     (consulte <strong>nl_langinfo()</strong> e <strong>setlocale()</strong>), nesta ordem. Não recomendado.   Nenhum
                     outro conjunto de caracteres é reconhecido. A codificação padrão será usada no
                     lugar e um alerta será emitido.
                     
                     Nenhum outro conjunto de caracteres é reconhecido. A codificação padrão será
                     usada no lugar e um alerta será emitido.

<comment>Return:</comment>
  <info>array</info>  Returns the translation table as an array, with the original characters as keys and
         entities as values.

<comment>See Also:</comment>
   * <strong>htmlspecialchars()</strong>
   * <strong>htmlentities()</strong>
   * <strong>html_entity_decode()</strong>


id: get_include_path
type: function
doc:
<comment>Description:</comment>
  Obtém a opção de configuração include_path atual
  
  Obtém a opção de configuração include_path atual.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o caminho, como uma string,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>ini_get()</strong>
   * <strong>restore_include_path()</strong>
   * <strong>set_include_path()</strong>
   * <strong>include()</strong>


id: get_included_files
type: function
doc:
<comment>Description:</comment>
  Returns an array with the names of included or required files
  
  Gets the names of all files that have been included using <strong>include()</strong>, <strong>include_once()</strong>, <strong>require()</strong> or
  <strong>require_once()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array of the names of all files.
         
         The script originally called is considered an "included file," so it will be listed
         together with the files referenced by  <strong>include()</strong> and family.
         
         Files that are included or required multiple times only show up once in the returned array.

<comment>See Also:</comment>
   * <strong>include()</strong>
   * <strong>include_once()</strong>
   * <strong>require()</strong>
   * <strong>require_once()</strong>
   * <strong>get_required_files()</strong>


id: get_loaded_extensions
type: function
doc:
<comment>Description:</comment>
  Returns an array with the names of all modules compiled and loaded
  
  This function returns the names of all the modules compiled and loaded in the PHP interpreter.

<comment>Param:</comment>
  <info>bool</info>  <strong>$zend_extensions</strong>  Only return Zend extensions, if not then regular extensions, like  mysqli
                          are listed. Defaults to <info>false</info> (return regular extensions).

<comment>Return:</comment>
  <info>array</info>  Returns an indexed array of all the modules names.

<comment>See Also:</comment>
   * <strong>get_extension_funcs()</strong>
   * <strong>extension_loaded()</strong>
   * <strong>dl()</strong>
   * <strong>phpinfo()</strong>


id: get_magic_quotes_gpc
type: function
doc:
<comment>Description:</comment>
  Obtém a configuração atual de magic_quotes_gpc
  
  Sempre retorna <info>false</info>.

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

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>get_magic_quotes_runtime()</strong>
   * <strong>ini_get()</strong>


id: get_magic_quotes_runtime
type: function
doc:
<comment>Description:</comment>
  Obtém a configuração ativa para magic_quotes_runtime
  
  Sempre retorna <info>false</info>.

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

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


id: get_mangled_object_vars
type: function
doc:
<comment>Description:</comment>
  Retorna um array de nomes únicos e valores das propriedades do objeto
  
  Retorna um <info>array</info> cujos elementos são as propriedades de <strong>$object</strong>. As chaves são os nomes das
  variáveis membras, com algumas exceções notáveis: variáveis privadas têm o nome da classe
  prefixada ao nome da variável, e variáveis protegidas têm um <return>*</return> prefixado ao nome da variável.
  Estes valores prefixados têm bytes <return>NUL</return> de cada um dos lados. Propriedades tipadas não
  inicializadas são silenciosamente descartadas.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Uma instância de objeto.

<comment>Return:</comment>
  <info>array</info>  Retorna um <info>array</info> contendo todas as propriedades de <strong>$object</strong>, independente da visibilidade.

<comment>See Also:</comment>
   * <strong>get_class_vars()</strong>
   * <strong>get_object_vars()</strong>


id: get_meta_tags
type: function
doc:
<comment>Description:</comment>
  Extracts all meta tag content attributes from a file and returns an array
  
  Opens <strong>$filename</strong> and parses it line by line for \<meta&gt; tags in the file. The parsing stops at <return>\</head&gt;</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          The path to the HTML file, as a string. This can be a local file or an
                             URL.
                             
                             What <strong>get_meta_tags()</strong> parses
                             
                             
                             
                              
                             ]]>
  <info>bool</info>    <strong>$use_include_path</strong>  Setting <strong>$use_include_path</strong> to <info>true</info> will result in PHP trying to open the
                             file along the standard include path as per the include_path directive.
                             This is used for local files, not URLs.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array with all the parsed meta tags.
               
               The value of the name property becomes the key, the value of the content property
               becomes the value of the returned array, so you can easily use standard array
               functions to traverse it or access single values.  Special characters in the value of
               the name property are substituted with '_', the rest is converted to lower case.  If
               two meta tags have the same name, only the last one is returned.
               
               Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>htmlentities()</strong>
   * <strong>urlencode()</strong>


id: get_object_vars
type: function
doc:
<comment>Description:</comment>
  Obtém as propriedades de um objeto
  
  Obtém as propriedades não estáticas acessíveis do <strong>$object</strong> informado de acordo com o escopo.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Uma instância de objeto.

<comment>Return:</comment>
  <info>array</info>  Retorna um array associativo das propriedades não estáticas acessíveis definidas para o
         <strong>$object</strong> especificado dentro do escopo.

<comment>See Also:</comment>
   * <strong>get_class_methods()</strong>
   * <strong>get_class_vars()</strong>


id: get_parent_class
type: function
doc:
<comment>Description:</comment>
  Obtém o nome da classe pai para o objeto ou classe
  
  Obtém o nome da classe pai para o objeto ou classe.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  O objeto testado ou o nome da classe. Este parâmetro é opcional
                                   se chamado pelo método do objeto.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome da classe pai da classe da qual <strong>$object_or_class</strong> é uma instância ou o
                nome.
                
                Se o objeto não tem um pai ou a classe informada não existe, será retornado <info>false</info>.
                
                Se chamada sem parâmetro fora do objeto, esta função retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>get_class()</strong>
   * <strong>is_subclass_of()</strong>
   * <strong>class_parents()</strong>


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


id: get_resource_id
type: function
doc:
<comment>Description:</comment>
  Retorna um idenficador inteiro para o recurso informado
    
  
  Esta função fornece uma maneira segura (do ponto de vista de tipo) de gerar o identificador
  inteiro para um recurso.

<comment>Param:</comment>
  <info>resource</info>  <strong>$resource</strong>  O manipulador de recurso a ser avaliado.

<comment>Return:</comment>
  <info>int</info>  O identificador <info>int</info> para o recurso informado em <strong>$resource</strong>.
       
       Esta função é essencialmente uma conversão para <info>int</info> do parâmetro <strong>$resource</strong> para tornar mais
       fácil a obtenção do ID do recurso.

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


id: get_resource_type
type: function
doc:
<comment>Description:</comment>
  Retorna o tipo de recurso
    
  
  Essa função obtém o tipo do recurso informado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$resource</strong>  O manipulador de recurso a ser avaliado.

<comment>Return:</comment>
  <info>string</info>  Se o parâmetro <strong>$resource</strong> for um recurso, esta função retornará uma string representando
          seu tipo. Se o tipo não for identificado por esta função, o valor de retorno será a string
          <return>Unknown</return>.
          
          Esta função retornará <info>null</info> e gerará um erro se <strong>$resource</strong> não for um recurso do tipo
          <info>resource</info>.

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


id: get_resources
type: function
doc:
<comment>Description:</comment>
  Returns active resources
  
  Returns an array of all currently active <info>resource</info>s, optionally filtered by resource type.
  
  This function is meant for debugging and testing purposes. It is not supposed to be used in
  production environments, especially not to access or even manipulate resources which are normally
  not accessible (e.g. the underlying stream resource of <class>SplFileObject</class> instances).

<comment>Param:</comment>
  <info>string|null</info>  <strong>$type</strong>  If defined, this will cause <strong>get_resources()</strong> to only return resources of the
                      given type. A list of resource types is available.
                      
                      If the <info>string</info> <return>Unknown</return> is provided as the type, then only resources that are of
                      an unknown type will be returned.
                      
                      If omitted, all resources will be returned.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of currently active resources, indexed by resource number.

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_defined_constants()</strong>
   * <strong>get_defined_functions()</strong>
   * <strong>get_defined_vars()</strong>


id: getallheaders
type: function
doc:
<comment>Description:</comment>
  Obtém todos os cabeçalhos da requisição HTTP
  
  Obtém todos cabeçalhos HTTP da requisição atual.
  
  Essa função é um sinônimo de <strong>apache_request_headers()</strong>. Veja a documentação de
  <strong>apache_request_headers()</strong> para mais informações dessa função.

<comment>Return:</comment>
  <info>array</info>  Um array associativo de todos cabeçalhos HTTP da requisição atual, ou <info>false</info> em caso de
         falha.

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


id: getcwd
type: function
doc:
<comment>Description:</comment>
  Obtém o diretório atual
  
  Obtém o diretório atual.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o diretório atual em sucesso, ou <info>false</info> em falha.
                
                Em algunmas variantes Unix, <strong>getcwd()</strong> irá retornar <info>false</info> se qualquer um dos
                diretórios-pai não tiver o modo leitura ou pesquisa definidos, mesmo se diretório
                atual tiver. Consulte <strong>chmod()</strong> para mais informação sobre modos e permissões.

<comment>See Also:</comment>
   * <strong>chdir()</strong>
   * <strong>chmod()</strong>


id: getdate
type: function
doc:
<comment>Description:</comment>
  Recupera informações de data/hora
  
  Retorna um <info>array</info> associativo contendo a informação da data do <strong>$timestamp</strong>, ou o horário atual local
  se <strong>$timestamp</strong> for <info>null</info> ou omitido.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$timestamp</strong>  O parâmetro opcional <strong>$timestamp</strong> é um
                        <info>int</info> de timestamp Unix cujo padrão é a hora local
                        atual se <strong>$timestamp</strong> não for informado ou for <info>null</info>. Em outras
                        palavras, o padrão é o valor de <strong>time()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna um <info>array</info> associativo de informação sobre o <strong>$timestamp</strong>. Os elementos do array
         associativo são os seguintes:
         
         Elementos chave de retorno do array associativoChaveDescriçãoExemplo dos valores
         retornados<return>"seconds"</return>Representação numérica dos segundos<return>0</return> a <return>59</return><return>"minutes"</return>Representação numérica
         dos minutos<return>0</return> a <return>59</return><return>"hours"</return>Representação numérica das horas<return>0</return> a <return>23</return><return>"mday"</return>Representação numérica
         do dia do mês<return>1</return> a <return>31</return><return>"wday"</return>Representação numérica do dia da semana<return>0</return> (para Sunday) a <return>6</return> (para
         Saturday)<return>"mon"</return>Representação numérica de um mês<return>1</return> a <return>12</return><return>"year"</return>Representação numérica completa
         do ano, 4 dígitosExemplos: <return>1999</return> ou <return>2003</return><return>"yday"</return>Representação numérica do dia do ano<return>0</return> a
         <return>365</return><return>"weekday"</return>Representação textual completa do dia da semana<return>Sunday</return> a
         <return>Saturday</return><return>"month"</return>Representação textual completa de um mês, tal como January ou March<return>January</return> a
         <return>December</return><return>0</return> Segundos desde a época UNIX, similar ao valor retornados pela função <strong>time()</strong> e
         utilizado pela função <strong>date()</strong>.  Dependente do sistema, tipicamente <return>-2147483648</return> à <return>2147483647</return>.

<comment>See Also:</comment>
   * <strong>date()</strong>
   * <strong>idate()</strong>
   * <strong>localtime()</strong>
   * <strong>time()</strong>
   * <strong>setlocale()</strong>


id: getenv
type: function
doc:
<comment>Description:</comment>
  Gets the value of a single or all environment variables
  
  Gets the value of a single or all environment variables.
  
  You can see a list of all the environmental variables by using <strong>phpinfo()</strong>. Many of these variables
  are listed within RFC 3875, specifically section 4.1, "Request Meta-Variables".

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>        The variable name as a <info>string</info> or <info>null</info>.
  <info>bool</info>         <strong>$local_only</strong>  When set to <info>true</info>, only local environment variables are returned, set by
                            the operating system or putenv. It only has an effect when <strong>$name</strong> is a
                            <info>string</info>.

<comment>Return:</comment>
  <info>string|array|false</info>  Returns the value of the environment variable <strong>$name</strong>, or <info>false</info> if the
                      environment variable <strong>$name</strong> does not exist. If <strong>$name</strong> is <info>null</info>, all environment
                      variables are returned as an associative <info>array</info>.

<comment>See Also:</comment>
   * <strong>putenv()</strong>
   * <strong>apache_getenv()</strong>
   * Superglobals


id: gethostbyaddr
type: function
doc:
<comment>Description:</comment>
  Obtém nome do servidor de Internet correspondente ao endereço de IP fornecido
    
  
  Retorna o nome do servidor de Internet especificado por <strong>$ip</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>  O endereço IP do host.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome do servidor em caso de sucesso, o <strong>$ip</strong> não modificado em caso de
                falha, ou <info>false</info> em caso de entrada mal formatada.

<comment>See Also:</comment>
   * <strong>gethostbyname()</strong>
   * <strong>gethostbynamel()</strong>


id: gethostbyname
type: function
doc:
<comment>Description:</comment>
  Obtenha o endereço IPv4 correspondente a um determinado nome de host da Internet
    
  
  Retorna o endereço IPv4 do host da Internet especificado por <strong>$hostname</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  O nome do host.

<comment>Return:</comment>
  <info>string</info>  Retorna o endereço IPv4 ou uma string contendo o endereço não modificado <strong>$hostname</strong> em caso
          de falha.

<comment>See Also:</comment>
   * <strong>gethostbyaddr()</strong>
   * <strong>gethostbynamel()</strong>
   * <strong>inet_pton()</strong>
   * <strong>inet_ntop()</strong>


id: gethostbynamel
type: function
doc:
<comment>Description:</comment>
  Obtenha uma lista de endereços IPv4 correspondentes a um determinado nome de host da Internet
    
  
  Retorna uma lista de endereços IPv4 aos quais o host da Internet especificado por <strong>$hostname</strong>
  resolve.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  O nome do host.

<comment>Return:</comment>
  <info>array|false</info>  Retorna uma matriz de endereços IPv4 ou <info>false</info> se o <strong>$hostname</strong> não for possivel
               resolver.

<comment>See Also:</comment>
   * <strong>gethostbyname()</strong>
   * <strong>gethostbyaddr()</strong>
   * <strong>checkdnsrr()</strong>
   * <strong>getmxrr()</strong>
   * the <return>named(8)</return> manual page


id: gethostname
type: function
doc:
<comment>Description:</comment>
  Gets the host name
  
  <strong>gethostname()</strong> gets the standard host name for  the local machine.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string with the hostname on success, otherwise <info>false</info> is  returned.

<comment>See Also:</comment>
   * <strong>gethostbyname()</strong>
   * <strong>gethostbyaddr()</strong>
   * <strong>php_uname()</strong>


id: getimagesize
type: function
doc:
<comment>Description:</comment>
  Obtém o tamanho de uma imagem
  
  A função <strong>getimagesize()</strong> irá determinar o tamanho de qualquer arquivo de imagem suportado fornecido
  e retornar as dimensões, juntamente com o tipo de arquivo e uma string de texto <return>height/width</return> a ser
  usada dentro de uma tagHTMLIMG normal, juntamente com o tipo de conteúdo HTTP correspondente.
  
  <strong>getimagesize()</strong> também pode retornar mais informações no parâmetro <strong>$image_info</strong>.
  
  Essa função espera que <strong>$filename</strong> seja um arquivo de imagem válido. Se um arquivo que não seja uma
  imagem for fornecido, ele pode ser incorretamente detectado como uma imagem, e a função será
  bem-sucedida, mas o array pode conter valores sem sentido.
  
  Não utilize a função <strong>getimagesize()</strong> para verificar se um determinado arquivo é uma imagem válida.
  Em vez disso, utilize uma solução específica para essa finalidade, como a extensão Fileinfo.
  
  Observe que os formatos JPC e JP2 podem ter componentes com diferentes profundidades de bits.
  Nesse caso, o valor "bits" representa a maior profundidade de bits encontrada. Além disso,
  arquivos JP2 podem conter <return>multiple JPEG 2000 codestreams</return>. Nesse caso, a função <strong>getimagesize()</strong>
  retorna os valores do primeiro codestream que encontra na raiz do arquivo.
  
  As informações sobre ícones são obtidas a partir do ícone com a maior taxa de bits.
  
  As imagens GIF consistem em um ou mais frames, em que cada frame pode ocupar apenas uma parte da
  imagem. O tamanho da imagem relatado pela função <strong>getimagesize()</strong> é o tamanho geral (lido do
  descritor da tela lógica).

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    Este parâmetro especifica o arquivo do qual você deseja obter informações.
                       Ele pode fazer referência a um arquivo local ou (se a configuração permitir)
                       a um arquivo remoto usando um dos streams suportados.
  <info>array</info>   <strong>$image_info</strong>  Este parâmetro opcional permite extrair informações estendidas do arquivo de
                       imagem. Atualmente, isso retornará os diferentes marcadores APP JPG como um
                       array associativo. Alguns programas usam esses marcadores APP para incorporar
                       informações de texto em imagens. Um dos usos comuns é incorporar informações
                       IPTC no marcador APP13. Você pode usar a função <strong>iptcparse()</strong> para analisar o
                       marcador binário APP13 em algo legível.
                       
                       O parâmetro <strong>$image_info</strong> suporta apenas arquivos no formato JFIF.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array com até 7 elementos. Nem todos os tipos de imagem incluirão os
               elementos <return>channels</return> e <return>bits</return>.
               
               O índice 0 e 1 contém, respectivamente, a largura e a altura da imagem.
               
               Alguns formatos podem não conter nenhuma imagem ou podem conter várias imagens.
               Nesses casos, a função <strong>getimagesize()</strong> pode não ser capaz de determinar corretamente o
               tamanho da imagem. A função <strong>getimagesize()</strong> retornará zero para largura e altura
               nesses casos.
               
               O índice 2 é uma das constantes IMAGETYPE_XXX, que indica o tipo da imagem.
               
               O índice 3 é uma sequência de texto com a string correta <return>height="yyy" width="xxx"</return> que
               pode ser usada diretamente em uma tag IMG.
               
               <return>mime</return> é o tipo MIME correspondente da imagem. Essa informação pode ser usada para
               fornecer imagens com o cabeçalho <return>Content-type</return> HTTP correto: <strong>getimagesize()</strong> e tipos
               MIME.
               ]]>
               
               <return>channels</return> Será 3 para imagens RGB e 4 para imagens CMYK.
               
               <return>bits</return> é o número de bits para cada cor.
               
               Para alguns tipos de imagem, a presença dos valores de <return>channels</return> e <return>bits</return> pode ser um
               pouco confusa. Por exemplo, o formato GIF sempre utiliza 3 canais por pixel, mas o
               número de bits por pixel não pode ser calculado para um GIF animado com uma tabela de
               cores global.
               
               Em caso de falha, é retornado <info>false</info>.

<comment>See Also:</comment>
   * <strong>image_type_to_mime_type()</strong>
   * <strong>exif_imagetype()</strong>
   * <strong>exif_read_data()</strong>
   * <strong>exif_thumbnail()</strong>
   * <strong>imagesx()</strong>
   * <strong>imagesy()</strong>


id: getimagesizefromstring
type: function
doc:
<comment>Description:</comment>
  Get the size of an image from a string
  
  Identical to <strong>getimagesize()</strong> except that <strong>getimagesizefromstring()</strong> accepts a string instead of a
  file name as the first parameter.
  
  See the <strong>getimagesize()</strong> documentation for details on how this function works.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      The image data, as a string.
  <info>array</info>   <strong>$image_info</strong>  See <strong>getimagesize()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  See <strong>getimagesize()</strong>.

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


id: getlastmod
type: function
doc:
<comment>Description:</comment>
  Obtém o horário da última modificação na página
  
  Obtém o horário da última modificação do script principal de execução.
  
  Se o objetivo for obter o horário da última modificação de um arquivo diferente, considere usar
  <strong>filemtime()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o tempo da última modificação na página atual. O valor é retornado como um
             timestamp Unix, útil para usar com a função <strong>date()</strong>. Retorna <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>date()</strong>
   * <strong>getmyuid()</strong>
   * <strong>getmygid()</strong>
   * <strong>get_current_user()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getmypid()</strong>
   * <strong>filemtime()</strong>


id: getmxrr
type: function
doc:
<comment>Description:</comment>
  Get MX records corresponding to a given Internet host name
  
  Searches DNS for MX records corresponding to  <strong>$hostname</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  The Internet host name.
  <info>array</info>   <strong>$hosts</strong>     A list of the MX records found is placed into the array <strong>$hosts</strong>.
  <info>array</info>   <strong>$weights</strong>   If the <strong>$weights</strong> array is given, it will be filled with the weight information
                     gathered.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if any records are found; returns <info>false</info> if no records were found or if an error
        occurred.

<comment>See Also:</comment>
   * <strong>checkdnsrr()</strong>
   * <strong>dns_get_record()</strong>
   * <strong>gethostbyname()</strong>
   * <strong>gethostbynamel()</strong>
   * <strong>gethostbyaddr()</strong>
   * the <return>named(8)</return> manual page


id: getmygid
type: function
doc:
<comment>Description:</comment>
  Obtém o GID do proprietário do script PHP
  
  Obtém o ID do grupo do script atual.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o ID do grupo do script atual, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>getmyuid()</strong>
   * <strong>getmypid()</strong>
   * <strong>get_current_user()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getlastmod()</strong>


id: getmyinode
type: function
doc:
<comment>Description:</comment>
  Gets the inode of the current script
  
  Gets the inode of the current script.

<comment>Return:</comment>
  <info>int|false</info>  Returns the current script's inode as an integer, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>getmygid()</strong>
   * <strong>getmyuid()</strong>
   * <strong>getmypid()</strong>
   * <strong>get_current_user()</strong>
   * <strong>getlastmod()</strong>


id: getmypid
type: function
doc:
<comment>Description:</comment>
  Obtém o ID do processo PHP
  
  Obtém o ID do processo atual do PHP.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o ID do processo atual do PHP, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>getmygid()</strong>
   * <strong>getmyuid()</strong>
   * <strong>get_current_user()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getlastmod()</strong>


id: getmyuid
type: function
doc:
<comment>Description:</comment>
  Obtém o UID do proprietário do script PHP
  
  Obtém o ID do usuário do script atual.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o ID do usuário do script atual, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>getmygid()</strong>
   * <strong>getmypid()</strong>
   * <strong>get_current_user()</strong>
   * <strong>getmyinode()</strong>
   * <strong>getlastmod()</strong>


id: getopt
type: function
doc:
<comment>Description:</comment>
  Obtêm opções da linha de comando
  
  Extrai as opções passadas para o script.

<comment>Param:</comment>
  <info>string</info>  <strong>$short_options</strong>  Cada caracter nessa string será usada como uma opção e comparada contra as
                          opções passadas para o script prefixadas com um único hífen (<return>-</return>).
                          
                          Por exemplo, a string <return>"x"</return> reconhece a opção <return>-x</return>.
                          
                          Somente a-z, A-Z e 0-9 são permitidos.
  <info>array</info>   <strong>$long_options</strong>   Um array de opções. Cada elemento desse array será usado como uma string
                          de opção e comparada contra as opções passadas para o script com dois
                          hífens (<return>--</return>).
                          
                          Por exemplo, um elemento longopts <return>"opt"</return> reconhece a opção <return>--opt</return>.
  <info>int</info>     <strong>$rest_index</strong>     Se o parâmetro <strong>$rest_index</strong> estiver presente, então o índice onde a
                          interpretação de argumentos parou será escrita nessa variável.

<comment>Return:</comment>
  <info>array|false</info>  Esta função retorna um array de pares de opções e argumentos,  ou <info>false</info> em caso de
               falha.
               
               A interpretação de opções irá parar na primeira opção desconhecida, e tudo o mais
               será descartado.

<comment>See Also:</comment>
   * $argv


id: getprotobyname
type: function
doc:
<comment>Description:</comment>
  Get protocol number associated with protocol name
  
  <strong>getprotobyname()</strong> returns the protocol number associated with the protocol <strong>$protocol</strong> as per
  /etc/protocols.

<comment>Param:</comment>
  <info>string</info>  <strong>$protocol</strong>  The protocol name.

<comment>Return:</comment>
  <info>int|false</info>  Returns the protocol number,  ou <info>false</info> em caso de falha.

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


id: getprotobynumber
type: function
doc:
<comment>Description:</comment>
  Get protocol name associated with protocol number
  
  <strong>getprotobynumber()</strong> returns the protocol name associated with protocol <strong>$protocol</strong> as per
  /etc/protocols.

<comment>Param:</comment>
  <info>int</info>  <strong>$protocol</strong>  The protocol number.

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

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


id: 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>rand()</strong>.

<comment>Return:</comment>
  <info>int</info>  The largest possible random value returned by <strong>rand()</strong>

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


id: getrusage
type: function
doc:
<comment>Description:</comment>
  Gets the current resource usages
  
  This is an interface to getrusage(2). It gets data returned from the system call.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  If <strong>$mode</strong> is 1, getrusage will be called with <info>RUSAGE_CHILDREN</info>.

<comment>Return:</comment>
  <info>array|false</info>  Returns an associative array containing the data returned from the system call. All
               entries are accessible by using their documented field names. Returns <info>false</info> on
               failure.

<comment>See Also:</comment>
   * Your system's man page on getrusage(2)


id: getservbyname
type: function
doc:
<comment>Description:</comment>
  Get port number associated with an Internet service and protocol
  
  <strong>getservbyname()</strong> returns the Internet port which corresponds to <strong>$service</strong> for the specified
  <strong>$protocol</strong> as per /etc/services.

<comment>Param:</comment>
  <info>string</info>  <strong>$service</strong>   The Internet service name, as a string.
  <info>string</info>  <strong>$protocol</strong>  <strong>$protocol</strong> is either <return>"tcp"</return> or <return>"udp"</return> (in lowercase).

<comment>Return:</comment>
  <info>int|false</info>  Returns the port number, or <info>false</info> if <strong>$service</strong> or <strong>$protocol</strong> is not found.

<comment>See Also:</comment>
   * <strong>getservbyport()</strong>
   * http://www.iana.org/assignments/port-numbers
     for a complete list of port numbers.
    


id: getservbyport
type: function
doc:
<comment>Description:</comment>
  Get Internet service which corresponds to port and protocol
  
  <strong>getservbyport()</strong> returns the Internet service associated with <strong>$port</strong> for the specified <strong>$protocol</strong> as
  per /etc/services.

<comment>Param:</comment>
  <info>int</info>     <strong>$port</strong>      The port number.
  <info>string</info>  <strong>$protocol</strong>  <strong>$protocol</strong> is either <return>"tcp"</return> or <return>"udp"</return> (in lowercase).

<comment>Return:</comment>
  <info>string|false</info>  Returns the Internet service name as a string,  ou <info>false</info> em caso de falha.

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


id: gettext
type: function
doc:
<comment>Description:</comment>
  Lookup a message in the current domain
  
  Looks up a message in the current domain.

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

<comment>Return:</comment>
  <info>string</info>  Returns a translated <info>string</info> if one is found in the  translation table, or the submitted
          message if not found.

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


id: gettimeofday
type: function
doc:
<comment>Description:</comment>
  Obtém o horário atual
  
  Esta é uma interface para gettimeofday(2). Retorna um array contendo os dados retornando a chamada
  ao sistema.

<comment>Param:</comment>
  <info>bool</info>  <strong>$as_float</strong>  Quando definido como <info>true</info>, um float, ao invés de array, é retornado.

<comment>Return:</comment>
  <info>array|float</info>  Por padrão, um <info>array</info> é retornado. Se o parâmetro <strong>$as_float</strong> é definido, então um <info>float</info>
               é retornado.
               
               Array keys:  "sec" - segundos desde a época Unix  "usec" - microsegundos
               "minuteswest" - minutos a oeste de Greenwich  "dsttime" - tipo de correção dst
               
               "sec" - segundos desde a época Unix
               
               "usec" - microsegundos
               
               "minuteswest" - minutos a oeste de Greenwich
               
               "dsttime" - tipo de correção dst


id: gettype
type: function
doc:
<comment>Description:</comment>
  Obtém o tipo de uma variável
  
  Retorna o tipo da variável PHP <strong>$value</strong>. Para checagem de tipo, utilize as funções <return>is_*</return>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  A variável a ter o tipo verificado.

<comment>Return:</comment>
  <info>string</info>  Os valores possíveis para a string retornada são: <return>"boolean"</return> - booleano <return>"integer"</return> - inteiro
          <return>"double"</return> - ponto flutuante (por razões históricas, <return>"double"</return> é retornado no caso de um
          <info>float</info>, e não simplesmente <return>"float"</return>) <return>"string"</return> - cadeia de caracteres <return>"array"</return><return>"object"</return> -
          objeto <return>"resource"</return> - recurso <return>"resource (closed)"</return> a partir do PHP 7.2.0 - recurso (fechado)
          <return>"NULL"</return> - nulo <return>"unknown type"</return> - tipo desconhecido

<comment>See Also:</comment>
   * <strong>get_debug_type()</strong>
   * <strong>settype()</strong>
   * <strong>get_class()</strong>
   * <strong>is_array()</strong>
   * <strong>is_bool()</strong>
   * <strong>is_callable()</strong>
   * <strong>is_float()</strong>
   * <strong>is_int()</strong>
   * <strong>is_null()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_object()</strong>
   * <strong>is_resource()</strong>
   * <strong>is_scalar()</strong>
   * <strong>is_string()</strong>
   * <strong>function_exists()</strong>
   * <strong>method_exists()</strong>


id: glob
type: function
doc:
<comment>Description:</comment>
  Acha caminhos que combinam com um padrão
  
  A função <strong>glob()</strong> procura por todos os caminhos que combinem com o padrão <strong>$pattern</strong> de acordo com as
  regras usadas pela função glob() da libc, que é semelhante às regras usadas por shells comuns.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  O padrão. Não é feita nenhuma expansão de til ou substituição de parâmetros.
                    
                    Caracteres especiais: <return>*</return> - Corresponde a zero ou mais caracteres. <return>?</return> - Corresponde
                    a exatamente um caractere (qualquer caractere). <return>[...]</return> - Corresponde a um
                    caractere de um grupo de caracteres. Se o primeiro caractere for <return>!</return>, corresponde
                    a qualquer caractere que não estiver no grupo. <return>\</return> - Faz escape no caractere
                    seguinte, exceto quando a opção <info>GLOB_NOESCAPE</info> for usada.
                    
                    <return>*</return> - Corresponde a zero ou mais caracteres.
                    
                    <return>?</return> - Corresponde a exatamente um caractere (qualquer caractere).
                    
                    <return>[...]</return> - Corresponde a um caractere de um grupo de caracteres. Se o primeiro
                    caractere for <return>!</return>, corresponde a qualquer caractere que não estiver no grupo.
                    
                    <return>\</return> - Faz escape no caractere seguinte, exceto quando a opção <info>GLOB_NOESCAPE</info> for
                    usada.
  <info>int</info>     <strong>$flags</strong>    Opções válidas: <info>GLOB_MARK</info> - Acrescenta uma barra (ou barra invertida no Windows)
                    a cada diretório retornado <info>GLOB_NOSORT</info> - Retorna os arquivos conforme eles
                    aparecem no diretório (sem ordenação). Quando esta flag não é utilizada os
                    caminhos são ordenados alfabeticamente. <info>GLOB_NOCHECK</info> - Retorna o padrão da busca
                    se nenhuma combinação de arquivo for encontrada <info>GLOB_NOESCAPE</info> - Barras
                    invertidas não escapam metacaracteres. <info>GLOB_BRACE</info> - Expande {a,b,c} para
                    combinar com 'a', 'b' ou 'c' <info>GLOB_ONLYDIR</info> - Retorna apenas diretórios que
                    combinem com o padrão <info>GLOB_ERR</info> - Pára em erros de leitura (como diretórios que
                    não podem ser lidos), por padrão os erros são ignorados.   A opção <info>GLOB_BRACE</info>
                    não está disponível em alguns sistemas não GNU, como Solaris ou Alpine Linux.
                    
                    <info>GLOB_MARK</info> - Acrescenta uma barra (ou barra invertida no Windows) a cada
                    diretório retornado
                    
                    <info>GLOB_NOSORT</info> - Retorna os arquivos conforme eles aparecem no diretório (sem
                    ordenação). Quando esta flag não é utilizada os caminhos são ordenados
                    alfabeticamente.
                    
                    <info>GLOB_NOCHECK</info> - Retorna o padrão da busca se nenhuma combinação de arquivo for
                    encontrada
                    
                    <info>GLOB_NOESCAPE</info> - Barras invertidas não escapam metacaracteres.
                    
                    <info>GLOB_BRACE</info> - Expande {a,b,c} para combinar com 'a', 'b' ou 'c'
                    
                    <info>GLOB_ONLYDIR</info> - Retorna apenas diretórios que combinem com o padrão
                    
                    <info>GLOB_ERR</info> - Pára em erros de leitura (como diretórios que não podem ser lidos),
                    por padrão os erros são ignorados.
                    
                    A opção <info>GLOB_BRACE</info> não está disponível em alguns sistemas não GNU, como Solaris
                    ou Alpine Linux.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array contendo os arquivos/diretórios que corresponderam, um array vazio
               se nenhum arquivo correspondeu ou <info>false</info> em caso de erro.
               
               Em alguns sistemas é impossível distinguir entre resultado vazio ou um erro.

<comment>See Also:</comment>
   * <strong>opendir()</strong>
   * <strong>readdir()</strong>
   * <strong>closedir()</strong>
   * <strong>fnmatch()</strong>


id: gmdate
type: function
doc:
<comment>Description:</comment>
  Formata uma data/hora GMT/CUT
  
  Idêntica à função <strong>date()</strong>, exceto que a hora retornada será baseada no Horário de Greenwich (GMT).

<comment>Param:</comment>
  <info>string</info>    <strong>$format</strong>     O formato da saída da <info>string</info> da data. Veja as opções de formatação para a
                        função <strong>date()</strong>.
  <info>int|null</info>  <strong>$timestamp</strong>  O parâmetro opcional <strong>$timestamp</strong> é um
                        <info>int</info> de timestamp Unix cujo padrão é a hora local
                        atual se <strong>$timestamp</strong> não for informado ou for <info>null</info>. Em outras
                        palavras, o padrão é o valor de <strong>time()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna uma string da data formatada.

<comment>See Also:</comment>
   * DateTimeImmutable::__construct
   * DateTimeInterface::format
   * <strong>date()</strong>
   * <strong>mktime()</strong>
   * <strong>gmmktime()</strong>
   * IntlDateFormatter::format


id: gmmktime
type: function
doc:
<comment>Description:</comment>
  Obtém um timestamp Unix para uma data GMT
  
  Idêntico ao <strong>mktime()</strong> exceto que os parâmetros representam uma data GMT. A função <strong>gmmktime()</strong> usa
  internamente a função <strong>mktime()</strong>, significando que somente horários válidos derivados de horários
  locais podem ser utilizados.
  
  Como em <strong>mktime()</strong>, argumentos opcionais podem ser omitidos da direita para esquerda, com todos os
  argumentos omitidos sendo definidos para o valor GMT correspondente.
  
  Chamar <strong>gmmktime()</strong> sem nenhum argumento não é suportado, e vai resultar em um <class>ArgumentCountError</class>.
  <strong>time()</strong> pode ser usado para obter o horário atual.

<comment>Param:</comment>
  <info>int</info>       <strong>$hour</strong>    O número de horas relativas ao início do dia determinadas pelos parâmetros
                     <strong>$month</strong>, <strong>$day</strong> and <strong>$year</strong>. Valores negativos são referenciados à horas antes da
                     meia noite do dia em questão. Valores maiores que 23 referenciam horas
                     correspondentes ao(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, incluso) 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, incluso) 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 ano

<comment>Return:</comment>
  <info>int|false</info>  Retorna um <info>int</info> timestamp Unix em caso de sucesso, ou <info>false</info> se o timestamp não couber em
             um número inteiro do PHP.

<comment>See Also:</comment>
   * A classe <class>DateTimeImmutable</class>
   * <strong>mktime()</strong>
   * <strong>date()</strong>
   * <strong>time()</strong>


id: gmp_abs
type: function
doc:
<comment>Description:</comment>
  Valor absoluto
  
  Obtém o valor absoluto de um número.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Retorna o valor absoluto de <strong>$num</strong>, como um número GMP.


id: gmp_add
type: function
doc:
<comment>Description:</comment>
  Adiciona números
  
  Adiciona dois números.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  A primeira parcela.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  A segunda parcela.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um número GMP representado a soma dos argumentos.


id: gmp_and
type: function
doc:
<comment>Description:</comment>
  Operação binária AND
  
  Faz a operação binária AND de dois números GMP.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um número GMP representando a comparação binária <return>AND</return>.


id: gmp_binomial
type: function
doc:
<comment>Description:</comment>
  Calculates binomial coefficient
  
  Calculates the binomial coefficient C(n, k).

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$n</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$k</strong>  

<comment>Return:</comment>
  <info>GMP</info>  Returns the binomial coefficient C(n, k).


id: gmp_clrbit
type: function
doc:
<comment>Description:</comment>
  Clear bit
  
  Clears (sets to 0) bit <strong>$index</strong> in <strong>$num</strong>. The index starts at 0.

<comment>Param:</comment>
  <info>GMP</info>  <strong>$num</strong>    A <class>GMP</class> object.
  <info>int</info>  <strong>$index</strong>  The index of the bit to clear.  Index 0 represents the least significant bit.

<comment>Return:</comment>
  <info>void</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * <strong>gmp_setbit()</strong>
   * <strong>gmp_testbit()</strong>


id: gmp_cmp
type: function
doc:
<comment>Description:</comment>
  Compara números
  
  Compara dois números.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>int</info>  Retorna um valor positivo se <return>a &gt; b</return>, zero se <return>a = b</return> e um valor negativo se <return>a \< b</return>.


id: gmp_com
type: function
doc:
<comment>Description:</comment>
  Calcula o complemento de um
  
  Retorna o complemento de um do valor <strong>$num</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Retorna o complemento de um do valor <strong>$num</strong>, como um número GMP.


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


id: gmp_div_q
type: function
doc:
<comment>Description:</comment>
  Divide numbers
  
  Divides <strong>$num1</strong> by <strong>$num2</strong> and returns the integer result.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>           The number being divided.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>           The number that <strong>$num1</strong> is being divided by.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$rounding_mode</strong>  The result rounding is defined by the <strong>$rounding_mode</strong>, which can
                                  have the following values: <info>GMP_ROUND_ZERO</info>: The result is truncated
                                  towards 0. <info>GMP_ROUND_PLUSINF</info>: The result is rounded towards
                                  <return>+infinity</return>. <info>GMP_ROUND_MINUSINF</info>: The result is rounded towards
                                  <return>-infinity</return>.
                                  
                                  <info>GMP_ROUND_ZERO</info>: The result is truncated towards 0.
                                  
                                  <info>GMP_ROUND_PLUSINF</info>: The result is rounded towards <return>+infinity</return>.
                                  
                                  <info>GMP_ROUND_MINUSINF</info>: The result is rounded towards <return>-infinity</return>.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * <strong>gmp_div_r()</strong>
   * <strong>gmp_div_qr()</strong>


id: gmp_div_qr
type: function
doc:
<comment>Description:</comment>
  Divide numbers and get quotient and remainder
  
  The function divides <strong>$num1</strong> by <strong>$num2</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>           The number being divided.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>           The number that <strong>$num1</strong> is being divided by.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$rounding_mode</strong>  See the <strong>gmp_div_q()</strong> function for description of the <strong>$rounding_mode</strong>
                                  argument.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info>, with the first element being <return>[n/d]</return> (the integer result of the division)
         and the second being <return>(n - [n/d] * d)</return> (the remainder of the division).

<comment>See Also:</comment>
   * <strong>gmp_div_q()</strong>
   * <strong>gmp_div_r()</strong>


id: gmp_div_r
type: function
doc:
<comment>Description:</comment>
  Remainder of the division of numbers
  
  Calculates remainder of the integer division of <strong>$num1</strong> by <strong>$num2</strong>. The remainder has the sign of the
  <strong>$num1</strong> argument, if not zero.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>           The number being divided.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>           The number that <strong>$num1</strong> is being divided by.
                                  
                                  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$rounding_mode</strong>  See the <strong>gmp_div_q()</strong> function for description of the <strong>$rounding_mode</strong>
                                  argument.

<comment>Return:</comment>
  <info>GMP</info>  The remainder, as a GMP number.

<comment>See Also:</comment>
   * <strong>gmp_div_q()</strong>
   * <strong>gmp_div_qr()</strong>


id: gmp_divexact
type: function
doc:
<comment>Description:</comment>
  Divisão exata de números
  
  Divide <strong>$num1</strong> por <strong>$num2</strong>, usando um algoritimo rápido de "divisão exata". Esta função produz
  resultados corretos apenas quando sabe anteriormente que <strong>$num2</strong> é divisor de <strong>$num1</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  O número a ser dividido.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  O número pelo qual <strong>$num1</strong> será dividido.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_export
type: function
doc:
<comment>Description:</comment>
  Export to a binary string
  
  Export a GMP number to a binary string

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>        The GMP number being exported
  <info>int</info>             <strong>$word_size</strong>  Default value is 1. The number of bytes in each chunk of binary data.
                              This is mainly used in conjunction with the options parameter.
  <info>int</info>             <strong>$flags</strong>      Default value is <info>GMP_MSW_FIRST</info> | <info>GMP_NATIVE_ENDIAN</info>.

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

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


id: gmp_fact
type: function
doc:
<comment>Description:</comment>
  Factorial
  
  Calculates factorial (<return>num!</return>) of <strong>$num</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  The factorial number.
                        
                        Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_gcd
type: function
doc:
<comment>Description:</comment>
  Calcula o MDC
  
  Calcula o máximo divisor comum de <strong>$num1</strong> e <strong>$num2</strong>. O resultado é sempre positivo, mesmo que um ou
  ambos os argumentos sejam negativos.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um número positivo GMP divisor de <strong>$num1</strong> e <strong>$num2</strong>.

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


id: gmp_gcdext
type: function
doc:
<comment>Description:</comment>
  Calcula MDC e multiplicadores
  
  Calcula g, s, e t, de forma que <return>a*s + b*t = g = gcd(a,b)</return>, onde gcd é o máximo divisor comum (MDC).
  Retorna um array com os respectivos elementos g, s e t.
  
  Esta função pode ser usada para resolver equações lineares de Diophantine com duas variáveis. São
  equações que permitem somente soluções com inteiros e têm a forma: <return>a*x + b*y = c</return>. Para mais
  informações, acesse a página "Equação de Diophantine" (em inglês) na MathWorld.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>array</info>  Um <info>array</info> de números GMP.


id: gmp_hamdist
type: function
doc:
<comment>Description:</comment>
  Distância de Hamming
  
  Retorna a distância de Hamming entre <strong>$num1</strong> e <strong>$num2</strong>. Ambos argumentos devem ser positivos.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
                         
                         Tem que ser positivo.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
                         
                         Tem que ser positivo.

<comment>Return:</comment>
  <info>int</info>  A distância de Hamming entre <strong>$num1</strong> e <strong>$num2</strong>, do tipo <info>int</info>.

<comment>See Also:</comment>
   * <strong>gmp_popcount()</strong>
   * <strong>gmp_xor()</strong>


id: gmp_import
type: function
doc:
<comment>Description:</comment>
  Import from a binary string
  
  Import a GMP number from a binary string

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       The binary string being imported
  <info>int</info>     <strong>$word_size</strong>  Default value is 1. The number of bytes in each chunk of binary data. This is
                      mainly used in conjunction with the options parameter.
  <info>int</info>     <strong>$flags</strong>      Default value is <info>GMP_MSW_FIRST</info> | <info>GMP_NATIVE_ENDIAN</info>.

<comment>Return:</comment>
  <info>GMP</info>  Returns a GMP number.

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


id: gmp_init
type: function
doc:
<comment>Description:</comment>
  Create GMP number
  
  Creates a GMP number from an integer or string.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$num</strong>   An integer or a string. The string representation can be decimal,  hexadecimal
                     or octal.
  <info>int</info>         <strong>$base</strong>  The base.
                     
                     The base may vary from 2 to 62. If base is 0 (default value), the actual base
                     is determined from the leading characters: if the first two characters are <return>0x</return>
                     or <return>0X</return>, hexadecimal is assumed, if the first two characters are <return>0b</return> or <return>0B</return>, binary
                     is assumed, otherwise if the first character is <return>0</return>, octal is assumed, otherwise
                     decimal is assumed. For bases up to 36, case is ignored; upper-case and
                     lower-case letters have the same value. For bases 37 to 62, upper-case letter
                     represent the usual 10 to 35 while lower-case letter represent 36 to 61.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * GMP::__construct


id: gmp_intval
type: function
doc:
<comment>Description:</comment>
  Converte um número GMP para um inteiro
  
  Esta função converte um número GMP para um <info>int</info> nativo do PHP.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>int</info>  Um valor <info>int</info> de <strong>$num</strong>.


id: gmp_invert
type: function
doc:
<comment>Description:</comment>
  Inverse by modulo
  
  Computes the inverse of <strong>$num1</strong> modulo <strong>$num2</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP|false</info>  A GMP number on success or <info>false</info> if an inverse does not exist.


id: gmp_jacobi
type: function
doc:
<comment>Description:</comment>
  Símbolo de Jacobi
  
  Computa o Símbolo de Jacobi de <strong>$num1</strong> e <strong>$num2</strong>. <strong>$num2</strong> deve ser ímpar e positivo.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
                         
                         Deve ser ímpar e positivo.

<comment>Return:</comment>
  <info>int</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * <strong>gmp_kronecker()</strong>
   * <strong>gmp_legendre()</strong>


id: gmp_kronecker
type: function
doc:
<comment>Description:</comment>
  Kronecker symbol
  
  This function computes the Kronecker symbol of <strong>$num1</strong> and <strong>$num2</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>int</info>  Returns the Kronecker symbol of <strong>$num1</strong> and <strong>$num2</strong>

<comment>See Also:</comment>
   * <strong>gmp_jacobi()</strong>
   * <strong>gmp_legendre()</strong>


id: gmp_lcm
type: function
doc:
<comment>Description:</comment>
  Calculate LCM
  
  This function computes the least common multiple (lcm) of <strong>$num1</strong> and <strong>$num2</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.

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


id: gmp_legendre
type: function
doc:
<comment>Description:</comment>
  Símbolo de Legendre
  
  Computa o  Símbolo de Legendre de <strong>$num1</strong> e <strong>$num2</strong>. <strong>$num2</strong> deve ser ímpar e positivo.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
                         
                         Precisa ser ímpar e positivo.

<comment>Return:</comment>
  <info>int</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * <strong>gmp_jacobi()</strong>
   * <strong>gmp_kronecker()</strong>


id: gmp_mod
type: function
doc:
<comment>Description:</comment>
  Operação Módulo
  
  Calcula o resto da divisão de <strong>$num1</strong> por <strong>$num2</strong>. O resultado é sempre não-negativo, o sinal de <strong>$num2</strong>
  é ignorado.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  O resto da divisão (módulo) que será calculado.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_mul
type: function
doc:
<comment>Description:</comment>
  Multiplica números
  
  Multiplica <strong>$num1</strong> por <strong>$num2</strong> e retorna o resultado.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um número que será multiplicado por <strong>$num2</strong>.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um número que será multiplicado por <strong>$num1</strong>.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_neg
type: function
doc:
<comment>Description:</comment>
  Negativa o número
  
  Retorna o valor negativo de um número.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Retorna -<strong>$num</strong>, como um número GMP.


id: gmp_nextprime
type: function
doc:
<comment>Description:</comment>
  Encontra o próximo número primo
  
  Encontra o próximo número primo

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Retorna o próximo número primo maior que <strong>$num</strong>, como um número GMP.


id: gmp_or
type: function
doc:
<comment>Description:</comment>
  Operação binária OR
  
  Faz a operação binária inclusiva OR de dois números GMP.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_perfect_power
type: function
doc:
<comment>Description:</comment>
  Perfect power check
  
  Checks whether <strong>$num</strong> is a perfect power.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$num</strong> is a perfect power, <info>false</info> otherwise.

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


id: gmp_perfect_square
type: function
doc:
<comment>Description:</comment>
  Perfect square check
  
  Check if a number is a perfect square.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  The number being checked as a perfect square.
                        
                        Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$num</strong> is a perfect square, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>gmp_perfect_power()</strong>
   * <strong>gmp_sqrt()</strong>
   * <strong>gmp_sqrtrem()</strong>


id: gmp_popcount
type: function
doc:
<comment>Description:</comment>
  Contagem de população
  
  Obtém a contagem de população.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>int</info>  A contagem de população de <strong>$num</strong>, como um <info>int</info>.


id: gmp_pow
type: function
doc:
<comment>Description:</comment>
  Elevar o número a uma potência
  
  Eleva <strong>$num</strong> à potência <strong>$exponent</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>       O número da base.
                             
                             Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$exponent</strong>  A potência positiva à qual <strong>$num</strong> será elevado.

<comment>Return:</comment>
  <info>GMP</info>  O novo número (exponenciado), como um número GMP. O caso de <return>0^0</return> produz 1.


id: gmp_powm
type: function
doc:
<comment>Description:</comment>
  Eleva um número a uma potência com módulo
  
  Calcula o resto da divisão de (<strong>$num</strong> elevado à potência <strong>$exponent</strong>) por <strong>$modulus</strong>. Se <strong>$exponent</strong> for
  negativo, o resultado é indefinido.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>       O número da base.
                             
                             Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$exponent</strong>  A potência positiva à qual <strong>$num</strong> será elevado.
                             
                             Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$modulus</strong>   O divisor para obtenção do resto (módulo).
                             
                             Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  O novo número (exponenciado), como um número GMP.


id: gmp_prob_prime
type: function
doc:
<comment>Description:</comment>
  Check if number is "probably prime"
  
  The function uses Miller-Rabin's probabilistic test to check if a number is a prime.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>          The number being checked as a prime.
                                
                                Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$repetitions</strong>  Reasonable values of <strong>$repetitions</strong> vary from 5 to 10 (default being
                                10); a higher value lowers the probability for a non-prime to pass
                                as a "probable" prime.
                                
                                Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>int</info>  If this function returns 0, <strong>$num</strong> is definitely not prime. If it returns 1, then <strong>$num</strong> is
       "probably" prime.  If it returns 2, then <strong>$num</strong> is surely prime.


id: gmp_random
type: function
doc:
<comment>Description:</comment>
  Random number
  
  Generate a random number. The number will be between 0 and (2 ** n) - 1, where n is the number of
  bits per limb multiplied by <strong>$limiter</strong>. If <strong>$limiter</strong> is negative, negative numbers are generated.
  
  A limb is an internal GMP mechanism. The number of bits in a limb is not static, and can vary from
  system to system. Generally, the number of bits in a limb is either 32 or 64, but this is not
  guaranteed.
  
  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>$limiter</strong>  The limiter.
                 
                 Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  A random GMP number.


id: gmp_random_bits
type: function
doc:
<comment>Description:</comment>
  Random number
  
  Generate a random number. The number will be between <return>0</return> and <return>2$bits - 1</return>.
  
  <strong>$bits</strong> must greater than 0, and the maximum value is restricted by available memory.
  
  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>$bits</strong>  The number of bits to generate.

<comment>Return:</comment>
  <info>GMP</info>  A random GMP number.


id: gmp_random_range
type: function
doc:
<comment>Description:</comment>
  Get a uniformly selected integer
  
  Generate a random number. The number will be between <strong>$min</strong> and <strong>$max</strong>.
  
  <strong>$min</strong> and <strong>$max</strong> can both be negative, but <strong>$min</strong> must always be less than <strong>$max</strong>.
  
  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>GMP|int|string</info>  <strong>$min</strong>  A GMP number representing the lower bound for the random number
  <info>GMP|int|string</info>  <strong>$max</strong>  A GMP number representing the upper bound for the random number

<comment>Return:</comment>
  <info>GMP</info>  Returns a <class>GMP</class> object which contains a uniformly selected integer from the closed interval
       [<strong>$min</strong>, <strong>$max</strong>]. Both <strong>$min</strong> and <strong>$max</strong> are possible return values.


id: gmp_random_seed
type: function
doc:
<comment>Description:</comment>
  Sets the RNG seed

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$seed</strong>  The seed to be set for the <strong>gmp_random()</strong>, <strong>gmp_random_bits()</strong>, and
                         <strong>gmp_random_range()</strong> functions.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

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

<comment>See Also:</comment>
   * <strong>gmp_init()</strong>
   * <strong>gmp_random()</strong>
   * <strong>gmp_random_bits()</strong>
   * <strong>gmp_random_range()</strong>


id: gmp_root
type: function
doc:
<comment>Description:</comment>
  Take the integer part of nth root
  
  Takes the <strong>$nth</strong> root of <strong>$num</strong> and returns the integer component of the result.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$nth</strong>  The positive root to take of <strong>$num</strong>.

<comment>Return:</comment>
  <info>GMP</info>  The integer component of the resultant root, as a GMP number.


id: gmp_rootrem
type: function
doc:
<comment>Description:</comment>
  Take the integer part and remainder of nth root
  
  Takes the <strong>$nth</strong> root of <strong>$num</strong> and returns the integer component and remainder of the result.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$nth</strong>  The positive root to take of <strong>$num</strong>.

<comment>Return:</comment>
  <info>array</info>  A two element array, where the first element is the integer component of the root, and the
         second element is the remainder, both represented as GMP numbers.


id: gmp_scan0
type: function
doc:
<comment>Description:</comment>
  Scan for 0
  
  Scans <strong>$num1</strong>, starting with bit <strong>$start</strong>, towards more significant bits, until the first clear bit is
  found.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>   The number to scan.
                          
                          Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$start</strong>  The starting bit.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the found bit, as an <info>int</info>. The index starts from 0.


id: gmp_scan1
type: function
doc:
<comment>Description:</comment>
  Scan for 1
  
  Scans <strong>$num1</strong>, starting with bit <strong>$start</strong>, towards more significant bits, until the first set bit is
  found.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>   The number to scan.
                          
                          Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$start</strong>  The starting bit.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the found bit, as an <info>int</info>. If no set bit is found, -1 is returned.


id: gmp_setbit
type: function
doc:
<comment>Description:</comment>
  Set bit
  
  Sets bit <strong>$index</strong> in <strong>$num</strong>.

<comment>Param:</comment>
  <info>GMP</info>   <strong>$num</strong>    A <class>GMP</class> object.
  <info>int</info>   <strong>$index</strong>  The index of the bit to set.  Index 0 represents the least significant bit.
  <info>bool</info>  <strong>$value</strong>  True to set the bit (set it to 1/on); false to clear the bit (set it to 0/off).

<comment>Return:</comment>
  <info>void</info>  Um objeto <class>GMP</class>.

<comment>See Also:</comment>
   * <strong>gmp_clrbit()</strong>
   * <strong>gmp_testbit()</strong>


id: gmp_sign
type: function
doc:
<comment>Description:</comment>
  Sinal do número
  
  Verifica o sinal de um número.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Pode ser um objeto <class>GMP</class>, ou uma string numérica desde que seja possível
                        convertê-la para um <info>int</info>.

<comment>Return:</comment>
  <info>int</info>  Retorna 1 se <strong>$num</strong> for positivo, -1 se <strong>$num</strong> for negativo, e 0 se <strong>$num</strong> for zero.

<comment>See Also:</comment>
   * <strong>gmp_abs()</strong>
   * <strong>abs()</strong>


id: gmp_sqrt
type: function
doc:
<comment>Description:</comment>
  Calcula a raiz quadrada
  
  Calcula a raiz quadrada de <strong>$num</strong>.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  A parte inteira da raiz quadrada, como um número GMP.


id: gmp_sqrtrem
type: function
doc:
<comment>Description:</comment>
  Raiz quadrada com resto
  
  Calcula a raiz quadrada de um número, com resto.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>  O número do qual será calculada a raiz quadrada.
                        
                        Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>array</info>  Retorna um array onde o primeiro elemento é a raiz quadrada inteira de <strong>$num</strong> e o segundo é o
         resto (isto é, a diferença entre <strong>$num</strong> e o quadrado do primeiro elemento).


id: gmp_strval
type: function
doc:
<comment>Description:</comment>
  Converte um número GMP para uma string
  
  Converte o número GMP para uma representação em string na base <strong>$base</strong>. A base padrão é 10.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>   O número GMP que será convertido para uma string.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$base</strong>  A base do número retornado. A base padrão é 10. Valores permitidos para
                         base são de 2 à 62 e -2 a -36.

<comment>Return:</comment>
  <info>string</info>  O número, como uma <info>string</info>.


id: gmp_sub
type: function
doc:
<comment>Description:</comment>
  Subtrai números
  
  Subtrai <strong>$num2</strong> de <strong>$num1</strong> e retorna o resultado.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  O minuendo.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  O subtraendo, que será subtraído de <strong>$num1</strong>.
                         
                         Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmp_testbit
type: function
doc:
<comment>Description:</comment>
  Tests if a bit is set
  
  Tests if the specified bit is set.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num</strong>    Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>int</info>             <strong>$index</strong>  The bit to test

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the bit is set in <strong>$num</strong>,  otherwise <info>false</info>.

<comment>See Also:</comment>
   * <strong>gmp_setbit()</strong>
   * <strong>gmp_clrbit()</strong>


id: gmp_xor
type: function
doc:
<comment>Description:</comment>
  Operação binária XOR
  
  Faz a operação binária exclusiva OR (XOR) de dois números GMP.

<comment>Param:</comment>
  <info>GMP|int|string</info>  <strong>$num1</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.
  <info>GMP|int|string</info>  <strong>$num2</strong>  Um objeto <class>GMP</class>, um <info>int</info> ou uma <info>string</info> numérica.

<comment>Return:</comment>
  <info>GMP</info>  Um objeto <class>GMP</class>.


id: gmstrftime
type: function
doc:
<comment>Description:</comment>
  Formata uma data/hora GMT/UTC de acordo com as configurações de localidade
  
  Possui o mesmo comportamento que a função <strong>strftime()</strong> exceto que o tempo retornado será no Horário
  de Greenwich (GMT). Por exemplo, quando executada no fuso horário EST (GMT -0500), a primeira
  linha abaixo imprime "Dec 31 1998 20:00:00", enquanto a segunda linha imprime "Jan 01 1999
  01:00:00".
  
  Esta função depende das informações de localidade do sistema operacional, que podem ser
  inconsistentes ou não disponíveis. Ao invés disso, use o método IntlDateFormatter::format.

<comment>Param:</comment>
  <info>string</info>    <strong>$format</strong>     Veja a descrição em <strong>strftime()</strong>.
  <info>int|null</info>  <strong>$timestamp</strong>  O parâmetro opcional <strong>$timestamp</strong> é um
                        <info>int</info> de timestamp Unix cujo padrão é a hora local
                        atual se <strong>$timestamp</strong> não for informado ou for <info>null</info>. Em outras
                        palavras, o padrão é o valor de <strong>time()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string formatada de acordo com a string de formatação, usando o
                <strong>$timestamp</strong> informado, ou o horário local se nenhum timestamp é informado. Nomes de
                meses, dias da semana e outras strings que dependem do idioma respeitam a
                configuração de localidade atual definido com a função <strong>setlocale()</strong>. Em caso de
                falha, é retornado <info>false</info>.

<comment>See Also:</comment>
   * IntlDateFormatter::format
   * DateTimeInterface::format
   * <strong>strftime()</strong>


id: gnupg_adddecryptkey
type: function
doc:
<comment>Description:</comment>
  Add a key for decryption

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>   O identificador gnupg, obtido de uma chamada a
                          <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$fingerprint</strong>  A chave da impressão digital.
  <info>string</info>    <strong>$passphrase</strong>   The pass phrase.

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


id: gnupg_addencryptkey
type: function
doc:
<comment>Description:</comment>
  Add a key for encryption

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>   O identificador gnupg, obtido de uma chamada a
                          <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$fingerprint</strong>  A chave da impressão digital.

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


id: gnupg_addsignkey
type: function
doc:
<comment>Description:</comment>
  Add a key for signing

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>   O identificador gnupg, obtido de uma chamada a
                          <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$fingerprint</strong>  A chave da impressão digital.
  <info>string</info>    <strong>$passphrase</strong>   The pass phrase.

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


id: gnupg_cleardecryptkeys
type: function
doc:
<comment>Description:</comment>
  Removes all keys which were set for decryption before

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

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


id: gnupg_clearencryptkeys
type: function
doc:
<comment>Description:</comment>
  Removes all keys which were set for encryption before

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

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


id: gnupg_clearsignkeys
type: function
doc:
<comment>Description:</comment>
  Removes all keys which were set for signing before

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

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


id: gnupg_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypts a given text
  
  Decrypts the given text with the keys, which were set with gnupg_adddecryptkey before.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$text</strong>        The text being decrypted.

<comment>Return:</comment>
  <info>string|false</info>  On success, this function returns the decrypted text. On failure, this function
                returns <info>false</info>.


id: gnupg_decryptverify
type: function
doc:
<comment>Description:</comment>
  Decrypts and verifies a given text
  
  Decrypts and verifies a given text and returns information about the signature.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$text</strong>        The text being decrypted.
  <info>string</info>    <strong>$plaintext</strong>   The parameter <strong>$plaintext</strong> gets filled with the decrypted text.

<comment>Return:</comment>
  <info>array|false</info>  On success, this function returns information about the signature and fills the
               <strong>$plaintext</strong> parameter with the decrypted text. On failure, this function returns
               <info>false</info>.


id: gnupg_deletekey
type: function
doc:
<comment>Description:</comment>
  Delete a key from the keyring

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>    O identificador gnupg, obtido de uma chamada a
                           <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$key</strong>           The key to delete.
  <info>bool</info>      <strong>$allow_secret</strong>  It specifies whether to delete secret keys as well.

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


id: gnupg_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypts a given text
  
  Encrypts the given <strong>$plaintext</strong> with the keys, which were set with gnupg_addencryptkey before and
  returns the encrypted text.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$plaintext</strong>   The text being encrypted.

<comment>Return:</comment>
  <info>string|false</info>  On success, this function returns the encrypted text. On failure, this function
                returns <info>false</info>.


id: gnupg_encryptsign
type: function
doc:
<comment>Description:</comment>
  Encrypts and signs a given text
  
  Encrypts and signs the given <strong>$plaintext</strong> with the keys, which were set with gnupg_addsignkey and
  gnupg_addencryptkey before and returns the encrypted and signed text.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$plaintext</strong>   The text being encrypted.

<comment>Return:</comment>
  <info>string|false</info>  On success, this function returns the encrypted and signed text. On failure, this
                function returns <info>false</info>.


id: gnupg_export
type: function
doc:
<comment>Description:</comment>
  Exports a key
  
  Exports the key <strong>$fingerprint</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>   O identificador gnupg, obtido de uma chamada a
                          <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$fingerprint</strong>  A chave da impressão digital.

<comment>Return:</comment>
  <info>string|false</info>  On success, this function returns the keydata. On failure, this function returns
                <info>false</info>.


id: gnupg_getengineinfo
type: function
doc:
<comment>Description:</comment>
  Returns the engine info

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with engine info consting of <return>protocol</return>, <return>file_name</return> and <return>home_dir</return>.


id: gnupg_geterror
type: function
doc:
<comment>Description:</comment>
  Returns the errortext, if a function fails

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

<comment>Return:</comment>
  <info>string|false</info>  Returns an errortext, if an error has occurred, otherwise <info>false</info>.


id: gnupg_geterrorinfo
type: function
doc:
<comment>Description:</comment>
  Returns the error info

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with error info.


id: gnupg_getprotocol
type: function
doc:
<comment>Description:</comment>
  Returns the currently active protocol for all operations

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.

<comment>Return:</comment>
  <info>int</info>  Returns the currently active protocol, which can be one of <info>GNUPG_PROTOCOL_OpenPGP</info> or
       <info>GNUPG_PROTOCOL_CMS</info>.


id: gnupg_gettrustlist
type: function
doc:
<comment>Description:</comment>
  Search the trust items

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$pattern</strong>     Expression to limit the list of trust items to only the ones matching the
                         pattern.

<comment>Return:</comment>
  <info>array|null</info>  On success, this function returns an array of trust items. On failure, this function
              returns <info>null</info>.


id: gnupg_import
type: function
doc:
<comment>Description:</comment>
  Imports a key
  
  Imports the key <strong>$keydata</strong> and returns an array with information about the importprocess.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$keydata</strong>     The data key that is being imported.

<comment>Return:</comment>
  <info>array|false</info>  On success, this function returns and info-array about the importprocess. On failure,
               this function returns <info>false</info>.


id: gnupg_init
type: function
doc:
<comment>Description:</comment>
  Initialize a connection

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  Must be an associative array. It is used to change the default configuration
                        of the crypto engine. Configuration
                        overrideskeytypedescriptionfile_name<info>string</info> It is the file name of the
                        executable program implementing this protocol which is usually path of the
                        <return>gpg</return> executable. home_dir<info>string</info> It is the directory name of the configuration
                        directory. It also overrides <return>GNUPGHOME</return> environment variable that is used for
                        the same purpose.

<comment>Return:</comment>
  <info>resource</info>  A GnuPG <info>resource</info> connection used by other GnuPG functions.


id: gnupg_keyinfo
type: function
doc:
<comment>Description:</comment>
  Returns an array with information about all keys that matches the given pattern

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$pattern</strong>     The pattern being checked against the keys.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array with information about all keys that matches the given pattern or
               <info>false</info>, if an error has occurred.


id: gnupg_listsignatures
type: function
doc:
<comment>Description:</comment>
  List key signatures

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$keyid</strong>       The key ID to list signatures for.

<comment>Return:</comment>
  <info>array|null</info>  On success, this function returns an array of key signatures. On failure, this
              function returns <info>null</info>.


id: gnupg_setarmor
type: function
doc:
<comment>Description:</comment>
  Toggle armored output
  
  Toggle the armored output.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>int</info>       <strong>$armor</strong>       Pass a non-zero integer-value to this function to enable armored-output
                         (default). Pass 0 to disable armored output.

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


id: gnupg_seterrormode
type: function
doc:
<comment>Description:</comment>
  Sets the mode for error_reporting
  
  Sets the mode for error_reporting.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>int</info>       <strong>$errormode</strong>   The error mode.
                         
                         <strong>$errormode</strong> takes a constant indicating what type of error_reporting should
                         be used. The possible values are <info>GNUPG_ERROR_WARNING</info>, <info>GNUPG_ERROR_EXCEPTION</info>
                         and <info>GNUPG_ERROR_SILENT</info>. By default <info>GNUPG_ERROR_SILENT</info> is used.

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


id: gnupg_setsignmode
type: function
doc:
<comment>Description:</comment>
  Sets the mode for signing
  
  Sets the mode for signing.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info></info>          <strong>$sigmode</strong>     The mode for signing.
                         
                         <strong>$signmode</strong> takes a constant indicating what type of signature should be
                         produced. The possible values are <info>GNUPG_SIG_MODE_NORMAL</info>,
                         <info>GNUPG_SIG_MODE_DETACH</info> and <info>GNUPG_SIG_MODE_CLEAR</info>. By default
                         <info>GNUPG_SIG_MODE_CLEAR</info> is used.

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


id: gnupg_sign
type: function
doc:
<comment>Description:</comment>
  Signs a given text
  
  Signs the given <strong>$plaintext</strong> with the keys, which were set with gnupg_addsignkey before and returns
  the signed text or the signature, depending on what was set with gnupg_setsignmode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>  O identificador gnupg, obtido de uma chamada a
                         <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$plaintext</strong>   The plain text being signed.

<comment>Return:</comment>
  <info>string|false</info>  On success, this function returns the signed text or the signature. On failure, this
                function returns <info>false</info>.


id: gnupg_verify
type: function
doc:
<comment>Description:</comment>
  Verifies a signed text
  
  Verifies the given <strong>$signed_text</strong> and returns information about the signature.

<comment>Param:</comment>
  <info>resource</info>  <strong>$identifier</strong>   O identificador gnupg, obtido de uma chamada a
                          <strong>gnupg_init()</strong> ou <class>gnupg</class>.
  <info>string</info>    <strong>$signed_text</strong>  The signed text.
  <info>string</info>    <strong>$signature</strong>    The signature. To verify a clearsigned text, set signature to <info>false</info>.
  <info>string</info>    <strong>$plaintext</strong>    The plain text. If this optional parameter is passed, it is filled with
                          the plain text.

<comment>Return:</comment>
  <info>array|false</info>  On success, this function returns information about the signature. On failure, this
               function returns <info>false</info>.


id: grapheme_extract
type: function
doc:
<comment>Description:</comment>
  Function to extract a sequence of default grapheme clusters from a text buffer, which must be
  encoded in UTF-8
  
  Estilo procedural
  
  Function to extract a sequence of default grapheme clusters from a text buffer, which must be
  encoded in UTF-8.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  String to search.
  <info>int</info>     <strong>$size</strong>      Maximum number items - based on the <strong>$type</strong> - to return.
  <info>int</info>     <strong>$type</strong>      Defines the type of units referred to by the <strong>$size</strong> parameter:
                     
                     GRAPHEME_EXTR_COUNT (default) -<strong>$size</strong> is the number of default grapheme clusters
                     to extract.GRAPHEME_EXTR_MAXBYTES -<strong>$size</strong> is the maximum number of bytes
                     returned.GRAPHEME_EXTR_MAXCHARS - <strong>$size</strong> is the maximum number of UTF-8
                     characters returned.
  <info>int</info>     <strong>$offset</strong>    Starting position in <strong>$haystack</strong> in bytes - if given, it must be zero or a
                     positive value that is less than or equal to the length of <strong>$haystack</strong> in bytes,
                     or a negative value that counts from the end of <strong>$haystack</strong>. If <strong>$offset</strong> does not
                     point to the first byte of a UTF-8 character, the start position is moved to
                     the next character boundary.
  <info>int</info>     <strong>$next</strong>      Reference to a value that will be set to the next starting position. When the
                     call returns, this may point to the first byte position past the end of the
                     string.

<comment>Return:</comment>
  <info>string|false</info>  A string starting at offset <strong>$offset</strong> and ending on a default grapheme cluster
                boundary that conforms to the <strong>$size</strong> and <strong>$type</strong> specified, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>grapheme_substr()</strong>
   * 
       Unicode Text Segmentation: Grapheme Cluster Boundaries
      


id: grapheme_stripos
type: function
doc:
<comment>Description:</comment>
  Find position (in grapheme units) of first occurrence of a case-insensitive string
  
  Estilo procedural
  
  Find position (in grapheme units) of first occurrence of a case-insensitive string

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to look in. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>    The string to look for. Must be valid UTF-8.
  <info>int</info>     <strong>$offset</strong>    The optional <strong>$offset</strong> parameter allows you to specify where in <strong>$haystack</strong> to
                     start searching as an offset in grapheme units (not bytes or characters). If
                     the offset is negative, it is treated relative to the end of the string. The
                     position returned is still relative to the beginning of <strong>$haystack</strong> regardless of
                     the value of <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position as an integer. If <strong>$needle</strong> is not found, <strong>grapheme_stripos()</strong> will
             return <info>false</info>.

<comment>See Also:</comment>
   * <strong>grapheme_stristr()</strong>
   * <strong>grapheme_strpos()</strong>
   * <strong>grapheme_strripos()</strong>
   * <strong>grapheme_strrpos()</strong>
   * <strong>grapheme_strstr()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_stristr
type: function
doc:
<comment>Description:</comment>
  Returns part of haystack string from the first occurrence of case-insensitive needle to the end of
  haystack
  
  Estilo procedural
  
  Returns part of <strong>$haystack</strong> string starting from and including the first occurrence of
  case-insensitive needle to the end of <strong>$haystack</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>      The input string. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>        The string to look for. Must be valid UTF-8.
  <info>bool</info>    <strong>$beforeNeedle</strong>  If <info>true</info>, <strong>grapheme_strstr()</strong> returns the part of the <strong>$haystack</strong> before the
                         first occurrence of the needle (excluding <strong>$needle</strong>).

<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>grapheme_stripos()</strong>
   * <strong>grapheme_strpos()</strong>
   * <strong>grapheme_strripos()</strong>
   * <strong>grapheme_strrpos()</strong>
   * <strong>grapheme_strstr()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_strlen
type: function
doc:
<comment>Description:</comment>
  Get string length in grapheme units
  
  Estilo procedural
  
  Get string length in grapheme units (not bytes or characters)

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string being measured for length. It must be a valid UTF-8 string.

<comment>Return:</comment>
  <info>int|false|null</info>  The length of the string on success,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     
   * <strong>iconv_strlen()</strong>
   * <strong>mb_strlen()</strong>
   * <strong>strlen()</strong>


id: grapheme_strpos
type: function
doc:
<comment>Description:</comment>
  Find position (in grapheme units) of first occurrence of a string
  
  Estilo procedural
  
  Find position (in grapheme units) of first occurrence of a string

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to look in. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>    The string to look for. Must be valid UTF-8.
  <info>int</info>     <strong>$offset</strong>    The optional <strong>$offset</strong> parameter allows you to specify where in <strong>$haystack</strong> to
                     start searching as an offset in grapheme units (not bytes or characters). If
                     the offset is negative, it is treated relative to the end of the string. The
                     position returned is still relative to the beginning of <strong>$haystack</strong> regardless of
                     the value of <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position as an integer. If <strong>$needle</strong> is not found, <strong>grapheme_strpos()</strong> will
             return <info>false</info>.

<comment>See Also:</comment>
   * <strong>grapheme_stripos()</strong>
   * <strong>grapheme_stristr()</strong>
   * <strong>grapheme_strripos()</strong>
   * <strong>grapheme_strrpos()</strong>
   * <strong>grapheme_strstr()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_strripos
type: function
doc:
<comment>Description:</comment>
  Find position (in grapheme units) of last occurrence of a case-insensitive string
  
  Estilo procedural
  
  Find position (in grapheme units) of last occurrence of a case-insensitive string

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to look in. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>    The string to look for. Must be valid UTF-8.
  <info>int</info>     <strong>$offset</strong>    The optional <strong>$offset</strong> parameter allows you to specify where in <strong>$haystack</strong> to
                     start searching as an offset in grapheme units (not bytes or characters). The
                     position returned is still relative to the beginning of <strong>$haystack</strong> regardless of
                     the value of <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position as an integer. If <strong>$needle</strong> is not found, <strong>grapheme_strripos()</strong> will
             return <info>false</info>.

<comment>See Also:</comment>
   * <strong>grapheme_stripos()</strong>
   * <strong>grapheme_stristr()</strong>
   * <strong>grapheme_strpos()</strong>
   * <strong>grapheme_strrpos()</strong>
   * <strong>grapheme_strstr()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_strrpos
type: function
doc:
<comment>Description:</comment>
  Find position (in grapheme units) of last occurrence of a string
  
  Estilo procedural
  
  Find position (in grapheme units) of last occurrence of a string

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>  The string to look in. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>    The string to look for. Must be valid UTF-8.
  <info>int</info>     <strong>$offset</strong>    The optional <strong>$offset</strong> parameter allows you to specify where in <strong>$haystack</strong> to
                     start searching as an offset in grapheme units (not bytes or characters). The
                     position returned is still relative to the beginning of <strong>$haystack</strong> regardless of
                     the value of <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Returns the position as an integer. If <strong>$needle</strong> is not found, <strong>grapheme_strrpos()</strong> will
             return <info>false</info>.

<comment>See Also:</comment>
   * <strong>grapheme_stripos()</strong>
   * <strong>grapheme_stristr()</strong>
   * <strong>grapheme_strpos()</strong>
   * <strong>grapheme_strripos()</strong>
   * <strong>grapheme_strstr()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_strstr
type: function
doc:
<comment>Description:</comment>
  Returns part of haystack string from the first occurrence of needle to the end of haystack
  
  Estilo procedural
  
  Returns part of haystack string from the first occurrence of needle to the end of haystack
  (including the needle).

<comment>Param:</comment>
  <info>string</info>  <strong>$haystack</strong>      The input string. Must be valid UTF-8.
  <info>string</info>  <strong>$needle</strong>        The string to look for. Must be valid UTF-8.
  <info>bool</info>    <strong>$beforeNeedle</strong>  If <info>true</info>, <strong>grapheme_strstr()</strong> returns the part of the <strong>$haystack</strong> before the
                         first occurrence of the <strong>$needle</strong> (excluding the <strong>$needle</strong>).

<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>grapheme_stristr()</strong>
   * <strong>grapheme_stripos()</strong>
   * <strong>grapheme_strpos()</strong>
   * <strong>grapheme_strripos()</strong>
   * <strong>grapheme_strrpos()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: grapheme_substr
type: function
doc:
<comment>Description:</comment>
  Return part of a string
  
  Estilo procedural
  
  Return part of a string

<comment>Param:</comment>
  <info>string</info>    <strong>$string</strong>  The input string. Must be valid UTF-8.
  <info>int</info>       <strong>$offset</strong>  Start position in default grapheme units. If <strong>$offset</strong> is non-negative, the
                     returned string will start at the <strong>$offset</strong>'th position in <strong>$string</strong>, counting from
                     zero. If <strong>$offset</strong> is negative, the returned string will start at the <strong>$offset</strong>'th
                     grapheme unit from the  end of string.
  <info>int|null</info>  <strong>$length</strong>  Length in grapheme units. If <strong>$length</strong> is given and is positive, the string
                     returned will contain at most <strong>$length</strong> grapheme units beginning from <strong>$offset</strong>
                     (depending on the  length of string). If <strong>$length</strong> is given and is negative, then
                     that many grapheme units will be omitted from the end of string (after the
                     start position has been calculated when <strong>$offset</strong> is negative). If <strong>$offset</strong>
                     denotes a position beyond this truncation, an empty string will be returned.

<comment>Return:</comment>
  <info>string|false</info>  Returns the extracted part of <strong>$string</strong>,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>grapheme_extract()</strong>
   * 
      Unicode Text Segmentation: Grapheme Cluster Boundaries
     


id: gregoriantojd
type: function
doc:
<comment>Description:</comment>
  Converte uma data gregoriana para o "Julian Day Count"
  
  A escala válida para o Calendário Gregoriano é de 25 de Novembro, 4714 A.C. até pelo menos 31 de
  Dezembro, 9999 D.C.
  
  Entretanto esta função pode trabalhar com todas datas anteriores à, porém usá-la desta maneira não
  tem muito sentido. O Calendário Gregoriano não foi instituído até 15 de Outubro de 1582 (ou 5 de
  Outubro de 1582, no calendário JDC ("Julian Day Count")). Alguns países aceitaram este calendário
  um pouco mais tarde. Por exemplo, a Grã Bretanha converteu-se em 1752, a URSS em 1918 e a Grécia
  em 1923. A maioria dos países Europeus usaram o calendário "Julian" (JDC) antes do calendário
  Gregoriano.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  O mês como um número entre 1 (para janeiro) e 12 (para dezembro)
  <info>int</info>  <strong>$day</strong>    O dia como um número entre 1 e 31 Se o mês tem menos dias do que o especificado; veja
               o exemplo abaixo.
  <info>int</info>  <strong>$year</strong>   O ano como um número entre -4714 e 9999 Números negativos indicam anos A.C., números
               positivos indicam anos D.C. Note que não existe ano <return>0</return>; 31 de Dezembro, 1 A.C. é
               seguido emediatamente por 1 de Janeiro, 1 D.C.

<comment>Return:</comment>
  <info>int</info>  A data juliana para a dada data gregoriana como um inteiro. Datas fora da escala válida
       retornam <return>0</return>.

<comment>See Also:</comment>
   * <strong>jdtogregorian()</strong>
   * <strong>cal_to_jd()</strong>


id: gzclose
type: function
doc:
<comment>Description:</comment>
  Fecha um ponteiro para um arquivo-gz
  
  Fecha o ponteiro para arquivo gz dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo gz. Ele deve ser válido,e apontar para um arquivo aberto
                     de maneira correta pela função <strong>gzopen()</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>gzopen()</strong>


id: gzcompress
type: function
doc:
<comment>Description:</comment>
  Compress a string
  
  This function compresses the given string using the <return>ZLIB</return> data format.
  
  For details on the ZLIB compression algorithm see the document "ZLIB Compressed Data Format
  Specification version 3.3" (RFC 1950).
  
  This is not the same as gzip compression, which includes some header data. See <strong>gzencode()</strong> for gzip
  compression.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      The data to compress.
  <info>int</info>     <strong>$level</strong>     The level of compression. Can be given as 0 for no compression up to 9 for
                     maximum compression.
                     
                     If -1 is used, the default compression of the zlib library is used which is 6.
  <info>int</info>     <strong>$encoding</strong>  One of <info>ZLIB_ENCODING_*</info> constants.

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

<comment>See Also:</comment>
   * <strong>gzdeflate()</strong>
   * <strong>gzinflate()</strong>
   * <strong>gzuncompress()</strong>
   * <strong>gzencode()</strong>


id: gzdecode
type: function
doc:
<comment>Description:</comment>
  Decodifica uma string comprimida usando o gzip
  
  Essa função retorna a versão decodifica de <strong>$data</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        Os dados a serem decodificados, encodificados por <strong>gzencode()</strong>.
  <info>int</info>     <strong>$max_length</strong>  Tamanho máximo dos dados a serem decodificados.

<comment>Return:</comment>
  <info>string|false</info>  A string decodificada, ou  ou <info>false</info> em caso de falha.

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


id: gzdeflate
type: function
doc:
<comment>Description:</comment>
  Deflate a string
  
  This function compresses the given string using the <return>DEFLATE</return> data format.
  
  For details on the DEFLATE compression algorithm see the document "DEFLATE Compressed Data Format
  Specification version 1.3" (RFC 1951).

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      The data to deflate.
  <info>int</info>     <strong>$level</strong>     The level of compression. Can be given as 0 for no compression up to 9 for
                     maximum compression. If not given, the default compression level will be the
                     default compression level of the zlib library.
  <info>int</info>     <strong>$encoding</strong>  One of <info>ZLIB_ENCODING_*</info> constants.

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

<comment>See Also:</comment>
   * <strong>gzinflate()</strong>
   * <strong>gzcompress()</strong>
   * <strong>gzuncompress()</strong>
   * <strong>gzencode()</strong>


id: gzencode
type: function
doc:
<comment>Description:</comment>
  Create a gzip compressed string
  
  This function returns a compressed version of the input <strong>$data</strong> compatible with the output of the
  gzip program.
  
  For more information on the GZIP file format, see the document: GZIP file format specification
  version 4.3 (RFC 1952).

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      The data to encode.
  <info>int</info>     <strong>$level</strong>     The level of compression. Can be given as 0 for no compression up to 9 for
                     maximum compression. If not given, the default compression level will be the
                     default compression level of the zlib library.
  <info>int</info>     <strong>$encoding</strong>  The encoding mode. Can be <info>FORCE_GZIP</info> (the default) or <info>FORCE_DEFLATE</info>.
                     
                     <info>FORCE_DEFLATE</info> generates RFC 1950 compliant output, consisting of a zlib header,
                     the deflated data, and an Adler checksum.

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

<comment>See Also:</comment>
   * <strong>gzdecode()</strong>
   * <strong>gzdeflate()</strong>
   * <strong>gzinflate()</strong>
   * <strong>gzuncompress()</strong>
   * <strong>gzcompress()</strong>
   * 
      ZLIB Compressed Data Format Specification (RFC 1950)
     


id: gzeof
type: function
doc:
<comment>Description:</comment>
  Test for EOF on a gz-file pointer
  
  Tests the given GZ file pointer for EOF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The gz-file pointer. It must be valid, and must point to a file successfully
                     opened by <strong>gzopen()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the gz-file pointer is at EOF or an error occurs; otherwise returns <info>false</info>.


id: gzfile
type: function
doc:
<comment>Description:</comment>
  Read entire gz-file into an array
  
  This function is identical to <strong>readgzfile()</strong>, except that it returns the file in an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          The file name.
  <info>int</info>     <strong>$use_include_path</strong>  You can set this optional parameter to <return>1</return>, if you want to search for the
                             file in the include_path too.

<comment>Return:</comment>
  <info>array|false</info>  An array containing the file, one line per cell, empty lines included, and with
               newlines still attached, ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>readgzfile()</strong>
   * <strong>gzopen()</strong>


id: gzgetc
type: function
doc:
<comment>Description:</comment>
  Get character from gz-file pointer
  
  Returns a string containing a single (uncompressed) character read from the given gz-file pointer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The gz-file pointer. It must be valid, and must point to a file successfully
                     opened by <strong>gzopen()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  The uncompressed character or <info>false</info> on EOF (unlike <strong>gzeof()</strong>).

<comment>See Also:</comment>
   * <strong>gzopen()</strong>
   * <strong>gzgets()</strong>


id: gzgets
type: function
doc:
<comment>Description:</comment>
  Obtém uma linha de um ponteiro de arquivo
  
  Obtém uma (descomprimida) string até o tamanho length - 1 bytes lidos a partir do ponteiro de
  arquivo dado. A leitura termina quando length - 1 bytes tiverem sido lidos, em uma nova liha ou em
  EOF (o que vier primeiro).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro do arquivo deve ser válido, e deve apontar para um arquivo aberto
                     corretamente com <strong>gzopen()</strong>.
  <info>int|null</info>  <strong>$length</strong>  O tamanho dos dados a pegar.

<comment>Return:</comment>
  <info>string|false</info>  A string descomprimida, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>gzopen()</strong>
   * <strong>gzgetc()</strong>
   * <strong>gzwrite()</strong>


id: gzgetss
type: function
doc:
<comment>Description:</comment>
  Get line from gz-file pointer and strip HTML tags
    
  
  Identical to <strong>gzgets()</strong>, except that <strong>gzgetss()</strong> attempts to strip any HTML and PHP tags from the text
  it reads.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zp</strong>              The gz-file pointer. It must be valid, and must point to a file
                             successfully opened by <strong>gzopen()</strong>.
  <info>int</info>       <strong>$length</strong>          The length of data to get.
  <info>string</info>    <strong>$allowable_tags</strong>  You can use this optional parameter to specify tags which should not
                             be stripped.

<comment>Return:</comment>
  <info>string</info>  The uncompressed and stripped string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>gzopen()</strong>
   * <strong>gzgets()</strong>
   * <strong>strip_tags()</strong>


id: gzinflate
type: function
doc:
<comment>Description:</comment>
  Inflate a deflated string
  
  This function inflates a deflated string.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        The data compressed by <strong>gzdeflate()</strong>.
  <info>int</info>     <strong>$max_length</strong>  The maximum length of decoded data.

<comment>Return:</comment>
  <info>string|false</info>  The original uncompressed data or <info>false</info> on error.
                
                The function will return an error if the uncompressed data is more than 32768 times
                the length of the compressed input <strong>$data</strong>  or, unless <strong>$max_length</strong> is <return>0</return>, more than the
                optional parameter <strong>$max_length</strong>.

<comment>See Also:</comment>
   * <strong>gzdeflate()</strong>
   * <strong>gzcompress()</strong>
   * <strong>gzuncompress()</strong>
   * <strong>gzencode()</strong>


id: gzopen
type: function
doc:
<comment>Description:</comment>
  Open gz-file
  
  Opens a gzip (.gz) file for reading or writing.
  
  <strong>gzopen()</strong> can be used to read a file which is not in gzip format; in this case <strong>gzread()</strong> will
  directly read from the file without decompression.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          The file name.
  <info>string</info>  <strong>$mode</strong>              As in <strong>fopen()</strong> (<return>rb</return> or  <return>wb</return>) but can also include a compression level
                             (<return>wb9</return>) or a strategy: <return>f</return> for filtered data as in <return>wb6f</return>, <return>h</return> for <return>Huffman only
                             compression</return> as in <return>wb1h</return>. (See the description of <return>deflateInit2</return> in zlib.h
                             for  more information about the strategy parameter.)
  <info>int</info>     <strong>$use_include_path</strong>  You can set this optional parameter to <return>1</return>, if you want to search for the
                             file in the include_path too.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a file pointer to the file opened, after that, everything you read from
                  this file descriptor will be transparently decompressed and what you  write gets
                  compressed.
                  
                  If the open fails, the function returns <info>false</info>.

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


id: gzpassthru
type: function
doc:
<comment>Description:</comment>
  Output all remaining data on a gz-file pointer
    
  
  Reads to EOF on the given gz-file pointer from the current position and writes the (uncompressed)
  results to standard output.
  
  You may need to call <strong>gzrewind()</strong> to reset the file pointer to the beginning of the file if you have
  already written data  to it.
  
  If you just want to dump the contents of a file to the output buffer,  without first modifying it
  or seeking to a particular offset, you may  want to use the <strong>readgzfile()</strong> function, which saves
  you the <strong>gzopen()</strong> call.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The gz-file pointer. It must be valid, and must point to a file successfully
                     opened by <strong>gzopen()</strong>.

<comment>Return:</comment>
  <info>int</info>  The number of uncompressed characters read from <strong>$gz</strong> and passed through to the input.


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


id: gzread
type: function
doc:
<comment>Description:</comment>
  Binary-safe gz-file read
  
  <strong>gzread()</strong> reads up to <strong>$length</strong> bytes from the given gz-file pointer. Reading stops when <strong>$length</strong>
  (uncompressed) bytes have been read or EOF is reached, whichever comes first.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The gz-file pointer. It must be valid, and must point to a file successfully
                     opened by <strong>gzopen()</strong>.
  <info>int</info>       <strong>$length</strong>  The number of bytes to read.

<comment>Return:</comment>
  <info>string|false</info>  The data that have been read,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>gzwrite()</strong>
   * <strong>gzopen()</strong>
   * <strong>gzgets()</strong>
   * <strong>gzgetss()</strong>
   * <strong>gzfile()</strong>
   * <strong>gzpassthru()</strong>


id: gzrewind
type: function
doc:
<comment>Description:</comment>
  Retorna ao início a posição de um ponteiro para um arquivo-gz
  
  Define o indicador de posição para o dado arquivo gz para o início do arquivo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro do arquivo gz. Ele deve ser válido e deve apontar para um arquivo
                     aberto corretamente com <strong>gzopen()</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>gzseek()</strong>
   * <strong>gztell()</strong>


id: gzseek
type: function
doc:
<comment>Description:</comment>
  Seek on a gz-file pointer
  
  Sets the file position indicator for the given file pointer to the given offset byte into the file
  stream. Equivalent to calling (in C) <return>gzseek(zp, offset, SEEK_SET)</return>.
  
  If the file is opened for reading, this function is emulated but can be extremely slow. If the
  file is opened for writing, only forward seeks are supported; <strong>gzseek()</strong> then compresses a sequence
  of zeroes up to the new starting position.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The gz-file pointer. It must be valid, and must point to a file successfully
                     opened by <strong>gzopen()</strong>.
  <info>int</info>       <strong>$offset</strong>  The seeked offset.
  <info>int</info>       <strong>$whence</strong>  <strong>$whence</strong> values are: <info>SEEK_SET</info> - Set position equal to <strong>$offset</strong> bytes.<info>SEEK_CUR</info> -
                     Set position to current location plus <strong>$offset</strong>.
                     
                     If <strong>$whence</strong> is not specified, it is assumed to be <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Upon success, returns 0; otherwise, returns -1. Note that seeking past EOF is not considered
       an error.

<comment>See Also:</comment>
   * <strong>gztell()</strong>
   * <strong>gzrewind()</strong>


id: gztell
type: function
doc:
<comment>Description:</comment>
  Indica a posição de leitura/gravação em um ponteiro para arquivo-gz
  
  Obtém a posição do ponteiro de arquivo, ou seja, seu índice dentro do arquivo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo gz. Precisa ser válido, e deve apontar para um arquivo
                     aberto corretamente com <strong>gzopen()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  A posição do ponteiro do arquivo ou <info>false</info> se um erro ocorrer.

<comment>See Also:</comment>
   * <strong>gzopen()</strong>
   * <strong>gzseek()</strong>
   * <strong>gzrewind()</strong>


id: gzuncompress
type: function
doc:
<comment>Description:</comment>
  Uncompress a compressed string
  
  This function uncompress a compressed string.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        The data compressed by <strong>gzcompress()</strong>.
  <info>int</info>     <strong>$max_length</strong>  The maximum length of data to decode.

<comment>Return:</comment>
  <info>string|false</info>  The original uncompressed data or <info>false</info> on error.
                
                The function will return an error if the uncompressed data is more than 32768 times
                the length of the compressed input <strong>$data</strong>  or more than the optional parameter
                <strong>$max_length</strong>.

<comment>See Also:</comment>
   * <strong>gzcompress()</strong>
   * <strong>gzinflate()</strong>
   * <strong>gzdeflate()</strong>
   * <strong>gzencode()</strong>


id: gzwrite
type: function
doc:
<comment>Description:</comment>
  Escrita segura para binário em arquivo-gz
  
  <strong>gzwrite()</strong> escreve o conteúdo de <strong>$data</strong> para o arquivo-gz.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro do arquivo gz. Precisa ser válido, e apontar para um arquivo aberto
                     com sucesso por <strong>gzopen()</strong>.
  <info>string</info>    <strong>$data</strong>    A string a ser escrita.
  <info>int|null</info>  <strong>$length</strong>  O número de bytes descomprimidos para escrever. Se fornecido, a escrita irá
                     parar depois de <strong>$length</strong> (descomprimido) bytes ter sido escritos, ou ao final de
                     <strong>$data</strong>, o que vier primeiro.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o número de (descomprimido) bytes escrito no dado stream do arquivo gz, ou
             <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>gzread()</strong>
   * <strong>gzopen()</strong>


id: hash
type: function
doc:
<comment>Description:</comment>
  Generate a hash value (message digest)

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>     Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..).
                    For a list of supported algorithms see <strong>hash_algos()</strong>.
  <info>string</info>  <strong>$data</strong>     Message to be hashed.
  <info>bool</info>    <strong>$binary</strong>   When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.
  <info>array</info>   <strong>$options</strong>  An array of options for the various hashing algorithms.  Currently, only the
                    "seed" parameter is supported by the MurmurHash variants.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the calculated message digest as lowercase hexits unless
          <strong>$binary</strong> is set to true in which case the raw binary representation of the message digest
          is returned.

<comment>See Also:</comment>
   * <strong>hash_file()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>hash_init()</strong>
   * <strong>md5()</strong>
   * <strong>sha1()</strong>


id: hash_algos
type: function
doc:
<comment>Description:</comment>
  Return a list of registered hashing algorithms

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array containing the list of supported hashing algorithms.

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


id: hash_copy
type: function
doc:
<comment>Description:</comment>
  Copy hashing context

<comment>Param:</comment>
  <info>HashContext</info>  <strong>$context</strong>  Hashing context returned by <strong>hash_init()</strong>.

<comment>Return:</comment>
  <info>HashContext</info>  Returns a copy of Hashing Context.


id: hash_equals
type: function
doc:
<comment>Description:</comment>
  Timing attack safe string comparison
  
  Checks whether two strings are equal without leaking information about the contents of
  <strong>$known_string</strong> via the execution time.
  
  This function can be used to mitigate timing attacks. Performing a regular comparison with ===
  will take more or less time to execute depending on whether the two values are different or not
  and at which position the first difference can be found, thus leaking information about the
  contents of the secret <strong>$known_string</strong>.
  
  It is important to provide the user-supplied string as the second parameter, rather than the
  first.

<comment>Param:</comment>
  <info>string</info>  <strong>$known_string</strong>  The known <info>string</info> that must be kept secret.
  <info>string</info>  <strong>$user_string</strong>   The user-supplied <info>string</info> to compare against.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the two strings are equal, <info>false</info> otherwise.

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


id: hash_file
type: function
doc:
<comment>Description:</comment>
  Generate a hash value using the contents of a given file

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>      Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..).
                     For a list of supported algorithms see <strong>hash_algos()</strong>.
  <info>string</info>  <strong>$filename</strong>  URL describing location of file to be hashed; Supports fopen wrappers.
  <info>bool</info>    <strong>$binary</strong>    When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.
  <info>array</info>   <strong>$options</strong>   An array of options for the various hashing algorithms.  Currently, only the
                     "seed" parameter is supported by the MurmurHash variants.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing the calculated message digest as lowercase hexits unless
                <strong>$binary</strong> is set to true in which case the raw binary representation of the message
                digest is returned.

<comment>See Also:</comment>
   * <strong>hash()</strong>
   * <strong>hash_hmac_file()</strong>
   * <strong>hash_update_file()</strong>
   * <strong>md5_file()</strong>
   * <strong>sha1_file()</strong>


id: hash_final
type: function
doc:
<comment>Description:</comment>
  Finalize an incremental hash and return resulting digest

<comment>Param:</comment>
  <info>HashContext</info>  <strong>$context</strong>  Hashing context returned by <strong>hash_init()</strong>.
  <info>bool</info>         <strong>$binary</strong>   When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the calculated message digest as lowercase hexits unless
          <strong>$binary</strong> is set to true in which case the raw binary representation of the message digest
          is returned.

<comment>See Also:</comment>
   * <strong>hash_init()</strong>
   * <strong>hash_update()</strong>
   * <strong>hash_update_stream()</strong>
   * <strong>hash_update_file()</strong>


id: hash_hkdf
type: function
doc:
<comment>Description:</comment>
  Generate a HKDF key derivation of a supplied key input

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>    Name of selected hashing algorithm (i.e. "sha256", "sha512", "haval160,4", etc..)
                   See <strong>hash_algos()</strong> for a list of supported algorithms.  Non-cryptographic hash
                   functions are not allowed.
                   
                   Non-cryptographic hash functions are not allowed.
  <info>string</info>  <strong>$key</strong>     Input keying material (raw binary). Cannot be empty.
  <info>int</info>     <strong>$length</strong>  Desired output length in bytes. Cannot be greater than 255 times the chosen hash
                   function size.
                   
                   If <strong>$length</strong> is <return>0</return>, the output length will default to the chosen hash function size.
  <info>string</info>  <strong>$info</strong>    Application/context-specific info string.
  <info>string</info>  <strong>$salt</strong>    Salt to use during derivation.
                   
                   While optional, adding random salt significantly improves the strength of HKDF.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing a raw binary representation of the derived key (also known as
          output keying material - OKM).

<comment>See Also:</comment>
   * <strong>hash_pbkdf2()</strong>
   * RFC 5869
   * userland implementation


id: hash_hmac
type: function
doc:
<comment>Description:</comment>
  Generate a keyed hash value using the HMAC method

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>    Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..)
                   See <strong>hash_hmac_algos()</strong> for a list of supported algorithms.
  <info>string</info>  <strong>$data</strong>    Message to be hashed.
  <info>string</info>  <strong>$key</strong>     Shared secret key used for generating the HMAC variant of the message digest.
  <info>bool</info>    <strong>$binary</strong>  When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the calculated message digest as lowercase hexits unless
          <strong>$binary</strong> is set to true in which case the raw binary representation of the message digest
          is returned.

<comment>See Also:</comment>
   * <strong>hash()</strong>
   * <strong>hash_hmac_algos()</strong>
   * <strong>hash_init()</strong>
   * <strong>hash_hmac_file()</strong>
   * <strong>hash_equals()</strong>


id: hash_hmac_algos
type: function
doc:
<comment>Description:</comment>
  Return a list of registered hashing algorithms suitable for hash_hmac

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array containing the list of supported hashing algorithms
         suitable for <strong>hash_hmac()</strong>.

<comment>See Also:</comment>
   * <strong>hash_hmac()</strong>
   * <strong>hash_algos()</strong>


id: hash_hmac_file
type: function
doc:
<comment>Description:</comment>
  Generate a keyed hash value using the HMAC method and the contents of a given file

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>      Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..)
                     See <strong>hash_hmac_algos()</strong> for a list of supported algorithms.
  <info>string</info>  <strong>$filename</strong>  URL describing location of file to be hashed; Supports fopen wrappers.
  <info>string</info>  <strong>$key</strong>       Shared secret key used for generating the HMAC variant of the message digest.
  <info>bool</info>    <strong>$binary</strong>    When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing the calculated message digest as lowercase hexits unless
                <strong>$binary</strong> is set to true in which case the raw binary representation of the message
                digest is returned. Returns <info>false</info> if the file <strong>$filename</strong> cannot be read.

<comment>See Also:</comment>
   * <strong>hash_hmac_algos()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>hash_file()</strong>


id: hash_init
type: function
doc:
<comment>Description:</comment>
  Initialize an incremental hashing context

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>     Name of selected hashing algorithm (i.e. "md5", "sha256", "haval160,4", etc..).
                    For a list of supported algorithms see <strong>hash_algos()</strong>.
  <info>int</info>     <strong>$flags</strong>    Optional settings for hash generation, currently supports only one option:
                    <info>HASH_HMAC</info>.  When specified, the <strong>$key</strong> must be specified.
  <info>string</info>  <strong>$key</strong>      When <info>HASH_HMAC</info> is specified for <strong>$flags</strong>, a shared secret key to be used with the
                    HMAC hashing method must be supplied in this parameter.
  <info>array</info>   <strong>$options</strong>  An array of options for the various hashing algorithms.  Currently, only the
                    "seed" parameter is supported by the MurmurHash variants.

<comment>Return:</comment>
  <info>HashContext</info>  Returns a Hashing Context for use with <strong>hash_update()</strong>, <strong>hash_update_stream()</strong>,
               <strong>hash_update_file()</strong>, and <strong>hash_final()</strong>.

<comment>See Also:</comment>
   * <strong>hash()</strong>
   * <strong>hash_algos()</strong>
   * <strong>hash_file()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>hash_hmac_file()</strong>


id: hash_pbkdf2
type: function
doc:
<comment>Description:</comment>
  Generate a PBKDF2 key derivation of a supplied password

<comment>Param:</comment>
  <info>string</info>  <strong>$algo</strong>        Name of selected hashing algorithm (i.e. <return>md5</return>, <return>sha256</return>, <return>haval160,4</return>, etc..) See
                       <strong>hash_algos()</strong> for a list of supported algorithms.
  <info>string</info>  <strong>$password</strong>    The password to use for the derivation.
  <info>string</info>  <strong>$salt</strong>        The salt to use for the derivation. This value should be generated randomly.
  <info>int</info>     <strong>$iterations</strong>  The number of internal iterations to perform for the derivation.
  <info>int</info>     <strong>$length</strong>      The length of the output string. If <strong>$binary</strong> is <info>true</info> this corresponds to the
                       byte-length of the derived key, if <strong>$binary</strong> is <info>false</info> this corresponds to twice
                       the byte-length of the derived key (as every byte of the key is returned as
                       two hexits).
                       
                       If <return>0</return> is passed, the entire output of the supplied algorithm is used.
  <info>bool</info>    <strong>$binary</strong>      When set to <info>true</info>, outputs raw binary data. <info>false</info> outputs lowercase hexits.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the derived key as lowercase hexits unless <strong>$binary</strong> is set to
          <info>true</info> in which case the raw binary representation of the derived key is returned.

<comment>See Also:</comment>
   * <strong>password_hash()</strong>
   * <strong>hash_hkdf()</strong>
   * <strong>sodium_crypto_pwhash()</strong>


id: hash_update
type: function
doc:
<comment>Description:</comment>
  Pump data into an active hashing context

<comment>Param:</comment>
  <info>HashContext</info>  <strong>$context</strong>  Hashing context returned by <strong>hash_init()</strong>.
  <info>string</info>       <strong>$data</strong>     Message to be included in the hash digest.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info>.

<comment>See Also:</comment>
   * <strong>hash_init()</strong>
   * <strong>hash_update_file()</strong>
   * <strong>hash_update_stream()</strong>
   * <strong>hash_final()</strong>


id: hash_update_file
type: function
doc:
<comment>Description:</comment>
  Pump data into an active hashing context from a file

<comment>Param:</comment>
  <info>HashContext</info>    <strong>$context</strong>         Hashing context returned by <strong>hash_init()</strong>.
  <info>string</info>         <strong>$filename</strong>        URL describing location of file to be hashed; Supports fopen
                                  wrappers.
  <info>resource|null</info>  <strong>$stream_context</strong>  Stream context as returned by <strong>stream_context_create()</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>hash_init()</strong>
   * <strong>hash_update()</strong>
   * <strong>hash_update_stream()</strong>
   * <strong>hash_final()</strong>
   * <strong>hash()</strong>
   * <strong>hash_file()</strong>


id: hash_update_stream
type: function
doc:
<comment>Description:</comment>
  Pump data into an active hashing context from an open stream

<comment>Param:</comment>
  <info>HashContext</info>  <strong>$context</strong>  Hashing context returned by <strong>hash_init()</strong>.
  <info>resource</info>     <strong>$stream</strong>   Open file handle as returned by any stream creation function.
  <info>int</info>          <strong>$length</strong>   Maximum number of characters to copy from <strong>$stream</strong> into the hashing context.

<comment>Return:</comment>
  <info>int</info>  Actual number of bytes added to the hashing context from <strong>$stream</strong>.

<comment>See Also:</comment>
   * <strong>hash_init()</strong>
   * <strong>hash_update()</strong>
   * <strong>hash_final()</strong>
   * <strong>hash()</strong>
   * <strong>hash_file()</strong>


id: header
type: function
doc:
<comment>Description:</comment>
  Send a raw HTTP header
  
  <strong>header()</strong> is used to send a raw HTTP header. See the HTTP/1.1 specification for more information on
  HTTP headers.
  
  Remember that <strong>header()</strong> must be called before any actual output is sent, either by normal HTML
  tags, blank lines in a file, or from PHP. It is a very common error to read code with <strong>include()</strong>,
  or <strong>require()</strong>,  functions, or another file access function, and have spaces or empty lines that are
  output before <strong>header()</strong> is called. The same problem exists when using a single PHP/HTML file.
  
  ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$header</strong>         The header string.
                          
                          There are two special-case header calls.  The first is a header that
                          starts with the string "<return>HTTP/</return>" (case is not significant), which will be
                          used to figure out the HTTP status code to send. For example, if you have
                          configured Apache to use a PHP script to handle requests for missing files
                          (using the <return>ErrorDocument</return> directive), you may want to make sure that your
                          script generates the proper status code.
                          
                          
                          ]]>
                          
                          The second special case is the "Location:" header.  Not only does it send
                          this header back to the browser, but it also returns a <return>REDIRECT</return> (302)
                          status code to the browser unless the <return>201</return> or a <return>3xx</return> status code has already
                          been set.
                          
                          
                          ]]>
  <info>bool</info>    <strong>$replace</strong>        The optional <strong>$replace</strong> parameter indicates whether the header should
                          replace a previous similar header, or add a second header of the same
                          type.  By default it will replace, but if you pass in <info>false</info> as the second
                          argument you can force multiple headers of the same type.  For example:
                          
                          
                          ]]>
  <info>int</info>     <strong>$response_code</strong>  Forces the HTTP response code to the specified value. Note that this
                          parameter only has an effect if the <strong>$header</strong> is  not empty.

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

<comment>See Also:</comment>
   * <strong>headers_sent()</strong>
   * <strong>setcookie()</strong>
   * <strong>http_response_code()</strong>
   * <strong>header_remove()</strong>
   * <strong>headers_list()</strong>
   * 
     The section on HTTP
     authentication
    


id: header_register_callback
type: function
doc:
<comment>Description:</comment>
  Call a header function
  
  Registers a function that will be called when PHP starts sending output.
  
  The <strong>$callback</strong> is executed just after PHP prepares all headers to be sent, and before any other
  output is sent, creating a window to manipulate the outgoing headers before being sent.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Function called just before the headers are sent. It gets no parameters and
                       the return value is ignored.

<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>headers_list()</strong>
   * <strong>header_remove()</strong>
   * <strong>header()</strong>


id: header_remove
type: function
doc:
<comment>Description:</comment>
  Remove cabeçalhos definidos anteriormente
  
  Remove um cabeçalho HTTP previamente definido usando <strong>header()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  O nome do cabeçalho a ser removido. Quando igual a <info>null</info>, todos os cabeçalhos
                      anteriormente definidos são removidos.
                      
                      Este parâmetro é insensível a maiúsculas/minúsculas.

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

<comment>See Also:</comment>
   * <strong>header()</strong>
   * <strong>headers_sent()</strong>


id: headers_list
type: function
doc:
<comment>Description:</comment>
  Retorna uma lista de cabeçalhos de resposta enviados (ou prontos para enviar)
  
  <strong>headers_list()</strong> retornará uma lista de cabeçalhos a serem enviados ao navegador / cliente.  Para
  determinar se esses cabeçalhos já foram ou não enviados, use <strong>headers_sent()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retorna um array de cabeçalhos indexado numericamente.

<comment>See Also:</comment>
   * <strong>headers_sent()</strong>
   * <strong>header()</strong>
   * <strong>setcookie()</strong>
   * <strong>apache_response_headers()</strong>
   * <strong>http_response_code()</strong>


id: headers_sent
type: function
doc:
<comment>Description:</comment>
  Checks if or where headers have been sent
  
  Checks if or where headers have been sent.
  
  You can't add any more header lines using the <strong>header()</strong> function once the header block has already
  been sent. Using this function you can at least prevent getting HTTP header related error
  messages. Another option is to use Output Buffering.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  If the optional <strong>$filename</strong> and <strong>$line</strong> parameters are set,  <strong>headers_sent()</strong> will
                     put the PHP source file name and line number where output started in the
                     <strong>$filename</strong> and <strong>$line</strong> variables.
                     
                     If the output has started before executing the PHP source file (for example due
                     to a startup error), the <strong>$filename</strong> parameter will be set to an empty string.
  <info>int</info>     <strong>$line</strong>      The line number where the output started.

<comment>Return:</comment>
  <info>bool</info>  <strong>headers_sent()</strong> will return <info>false</info> if no HTTP headers have already been sent or <info>true</info>
        otherwise.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>trigger_error()</strong>
   * <strong>headers_list()</strong>
   * <strong>header()</strong> for a more detailed discussion of the
     matters involved.
    


id: hebrev
type: function
doc:
<comment>Description:</comment>
  Convert logical Hebrew text to visual text
  
  Converts logical Hebrew text to visual text.
  
  The function tries to avoid breaking words.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>              A Hebrew input string.
  <info>int</info>     <strong>$max_chars_per_line</strong>  This optional parameter indicates maximum number of characters per
                               line that will be returned.

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

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


id: hebrevc
type: function
doc:
<comment>Description:</comment>
  Convert logical Hebrew text to visual text with newline conversion
  
  This function is similar to <strong>hebrev()</strong> with the difference that it converts newlines (\n) to "\<br&gt;\n".
  
  The function tries to avoid breaking words.

<comment>Param:</comment>
  <info>string</info>  <strong>$hebrew_text</strong>         A Hebrew input string.
  <info>int</info>     <strong>$max_chars_per_line</strong>  This optional parameter indicates maximum number of characters per
                               line that will be returned.

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

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


id: hex2bin
type: function
doc:
<comment>Description:</comment>
  Decodifica uma string binária codificada em hexadecimal
  
  Decodifica uma string binária codificada em hexadecimal.
  
  Esta função NÃO converte um número hexadecimal para um número binário. Isso pode ser feito através
  da função <strong>base_convert()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  Representação hexadecimal dos dados.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a representação binária dos dados fornecidos  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>bin2hex()</strong>
   * <strong>unpack()</strong>


id: hexdec
type: function
doc:
<comment>Description:</comment>
  Hexadecimal para decimal
  
  Retorna o equivalente em decimal do número hexadecimal representado pelo argumento <strong>$hex_string</strong>.
  <strong>hexdec()</strong> converte uma string hexadecimal para um número decimal.
  
  <strong>hexdec()</strong> irá ignorar qualquer caractere não hexadecimal que encontrar. A partir do PHP 7.4.0
  fornecer caracteres inválidos está defasado.

<comment>Param:</comment>
  <info>string</info>  <strong>$hex_string</strong>  A string hexadecimal a ser convertida

<comment>Return:</comment>
  <info>int|float</info>  A representação decimal de <strong>$hex_string</strong>

<comment>See Also:</comment>
   * <strong>dechex()</strong>
   * <strong>bindec()</strong>
   * <strong>octdec()</strong>
   * <strong>base_convert()</strong>


id: highlight_file
type: function
doc:
<comment>Description:</comment>
  Destaca a sintaxe de um arquivo
  
  Imprime ou retorna a versão com destaque de sintaxe do código contigo no arquivo <strong>$filename</strong>
  utilizando as cores definidas no destacador de sintaxe nativo do PHP.
  
  Muitos servidores são configurados para destacar automaticamente os arquivos com extensão phps.
  Por exemplo, o arquivo example.phps quando acessado irá mostrar o código fonte com destaque de
  cores. Para ativar isso, acrescente a seguinte linha no httpd.conf:

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho do arquivo PHP a ser destacado.
  <info>bool</info>    <strong>$return</strong>    Informe esse parâmetro como <info>true</info> para fazer essa função retornar o código
                     destacado (ao invés de imprimir).

<comment>Return:</comment>
  <info>string|bool</info>  Se <strong>$return</strong> for <info>true</info>, retorna o código destacado como uma string ao invés de imprimir.
               Se não, irá retornar <info>true</info> no sucesso e <info>false</info> no caso de falhas.

<comment>See Also:</comment>
   * <strong>highlight_string()</strong>
   * Diretivas INI de highlight


id: highlight_string
type: function
doc:
<comment>Description:</comment>
  Destaque de sintaxe de uma string
  
  Mostra ou retorna uma marcação html para uma versão destacada do código PHP fornecido usando as
  cores definidas no marcador de sintaxe integrado do PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  O código PHP a ser destacado. Isso deve incluir a etiqueta de abertura.
  <info>bool</info>    <strong>$return</strong>  Defina este parâmetro como <info>true</info> para fazer esta função retornar o código
                   destacado.

<comment>Return:</comment>
  <info>string|bool</info>  Se <strong>$return</strong> estiver definido para <info>true</info>, retorna o código destacado como uma string ao
               invés de mostrá-lo. Caso contrário, retorna <info>true</info> em caso de sucesso, <info>false</info> em caso de
               falha.

<comment>See Also:</comment>
   * <strong>highlight_file()</strong>
   * Diretivas INI para destaque


id: hrtime
type: function
doc:
<comment>Description:</comment>
  Obtém o tempo de alta resolução do sistema
  
  Retorna o tempo em alta resolução do sistema, contado a partir de um ponto arbitrário no tempo. O
  timestamp fornecido é monotônico e não pode ser ajustado.

<comment>Param:</comment>
  <info>bool</info>  <strong>$as_number</strong>  Define se o tempo em alta resolução deve ser retornado como <info>array</info> ou como
                    número.

<comment>Return:</comment>
  <info>array|int|float|false</info>  Retorna um array de inteiros na forma [segundos, nanossegundos], se o
                         parâmetro <strong>$as_number</strong> for falso. Caso contrário, os nanossegundos são
                         retornados como <info>int</info> (plataformas 64 bits) ou <info>float</info> (plataformas 32 bits).
                         Retorna <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * A extensão de Tempo de alta resolução
   * <strong>microtime()</strong>


id: html_entity_decode
type: function
doc:
<comment>Description:</comment>
  Convert HTML entities to their corresponding characters
  
  <strong>html_entity_decode()</strong> is the opposite of <strong>htmlentities()</strong> in that it converts HTML entities in the
  <strong>$string</strong> to their corresponding characters.
  
  More precisely, this function decodes all the entities (including all numeric entities) that a)
  are necessarily valid for the chosen document type — i.e., for XML, this function does not decode
  named entities that might be defined in some DTD — and b) whose character or characters are in the
  coded character set associated with the chosen encoding and are permitted in the chosen document
  type. All other entities are left as is.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    The input string.
  <info>int</info>          <strong>$flags</strong>     A bitmask of one or more of the following flags, which specify how to
                          handle quotes and which document type to use. The default is <return>ENT_QUOTES |
                          ENT_SUBSTITUTE | ENT_HTML401</return>. Available <strong>$flags</strong> constantsConstant
                          NameDescription<info>ENT_COMPAT</info>Will convert double-quotes and leave
                          single-quotes alone.<info>ENT_QUOTES</info>Will convert both double and single
                          quotes.<info>ENT_NOQUOTES</info>Will leave both double and single quotes
                          unconverted.<info>ENT_SUBSTITUTE</info> Replace invalid code unit sequences with a
                          Unicode Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise)
                          instead of returning an empty string. <info>ENT_HTML401</info> Handle code as HTML
                          4.01. <info>ENT_XML1</info> Handle code as XML 1. <info>ENT_XHTML</info> Handle code as XHTML.
                          <info>ENT_HTML5</info> Handle code as HTML 5.
  <info>string|null</info>  <strong>$encoding</strong>  Um argumento opcional que define a codificação usada na conversão de
                          caracteres.
                          
                          Se omitido, <strong>$encoding</strong> assume como padrão o valor da opção de configuração
                          default_charset .
                          
                          Embora este argumento seja tecnicamente opcional, especificar o valor
                          correto para o código é altamente recomendável se a opção de configuração
                          default_charset puder ser definida incorretamente para a entrada
                          fornecida.
                          
                          Os seguintes conjuntos de caracteres são suportados: Conjuntos de
                          caracteres suportadosConjunto de
                          caracteresApelidosDescriçãoISO-8859-1ISO8859-1 Western European, Latin-1.
                          ISO-8859-5ISO8859-5 Conjunto de caracteres cirílicos pouco usado
                          (Latim/Cirílico). ISO-8859-15ISO8859-15 Western European, Latin-9.
                          Adiciona o símbolo do Euro, letras Francesas e Filandesas faltando no
                          Latin-1 (ISO-8859-1). UTF-8 Código de multi-byte 8-bit Unicode compatível
                          com ASCII. cp866ibm866, 866 Conjunto de caracteres do DOS específico para
                          o Russo. cp1251Windows-1251, win-1251, 1251 Conjunto de caracteres do
                          Windows específico para o Russo. cp1252Windows-1252, 1252 Conjunto de
                          caracteres do Windows específico para a Europa Ocidental. KOI8-Rkoi8-ru,
                          koi8r Russo. BIG5950 Chinês Tradicional, usado principalmente em Taiwan.
                          GB2312936 Chins Simplificado, conjunto de caracteres padrão nacional.
                          BIG5-HKSCS Big5 com extenções de Hong Kong, Chinês Tradicional.
                          Shift_JISSJIS, SJIS-win, cp932, 932 Japonês EUC-JPEUCJP, eucJP-win Japonês
                          MacRoman Conjunto de caracteres que era usado pelo Mac OS. <return>''</return> Uma string
                          vazia ativa a detecção a partir de codificação de script (multibyte Zend),
                          conjunto padrão de caracteres e localidade atual (consulte <strong>nl_langinfo()</strong> e
                          <strong>setlocale()</strong>), nesta ordem. Não recomendado.   Nenhum outro conjunto de
                          caracteres é reconhecido. A codificação padrão será usada no lugar e um
                          alerta será emitido.
                          
                          Nenhum outro conjunto de caracteres é reconhecido. A codificação padrão
                          será usada no lugar e um alerta será emitido.

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

<comment>See Also:</comment>
   * <strong>htmlentities()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>get_html_translation_table()</strong>
   * <strong>urldecode()</strong>


id: htmlentities
type: function
doc:
<comment>Description:</comment>
  Convert all applicable characters to HTML entities
  
  This function is identical to <strong>htmlspecialchars()</strong> in all ways, except with <strong>htmlentities()</strong>, all
  characters which have HTML character entity equivalents are translated into these entities. The
  <strong>get_html_translation_table()</strong> function can be used to return the translation table used dependent
  upon the provided <strong>$flags</strong> constants.
  
  If you want to decode instead (the reverse) you can use <strong>html_entity_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>         The input string.
  <info>int</info>          <strong>$flags</strong>          A bitmask of one or more of the following flags, which specify how to
                               handle quotes, invalid code unit sequences and the used document
                               type. The default is <return>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</return>.
                               Available <strong>$flags</strong> constantsConstant NameDescription<info>ENT_COMPAT</info>Will
                               convert double-quotes and leave single-quotes alone.<info>ENT_QUOTES</info>Will
                               convert both double and single quotes.<info>ENT_NOQUOTES</info>Will leave both
                               double and single quotes unconverted.<info>ENT_IGNORE</info> Silently discard
                               invalid code unit sequences instead of returning an empty string.
                               Using this flag is discouraged as it may have security implications.
                               <info>ENT_SUBSTITUTE</info> Replace invalid code unit sequences with a Unicode
                               Replacement Character U+FFFD (UTF-8) or &#FFFD; (otherwise) instead
                               of returning an empty string. <info>ENT_DISALLOWED</info> Replace invalid code
                               points for the given document type with a Unicode Replacement
                               Character U+FFFD (UTF-8) or &#FFFD; (otherwise) instead of leaving
                               them as is. This may be useful, for instance, to ensure the
                               well-formedness of XML documents with embedded external content.
                               <info>ENT_HTML401</info> Handle code as HTML 4.01. <info>ENT_XML1</info> Handle code as XML 1.
                               <info>ENT_XHTML</info> Handle code as XHTML. <info>ENT_HTML5</info> Handle code as HTML 5.
  <info>string|null</info>  <strong>$encoding</strong>       Um argumento opcional que define a codificação usada na conversão de
                               caracteres.
                               
                               Se omitido, <strong>$encoding</strong> assume como padrão o valor da opção de
                               configuração default_charset .
                               
                               Embora este argumento seja tecnicamente opcional, especificar o valor
                               correto para o código é altamente recomendável se a opção de
                               configuração default_charset puder ser definida incorretamente para a
                               entrada fornecida.
                               
                               Os seguintes conjuntos de caracteres são suportados: Conjuntos de
                               caracteres suportadosConjunto de
                               caracteresApelidosDescriçãoISO-8859-1ISO8859-1 Western European,
                               Latin-1. ISO-8859-5ISO8859-5 Conjunto de caracteres cirílicos pouco
                               usado (Latim/Cirílico). ISO-8859-15ISO8859-15 Western European,
                               Latin-9. Adiciona o símbolo do Euro, letras Francesas e Filandesas
                               faltando no Latin-1 (ISO-8859-1). UTF-8 Código de multi-byte 8-bit
                               Unicode compatível com ASCII. cp866ibm866, 866 Conjunto de caracteres
                               do DOS específico para o Russo. cp1251Windows-1251, win-1251, 1251
                               Conjunto de caracteres do Windows específico para o Russo.
                               cp1252Windows-1252, 1252 Conjunto de caracteres do Windows específico
                               para a Europa Ocidental. KOI8-Rkoi8-ru, koi8r Russo. BIG5950 Chinês
                               Tradicional, usado principalmente em Taiwan. GB2312936 Chins
                               Simplificado, conjunto de caracteres padrão nacional. BIG5-HKSCS Big5
                               com extenções de Hong Kong, Chinês Tradicional. Shift_JISSJIS,
                               SJIS-win, cp932, 932 Japonês EUC-JPEUCJP, eucJP-win Japonês MacRoman
                               Conjunto de caracteres que era usado pelo Mac OS. <return>''</return> Uma string vazia
                               ativa a detecção a partir de codificação de script (multibyte Zend),
                               conjunto padrão de caracteres e localidade atual (consulte
                               <strong>nl_langinfo()</strong> e <strong>setlocale()</strong>), nesta ordem. Não recomendado.   Nenhum
                               outro conjunto de caracteres é reconhecido. A codificação padrão será
                               usada no lugar e um alerta será emitido.
                               
                               Nenhum outro conjunto de caracteres é reconhecido. A codificação
                               padrão será usada no lugar e um alerta será emitido.
  <info>bool</info>         <strong>$double_encode</strong>  When <strong>$double_encode</strong> is turned off PHP will not encode existing html
                               entities. The default is to convert everything.

<comment>Return:</comment>
  <info>string</info>  Returns the encoded string.
          
          If the input <strong>$string</strong> contains an invalid code unit sequence within the given <strong>$encoding</strong> an
          empty string will be returned, unless either the <info>ENT_IGNORE</info> or <info>ENT_SUBSTITUTE</info> flags are
          set.

<comment>See Also:</comment>
   * <strong>html_entity_decode()</strong>
   * <strong>get_html_translation_table()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>nl2br()</strong>
   * <strong>urlencode()</strong>


id: htmlspecialchars
type: function
doc:
<comment>Description:</comment>
  Convert special characters to HTML entities
  
  Certain characters have special significance in HTML, and should be represented by HTML entities
  if they are to preserve their meanings. This function returns a string with these conversions
  made. If you require all input substrings that have associated named entities to be translated,
  use <strong>htmlentities()</strong> instead.
  
  If the input string passed to this function and the final document share the same character set,
  this function is sufficient to prepare input for inclusion in most contexts of an HTML document.
  If, however, the input can represent characters that are not coded in the final document character
  set and you wish to retain those characters (as numeric or named entities), both this function and
  <strong>htmlentities()</strong> (which only encodes substrings that have named entity equivalents) may be
  insufficient. You may have to use <strong>mb_encode_numericentity()</strong> instead.
  
  Performed translationsCharacterReplacement<return>&</return> (ampersand)<return>&amp;</return><return>"</return> (double quote)<return>&quot;</return>, unless
  <info>ENT_NOQUOTES</info> is set<return>'</return> (single quote)<return>&#039;</return> (for <info>ENT_HTML401</info>) or <return>&apos;</return> (for <info>ENT_XML1</info>, <info>ENT_XHTML</info> or
  <info>ENT_HTML5</info>), but only when <info>ENT_QUOTES</info> is set <return>\<</return> (less than)<return>&lt;</return><return>&gt;</return> (greater than)<return>&gt;</return>

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>         The <info>string</info> being converted.
  <info>int</info>          <strong>$flags</strong>          A bitmask of one or more of the following flags, which specify how to
                               handle quotes, invalid code unit sequences and the used document
                               type. The default is <return>ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401</return>.
                               Available <strong>$flags</strong> constantsConstant NameDescription<info>ENT_COMPAT</info>Will
                               convert double-quotes and leave single-quotes alone.<info>ENT_QUOTES</info>Will
                               convert both double and single quotes.<info>ENT_NOQUOTES</info>Will leave both
                               double and single quotes unconverted.<info>ENT_IGNORE</info> Silently discard
                               invalid code unit sequences instead of returning an empty string.
                               Using this flag is discouraged as it may have security implications.
                               <info>ENT_SUBSTITUTE</info> Replace invalid code unit sequences with a Unicode
                               Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise) instead
                               of returning an empty string. <info>ENT_DISALLOWED</info> Replace invalid code
                               points for the given document type with a Unicode Replacement
                               Character U+FFFD (UTF-8) or &#xFFFD; (otherwise) instead of leaving
                               them as is. This may be useful, for instance, to ensure the
                               well-formedness of XML documents with embedded external content.
                               <info>ENT_HTML401</info> Handle code as HTML 4.01. <info>ENT_XML1</info> Handle code as XML 1.
                               <info>ENT_XHTML</info> Handle code as XHTML. <info>ENT_HTML5</info> Handle code as HTML 5.
  <info>string|null</info>  <strong>$encoding</strong>       Um argumento opcional que define a codificação usada na conversão de
                               caracteres.
                               
                               Se omitido, <strong>$encoding</strong> assume como padrão o valor da opção de
                               configuração default_charset .
                               
                               Embora este argumento seja tecnicamente opcional, especificar o valor
                               correto para o código é altamente recomendável se a opção de
                               configuração default_charset puder ser definida incorretamente para a
                               entrada fornecida.
                               
                               For the purposes of this function, the encodings <return>ISO-8859-1</return>,
                               <return>ISO-8859-15</return>, <return>UTF-8</return>, <return>cp866</return>, <return>cp1251</return>, <return>cp1252</return>, and <return>KOI8-R</return> are effectively
                               equivalent, provided the <strong>$string</strong> itself is valid for the encoding, as
                               the characters affected by <strong>htmlspecialchars()</strong> occupy the same
                               positions in all of these encodings.
                               
                               Os seguintes conjuntos de caracteres são suportados: Conjuntos de
                               caracteres suportadosConjunto de
                               caracteresApelidosDescriçãoISO-8859-1ISO8859-1 Western European,
                               Latin-1. ISO-8859-5ISO8859-5 Conjunto de caracteres cirílicos pouco
                               usado (Latim/Cirílico). ISO-8859-15ISO8859-15 Western European,
                               Latin-9. Adiciona o símbolo do Euro, letras Francesas e Filandesas
                               faltando no Latin-1 (ISO-8859-1). UTF-8 Código de multi-byte 8-bit
                               Unicode compatível com ASCII. cp866ibm866, 866 Conjunto de caracteres
                               do DOS específico para o Russo. cp1251Windows-1251, win-1251, 1251
                               Conjunto de caracteres do Windows específico para o Russo.
                               cp1252Windows-1252, 1252 Conjunto de caracteres do Windows específico
                               para a Europa Ocidental. KOI8-Rkoi8-ru, koi8r Russo. BIG5950 Chinês
                               Tradicional, usado principalmente em Taiwan. GB2312936 Chins
                               Simplificado, conjunto de caracteres padrão nacional. BIG5-HKSCS Big5
                               com extenções de Hong Kong, Chinês Tradicional. Shift_JISSJIS,
                               SJIS-win, cp932, 932 Japonês EUC-JPEUCJP, eucJP-win Japonês MacRoman
                               Conjunto de caracteres que era usado pelo Mac OS. <return>''</return> Uma string vazia
                               ativa a detecção a partir de codificação de script (multibyte Zend),
                               conjunto padrão de caracteres e localidade atual (consulte
                               <strong>nl_langinfo()</strong> e <strong>setlocale()</strong>), nesta ordem. Não recomendado.   Nenhum
                               outro conjunto de caracteres é reconhecido. A codificação padrão será
                               usada no lugar e um alerta será emitido.
                               
                               Nenhum outro conjunto de caracteres é reconhecido. A codificação
                               padrão será usada no lugar e um alerta será emitido.
  <info>bool</info>         <strong>$double_encode</strong>  When <strong>$double_encode</strong> is turned off PHP will not encode existing html
                               entities, the default is to convert everything.

<comment>Return:</comment>
  <info>string</info>  The converted <info>string</info>.
          
          If the input <strong>$string</strong> contains an invalid code unit sequence within the given <strong>$encoding</strong> an
          empty string will be returned, unless either the <info>ENT_IGNORE</info> or <info>ENT_SUBSTITUTE</info> flags are
          set.

<comment>See Also:</comment>
   * <strong>get_html_translation_table()</strong>
   * <strong>htmlspecialchars_decode()</strong>
   * <strong>strip_tags()</strong>
   * <strong>htmlentities()</strong>
   * <strong>nl2br()</strong>


id: htmlspecialchars_decode
type: function
doc:
<comment>Description:</comment>
  Convert special HTML entities back to characters
    
  
  This function is the opposite of <strong>htmlspecialchars()</strong>. It converts special HTML entities back to
  characters.
  
  The converted entities are: , (when <info>ENT_NOQUOTES</info> is not set), <return>&#039;</return> (when <info>ENT_QUOTES</info> is set), and
  .

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string to decode.
  <info>int</info>     <strong>$flags</strong>   A bitmask of one or more of the following flags, which specify how to handle
                   quotes and which document type to use. The default is <return>ENT_QUOTES | ENT_SUBSTITUTE
                   | ENT_HTML401</return>. Available <strong>$flags</strong> constantsConstant NameDescription<info>ENT_COMPAT</info>Will
                   convert double-quotes and leave single-quotes alone.<info>ENT_QUOTES</info>Will convert both
                   double and single quotes.<info>ENT_NOQUOTES</info>Will leave both double and single quotes
                   unconverted.<info>ENT_SUBSTITUTE</info> Replace invalid code unit sequences with a Unicode
                   Replacement Character U+FFFD (UTF-8) or &#xFFFD; (otherwise) instead of returning
                   an empty string. <info>ENT_HTML401</info> Handle code as HTML 4.01. <info>ENT_XML1</info> Handle code as
                   XML 1. <info>ENT_XHTML</info> Handle code as XHTML. <info>ENT_HTML5</info> Handle code as HTML 5.

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

<comment>See Also:</comment>
   * <strong>htmlspecialchars()</strong>
   * <strong>html_entity_decode()</strong>
   * <strong>get_html_translation_table()</strong>


id: http_build_query
type: function
doc:
<comment>Description:</comment>
  Gera a string de consulta (query) em formato URL
  
  Gera a string de consulta (query) em formato URL a partir de um array associativo (ou indexado).

<comment>Param:</comment>
  <info>array|object</info>  <strong>$data</strong>            Pode ser um array ou objeto contendo propriedades.
                                 
                                 Se <strong>$data</strong> é um array, este pode ser de estrutura simples de uma
                                 dimensão, ou um array multidimensional (que por sua vez pode conter
                                 outros arrays).
                                 
                                 Se <strong>$data</strong> é um objeto, então somente propriedades públicas serão
                                 incorporadas ao resultado.
  <info>string</info>        <strong>$numeric_prefix</strong>  Se índices numéricos são usados no array base e esse parâmetro for
                                 fornecido, o número índice dos elementos será prefixado com seu
                                 valor, apenas no array base.
                                 
                                 Isso é feito para permitir nomes de variáveis aceitáveis quando os
                                 dados forem decodificados pelo PHP ou por outra aplicação CGI
                                 posteriormente.
  <info>string|null</info>   <strong>$arg_separator</strong>   O argumento separador. Se não estiver definido ou <info>null</info>,
                                 arg_separator.output é usado para separar argumentos.
  <info>int</info>           <strong>$encoding_type</strong>   Por padrão, <info>PHP_QUERY_RFC1738</info>.
                                 
                                 Se <strong>$encoding_type</strong> é <info>PHP_QUERY_RFC1738</info>, então a codificação é
                                 executada por RFC 1738 e o media type
                                 <return>application/x-www-form-urlencoded</return>, o que implica que os espaços são
                                 codificados com o sinal de mais(<return>+</return>).
                                 
                                 Se <strong>$encoding_type</strong> é <info>PHP_QUERY_RFC3986</info>, então a codificação é
                                 executada de acordo com RFC 3986, e os espaços serão codificados em
                                 porcentagem (<return>%20</return>).

<comment>Return:</comment>
  <info>string</info>  Retorna um string no formato de uma URL.

<comment>See Also:</comment>
   * <strong>parse_str()</strong>
   * <strong>parse_url()</strong>
   * <strong>urlencode()</strong>
   * <strong>array_walk()</strong>


id: http_response_code
type: function
doc:
<comment>Description:</comment>
  Get or Set the HTTP response code
  
  Gets or sets the HTTP response status code.

<comment>Param:</comment>
  <info>int</info>  <strong>$response_code</strong>  The optional <strong>$response_code</strong> will set the response code.

<comment>Return:</comment>
  <info>int|bool</info>  If <strong>$response_code</strong> is provided, then the previous status code will be returned. If
            <strong>$response_code</strong> is not provided, then the current status code will be returned. Both of
            these values will default to a <return>200</return> status code if used in a web server environment.
            
            <info>false</info> will be returned if <strong>$response_code</strong> is not provided and it is not invoked in a web
            server environment (such as from a CLI application). <info>true</info> will be returned if
            <strong>$response_code</strong> is provided and it is not invoked in a web server environment (but only
            when no previous response status has been set).

<comment>See Also:</comment>
   * <strong>header()</strong>
   * <strong>headers_list()</strong>


id: hypot
type: function
doc:
<comment>Description:</comment>
  Calcula o comprimento da hipotenusa de triângulo retângulo
    
  
  <strong>hypot()</strong> retorna o comprimento da hipotenusa de um triângulo retângulo com lados de tamanho <strong>$x</strong> e
  <strong>$y</strong>, ou a distância do ponto (<strong>$x</strong>, <strong>$y</strong>) a partir da origem. É o equivalente a sqrt($x*$x + $y*$y).

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  Comprimento do primeiro lado
  <info>float</info>  <strong>$y</strong>  Comprimento do segundo lado

<comment>Return:</comment>
  <info>float</info>  Comprimento calculado da hipotenusa


id: ibase_add_user
type: function
doc:
<comment>Description:</comment>
  Adiciona um usuário a um banco de dados seguro

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  O manipulador no serviço do servidor de banco de dados.
  <info>string</info>    <strong>$user_name</strong>       O login do novo usuário do banco de dados.
  <info>string</info>    <strong>$password</strong>        A senha do novo usuário.
  <info>string</info>    <strong>$first_name</strong>      O primeiro nome do novo usuário.
  <info>string</info>    <strong>$middle_name</strong>     O nome do meio do novo usuário.
  <info>string</info>    <strong>$last_name</strong>       O último nome do novo usuário.

<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>ibase_modify_user()</strong>
   * <strong>ibase_delete_user()</strong>


id: ibase_affected_rows
type: function
doc:
<comment>Description:</comment>
  Retorna o número de linhas que foram afetados pela consulta anterior
  
  Esta função retorna o número de registros que foram afetados pela consulta (INSERT, UPDATE or
  DELETE) anterior que foi executada no contexto da transação especificada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Um contexto de transação. Se <strong>$link_identifier</strong> é um resource de
                              conexão, a transação padrão é usada.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de linhas como um inteiro.

<comment>See Also:</comment>
   * <strong>ibase_query()</strong>
   * <strong>ibase_execute()</strong>


id: ibase_backup
type: function
doc:
<comment>Description:</comment>
  Initiates a backup task in the service manager and returns immediately
  
  This function passes the arguments to the (remote) database server. There it starts a new backup
  process. Therefore you won't get any responses.

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  A previously opened connection to the database server.
  <info>string</info>    <strong>$source_db</strong>       The absolute file path to the database on the database server. You can
                             also use a database alias.
  <info>string</info>    <strong>$dest_file</strong>       The path to the backup file on the database server.
  <info>int</info>       <strong>$options</strong>         Additional options to pass to the database server for backup. The
                             <strong>$options</strong> parameter can be a combination  of the following constants:
                             <info>IBASE_BKP_IGNORE_CHECKSUMS</info>, <info>IBASE_BKP_IGNORE_LIMBO</info>,
                             <info>IBASE_BKP_METADATA_ONLY</info>, <info>IBASE_BKP_NO_GARBAGE_COLLECT</info>,
                             <info>IBASE_BKP_OLD_DESCRIPTIONS</info>, <info>IBASE_BKP_NON_TRANSPORTABLE</info> or
                             <info>IBASE_BKP_CONVERT</info>. Read the section about  for further information.
  <info>bool</info>      <strong>$verbose</strong>         Since the backup process is done on the database server, you don't have
                             any chance to get its output. This argument is useless.

<comment>Return:</comment>
  <info>mixed</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
         
         Since the backup process is done on the (remote) server, this function just passes the
         arguments to it. While the arguments are legal, you won't get <info>false</info>.

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


id: ibase_blob_add
type: function
doc:
<comment>Description:</comment>
  Adiciona dados em um blob recém criado
  
  <strong>ibase_blob_add()</strong> adiciona dados em um blob criado com <strong>ibase_blob_create()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  Um manipulador blob aberto com <strong>ibase_blob_create()</strong>.
  <info>string</info>    <strong>$data</strong>         A informação a ser adicionada.

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

<comment>See Also:</comment>
   * <strong>ibase_blob_cancel()</strong>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_create()</strong>
   * <strong>ibase_blob_import()</strong>


id: ibase_blob_cancel
type: function
doc:
<comment>Description:</comment>
  Cancel creating blob
  
  This function will discard a BLOB if it has not yet been closed by <strong>ibase_blob_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  A BLOB handle opened with <strong>ibase_blob_create()</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>ibase_blob_close()</strong>
   * <strong>ibase_blob_create()</strong>
   * <strong>ibase_blob_import()</strong>


id: ibase_blob_close
type: function
doc:
<comment>Description:</comment>
  Close blob
  
  This function closes a BLOB that has either been opened for reading by <strong>ibase_blob_open()</strong> or has
  been opened for writing by <strong>ibase_blob_create()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  A BLOB handle opened with <strong>ibase_blob_create()</strong> or <strong>ibase_blob_open()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  If the BLOB was being read, this function returns <info>true</info> on success, if the BLOB was being
         written to, this function returns a string containing the BLOB id that has been assigned to
         it by the database. On failure, this function returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>ibase_blob_cancel()</strong>
   * <strong>ibase_blob_open()</strong>


id: ibase_blob_create
type: function
doc:
<comment>Description:</comment>
  Create a new blob for adding data
  
  <strong>ibase_blob_create()</strong> creates a new BLOB for filling with data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  An InterBase link identifier. If omitted, the last opened link is
                              assumed.

<comment>Return:</comment>
  <info>resource|false</info>  Returns a BLOB handle for later use with <strong>ibase_blob_add()</strong> ou <info>false</info> em caso de
                  falha.

<comment>See Also:</comment>
   * <strong>ibase_blob_add()</strong>
   * <strong>ibase_blob_cancel()</strong>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_import()</strong>


id: ibase_blob_echo
type: function
doc:
<comment>Description:</comment>
  Output blob contents to browser
  
  This function opens a BLOB for reading and sends its contents directly to standard output (the
  browser, in most cases).

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  An InterBase link identifier. If omitted, the last opened link is
                              assumed.
  <info>string</info>    <strong>$blob_id</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>ibase_blob_open()</strong>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_get()</strong>


id: ibase_blob_get
type: function
doc:
<comment>Description:</comment>
  Retorna uma quantidade especificada de bytes de dados de um blob aberto
  
  Esta função retorna a quantidade <strong>$len</strong> de bytes de um BLOB que foi aberto para leitura com
  <strong>ibase_blob_open()</strong>.
  
  Não é possível ler de um BLOB que não foi aberto para escrita por <strong>ibase_blob_create()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  Um manipulador de BLOB aberto com <strong>ibase_blob_open()</strong>.
  <info>int</info>       <strong>$len</strong>          Tamanho da informação retornada.

<comment>Return:</comment>
  <info>string</info>  Retorna no máximo <strong>$len</strong> bytes de um BLOB, ou <info>false</info> em falha.

<comment>See Also:</comment>
   * <strong>ibase_blob_open()</strong>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_echo()</strong>


id: ibase_blob_import
type: function
doc:
<comment>Description:</comment>
  Cria um blob, copia um arquivo para ele e o fecha
  
  Este função cria um BLOB, lê um arquivo inteiro para dentro dele, fecha, e retorna o id do BLOB.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Um link identificador InterBase. Se omitido, o último link aberto é
                              usado.
  <info>resource</info>  <strong>$file_handle</strong>      O manipulador de arquivo é um manipulador retornado por <strong>fopen()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna o id do BLOB em sucesso, ou <info>false</info> em erro.

<comment>See Also:</comment>
   * <strong>ibase_blob_add()</strong>
   * <strong>ibase_blob_cancel()</strong>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_create()</strong>


id: ibase_blob_info
type: function
doc:
<comment>Description:</comment>
  Retorna o tamanho do blob e outras informações úteis
  
  Retorna o tamanho do BLOB e outras informações úteis.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Um link identificador InterBase. Se omitido, o último link aberto é
                              usado.
  <info>string</info>    <strong>$blob_id</strong>          Um id de BLOB.

<comment>Return:</comment>
  <info>array</info>  Retorna uma matriz contendo informações sobre um BLOB. A informação retornada consiste no
         tamanho do BLOB, o número de seguimentos que ele contém, o tamanho do maior seguimento e
         quando é um BLOB de stream ou um BLOB seguimentado.


id: ibase_blob_open
type: function
doc:
<comment>Description:</comment>
  Abre um blob para obter partes de dados
  
  Abre um BLOB existente para leitura.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Um link identificador InterBase. Se omitido, o último link aberto é
                              usado.
  <info>string</info>    <strong>$blob_id</strong>          Um id de BLOB.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um manipulador de BLOB para uso posterior com <strong>ibase_blob_get()</strong> ou <info>false</info> em
                  caso de falha.

<comment>See Also:</comment>
   * <strong>ibase_blob_close()</strong>
   * <strong>ibase_blob_echo()</strong>
   * <strong>ibase_blob_get()</strong>


id: ibase_close
type: function
doc:
<comment>Description:</comment>
  Close a connection to an InterBase database
  
  Closes the link to an InterBase database that's associated with a connection id returned from
  <strong>ibase_connect()</strong>. Default transaction on link is committed, other transactions are rolled back.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection_id</strong>  An InterBase link identifier returned from <strong>ibase_connect()</strong>. If omitted,
                            the last opened link is assumed.

<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>ibase_connect()</strong>
   * <strong>ibase_pconnect()</strong>


id: ibase_commit
type: function
doc:
<comment>Description:</comment>
  Commit a transaction
  
  Commits a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_or_trans_identifier</strong>  If called without an argument, this function commits the
                                       default transaction of the default link. If the argument is a
                                       connection identifier, the default transaction of the
                                       corresponding connection will be committed. If the argument
                                       is a transaction identifier, the corresponding transaction
                                       will be committed.

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


id: ibase_commit_ret
type: function
doc:
<comment>Description:</comment>
  Commit a transaction without closing it
  
  Commits a transaction without closing it.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_or_trans_identifier</strong>  If called without an argument, this function commits the
                                       default transaction of the default link. If the argument is a
                                       connection identifier, the default transaction of the
                                       corresponding connection will be committed. If the argument
                                       is a transaction identifier, the corresponding transaction
                                       will be committed. The transaction context will be retained,
                                       so statements executed from within this transaction will not
                                       be invalidated.

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


id: ibase_connect
type: function
doc:
<comment>Description:</comment>
  Abre uma conexão com um banco de dados
  
  Estabelece uma conexão com um banco de dados Firebird/InterBase.
  
  No caso de uma segunda chamada a <strong>ibase_connect()</strong> com os mesmos argumntos, não será criada uma nova
  conexão, mas ao invés, será retornado o identificador da conexão já aberta. A conexão com o
  servidor será fechada assim que terminar a execução do script, a menos que seja fechada
  explicitamente pela chamada de <strong>ibase_close()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$database</strong>  O argumento <strong>$database</strong> deve ser um caminho válido para o arquivo do banco de
                     dados no servidor no qual ele reside. Se o servidor não for local, ele deve ser
                     prefixado com 'hostname:' (TCP/IP), 'hostname/port:' (TCP/IP com servidor
                     interbase em porta TCP customizada), '//hostname/' (NetBEUI), dependendo do
                     protocolo de conexão usado.
  <info>string</info>  <strong>$username</strong>  O nome de usuário. Pode ser definido com a diretiva <return>ibase.default_user</return> do
                     php.ini
  <info>string</info>  <strong>$password</strong>  A senha para <strong>$username</strong>. Poe ser definida com a diretiva <return>ibase.default_password</return>
                     do php.ini.
  <info>string</info>  <strong>$charset</strong>   <strong>$charset</strong> é o conjunto de caracteres padrão para o banco de dados.
  <info>int</info>     <strong>$buffers</strong>   <strong>$buffers</strong> é o número de buffers do banco de dados a serem alocados para o cache
                     do lado do servidor. Se 0 ou omitido, o servidor escolhe o seu próprio padrão.
  <info>int</info>     <strong>$dialect</strong>   <strong>$dialect</strong> define o dialeto SQL padrão para qualquer comand executado na conexão,
                     e o padrão é o mais alto suportado pelas bibliotecas do cliente.
  <info>string</info>  <strong>$role</strong>      Funcional apenas com InterBase 5 e superior.
  <info>int</info>     <strong>$sync</strong>      

<comment>Return:</comment>
  <info>resource</info>  Retorna um identificador de conexão Firebird/InterBase em caso de sucesso, ou <info>false</info> em
            caso de erro.

<comment>See Also:</comment>
   * <strong>ibase_pconnect()</strong>
   * <strong>ibase_close()</strong>


id: ibase_db_info
type: function
doc:
<comment>Description:</comment>
  Request statistics about a database
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ibase_delete_user
type: function
doc:
<comment>Description:</comment>
  Exclui um usuário de um banco de dados seguro

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  O manipulador no serviço do servidor do banco de dados.
  <info>string</info>    <strong>$user_name</strong>       O login do usuário que deseja-se remover 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>ibase_add_user()</strong>
   * <strong>ibase_modify_user()</strong>


id: ibase_drop_db
type: function
doc:
<comment>Description:</comment>
  Drops a database
  
  This functions drops a database that was opened by either <strong>ibase_connect()</strong> or <strong>ibase_pconnect()</strong>. The
  database is closed and deleted from the server.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  An InterBase link identifier. If omitted, the last opened link is assumed.

<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>ibase_connect()</strong>
   * <strong>ibase_pconnect()</strong>


id: ibase_errcode
type: function
doc:
<comment>Description:</comment>
  Return an error code
  
  Returns the error code that resulted from the most recent InterBase function call.

<comment>Return:</comment>
  <info>int</info>  Returns the error code as an integer, or <info>false</info> if no error occurred.

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


id: ibase_errmsg
type: function
doc:
<comment>Description:</comment>
  Return error messages
  
  Returns the error message that resulted from the most recent InterBase function call.

<comment>Return:</comment>
  <info>string</info>  Returns the error message as a string, or <info>false</info> if no error occurred.

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


id: ibase_execute
type: function
doc:
<comment>Description:</comment>
  Executa uma consulta preparada anteriormente
  
  Executa uma consulta preparada por <strong>ibase_prepare()</strong>.
  
  Isto é muito mais efetivo do que usar <strong>ibase_query()</strong> se você estiver repetindo o mesmo tipo de
  consulta muitas vezes apenas mudando alguns parâmetros.

<comment>Param:</comment>
  <info>resource</info>  <strong>$query</strong>   Uma consulta do InterBase preparada por <strong>ibase_prepare()</strong>.
  <info>mixed</info>     <strong>$values</strong>  

<comment>Return:</comment>
  <info>resource</info>  Se houver um erro na consulta, retorna <info>false</info>. Se for bem sucedida e tiver um conjunto de
            resultados (possivelmente vazio, como em uma consulta SELECT), retorna um identificador
            de resultado. Se a consulta for bem sucedida e não houver resultados, retorna <info>true</info>.
            
            Esta função retorna o número de linhas afetadas pela consulta (se &gt; 0 e aplicável ao
            tipo de declaração). A consulta que tenha sido bem sucedida mas não afete nenhuma
            linha(ex.: um UPDATE de um registro que não exista) irá retornar <info>true</info>.

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


id: ibase_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Fetch a result row from a query as an associative array
  
  Fetch a result row from a query as an associative array.
  
  <strong>ibase_fetch_assoc()</strong> fetches one row of data from the <strong>$result</strong>.  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 either need to access the result with numeric indices by using
  <strong>ibase_fetch_row()</strong> or use alias names in your query.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>      The result handle.
  <info>int</info>       <strong>$fetch_flag</strong>  <strong>$fetch_flag</strong> is a combination of the constants <info>IBASE_TEXT</info> and <info>IBASE_UNIXTIME</info>
                         ORed together. Passing <info>IBASE_TEXT</info> will cause this function to return BLOB
                         contents instead of BLOB ids. Passing <info>IBASE_UNIXTIME</info> will cause this
                         function to return date/time values as Unix timestamps instead of as
                         formatted strings.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array that corresponds to the fetched row. Subsequent calls will
         return the next row in the result set, or <info>false</info> if there are no more rows.

<comment>See Also:</comment>
   * <strong>ibase_fetch_row()</strong>
   * <strong>ibase_fetch_object()</strong>


id: ibase_fetch_object
type: function
doc:
<comment>Description:</comment>
  Get an object from a InterBase database
  
  Fetches a row as a pseudo-object from a given result identifier.
  
  Subsequent calls to <strong>ibase_fetch_object()</strong> return the next row in the result set.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result_id</strong>   An InterBase result identifier obtained either by <strong>ibase_query()</strong> or
                         <strong>ibase_execute()</strong>.
  <info>int</info>       <strong>$fetch_flag</strong>  <strong>$fetch_flag</strong> is a combination of the constants <info>IBASE_TEXT</info> and <info>IBASE_UNIXTIME</info>
                         ORed together. Passing <info>IBASE_TEXT</info> will cause this function to return BLOB
                         contents instead of BLOB ids. Passing <info>IBASE_UNIXTIME</info> will cause this
                         function to return date/time values as Unix timestamps instead of as
                         formatted strings.

<comment>Return:</comment>
  <info>object</info>  Returns an object with the next row information, or <info>false</info> if there are no more rows.

<comment>See Also:</comment>
   * <strong>ibase_fetch_row()</strong>
   * <strong>ibase_fetch_assoc()</strong>


id: ibase_fetch_row
type: function
doc:
<comment>Description:</comment>
  Fetch a row from an InterBase database
  
  <strong>ibase_fetch_row()</strong> fetches one row of data from the given result set.
  
  Subsequent calls to <strong>ibase_fetch_row()</strong> return the next row in the result set, or <info>false</info> if there are
  no more rows.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result_identifier</strong>  An InterBase result identifier.
  <info>int</info>       <strong>$fetch_flag</strong>         <strong>$fetch_flag</strong> is a combination of the constants <info>IBASE_TEXT</info> and
                                <info>IBASE_UNIXTIME</info> ORed together. Passing <info>IBASE_TEXT</info> will cause this
                                function to return BLOB contents instead of BLOB ids. Passing
                                <info>IBASE_UNIXTIME</info> will cause this function to return date/time values
                                as Unix timestamps instead of as formatted strings.

<comment>Return:</comment>
  <info>array</info>  Returns an array that corresponds to the fetched row, or <info>false</info> if there are no more rows.
         Each result column is stored in an array offset, starting at offset 0.

<comment>See Also:</comment>
   * <strong>ibase_fetch_assoc()</strong>
   * <strong>ibase_fetch_object()</strong>


id: ibase_field_info
type: function
doc:
<comment>Description:</comment>
  Obtém informação sobre um campo
  
  Retorna uma matriz com informações sobre um campo após uma consulta SELECT ter sido executada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>        Um identificador de resultado do InterBase.
  <info>int</info>       <strong>$field_number</strong>  Índice do campo.

<comment>Return:</comment>
  <info>array</info>  Retorna um array com as seguintes chaves: <return>name</return>, <return>alias</return>, <return>relation</return>, <return>length</return> e <return>type</return>.

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


id: ibase_free_event_handler
type: function
doc:
<comment>Description:</comment>
  Cancela um manipulador de eventos registrado
  
  Esta função faz com que o manipulador de eventos registrado especificado por <strong>$event</strong> seja
  cancelado. A função de callback não será mais chamada para os eventos que estava registrada para
  manipular.

<comment>Param:</comment>
  <info>resource</info>  <strong>$event</strong>  Um resource de evento criado com <strong>ibase_set_event_handler()</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>ibase_set_event_handler()</strong>


id: ibase_free_query
type: function
doc:
<comment>Description:</comment>
  Libera a memória alocada para uma consulta preparada
  
  Libera uma query preparada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$query</strong>  Uma query preparada com <strong>ibase_prepare()</strong>.

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


id: ibase_free_result
type: function
doc:
<comment>Description:</comment>
  Libera um conjunto de resultados
  
  Libera um conjunto de resultado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result_identifier</strong>  Um conjunto de resultado criado pela <strong>ibase_query()</strong> ou
                                <strong>ibase_execute()</strong>.

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


id: ibase_gen_id
type: function
doc:
<comment>Description:</comment>
  Increments the named generator and returns its new value
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mixed</info>  Returns new generator value as integer, or as string if the value is too big.


id: ibase_maintain_db
type: function
doc:
<comment>Description:</comment>
  Execute a maintenance command on the database server
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: ibase_modify_user
type: function
doc:
<comment>Description:</comment>
  Modifica um usuário para um banco de dados seguro

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  O manipulador no serviço do servidor de banco de dados.
  <info>string</info>    <strong>$user_name</strong>       O login do usuário do banco de dados a modificar.
  <info>string</info>    <strong>$password</strong>        A nova senha do usuário.
  <info>string</info>    <strong>$first_name</strong>      O novo primeiro nome do usuário.
  <info>string</info>    <strong>$middle_name</strong>     O novo nome do meio do usuário.
  <info>string</info>    <strong>$last_name</strong>       O novo último nome do usuário.

<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>ibase_add_user()</strong>
   * <strong>ibase_delete_user()</strong>


id: ibase_name_result
type: function
doc:
<comment>Description:</comment>
  Define um nome para um conjunto de resultados
  
  Esta função define um nome para um conjunto de resultados. Este nome pode ser usado posteriormente
  em comandos UPDATE|DELETE ... WHERE CURRENT OF <strong>$name</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  Um conjunto de resultado do InterBase.
  <info>string</info>    <strong>$name</strong>    O nome a ser atribuído.

<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>ibase_prepare()</strong>
   * <strong>ibase_execute()</strong>


id: ibase_num_fields
type: function
doc:
<comment>Description:</comment>
  Obtém o número de campos em um conjunto de resultados
  
  Obtém o número de campos em um conjunto de resultados.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result_id</strong>  Um identificador de resultado InterBase.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de campos como um inteiro.

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


id: ibase_num_params
type: function
doc:
<comment>Description:</comment>
  Retorna o número de parâmetros em uma consulta preparada
  
  Esta função retorna o número de parâmetros em uma consulta preparada especificada <strong>$query</strong>. Este é o
  numero de argumentos que devem estar presentes quando usar a função <strong>ibase_execute()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$query</strong>  O manipulador da query preparada.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de parâmetros como um inteiro.

<comment>See Also:</comment>
   * <strong>ibase_prepare()</strong>
   * <strong>ibase_param_info()</strong>


id: ibase_param_info
type: function
doc:
<comment>Description:</comment>
  Retorna informação sobre um parâmetro em uma consulta preparada
  
  Retorna uma matriz com informações sobre um parâmetro após a consulta ter sido preparada.

<comment>Param:</comment>
  <info>resource</info>  <strong>$query</strong>         Um manipulador de query preparada do InterBase.
  <info>int</info>       <strong>$param_number</strong>  O índice do parâmetro.

<comment>Return:</comment>
  <info>array</info>  Retorna um array com as seguintes chaves: <return>name</return>, <return>alias</return>, <return>relation</return>, <return>length</return> and <return>type</return>.

<comment>See Also:</comment>
   * <strong>ibase_field_info()</strong>
   * <strong>ibase_num_params()</strong>


id: ibase_pconnect
type: function
doc:
<comment>Description:</comment>
  Open a persistent connection to an InterBase database
  
  Opens a persistent connection to an InterBase database.
  
  <strong>ibase_pconnect()</strong> acts very much like <strong>ibase_connect()</strong> with two major differences.
  
  First, when connecting, the function will first try to find a (persistent) link that's already
  opened with the same parameters. If one is found, an identifier for it will be returned instead of
  opening a new connection.
  
  Second, the connection to the InterBase server will not be closed when the execution of the script
  ends. Instead, the link will remain open for future use (<strong>ibase_close()</strong> will not close links
  established by <strong>ibase_pconnect()</strong>). This type of link is therefore called 'persistent'.

<comment>Param:</comment>
  <info>string</info>  <strong>$database</strong>  The <strong>$database</strong> argument has to be a valid path to database file on the server it
                     resides on. If the server is not local, it must be prefixed with either
                     'hostname:' (TCP/IP), '//hostname/' (NetBEUI) or 'hostname@' (IPX/SPX),
                     depending on the connection protocol used.
  <info>string</info>  <strong>$username</strong>  The user name. Can be set with the <return>ibase.default_user</return> php.ini directive.
  <info>string</info>  <strong>$password</strong>  The password for <strong>$username</strong>. Can be set with the <return>ibase.default_password</return> php.ini
                     directive.
  <info>string</info>  <strong>$charset</strong>   <strong>$charset</strong> is the default character set for a database.
  <info>int</info>     <strong>$buffers</strong>   <strong>$buffers</strong> is the number of database buffers to allocate for the server-side
                     cache. If 0 or omitted, server chooses its own default.
  <info>int</info>     <strong>$dialect</strong>   <strong>$dialect</strong> selects the default SQL dialect for any statement executed within a
                     connection, and it defaults to the highest one supported by client libraries.
                     Functional only with InterBase 6 and up.
  <info>string</info>  <strong>$role</strong>      Functional only with InterBase 5 and up.
  <info>int</info>     <strong>$sync</strong>      

<comment>Return:</comment>
  <info>resource</info>  Returns an InterBase link identifier on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ibase_close()</strong>
   * <strong>ibase_connect()</strong>


id: ibase_prepare
type: function
doc:
<comment>Description:</comment>
  Prepara uma consulta para ligação de parâmetros e execução posteriores
  
  Prepara uma consulta para ligação de parâmetros e execução posteriores (via <strong>ibase_execute()</strong>).

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>            Uma consulta InterBase.
  <info>resource</info>  <strong>$link_identifier</strong>  Um identificador de conexão InterBase retornado por <strong>ibase_connect()</strong>.
                              Se omitido, o identificador da última conexão aberta será utilizado.
  <info>string</info>    <strong>$trans</strong>            Um manipulador de transação InterBase com a qual a consulta deve ser
                              associada. Se omitido, a transação padrão da conexão será utilizada.

<comment>Return:</comment>
  <info>resource</info>  Retorna o manipulador da consulta preparada, ou <info>false</info> em caso de erro.


id: ibase_query
type: function
doc:
<comment>Description:</comment>
  Executa uma consulta em um banco de dados InterBase
  
  Executa uma consulta em um banco de dados InterBase.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_identifier</strong>  Um identificador de conexão InterBase. Se omitido, o da última conexão
                              será utilizado.
  <info>string</info>    <strong>$query</strong>            Uma consulta do InterBase.
  <info>int</info>       <strong>$bind_args</strong>        

<comment>Return:</comment>
  <info>resource</info>  Se houver um erro na consulta, retorna <info>false</info>. Se ela for bem sucedida e houver um
            conjunto de resultados (possivelmente vazio), como o retornado por uma consulta SELECT,
            retorna um identificador de resultado. Se a consulta for bem sucedida e não houver
            resultado, retorna <info>true</info>.
            
            No PHP 5.0.0 e posterior, esta função irá retornar o número de linhas afetadas pela
            consulta para INSERT, UPDATE e DELETE. Para manter a compatibilidade com versões
            anteriores, irá retornar <info>true</info> para estas consultas se ela for bem sucedida sem afetar
            nenhuma linha.

<comment>See Also:</comment>
   * <strong>ibase_errmsg()</strong>
   * <strong>ibase_fetch_row()</strong>
   * <strong>ibase_fetch_object()</strong>
   * <strong>ibase_free_result()</strong>


id: ibase_restore
type: function
doc:
<comment>Description:</comment>
  Initiates a restore task in the service manager and returns immediately
  
  This function passes the arguments to the (remote) database server. There it starts a new restore
  process. Therefore you won't get any responses.

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  A previously opened connection to the database server.
  <info>string</info>    <strong>$source_file</strong>     The absolute path on the server where the backup file is located.
  <info>string</info>    <strong>$dest_db</strong>         The path to create the new database on the server. You can also use
                             database alias.
  <info>int</info>       <strong>$options</strong>         Additional options to pass to the database server for restore. The
                             <strong>$options</strong> parameter can be a combination  of the following constants:
                             <info>IBASE_RES_DEACTIVATE_IDX</info>, <info>IBASE_RES_NO_SHADOW</info>,  <info>IBASE_RES_NO_VALIDITY</info>,
                             <info>IBASE_RES_ONE_AT_A_TIME</info>, <info>IBASE_RES_REPLACE</info>, <info>IBASE_RES_CREATE</info>,
                             <info>IBASE_RES_USE_ALL_SPACE</info>, <info>IBASE_PRP_PAGE_BUFFERS</info>,
                             <info>IBASE_PRP_SWEEP_INTERVAL</info>, <info>IBASE_RES_CREATE</info>. Read the section about  for
                             further information.
  <info>bool</info>      <strong>$verbose</strong>         Since the restore process is done on the database server, you don't
                             have any chance to get its output. This argument is useless.

<comment>Return:</comment>
  <info>mixed</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
         
         Since the restore process is done on the (remote) server, this function just passes the
         arguments to it. While the arguments are legal, you won't get <info>false</info>.

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


id: ibase_rollback
type: function
doc:
<comment>Description:</comment>
  Roll back a transaction
  
  Rolls back a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_or_trans_identifier</strong>  If called without an argument, this function rolls back the
                                       default transaction of the default link. If the argument is a
                                       connection identifier, the default transaction of the
                                       corresponding connection will be rolled back. If the argument
                                       is a transaction identifier, the corresponding transaction
                                       will be rolled back.

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


id: ibase_rollback_ret
type: function
doc:
<comment>Description:</comment>
  Roll back a transaction without closing it
  
  Rolls back a transaction without closing it.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link_or_trans_identifier</strong>  If called without an argument, this function rolls back the
                                       default transaction of the default link. If the argument is a
                                       connection identifier, the default transaction of the
                                       corresponding connection will be rolled back. If the argument
                                       is a transaction identifier, the corresponding transaction
                                       will be rolled back. The transaction context will be
                                       retained, so statements executed from within this transaction
                                       will not be invalidated.

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


id: ibase_server_info
type: function
doc:
<comment>Description:</comment>
  Request information about a database server

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  A previously created connection to the database server.
  <info>int</info>       <strong>$action</strong>          A valid constant.

<comment>Return:</comment>
  <info>string</info>  Returns mixed types depending on context.


id: ibase_service_attach
type: function
doc:
<comment>Description:</comment>
  Connect to the service manager

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>          The name or ip address of the database host. You can define the port by
                         adding  '/' and port number. If no port is specified, port 3050 will be
                         used.
  <info>string</info>  <strong>$dba_username</strong>  The name of any valid user.
  <info>string</info>  <strong>$dba_password</strong>  The user's password.

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

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


id: ibase_service_detach
type: function
doc:
<comment>Description:</comment>
  Disconnect from the service manager

<comment>Param:</comment>
  <info>resource</info>  <strong>$service_handle</strong>  A previously created connection to the database server.

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


id: ibase_set_event_handler
type: function
doc:
<comment>Description:</comment>
  Register a callback function to be called when events are posted
  
  This function registers a PHP user function as event handler for the specified events.

<comment>Param:</comment>
  <info>callable</info>  <strong>$event_handler</strong>  The callback is called with the event name and the link resource as
                            arguments whenever one of the specified events is posted by the
                            database.
                            
                            The callback must return <info>false</info> if the event handler should be canceled.
                            Any other return value is ignored. This function accepts up to 15 event
                            arguments.
  <info>string</info>    <strong>$event_name</strong>     An event name.
  <info>string</info>    <strong>$event_names</strong>    At most 15 events allowed.

<comment>Return:</comment>
  <info>resource</info>  The return value is an event resource. This resource can be used to free the event
            handler using <strong>ibase_free_event_handler()</strong>.

<comment>See Also:</comment>
   * <strong>ibase_free_event_handler()</strong>
   * <strong>ibase_wait_event()</strong>


id: ibase_trans
type: function
doc:
<comment>Description:</comment>
  Begin a transaction
  
  Begins a transaction.
  
  The first call to <strong>ibase_trans()</strong> will not return the default transaction of a connection. All
  transactions started by <strong>ibase_trans()</strong> will be rolled back at the end of the script if they were
  not committed or rolled back by either <strong>ibase_commit()</strong> or <strong>ibase_rollback()</strong>.
  
  This function will accept multiple <strong>$trans_args</strong> and <strong>$link_identifier</strong> arguments. This allows
  transactions over multiple database connections, which are committed using a 2-phase commit
  algorithm. This means you can rely on the updates to either succeed in every database, or fail in
  every database. It does NOT mean you can use tables from different databases in the same query!
  
  If you use transactions over multiple databases, you will have to specify both the <strong>$link_id</strong> and
  <strong>$transaction_id</strong> in calls to <strong>ibase_query()</strong> and <strong>ibase_prepare()</strong>.

<comment>Param:</comment>
  <info>int</info>       <strong>$trans_args</strong>       <strong>$trans_args</strong> can be a combination of <info>IBASE_READ</info>, <info>IBASE_WRITE</info>,
                              <info>IBASE_COMMITTED</info>,  <info>IBASE_CONSISTENCY</info>, <info>IBASE_CONCURRENCY</info>,
                              <info>IBASE_REC_VERSION</info>,  <info>IBASE_REC_NO_VERSION</info>, <info>IBASE_WAIT</info> and
                              <info>IBASE_NOWAIT</info>.
  <info>resource</info>  <strong>$link_identifier</strong>  An InterBase link identifier. If omitted, the last opened link is
                              assumed.

<comment>Return:</comment>
  <info>resource</info>  Returns a transaction handle, or <info>false</info> on error.


id: ibase_wait_event
type: function
doc:
<comment>Description:</comment>
  Espera por um evento ser postado pelo banco de dados
  
  Esta função suspende a execução do script até que um dos dos eventos especificados seja postado
  pelo banco de dados. O nome do evento que foi postado é retornado. Esta função aceita até 15
  argumentos de eventos.

<comment>Param:</comment>
  <info>string</info>  <strong>$event_name</strong>   O nome do evento.
  <info>string</info>  <strong>$event_names</strong>  

<comment>Return:</comment>
  <info>string</info>  Retorna o nome do evento que foi postado.

<comment>See Also:</comment>
   * <strong>ibase_set_event_handler()</strong>
   * <strong>ibase_free_event_handler()</strong>


id: iconv
type: function
doc:
<comment>Description:</comment>
  Converte uma string de uma codificação de caracteres para outra
  
  Converte <strong>$string</strong> de <strong>$from_encoding</strong> para <strong>$to_encoding</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$from_encoding</strong>  A codificação atual usada para interpretar <strong>$string</strong>.
  <info>string</info>  <strong>$to_encoding</strong>    A codificação desejada do resultado.
                          
                          Se a string <return>//TRANSLIT</return> for anexada a <strong>$to_encoding</strong>, a transliteração será
                          ativada. Isso significa que, quando um caractere não pode ser representado
                          no conjunto de caracteres de destino, ele pode ser aproximado por meio de
                          um ou vários caracteres de aparência semelhante. Se a string <return>//IGNORE</return> for
                          anexada, os caracteres que não podem ser representados no charset de
                          destino são descartados silenciosamente. Caso contrário, <info>E_NOTICE</info> é gerado
                          e a função retornará <info>false</info>.
                          
                          Como <return>//TRANSLIT</return> funciona exatamente depende da implementação do iconv() do
                          sistema (cf. <info>ICONV_IMPL</info>). Algumas implementações são conhecidas por
                          ignorar <return>//TRANSLIT</return>, então a conversão provavelmente falhará para
                          caracteres que são ilegais para <strong>$to_encoding</strong>.
  <info>string</info>  <strong>$string</strong>         A <info>string</info> a ser convertida

<comment>Return:</comment>
  <info>string|false</info>  Retorna a string convertida,  ou <info>false</info> em caso de falha.

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


id: iconv_get_encoding
type: function
doc:
<comment>Description:</comment>
  Recuperar variáveis de configuração internas da extensão iconv
  
  Recuperar variáveis de configuração internas da extensão iconv

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  O valor do parâmetro opcional <strong>$type</strong> pode ser:
                 allinput_encodingoutput_encodinginternal_encoding

<comment>Return:</comment>
  <info>array|string|false</info>  Retorna o valor atual da variável de configuração interna se bem sucedido ou
                      <info>false</info> em caso de falha.
                      
                      Se <strong>$type</strong> for omitido ou definido como "all", <strong>iconv_get_encoding()</strong> retorna um
                      array que armazena todas essas variáveis.

<comment>See Also:</comment>
   * <strong>iconv_set_encoding()</strong>
   * <strong>ob_iconv_handler()</strong>


id: iconv_mime_decode
type: function
doc:
<comment>Description:</comment>
  Decodifica um campo de cabeçalho MIME
  
  Decodifica um campo de cabeçalho <return>MIME</return>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    O cabeçalho codificado, como uma string.
  <info>int</info>          <strong>$mode</strong>      <strong>$mode</strong> determina o comportamento no caso de <strong>iconv_mime_decode()</strong> encontrar
                          um campo de cabeçalho <return>MIME</return> malformado. Você pode especificar qualquer
                          combinação das seguintes máscaras de bits. Máscaras de bits aceitáveis
                          para <strong>iconv_mime_decode()</strong>ValorConstanteDescrição1ICONV_MIME_DECODE_STRICT
                          Se definido, o cabeçalho fornecido é decodificado em total conformidade
                          com os padrões definidos em RFC2047. Esta opção está desativada por padrão
                          porque há muitos agentes de usuário de e-mail quebrados que não seguem a
                          especificação e não produzem cabeçalhos <return>MIME</return> corretos.
                          2ICONV_MIME_DECODE_CONTINUE_ON_ERROR Se definido,
                          <strong>iconv_mime_decode_headers()</strong> tenta ignorar quaisquer erros gramaticais e
                          continuar a processar um determinado cabeçalho.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro opcional <strong>$encoding</strong> especifica o conjunto de caracteres pelo
                          qual representar o resultado. Se omitido ou <info>null</info>, iconv.internal_encoding
                          será usado.

<comment>Return:</comment>
  <info>string|false</info>  Retorna um campo <return>MIME</return> decodificado em caso de sucesso ou <info>false</info> se ocorrer um erro
                durante a decodificação.

<comment>See Also:</comment>
   * <strong>iconv_mime_decode_headers()</strong>
   * <strong>mb_decode_mimeheader()</strong>
   * <strong>imap_mime_header_decode()</strong>
   * <strong>imap_base64()</strong>
   * <strong>imap_qprint()</strong>


id: iconv_mime_decode_headers
type: function
doc:
<comment>Description:</comment>
  Decodifica vários campos de cabeçalho MIME de uma só vez
  
  Decodifica vários campos de cabeçalho <return>MIME</return> de uma só vez.

<comment>Param:</comment>
  <info>string</info>       <strong>$headers</strong>   Os cabeçalhos codificados como uma string.
  <info>int</info>          <strong>$mode</strong>      <strong>$mode</strong> determina o comportamento no caso de <strong>iconv_mime_decode_headers()</strong>
                          encontrar um campo de cabeçalho <return>MIME</return> malformado. Você pode especificar
                          qualquer combinação das seguintes máscaras de bits. Máscaras de bits
                          aceitáveis para
                          <strong>iconv_mime_decode_headers()</strong>ValorConstanteDescrição1ICONV_MIME_DECODE_STRICT
                          Se definido, o cabeçalho fornecido é decodificado em total conformidade
                          com os padrões definidos em RFC2047. Esta opção está desativada por padrão
                          porque há muitos agentes de usuário de e-mail quebrados que não seguem a
                          especificação e não produzem cabeçalhos <return>MIME</return> corretos.
                          2ICONV_MIME_DECODE_CONTINUE_ON_ERROR Se definido,
                          <strong>iconv_mime_decode_headers()</strong> tenta ignorar quaisquer erros gramaticais e
                          continuar a processar um determinado cabeçalho.
  <info>string|null</info>  <strong>$encoding</strong>  O parâmetro opcional <strong>$encoding</strong> especifica o conjunto de caracteres pelo
                          qual representar o resultado. Se omitido ou <info>null</info>, iconv.internal_encoding
                          será usado.

<comment>Return:</comment>
  <info>array|false</info>  Retorna uma matriz associativa que contém todo um conjunto de campos de cabeçalho
               <return>MIME</return> especificados por <strong>$headers</strong> em caso de sucesso ou <info>false</info> se ocorrer um erro
               durante a decodificação.
               
               Cada chave do valor de retorno representa um nome de campo individual e o elemento
               correspondente representa um valor de campo. Se mais de um campo com o mesmo nome
               estiver presente, <strong>iconv_mime_decode_headers()</strong> os incorporará automaticamente em uma
               matriz indexada numericamente na ordem de ocorrência. Observe que os nomes de
               cabeçalhos não são case-insensitive.

<comment>See Also:</comment>
   * <strong>iconv_mime_decode()</strong>
   * <strong>mb_decode_mimeheader()</strong>
   * <strong>imap_mime_header_decode()</strong>
   * <strong>imap_base64()</strong>
   * <strong>imap_qprint()</strong>


id: iconv_mime_encode
type: function
doc:
<comment>Description:</comment>
  Compõe um campo de cabeçalho MIME
  
  Compõe e retorna uma string que representa um campo de cabeçalho <return>MIME</return> válido, semelhante ao
  seguinte:  No exemplo acima, "Subject" é o nome do campo e a parte que começa com
  "=?ISO-8859-1?..." é o valor do campo.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_name</strong>   O nome do campo.
  <info>string</info>  <strong>$field_value</strong>  O valor do campo.
  <info>array</info>   <strong>$options</strong>      Você pode controlar o comportamento de <strong>iconv_mime_encode()</strong> especificando uma
                        matriz associativa que contém itens de configuração para as <strong>$options</strong>
                        opcionais do terceiro parâmetro. Os itens suportados por <strong>iconv_mime_encode()</strong>
                        estão listados abaixo. Observe que os nomes dos itens são tratados com
                        distinção entre maiúsculas e minúsculas. Itens de configuração suportados
                        por <strong>iconv_mime_encode()</strong>ItemTipoDescriçãoValor padrãoExemploscheme<info>string</info>
                        Especifica o método para codificar um valor de campo. O valor deste item
                        pode ser "B" ou "Q", onde "B" significa esquema de codificação <return>base64</return> e "Q"
                        significa esquema de codificação <return>quoted-printable</return>. BBinput-charset<info>string</info>
                        Especifica o conjunto de caracteres no qual o primeiro parâmetro <strong>$field_name</strong>
                        e o segundo parâmetro <strong>$field_value</strong> são apresentados. Se não for fornecido,
                        <strong>iconv_mime_encode()</strong> assume que esses parâmetros são apresentados a ele na
                        configuração ini iconv.internal_encoding .
                        iconv.internal_encodingISO-8859-1output-charset<info>string</info> Especifica o conjunto
                        de caracteres a ser usado para compor o cabeçalho <return>MIME</return>.
                        iconv.internal_encodingUTF-8line-length<info>int</info> Especifica o comprimento máximo
                        das linhas de cabeçalho. O cabeçalho resultante é "dobrado" em um conjunto
                        de múltiplas linhas caso o campo do cabeçalho resultante seja maior que o
                        valor deste parâmetro, de acordo com RFC2822 - Internet Message Format. Se
                        não for fornecido, o comprimento será limitado a 76 caracteres.
                        76996line-break-chars<info>string</info> Especifica a sequência de caracteres a ser
                        anexada a cada linha como um sinal de fim de linha quando a "dobragem" é
                        executada em um campo de cabeçalho longo. Se não fornecido, o padrão é
                        "\r\n" (<return>CR</return> <return>LF</return>). Observe que esse parâmetro é sempre tratado como uma string
                        ASCII, independentemente do valor de <return>input-charset</return>. \r\n\n

<comment>Return:</comment>
  <info>string|false</info>  Retorna um campo <return>MIME</return> codificado em caso de sucesso ou <info>false</info> se ocorrer um erro
                durante a codificação.

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


id: iconv_set_encoding
type: function
doc:
<comment>Description:</comment>
  Define a configuração atual para conversão de codificação de caracteres
  
  Altera o valor da variável de configuração interna especificada por <strong>$type</strong> para <strong>$encoding</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>      O valor de <strong>$type</strong> pode ser qualquer um destes:
                     input_encodingoutput_encodinginternal_encoding
  <info>string</info>  <strong>$encoding</strong>  O conjunto de caracteres.

<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>iconv_get_encoding()</strong>
   * <strong>ob_iconv_handler()</strong>


id: iconv_strlen
type: function
doc:
<comment>Description:</comment>
  Retorna a contagem de caracteres da string
  
  Ao contrário de <strong>strlen()</strong>, <strong>iconv_strlen()</strong> conta as ocorrências de caracteres na <strong>$string</strong> de
  sequência de bytes fornecida com base no conjunto de caracteres especificado, cujo resultado não é
  necessariamente idêntico ao comprimento da string em bytes.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A string.
  <info>string|null</info>  <strong>$encoding</strong>  Se o parâmetro <strong>$encoding</strong> for omitido ou <info>null</info>, presume-se que a <strong>$string</strong>
                          esteja codificada em iconv.internal_encoding.

<comment>Return:</comment>
  <info>int|false</info>  Retorna a contagem de caracteres da <strong>$string</strong>, como um número inteiro, ou <info>false</info> se
             ocorrer um erro durante a codificação.

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


id: iconv_strpos
type: function
doc:
<comment>Description:</comment>
  Localiza a posição da primeira ocorrência de um caractere em uma string
  
  Localiza a posição da primeira ocorrência de um <strong>$needle</strong> em um <strong>$haystack</strong>.
  
  Em contraste com <strong>strpos()</strong>, o valor de retorno de <strong>iconv_strpos()</strong> é o número de caracteres que
  aparecem antes da agulha, em vez do deslocamento em bytes para a posição onde a agulha foi
  encontrada. Os caracteres são contados com base no <strong>$encoding</strong> do conjunto de caracteres
  especificado.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  A string inteira.
  <info>string</info>       <strong>$needle</strong>    A substring pesquisada.
  <info>int</info>          <strong>$offset</strong>    O parâmetro <strong>$offset</strong> opcional especifica a posição a partir da qual a
                          pesquisa deve ser realizada. Se o offset for negativo, ele será contado a
                          partir do final da string.
  <info>string|null</info>  <strong>$encoding</strong>  Se o parâmetro <strong>$encoding</strong> for omitido ou <info>null</info>, presume-se que a <strong>$string</strong>
                          esteja codificada em iconv.internal_encoding.

<comment>Return:</comment>
  <info>int|false</info>  Retorna a posição numérica da primeira ocorrência de <strong>$needle</strong> em <strong>$haystack</strong>.
             
             Se <strong>$needle</strong> não for encontrada, <strong>iconv_strpos()</strong> retornará <info>false</info>.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

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


id: iconv_strrpos
type: function
doc:
<comment>Description:</comment>
  Localiza a última ocorrência de um caractere em uma string
  
  Localiza a última ocorrência de <strong>$needle</strong> em <strong>$haystack</strong>.
  
  Em contraste com <strong>strrpos()</strong>, o valor de retorno de <strong>iconv_strrpos()</strong> é o número de caracteres que
  aparecem antes de needle, em vez do deslocamento em bytes para a posição onde needle foi
  encontrada. Os caracteres são contados com base no <strong>$encoding</strong> do conjunto de caracteres
  especificado.

<comment>Param:</comment>
  <info>string</info>       <strong>$haystack</strong>  The string inteira.
  <info>string</info>       <strong>$needle</strong>    A substring pesquisada.
  <info>string|null</info>  <strong>$encoding</strong>  Se o parâmetro <strong>$encoding</strong> for omitido ou <info>null</info>, presume-se que a <strong>$string</strong>
                          esteja codificada em iconv.internal_encoding.

<comment>Return:</comment>
  <info>int|false</info>  Retorna a posição numérica da última ocorrência de <strong>$needle</strong> em <strong>$haystack</strong>.
             
             Se <strong>$needle</strong> não for encontrada, <strong>iconv_strrpos()</strong> retornará <info>false</info>.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

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


id: iconv_substr
type: function
doc:
<comment>Description:</comment>
  Corta parte de uma string
  
  Corta uma parte da <strong>$string</strong> especificada pelos parâmetros <strong>$offset</strong> e <strong>$length</strong>.

<comment>Param:</comment>
  <info>string</info>       <strong>$string</strong>    A string original.
  <info>int</info>          <strong>$offset</strong>    Se <strong>$offset</strong> não for negativo, <strong>iconv_substr()</strong> corta a parte da <strong>$string</strong>
                          começando no <strong>$offset</strong>'th caractere, contando a partir de zero.
                          
                          Se <strong>$offset</strong> for negativo, <strong>iconv_substr()</strong> corta a parte que começa na
                          posição, desloca <strong>$offset</strong> caracteres para longe do final da <strong>$string</strong>.
  <info>int|null</info>     <strong>$length</strong>    Se <strong>$length</strong> for fornecido e for positivo, o valor de retorno conterá no
                          máximo caracteres de <strong>$length</strong> da parte que começa no <strong>$offset</strong> (dependendo do
                          comprimento da <strong>$string</strong>).
                          
                          Se <strong>$length</strong> for negativo, <strong>iconv_substr()</strong> cortará a parte da <strong>$string</strong> desde o
                          caractere <strong>$offset</strong>'th até o caractere do <strong>$length</strong> final da string. Caso
                          <strong>$offset</strong> também seja negativo, a posição inicial é calculada
                          antecipadamente de acordo com a regra explicada acima.
  <info>string|null</info>  <strong>$encoding</strong>  Se o parâmetro <strong>$encoding</strong> for omitido ou <info>null</info>, presume-se que a <strong>$string</strong>
                          esteja codificada em iconv.internal_encoding.
                          
                          Observe que os parâmetros <strong>$offset</strong> e <strong>$length</strong> são sempre considerados como
                          representando deslocamentos que são calculados com base no conjunto de
                          caracteres determinado por <strong>$encoding</strong>, enquanto a contraparte <strong>substr()</strong>
                          sempre os considera deslocamentos de byte.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a parte da <strong>$string</strong> especificada pelos parâmetros <strong>$offset</strong> e <strong>$length</strong>.
                
                Se <strong>$string</strong> for menor que os caracteres de <strong>$offset</strong>, <info>false</info> será retornado. Se <strong>$string</strong>
                tiver exatamente o comprimento de caracteres de <strong>$offset</strong>, uma string vazia será
                retornada.

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


id: idate
type: function
doc:
<comment>Description:</comment>
  Formata uma parte de uma hora/data local como um inteiro
  
  Retorna um número formatado de acordo com um formato informado utilizando o inteiro <strong>$timestamp</strong>, ou
  o horário local atual se nenhum timestamp foi informado. Em outras palavras, <strong>$timestamp</strong> é opcional
  e tem como padrão o valor da função <strong>time()</strong>.
  
  Ao contrário da função <strong>date()</strong>, a <strong>idate()</strong>, aceita apenas um caractere no parâmetro <strong>$format</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$format</strong>     Os caracteres a seguir são reconhecidos como válidos no parâmetro
                        <strong>$format</strong>Caractere <strong>$format</strong>Descrição<return>B</return>Swatch Beat/Horário da Internet<return>d</return>Dia do
                        mês<return>h</return>Hora (no formato de 12 horas)<return>H</return>Hora (no formato de 24 horas)<return>i</return>Minutos<return>I</return> (i
                        maiúsculo)retorna <return>1</return> se o horário de verão está ativo, <return>0</return>, caso contrário<return>L</return> (l
                        maiúsculo)retorna <return>1</return> para anos bissextos, <return>0</return>, caso contrário<return>m</return>Número do mês<return>N</return>Dia
                        da semana, baseado na ISO-8601 (<return>1</return> para segunda-feira até<return>7</return> para
                        domingo)<return>o</return>ISO-8601 year (4 digits)<return>s</return>Segundos<return>t</return>Dias do mês atual<return>U</return>Segundos desde
                        a época Unix - January 1 1970 00:00:00 UTC - isso é o mesmo que a função
                        <strong>time()</strong><return>w</return>Dia da semana (<return>0</return> para domingo)<return>W</return>Semana do ano, baseado na ISO-8601,
                        com a semana começando na segunda-feira<return>y</return>Ano (1 ou 2 dígitos - veja a nota
                        abaixo)<return>Y</return>Ano (4 dígitos)<return>z</return>Dia do ano<return>Z</return>Deslocamento do fuso horário em segundos
  <info>int|null</info>  <strong>$timestamp</strong>  O parâmetro opcional <strong>$timestamp</strong> é um
                        <info>int</info> de timestamp Unix cujo padrão é a hora local
                        atual se <strong>$timestamp</strong> não for informado ou for <info>null</info>. Em outras
                        palavras, o padrão é o valor de <strong>time()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Retorna um <info>int</info> em caso de sucesso,  ou <info>false</info> em caso de falha.
             
             Como a função <strong>idate()</strong> sempre retorna um <info>int</info> e como ela não começa com um "0", <strong>idate()</strong>
             pode retornar menos dígitos do que se espera. Veja o exemplo abaixo.

<comment>See Also:</comment>
   * DateTimeInterface::format
   * <strong>date()</strong>
   * <strong>getdate()</strong>
   * <strong>time()</strong>


id: idn_to_ascii
type: function
doc:
<comment>Description:</comment>
  Convert domain name to IDNA ASCII form
  
  Estilo procedural
  
  This function converts a Unicode domain name to an IDNA ASCII-compatible format.

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>     The domain to convert, which must be UTF-8 encoded.
  <info>int</info>     <strong>$flags</strong>      Conversion options - combination of IDNA_* constants (except IDNA_ERROR_*
                      constants).
  <info>int</info>     <strong>$variant</strong>    Either <info>INTL_IDNA_VARIANT_2003</info> (deprecated as of PHP 7.2.0) for IDNA 2003 or
                      <info>INTL_IDNA_VARIANT_UTS46</info> (only available as of ICU 4.6) for UTS #46.
  <info>array</info>   <strong>$idna_info</strong>  This parameter can be used only if <info>INTL_IDNA_VARIANT_UTS46</info> was used for
                      <strong>$variant</strong>. In that case, it will be filled with an array with the keys
                      <return>'result'</return>, the possibly illegal result of the transformation,
                      <return>'isTransitionalDifferent'</return>, a boolean indicating whether the usage of the
                      transitional mechanisms of UTS #46 either has or would have changed the result
                      and <return>'errors'</return>, which is an <info>int</info> representing a bitset of the error constants
                      IDNA_ERROR_*.

<comment>Return:</comment>
  <info>string|false</info>  The domain name encoded in ASCII-compatible form,  ou <info>false</info> em caso de falha

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


id: idn_to_utf8
type: function
doc:
<comment>Description:</comment>
  Convert domain name from IDNA ASCII to Unicode
  
  Estilo procedural
  
  This function converts a Unicode domain name from an IDNA ASCII-compatible format to plain
  Unicode, encoded in UTF-8.

<comment>Param:</comment>
  <info>string</info>  <strong>$domain</strong>     Domain to convert in an IDNA ASCII-compatible format.
  <info>int</info>     <strong>$flags</strong>      Conversion options - combination of IDNA_* constants (except IDNA_ERROR_*
                      constants).
  <info>int</info>     <strong>$variant</strong>    Either <info>INTL_IDNA_VARIANT_2003</info> (deprecated as of PHP 7.2.0) for IDNA 2003 or
                      <info>INTL_IDNA_VARIANT_UTS46</info> (only available as of ICU 4.6) for UTS #46.
  <info>array</info>   <strong>$idna_info</strong>  This parameter can be used only if <info>INTL_IDNA_VARIANT_UTS46</info> was used for
                      <strong>$variant</strong>. In that case, it will be filled with an array with the keys
                      <return>'result'</return>, the possibly illegal result of the transformation,
                      <return>'isTransitionalDifferent'</return>, a boolean indicating whether the usage of the
                      transitional mechanisms of UTS #46 either has or would have changed the result
                      and <return>'errors'</return>, which is an <info>int</info> representing a bitset of the error constants
                      IDNA_ERROR_*.

<comment>Return:</comment>
  <info>string|false</info>  The domain name in Unicode, encoded in UTF-8,  ou <info>false</info> em caso de falha

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


id: igbinary_serialize
type: function
doc:
<comment>Description:</comment>
  Generates a compact, storable binary representation of a value
  
  Generates a storable representation of a value.
  
  This is useful for storing or passing PHP values around without losing their type and structure.
  
  To make the serialized string into a PHP value again, <strong>igbinary_unserialize()</strong> can be used.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to be serialized. <strong>igbinary_serialize()</strong> handles all types, except the
                 <info>resource</info>-type and some <info>object</info>s (see note below). Even <info>array</info>s that contain
                 references to itself can be processed by <strong>igbinary_serialize()</strong>. Circular references
                 inside the <info>array</info> or <info>object</info> that is being serializend will also be stored. Any other
                 reference will be lost.
                 
                 When serializing objects, igbinary will attempt to call the member functions
                 __serialize() or __sleep() prior to serialization. This is to allow the object to
                 do any last minute clean-up, etc. prior to being serialized. Likewise, when the
                 object is restored using <strong>igbinary_unserialize()</strong> the __unserialize() or __wakeup()
                 member function is called.
                 
                 Private members of <info>object</info>s have the class name prepended to the member name;
                 protected members have a <return>'*'</return> prepended to the member name. These prepended values
                 have null bytes on either side.

<comment>Return:</comment>
  <info>string|false</info>  Returns a string containing a byte-stream representation of <strong>$value</strong> that can be
                stored anywhere.
                
                Note that this is a binary string which can include any byte value, and needs to be
                stored and handled as such. For example, <strong>igbinary_serialize()</strong> output should
                generally be stored in a <return>BLOB</return> field in a database, rather than a <return>CHAR</return> or <return>TEXT</return> field.

<comment>See Also:</comment>
   * <strong>serialize()</strong>
   * <strong>igbinary_unserialize()</strong>
   * <strong>var_export()</strong>
   * <strong>json_encode()</strong>
   * Serializing Objects
   * __sleep()
   * __wakeup()
   * __serialize()
   * __unserialize()


id: igbinary_unserialize
type: function
doc:
<comment>Description:</comment>
  Creates a PHP value from a stored representation from igbinary_serialize
    
  
  <strong>igbinary_unserialize()</strong> takes a single serialized variable from <strong>igbinary_serialize()</strong> and converts
  it back into a PHP value.
  
  Untrusted user input must not be passed to <strong>igbinary_unserialize()</strong>. Unserialization can result in
  code being loaded and executed due to object instantiation and autoloading, and a malicious user
  may be able to exploit this. Instead a safe, standard data interchange format such as JSON (via
  <strong>json_decode()</strong> and <strong>json_encode()</strong>) should be used, if serialized data needs to be passed to a
  client.
  
  If there is the need to unserialize externally-stored serialized data, <strong>hash_hmac()</strong> can be used for
  data validation. It is important to ensure that nobody has tampered with the data.
  
  The igbinary serialization format does not provide a way to distinguish between different
  reference groups for the same value. All PHP references to a given value as treated as part of the
  same reference group when unserialized, even if they were parts of difference reference groups
  when serialized.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The serialized string generated by <strong>igbinary_serialize()</strong>.
                
                If the value being unserialized is an <info>object</info>, after successfully reconstructing the
                object igbinary will automatically attempt to call the __unserialize() or __wakeup()
                methods (if one exists).
                
                unserialize_callback_func directive It is possible to set a callback function which
                will be called, if an undefined class should be instantiated during unserializing.
                (to prevent getting an incomplete <info>object</info> <return>__PHP_Incomplete_Class</return>.) The php.ini,
                <strong>ini_set()</strong> or .htaccess can be used to define unserialize_callback_func. Everytime an
                undefined class should be instantiated, it will be called. To disable this feature
                this setting should be emptied.
                
                It is possible to set a callback function which will be called, if an undefined
                class should be instantiated during unserializing. (to prevent getting an incomplete
                <info>object</info> <return>__PHP_Incomplete_Class</return>.) The php.ini, <strong>ini_set()</strong> or .htaccess can be used to
                define unserialize_callback_func. Everytime an undefined class should be
                instantiated, it will be called. To disable this feature this setting should be
                emptied.

<comment>Return:</comment>
  <info>mixed</info>  The converted value is returned, and can be a <info>bool</info>, <info>int</info>, <info>float</info>, <info>string</info>, <info>array</info>, <info>object</info>, or
         <info>null</info>.
         
         In case the passed string is not unserializeable, <info>false</info> is returned and <info>E_NOTICE</info> or
         <info>E_WARNING</info> is issued.

<comment>See Also:</comment>
   * <strong>unserialize()</strong>
   * <strong>json_encode()</strong>
   * <strong>json_decode()</strong>
   * <strong>hash_hmac()</strong>
   * <strong>igbinary_serialize()</strong>
   * Autoloading Classes
   * unserialize_callback_func
   * __wakeup()
   * __serialize()
   * __unserialize()


id: ignore_user_abort
type: function
doc:
<comment>Description:</comment>
  Define se uma desconexão de cliente deve abortar execução de script
  
  Define se a desconexão do cliente deve abortar a execução do script.
  
  Ao executar o PHP como um script de linha de comando, e o terminal do script for fechado antes do
  script ser terminado, o script irá morrer na próxima vez que tentar escreve algo, a menos que o
  parâmetro <strong>$enable</strong> seja definido para <info>true</info>

<comment>Param:</comment>
  <info>bool|null</info>  <strong>$enable</strong>  Se definido e não <info>null</info>, esta função definirá a configuração ini
                      ignore_user_abort para o valor definido em <strong>$enable</strong>. Caso contrário, esta
                      função irá somente retornar a configuração anterior sem alterá-la.

<comment>Return:</comment>
  <info>int</info>  Retorna a configuração anterior, como um inteiro.

<comment>See Also:</comment>
   * <strong>connection_aborted()</strong>
   * <strong>connection_status()</strong>
   * Manipulação de Conexões
     para uma descrição completa de manipulação de conexões no PHP.
    


id: image2wbmp
type: function
doc:
<comment>Description:</comment>
  Envia a imagem para o navegador ou para um arquivo
  
  <strong>image2wbmp()</strong> outputs or save a WBMP version of the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$image</strong>       An image resource, returned by one of the image creation functions, such as
                         <strong>imagecreatetruecolor()</strong>.
  <info>string</info>    <strong>$filename</strong>    Path to the saved file. If not given, the raw image stream will be output
                         directly.
  <info>int</info>       <strong>$foreground</strong>  You can set the foreground color with this parameter by setting an
                         identifier obtained from <strong>imagecolorallocate()</strong>. The default foreground color
                         is black.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Entretanto, se a biblioteca libgd falhar ao gerar a imagem, esta função retornará <info>true</info>.

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


id: image_type_to_extension
type: function
doc:
<comment>Description:</comment>
  Get file extension for image type
  
  Returns the extension for the given <return>IMAGETYPE_XXX</return> constant.

<comment>Param:</comment>
  <info>int</info>   <strong>$image_type</strong>   One of the <return>IMAGETYPE_XXX</return> constant.
  <info>bool</info>  <strong>$include_dot</strong>  Whether to prepend a dot to the extension or not. Default to <info>true</info>.

<comment>Return:</comment>
  <info>string|false</info>  A string with the extension corresponding to the given image type,  ou <info>false</info> em caso
                de falha.


id: image_type_to_mime_type
type: function
doc:
<comment>Description:</comment>
  Get Mime-Type for image-type returned by getimagesize,
     exif_read_data, exif_thumbnail, exif_imagetype
  
  The <strong>image_type_to_mime_type()</strong> function will determine the Mime-Type for an IMAGETYPE constant.

<comment>Param:</comment>
  <info>int</info>  <strong>$image_type</strong>  One of the <return>IMAGETYPE_XXX</return> constants.

<comment>Return:</comment>
  <info>string</info>  The returned values are as follows Returned values Constants<strong>$image_type</strong>Returned
          value<info>IMAGETYPE_GIF</info><return>image/gif</return><info>IMAGETYPE_JPEG</info><return>image/jpeg</return><info>IMAGETYPE_PNG</info><return>image/png</return><info>IMAGETYPE_SWF</info><return>application/x-shockwave-flash</return><info>IMAGETYPE_PSD</info><return>image/psd</return><info>IMAGETYPE_BMP</info><return>image/bmp</return><info>IMAGETYPE_TIFF_II</info>
          (intel byte order)<return>image/tiff</return><info>IMAGETYPE_TIFF_MM</info> (motorola byte order)
          <return>image/tiff</return><info>IMAGETYPE_JPC</info><return>application/octet-stream</return><info>IMAGETYPE_JP2</info><return>image/jp2</return><info>IMAGETYPE_JPX</info><return>application/octet-stream</return><info>IMAGETYPE_JB2</info><return>application/octet-stream</return><info>IMAGETYPE_SWC</info><return>application/x-shockwave-flash</return><info>IMAGETYPE_IFF</info><return>image/iff</return><info>IMAGETYPE_WBMP</info><return>image/vnd.wap.wbmp</return><info>IMAGETYPE_XBM</info><return>image/xbm</return><info>IMAGETYPE_ICO</info><return>image/vnd.microsoft.icon</return><info>IMAGETYPE_WEBP</info><return>image/webp</return><info>IMAGETYPE_AVIF</info><return>image/avif</return>

<comment>See Also:</comment>
   * <strong>getimagesize()</strong>
   * <strong>exif_imagetype()</strong>
   * <strong>exif_read_data()</strong>
   * <strong>exif_thumbnail()</strong>


id: imageaffine
type: function
doc:
<comment>Description:</comment>
  Return an image containing the affine transformed src image, using an optional clipping area
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>   Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                       como <strong>imagecreatetruecolor()</strong>.
  <info>array</info>       <strong>$affine</strong>  Array with keys 0 to 5.
  <info>array|null</info>  <strong>$clip</strong>    Array with keys "x", "y", "width" and "height"; or <info>null</info>.

<comment>Return:</comment>
  <info>GdImage|false</info>  Return affined image object on success ou <info>false</info> em caso de falha.


id: imageaffinematrixconcat
type: function
doc:
<comment>Description:</comment>
  Concatenate two affine transformation matrices
  
  Returns the concatenation of two affine transformation matrices, what is useful if multiple
  transformations should be applied to the same image in one go.

<comment>Param:</comment>
  <info>array</info>  <strong>$matrix1</strong>  An affine transformation matrix (an array with keys <return>0</return> to <return>5</return> and float values).
  <info>array</info>  <strong>$matrix2</strong>  An affine transformation matrix (an array with keys <return>0</return> to <return>5</return> and float values).

<comment>Return:</comment>
  <info>array|false</info>  An affine transformation matrix (an array with keys <return>0</return> to <return>5</return> and float values) ou <info>false</info>
               em caso de falha.

<comment>See Also:</comment>
   * <strong>imageaffine()</strong>
   * <strong>imageaffinematrixget()</strong>


id: imageaffinematrixget
type: function
doc:
<comment>Description:</comment>
  Get an affine transformation matrix
  
  Returns an affine transformation matrix.

<comment>Param:</comment>
  <info>int</info>          <strong>$type</strong>     One of the <info>IMG_AFFINE_*</info> constants.
  <info>array|float</info>  <strong>$options</strong>  If <strong>$type</strong> is <info>IMG_AFFINE_TRANSLATE</info> or <info>IMG_AFFINE_SCALE</info>, <strong>$options</strong> has to be an
                         <info>array</info> with keys <return>x</return> and <return>y</return>, both having <info>float</info> values.
                         
                         If <strong>$type</strong> is <info>IMG_AFFINE_ROTATE</info>, <info>IMG_AFFINE_SHEAR_HORIZONTAL</info> or
                         <info>IMG_AFFINE_SHEAR_VERTICAL</info>, <strong>$options</strong> has to be a <info>float</info> specifying the angle.

<comment>Return:</comment>
  <info>array|false</info>  An affine transformation matrix (an array with keys <return>0</return> to <return>5</return> and float values) ou <info>false</info>
               em caso de falha.

<comment>See Also:</comment>
   * <strong>imageaffine()</strong>
   * <strong>imageaffinematrixconcat()</strong>


id: imagealphablending
type: function
doc:
<comment>Description:</comment>
  Set the blending mode for an image
  
  <strong>imagealphablending()</strong> allows for two different modes of drawing on truecolor images. In blending
  mode, the alpha channel component of the color supplied to all drawing function, such as
  <strong>imagesetpixel()</strong> determines how much of the underlying color should be allowed to shine through.
  As a result, gd automatically blends the existing color at that point with the drawing color, and
  stores the result in the image.  The resulting pixel is opaque.  In non-blending mode, the drawing
  color is copied literally with its alpha channel information, replacing the destination pixel.
  Blending mode is not available when drawing on palette images.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                    como <strong>imagecreatetruecolor()</strong>.
  <info>bool</info>     <strong>$enable</strong>  Whether to enable the blending mode or not. On true color images  the default
                    value is <info>true</info> otherwise the default value is <info>false</info>

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


id: imageantialias
type: function
doc:
<comment>Description:</comment>
  Should antialias functions be used or not
  
  Activate the fast drawing antialiased methods for lines and wired polygons. It does not support
  alpha components. It works using a direct blend operation. It works only with truecolor images.
  
  Thickness and styled are not supported.
  
  Using antialiased primitives with transparent background color can end with some unexpected
  results. The blend method uses the background color as any other colors. The lack of alpha
  component support does not allow an alpha based antialiasing method.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>   Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                    como <strong>imagecreatetruecolor()</strong>.
  <info>bool</info>     <strong>$enable</strong>  Whether to enable antialiasing or not.

<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>imagecreatetruecolor()</strong>


id: imagearc
type: function
doc:
<comment>Description:</comment>
  Draws an arc
  
  <strong>imagearc()</strong> draws an arc of circle centered at the given coordinates.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>        Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                         como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$center_x</strong>     x-coordinate of the center.
  <info>int</info>      <strong>$center_y</strong>     y-coordinate of the center.
  <info>int</info>      <strong>$width</strong>        The arc width.
  <info>int</info>      <strong>$height</strong>       The arc height.
  <info>int</info>      <strong>$start_angle</strong>  The arc start angle, in degrees.
  <info>int</info>      <strong>$end_angle</strong>    The arc end angle, in degrees. 0° is located at the three-o'clock position,
                         and the arc is drawn clockwise.
  <info>int</info>      <strong>$color</strong>        Um identificador de cor criado com <strong>imagecolorallocate()</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>imagefilledarc()</strong>
   * <strong>imageellipse()</strong>
   * <strong>imagefilledellipse()</strong>


id: imageavif
type: function
doc:
<comment>Description:</comment>
  Envia a imagem para o navegador ou para um arquivo
  
  Outputs or saves a AVIF Raster image from the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>    Um objeto <class>GdImage</class>, retornado por uma das funções de criação de
                                  imagem,
                                  como <strong>imagecreatetruecolor()</strong>.
  <info>resource|string|null</info>  <strong>$file</strong>     O caminho ou um recurso de stream aberto (que será fechado
                                  automaticamente após o retorno desta função) para salvar o
                                  arquivo. Se não for definido ou for <info>null</info>, o stream da imagem bruta
                                  será enviado diretamente.
  <info>int</info>                   <strong>$quality</strong>  <strong>$quality</strong> is optional, and ranges from 0 (worst quality, smaller
                                  file) to 100 (best quality, larger file). If <return>-1</return> is provided, the
                                  default value <return>30</return> is used.
  <info>int</info>                   <strong>$speed</strong>    <strong>$speed</strong> is optional, and ranges from 0 (slow, smaller file) to 10
                                  (fast, larger file). If <return>-1</return> is provided, the default value <return>6</return> is
                                  used.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Entretanto, se a biblioteca libgd falhar ao gerar a imagem, esta função retornará <info>true</info>.

<comment>See Also:</comment>
   * <strong>imagepng()</strong>
   * <strong>imagewbmp()</strong>
   * <strong>imagejpeg()</strong>
   * <strong>imagetypes()</strong>


id: imagebmp
type: function
doc:
<comment>Description:</comment>
  Output a BMP image to browser or file
  
  Outputs or saves a BMP version of the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>               <strong>$image</strong>       Um objeto <class>GdImage</class>, retornado por uma das funções de criação de
                                     imagem,
                                     como <strong>imagecreatetruecolor()</strong>.
  <info>resource|string|null</info>  <strong>$file</strong>        O caminho ou um recurso de stream aberto (que será fechado
                                     automaticamente após o retorno desta função) para salvar o
                                     arquivo. Se não for definido ou for <info>null</info>, o stream da imagem
                                     bruta será enviado diretamente.
                                     
                                     <info>null</info> is invalid if the <strong>$compressed</strong> arguments is not used.
  <info>bool</info>                  <strong>$compressed</strong>  Whether the BMP should be compressed with run-length encoding
                                     (RLE), or not.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.
        
        Entretanto, se a biblioteca libgd falhar ao gerar a imagem, esta função retornará <info>true</info>.


id: imagechar
type: function
doc:
<comment>Description:</comment>
  Draw a character horizontally
  
  <strong>imagechar()</strong> draws the first character of <strong>$char</strong> in the image identified by <strong>$image</strong> with its
  upper-left at <strong>$x</strong>,<strong>$y</strong> (top left is 0, 0) with the color <strong>$color</strong>.

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                      como <strong>imagecreatetruecolor()</strong>.
  <info>GdFont|int</info>  <strong>$font</strong>   Pode ser 1, 2, 3, 4, 5 para as fontes
                      nativas na codificação latin2 (onde números maiores correspondem a fontes
                      maiores) ou uma instância de <class>GdFont</class>,
                      retornada por <strong>imageloadfont()</strong>.
  <info>int</info>         <strong>$x</strong>      x-coordinate of the start.
  <info>int</info>         <strong>$y</strong>      y-coordinate of the start.
  <info>string</info>      <strong>$char</strong>   The character to draw.
  <info>int</info>         <strong>$color</strong>  Um identificador de cor criado com <strong>imagecolorallocate()</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>imagecharup()</strong>
   * <strong>imageloadfont()</strong>


id: imagecharup
type: function
doc:
<comment>Description:</comment>
  Draw a character vertically
  
  Draws the character <strong>$char</strong> vertically at the specified coordinate on the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>     <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                      como <strong>imagecreatetruecolor()</strong>.
  <info>GdFont|int</info>  <strong>$font</strong>   Pode ser 1, 2, 3, 4, 5 para as fontes
                      nativas na codificação latin2 (onde números maiores correspondem a fontes
                      maiores) ou uma instância de <class>GdFont</class>,
                      retornada por <strong>imageloadfont()</strong>.
  <info>int</info>         <strong>$x</strong>      x-coordinate of the start.
  <info>int</info>         <strong>$y</strong>      y-coordinate of the start.
  <info>string</info>      <strong>$char</strong>   The character to draw.
  <info>int</info>         <strong>$color</strong>  Um identificador de cor criado com <strong>imagecolorallocate()</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>imagechar()</strong>
   * <strong>imageloadfont()</strong>


id: imagecolorallocate
type: function
doc:
<comment>Description:</comment>
  Allocate a color for an image
  
  Returns a color identifier representing the color composed of the given RGB components.
  
  <strong>imagecolorallocate()</strong> must be called to create each color that is to be used in the image
  represented by <strong>$image</strong>.
  
  The first call to <strong>imagecolorallocate()</strong> fills the background color in palette-based images - images
  created using <strong>imagecreate()</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.

<comment>Return:</comment>
  <info>int|false</info>  A color identifier or <info>false</info> if the allocation failed.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

<comment>See Also:</comment>
   * <strong>imagecolorallocatealpha()</strong>
   * <strong>imagecolordeallocate()</strong>


id: imagecolorallocatealpha
type: function
doc:
<comment>Description:</comment>
  Allocate a color for an image
  
  <strong>imagecolorallocatealpha()</strong> behaves identically to <strong>imagecolorallocate()</strong> with the addition of the
  transparency parameter <strong>$alpha</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.
  <info>int</info>      <strong>$alpha</strong>  A value between <return>0</return> and <return>127</return>. <return>0</return> indicates completely opaque while  <return>127</return> indicates
                   completely transparent.

<comment>Return:</comment>
  <info>int|false</info>  A color identifier or <info>false</info> if the allocation failed.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

<comment>See Also:</comment>
   * <strong>imagecolorallocate()</strong>
   * <strong>imagecolordeallocate()</strong>


id: imagecolorat
type: function
doc:
<comment>Description:</comment>
  Get the index of the color of a pixel
  
  Returns the index of the color of the pixel at the specified location in the image specified by
  <strong>$image</strong>.
  
  If the image is a truecolor image, this function returns the RGB value of that pixel as integer.
  Use bitshifting and masking to access the distinct red, green and blue component values:

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$x</strong>      x-coordinate of the point.
  <info>int</info>      <strong>$y</strong>      y-coordinate of the point.

<comment>Return:</comment>
  <info>int|false</info>  Returns the index of the color  ou <info>false</info> em caso de falha.
             
             Esta função pode
             retornar o valor booleano <info>false</info>, mas também pode retornar um valor não booleano que
             pode ser
             avaliado como <info>false</info>. Leia a seção sobre Booleanos para mais
             informações. Use o operador
             === para testar o valor retornado por esta
             função.

<comment>See Also:</comment>
   * <strong>imagecolorset()</strong>
   * <strong>imagecolorsforindex()</strong>
   * <strong>imagesetpixel()</strong>


id: imagecolorclosest
type: function
doc:
<comment>Description:</comment>
  Get the index of the closest color to the specified color
  
  Returns the index of the color in the palette of the image which is "closest" to the specified RGB
  value.
  
  The "distance" between the desired color and each color in the palette is calculated as if the RGB
  values represented points in three-dimensional space.
  
  Se a imagem foi criada a partir de um arquivo, apenas as cores usadas na imagem são resolvidas. As
  cores presentes apenas na paleta não serão resolvidas.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the closest color, in the palette of the image, to the specified one

<comment>See Also:</comment>
   * <strong>imagecolorexact()</strong>
   * <strong>imagecolorclosestalpha()</strong>
   * <strong>imagecolorclosesthwb()</strong>


id: imagecolorclosestalpha
type: function
doc:
<comment>Description:</comment>
  Get the index of the closest color to the specified color + alpha
  
  Returns the index of the color in the palette of the image which is "closest" to the specified RGB
  value and  <strong>$alpha</strong> level.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.
  <info>int</info>      <strong>$alpha</strong>  A value between <return>0</return> and <return>127</return>. <return>0</return> indicates completely opaque while  <return>127</return> indicates
                   completely transparent.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the closest color in the palette.

<comment>See Also:</comment>
   * <strong>imagecolorexactalpha()</strong>
   * <strong>imagecolorclosest()</strong>
   * <strong>imagecolorclosesthwb()</strong>


id: imagecolorclosesthwb
type: function
doc:
<comment>Description:</comment>
  Get the index of the color which has the hue, white and blackness
  
  Get the index of the color which has the hue,  white and blackness nearest the given color.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.

<comment>Return:</comment>
  <info>int</info>  Returns an integer with the index of the color which has  the hue, white and blackness
       nearest the given color.

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


id: imagecolordeallocate
type: function
doc:
<comment>Description:</comment>
  De-allocate a color for an image
  
  De-allocates a color previously allocated with  <strong>imagecolorallocate()</strong> or <strong>imagecolorallocatealpha()</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$color</strong>  The color identifier.

<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>imagecolorallocate()</strong>
   * <strong>imagecolorallocatealpha()</strong>


id: imagecolorexact
type: function
doc:
<comment>Description:</comment>
  Get the index of the specified color
  
  Returns the index of the specified color in the palette of the image.
  
  Se a imagem foi criada a partir de um arquivo, apenas as cores usadas na imagem são resolvidas. As
  cores presentes apenas na paleta não serão resolvidas.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the specified color in the palette, or -1 if the color does not exist.

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


id: imagecolorexactalpha
type: function
doc:
<comment>Description:</comment>
  Get the index of the specified color + alpha
  
  Returns the index of the specified color+alpha in the palette of the image.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.
  <info>int</info>      <strong>$alpha</strong>  A value between <return>0</return> and <return>127</return>. <return>0</return> indicates completely opaque while  <return>127</return> indicates
                   completely transparent.

<comment>Return:</comment>
  <info>int</info>  Returns the index of the specified color+alpha in the palette of the image, or -1 if the
       color does not exist in the image's palette.

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


id: imagecolormatch
type: function
doc:
<comment>Description:</comment>
  Makes the colors of the palette version of an image more closely match the true color version
  
  Makes the colors of the palette version of an image more closely match the true color version.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image1</strong>  A truecolor image object.
  <info>GdImage</info>  <strong>$image2</strong>  A palette image object pointing to an image that has the same size as <strong>$image1</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>imagecreatetruecolor()</strong>


id: imagecolorresolve
type: function
doc:
<comment>Description:</comment>
  Get the index of the specified color or its closest possible alternative
  
  This function is guaranteed to return a color index for a requested color, either the exact color
  or the closest possible alternative.
  
  Se a imagem foi criada a partir de um arquivo, apenas as cores usadas na imagem são resolvidas. As
  cores presentes apenas na paleta não serão resolvidas.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.

<comment>Return:</comment>
  <info>int</info>  Returns a color index.

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


id: imagecolorresolvealpha
type: function
doc:
<comment>Description:</comment>
  Get the index of the specified color + alpha or its closest possible alternative
  
  This function is guaranteed to return a color index for a requested color, either the exact color
  or the closest possible alternative.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.
  <info>int</info>      <strong>$alpha</strong>  A value between <return>0</return> and <return>127</return>. <return>0</return> indicates completely opaque while  <return>127</return> indicates
                   completely transparent.

<comment>Return:</comment>
  <info>int</info>  Returns a color index.

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


id: imagecolorset
type: function
doc:
<comment>Description:</comment>
  Set the color for the specified palette index
  
  This sets the specified index in the palette to the specified color. This is useful for creating
  flood-fill-like effects in palleted images without the overhead of performing the actual
  flood-fill.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$color</strong>  An index in the palette.
  <info>int</info>      <strong>$red</strong>    Valor do componente vermelho.
  <info>int</info>      <strong>$green</strong>  Valor do componente verde.
  <info>int</info>      <strong>$blue</strong>   Valor do componente azul.
  <info>int</info>      <strong>$alpha</strong>  Value of alpha component.

<comment>Return:</comment>
  <info>false|null</info>  The function returns <info>null</info> on success,  ou <info>false</info> em caso de falha.

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


id: imagecolorsforindex
type: function
doc:
<comment>Description:</comment>
  Get the colors for an index
  
  Gets the color for a specified index.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$color</strong>  The color index.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with red, green, blue and alpha keys that contain the
         appropriate values for the specified color index.

<comment>See Also:</comment>
   * <strong>imagecolorat()</strong>
   * <strong>imagecolorexact()</strong>


id: imagecolorstotal
type: function
doc:
<comment>Description:</comment>
  Find out the number of colors in an image's palette
  
  Returns the number of colors in an image palette.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the number of colors in the specified image's palette or 0 for truecolor images.

<comment>See Also:</comment>
   * <strong>imagecolorat()</strong>
   * <strong>imagecolorsforindex()</strong>
   * <strong>imageistruecolor()</strong>


id: imagecolortransparent
type: function
doc:
<comment>Description:</comment>
  Define a color as transparent
  
  Gets or sets the transparent color in the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>   <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                    como <strong>imagecreatetruecolor()</strong>.
  <info>int|null</info>  <strong>$color</strong>  Um identificador de cor criado com <strong>imagecolorallocate()</strong>.

<comment>Return:</comment>
  <info>int</info>  The identifier of the new (or current, if none is specified) transparent color is returned.
       If <strong>$color</strong> is <info>null</info>, and the image has no transparent color, the returned identifier will be
       <return>-1</return>.


id: imageconvolution
type: function
doc:
<comment>Description:</comment>
  Apply a 3x3 convolution matrix, using coefficient and offset
  
  Applies a convolution matrix on the image, using the given coefficient and offset.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>    Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                     como <strong>imagecreatetruecolor()</strong>.
  <info>array</info>    <strong>$matrix</strong>   A 3x3 matrix: an array of three arrays of three floats.
  <info>float</info>    <strong>$divisor</strong>  The divisor of the result of the convolution, used for normalization.
  <info>float</info>    <strong>$offset</strong>   Color offset.

<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>imagefilter()</strong>


id: imagecopy
type: function
doc:
<comment>Description:</comment>
  Copiar uma parte de uma imagem
  
  Copiar uma parte de <strong>$src_image</strong> para <strong>$dst_image</strong>, começando nas coordenadas x, y <strong>$src_x</strong>, <strong>$src_y </strong> com
  uma largura de <strong>$src_width</strong> e uma altura de <strong>$src_height</strong>. A porção definida será copiada para as
  coordenadas x, y, <strong>$dst_x</strong> e <strong>$dst_y</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst_image</strong>   Recurso da imagem de destino.
  <info>GdImage</info>  <strong>$src_image</strong>   Recurso da imagem de origem.
  <info>int</info>      <strong>$dst_x</strong>       Coordenada x do ponto de destino.
  <info>int</info>      <strong>$dst_y</strong>       Coordenada y do ponto de destino.
  <info>int</info>      <strong>$src_x</strong>       Coordenada x do ponto de origem.
  <info>int</info>      <strong>$src_y</strong>       Coordenada y do ponto de origem.
  <info>int</info>      <strong>$src_width</strong>   Largura da imagem de origem.
  <info>int</info>      <strong>$src_height</strong>  Altura da imagem de origem.

<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>imagecrop()</strong>


id: imagecopymerge
type: function
doc:
<comment>Description:</comment>
  Copy and merge part of an image
  
  Copy a part of <strong>$src_image</strong> onto <strong>$dst_image</strong> starting at the x,y coordinates <strong>$src_x</strong>, <strong>$src_y </strong> with a
  width of <strong>$src_width</strong> and a height of <strong>$src_height</strong>.  The portion defined will be copied onto the x,y
  coordinates, <strong>$dst_x</strong> and <strong>$dst_y</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst_image</strong>   Recurso da imagem de destino.
  <info>GdImage</info>  <strong>$src_image</strong>   Recurso da imagem de origem.
  <info>int</info>      <strong>$dst_x</strong>       x-coordinate of destination point.
  <info>int</info>      <strong>$dst_y</strong>       y-coordinate of destination point.
  <info>int</info>      <strong>$src_x</strong>       x-coordinate of source point.
  <info>int</info>      <strong>$src_y</strong>       y-coordinate of source point.
  <info>int</info>      <strong>$src_width</strong>   Largura da imagem de origem.
  <info>int</info>      <strong>$src_height</strong>  Altura da imagem de origem.
  <info>int</info>      <strong>$pct</strong>         The two images will be merged according to <strong>$pct</strong> which can range from 0 to
                        100.  When <strong>$pct</strong> = 0, no action is taken, when 100 this function behaves
                        identically to <strong>imagecopy()</strong> for pallete images, except for ignoring alpha
                        components, while it implements alpha transparency for true colour images.

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


id: imagecopymergegray
type: function
doc:
<comment>Description:</comment>
  Copy and merge part of an image with gray scale
  
  <strong>imagecopymergegray()</strong> copy a part of <strong>$src_image</strong> onto <strong>$dst_image</strong> starting at the x,y coordinates
  <strong>$src_x</strong>, <strong>$src_y </strong> with a width of <strong>$src_width</strong> and a height of <strong>$src_height</strong>.  The portion defined will
  be copied onto the x,y coordinates, <strong>$dst_x</strong> and <strong>$dst_y</strong>.
  
  This function is identical to <strong>imagecopymerge()</strong> except that when merging it preserves the hue of
  the source by converting the destination pixels to gray scale before the copy operation.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst_image</strong>   Recurso da imagem de destino.
  <info>GdImage</info>  <strong>$src_image</strong>   Recurso da imagem de origem.
  <info>int</info>      <strong>$dst_x</strong>       x-coordinate of destination point.
  <info>int</info>      <strong>$dst_y</strong>       y-coordinate of destination point.
  <info>int</info>      <strong>$src_x</strong>       x-coordinate of source point.
  <info>int</info>      <strong>$src_y</strong>       y-coordinate of source point.
  <info>int</info>      <strong>$src_width</strong>   Largura da imagem de origem.
  <info>int</info>      <strong>$src_height</strong>  Altura da imagem de origem.
  <info>int</info>      <strong>$pct</strong>         The <strong>$src_image</strong> will be changed to grayscale according  to <strong>$pct</strong> where 0 is
                        fully grayscale and 100 is  unchanged. When <strong>$pct</strong> = 100 this function behaves
                        identically to <strong>imagecopy()</strong> for pallete images, except for ignoring alpha
                        components, while it implements alpha transparency for true colour images.

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


id: imagecopyresampled
type: function
doc:
<comment>Description:</comment>
  Copy and resize part of an image with resampling
  
  <strong>imagecopyresampled()</strong> copies a rectangular portion of one image to another image, smoothly
  interpolating pixel values so that, in particular, reducing the size of an image still retains a
  great deal of clarity.
  
  In other words, <strong>imagecopyresampled()</strong> will take a  rectangular area from <strong>$src_image</strong> of width
  <strong>$src_width</strong> and height <strong>$src_height</strong> at  position (<strong>$src_x</strong>,<strong>$src_y</strong>)  and place it in a rectangular area
  of <strong>$dst_image</strong>  of width <strong>$dst_width</strong> and height <strong>$dst_height</strong> at position (<strong>$dst_x</strong>,<strong>$dst_y</strong>).
  
  If the source and destination coordinates and width and heights differ, appropriate stretching or
  shrinking of the image fragment will be performed. The coordinates refer to the upper left corner.
  This function can be used to copy regions within the same image (if <strong>$dst_image</strong> is the same as
  <strong>$src_image</strong>) but if the regions overlap the results will be unpredictable.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst_image</strong>   Recurso da imagem de destino.
  <info>GdImage</info>  <strong>$src_image</strong>   Recurso da imagem de origem.
  <info>int</info>      <strong>$dst_x</strong>       x-coordinate of destination point.
  <info>int</info>      <strong>$dst_y</strong>       y-coordinate of destination point.
  <info>int</info>      <strong>$src_x</strong>       x-coordinate of source point.
  <info>int</info>      <strong>$src_y</strong>       y-coordinate of source point.
  <info>int</info>      <strong>$dst_width</strong>   Destination width.
  <info>int</info>      <strong>$dst_height</strong>  Destination height.
  <info>int</info>      <strong>$src_width</strong>   Largura da imagem de origem.
  <info>int</info>      <strong>$src_height</strong>  Altura da imagem de origem.

<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>imagecopyresized()</strong>
   * <strong>imagescale()</strong>
   * <strong>imagecrop()</strong>


id: imagecopyresized
type: function
doc:
<comment>Description:</comment>
  Copy and resize part of an image
  
  <strong>imagecopyresized()</strong> copies a rectangular portion of one image to another image. <strong>$dst_image</strong> is the
  destination image, <strong>$src_image</strong> is the source image identifier.
  
  In other words, <strong>imagecopyresized()</strong> will take a  rectangular area from <strong>$src_image</strong> of width
  <strong>$src_width</strong> and height <strong>$src_height</strong> at  position (<strong>$src_x</strong>,<strong>$src_y</strong>)  and place it in a rectangular area
  of <strong>$dst_image</strong>  of width <strong>$dst_width</strong> and height <strong>$dst_height</strong> at position (<strong>$dst_x</strong>,<strong>$dst_y</strong>).
  
  If the source and destination coordinates and width and heights differ, appropriate stretching or
  shrinking of the image fragment will be performed. The coordinates refer to the upper left corner.
  This function can be used to copy regions within the same image (if <strong>$dst_image</strong> is the same as
  <strong>$src_image</strong>) but if the regions overlap the results will be unpredictable.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$dst_image</strong>   Recurso da imagem de destino.
  <info>GdImage</info>  <strong>$src_image</strong>   Recurso da imagem de origem.
  <info>int</info>      <strong>$dst_x</strong>       x-coordinate of destination point.
  <info>int</info>      <strong>$dst_y</strong>       y-coordinate of destination point.
  <info>int</info>      <strong>$src_x</strong>       x-coordinate of source point.
  <info>int</info>      <strong>$src_y</strong>       y-coordinate of source point.
  <info>int</info>      <strong>$dst_width</strong>   Destination width.
  <info>int</info>      <strong>$dst_height</strong>  Destination height.
  <info>int</info>      <strong>$src_width</strong>   Largura da imagem de origem.
  <info>int</info>      <strong>$src_height</strong>  Altura da imagem de origem.

<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>imagecopyresampled()</strong>
   * <strong>imagescale()</strong>
   * <strong>imagecrop()</strong>


id: imagecreate
type: function
doc:
<comment>Description:</comment>
  Crie uma nova imagem baseada em paleta
  
  <strong>imagecreate()</strong> retorna um identificador de imagem que representa uma imagem em branco do tamanho
  especificado.
  
  Em geral, recomendamos o uso de <strong>imagecreatetruecolor()</strong> em vez de <strong>imagecreate()</strong> para que o
  processamento da imagem ocorra na mais alta qualidade possível. Se você deseja gerar uma imagem
  paletizada, então <strong>imagetruecolortopalette()</strong> deve ser chamada imediatamente antes de salvar a
  imagem com <strong>imagepng()</strong> ou <strong>imagegif()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   A largura da imagem.
  <info>int</info>  <strong>$height</strong>  A altura da imagem.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.

<comment>See Also:</comment>
   * <strong>imagedestroy()</strong>
   * <strong>imagecreatetruecolor()</strong>


id: imagecreatefromavif
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromavif()</strong> returns an image object representing the image obtained from the given
  filename.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the AVIF raster image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefrombmp
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefrombmp()</strong> returns an image identifier representing the image obtained from the given
  filename.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the BMP image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromgd
type: function
doc:
<comment>Description:</comment>
  Criar uma nova imagem a partir de um arquivo GD ou URL
  
  Criar uma nova imagem a partir de um arquivo GD ou URL.
  
  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.

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

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromgd2
type: function
doc:
<comment>Description:</comment>
  Create a new image from GD2 file or URL
  
  Create a new image from GD2 file or URL.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the GD2 image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromgd2part
type: function
doc:
<comment>Description:</comment>
  Create a new image from a given part of GD2 file or URL
  
  Create a new image from a given part of GD2 file or URL.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the GD2 image.
  <info>int</info>     <strong>$x</strong>         x-coordinate of source point.
  <info>int</info>     <strong>$y</strong>         y-coordinate of source point.
  <info>int</info>     <strong>$width</strong>     Largura da imagem de origem.
  <info>int</info>     <strong>$height</strong>    Altura da imagem de origem.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromgif
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromgif()</strong> returns an image identifier representing the image obtained from the given
  filename.
  
  When reading GIF files into memory, only the first frame  is returned in the image object. The
  size of the image is not necessarily what is reported by <strong>getimagesize()</strong>.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the GIF image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromjpeg
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromjpeg()</strong> retorna um identificador de imagem que representa a imagem obtida a partir
  do nome de arquivo fornecido.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho para a imagem JPEG.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefrompng
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefrompng()</strong> retorna um identificador de imagem que representa a imagem obtida a partir do
  nome de arquivo fornecido.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho para a imagem PNG

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromstring
type: function
doc:
<comment>Description:</comment>
  Create a new image from the image stream in the string
  
  <strong>imagecreatefromstring()</strong> returns an image identifier representing the image obtained from the given
  <strong>$data</strong>. These types will be automatically detected if your build of PHP supports  them: JPEG, PNG,
  GIF, BMP, WBMP, GD2, and WEBP.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  A string containing the image data.

<comment>Return:</comment>
  <info>GdImage|false</info>  An image object will be returned on success. <info>false</info> is returned if the image type is
                 unsupported, the data is not in a recognised format, or the image is corrupt and
                 cannot be loaded.

<comment>See Also:</comment>
   * <strong>imagecreatefromjpeg()</strong>
   * <strong>imagecreatefrompng()</strong>
   * <strong>imagecreatefromgif()</strong>
   * <strong>imagecreatetruecolor()</strong>


id: imagecreatefromtga
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromtga()</strong> returns an image object representing the image obtained from the given
  filename.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the Truevision TGA image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromwbmp
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromwbmp()</strong> returns an image identifier representing the image obtained from the given
  filename.
  
  WBMP images are Wireless Bitmaps, not Windows Bitmaps. The latter can be loaded with
  <strong>imagecreatefrombmp()</strong>.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the WBMP image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromwebp
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromwebp()</strong> returns an image identifier representing the image obtained from the given
  filename. Note that animated WebP files cannot be read.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the WebP image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromxbm
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromxbm()</strong> returns an image identifier representing the image obtained from the given
  filename.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the XBM image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatefromxpm
type: function
doc:
<comment>Description:</comment>
  Cria uma nova imagem a partir de um arquivo ou URL
  
  <strong>imagecreatefromxpm()</strong> returns an image identifier representing the image obtained from the given
  filename.
  
  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.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the XPM image.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.


id: imagecreatetruecolor
type: function
doc:
<comment>Description:</comment>
  Create a new true color image
  
  <strong>imagecreatetruecolor()</strong> returns an image object representing a black image of the specified size.

<comment>Param:</comment>
  <info>int</info>  <strong>$width</strong>   Image width.
  <info>int</info>  <strong>$height</strong>  Image height.

<comment>Return:</comment>
  <info>GdImage|false</info>  Retorna um objeto de imagem em caso de sucesso, <info>false</info> em caso de erros.

<comment>See Also:</comment>
   * <strong>imagedestroy()</strong>
   * <strong>imagecreate()</strong>


id: imagecrop
type: function
doc:
<comment>Description:</comment>
  Crop an image to the given rectangle
  
  Crops an image to the given rectangular area and returns the resulting image. The given <strong>$image</strong> is
  not modified.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>      Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                       como <strong>imagecreatetruecolor()</strong>.
  <info>array</info>    <strong>$rectangle</strong>  The cropping rectangle as <info>array</info> with keys <return>x</return>, <return>y</return>, <return>width</return> and <return>height</return>.

<comment>Return:</comment>
  <info>GdImage|false</info>  Return cropped image object on success ou <info>false</info> em caso de falha.

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


id: imagecropauto
type: function
doc:
<comment>Description:</comment>
  Crop an image automatically using one of the available modes
  
  Automatically crops an image according to the given <strong>$mode</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>      Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                       como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$mode</strong>       One of the following constants:
                       
                       Same as <info>IMG_CROP_TRANSPARENT</info>. Before PHP 7.4.0, the bundled libgd fell back
                       to <info>IMG_CROP_SIDES</info>, if the image had no transparent color.
                       
                       Crops out a transparent background.
                       
                       Crops out a black background.
                       
                       Crops out a white background.
                       
                       Uses the 4 corners of the image to attempt to detect the background to crop.
                       
                       Crops an image using the given <strong>$threshold</strong> and <strong>$color</strong>.
  <info>float</info>    <strong>$threshold</strong>  Crops an image using the given <strong>$threshold</strong> and <strong>$color</strong>.
  <info>float</info>    <strong>$threshold</strong>  Specifies the tolerance in percent to be used while comparing the image color
                       and the color to crop. The method used to calculate the color difference is
                       based on the color distance in the RGB(a) cube.
                       
                       Used only in <info>IMG_CROP_THRESHOLD</info> mode.
                       
                       Before PHP 7.4.0, the bundled libgd used a somewhat different algorithm, so
                       the same <strong>$threshold</strong> yielded different results for system and bundled libgd.
  <info>int</info>      <strong>$color</strong>      Either an RGB color value or a palette index.
                       
                       Used only in <info>IMG_CROP_THRESHOLD</info> mode.

<comment>Return:</comment>
  <info>GdImage|false</info>  Returns a cropped image object on success ou <info>false</info> em caso de falha. If the
                 complete image was cropped, <strong>imagecrop()</strong> returns <info>false</info>.

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


id: imagedashedline
type: function
doc:
<comment>Description:</comment>
  Draw a dashed line
  
  This function is deprecated. Use combination of <strong>imagesetstyle()</strong> and <strong>imageline()</strong> instead.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$x1</strong>     Upper left x coordinate.
  <info>int</info>      <strong>$y1</strong>     Upper left y coordinate 0, 0 is the top left corner of the image.
  <info>int</info>      <strong>$x2</strong>     Bottom right x coordinate.
  <info>int</info>      <strong>$y2</strong>     Bottom right y coordinate.
  <info>int</info>      <strong>$color</strong>  The fill color. Um identificador de cor criado com <strong>imagecolorallocate()</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>imagesetstyle()</strong>
   * <strong>imageline()</strong>


id: imagedestroy
type: function
doc:
<comment>Description:</comment>
  Destruir uma imagem
  
  Esta função não tem efeito. Antes do PHP 8.0.0, esta função era usada para fechar o recurso.
  
  Antes do PHP 8.0.0, a função <strong>imagedestroy()</strong> liberava qualquer memória associada à imagem <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.

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


id: imageellipse
type: function
doc:
<comment>Description:</comment>
  Draw an ellipse
  
  Draws an ellipse centered at the specified coordinates.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>     Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                      como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$center_x</strong>  x-coordinate of the center.
  <info>int</info>      <strong>$center_y</strong>  y-coordinate of the center.
  <info>int</info>      <strong>$width</strong>     The ellipse width.
  <info>int</info>      <strong>$height</strong>    The ellipse height.
  <info>int</info>      <strong>$color</strong>     The color of the ellipse. Um identificador de cor criado com
                      <strong>imagecolorallocate()</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>imagefilledellipse()</strong>
   * <strong>imagearc()</strong>


id: imagefill
type: function
doc:
<comment>Description:</comment>
  Flood fill
  
  Performs a flood fill starting at the given coordinate (top left is 0, 0) with the given <strong>$color</strong> in
  the <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$x</strong>      x-coordinate of start point.
  <info>int</info>      <strong>$y</strong>      y-coordinate of start point.
  <info>int</info>      <strong>$color</strong>  The fill color. Um identificador de cor criado com <strong>imagecolorallocate()</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>imagecolorallocate()</strong>


id: imagefilledarc
type: function
doc:
<comment>Description:</comment>
  Draw a partial arc and fill it
  
  Draws a partial arc centered at the specified coordinate in the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>        Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                         como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$center_x</strong>     x-coordinate of the center.
  <info>int</info>      <strong>$center_y</strong>     y-coordinate of the center.
  <info>int</info>      <strong>$width</strong>        The arc width.
  <info>int</info>      <strong>$height</strong>       The arc height.
  <info>int</info>      <strong>$start_angle</strong>  The arc start angle, in degrees.
  <info>int</info>      <strong>$end_angle</strong>    The arc end angle, in degrees. 0° is located at the three-o'clock position,
                         and the arc is drawn clockwise.
  <info>int</info>      <strong>$color</strong>        Um identificador de cor criado com <strong>imagecolorallocate()</strong>.
  <info>int</info>      <strong>$style</strong>        A bitwise OR of the following possibilities:
                         <info>IMG_ARC_PIE</info><info>IMG_ARC_CHORD</info><info>IMG_ARC_NOFILL</info><info>IMG_ARC_EDGED</info> <info>IMG_ARC_PIE</info> and
                         <info>IMG_ARC_CHORD</info> are mutually exclusive; <info>IMG_ARC_CHORD</info> just connects the
                         starting and ending angles with a straight line, while <info>IMG_ARC_PIE</info> produces
                         a rounded edge. <info>IMG_ARC_NOFILL</info> indicates that the arc or chord should be
                         outlined, not filled.  <info>IMG_ARC_EDGED</info>, used together with <info>IMG_ARC_NOFILL</info>,
                         indicates that the beginning and ending angles should be connected to the
                         center - this is a good way to outline (rather than fill) a 'pie slice'.
                         
                         <info>IMG_ARC_PIE</info>
                         
                         <info>IMG_ARC_CHORD</info>
                         
                         <info>IMG_ARC_NOFILL</info>
                         
                         <info>IMG_ARC_EDGED</info>

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


id: imagefilledellipse
type: function
doc:
<comment>Description:</comment>
  Draw a filled ellipse
  
  Draws an ellipse centered at the specified coordinate on the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>     Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                      como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$center_x</strong>  x-coordinate of the center.
  <info>int</info>      <strong>$center_y</strong>  y-coordinate of the center.
  <info>int</info>      <strong>$width</strong>     The ellipse width.
  <info>int</info>      <strong>$height</strong>    The ellipse height.
  <info>int</info>      <strong>$color</strong>     The fill color. Um identificador de cor criado com <strong>imagecolorallocate()</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>imageellipse()</strong>
   * <strong>imagefilledarc()</strong>


id: imagefilledpolygon
type: function
doc:
<comment>Description:</comment>
  Draw a filled polygon
  
  Signature as of PHP 8.0.0 (not supported with named arguments)
  
  Alternative signature (deprecated as of PHP 8.1.0)
  
  <strong>imagefilledpolygon()</strong> creates a filled polygon in the given <strong>$image</strong>.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>       Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                        como <strong>imagecreatetruecolor()</strong>.
  <info>array</info>    <strong>$points</strong>      An array containing the <return>x</return> and <return>y</return> coordinates of the polygons vertices
                        consecutively.
  <info>int</info>      <strong>$num_points</strong>  Total number of points (vertices), which must be at least 3.
                        
                        If this parameter is omitted as per the second signature, <strong>$points</strong> must have
                        an even number of elements, and <strong>$num_points</strong> is assumed to be
                        count($points)/2.
  <info>int</info>      <strong>$color</strong>       Um identificador de cor criado com <strong>imagecolorallocate()</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>imagepolygon()</strong>


id: imagefilledrectangle
type: function
doc:
<comment>Description:</comment>
  Draw a filled rectangle
  
  Creates a rectangle filled with <strong>$color</strong> in the given <strong>$image</strong> starting at point 1 and ending at point
  2. 0, 0 is the top left corner of the image.

<comment>Param:</comment>
  <info>GdImage</info>  <strong>$image</strong>  Um objeto <class>GdImage</class>, retornado por uma das funções de criação de imagem,
                   como <strong>imagecreatetruecolor()</strong>.
  <info>int</info>      <strong>$x1</strong>     x-coordinate for point 1.
  <info>int</info>      <strong>$y1</strong>     y-coordinate for point 1.
  <info>int</info>      <strong>$x2</strong>     x-coordinate for point 2.
  <info>int</info>      <strong>$y2</strong>     y-coordinate for point 2.
  <info>int</info>      <strong>$color</strong>  The fill color. Um identificador de cor criado com <strong>imagecolorallocate()</strong>.

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


