# php_manual

id: eio_npending
type: function
doc:
<comment>Description:</comment>
  Returns number of finished, but unhandled requests
  
  <strong>eio_npending()</strong> returns number of finished, but unhandled requests

<comment>Return:</comment>
  <info>int</info>  <strong>eio_npending()</strong> returns number of finished, but unhandled requests.

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nready
type: function
doc:
<comment>Description:</comment>
  Returns number of not-yet handled requests

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nready()</strong> returns number of not-yet handled requests

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nreqs
type: function
doc:
<comment>Description:</comment>
  Returns number of requests to be processed
  
  <strong>eio_nreqs()</strong> could be called in a custom loop calling <strong>eio_poll()</strong>.

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nreqs()</strong> returns number of requests to be processed.

<comment>See Also:</comment>
   * <strong>eio_poll()</strong>
   * <strong>eio_nready()</strong>


id: eio_nthreads
type: function
doc:
<comment>Description:</comment>
  Returns number of threads currently in use

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nthreads()</strong> returns number of threads currently in use.

<comment>See Also:</comment>
   * <strong>eio_npending()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_open
type: function
doc:
<comment>Description:</comment>
  Opens a file
  
  <strong>eio_open()</strong> opens file specified by <strong>$path</strong> in access mode <strong>$mode</strong> with

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Path of the file to be opened.  In some SAPIs(e.g. PHP-FPM) it could fail, if
                       you don't specify full path.
                       
                       In some SAPIs(e.g. PHP-FPM) it could fail, if you don't specify full path.
  <info>int</info>       <strong>$flags</strong>     One of EIO_O_* constants, or their combinations. EIO_O_* constants have the
                       same meaning, as their corresponding O_* counterparts defined in <return>fnctl.h</return> C
                       header file. Default is <info>EIO_O_RDWR</info>.
  <info>int</info>       <strong>$mode</strong>      One of EIO_S_I* constants, or their combination (via bitwise OR operator).
                       The constants have the same meaning as their S_I* counterparts defined in
                       sys/stat.h C header file. Required, if a file is created. Otherwise ignored.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_open()</strong> returns file descriptor in <strong>$result</strong> argument of <strong>$callback</strong> on success;
            otherwise, <strong>$result</strong> is equal to <info>-1</info>.

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


id: eio_poll
type: function
doc:
<comment>Description:</comment>
  Can be to be called whenever there are pending requests that need finishing
  
  <strong>eio_poll()</strong> can be used to implement special event loop. For this <strong>eio_nreqs()</strong> could be used to test
  if there are unprocessed requests.
  
  Applicable only when implementing userspace event loop.

<comment>Return:</comment>
  <info>int</info>  If any request invocation returns a non-zero value, returns that value. Otherwise, it returns
       <info>0</info>.

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


id: eio_read
type: function
doc:
<comment>Description:</comment>
  Read from a file descriptor at given offset
  
  <strong>eio_read()</strong> reads up to <strong>$length</strong> bytes from <strong>$fd</strong> file descriptor at <strong>$offset</strong>. The read bytes are
  stored in <strong>$result</strong> argument of <strong>$callback</strong>.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Stream, Socket resource, or numeric file descriptor
  <info>int</info>       <strong>$length</strong>    Maximum number of bytes to read.
  <info>int</info>       <strong>$offset</strong>    Offset within the file.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_read()</strong> stores read bytes in <strong>$result</strong> argument of <strong>$callback</strong> function.

<comment>See Also:</comment>
   * <strong>eio_open()</strong>
   * <strong>eio_write()</strong>
   * <strong>eio_close()</strong>
   * <strong>eio_event_loop()</strong>


id: eio_readahead
type: function
doc:
<comment>Description:</comment>
  Perform file readahead into page cache
  
  <strong>eio_readahead()</strong> populates the page cache with data from a file so that subsequent reads from that
  file will not block on disk I/O. See <return>READAHEAD(2)</return> man page for details.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Stream, Socket resource, or numeric file descriptor
  <info>int</info>       <strong>$offset</strong>    Starting point from which data is to be read.
  <info>int</info>       <strong>$length</strong>    Number of bytes to be read.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readahead()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_readdir
type: function
doc:
<comment>Description:</comment>
  Reads through a whole directory
  
  Reads through a whole directory(via the <return>opendir</return>, <return>readdir</return> and <return>closedir</return> system calls) and returns
  either the names or an array in <strong>$result</strong> argument of <strong>$callback</strong> function, depending on the <strong>$flags</strong>
  argument.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Directory path.
  <info>int</info>       <strong>$flags</strong>     Combination of EIO_READDIR_* constants.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readdir()</strong> returns request resource on success, ou <info>false</info> em caso de falha.  Sets
            <strong>$result</strong> argument of <strong>$callback</strong> function according to <strong>$flags</strong>:
            
            <info>EIO_READDIR_DENTS</info> (<info>int</info>) <strong>eio_readdir()</strong> flag. If specified, the result argument of the
            callback becomes an array with the following keys: <return>'names'</return> - array of directory names
            <return>'dents'</return> - array of <return>struct eio_dirent</return>-like arrays having the following keys each: <return>'name'</return>
            - the directory name; <return>'type'</return> - one of EIO_DT_* constants; <return>'inode'</return> - the inode number, if
            available, otherwise unspecified; <info>EIO_READDIR_DIRS_FIRST</info> (<info>int</info>)  When this flag is
            specified, the names will be returned in an order where likely directories come first,
            in optimal stat order. <info>EIO_READDIR_STAT_ORDER</info> (<info>int</info>)  When this flag is specified, then
            the names will be returned in an order suitable for <return>stat</return>'ing each one. When planning to
            <strong>stat()</strong> all files in the given directory, the returned order will likely be fastest.
            <info>EIO_READDIR_FOUND_UNKNOWN</info> (<info>int</info>)
             
            
            <strong>eio_readdir()</strong> flag. If specified, the result argument of the callback becomes an array
            with the following keys: <return>'names'</return> - array of directory names <return>'dents'</return> - array of <return>struct
            eio_dirent</return>-like arrays having the following keys each: <return>'name'</return> - the directory name;
            <return>'type'</return> - one of EIO_DT_* constants; <return>'inode'</return> - the inode number, if available, otherwise
            unspecified;
            
            When this flag is specified, the names will be returned in an order where likely
            directories come first, in optimal stat order.
            
            When this flag is specified, then the names will be returned in an order suitable for
            <return>stat</return>'ing each one. When planning to <strong>stat()</strong> all files in the given directory, the
            returned order will likely be fastest.
            
            Node types: <info>EIO_DT_UNKNOWN</info> (<info>int</info>)  Unknown node type(very common). Further <strong>stat()</strong> needed.
            <info>EIO_DT_FIFO</info> (<info>int</info>)  FIFO node type <info>EIO_DT_CHR</info> (<info>int</info>)  Node type <info>EIO_DT_MPC</info> (<info>int</info>)
            Multiplexed char device (v7+coherent) node type <info>EIO_DT_DIR</info> (<info>int</info>)  Directory node type
            <info>EIO_DT_NAM</info> (<info>int</info>)  Xenix special named file node type <info>EIO_DT_BLK</info> (<info>int</info>)  Node type
            <info>EIO_DT_MPB</info> (<info>int</info>)  Multiplexed block device (v7+coherent) <info>EIO_DT_REG</info> (<info>int</info>)  Node type
            <info>EIO_DT_NWK</info> (<info>int</info>)  <info>EIO_DT_CMP</info> (<info>int</info>)  HP-UX network special node type <info>EIO_DT_LNK</info> (<info>int</info>)
            Link node type <info>EIO_DT_SOCK</info> (<info>int</info>)  Socket node type <info>EIO_DT_DOOR</info> (<info>int</info>)  Solaris door node
            type <info>EIO_DT_WHT</info> (<info>int</info>)  Node type <info>EIO_DT_MAX</info> (<info>int</info>)  Highest node type value
            
            Unknown node type(very common). Further <strong>stat()</strong> needed.
            
            FIFO node type
            
            Node type
            
            Multiplexed char device (v7+coherent) node type
            
            Directory node type
            
            Xenix special named file node type
            
            Node type
            
            Multiplexed block device (v7+coherent)
            
            Node type
            
            HP-UX network special node type
            
            Link node type
            
            Socket node type
            
            Solaris door node type
            
            Node type
            
            Highest node type value


id: eio_readlink
type: function
doc:
<comment>Description:</comment>
  Read value of a symbolic link

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Source symbolic link path
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readlink()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: eio_realpath
type: function
doc:
<comment>Description:</comment>
  Get the canonicalized absolute pathname
  
  <strong>eio_realpath()</strong> returns the canonicalized absolute pathname in <strong>$result</strong> argument of <strong>$callback</strong>
  function.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Short pathname
  <info>int</info>       <strong>$pri</strong>       
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$data</strong>      

<comment>Return:</comment>
  <info>resource</info>  


id: eio_rename
type: function
doc:
<comment>Description:</comment>
  Change the name or location of a file
  
  <strong>eio_rename()</strong> renames or moves a file to new location.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Source path
  <info>string</info>    <strong>$new_path</strong>  Target path
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rename()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_rmdir
type: function
doc:
<comment>Description:</comment>
  Remove a directory
  
  <strong>eio_rmdir()</strong> removes a directory.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Directory path
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rmdir()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: eio_seek
type: function
doc:
<comment>Description:</comment>
  Repositions the offset of the open file associated with the fd argument to the argument offset
  according to the directive whence
  
  <strong>eio_seek()</strong> repositions the offset of the open file associated with  stream, Socket resource, or
  file descriptor specified by <strong>$fd</strong> to the argument <strong>$offset</strong> according to the directive <strong>$whence</strong> as
  follows: <info>EIO_SEEK_SET</info> - Set position equal to <strong>$offset</strong> bytes.<info>EIO_SEEK_CUR</info> - Set position to current
  location plus <strong>$offset</strong>.<info>EIO_SEEK_END</info> - Set position to end-of-file plus <strong>$offset</strong>.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Stream, Socket resource, or numeric file descriptor
  <info>int</info>       <strong>$offset</strong>    Starting point from which data is to be read.
  <info></info>          <strong>$length</strong>    Number of bytes to be read.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_seek()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_sendfile
type: function
doc:
<comment>Description:</comment>
  Transfer data between file descriptors
  
  <strong>eio_sendfile()</strong> copies  data between one file descriptor and another. See <return>SENDFILE(2)</return> man page for
  details.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$out_fd</strong>    Output stream, Socket resource, or file descriptor. Should be opened for
                       writing.
  <info>mixed</info>     <strong>$in_fd</strong>     Input stream, Socket resource, or file descriptor. Should be opened for
                       reading.
  <info>int</info>       <strong>$offset</strong>    Offset within the source file.
  <info>int</info>       <strong>$length</strong>    Number of bytes to copy.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sendfile()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_set_max_idle
type: function
doc:
<comment>Description:</comment>
  Set maximum number of idle threads

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  Number of idle threads.

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_min_parallel()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_set_max_parallel
type: function
doc:
<comment>Description:</comment>
  Set maximum parallel threads

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  Number of parallel threads

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_set_max_poll_reqs
type: function
doc:
<comment>Description:</comment>
  Set maximum number of requests processed in a poll

<comment>Param:</comment>
  <info>int</info>  <strong>$nreqs</strong>  Number of requests

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


id: eio_set_max_poll_time
type: function
doc:
<comment>Description:</comment>
  Set maximum poll time
  
  Polling stops, if poll took longer than <strong>$nseconds</strong> seconds.

<comment>Param:</comment>
  <info>float</info>  <strong>$nseconds</strong>  Number of seconds

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


id: eio_set_min_parallel
type: function
doc:
<comment>Description:</comment>
  Set minimum parallel thread number

<comment>Param:</comment>
  <info>string</info>  <strong>$nthreads</strong>  Number of parallel threads.

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

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_stat
type: function
doc:
<comment>Description:</comment>
  Get file status
  
  <strong>eio_stat()</strong> returns file status information in <strong>$result</strong> argument of <strong>$callback</strong>

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      The file path
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_stat()</strong> returns request resource on success or <info>false</info> on error. On success assigns
            <strong>$result</strong> argument of <strong>$callback</strong> to an array.

<comment>See Also:</comment>
   * <strong>eio_lstat()</strong>
   * <strong>eio_fstat()</strong>


id: eio_statvfs
type: function
doc:
<comment>Description:</comment>
  Get file system statistics
  
  <strong>eio_statvfs()</strong> returns file system statistics information in <strong>$result</strong> argument of <strong>$callback</strong>

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Pathname of any file within the mounted file system
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_statvfs()</strong> returns request resource on success, ou <info>false</info> em caso de falha.  On
            success assigns <strong>$result</strong> argument of <strong>$callback</strong> to an array.


id: eio_symlink
type: function
doc:
<comment>Description:</comment>
  Create a symbolic link
  
  <strong>eio_symlink()</strong> creates a symbolic link <strong>$new_path</strong> to <strong>$path</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Source path
  <info>string</info>    <strong>$new_path</strong>  Target path
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_symlink()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: eio_sync
type: function
doc:
<comment>Description:</comment>
  Commit buffer cache to disk

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_sync_file_range
type: function
doc:
<comment>Description:</comment>
  Sync a file segment with disk
  
  <strong>eio_sync_file_range()</strong> permits fine control when synchronizing the open file referred to by the
  file descriptor <strong>$fd</strong> with disk.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        File descriptor
  <info>int</info>       <strong>$offset</strong>    The starting byte of the file range to be synchronized
  <info>int</info>       <strong>$nbytes</strong>    Specifies the length of the range to be synchronized, in bytes. If <strong>$nbytes</strong> is
                       zero, then all bytes from <strong>$offset</strong> through to the end of file are
                       synchronized.
  <info>int</info>       <strong>$flags</strong>     A bit-mask. Can include any of the following values:
                       <info>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</info>, <info>EIO_SYNC_FILE_RANGE_WRITE</info>,
                       <info>EIO_SYNC_FILE_RANGE_WAIT_AFTER</info>. These flags have the same meaning as their
                       SYNC_FILE_RANGE_* counterparts(see <return>SYNC_FILE_RANGE(2)</return> man page).
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync_file_range()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_syncfs
type: function
doc:
<comment>Description:</comment>
  Calls Linux' syncfs syscall, if available

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        File descriptor
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_syncfs()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_truncate
type: function
doc:
<comment>Description:</comment>
  Truncate a file
  
  <strong>eio_truncate()</strong> causes the regular file named by <strong>$path</strong> to be truncated to a size of precisely
  <strong>$length</strong> bytes

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      File path
  <info>int</info>       <strong>$offset</strong>    Offset from beginning of the file.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_busy()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: eio_unlink
type: function
doc:
<comment>Description:</comment>
  Delete a name and possibly the file it refers to
  
  <strong>eio_unlink()</strong> deletes  a  name from the file system.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Path to file
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_unlink()</strong> returns request resource on success, ou <info>false</info> em caso de falha.


id: eio_utime
type: function
doc:
<comment>Description:</comment>
  Change file last access and modification times

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Path to the file.
  <info>float</info>     <strong>$atime</strong>     Access time
  <info>float</info>     <strong>$mtime</strong>     Modification time
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_utime()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: eio_write
type: function
doc:
<comment>Description:</comment>
  Write to file
  
  <strong>eio_write()</strong> writes up to <strong>$length</strong> bytes from <strong>$str</strong> at <strong>$offset</strong> offset from the beginning of the file.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Stream, Socket resource, or numeric file descriptor, e.g. returned by
                       <strong>eio_open()</strong>
  <info>string</info>    <strong>$str</strong>       Source string
  <info>int</info>       <strong>$length</strong>    Maximum number of bytes to write.
  <info>int</info>       <strong>$offset</strong>    Offset from the beginning of file.
  <info>int</info>       <strong>$pri</strong>       A prioridade da requisição: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info> ou
                       <info>null</info>.
                       Se <info>null</info> for passado, o parâmetro <strong>$pri</strong> internamente será definido como
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  A função <strong>$callback</strong> é chamada quando a requisição é concluída.
                       Ela deve corresponder ao seguinte protótipo: 
                       <strong>$data</strong>são dados personalizados passados para a requisição.<strong>$result</strong>valor de
                       resultado específico da requisição; basicamente, o valor retornado pela
                       chamada de sistema
                       correspondente.<strong>$req</strong>é um recurso de requisição opcional que pode ser usado com
                       funções como <strong>eio_get_last_error()</strong>
                       
                       são dados personalizados passados para a requisição.
                       
                       valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
                       
                       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      são dados personalizados passados para a requisição.
  <info></info>          <strong>$result</strong>    valor de resultado específico da requisição; basicamente, o valor retornado
                       pela chamada de sistema
                       correspondente.
  <info></info>          <strong>$req</strong>       é um recurso de requisição opcional que pode ser usado com funções como
                       <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_write()</strong> returns request resource on success, ou <info>false</info> em caso de falha.

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


id: empty
type: function
doc:
<comment>Description:</comment>
  Determina se uma variável está vazia
  
  Determina se uma variável é considerada vazia. Uma variável é considerada vazia se não existir ou
  seu valor for igual a <info>false</info>. A função <strong>empty()</strong> não gera um aviso se a variável não existir.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  Variável a ser verificada
               
               Nenhum aviso é gerado se a variável não existir. Isso significa que a função <strong>empty()</strong>
               é essencialmente o equivalente sucinto de !isset($var) || $var == false.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$var</strong> não existir ou se tiver um valor que é vazio ou igual a zero. Consulte
        conversão para booleano. Caso contrário, retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>array_key_exists()</strong>
   * <strong>count()</strong>
   * <strong>strlen()</strong>
   * A tabela de comparação de tipos


id: enchant_broker_describe
type: function
doc:
<comment>Description:</comment>
  Enumerates the Enchant providers
  
  Enumerates the Enchant providers and tells you some rudimentary information about them. The same
  info is provided through phpinfo().

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of available Enchant providers with their details.


id: enchant_broker_dict_exists
type: function
doc:
<comment>Description:</comment>
  Whether a dictionary exists or not. Using non-empty tag
  
  Tells if a dictionary exists or not, using a non-empty tags

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>     non-empty tag in the LOCALE format, ex: us_US, ch_DE, etc.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the tag exist or <info>false</info> when not.

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


id: enchant_broker_free
type: function
doc:
<comment>Description:</comment>
  Free the broker resource and its dictionaries
  
  Free a broker with all its dictionaries. As of PHP 8.0.0, it is recommended to unset the object
  instead of calling this function.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.

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

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


id: enchant_broker_free_dict
type: function
doc:
<comment>Description:</comment>
  Free a dictionary resource
  
  Free a dictionary. As of PHP 8.0.0, it is recommended to unset the object instead of calling this
  function.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</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>enchant_broker_request_dict()</strong>
   * <strong>enchant_broker_request_pwl_dict()</strong>


id: enchant_broker_get_dict_path
type: function
doc:
<comment>Description:</comment>
  Get the directory path for a given backend
  
  Get the directory path for a given backend.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>int</info>            <strong>$type</strong>    The type of the dictionaries, i.e. <info>ENCHANT_MYSPELL</info> or <info>ENCHANT_ISPELL</info>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the path of the dictionary directory on success ou <info>false</info> em caso de falha.

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


id: enchant_broker_get_error
type: function
doc:
<comment>Description:</comment>
  Returns the last error of the broker
  
  Returns the last error which occurred in this broker.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Return the msg string if an error was found or <info>false</info>


id: enchant_broker_init
type: function
doc:
<comment>Description:</comment>
  Create a new broker object capable of requesting

<comment>Return:</comment>
  <info>EnchantBroker|false</info>  Returns a broker resource on success or <info>false</info>.

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


id: enchant_broker_list_dicts
type: function
doc:
<comment>Description:</comment>
  Returns a list of available dictionaries
  
  Returns a list of available dictionaries with their details.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of available dictionaries with their details.

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


id: enchant_broker_request_dict
type: function
doc:
<comment>Description:</comment>
  Create a new dictionary using a tag
  
  create a new dictionary using tag, the non-empty language tag you wish to request a dictionary for
  ("en_US", "de_DE", ...)

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>     A tag describing the locale, for example en_US, de_DE

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

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_request_pwl_dict
type: function
doc:
<comment>Description:</comment>
  Creates a dictionary using a PWL file
  
  Creates a dictionary using a PWL file. A PWL file is personal word file one word per line.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$filename</strong>  Path to the PWL file. If there is no such file, a new one will be
                            created if possible.

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

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_set_dict_path
type: function
doc:
<comment>Description:</comment>
  Set the directory path for a given backend
  
  Set the directory path for a given backend.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>int</info>            <strong>$type</strong>    The type of the dictionaries, i.e. <info>ENCHANT_MYSPELL</info> or <info>ENCHANT_ISPELL</info>.
  <info>string</info>         <strong>$path</strong>    The path of the dictionary directory.

<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>enchant_broker_get_dict_path()</strong>


id: enchant_broker_set_ordering
type: function
doc:
<comment>Description:</comment>
  Declares a preference of dictionaries to use for the language
  
  Declares a preference of dictionaries to use for the language described/referred to by 'tag'. The
  ordering is a comma delimited list of provider names. As a special exception, the "*" tag can be
  used as a language tag to declare a default ordering for any language that does not explicitly
  declare an ordering.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    Um agente Enchant retornado por <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>       Language tag. The special "*" tag can be used as a language tag to
                            declare a default ordering for any language that does not explicitly
                            declare an ordering.
  <info>string</info>         <strong>$ordering</strong>  Comma delimited list of provider names

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


id: enchant_dict_add
type: function
doc:
<comment>Description:</comment>
  Add a word to personal word list
  
  Add a word to personal word list of the given dictionary.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        The word to add

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

<comment>See Also:</comment>
   * <strong>enchant_broker_request_pwl_dict()</strong>
   * <strong>enchant_broker_request_dict()</strong>


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


id: enchant_dict_add_to_session
type: function
doc:
<comment>Description:</comment>
  Add 'word' to this spell-checking session
  
  Add a word to the given dictionary. It will be added only for the active spell-checking session.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        The word to add

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

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


id: enchant_dict_check
type: function
doc:
<comment>Description:</comment>
  Check whether a word is correctly spelled or not
  
  If the word is correctly spelled return <info>true</info>, otherwise return <info>false</info>

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        The word to check

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the word is spelled correctly, <info>false</info> if not.


id: enchant_dict_describe
type: function
doc:
<comment>Description:</comment>
  Describes an individual dictionary
  
  Returns the details of the dictionary.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.

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


id: enchant_dict_get_error
type: function
doc:
<comment>Description:</comment>
  Returns the last error of the current spelling-session
  
  Returns the last error of the current spelling-session

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Returns the error message as string or <info>false</info> if no error occurred.


id: enchant_dict_is_added
type: function
doc:
<comment>Description:</comment>
  Whether or not 'word' exists in this spelling-session
  
  Tells whether or not a word already exists in the current session.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        The word to lookup

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the word exists or <info>false</info>

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


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


id: enchant_dict_quick_check
type: function
doc:
<comment>Description:</comment>
  Check the word is correctly spelled and provide suggestions
  
  If the word is correctly spelled return <info>true</info>, otherwise return <info>false</info>, if suggestions variable is
  provided, fill it with spelling alternatives.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>   Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                   ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>         The word to check
  <info>array</info>              <strong>$suggestions</strong>  If the word is not correctly spelled, this variable will contain
                                   an array of suggestions.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the word is correctly spelled or <info>false</info>

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_suggest()</strong>


id: enchant_dict_store_replacement
type: function
doc:
<comment>Description:</comment>
  Add a correction for a word
  
  Add a correction for 'mis' using 'cor'. Notes that you replaced @mis with @cor, so it's possibly
  more likely that future occurrences of @mis will be replaced with @cor. So it might bump @cor up
  in the suggestion list.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$misspelled</strong>  The work to fix
  <info>string</info>             <strong>$correct</strong>     The correct word

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


id: enchant_dict_suggest
type: function
doc:
<comment>Description:</comment>
  Will return a list of values if any of those pre-conditions are not met

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Um dicionário Enchant retornado por <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Word to use for the suggestions.

<comment>Return:</comment>
  <info>array</info>  Will returns an array of suggestions if the word is bad spelled.

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_quick_check()</strong>


id: end
type: function
doc:
<comment>Description:</comment>
  Define o ponteiro interno de um array para seu último elemento
  
  <strong>end()</strong> avança o ponteiro interno de <strong>$array</strong> até o último elemento, e retorna seu valor.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  O array.  Este array é passado por referência porque ele é modificado pela
                        função.  Isto significa que deve-se passar a esta função uma variável real,
                        e não uma função retornando um array, porque somente variáveis reais podem
                        ser passadas por referência.

<comment>Return:</comment>
  <info>mixed</info>  Retorna o valor do último elemento ou <info>false</info> para array vazio.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>each()</strong>
   * <strong>prev()</strong>
   * <strong>reset()</strong>
   * <strong>next()</strong>
   * <strong>array_key_last()</strong>


id: enum_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se uma enumeração foi definida
  
  Esta função verifica se o enum fornecido foi definido.

<comment>Param:</comment>
  <info>string</info>  <strong>$enum</strong>      O nome da enumetação. O nome é verificado sem sensibilidade a
                     maiúsculas/minúsculas.
  <info>bool</info>    <strong>$autoload</strong>  Se deve-se carregar automaticamente a enumeração caso não tenha sido carregada.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se <strong>$enum</strong> é uma enumeração definida, <info>false</info> caso contrário.

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


