# php_manual

id: dotnet
type: class
doc:
<comment>Description:</comment>
  The dotnet class allows you to instantiate a class from a .Net assembly and call its methods and
  access its properties, if the class and the methods and properties are visible to COM.
  
  Neither instantiating static classes nor calling static methods is supported.
  
  Some .Net classes do not implement IDispatch, so while they can be instantiated, calling methods
  or accessing properties on these classes is not supported.
  
  You need to install the .Net runtime on your web server to take advantage of this feature.
  
  .Net framework 4.0 and later are not supported by the <class>dotnet</class> class. If assemblies have been
  registered with regasm.exe, the classes can be instantiated as <class>com</class> objects, though.


id: dotnet::__construct
type: function
doc:
<comment>Description:</comment>
  dotnet class constructor
  
  Constructs a new dotnet object.

<comment>Param:</comment>
  <info>string</info>  <strong>$assembly_name</strong>  Specifies which assembly should be loaded.
  <info>string</info>  <strong>$datatype_name</strong>  Specifices which class in that assembly to instantiate.
  <info>int   </info>  <strong>$codepage     </strong>  Codepage to use for unicode string transformations; see the  class for
                          more details on code pages.


id: doubleval
type: function
doc:
<comment>Description:</comment>
  Alias di floatval
  
  Questa funzione è sinonimo di:  <strong>floatval()</strong>.


id: each
type: function
doc:
<comment>Description:</comment>
  Restituisce la corrente coppia chiave/valore di un array e incrementa
       il puntatore dell'array


id: easter_date
type: function
doc:
<comment>Description:</comment>
  Restituisce un timestamp Unix della mezzanotte del giorno di Pasqua di un dato anno


id: easter_days
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero di giorni tra il 21 Marzo e Pasqua, dato un
       anno


id: echo
type: function
doc:
<comment>Description:</comment>
  Visualizza una o più stringhe
  
  Visualizza tutti i parametri.
  
  <strong>echo()</strong> in realtà non è una funzione (è un  costrutto del linguaggio) pertanto non richiede l'uso
  di parentesi. <strong>echo()</strong> (diversamente da altri costrutti del linguaggio)) non si comporta come una
  funzion, quindi non può essere sempre usata nel constesto di una funzione. Inoltre,se si vuole
  passare più di un parametro a <strong>echo()</strong>, i parametri non devono essere racchiusi tra parentesi.
  
  <strong>echo()</strong> ha anche una sintassi abbreviata, nella quale si può immediatamente seguire il simbolo di
  apertura del tag con un simbolo di uguale. questa sintassi abbreviata funziona solo se la
  configurazione short_open_tag è abilitata. .
  ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$arg1</strong>  Il parametro da visualizzare.
  <info>string</info>  <strong>$... </strong>  

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * sintassi heredoc


id: eio_busy
type: function
doc:
<comment>Description:</comment>
  Artificially increase load. Could be useful in tests,
    benchmarking
  
  <strong>eio_busy()</strong> artificially increases load taking <strong>$delay</strong> seconds to execute. May be used for
  debugging, or benchmarking.

<comment>Param:</comment>
  <info>int     </info>  <strong>$delay   </strong>  Delay in seconds
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  This callback is called when all the group requests are done.
  <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 or <info>false</info> on error.

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


id: eio_cancel
type: function
doc:
<comment>Description:</comment>
  Cancels a request
  
  <strong>eio_cancel()</strong> cancels a request specified by <strong>$req</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$req     </strong>  The request resource
  <info>        </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>        </info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>        </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>resource</info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>        </info>  <strong>$data    </strong>  Arbitrary variable passed to <strong>$callback</strong>.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


id: eio_chmod
type: function
doc:
<comment>Description:</comment>
  Change file/directory permissions
  
  <strong>eio_chmod()</strong> changes file, or directory permissions. The new permissions are specified by <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  Path to the target file or directory Avoid relative
                       paths
                       
                       Avoid relative
                       paths
  <info>int     </info>  <strong>$mode    </strong>  The new permissions. E.g. <info>0644</info>.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_chmod()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_chown
type: function
doc:
<comment>Description:</comment>
  Change file/directory permissions
  
  Changes file, or directory permissions.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  Path to file or directory. Avoid relative
                       paths
                       
                       Avoid relative
                       paths
  <info>int     </info>  <strong>$uid     </strong>  User ID. Is ignored when equal to -1.
  <info>int     </info>  <strong>$gid     </strong>  Group ID. Is ignored when equal to -1.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_chown()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_close
type: function
doc:
<comment>Description:</comment>
  Close file
  
  <strong>eio_close()</strong> closes file specified by <strong>$fd</strong>.

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  Stream, Socket resource, or numeric file descriptor
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_close()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_custom
type: function
doc:
<comment>Description:</comment>
  Execute custom request like any other eio_* call
  
  <strong>eio_custom()</strong> executes custom function specified by <strong>$execute</strong> processing it just like any other
  eio_* call.

<comment>Param:</comment>
  <info>callable</info>  <strong>$execute </strong>  Specifies the request function that should match the following prototype:
                         <strong>$callback</strong> is event completion callback that should match the following
                       prototype:
                        <strong>$data</strong> is the data passed to <strong>$execute</strong> via <strong>$data</strong> argument without
                       modifications <strong>$result</strong> value returned by <strong>$execute</strong>
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_custom()</strong> returns request resource on success or <info>false</info> on error.


id: eio_dup2
type: function
doc:
<comment>Description:</comment>
  Duplicate a file descriptor
  
  <strong>eio_dup2()</strong> duplicates file descriptor.

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  Source stream, Socket resource, or numeric file descriptor
  <info>mixed   </info>  <strong>$fd2     </strong>  Target stream, Socket resource, or numeric file descriptor
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_dup2()</strong> returns request resource on success or <info>false</info> on error.


id: eio_event_loop
type: function
doc:
<comment>Description:</comment>
  Polls libeio until all requests proceeded
  
  <strong>eio_event_loop()</strong> polls libeio until all requests proceeded.

<comment>Return:</comment>
  <info>bool</info>  <strong>eio_event_loop()</strong> returns <info>true</info> on success or <info>false</info> on error.

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


id: eio_fallocate
type: function
doc:
<comment>Description:</comment>
  Allows the caller to directly manipulate the allocated disk
    space for a file
  
  <strong>eio_fallocate()</strong> allows the caller to directly manipulate the allocated disk space for the file
  specified by <strong>$fd</strong> file descriptor for the byte range starting at <strong>$offset</strong> and continuing for <strong>$length</strong>
  bytes.
  
  <info>EIO_O_CREAT</info> should be logically OR'd with <info>EIO_O_WRONLY</info>, or <info>EIO_O_RDWR</info>

<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>int     </info>  <strong>$mode    </strong>  Currently only one flag is supported for mode: <info>EIO_FALLOC_FL_KEEP_SIZE</info> (the
                       same as POSIX constant <info>FALLOC_FL_KEEP_SIZE</info>).
  <info>int     </info>  <strong>$offset  </strong>  Specifies start of the byte range.
  <info>int     </info>  <strong>$length  </strong>  Specifies length the byte range.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_fallocate()</strong> returns request resource on success or <info>false</info> on error.


id: eio_fchmod
type: function
doc:
<comment>Description:</comment>
  Change file permissions
  
  <strong>eio_fchmod()</strong> changes permissions for the file specified by <strong>$fd</strong> file descriptor.

<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>int     </info>  <strong>$mode    </strong>  The new permissions. E.g. 0644.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_fchmod()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_fchown
type: function
doc:
<comment>Description:</comment>
  Change file ownership
  
  <strong>eio_fchown()</strong> changes ownership of the file specified by <strong>$fd</strong> file descriptor.

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  Stream, Socket resource, or numeric file descriptor.
  <info>int     </info>  <strong>$uid     </strong>  User ID. Is ignored when equal to -1.
  <info>int     </info>  <strong>$gid     </strong>  Group ID. Is ignored when equal to -1.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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>  

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


id: eio_fdatasync
type: function
doc:
<comment>Description:</comment>
  Synchronize a file's in-core state with storage device
  
  <strong>eio_fdatasync()</strong> synchronizes a file's in-core state with storage device.

<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>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_fdatasync()</strong> returns request resource on success or <info>false</info> on error.


id: eio_fstat
type: function
doc:
<comment>Description:</comment>
  Get file status
  
  <strong>eio_fstat()</strong> returns file status information 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>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

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


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

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  A file descriptor of a file within the mounted file system.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_fstatvfs()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_fsync
type: function
doc:
<comment>Description:</comment>
  Synchronize a file's in-core state with storage device
  
  Synchronize a file's in-core state with storage device

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  Stream, Socket resource, or numeric file descriptor.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_fsync()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_ftruncate
type: function
doc:
<comment>Description:</comment>
  Truncate a file
  
  <strong>eio_ftruncate()</strong> causes a regular file referenced by <strong>$fd</strong> file descriptor to be truncated to
  precisely <strong>$length</strong> bytes.

<comment>Param:</comment>
  <info>mixed   </info>  <strong>$fd      </strong>  Stream, Socket resource, or numeric file descriptor.
  <info>int     </info>  <strong>$offset  </strong>  Offset from beginning of the file
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_ftruncate()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_futime
type: function
doc:
<comment>Description:</comment>
  Change file last access and modification times
  
  <strong>eio_futime()</strong> changes file last access and modification times.

<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>float   </info>  <strong>$atime   </strong>  Access time
  <info>float   </info>  <strong>$mtime   </strong>  Modification time
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_futime()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_get_event_stream
type: function
doc:
<comment>Description:</comment>
  Get stream representing a variable used in internal communications with libeio
  
  <strong>eio_get_event_stream()</strong> acquires stream representing a variable used in internal communications
  with libeio. Could be used to bind with some event loop provided by other PECL extension, for
  example libevent.

<comment>Return:</comment>
  <info>mixed</info>  <strong>eio_get_event_stream()</strong> returns stream on success; otherwise, <info>null</info>


id: eio_get_last_error
type: function
doc:
<comment>Description:</comment>
  Returns string describing the last error associated with a request resource
  
  <strong>eio_get_last_error()</strong> returns string describing the last error associated with <strong>$req</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req</strong>  The request resource

<comment>Return:</comment>
  <info>string</info>  <strong>eio_get_last_error()</strong> returns string describing the last error associated with the request
          resource specified by <strong>$req</strong>.
          
          Questa funzione è
          SPERIMENTALE. Ovvero, il comportamento di questa funzione,
          il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
          può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
          funzione è a vostro rischio.


id: eio_grp
type: function
doc:
<comment>Description:</comment>
  Creates a request group
  
  <strong>eio_grp()</strong> creates a request group.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>string  </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_grp()</strong> returns request group resource on success or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>eio_grp_cancel()</strong>
   * <strong>eio_grp_add()</strong>


id: eio_grp_add
type: function
doc:
<comment>Description:</comment>
  Adds a request to the request group
  
  <strong>eio_grp_add()</strong> adds a request to the request group.

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp</strong>  The request group resource returned by <strong>eio_grp()</strong>
  <info>resource</info>  <strong>$req</strong>  The request resource

<comment>Return:</comment>
  <info>void</info>  <strong>eio_grp_add()</strong> doesn't return a value.

<comment>See Also:</comment>
   * <strong>eio_grp()</strong>
   * <strong>eio_grp_cancel()</strong>
   * <strong>eio_grp_limit()</strong>


id: eio_grp_cancel
type: function
doc:
<comment>Description:</comment>
  Cancels a request group
  
  <strong>eio_grp_cancel()</strong> cancels a group request specified by <strong>$grp</strong> request group resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp</strong>  The request group resource returned by <strong>eio_grp()</strong>.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

<comment>See Also:</comment>
   * <strong>eio_grp()</strong>
   * <strong>eio_grp_add()</strong>


id: eio_grp_limit
type: function
doc:
<comment>Description:</comment>
  Set group limit
  
  Limit number of requests in the request group.

<comment>Param:</comment>
  <info>resource</info>  <strong>$grp  </strong>  The request group resource.
  <info>int     </info>  <strong>$limit</strong>  Number of requests in the group.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


id: eio_init
type: function
doc:
<comment>Description:</comment>
  (Re-)initialize Eio
  
  <strong>eio_init()</strong> (re-)initializes Eio. It allocates memory for internal structures of libeio and Eio
  itself. You may call <strong>eio_init()</strong> before using Eio functions. Otherwise it will be called internally
  first time you invoke an Eio function in a process.
  
   Questa funzione deprecata sarà
  sicuramente rimossa in futuro. Since Eio 1.1.0 <strong>eio_init()</strong> is deprecated. In Eio 1.0.0 because of
  libeio's restrictions you must call <strong>eio_init()</strong> in child process, if you fork one by any means. You
  have to avoid using Eio in parent process, if you use it in childs.
  
  Questa funzione deprecata sarà
  sicuramente rimossa in futuro. Since Eio 1.1.0 <strong>eio_init()</strong> is deprecated. In Eio 1.0.0 because of
  libeio's restrictions you must call <strong>eio_init()</strong> in child process, if you fork one by any means. You
  have to avoid using Eio in parent process, if you use it in childs.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.