id: error_clear_last
type: function
doc:
<comment>Description:</comment>
  Clear the most recent error

<comment>Return:</comment>
  <info>void</info>  Clears the most recent errors, making it unable to be retrieved with <strong>error_get_last()</strong>.

<comment>See Also:</comment>
   * Error constants


id: error_get_last
type: function
doc:
<comment>Description:</comment>
  Obtém o último erro ocorrido
  
  Obtém informações sobre o último erro que ocorreu.

<comment>Return:</comment>
  <info>array|null</info>  Retorna um array associativo que descreve o último erro com as chaves "type",
              "message", "file" e "line". Se o erro foi causado por uma função interna do PHP, então
              a "message" começa com o nome da função. Retorna <info>null</info> se ainda não houve erro.

<comment>See Also:</comment>
   * Constantes de erro
   * Variável $php_errormsg
   * <strong>error_clear_last()</strong>
   * Diretiva <strong>$display_errors</strong>
   * Diretiva <strong>$html_errors</strong>
   * Diretiva <strong>$xmlrpc_errors</strong>


id: error_log
type: function
doc:
<comment>Description:</comment>
  Envia uma mensagem de erro para as rotinas de tratamento de erros definidas
  
  Envia uma mensagem de erro para o registro de erros do servidor web ou para um arquivo.

<comment>Param:</comment>
  <info>string</info>       <strong>$message</strong>             A mensagem de erro que deve ser registrada.
  <info>int</info>          <strong>$message_type</strong>        Indica para onde o erro deve ser direcionado. Os possíveis tipos
                                    de mensagem são os seguintes:
                                    
                                    Tipos de logs de <strong>error_log()</strong>0<strong>$message</strong> é enviado para sistema de
                                    logs do PHP, usando o mecanismo de log do sistema operacional ou
                                    um arquivo, dependendo do que a diretiva de configuração
                                    error_log estiver definida. Esta é a opção padrão. 1<strong>$message</strong> é
                                    enviado por e-mail para o endereço no parâmetro <strong>$destination</strong>.
                                    Este é o único tipo de mensagem em que o quarto parâmetro,
                                    <strong>$additional_headers</strong>, é utilizado. 2 Não é mais uma opção.
                                    3<strong>$message</strong> é adicionada ao arquivo <strong>$destination</strong>. Uma nova linha
                                    não é automaticamente adicionada ao final da string <strong>$message</strong>.
                                    4<strong>$message</strong> é enviado diretamente para o manipulador de log do
                                    SAPI.
  <info>string|null</info>  <strong>$destination</strong>         O destino. Seu significado depende do parâmetro <strong>$message_type</strong>,
                                    conforme descrito acima.
  <info>string|null</info>  <strong>$additional_headers</strong>  Os cabeçalhos adicionais. É usado quando o parâmetro
                                    <strong>$message_type</strong> está definido como <return>1</return>. Este tipo de mensagem usa a
                                    mesma função interna que <strong>mail()</strong> utiliza.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se <strong>$message_type</strong> for zero, esta
        função sempre retorna <info>true</info>, independentemente de o erro poder ser registrado ou não.


id: error_reporting
type: function
doc:
<comment>Description:</comment>
  Define quais erros do PHP são relatados
  
  A função <strong>error_reporting()</strong> define a diretiva error_reporting em tempo de execução. O PHP possui
  muitos níveis de erros, e o uso desta função define esse nível para a duração (tempo de execução)
  do seu script. Se o parâmetro opcional <strong>$error_level</strong> não for definido, a função <strong>error_reporting()</strong>
  retornará apenas o nível de relatório de erros atual.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$error_level</strong>  O novo nível de error_reporting. Pode ser uma máscara de bits ou
                          constantes nomeadas. É altamente recomendado o uso de constantes nomeadas
                          para garantir compatibilidade com futuras versões. Conforme são
                          adicionados níveis de erro, o intervalo de inteiros aumenta, então os
                          níveis de erro baseados em inteiros mais antigos nem sempre se comportarão
                          como esperado.
                          
                          As constantes de nível de erro disponíveis e os significados reais desses
                          níveis de erro são descritos nas constantes predefinidas.

<comment>Return:</comment>
  <info>int</info>  Retorna o nível de error_reporting antes que ele seja alterado para <strong>$error_level</strong>.
       
       O operador de controle de erro <return>@</return> altera o <strong>$error_level</strong> durante o tratamento de erros.

<comment>See Also:</comment>
   * A diretiva display_errors
   * A diretiva html_errors
   * A diretiva xmlrpc_errors
   * O operador error control
   * <strong>ini_set()</strong>


id: escapeshellarg
type: function
doc:
<comment>Description:</comment>
  Escapa uma string para ser usada como um argumento shell
  
  <strong>escapeshellarg()</strong> adiciona aspas simples em torno de uma string e escapa quaisquer aspas simples
  existentes permitindo passar uma string diretamente a uma função shell e tê-la tratada como um
  único argumento seguro. Esta função deve ser usada para escapar argumentos individuais a funções
  shell vindos de entrada de usuário. As funções shell incluem <strong>exec()</strong>, <strong>system()</strong> e o operador crase.
  
  Diferentemente, no Windows, <strong>escapeshellarg()</strong> substitui sinais de porcentagem, sinais de exclamação
  (subsitituição atrasada de variáveis) e aspas duplas com espaços e adiciona aspas duplas em torno
  da string. Posteriormente, cada sequencia de barras invertidas consecutivas (<return>\</return>) é escapada por uma
  barra invertida adicional.

<comment>Param:</comment>
  <info>string</info>  <strong>$arg</strong>  O argumento que será escapado.

<comment>Return:</comment>
  <info>string</info>  A string escapada.

<comment>See Also:</comment>
   * <strong>escapeshellcmd()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * Operador crase


id: escapeshellcmd
type: function
doc:
<comment>Description:</comment>
  Escapa metacaracteres shell
  
  <strong>escapeshellcmd()</strong> escapa qualquer caractere em uma string que possa ser utilizada para enganar um
  comando shell para executar comandos arbritários. Esta função deve ser utilizada para ter certeza
  que quaisquer dados vindos do usuário são escapado antes que estes dados sejam passados para as
  funções <strong>exec()</strong> ou <strong>system()</strong>, ou para o operador crase.
  
  Os seguintes caracteres são precedidos por uma barra invertida: <return>&#;`|*?~\<&gt;^()[]{}$\</return>, <return>\x0A</return> e <return>\xFF</return>. <return>'</return> e <return>"</return> são escapados apenas se não estiverem em pares. No windows, todos estes caracteres mais <return>%</return> e <return>!</return> são precedidos por um circunflexo (<return>^</return>).

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  O comando que será escapado.

<comment>Return:</comment>
  <info>string</info>  A string escapada.

<comment>See Also:</comment>
   * <strong>escapeshellarg()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * backtick operator


id: eval
type: function
doc:
<comment>Description:</comment>
  Avalia uma string como código PHP
  
  Avalia a string fornecida no parâmetro <strong>$code</strong> como um código PHP.
  
  O código a ser avaliado herda o escopo de variáveis da linha na qual a chamada a <strong>eval()</strong> ocorrer.
  Todas as variáveis disponíveis naquela linha estarão disponíveis para leitura e modificação no
  código avaliado. Entretanto, todas as funções e classes definidas serão definidas no espaço de
  nomes global. Em outras palavras, o compilador considera o código avaliado como se ele fosse um
  arquivo incluído separadamente.
  
  A construção de linguagem <strong>eval()</strong> é bastante perigosa porque permite execução de código PHP
  arbitrário. Seu uso é contudo desencorajado. Se foi cuidadosamente verificado que não há outra
  opção a não ser usar esta construção, deve-se prestar atenção especial para não passar nenhum dado
  fornecido pelo usuário no parâmetro sem antes validá-lo.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>  Código PHP válido a ser avaliado.
                 
                 O código não pode ser envolvido em etiquetas PHP de abertura e de fechamento, isto
                 é, <return>'echo "Hi!";'</return> deve ser passado ao invés de <return>'\<?php echo "Hi!"; ?&gt;'</return>. Ainda é possível sair e re-entrar no modo PGP usando-se os marcadores apropriados, ex.: <return>'echo "In PHP mode!"; ?&gt;In HTML mode!\<?php echo "Back in PHP mode!";'</return>.
                 
                 Além disso, o código informado deve ser código PHP válido. Isto inclui o fato de
                 que todas as instruções devem ser adequadamente terminadas com ponto-e-vírgula.
                 <return>'echo "Hi!"'</return> por exemplo causará um erro de avaliação, enquanto que <return>'echo "Hi!";'</return>
                 funcionará.
                 
                 Uma instrução <return>return</return> irá terminar imediatamente a avaliação do código.
                 
                 o código será executado no escopo do código que está chamando <strong>eval()</strong>. Todas as
                 variáveis definidas ou alteradas na chamada a <strong>eval()</strong> permanecerão visíveis depois
                 que ela terminar.

<comment>Return:</comment>
  <info>mixed</info>  <strong>eval()</strong> retorna <info>null</info> a menos que <return>return</return> seja chamado no código avaliado, neste caso o valor
         passado a <return>return</return> será o retornado. A partir do PHP 7, se houver um erro de avaliação no
         código, <strong>eval()</strong> lança uma exceção ParseError. Antes do PHP 7, neste caso <strong>eval()</strong> retornava
         <info>false</info> e a execução do código seguinte continuava normalmente. Não é possível capturar um
         erro de avaliação em <strong>eval()</strong> usando <strong>set_error_handler()</strong>.

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


id: exec
type: function
doc:
<comment>Description:</comment>
  Executa um programa externo
  
  <strong>exec()</strong> executa o comando informado em <strong>$command</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      O comando que será executado.
  <info>array</info>   <strong>$output</strong>       Se o argumento <strong>$output</strong> estiver presente, então o array especificado será
                        prenchido com cada linha da saída do comando. Espaço ao final, como <return>\n</return>, não
                        é incluído neste array. Note que se o array já contiver alguns elementos,
                        <strong>exec()</strong> irá adicionar ao final do array. Se nnão houver intenção de que a
                        função adicione elementos, use <strong>unset()</strong> no array antes de passá-lo para
                        <strong>exec()</strong>.
  <info>int</info>     <strong>$result_code</strong>  Se o argumento <strong>$result_code</strong> estiver presente junto com o argumento <strong>$output</strong>,
                        então o estado de retorno do comando executado será escrito nesta variável.

<comment>Return:</comment>
  <info>string|false</info>  A última linha do resultado do comando. Se for necessário executar um comando e ter
                todos os dados dele passados diretamente de volta sem qualquer interferência, use a
                função <strong>passthru()</strong>.
                
                Retorna <info>false</info> em caso de falha.
                
                Para obter a saída do comando executado, certifique-se de definir e usar o parâmetro
                <strong>$output</strong>.

<comment>See Also:</comment>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * Operador crase


id: exif_imagetype
type: function
doc:
<comment>Description:</comment>
  Verifica o tipo de uma imagem
  
  <strong>exif_imagetype()</strong> lê os primeiros bytes de uma imagem e verifica sua assinatura.
  
  <strong>exif_imagetype()</strong> pode ser usada para evitar chamadas a outras funções exif que não têm suporte a
  certos tipos de arquivos ou um conjunção com $_SERVER['HTTP_ACCEPT'] para verificar se o
  visualizador é capaz de mostrar uma imagem específica no browser.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  A imagem a ser verificada.

<comment>Return:</comment>
  <info>int|false</info>  Quando uma assinatura correta é encontrada, o valor da constante associada será
             retornado, caso contrário o valor de retorno será <info>false</info>. O valor retornado é o mesmo
             valor que <strong>getimagesize()</strong> retorna no índice 2, mas <strong>exif_imagetype()</strong> é bem mais rápida.
             
             As seguintes constantes estão definidas, e representam os possíveis valores de retorno
             de <strong>exif_imagetype()</strong>: Constantes
             ImagetypeValorConstante1<info>IMAGETYPE_GIF</info>2<info>IMAGETYPE_JPEG</info>3<info>IMAGETYPE_PNG</info>4<info>IMAGETYPE_SWF</info>5<info>IMAGETYPE_PSD</info>6<info>IMAGETYPE_BMP</info>7<info>IMAGETYPE_TIFF_II</info>
             (ordem de bytes Intel)8<info>IMAGETYPE_TIFF_MM</info> (ordem de bytes Motorola)
             9<info>IMAGETYPE_JPC</info>10<info>IMAGETYPE_JP2</info>11<info>IMAGETYPE_JPX</info>12<info>IMAGETYPE_JB2</info>13<info>IMAGETYPE_SWC</info>14<info>IMAGETYPE_IFF</info>15<info>IMAGETYPE_WBMP</info>16<info>IMAGETYPE_XBM</info>17<info>IMAGETYPE_ICO</info>18<info>IMAGETYPE_WEBP</info>19<info>IMAGETYPE_AVIF</info>
             
             <strong>exif_imagetype()</strong> emitirá um erro de nível <info>E_NOTICE</info> e retornará <info>false</info> se for incapaz de
             ler bytes suficientes do arquivo para determinar o tipo da imagem.

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


id: exif_read_data
type: function
doc:
<comment>Description:</comment>
  Lê os cabeçalhos EXIF de um arquivo de imagen
  
  A função <strong>exif_read_data()</strong> lê os cabeçalhos EXIF de um arquivo de imagem. Desta forma é possível
  ler metadados gerados por câmeras digitais.
  
  Cabeçalhos EXIF tendem a estar presentes em imagens JPEG/TIFF geradas por camêras digitais, mas
  infelizmente, cada fabricante de camêra digital tem uma idéia diferente de como marcar as suas
  imagens, então não se pode confiar sempre que um cabeçalho EXIF específico estará presente.
  
  Altura (<return>Height</return>) e largura (<return>Width</return>) sao computadas da mesma maneira que <strong>getimagesize()</strong> faz, então
  seus valores não devem ser parte de nenhum cabeçalho retornado. Além disso, <return>html</return> é uma string de
  texto com altura/largura a ser usado dentro de umHTML normal.
  
  Quando um cabeçalho Exif contém uma nota de direitos autorais, esta nota pode conter dois valores.
  Como a solução é inconsistente com o padrão Exif 2.10 a seção <return>COMPUTED</return> irá retornar ambas as
  entradas <return>Copyright.Photographer</return> e <return>Copyright.Editor</return> enquando que as seções <return>IFD0</return> contém um array de
  bytes com o caractere NULL que separa as duas entradas. Ou apenas a primeira entrada se o tipo de
  dados estiver errado (funcionamento normal do Exif). <return>COMPUTED</return> irá conter também a entrada
  <return>Copyright</return> que será a string original do copyright ou uma lista separada por vírgula dos direitos
  autorais da foto e do editor.
  
  A marca <return>UserComment</return> tem o mesmo problema que a marca de Copyright. Ela pode guardar dois valores.
  Primeiro a codificação usada e em segundo o valor em si. Então a seção <return>IFD</return> contém somente a
  codificação ou um array de bytes. A seção <return>COMPUTED</return> irá guardar ambos nas entradas
  <return>UserCommentEncoding</return> e <return>UserComment</return>. A entrada <return>UserComment</return> está disponível em ambos os casos então
  deve ser usada em preferência ao valor da seção <return>IFD0</return>.
  
  <strong>exif_read_data()</strong> também valida marcas de dados EXIF de acordo com a especificação EXIF
  (http://exif.org/Exif2-2.PDF, página 20).

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>               A localização do arquivo de imagem. Pode ser uma caminho para
                                       o arquivo (empacotadores de fluxo são também suportados) ou
                                       um fluxo do tipo <info>resource</info>.
  <info>string|null</info>      <strong>$required_sections</strong>  Uma lista de seções separadas por vírgula que precisam estar
                                       presentes no arquivo para produzir o resultado do tipo <info>array</info>.
                                       Se nenhuma das seções informadas puder ser encontrada o valor
                                       de retorno é <info>false</info>. FILEFileName, FileSize, FileDateTime,
                                       SectionsFoundCOMPUTED html, Width, Height, IsColor, e mais se
                                       disponíveis. Height e Width são computadas da mesma maneira
                                       que <strong>getimagesize()</strong> faz, portanto seus valores não deve ser
                                       parte de nenhum cabeçalho retornado. Além disso, <return>html</return> é uma
                                       string de texto com altura/largura a ser usado dentro de um
                                       HTML normal. ANY_TAGQualquer informação que tenha uma marca,
                                       ex.: <return>IFD0</return>, <return>EXIF</return>, ...IFD0 Todos os dados marcados de IFD0. Em
                                       arquivos de imagem normais, contém o tamanho da imagem e
                                       outros dados. THUMBNAIL Um arquivo deveria ter uma miniatura
                                       se tiver um segundo <return>IFD</return>. Todas as informações marcadas sobre
                                       a miniatura embutida estão gravadas nesta seção.
                                       COMMENTCabeçalho de comentários de imagens JPEG.EXIF A seção
                                       EXIF é uma sub-seção de <return>IFD0</return>. Contém informação mais
                                       detalhada sobre uma imagem. A maior parte destas entradas são
                                       relacionadas a câmeras digitais.
  <info>bool</info>             <strong>$as_arrays</strong>          Especifica se cada seção se torna ou não um array. As seções
                                       <return>COMPUTED</return>, <return>THUMBNAIL</return> E <return>COMMENT</return> de <strong>$required_sections</strong> sempre se
                                       toranm arrays por que contêm valores cujos nomes conflitam
                                       com outras seções.
  <info>bool</info>             <strong>$read_thumbnail</strong>     Quando definida para <info>true</info> a miniatura em si é lida. Caso
                                       contrário, apenas os dados marcados são ligos.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um <info>array</info> associativo onde os índices são os nomes dos cabeçalhos e os valores
               são os associados com esses cabeçalhos. Se nenhum dado puder ser retornado,
               <strong>exif_read_data()</strong> retornará <info>false</info>.

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


id: exif_tagname
type: function
doc:
<comment>Description:</comment>
  Obtém o nome do cabeçalho para um índice

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  O ID da marca para o qual o nome do cabeçalho será pesquisado

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome do cabeçalho, ou <info>false</info> se <strong>$index</strong> não for um id de marca EXIF
                definido.

<comment>See Also:</comment>
   * <strong>exif_imagetype()</strong>
   * EXIF Specification
   * EXIF Tags


id: exif_thumbnail
type: function
doc:
<comment>Description:</comment>
  Recupera a miniatura embutida de uma imagem
  
  <strong>exif_thumbnail()</strong> lê a miniatura embutida de uma imagem.
  
  Se for desejado exibir miniaturas através desta função, deve-se enviar a informação do tipo de
  mídia usando a função <strong>header()</strong>.
  
  É possível que <strong>exif_thumbnail()</strong> não possa criar uma imagem mas possa determinar seu tamanho. Neste
  caso, o valor retornado é <info>false</info> mas a largura (<strong>$width</strong>) e altura (<strong>$height</strong>) serão definidos.

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>        A localização do arquivo de imagem. Pode ser um caminho ou um fluxo
                                do tipo <info>resource</info>.
  <info>int</info>              <strong>$width</strong>       A largura da miniatura retornada.
  <info>int</info>              <strong>$height</strong>      A altura da miniatura retornada.
  <info>int</info>              <strong>$image_type</strong>  O tipo da imagem da miniatura retornada. Pode ser TIFF ou JPEG.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a miniatura embutida, ou <info>false</info> se a imagem não contiver miniatura.

<comment>See Also:</comment>
   * <strong>exif_read_data()</strong>
   * <strong>image_type_to_mime_type()</strong>


id: exit
type: function
doc:
<comment>Description:</comment>
  Mostra uma mensagem e termina o script atual
  
  Termina a execução do script. Funções de desligamento e destruidores de objeto sempre serão
  executados mesmo que <return>exit</return> seja chamada.
  
  <return>exit</return> é uma construção de linguagem e pode ser chamada sem parênteses se <strong>$status</strong> não foi informado.

<comment>Param:</comment>
  <info>string</info>  <strong>$status</strong>  Se <strong>$status</strong> for uma string, a função mostra <strong>$status</strong> logo antes de sair.
                   
                   Se <strong>$status</strong> for um <info>int</info>, este valor será usado como o estado da saída e não será
                   mostrado Estados de saída devem estar no intervalo de 0 a 254, o estado de saída
                   255 é reservado pelo PHP e não deve ser usado. O estado 0 é usado para terminar o
                   programa com sucesso.

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

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


id: exp
type: function
doc:
<comment>Description:</comment>
  Calcula o expoente de e
  
  Retorna <info>e</info> elevada à potência de <strong>$num</strong>.
  
  '<info>e</info>' é a base do sistema natural de logaritmos, ou aproximadamente 2.718282.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento a ser processado

<comment>Return:</comment>
  <info>float</info>  'e' elevado à potência de <strong>$num</strong>

<comment>See Also:</comment>
   * <strong>log()</strong>
   * <strong>pow()</strong>


id: expect_expectl
type: function
doc:
<comment>Description:</comment>
  Waits until the output from a process matches one
    of the patterns, a specified time period has passed, or an EOF is seen
    
  
  Waits until the output from a process matches one of the patterns, a specified time period has
  passed, or an EOF is seen.
  
  If <strong>$match</strong> is provided, then it is filled with the result of search. The matched string can be
  found in <strong>$match[0]</strong>. The match substrings (according to the parentheses) in the original pattern
  can be found in <strong>$match[1]</strong>, <strong>$match[2]</strong>, and so on, up to <strong>$match[9]</strong> (the limitation of libexpect).

<comment>Param:</comment>
  <info>resource</info>  <strong>$expect</strong>  An Expect stream, previously opened with <strong>expect_popen()</strong>.
  <info>array</info>     <strong>$cases</strong>   An array of expect cases. Each expect case is an indexed array, as described in
                     the following table: Expect Case ArrayIndex KeyValue TypeDescriptionIs
                     MandatoryDefault Value0stringpattern, that will be matched against the output
                     from the streamyes1mixedvalue, that will be returned by this function, if the
                     pattern matchesyes2integer pattern type, one of: <info>EXP_GLOB</info>, <info>EXP_EXACT</info> or
                     <info>EXP_REGEXP</info> no<info>EXP_GLOB</info>

<comment>Return:</comment>
  <info>int</info>  Returns value associated with the pattern that was matched.
       
       On failure this function returns: <info>EXP_EOF</info>, <info>EXP_TIMEOUT</info> or <info>EXP_FULLBUFFER</info>

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


id: expect_popen
type: function
doc:
<comment>Description:</comment>
  Execute command via Bourne shell, and open the PTY stream to
    the process
  
  Execute command via Bourne shell, and open the PTY stream to the process.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Command to execute.

<comment>Return:</comment>
  <info>resource</info>  Returns an open PTY stream to the processes <return>stdio</return>, <return>stdout</return>, and <return>stderr</return>.
            
            On failure this function returns <info>false</info>.

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


id: explode
type: function
doc:
<comment>Description:</comment>
  Split a string by a string
  
  Returns an array of strings, each of which is a substring of <strong>$string</strong> formed by splitting it on
  boundaries formed by the string <strong>$separator</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  The boundary string.
  <info>string</info>  <strong>$string</strong>     The input string.
  <info>int</info>     <strong>$limit</strong>      If <strong>$limit</strong> is set and positive, the returned array will contain a maximum of
                      <strong>$limit</strong> elements with the last element containing the rest of <strong>$string</strong>.
                      
                      If the <strong>$limit</strong> parameter is negative, all components except the last -<strong>$limit</strong>
                      are returned.
                      
                      If the <strong>$limit</strong> parameter is zero, then this is treated as 1.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of <info>string</info>s created by splitting the <strong>$string</strong> parameter on boundaries formed
         by the <strong>$separator</strong>.
         
         If <strong>$separator</strong> is an empty <info>string</info> (""), <strong>explode()</strong> throws a <class>ValueError</class>. If <strong>$separator</strong>
         contains a value that is not contained in <strong>$string</strong> and a negative <strong>$limit</strong> is used, then an
         empty <info>array</info> will be returned, otherwise an <info>array</info> containing <strong>$string</strong> will be returned. If
         <strong>$separator</strong>  values appear at the start or end of <strong>$string</strong>, said values  will be added as an
         empty <info>array</info> value either in the first or last  position of the returned <info>array</info> respectively.

<comment>See Also:</comment>
   * <strong>preg_split()</strong>
   * <strong>str_split()</strong>
   * <strong>mb_split()</strong>
   * <strong>str_word_count()</strong>
   * <strong>strtok()</strong>
   * <strong>implode()</strong>


id: expm1
type: function
doc:
<comment>Description:</comment>
  Retorna exp($num) - 1, computado de forma precisa mesmo
     quando o valor do número está próximo de zero.
    
  
  <strong>expm1()</strong> retorna o equivalente a 'exp(<strong>$num</strong>) -  1' computado de forma precisa mesmo se o valor de
  <strong>$num</strong> for próximo de zero, em algum caso onde 'exp (<strong>$num</strong>) - 1' possa ser impreciso devido à
  subtração de dois números quase iguais.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  O argumento a ser processado

<comment>Return:</comment>
  <info>float</info>  'e' elevado à potência de <strong>$num</strong> menos um

<comment>See Also:</comment>
   * <strong>log1p()</strong>
   * <strong>exp()</strong>


id: expression
type: function
doc:
<comment>Description:</comment>
  Bind prepared statement variables as parameters
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>Return:</comment>
  <info>object</info>  


id: extension_loaded
type: function
doc:
<comment>Description:</comment>
  Descobre se uma extensão está carregada
  
  Descobre se uma extensão está carregada.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  O nome da extensão. O parâmetro não faz distinção de maiúsculas/minúsculas.
                      
                      Pode-se ver os nomes de várias extensões usando <strong>phpinfo()</strong>; ou se estiver sendo
                      usada a versão <return>CGI</return> ou <return>CLI</return> do PHP, pode-se usar a opção -m para listar todas as
                      extensões disponíveis:

<comment>Return:</comment>
  <info>bool</info>  Retorna true <info>true</info> se a extensão identificada por <strong>$extension</strong> estiver carregada, <info>false</info> caso
        contrário.

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


id: extract
type: function
doc:
<comment>Description:</comment>
  Importa variáveis para a tabela de símbolos a partir de um array
  
  Importar variáveis a partir de um array para a tabela de símbolos corrente.
  
  Verifica cada chave se ela tem nome de variável válido. Também verifica por colisões com já
  existente variáveis na tabela de símbolos.
  
  Não use <strong>extract()</strong> em dados inseguros, como informações externas (e.g. $_GET, $_FILES).

<comment>Param:</comment>
  <info>array</info>   <strong>$array</strong>   Um array associativo. Esta função trata chaves como nome de variáveis e valores
                   com os valores da variáveis. Para cada par chave/valor ela cria uma variável na
                   atual tabela de símbolo, seguindo os parâmetros <strong>$flags</strong> e <strong>$prefix</strong>.
                   
                   Você precisa usar um array associativo, um array numericamente indexado não irá
                   produzir resultado até que você use <info>EXTR_PREFIX_ALL</info> ou <info>EXTR_PREFIX_INVALID</info>.
  <info>int</info>     <strong>$flags</strong>   A forma como inválida/chaves numéricas e colisões são tratadas é determinada por
                   <strong>$flags</strong>. Pode ser um dos seguintes valores: <info>EXTR_OVERWRITE</info> Se houver uma colisão,
                   sobrescreve a variável existente. <info>EXTR_SKIP</info> Se houver uma colisão, não
                   sobrescreve a variável existente. <info>EXTR_PREFIX_SAME</info>Se houver uma colisão, adiciona
                   um prefixo ao nome da variável definido pelo argumento <strong>$prefix</strong>. <info>EXTR_PREFIX_ALL</info>
                   Adiciona um prefixo ao nome de todas as variáveis definido por <strong>$prefix</strong>.
                   <info>EXTR_PREFIX_INVALID</info> Adiciona um prefixo definido por <strong>$prefix</strong> apenas para
                   variáveis como nomes inválidos ou numéricos. <info>EXTR_IF_EXISTS</info> Só sobrescreve a
                   variável se ela já existe na tabela de símbolos corrente, caso contrário, não faz
                   nada. Isso é útil quando se quer definir uma lista de variáveis válidas e então
                   extrair só as que foram definidas em $_REQUEST, por exemplo.
                   <info>EXTR_PREFIX_IF_EXISTS</info> Só cria nomes de variáveis usando o prefixo se na tabela de
                   símbolos já existe uma variável com o nome sem esse prefixo. <info>EXTR_REFS</info> Extrai
                   variáveis como referências, ou seja, os valores das variáveis importadas ainda
                   estarão referenciando os valores do parâmetro <strong>$array</strong>. Essa opção pode ser usada
                   sozinha ou em conjunto com as outras usando o operador 'ou' em <strong>$flags</strong>.
                   
                   Se houver uma colisão, sobrescreve a variável existente.
                   
                   Se houver uma colisão, não sobrescreve a variável existente.
                   
                   Se houver uma colisão, adiciona um prefixo ao nome da variável definido pelo
                   argumento <strong>$prefix</strong>.
                   
                   Adiciona um prefixo ao nome de todas as variáveis definido por <strong>$prefix</strong>.
                   
                   Adiciona um prefixo definido por <strong>$prefix</strong> apenas para variáveis como nomes
                   inválidos ou numéricos.
                   
                   Só sobrescreve a variável se ela já existe na tabela de símbolos corrente, caso
                   contrário, não faz nada. Isso é útil quando se quer definir uma lista de
                   variáveis válidas e então extrair só as que foram definidas em $_REQUEST, por
                   exemplo.
                   
                   Só cria nomes de variáveis usando o prefixo se na tabela de símbolos já existe
                   uma variável com o nome sem esse prefixo.
                   
                   Extrai variáveis como referências, ou seja, os valores das variáveis importadas
                   ainda estarão referenciando os valores do parâmetro <strong>$array</strong>. Essa opção pode ser
                   usada sozinha ou em conjunto com as outras usando o operador 'ou' em <strong>$flags</strong>.
                   
                   Se <strong>$flags</strong> não for especificado, é assumido o valor <info>EXTR_OVERWRITE</info>.
  <info>string</info>  <strong>$prefix</strong>  Se houver uma colisão, adiciona um prefixo ao nome da variável definido pelo
                   argumento <strong>$prefix</strong>.
  <info>string</info>  <strong>$prefix</strong>  Adiciona um prefixo ao nome de todas as variáveis definido por <strong>$prefix</strong>.
  <info>string</info>  <strong>$prefix</strong>  Adiciona um prefixo definido por <strong>$prefix</strong> apenas para variáveis como nomes
                   inválidos ou numéricos.
  <info>array</info>   <strong>$array</strong>   Extrai variáveis como referências, ou seja, os valores das variáveis importadas
                   ainda estarão referenciando os valores do parâmetro <strong>$array</strong>. Essa opção pode ser
                   usada sozinha ou em conjunto com as outras usando o operador 'ou' em <strong>$flags</strong>.
  <info>string</info>  <strong>$prefix</strong>  Note que <strong>$prefix</strong> só é necessário se <strong>$flags</strong> for <info>EXTR_PREFIX_SAME</info>, <info>EXTR_PREFIX_ALL</info>,
                   ou <info>EXTR_PREFIX_INVALID</info> ou <info>EXTR_PREFIX_IF_EXISTS</info>. Se o nome com o prefixo não for
                   um nome de variável válido, ela não será importada para a tabela de símbolos.
                   Prefixos são automaticamente separados da chave do array pelo caractere
                   underscore.

<comment>Return:</comment>
  <info>int</info>  Retorna o número de variáveis importadas com sucesso para a tabela de símbolo.

<comment>See Also:</comment>
   * <strong>compact()</strong>
   * <strong>list()</strong>


id: ezmlm_hash
type: function
doc:
<comment>Description:</comment>
  Calcula o valor do hash necessário para EZMLM
  
  <strong>ezmlm_hash()</strong> calcula valor do hash necessário ao se manter listas de e-mail EZMLM num banco de
  dados MySQL.

<comment>Param:</comment>
  <info>string</info>  <strong>$addr</strong>  O endereço de e-mail para o qual está sendo calculado o hash.

<comment>Return:</comment>
  <info>int</info>  O valor do hash de <strong>$addr</strong>.


id: fann_cascadetrain_on_data
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset, for a period of time using the Cascade2 training algorithm
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate.  If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  This training uses the parameters set using the fann_set_cascade_..., but it also uses another
  training algorithm as it’s internal training algorithm. This algorithm can be set to either
  <info>FANN_TRAIN_RPROP</info> or <info>FANN_TRAIN_QUICKPROP</info> by <strong>fann_set_training_algorithm()</strong>, and the parameters set
  for these training algorithms will also affect the cascade training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$data</strong>                     <info>resource</info> dos dados de treinamento da rede neural.
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network.
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_file()</strong>


id: fann_cascadetrain_on_file
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset read from file, for a period of time using the Cascade2 training
  algorithm
  
  Does the same as <strong>fann_cascadetrain_on_data()</strong>, but reads the training data directly from a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      <info>resource</info> da rede neural.
  <info>string</info>    <strong>$filename</strong>                 A file containing the data for training.
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_data()</strong>


id: fann_clear_scaling_params
type: function
doc:
<comment>Description:</comment>
  Clears scaling parameters
  
  Clears scaling parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

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


id: fann_copy
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a fann structure
  
  Creates a copy of a fann structure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>resource</info>  Returns a copy of neural network resource on success, or <info>false</info> on error

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


id: fann_create_from_file
type: function
doc:
<comment>Description:</comment>
  Constructs a backpropagation neural network from a configuration file
  
  Constructs a backpropagation neural network from a configuration file, which have been saved by
  <strong>fann_save()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$configuration_file</strong>  The configuration file path.

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de rede neural em caso de sucesso ou <info>false</info> em caso de erro.

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


id: fann_create_shortcut
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections
  
  Creates a standard backpropagation neural network, which is not fully connected and which also has
  shortcut connections.
  
  Shortcut connections are connections that skip layers. A fully connected network with shortcut
  connections, is a network where all neurons are connected to all neurons in later layers.
  Including direct connections from the input layer to the output layer.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_shortcut_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections
  
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections using an array of layers sizes.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>      An array of layers sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_sparse
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected
  
  Creates a standard backpropagation neural network, which is not fully connected.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>int</info>    <strong>$num_neurons1</strong>     Number of neurons in the first layer.
  <info>int</info>    <strong>$num_neurons2</strong>     Number of neurons in the second layer.
  <info>int</info>    <strong>$num_neuronsN</strong>     Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse_array()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_sparse_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes
  
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>           An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network using an array of layer sizes
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>      An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_train
type: function
doc:
<comment>Description:</comment>
  Creates an empty training data struct
  
  Creates an empty training data struct.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_data</strong>    The number of training data
  <info>int</info>  <strong>$num_input</strong>   The number of inputs per training data
  <info>int</info>  <strong>$num_output</strong>  The number of ouputs per training data

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de dados de treinamento em caso de sucesso ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_create_train_from_callback
type: function
doc:
<comment>Description:</comment>
  Creates the training data struct from a user supplied function
  
  Creates the training data struct from a user supplied function. As the training data are numerable
  (data 1, data 2...), the user must write a function that receives the number of the training data
  set (input, output) and returns the set.

<comment>Param:</comment>
  <info>int</info>       <strong>$num_data</strong>       The number of training data
  <info>int</info>       <strong>$num_input</strong>      The number of inputs per training data
  <info>int</info>       <strong>$num_output</strong>     The number of ouputs per training data
  <info>callable</info>  <strong>$user_function</strong>  The user supplied function with following parameters: <return>num</return> - The number
                            of the training data set<return>num_input</return> - The number of inputs per training
                            data<return>num_output</return> - The number of ouputs per training data
                            
                            The function should return an associative array with keys <return>input</return> and
                            <return>output</return> and two array values of input and output.

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de dados de treinamento em caso de sucesso ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_descale_input
type: function
doc:
<comment>Description:</comment>
  Scale data in input vector after get it from ann based on previously calculated parameters
  
  Scale data in input vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           <info>resource</info> da rede neural.
  <info>array</info>     <strong>$input_vector</strong>  Input vector that will be descaled

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

<comment>See Also:</comment>
   * <strong>fann_scale_input()</strong>
   * <strong>fann_descale_output()</strong>


id: fann_descale_output
type: function
doc:
<comment>Description:</comment>
  Scale data in output vector after get it from ann based on previously calculated parameters
  
  Scale data in output vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            <info>resource</info> da rede neural.
  <info>array</info>     <strong>$output_vector</strong>  Output vector that will be descaled

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

<comment>See Also:</comment>
   * <strong>fann_scale_output()</strong>
   * <strong>fann_descale_input()</strong>


id: fann_descale_train
type: function
doc:
<comment>Description:</comment>
  Descale input and output data based on previously calculated parameters
  
  Descale input and output data based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

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

<comment>See Also:</comment>
   * <strong>fann_scale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_destroy
type: function
doc:
<comment>Description:</comment>
  Destroys the entire network and properly freeing all the associated memory
  
  Destroys the entire network and properly freeing all the associated memory.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

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


id: fann_destroy_train
type: function
doc:
<comment>Description:</comment>
  Destructs the training data
  
  Destructs the training data

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

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


id: fann_duplicate_train_data
type: function
doc:
<comment>Description:</comment>
  Returns an exact copy of a fann train data
  
  Returns an exact copy of a fann train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de dados de treinamento em caso de sucesso ou <info>false</info> em caso de erro.


id: fann_get_MSE
type: function
doc:
<comment>Description:</comment>
  Reads the mean square error from the network
  
  Reads the mean square error from the network.
  
  Reads the mean square error from the network. This value is calculated during training or testing
  and can therefore sometimes be a bit off if the weights have been changed since the last
  calculation of the value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The mean square error, or <info>false</info> on error.

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


id: fann_get_activation_function
type: function
doc:
<comment>Description:</comment>
  Returns the activation function
  
  Get the activation function for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation functions for the neurons in the input layer.
  
  The return value is one of the activation functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     <info>resource</info> da rede neural.
  <info>int</info>       <strong>$layer</strong>   Layer number.
  <info>int</info>       <strong>$neuron</strong>  Neuron number.

<comment>Return:</comment>
  <info>int</info>  Learning functions constant or -1 if the neuron is not defined in the neural network, or
       <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_get_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Returns the activation steepness for supplied neuron and layer number
  
  Get the activation steepness for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation steepness for the neurons in the input layer.
  
  The steepness of an activation function says something about how fast the activation function goes
  from the minimum to the maximum.  A high value for the activation function will also give a more
  aggressive training.
  
  When training neural networks where the output values should be at the extremes (usually 0 and 1,
  depending on the activation function), a steep activation function can be used (e.g.  1.0).
  
  The default activation steepness is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     <info>resource</info> da rede neural.
  <info>int</info>       <strong>$layer</strong>   Layer number
  <info>int</info>       <strong>$neuron</strong>  Neuron number

<comment>Return:</comment>
  <info>float</info>  The activation steepness for the neuron or -1 if the neuron is not defined in the neural
         network, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_get_bias_array
type: function
doc:
<comment>Description:</comment>
  Get the number of bias in each layer in the network
  
  Get the number of bias in each layer in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>array</info>  An array of numbers of bias in each layer


id: fann_get_bit_fail
type: function
doc:
<comment>Description:</comment>
  The number of fail bits
  
  The number of fail bits; means the number of output neurons which differ more than the bit fail
  limit (see <strong>fann_get_bit_fail_limit()</strong>, <strong>fann_set_bit_fail_limit()</strong>). The bits are counted in all of
  the training data, so this number can be higher than the number of training data.
  
  This value is reset by <strong>fann_reset_MSE()</strong> and updated by all the same functions which also updates
  the MSE value (e.g. <strong>fann_test_data()</strong>, <strong>fann_train_epoch()</strong>)

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of bits fail, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_reset_MSE()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>
   * <strong>fann_set_bit_fail_limit()</strong>


id: fann_get_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Returns the bit fail limit used during training
  
  Returns the bit fail limit used during training.
  
  The bit fail limit is used during training where the stop function is set to <info>FANN_STOPFUNC_BIT</info>.
  
  The limit is the maximum accepted difference between the desired output and the actual output
  during training. Each output that diverges more than this limit is counted as an error bit. This
  difference is divided by two when dealing with symmetric activation functions, so that symmetric
  and not symmetric activation functions can use the same limit.
  
  The default bit fail limit is 0.35.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The bit fail limit, or <info>false</info> on error.

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


id: fann_get_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation functions
  
  The cascade activation functions array is an array of the different activation functions used by
  the candidates
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation functions are <info>FANN_SIGMOID</info>, <info>FANN_SIGMOID_SYMMETRIC</info>, <info>FANN_GAUSSIAN</info>,
  <info>FANN_GAUSSIAN_SYMMETRIC</info>, <info>FANN_ELLIOT</info>, <info>FANN_ELLIOT_SYMMETRIC</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>array</info>  The cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_functions_count
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade activation functions
  
  The number of activation functions in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation functions is 6.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation steepnesses
  
  The cascade activation steepnesses array is an array of the different activation functions used by
  the candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>array</info>  The cascade activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_set_cascade_activation_steepnesses()</strong>


id: fann_get_cascade_activation_steepnesses_count
type: function
doc:
<comment>Description:</comment>
  The number of activation steepnesses
  
  The number of activation steepnesses in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation steepnesses is 4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade candidate change fraction
  
  The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>
  during training of the candidate neurons, in order for the training not to stagnate. If the
  training stagnates, the training of the candidate neurons will be ended and the best candidate
  will be selected.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>, the training of the candidate neurons is stopped
  because the training has stagnated.
  
  If the cascade candidate change fraction is low, the candidate neurons will be trained more and if
  the fraction is high they will be trained less.
  
  The default cascade candidate change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The cascade candidate change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>


id: fann_get_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Return the candidate limit
  
  The candidate limit is a limit for how much the candidate neuron may be trained. The limit is a
  limit on the proportion between the MSE and candidate score.
  
  Set this to a lower value to avoid overfitting and to a higher if overfitting is not a problem.
  
  The default candidate limit is 1000.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The candidate limit, or <info>false</info> on error.

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


id: fann_get_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade candidate stagnation epochs
  
  The number of cascade candidate stagnation epochs determines the number of epochs training is
  allowed to continue without changing the MSE by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  The default number of cascade candidate stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of cascade candidate stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_candidate_change_fraction()</strong>


id: fann_get_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum candidate epochs
  
  The maximum candidate epochs determines the maximum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default max candidate epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The maximum candidate epochs, or <info>false</info> on error.

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


id: fann_get_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum out epochs
  
  The maximum out epochs determines the maximum number of epochs the output connections may be
  trained after adding a new candidate neuron.
  
  The default max out epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The maximum out epochs, or <info>false</info> on error.

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


id: fann_get_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum candidate epochs
  
  The minimum candidate epochs determines the minimum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default min candidate epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The minimum candidate epochs, or <info>false</info> on error.

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


id: fann_get_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum out epochs
  
  The minimum out epochs determines the minimum number of epochs the output connections must be
  trained after adding a new candidate neuron.
  
  The default min out epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The minimum out epochs, or <info>false</info> on error.

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


id: fann_get_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidate groups
  
  The number of candidate groups is the number of groups of identical candidates which will be used
  during training.
  
  This number can be used to have more candidates without having to define new parameters for the
  candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this parameter.
  
  The default number of candidate groups is 2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of candidate groups, or <info>false</info> on error.

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


id: fann_get_cascade_num_candidates
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidates used during training
  
  The number of candidates used during training (calculated by multiplying
  <strong>fann_get_cascade_activation_functions_count()</strong>, <strong>fann_get_cascade_activation_steepnesses_count()</strong> and
  <strong>fann_get_cascade_num_candidate_groups()</strong>).
  
  The actual candidates is defined by the <strong>fann_get_cascade_activation_functions()</strong> and
  <strong>fann_get_cascade_activation_steepnesses()</strong> arrays. These arrays define the activation functions and
  activation steepnesses used for the candidate neurons. If there are 2 activation functions in the
  activation function array and 3 steepnesses in the steepness array, then there will be 2x3=6
  different candidates which will be trained. These 6 different candidates can be copied into
  several candidate groups, where the only difference between these groups is the initial weights.
  If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12. The
  number of candidate groups is defined by <strong>fann_set_cascade_num_candidate_groups()</strong>.
  
  The default number of candidates is 6x4x2 = 48

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of candidates used during training, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_get_cascade_num_candidate_groups()</strong>


id: fann_get_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade output change fraction
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction of
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate. If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_output_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_output_stagnation_epochs()</strong>, the training of the output connections is stopped
  because the training has stagnated.
  
  If the cascade output change fraction is low, the output connections will be trained more and if
  the fraction is high, they will be trained less.
  
  The default cascade output change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The cascade output change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_output_stagnation_epochs()</strong>


id: fann_get_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade output stagnation epochs
  
  The number of cascade output stagnation epochs determines the number of epochs training is allowed
  to continue without changing the MSE by a fraction of <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  The default number of cascade output stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of cascade output stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_output_change_fraction()</strong>


id: fann_get_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Returns the weight multiplier
  
  The weight multiplier is a parameter which is used to multiply the weights from the candidate
  neuron before adding the neuron to the neural network. This parameter is usually between 0 and 1,
  and is used to make the training a bit less aggressive.
  
  The default weight multiplier is 0.4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The weight multiplier, or <info>false</info> on error.

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


id: fann_get_connection_array
type: function
doc:
<comment>Description:</comment>
  Get connections in the network
  
  Get connections in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>array</info>  An array of connections in the network


id: fann_get_connection_rate
type: function
doc:
<comment>Description:</comment>
  Get the connection rate used when the network was created
  
  Get the connection rate used when the network was created.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The connection rate used when the network was created, or <info>false</info> on error.


id: fann_get_errno
type: function
doc:
<comment>Description:</comment>
  Returns the last error number
  
  Returns the last error number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                     neural.

<comment>Return:</comment>
  <info>int</info>  The error number, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_reset_errno()</strong>
   * <strong>fann_get_errstr()</strong>


id: fann_get_errstr
type: function
doc:
<comment>Description:</comment>
  Returns the last errstr
  
  Returns the last errstr.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                     neural.

<comment>Return:</comment>
  <info>string</info>  The last error string, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_reset_errstr()</strong>
   * <strong>fann_get_errno()</strong>


id: fann_get_layer_array
type: function
doc:
<comment>Description:</comment>
  Get the number of neurons in each layer in the network
  
  Get the number of neurons in each layer in the neural network.
  
  Bias is not included so the layers match the fann_create functions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>array</info>  An array of numbers of neurons in each leayer


id: fann_get_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Returns the learning momentum
  
  The learning momentum can be used to speed up <info>FANN_TRAIN_INCREMENTAL</info> training. A too high momentum
  will however not benefit training. Setting momentum to 0 will be the same as not using the
  momentum parameter. The recommended value of this parameter is between 0.0 and 1.0.
  
  The default momentum is 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> caso contrário.
         
         The learning momentum, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_learning_rate
type: function
doc:
<comment>Description:</comment>
  Returns the learning rate
  
  The learning rate is used to determine how aggressive training should be for some of the training
  algorithms (<info>FANN_TRAIN_INCREMENTAL</info>, <info>FANN_TRAIN_BATCH</info>, <info>FANN_TRAIN_QUICKPROP</info>). Do however note that
  it is not used in <info>FANN_TRAIN_RPROP</info>.
  
  The default learning rate is 0.7.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The learning rate, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_network_type
type: function
doc:
<comment>Description:</comment>
  Get the type of neural network it was created as
  
  Get the type of neural network it was created as.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Network type constant, or <info>false</info> on error.


id: fann_get_num_input
type: function
doc:
<comment>Description:</comment>
  Get the number of input neurons
  
  Get the number of input neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Number of input neurons, or <info>false</info> on error


id: fann_get_num_layers
type: function
doc:
<comment>Description:</comment>
  Get the number of layers in the neural network
  
  Get the number of layers in the neural network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of leayers in the neural network, or <info>false</info> on error.


id: fann_get_num_output
type: function
doc:
<comment>Description:</comment>
  Get the number of output neurons
  
  Get the number of output neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Number of output neurons, or <info>false</info> on error


id: fann_get_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Returns the decay which is a factor that weights should decrease in each iteration during
  quickprop
  training
  
  The decay is a small negative valued number which is a factor that the weights should decrease in
  each iteration during quickprop training. This is used to make sure that the weights do not become
  too high during training.
  
  The default decay is -0.0001.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The decay, or <info>false</info> on error.

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


id: fann_get_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Returns the mu factor
  
  The mu factor is used to increase and decrease the step-size during quickprop training. The mu
  factor should always be above 1, since it would otherwise decrease the step-size when it was
  suppose to increase it.
  
  The default mu factor is 1.75.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The mu factor, or <info>false</info> on error.

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


id: fann_get_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Returns the increase factor used during RPROP training
  
  The decrease factor is a value smaller than 1, which is used to decrease the step-size during
  RPROP training.
  
  The default decrease factor is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The decrease factor, or <info>false</info> on error.

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


id: fann_get_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Returns the maximum step-size
  
  The maximum step-size is a positive number determining how large the maximum step-size may be.
  
  The default delta max is 50.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The maximum step-size, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_get_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Returns the minimum step-size
  
  The minimum step-size is a small positive number determining how small the minimum step-size may
  be.
  
  The default value delta min is 0.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The minimum step-size, or <info>false</info> on error.

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


id: fann_get_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Returns the initial step-size
  
  The initial step-size is a positive number determining the initial step size.
  
  The default delta zero is 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The initial step-size, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_get_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Returns the increase factor used during RPROP training
  
  The increase factor is a value larger than 1, which is used to increase the step-size during RPROP
  training.
  
  The default increase factor is 1.2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The increase factor, or <info>false</info> on error.

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


id: fann_get_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop step error shift
  
  Returns the sarprop step error shift.
  
  The default step error shift is 1.385.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The sarprop step error shift , or <info>false</info> on error.

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


id: fann_get_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop step error threshold factor
  
  The sarprop step error threshold factor.
  
  The default factor is 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The sarprop step error threshold factor, or <info>false</info> on error.

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


id: fann_get_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop temperature
  
  Returns the sarprop temperature.
  
  The default temperature is 0.015.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The sarprop temperature, or <info>false</info> on error.

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


id: fann_get_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Returns the sarprop weight decay shift
  
  The sarprop weight decay shift.
  
  The default delta max is -6.644.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>float</info>  The sarprop weight decay shift, or <info>false</info> on error.

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


id: fann_get_total_connections
type: function
doc:
<comment>Description:</comment>
  Get the total number of connections in the entire network
  
  Get the total number of connections in the entire network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Total number of connections in the entire network, or <info>false</info> on error


id: fann_get_total_neurons
type: function
doc:
<comment>Description:</comment>
  Get the total number of neurons in the entire network
  
  Get the total number of neurons in the entire network. This number does also include the bias
  neurons, so a 2-4-2 network has 2+4+2 +2(bias) = 10 neurons.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Total number of neurons in the entire network, or <info>false</info> on error.


id: fann_get_train_error_function
type: function
doc:
<comment>Description:</comment>
  Returns the error function used during training
  
  Returns the error function used during training.
  
  The error functions are described further in error functions constants.
  
  The default error function is <info>FANN_ERRORFUNC_TANH</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The error function constant, or <info>false</info> on error.

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


id: fann_get_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Returns the stop function used during training
  
  Returns the stop function used during training.
  
  The stop functions are described further in stop functions constants.
  
  The default stop function is <info>FANN_STOPFUNC_MSE</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  The stop function constant, or <info>false</info> on error.

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


id: fann_get_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Returns the training algorithm
  
  Returns the training algorithm. This training algorithm is used by <strong>fann_train_on_data()</strong> and
  associated functions.
  
  Note that this algorithm is also used during <strong>fann_cascadetrain_on_data()</strong>, although only
  <info>FANN_TRAIN_RPROP</info> and <info>FANN_TRAIN_QUICKPROP</info> is allowed during cascade training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

<comment>Return:</comment>
  <info>int</info>  Training algorithm constant, or <info>false</info> on error.

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


id: fann_init_weights
type: function
doc:
<comment>Description:</comment>
  Initialize the weights using Widrow + Nguyen’s algorithm
  
  Initialize the weights using Widrow + Nguyen’s algorithm.
  
  This function behaves similarly to <strong>fann_randomize_weights()</strong>. It will use the algorithm developed
  by Derrick Nguyen and Bernard Widrow to set the weights in such a way as to speed up training.
  This technique is not always successful, and in some cases can be less efficient than a purely
  random initialization.
  
  The algorithm requires access to the range of the input data (for example largest and smallest
  input), and therefore accepts a second argument, data, which is the training data that will be
  used to train the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

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

<comment>See Also:</comment>
   * <strong>fann_randomize_weights()</strong>
   * <strong>fann_read_train_from_file()</strong>


id: fann_length_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of training patterns in the train data
  
  Returns the number of training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>int</info>  Number of elements in the train data <info>resource</info>, or <info>false</info> on error.


id: fann_merge_train_data
type: function
doc:
<comment>Description:</comment>
  Merges the train data
  
  Merges the data from data1 and data2 into a new train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data1</strong>  <info>resource</info> dos dados de treinamento da rede neural.
  <info>resource</info>  <strong>$data2</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>resource</info>  New merged train data <info>resource</info>, or <info>false</info> on error.


id: fann_num_input_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of inputs in each of the training patterns in the train data
  
  Returns the number of inputs in each of the training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of inputs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_output_train_data()</strong>


id: fann_num_output_train_data
type: function
doc:
<comment>Description:</comment>
  Returns the number of outputs in each of the training patterns in the train data
  
  Returns the number of outputs in each of the training patterns in the train data <info>resource</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>int</info>  The number of outputs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_input_train_data()</strong>


id: fann_print_error
type: function
doc:
<comment>Description:</comment>
  Prints the error string
  
  Prints the error string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                     neural.

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

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


id: fann_randomize_weights
type: function
doc:
<comment>Description:</comment>
  Give each connection a random weight between min_weight and max_weight
  
  Give each connection a random weight between <strong>$min_weight</strong> and <strong>$max_weight</strong>
  
  From the beginning the weights are random between -0.1 and 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         <info>resource</info> da rede neural.
  <info>float</info>     <strong>$min_weight</strong>  Minimum weight value
  <info>float</info>     <strong>$max_weight</strong>  Maximum weight value

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

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


id: fann_read_train_from_file
type: function
doc:
<comment>Description:</comment>
  Reads a file that stores training data
  
  Reads a file that stores training data.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The input file in the following format:

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de dados de treinamento em caso de sucesso ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_reset_MSE
type: function
doc:
<comment>Description:</comment>
  Resets the mean square error from the network
  
  Resets the mean square error from the network.
  
  This function also resets the number of bits that fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$ann</strong>  <info>resource</info> da rede neural.

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

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>


id: fann_reset_errno
type: function
doc:
<comment>Description:</comment>
  Resets the last error number
  
  Resets the last error number.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                     neural.

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

<comment>See Also:</comment>
   * <strong>fann_get_errno()</strong>
   * <strong>fann_reset_errstr()</strong>


id: fann_reset_errstr
type: function
doc:
<comment>Description:</comment>
  Resets the last error string
  
  Resets the last error string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                     neural.

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

<comment>See Also:</comment>
   * <strong>fann_get_errstr()</strong>
   * <strong>fann_reset_errno()</strong>


id: fann_run
type: function
doc:
<comment>Description:</comment>
  Will run input through the neural network
  
  Will run input through the neural network, returning an array of outputs, the number of which
  being equal to the number of neurons in the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>    <info>resource</info> da rede neural.
  <info>array</info>     <strong>$input</strong>  Array of input values

<comment>Return:</comment>
  <info>array</info>  Array of output values, or <info>false</info> on error


id: fann_save
type: function
doc:
<comment>Description:</comment>
  Saves the entire network to a configuration file
  
  Saves the entire network to a configuration file.
  
  The configuration file contains all information about the neural network and enables
  <strong>fann_create_from_file()</strong> to create an exact copy of the neural network and all of the parameters
  associated with the neural network.
  
  These three parameters (<strong>fann_set_callback()</strong>, <strong>fann_set_error_log()</strong>, <strong>fann_set_user_data()</strong>) are NOT
  saved to the file because they cannot safely be ported to a different location. Also temporary
  parameters generated during training like <strong>fann_get_MSE()</strong> is not saved.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 <info>resource</info> da rede neural.
  <info>string</info>    <strong>$configuration_file</strong>  The configuration file path.

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

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


id: fann_save_train
type: function
doc:
<comment>Description:</comment>
  Save the training structure to a file
  
  Save the training data to a file, with the format as specified in <strong>fann_read_train_from_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>       <info>resource</info> dos dados de treinamento da rede neural.
  <info>string</info>    <strong>$file_name</strong>  The file name of the file where training data is saved to.

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

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


id: fann_scale_input
type: function
doc:
<comment>Description:</comment>
  Scale data in input vector before feed it to ann based on previously calculated parameters
  
  Scale data in input vector before feed it to ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           <info>resource</info> da rede neural.
  <info>array</info>     <strong>$input_vector</strong>  Input vector that will be scaled

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

<comment>See Also:</comment>
   * <strong>fann_descale_input()</strong>
   * <strong>fann_scale_output()</strong>


id: fann_scale_input_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the inputs in the training data to the specified range
  
  Scales the inputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling inputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling inputs in training data.

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

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_output
type: function
doc:
<comment>Description:</comment>
  Scale data in output vector before feed it to ann based on previously calculated parameters
  
  Scale data in output vector before feed it to ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            <info>resource</info> da rede neural.
  <info>array</info>     <strong>$output_vector</strong>  Output vector that will be scaled

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

<comment>See Also:</comment>
   * <strong>fann_descale_output()</strong>
   * <strong>fann_scale_input()</strong>


id: fann_scale_output_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the outputs in the training data to the specified range
  
  Scales the outputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling outputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling outputs in training data.

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

<comment>See Also:</comment>
   * <strong>fann_scale_input_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_train
type: function
doc:
<comment>Description:</comment>
  Scale input and output data based on previously calculated parameters
  
  Scale input and output data based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

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

<comment>See Also:</comment>
   * <strong>fann_descale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_scale_train_data
type: function
doc:
<comment>Description:</comment>
  Scales the inputs and outputs in the training data to the specified range
  
  Scales the inputs and outputs in the training data to the specified range.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_min</strong>     New minimum after scaling inputs and outputs in training data.
  <info>float</info>     <strong>$new_max</strong>     New maximum after scaling inputs and outputs in training data.

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

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_input_train_data()</strong>


id: fann_set_activation_function
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for supplied neuron and layer
  
  Set the activation function for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation functions for the neurons in the input layer.
  
  When choosing an activation function it is important to note that the activation functions have
  different range. <info>FANN_SIGMOID</info> is e.g. in the 0 - 1 range while <info>FANN_SIGMOID_SYMMETRIC</info> is in the -1
  - 1 range and <info>FANN_LINEAR</info> is unbound.
  
  The supplied activation_function value must be one of the activation functions constants.
  
  The return value is one of the activation functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  <info>resource</info> da rede neural.
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.
  <info>int</info>       <strong>$layer</strong>                Layer number.
  <info>int</info>       <strong>$neuron</strong>               Neuron number.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_get_activation_function()</strong>


id: fann_set_activation_function_hidden
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for all of the hidden layers
  
  Sets the activation function for all of the hidden layers.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  <info>resource</info> da rede neural.
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_layer
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for all the neurons in the supplied layer
  
  Set the activation function for all the neurons in the layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation functions for the neurons in the input layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  <info>resource</info> da rede neural.
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.
  <info>int</info>       <strong>$layer</strong>                Layer number.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_output
type: function
doc:
<comment>Description:</comment>
  Sets the activation function for the output layer
  
  Sets the activation function for the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  <info>resource</info> da rede neural.
  <info>int</info>       <strong>$activation_function</strong>  The activation functions constant.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Sets the activation steepness for supplied neuron and layer number
  
  Set the activation steepness for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation steepness for the neurons in the input layer.
  
  The steepness of an activation function says something about how fast the activation function goes
  from the minimum to the maximum. A high value for the activation function will also give a more
  aggressive training.
  
  When training neural networks where the output values should be at the extremes (usually 0 and 1,
  depending on the activation function), a steep activation function can be used (e.g.  1.0).
  
  The default activation steepness is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   <info>resource</info> da rede neural.
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.
  <info>int</info>       <strong>$layer</strong>                 Layer number.
  <info>int</info>       <strong>$neuron</strong>                Neuron number.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_hidden
type: function
doc:
<comment>Description:</comment>
  Sets the steepness of the activation steepness for all neurons in the all hidden layers
  
  Sets the steepness of the activation steepness for all neurons in the all hidden layers.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   <info>resource</info> da rede neural.
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_layer
type: function
doc:
<comment>Description:</comment>
  Sets the activation steepness for all of the neurons in the supplied layer number
  
  Set the activation steepness for all of the neurons in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to set activation steepness for the neurons in the input layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   <info>resource</info> da rede neural.
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.
  <info>int</info>       <strong>$layer</strong>                 Layer number.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_output
type: function
doc:
<comment>Description:</comment>
  Sets the steepness of the activation steepness in the output layer
  
  Sets the steepness of the activation steepness in the output layer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   <info>resource</info> da rede neural.
  <info>float</info>     <strong>$activation_steepness</strong>  The activation steepness.

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

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Set the bit fail limit used during training
  
  Set the bit fail limit used during training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>float</info>     <strong>$bit_fail_limit</strong>  The bit fail limit.

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

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


id: fann_set_callback
type: function
doc:
<comment>Description:</comment>
  Sets the callback function for use during training
  
  Sets the callback function for use during training. It means that it is called from
  <strong>fann_train_on_data()</strong> or <strong>fann_train_on_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>       <info>resource</info> da rede neural.
  <info>callable</info>  <strong>$callback</strong>  The supplied callback function takes following parameters: <return>ann</return> - The neural
                       network <info>resource</info><return>train</return> - The train data <info>resource</info> or <info>null</info> if called from
                       <strong>fann_train_on_file()</strong><return>max_epochs</return> - The maximum number of epochs the training
                       should continue<return>epochs_between_reports</return> - The number of epochs between calling
                       this function<return>desired_error</return> - The desired <strong>fann_get_MSE()</strong> or
                       <strong>fann_get_bit_fail()</strong>, depending on the stop function chosen by
                       <strong>fann_set_train_stop_function()</strong><return>epochs</return> - The current epoch
                       
                       The callback should return <info>true</info>. If it returns <info>false</info>, the training will
                       terminate.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_on_file()</strong>


id: fann_set_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Sets the array of cascade candidate activation functions
  
  Sets the array of cascade candidate activation functions.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           <info>resource</info> da rede neural.
  <info>array</info>     <strong>$cascade_activation_functions</strong>  The array of cascade candidate activation functions.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_set_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Sets the array of cascade candidate activation steepnesses
  
  Sets the array of cascade candidate activation steepnesses.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                   <info>resource</info> da rede neural.
  <info>array</info>     <strong>$cascade_activation_steepnesses_count</strong>  The array of cascade candidate activation
                                                   steepnesses.

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

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>


id: fann_set_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Sets the cascade candidate change fraction
  
  Sets the cascade candidate change fraction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                <info>resource</info> da rede neural.
  <info>float</info>     <strong>$cascade_candidate_change_fraction</strong>  The cascade candidate change fraction.

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

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


id: fann_set_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Sets the candidate limit
  
  Sets the candidate limit.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      <info>resource</info> da rede neural.
  <info>float</info>     <strong>$cascade_candidate_limit</strong>  The candidate limit.

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

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


id: fann_set_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the number of cascade candidate stagnation epochs
  
  Sets the number of cascade candidate stagnation epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_candidate_stagnation_epochs</strong>  The number of cascade candidate stagnation epochs.

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

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


id: fann_set_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the max candidate epochs
  
  Sets the max candidate epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_max_cand_epochs</strong>  The max candidate epochs.

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

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


id: fann_set_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the maximum out epochs
  
  Sets the maximum out epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_max_out_epochs</strong>  The maximum out epochs.

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

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


id: fann_set_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the min candidate epochs
  
  Sets the min candidate epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_min_cand_epochs</strong>  The minimum candidate epochs.

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

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


id: fann_set_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the minimum out epochs
  
  Sets the minimum out epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_min_out_epochs</strong>  The minimum out epochs.

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

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


id: fann_set_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Sets the number of candidate groups
  
  Sets the number of candidate groups.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_num_candidate_groups</strong>  The number of candidate groups.

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

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


id: fann_set_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Sets the cascade output change fraction
  
  Sets the cascade output change fraction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                             <info>resource</info> da rede neural.
  <info>float</info>     <strong>$cascade_output_change_fraction</strong>  The cascade output change fraction.

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

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


id: fann_set_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Sets the number of cascade output stagnation epochs
  
  Sets the number of cascade output stagnation epochs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                               <info>resource</info> da rede neural.
  <info>int</info>       <strong>$cascade_output_stagnation_epochs</strong>  The number of cascade output stagnation epochs.

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

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


id: fann_set_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Sets the weight multiplier
  
  Sets the weight multiplier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                        <info>resource</info> da rede neural.
  <info>float</info>     <strong>$cascade_weight_multiplier</strong>  The weight multiplier.

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

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


id: fann_set_error_log
type: function
doc:
<comment>Description:</comment>
  Sets where the errors are logged to
  
  Sets where the errors are logged to.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>    Um <info>resource</info> de rede neural ou um <info>resource</info> de dados de treinamento da rede
                       neural.
  <info>string</info>    <strong>$log_file</strong>  The log file path.

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


id: fann_set_input_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate input scaling parameters for future use based on training data
  
  Calculate input scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>     <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_input_min</strong>  The desired lower bound in input data after scaling (not strictly
                            followed)
  <info>float</info>     <strong>$new_input_max</strong>  The desired upper bound in input data after scaling (not strictly
                            followed)

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

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


id: fann_set_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Sets the learning momentum
  
  Sets the learning momentum.
  
  More info available in <strong>fann_get_learning_momentum()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                <info>resource</info> da rede neural.
  <info>float</info>     <strong>$learning_momentum</strong>  The learning momentum.

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

<comment>See Also:</comment>
   * <strong>fann_get_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_learning_rate
type: function
doc:
<comment>Description:</comment>
  Sets the learning rate
  
  Sets the learning rate.
  
  More info available in <strong>fann_get_learning_rate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            <info>resource</info> da rede neural.
  <info>float</info>     <strong>$learning_rate</strong>  The learning rate.

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

<comment>See Also:</comment>
   * <strong>fann_get_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_output_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate output scaling parameters for future use based on training data
  
  Calculate output scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>      <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_output_min</strong>  The desired lower bound in output data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_max</strong>  The desired upper bound in output data after scaling (not strictly
                             followed)

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

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


id: fann_set_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Sets the quickprop decay factor
  
  Sets the quickprop decay factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              <info>resource</info> da rede neural.
  <info>float</info>     <strong>$quickprop_decay</strong>  The quickprop decay factor.

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

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


id: fann_set_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Sets the quickprop mu factor
  
  Sets the quickprop mu factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           <info>resource</info> da rede neural.
  <info>float</info>     <strong>$quickprop_mu</strong>  The mu factor.

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

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


id: fann_set_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Sets the decrease factor used during RPROP training
  
  Sets the decrease factor used during RPROP training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    <info>resource</info> da rede neural.
  <info>float</info>     <strong>$rprop_decrease_factor</strong>  The decrease factor.

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

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


id: fann_set_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Sets the maximum step-size
  
  The maximum step-size is a positive number determining how large the maximum step-size may be.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              <info>resource</info> da rede neural.
  <info>float</info>     <strong>$rprop_delta_max</strong>  The maximum step-size.

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

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_set_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Sets the minimum step-size
  
  The minimum step-size is a small positive number determining how small the minimum step-size may
  be.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              <info>resource</info> da rede neural.
  <info>float</info>     <strong>$rprop_delta_min</strong>  The minimum step-size.

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

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


id: fann_set_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Sets the initial step-size
  
  The initial step-size is a positive number determining the initial step size.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>               <info>resource</info> da rede neural.
  <info>float</info>     <strong>$rprop_delta_zero</strong>  The initial step-size.

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

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_set_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Sets the increase factor used during RPROP training
  
  Sets the increase factor used during RPROP training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    <info>resource</info> da rede neural.
  <info>float</info>     <strong>$rprop_increase_factor</strong>  The increase factor.

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

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


id: fann_set_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop step error shift
  
  Sets the sarprop step error shift.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                       <info>resource</info> da rede neural.
  <info>float</info>     <strong>$sarprop_step_error_shift</strong>  The sarprop step error shift.

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

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


id: fann_set_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop step error threshold factor
  
  Sets the sarprop step error threshold factor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  <info>resource</info> da rede neural.
  <info>float</info>     <strong>$sarprop_step_error_threshold_factor</strong>  The sarprop step error threshold factor.

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

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


id: fann_set_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop temperature
  
  Sets the sarprop temperature.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  <info>resource</info> da rede neural.
  <info>float</info>     <strong>$sarprop_temperature</strong>  The sarprop temperature.

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

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


id: fann_set_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Sets the sarprop weight decay shift
  
  Sets the sarprop weight decay shift.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                         <info>resource</info> da rede neural.
  <info>float</info>     <strong>$sarprop_weight_decay_shift</strong>  The sarprop weight decay shift.

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

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


id: fann_set_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calculate input and output scaling parameters for future use based on training data
  
  Calculate input and output scaling parameters for future use based on training data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$train_data</strong>      <info>resource</info> dos dados de treinamento da rede neural.
  <info>float</info>     <strong>$new_input_min</strong>   The desired lower bound in input data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_input_max</strong>   The desired upper bound in input data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_min</strong>  The desired lower bound in output data after scaling (not strictly
                             followed)
  <info>float</info>     <strong>$new_output_max</strong>  The desired upper bound in output data after scaling (not strictly
                             followed)

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

<comment>See Also:</comment>
   * <strong>fann_set_input_scaling_params()</strong>
   * <strong>fann_set_output_scaling_params()</strong>


id: fann_set_train_error_function
type: function
doc:
<comment>Description:</comment>
  Sets the error function used during training
  
  Sets the error function used during training.
  
  The error functions are described further in error functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>int</info>       <strong>$error_function</strong>  The error function constant

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

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


id: fann_set_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Sets the stop function used during training
  
  Sets the stop function used during training.
  
  The stop functions are described further in stop functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            <info>resource</info> da rede neural.
  <info>int</info>       <strong>$stop_function</strong>  The stop function constant.

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

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


id: fann_set_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Sets the training algorithm
  
  Sets the training algorithm.
  
  More info available in <strong>fann_get_training_algorithm()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 <info>resource</info> da rede neural.
  <info>int</info>       <strong>$training_algorithm</strong>  Training algorithm constant

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

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


id: fann_set_weight
type: function
doc:
<comment>Description:</comment>
  Set a connection in the network
  
  Set a connections in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          <info>resource</info> da rede neural.
  <info>int</info>       <strong>$from_neuron</strong>  The neuron where the connection starts
  <info>int</info>       <strong>$to_neuron</strong>    The neuron where the connection ends
  <info>float</info>     <strong>$weight</strong>       Connection weight

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


id: fann_set_weight_array
type: function
doc:
<comment>Description:</comment>
  Set connections in the network
  
  Set connections in the network.
  
  Only the weights can be changed, connections and weights are ignored if they do not already exist
  in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          <info>resource</info> da rede neural.
  <info>array</info>     <strong>$connections</strong>  An array of <class>FANNConnection</class> objects

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


id: fann_shuffle_train_data
type: function
doc:
<comment>Description:</comment>
  Shuffles training data, randomizing the order
  
  Shuffles training data, randomizing the order. This is recommended for incremental training, while
  it have no influence during batch training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

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


id: fann_subset_train_data
type: function
doc:
<comment>Description:</comment>
  Returns an copy of a subset of the train data
  
  Returns an copy of a subset of the train data <info>resource</info>, starting at position <return>pos</return> and <return>length</return>
  elements forward.
  
  The <return>fann_subset_train_data(train_data, 0, fann_length_train_data(train_data))</return> do the same as
  <strong>fann_duplicate_train_data()</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>    <info>resource</info> dos dados de treinamento da rede neural.
  <info>int</info>       <strong>$pos</strong>     Starting position.
  <info>int</info>       <strong>$length</strong>  The number of copied elements.

<comment>Return:</comment>
  <info>resource</info>  Retorna um <info>resource</info> de dados de treinamento em caso de sucesso ou <info>false</info> em caso de erro.

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


id: fann_test
type: function
doc:
<comment>Description:</comment>
  Test with a set of inputs, and a set of desired outputs
  
  Test with a set of inputs, and a set of desired outputs. This operation updates the mean square
  error, but does not change the network in any way.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>array</info>     <strong>$input</strong>           An array of inputs. This array must be exactly <strong>fann_get_num_input()</strong>
                             long.
  <info>array</info>     <strong>$desired_output</strong>  An array of desired outputs. This array must be exactly
                             <strong>fann_get_num_output()</strong> long.

<comment>Return:</comment>
  <info>array</info>  Returns test outputs on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_test_data
type: function
doc:
<comment>Description:</comment>
  Test a set of training data and calculates the MSE for the training data
  
  Test a set of training data and calculates the MSE for the training data.
  
  This function updates the MSE and the bit fail values.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>float</info>  The updated MSE, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train
type: function
doc:
<comment>Description:</comment>
  Train one iteration with a set of inputs, and a set of desired outputs
  
  Train one iteration with a set of inputs, and a set of desired outputs. This training is always
  incremental training, since only one pattern is presented.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             <info>resource</info> da rede neural.
  <info>array</info>     <strong>$input</strong>           An array of inputs. This array must be exactly <strong>fann_get_num_input()</strong>
                             long.
  <info>array</info>     <strong>$desired_output</strong>  An array of desired outputs. This array must be exactly
                             <strong>fann_get_num_output()</strong> long.

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_train_epoch
type: function
doc:
<comment>Description:</comment>
  Train one epoch with a set of training data
  
  Train one epoch with the training data stored in data. One epoch is where all of the training data
  is considered exactly once.
  
  This function returns the MSE error as it is calculated either before or during the actual
  training. This is not the actual MSE after the training epoch, but since calculating this will
  require to go through the entire training set once more. It is more than adequate to use this
  value during training.
  
  The training algorithm used by this function is chosen by <strong>fann_set_training_algorithm()</strong> function.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$data</strong>  <info>resource</info> dos dados de treinamento da rede neural.

<comment>Return:</comment>
  <info>float</info>  The MSE, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train_on_data
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset for a period of time
  
  Trains on an entire dataset for a period of time.
  
  This training uses the training algorithm chosen by <strong>fann_set_training_algorithm()</strong> and the
  parameters set for these training algorithms.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     <info>resource</info> da rede neural.
  <info>resource</info>  <strong>$data</strong>                    <info>resource</info> dos dados de treinamento da rede neural.
  <info>int</info>       <strong>$max_epochs</strong>              The maximum number of epochs the training should continue
  <info>int</info>       <strong>$epochs_between_reports</strong>  The number of epochs between calling a callback function. A
                                     value of zero means that user function is not called.
  <info>float</info>     <strong>$desired_error</strong>           The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending on
                                     the stop function chosen by <strong>fann_set_train_stop_function()</strong>

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

<comment>See Also:</comment>
   * <strong>fann_train_on_file()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fann_train_on_file
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset, which is read from file, for a period of time
  
  Trains on an entire dataset, which is read from file, for a period of time.
  
  This training uses the training algorithm chosen by <strong>fann_set_training_algorithm()</strong> and the
  parameters set for these training algorithms.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     <info>resource</info> da rede neural.
  <info>string</info>    <strong>$filename</strong>                The file containing train data
  <info>int</info>       <strong>$max_epochs</strong>              The maximum number of epochs the training should continue
  <info>int</info>       <strong>$epochs_between_reports</strong>  The number of epochs between calling a user function. A value
                                     of zero means that user function is not called.
  <info>float</info>     <strong>$desired_error</strong>           The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending on
                                     the stop function chosen by <strong>fann_set_train_stop_function()</strong>

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

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fastcgi_finish_request
type: function
doc:
<comment>Description:</comment>
  Envia todos os dados de resposta ao cliente
  
  Esta função envia todos os dados de resposta para o cliente e finaliza a requisição. Isso permite
  que tarefas demoradas sejam executadas sem que a conexão com o cliente seja mantida aberta.

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


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

<comment>See Also:</comment>
   * <strong>fbird_modify_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_query()</strong>
   * <strong>fbird_execute()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  A BLOB handle opened with <strong>fbird_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>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_import()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>
   * <strong>fbird_blob_get()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_pconnect()</strong>
   * <strong>fbird_close()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_modify_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


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

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


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

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


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_assoc()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_fetch_assoc()</strong>
   * <strong>fbird_fetch_object()</strong>


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

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


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

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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_delete_user()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_execute()</strong>


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

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


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

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_param_info()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_field_info()</strong>
   * <strong>fbird_num_params()</strong>


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

<comment>See Also:</comment>
   * <strong>fbird_close()</strong>
   * <strong>fbird_connect()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_errmsg()</strong>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>
   * <strong>fbird_free_result()</strong>


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


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


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


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


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


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


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

<comment>See Also:</comment>
   * <strong>fbird_free_event_handler()</strong>
   * <strong>fbird_wait_event()</strong>


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


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

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>
   * <strong>fbird_free_event_handler()</strong>


id: fclose
type: function
doc:
<comment>Description:</comment>
  Fecha um ponteiro de arquivo aberto
  
  O arquivo apontado por <strong>$stream</strong> é fechado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro para o arquivo tem que ser válido e tem que apontar para um arquivo
                     aberto por <strong>fopen()</strong> ou <strong>fsockopen()</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>fopen()</strong>
   * <strong>fsockopen()</strong>


id: fdatasync
type: function
doc:
<comment>Description:</comment>
  Sincroniza dados (mas não metadados) ao arquivo
  
  Esta função sincroniza o conteúdo do fluxo definido em <strong>$stream</strong> para a mídia de armazenamento, da
  mesma forma que <strong>fsync()</strong>, mas não sincroniza os metadados de arquivo. Note que esta função só é
  efetivamente diferente em sistemas POSIX. No Windows, esta função é apelidada de <strong>fsync()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</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>fflush()</strong>
   * <strong>fsync()</strong>


id: fdf_add_doc_javascript
type: function
doc:
<comment>Description:</comment>
  Adds javascript code to the FDF document
  
  Adds a script to the FDF, which Acrobat then adds to the doc-level scripts of a document, once the
  FDF is imported into it.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$script_name</strong>   The script name.
  <info>string</info>    <strong>$script_code</strong>   The script code. It is strongly suggested to use <return>\r</return> for linebreaks within
                           the script code.

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


id: fdf_add_template
type: function
doc:
<comment>Description:</comment>
  Adds a template into the FDF document
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: fdf_close
type: function
doc:
<comment>Description:</comment>
  Close an FDF document
  
  Closes the FDF document.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

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

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


id: fdf_create
type: function
doc:
<comment>Description:</comment>
  Create a new FDF document
  
  Creates a new FDF document.
  
  This function is needed if one would like to populate input fields in a PDF document with data.

<comment>Return:</comment>
  <info>resource</info>  Returns a FDF document handle, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_save()</strong>
   * <strong>fdf_open()</strong>


id: fdf_enum_values
type: function
doc:
<comment>Description:</comment>
  Call a user defined function for each document value 
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: fdf_errno
type: function
doc:
<comment>Description:</comment>
  Return error code for last fdf operation
  
  Gets the error code set by the last FDF function call.
  
  A textual description of the error may be obtained using with <strong>fdf_error()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the error code as an integer, or zero if there was no errors.

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


id: fdf_error
type: function
doc:
<comment>Description:</comment>
  Return error description for FDF error code
  
  Gets a textual description for the FDF error code given in <strong>$error_code</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  An error code obtained with <strong>fdf_errno()</strong>. If not provided, this function uses the
                    internal error code set by the last operation.

<comment>Return:</comment>
  <info>string</info>  Returns the error message as a string, or the string  <return>no error</return> if nothing went wrong.

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


id: fdf_get_ap
type: function
doc:
<comment>Description:</comment>
  Get the appearance of a field
  
  Gets the appearance of a <strong>$field</strong> (i.e. the value of the /AP key) and stores it in a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field</strong>         
  <info>int</info>       <strong>$face</strong>          The possible values are <info>FDFNormalAP</info>,  <info>FDFRolloverAP</info> and <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      The appearance will be stored in this parameter.

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


id: fdf_get_attachment
type: function
doc:
<comment>Description:</comment>
  Extracts uploaded file embedded in the FDF
  
  Extracts a file uploaded by means of the "file selection" field <strong>$fieldname</strong> and stores it under
  <strong>$savepath</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     
  <info>string</info>    <strong>$savepath</strong>      May be the name of a plain file or an existing directory in which the
                           file is to be created under its original name. Any existing file under
                           the same name will be overwritten.
                           
                           There seems to be no other way to find out the original filename but to
                           store the file using a directory as  <strong>$savepath</strong> and check for the basename
                           it was stored under.

<comment>Return:</comment>
  <info>array</info>  The returned array contains the following fields: <strong>$path</strong> - path were the file got
         stored<strong>$size</strong> - size of the stored file in bytes<strong>$type</strong> - mimetype if given in the FDF
         
         <strong>$path</strong> - path were the file got stored
         
         <strong>$size</strong> - size of the stored file in bytes
         
         <strong>$type</strong> - mimetype if given in the FDF


id: fdf_get_encoding
type: function
doc:
<comment>Description:</comment>
  Get the value of the /Encoding key
  
  Gets the value of the <return>/Encoding</return> key.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns the encoding as a string. An empty string is returned if the default
          <return>PDFDocEncoding/Unicode</return> scheme is used.

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


id: fdf_get_file
type: function
doc:
<comment>Description:</comment>
  Get the value of the /F key
  
  Gets the value of the <return>/F</return> key.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

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

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


id: fdf_get_flags
type: function
doc:
<comment>Description:</comment>
  Gets the flags of a field
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: fdf_get_opt
type: function
doc:
<comment>Description:</comment>
  Gets a value from the opt array of a field
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: fdf_get_status
type: function
doc:
<comment>Description:</comment>
  Get the value of the /STATUS key
  
  Gets the value of the <return>/STATUS</return> key.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

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

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


id: fdf_get_value
type: function
doc:
<comment>Description:</comment>
  Get the value of a field
  
  Gets the value for the requested field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>int</info>       <strong>$which</strong>         Elements of an array field can be retrieved by passing this optional
                           parameter, starting at zero. For non-array fields, this parameter will be
                           ignored.

<comment>Return:</comment>
  <info>mixed</info>  Returns the field value.

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


id: fdf_get_version
type: function
doc:
<comment>Description:</comment>
  Gets version number for FDF API or file 
  
  Return the FDF version for the given document, or the toolkit API version number if no parameter
  is given.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns the version as a string. For the current FDF toolkit 5.0 the API version number is
          <return>5.0</return> and the document version number is either <return>1.2</return>, <return>1.3</return> or  <return>1.4</return>.

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


id: fdf_header
type: function
doc:
<comment>Description:</comment>
  Sets FDF-specific output headers
  
  This is a convenience function to set appropriate HTTP headers for FDF output. It sets the
  <return>Content-type:</return> to  <return>application/vnd.fdf</return>.

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


id: fdf_next_field_name
type: function
doc:
<comment>Description:</comment>
  Get the next field name
  
  Gets the name of the field after the given field. This name can be used with several functions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string. If not given, the first field will be
                           assumed.

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

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


id: fdf_open
type: function
doc:
<comment>Description:</comment>
  Open a FDF document
  
  Opens a file with form data.
  
  You can also use <strong>fdf_open_string()</strong> to process the results of a PDF form POST request.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Path to the FDF file. This file must contain the data as returned from a PDF
                     form or created using <strong>fdf_create()</strong> and <strong>fdf_save()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Returns a FDF document handle, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_open_string
type: function
doc:
<comment>Description:</comment>
  Read a FDF document from a string
  
  Reads form data from a string.
  
  You can use <strong>fdf_open_string()</strong> together with $HTTP_FDF_DATA to process FDF form input from a remote
  client.

<comment>Param:</comment>
  <info>string</info>  <strong>$fdf_data</strong>  The data as returned from a PDF form or created using  <strong>fdf_create()</strong> and
                     <strong>fdf_save_string()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Returns a FDF document handle, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fdf_open()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_remove_item
type: function
doc:
<comment>Description:</comment>
  Sets target frame for form
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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


id: fdf_save
type: function
doc:
<comment>Description:</comment>
  Save a FDF document
  
  Saves a FDF document.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$filename</strong>      If provided, the resulting FDF will be written in this parameter.
                           Otherwise, this function will write the FDF to the default PHP output
                           stream.

<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>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_save_string
type: function
doc:
<comment>Description:</comment>
  Returns the FDF document as a string
  
  Returns the FDF document as a string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.

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

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_set_ap
type: function
doc:
<comment>Description:</comment>
  Set the appearance of a field
  
  Sets the appearance of a field (i.e. the value of the  <return>/AP</return> key).

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field_name</strong>    
  <info>int</info>       <strong>$face</strong>          The possible values <info>FDFNormalAP</info>, <info>FDFRolloverAP</info> and <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      
  <info>int</info>       <strong>$page_number</strong>   

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


id: fdf_set_encoding
type: function
doc:
<comment>Description:</comment>
  Sets FDF character encoding
  
  Sets the character encoding for the FDF document.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$encoding</strong>      The encoding name. The following values are supported:  "<return>Shift-JIS</return>",
                           "<return>UHC</return>", "<return>GBK</return>" and "<return>BigFive</return>".
                           
                           An empty string resets the encoding to the default
                           <return>PDFDocEncoding/Unicode</return> scheme.

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


id: fdf_set_file
type: function
doc:
<comment>Description:</comment>
  Set PDF document to display FDF data in
  
  Selects a different PDF document to display the form results in then the form it originated from.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$url</strong>           Should be given as an absolute URL.
  <info>string</info>    <strong>$target_frame</strong>  Use this parameter to specify the frame in which the document will be
                           displayed. You can also set the default value for this parameter using
                           <strong>fdf_set_target_frame()</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>fdf_get_file()</strong>
   * <strong>fdf_set_target_frame()</strong>


id: fdf_set_flags
type: function
doc:
<comment>Description:</comment>
  Sets a flag of a field
  
  Sets certain flags of the given field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>int</info>       <strong>$whichFlags</strong>    
  <info>int</info>       <strong>$newFlags</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>fdf_set_opt()</strong>


id: fdf_set_javascript_action
type: function
doc:
<comment>Description:</comment>
  Sets an javascript action of a field
  
  Sets a javascript action for the given field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</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>fdf_set_submit_form_action()</strong>


id: fdf_set_on_import_javascript
type: function
doc:
<comment>Description:</comment>
  Adds javascript code to be executed when Acrobat opens the FDF
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>See Also:</comment>
   * <strong>fdf_add_doc_javascript()</strong>
   * <strong>fdf_set_javascript_action()</strong>


id: fdf_set_opt
type: function
doc:
<comment>Description:</comment>
  Sets an option of a field
  
  Sets options of the given field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>int</info>       <strong>$element</strong>       
  <info>string</info>    <strong>$str1</strong>          
  <info>string</info>    <strong>$str2</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>fdf_set_flags()</strong>


id: fdf_set_status
type: function
doc:
<comment>Description:</comment>
  Set the value of the /STATUS key
  
  Sets the value of the <return>/STATUS</return> key. When a client receives a FDF with a status set it will present
  the value in an alert box.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$status</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>fdf_get_status()</strong>


id: fdf_set_submit_form_action
type: function
doc:
<comment>Description:</comment>
  Sets a submit form action of a field
  
  Sets a submit form action for the given field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        
  <info>int</info>       <strong>$flags</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>fdf_set_javascript_action()</strong>


id: fdf_set_target_frame
type: function
doc:
<comment>Description:</comment>
  Set target frame for form display
  
  Sets the target frame to display a result PDF defined with  <strong>fdf_save_file()</strong> in.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$frame_name</strong>    The frame name, as a string.

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

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


id: fdf_set_value
type: function
doc:
<comment>Description:</comment>
  Set the value of a field
  
  Sets the <strong>$value</strong> for the given field.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Name of the FDF field, as a string.
  <info>mixed</info>     <strong>$value</strong>         This parameter will be stored as a string unless it is an array. In this
                           case all array elements will be stored as a value array.
  <info>int</info>       <strong>$isName</strong>        In older versions of the FDF toolkit last parameter determined if the
                           field value was to be converted to a PDF Name (= 1) or set to a PDF
                           String (= 0).
                           
                           The value is no longer used in the current toolkit version 5.0. For
                           compatibility reasons it is still supported as an optional parameter, but
                           ignored internally.

<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>fdf_get_value()</strong>
   * <strong>fdf_remove_item()</strong>


id: fdf_set_version
type: function
doc:
<comment>Description:</comment>
  Sets version number for a FDF file 
  
  Sets the FDF <strong>$version</strong> for the given document.
  
  Some features supported by this extension are only available in newer FDF versions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  The FDF document handle, returned by <strong>fdf_create()</strong>, <strong>fdf_open()</strong> or
                           <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$version</strong>       The version number. For the current FDF toolkit 5.0, this may be either
                           <return>1.2</return>, <return>1.3</return> or <return>1.4</return>.

<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>fdf_get_version()</strong>


id: fdiv
type: function
doc:
<comment>Description:</comment>
  Divide dois números de acordo com a IEEE 754
  
  Retorna o resultado em ponto flutuante da divisão de <strong>$num1</strong> por <strong>$num2</strong>. Se <strong>$num2</strong> for zero, um dos
  valores <return>INF</return>, <return>-INF</return> ou <return>NAN</return> será retornado.
  
  Note que em comparações, <return>NAN</return> nunca será == ou === a nenhum valor, incluindo a si mesmo.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  O dividendo (numerador)
  <info>float</info>  <strong>$num2</strong>  O divisor

<comment>Return:</comment>
  <info>float</info>  O resultado em ponto flutuante de <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - Divisão com ponto flutuante
   * <strong>intdiv()</strong> - Divisão de inteiros
   * <strong>fmod()</strong> - Módulo


id: feof
type: function
doc:
<comment>Description:</comment>
  Testa pelo fim-de-arquivo em um ponteiro de arquivo
  
  Testa pelo fim-do-arquivo em um ponteiro de arquivo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o ponteiro estiver no fim do arquivo ou um erro ocorrer (incluindo um limite
        de tempo de socket); caso contrário retorna <info>false</info>.


id: fflush
type: function
doc:
<comment>Description:</comment>
  Força a liberação do buffer para um arquivo
  
  Esta função força a escrita de toda saída cacheada para o recurso apontado fluxo de arquivo
  <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</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>clearstatcache()</strong>
   * <strong>fwrite()</strong>


id: fgetc
type: function
doc:
<comment>Description:</comment>
  Lê um caractere do ponteiro de arquivo
  
  Obtém um caractere de um dado ponteiro de arquivo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string contendo um único caractere lido do ponteiro do arquivo passado
                por <strong>$stream</strong>. Retorna <info>false</info> em EOF.
                
                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>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>fgets()</strong>


id: fgetcsv
type: function
doc:
<comment>Description:</comment>
  Lê uma linha do ponteiro de arquivos e a interpreta como campos CSV
  
  Similar à função <strong>fgets()</strong>, exceto que a <strong>fgetcsv()</strong> interpreta a linha em busca de campos no formato
  CSV e retorna um array contendo os campos lidos.
  
  As configurações de localidade são consideradas por esta função. Se <return>LC_CTYPE</return> for por exemplo
  <return>en_US.UTF-8</return>, arquivos em codificação de um byte podem ser lidos incorretamente por esta função.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     Um ponteiro de arquivo válido para um arquivo aberto com sucesso por
                        <strong>fopen()</strong>, <strong>popen()</strong> ou <strong>fsockopen()</strong>.
  <info>int|null</info>  <strong>$length</strong>     Deve ser maior do que a maior linha (em caracteres) a ser encontrada no
                        arquivo CSV (considerando também os caracteres de fim-de-linha). Caso
                        contrário a linha é dividida em partes de <strong>$length</strong> caracteres, a não ser que
                        a divisão ocorra dentro de um caractere que cerca os campos (enclosure).
                        
                        Se este parâmetro for omitido (ou definido em 0 ou <info>null</info> a partir do PHP
                        8.0.0), o tamanho máximo das linhas não é limitado, o que é um pouco mais
                        lento.
  <info>string</info>    <strong>$separator</strong>  O parâmetro opcional <strong>$separator</strong> define o delimitador de campo (somente um
                        caractere de um byte).
  <info>string</info>    <strong>$enclosure</strong>  O parâmetro opctional <strong>$enclosure</strong> define o caractere que cerca um campo
                        (somente um caractere de um byte).
  <info>string</info>    <strong>$escape</strong>     O parâmetro opcional <strong>$escape</strong> define o caractere de escape (no máximo um
                        caractere de um byte). Uma string vazia (<return>""</return>) desabilita o mecanismo de
                        escape proprietário.
                        
                        Normalmente um caractere de <strong>$enclosure</strong> sofre escape dentro de um campo
                        através da duplicação; entretanto, o caractere <strong>$escape</strong> pode ser usado como
                        uma alternativa. Portanto, para os parâmetros padrões os valores <return>""</return> e <return>\"</return> têm
                        o mesmo significado. Além de permitir fazer escape no caractere <strong>$enclosure</strong>,
                        o caractere <strong>$escape</strong> não tem nenhum significado especial adicional; muito
                        menos foi projetado para fazer escape de si mesmo.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array indexado contendo os campos lidos em caso de sucesso,  ou <info>false</info> em
               caso de falha.
               
               Uma linha em branco em um arquivo CSV será retornada como um array contendo um único
               campo nulo (<info>null</info>) e não será tratada como um erro.
               
               Se o PHP não estiver reconhecendo corretamente
               os finais de linha ao ler arquivos em um computador Macintosh ou que foram criados
               em um, habilitar a opção de configuração em tempo de execução
               auto_detect_line_endings
               pode ajudar a resolver o problema.

<comment>See Also:</comment>
   * <strong>str_getcsv()</strong>
   * <strong>explode()</strong>
   * <strong>file()</strong>
   * <strong>pack()</strong>
   * <strong>fputcsv()</strong>


id: fgets
type: function
doc:
<comment>Description:</comment>
  Lê uma linha de um ponteiro de arquivo
  
  Retorna uma linha do ponteiro do arquivo.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</strong>).
  <info>int|null</info>  <strong>$length</strong>  A leitura termina quando <strong>$length</strong> - 1 bytes tenham sido lidos, ou uma quebra de
                     linha (que é incluída no retorno), ou no final do arquivo (EOF), o que
                     acontecer primeiro. Se nenhum comprimento for especificado, a leitura do fluxo
                     continuará até chegar ao final da linha.

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma string de até <strong>$length</strong> - 1 bytes lida do arquivo apontado por <strong>$stream</strong>. Se
                não tiver mais dados para ler no ponteiro do arquivo, então retorna <info>false</info>.
                
                Se um erro ocorrer, é retornado <info>false</info>.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * <strong>fread()</strong>
   * <strong>fgetc()</strong>
   * <strong>stream_get_line()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>stream_set_timeout()</strong>