id: eio_link
type: function
doc:
<comment>Description:</comment>
  Create a hardlink for file
  
  <strong>eio_link()</strong> creates a hardlink <strong>$new_path</strong> for a file specified by <strong>$path</strong>.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  Source file path.
  <info>string  </info>  <strong>$new_path</strong>  Target file path.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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>  

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


id: eio_lstat
type: function
doc:
<comment>Description:</comment>
  Get file status
  
  <strong>eio_lstat()</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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_lstat()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_mkdir
type: function
doc:
<comment>Description:</comment>
  Create directory
  
  <strong>eio_mkdir()</strong> creates directory with specified access <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  Path for the new directory.
  <info>int     </info>  <strong>$mode    </strong>  Access mode, e.g. 0755
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_mkdir()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_mknod
type: function
doc:
<comment>Description:</comment>
  Create a special or ordinary file
  
  <strong>eio_mknod()</strong> creates ordinary or special(often) file.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  Path for the new node(file).
  <info>int     </info>  <strong>$mode    </strong>  Specifies both the permissions to use and the type of node to be created. It
                       should be a combination (using bitwise OR) of one of the file types listed
                       below and the permissions for the new node(e.g. 0640).
                        Possible file types are: <info>EIO_S_IFREG</info>(regular file), <info>EIO_S_IFCHR</info>(character
                       file), <info>EIO_S_IFBLK</info>(block special file), <info>EIO_S_IFIFO</info>(FIFO - named pipe) and
                       <info>EIO_S_IFSOCK</info>(UNIX domain socket).
                        To specify permissions EIO_S_I* constants could be used.
  <info>int     </info>  <strong>$dev     </strong>  If  the  file type is <info>EIO_S_IFCHR</info> or <info>EIO_S_IFBLK</info> then dev specifies the major
                       and minor numbers of the newly created device special file. Otherwise <strong>$dev</strong>
                       ignored. See mknod(2) man page for details.
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_mknod()</strong> returns request resource on success or <info>false</info> on error.

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


id: eio_nop
type: function
doc:
<comment>Description:</comment>
  Does nothing, except go through the whole request cycle
  
  <strong>eio_nop()</strong> does nothing, except go through the whole request cycle. Could be useful in debugging.

<comment>Param:</comment>
  <info>int     </info>  <strong>$pri     </strong>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_nop()</strong> returns request resource on success or <info>false</info> on error.

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


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>string  </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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, or <info>false</info> on error. 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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>string  </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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_readlink()</strong> returns request resource on success or <info>false</info> on error.

<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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

<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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>string  </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  Nessun valore viene restituito.

<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>  Nessun valore viene restituito.

<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>  Nessun valore viene restituito.


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>  Nessun valore viene restituito.


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>  Nessun valore viene restituito.

<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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error. 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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

<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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

<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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.


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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

<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>  The request priority: <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, or <info>null</info>.
                       If <info>null</info> passed, <strong>$pri</strong> internally is set to
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  <strong>$callback</strong> function is called when the request is done.
                       It should match the following prototype: 
                       <strong>$data</strong>is custom data passed to the request.<strong>$result</strong>request-specific result
                       value; basically, the value returned by corresponding
                       system call.<strong>$req</strong>is optional request resource which can be used with functions
                       like <strong>eio_get_last_error()</strong>
                       
                       is custom data passed to the request.
                       
                       request-specific result value; basically, the value returned by corresponding
                       system call.
                       
                       is optional request resource which can be used with functions like
                       <strong>eio_get_last_error()</strong>
  <info>mixed   </info>  <strong>$data    </strong>  is custom data passed to the request.
  <info>        </info>  <strong>$result  </strong>  request-specific result value; basically, the value returned by corresponding
                       system call.
  <info>        </info>  <strong>$req     </strong>  is optional request resource which can be used with functions like
                       <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 or <info>false</info> on error.

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


id: empty
type: function
doc:
<comment>Description:</comment>
  Determina se una variabile è valorizzata
  
  Determina se una variabile è da considerare vuota. Una variabile è considerata vuota se non esiste
  oppure se il suo valore è uguale a <info>false</info>. <strong>empty()</strong> non genera un avviso se la variabile non esiste.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  Variabile da controllare
               
               Prima di PHP 5.5, <strong>empty()</strong> supporta solo variabili; qualsiasi altra cosa si traduce in
               un errore di analisi. In altre parole, il seguente comando non funziona:
               empty(trim($name)). Invece, utilizzare trim($name) == false.
               
               Se la variabile non esiste, nessun avviso verrà generato. Questo significa che
               <strong>empty()</strong> è essenzialmente l'equivalente conciso di !isset($var) || $var == false.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>false</info> se <strong>$var</strong> esiste e ha un valore non vuoto e diverso da zero. Altrimenti
        restituisce <info>true</info>.
        
        I seguenti valori sono considerati vuoti: <return>""</return> (una stringa vuota)<return>0</return> (0 come intero)<return>0.0</return> (0 come
        numero decimale)<return>"0"</return> (0 come stringa)<info>null</info><info>false</info><return>array()</return> (un array vuoto)

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>array_key_exists()</strong>
   * <strong>count()</strong>
   * <strong>strlen()</strong>
   * la tabella di comparazione dei tipi


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>  An Enchant broker returned by <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>  An Enchant broker returned by <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 resource with all its dictionaries.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  An Enchant broker returned by <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<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 resource.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<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>  An Enchant broker returned by <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>stringfalse</info>  Returns the path of the dictionary directory on success o <info>false</info> in caso di
               fallimento.

<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>  An Enchant broker returned by <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>stringfalse</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>EnchantBrokerfalse</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>  An Enchant broker returned by <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>  An Enchant broker returned by <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>EnchantDictionaryfalse</info>  Returns a dictionary resource on success o <info>false</info> in caso di fallimento.

<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>  An Enchant broker returned by <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>EnchantDictionaryfalse</info>  Returns a dictionary resource on success o <info>false</info> in caso di fallimento.

<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>  An Enchant broker returned by <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>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<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>  An Enchant broker returned by <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>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: enchant_dict_add_to_personal
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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string           </info>  <strong>$word      </strong>  The word to add

<comment>Return:</comment>
  <info>void</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * <strong>enchant_broker_request_pwl_dict()</strong>
   * <strong>enchant_broker_request_dict()</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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string           </info>  <strong>$word      </strong>  The word to add

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

<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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>array</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <strong>enchant_broker_request_pwl_dict()</strong>.

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


id: enchant_dict_is_in_session
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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <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_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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong>
                                   or <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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <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>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


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>  An Enchant dictionary returned by <strong>enchant_broker_request_dict()</strong> or
                                  <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: eregi
type: function
doc:
<comment>Description:</comment>
  Riconoscimento di espressioni regolari senza distinzione tra maiuscole e minuscole


id: eregi_replace
type: function
doc:
<comment>Description:</comment>
  Sostituzioni con espressioni regolari senza distinzione tra maiuscole e minuscole


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>
  Get the last occurred error
  
  Gets information about the last error that occurred.

<comment>Return:</comment>
  <info>arraynull</info>  Returns an associative array describing the last error with keys "type", "message",
             "file" and "line". If the error has been caused by a PHP internal function then the
             "message" begins with its name. Returns <info>null</info> if there hasn't been an error yet.

<comment>See Also:</comment>
   * Error constants
   * Variable $php_errormsg
   * <strong>error_clear_last()</strong>
   * Directive <strong>$display_errors</strong>
   * Directive <strong>$html_errors</strong>
   * Directive <strong>$xmlrpc_errors</strong>


id: error_log
type: function
doc:
<comment>Description:</comment>
  invia un messaggio di errore
  
  Invia un messaggio di errore al log del server web o ad un file

<comment>Param:</comment>
  <info>string</info>  <strong>$message      </strong>  Il messaggio di errore che deve essere registrato.
  <info>int   </info>  <strong>$message_type </strong>  Indica la destinazione del messaggio. I possibili tipi di messaggio sono:
                          
                          <strong>error_log()</strong> tipi di log0<strong>$message</strong> è inviato al log di sistema di PHP,
                          utilizzando il sistema di log del Sistema Operativo o un file, a seconda
                          di come sia impostata la direttiva di configurazione error-log. 1<strong>$message</strong>
                          è inviato via posta elettronica all'indirizzo indicato nel parametro
                          <strong>$destination</strong>. Questo è l'unico tipo di messaggio nel quale viene usato il
                          quarto parametro, <strong>$extra_headers</strong>. 2 Non è più un'opzione. 3<strong>$message</strong> è
                          aggiunto al file  <strong>$destination</strong>. Il ritorno carrello non è aggiunto
                          automaticamente alla fine della stringa <strong>$message</strong>. 4<strong>$message</strong> è inviato
                          direttamente al gestore di log SAPI.
  <info>string</info>  <strong>$destination  </strong>  La destinazione. Il suo significato dipende dal parametro <strong>$message_type</strong>
                          come descritto più sopra.
  <info>string</info>  <strong>$extra_headers</strong>  Gli header supplementari. Viene usato quando il parametro <strong>$message_type</strong> è
                          impostato a <return>1</return>. Questo tipo di mesaggio usa la stessa funzione interna di
                          <strong>mail()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: error_reporting
type: function
doc:
<comment>Description:</comment>
  definisce quali errori di PHP vengono restituiti
  
  La funzione <strong>error_reporting()</strong> imposta la direttiva error_reporting a runtime. PHP ha parecchi
  livelli d'errore, usando questa funzione si imposta il livello per la durata (runtime) dello
  script.

<comment>Param:</comment>
  <info>int</info>  <strong>$livello</strong>  Il nuovo livello di error_reporting. Accetta una maschera di bit o una costante
                 named. L'utilizzo delle costanti named è caldamente consigliato per assicurare la
                 compatibilità con versioni future. All'aggiungere di livelli di errore, la gamma
                 degli interi viene incrementata, perciò vecchi livelli di errore basati sull'intero
                 non si comporteranno sempre come ci si aspetta.
                 
                 Le costanti disponibili sono elencate qui sotto. Il significato di questi livelli
                 d'errore è descritto nelle costanti predefinite. <strong>error_reporting()</strong> valori dei
                 bitvalorecostante1E_ERROR2E_WARNING4E_PARSE8E_NOTICE16E_CORE_ERROR32E_CORE_WARNING64E_COMPILE_ERROR128E_COMPILE_WARNING256E_USER_ERROR512E_USER_WARNING1024E_USER_NOTICE6143E_ALL2048E_STRICT4096E_RECOVERABLE_ERROR

<comment>Return:</comment>
  <info>int</info>  Restituisce il precedente livello di error_reporting .

<comment>See Also:</comment>
   * La direttiva display_errors
   * <strong>ini_set()</strong>


id: eval
type: function
doc:
<comment>Description:</comment>
  Esegue una stringa come codice PHP
  
  Esegue la data stringa <strong>$code</strong> come codice PHP.
  
  <strong>eval()</strong> è un costrutto del linguaggio molto pericoloso perché permette l'esecuzione di codice PHP
  arbitrario. Il suo uso è pertanto  sconsigliato. Se si è certi che non esistono altre soluzioni al
  posto di usare <strong>eval()</strong>, fare particolare attenzione a non inserire codice fornito dall'utente senza
  averlo preventivamente validato.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>  Codice PHP valido da eseguire.
                 
                 Il codice non deve essere incluso nei tag di apertura e chisura di PHP. Ad esempio
                 <return>'echo "Ciao!";'</return> è corretto invece di <return>'\<? echo "Ciao!"; &gt;'</return>. È comunque possibile uscire e rientrare nella modalità PHP attraverso l'utilizzo dei tag PHP appropriati, ad esempio: <return>'echo "In PHP mode!"; ?&gt;In HTML mode!\<? echo "Back in PHP mode!";'</return>.
                 
                 Oltre a questo, valgono tutte le regole del codice PHP. Questo include
                 l'inserimento al termine di ogni istruzione del punto e virgola. <return>'echo "Ciao!"'</return> per
                 esempio causerà un parse error, mentre <return>'echo "Ciao!";'</return> funzionerà.
                 
                 Un'istruzione <return>return</return> causa immediatamente la terminazione del codice in corso di
                 esecuzione dalla <strong>eval()</strong>.
                 
                 L'ambito di esecuzione è ristretto a dove <strong>eval()</strong> viene chiamata. Quindi qualsiasi
                 variabile definita o modificata all'interno di <strong>eval()</strong> rimarrà visibile dopo la sua
                 terminazione.