id: fgetss
type: function
doc:
<comment>Description:</comment>
  Ler uma linha de um ponteiro de arquivo e retira as tags HTML
  
  Idêntico a <strong>fgets()</strong>, exceto que <strong>fgetss()</strong> tenta retirar qualquer byte NUL, tag HTML ou PHP do texto
  que ela lê. A função retém o estado de interpretação de chamada para chamada, e desta forma não É
  equivalente a chamar <strong>strip_tags()</strong> no valor de retorno de <strong>fgets()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>          O ponteiro de arquivo deve ser válido e deve apontar para
                             um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                             <strong>fsockopen()</strong> (e ainda não fechado por
                             <strong>fclose()</strong>).
  <info>int</info>       <strong>$length</strong>          Tamanho da informação a ser recebida.
  <info>string</info>    <strong>$allowable_tags</strong>  Pode-se usar o terceiro parâmetro opcional para especificar as tags que
                             não devem ser removidas. Consulte <strong>strip_tags()</strong> para detalhes sobre
                             <strong>$allowable_tags</strong>.

<comment>Return:</comment>
  <info>string</info>  Retorna uma stirng de até <strong>$length</strong> - 1 bytes lidos do arquivo apontado por <strong>$handle</strong>, com
          todo o código HTML e PHP removidos.
          
          Se um erro ocorrer, retorna <info>false</info>.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>strip_tags()</strong>
   * SplFileObject::fgetss
   * O filtro string.strip_tags