<comment>Return:</comment>
  <info>mixed</info>  <strong>eval()</strong> ritorna <info>null</info> a meno che  non venga richiamato <return>return</return> nel codice da valutare, in tal
         caso il valore passato a <return>return</return> viene ritornato. Se avviene un parse error nel codice
         valutato, <strong>eval()</strong> ritorna <info>false</info> e l'esecuzione del codice seguente continua normalmente. Non
         è possibile catturare un parse error in <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>
  Esegue un programma esterno
  
  <strong>exec()</strong> esegue il <strong>$command</strong> passato.

<comment>Param:</comment>
  <info>string</info>  <strong>$command   </strong>  Il comando che verrà eseguito.
  <info>array </info>  <strong>$output    </strong>  Se l'argomento <strong>$output</strong> è presente, allora l' array specificato verrà riempito
                       con ogni linea del output del comando.  I fine riga, come <return>\n</return>, non sono
                       inclusi in questo array.  Notare che se l'array contiene già degli elementi,
                       <strong>exec()</strong> li aggiungerà in coda all'array. Se non si vuole che la funzione
                       aggiunga elementi, eseguire un  <strong>unset()</strong> sull'array prima di passarlo ad
                       <strong>exec()</strong>.
  <info>int   </info>  <strong>$return_var</strong>  Se viene passato l'argomento <strong>$return_var</strong> assieme all'argomento <strong>$output</strong>,
                       allora lo stato di ritorno del comando eseguito verrà scritto in questa
                       variabile.

<comment>Return:</comment>
  <info>string</info>  L'ultima riga dal risultato del comando.  Se si ha bisogno di eseguire un  comando ed
          ottenere tutti i dati dello stesso direttamente senza alcuna interferenza, usare la
          funzione <strong>passthru()</strong>.
          
          Per ottenere l'output del comando eseguito, assicurarsi di impostare ed utilizzare il
          parametro <strong>$output</strong>.

<comment>See Also:</comment>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * l'operatore backtick


id: exif_imagetype
type: function
doc:
<comment>Description:</comment>
  Determine the type of an image
  
  <strong>exif_imagetype()</strong> reads the first bytes of an image and checks its signature.
  
  <strong>exif_imagetype()</strong> can be used to avoid calls to other  exif functions with unsupported file types
  or in conjunction with $_SERVER['HTTP_ACCEPT'] to check  whether or not the viewer is able to see
  a specific image in the browser.

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

<comment>Return:</comment>
  <info>intfalse</info>  When a correct signature is found, the appropriate constant value will be returned
            otherwise the return value is <info>false</info>. The return value is the same value that
            <strong>getimagesize()</strong> returns in index 2 but <strong>exif_imagetype()</strong> is much faster.
            
            <strong>exif_imagetype()</strong> will emit an <info>E_NOTICE</info> and return <info>false</info> if it is unable to read enough
            bytes from the file to determine the image type.

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


id: exif_read_data
type: function
doc:
<comment>Description:</comment>
  Reads the EXIF headers from an image file
  
  <strong>exif_read_data()</strong> reads the EXIF headers from an image file. This way you can read meta data
  generated by digital cameras.
  
  EXIF headers tend to be present in JPEG/TIFF images generated by digital cameras, but
  unfortunately each digital camera maker has a different idea of how to actually tag their images,
  so you can't always rely on a specific Exif header being present.
  
  <return>Height</return> and <return>Width</return> are computed the  same way <strong>getimagesize()</strong> does so their values must not be  part
  of any header returned.  Also, <return>html</return> is a  height/width text string to be used inside normal HTML.
  
  When an Exif header contains a Copyright note, this itself can contain two values. As the solution
  is inconsistent in the Exif 2.10 standard, the <return>COMPUTED</return> section will return both entries
  <return>Copyright.Photographer</return> and <return>Copyright.Editor</return> while the <return>IFD0</return> sections contains the byte array with
  the NULL character that splits both entries. Or just the first entry if the datatype was wrong
  (normal behaviour of Exif). The <return>COMPUTED</return> will also contain the entry <return>Copyright</return> which is either the
  original copyright string, or a comma separated list of the photo and editor copyright.
  
  The tag <return>UserComment</return> has the same problem as the Copyright tag. It can store two values.  First the
  encoding used, and second the value itself. If so the <return>IFD</return> section only contains the encoding or a
  byte array. The <return>COMPUTED</return> section will store both in the entries <return>UserCommentEncoding</return> and
  <return>UserComment</return>. The entry <return>UserComment</return> is available in both cases so it should be used in preference
  to the value in <return>IFD0</return> section.
  
  <strong>exif_read_data()</strong> also validates EXIF data tags according to the EXIF specification
  (http://exif.org/Exif2-2.PDF, page 20).
  
  Windows Me/XP can both wipe the Exif headers when connecting to a camera.

<comment>Param:</comment>
  <info>resourcestring</info>  <strong>$file             </strong>  The location of the image file. This can either be a path to
                                      the file (stream wrappers are also supported as usual) or a
                                      stream <info>resource</info>.
  <info>stringnull    </info>  <strong>$required_sections</strong>  Is a comma separated list of sections that need to be present
                                      in file  to produce a result <info>array</info>.  If none of the requested
                                      sections could be found the return value is <info>false</info>.
                                      FILEFileName, FileSize, FileDateTime, SectionsFoundCOMPUTED
                                      html, Width, Height, IsColor, and more if available.  Height
                                      and  Width are computed the same way <strong>getimagesize()</strong> does so
                                      their values must not be part of any header returned.  Also,
                                      <return>html</return> is a height/width text string to be used inside normal
                                      HTML. ANY_TAGAny information that has a Tag e.g. <return>IFD0</return>, <return>EXIF</return>,
                                      ...IFD0 All tagged data of IFD0. In normal imagefiles this
                                      contains image size and so forth. THUMBNAIL A file is supposed
                                      to contain a thumbnail if it has a second <return>IFD</return>. All tagged
                                      information about the embedded thumbnail is stored in  this
                                      section. COMMENTComment headers of JPEG images.EXIF The EXIF
                                      section is a sub section of <return>IFD0</return>. It contains more detailed
                                      information about an image. Most of these entries are digital
                                      camera related.
  <info>bool          </info>  <strong>$as_arrays        </strong>  Specifies whether or not each section becomes an array. The
                                      <strong>$required_sections</strong> <return>COMPUTED</return>, <return>THUMBNAIL</return>, and <return>COMMENT</return>  always
                                      become arrays as they may contain values whose names conflict
                                      with other sections.
  <info>bool          </info>  <strong>$read_thumbnail   </strong>  When set to <info>true</info> the thumbnail itself is read.  Otherwise,
                                      only the tagged data is read.

<comment>Return:</comment>
  <info>arrayfalse</info>  It returns an associative <info>array</info> where the array indexes are  the header names and the
              array values are the values associated with  those headers. If no data can be
              returned,  <strong>exif_read_data()</strong> will return <info>false</info>.

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


id: exif_tagname
type: function
doc:
<comment>Description:</comment>
  Get the header name for an index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The Tag ID for which a Tag Name will be looked up.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the header name, or <info>false</info> if <strong>$index</strong> is not a defined EXIF tag id.

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


id: exif_thumbnail
type: function
doc:
<comment>Description:</comment>
  Retrieve the embedded thumbnail of an image
  
  <strong>exif_thumbnail()</strong> reads the embedded thumbnail of an image.
  
  If you want to deliver thumbnails through this function, you should send the mimetype information
  using the <strong>header()</strong> function.
  
  It is possible that <strong>exif_thumbnail()</strong> cannot create an  image but can determine its size. In this
  case, the return value is  <info>false</info> but <strong>$width</strong> and <strong>$height</strong>  are set.

<comment>Param:</comment>
  <info>resourcestring</info>  <strong>$file      </strong>  The location of the image file. This can either be a path to the file
                               or a stream <info>resource</info>.
  <info>int           </info>  <strong>$width     </strong>  The return width of the returned thumbnail.
  <info>int           </info>  <strong>$height    </strong>  The returned height of the returned thumbnail.
  <info>int           </info>  <strong>$image_type</strong>  The returned image type of the returned thumbnail.  This is either
                               TIFF or JPEG.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the embedded thumbnail, or <info>false</info> if the image contains no  thumbnail.

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


id: exit
type: function
doc:
<comment>Description:</comment>
  Output a message and terminate the current script
  
  Terminates execution of the script. Shutdown functions and object destructors will always be
  executed even if <return>exit</return> is called.
  
  <return>exit</return> is a language construct and it can be called without parentheses if no <strong>$status</strong> is passed.

<comment>Param:</comment>
  <info>string</info>  <strong>$status</strong>  If <strong>$status</strong> is a string, this function prints the <strong>$status</strong> just before exiting.
                   
                   If <strong>$status</strong> is an <info>int</info>, that value will be used as the exit status and not printed.
                   Exit statuses should be in the range 0 to 254, the exit status 255 is reserved by
                   PHP and shall not be used. The status 0 is used to terminate the program
                   successfully.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


id: exp
type: function
doc:
<comment>Description:</comment>
  Calcola l'esponente di e (la base logaritmica naturale o di Nepero)


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: expm1
type: function
doc:
<comment>Description:</comment>
  Restituisce exp(numero) - 1, computato in maniera tale da essere accurato anche se 
       il valore del numero è vicino a zero


id: expression
type: function
doc:
<comment>Description:</comment>
  Bind prepared statement variables as parameters
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$data                   </strong>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.

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


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>  Neural network <info>resource</info>.

<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>  Returns a neural network <info>resource</info> on success, or <info>false</info> on error.

<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>  Returns a train data <info>resource</info> on success, or <info>false</info> on error.

<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>  Returns a train data <info>resource</info> on success, or <info>false</info> on error.

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$input_vector</strong>  Input vector that will be descaled

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

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$output_vector</strong>  Output vector that will be descaled

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

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data</strong>  Neural network training data <info>resource</info>.

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

<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>  Neural network <info>resource</info>.

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


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>  Neural network training data <info>resource</info>.

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


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>  Neural network training data <info>resource</info>.

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


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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.
  <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
  agressive 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>  Neural network <info>resource</info>.
  <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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<comment>Return:</comment>
  <info>float</info>  Returns <info>true</info> on success, or <info>false</info> otherwise.
         
         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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data</strong>  Neural network training data <info>resource</info>.

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

<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>  Neural network training data <info>resource</info>.

<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>  Neural network training data <info>resource</info>.
  <info>resource</info>  <strong>$data2</strong>  Neural network training data <info>resource</info>.

<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>  Neural network training data <info>resource</info>.

<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>  Neural network training data <info>resource</info>.

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.

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

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Returns a train data <info>resource</info> on success, or <info>false</info> on error.

<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>  Neural network <info>resource</info>.

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

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.

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

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.

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

<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>  Neural network <info>resource</info>.
  <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>  Neural network <info>resource</info>.
  <info>string  </info>  <strong>$configuration_file</strong>  The configuration file path.

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

<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>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$input_vector</strong>  Input vector that will be scaled

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

<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>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$output_vector</strong>  Output vector that will be scaled

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

<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>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data</strong>  Neural network training data <info>resource</info>.

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

<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>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$activation_function</strong>  The activation functions constant.

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

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$activation_function</strong>  The activation functions constant.

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

<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
  agressive 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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$activation_steepness</strong>  The activation steepness.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$activation_steepness</strong>  The activation steepness.
  <info>int     </info>  <strong>$layer               </strong>  Layer number.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$activation_steepness</strong>  The activation steepness.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$bit_fail_limit</strong>  The bit fail limit.

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

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$cascade_activation_functions</strong>  The array of cascade candidate activation functions.

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

<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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$cascade_activation_steepnesses_count</strong>  The array of cascade candidate activation
                                                   steepnesses.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$cascade_candidate_change_fraction</strong>  The cascade candidate change fraction.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$cascade_candidate_limit</strong>  The candidate limit.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_candidate_stagnation_epochs</strong>  The number of cascade candidate stagnation epochs.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_max_cand_epochs</strong>  The max candidate epochs.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_max_out_epochs</strong>  The maximum out epochs.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_min_cand_epochs</strong>  The minimum candidate epochs.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_min_out_epochs</strong>  The minimum out epochs.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_num_candidate_groups</strong>  The number of candidate groups.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$cascade_output_change_fraction</strong>  The cascade output change fraction.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$cascade_output_stagnation_epochs</strong>  The number of cascade output stagnation epochs.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$cascade_weight_multiplier</strong>  The weight multiplier.

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

<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>  Either neural network <info>resource</info> or neural network trainining data <info>resource</info>.
  <info>string  </info>  <strong>$log_file</strong>  The log file path.

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


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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data   </strong>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$learning_momentum</strong>  The learning momentum.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$learning_rate</strong>  The learning rate.

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

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data    </strong>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$quickprop_decay</strong>  The quickprop decay factor.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$quickprop_mu</strong>  The mu factor.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$rprop_decrease_factor</strong>  The decrease factor.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$rprop_delta_max</strong>  The maximum step-size.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$rprop_delta_min</strong>  The minimum step-size.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$rprop_delta_zero</strong>  The initial step-size.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$rprop_increase_factor</strong>  The increase factor.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$sarprop_step_error_shift</strong>  The sarprop step error shift.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$sarprop_step_error_threshold_factor</strong>  The sarprop step error threshold factor.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$sarprop_temperature</strong>  The sarprop temperature.

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

<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>  Neural network <info>resource</info>.
  <info>float   </info>  <strong>$sarprop_weight_decay_shift</strong>  The sarprop weight decay shift.

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

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$train_data    </strong>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$error_function</strong>  The error function constant

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$stop_function</strong>  The stop function constant.

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

<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>  Neural network <info>resource</info>.
  <info>int     </info>  <strong>$training_algorithm</strong>  Training algorithm constant

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

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.


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>  Neural network <info>resource</info>.
  <info>array   </info>  <strong>$connections</strong>  An array of <class>FANNConnection</class> objects

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


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>  Neural network training data <info>resource</info>.

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


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>  Neural network training data <info>resource</info>.
  <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>  Returns a train data <info>resource</info> on success, or <info>false</info> on error.

<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>  Neural network <info>resource</info>.
  <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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$data</strong>  Neural network training data <info>resource</info>.

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$data</strong>  Neural network training data <info>resource</info>.

<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>  Neural network <info>resource</info>.
  <info>resource</info>  <strong>$data                  </strong>  Neural network training data <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>  Neural network <info>resource</info>.
  <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>  Returns <info>true</info> on success, or <info>false</info> otherwise.

<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>
  Flushes all response data to the client
  
  This function flushes all response data to the client and finishes the request. This allows for
  time consuming tasks to be performed without leaving the connection to the client open.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: fbird_add_user
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_add_user
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_affected_rows
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_backup
  
  Questa funzione è sinonimo di:  <strong>ibase_backup()</strong>.


id: fbird_blob_add
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_blob_add
  
  Questa funzione è sinonimo di:  <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>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<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>
  Alias di ibase_blob_close
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_blob_create
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_blob_echo
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_blob_get
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_blob_import
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_blob_info
  
  Questa funzione è sinonimo di:  <strong>ibase_blob_info()</strong>.


id: fbird_blob_open
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_blob_open
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_close
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_commit
  
  Questa funzione è sinonimo di:  <strong>ibase_commit()</strong>.


id: fbird_commit_ret
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_commit_ret
  
  Questa funzione è sinonimo di:  <strong>ibase_commit_ret()</strong>.


id: fbird_connect
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_connect
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_db_info
  
  Questa funzione è sinonimo di:  <strong>ibase_db_info()</strong>.


id: fbird_delete_user
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_delete_user
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_drop_db
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_errcode
  
  Questa funzione è sinonimo di:  <strong>ibase_errcode()</strong>.

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


id: fbird_errmsg
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_errmsg
  
  Questa funzione è sinonimo di:  <strong>ibase_errmsg()</strong>.

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


id: fbird_execute
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_execute
  
  Questa funzione è sinonimo di:  <strong>ibase_execute()</strong>.

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


id: fbird_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_fetch_assoc
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_fetch_object
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_fetch_row
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_field_info
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_free_event_handler
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_free_query
  
  Questa funzione è sinonimo di:  <strong>ibase_free_query()</strong>.


id: fbird_free_result
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_free_result
  
  Questa funzione è sinonimo di:  <strong>ibase_free_result()</strong>.


id: fbird_gen_id
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_gen_id
  
  Questa funzione è sinonimo di:  <strong>ibase_gen_id()</strong>.


id: fbird_maintain_db
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_maintain_db
  
  Questa funzione è sinonimo di:  <strong>ibase_maintain_db()</strong>.


id: fbird_modify_user
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_modify_user
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_name_result
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_num_fields
  
  Questa funzione è sinonimo di:  <strong>ibase_num_fields()</strong>.

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


id: fbird_num_params
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_num_params
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_param_info
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_pconnect
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_prepare
  
  Questa funzione è sinonimo di:  <strong>ibase_prepare()</strong>.


id: fbird_query
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_query
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_restore
  
  Questa funzione è sinonimo di:  <strong>ibase_restore()</strong>.


id: fbird_rollback
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_rollback
  
  Questa funzione è sinonimo di:  <strong>ibase_rollback()</strong>.


id: fbird_rollback_ret
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_rollback_ret
  
  Questa funzione è sinonimo di:  <strong>ibase_rollback_ret()</strong>.


id: fbird_server_info
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_server_info
  
  Questa funzione è sinonimo di:  <strong>ibase_server_info()</strong>.


id: fbird_service_attach
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_service_attach
  
  Questa funzione è sinonimo di:  <strong>ibase_service_attach()</strong>.


id: fbird_service_detach
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_service_detach
  
  Questa funzione è sinonimo di:  <strong>ibase_service_detach()</strong>.


id: fbird_set_event_handler
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_set_event_handler
  
  Questa funzione è sinonimo di:  <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>
  Alias di ibase_trans
  
  Questa funzione è sinonimo di:  <strong>ibase_trans()</strong>.


id: fbird_wait_event
type: function
doc:
<comment>Description:</comment>
  Alias di ibase_wait_event
  
  Questa funzione è sinonimo di:  <strong>ibase_wait_event()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>
   * <strong>fbird_free_event_handler()</strong>


id: fbsql_affected_rows
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero di righe (tuple) interessate nella precedente operazione di FrontBase


id: fbsql_blob_size
type: function
doc:
<comment>Description:</comment>
  Get the size of a BLOB
  
  Returns the size of the given BLOB.

<comment>Param:</comment>
  <info>string</info>  <strong>$blob_handle    </strong>  A BLOB handle, returned by <strong>fbsql_create_blob()</strong>.
  <info>      </info>  <strong>$link_identifier</strong>  Un identificatore di connessione FrontBase
                            restituito da <strong>fbsql_connect()</strong> o
                            <strong>fbsql_pconnect()</strong>.
                            
                            Se opzionale e non specificata,
                            la funzione cercherà di trovare una connesione aperto al server
                            FrontBase e se non
                            lo trova cercherà di crearne una come se
                            <strong>fbsql_connect()</strong> fosse stata chiamata senza argomenti

<comment>Return:</comment>
  <info>int</info>  Returns the BLOB size as an integer, or <info>false</info> on error.

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


id: fbsql_change_user
type: function
doc:
<comment>Description:</comment>
  Cambia l'identità dell'utente connesso con una connessione attiva


id: fbsql_clob_size
type: function
doc:
<comment>Description:</comment>
  Get the size of a CLOB
  
  Returns the size of the given CLOB.

<comment>Param:</comment>
  <info>string</info>  <strong>$clob_handle    </strong>  A CLOB handle, returned by <strong>fbsql_create_clob()</strong>.
  <info>      </info>  <strong>$link_identifier</strong>  Un identificatore di connessione FrontBase
                            restituito da <strong>fbsql_connect()</strong> o
                            <strong>fbsql_pconnect()</strong>.
                            
                            Se opzionale e non specificata,
                            la funzione cercherà di trovare una connesione aperto al server
                            FrontBase e se non
                            lo trova cercherà di crearne una come se
                            <strong>fbsql_connect()</strong> fosse stata chiamata senza argomenti

<comment>Return:</comment>
  <info>int</info>  Returns the CLOB size as an integer, or <info>false</info> on error.

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


id: fbsql_database
type: function
doc:
<comment>Description:</comment>
  Imposta oppure ottiene il nome del database usato per la connessione


id: fbsql_errno
type: function
doc:
<comment>Description:</comment>
  Ritorna il valore numerico del messaggio 
       di errore emesso dalla precedente operazione FrontBase.


id: fbsql_error
type: function
doc:
<comment>Description:</comment>
  Ritorna il testo del messaggio di errore emesso dalla precedente operazione 
       FrontBase.


id: fbsql_fetch_array
type: function
doc:
<comment>Description:</comment>
  Restituisce una riga (tupla) di risultato in forma di Array associativo, Array enumerato o 
       entrambi


id: fbsql_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Restituisce una riga (tupla) di risultato in forma di Array associativo.


id: fbsql_fetch_field
type: function
doc:
<comment>Description:</comment>
  Ottiene informazioni su una colonna da un set di risultati come oggetto


id: fbsql_fetch_object
type: function
doc:
<comment>Description:</comment>
  Resituisce un riga da un set di risultati come oggetto
  
  La funzione <strong>fbsql_fetch_object()</strong> è simile a <strong>fbsql_fetch_array()</strong>, con una differenza, resituisce un
  oggetto anzichè un array. Indirettamente ciò significa che si può accedere ai dati solo per nome
  dei campi, e non per il loro offset (i numeri non sono nomi di proprietà validi).
  
  Come performance la funzione è simile a  <strong>fbsql_fetch_array()</strong>, e quasi veloce come
  <strong>fbsql_fetch_row()</strong> (le differenza è insignificante).

<comment>Param:</comment>
  <info></info>  <strong>$result</strong>  Un identificatore di risultato
             restituito da <strong>fbsql_query()</strong> o
             <strong>fbsql_db_query()</strong>.

<comment>Return:</comment>
  <info>object</info>  Restituisce un oggetto con le proprietà che corrispondono alla riga recuperata, oppure
          <info>false</info> se non ci sono più righe.

<comment>See Also:</comment>
   * <strong>fbsql_fetch_array()</strong>
   * <strong>fbsql_fetch_row()</strong>
   * <strong>fbsql_fetch_assoc()</strong>


id: fbsql_field_seek
type: function
doc:
<comment>Description:</comment>
  Imposta il puntatore del set di risultati ad un specifico indice di campo


id: fbsql_rows_fetched
type: function
doc:
<comment>Description:</comment>
  Get the number of rows affected by the last statement
  
  Gets the number of rows affected by the last statement.

<comment>Param:</comment>
  <info></info>  <strong>$result</strong>  Un identificatore di risultato
             restituito da <strong>fbsql_query()</strong> o
             <strong>fbsql_db_query()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows, as an integer.


id: fbsql_set_characterset
type: function
doc:
<comment>Description:</comment>
  Change input/output character set
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.


id: fbsql_set_password
type: function
doc:
<comment>Description:</comment>
  Change the password for a given user
  
  Changes the password for the given <strong>$user</strong>.

<comment>Param:</comment>
  <info>      </info>  <strong>$link_identifier</strong>  Un identificatore di connessione FrontBase
                            restituito da <strong>fbsql_connect()</strong> o
                            <strong>fbsql_pconnect()</strong>.
                            
                            Se opzionale e non specificata,
                            la funzione cercherà di trovare una connesione aperto al server
                            FrontBase e se non
                            lo trova cercherà di crearne una come se
                            <strong>fbsql_connect()</strong> fosse stata chiamata senza argomenti
  <info>string</info>  <strong>$user           </strong>  The user name.
  <info>string</info>  <strong>$password       </strong>  The new password to be set.
  <info>string</info>  <strong>$old_password   </strong>  The old password to be replaced.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: fbsql_table_name
type: function
doc:
<comment>Description:</comment>
  Get table name of field
  
  <strong>fbsql_table_name()</strong> gets the name of the current table in the given <strong>$result</strong> set.
  
  The <strong>fbsql_num_rows()</strong> function may be used to determine the number of tables in the result pointer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  A result pointer returned by <strong>fbsql_list_tables()</strong>.
  <info>int     </info>  <strong>$index </strong>  Integer index for the current table.

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


id: fdf_add_doc_javascript
type: function
doc:
<comment>Description:</comment>
  Aggiunge codice Javascript ad un documento FDF
  
  Aggiunge uno script al documento FDF, che in seguito Acrobat aggiungerà agli script del documento
  una volta che l'FDF è importato.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> oppure
                           <strong>fdf_open_string()</strong>.
  <info>string  </info>  <strong>$script_name </strong>  Il nome dello script.
  <info>string  </info>  <strong>$script_code </strong>  Il codice dello script. È fortemente suggerito utilizzare <return>\r</return> per le
                           interruzioni di riga all'interno del codice dello script.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: fdf_add_template
type: function
doc:
<comment>Description:</comment>
  Aggiunge un template in un documento FDF
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: fdf_close
type: function
doc:
<comment>Description:</comment>
  Chiude un documento FDF
  
  Chiude il documento FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> o
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


id: fdf_create
type: function
doc:
<comment>Description:</comment>
  Crea un nuovo documento FDF
  
  Crea un nuovo documento FDF.
  
  Questa funzione è necessaria se si desidera compilare con dei dati dei campi di input in un
  documento PDF.

<comment>Return:</comment>
  <info>resource</info>  Restituisce un handle del documento FDF, o <info>false</info> in caso di errore.

<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>
  Richiama una funzione definita dall'utente per ciascun valore del documento
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: fdf_errno
type: function
doc:
<comment>Description:</comment>
  Restituisce il codice di errore per l'ultima operazione FDF
  
  Ottiene il codice di erore impostato dall'ultima funzione FDF eseguita.
  
  Una descrizione testuale dell'errore può essere ottenuta usando <strong>fdf_error()</strong>.

<comment>Return:</comment>
  <info>int</info>  Restituisce il codice dell'errore come integer, o zero se c'è stato nessun errore.

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


id: fdf_error
type: function
doc:
<comment>Description:</comment>
  Restituisce la descrizione di un codice di errore FDF
  
  Ottiene la descrizione testuale per il codice di errore FDF passato da <strong>$error_code</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Un codice di errore ottenuto con <strong>fdf_errno()</strong>. Se non è presente, questa funzione
                    utilizza il codice dell'errore interno fissato dall' ultima operazione.

<comment>Return:</comment>
  <info>string</info>  Restituisce il messaggio di errore come stringa, o la stringa <return>no error</return> se nessun errore
          viene riscontrato.

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


id: fdf_get_ap
type: function
doc:
<comment>Description:</comment>
  Ottiene l'aspetto di un campo
  
  Ottiene l'aspetto sul campo <strong>$field</strong> (per es. il valore della chiave /AP) e la memorizza in un file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> o
                           <strong>fdf_open_string()</strong>.
  <info>string  </info>  <strong>$field       </strong>  
  <info>int     </info>  <strong>$face        </strong>  I possibili valori sono <info>FDFNormalAP</info>,  <info>FDFRolloverAP</info> e <info>FDFDownAP</info>.
  <info>string  </info>  <strong>$filename    </strong>  L'aspetto sarà memorizzato in questo parametro.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: fdf_get_attachment
type: function
doc:
<comment>Description:</comment>
  Estrae un file caricato racchiuso nel FDF
  
  Estrae un file caricato indicato dal "selettore di file" <strong>$fieldname</strong> e lo memorizza in <strong>$savepath</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> o
                           <strong>fdf_open_string()</strong>.
  <info>string  </info>  <strong>$fieldname   </strong>  
  <info>string  </info>  <strong>$savepath    </strong>  Può essere il nome di un file normale o una directory esistente in cui il
                           file deve essere creato con il suo nome originale. Qualsiasi file
                           esistente con lo stesso nome sarà sovrascritto.
                           
                           Sembra che non ci sia altro modo per risalire al nome originale del file
                           se non quello di memorizzare il file nella directory indicata da
                           <strong>$savepath</strong> e verificare se il nome di base è stato salvato.

<comment>Return:</comment>
  <info>array</info>  L'array restituito contiene i seguenti campi: <strong>$path</strong> - percorso in cui viene archiviato il
         file<strong>$size</strong> - dimensione del file salvato in bytes<strong>$type</strong> - mimetype se è dato nell'FDF
         
         <strong>$path</strong> - percorso in cui viene archiviato il file
         
         <strong>$size</strong> - dimensione del file salvato in bytes
         
         <strong>$type</strong> - mimetype se è dato nell'FDF


id: fdf_get_encoding
type: function
doc:
<comment>Description:</comment>
  Restituisce il valore della chiave /Encoding
  
  Restituisce il valore della chiave <return>/Encoding</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> o
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Restituisce la codifica come una stringa. Viene restituita una stringa vuota se lo schema
          predefinito <return>PDFDocEncoding/Unicode</return> è utilizzato.

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


id: fdf_get_file
type: function
doc:
<comment>Description:</comment>
  Ottiene il valore della chiave /F
  
  Restituisce il valore della chiave <return>/F</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  L'handle del documento FDF, restituito da <strong>fdf_create()</strong>, <strong>fdf_open()</strong> o
                           <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Ritorna il valore della chiave, come una stringa.

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


id: fdf_get_flags
type: function
doc:
<comment>Description:</comment>
  Ottiene i flag di un campo
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: fdf_set_on_import_javascript
type: function
doc:
<comment>Description:</comment>
  Adds javascript code to be executed when Acrobat opens the FDF
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

<comment>See Also:</comment>
   * <strong>fdf_add_doc_javascript()</strong>
   * <strong>fdf_set_javascript_action()</strong>


id: fdiv
type: function
doc:
<comment>Description:</comment>
  Divides two numbers, according to IEEE 754
  
  Returns the floating point result of dividing the <strong>$num1</strong> by the <strong>$num2</strong>. If the <strong>$num2</strong> is zero, then
  one of <return>INF</return>, <return>-INF</return>, or <return>NAN</return> will be returned.
  
  Note that in comparisons, <return>NAN</return> will never == or ===, any value, including itself.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  The dividend (numerator)
  <info>float</info>  <strong>$num2</strong>  The divisor

<comment>Return:</comment>
  <info>float</info>  The floating point result of <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - Floating-point division
   * <strong>intdiv()</strong> - Integer division
   * <strong>fmod()</strong> - Modulus


id: feof
type: function
doc:
<comment>Description:</comment>
  Verifica se è stata raggiunta la fine del file su un puntatore a file


id: fgetcsv
type: function
doc:
<comment>Description:</comment>
  Prende una riga da un puntatore a file e l'analizza in cerca di campi CSV


id: file_put_contents
type: function
doc:
<comment>Description:</comment>
  Write data to a file
  
  This function is identical to calling <strong>fopen()</strong>,  <strong>fwrite()</strong> and <strong>fclose()</strong> successively to write data
  to a file.
  
  If <strong>$filename</strong> does not exist, the file is created. Otherwise, the existing file is overwritten,
  unless the  <info>FILE_APPEND</info> flag is set.

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename</strong>  Path to the file where to write the data.
  <info>mixed   </info>  <strong>$data    </strong>  The data to write. Can be either a <info>string</info>, an <info>array</info> or a <info>stream</info> resource.
                       
                       If <strong>$data</strong> is a <info>stream</info> resource, the remaining buffer of that stream will be
                       copied to the specified file. This is similar with using
                       <strong>stream_copy_to_stream()</strong>.
                       
                       You can also specify the <strong>$data</strong> parameter as a single dimension array. This is
                       equivalent to <return>file_put_contents($filename, implode('', $array))</return>.
  <info>int     </info>  <strong>$flags   </strong>  The value of <strong>$flags</strong> can be any combination of  the following flags, joined
                       with the binary OR (<return>|</return>) operator.
                       
                       Available flagsFlagDescription<info>FILE_USE_INCLUDE_PATH</info> Search for <strong>$filename</strong> in
                       the include directory. See include_path for more information. <info>FILE_APPEND</info> If
                       file <strong>$filename</strong> already exists, append  the data to the file instead of
                       overwriting it. <info>LOCK_EX</info> Acquire an exclusive lock on the file while
                       proceeding to the  writing. In other words, a <strong>flock()</strong> call happens between
                       the <strong>fopen()</strong> call and the  <strong>fwrite()</strong> call. This is not identical to an  <strong>fopen()</strong>
                       call with mode "x".
  <info>resource</info>  <strong>$context </strong>  A valid context resource created with  <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>int</info>  This function returns the number of bytes that were written to the file, or <info>false</info> on failure.
       
       Questa funzione può
       restituire il Booleano <info>false</info>, ma può anche restituire un valore non-Booleano valutato
       come <info>false</info>. Fare riferimento alla sezione Booleans per maggiori 
       informazioni. Usare l'operatore ===
        per controllare il valore restituito da questa 
       funzione.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>fwrite()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>stream_context_create()</strong>


id: filegroup
type: function
doc:
<comment>Description:</comment>
  Restituisce il gruppo di un file
  
  Restituisce il gruppo del file. L'ID del gruppo viene restituito in formato numerico, utilizzare
  <strong>posix_getgrgid()</strong> per risolverlo in un nome di gruppo.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Percorso del file.

<comment>Return:</comment>
  <info>int</info>  Restituisce l'ID del gruppo del file, o <info>false</info> in caso d'errore. L'ID del gruppo viene
       restituito in formato numerico, utilizzare <strong>posix_getgrgid()</strong> per risolverlo in un nome di
       gruppo. In caso di errore viene restituito <info>false</info>.

<comment>See Also:</comment>
   * <strong>fileowner()</strong>
   * <strong>posix_getgrgid()</strong>


id: filepro
type: function
doc:
<comment>Description:</comment>
  Legge e verifica il map file
  
  Questa funzione legge e verifica il map file, memorizzando il conteggio dei campi e le
  informazioni.
  
  Non viene eseguito alcun lock, quindi si dovrebbe evitare di modificare il proprio database
  filePro mentre potrebbe essere aperto in PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  La cartella map.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: filepro_retrieve
type: function
doc:
<comment>Description:</comment>
  Preleva i dati da un database filePro
  
  Restituisce i dati dalla posizione specificata nel database.

<comment>Param:</comment>
  <info>int</info>  <strong>$row_number  </strong>  Il numero di riga. Deve essere compreso tra zero ed il numero totale di righe
                      meno uno (0..<strong>filepro_rowcount()</strong> - 1)
  <info>int</info>  <strong>$field_number</strong>  Il numero del campo. Accetta valori compresi tra zero ed il numero totale di
                      campi meno uno (0..<strong>filepro_fieldcount()</strong> - 1)

<comment>Return:</comment>
  <info>string</info>  Restituisce i dati specificati o <info>false</info> in caso di errori.


id: filepro_rowcount
type: function
doc:
<comment>Description:</comment>
  Conta quante righe sono presenti in un database filePro
  
  Restituisce il numero di righe nel database filePro aperto.

<comment>Return:</comment>
  <info>int</info>  Restituisce il numero di righe nel database filePro aperto, o <info>false</info> in caso di errori.

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


id: filter_has_var
type: function
doc:
<comment>Description:</comment>
  Checks if variable of specified type exists

<comment>Param:</comment>
  <info>int   </info>  <strong>$input_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 check.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: filter_id
type: function
doc:
<comment>Description:</comment>
  Returns the filter ID belonging to a named filter

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of a filter to get.

<comment>Return:</comment>
  <info>intfalse</info>  ID of a filter on success or <info>false</info> if filter doesn't exist.

<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>  The ID of the filter to apply. The  manual page lists the available filters.
                       
                       If omitted, <info>FILTER_DEFAULT</info> will be used, which is equivalent to
                       <info>FILTER_UNSAFE_RAW</info>. This will result in no filtering taking place by default.
  <info>arrayint</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>
  Gets external variables and optionally filters them
  
  This function is useful for retrieving many values without repetitively calling <strong>filter_input()</strong>.

<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>arrayint</info>  <strong>$options  </strong>  An array defining the arguments. A valid key is a <info>string</info> containing a
                        variable name and a valid value is either a filter type, or an <info>array</info>
                        optionally specifying the filter, flags and options. If the value is an
                        array, valid keys are <return>filter</return> which specifies the filter type, <return>flags</return> which
                        specifies any flags that apply to the filter, and <return>options</return> which specifies
                        any options that apply to the filter. See the example below for a better
                        understanding.
                        
                        This parameter can be also an integer holding a filter constant. Then all
                        values in the input array are filtered by this filter.
  <info>bool    </info>  <strong>$add_empty</strong>  Add missing keys as <info>null</info> to the return value.

<comment>Return:</comment>
  <info>arrayfalsenull</info>  An array containing the values of the requested variables on success. If the input
                  array designated by <strong>$type</strong> is not populated, the function returns <info>null</info> if the
                  <info>FILTER_NULL_ON_FAILURE</info> flag is not given, or <info>false</info> otherwise. For other failures,
                  <info>false</info> is returned.
                  
                  An array value will be <info>false</info> if the filter fails, or <info>null</info> if  the variable is not
                  set. Or 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. If the <strong>$add_empty</strong> parameter is
                  <info>false</info>, no array element will be added for unset variables.

<comment>See Also:</comment>
   * <strong>filter_input()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_list
type: function
doc:
<comment>Description:</comment>
  Returns a list of all supported filters

<comment>Return:</comment>
  <info>array</info>  Returns an array of names of all supported filters, empty array if there are no such
         filters. Indexes of this array are not filter IDs, they can be obtained with <strong>filter_id()</strong>
         from a name instead.


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>  The ID of the filter to apply. The  manual page lists the available filters.
                      
                      If omitted, <info>FILTER_DEFAULT</info> will be used, which is equivalent to
                      <info>FILTER_UNSAFE_RAW</info>. This will result in no filtering taking place by default.
  <info>arrayint</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>
  Gets multiple variables and optionally filters them
  
  This function is useful for retrieving many values without repetitively calling <strong>filter_var()</strong>.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array    </strong>  An array with string keys containing the data to filter.
  <info>arrayint</info>  <strong>$options  </strong>  An array defining the arguments. A valid key is a <info>string</info> containing a
                        variable name and a valid value is either a filter type, or an <info>array</info>
                        optionally specifying the filter, flags and options. If the value is an
                        array, valid keys are <return>filter</return> which specifies the filter type, <return>flags</return> which
                        specifies any flags that apply to the filter, and <return>options</return> which specifies
                        any options that apply to the filter. See the example below for a better
                        understanding.
                        
                        This parameter can be also an integer holding a filter constant. Then all
                        values in the input array are filtered by this filter.
  <info>bool    </info>  <strong>$add_empty</strong>  Add missing keys as <info>null</info> to the return value.

<comment>Return:</comment>
  <info>arrayfalsenull</info>  An array containing the values of the requested variables on success, or <info>false</info>  on
                  failure. An array value will be <info>false</info> if the filter fails, or <info>null</info> if  the
                  variable is not set.

<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>
  This class provides an object oriented interface into the fileinfo functions.


id: finfo::__construct
type: function
doc:
<comment>Description:</comment>
  Alias di finfo_open
  
  Questa funzione è sinonimo di:  <strong>finfo_open()</strong>


id: finfo::buffer
type: function
doc:
<comment>Description:</comment>
  Alias di finfo_buffer()
  
  Questa funzione è sinonimo di:  finfo_buffer()

<comment>Return:</comment>
  <info>stringfalse</info>  


id: finfo::file
type: function
doc:
<comment>Description:</comment>
  Alias di finfo_file()
  
  Questa funzione è sinonimo di:  finfo_file()

<comment>Return:</comment>
  <info>stringfalse</info>  


id: finfo::set_flags
type: function
doc:
<comment>Description:</comment>
  Alias di finfo_set_flags()
  
  Questa funzione è sinonimo di:  finfo_set_flags()

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


id: finfo_buffer
type: function
doc:
<comment>Description:</comment>
  Return information about a string buffer
  
  Stile procedurale
  
  Stile orientato agli oggetti
  
  This function is used to get information about binary data in a string.

<comment>Param:</comment>
  <info>resource    </info>  <strong>$finfo  </strong>  Fileinfo resource returned by <strong>finfo_open()</strong>.
  <info>string      </info>  <strong>$string </strong>  Content of a file to be checked.
  <info>int         </info>  <strong>$flags  </strong>  One or disjunction of more Fileinfo constants.
  <info>resourcenull</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>stringfalse</info>  Returns a textual description of the <strong>$string</strong> argument, or <info>false</info> if an error occurred.

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


id: finfo_close
type: function
doc:
<comment>Description:</comment>
  Close fileinfo resource
  
  This function closes the resource opened by <strong>finfo_open()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$finfo</strong>  Fileinfo resource returned by <strong>finfo_open()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: finfo_file
type: function
doc:
<comment>Description:</comment>
  Return information about a file
  
  Stile procedurale
  
  Stile orientato agli oggetti
  
  This function is used to get information about a file.

<comment>Param:</comment>
  <info>resource    </info>  <strong>$finfo   </strong>  Fileinfo resource returned by <strong>finfo_open()</strong>.
  <info>string      </info>  <strong>$filename</strong>  Name of a file to be checked.
  <info>int         </info>  <strong>$flags   </strong>  One or disjunction of more Fileinfo constants.
  <info>resourcenull</info>  <strong>$context </strong>  For a description of <return>contexts</return>, refer to .

<comment>Return:</comment>
  <info>stringfalse</info>  Returns a textual description of the contents of the <strong>$filename</strong> argument, or <info>false</info> if
               an error occurred.

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


id: finfo_open
type: function
doc:
<comment>Description:</comment>
  Create a new fileinfo resource
  
  Stile procedurale
  
  Stile orientato agli oggetti (constructor):
  
  This function opens a magic database and returns its resource.

<comment>Param:</comment>
  <info>int   </info>  <strong>$flags         </strong>  One or disjunction of more Fileinfo constants.
  <info>string</info>  <strong>$magic_database</strong>  Name of a magic database file, usually something like
                           /path/to/magic.mime. If not specified, the <return>MAGIC</return> environment variable is
                           used. If the environment variable isn't set, then PHP's bundled magic
                           database will be used.
                           
                           Passing <info>null</info> or an empty string will be equivalent to the default value.

<comment>Return:</comment>
  <info>resourcefalse</info>  (Procedural style only) Returns a magic database resource on success o <info>false</info> in
                 caso di fallimento.

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


id: finfo_set_flags
type: function
doc:
<comment>Description:</comment>
  Set libmagic configuration options
  
  Stile procedurale
  
  Stile orientato agli oggetti
  
  This function sets various Fileinfo options. Options can be set also directly in <strong>finfo_open()</strong> or
  other Fileinfo functions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$finfo</strong>  Fileinfo resource returned by <strong>finfo_open()</strong>.
  <info>int     </info>  <strong>$flags</strong>  One or disjunction of more Fileinfo constants.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: floatval
type: function
doc:
<comment>Description:</comment>
  Restituisce il valore di una variabile di tipo float
  
  La funzione restituisce il valore di tipo <info>float</info> di <strong>$var</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  Può anche essere di tipo scalare. La funzione <strong>floatval()</strong> non dovrebbe essere usata
               sugli oggetti, facendolo emetterà un errore di livello <info>E_NOTICE</info> e restituirà 1.

<comment>Return:</comment>
  <info>float</info>  Il valore in virgola mobile della variabile. Gli array vuoti restituiscono 0, gli array non
         vuoti restituiscono 1.
         
         Le stringhe molto probabilmente restituiscono 0 anche se questo dipende dai  caratteri più
         a sinistra della stringa. Si applicano le regole  comuni del  casting del float.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>intval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * Type juggling


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 you will have to call both <strong>ob_flush()</strong> and <strong>flush()</strong> to flush the ob
  output buffers if you are using those.
  
  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>  Nessun valore viene restituito.

<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>
  Returns the floating point remainder (modulo) of the division
    of the arguments
  
  Returns the floating point remainder of dividing the dividend (<strong>$num1</strong>) by the divisor (<strong>$num2</strong>). The
  remainder (r) is defined as: num1 = i * num2 + r, for  some integer i. If <strong>$num2</strong> is non-zero, r has
  the same sign as <strong>$num1</strong> and a magnitude less than the magnitude of <strong>$num2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  The dividend
  <info>float</info>  <strong>$num2</strong>  The divisor

<comment>Return:</comment>
  <info>float</info>  The floating point remainder of  <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - Floating-point division
   * <return>%</return> - Integer modulus
   * <strong>intdiv()</strong> - Integer division


id: fnmatch
type: function
doc:
<comment>Description:</comment>
  Match filename against a pattern
  
  <strong>fnmatch()</strong> checks if the passed <strong>$filename</strong> would match the given shell wildcard <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern </strong>  The shell wildcard pattern.
  <info>string</info>  <strong>$filename</strong>  The tested string. This function is especially useful for filenames, but may
                     also be used on regular strings.
                     
                     The average user may be used to shell patterns or at least in their simplest
                     form to <return>'?'</return> and <return>'*'</return> wildcards so using <strong>fnmatch()</strong> instead of <strong>preg_match()</strong> for
                     frontend search expression input may be way more convenient for non-programming
                     users.
  <info>int   </info>  <strong>$flags   </strong>  The value of <strong>$flags</strong> can be any combination of  the following flags, joined with
                     the binary OR (|) operator.  A list of possible flags for <strong>fnmatch()</strong>
                     <strong>$Flag</strong>Description<info>FNM_NOESCAPE</info> Disable backslash escaping. <info>FNM_PATHNAME</info> Slash in
                     string only matches slash in the given pattern. <info>FNM_PERIOD</info> Leading period in
                     string must be exactly matched by period in the given pattern. <info>FNM_CASEFOLD</info>
                     Caseless match. Part of the GNU extension.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there is a match, <info>false</info> otherwise.

<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>
  Apre un file o un URL
  
  La funzione <strong>fopen()</strong> apre un collegamento tra una risorsa, indicata dal parametro <strong>$filename</strong>, ed un
  flusso.

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename        </strong>  Se il parametro <strong>$filename</strong> è nella forma "scheme://...", si assume che
                               sia un URL e PHP cercherà il modulo di gestione del protocollo (detto
                               anche wrapper) per quello schema. Se non vi sono wrapper registrati
                               per il protocollo richiesto, PHP genererà un messaggio per aiutare a
                               trovare potenziali problemi nello script e quindi procede
                               considerando <strong>$filename</strong> come un file normale.
                               
                               Se PHP ha stabilito che <strong>$filename</strong> indica un file locale, tenterà di
                               aprire detto file come stream. Il file in oggetto dovrà esere
                               accessibile a PHP, occorre, pertanto, assicurarsi che i permessi di
                               accesso del file lo consentano. Se si è attivato open_basedir
                               potrebbero essere applicate ulteriori restrizioni.
                               
                               Se PHP ha stabilito che <strong>$filename</strong> indica un protocollo registrato, e
                               che tale protocollo è registrato come un URL di rete, PHP verificherà
                               che allow_url_fopen sia abilitato. Se fosse disabilitato, PHP
                               genererà un avviso e la chiamata ad fopen fallirà.
                               
                               L'elenco dei protocolli supportati si trova in . Alcuni protocolli
                               (indicati anche come <return>wrappers</return>) supportano il <return>context</return> e/o le opzioni
                               del php.ini. Fare riferimento alla pagina specifica del protocollo in
                               uso per avere l'elenco delle opzioni che possono essere utilizzate.
                               (Ad esempio il valore di <return>user_agent</return> del php.ini è utilizzato dal
                               wrapper <return>http</return>).
                               
                               Sulla piattaforma Windows, fare attenzione effettuando l'escape dei
                               backslash usati nel percorso del file, o utilizzare gli slash.
                               ]]>
  <info>string  </info>  <strong>$mode            </strong>  Il parametro <strong>$mode</strong> indica il tipo di accesso richiesto per il flusso.
                               Esso può essere uno dei seguenti:  Elenco dei possibili valori usati
                               da <strong>fopen()</strong> per il parametro <strong>$mode</strong> <strong>$mode</strong>Descrizione<return>'r'</return> Apre in sola
                               lettura; posiziona il puntatore all'inizio del file. <return>'r+'</return> Apre in
                               lettura e scrittura; posiziona il puntatore all'inizio del file. <return>'w'</return>
                               Apre il file in sola scrittura; posiziona il puntatore all'inizio del
                               file e tronca il file alla lunghezza zero. Se il file non esiste,
                               tenta di crearlo. <return>'w+'</return> Apre in lettura e scrittura; posiziona il
                               puntatore all'inizio del file e tronca il file alla lunghezza zero.
                               Se il file non esiste, tenta di crearlo. <return>'a'</return> Apre in sola scrittura;
                               posiziona il puntatore alla fine del file. Se il file non esiste,
                               tenta di crearlo. In questa modalità, <strong>fseek()</strong> non ha effetto, le
                               scritture vengono sempre aggiunte alla fine. <return>'a+'</return> Apre in lettura e
                               scrittura; posiziona il puntatore alla fine del file. Se il file non
                               esiste, tenta di crearlo. In questa modalità <strong>fseek()</strong> influisce solo
                               sulla posizione di lettura, le scritture vengono sempre aggiunte alla
                               fine. <return>'x'</return> Crea ed apre il file in sola scrittura; posiziona il
                               puntatore all'inizio del file. Se il file esiste già, la chiamata a
                               <strong>fopen()</strong> fallirà restituendo <info>false</info> e verrà generato un errore di
                               livello <info>E_WARNING</info>. Se il file non esiste, si tenterà di crearlo.
                               Questo equivale a specificare i flag <return>O_EXCL|O_CREAT</return> nella sottostante
                               chiamata di sistema a <return>open(2)</return>. <return>'x+'</return> Crea ed apre il file in lettura e
                               scrittura; per il resto ha lo stesso comportamento di <return>'x'</return>. <return>'c'</return> Apre
                               il file in sola scrittura. Se il file non esiste, viene creato. Se
                               esiste, non viene né troncato (al contrario di <return>'w'</return>), né la chiamata a
                               questa funzione fallisce (come nel caso di <return>'x'</return>). Il puntatore del
                               file è posizionato all'inizio del file. Questo può essere utile se si
                               desidera ottenere un advisory lock (vedere <strong>flock()</strong>) prima di tentare
                               di modificare il file, poiché l'utilizzo di <return>'w'</return> potrebbe troncare il
                               file prima che il lock venga ottenuto (se si desidera troncare, può
                               essere usata <strong>ftruncate()</strong>dopo che il lock viene richiesto). <return>'c+'</return> Apre
                               il file in lettura e scrittura; per il resto ha lo stesso
                               comportamento di <return>'c'</return>. <return>'e'</return> Imposta il flag close-on-exec sul
                               descrittore del file aperto. Disponibile solo per PHP compilato su
                               sistemi conformi a POSIX.1-2008.
                               
                               Differenti famiglie di file system hanno differenti convenzioni di
                               terminatori di riga. Quando si scrive un file di testo e si desidera
                               inserire una interruzione di linea, occorre utilizzare il terminatore
                               appropriato per il sistema operativo utilizzato. I sistemi basati su
                               Unix utilizzano <return>\n</return> come terminatore di riga, i sistemi basati su
                               Windows utilizzano <return>\r\n</return> mentre i sistemi Macintosh (Mac OS Classic)
                               utilizzano <return>\r</return>.
                               
                               Se si utilizza un errato terminatore di riga quando si scrivono i
                               file, si può verificare che altre applicazioni che aprono questi file
                               abbiano "comportamenti bizzarri".
                               
                               Windows offre un flag di traduzione della modalità testo (<return>'t'</return>) che in
                               modo trasparente converte <return>\n</return>  in <return>\r\n</return> mentre si lavora sul file. In
                               contrasto, si può anche usare il flag <return>'b'</return> per forzare una modalità
                               binaria, nella quale non si ha la conversione dei dati. Per usare
                               questi flag, <return>'b'</return> oppure <return>'t'</return>, devono essere posizionati come ultimo
                               carattere del parametro <strong>$mode</strong>.
                               
                               La modalità di conversione di default è <return>'b'</return>. Si può usare la modalità
                               <return>'t'</return> se si lavora con dei file di testo e si utilizza  <return>\n</return> per indicare
                               il fine linea negli script, ma ci si aspetta che applicazioni, tipo
                               vecchie versioni di notepad, leggano i file prodotti. In tutti gli
                               altri casi si dovrebbe utilizzare <return>'b'</return>.
                               
                               Se non si specifica il flag 'b' quando si lavora con file binari, si
                               possono avere situazioni anomale nei dati, tipo immagini corrotte, e
                               situazioni anomale con i caratteri <return>\r\n</return>.
                               
                               Per la portabilità, è fortemente raccomandato di riscrivere il codice
                               che utilizza o che si avvale del mode <return>'t'</return>, così da utilizzare il
                               corretto terminatore di linea invece del <return>'b'</return> mode.
  <info>bool    </info>  <strong>$use_include_path</strong>  Il terzo parametro opzionale <strong>$use_include_path</strong> può essere impostato a
                               '1' oppure a <info>true</info> se si desidera cercare il file anche in
                               include_path.
  <info>resource</info>  <strong>$context         </strong>  Il supporto per il contesto è stato
                               aggiunto in PHP 5.0.0. Per la descrizione del <return>contesto</return>, fare
                               riferimento a
                               .