id: file
type: function
doc:
<comment>Description:</comment>
  Lê todo o arquivo para um array
  
  Carrega todo um arquivo em um array.
  
  Pode-se utilizar <strong>file_get_contents()</strong> para retornar o conteúdo de um arquivo como uma string.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Caminho para o arquivo.
                            
                            Uma URL pode ser usada como um
                            nome de arquivo com esta função se os wrappers fopen estiverem
                            habilitados.
                            Consulte a função <strong>fopen()</strong> para mais detalhes sobre como especificar
                            o nome do arquivo. Consulte os  para obter links para informações
                            sobre as capacidades de cada wrapper, notas de uso
                            e informações sobre quaisquer variáveis predefinidas que eles possam
                            fornecer.
  <info>int</info>            <strong>$flags</strong>     O parâmetro opcional <strong>$flags</strong> pode ser uma ou mais das seguintes
                            constantes: <info>FILE_USE_INCLUDE_PATH</info> Procurar pelo arquivo no include_path.
                            <info>FILE_IGNORE_NEW_LINES</info> Omite a quebra de linha no final de cada elemento
                            do array <info>FILE_SKIP_EMPTY_LINES</info> Pula linhas vazias
                            <info>FILE_NO_DEFAULT_CONTEXT</info> Não usa o contexto padrão
                            
                            Procurar pelo arquivo no include_path.
                            
                            Omite a quebra de linha no final de cada elemento do array
                            
                            Pula linhas vazias
                            
                            Não usa o contexto padrão
  <info>resource|null</info>  <strong>$context</strong>   Um <info>resource</info> de
                            contexto de stream.

<comment>Return:</comment>
  <info>array|false</info>  Retorna o arquivo em um array. Cada elemento do array corresponde a uma linha no
               arquivo, ainda com a quebra de linha. Em caso de falha, <strong>file()</strong> retorna <info>false</info>
               
               Cada linha no array incluirá a quebra de linha, a não ser que <info>FILE_IGNORE_NEW_LINES</info>
               seja usado.
               
               Se o PHP não estiver reconhecendo corretamente
               os finais de linha ao ler arquivos em um computador Macintosh ou que foram criados
               em um, habilitar a opção de configuração em tempo de execução
               auto_detect_line_endings
               pode ajudar a resolver o problema.

<comment>See Also:</comment>
   * <strong>file_get_contents()</strong>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>include()</strong>
   * <strong>stream_context_create()</strong>


id: file_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se um arquivo ou diretório existe
  
  Verifica se um arquivo ou diretório existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho para o arquivo ou diretório.
                     
                     No Windows, use //computername/share/filename ou \\computername\share\filename
                     para checar arquivos em compartilhamentos de rede.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o arquivo ou diretório especificado por <strong>$filename</strong> existe; <info>false</info> caso
        contrário.
        
        Esta função retorna <info>false</info> para ligações simbólicas apontando para arquivos inexistentes.
        
        O teste é realizado utilizando o UID/GID real, em vez de outro valor efetivo.
        
        Como o tipo inteiro do PHP possui sinal e muitas plataformas usam números inteiros de 32
        bits, algumas funções do sistema de arquivos podem retornar resultados inesperados para
        arquivos maiores que 2GB.

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>is_writable()</strong>
   * <strong>is_file()</strong>
   * <strong>file()</strong>
   * <class>SplFileInfo</class>