<comment>Return:</comment>
  <info>resource</info>  Restituisce una risorsa puntatore a file in caso di successo, o <info>false</info> in caso di
            fallimento

<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: fputcsv
type: function
doc:
<comment>Description:</comment>
  Format line as CSV and write to file pointer
  
  <strong>fputcsv()</strong> formats a line (passed as a <strong>$fields</strong> array) as CSV and writes it (terminated by a
  newline) to the specified file <strong>$handle</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle     </strong>  Il puntatore al file deve essere valido, e deve puntare ad
                          un file aperto con successo da <strong>fopen()</strong> o
                          <strong>fsockopen()</strong> (e non ancora chiuso da
                          <strong>fclose()</strong>).
  <info>array   </info>  <strong>$fields     </strong>  An array of <info>string</info>s.
  <info>string  </info>  <strong>$delimiter  </strong>  The optional <strong>$delimiter</strong> parameter sets the field delimiter (one character
                          only).
  <info>string  </info>  <strong>$enclosure  </strong>  The optional <strong>$enclosure</strong> parameter sets the field enclosure (one character
                          only).
  <info>string  </info>  <strong>$escape_char</strong>  The optional <strong>$escape_char</strong> parameter sets the escape character (at most one
                          character). An empty string (<return>""</return>) disables the proprietary escape
                          mechanism.