id: file_get_contents
type: function
doc:
<comment>Description:</comment>
  Lê todo o conteúdo de um arquivo para uma string
  
  Esta função é semelhante à <strong>file()</strong>, exceto que <strong>file_get_contents()</strong> retorna o arquivo em uma <info>string</info>,
  começando a partir de <strong>$offset</strong> até <strong>$length</strong> bytes. Em caso de falha, <strong>file_get_contents()</strong> retornará
  <info>false</info>.
  
  <strong>file_get_contents()</strong> é o método preferível para ler o conteúdo de um arquivo em uma string. Ela usa
  técnicas de mapeamento de memória suportadas pelo sistema operacional para melhorar o desempenho.
  
  Se for aberta uma URI com caracteres especiais, como espaços, é necessário codificar a URI com
  <strong>urlencode()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Nome do arquivo para ler.
  <info>bool</info>           <strong>$use_include_path</strong>  A constante <info>FILE_USE_INCLUDE_PATH</info> pode ser usada para acionar a
                                    busca no include path. Isto não é possível se a tipagem estrita
                                    estiver habilitada, já que <info>FILE_USE_INCLUDE_PATH</info> é um <info>int</info>. Em
                                    vez disso, use <info>true</info>.
  <info>resource|null</info>  <strong>$context</strong>           Um recurso de contexto válido, criado com
                                    <strong>stream_context_create()</strong>. Se você não precisa usar um contexto
                                    personalizado, você pode ignorar este parâmetro passando <info>null</info>.
  <info>int</info>            <strong>$offset</strong>            O ponto onde a leitura deve começar no fluxo original. Offsets
                                    negativos contam a partir do final do fluxo.
                                    
                                    <strong>$offset</strong> não é suportado em arquivos remotos. Tentar fazer busca
                                    em arquivos não locais pode funcionar com offsets pequenos, mas
                                    isso é imprevisível pois só funciona no fluxo com buffer.
  <info>int|null</info>       <strong>$length</strong>            Comprimento máximo dos dados lidos. O padrão é ler até que o fim
                                    do arquivo seja alcançado. Note que este parâmetro é aplicado
                                    para o fluxo processado pelos filtros.

<comment>Return:</comment>
  <info>string|false</info>  A função retorna os dados lidos  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>file()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>readfile()</strong>
   * <strong>file_put_contents()</strong>
   * <strong>stream_get_contents()</strong>
   * <strong>stream_context_create()</strong>
   * $http_response_header


id: file_put_contents
type: function
doc:
<comment>Description:</comment>
  Escreve dados em um arquivo
  
  Esta função é idêntica a chamar <strong>fopen()</strong>, <strong>fwrite()</strong> e <strong>fclose()</strong> sucessivamente para escrever dados em
  um arquivo.
  
  Se o arquivo informado em <strong>$filename</strong> não existir, o arquivo é criado. Do contrário, o arquivo
  existente é sobrescrito, a não ser que a opção <info>FILE_APPEND</info> seja definida.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  O caminho para o arquivo onde os dados serão escritos.
  <info>mixed</info>          <strong>$data</strong>      Os dados a serem escritos. Pode ser uma <info>string</info>, um <info>array</info> ou um recurso
                            <info>stream</info>.
                            
                            Se <strong>$data</strong> for um recurso <info>stream</info>, o buffer restante desse fluxo será
                            copiado para o arquivo especificado, semelhante à utilização de
                            <strong>stream_copy_to_stream()</strong>.
                            
                            Você também pode especificar o parâmetro <strong>$data</strong> como um array
                            unidimensional. Isso é equivalente a <return>file_put_contents($filename,
                            implode('', $array))</return>.
  <info>int</info>            <strong>$flags</strong>     O valor de <strong>$flags</strong> pode ser qualquer combinação das seguintes opções,
                            adicionadas com o operador binário OR (<return>|</return>).
                            
                            Opções disponíveisOpçãoDescrição<info>FILE_USE_INCLUDE_PATH</info> Procura o arquivo
                            <strong>$filename</strong> nos diretórios de include. Consulte include_path para mais
                            informações. <info>FILE_APPEND</info> Se o arquivo <strong>$filename</strong> já existir, acrescenta
                            os dados ao arquivo ao invés de sobrescrevê-lo. <info>LOCK_EX</info> Adquire uma
                            trava exclusiva no arquivo ao prosseguir para a escrita. Em outras
                            palavras, uma chamada a <strong>flock()</strong> acontece entre a chamada <strong>fopen()</strong> e a
                            chamada <strong>fwrite()</strong>. Isso não é idêntico à uma chamada <strong>fopen()</strong> com modo
                            "x".
  <info>resource|null</info>  <strong>$context</strong>   Um recurso de contexto válido criado com <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Esta função retorna a quantidade de bytes que foi escrita no arquivo 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>fopen()</strong>
   * <strong>fwrite()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>stream_context_create()</strong>


id: fileatime
type: function
doc:
<comment>Description:</comment>
  Obtém o último horário de acesso do arquivo
  
  Obtém o último horário de acesso do arquivo.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna o horário em que um arquivo foi acessado pela última vez,  ou <info>false</info> em caso de
             falha. O horário é retornado como um timestamp Unix.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * <strong>fileinode()</strong>
   * <strong>date()</strong>


id: filectime
type: function
doc:
<comment>Description:</comment>
  Obtém o horário de modificação de inode do arquivo
  
  Obtém o horário de modificação do inode de um arquivo.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna o horário em que o arquivo foi modificado pela última vez,  ou <info>false</info> em caso de
             falha. O horário é retornado como um timestamp Unix.

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


id: filegroup
type: function
doc:
<comment>Description:</comment>
  Lê o grupo do arquivo
  
  Obtém o grupo do arquivo. O ID do grupo é retornado no formato numérico, use <strong>posix_getgrgid()</strong> para
  resolvê-lo para um nome do grupo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho do arquivo.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o group ID do arquivo, ou <info>false</info> no caso de um erro. O group ID é retornado em
             um formato numérico. Use <strong>posix_getgrgid()</strong> para resolver para o nome do grupo. Em caso
             de falha, <info>false</info> é retornado.

<comment>See Also:</comment>
   * <strong>fileowner()</strong>
   * <strong>posix_getgrgid()</strong>


id: fileinode
type: function
doc:
<comment>Description:</comment>
  Lê o inode do arquivo
  
  Obtém o inode do arquivo.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna o número do inode do arquivo,  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>getmyinode()</strong>
   * <strong>stat()</strong>


id: filemtime
type: function
doc:
<comment>Description:</comment>
  Obtém o horário de modificação do arquivo
  
  Esta função retorna o horário em que os blocos de dados de um arquivo estavam sendo escritos, isto
  é, o horário em que o conteúdo do arquivo foi modificado.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna o horário em que o arquivo foi modificado pela última vez,  ou <info>false</info> em caso de
             falha. O horário é retornado como um timestamp Unix, que é adequado para a função
             <strong>date()</strong>.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * <strong>stat()</strong>
   * <strong>touch()</strong>
   * <strong>getlastmod()</strong>


id: fileowner
type: function
doc:
<comment>Description:</comment>
  Obtem o proprietário do arquivo
  
  Obtém o proprietário do arquivo.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna a ID do usuário do proprietário do arquivo,  ou <info>false</info> em caso de falha. A ID do
             usuário é retornada em formato numérico, use a função <strong>posix_getpwuid()</strong> para obter o
             nome do usuário.

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * <strong>posix_getpwuid()</strong>


id: fileperms
type: function
doc:
<comment>Description:</comment>
  Obtém permissões de arquivo
  
  Obtém as permissões para o arquivo informado.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna as permissões do arquivo em modo numérico. Os bits menos significativos deste
             modo são os mesmos das permissões esperadas por <strong>chmod()</strong>, entretanto na maioria das
             plataformas o valor de retorno também inclui informação sobre o tipo do arquivo
             informado em <strong>$filename</strong>. Os exemplo abaixo demonstram como testar o valor de retorno
             para permissões e tipos de arquivos específicos em sistemas POSIX, incluindo Linux e
             macOS.
             
             Para aquivos locais, o valor de retorno específico é o do membro <return>st_mode</return> da estrutura
             retornada pela função <strong>stat()</strong> da biblioteca C. Exatamenta quais bits são definidos pode
             variar de plataforma para plataforma, e é recomendado consultar a documentação
             específica da plataforma se for necessária uma interpretação dos bits de não-permissão
             do valor de retorno.
             
             Retorna <info>false</info> em caso de falha.

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


id: filesize
type: function
doc:
<comment>Description:</comment>
  Obtém o tamanho do arquivo
  
  Obtém o tamanho do arquivo.

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

<comment>Return:</comment>
  <info>int|false</info>  Retorna o tamanho do arquivo em bytes, ou <info>false</info> (e gera um aviso <info>E_WARNING</info>) em caso de
             erro.
             
             Como o tipo inteiro do PHP possui sinal e muitas plataformas usam números inteiros de
             32 bits, algumas funções do sistema de arquivos podem retornar resultados inesperados
             para arquivos maiores que 2GB.

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


id: filetype
type: function
doc:
<comment>Description:</comment>
  Lê o tipo do arquivo
  
  Retorna o tipo do arquivo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Caminho até o arquivo.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o tipo do arquivo. Os valores possíveis são fifo, char, dir, block, link,
                file, socket e unknown (desconhecido).
                
                Retorna <info>false</info> se ocorrer algum erro. <strong>filetype()</strong> também produzirá uma mensagem
                <info>E_NOTICE</info> se a chamada stat falhar ou se o tipo do arquivo for desconhecido.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>
   * <strong>file_exists()</strong>
   * <strong>mime_content_type()</strong>
   * <strong>pathinfo()</strong>
   * <strong>stat()</strong>


id: filter_has_var
type: function
doc:
<comment>Description:</comment>
  Verifica se uma variável de um especificado tipo existe

<comment>Param:</comment>
  <info>int</info>     <strong>$input_type</strong>  Uma das constantes <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> ou
                       <info>INPUT_ENV</info>.
  <info>string</info>  <strong>$var_name</strong>    Nome da variável a ser verificada.

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


id: filter_id
type: function
doc:
<comment>Description:</comment>
  Retorna o ID de filtro pertencente a um filtro nomeado

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Nome do filtro a ser obtido.

<comment>Return:</comment>
  <info>int|false</info>  ID do filtro em caso de sucesso ou <info>false</info> se o filtro não existir.

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


id: filter_input
type: function
doc:
<comment>Description:</comment>
  Gets a specific external variable by name and optionally filters it

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>      One of <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info>, or <info>INPUT_ENV</info>.
  <info>string</info>     <strong>$var_name</strong>  Name of a variable to get.
  <info>int</info>        <strong>$filter</strong>    O ID do filtro a ser aplicado. A página do manual  lista os filtros
                        disponíveis.
                        
                        Se omitido, <info>FILTER_DEFAULT</info> será usado, que é equivalente a
                        <info>FILTER_UNSAFE_RAW</info>. Isso resultará em nenhuma filtragem ocorrendo por padrão.
  <info>array|int</info>  <strong>$options</strong>   Associative array of options or bitwise disjunction of flags. If filter
                        accepts options, flags can be provided in "flags" field of array.

<comment>Return:</comment>
  <info>mixed</info>  Value of the requested variable on success, <info>false</info> if the filter fails, or <info>null</info> if the
         <strong>$var_name</strong> variable is not set. If the flag <info>FILTER_NULL_ON_FAILURE</info> is used, it returns <info>false</info>
         if the variable is not set and <info>null</info> if the filter fails.

<comment>See Also:</comment>
   * <strong>filter_var()</strong>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_input_array
type: function
doc:
<comment>Description:</comment>
  Obtem variáveis externas e opcionalmente as filtra
  
  Esta função é útil para receber muitos valores sem repetidamente chamar a função <strong>filter_input()</strong>.

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>       Uma das constantes <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> ou
                         <info>INPUT_ENV</info>.
  <info>array|int</info>  <strong>$options</strong>    Um array definindo os argumentos. Uma chave válida é uma <info>string</info> contendo um
                         nome da variável, e um valor válido é um tipo de filtro, ou um <info>array</info>
                         opcionalmente especificando o filtro, marcas e opções. Se o valor for um
                         array, chaves válidas são <return>filter</return> que especifica o tipo de filtro, <return>flags</return> que
                         especifica quaisquer marcas que se aplicam ao filtro, e <return>options</return> que
                         especifica quaisquer opções que serão aplicadas ao filtro. Veja os exemplos
                         abaixo para um melhor entendimento.
                         
                         Este parâmetro pode ser também um inteiro contendo uma constante de filtro.
                         Desta forma, todos os valores no array de entrada serão filtradas por este
                         filtro.
  <info>bool</info>       <strong>$add_empty</strong>  Adiciona chaves faltantes como <info>null</info> ao valor de retorno.

<comment>Return:</comment>
  <info>array|false|null</info>  Um array contendo os valores das variáveis requisitads em caso de sucesso. Se o
                    array de entrada designado por <strong>$type</strong> não for preenchido, a função retorna <info>null</info>
                    se a marca <info>FILTER_NULL_ON_FAILURE</info> não for fornecida, ou <info>false</info> caso contrário.
                    Para outras falhas, <info>false</info> é retornado.
                    
                    Um valor de array será <info>false</info> se o filtro falhar, ou <info>null</info> se a variável não
                    estiver definida. Ou, se a marca <info>FILTER_NULL_ON_FAILURE</info> for usada, a função
                    retorna <info>false</info> se a variável não estiver definida e <info>null</info> se o filtro falhar. Se o
                    parâmetro <strong>$add_empty</strong> for <info>false</info>, nenhum elemento de array será adicionado para
                    variáveis não definidas.

<comment>See Also:</comment>
   * <strong>filter_input()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_list
type: function
doc:
<comment>Description:</comment>
  Retorna a lista de todos os filtros suportados

<comment>Return:</comment>
  <info>array</info>  Retorna um array de nomes de todos os filtros suportados, um array vazio se não houver
         filtros. Índices deste array não são IDs de filtros, estes podem ser obtidos com
         <strong>filter_id()</strong> a partir do nome.


id: filter_var
type: function
doc:
<comment>Description:</comment>
  Filters a variable with a specified filter

<comment>Param:</comment>
  <info>mixed</info>      <strong>$value</strong>    Value to filter. Note that scalar values are converted to string internally
                       before they are filtered.
  <info>int</info>        <strong>$filter</strong>   O ID do filtro a ser aplicado. A página do manual  lista os filtros
                       disponíveis.
                       
                       Se omitido, <info>FILTER_DEFAULT</info> será usado, que é equivalente a <info>FILTER_UNSAFE_RAW</info>.
                       Isso resultará em nenhuma filtragem ocorrendo por padrão.
  <info>array|int</info>  <strong>$options</strong>  Associative array of options or bitwise disjunction of flags. If filter
                       accepts options, flags can be provided in "flags" field of array. For the
                       "callback" filter, <info>callable</info> type should be passed.  The callback must accept
                       one argument, the value to be filtered, and return the value after
                       filtering/sanitizing it.
                       
                        array( 'default' => 3, // value to return if the filter fails // other
                       options here 'min_range' => 0 ), 'flags' => FILTER_FLAG_ALLOW_OCTAL,
                       );
                       $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
                       
                       // for filters that only accept flags, you can pass them directly
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
                       
                       // for filters that only accept flags, you can also pass as an array
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, array('flags' =>
                       FILTER_NULL_ON_FAILURE));
                       
                       // callback validate filter
                       function foo($value)
                       { // Expected format: Surname, GivenNames if (strpos($value, ", ") === false)
                       return false; list($surname, $givennames) = explode(", ", $value, 2); $empty
                       = (empty($surname) || empty($givennames)); $notstrings =
                       (!is_string($surname) || !is_string($givennames)); if ($empty || $notstrings)
                       { return false; } else { return $value; }
                       }
                       $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' =>
                       'foo'));
                       ?> ]]>

<comment>Return:</comment>
  <info>mixed</info>  Returns the filtered data, or <info>false</info> if the filter fails.

<comment>See Also:</comment>
   * <strong>filter_var_array()</strong>
   * <strong>filter_input()</strong>
   * <strong>filter_input_array()</strong>
   * 


id: filter_var_array
type: function
doc:
<comment>Description:</comment>
  Obtêm múltiplas variáveis e opcionalmente as filtra
  
  Esta função é útil para receber muitos valores sem repetidamente chamar a função <strong>filter_var()</strong>.

<comment>Param:</comment>
  <info>array</info>      <strong>$array</strong>      Um array com as chaves string contendo os dados a filtrar.
  <info>array|int</info>  <strong>$options</strong>    Um array definindo os argumentos. Uma chave válida é uma <info>string</info> contendo o
                         nome da variável, e um valor válido é um tipo de filtro ou um <info>array</info>
                         opcionalmente especificando o filtro, marcas e opções. Se o valor for um
                         array, chaves válida são <return>filter</return> que especifica o tipo de filtro, <return>flags</return> que
                         especifica alguma marca aplicada ao filtro, e <return>options</return> que especifica uma
                         opção que é aplicada ao filtro. Veja o exemplo abaixo para um melhor
                         entendimento.
                         
                         Este parâmetro pode ser também um inteiro contendo uma constante de filtro.
                         Desta forma, todos valores no array de entrada serão filtrados por este
                         filtro.
  <info>bool</info>       <strong>$add_empty</strong>  Adiciona chaves faltantes como <info>null</info> ao valor de retorno.

<comment>Return:</comment>
  <info>array|false|null</info>  Um array contendo valores das variáveis requisitadas em caso de sucesso, ou
                    <info>false</info> em caso de falha. Um valor de array será <info>false</info> se o filtro falhar, ou <info>null</info>
                    se a variável não estiver definida.

<comment>See Also:</comment>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var()</strong>
   * <strong>filter_input()</strong>
   * 


id: finfo
type: class
doc:
<comment>Description:</comment>
  Esta classe fornece uma interface orientada a objetos para as funções fileinfo.


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


id: finfo::buffer
type: function
doc:
<comment>Description:</comment>
  Sinônimo de finfo_buffer()
  
  Esta função é um apelido para:  finfo_buffer()

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


id: finfo::file
type: function
doc:
<comment>Description:</comment>
  Sinônimo de finfo_file()
  
  Esta função é um apelido para:  finfo_file()

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


id: finfo::set_flags
type: function
doc:
<comment>Description:</comment>
  Sinônimo de finfo_set_flags()
  
  Esta função é um apelido para:  finfo_set_flags()

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


id: finfo_buffer
type: function
doc:
<comment>Description:</comment>
  Retorna informações sobre um buffer de string
  
  Estilo procedural
  
  Estilo orientado a objetos
  
  Esta função é usada para obter informações sobre dados binários em uma string.

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>    Uma instância de <class>finfo</class>, retornada por <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$string</strong>   Conteúdo do arquivo a ser verificado.
  <info>int</info>            <strong>$flags</strong>    Uma ou disjunção de mais constantes Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma descrição textual do parâmetro <strong>$string</strong>, ou <info>false</info> em caso de erro.

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


id: finfo_close
type: function
doc:
<comment>Description:</comment>
  Fecha uma instância de finfo
  
  Esta função fecha uma instância aberta por <strong>finfo_open()</strong>.

<comment>Param:</comment>
  <info>finfo</info>  <strong>$finfo</strong>  Uma instância de <class>finfo</class>, retornada por <strong>finfo_open()</strong>.

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


id: finfo_file
type: function
doc:
<comment>Description:</comment>
  Retorna informações sobre um arquivo
  
  Estilo procedural
  
  Estilo orientado a objetos
  
  Esta função é usada para obter informações sobre um arquivo.

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>     Uma instância de <class>finfo</class>, retornada por <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$filename</strong>  Nome do arquivo a ser verificado.
  <info>int</info>            <strong>$flags</strong>     Uma ou disjunção de mais constantes Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>   Para uma descrição de <return>contexts</return>, consulte .

<comment>Return:</comment>
  <info>string|false</info>  Retorna uma descrição textual do conteúdo do argumento <strong>$filename</strong> ou <info>false</info> em caso de
                erro.

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


id: finfo_open
type: function
doc:
<comment>Description:</comment>
  Cria uma instância de finfo
  
  Estilo procedural
  
  Estilo orientado a objetos (construtor):
  
  Esta função abre um banco de dados mágico e retorna a instância.

<comment>Param:</comment>
  <info>int</info>          <strong>$flags</strong>           Uma ou disjunção de mais constantes Fileinfo.
  <info>string|null</info>  <strong>$magic_database</strong>  Nome de um arquivo de banco de dados mágico, geralmente algo como
                                /caminho/para/magic.mime. Se não for especificado, a variável de
                                ambiente <return>MAGIC</return> será usada. O banco de dados mágico incluído no PHP
                                será usado se a variável de ambiente não estiver definida.
                                
                                Passar <info>null</info> ou uma string vazia será equivalente ao valor padrão.

<comment>Return:</comment>
  <info>finfo|false</info>  (Apenas no estilo procedural) Retorna uma instância de <class>finfo</class> em caso de sucesso, ou
               <info>false</info> em caso de falha.

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


id: finfo_set_flags
type: function
doc:
<comment>Description:</comment>
  Define as opções de configuração da libmagic
  
  Estilo procedural
  
  Estilo orientado a objetos
  
  Esta função define várias opções de Fileinfo. As opções também podem ser definidas diretamente em
  <strong>finfo_open()</strong> ou em outras funções da Fileinfo.

<comment>Param:</comment>
  <info>finfo</info>  <strong>$finfo</strong>  Uma instância de <class>finfo</class>, retornada por <strong>finfo_open()</strong>.
  <info>int</info>    <strong>$flags</strong>  Uma ou disjunção de mais constantes Fileinfo.

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


id: floatval
type: function
doc:
<comment>Description:</comment>
  Obtém o valor em ponto flutuante da variável
  
  Obtém o valor <info>float</info> de <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Pode ser qualquer tipo escalar. <strong>floatval()</strong> não deve ser utilizada em objetos, pois
                 isso ocasionará emissão de um erro de nível <info>E_WARNING</info> e retornará 1.

<comment>Return:</comment>
  <info>float</info>  O valor em ponto flutuante da variável informada. Arrays vazios retornam 0, arrays com
         valores retoram 1.
         
         Strings provavelmente retornarão 0, embora esse comportamento dependa dos caracteres à
         esquerda da string. A regra geral de conversão para ponto flutuante é aplicada.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>intval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * Manipulação de Tipos


id: flock
type: function
doc:
<comment>Description:</comment>
  Travamento consultivo portável de arquivo
  
  <strong>flock()</strong> permite realizar um modelo simple de leitura/escrita que pode ser usado virtualmente em
  qualquer plataforma (incluindo na maioria dos derivados Unix e até mesmo no Windows).
  
  A trava é liberada também por <strong>fclose()</strong>, ou quando o fluxo <strong>$stream</strong> sofrer coleta de lixo.
  
  O PHP suporta uma maneira portável de travamento de arquivos completos de forma consultiva (que
  significa que todos programas de acesso devem usar a mesma forma de travamento ou ela não irá
  funcionar). Por padrão, esta função irá bloquear até que a trava solicitada seja adquirida; isto
  pode ser controlado com a opção <info>LOCK_NB</info> documentada abaixo.

<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>int</info>       <strong>$operation</strong>    <strong>$operation</strong> deve ser uma das opções a seguir: <info>LOCK_SH</info> para obter uma trava
                          compartilhada (leitura). <info>LOCK_EX</info> para obter uma trava exclusiva (escrita).
                          <info>LOCK_UN</info> para liberar uma trava (compartilhada ou exclusiva).
                          
                          <info>LOCK_SH</info> para obter uma trava compartilhada (leitura).
                          
                          <info>LOCK_EX</info> para obter uma trava exclusiva (escrita).
                          
                          <info>LOCK_UN</info> para liberar uma trava (compartilhada ou exclusiva).
                          
                          É possível também adicionar <info>LOCK_NB</info> como uma máscara de bits a uma das
                          operações acima, caso seja necessário que <strong>flock()</strong> não bloqueie durante a
                          tentativa de travamento.
  <info>int</info>       <strong>$would_block</strong>  O terceiro argumento opcional é definido como 1 se a trava for bloquear
                          (condição de erro número EWOULDBLOCK).

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


id: floor
type: function
doc:
<comment>Description:</comment>
  Arredonda frações para baixo
  
  Retorna o próximo menor valor inteiro (como float), arredondando <strong>$num</strong> para baixo, se necessário.

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  O valor numérico a ser arredondado

<comment>Return:</comment>
  <info>float</info>  <strong>$num</strong> arredondado para o inteiro menor mais próximo. O valor retornado por <strong>floor()</strong> ainda
         será do tipo <info>float</info>.

<comment>See Also:</comment>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: flush
type: function
doc:
<comment>Description:</comment>
  Flush system output buffer
  
  Flushes the system write buffers of PHP and whatever backend PHP is using (CGI, a web server,
  etc).  This attempts to push current output all the way to the browser with a few caveats.
  
  <strong>flush()</strong> may not be able to override the buffering scheme of your web server and it has no effect
  on any client-side buffering in the browser.  It also doesn't affect PHP's userspace output
  buffering mechanism. This means <strong>ob_flush()</strong> should be called before <strong>flush()</strong> to flush the output
  buffers if they are in use.
  
  Several servers, especially on Win32, will still buffer the output from your script until it
  terminates before transmitting the results to the browser.
  
  Server modules for Apache like mod_gzip may do buffering of their own that will cause <strong>flush()</strong> to
  not result in data being sent immediately to the client.
  
  Even the browser may buffer its input before displaying it. Netscape, for example, buffers text
  until it receives an end-of-line or the beginning of a tag, and it won't render tables until the \</table&gt; tag of the outermost table is seen.
  
  Some versions of Microsoft Internet Explorer will only start to display the page after they have
  received 256 bytes of output, so you may need to send extra whitespace before flushing to get
  those browsers to display the page.

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

<comment>See Also:</comment>
   * <strong>ob_flush()</strong>
   * <strong>ob_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: fmod
type: function
doc:
<comment>Description:</comment>
  Retorna o resto (módulo) em ponto flutuante da divisão
    dos argumentos
  
  Retorna o resto em ponto flutuante da divisão do dividendo (<strong>$num1</strong>) pelo divisor (<strong>$num2</strong>). O resto
  (r) é definido como: num1 = i * num2 + r, para algum inteiro i. Se o <strong>$num2</strong> for diferente de zero,
  r terá o mesmo sinal de <strong>$num1</strong> e uma magnitude menor que a magnitude de <strong>$num2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  O dividendo
  <info>float</info>  <strong>$num2</strong>  O divisor

<comment>Return:</comment>
  <info>float</info>  O resto em ponto flutuante de <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - Divisão de ponto flutuante
   * <return>%</return> - Módulo de inteiros
   * <strong>intdiv()</strong> - Divisão de inteiros


id: fnmatch
type: function
doc:
<comment>Description:</comment>
  Compara nome de arquivo com um padrão
  
  <strong>fnmatch()</strong> verifica se o parâmetro <strong>$filename</strong> informado corresponde com o padrão de curingas shell
  <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>   Padrão de curingas shell.
  <info>string</info>  <strong>$filename</strong>  A string testada. Esta função é especialmente útil para nomes de arquivo, mas
                     também pode ser usada em strings normais.
                     
                     O usuário comum pode estar acostumado com padrões shell ou pelo menos, na sua
                     forma mais simples, aos curingas <return>'?'</return> e <return>'*'</return>. Então usar <strong>fnmatch()</strong> ao invés de
                     <strong>preg_match()</strong> para entrada de expressões de busca na interface com o usuário
                     pode ser muito mais conveniente para não programadores.
  <info>int</info>     <strong>$flags</strong>     O valor do parâmetro <strong>$flags</strong> pode ser qualquer combinação das opções a seguir,
                     unidos com o operador binário OR (|).  Uma lista de opções possíveis para
                     <strong>fnmatch()</strong> <strong>$Flag</strong>Descrição<info>FNM_NOESCAPE</info> Desabilita escape por barra invertida.
                     <info>FNM_PATHNAME</info> Barra na string somente corresponde a barra no padrão fornecido.
                     <info>FNM_PERIOD</info> Um ponto no início da string deve corresponder a exatamente um ponto
                     no padrão fornecido. <info>FNM_CASEFOLD</info> Não diferencia maiúsculas de minúsculas.
                     Parte da extensão GNU.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se houver correspondência, <info>false</info> caso contrário.

<comment>See Also:</comment>
   * <strong>glob()</strong>
   * <strong>preg_match()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fopen
type: function
doc:
<comment>Description:</comment>
  Abre um arquivo ou URL
  
  <strong>fopen()</strong> conecta um recurso nomeado, especificado por <strong>$filename</strong>, a um fluxo.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Se <strong>$filename</strong> estiver na forma de "esquema://...", assume-se que
                                    seja uma URL, e o PHP buscará por um manipulador de protocolo
                                    (também conhecido como empacotador) para aquele esquema. Se
                                    nenhum empacotador para aquele protocolo estiver registrado, o
                                    PHP emitirá uma aviso para auxiliar no rastreio de potenciais
                                    problemas no script, e então continuará presumindo que <strong>$filename</strong>
                                    especifica um arquivo normal.
                                    
                                    Se o PHP decidiu que <strong>$filename</strong> se refere a um arquivo local,
                                    então ele tentará abrir um fluxo para aquele arquivo. O arquivo
                                    precisa ser acessível pelo PHP, portanto é necessário garantir
                                    que as permissões de acesso do arquivo possibilitem este acesso.
                                    Se estiver habilitado open_basedir, outras restrições podem se
                                    aplicar.
                                    
                                    Se o PHP decidiu que <strong>$filename</strong> se refere a um protocolo
                                    registrado e esse protocolo estiver registrado como uma URL de
                                    rede, o PHP irá verificar para ter certeza que allow_url_fopen
                                    está habilitado. Se não estiver, o PHP emitirá um alerta e a
                                    chamada ao fopen irá falhar.
                                    
                                    A lista de protocolos suportados pode ser encontrada em . Alguns
                                    protocolos (também mencionados como <return>wrappers</return>) suportam <return>context</return>
                                    e/ou opções do php.ini. Recorra à página específica do protocolo
                                    em uso para uma lista das opções que podem ser definidas. (ex.:
                                    o valor php.ini <return>user_agent</return> utilizado pelo protocolo <return>http</return>).
                                    
                                    Na plataforma Windows, tenha cuidado de escapar qualquer barra
                                    invertida usada no caminho do arquivo, ou use barras normais.
                                    ]]>
  <info>string</info>         <strong>$mode</strong>              O parâmetro <strong>$mode</strong> especifica o tipo de acesso que você precisa
                                    ao fluxo. Pode ser um dos seguintes:  Lista dos possíveis modos
                                    de <strong>fopen()</strong> utilizando <strong>$mode</strong> <strong>$mode</strong>Descrição<return>'r'</return> Abre somente para
                                    leitura; coloca o ponteiro do arquivo no começo do arquivo. <return>'r+'</return>
                                    Abre para leitura e escrita; coloca o ponteiro do arquivo no
                                    começo do arquivo. <return>'w'</return> Abre somente para escrita; coloca o
                                    ponteiro do arquivo no começo do arquivo e reduz o comprimento
                                    do arquivo para zero. Se o arquivo não existir, tenta criá-lo.
                                    <return>'w+'</return> Abre para leitura e escrita; fora isso, tem o mesmo
                                    comportamento de <return>'w'</return>. <return>'a'</return> Abre somente para escrita; coloca o
                                    ponteiro do arquivo no final do arquivo. Se o arquivo não
                                    existir, tenta criá-lo. Neste modo, <strong>fseek()</strong> não tem efeito, a
                                    escrita é sempre adicionada. <return>'a+'</return> Abre para leitura e escrita;
                                    coloca o ponteiro do arquivo no final do arquivo. Se o arquivo
                                    não existir, tenta criá-lo. Neste modo, <strong>fseek()</strong> somente afeta a
                                    posição de leitura, escrita é sempre adicionada. <return>'x'</return> Cria e abre
                                    o arquivo somente para escrita; coloca o ponteiro no começo do
                                    arquivo. Se o arquivo já existir, a chamada a <strong>fopen()</strong> falhará,
                                    retornando <info>false</info> e gerando um erro de nível <info>E_WARNING</info>. Se o
                                    arquivo não existir, tenta criá-lo. Isto é equivalente a
                                    especificar as opções <return>O_EXCL|O_CREAT</return> para a chamada de sistema
                                    <return>open(2)</return> subjacente. <return>'x+'</return> Cria e abre o arquivo para leitura e
                                    escrita; fora isso, tem o mesmo comportamento de <return>'x'</return>. <return>'c'</return> Abre o
                                    arquivo somente para escrita. Se o arquivo não existir, ele é
                                    criado. Se existir, ele não é truncado (ao contrário de <return>'w'</return>) e
                                    nem a chamada a esta função falha (como no caso de <return>'x'</return>). O
                                    ponteiro é posicionado no início do arquivo. Isto pode ser útil
                                    se for desejado obter uma trava consultiva (consulte <strong>flock()</strong>)
                                    antes de tentar modificar o arquivo, já que usar <return>'w'</return> poderia
                                    trincar o arquivo antes que a trava fosse obtida (se o
                                    truncamento for desejado, <strong>ftruncate()</strong> pode ser usando depois que
                                    a trava for requisitada). <return>'c+'</return> Abre o arquivo para leitura e
                                    escrita; fora isso, tem o mesmo comportamento de <return>'c'</return>. <return>'e'</return> Define
                                    a opção close-on-exec no descritor do arquivo aberto. Somente
                                    disponível no PHP compilado em sistemas conforme POSIX.1-2008.
                                    
                                    Diferentes famílias de sistemas operacionais têm diferentes
                                    convenções de final de linha. Quando um arquivo texto é escrito
                                    e deseja-se inserir uma quebra de linha, é necessário usar o
                                    caractere correto de fim de linha para o sistema operacional.
                                    Sistemas baseados no Unix utilizam <return>\n</return> como o caractere de fim de
                                    linha, sistemas baseados no Windows utilizam <return>\r\n</return> e sistemas
                                    baseados no Macintosh (Mac OS Classic) utilizavam <return>\r</return>.
                                    
                                    Se forem usados os caracteres de fim de linha inadequados em
                                    seus arquivos, pode ser que esses arquivos "parecer estranhos"
                                    quando forem abertos em outras aplicações.
                                    
                                    O Windows oferece uma opção de tradução do modo texto (<return>'t'</return>) que
                                    traduz, transparentemente, <return>\n</return> para <return>\r\n</return> quando estiver
                                    trabalhando com o arquivo. Em contraste, pode-se também utilizar
                                    <return>'b'</return> para forçar o modo binário, que não irá traduzir os dados.
                                    Para usar essas opções, especifique <return>'b'</return> ou <return>'t'</return> como o último
                                    caractere do parâmetro <strong>$mode</strong>.
                                    
                                    O modo de tradução padrão é <return>'b'</return>. Pode-se usar o modo <return>'t'</return> ao
                                    trabalhar com arquivos texto e usar <return>\n</return> para delimitar as linhas
                                    no script, de forma que pode-se esperar que eles sejam lidos em
                                    aplicações como versões antigas do bloco de notas. Deve-se usar
                                    <return>'b'</return> em todos os outros casos.
                                    
                                    Se for especificada a opção 't' ao trabalhar com arquivos
                                    binários, pode-se experimentar problemas estranhos com os dados,
                                    incluindo arquivos de imagens corrompidos e problemas estranhos
                                    com os caracteres <return>\r\n</return>.
                                    
                                    Para portabilidade, é fortemente recomendado que se reescreva
                                    códigos que usem ou dependam do modo <return>'t'</return> de forma que passem a
                                    usar o fim de linha correto e o modo <return>'b'</return> em seu lugar.
                                    
                                    O parâmetro <strong>$mode</strong> é ignorado para os empacotadores de fluxo
                                    php://output, php://input, php://stdin, php://stdout,
                                    php://stderr e php://fd.
  <info>bool</info>           <strong>$use_include_path</strong>  O terceiro parâmetro opcional <strong>$use_include_path</strong> pode ser
                                    definido para '1' ou <info>true</info> se for desejado buscar o arquivo
                                    também no include_path.
  <info>resource|null</info>  <strong>$context</strong>           Um <info>resource</info> de
                                    contexto de stream.

<comment>Return:</comment>
  <info>resource|false</info>  Retorna um recurso de ponteiro de arquivo em caso de sucesso, ou <info>false</info> em caso de
                  falha

<comment>See Also:</comment>
   * 
   * <strong>fclose()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>fwrite()</strong>
   * <strong>fsockopen()</strong>
   * <strong>file()</strong>
   * <strong>file_exists()</strong>
   * <strong>is_readable()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>popen()</strong>
   * <strong>stream_context_create()</strong>
   * <strong>umask()</strong>
   * <class>SplFileObject</class>


id: forward_static_call
type: function
doc:
<comment>Description:</comment>
  Call a static method
  
  Calls a user defined function or method given by the <strong>$callback</strong> parameter, with the following
  arguments. This function must be called within a method context, it can't be used outside a class.
  It uses the late static binding.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The function or method to be called. This parameter may be an array, with the
                       name of the class, and the method, or a string, with a function name.
  <info>mixed</info>     <strong>$args</strong>      Zero or more parameters to be passed to the function.

<comment>Return:</comment>
  <info>mixed</info>  Returns the function result, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>forward_static_call_array()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>call_user_func()</strong>
   * <strong>is_callable()</strong>


id: forward_static_call_array
type: function
doc:
<comment>Description:</comment>
  Call a static method and pass the arguments as array
  
  Calls a user defined function or method given by the <strong>$callback</strong> parameter. This function must be
  called within a method context, it can't be  used outside a class. It uses the late static
  binding. All arguments of the forwarded method are passed as values, and as an array, similarly to
  <strong>call_user_func_array()</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>   The function or method to be called. This parameter may be an <info>array</info>, with
                        the name of the class, and the method, or a <info>string</info>, with a function name.
  <info></info>          <strong>$parameter</strong>  One parameter, gathering all the method parameter in one array.
                        
                        Note that the parameters for <strong>forward_static_call_array()</strong> are not passed by
                        reference.

<comment>Return:</comment>
  <info>mixed</info>  Returns the function result, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>forward_static_call()</strong>
   * <strong>call_user_func()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>is_callable()</strong>


id: fpassthru
type: function
doc:
<comment>Description:</comment>
  Imprime todo os dados restantes de um ponteiro de arquivo
  
  Lê até o fim do arquivo (EOF) do ponteiro de arquivo dado e imprime os resultados para a buffer de
  saída.
  
  Pode ser necessário chamar <strong>rewind()</strong> para redefinir o ponteiro do arquivo para início do arquivo se
  dados já tiverem sido escritos no arquivo.
  
  Se for desejado apenas descarregar o conteúdo de um arquivo para o buffer de saída, sem primeiro
  modificá-lo ou deslocar o ponteiro até uma posição, pode-se usar a função <strong>readfile()</strong>, que vai
  economizar uma chamada à função <strong>fopen()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>int</info>  Retorna o número de caracteres lidos do fluxo <strong>$stream</strong> e passados para a saída.

<comment>See Also:</comment>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>


id: fpm_get_status
type: function
doc:
<comment>Description:</comment>
  Returns the current FPM pool status
  
  This function returns the full current FPM pool status as an associative array. It always returns
  the full status, including per-process status information. See the FPM status page guide for
  further details.
  
  Note that this function will only be defined if FPM is being used to serve the script.

<comment>Return:</comment>
  <info>array|false</info>  Associative array containing the full FPM pool status, ou <info>false</info> em caso de falha.


id: fprintf
type: function
doc:
<comment>Description:</comment>
  Escreve uma string formatada para um fluxo
  
  Escreve uma string produzida de acordo com o formato em <strong>$format</strong> para o recurso de fluxo
  especificado por <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>$format</strong>  A string de formato é composta de zero ou mais diretivas: caracteres comuns
                     (excluindo <return>%</return>) que são copiados diretamente para o resultado e especificações de
                     conversão, cada uma das quais resulta na busca de seu próprio parâmetro.
                     
                     Uma especificação de conversão segue este protótipo:
                     <return>%[argnum$][flags][width][.precision]especificador</return>.
                     
                     Um número inteiro seguido por um cifrão <return>$</return>, para especificar qual o número de
                     argumento a tratar na conversão.
                     
                     FlagsFlagDescrição<return>-</return> Justificar à esquerda dentro da largura de campo
                     especificada; A justificação à direita é o padrão. <return>+</return> Prefixa números positivos
                     com um sinal de mais <return>+</return>; Por padrão, apenas números negativos são prefixados com
                     um sinal negativo. <return> </return>(espaço) Preenche o resultado com espaços. Este é o padrão.
                     <return>0</return> Preenche números com zeros apenas à esquerda. Com os especificadores <return>s</return>,
                     também pode preencher com zeros à direita. <return>'</return>(char) Preenche o resultado com o
                     caractere (char).
                     
                     Um número inteiro que define em quantos caracteres (mínimo) esta conversão deve
                     resultar, ou <return>*</return>. Se <return>*</return> for usado, a largura será fornecida como um valor inteiro
                     adicional precedendo aquele formatado pelo especificador.
                     
                     Um ponto <return>.</return> opcionalmente seguido por um número inteiro ou <return>*</return>, cujo significado
                     depende do especificador:  Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número
                     de dígitos a serem impressos após o ponto decimal (por padrão, é 6).  Para os
                     especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos significativos a
                     serem impressos.  Para o especificador <return>s</return>: atua como um ponto de corte,
                     definindo um limite máximo de caracteres para a string.   Se o ponto for
                     especificado sem um valor explícito para precisão, 0 é assumido. Se <return>*</return> for
                     usado, a precisão é fornecida como um valor inteiro adicional precedendo aquele
                     formatado pelo especificador.
                     
                     Para os especificadores <return>e</return>, <return>E</return>, <return>f</return> e <return>F</return>: este é o número de dígitos a serem
                     impressos após o ponto decimal (por padrão, é 6).
                     
                     Para os especificadores <return>g</return>, <return>G</return>, <return>h</return> e <return>H</return>: este é o número máximo de dígitos
                     significativos a serem impressos.
                     
                     Para o especificador <return>s</return>: atua como um ponto de corte, definindo um limite máximo
                     de caracteres para a string.
                     
                     Se o ponto for especificado sem um valor explícito para precisão, 0 é assumido.
                     Se <return>*</return> for usado, a precisão é fornecida como um valor inteiro adicional
                     precedendo aquele formatado pelo especificador.
                     
                     EspecificadoresEspecificadorDescrição<return>%</return> Um caractere literal de porcentagem.
                     Nenhum argumento é necessário. <return>b</return> O argumento é tratado como um número inteiro e
                     apresentado como um número binário. <return>c</return> O argumento é tratado como um número
                     inteiro e apresentado como o caractere com aquele código ASCII. <return>d</return> O argumento é
                     tratado como um número inteiro e apresentado como um número decimal (com
                     sinal). <return>e</return> O argumento é tratado como notação científica (por exemplo, 1.2e+2).
                     <return>E</return> Como o especificador <return>e</return>, mas usa letra maiúscula (por exemplo, 1.2E+2). <return>f</return> O
                     argumento é tratado como um float e apresentado como um número de ponto
                     flutuante (com reconhecimento da localidade). <return>F</return> O argumento é tratado como um
                     float e apresentado como um número de ponto flutuante (sem reconhecimento da
                     localidade). <return>g</return> Formato geral.  Deixa P igual à precisão se for diferente de
                     zero, 6 se a precisão for omitida, ou 1 se a precisão for zero. Então, se uma
                     conversão com estilo E tivesse um expoente de X:  Se P &gt; X ≥ −4, a conversão
                     é com estilo f e precisão P − (X + 1). Caso contrário, a conversão é com estilo
                     e e precisão P − 1. <return>G</return> Como o especificador <return>g</return>, mas usa <return>E</return> e <return>f</return>. <return>h</return> Como o
                     especificador <return>g</return>, mas usa <return>F</return>. Disponível a partir do PHP 8.0.0. <return>H</return> Como o
                     especificador <return>g</return>, mas usa <return>E</return> e <return>F</return>. Disponível a partir do PHP 8.0.0. <return>o</return> O argumento
                     é tratado como um número inteiro e apresentado como um número octal. <return>s</return> O
                     argumento é tratado e apresentado como uma string. <return>u</return> O argumento é tratado como
                     um número inteiro e apresentado como um número decimal sem sinal. <return>x</return> O argumento
                     é tratado como um número inteiro e apresentado como um número hexadecimal (com
                     letras minúsculas). <return>X</return> O argumento é tratado como um número inteiro e
                     apresentado como um número hexadecimal (com letras maiúsculas).
                     
                     Formato geral.
                     
                     Deixa P igual à precisão se for diferente de zero, 6 se a precisão for omitida,
                     ou 1 se a precisão for zero. Então, se uma conversão com estilo E tivesse um
                     expoente de X:
                     
                     Se P &gt; X ≥ −4, a conversão é com estilo f e precisão P − (X + 1). Caso
                     contrário, a conversão é com estilo e e precisão P − 1.
                     
                     O especificador de tipo <return>c</return> ignora preenchimento e largura.
                     
                     Tentar usar uma combinação dos especificadores de string e largura com
                     conjuntos de caracteres que requerem mais de um byte por caractere pode
                     resultar em resultados inesperados.
                     
                     As variáveis serão forçadas a um tipo adequado para o especificador: Tratamento
                     de TiposTipoEspecificadores<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>, <return>F</return>, <return>g</return>, <return>G</return>,
                     <return>h</return>, <return>H</return>
  <info>mixed</info>     <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  Retorna o tamanho da string escrita.

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: fputcsv
type: function
doc:
<comment>Description:</comment>
  Formata a linha como CSV e a escreve em um ponteiro de arquivo
  
  <strong>fputcsv()</strong> formata uma linha (passada como um array de campos <strong>$fields</strong>) como CSV e a escreve
  (terminando com uma nova linha) no fluxo de arquivo especificado por <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     O ponteiro de arquivo deve ser válido e deve apontar para
                        um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                        <strong>fsockopen()</strong> (e ainda não fechado por
                        <strong>fclose()</strong>).
  <info>array</info>     <strong>$fields</strong>     Um array de <info>string</info>s.
  <info>string</info>    <strong>$separator</strong>  O parâmetro opcional <strong>$separator</strong> configura o caractere delimitador (apenas um
                        caractere de um byte).
  <info>string</info>    <strong>$enclosure</strong>  O parâmetro opcional <strong>$enclosure</strong> configura o caractere que envolve os dados
                        (apenas um caractere de um byte).
  <info>string</info>    <strong>$escape</strong>     O parâmetro opcional <strong>$escape</strong> configura o caractere de escape (no máximo um
                        caractere de um byte). Uma string vazia (<return>""</return>) desabilita o mecanismo de
                        escape proprietário.
  <info>string</info>    <strong>$eol</strong>        O parâmetro opcional <strong>$eol</strong> define uma sequencia customizada de Fim de Linha.

<comment>Return:</comment>
  <info>int|false</info>  Retorna o comprimento da string escrita  ou <info>false</info> em caso de falha.

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


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


id: fread
type: function
doc:
<comment>Description:</comment>
  Leitura de arquivo segura para binário
  
  <strong>fread()</strong> lê até <strong>$length</strong> bytes do ponteiro de arquivo informado em <strong>$stream</strong>. A leitura é interrompida
  quando uma das seguintes condições são satisfeitas: <strong>$length</strong> bytes foram lidos  EOF (final do
  arquivo) é alcançado  um pacote tornou-se disponível ou o  limite de tempo de socket foi atingido
  (para fluxos de rede)  se o fluxo é lido com buffer e não representa um arquivo, é realizada no
  máximo uma leitura de até o número de bytes igual ao tamanho do bloco (normalmente 8192);
  dependendo dos dados previamente armazenados em buffer, o tamanho dos dados retornados pode ser
  maior que o tamanho do bloco.
  
  <strong>$length</strong> bytes foram lidos
  
  EOF (final do arquivo) é alcançado
  
  um pacote tornou-se disponível ou o  limite de tempo de socket foi atingido (para fluxos de rede)
  
  se o fluxo é lido com buffer e não representa um arquivo, é realizada no máximo uma leitura de até
  o número de bytes igual ao tamanho do bloco (normalmente 8192); dependendo dos dados previamente
  armazenados em buffer, o tamanho dos dados retornados pode ser maior que o tamanho do bloco.

<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>int</info>       <strong>$length</strong>  Limite de até <strong>$length</strong> bytes lidos.

<comment>Return:</comment>
  <info>string|false</info>  Retorna a string lida  ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * <strong>fwrite()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fscanf()</strong>
   * <strong>file()</strong>
   * <strong>fpassthru()</strong>
   * <strong>fseek()</strong>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>
   * <strong>unpack()</strong>


id: frenchtojd
type: function
doc:
<comment>Description:</comment>
  Converts a date from the French Republican Calendar to a Julian Day Count
  
  Converts a date from the French Republican Calendar to a Julian Day Count.
  
  These routines only convert dates in years 1 through 14 (Gregorian dates 22 September 1792 through
  22 September 1806). This more than covers the period when the calendar was in use.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  The month as a number from 1 (for Vendémiaire) to 13 (for the period of 5-6 days at
               the end of each year)
  <info>int</info>  <strong>$day</strong>    The day as a number from 1 to 30
  <info>int</info>  <strong>$year</strong>   The year as a number between 1 and 14

<comment>Return:</comment>
  <info>int</info>  The julian day for the given french revolution date as an integer.

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


id: fscanf
type: function
doc:
<comment>Description:</comment>
  Interpreta a leitura de um arquivo de acordo com um formato
  
  A função <strong>fscanf()</strong> é semelhante à <strong>sscanf()</strong>, mas usa como entrada um arquivo associado com o fluxo
  <strong>$stream</strong> e interpreta a entrada de acordo com o especificado em <strong>$format</strong>.
  
  Qualquer espaço em branco na string do formato corresponde a quaisquer espaços em branco no fluxo
  de entrada. Isto significa que até mesmo uma tabulação (<return>\t</return>) na string do formato pode corresponder
  a um único caractere de espaço no fluxo de entrada.
  
  Cada chamada a <strong>fscanf()</strong> lê uma linha do arquivo.

<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>$format</strong>  O formato interpretado para <strong>$string</strong>, que é descrito na documentação para
                     <strong>sprintf()</strong> com as seguintes diferenças:  A função não reconhece a localidade. <return>F</return>,
                     <return>g</return>, <return>G</return> e <return>b</return> não são suportados. <return>D</return> significa número decimal. <return>i</return> significa inteiro
                     com detecção de base. <return>n</return> representa o número de caracteres processados até o
                     momento. <return>s</return> pára de ler em qualquer caractere de espaço em branco. <return>*</return> em vez de
                     <return>argnum$</return> suprime a atribuição desta especificação de conversão.
  <info>mixed</info>     <strong>$vars</strong>    Os valores opcionais atribuídos.