<comment>Return:</comment>
  <info>intfalse</info>  Returns the length of the written string  o <info>false</info> in caso di fallimento.

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


id: fread
type: function
doc:
<comment>Description:</comment>
  Legge un file salvaguardando la corrispondenza binaria
  
  <strong>fread()</strong> legge fino a <strong>$length</strong> byte dal puntatore al file indicato da <strong>$handle</strong>. La lettura finisce
  quando una delle seguenti condizioni è raggiunta:  sono stati letti <strong>$length</strong> byte  è stata
  raggiunta EOF (end of file - fine del file)  un pacchetto diventa disponibile o si verifica un
  socket timeout (nel caso di stream sulla rete)   se lo stream è letto attraverso un buffer e non
  rappresenta un normale file, viene fatta almeno una lettura di un numero di byte uguale alla
  dimensione del chunk (di solito 8192); a seconda dei dati precedentemente messi nel buffer, la
  dimensione dei dati restituiti può essere maggiore della dimensione del chunk.
  
  sono stati letti <strong>$length</strong> byte
  
  è stata raggiunta EOF (end of file - fine del file)
  
  un pacchetto diventa disponibile o si verifica un  socket timeout (nel caso di stream sulla rete)
  
  se lo stream è letto attraverso un buffer e non rappresenta un normale file, viene fatta almeno
  una lettura di un numero di byte uguale alla dimensione del chunk (di solito 8192); a seconda dei
  dati precedentemente messi nel buffer, la dimensione dei dati restituiti può essere maggiore della
  dimensione del chunk.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Un puntatore a una <info>resource</info> di filesystem
                     che è normalmente creata utilizzando <strong>fopen()</strong>.
  <info>int     </info>  <strong>$length</strong>  Fino a <strong>$length</strong> numero di byte letti.