<comment>Return:</comment>
  <info>array|int|false|null</info>  Se somente dois parâmetros forem passados a esta função, os valores
                        interpretados serão retornados como um array. Do contrário, se parâmetros
                        opcionais forem passados, a função retornará o número de valores atribuídos.
                        Os parâmetros opcionais devem ser passados por referência.
                        
                        Se houver mais substrings esperadas no parâmetro <strong>$format</strong> do que estiverem
                        disponíveis na <strong>$string</strong>, <info>null</info> será retornado. Para outros erros, <info>false</info> será
                        retornado.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fseek
type: function
doc:
<comment>Description:</comment>
  Procura (seeks) em um ponteiro de arquivo
  
  Modifica o indicador de posição do arquivo referenciado por <strong>$stream</strong>. A nova posição, medida em
  bytes a partir do início do arquivo, é obtida ao adicionar <strong>$offset</strong> à posição especificada por
  <strong>$whence</strong>.
  
  Geralmente é permitido procurar (seek) além do fim-do-arquivo; se algum dado for então escrito,
  leituras além de qualquer região escrita entre o fim-do-arquivo e a região desejada irão trazer
  bytes com valor 0. Entretanto, alguns fluxos (streams) podem não suportar esse comportamento,
  especialmente quando têm definido um tamanho de armazenamento fixo.

<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>int</info>       <strong>$offset</strong>  A posição.
                     
                     Para mover até uma posição anterior ao fim-do-arquivo, você precisa passar um
                     valor negativo no <strong>$offset</strong> e definir o parâmetro <strong>$whence</strong> para <info>SEEK_END</info>.
  <info>int</info>       <strong>$whence</strong>  Valores de <strong>$whence</strong> são: <info>SEEK_SET</info> - Define a posição igual ao <strong>$offset</strong>
                     bytes.<info>SEEK_CUR</info> - Define a posição para a atual localização mais
                     <strong>$offset</strong>.<info>SEEK_END</info> - Define a posição para o final do arquivo mais <strong>$offset</strong>.

<comment>Return:</comment>
  <info>int</info>  Em caso de sucesso, retorna 0; caso contrário, retorna -1.

<comment>See Also:</comment>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>


id: fsockopen
type: function
doc:
<comment>Description:</comment>
  Abre uma conexão socket de domínio Unix ou Internet
  
  Inicia uma conexão socket para o recurso especificado em <strong>$hostname</strong>.
  
  O PHP suporta alvos na Internet ou domínios Unix, conforme descrito em . Uma lista dos transportes
  suportados pode ser encontrada utilizando-se a função <strong>stream_get_transports()</strong>.
  
  Por padrão o socket será aberto em modo de bloqueio. Pode-se mudar para o modo de não-bloqueio
  utilizando-se a função <strong>stream_set_blocking()</strong>.
  
  A função <strong>stream_socket_client()</strong> é similar mas fornece um número maior de opções, incluindo conexão
  não bloqueada e a habilidade de fornecer um contexto de fluxo .

<comment>Param:</comment>
  <info>string</info>      <strong>$hostname</strong>       Se o suporte Open SSL estiver instalado, pode-se prefixar o <strong>$hostname</strong>
                              com <return>ssl://</return> ou <return>tls://</return> para utilizar uma conexão SSL ou TLS sobre TCP/IP
                              para conectar-se ao servidor remoto.
  <info>int</info>         <strong>$port</strong>           O número da porta. Pode ser omitido e ignorado com <return>-1</return> para transportes
                              que não usam portas, como <return>unix://</return>.
  <info>int</info>         <strong>$error_code</strong>     Se informado, guarda o número do erro do sistema que aconteceu na
                              chamada de <return>connect()</return> no nível do sistema.
                              
                              Se o valor retornado em <strong>$error_code</strong> for <return>0</return> e a função retornou <info>false</info>, é
                              uma indicação que o erro aconteceu antes da chamada a <return>connect()</return>. A
                              causa mais provável é um problema na inicialização do socket.
  <info>string</info>      <strong>$error_message</strong>  A mensagem de erro como uma string.
  <info>float|null</info>  <strong>$timeout</strong>        Limite de tempo de conexão, em segundos. Quando igual a <info>null</info>, a
                              configuração default_socket_timeout php.ini é usada.
                              
                              Se for necessário um limite de tempo para ler/escrever dados através
                              do socket, use <strong>stream_set_timeout()</strong>, já que o parâmetro <strong>$timeout</strong> de
                              <strong>fsockopen()</strong> somente é aplicável enquanto o socket estiver conectando.

<comment>Return:</comment>
  <info>resource|false</info>  <strong>fsockopen()</strong> retorna um ponteiro de arquivo que pode ser usado em em conjunto com
                  outras funções de arquivo (como <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fwrite()</strong>, <strong>fclose()</strong> e <strong>feof()</strong>).
                  Se a chamada falhar, ela retornará <info>false</info>.

<comment>See Also:</comment>
   * <strong>pfsockopen()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * <strong>socket_connect()</strong>
   * A extensão Curl


id: fstat
type: function
doc:
<comment>Description:</comment>
  Lê informações sobre um arquivo usando um ponteiro de arquivo aberto
  
  Obtêm estatísticas do arquivo aberto pelo ponteiro de arquivos <strong>$stream</strong>. Esta função é similar à
  função <strong>stat()</strong> exceto que ela opera em um ponteiro de arquivo aberto ao invés de um nome de
  arquivo.

<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>.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array com as estatísticas de um arquivo. O formato do array é descrito em
               detalhes na página do manual sobre <strong>stat()</strong>. Returns <info>false</info> on failure.


id: fsync
type: function
doc:
<comment>Description:</comment>
  Sincroniza mudanças ao arquivo (incluindo metadados)
  
  Este função sincroniza mudanças ao arquivo, incluindo seus metadados. Isto é semelhante a
  <strong>fflush()</strong>, mas também instrui o sistema operacional a escrever na mídia de armazenamento.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo deve ser válido e deve apontar para
                     um arquivo aberto com sucesso por <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (e ainda não fechado por
                     <strong>fclose()</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>fdatasync()</strong>
   * <strong>fflush()</strong>


id: ftell
type: function
doc:
<comment>Description:</comment>
  Retorna a posição atual do ponteiro de leitura/gravação do arquivo
  
  Retorna a posição do ponteiro do arquivo referenciado por <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  O ponteiro de arquivo precisa ser válido, e deve apontar para um arquivo aberto
                     com sucesso por <strong>fopen()</strong> ou <strong>popen()</strong>. <strong>ftell()</strong> dá resultados indefinidos para
                     fluxos no modo de acréscimo (abertos com a opção "a").

<comment>Return:</comment>
  <info>int|false</info>  Retorna a posição do ponteiro do arquivo referenciado por <strong>$stream</strong> como um inteiro; isto
             é, seu deslocamento no fluxo do arquivo.
             
             Se um erro ocorrer, retorna <info>false</info>.
             
             Como o tipo inteiro do PHP possui sinal e muitas plataformas usam números inteiros de
             32 bits, algumas funções do sistema de arquivos podem retornar resultados inesperados
             para arquivos maiores que 2GB.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fseek()</strong>
   * <strong>rewind()</strong>


id: ftok
type: function
doc:
<comment>Description:</comment>
  Convert a pathname and a project identifier to a System V IPC key
  
  The function converts the <strong>$filename</strong> of an existing accessible file and a project identifier into
  an <return>integer</return> for use with for example <strong>shmop_open()</strong> and other System V IPC keys.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    Path to an accessible file.
  <info>string</info>  <strong>$project_id</strong>  Project identifier. This must be a one character string.

<comment>Return:</comment>
  <info>int</info>  On success the return value will be the created key value, otherwise <return>-1</return> is returned.

<comment>See Also:</comment>
   * <strong>shmop_open()</strong>
   * <strong>sem_get()</strong>


id: ftp_alloc
type: function
doc:
<comment>Description:</comment>
  Allocates space for a file to be uploaded
  
  Sends an <return>ALLO</return> command to the remote FTP server to  allocate space for a file to be uploaded.
  
  Many FTP servers do not support this command.  These servers may return a failure  code (<info>false</info>)
  indicating the command is not supported or a success code (<info>true</info>) to indicate that pre-allocation
  is not necessary and the client should continue as though the operation were successful.  Because
  of this, it may be best to reserve this function for servers which explicitly require
  preallocation.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Uma instância de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$size</strong>      The number of bytes to allocate.
  <info>string</info>          <strong>$response</strong>  A textual representation of the servers response will be returned by
                             reference in <strong>$response</strong> if a variable is provided.

<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>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_append
type: function
doc:
<comment>Description:</comment>
  Append the contents of a file to another file on the FTP server
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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


id: ftp_cdup
type: function
doc:
<comment>Description:</comment>
  Muda para o diretório acima
  
  Muda para o diretório acima.

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

<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>ftp_chdir()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chdir
type: function
doc:
<comment>Description:</comment>
  Muda o diretório atual em um servidor FTP
  
  Muda o diretório atual para o especificado.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  O diretório de destino.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se houver falha ao mudar o
        diretório, o PHP também irá disparar um alerta.

<comment>See Also:</comment>
   * <strong>ftp_cdup()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chmod
type: function
doc:
<comment>Description:</comment>
  Define as permissões de um arquivo via FTP
  
  Estabelece as permissões para o arquivo remoto especificado para <strong>$permissions</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>          Uma instância de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$permissions</strong>  As novas permissões, informadas em valor octal.
  <info>string</info>          <strong>$filename</strong>     O arquivo remoto.

<comment>Return:</comment>
  <info>int|false</info>  Retorna as novas permissões em caso de sucesso ou <info>false</info> em caso de erro.

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


id: ftp_close
type: function
doc:
<comment>Description:</comment>
  Fecha uma conexão FTP
  
  <strong>ftp_close()</strong> fecha o identificador de conexão informado e libera o recurso (<info>resource</info>).
  
  Após a chamada a esta função, não se pode mais usar a conexão FTP e deve-se criar uma nova com
  <strong>ftp_connect()</strong>.

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

<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>ftp_connect()</strong>


id: ftp_connect
type: function
doc:
<comment>Description:</comment>
  Opens an FTP connection
  
  <strong>ftp_connect()</strong> opens an FTP connection to the specified <strong>$hostname</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 in seconds 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_close()</strong>
   * <strong>ftp_ssl_connect()</strong>


id: ftp_delete
type: function
doc:
<comment>Description:</comment>
  Exclui um arquivo no servidor FTP
  
  <strong>ftp_delete()</strong> apaga o arquivo especificado por <strong>$filename</strong> do servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$filename</strong>  O arquivo a ser excluído.

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


id: ftp_exec
type: function
doc:
<comment>Description:</comment>
  Solicita a execução de um comando no servidor FTP
  
  Envia uma solicitação de comando SITE EXEC especificada no parâmetro <strong>$command</strong> para o servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$command</strong>  O comando a executar.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se o comando for bem sucedido (o servidor enviou o código de resposta: <return>200</return>);
        caso contrário retorna <info>false</info>.

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


id: ftp_fget
type: function
doc:
<comment>Description:</comment>
  Downloads a file from the FTP server and saves to an open file
  
  <strong>ftp_fget()</strong> retrieves <strong>$remote_filename</strong> from the FTP server, and writes it to the given file
  pointer.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>resource</info>        <strong>$stream</strong>           An open file pointer in which we store the data.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start downloading from.

<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>ftp_get()</strong>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_fget()</strong>


id: ftp_fput
type: function
doc:
<comment>Description:</comment>
  Uploads from an open file to the FTP server
  
  <strong>ftp_fput()</strong> uploads the data from a file pointer to a remote file on the FTP server.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>resource</info>        <strong>$stream</strong>           An open file pointer on the local file. Reading stops at end of
                                    file.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start uploading to.

<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>ftp_put()</strong>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_put()</strong>


id: ftp_get
type: function
doc:
<comment>Description:</comment>
  Downloads a file from the FTP server
  
  <strong>ftp_get()</strong> retrieves a remote file from the FTP server, and saves it into a local file.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$local_filename</strong>   The local file path (will be overwritten if the file already
                                    exists).
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start downloading from.

<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>ftp_pasv()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_fget()</strong>


id: ftp_get_option
type: function
doc:
<comment>Description:</comment>
  Obtém várias opções em tempo de execução da conexão FTP atual
  
  Esta função retorna o valor da opção solicitada no parâmetro <strong>$option</strong> em relação à conexão FTP
  especificada.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     Uma instância de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$option</strong>  Atualmente, as seguintes opções são suportadas: Opções em tempo de
                           execução do FTP suportadas<info>FTP_TIMEOUT_SEC</info> Retorna o limite de tempo usado
                           atualmente para as operações de rede. <info>FTP_AUTOSEEK</info> Retorna <info>true</info> se esta
                           opção estiver ativa, <info>false</info> caso contrário.

<comment>Return:</comment>
  <info>int|bool</info>  Retorna o valor em caso de sucesso ou <info>false</info> se a opção indicada em <strong>$option</strong> não for
            suportada. Neste caso, uma mensagem de alerta também é emitida.

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


id: ftp_login
type: function
doc:
<comment>Description:</comment>
  Realiza o login em uma conexão FTP
  
  Realiza o login na conexão FTP informada.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$username</strong>  O nome de usuário (<return>USER</return>).
  <info>string</info>          <strong>$password</strong>  A senha (<return>PASS</return>).

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Se o login falhar, o PHP também
        emitirá um alerta.


id: ftp_mdtm
type: function
doc:
<comment>Description:</comment>
  Retorna o horário da última modificação do arquivo informado
  
  <strong>ftp_mdtm()</strong> retorna o horário da última modificação de um arquivo remoto.
  
  Nem todos os servidores suportam este recurso!
  
  <strong>ftp_mdtm()</strong> não funciona com diretórios.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$filename</strong>  O arquivo do qual será extraído o horário da última modificação.

<comment>Return:</comment>
  <info>int</info>  Retorna o horário da última modificação como um timestamp Unix local em caso de sucesso, ou
       -1 em caso de erro.


id: ftp_mkdir
type: function
doc:
<comment>Description:</comment>
  Cria um diretório
  
  Cria o diretório especificado pelo parâmetro <strong>$directory</strong> no servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  O nome do diretório que será criado.

<comment>Return:</comment>
  <info>string|false</info>  Retorna o nome do diretório recém criado em caso de sucesso ou <info>false</info> em caso de
                erro.

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


id: ftp_mlsd
type: function
doc:
<comment>Description:</comment>
  Returns a list of files in the given directory

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  The directory to be listed.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array of arrays with file infos from the specified directory on success or
               <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>ftp_rawlist()</strong>
   * <strong>ftp_nlist()</strong>


id: ftp_nb_continue
type: function
doc:
<comment>Description:</comment>
  Continua a receber/enviar um arquivo (sem bloquear)
  
  Continua a receber/enviar um arquivo sem bloquear.

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

<comment>Return:</comment>
  <info>int</info>  Retorna <info>FTP_FAILED</info>, <info>FTP_FINISHED</info> ou <info>FTP_MOREDATA</info>.


id: ftp_nb_fget
type: function
doc:
<comment>Description:</comment>
  Retrieves a file from the FTP server and writes it to an open file (non-blocking)
  
  <strong>ftp_nb_fget()</strong> retrieves a remote file from the FTP  server.
  
  The difference between this function and <strong>ftp_fget()</strong> is  that this function retrieves the file
  asynchronously, so your program can  perform other operations while the file is being downloaded.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>resource</info>        <strong>$stream</strong>           An open file pointer in which we store the data.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start downloading from.

<comment>Return:</comment>
  <info>int</info>  Returns <info>FTP_FAILED</info> or <info>FTP_FINISHED</info> or <info>FTP_MOREDATA</info>.

<comment>See Also:</comment>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_get()</strong>


id: ftp_nb_fput
type: function
doc:
<comment>Description:</comment>
  Stores a file from an open file to the FTP server (non-blocking)
  
  <strong>ftp_nb_fput()</strong> uploads the data from a file pointer to a remote file on the FTP server.
  
  The difference between this function and the <strong>ftp_fput()</strong>  is that this function uploads the file
  asynchronously, so your program can perform other operations while the file is being uploaded.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>resource</info>        <strong>$stream</strong>           An open file pointer on the local file. Reading stops at end of
                                    file.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start uploading to.

<comment>Return:</comment>
  <info>int</info>  Returns <info>FTP_FAILED</info> or <info>FTP_FINISHED</info> or <info>FTP_MOREDATA</info>.

<comment>See Also:</comment>
   * <strong>ftp_nb_put()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_nb_get
type: function
doc:
<comment>Description:</comment>
  Retrieves a file from the FTP server and writes it to a local file (non-blocking)
  
  <strong>ftp_nb_get()</strong> retrieves a remote file from the FTP server, and saves it into a local file.
  
  The difference between this function and <strong>ftp_get()</strong> is that this function retrieves the file
  asynchronously, so your program can perform  other operations while the file is being downloaded.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$local_filename</strong>   The local file path (will be overwritten if the file already
                                    exists).
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start downloading from.

<comment>Return:</comment>
  <info>int|false</info>  Returns <info>FTP_FAILED</info> or <info>FTP_FINISHED</info> or <info>FTP_MOREDATA</info>, or <info>false</info> on failure to open the
             local file.

<comment>See Also:</comment>
   * <strong>ftp_nb_fget()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_fget()</strong>
   * <strong>ftp_get()</strong>


id: ftp_nb_put
type: function
doc:
<comment>Description:</comment>
  Stores a file on the FTP server (non-blocking)
  
  <strong>ftp_nb_put()</strong> stores a local file on the FTP server.
  
  The difference between this function and the <strong>ftp_put()</strong> is that this function uploads the file
  asynchronously, so your program can perform other operations while the file is being uploaded.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>string</info>          <strong>$local_filename</strong>   The local file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start uploading to.

<comment>Return:</comment>
  <info>int|false</info>  Returns <info>FTP_FAILED</info> or <info>FTP_FINISHED</info> or <info>FTP_MOREDATA</info>, or <info>false</info> on failure to open the
             local file.

<comment>See Also:</comment>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_continue()</strong>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_nlist
type: function
doc:
<comment>Description:</comment>
  Retorna uma lista de arquivos em um diretório

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  O diretório a ser listado. Este parâmetro também pode incluir
                              argumentos, ex.: <return>ftp_nlist($ftp, "-la /your/dir");</return>. Note que este
                              parâmetro não é escapado, portanto pode haver alguns problemas com
                              nomes de arquivo contendo espaços e outros caracteres.

<comment>Return:</comment>
  <info>array|false</info>  Retorna um array com os nomes dos arquivos do diretório especificado em caso de
               sucesso, ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>ftp_rawlist()</strong>
   * <strong>ftp_mlsd()</strong>


id: ftp_pasv
type: function
doc:
<comment>Description:</comment>
  Liga ou desliga o modo passivo
  
  <strong>ftp_pasv()</strong> liga ou desliga o modo passivo. No modo passivo, as conexões de dados são iniciadas
  pelo cliente, e não pelo servidor. Pode ser necessário se o cliente estiver atrás de um firewall.
  
  Note que <strong>ftp_pasv()</strong> somente pode ser chamada depois do login ter sido feito com sucesso, caso
  contrário irá falhar.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     Uma instância de <class>FTP\Connection</class>.
  <info>bool</info>            <strong>$enable</strong>  Se <info>true</info>, o modo passivo será ligado, senão será desligado.

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


id: ftp_put
type: function
doc:
<comment>Description:</comment>
  Uploads a file to the FTP server
  
  <strong>ftp_put()</strong> stores a local file on the FTP server.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$remote_filename</strong>  The remote file path.
  <info>string</info>          <strong>$local_filename</strong>   The local file path.
  <info>int</info>             <strong>$mode</strong>             The transfer mode. Must be either <info>FTP_ASCII</info> or <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           The position in the remote file to start uploading to.

<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>ftp_pasv()</strong>
   * <strong>ftp_fput()</strong>
   * <strong>ftp_nb_fput()</strong>
   * <strong>ftp_nb_put()</strong>


id: ftp_pwd
type: function
doc:
<comment>Description:</comment>
  Retorna o nome do diretório atual

<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 nome do diretório atual ou <info>false</info> em caso de erro.

<comment>See Also:</comment>
   * <strong>ftp_chdir()</strong>
   * <strong>ftp_cdup()</strong>


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


id: ftp_raw
type: function
doc:
<comment>Description:</comment>
  Envia um comando arbritário a um servidor FTP
  
  Envia um comando arbritário, especificado no parâmetro <strong>$command</strong>, ao servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$command</strong>  O comando a executar.

<comment>Return:</comment>
  <info>array|null</info>  Retorna a resposta do servidor como um array de strings, ou <info>null</info> em caso de falha.
              Nenhuma interpretação é realizada na string de resposta, e <strong>ftp_raw()</strong> não determina se
              o comando foi bem sucedido .

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


id: ftp_rawlist
type: function
doc:
<comment>Description:</comment>
  Returns a detailed list of files in the given directory
  
  <strong>ftp_rawlist()</strong> executes the FTP  LIST command, and returns the result as an array.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  The directory path. May include arguments for the LIST command.
  <info>bool</info>            <strong>$recursive</strong>  If set to <info>true</info>, the issued command will be LIST -R.

<comment>Return:</comment>
  <info>array|false</info>  Returns an array where each element corresponds to one line of text. Returns <info>false</info>
               when passed <strong>$directory</strong> is invalid.
               
               The output is not parsed in any way. The system type identifier returned by
               <strong>ftp_systype()</strong> can be used to determine how the results  should be interpreted.

<comment>See Also:</comment>
   * <strong>ftp_nlist()</strong>
   * <strong>ftp_mlsd()</strong>


id: ftp_rename
type: function
doc:
<comment>Description:</comment>
  Renomeia um arquivo ou um diretório no servidor FTP
  
  <strong>ftp_rename()</strong> renomeia um arquivo ou diretório no servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>   Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$from</strong>  O nome atual do arquivo/diretório.
  <info>string</info>          <strong>$to</strong>    O novo nome para o qual se deseja renomear.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha. Em caso de falha (como em
        tentativa de renomear um arquivo que não existe), um erro de nível <return>E_WARNING</return> será emitido.


id: ftp_rmdir
type: function
doc:
<comment>Description:</comment>
  Remove um diretório
  
  Remove o <strong>$directory</strong> especificado no servidor FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  O diretório a excluir. Isto deve set um caminho absoluto ou relativo a
                              um diretório vazio.

<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>ftp_mkdir()</strong>


id: ftp_set_option
type: function
doc:
<comment>Description:</comment>
  Define opções diversas em tempo de execução
  
  Esta função controla várias opções em tempo de execução para a conexão FTP especificada.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>     Uma instância de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$option</strong>  Atualmente, as seguintes opções são suportadas: Opção em tempo de
                           execução do FTP suportada<info>FTP_TIMEOUT_SEC</info> Muda o limite de tempo em
                           segundos usado para todas as operações de rede relacionadas. <strong>$value</strong> deve
                           ser um inteiro maior que 0. O limite de tempo padrão é de 90 segundos.
                           <info>FTP_AUTOSEEK</info> Quando ativado, requisições GET ou PUT com um parâmetro
                           <strong>$resumepos</strong> ou <strong>$startpos</strong> irão primeiro procurar a posição especificada no
                           arquivo. Isto está ativado por padrâo. <info>FTP_USEPASVADDRESS</info> Quando
                           desabilitado, PHP irá ignorar o endereço IP retornado pelo servidor FTP
                           em resposta do comando PASV, e no lugar usará o endereço IP que foi
                           fornecido em ftp_connect(). <strong>$value</strong> deve ser um booleano.
  <info>int|bool</info>        <strong>$value</strong>   Este parâmetro depende de qual opção foi escolhida em <strong>$option</strong> para ser
                           alterada.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> se a opção pôde ser definida; <info>false</info> se não. Uma mesangem de alerta será emitida
        se a opção em <strong>$option</strong> não for suportada ou se o parâmetro <strong>$value</strong> informado não corresponder
        ao valor esperado para a opção informada em <strong>$option</strong>.

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


id: ftp_site
type: function
doc:
<comment>Description:</comment>
  Sends a SITE command to the server
  
  <strong>ftp_site()</strong> sends the given <return>SITE</return>  command to the FTP server.
  
  <return>SITE</return> commands are not standardized, and vary from server to server. They are useful for handling
  such things as file permissions and  group membership.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      Uma instância de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$command</strong>  The SITE command. Note that this parameter isn't escaped so there may be
                            some issues with filenames containing spaces and other characters.

<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>ftp_raw()</strong>


id: ftp_size
type: function
doc:
<comment>Description:</comment>
  Retorna o tamanho do arquivo especificado
  
  <strong>ftp_size()</strong> retorna o tamanho do arquivo especificado, em bytes.
  
  Nem todos os servidores suportam este recurso.

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

<comment>Return:</comment>
  <info>int</info>  Retorna o tamanho do arquivo em caso de sucesso ou -1 em caso de erro.

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