<comment>Return:</comment>
  <info>string</info>  Restituisce la stringa letta  o <info>false</info> in caso di fallimento.

<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>ftell()</strong>
   * <strong>rewind()</strong>


id: fsockopen
type: function
doc:
<comment>Description:</comment>
  Apre una connessione a un socket appartenente a un dominio Internet o Unix


id: fstat
type: function
doc:
<comment>Description:</comment>
  Restituisce le informazioni riguardanti un file attraverso un puntatore al file aperto


id: ftok
type: function
doc:
<comment>Description:</comment>
  Converte il percorso e un identificatore di progetto in un chiave IPC di System V


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>resource</info>  <strong>$ftp_stream</strong>  The link identifier of the FTP connection.
  <info>int     </info>  <strong>$filesize  </strong>  The number of bytes to allocate.
  <info>string  </info>  <strong>$result    </strong>  A textual representation of the servers response will be returned by
                         reference in <strong>$result</strong> if a variable is provided.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

<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
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ftp        </strong>  
  <info>string  </info>  <strong>$remote_file</strong>  
  <info>string  </info>  <strong>$local_file </strong>  
  <info>int     </info>  <strong>$mode       </strong>  

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: ftp_chmod
type: function
doc:
<comment>Description:</comment>
  Set permissions on a file via FTP
  
  Sets the permissions on the specified remote file to  <strong>$mode</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ftp_stream</strong>  The link identifier of the FTP connection.
  <info>int     </info>  <strong>$mode      </strong>  The new permissions, given as an octal value.
  <info>string  </info>  <strong>$filename  </strong>  The remote file.

<comment>Return:</comment>
  <info>int</info>  Returns the new file permissions on success or <info>false</info> on error.

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


id: ftp_close
type: function
doc:
<comment>Description:</comment>
  Chiude una connessione FTP
  
  <strong>ftp_close()</strong> chiude <strong>$ftp_stream</strong> e rilascia la risorsa <info>resource</info>.
  
  Dopo aver chiamato questa funzione non è più possibile usare la connessione FTP ed  è necessario
  crearne una nuova con <strong>ftp_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ftp_stream</strong>  L'identificatore di collegamento della connessione FTP.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.

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


id: ftp_delete
type: function
doc:
<comment>Description:</comment>
  Cancella un file sul server FTP
  
  <strong>ftp_delete()</strong> cancella il file specificato da <strong>$path</strong> dal server FTP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ftp_stream</strong>  L'identificatore di collegamento della connessione FTP.
  <info>string  </info>  <strong>$path      </strong>  Il file da cancellare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.


id: ftp_get_option
type: function
doc:
<comment>Description:</comment>
  Recupera diversi comportamenti dello stream FTP durante l'esecuzione


id: ftp_mlsd
type: function
doc:
<comment>Description:</comment>
  Returns a list of files in the given directory

<comment>Param:</comment>
  <info>resource</info>  <strong>$ftp_stream</strong>  The link identifier of the FTP connection.
  <info>string  </info>  <strong>$directory </strong>  The directory to be listed.

<comment>Return:</comment>
  <info>array</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 ricevere/trasmettere un file in modalita' non bloccante


id: ftp_nb_fget
type: function
doc:
<comment>Description:</comment>
  Recupera un file dal server FTP e lo scrive su un file aperto, in modalita' non bloccante


id: ftp_nb_fput
type: function
doc:
<comment>Description:</comment>
  Salva il contenuto di un file aperto sul server FTP in modalita' non bloccante


id: ftp_nb_get
type: function
doc:
<comment>Description:</comment>
  Recupera un file dal server FTP e lo scrive su un file locale in modalita' non bloccante


id: ftp_rawlist
type: function
doc:
<comment>Description:</comment>
  Restituisce un elenco dettagliato dei files nella directory in esame


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

<comment>Param:</comment>
  <info>int</info>  <strong>$arg_num</strong>  The argument offset. Function arguments are counted starting from zero.

<comment>Return:</comment>
  <info>mixed</info>  Returns the specified argument, or <info>false</info> on error.

<comment>See Also:</comment>
   * <return>...</return> syntax in PHP 5.6+
   * <strong>func_get_args()</strong>
   * <strong>func_num_args()</strong>


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

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

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


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

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

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


id: function_exists
type: function
doc:
<comment>Description:</comment>
  Return true if the given function has been defined
  
  Checks the list of defined functions, both built-in (internal) and user-defined, for
  <strong>$function_name</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$function_name</strong>  The function name, as a string.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$function_name</strong> exists and is a function, <info>false</info> otherwise.
        
        This function will return <info>false</info> for constructs, such as  <strong>include_once()</strong> and <strong>echo()</strong>.

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


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

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

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


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

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


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

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.

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


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

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

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


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

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

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


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

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

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


id: gd_info
type: function
doc:
<comment>Description:</comment>
  Retrieve information about the currently installed GD library
  
  Gets information about the version and capabilities of the installed GD library.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array.
         
         Elements of array returned by <strong>gd_info()</strong>AttributeMeaningGD Version<info>string</info> value describing
         the installed <return>libgd</return> version.FreeType Support<info>bool</info> value.  <info>true</info> if FreeType Support is
         installed.FreeType Linkage<info>string</info> value describing the way in which FreeType was linked.
         Expected values are: 'with freetype', 'with TTF library', and 'with unknown library'.  This
         element will only be defined if <return>FreeType Support</return> evaluated to <info>true</info>.GIF Read Support<info>bool</info>
         value.  <info>true</info> if support for reading <return>GIF</return> images is included.GIF Create Support<info>bool</info> value.
         <info>true</info> if support for creating <return>GIF</return> images is included.JPEG Support<info>bool</info> value.  <info>true</info> if <return>JPEG</return>
         support is included.PNG Support<info>bool</info> value.  <info>true</info> if <return>PNG</return> support is included.WBMP
         Support<info>bool</info> value.  <info>true</info> if <return>WBMP</return> support is included.XBM Support<info>bool</info> value.  <info>true</info> if <return>XBM</return>
         support is included.WebP Support<info>bool</info> value.  <info>true</info> if <return>WebP</return> support is included.

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


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

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

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


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

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

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

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


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

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

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

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


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

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

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

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


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

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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.


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

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

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


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

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

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


id: get_browser
type: function
doc:
<comment>Description:</comment>
  Tells what the user's browser is capable of
  
  Attempts to determine the capabilities of the user's browser, by looking up the browser's
  information in the browscap.ini file.

<comment>Param:</comment>
  <info>string</info>  <strong>$user_agent  </strong>  The User Agent to be analyzed. By default, the value of HTTP User-Agent
                         header is used; however, you can alter this (i.e., look up another
                         browser's info) by passing this parameter.
                         
                         You can bypass this parameter with a <info>null</info> value.
  <info>bool  </info>  <strong>$return_array</strong>  If set to <info>true</info>, this function will return an <info>array</info> instead of an <info>object</info>.

<comment>Return:</comment>
  <info>mixed</info>  The information is returned in an object or an array which will contain various data
         elements representing, for instance, the browser's major and minor version numbers and ID
         string; <info>true</info>/<info>false</info> values for features such as frames, JavaScript, and cookies; and so
         forth.
         
         The <return>cookies</return> value simply means that the browser itself is capable of accepting cookies and
         does not mean the user has enabled the browser to accept cookies or not. The only way to
         test if cookies are accepted is to set one with <strong>setcookie()</strong>, reload, and check for the
         value.


id: get_called_class
type: function
doc:
<comment>Description:</comment>
  The "Late Static Binding" class name
  
  Gets the name of the class the static method is called in.

<comment>Return:</comment>
  <info>string</info>  Returns the class name.  Returns <info>false</info> if called from outside a class.

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


id: get_class
type: function
doc:
<comment>Description:</comment>
  Restituisce il nome della classe di un oggetto
  
  Restituisce il nome della classe dell'<strong>$object</strong> dato.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'oggetto testato. Questo parametro potrebbe essere omesso quando si è dentro ad
                   una classe.

<comment>Return:</comment>
  <info>string</info>  Restituisce il nome della classe di cui <strong>$object</strong> è un'istanza. Restituisce <info>false</info> se <strong>$object</strong>
          non è un  oggetto.
          
          Se viene omesso <strong>$object</strong> quando è dentro una classe, viene restituito il nome di quella
          classe.

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


id: get_class_methods
type: function
doc:
<comment>Description:</comment>
  Restituisce i nomi dei metodi della classe
  
  Restituisce i nomi dei metodi della classe.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$class_name</strong>  Il nome della classe o un'istanza di un oggetto

<comment>Return:</comment>
  <info>array</info>  Restituisce un array dei nomi dei metodi definiti per la classe specificata da <strong>$class_name</strong>.
         In caso di errore, essa restituisce <info>null</info>.

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


id: get_class_vars
type: function
doc:
<comment>Description:</comment>
  Restituisce le proprietà di default della classe
  
  Restituisce le proprietà di default della classe data.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  Il nome della classe

<comment>Return:</comment>
  <info>array</info>  Restituisce un array associativo delle proprietà dichiarate e visibili dall'ambito
         corrente, con il loro valore di default. Gli elementi dell'array risultante sono nella
         forma di  <return>nomevariabile =&gt; valore</return>. In caso di errore, essa restituisce <info>false</info>.

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


id: get_declared_classes
type: function
doc:
<comment>Description:</comment>
  Restituisce un array con i nomi delle classi definite
  
  Restituisce le classi dichiarate.

<comment>Return:</comment>
  <info>array</info>  Restituisce un array con i nomi delle classi dichiarate nel codice corrente.
         
         Notare che in base alle estensioni compilate o caricate in PHP, potrebbero essere presenti
         classi aggiuntive. Questo significa che non si sarà in grado di definire le proprie classi
         usando questi nomi. C'è una lista delle classi predefinite nella sezione Classi Predefinite
         dell'appendice.

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


id: get_declared_interfaces
type: function
doc:
<comment>Description:</comment>
  Returns an array of all declared interfaces
  
  Gets the declared interfaces.

<comment>Return:</comment>
  <info>array</info>  Returns an array of the names of the declared interfaces in the current script.

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


id: get_declared_traits
type: function
doc:
<comment>Description:</comment>
  Returns an array of all declared traits

<comment>Return:</comment>
  <info>array</info>  Returns an array with names of all declared traits in values. Returns <info>null</info> in case of a
         failure.

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


id: get_defined_constants
type: function
doc:
<comment>Description:</comment>
  Restituisve un array associativo con i nomi di tutte le costanti
       ed i loro valori


id: get_defined_functions
type: function
doc:
<comment>Description:</comment>
  Returns an array of all defined functions
  
  Gets an array of all defined functions.

<comment>Param:</comment>
  <info>bool</info>  <strong>$exclude_disabled</strong>  Whether disabled functions should be excluded from the return value.

<comment>Return:</comment>
  <info>array</info>  Returns a multidimensional array containing a list of all defined functions, both built-in
         (internal) and user-defined. The internal functions will be accessible via
         $arr["internal"], and the user defined ones using $arr["user"] (see example below).

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


id: get_defined_vars
type: function
doc:
<comment>Description:</comment>
  Restituisce un'array contenente tutte le variabili definite
    
  
  Questa funzione restituisce un'array multidimensionale contenente la lista di tutte le variabili
  definite, siano esse d'ambiente, variabili del server o definite dall'utente, visibili da dove
  <strong>get_defined_vars()</strong> viene eseguito.

<comment>Return:</comment>
  <info>array</info>  Un'array multidimensionale contenente la lista di tutte le variabili definite.

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


id: get_headers
type: function
doc:
<comment>Description:</comment>
  Fetches all the headers sent by the server in response to an HTTP request
  
  <strong>get_headers()</strong> returns an array with the headers sent by the server in response to a HTTP request.

<comment>Param:</comment>
  <info>string  </info>  <strong>$url    </strong>  The target URL.
  <info>int     </info>  <strong>$format </strong>  If the optional <strong>$format</strong> parameter is set to non-zero, <strong>get_headers()</strong> parses the
                      response and sets the  array's keys.
  <info>resource</info>  <strong>$context</strong>  A valid context resource created with <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an indexed or associative array with the headers, or <info>false</info> on failure.

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


id: get_html_translation_table
type: function
doc:
<comment>Description:</comment>
  Restituisce la tabella di decodifica utilizzata da    
       htmlspecialchars e
       htmlentities


id: get_include_path
type: function
doc:
<comment>Description:</comment>
  Restituisce il valore del parametro di configurazione include_path


id: get_loaded_extensions
type: function
doc:
<comment>Description:</comment>
  Restituisce una matrice con il nome di tutti i moduli compilati
       e caricati


id: get_magic_quotes_gpc
type: function
doc:
<comment>Description:</comment>
  Restituisce l'attuale configurazione di magic_quotes_gpc
  
  Restituisce l'attuale impostazione di configurazione di magic_quotes_gpc
  
  Tenere presente che il tentativo di impostare  magic_quotes_gpc in fase di esecuzione non
  funzionerà.
  
  Per ulteriori informazioni su magic_quotes, vedere la sezione sulla sicurezza.

<comment>Return:</comment>
  <info>bool</info>  Restituisce 0 se magic_quotes_gpc è spento, 1 in caso contrario.  O restituisce sempre <info>false</info>
        per PHP 5.4.0.

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


id: get_magic_quotes_runtime
type: function
doc:
<comment>Description:</comment>
  Restituisce l'impostazione corrente della direttiva
       magic_quotes_runtime


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

<comment>Param:</comment>
  <info>string</info>  <strong>$filename        </strong>  The path to the HTML file, as a string. This can be a local file or an
                             URL.
                             
                             What <strong>get_meta_tags()</strong> parses
                             
                             
                             
                              
                             ]]> (pay attention to line endings - PHP uses a native function to
                             parse the input, so a Mac file won't work on Unix).
  <info>bool  </info>  <strong>$use_include_path</strong>  Setting <strong>$use_include_path</strong> to <info>true</info> will result in PHP trying to open the
                             file along the standard include path as per the include_path directive.
                             This is used for local files, not URLs.

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

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


id: get_object_vars
type: function
doc:
<comment>Description:</comment>
  Restituisce le proprietà dell'oggetto dato
  
  Restituisce le proprietà non-statiche accessibili dell'<strong>$object</strong> dato in base all'ambito.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Un'istanza dell'oggetto.

<comment>Return:</comment>
  <info>array</info>  Restituisce un array associativo delle proprietà non-statiche accessibili dell'oggetto
         definito  per l'<strong>$object</strong> specificato nell'ambito. Se ad una proprietà non è stato assegnato
         un valore, essa verrà restituita con un valore <info>null</info>.

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


id: get_parent_class
type: function
doc:
<comment>Description:</comment>
  Restituisce il nome della classe genitrice di un oggetto o di una classe
  
  Restituisce il nome della classe genitrice di un oggetto o di una classe.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$object</strong>  Il nome dell'oggetto testato o della classe. Questo parametro è opzionale se viene
                  chiamato dal metodo dell'oggetto.

<comment>Return:</comment>
  <info>string</info>  Restituisce il nome della classe genitrice della classe di cui <strong>$object</strong> è un'istanza o il
          nome.
          
          Se l'oggetto non ha una classe genitrice o la classe data non esiste verrà restituito
          <info>false</info>.
          
          Se viene chiamata senza parametro fuori dall'oggetto, questa funzione restituisce <info>false</info>.

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


id: get_resource_id
type: function
doc:
<comment>Description:</comment>
  Returns an integer identifier for the given resource
    
  
  This function provides a type-safe way for generating the integer identifier for a resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$res</strong>  The evaluated resource handle.

<comment>Return:</comment>
  <info>int</info>  The <info>int</info> identifier for the given <strong>$res</strong>.
       
       This function is essentially an <info>int</info> cast of <strong>$res</strong> to make it easier to retrieve the resource
       ID.

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


id: get_resource_type
type: function
doc:
<comment>Description:</comment>
  Restituisce il tipo di risorsa
    
  
  Questa funzione restituisce il tipo della risorsa data.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  L'handle della risorsa da valutare.

<comment>Return:</comment>
  <info>string</info>  Se il parametro <strong>$handle</strong> è una risorsa, questa funzione restituirà una stringa che ne
          rappresenta il tipo. Se il tipo non viene identificato da questa funzione, il valore
          restituito sarà la stringa  <return>Unknown</return>.
          
          Questa funzione restituirà <info>false</info> e genererà un errore se  <strong>$handle</strong> non è una <info>resource</info>.


id: get_resources
type: function
doc:
<comment>Description:</comment>
  Returns active resources
  
  Returns an array of all currently active <info>resource</info>s, optionally filtered by resource type.

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

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

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


id: getallheaders
type: function
doc:
<comment>Description:</comment>
  Estrae tutti gli header della richiesta HTTP
  
  Recupera tutti gli header HTTP dalla richiesta corrente.
  
  Questa funzione è un alias per <strong>apache_request_headers()</strong>. Si prega di leggere la documentazione di
  <strong>apache_request_headers()</strong> per maggiori informazioni su come funziona questa funzione.

<comment>Return:</comment>
  <info>array</info>  Un array associativo di tutti gli header HTTP nella richiesta corrente, o <info>false</info> in caso di
         fallimento.

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


id: getdate
type: function
doc:
<comment>Description:</comment>
  Restituisce informazioni sulla data/orario
  
  Restituisce un <info>array</info> associativo che contiene informazioni sulla data del <strong>$timestamp</strong>, o l'orario
  locale corrente se non viene passato il <strong>$timestamp</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  Il parametro opzionale <strong>$timestamp</strong> è un 
                   <info>integer</info> timestamp Unix che ha come default
                   l'ora locale attuale se un <strong>$timestamp</strong> non è fornito. In altre 
                   parole, ha come default il valore di <strong>time()</strong>.

<comment>Return:</comment>
  <info>array</info>  Restituisce un <info>array</info> associativo delle informazioni relative al <strong>$timestamp</strong>. Gli elementi
         dell'array  associativo sono i seguenti:
         
         Elementi chiave dell'array associativo restituitoChiaveDescrizioneEsempio di valori
         restituiti<return>"seconds"</return>Rappresentazione numerica dei secondida <return>0</return> a <return>59</return><return>"minutes"</return>Rappresentazione
         numerica dei minutida <return>0</return> a <return>59</return><return>"hours"</return>Rappresentazione numerica delle oreda <return>0</return> a
         <return>23</return><return>"mday"</return>Rappresentazione numerica del giorno del meseda <return>1</return> a <return>31</return><return>"wday"</return>Rappresentazione
         numerica del giorno della settimanada <return>0</return> (per Domenica) a <return>6</return> (per
         Sabato)<return>"mon"</return>Rappresentazione numerica di un meseda <return>1</return> a <return>12</return><return>"year"</return>Una rappresentazione
         numerica completa di un anno, 4 cifreEsempi: <return>1999</return> o <return>2003</return><return>"yday"</return>Una rappresentazione del
         giorno dell'annoDa <return>0</return> a <return>365</return><return>"weekday"</return>Una rappresentazione testuale completa del giorno della
         settimanaDa <return>Sunday</return> a <return>Saturday</return><return>"month"</return>Una rappresentazione testuale completa di un mese, come
         Gennaio o MarzoDa <return>January</return> a <return>December</return><return>0</return> Secondi dalla Unix Epoch, simile ai valori restituiti
         da <strong>time()</strong> e usati da <strong>date()</strong>.  Dipendente dal sistema, tipicamente da <return>-2147483648</return> a
         <return>2147483647</return>.

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


