# php_manual

id: strripos
type: function
doc:
<comment>Description:</comment>
  Trova la posizione dell'ultima occorrenza di una stringa in un'altra indipendentemente dalle
  lettere minuscole/maiusole


id: strrpos
type: function
doc:
<comment>Description:</comment>
  Trova la posizione dell'ultima occorrenza di un carattere in una stringa


id: strspn
type: function
doc:
<comment>Description:</comment>
  Trova la lunghezza di un testo che corrisponde alla maschera data


id: strtotime
type: function
doc:
<comment>Description:</comment>
  Analizza qualsiasi descrizione datetime testuale inglese e la converte in uno Unix timestamp
  
  La funzione si aspetta una stringa contenente un formato di data inglese e proverà ad analizzare
  quel formato ed a convertirlo in uno Unix timestamp (il numero di secondi dall'1 Gennaio 1970
  00:00:00 UTC), relativo al timestamp dato in <strong>$now</strong>, oppure all'ora corrente se non viene fornito
  <strong>$now</strong>.
  
  Ogni parametro di questa funzione usa il fuso orario predefinito a meno che non sia specificato il
  fuso orario in quel parametro.  Badare a non usare diversi fusi orari in ogni parametro a meno che
  non sia intenzionale. Vedere <strong>date_default_timezone_get()</strong> sui vari modi per definire il fuso orario
  predefinito.

<comment>Param:</comment>
  <info>string</info>  <strong>$time</strong>  Una stringa data/ora. I formati validi sono descritti in Formati di Data e Tempo.
  <info>int   </info>  <strong>$now </strong>  Il timestamp che è usato come base per il calcolo delle date relative.

<comment>Return:</comment>
  <info>int</info>  Restituisce un timestamp in caso di successo, altrimenti <info>false</info>. Prima di PHP 5.1.0, questa
       funzione restituiva <return>-1</return> in caso di fallimento.

<comment>See Also:</comment>
   * Formati di Data e Tempo
   * DateTime::createFromFormat
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: strval
type: function
doc:
<comment>Description:</comment>
  Restituisce il valore di una variabile interpretato come stringa
  
  Restituisce il valore di una variabile interpretato come stringa. Vedere la documentazione su
  <info>string</info> per più informazioni sulla conversione in stringa.
  
  Questa funzione non effettua formattazioni sul valore restituito. Se si sta cercando un modo per
  formattare un valore numerico come una stringa, dare un'occhiata a <strong>sprintf()</strong> o a <strong>number_format()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variable che viene convertita in una <info>string</info>.
               
               <strong>$var</strong> può essere qualsiasi tipo scalare o un oggetto che implementa il metodo
               __toString(). Non si può utilizzare <strong>strval()</strong> su array o su oggetti che non
               implementano il metodo __toString().

<comment>Return:</comment>
  <info>string</info>  Il valore <info>string</info> di <strong>$var</strong>.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>floatval()</strong>
   * <strong>intval()</strong>
   * <strong>settype()</strong>
   * <strong>sprintf()</strong>
   * <strong>number_format()</strong>
   * Manipolazione del tipo
   * __toString()


id: substr_compare
type: function
doc:
<comment>Description:</comment>
  Confronto tra due stringhe a partire da una data posizione per n caratteri, sicuro con i dati
  binari e, opzionalmente, senza distinguere tra lettere maiuscole e minuscole


id: svn_add
type: function
doc:
<comment>Description:</comment>
  Schedules the addition of an item in a working directory
  
  Adds the file, directory or symbolic link at <strong>$path</strong> to the working directory. The item will be
  added to the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path     </strong>  Path of item to add.
                      
                      I percorsi relativi verranno risolti se la cartella di lavoro corrente è
                      quello che contiene il binario PHP. Per usare la cartella dello script
                      chiamante, usare <strong>realpath()</strong> o dirname(__FILE__).
  <info>bool  </info>  <strong>$recursive</strong>  If item is directory, whether or not to recursively add all of its contents.
                      Default is <info>true</info>
  <info>bool  </info>  <strong>$force    </strong>  If true, Subversion will recurse into already versioned directories in order
                      to add unversioned files that may be hiding in those directories. Default is
                      <info>false</info>

<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>
   * SVN documentation on svn add


id: svn_auth_get_parameter
type: function
doc:
<comment>Description:</comment>
  Retrieves authentication parameter
  
  Retrieves authentication parameter at <strong>$key</strong>. For a list of valid keys and their meanings, consult
  the authentication constants list.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  String key name. Use the authentication constants defined by this extension to
                specify a key.

<comment>Return:</comment>
  <info>string</info>  Returns the string value of the parameter at <strong>$key</strong>; returns <info>null</info> if parameter does not
          exist.

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * Authentication constants


id: svn_auth_set_parameter
type: function
doc:
<comment>Description:</comment>
  Sets an authentication parameter
  
  Sets authentication parameter at <strong>$key</strong> to <strong>$value</strong>. For a list of valid keys and their meanings,
  consult the authentication constants list.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  String key name. Use the authentication constants defined by this extension to
                  specify a key.
  <info>string</info>  <strong>$value</strong>  String value to set to parameter at key. Format of value varies with the
                  parameter.

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

<comment>See Also:</comment>
   * <strong>svn_auth_get_parameter()</strong>
   * Authentication constants


id: svn_blame
type: function
doc:
<comment>Description:</comment>
  Get the SVN blame for a file
  
  Get the SVN blame of a file from a repository URL.

<comment>Param:</comment>
  <info>string</info>  <strong>$repository_url</strong>  The repository URL.
  <info>int   </info>  <strong>$revision_no   </strong>  The revision number.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of SVN blame information separated by line which includes the revision number,
         line number, line of code, author, and date.

<comment>See Also:</comment>
   * <strong>svn_diff()</strong>
   * <strong>svn_logs()</strong>
   * <strong>svn_status()</strong>


id: svn_cat
type: function
doc:
<comment>Description:</comment>
  Returns the contents of a file in a repository
  
  Returns the contents of the URL <strong>$repos_url</strong> to a file in the repository, optionally at revision
  number <strong>$revision_no</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url  </strong>  String URL path to item in a repository.
  <info>int   </info>  <strong>$revision_no</strong>  Integer revision number of item to retrieve, default is the HEAD revision.

<comment>Return:</comment>
  <info>string</info>  Returns the string contents of the item from the repository on success, and <info>false</info> on
          failure.

<comment>See Also:</comment>
   * <strong>svn_list()</strong>
   * SVN documentation on svn cat


id: svn_checkout
type: function
doc:
<comment>Description:</comment>
  Checks out a working copy from the repository
  
  Checks out a working copy from the repository at <strong>$repos</strong> to <strong>$targetpath</strong> at revision <strong>$revision</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos     </strong>  String URL path to directory in repository to check out.
  <info>string</info>  <strong>$targetpath</strong>  String local path to directory to check out in to
                       
                       I percorsi relativi verranno risolti se la cartella di lavoro corrente è
                       quello che contiene il binario PHP. Per usare la cartella dello script
                       chiamante, usare <strong>realpath()</strong> o dirname(__FILE__).
  <info>int   </info>  <strong>$revision  </strong>  Integer revision number of repository to check out. Default is HEAD, the most
                       recent revision.
  <info>int   </info>  <strong>$flags     </strong>  Any combination of <info>SVN_NON_RECURSIVE</info> and <info>SVN_IGNORE_EXTERNALS</info>.

<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>svn_add()</strong>
   * <strong>svn_commit()</strong>
   * <strong>svn_status()</strong>
   * <strong>svn_update()</strong>
   * SVN documentation on svn checkout


id: svn_cleanup
type: function
doc:
<comment>Description:</comment>
  Recursively cleanup a working copy directory, finishing incomplete operations and removing locks
  
  Recursively cleanup working copy directory <strong>$workingdir</strong>, finishing any incomplete operations and
  removing working copy locks. Use when a working copy is in limbo and needs to be usable again.

<comment>Param:</comment>
  <info>string</info>  <strong>$workingdir</strong>  String path to local working directory to cleanup
                       
                       I percorsi relativi verranno risolti se la cartella di lavoro corrente è
                       quello che contiene il binario PHP. Per usare la cartella dello script
                       chiamante, usare <strong>realpath()</strong> o dirname(__FILE__).

<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>update()</strong>
   * SVN documentation on svn cleanup


id: svn_client_version
type: function
doc:
<comment>Description:</comment>
  Returns the version of the SVN client libraries
  
  Returns the version of the SVN client libraries

<comment>Return:</comment>
  <info>string</info>  String version number, usually in form of x.y.z.


id: svn_commit
type: function
doc:
<comment>Description:</comment>
  Sends changes from the local working copy to the repository
  
  Commits changes made in the local working copy files enumerated in the <strong>$targets</strong> array to the
  repository, with the log message <strong>$log</strong>. Directories in the <strong>$targets</strong> array will be recursively
  committed unless <strong>$recursive</strong> is set to <info>false</info>.
  
  This function does not have any parameters for specifying authentication, so a username and
  password must be set using <strong>svn_auth_set_parameter()</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$log      </strong>  String log text to commit
  <info>array </info>  <strong>$targets  </strong>  Array of local paths of files to be committed
                      
                      This parameter must be an array, a string for a single target is not
                      acceptable.
                      
                      I percorsi relativi verranno risolti se la cartella di lavoro corrente è
                      quello che contiene il binario PHP. Per usare la cartella dello script
                      chiamante, usare <strong>realpath()</strong> o dirname(__FILE__).
  <info>bool  </info>  <strong>$recursive</strong>  Boolean flag to disable recursive committing of directories in the <strong>$targets</strong>
                      array. Default is <info>true</info>.

<comment>Return:</comment>
  <info>array</info>  Returns array in form of:
         
         Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_auth_set_parameter()</strong>
   * SVN documentation on svn commit


id: svn_delete
type: function
doc:
<comment>Description:</comment>
  Delete items from a working copy or repository
  
  Deletes the file, directory or symbolic link at <strong>$path</strong> from the working directory. The item will be
  deleted from the repository the next time you call <strong>svn_commit()</strong> on the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path </strong>  Path of item to delete.
                  
                  I percorsi relativi verranno risolti se la cartella di lavoro corrente è quello
                  che contiene il binario PHP. Per usare la cartella dello script chiamante, usare
                  <strong>realpath()</strong> o dirname(__FILE__).
  <info>bool  </info>  <strong>$force</strong>  If <info>true</info>, the file will be deleted even if it has local modifications. Otherwise,
                  local modifications will result in a failure. Default is <info>false</info>

<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>
   * SVN documentation on svn
    delete


id: svn_diff
type: function
doc:
<comment>Description:</comment>
  Recursively diffs two paths
  
  Recursively diffs two paths, <strong>$path1</strong> and <strong>$path2</strong>.
  
  This is not a general-purpose diff utility. Only local files that are versioned may be diffed:
  other files will fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$path1</strong>  First path to diff. This can be a URL to a file/directory in an SVN repository or
                  a local file/directory path.
                  
                  I percorsi relativi verranno risolti se la cartella di lavoro corrente è quello
                  che contiene il binario PHP. Per usare la cartella dello script chiamante, usare
                  <strong>realpath()</strong> o dirname(__FILE__).
                  
                  If a local file path has only backslashes and no forward slashes, this extension
                  will fail to find the path. Always replace all backslashes with forward slashes
                  when using this function.
  <info>int   </info>  <strong>$rev1 </strong>  First path's revision number. Use <info>SVN_REVISION_HEAD</info> to specify the most recent
                  revision.
  <info>string</info>  <strong>$path2</strong>  Second path to diff. See <strong>$path1</strong> for description.
  <info>int   </info>  <strong>$rev2 </strong>  Second path's revision number. See <strong>$rev1</strong> for description.

<comment>Return:</comment>
  <info>array</info>  Returns an array-list consisting of two streams: the first is the diff output and the
         second contains error stream output. The streams can be read using <strong>fread()</strong>. Returns <info>false</info>
         or <info>null</info> on error.
         
         The diff output will, by default, be in the form of Subversion's custom unified diff
         format, but an external diff engine may be used depending on Subversion's configuration.

<comment>See Also:</comment>
   * SVN documentation on svn diff


id: svn_export
type: function
doc:
<comment>Description:</comment>
  Export the contents of a SVN directory
  
  Export the contents of either a working copy or repository into a 'clean' directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$frompath    </strong>  The path to the current repository.
  <info>string</info>  <strong>$topath      </strong>  The path to the new repository.
  <info>bool  </info>  <strong>$working_copy</strong>  If <info>true</info>, it will export uncommitted files from the working copy.

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


id: svn_fs_abort_txn
type: function
doc:
<comment>Description:</comment>
  Abort a transaction, returns true if everything is okay, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Abort a transaction, returns true if everything is okay, false otherwise

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


id: svn_fs_apply_text
type: function
doc:
<comment>Description:</comment>
  Creates and returns a stream that will be used to replace
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Creates and returns a stream that will be used to replace

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


id: svn_fs_begin_txn2
type: function
doc:
<comment>Description:</comment>
  Create a new transaction
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Create a new transaction

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


id: svn_fs_change_node_prop
type: function
doc:
<comment>Description:</comment>
  Return true if everything is ok, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Return true if everything is ok, false otherwise

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


id: svn_fs_check_path
type: function
doc:
<comment>Description:</comment>
  Determines what kind of item lives at path in a given repository fsroot
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Determines what kind of item lives at path in a given repository fsroot

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


id: svn_fs_contents_changed
type: function
doc:
<comment>Description:</comment>
  Return true if content is different, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Return true if content is different, false otherwise

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


id: svn_fs_copy
type: function
doc:
<comment>Description:</comment>
  Copies a file or a directory, returns true if all is ok, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Copies a file or a directory, returns true if all is ok, false otherwise

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


id: svn_fs_delete
type: function
doc:
<comment>Description:</comment>
  Deletes a file or a directory, return true if all is ok, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Deletes a file or a directory, return true if all is ok, false otherwise

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


id: svn_fs_dir_entries
type: function
doc:
<comment>Description:</comment>
  Enumerates the directory entries under path; returns a hash of dir names to file type
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Enumerates the directory entries under path; returns a hash of dir names to file type

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


id: svn_fs_file_contents
type: function
doc:
<comment>Description:</comment>
  Returns a stream to access the contents of a file from a given version of the fs
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Returns a stream to access the contents of a file from a given version of the fs

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


id: svn_fs_file_length
type: function
doc:
<comment>Description:</comment>
  Returns the length of a file from a given version of the fs
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Returns the length of a file from a given version of the fs

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


id: svn_fs_is_dir
type: function
doc:
<comment>Description:</comment>
  Return true if the path points to a directory, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Return true if the path points to a directory, false otherwise

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


id: svn_fs_is_file
type: function
doc:
<comment>Description:</comment>
  Return true if the path points to a file, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Return true if the path points to a file, false otherwise

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


id: svn_fs_make_dir
type: function
doc:
<comment>Description:</comment>
  Creates a new empty directory, returns true if all is ok, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Creates a new empty directory, returns true if all is ok, false otherwise

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


id: svn_fs_make_file
type: function
doc:
<comment>Description:</comment>
  Creates a new empty file, returns true if all is ok, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Creates a new empty file, returns true if all is ok, false otherwise

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


id: svn_fs_node_created_rev
type: function
doc:
<comment>Description:</comment>
  Returns the revision in which path under fsroot was created
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Returns the revision in which path under fsroot was created

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


id: svn_fs_node_prop
type: function
doc:
<comment>Description:</comment>
  Returns the value of a property for a node
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Returns the value of a property for a node

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


id: svn_fs_props_changed
type: function
doc:
<comment>Description:</comment>
  Return true if props are different, false otherwise
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Return true if props are different, false otherwise

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


id: svn_fs_revision_prop
type: function
doc:
<comment>Description:</comment>
  Fetches the value of a named property
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Fetches the value of a named property

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


id: svn_fs_revision_root
type: function
doc:
<comment>Description:</comment>
  Get a handle on a specific version of the repository root
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Get a handle on a specific version of the repository root

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


id: svn_fs_txn_root
type: function
doc:
<comment>Description:</comment>
  Creates and returns a transaction root
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Creates and returns a transaction root

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


id: svn_fs_youngest_rev
type: function
doc:
<comment>Description:</comment>
  Returns the number of the youngest revision in the filesystem
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Returns the number of the youngest revision in the filesystem

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


id: svn_import
type: function
doc:
<comment>Description:</comment>
  Imports an unversioned path into a repository
  
  Commits unversioned <strong>$path</strong> into repository at <strong>$url</strong>. If <strong>$path</strong> is a directory and <strong>$nonrecursive</strong> is
  <info>false</info>,  the directory will be imported recursively.

<comment>Param:</comment>
  <info>string</info>  <strong>$path        </strong>  Path of file or directory to import.
                         
                         I percorsi relativi verranno risolti se la cartella di lavoro corrente è
                         quello che contiene il binario PHP. Per usare la cartella dello script
                         chiamante, usare <strong>realpath()</strong> o dirname(__FILE__).
  <info>string</info>  <strong>$url         </strong>  Repository URL to import into.
  <info>bool  </info>  <strong>$nonrecursive</strong>  Whether or not to refrain from recursively processing directories.

<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>svn_add()</strong>
   * SVN documentation for svn import


id: svn_log
type: function
doc:
<comment>Description:</comment>
  Returns the commit log messages of a repository URL
  
  <strong>svn_log()</strong> returns the complete history of the item at the repository URL <strong>$repos_url</strong>, or the
  history of a specific revision if <strong>$start_revision</strong> is set. This function is equivalent to svn log
  --verbose -r $start_revision $repos_url.

<comment>Param:</comment>
  <info>string</info>  <strong>$repos_url     </strong>  Repository URL of the item to retrieve log history from.
  <info>int   </info>  <strong>$start_revision</strong>  Revision number of the first log to retrieve. Use <info>SVN_REVISION_HEAD</info> to
                           retrieve the log from the most recent revision.
  <info>int   </info>  <strong>$end_revision  </strong>  Revision number of the last log to retrieve. Defaults to <strong>$start_revision</strong>
                           if specified or to <info>SVN_REVISION_INITIAL</info> otherwise.
  <info>int   </info>  <strong>$limit         </strong>  Number of logs to retrieve.
  <info>int   </info>  <strong>$flags         </strong>  Any combination of <info>SVN_OMIT_MESSAGES</info>, <info>SVN_DISCOVER_CHANGED_PATHS</info> and
                           <info>SVN_STOP_ON_COPY</info>.

<comment>Return:</comment>
  <info>array</info>  On success, this function returns an array file listing in the format of:  Array, ordered
         most recent (highest) revision first
         ( [rev] => integer revision number [author] => string author name [msg] => string log
         message [date] => string date formatted per ISO 8601, i.e. date('c') [paths] => Array,
         describing changed files ( [0] => Array ( [action] => string letter signifying change
         [path] =>  absolute repository path of changed file ) [1] => ... )
         )
         [1] => ...
         ]]>
         
         The output will always be a numerically indexed array of arrays, even when there are none
         or only one log message(s).
         
         The value of action is a subset of the status output in the first column, where possible
         values are:
         
         If no changes were made to the item, an empty array is returned.

<comment>See Also:</comment>
   * 
      SVN documentation on svn log
     


id: svn_ls
type: function
doc:
<comment>Description:</comment>
  Returns list of directory contents in repository URL, optionally at revision number
  
  This function queries the repository URL and returns a list of files and directories, optionally
  from a specific revision. This is equivalent to svn list $repos_url[@$revision_no]
  
  This function does not work with working copies. <strong>$repos_url</strong> must be a repository URL.

<comment>Param:</comment>
  <info>    </info>  <strong>$url     </strong>  URL of the repository, eg. http://www.example.com/svnroot. To access a local
                   Subversion repository via filesystem, use the file URI scheme, eg.
                   file:///home/user/svn-repos
  <info>    </info>  <strong>$revision</strong>  Integer revision number to retrieve listing of. When omitted, the HEAD revision
                   is used.
  <info>bool</info>  <strong>$recurse </strong>  Enables recursion.

<comment>Return:</comment>
  <info>array</info>  On success, this function returns an array file listing in the format of:  Array (
         [created_rev] => integer revision number of last edit [last_author] => string author name
         of last edit [size] => integer byte file size of file [time] => string date of last edit in
         form 'M d H:i' or 'M d Y', depending on how old the file is [time_t] => integer unix
         timestamp of last edit [name] => name of file/directory [type] => type, can be 'file' or
         'dir' )
         [1] => ...
         ]]>

<comment>See Also:</comment>
   * SVN documentation on svn list


id: svn_mkdir
type: function
doc:
<comment>Description:</comment>
  Creates a directory in a working copy or repository
  
  Creates a directory in a working copy or repository.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path to the working copy or repository.

<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>svn_add()</strong>
   * <strong>svn_copy()</strong>


id: svn_repos_create
type: function
doc:
<comment>Description:</comment>
  Create a new subversion repository at path
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Create a new subversion repository at path

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


id: svn_repos_fs
type: function
doc:
<comment>Description:</comment>
  Gets a handle on the filesystem for a repository
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Gets a handle on the filesystem for a repository

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


id: svn_repos_fs_commit_txn
type: function
doc:
<comment>Description:</comment>
  Commits a transaction and returns the new revision
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Commits a transaction and returns the new revision

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


id: svn_repos_hotcopy
type: function
doc:
<comment>Description:</comment>
  Make a hot-copy of the repos at repospath; copy it to destpath
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Make a hot-copy of the repos at repospath; copy it to destpath

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


id: svn_repos_open
type: function
doc:
<comment>Description:</comment>
  Open a shared lock on a repository
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Open a shared lock on a repository.

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


id: svn_repos_recover
type: function
doc:
<comment>Description:</comment>
  Run recovery procedures on the repository located at path
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.
  
  Run recovery procedures on the repository located at path.

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


id: svn_revert
type: function
doc:
<comment>Description:</comment>
  Revert changes to the working copy
  
  Revert any local changes to the path in a working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path     </strong>  The path to the working repository.
  <info>bool  </info>  <strong>$recursive</strong>  Optionally make recursive changes.

<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>svn_delete()</strong>
   * <strong>svn_export()</strong>


id: svn_status
type: function
doc:
<comment>Description:</comment>
  Returns the status of working copy files and directories
  
  Returns the status of working copy files and directories, giving modifications, additions,
  deletions and other changes to items in the working copy.

<comment>Param:</comment>
  <info>string</info>  <strong>$path </strong>  Local path to file or directory to retrieve status of.
                  
                  I percorsi relativi verranno risolti se la cartella di lavoro corrente è quello
                  che contiene il binario PHP. Per usare la cartella dello script chiamante, usare
                  <strong>realpath()</strong> o dirname(__FILE__).
  <info>int   </info>  <strong>$flags</strong>  Any combination of <info>Svn::NON_RECURSIVE</info>, <info>Svn::ALL</info> (regardless of modification
                  status), <info>Svn::SHOW_UPDATES</info> (entries will be added for items that are out-of-date),
                  <info>Svn::NO_IGNORE</info> (disregard <return>svn:ignore</return> properties when scanning for new files) and
                  <info>Svn::IGNORE_EXTERNALS</info>.

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of associative arrays detailing the status of items in
         the repository:
         
         The information on the item is an associative array that can contain the following keys:
         
         String path to file/directory of this entry on local filesystem.
         
         Status of item's text. Consultare status constants per i possibili valori.
         
         Status of item's text in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>. Consultare
         status constants per i possibili valori.
         
         Status of item's properties. Consultare status constants per i possibili valori.
         
         Status of item's property in repository. Only accurate if <strong>$update</strong> was set to <info>true</info>.
         Consultare status constants per i possibili valori.
         
         Whether or not the item is locked. (Only set if <info>true</info>.)
         
         Whether or not the item was copied (scheduled for addition with history). (Only set if
         <info>true</info>.)
         
         Whether or not the item was switched using the switch command. (Only set if <info>true</info>)
         
         These keys are only set if the item is versioned:
         
         Base name of item in repository.
         
         URL of item in repository.
         
         Base URL of repository.
         
         Integer revision of item in working copy.
         
         Type of item, i.e. file or directory. Consultare type constants per i possibili valori.
         
         Scheduled action for item, i.e. addition or deletion. Constants for these magic numbers are
         not available, they can be emulated by using:
         
         Whether or not the item was deleted, but parent revision lags behind. (Only set if <info>true</info>.)
         
         Whether or not the item is absent, that is, Subversion knows that there should be something
         there but there isn't. (Only set if <info>true</info>.)
         
         Whether or not the entries file for a directory is incomplete. (Only set if <info>true</info>.)
         
         Integer Unix timestamp of last commit date. (Unaffected by <strong>$update</strong>.)
         
         Integer revision of last commit. (Unaffected by <strong>$update</strong>.)
         
         String author of last commit. (Unaffected by <strong>$update</strong>.)
         
         Integer Unix timestamp of last up-to-date time for properties
         
         Integer Unix timestamp of last up-to-date time for text

<comment>See Also:</comment>
   * <strong>svn_update()</strong>
   * <strong>svn_log()</strong>
   * SVN documentation for svn status


id: svn_update
type: function
doc:
<comment>Description:</comment>
  Update working copy
  
  Update working copy at <strong>$path</strong> to revision <strong>$revno</strong>. If <strong>$recurse</strong> is true, directories will be
  recursively updated.

<comment>Param:</comment>
  <info>string</info>  <strong>$path   </strong>  Path to local working copy.
                    
                    I percorsi relativi verranno risolti se la cartella di lavoro corrente è quello
                    che contiene il binario PHP. Per usare la cartella dello script chiamante, usare
                    <strong>realpath()</strong> o dirname(__FILE__).
  <info>int   </info>  <strong>$revno  </strong>  Revision number to update to, default is <info>SVN_REVISION_HEAD</info>.
  <info>bool  </info>  <strong>$recurse</strong>  Whether or not to recursively update directories.

<comment>Return:</comment>
  <info>int</info>  Returns new revision number on success, returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>svn_checkout()</strong>
   * <strong>svn_commit()</strong>
   * SVN documentation for svn update


id: swoole_async_dns_lookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup

<comment>Param:</comment>
  <info>string  </info>  <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string  </info>  <strong>$hostname</strong>  The host name.
  <info>        </info>  <strong>$IP      </strong>  The IP address.

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


id: swoole_async_read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename  </strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback  </strong>  The name of the file.
                         
                         The content readed from the file stream.
  <info>string  </info>  <strong>$filename  </strong>  The name of the file.
  <info>string  </info>  <strong>$content   </strong>  The content readed from the file stream.
  <info>int     </info>  <strong>$chunk_size</strong>  The chunk length.
  <info>int     </info>  <strong>$offset    </strong>  The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


id: swoole_async_readfile
type: function
doc:
<comment>Description:</comment>
  Read a file asynchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename</strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>  The name of the file.
                       
                       The content readed from the file.
  <info>string  </info>  <strong>$filename</strong>  The name of the file.
  <info>string  </info>  <strong>$content </strong>  The content readed from the file.

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


id: swoole_async_set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: swoole_async_write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename</strong>  The filename being written.
  <info>string  </info>  <strong>$content </strong>  The content writing to the file.
  <info>int     </info>  <strong>$offset  </strong>  The offset.
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_async_writefile
type: function
doc:
<comment>Description:</comment>
  Write data to a file asynchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename</strong>  The filename being written.
  <info>string  </info>  <strong>$content </strong>  The content writing to the file.
  <info>callable</info>  <strong>$callback</strong>  
  <info>int     </info>  <strong>$flags   </strong>  

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


id: swoole_client_select
type: function
doc:
<comment>Description:</comment>
  Get the file description which are ready to read/write or error

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array </strong>  
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout    </strong>  

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


id: swoole_cpu_num
type: function
doc:
<comment>Description:</comment>
  Get the number of CPU

<comment>Return:</comment>
  <info>int</info>  The number of CPU.


id: swoole_errno
type: function
doc:
<comment>Description:</comment>
  Get the error code of the latest system call

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


id: swoole_event_add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop

<comment>Param:</comment>
  <info>int     </info>  <strong>$fd            </strong>  
  <info>callable</info>  <strong>$read_callback </strong>  
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>int     </info>  <strong>$events        </strong>  

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


id: swoole_event_defer
type: function
doc:
<comment>Description:</comment>
  Add callback function to the next event loop

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_event_del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket

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

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


id: swoole_event_exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at the client side

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


id: swoole_event_set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket

<comment>Param:</comment>
  <info>int     </info>  <strong>$fd            </strong>  
  <info>callable</info>  <strong>$read_callback </strong>  
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>int     </info>  <strong>$events        </strong>  

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


id: swoole_event_wait
type: function
doc:
<comment>Description:</comment>
  Start the event loop

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


id: swoole_event_write
type: function
doc:
<comment>Description:</comment>
  Write data to a socket

<comment>Param:</comment>
  <info>int   </info>  <strong>$fd  </strong>  
  <info>string</info>  <strong>$data</strong>  

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


id: swoole_get_local_ip
type: function
doc:
<comment>Description:</comment>
  Get the IPv4 IP addresses of each NIC on the machine

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


id: swoole_last_error
type: function
doc:
<comment>Description:</comment>
  Get the lastest error message

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


id: swoole_load_module
type: function
doc:
<comment>Description:</comment>
  Load a swoole extension

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


id: swoole_select
type: function
doc:
<comment>Description:</comment>
  Select the file descriptions which are ready to read/write or error in the eventloop

<comment>Param:</comment>
  <info>array</info>  <strong>$read_array </strong>  
  <info>array</info>  <strong>$write_array</strong>  
  <info>array</info>  <strong>$error_array</strong>  
  <info>float</info>  <strong>$timeout    </strong>  

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


id: swoole_set_process_name
type: function
doc:
<comment>Description:</comment>
  Set the process name

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

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


id: swoole_strerror
type: function
doc:
<comment>Description:</comment>
  Convert the Errno into error messages

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

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


id: swoole_timer_after
type: function
doc:
<comment>Description:</comment>
  Trigger a one time callback function in the future

<comment>Param:</comment>
  <info>int     </info>  <strong>$ms      </strong>  
  <info>callable</info>  <strong>$callback</strong>  
  <info>mixed   </info>  <strong>$param   </strong>  

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


id: swoole_timer_exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer callback function is existed

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

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


id: swoole_timer_tick
type: function
doc:
<comment>Description:</comment>
  Trigger a timer tick callback function by time interval

<comment>Param:</comment>
  <info>int     </info>  <strong>$ms      </strong>  
  <info>callable</info>  <strong>$callback</strong>  

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


id: swoole_version
type: function
doc:
<comment>Description:</comment>
  Get the version of Swoole

<comment>Return:</comment>
  <info>string</info>  The version of Swoole.


id: sys_get_temp_dir
type: function
doc:
<comment>Description:</comment>
  Returns directory path used for temporary files
  
  Returns the path of the directory PHP stores temporary files in by default.

<comment>Return:</comment>
  <info>string</info>  Returns the path of the temporary directory.

<comment>See Also:</comment>
   * <strong>tmpfile()</strong>
   * <strong>tempnam()</strong>


id: sys_getloadavg
type: function
doc:
<comment>Description:</comment>
  Gets system load average
  
  Returns three samples representing the average system load (the number of processes in the system
  run queue) over the last 1, 5 and 15 minutes, respectively. Returns <info>false</info> on failure.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an <info>array</info> with three samples (last 1, 5 and 15 minutes).


id: system
type: function
doc:
<comment>Description:</comment>
  Esegue un programma esterno e mostra l'output
  
  <strong>system()</strong> è proprio come la versione C della funzione in quanto esegue il comando <strong>$command</strong> dato e
  restituisce il risultato.
  
  La chiamata a <strong>system()</strong> prova anche a svuotare automaticamente il buffer di output del web server
  dopo ogni linea di output se PHP è in esecuzione come modulo server.
  
  Se è necessario eseguire un comando ottenendo direttamente tutti i dati restituiti dallo stesso
  senza alcuna interferenza, usare la funzione <strong>passthru()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command   </strong>  Il comando che verrà eseguito.
  <info>int   </info>  <strong>$return_var</strong>  Se viene passato l'argomento <strong>$return_var</strong> allora lo stato di ritorno del
                       comando eseguito verrà scritto in questa variabile.

<comment>Return:</comment>
  <info>string</info>  Restituisce l'ultima riga dell'output del comando in caso di successo e <info>false</info> in caso di
          fallimento.

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


id: taint
type: function
doc:
<comment>Description:</comment>
  Contamina una stringa
  
  Rende una stringa contaminata. Questo è usato solo per scopo di testing.

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

<comment>Return:</comment>
  <info>bool</info>  Restituisce TRUE se la trasformazione viene effettuata. Restituisce sempre TRUE se
        l'estensione taint non è abilitata.


id: tcpwrap_check
type: function
doc:
<comment>Description:</comment>
  Performs a tcpwrap check
  
  This function consults the /etc/hosts.allow and  /etc/hosts.deny files to check if access to
  service  <strong>$daemon</strong> should be granted or denied for a client.

<comment>Param:</comment>
  <info>string</info>  <strong>$daemon </strong>  The service name.
  <info>string</info>  <strong>$address</strong>  The client remote address. Can be either an IP address or a domain name.
  <info>string</info>  <strong>$user   </strong>  An optional user name.
  <info>bool  </info>  <strong>$nodns  </strong>  If <strong>$address</strong> looks like domain name then DNS is  used to resolve it to IP
                    address; set <strong>$nodns</strong> to  <info>true</info> to avoid this.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if access should be granted, <info>false</info> otherwise.


id: textdomain
type: function
doc:
<comment>Description:</comment>
  Sets the default domain
  
  This function sets the domain to search within when calls are made to <strong>gettext()</strong>, usually the named
  after an application.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$domain</strong>  The new message domain, or <info>null</info> to get the current setting without changing
                       it

<comment>Return:</comment>
  <info>string</info>  If successful, this function returns the current message domain, after possibly changing
          it.


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

<comment>Param:</comment>
  <info>stringnull     </info>  <strong>$filename      </strong>  If the <strong>$filename</strong> parameter is given, this function will also
                                    read that file and initialize the object with the file, acting
                                    like <strong>tidy_parse_file()</strong>.
  <info>arraystringnull</info>  <strong>$config        </strong>  The config <strong>$config</strong> can be passed either as an array or as a
                                    string. If a string is passed, it is interpreted as the name of
                                    the configuration file, otherwise, it is interpreted as the
                                    options themselves.
                                    
                                    For an explanation about each option, visit
                                    http://api.html-tidy.org/#quick-reference.
  <info>stringnull     </info>  <strong>$encoding      </strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output
                                    documents. The possible values for encoding  are:  <return>ascii</return>,
                                    <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>,
                                    <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool           </info>  <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>Return:</comment>
  <info>unknown</info>  Returns the new <class>tidy</class> instance.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>


id: tidy::body
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns a <class>tidyNode</class> object starting from the  \<body&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>tidyNodenull</info>  Returns a <class>tidyNode</class> object starting from the  \<body&gt; tag of the tidy parse tree.

<comment>See Also:</comment>
   * <strong>tidy::head()</strong>
   * <strong>tidy::html()</strong>


id: tidy::cleanRepair
type: function
doc:
<comment>Description:</comment>
  Execute configured cleanup and repair operations on parsed markup
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  This function cleans and repairs the given tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<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>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::diagnose
type: function
doc:
<comment>Description:</comment>
  Run configured diagnostics on parsed and repaired markup
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Runs diagnostic tests on the given tidy <strong>$tidy</strong>, adding some more information about the document in
  the error buffer.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<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>tidy::errorBuffer()</strong>


id: tidy::getConfig
type: function
doc:
<comment>Description:</comment>
  Get current Tidy configuration
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Gets the list of the configuration options in use by the given tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>array</info>  Returns an array of configuration options.
         
         For an explanation about each option, visit http://api.html-tidy.org/#quick-reference.

<comment>See Also:</comment>
   * <strong>tidy_reset_config()</strong>
   * <strong>tidy_save_config()</strong>


id: tidy::getHtmlVer
type: function
doc:
<comment>Description:</comment>
  Get the Detected HTML version for the specified document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns the detected HTML version for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>int</info>  Returns the detected HTML version.
       
       This function is not yet implemented in the Tidylib itself, so it always return <return>0</return>.


id: tidy::getOpt
type: function
doc:
<comment>Description:</comment>
  Returns the value of the specified configuration option for the tidy document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns the value of the specified <strong>$option</strong> for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy  </info>  <strong>$tidy  </strong>  L'oggetto <class>Tidy</class>
  <info>string</info>  <strong>$option</strong>  You will find a list with each configuration option and their types at:
                   http://api.html-tidy.org/#quick-reference.

<comment>Return:</comment>
  <info>stringintbool</info>  Returns the value of the specified <strong>$option</strong>. The return type depends on the type of
                 the specified one.


id: tidy::getOptDoc
type: function
doc:
<comment>Description:</comment>
  Returns the documentation for the given option name
    
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  <strong>tidy_get_opt_doc()</strong> returns the documentation for the given option name.
  
  You need at least libtidy from 25 April, 2005 for this function be available.

<comment>Param:</comment>
  <info>tidy  </info>  <strong>$tidy  </strong>  L'oggetto <class>Tidy</class>
  <info>string</info>  <strong>$option</strong>  The option name

<comment>Return:</comment>
  <info>stringfalse</info>  Returns a string if the option exists and has documentation available, or <info>false</info>
               otherwise.

<comment>See Also:</comment>
   * <strong>tidy::getconfig()</strong>
   * <strong>tidy::getopt()</strong>


id: tidy::getRelease
type: function
doc:
<comment>Description:</comment>
  Get release date (version) for Tidy library
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Gets the release date of the Tidy library.

<comment>Return:</comment>
  <info>string</info>  Returns a string with the release date of the Tidy library, which may be 'unknown'.


id: tidy::getStatus
type: function
doc:
<comment>Description:</comment>
  Get status of specified document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns the status for the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>int</info>  Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for
       errors.


id: tidy::head
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns a <class>tidyNode</class> object starting from the \<head&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>tidyNodenull</info>  Returns the <class>tidyNode</class> object.

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::html()</strong>


id: tidy::html
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object starting from the  tag of the tidy parse tree
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns a <class>tidyNode</class> object starting from the \<html&gt; tag of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>tidyNodenull</info>  Returns the <class>tidyNode</class> object.

<comment>See Also:</comment>
   * <strong>tidy::body()</strong>
   * <strong>tidy::head()</strong>


id: tidy::isXhtml
type: function
doc:
<comment>Description:</comment>
  Indicates if the document is a XHTML document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Tells if the document is a XHTML document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified tidy <strong>$tidy</strong> is a XHTML document, or <info>false</info>
        otherwise.
        
        This function is not yet implemented in the Tidylib itself, so it always return <info>false</info>.


id: tidy::isXml
type: function
doc:
<comment>Description:</comment>
  Indicates if the document is a generic (non HTML/XHTML) XML document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Tells if the document is a generic (non HTML/XHTML) XML document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if the specified tidy <strong>$tidy</strong> is a generic XML document (non
        HTML/XHTML), or <info>false</info> otherwise.
        
        This function is not yet implemented in the Tidylib itself, so it always return <info>false</info>.


id: tidy::parseFile
type: function
doc:
<comment>Description:</comment>
  Parse markup in file or URI
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Parses the given file.

<comment>Param:</comment>
  <info>string         </info>  <strong>$filename      </strong>  If the <strong>$filename</strong> parameter is given, this function will also
                                    read that file and initialize the object with the file, acting
                                    like <strong>tidy_parse_file()</strong>.
  <info>arraystringnull</info>  <strong>$config        </strong>  The config <strong>$config</strong> can be passed either as an array or as a
                                    string. If a string is passed, it is interpreted as the name of
                                    the configuration file, otherwise, it is interpreted as the
                                    options themselves.
                                    
                                    For an explanation about each option, see
                                    http://api.html-tidy.org/#quick-reference.
  <info>stringnull     </info>  <strong>$encoding      </strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output
                                    documents. The possible values for encoding  are:  <return>ascii</return>,
                                    <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>,
                                    <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool           </info>  <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>Return:</comment>
  <info>bool</info>  tidy::parseFile returns <info>true</info> on success. <strong>tidy_parse_file()</strong> returns a new <class>tidy</class> instance on
        success. Both, the method and the function return <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>tidy::parsestring()</strong>
   * <strong>tidy::repairfile()</strong>
   * <strong>tidy::repairstring()</strong>


id: tidy::parseString
type: function
doc:
<comment>Description:</comment>
  Parse a document stored in a string
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Parses a document stored in a string.

<comment>Param:</comment>
  <info>string         </info>  <strong>$string  </strong>  The data to be parsed.
  <info>arraystringnull</info>  <strong>$config  </strong>  The config <strong>$config</strong> can be passed either as an array or as a string. If
                              a string is passed, it is interpreted as the name of the configuration
                              file, otherwise, it is interpreted as the options themselves.
                              
                              For an explanation about each option, visit
                              http://api.html-tidy.org/#quick-reference.
  <info>stringnull     </info>  <strong>$encoding</strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output documents.
                              The possible values for encoding  are:  <return>ascii</return>, <return>latin0</return>, <return>latin1</return>, <return>raw</return>,
                              <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>, <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>,
                              and <return>shiftjis</return>.

<comment>Return:</comment>
  <info>bool</info>  tidy::parseString returns <info>true</info> on success. <strong>tidy_parse_string()</strong> returns a new <class>tidy</class> instance
        on success. Both, the method and the function return <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::repairFile()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairFile
type: function
doc:
<comment>Description:</comment>
  Repair a file and return it as a string
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Repairs the given file and returns it as a string.

<comment>Param:</comment>
  <info>string         </info>  <strong>$filename      </strong>  The file to be repaired.
  <info>arraystringnull</info>  <strong>$config        </strong>  The config <strong>$config</strong> can be passed either as an array or as a
                                    string. If a string is passed, it is interpreted as the name of
                                    the configuration file, otherwise, it is interpreted as the
                                    options themselves.
                                    
                                    Check http://tidy.sourceforge.net/docs/quickref.html for an
                                    explanation about each option.
  <info>stringnull     </info>  <strong>$encoding      </strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output
                                    documents. The possible values for encoding  are:  <return>ascii</return>,
                                    <return>latin0</return>, <return>latin1</return>, <return>raw</return>, <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>,
                                    <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>, and <return>shiftjis</return>.
  <info>bool           </info>  <strong>$useIncludePath</strong>  Search for the file in the include_path.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the repaired contents as a string,  o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairString()</strong>


id: tidy::repairString
type: function
doc:
<comment>Description:</comment>
  Repair a string using an optionally provided configuration file
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Repairs the given string.

<comment>Param:</comment>
  <info>string         </info>  <strong>$string  </strong>  The data to be repaired.
  <info>arraystringnull</info>  <strong>$config  </strong>  The config <strong>$config</strong> can be passed either as an array or as a string. If
                              a string is passed, it is interpreted as the name of the configuration
                              file, otherwise, it is interpreted as the options themselves.
                              
                              Check http://api.html-tidy.org/#quick-reference for an explanation
                              about each option.
  <info>stringnull     </info>  <strong>$encoding</strong>  The <strong>$encoding</strong> parameter sets the encoding for input/output documents.
                              The possible values for encoding  are:  <return>ascii</return>, <return>latin0</return>, <return>latin1</return>, <return>raw</return>,
                              <return>utf8</return>, <return>iso2022</return>, <return>mac</return>, <return>win1252</return>, <return>ibm858</return>, <return>utf16</return>, <return>utf16le</return>, <return>utf16be</return>, <return>big5</return>,
                              and <return>shiftjis</return>.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the repaired string,  o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * <strong>tidy::parseFile()</strong>
   * <strong>tidy::parseString()</strong>
   * <strong>tidy::repairFile()</strong>


id: tidy::root
type: function
doc:
<comment>Description:</comment>
  Returns a tidyNode object representing the root of the tidy parse tree
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns a <class>tidyNode</class> object representing the root of the tidy parse tree.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>tidyNodenull</info>  Returns the <class>tidyNode</class> object.


id: tidyNode::getParent
type: function
doc:
<comment>Description:</comment>
  Returns the parent node of the current node
  
  Returns the parent node of the current node.

<comment>Return:</comment>
  <info>tidyNodenull</info>  Returns a <info>tidyNode</info> if the node has a parent, or <info>null</info> otherwise.


id: tidyNode::hasChildren
type: function
doc:
<comment>Description:</comment>
  Checks if a node has children
  
  Tells if the node has children.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node has children, <info>false</info> otherwise.


id: tidyNode::hasSiblings
type: function
doc:
<comment>Description:</comment>
  Checks if a node has siblings
  
  Tells if the node has siblings.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node has siblings, <info>false</info> otherwise.


id: tidyNode::isAsp
type: function
doc:
<comment>Description:</comment>
  Checks if this node is ASP
  
  Tells whether the current node is ASP.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node is ASP, <info>false</info> otherwise.


id: tidyNode::isComment
type: function
doc:
<comment>Description:</comment>
  Checks if a node represents a comment
  
  Tells if the node is a comment.

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


id: tidyNode::isHtml
type: function
doc:
<comment>Description:</comment>
  Checks if a node is an element node
  
  Tells if the node is an element node, but not the root node of the document.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node is an element node, but not the root node of the document, <info>false</info>
        otherwise.


id: tidyNode::isJste
type: function
doc:
<comment>Description:</comment>
  Checks if this node is JSTE
  
  Tells if the node is JSTE.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node is JSTE, <info>false</info> otherwise.


id: tidyNode::isPhp
type: function
doc:
<comment>Description:</comment>
  Checks if a node is PHP
  
  Tells if the node is PHP.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current node is PHP code, <info>false</info> otherwise.


id: tidyNode::isText
type: function
doc:
<comment>Description:</comment>
  Checks if a node represents text (no markup)
  
  Tells if the node represents a text (without any markup).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the node represent a text, <info>false</info> otherwise.


id: tidy_access_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy accessibility warnings encountered for specified document
  
  <strong>tidy_access_count()</strong> returns the number of accessibility warnings found for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

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

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_config_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy configuration errors encountered for specified document
  
  Returns the number of errors encountered in the configuration of the specified tidy <strong>$tidy</strong>.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

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


id: tidy_error_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy errors encountered for specified document
  
  Returns the number of Tidy errors encountered for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

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

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_error_buffer
type: function
doc:
<comment>Description:</comment>
  Return warnings and errors which occurred parsing the specified document
  
  Stile orientato agli oggetti (property):
  
  Stile procedurale:
  
  Returns warnings and errors which occurred parsing the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the error buffer as a string, or <info>false</info> if the buffer is empty.

<comment>See Also:</comment>
   * <strong>tidy_access_count()</strong>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_warning_count()</strong>


id: tidy_get_output
type: function
doc:
<comment>Description:</comment>
  Return a string representing the parsed tidy markup
  
  Gets a string with the repaired html.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

<comment>Return:</comment>
  <info>string</info>  Returns the parsed tidy markup.


id: tidy_warning_count
type: function
doc:
<comment>Description:</comment>
  Returns the Number of Tidy warnings encountered for specified document
  
  Returns the number of Tidy warnings encountered for the specified document.

<comment>Param:</comment>
  <info>tidy</info>  <strong>$tidy</strong>  L'oggetto <class>Tidy</class>

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

<comment>See Also:</comment>
   * <strong>tidy_error_count()</strong>
   * <strong>tidy_access_count()</strong>


id: time_nanosleep
type: function
doc:
<comment>Description:</comment>
  Delay for a number of seconds and nanoseconds
  
  Delays program execution for the given number of <strong>$seconds</strong> and <strong>$nanoseconds</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds    </strong>  Must be a non-negative integer.
  <info>int</info>  <strong>$nanoseconds</strong>  Must be a non-negative integer less than 1 billion.
                     
                     On Windows, the system may sleep longer that the given number of nanoseconds,
                     depending on the hardware.

<comment>Return:</comment>
  <info>arraybool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.
             
             If the delay was interrupted by a signal, an associative array will be returned with
             the components: <return>seconds</return> - number of seconds remaining in the delay <return>nanoseconds</return> - number
             of nanoseconds remaining in the delay
             
             <return>seconds</return> - number of seconds remaining in the delay
             
             <return>nanoseconds</return> - number of nanoseconds remaining in the delay

<comment>See Also:</comment>
   * <strong>sleep()</strong>
   * <strong>usleep()</strong>
   * <strong>time_sleep_until()</strong>
   * <strong>set_time_limit()</strong>


id: time_sleep_until
type: function
doc:
<comment>Description:</comment>
  Make the script sleep until the specified time
    
  
  Makes the script sleep until the specified <strong>$timestamp</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$timestamp</strong>  The timestamp when the script should wake.

<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>sleep()</strong>
   * <strong>usleep()</strong>
   * <strong>time_nanosleep()</strong>
   * <strong>set_time_limit()</strong>


id: timezone_abbreviations_list
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::listAbbreviations
  
  Questa funzione è sinonimo di:  DateTimeZone::listAbbreviations


id: timezone_identifiers_list
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::listIdentifiers
  
  Questa funzione è sinonimo di:  DateTimeZone::listIdentifiers


id: timezone_location_get
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::getLocation
  
  Questa funzione è sinonimo di:  DateTimeZone::getLocation


id: timezone_name_from_abbr
type: function
doc:
<comment>Description:</comment>
  Returns the timezone name from abbreviation

<comment>Param:</comment>
  <info>string</info>  <strong>$abbr     </strong>  Time zone abbreviation.
  <info>int   </info>  <strong>$utcOffset</strong>  Offset from GMT in seconds. Defaults to -1 which means that first found time
                      zone corresponding to <strong>$abbr</strong> is returned. Otherwise exact offset is searched
                      and only if not found then the first time zone with any offset is returned.
  <info>int   </info>  <strong>$isDST    </strong>  Daylight saving time indicator. Defaults to -1, which means that whether the
                      time zone has daylight saving or not is not taken into consideration when
                      searching. If this is set to 1, then the <strong>$utcOffset</strong> is assumed to be an offset
                      with daylight saving in effect; if 0, then <strong>$utcOffset</strong> is assumed to be an
                      offset without daylight saving in effect. If <strong>$abbr</strong> doesn't exist then the time
                      zone is searched solely by the <strong>$utcOffset</strong> and <strong>$isDST</strong>.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns time zone name on success o <info>false</info> in caso di fallimento.

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


id: timezone_name_get
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::getName
  
  Questa funzione è sinonimo di:  DateTimeZone::getName


id: timezone_offset_get
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::getOffset
  
  Questa funzione è sinonimo di:  DateTimeZone::getOffset


id: timezone_open
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::__construct
  
  Questa funzione è sinonimo di:  DateTimeZone::__construct


id: timezone_transitions_get
type: function
doc:
<comment>Description:</comment>
  Alias di DateTimeZone::getTransitions
  
  Questa funzione è sinonimo di:  DateTimeZone::getTransitions


id: timezone_version_get
type: function
doc:
<comment>Description:</comment>
  Gets the version of the timezonedb
    
  
  Returns the current version of the timezonedb.

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

<comment>See Also:</comment>
   * List of Supported Timezones


id: token_get_all
type: function
doc:
<comment>Description:</comment>
  Split given source into PHP tokens
  
  <strong>token_get_all()</strong> parses the given <strong>$code</strong>  string into PHP language tokens using the Zend engine's
  lexical scanner.
  
  For a list of parser tokens, see , or use  <strong>token_name()</strong> to translate a token value into its string
  representation.

<comment>Param:</comment>
  <info>string</info>  <strong>$code </strong>  The PHP source to parse.
  <info>int   </info>  <strong>$flags</strong>  Valid flags: <info>TOKEN_PARSE</info> - Recognises the ability to use reserved words in
                  specific contexts.
                  
                  <info>TOKEN_PARSE</info> - Recognises the ability to use reserved words in specific contexts.

<comment>Return:</comment>
  <info>array</info>  An array of token identifiers. Each individual token identifier is either a single
         character (i.e.: <return>;</return>, <return>.</return>,  <return>&gt;</return>, <return>!</return>, etc...), or a three element array containing the token
         index in element 0, the string content of the original token in element 1 and the line
         number in element 2.

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>
   * <strong>token_name()</strong>


id: token_name
type: function
doc:
<comment>Description:</comment>
  Get the symbolic name of a given PHP token
  
  <strong>token_name()</strong> gets the symbolic name for a PHP  <strong>$id</strong> value.

<comment>Param:</comment>
  <info>int</info>  <strong>$id</strong>  The token value.

<comment>Return:</comment>
  <info>string</info>  The symbolic name of the given <strong>$id</strong>.

<comment>See Also:</comment>
   * <strong>PhpToken::getTokenName()</strong>


id: trader_acos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ACos
  
  Calculates the arc cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ad
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Line

<comment>Param:</comment>
  <info>array</info>  <strong>$high  </strong>  High price, array of real values.
  <info>array</info>  <strong>$low   </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close </strong>  Closing price, array of real values.
  <info>array</info>  <strong>$volume</strong>  Volume traded, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_add
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Add
  
  Calculates the vector addition of <strong>$real0</strong> to <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array of real values.
  <info>array</info>  <strong>$real1</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adosc
type: function
doc:
<comment>Description:</comment>
  Chaikin A/D Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>array</info>  <strong>$volume    </strong>  Volume traded, array of real values.
  <info>int  </info>  <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adx
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_adxr
type: function
doc:
<comment>Description:</comment>
  Average Directional Movement Index Rating

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_apo
type: function
doc:
<comment>Description:</comment>
  Absolute Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$mAType    </strong>  Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroon
type: function
doc:
<comment>Description:</comment>
  Aroon

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_aroonosc
type: function
doc:
<comment>Description:</comment>
  Aroon Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_asin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ASin
  
  Calculates the arc sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric ATan
  
  Calculates the arc tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_atr
type: function
doc:
<comment>Description:</comment>
  Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_avgprice
type: function
doc:
<comment>Description:</comment>
  Average Price

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bbands
type: function
doc:
<comment>Description:</comment>
  Bollinger Bands

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDevUp   </strong>  Deviation multiplier for upper band. Valid range from TRADER_REAL_MIN to
                      TRADER_REAL_MAX.
  <info>float</info>  <strong>$nbDevDn   </strong>  Deviation multiplier for lower band. Valid range from TRADER_REAL_MIN to
                      TRADER_REAL_MAX.
  <info>int  </info>  <strong>$mAType    </strong>  Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_beta
type: function
doc:
<comment>Description:</comment>
  Beta

<comment>Param:</comment>
  <info>array</info>  <strong>$real0     </strong>  Array of real values.
  <info>array</info>  <strong>$real1     </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_bop
type: function
doc:
<comment>Description:</comment>
  Balance Of Power

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cci
type: function
doc:
<comment>Description:</comment>
  Commodity Channel Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl2crows
type: function
doc:
<comment>Description:</comment>
  Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3blackcrows
type: function
doc:
<comment>Description:</comment>
  Three Black Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3inside
type: function
doc:
<comment>Description:</comment>
  Three Inside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3linestrike
type: function
doc:
<comment>Description:</comment>
  Three-Line Strike

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3outside
type: function
doc:
<comment>Description:</comment>
  Three Outside Up/Down

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3starsinsouth
type: function
doc:
<comment>Description:</comment>
  Three Stars In The South

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdl3whitesoldiers
type: function
doc:
<comment>Description:</comment>
  Three Advancing White Soldiers

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlabandonedbaby
type: function
doc:
<comment>Description:</comment>
  Abandoned Baby

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdladvanceblock
type: function
doc:
<comment>Description:</comment>
  Advance Block

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbelthold
type: function
doc:
<comment>Description:</comment>
  Belt-hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlbreakaway
type: function
doc:
<comment>Description:</comment>
  Breakaway

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlclosingmarubozu
type: function
doc:
<comment>Description:</comment>
  Closing Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlconcealbabyswall
type: function
doc:
<comment>Description:</comment>
  Concealing Baby Swallow

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlcounterattack
type: function
doc:
<comment>Description:</comment>
  Counterattack

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldarkcloudcover
type: function
doc:
<comment>Description:</comment>
  Dark Cloud Cover

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldoji
type: function
doc:
<comment>Description:</comment>
  Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldojistar
type: function
doc:
<comment>Description:</comment>
  Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdldragonflydoji
type: function
doc:
<comment>Description:</comment>
  Dragonfly Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlengulfing
type: function
doc:
<comment>Description:</comment>
  Engulfing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningdojistar
type: function
doc:
<comment>Description:</comment>
  Evening Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdleveningstar
type: function
doc:
<comment>Description:</comment>
  Evening Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgapsidesidewhite
type: function
doc:
<comment>Description:</comment>
  Up/Down-gap side-by-side white lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlgravestonedoji
type: function
doc:
<comment>Description:</comment>
  Gravestone Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhammer
type: function
doc:
<comment>Description:</comment>
  Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhangingman
type: function
doc:
<comment>Description:</comment>
  Hanging Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharami
type: function
doc:
<comment>Description:</comment>
  Harami Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlharamicross
type: function
doc:
<comment>Description:</comment>
  Harami Cross Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhighwave
type: function
doc:
<comment>Description:</comment>
  High-Wave Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkake
type: function
doc:
<comment>Description:</comment>
  Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhikkakemod
type: function
doc:
<comment>Description:</comment>
  Modified Hikkake Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlhomingpigeon
type: function
doc:
<comment>Description:</comment>
  Homing Pigeon

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlidentical3crows
type: function
doc:
<comment>Description:</comment>
  Identical Three Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinneck
type: function
doc:
<comment>Description:</comment>
  In-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlinvertedhammer
type: function
doc:
<comment>Description:</comment>
  Inverted Hammer

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkicking
type: function
doc:
<comment>Description:</comment>
  Kicking

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlkickingbylength
type: function
doc:
<comment>Description:</comment>
  Kicking - bull/bear determined by the longer marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlladderbottom
type: function
doc:
<comment>Description:</comment>
  Ladder Bottom

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongleggeddoji
type: function
doc:
<comment>Description:</comment>
  Long Legged Doji

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdllongline
type: function
doc:
<comment>Description:</comment>
  Long Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmarubozu
type: function
doc:
<comment>Description:</comment>
  Marubozu

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmatchinglow
type: function
doc:
<comment>Description:</comment>
  Matching Low

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmathold
type: function
doc:
<comment>Description:</comment>
  Mat Hold

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningdojistar
type: function
doc:
<comment>Description:</comment>
  Morning Doji Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlmorningstar
type: function
doc:
<comment>Description:</comment>
  Morning Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open       </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>float</info>  <strong>$penetration</strong>  Percentage of penetration of a candle within another candle.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlonneck
type: function
doc:
<comment>Description:</comment>
  On-Neck Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlpiercing
type: function
doc:
<comment>Description:</comment>
  Piercing Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrickshawman
type: function
doc:
<comment>Description:</comment>
  Rickshaw Man

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlrisefall3methods
type: function
doc:
<comment>Description:</comment>
  Rising/Falling Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlseparatinglines
type: function
doc:
<comment>Description:</comment>
  Separating Lines

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshootingstar
type: function
doc:
<comment>Description:</comment>
  Shooting Star

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlshortline
type: function
doc:
<comment>Description:</comment>
  Short Line Candle

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlspinningtop
type: function
doc:
<comment>Description:</comment>
  Spinning Top

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlstalledpattern
type: function
doc:
<comment>Description:</comment>
  Stalled Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlsticksandwich
type: function
doc:
<comment>Description:</comment>
  Stick Sandwich

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltakuri
type: function
doc:
<comment>Description:</comment>
  Takuri (Dragonfly Doji with very long lower shadow)

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltasukigap
type: function
doc:
<comment>Description:</comment>
  Tasuki Gap

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlthrusting
type: function
doc:
<comment>Description:</comment>
  Thrusting Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdltristar
type: function
doc:
<comment>Description:</comment>
  Tristar Pattern

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlunique3river
type: function
doc:
<comment>Description:</comment>
  Unique 3 River

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlupsidegap2crows
type: function
doc:
<comment>Description:</comment>
  Upside Gap Two Crows

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cdlxsidegap3methods
type: function
doc:
<comment>Description:</comment>
  Upside/Downside Gap Three Methods

<comment>Param:</comment>
  <info>array</info>  <strong>$open </strong>  Opening price, array of real values.
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ceil
type: function
doc:
<comment>Description:</comment>
  Vector Ceil
  
  Calculates the next highest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cmo
type: function
doc:
<comment>Description:</comment>
  Chande Momentum Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_correl
type: function
doc:
<comment>Description:</comment>
  Pearson's Correlation Coefficient (r)

<comment>Param:</comment>
  <info>array</info>  <strong>$real0     </strong>  Array of real values.
  <info>array</info>  <strong>$real1     </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cos
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cos
  
  Calculates the cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_cosh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Cosh
  
  Calculates the hyperbolic cosine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dema
type: function
doc:
<comment>Description:</comment>
  Double Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_div
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Div
  
  Divides each value from <strong>$real0</strong> by the corresponding value from <strong>$real1</strong> and returns the resulting
  array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array of real values.
  <info>array</info>  <strong>$real1</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_dx
type: function
doc:
<comment>Description:</comment>
  Directional Movement Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ema
type: function
doc:
<comment>Description:</comment>
  Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_errno
type: function
doc:
<comment>Description:</comment>
  Get error code
  
  Get error code of the last operation.

<comment>Return:</comment>
  <info>int</info>  Returns the error code identified by one of the TRADER_ERR_* constants.


id: trader_exp
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Exp
  
  Calculates <info>e</info> raised to the power of each value in <strong>$real</strong>. Returns an array with the calculated
  data.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_floor
type: function
doc:
<comment>Description:</comment>
  Vector Floor
  
  Calculates the next lowest integer for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_get_compat
type: function
doc:
<comment>Description:</comment>
  Get compatibility mode
  
  Get compatibility mode which affects the way calculations are done by all the extension functions.

<comment>Return:</comment>
  <info>int</info>  Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of
       constants.


id: trader_get_unstable_period
type: function
doc:
<comment>Description:</comment>
  Get unstable period
  
  Get unstable period factor for a particular function.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor to be read for. TRADER_FUNC_UNST_* series of constants
                    should be used.

<comment>Return:</comment>
  <info>int</info>  Returns the unstable period factor for the corresponding function.


id: trader_ht_dcperiod
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Period

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_dcphase
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Dominant Cycle Phase

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_phasor
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Phasor Components

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_sine
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - SineWave

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendline
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Instantaneous Trendline

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ht_trendmode
type: function
doc:
<comment>Description:</comment>
  Hilbert Transform - Trend vs Cycle Mode

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_kama
type: function
doc:
<comment>Description:</comment>
  Kaufman Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg
type: function
doc:
<comment>Description:</comment>
  Linear Regression

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_angle
type: function
doc:
<comment>Description:</comment>
  Linear Regression Angle

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_intercept
type: function
doc:
<comment>Description:</comment>
  Linear Regression Intercept

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_linearreg_slope
type: function
doc:
<comment>Description:</comment>
  Linear Regression Slope

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ln
type: function
doc:
<comment>Description:</comment>
  Vector Log Natural
  
  Calculates the natural logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_log10
type: function
doc:
<comment>Description:</comment>
  Vector Log10
  
  Calculates the base-10 logarithm for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ma
type: function
doc:
<comment>Description:</comment>
  Moving average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$mAType    </strong>  Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macd
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence

<comment>Param:</comment>
  <info>array</info>  <strong>$real        </strong>  Array of real values.
  <info>int  </info>  <strong>$fastPeriod  </strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$slowPeriod  </strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdext
type: function
doc:
<comment>Description:</comment>
  MACD with controllable MA type

<comment>Param:</comment>
  <info>array</info>  <strong>$real        </strong>  Array of real values.
  <info>int  </info>  <strong>$fastPeriod  </strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$fastMAType  </strong>  Type of Moving Average for fast MA. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int  </info>  <strong>$slowPeriod  </strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$slowMAType  </strong>  Type of Moving Average for slow MA. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int  </info>  <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.
  <info>int  </info>  <strong>$signalMAType</strong>  Type of Moving Average for signal line. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_macdfix
type: function
doc:
<comment>Description:</comment>
  Moving Average Convergence/Divergence Fix 12/26

<comment>Param:</comment>
  <info>array</info>  <strong>$real        </strong>  Array of real values.
  <info>int  </info>  <strong>$signalPeriod</strong>  Smoothing for the signal line (nb of period). Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mama
type: function
doc:
<comment>Description:</comment>
  MESA Adaptive Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real     </strong>  Array of real values.
  <info>float</info>  <strong>$fastLimit</strong>  Upper limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.
  <info>float</info>  <strong>$slowLimit</strong>  Lower limit use in the adaptive algorithm. Valid range from 0.01 to 0.99.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mavp
type: function
doc:
<comment>Description:</comment>
  Moving average with variable period

<comment>Param:</comment>
  <info>array</info>  <strong>$real     </strong>  Array of real values.
  <info>array</info>  <strong>$periods  </strong>  Array of real values.
  <info>int  </info>  <strong>$minPeriod</strong>  Value less than minimum will be changed to Minimum period. Valid range from 2
                     to 100000
  <info>int  </info>  <strong>$maxPeriod</strong>  Value higher than minimum will be changed to Maximum period. Valid range from 2
                     to 100000
  <info>int  </info>  <strong>$mAType   </strong>  Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_max
type: function
doc:
<comment>Description:</comment>
  Highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_maxindex
type: function
doc:
<comment>Description:</comment>
  Index of highest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_medprice
type: function
doc:
<comment>Description:</comment>
  Median Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high</strong>  High price, array of real values.
  <info>array</info>  <strong>$low </strong>  Low price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mfi
type: function
doc:
<comment>Description:</comment>
  Money Flow Index

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>array</info>  <strong>$volume    </strong>  Volume traded, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midpoint
type: function
doc:
<comment>Description:</comment>
  MidPoint over period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_midprice
type: function
doc:
<comment>Description:</comment>
  Midpoint Price over period

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_min
type: function
doc:
<comment>Description:</comment>
  Lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minindex
type: function
doc:
<comment>Description:</comment>
  Index of lowest value over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmax
type: function
doc:
<comment>Description:</comment>
  Lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minmaxindex
type: function
doc:
<comment>Description:</comment>
  Indexes of lowest and highest values over a specified period

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_di
type: function
doc:
<comment>Description:</comment>
  Minus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_minus_dm
type: function
doc:
<comment>Description:</comment>
  Minus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mom
type: function
doc:
<comment>Description:</comment>
  Momentum

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_mult
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Mult
  
  Calculates the vector dot product of <strong>$real0</strong> with <strong>$real1</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array of real values.
  <info>array</info>  <strong>$real1</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_natr
type: function
doc:
<comment>Description:</comment>
  Normalized Average True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_obv
type: function
doc:
<comment>Description:</comment>
  On Balance Volume

<comment>Param:</comment>
  <info>array</info>  <strong>$real  </strong>  Array of real values.
  <info>array</info>  <strong>$volume</strong>  Volume traded, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_di
type: function
doc:
<comment>Description:</comment>
  Plus Directional Indicator

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_plus_dm
type: function
doc:
<comment>Description:</comment>
  Plus Directional Movement

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ppo
type: function
doc:
<comment>Description:</comment>
  Percentage Price Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$fastPeriod</strong>  Number of period for the fast MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$slowPeriod</strong>  Number of period for the slow MA. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$mAType    </strong>  Type of Moving Average. TRADER_MA_TYPE_* series of constants should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_roc
type: function
doc:
<comment>Description:</comment>
  Rate of change : ((price/prevPrice)-1)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocp
type: function
doc:
<comment>Description:</comment>
  Rate of change Percentage: (price-prevPrice)/prevPrice

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio: (price/prevPrice)

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rocr100
type: function
doc:
<comment>Description:</comment>
  Rate of change ratio 100 scale: (price/prevPrice)*100

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_rsi
type: function
doc:
<comment>Description:</comment>
  Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sar
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR

<comment>Param:</comment>
  <info>array</info>  <strong>$high        </strong>  High price, array of real values.
  <info>array</info>  <strong>$low         </strong>  Low price, array of real values.
  <info>float</info>  <strong>$acceleration</strong>  Acceleration Factor used up to the Maximum value. Valid range from 0 to
                        TRADER_REAL_MAX.
  <info>float</info>  <strong>$maximum     </strong>  Acceleration Factor Maximum value. Valid range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sarext
type: function
doc:
<comment>Description:</comment>
  Parabolic SAR - Extended

<comment>Param:</comment>
  <info>array</info>  <strong>$high                 </strong>  High price, array of real values.
  <info>array</info>  <strong>$low                  </strong>  Low price, array of real values.
  <info>float</info>  <strong>$startValue           </strong>  Start value and direction. 0 for Auto, &gt;0 for Long, \<0 for Short. Valid range from TRADER_REAL_MIN to TRADER_REAL_MAX.
  <info>float</info>  <strong>$offsetOnReverse      </strong>  Percent offset added/removed to initial stop on short/long
                                 reversal. Valid range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitLong </strong>  Acceleration Factor initial value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationLong     </strong>  Acceleration Factor for the Long direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxLong  </strong>  Acceleration Factor maximum value for the Long direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationInitShort</strong>  Acceleration Factor initial value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationShort    </strong>  Acceleration Factor for the Short direction. Valid range from 0 to
                                 TRADER_REAL_MAX.
  <info>float</info>  <strong>$accelerationMaxShort </strong>  Acceleration Factor maximum value for the Short direction. Valid
                                 range from 0 to TRADER_REAL_MAX.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_set_compat
type: function
doc:
<comment>Description:</comment>
  Set compatibility mode
  
  Set compatibility mode which will affect the way calculations are done by all the extension
  functions.

<comment>Param:</comment>
  <info>int</info>  <strong>$compatId</strong>  Compatibility Id. TRADER_COMPATIBILITY_* series of constants should be used.

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


id: trader_set_unstable_period
type: function
doc:
<comment>Description:</comment>
  Set unstable period
  
  Influences unstable period factor for functions, which are sensible to it. More information about
  unstable periods can be found on the TA-Lib API documentation page.

<comment>Param:</comment>
  <info>int</info>  <strong>$functionId</strong>  Function ID the factor should be set for. TRADER_FUNC_UNST_* constant series can
                    be used to affect the corresponding function.
  <info>int</info>  <strong>$timePeriod</strong>  Unstable period value.

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


id: trader_sin
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sin
  
  Calculates the sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sinh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Sinh
  
  Calculates the hyperbolic sine for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sma
type: function
doc:
<comment>Description:</comment>
  Simple Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sqrt
type: function
doc:
<comment>Description:</comment>
  Vector Square Root
  
  Calculates the square root of each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stddev
type: function
doc:
<comment>Description:</comment>
  Standard Deviation

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDev     </strong>  

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stoch
type: function
doc:
<comment>Description:</comment>
  Stochastic

<comment>Param:</comment>
  <info>array</info>  <strong>$high        </strong>  High price, array of real values.
  <info>array</info>  <strong>$low         </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close       </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$slowK_Period</strong>  Smoothing for making the Slow-K line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int  </info>  <strong>$slowK_MAType</strong>  Type of Moving Average for Slow-K. TRADER_MA_TYPE_* series of constants
                        should be used.
  <info>int  </info>  <strong>$slowD_Period</strong>  Smoothing for making the Slow-D line. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$slowD_MAType</strong>  Type of Moving Average for Slow-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochf
type: function
doc:
<comment>Description:</comment>
  Stochastic Fast

<comment>Param:</comment>
  <info>array</info>  <strong>$high        </strong>  High price, array of real values.
  <info>array</info>  <strong>$low         </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close       </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$fastD_Period</strong>  Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int  </info>  <strong>$fastD_MAType</strong>  Type of Moving Average for Fast-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_stochrsi
type: function
doc:
<comment>Description:</comment>
  Stochastic Relative Strength Index

<comment>Param:</comment>
  <info>array</info>  <strong>$real        </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod  </strong>  Number of period. Valid range from 2 to 100000.
  <info>int  </info>  <strong>$fastK_Period</strong>  Time period for building the Fast-K line. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$fastD_Period</strong>  Smoothing for making the Fast-D line. Valid range from 1 to 100000, usually
                        set to 3.
  <info>int  </info>  <strong>$fastD_MAType</strong>  Type of Moving Average for Fast-D. TRADER_MA_TYPE_* series of constants
                        should be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sub
type: function
doc:
<comment>Description:</comment>
  Vector Arithmetic Subtraction
  
  Calculates the vector subtraction of <strong>$real1</strong> from <strong>$real0</strong> and returns the resulting vector.

<comment>Param:</comment>
  <info>array</info>  <strong>$real0</strong>  Array of real values.
  <info>array</info>  <strong>$real1</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_sum
type: function
doc:
<comment>Description:</comment>
  Summation

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_t3
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average (T3)

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$vFactor   </strong>  Volume Factor. Valid range from 1 to 0.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tan
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tan
  
  Calculates the tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tanh
type: function
doc:
<comment>Description:</comment>
  Vector Trigonometric Tanh
  
  Calculates the hyperbolic tangent for each value in <strong>$real</strong> and returns the resulting array.

<comment>Param:</comment>
  <info>array</info>  <strong>$real</strong>  Array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tema
type: function
doc:
<comment>Description:</comment>
  Triple Exponential Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trange
type: function
doc:
<comment>Description:</comment>
  True Range

<comment>Param:</comment>
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trima
type: function
doc:
<comment>Description:</comment>
  Triangular Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_trix
type: function
doc:
<comment>Description:</comment>
  1-day Rate-Of-Change (ROC) of a Triple Smooth EMA

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_tsf
type: function
doc:
<comment>Description:</comment>
  Time Series Forecast

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_typprice
type: function
doc:
<comment>Description:</comment>
  Typical Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_ultosc
type: function
doc:
<comment>Description:</comment>
  Ultimate Oscillator

<comment>Param:</comment>
  <info>array</info>  <strong>$high       </strong>  High price, array of real values.
  <info>array</info>  <strong>$low        </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close      </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod1</strong>  Number of bars for 1st period. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$timePeriod2</strong>  Number of bars for 2nd period. Valid range from 1 to 100000.
  <info>int  </info>  <strong>$timePeriod3</strong>  Number of bars for 3rd period. Valid range from 1 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_var
type: function
doc:
<comment>Description:</comment>
  Variance

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.
  <info>float</info>  <strong>$nbDev     </strong>  

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wclprice
type: function
doc:
<comment>Description:</comment>
  Weighted Close Price

<comment>Param:</comment>
  <info>array</info>  <strong>$high </strong>  High price, array of real values.
  <info>array</info>  <strong>$low  </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close</strong>  Closing price, array of real values.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_willr
type: function
doc:
<comment>Description:</comment>
  Williams' %R

<comment>Param:</comment>
  <info>array</info>  <strong>$high      </strong>  High price, array of real values.
  <info>array</info>  <strong>$low       </strong>  Low price, array of real values.
  <info>array</info>  <strong>$close     </strong>  Closing price, array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trader_wma
type: function
doc:
<comment>Description:</comment>
  Weighted Moving Average

<comment>Param:</comment>
  <info>array</info>  <strong>$real      </strong>  Array of real values.
  <info>int  </info>  <strong>$timePeriod</strong>  Number of period. Valid range from 2 to 100000.

<comment>Return:</comment>
  <info>array</info>  Returns an array with calculated data or false on failure.


id: trait_exists
type: function
doc:
<comment>Description:</comment>
  Checks if the trait exists

<comment>Param:</comment>
  <info>string</info>  <strong>$traitname</strong>  Name of the trait to check
  <info>bool  </info>  <strong>$autoload </strong>  Whether to autoload if not already loaded.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if trait exists, <info>false</info> if not, <info>null</info> in case of an error.


id: trigger_error
type: function
doc:
<comment>Description:</comment>
  Genera un messaggio a livello utente di errore/avviso/avvertimento message


id: trim
type: function
doc:
<comment>Description:</comment>
  Rimuove gli spazi (ed altri caratteri) all'inizio e alla fine di un testo
  
  Questa funzione restituisce il parametro <strong>$str</strong> privo degli spazi iniziali e finali. Senza la
  specifica del secondo parametro, <strong>trim()</strong> rimuoverà questi caratteri:   " " (ASCII <return>32</return> (<return>0x20</return>)),
  spazio.  "\t" (ASCII <return>9</return> (<return>0x09</return>)), il carattere tab.  "\n" (ASCII <return>10</return> (<return>0x0A</return>)),  il new line (line
  feed).  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), il carriage return.  "\0" (ASCII <return>0</return> (<return>0x00</return>)),  il byte <return>NUL</return>.  "\x0B"
  (ASCII <return>11</return> (<return>0x0B</return>)), il tab verticale.
  
  " " (ASCII <return>32</return> (<return>0x20</return>)), spazio.
  
  "\t" (ASCII <return>9</return> (<return>0x09</return>)), il carattere tab.
  
  "\n" (ASCII <return>10</return> (<return>0x0A</return>)),  il new line (line feed).
  
  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), il carriage return.
  
  "\0" (ASCII <return>0</return> (<return>0x00</return>)),  il byte <return>NUL</return>.
  
   "\x0B" (ASCII <return>11</return> (<return>0x0B</return>)), il tab verticale.

<comment>Param:</comment>
  <info>string</info>  <strong>$str     </strong>  La <info>stringa</info> che deve essere troncata.
  <info>string</info>  <strong>$charlist</strong>  Opzionale, Si può, inoltre, specificare quali caratteri si desidera rimuovere
                     elencandoli in <strong>$charlist</strong>. Questo parametro è un semplice elenco dei caratteri
                     da rimuovere. Con <return>..</return> si può indicare un range di caratteri.

<comment>Return:</comment>
  <info>string</info>  La stringa troncata.

<comment>See Also:</comment>
   * <strong>ltrim()</strong>
   * <strong>rtrim()</strong>


id: uasort
type: function
doc:
<comment>Description:</comment>
  Ordina un array mediante una funzione definita dall'utente e
       mantiene le associazioni


id: ucwords
type: function
doc:
<comment>Description:</comment>
  Converte in maiuscolo il primo carattere di ogni parola di una stringa


id: uksort
type: function
doc:
<comment>Description:</comment>
  Ordina rispetto alle chiavi di un array mediante una funzione definita dall'utente


id: uniqid
type: function
doc:
<comment>Description:</comment>
  Generate a unique ID
  
  Gets a prefixed unique identifier based on the current time in microseconds.
  
  Questa funzione non genera valori crittograficamente sicuri, e non dovrebbe essere usata per scopi
  di crittografia. Se c'è necessità di utilizzare un valore crittograficamente sicuro, si preferisca
  <strong>openssl_random_pseudo_bytes()</strong>.
  
  This function does not guarantee uniqueness of return value. Since most systems adjust system
  clock by NTP or like, system time is changed constantly. Therefore, it is possible that this
  function does not return unique ID for the process/thread. Use <strong>$more_entropy</strong> to increase
  likelihood of uniqueness.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix      </strong>  Can be useful, for instance, if you generate identifiers simultaneously on
                         several hosts that might happen to generate the identifier at the same
                         microsecond.
                         
                         With an empty <strong>$prefix</strong>, the returned string will be 13 characters long.  If
                         <strong>$more_entropy</strong> is <info>true</info>, it will be 23 characters.
  <info>bool  </info>  <strong>$more_entropy</strong>  If set to <info>true</info>, <strong>uniqid()</strong> will add additional entropy (using the combined
                         linear congruential generator) at the end of the return value, which
                         increases the likelihood that the result will be unique.

<comment>Return:</comment>
  <info>string</info>  Returns timestamp based unique identifier as a string.
          
          This function tries to create unique identifier, but it does not guarantee 100% uniqueness
          of return value.


id: unpack
type: function
doc:
<comment>Description:</comment>
  Unpack data from binary string
  
  Unpacks from a binary string into an array according to the given <strong>$format</strong>.
  
  The unpacked data is stored in an associative array. To accomplish this you have to name the
  different format codes and separate them by a slash /. If a repeater argument is present, then
  each of the array keys will have a sequence number behind the given name.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  See <strong>pack()</strong> for an explanation of the format codes.
  <info>string</info>  <strong>$string</strong>  The packed data.
  <info>int   </info>  <strong>$offset</strong>  The offset to begin unpacking from.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an associative array containing unpacked elements of binary string,  o <info>false</info>
              in caso di fallimento.

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


id: unregister_tick_function
type: function
doc:
<comment>Description:</comment>
  De-register a function for execution on each tick
  
  De-registers the function <strong>$function</strong> so it is no longer executed when a tick is called.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The function to de-register.

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

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


id: unserialize
type: function
doc:
<comment>Description:</comment>
  Crea un valore PHP a partire da una rappresentazione archiviata
    
  
  La funzione <strong>unserialize()</strong> prende il formato serializzato di una variabile (vedere <strong>serialize()</strong>) e
  la riporta al valore PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  La stringa serializzata.
                
                Se la variabile da ripristinare è un oggetto, dopo avere ricostruito l'oggetto, il
                PHP cercherà di eseguire la funzione membro  <strong>__wakeup()</strong> (se esiste).
                
                Direttiva unserialize_callback_func E' possibile impostare una funzione di callback
                che possa essere richiamata se, durante la fase di deserializzazione, occorre
                istanziare una classe indefinita. (per evitare di ottenere un tipo <info>object</info> incompleto
                "__PHP_Incomplete_Class".) Per definire il parametro 'unserialize_callback_func' si
                può agire sul php.ini, o usare <strong>ini_set()</strong> oppure con .htaccess. Verrà utilizzata
                questa funzione ogni volta che occorre istanziare una classe indefinita. Per
                disabilitare questa opzione, lasciare vuota questa impostazione.
                
                E' possibile impostare una funzione di callback che possa essere richiamata se,
                durante la fase di deserializzazione, occorre istanziare una classe indefinita. (per
                evitare di ottenere un tipo <info>object</info> incompleto "__PHP_Incomplete_Class".) Per
                definire il parametro 'unserialize_callback_func' si può agire sul php.ini, o usare
                <strong>ini_set()</strong> oppure con .htaccess. Verrà utilizzata questa funzione ogni volta che
                occorre istanziare una classe indefinita. Per disabilitare questa opzione, lasciare
                vuota questa impostazione.

<comment>Return:</comment>
  <info>mixed</info>  Il valore convertito è restituito, e può essere un <info>boolean</info>, <info>integer</info>, <info>float</info>, <info>string</info>, <info>array</info>
         oppure <info>object</info>.
         
         Nel caso in cui la stringa passata non sia deserializzabile la funzione restituisce <info>false</info> e
         genera un <info>E_NOTICE</info>.

<comment>See Also:</comment>
   * <strong>serialize()</strong>
   * Autoloading Objects
   * unserialize_callback_func


id: unset
type: function
doc:
<comment>Description:</comment>
  Cancella una data variabile
  
  <strong>unset()</strong> distrugge la variabile specificata.
  
  Il comportamento di <strong>unset()</strong> all'interno di una funzione può dipendere molto dal tipo di variabile
  che si intende distruggere.
  
  Se una variabile globale è <strong>unset()</strong> all'interno di una funzione, solo la variabile locale viene
  distrutta.  La variabile nell'ambiente chiamante conserverà lo stesso valore che aveva prima che
  <strong>unset()</strong> venisse chiamata.
  ]]>
  
  Il precedente esempio visualizzerà:
  
  
  
  Per <strong>unset()</strong> una variabile globale all'interno di una funzione, viene usato l'array $GLOBALS: 
  ]]>
  
  Se una variabile che è PASSATA PER RIFERIMENTO viene <strong>unset()</strong> all'interno di una funzione, solo la
  variabile locale viene distrutta.  La variabile nell'ambiente chiamante conserverà lo stesso
  valore che aveva prima che <strong>unset()</strong> venisse chiamata.
  ]]>
  
  Il precedente esempio visualizzerà:
  
  
  
  Se una variabile statica viene <strong>unset()</strong> all'interno di una funzione, <strong>unset()</strong> distrugge la variabile
  solo nel contesto del resto della funzione. Le chiamate successive ripristineranno il precedente
  valore di una variabile.
  ]]>
  
  Il precedente esempio visualizzerà:
  
  

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  La variabile da distruggere.
  <info>mixed</info>  <strong>$...</strong>  Un'altra variabile ...

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

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * <strong>empty()</strong>
   * __unset()
   * <strong>array_splice()</strong>


id: untaint
type: function
doc:
<comment>Description:</comment>
  Decontamina stringhe
  
  Decontamina stringhe

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

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


id: uopz_add_function
type: function
doc:
<comment>Description:</comment>
  Adds non-existent function or method
  
  Adds a non-existent function or method.

<comment>Param:</comment>
  <info>string </info>  <strong>$class   </strong>  The name of the class.
  <info>string </info>  <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$handler </strong>  The <class>Closure</class> that defines the new function or method.
  <info>int    </info>  <strong>$flags   </strong>  Flags to set for the new function or method.
  <info>int    </info>  <strong>$all     </strong>  Whether all classes that descend from <strong>$class</strong> will also be affected.

<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>uopz_del_function()</strong>
   * <strong>uopz_set_return()</strong>


id: uopz_allow_exit
type: function
doc:
<comment>Description:</comment>
  Allows control over disabled exit opcode
  
  By default uopz disables the exit opcode, so <strong>exit()</strong> calls are practically ignored.
  <strong>uopz_allow_exit()</strong> allows to control this behavior.

<comment>Param:</comment>
  <info>bool</info>  <strong>$allow</strong>  Whether to allow the execution of exit opcodes or not.

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

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


id: uopz_backup
type: function
doc:
<comment>Description:</comment>
  Backup a function
  
  Backup a function at runtime, to be restored on shutdown

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function to backup
  <info>string</info>  <strong>$function</strong>  The name of the function

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


id: uopz_compose
type: function
doc:
<comment>Description:</comment>
  Compose a class
  
  Creates a new class of the given name that implements, extends, or uses all of the provided
  classes

<comment>Param:</comment>
  <info>string</info>  <strong>$name      </strong>  A legal class name
  <info>array </info>  <strong>$classes   </strong>  An array of class, interface and trait names
  <info>array </info>  <strong>$methods   </strong>  An associative array of methods, values are either closures or [modifiers
                       =&gt; closure]
  <info>array </info>  <strong>$properties</strong>  An associative array of properties, keys are names, values are modifiers
  <info>int   </info>  <strong>$flags     </strong>  Entry type, by default ZEND_ACC_CLASS

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


id: uopz_copy
type: function
doc:
<comment>Description:</comment>
  Copy a function
  
  Copy a function by name

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function to copy
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>Closure</info>  A Closure for the specified function


id: uopz_del_function
type: function
doc:
<comment>Description:</comment>
  Deletes previously added function or method
  
  Deletes a previously added function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>int   </info>  <strong>$all     </strong>  Whether all classes that descend from <strong>$class</strong> will also be affected.

<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>uopz_add_function()</strong>
   * <strong>uopz_unset_return()</strong>


id: uopz_delete
type: function
doc:
<comment>Description:</comment>
  Delete a function
  
  Deletes a function or method

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  
  <info>string</info>  <strong>$function</strong>  

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


id: uopz_extend
type: function
doc:
<comment>Description:</comment>
  Extend a class at runtime
  
  Makes <strong>$class</strong> extend <strong>$parent</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class </strong>  The name of the class to extend
  <info>string</info>  <strong>$parent</strong>  The name of the class to inherit

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


id: uopz_flags
type: function
doc:
<comment>Description:</comment>
  Get or set flags on function or class
  
  Get or set the flags on a class or function entry at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of a class
  <info>string</info>  <strong>$function</strong>  The name of the function. If <strong>$class</strong> is given and an empty string is passed as
                     <strong>$function</strong>, <strong>uopz_flags()</strong> gets or sets the flags of the class entry.
  <info>int   </info>  <strong>$flags   </strong>  A valid set of ZEND_ACC_ flags. If omitted, <strong>uopz_flags()</strong> acts as getter.

<comment>Return:</comment>
  <info>int</info>  If setting, returns old flags, else returns flags


id: uopz_function
type: function
doc:
<comment>Description:</comment>
  Creates a function at runtime
  
  Creates a function at runtime

<comment>Param:</comment>
  <info>string </info>  <strong>$class    </strong>  The name of the class to receive the new function
  <info>string </info>  <strong>$function </strong>  The name of the function
  <info>Closure</info>  <strong>$handler  </strong>  The Closure for the function
  <info>int    </info>  <strong>$modifiers</strong>  The modifiers for the function, by default copied or ZEND_ACC_PUBLIC

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


id: uopz_get_exit_status
type: function
doc:
<comment>Description:</comment>
  Retrieve the last set exit status
  
  Retrieves the last set exit status, i.e. the value passed to <strong>exit()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  This function returns the last exit status, or <info>null</info> if <strong>exit()</strong> has not been called.

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


id: uopz_get_hook
type: function
doc:
<comment>Description:</comment>
  Gets previously set hook on function or method
  
  Gets the previously set hook on a function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>Closure</info>  Returns the previously set hook on a function or method, or <info>null</info> if no hook has been set.

<comment>See Also:</comment>
   * <strong>uopz_set_hook()</strong>
   * <strong>uopz_unset_hook()</strong>


id: uopz_get_mock
type: function
doc:
<comment>Description:</comment>
  Get the current mock for a class
  
  Returns the current mock for <strong>$class</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the mocked class.

<comment>Return:</comment>
  <info>mixed</info>  Either a string containing the name of the mock, or an object, or <info>null</info> if no mock has been
         set.

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_get_property
type: function
doc:
<comment>Description:</comment>
  Gets value of class or instance property
  
  Gets the value of a static class property, if <strong>$class</strong> is given, or the value of an instance
  property, if <strong>$instance</strong> is given.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>object</info>  <strong>$instance</strong>  The object instance.
  <info>string</info>  <strong>$property</strong>  The name of the property.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the class or instance property, or <info>null</info> if the property is not
         defined.

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


id: uopz_get_return
type: function
doc:
<comment>Description:</comment>
  Gets a previous set return value for a function
  
  Gets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>mixed</info>  The return value or Closure previously set.


id: uopz_get_static
type: function
doc:
<comment>Description:</comment>
  Gets the static variables from function or method scope
  
  Gets the static variables from function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<comment>Return:</comment>
  <info>array</info>  Returns an associative <info>array</info> of variable names mapped to their current values on success,
         or <info>null</info> if the function or method does not exist.

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


id: uopz_implement
type: function
doc:
<comment>Description:</comment>
  Implements an interface at runtime
  
  Makes <strong>$class</strong> implement <strong>$interface</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class    </strong>  
  <info>string</info>  <strong>$interface</strong>  

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


id: uopz_overload
type: function
doc:
<comment>Description:</comment>
  Overload a VM opcode
  
  Overloads the specified <strong>$opcode</strong> with the user defined function

<comment>Param:</comment>
  <info>int     </info>  <strong>$opcode  </strong>  A valid opcode, see constants for details of supported codes
  <info>Callable</info>  <strong>$callable</strong>  

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


id: uopz_redefine
type: function
doc:
<comment>Description:</comment>
  Redefine a constant
  
  Redefines the given <strong>$constant</strong> as <strong>$value</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the constant
  <info>string</info>  <strong>$constant</strong>  The name of the constant
  <info>mixed </info>  <strong>$value   </strong>  The new value for the constant, must be a valid type for a constant variable

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


id: uopz_rename
type: function
doc:
<comment>Description:</comment>
  Rename a function at runtime
  
  Renames <strong>$function</strong> to <strong>$rename</strong>
  
  If both functions exist, this effectively swaps their names

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>string</info>  <strong>$rename  </strong>  The new name for the function

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


id: uopz_restore
type: function
doc:
<comment>Description:</comment>
  Restore a previously backed up function
  
  Restore a previously backed up function

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function to restore
  <info>string</info>  <strong>$function</strong>  The name of the function

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


id: uopz_set_hook
type: function
doc:
<comment>Description:</comment>
  Sets hook to execute when entering a function or method
  
  Sets a hook to execute when entering a function or method.

<comment>Param:</comment>
  <info>string </info>  <strong>$class   </strong>  The name of the class.
  <info>string </info>  <strong>$function</strong>  The name of the function or method.
  <info>Closure</info>  <strong>$hook    </strong>  A closure to execute when entering the function or method.

<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>uopz_get_hook()</strong>
   * <strong>uopz_unset_hook()</strong>


id: uopz_set_mock
type: function
doc:
<comment>Description:</comment>
  Use mock instead of class for new objects
  
  If <strong>$mock</strong> is a string containing the name of a class then it will be instantiated instead of
  <strong>$class</strong>. <strong>$mock</strong> can also be an object.
  
  Only dynamic access to properties and methods will use the <strong>$mock</strong> object. Static access still uses
  the original <strong>$class</strong>. See example below.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the class to be mocked.
  <info>mixed </info>  <strong>$mock </strong>  The mock to use in the form of a string containing the name of the class to use or
                  an object. If a string is passed, it has to be the fully qualified class name. It
                  is recommended to use the ::class magic constant in this case.

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

<comment>See Also:</comment>
   * <strong>uopz_get_mock()</strong>
   * <strong>uopz_unset_mock()</strong>


id: uopz_set_property
type: function
doc:
<comment>Description:</comment>
  Sets value of existing class or instance property
  
  Sets the value of an existing static class property, if <strong>$class</strong> is given, or the value of an
  instance property (regardless whether the instance property already exists), if <strong>$instance</strong> is
  given.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>object</info>  <strong>$instance</strong>  The object instance.
  <info>string</info>  <strong>$property</strong>  The name of the property.
  <info>mixed </info>  <strong>$value   </strong>  The value to assign to the property.

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

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


id: uopz_set_return
type: function
doc:
<comment>Description:</comment>
  Provide a return value for an existing function
  
  Sets the return value of the <strong>$function</strong> to <strong>$value</strong>. If <strong>$value</strong> is a Closure and <strong>$execute</strong> is set, the
  Closure will be executed in place of the original function. It is possible to call the original
  function from the Closure.
  
  This function replaces uopz_rename.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of an existing function
  <info>mixed </info>  <strong>$value   </strong>  The value the function should return. If a Closure is provided and the execute
                     flag is set, the Closure will be executed in place of the original function.
  <info>bool  </info>  <strong>$execute </strong>  If true, and a Closure was provided as the value, the Closure will be executed
                     in place of the original function.

<comment>Return:</comment>
  <info>bool</info>  True if succeeded, false otherwise.


id: uopz_set_static
type: function
doc:
<comment>Description:</comment>
  Sets the static variables in function or method scope
  
  Sets the static variables in function or method scope.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.
  <info>array </info>  <strong>$static  </strong>  The associative <info>array</info> of variable names mapped to their values.

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

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


id: uopz_undefine
type: function
doc:
<comment>Description:</comment>
  Undefine a constant
  
  Removes the constant at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing <strong>$constant</strong>
  <info>string</info>  <strong>$constant</strong>  The name of an existing constant

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


id: uopz_unset_hook
type: function
doc:
<comment>Description:</comment>
  Removes previously set hook on function or method
  
  Removes the previously set hook on a function or method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class.
  <info>string</info>  <strong>$function</strong>  The name of the function or method.

<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>uopz_set_hook()</strong>
   * <strong>uopz_get_hook()</strong>


id: uopz_unset_mock
type: function
doc:
<comment>Description:</comment>
  Unset previously set mock
  
  Unsets the previously set mock for <strong>$class</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the mocked class.

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

<comment>See Also:</comment>
   * <strong>uopz_set_mock()</strong>
   * <strong>uopz_get_mock()</strong>


id: uopz_unset_return
type: function
doc:
<comment>Description:</comment>
  Unsets a previously set return value for a function
  
  Unsets the return value of the <strong>$function</strong> previously set by uopz_set_return.

<comment>Param:</comment>
  <info>string</info>  <strong>$class   </strong>  The name of the class containing the function
  <info>string</info>  <strong>$function</strong>  The name of the function

<comment>Return:</comment>
  <info>bool</info>  True on success


id: urldecode
type: function
doc:
<comment>Description:</comment>
  Decodes URL-encoded string
  
  Decodes any <return>%##</return> encoding in the given string. Plus symbols ('<return>+</return>') are decoded to a space character.

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

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

<comment>See Also:</comment>
   * <strong>urlencode()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: urlencode
type: function
doc:
<comment>Description:</comment>
  URL-encodes string
  
  This function is convenient when encoding a string to be used in a query part of a URL, as a
  convenient way to pass variables to the next page.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The string to be encoded.

<comment>Return:</comment>
  <info>string</info>  Returns a string in which all non-alphanumeric characters except <return>-_.</return> have been replaced
          with a percent (<return>%</return>) sign followed by two hex digits and spaces encoded as plus (<return>+</return>) signs.
          It is encoded the same way that the posted data from a WWW form is encoded, that is the
          same way as in <return>application/x-www-form-urlencoded</return> media type. This differs from the RFC
          3986 encoding (see <strong>rawurlencode()</strong>) in that for historical reasons, spaces are encoded as
          plus (+) signs.

<comment>See Also:</comment>
   * <strong>urldecode()</strong>
   * <strong>htmlentities()</strong>
   * <strong>rawurlencode()</strong>
   * <strong>rawurldecode()</strong>
   * RFC 3986


id: use_soap_error_handler
type: function
doc:
<comment>Description:</comment>
  Set whether to use the SOAP error handler
  
  This function sets whether or not to use the SOAP error handler in the SOAP server.  It will
  return the previous value. If set to <info>true</info>, details of errors in a <class>SoapServer</class> application will be
  sent to the client as a SOAP fault message. If <info>false</info>, the standard PHP error handler is used. The
  default is to send error to the client as SOAP fault message.

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  Set to <info>true</info> to send error details to clients.

<comment>Return:</comment>
  <info>bool</info>  Returns the original value.

<comment>See Also:</comment>
   * <strong>set_error_handler()</strong>
   * <strong>set_exception_handler()</strong>


id: user_error
type: function
doc:
<comment>Description:</comment>
  Genera un messaggio di errore/avviso/avvertimento a livello utente


id: usleep
type: function
doc:
<comment>Description:</comment>
  Ritarda l'esecuzione in micro-secondi
  
  Mette in pausa l'esecuzione del programma per il numero indicato di micro-secondi.

<comment>Param:</comment>
  <info>int</info>  <strong>$micro_seconds</strong>  Tempo di pausa in micro-secondi. Un micro-secondo è un milionesimo di
                       secondo.

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

<comment>See Also:</comment>
   * <strong>sleep()</strong>
   * <strong>time_nanosleep()</strong>
   * <strong>time_sleep_until()</strong>
   * <strong>set_time_limit()</strong>


id: utf8_decode
type: function
doc:
<comment>Description:</comment>
  Converte una stringa con caratteri ISO-8859-1 codificati con UTF-8
     in formato ISO-8859-1 singolo byte
    
  
  Questa funzione decodifica <strong>$data</strong>, assumendo che sia codificato in <return>UTF-8</return>, in <return>ISO-8859-1</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Una stringa codificata in UTF-8.

<comment>Return:</comment>
  <info>string</info>  Restituisce la traduzione ISO-8859-1 di <strong>$data</strong>.

<comment>See Also:</comment>
   * <strong>utf8_encode()</strong> (contiene una spiegazione della codifica UTF-8)


id: utf8_encode
type: function
doc:
<comment>Description:</comment>
  Codifica una stringa da ISO-8859-1 a UTF-8
  
  Questa funzione converte la stringa <strong>$data</strong> al formato <return>UTF-8</return>, e restituisce la versione codificata.
  <return>UTF-8</return> è il meccanismo standard utilizzato da  Unicode per la codifica dei valori wide character in
  un flusso di byte. La codifica <return>UTF-8</return> è trasparente ai caratteri ASCII, è auto-sincronizzata (per
  un programma è possibile determinare dove iniziano i caratteri in un flusso di dati) e può essere
  usata nelle normali funzioni di confronto di stringhe per i sort e simili. Il PHP codifica i
  caratteri <return>UTF-8</return> fino a quattro byte come segue: Codifica
  UTF-8bytebitrappresentazione170bbbbbbb211110bbbbb 10bbbbbb3161110bbbb 10bbbbbb 10bbbbbb42111110bbb
  10bbbbbb 10bbbbbb 10bbbbbb Ciascuna b rappresenta un bit che può essere utilizzato per memorizzare
  le informazioni del carattere.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Una stringa ISO-8859-1.

<comment>Return:</comment>
  <info>string</info>  Restituisce la traduzione UTF-8 di <strong>$data</strong>.

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


id: var_dump
type: function
doc:
<comment>Description:</comment>
  Stampa delle informazioni relative ad una variabile
  
  Questa funzione visualizza delle informazioni strutturate riguardanti una espressione,  tra cui il
  suo tipo e il suo valore. Gli array e gli oggetti sono attraversati in maniera  ricorsiva e i
  valori indentati per evidenziare la struttura.
  
  Tutte le proprietà pubbliche, private e protette degli oggetti saranno restituite nell'output
  almeno che l'oggetto non implementi un metodo __debugInfo() (implementato in PHP 5.6.0).
  
  Come con qualsiasi cosa che invia
  il risultato direttamente al browser, è possibile utilizzare la
  funzione output-control per catturare
  l'uscita di questa funzione e salvarla - per esempio - in una 
  <info>stringa</info> (per esempio).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$expression</strong>  La variabile che si desidera visualizzare.

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

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>debug_zval_dump()</strong>
   * <strong>var_export()</strong>
   * __debugInfo()


id: var_export
type: function
doc:
<comment>Description:</comment>
  Visualizza o restituisce una variabile in formato stringa
  
  La funzione <strong>var_export()</strong> restituisce informazioni strutturate sulla data variabile. E' simile a
  <strong>var_dump()</strong> con una differenza:  il valore restituito è codice PHP.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$expression</strong>  La variabile che si desidera esportare.
  <info>bool </info>  <strong>$return    </strong>  Se utilizzato ed impostato a <info>true</info>, la funzione <strong>var_export()</strong> restituisce la
                      rappresentazione della variabile anzichè visualizzarla.

<comment>Return:</comment>
  <info>mixed</info>  Restituisce la rappresentazione della variabile quando il parametro  <strong>$return</strong> viene
         utilizzato ed impostato a <info>true</info>. Altrimenti la funzione restituisce <info>null</info>.

<comment>See Also:</comment>
   * <strong>print_r()</strong>
   * <strong>serialize()</strong>
   * <strong>var_dump()</strong>


id: variant
type: class
doc:
<comment>Description:</comment>
  The VARIANT is COM's equivalent of the PHP zval; it is a structure that can contain a value with a
  range of different possible types.  The variant class provided by the COM extension allows you to
  have more control over the way that PHP passes values to and from COM.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value   </strong>  Initial value. If omitted, or set to <info>null</info> an VT_EMPTY object is created.
  <info>int  </info>  <strong>$type    </strong>  Specifies the content type of the variant object. Possible values are one of the
                    <info>VT_XXX</info> .
                    
                    PHP can detect parameters passed by reference automatically; they do not even
                    need to be passed as variant objects.
                    
                    Consult the MSDN library for additional information on the VARIANT type.
  <info>int  </info>  <strong>$codepage</strong>  Specifies the codepage that is used to convert strings to unicode.  See the
                    parameter of the same name in the  class for more information.


id: variant_abs
type: function
doc:
<comment>Description:</comment>
  Returns the absolute value of a variant
  
  Returns the absolute value of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the absolute value of <strong>$value</strong>.

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


id: variant_add
type: function
doc:
<comment>Description:</comment>
  "Adds" two variant values together and returns the result
  
  Adds <strong>$left</strong> to <strong>$right</strong> using the following rules (taken from the MSDN library), which correspond to
  those of Visual Basic: Variant Addition RulesIfThenBoth expressions are of the string
  typeConcatenationOne expression is a string type and the other a characterAdditionOne expression
  is numeric and the other is a stringAdditionBoth expressions are numericAdditionEither expression
  is NULLNULL is returnedBoth expressions are emptyInteger subtype is returned

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result.

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


id: variant_and
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise AND operation between two variants
  
  Performs a bitwise AND operation. Note that this is slightly different from a regular AND
  operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant AND RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>null</info><info>false</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>false</info><info>null</info><info>true</info><info>null</info><info>null</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

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


id: variant_cast
type: function
doc:
<comment>Description:</comment>
  Convert a variant into a new variant object of another type
  
  This function makes a copy of <strong>$variant</strong> and then performs a variant cast operation to force the
  copy to have the type given by <strong>$type</strong>.
  
  This function wraps VariantChangeType() in the COM library; consult MSDN for more information.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>int    </info>  <strong>$type   </strong>  <strong>$type</strong> should be one of the <info>VT_XXX</info> constants.

<comment>Return:</comment>
  <info>variant</info>  Returns a variant of given <strong>$type</strong>.

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


id: variant_cat
type: function
doc:
<comment>Description:</comment>
  Concatenates two variant values together and returns the result
  
  Concatenates <strong>$left</strong> with <strong>$right</strong> and returns the result.
  
  This function is notionally equivalent to <strong>$left</strong> <return>.</return> <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of the concatenation.

<comment>See Also:</comment>
   *  for the string
   concatenation operator


id: variant_cmp
type: function
doc:
<comment>Description:</comment>
  Compares two variants
  
  Compares <strong>$left</strong> with <strong>$right</strong>.
  
  This function will only compare scalar values, not arrays or variant records.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left     </strong>  The left operand.
  <info>mixed</info>  <strong>$right    </strong>  The right operand.
  <info>int  </info>  <strong>$locale_id</strong>  A valid Locale Identifier to use when comparing strings (this affects string
                     collation).
  <info>int  </info>  <strong>$flags    </strong>  <strong>$flags</strong> can be one or more of the following values OR'd together, and affects
                     string comparisons: Variant Comparision Flagsvaluemeaning<info>NORM_IGNORECASE</info>Compare
                     case insensitively<info>NORM_IGNORENONSPACE</info>Ignore nonspacing
                     characters<info>NORM_IGNORESYMBOLS</info>Ignore symbols<info>NORM_IGNOREWIDTH</info>Ignore string
                     width<info>NORM_IGNOREKANATYPE</info>Ignore Kana type<info>NORM_IGNOREKASHIDA</info>Ignore Arabic kashida
                     characters

<comment>Return:</comment>
  <info>int</info>  Returns one of the following: Variant Comparision Resultsvaluemeaning<info>VARCMP_LT</info><strong>$left</strong> is less
       than <strong>$right</strong> <info>VARCMP_EQ</info><strong>$left</strong> is equal to <strong>$right</strong> <info>VARCMP_GT</info><strong>$left</strong> is greater than <strong>$right</strong>
       <info>VARCMP_NULL</info>Either <strong>$left</strong>, <strong>$right</strong> or both are <info>null</info>


id: variant_date_from_timestamp
type: function
doc:
<comment>Description:</comment>
  Returns a variant date representation of a Unix timestamp
  
  Converts <strong>$timestamp</strong> from a unix timestamp value into a variant of type <info>VT_DATE</info>.  This allows
  easier interopability between the unix-ish parts of PHP and COM.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  A unix timestamp.

<comment>Return:</comment>
  <info>variant</info>  Returns a <info>VT_DATE</info> variant.

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


id: variant_date_to_timestamp
type: function
doc:
<comment>Description:</comment>
  Converts a variant date/time value to Unix timestamp
  
  Converts <strong>$variant</strong> from a <info>VT_DATE</info> (or similar) value into a Unix timestamp.  This allows easier
  interopability between the Unix-ish parts of PHP and COM.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.

<comment>Return:</comment>
  <info>intnull</info>  Returns a unix timestamp, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>variant_date_from_timestamp()</strong>
   * <strong>date()</strong>
   * <strong>strftime()</strong>


id: variant_div
type: function
doc:
<comment>Description:</comment>
  Returns the result from dividing two variants
  
  Divides <strong>$left</strong> by <strong>$right</strong> and returns the result.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Division RulesIfThenBoth expressions are of the string, date, character, boolean
           typeDouble is returnedOne expression is a string type and the other a characterDivision
           and a double is returnedOne expression is numeric and the other is a stringDivision and a
           double is returned.Both expressions are numericDivision and a double is returnedEither
           expression is NULLNULL is returned<strong>$right</strong> is empty and <strong>$left</strong> is anything but emptyA
           <class>com_exception</class> with code <info>DISP_E_DIVBYZERO</info> is thrown<strong>$left</strong> is empty and <strong>$right</strong> is anything
           but empty.0 as type double is returnedBoth expressions are emptyA <class>com_exception</class> with code
           <info>DISP_E_OVERFLOW</info> is thrown

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


id: variant_eqv
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise equivalence on two variants
  
  Performs a bitwise equivalence on two variants.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  If each bit in <strong>$left</strong> is equal to the corresponding bit in <strong>$right</strong> then <info>true</info> is returned,
           otherwise <info>false</info> is returned.


id: variant_fix
type: function
doc:
<comment>Description:</comment>
  Returns the integer portion of a variant
  
  Gets the integer portion of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  If <strong>$value</strong> is negative, then the first negative integer greater than or equal to the
           variant is returned, otherwise returns the integer portion of the value of <strong>$value</strong>.

<comment>See Also:</comment>
   * <strong>variant_int()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_get_type
type: function
doc:
<comment>Description:</comment>
  Returns the type of a variant object
  
  Returns the type of a variant object.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant object.

<comment>Return:</comment>
  <info>int</info>  This function returns an integer value that indicates the type of <strong>$variant</strong>, which can be an
       instance of ,  or  classes.  The return value can be compared to one of the <info>VT_XXX</info> constants.
       
       The return value for COM and DOTNET objects will usually be <info>VT_DISPATCH</info>; the only reason this
       function works for those classes is because COM and DOTNET are descendants of VARIANT.

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


id: variant_idiv
type: function
doc:
<comment>Description:</comment>
  Converts variants to integers and then returns the result from dividing them
  
  Converts <strong>$left</strong> and <strong>$right</strong> to integer values, and then performs integer division.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Integer Division RulesIfThenBoth expressions are of the string, date, character,
           boolean typeDivision and integer is returnedOne expression is a string type and the other
           a characterDivisionOne expression is numeric and the other is a stringDivisionBoth
           expressions are numericDivisionEither expression is NULLNULL is returnedBoth expressions
           are emptyA <class>com_exception</class> with code <info>DISP_E_DIVBYZERO</info> is thrown

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


id: variant_imp
type: function
doc:
<comment>Description:</comment>
  Performs a bitwise implication on two variants
  
  Performs a bitwise implication operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Implication TableIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>true</info><info>false</info><info>null</info><info>true</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>


id: variant_int
type: function
doc:
<comment>Description:</comment>
  Returns the integer portion of a variant
  
  Gets the integer portion of a variant.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  If <strong>$value</strong> is negative, then the first negative integer greater than or equal to the
           variant is returned, otherwise returns the integer portion of the value of <strong>$value</strong>.

<comment>See Also:</comment>
   * <strong>variant_fix()</strong>
   * <strong>variant_round()</strong>
   * <strong>floor()</strong>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: variant_mod
type: function
doc:
<comment>Description:</comment>
  Divides two variants and returns only the remainder
  
  Divides <strong>$left</strong> by <strong>$right</strong> and returns the remainder.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the remainder of the division.

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_mul
type: function
doc:
<comment>Description:</comment>
  Multiplies the values of the two variants
  
  Multiplies <strong>$left</strong> by <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Multiplication RulesIfThenBoth expressions are of the string, date, character,
           boolean typeMultiplicationOne expression is a string type and the other a
           characterMultiplicationOne expression is numeric and the other is a
           stringMultiplicationBoth expressions are numericMultiplicationEither expression is
           NULLNULL is returnedBoth expressions are emptyEmpty string is returned

<comment>See Also:</comment>
   * <strong>variant_div()</strong>
   * <strong>variant_idiv()</strong>


id: variant_neg
type: function
doc:
<comment>Description:</comment>
  Performs logical negation on a variant
  
  Performs logical negation of <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of the logical negation.


id: variant_not
type: function
doc:
<comment>Description:</comment>
  Performs bitwise not negation on a variant
  
  Performs bitwise not negation on <strong>$value</strong> and returns the result.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The variant.

<comment>Return:</comment>
  <info>variant</info>  Returns the bitwise not negation. If <strong>$value</strong> is <info>null</info>, the result will also be <info>null</info>.


id: variant_or
type: function
doc:
<comment>Description:</comment>
  Performs a logical disjunction on two variants
  
  Performs a bitwise OR operation. Note that this is slightly different from a regular OR operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant OR RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>true</info><info>true</info><info>false</info><info>true</info><info>true</info><info>null</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info><info>true</info><info>true</info><info>null</info><info>false</info><info>null</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_and()</strong>
   * <strong>variant_xor()</strong>


id: variant_pow
type: function
doc:
<comment>Description:</comment>
  Returns the result of performing the power function with two variants
  
  Returns the result of <strong>$left</strong> to the power of <strong>$right</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Returns the result of <strong>$left</strong> to the power of <strong>$right</strong>.

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


id: variant_round
type: function
doc:
<comment>Description:</comment>
  Rounds a variant to the specified number of decimal places
  
  Returns the value of <strong>$value</strong> rounded to <strong>$decimals</strong> decimal places.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value   </strong>  The variant.
  <info>int  </info>  <strong>$decimals</strong>  Number of decimal places.

<comment>Return:</comment>
  <info>variantnull</info>  Returns the rounded value, or <info>null</info> on failure.

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


id: variant_set
type: function
doc:
<comment>Description:</comment>
  Assigns a new value for a variant object
  
  Converts <strong>$value</strong> to a variant and assigns it to the <strong>$variant</strong> object; no new variant object is
  created, and the old value of <strong>$variant</strong> is freed/released.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>mixed  </info>  <strong>$value  </strong>  

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


id: variant_set_type
type: function
doc:
<comment>Description:</comment>
  Convert a variant into another type "in-place"
  
  This function is similar to <strong>variant_cast()</strong> except that the variant is modified "in-place"; no new
  variant is created. The parameters for this function have identical meaning to those of
  <strong>variant_cast()</strong>.

<comment>Param:</comment>
  <info>variant</info>  <strong>$variant</strong>  The variant.
  <info>int    </info>  <strong>$type   </strong>  

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

<comment>See Also:</comment>
   * <strong>variant_cast()</strong>
   * <strong>variant_get_type()</strong>


id: variant_sub
type: function
doc:
<comment>Description:</comment>
  Subtracts the value of the right variant from the left variant value
  
  Subtracts <strong>$right</strong> from <strong>$left</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant Subtraction RulesIfThenBoth expressions are of the string typeSubtractionOne
           expression is a string type and the other a characterSubtractionOne expression is numeric
           and the other is a stringSubtraction.Both expressions are numericSubtractionEither
           expression is NULLNULL is returnedBoth expressions are emptyEmpty string is returned

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


id: variant_xor
type: function
doc:
<comment>Description:</comment>
  Performs a logical exclusion on two variants
  
  Performs a logical exclusion.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$left </strong>  The left operand.
  <info>mixed</info>  <strong>$right</strong>  The right operand.

<comment>Return:</comment>
  <info>variant</info>  Variant XOR RulesIf <strong>$left</strong> isIf <strong>$right</strong> isthen the result
           is<info>true</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>false</info><info>true</info><info>true</info><info>false</info><info>false</info><info>false</info><info>null</info><info>null</info><info>null</info>

<comment>See Also:</comment>
   * <strong>variant_or()</strong>
   * <strong>variant_and()</strong>


id: version_compare
type: function
doc:
<comment>Description:</comment>
  Confronta due stringhe contenenti il numero di versione di "PHP-standardized"


id: virtual
type: function
doc:
<comment>Description:</comment>
  Esegue una sotto-richiesta Apache
  
  <strong>virtual()</strong> è una funzione specifica Apache che è simile a <return>\<!--#include virtual...--&gt;</return> in <return>mod_include</return>. Esegue una sotto-richiesta Apache.  È utile ad includere script CGI o file .shtml, o qualsiasi altra cosa si voglia far caricare ad Apache. Si noti che per uno script CGI, questo deve generare degli header CGI validi. Come minimo ciò significa che deve generare un header <return>Content-Type</return>.
  
  Al fine di eseguire la sotto-richiesta, tutti i buffer vengono chiusi e svuotati verso il browser,
  e anche gli header in attesa vengono inviati.
  
  This function is only supported when PHP
  is installed as an Apache module.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  Il file su cui verrà eseguito il comando virtuale.

<comment>Return:</comment>
  <info>bool</info>  Esegue il comando virtuale in caso di successo, o restituisce <info>false</info> in caso di fallimento.

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


id: wddx_add_vars
type: function
doc:
<comment>Description:</comment>
  Add variables to a WDDX packet with the specified ID
  
  Serializes the passed variables and add the result to the given packet.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  A WDDX packet, returned by <strong>wddx_packet_start()</strong>.
  <info>mixed   </info>  <strong>$var_name </strong>  Can be either a string naming a variable or an array containing strings
                        naming the variables or another array, etc.
  <info>mixed   </info>  <strong>$var_names</strong>  

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


id: wddx_deserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes a WDDX packet
  
  Unserializes a WDDX <strong>$packet</strong>.
  
  Do not pass untrusted user input to <strong>wddx_deserialize()</strong>. Unserialization can result in code being
  loaded and executed due to object instantiation and autoloading, and a malicious user may be able
  to exploit this. Use a safe, standard data interchange format such as JSON (via <strong>json_decode()</strong> and
  <strong>json_encode()</strong>) if you need to pass serialized data to the user.

<comment>Param:</comment>
  <info>string</info>  <strong>$packet</strong>  A WDDX packet, as a string or stream.

<comment>Return:</comment>
  <info>mixed</info>  Returns the deserialized value which can be a string, a number or an array. Note that
         structures are deserialized into associative arrays.


id: wddx_packet_end
type: function
doc:
<comment>Description:</comment>
  Ends a WDDX packet with the specified ID
  
  Ends and returns the given WDDX packet.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  A WDDX packet, returned by <strong>wddx_packet_start()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns the string containing the WDDX packet.


id: wddx_packet_start
type: function
doc:
<comment>Description:</comment>
  Starts a new WDDX packet with structure inside it
  
  Start a new WDDX packet for incremental addition of variables. It automatically creates a
  structure definition inside the packet to contain the variables.

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  An optional comment string.

<comment>Return:</comment>
  <info>resource</info>  Returns a packet ID for use in later functions, or <info>false</info> on error.


id: wddx_serialize_value
type: function
doc:
<comment>Description:</comment>
  Serialize a single value into a WDDX packet
  
  Creates a WDDX packet from a single given value.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$var    </strong>  The value to be serialized
  <info>string</info>  <strong>$comment</strong>  An optional comment string that appears in the packet header.

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


id: wddx_serialize_vars
type: function
doc:
<comment>Description:</comment>
  Serialize variables into a WDDX packet
  
  Creates a WDDX packet with a structure that contains the serialized representation of the passed
  variables.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var_name </strong>  Can be either a string naming a variable or an array containing strings naming
                     the variables or another array, etc.
  <info>mixed</info>  <strong>$var_names</strong>  

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


id: win32_continue_service
type: function
doc:
<comment>Description:</comment>
  Resumes a paused service
  
  Resumes a paused, named service. Requires administrative privileges or  an account with
  appropriate rights set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_create_service
type: function
doc:
<comment>Description:</comment>
  Creates a new service entry in the SCM database
  
  Attempts to add a service into the SCM database. Administrative privileges are required for this
  to succeed.

<comment>Param:</comment>
  <info>array </info>  <strong>$details              </strong>  An array of service details: <strong>$service</strong> The short name of the
                                  service.  This is the name that you will use to control the
                                  service using the <return>net</return> command.  The service must be unique (no two
                                  services can share the same name), and, ideally, should avoid
                                  having spaces in the name. <strong>$display</strong>The display name of the
                                  service.  This is the name that you will see in the Services
                                  Applet. <strong>$description</strong>The long description of the service.  This is
                                  the description that you will see in the Services Applet. <strong>$user</strong>
                                  The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
                                  <strong>$password</strong> The password that corresponds to the <strong>$user</strong>. <strong>$path</strong> The
                                  full path to the executable module that will be launched when the
                                  service is started.  If omitted, the path to the current PHP
                                  process will be used. <strong>$params</strong> Command line parameters to pass to
                                  the service when it starts. If you want to run a PHP script as the
                                  service, then the first parameter should be the full path to the
                                  PHP script that you intend to run. If the script name or path
                                  contains spaces, then wrap the full path to the PHP script with <return>"</return>.
                                  <strong>$load_order</strong> Controls the load_order.  This is not yet fully
                                  supported. <strong>$svc_type</strong> Sets the service type.  If omitted, the
                                  default value is <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change
                                  this unless you know what you're doing. <strong>$start_type</strong> Specifies how
                                  the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up. <strong>$error_control</strong> Informs the SCM what it
                                  should do when it detects a problem with the service.  The default
                                  is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing this value is not yet
                                  fully supported. <strong>$delayed_start</strong> If <strong>$delayed_start</strong> is set to <info>true</info>,
                                  then this will inform the SCM that this service should be started
                                  after other auto-start services are started plus a short delay.
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.  This setting is only
                                  applicable on Windows Vista and Windows Server 2008 or greater.
                                  <strong>$base_priority</strong> To reduce the impact on processor utilisation, it
                                  may be necessary to set a base priority lower than normal.  The
                                  <strong>$base_priority</strong> can be set to one of the constants define in Win32
                                  Base Priority Classes. <strong>$dependencies</strong> To define the dependencies
                                  for your service, it may be necessary to set  this parameter to
                                  the list of the services names in an array. <strong>$recovery_delay</strong> This
                                  parameter defines the delay between the fail and the execution  of
                                  recovery action. The value is in milliseconds.  The default value
                                  is 60000. <strong>$recovery_action_1</strong> The action will be executed on first
                                  failure. The default value is  <info>WIN32_SC_ACTION_NONE</info>.  The
                                  <strong>$recovery_action_1</strong> can be set to one of the constants defined in
                                  Win32 Recovery action. <strong>$recovery_action_2</strong> The action will be
                                  executed on second failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.  The <strong>$recovery_action_2</strong> can be set to one of
                                  the constants defined in Win32 Recovery action. <strong>$recovery_action_3</strong>
                                  The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.  The <strong>$recovery_action_3</strong> can be set to one of
                                  the constants defined in Win32 Recovery action.
                                  <strong>$recovery_reset_period</strong> The failure count will be reset after the
                                  delay defined in the parameter. The delay is expirement in
                                  seconds.  The default value is <return>86400</return>. <strong>$recovery_enabled</strong> Set this
                                  parameter at <info>true</info> to enable the recovery settings, <info>false</info>  to
                                  disable.   The default value is <info>false</info> <strong>$recovery_reboot_msg</strong> Set
                                  this parameter to define the message saved into the Windows Event
                                  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>. <strong>$recovery_command</strong> Set this parameter to
                                  define the command executed when one action is defined on
                                  <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
                                  
                                  The short name of the service.  This is the name that you will use
                                  to control the service using the <return>net</return> command.  The service must be
                                  unique (no two services can share the same name), and, ideally,
                                  should avoid having spaces in the name.
                                  
                                  The display name of the service.  This is the name that you will
                                  see in the Services Applet.
                                  
                                  The long description of the service.  This is the description that
                                  you will see in the Services Applet.
                                  
                                  The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
                                  
                                  The password that corresponds to the <strong>$user</strong>.
                                  
                                  The full path to the executable module that will be launched when
                                  the service is started.  If omitted, the path to the current PHP
                                  process will be used.
                                  
                                  Command line parameters to pass to the service when it starts. If
                                  you want to run a PHP script as the service, then the first
                                  parameter should be the full path to the PHP script that you
                                  intend to run. If the script name or path contains spaces, then
                                  wrap the full path to the PHP script with <return>"</return>.
                                  
                                  Controls the load_order.  This is not yet fully supported.
                                  
                                  Sets the service type.  If omitted, the default value is
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change this unless you know
                                  what you're doing.
                                  
                                  Specifies how the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up.
                                  
                                  Informs the SCM what it should do when it detects a problem with
                                  the service.  The default is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing
                                  this value is not yet fully supported.
                                  
                                  If <strong>$delayed_start</strong> is set to <info>true</info>, then this will inform the SCM
                                  that this service should be started after other auto-start
                                  services are started plus a short delay.
                                  
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  This setting is only applicable on Windows Vista and Windows
                                  Server 2008 or greater.
                                  
                                  To reduce the impact on processor utilisation, it may be necessary
                                  to set a base priority lower than normal.
                                  
                                  The <strong>$base_priority</strong> can be set to one of the constants define in
                                  Win32 Base Priority Classes.
                                  
                                  To define the dependencies for your service, it may be necessary
                                  to set  this parameter to the list of the services names in an
                                  array.
                                  
                                  This parameter defines the delay between the fail and the
                                  execution  of recovery action. The value is in milliseconds.
                                  
                                  The default value is 60000.
                                  
                                  The action will be executed on first failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_1</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The action will be executed on second failure. The default value
                                  is  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_2</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_3</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
                                  
                                  The failure count will be reset after the delay defined in the
                                  parameter. The delay is expirement in seconds.
                                  
                                  The default value is <return>86400</return>.
                                  
                                  Set this parameter at <info>true</info> to enable the recovery settings, <info>false</info>
                                  to disable.
                                  
                                  The default value is <info>false</info>
                                  
                                  Set this parameter to define the message saved into the Windows
                                  Event  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
                                  
                                  Set this parameter to define the command executed when one action
                                  is defined on   <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info>      </info>  <strong>$service              </strong>  The short name of the service.  This is the name that you will use
                                  to control the service using the <return>net</return> command.  The service must be
                                  unique (no two services can share the same name), and, ideally,
                                  should avoid having spaces in the name.
  <info>      </info>  <strong>$display              </strong>  The display name of the service.  This is the name that you will
                                  see in the Services Applet.
  <info>      </info>  <strong>$description          </strong>  The long description of the service.  This is the description that
                                  you will see in the Services Applet.
  <info>      </info>  <strong>$user                 </strong>  The name of the user account under which you want the service to
                                  run.  If omitted, the service will run as the LocalSystem account.
                                  If the username is specified, you must also provide a password.
  <info>      </info>  <strong>$password             </strong>  The password that corresponds to the <strong>$user</strong>.
  <info>      </info>  <strong>$path                 </strong>  The full path to the executable module that will be launched when
                                  the service is started.  If omitted, the path to the current PHP
                                  process will be used.
  <info>      </info>  <strong>$params               </strong>  Command line parameters to pass to the service when it starts. If
                                  you want to run a PHP script as the service, then the first
                                  parameter should be the full path to the PHP script that you
                                  intend to run. If the script name or path contains spaces, then
                                  wrap the full path to the PHP script with <return>"</return>.
  <info>      </info>  <strong>$load_order           </strong>  Controls the load_order.  This is not yet fully supported.
  <info>      </info>  <strong>$svc_type             </strong>  Sets the service type.  If omitted, the default value is
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Don't change this unless you know
                                  what you're doing.
  <info>      </info>  <strong>$start_type           </strong>  Specifies how the service should be started.  The default is
                                  <info>WIN32_SERVICE_AUTO_START</info> which means the service will be launched
                                  when the machine starts up.
  <info>      </info>  <strong>$error_control        </strong>  Informs the SCM what it should do when it detects a problem with
                                  the service.  The default is <info>WIN32_SERVER_ERROR_IGNORE</info>.  Changing
                                  this value is not yet fully supported.
  <info>      </info>  <strong>$delayed_start        </strong>  If <strong>$delayed_start</strong> is set to <info>true</info>, then this will inform the SCM
                                  that this service should be started after other auto-start
                                  services are started plus a short delay.
                                  
                                  Any service can be marked as a delayed auto-start service;
                                  however, this setting has no effect unless the service's
                                  <strong>$start_type</strong> is <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  This setting is only applicable on Windows Vista and Windows
                                  Server 2008 or greater.
  <info>      </info>  <strong>$base_priority        </strong>  To reduce the impact on processor utilisation, it may be necessary
                                  to set a base priority lower than normal.
                                  
                                  The <strong>$base_priority</strong> can be set to one of the constants define in
                                  Win32 Base Priority Classes.
  <info>      </info>  <strong>$dependencies         </strong>  To define the dependencies for your service, it may be necessary
                                  to set  this parameter to the list of the services names in an
                                  array.
  <info>      </info>  <strong>$recovery_delay       </strong>  This parameter defines the delay between the fail and the
                                  execution  of recovery action. The value is in milliseconds.
                                  
                                  The default value is 60000.
  <info>      </info>  <strong>$recovery_action_1    </strong>  The action will be executed on first failure. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_1</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info>      </info>  <strong>$recovery_action_2    </strong>  The action will be executed on second failure. The default value
                                  is  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_2</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info>      </info>  <strong>$recovery_action_3    </strong>  The action will be executed on next failures. The default value is
                                  <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  The <strong>$recovery_action_3</strong> can be set to one of the constants defined
                                  in Win32 Recovery action.
  <info>      </info>  <strong>$recovery_reset_period</strong>  The failure count will be reset after the delay defined in the
                                  parameter. The delay is expirement in seconds.
                                  
                                  The default value is <return>86400</return>.
  <info>      </info>  <strong>$recovery_enabled     </strong>  Set this parameter at <info>true</info> to enable the recovery settings, <info>false</info>
                                  to disable.
                                  
                                  The default value is <info>false</info>
  <info>      </info>  <strong>$recovery_reboot_msg  </strong>  Set this parameter to define the message saved into the Windows
                                  Event  Log before the reboot. Used only if one action is set to
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
  <info>      </info>  <strong>$recovery_command     </strong>  Set this parameter to define the command executed when one action
                                  is defined on   <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info>string</info>  <strong>$machine              </strong>  The optional machine name on which you want to create a service.
                                  If omitted, it will use the local machine.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_delete_service()</strong>
   * Win32 Base Priority Classes
   * Win32 Recovery action
   * Win32 Error Codes


id: win32_delete_service
type: function
doc:
<comment>Description:</comment>
  Deletes a service entry from the SCM database
  
  Attempts to delete a service from the SCM database.  Administrative privileges are required for
  this to succeed.
  
  This function really just marks the service for deletion.  If other processes (such as the
  Services Applet) are open, then the deletion will be deferred until those applications are closed.
  If a service is marked for deletion, further attempts to delete it will fail, and attempts to
  create a new service with that name will also fail.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  The optional machine name.  If omitted, the local machine will be used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_create_service()</strong>
   * Win32 Error Codes


id: win32_get_last_control_message
type: function
doc:
<comment>Description:</comment>
  Returns the last control message that was sent to this service
  
  Returns the control code that was last sent to this service process. When running as a service you
  should periodically check this to determine if your service needs to stop running.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Return:</comment>
  <info>int</info>  Returns a control constant which will be one of the Win32Service Service Control Message
       Constants: <info>WIN32_SERVICE_CONTROL_CONTINUE</info>, <info>WIN32_SERVICE_CONTROL_DEVICEEVENT</info>,
       <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>, <info>WIN32_SERVICE_CONTROL_INTERROGATE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>, <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
       <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>, <info>WIN32_SERVICE_CONTROL_PAUSE</info>,
       <info>WIN32_SERVICE_CONTROL_POWEREVENT</info>, <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info>, <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_STOP</info>.
       
       If the value is between 128 and 255, the control code is custom.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service Service Control Message Constants


id: win32_pause_service
type: function
doc:
<comment>Description:</comment>
  Pauses a service
  
  Pauses a named service. Requires administrative privileges or an account with appropriate rights
  set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_query_service_status
type: function
doc:
<comment>Description:</comment>
  Queries the status of a service
  
  Queries the current status for a service, returning an array of information.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  The optional machine name.  If omitted, the local machine will be used.

<comment>Return:</comment>
  <info>array</info>  Returns an array consisting of the following information on success
         
         Prior version 1.0.0, <info>false</info> if there is a problem with the parameters or a Win32 Error Code
         on failure.
         
         <strong>$ServiceType</strong> The dwServiceType. See Win32Service Service Type Bitmasks. <strong>$CurrentState</strong> The
         dwCurrentState. See Win32Service Service Status Constants. <strong>$ControlsAccepted</strong> Which service
         controls are accepted by the service. See Win32Service Service Control Message Accepted
         Bitmasks. <strong>$Win32ExitCode</strong> If the service exited, the return code from the process. This
         value is equal to  <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info>  if the exit mode is not gracefuly.
         See  Win32Service error codes and  <strong>win32_set_service_exit_mode()</strong> <strong>$ServiceSpecificExitCode</strong>
         If the service exited with an error condition, the service specific code that is logged in
         the event log is visible here. This value is equal  to the value defined by
         <strong>win32_set_service_exit_code()</strong> <strong>$CheckPoint</strong> If the service is shutting down, holds the
         current check point number. This is used by the SCM as a kind of heart-beat to detect a
         wedged service process.  The value of the check point is best interpreted in conjunction
         with the WaitHint value. <strong>$WaitHint</strong> If the service is shutting down it will set WaitHint to
         a checkpoint value that will indicate 100% completion.  This can be used to implement a
         progress indicator. <strong>$ProcessId</strong> The Windows process identifier. If 0, the process is not
         running. <strong>$ServiceFlags</strong> The dwServiceFlags. See Win32Service Service Service Flag Constants.
         
         The dwServiceType. See Win32Service Service Type Bitmasks.
         
         The dwCurrentState. See Win32Service Service Status Constants.
         
         Which service controls are accepted by the service. See Win32Service Service Control
         Message Accepted Bitmasks.
         
         If the service exited, the return code from the process. This value is equal to
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info>  if the exit mode is not gracefuly. See  Win32Service
         error codes and  <strong>win32_set_service_exit_mode()</strong>
         
         If the service exited with an error condition, the service specific code that is logged in
         the event log is visible here. This value is equal  to the value defined by
         <strong>win32_set_service_exit_code()</strong>
         
         If the service is shutting down, holds the current check point number. This is used by the
         SCM as a kind of heart-beat to detect a wedged service process.  The value of the check
         point is best interpreted in conjunction with the WaitHint value.
         
         If the service is shutting down it will set WaitHint to a checkpoint value that will
         indicate 100% completion.  This can be used to implement a progress indicator.
         
         The Windows process identifier. If 0, the process is not running.
         
         The dwServiceFlags. See Win32Service Service Service Flag Constants.

<comment>See Also:</comment>
   * Win32Service Predefined Constants


id: win32_send_custom_control
type: function
doc:
<comment>Description:</comment>
  Send a custom control to the service
  
  See Microsoft ControlService function for more details

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>int   </info>  <strong>$control    </strong>  The custom contole value between 128 and 255.
  <info>string</info>  <strong>$machine    </strong>  Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * Win32 Error Codes


id: win32_set_service_exit_code
type: function
doc:
<comment>Description:</comment>
  Define or return the exit code for the current running service
  
  Change or return the exit code. The exit code is used only if the exit mode is not graceful.  If
  the value is not zero, the recovery configuration can be used after  service fail. See  Microsoft
  system error codes  for more details
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>int</info>  <strong>$exitCode</strong>  The return code used on exit.

<comment>Return:</comment>
  <info>int</info>  Return the current or old exit code.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>


id: win32_set_service_exit_mode
type: function
doc:
<comment>Description:</comment>
  Define or return the exit mode for the current running service
  
  If <strong>$gracefulMode</strong> parameter is provided, the exit mode 
  is changed. When the exit mode is not gracefuly, the exit code used can be set 
  with the <strong>win32_set_service_exit_code()</strong> function.
  
  This function work only in "cli" SAPI. On other SAPI  this function is disabled.

<comment>Param:</comment>
  <info>bool</info>  <strong>$gracefulMode</strong>  <info>true</info> for exit graceful. <info>false</info> for exit with error.

<comment>Return:</comment>
  <info>bool</info>  Return the current or old exit mode.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_code()</strong>


id: win32_set_service_status
type: function
doc:
<comment>Description:</comment>
  Update the service status
  
  Informs the SCM of the current status of a running service. This call is only valid for a running
  service process.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Param:</comment>
  <info>int</info>  <strong>$status    </strong>  The service status code, one of <info>WIN32_SERVICE_RUNNING</info>, <info>WIN32_SERVICE_STOPPED</info>,
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info>, <info>WIN32_SERVICE_PAUSE_PENDING</info>,
                    <info>WIN32_SERVICE_PAUSED</info>.
  <info>int</info>  <strong>$checkpoint</strong>  The checkpoint value the service increments periodically to report its progress
                    during a lengthy start, stop, pause, or continue operation. For example, the
                    service should increment this value as it completes each step of its
                    initialization when it is starting up.
                    
                    The <strong>$checkpoint</strong> is only valid when the <strong>$status</strong> is one of
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info> or <info>WIN32_SERVICE_PAUSE_PENDING</info>.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32Service Service Status Constants


id: win32_start_service
type: function
doc:
<comment>Description:</comment>
  Starts a service
  
  Attempts to start the named service. Requires administrative privileges or  an account with
  appropriate rights set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: win32_start_service_ctrl_dispatcher
type: function
doc:
<comment>Description:</comment>
  Registers the script with the SCM, so that it can act as the service with the given name
  
  When launched via the Service Control Manager, a service process is required to "check-in" with it
  to establish service monitoring and communication facilities.  This function performs the check-in
  by spawning a thread to handle the lower-level communication with the service control manager.
  
  Once started, the service process should do 2 things. The first is to tell the Service Control
  Manager that the service is running. This is achieved by calling <strong>win32_set_service_status()</strong> with
  the <info>WIN32_SERVICE_RUNNING</info> constant. If you need to perform some lengthy process before the service
  is actually running, then you can use the <info>WIN32_SERVICE_START_PENDING</info> constant. The second is to
  continue to check-in with the service control manager so that it can determine if it should
  terminate. This is achieved by periodically calling <strong>win32_get_last_control_message()</strong> and handling
  the return code appropriately.
  
  Since version 0.2.0, this function work only in "cli" SAPI. On other SAPI  this function is
  disabled.

<comment>Param:</comment>
  <info>string</info>  <strong>$name        </strong>  The short-name of the service, as registered by <strong>win32_create_service()</strong>.
  <info>bool  </info>  <strong>$gracefulMode</strong>  <info>true</info> for exit graceful. <info>false</info> for exit with error. See
                         <strong>win32_set_service_exit_mode()</strong> for more details.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Win32 Error Codes


id: win32_stop_service
type: function
doc:
<comment>Description:</comment>
  Stops a service
  
  Stops a named service. Requires administrative privileges or an account with appropriate rights
  set in the service's ACL.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  The short name of the service.
  <info>string</info>  <strong>$machine    </strong>  Optional machine name.  If omitted, the local machine is used.

<comment>Return:</comment>
  <info>void</info>  Nessun valore viene restituito.
        
        Prior to version 1.0.0, returned <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem with
        the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Win32 Error Codes


id: wincache_fcache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the file cache
    
  
  Retrieves information about file cache content and its usage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the file cache summary.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about file cache  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements:
              <return>total_cache_uptime</return> - total time in seconds that the file cache has been active
              <return>total_file_count</return> - total number of files that are currently in the file cache
              <return>total_hit_count</return> - number of times the files have been served from the file cache
              <return>total_miss_count</return> - number of times the files have not been found in the file cache
              <return>file_entries</return> - an array that contains the information about all the cached files:
              <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since the
              file has been added to the file cache <return>use_time</return> - time in seconds since the file has
              been accessed in the file cache <return>last_check</return> - time in seconds since the file has been
              checked for modifications <return>hit_count</return> - number of times the file has been served from
              the cache <return>file_size</return> - size of the cached file in bytes
              
              <return>total_cache_uptime</return> - total time in seconds that the file cache has been active
              
              <return>total_file_count</return> - total number of files that are currently in the file cache
              
              <return>total_hit_count</return> - number of times the files have been served from the file cache
              
              <return>total_miss_count</return> - number of times the files have not been found in the file cache
              
              <return>file_entries</return> - an array that contains the information about all the cached files:
              <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since the
              file has been added to the file cache <return>use_time</return> - time in seconds since the file has
              been accessed in the file cache <return>last_check</return> - time in seconds since the file has been
              checked for modifications <return>hit_count</return> - number of times the file has been served from
              the cache <return>file_size</return> - size of the cached file in bytes
              
              <return>file_name</return> - absolute file name of the cached file
              
              <return>add_time</return> - time in seconds since the file has been added to the file cache
              
              <return>use_time</return> - time in seconds since the file has been accessed in the file cache
              
              <return>last_check</return> - time in seconds since the file has been checked for modifications
              
              <return>hit_count</return> - number of times the file has been served from the cache
              
              <return>file_size</return> - size of the cached file in bytes

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_fcache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about file cache memory usage
    
  
  Retrieves information about memory usage by file cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about file cache memory usage  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements: <return>memory_total</return> -
              amount of memory in bytes allocated for the file cache <return>memory_free</return> - amount of free
              memory in bytes available for the file cache <return>num_used_blks</return> - number of memory blocks
              used by the file cache <return>num_free_blks</return> - number of free memory blocks available for the
              file cache <return>memory_overhead</return> - amount of memory in bytes used for the file cache
              internal structures
              
              <return>memory_total</return> - amount of memory in bytes allocated for the file cache
              
              <return>memory_free</return> - amount of free memory in bytes available for the file cache
              
              <return>num_used_blks</return> - number of memory blocks used by the file cache
              
              <return>num_free_blks</return> - number of free memory blocks available for the file cache
              
              <return>memory_overhead</return> - amount of memory in bytes used for the file cache internal
              structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_lock
type: function
doc:
<comment>Description:</comment>
  Acquires an exclusive lock on a given key
    
  
  Obtains an exclusive lock on a given key. The execution of the current script will be blocked
  until the  lock can be obtained. Once the lock is obtained, the other scripts that try to request
  the lock by using the same  key will be blocked, until the current script releases the lock by
  using <strong>wincache_unlock()</strong>.
  
  Using of the <strong>wincache_lock()</strong> and <strong>wincache_unlock()</strong> can cause deadlocks when  executing PHP scripts
  in a multi-process environment like FastCGI. Do not use these functions unless you are  absolutely
  sure you need to use them. For the majority of the operations on the user cache it is not
  necessary to use these functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key     </strong>  Name of the key in the cache to get the lock on.
  <info>bool  </info>  <strong>$isglobal</strong>  Controls whether the scope of the lock is system-wide or local. Local locks are
                     scoped to the application pool  in IIS FastCGI case or to all php processes
                     that have the same parent process identifier.

<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>wincache_unlock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ocache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the opcode cache
    
  
  Retrieves information about opcode cache content and its usage.
  
  This function was
  REMOVED in PHP 7.0.0.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the opcode cache summary.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about opcode cache  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements:
              <return>total_cache_uptime</return> - total time in seconds that the opcode cache has been active
              <return>total_file_count</return> - total number of files that are currently in the opcode cache
              <return>total_hit_count</return> - number of times the compiled opcode have been served from the cache
              <return>total_miss_count</return> - number of times the compiled opcode have not been found in the
              cache <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,
              false if the metadata is for the global cache <return>file_entries</return> - an array that contains
              the information about all the cached files: <return>file_name</return> - absolute file name of the
              cached file <return>add_time</return> - time in seconds since the file has been added to the opcode
              cache <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
              <return>last_check</return> - time in seconds since the file has been checked for modifications
              <return>hit_count</return> - number of times the file has been served from the cache <return>function_count</return> -
              number of functions in the cached file <return>class_count</return> - number of classes in the cached
              file
              
              <return>total_cache_uptime</return> - total time in seconds that the opcode cache has been active
              
              <return>total_file_count</return> - total number of files that are currently in the opcode cache
              
              <return>total_hit_count</return> - number of times the compiled opcode have been served from the cache
              
              <return>total_miss_count</return> - number of times the compiled opcode have not been found in the
              cache
              
              <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
              the metadata is for the global cache
              
              <return>file_entries</return> - an array that contains the information about all the cached files:
              <return>file_name</return> - absolute file name of the cached file <return>add_time</return> - time in seconds since the
              file has been added to the opcode cache <return>use_time</return> - time in seconds since the file has
              been accessed in the opcode cache <return>last_check</return> - time in seconds since the file has been
              checked for modifications <return>hit_count</return> - number of times the file has been served from
              the cache <return>function_count</return> - number of functions in the cached file <return>class_count</return> - number
              of classes in the cached file
              
              <return>file_name</return> - absolute file name of the cached file
              
              <return>add_time</return> - time in seconds since the file has been added to the opcode cache
              
              <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
              
              <return>last_check</return> - time in seconds since the file has been checked for modifications
              
              <return>hit_count</return> - number of times the file has been served from the cache
              
              <return>function_count</return> - number of functions in the cached file
              
              <return>class_count</return> - number of classes in the cached file

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ocache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about opcode cache memory usage
    
  
  Retrieves information about memory usage by opcode cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about opcode cache memory usage  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements: <return>memory_total</return> -
              amount of memory in bytes allocated for the opcode cache <return>memory_free</return> - amount of free
              memory in bytes available for the opcode cache <return>num_used_blks</return> - number of memory blocks
              used by the opcode cache <return>num_free_blks</return> - number of free memory blocks available for
              the opcode cache <return>memory_overhead</return> - amount of memory in bytes used for the opcode cache
              internal structures
              
              <return>memory_total</return> - amount of memory in bytes allocated for the opcode cache
              
              <return>memory_free</return> - amount of free memory in bytes available for the opcode cache
              
              <return>num_used_blks</return> - number of memory blocks used by the opcode cache
              
              <return>num_free_blks</return> - number of free memory blocks available for the opcode cache
              
              <return>memory_overhead</return> - amount of memory in bytes used for the opcode cache internal
              structures
              
              This function was
              REMOVED in PHP 7.0.0.

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_refresh_if_changed
type: function
doc:
<comment>Description:</comment>
  Refreshes the cache entries for the cached files
    
  
  Refreshes the cache entries for the files, whose names were passed in the input argument.  If no
  argument is specified then refreshes all the entries in the cache.

<comment>Param:</comment>
  <info>array</info>  <strong>$files</strong>  An array of file names for files that need to be refreshed.  An absolute or
                 relative file paths can be used.

<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>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_rplist_fileinfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about resolve file path cache
    
  
  Retrieves information about cached mappings between relative file paths  and corresponding
  absolute file paths.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about the resolve file path cache  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements: <return>total_file_count</return>
              - total number of file path  mappings stored in the cache <return>rplist_entries</return> - an array
              that contains the information about all  the cached file paths: <return>resolve_path</return> - path to
              a file <return>subkey_data</return> - corresponding absolute path to a file
              
              <return>total_file_count</return> - total number of file path  mappings stored in the cache
              
              <return>rplist_entries</return> - an array that contains the information about all  the cached file
              paths: <return>resolve_path</return> - path to a file <return>subkey_data</return> - corresponding absolute path to a
              file
              
              <return>resolve_path</return> - path to a file
              
              <return>subkey_data</return> - corresponding absolute path to a file

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_rplist_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about memory usage by the resolve file path cache
    
  
  Retrieves information about memory usage by resolve file path cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data that describes memory usage by resolve file path cache.  o <info>false</info> in
              caso di fallimento
              
              The array returned by this function contains the following elements: <return>memory_total</return> -
              amount of memory in bytes allocated for the resolve file path cache <return>memory_free</return> -
              amount of free memory in bytes available for the resolve file path cache <return>num_used_blks</return>
              - number of memory blocks used by the resolve file path cache <return>num_free_blks</return> - number
              of free memory blocks available for the resolve file path cache <return>memory_overhead</return> -
              amount of memory in bytes used for the internal structures of resolve file path cache
              
              <return>memory_total</return> - amount of memory in bytes allocated for the resolve file path cache
              
              <return>memory_free</return> - amount of free memory in bytes available for the resolve file path cache
              
              <return>num_used_blks</return> - number of memory blocks used by the resolve file path cache
              
              <return>num_free_blks</return> - number of free memory blocks available for the resolve file path cache
              
              <return>memory_overhead</return> - amount of memory in bytes used for the internal structures of
              resolve file path cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves information about files cached in the session cache
    
  
  Retrieves information about session cache content and its usage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about individual
                      cache entries  along with the session cache summary.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about session cache  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements:
              <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
              <return>total_item_count</return> - total number of elements that are currently in the session cache
              <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
              the metadata is for the global cache <return>total_hit_count</return> - number of times the data has
              been served from the cache <return>total_miss_count</return> - number of times the data has not been
              found in the cache <return>scache_entries</return> - an array that contains the information about all
              the cached items: <return>key_name</return> - name of the key which is used to store the data
              <return>value_type</return> - type of value stored by the key <return>use_time</return> - time in seconds since the file
              has been accessed in the opcode cache <return>last_check</return> - time in seconds since the file has
              been checked for modifications <return>ttl_seconds</return> - time remaining for the data to live in
              the cache, 0 meaning infinite <return>age_seconds</return> - time elapsed from the time data has been
              added in the cache <return>hitcount</return> - number of times data has been served from the cache
              
              <return>total_cache_uptime</return> - total time in seconds that the session cache has been active
              
              <return>total_item_count</return> - total number of elements that are currently in the session cache
              
              <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
              the metadata is for the global cache
              
              <return>total_hit_count</return> - number of times the data has been served from the cache
              
              <return>total_miss_count</return> - number of times the data has not been found in the cache
              
              <return>scache_entries</return> - an array that contains the information about all the cached items:
              <return>key_name</return> - name of the key which is used to store the data <return>value_type</return> - type of value
              stored by the key <return>use_time</return> - time in seconds since the file has been accessed in the
              opcode cache <return>last_check</return> - time in seconds since the file has been checked for
              modifications <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0
              meaning infinite <return>age_seconds</return> - time elapsed from the time data has been added in the
              cache <return>hitcount</return> - number of times data has been served from the cache
              
              <return>key_name</return> - name of the key which is used to store the data
              
              <return>value_type</return> - type of value stored by the key
              
              <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
              
              <return>last_check</return> - time in seconds since the file has been checked for modifications
              
              <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning infinite
              
              <return>age_seconds</return> - time elapsed from the time data has been added in the cache
              
              <return>hitcount</return> - number of times data has been served from the cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about session cache memory usage
    
  
  Retrieves information about memory usage by session cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about session cache memory usage  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements: <return>memory_total</return> -
              amount of memory in bytes allocated for the session cache <return>memory_free</return> - amount of free
              memory in bytes available for the session cache <return>num_used_blks</return> - number of memory
              blocks used by the session cache <return>num_free_blks</return> - number of free memory blocks
              available for the session cache <return>memory_overhead</return> - amount of memory in bytes used for
              the session cache internal structures
              
              <return>memory_total</return> - amount of memory in bytes allocated for the session cache
              
              <return>memory_free</return> - amount of free memory in bytes available for the session cache
              
              <return>num_used_blks</return> - number of memory blocks used by the session cache
              
              <return>num_free_blks</return> - number of free memory blocks available for the session cache
              
              <return>memory_overhead</return> - amount of memory in bytes used for the session cache internal
              structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ucache_add
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache only if variable does not already exist in the cache
    
  
  Adds a variable in user cache, only if this variable doesn't already exist in the cache.  The
  added variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  Store the variable using this <strong>$key</strong> name. If a variable with same key is already
                   present the function will fail and return <info>false</info>. <strong>$key</strong> is case sensitive. To
                   override the value even if  <strong>$key</strong> is present use <strong>wincache_ucache_set()</strong> function
                   instad.  <strong>$key</strong> can also take array of name =&gt; value pairs where names will be
                   used as keys.  This can be used to add multiple values in the cache in one
                   operation, thus avoiding race condition.
  <info>mixed </info>  <strong>$value </strong>  Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                   such as file handles. This paramter is ignored if first argument is an array. A
                   general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                   is an object, or an array containing objects, then the objects will be
                   serialized. See __sleep() for details on serializing objects.
  <info>array </info>  <strong>$values</strong>  Associative array of keys and values.
  <info>int   </info>  <strong>$ttl   </strong>  Time for the variable to live in the cache in seconds. After the value specified
                   in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                   parameter takes a default value of <return>0</return> which means  the variable will stay in the
                   cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                   <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_ucache_cas
type: function
doc:
<comment>Description:</comment>
  Compares the variable with old value and assigns new value to it
    
  
  Compares the variable associated with the <strong>$key</strong> with <strong>$old_value</strong>  and if it matches then assigns the
  <strong>$new_value</strong> to it.

<comment>Param:</comment>
  <info>string</info>  <strong>$key      </strong>  The <strong>$key</strong> that is used to store the variable in the cache.  <strong>$key</strong> is case
                      sensitive.
  <info>int   </info>  <strong>$old_value</strong>  Old value of the variable pointed by <strong>$key</strong> in the user cache.  The value should
                      be of type <return>long</return>, otherwise the function returns  <info>false</info>.
  <info>int   </info>  <strong>$new_value</strong>  New value which will get assigned to variable pointer by <strong>$key</strong> if a  match is
                      found. The value should be of type <return>long</return>, otherwise  the function returns
                      <info>false</info>.

<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>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_dec()</strong>


id: wincache_ucache_clear
type: function
doc:
<comment>Description:</comment>
  Deletes entire content of the user cache
    
  
  Clears/deletes all the values stored in the user cache.

<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>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_dec
type: function
doc:
<comment>Description:</comment>
  Decrements the value associated with the key
    
  
  Decrements the value associated with the <strong>$key</strong> by 1 or as specified  by <strong>$dec_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                    sensitive.
  <info>int   </info>  <strong>$dec_by </strong>  The value by which the variable associated with the <strong>$key</strong> will get decremented.
                    If the argument is a floating point number it will be truncated to nearest
                    integer. The variable  associated with the <strong>$key</strong> should be of type <return>long</return>,
                    otherwise  the function fails and returns <info>false</info>.
  <info>bool  </info>  <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

<comment>Return:</comment>
  <info>mixed</info>  Returns the decremented value on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_delete
type: function
doc:
<comment>Description:</comment>
  Deletes variables from the user cache
    
  
  Deletes the elements in the user cache pointed by <strong>$key</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case sensitive.
               <strong>$key</strong> can be an  array of keys.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento.
        
        If <strong>$key</strong> is an array then the function returns <info>false</info>  if every element of the array fails to
        get deleted from the user cache, otherwise returns an  array which consists of all the keys
        that are deleted.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_exists
type: function
doc:
<comment>Description:</comment>
  Checks if a variable exists in the user cache
    
  
  Checks if a variable with the <strong>$key</strong> exists in the user cache or not.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case sensitive.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if variable with the <strong>$key</strong> exitsts,  otherwise returns <info>false</info>.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_get
type: function
doc:
<comment>Description:</comment>
  Gets a variable stored in the user cache
    
  
  Gets a variable stored in the user cache.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key    </strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                   sensitive. <strong>$key</strong> can be an  array of keys. In this case the return value will be
                   an array of values of each element  in the <strong>$key</strong> array. If an object, or an array
                   containing objects, is returned, then the objects will be unserialized. See
                   __wakeup() for details on unserializing objects.
  <info>bool </info>  <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

<comment>Return:</comment>
  <info>mixed</info>  If <strong>$key</strong> is a string, the function returns the value of the variable stored with that key.
         The <strong>$success</strong> is set to <info>true</info> on success and  to <info>false</info> on failure.
         
         The <strong>$key</strong> is an array, the parameter <strong>$success</strong>  is always set to <info>true</info>. The returned array
         (name =&gt; value pairs) will  contain only those name =&gt; value pairs for which the get
         operation in user cache was  successful. If none of the keys in the key array finds a match
         in the user cache  an empty array will be returned.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __wakeup()


id: wincache_ucache_inc
type: function
doc:
<comment>Description:</comment>
  Increments the value associated with the key
    
  
  Increments the value associated with the <strong>$key</strong> by 1 or as specified  by <strong>$inc_by</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The <strong>$key</strong> that was used to store the variable in the cache.  <strong>$key</strong> is case
                    sensitive.
  <info>int   </info>  <strong>$inc_by </strong>  The value by which the variable associated with the <strong>$key</strong> will get incremented.
                    If the argument is a floating point number it will be truncated to nearest
                    integer. The variable  associated with the <strong>$key</strong> should be of type <return>long</return>,
                    otherwise  the function fails and returns <info>false</info>.
  <info>bool  </info>  <strong>$success</strong>  Will be set to <info>true</info> on success and <info>false</info> on failure.

<comment>Return:</comment>
  <info>mixed</info>  Returns the incremented value on success and <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>wincache_ucache_dec()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves information about data stored in the user cache
    
  
  Retrieves information about data stored in the user cache.

<comment>Param:</comment>
  <info>bool  </info>  <strong>$summaryonly</strong>  Controls whether the returned array will contain information about
                        individual cache entries  along with the user cache summary.
  <info>string</info>  <strong>$key        </strong>  The key of an entry in the user cache. If specified then the returned array
                        will contain information  only about that cache entry. If not specified and
                        <strong>$summaryonly</strong> is set to  <info>false</info> then the returned array will contain
                        information about all entries in the cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about user cache  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements:
              <return>total_cache_uptime</return> - total time in seconds that the user cache has been active
              <return>total_item_count</return> - total number of elements that are currently in the user cache
              <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
              the metadata is for the global cache <return>total_hit_count</return> - number of times the data has
              been served from the cache <return>total_miss_count</return> - number of times the data has not been
              found in the cache <return>ucache_entries</return> - an array that contains the information about all
              the cached items: <return>key_name</return> - name of the key which is used to store the data
              <return>value_type</return> - type of value stored by the key <return>use_time</return> - time in seconds since the file
              has been accessed in the opcode cache <return>last_check</return> - time in seconds since the file has
              been checked for modifications <return>is_session</return> - indicates if the data is a session
              variable <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning
              infinite <return>age_seconds</return> - time elapsed from the time data has been added in the cache
              <return>hitcount</return> - number of times data has been served from the cache
              
              <return>total_cache_uptime</return> - total time in seconds that the user cache has been active
              
              <return>total_item_count</return> - total number of elements that are currently in the user cache
              
              <return>is_local_cache</return> - true is the cache metadata is for a local cache instance,  false if
              the metadata is for the global cache
              
              <return>total_hit_count</return> - number of times the data has been served from the cache
              
              <return>total_miss_count</return> - number of times the data has not been found in the cache
              
              <return>ucache_entries</return> - an array that contains the information about all the cached items:
              <return>key_name</return> - name of the key which is used to store the data <return>value_type</return> - type of value
              stored by the key <return>use_time</return> - time in seconds since the file has been accessed in the
              opcode cache <return>last_check</return> - time in seconds since the file has been checked for
              modifications <return>is_session</return> - indicates if the data is a session variable <return>ttl_seconds</return> -
              time remaining for the data to live in the cache, 0 meaning infinite <return>age_seconds</return> -
              time elapsed from the time data has been added in the cache <return>hitcount</return> - number of times
              data has been served from the cache
              
              <return>key_name</return> - name of the key which is used to store the data
              
              <return>value_type</return> - type of value stored by the key
              
              <return>use_time</return> - time in seconds since the file has been accessed in the opcode cache
              
              <return>last_check</return> - time in seconds since the file has been checked for modifications
              
              <return>is_session</return> - indicates if the data is a session variable
              
              <return>ttl_seconds</return> - time remaining for the data to live in the cache, 0 meaning infinite
              
              <return>age_seconds</return> - time elapsed from the time data has been added in the cache
              
              <return>hitcount</return> - number of times data has been served from the cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_meminfo
type: function
doc:
<comment>Description:</comment>
  Retrieves information about user cache memory usage
    
  
  Retrieves information about memory usage by user cache.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of meta data about user cache memory usage  o <info>false</info> in caso di fallimento
              
              The array returned by this function contains the following elements: <return>memory_total</return> -
              amount of memory in bytes allocated for the user cache <return>memory_free</return> - amount of free
              memory in bytes available for the user cache <return>num_used_blks</return> - number of memory blocks
              used by the user cache <return>num_free_blks</return> - number of free memory blocks available for the
              user cache <return>memory_overhead</return> - amount of memory in bytes used for the user cache
              internal structures
              
              <return>memory_total</return> - amount of memory in bytes allocated for the user cache
              
              <return>memory_free</return> - amount of free memory in bytes available for the user cache
              
              <return>num_used_blks</return> - number of memory blocks used by the user cache
              
              <return>num_free_blks</return> - number of free memory blocks available for the user cache
              
              <return>memory_overhead</return> - amount of memory in bytes used for the user cache internal
              structures

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_set
type: function
doc:
<comment>Description:</comment>
  Adds a variable in user cache and overwrites a variable if it already exists in the cache
    
  
  Adds a variable in user cache. Overwrites a variable if it already exists in the cache.  The added
  or updated variable remains in the user cache unless its time to live expires or it is  deleted by
  using <strong>wincache_ucache_delete()</strong> or <strong>wincache_ucache_clear()</strong> functions.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key   </strong>  Store the variable using this <strong>$key</strong> name. If a variable with same  <strong>$key</strong> is already
                  present the function will overwrite the previous  value with the new one. <strong>$key</strong> is
                  case sensitive.  <strong>$key</strong> can also take array of name =&gt; value pairs where names
                  will be used as  keys. This can be used to add multiple values in the cache in one
                  operation, thus avoiding  race condition.
  <info>mixed</info>  <strong>$value </strong>  Value of a variable to store. <strong>$Value</strong> supports all data types except resources,
                  such as file handles. This paramter is ignored if first argument is an array. A
                  general guidance is to pass <info>null</info>  as <strong>$value</strong> while using array as <strong>$key</strong>. If <strong>$value</strong>
                  is an object, or an array containing objects, then the objects will be serialized.
                  See __sleep() for details on serializing objects.
  <info>array</info>  <strong>$values</strong>  Associative array of keys and values.
  <info>int  </info>  <strong>$ttl   </strong>  Time for the variable to live in the cache in seconds. After the value specified
                  in <strong>$ttl</strong> has passed  the stored variable will be deleted from the cache. This
                  parameter takes a default value of <return>0</return> which means  the variable will stay in the
                  cache unless explicitly deleted by using <strong>wincache_ucache_delete()</strong>  or
                  <strong>wincache_ucache_clear()</strong> functions.

<comment>Return:</comment>
  <info>bool</info>  If <strong>$key</strong> is string, the function returns <info>true</info> on success and <info>false</info> on failure.
        
        If <strong>$key</strong> is an array, the function returns:  If all the name =&gt; value pairs in the array
        can be set, function returns an empty array;  If all the name =&gt; value pairs in the array
        cannot be set, function returns <info>false</info>;  If some can be set while others cannot, function
        returns an array with name=&gt;value pair for which the addition failed in the user cache.
        
        If all the name =&gt; value pairs in the array can be set, function returns an empty array;
        
        If all the name =&gt; value pairs in the array cannot be set, function returns <info>false</info>;
        
        If some can be set while others cannot, function returns an array with name=&gt;value pair
        for which the addition failed in the user cache.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_unlock
type: function
doc:
<comment>Description:</comment>
  Releases an exclusive lock on a given key
    
  
  Releases an exclusive lock that was obtained on a given key by using <strong>wincache_lock()</strong>.  If any
  other process was blocked waiting for the lock on this key, that process will be able to obtain
  the lock.
  
  Using of the <strong>wincache_lock()</strong> and <strong>wincache_unlock()</strong> can cause deadlocks when  executing PHP scripts
  in a multi-process environment like FastCGI. Do not use these functions unless you are  absolutely
  sure you need to use them. For the majority of the operations on the user cache it is not
  necessary to use these functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Name of the key in the cache to release the lock on.

<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>wincache_lock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wkhtmltox\Image\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Image converter
  
  Creates an Image converter, optionally taking an input buffer and configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer  </strong>  HTML
  <info>array </info>  <strong>$settings</strong>  NameDescriptionValuesChangeloginURL or path of the input file, if "-" stdin is
                     used/path/to/markup.html&gt;= 0.1.0outpath of output file, if "-" stdout is
                     used, by default an internal buffer is used/path/to/output.png&gt;=
                     0.1.0fmtoutput format to use""defaultjpgoutput as JPEGpngoutput as PNGbmpoutput
                     as bitmapsvgoutput as SVG&gt;= 0.1.0transparentwhen outputting a PNG or SVG,
                     make the white background transparentboolean&gt;= 0.1.0screenWidththe with of
                     the screen used to render in pixels800&gt;= 0.1.0smartWidthwhen true,
                     screenWidth is expanded to the content widthboolean&gt;=
                     0.1.0qualitycompression factor to use when outputting a JPEG image94&gt;=
                     0.1.0crop.leftleft/x coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.toptop/y coordinate of the window to capture in pixels200&gt;=
                     0.1.0crop.widthwidth of the window to capture in pixels200&gt;=
                     0.1.0crop.heightheight of the window to capture in pixels200&gt;=
                     0.1.0load.cookieJarpath of file used to load and store
                     cookies/tmp/cookies.txt&gt;= 0.1.0load.usernameuser name to use when loging
                     into a websitebart&gt;= 0.1.0load.passwordthe password to used when logging
                     into a websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds
                     to wait after a page is loaded until it is captured1200&gt;=
                     0.1.0load.zoomFactorhow much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wkhtmltox\Image\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform Image conversion
  
  Performs conversion of the input buffer

<comment>Return:</comment>
  <info>stringnull</info>  Where the return value is used, it will be populated with the contents of the
              conversion buffer


id: wkhtmltox\Image\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Returns a version string
          
          This is not yet implemented by libwkhtmltox


id: wkhtmltox\PDF\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF converter
  
  Creates a PDF converter, using optional configuration settings

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  NameDescriptionValuesChangelogsize.pageSizepaper size of output documentA4&gt;=
                    0.1.0size.widthwith of the output document210mm&gt;= 0.1.0size.heightheight of
                    the output document297mm&gt;= 0.1.0orientationorientation of the output
                    documentLandscapePortrait&gt;= 0.1.0colorModecolor mode of the output
                    documentColorGreyscale&gt;= 0.1.0resolutionresoluition of the output
                    documentmost likely has no effect&gt;= 0.1.0dpidpi to use while printing80&gt;=
                    0.1.0pageOffsetinteger added to page numbers generating headers, footers, and
                    toc&gt;= 0.1.0copies&gt;= 0.1.0collatecollate copiesboolean&gt;=
                    0.1.0outlinegenerate PDF outlineboolean&gt;= 0.1.0outlineDepthmaximum depth of
                    outline&gt;= 0.1.0dumpOutlinepath of file to dump outline XML&gt;= 0.1.0outpath
                    of output file, if "-" stdout is used&gt;= 0.1.0documentTitletitle for the
                    output document&gt;= 0.1.0useCompressionenable or disable lossless
                    compressionboolean&gt;= 0.1.0margin.topsize of the top margin2cm&gt;=
                    0.1.0margin.bottomsize of the bottom margin2cm&gt;= 0.1.0margin.leftsize of the
                    left margin2cm&gt;= 0.1.0margin.rightsize of the right margin2cm&gt;=
                    0.1.0imageDPImaximum DPI for images in the output document&gt;=
                    0.1.0imageQualitythe jpeg compression factor for images in the output
                    document94&gt;= 0.1.0load.cookieJarpath of file used to load and store
                    cookies/tmp/cookies.txt&gt;= 0.1.0


id: wkhtmltox\PDF\Converter::add
type: function
doc:
<comment>Description:</comment>
  Add an object for conversion
  
  Adds the given object to conversion

<comment>Param:</comment>
  <info>wkhtmltox\PDF\Object</info>  <strong>$object</strong>  The object to add

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


id: wkhtmltox\PDF\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Perform PDF conversion
  
  Performs conversion of all previously added Objects

<comment>Return:</comment>
  <info>stringnull</info>  Where the return value is used, it will be populated with the contents of the
              conversion buffer


id: wkhtmltox\PDF\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Determine version of Converter
  
  Determines the version of Converter as reported by libwkhtmltox

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


id: wkhtmltox\PDF\Object::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new PDF Object
  
  Creates a new PDF Object from the given buffer and optional configuration settings

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer  </strong>  HTML
  <info>array </info>  <strong>$settings</strong>  NameDescriptionValuesChangelogpageURL or path of the HTML to convert&gt;=
                     0.1.0useExternalLinksset true to convert external links in the input into
                     external PDF links in the outputboolean&gt;= 0.1.0useLocalLinksset true to
                     convert internal links in the input into internal PDF links in the
                     outputboolean&gt;= 0.1.0produceFormsset true to turn HTML forms into PDF
                     formsboolean&gt;= 0.1.0replacementsundocumented&gt;= 0.1.0includeInOutlineset
                     true to include sections from this object in the outline and tocboolean&gt;=
                     0.1.0pagesCountset true to make page count in toc inclusive of the number of
                     pages in this objectboolean&gt;= 0.1.0tocXslset to style sheet to convert this
                     object into a toc object&gt;= 0.1.0toc.useDottedLinesset true to use dotted
                     lines in tocboolean&gt;= 0.1.0toc.captionTextthe caption text for toc&gt;=
                     0.1.0toc.forwardLinksset true to create links from toc to contentboolean&gt;=
                     0.1.0toc.backLinksset true to create links from content to tocboolean&gt;=
                     0.1.0toc.indentationindentation for toc2em&gt;= 0.1.0toc.fontScalethe factor to
                     scale down the font at every toc level0.8&gt;= 0.1.0header.fontSizefont size
                     for use in header13&gt;= 0.1.0header.fontNamename of font for use in
                     headertimes&gt;= 0.1.0header.lefttext for left of header&gt;=
                     0.1.0header.centertext for center of header&gt;= 0.1.0header.righttext for
                     right of header&gt;= 0.1.0header.lineenable or disable horizontal rule under
                     headerboolean&gt;= 0.1.0header.spacingspace between header and content1.8&gt;=
                     0.1.0header.htmlUrlURL or path of HTML to use in header&gt;=
                     0.1.0footer.fontSizefont size for use in footer13&gt;= 0.1.0footer.fontNamename
                     of font for use in footertimes&gt;= 0.1.0footer.lefttext for left of
                     footer&gt;= 0.1.0footer.centertext for center of footer&gt;=
                     0.1.0footer.righttext for right of footer&gt;= 0.1.0footer.lineenable or
                     disable horizontal rule under footerboolean&gt;= 0.1.0footer.spacingspace
                     between footer and content1.8&gt;= 0.1.0footer.htmlUrlURL or path of HTML to
                     use in footer&gt;= 0.1.0load.usernameuser name to use when loging into a
                     websitebart&gt;= 0.1.0load.passwordthe password to used when logging into a
                     websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds to wait
                     after a page is loaded until it is captured1200&gt;= 0.1.0load.zoomFactorhow
                     much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wordwrap
type: function
doc:
<comment>Description:</comment>
  Divide una stringa ad un certo numero di caratteri utilizzando
       il carattere di divisione


id: xattr_get
type: function
doc:
<comment>Description:</comment>
  Get an extended attribute
    
  
  This function gets the value of an extended attribute of a file.
  
  Gli attributi estesi hanno due namespace differenti: user
  e root. Il namespace user è disponibile per tutti gli utenti mentre il namespace root
  è disponibile solo per gli utenti con privilegi di root. xattr opera sul namespace user
  di default, ma questo si può cambiare utilizzando il parametro 
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file from which we get the attribute.
  <info>string</info>  <strong>$name    </strong>  The name of the attribute.
  <info>int   </info>  <strong>$flags   </strong>  Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the value or <info>false</info> if the attribute doesn't  exist.

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_list
type: function
doc:
<comment>Description:</comment>
  Get a list of extended attributes
    
  
  This functions gets a list of names of extended attributes of a file.
  
  Gli attributi estesi hanno due namespace differenti: user
  e root. Il namespace user è disponibile per tutti gli utenti mentre il namespace root
  è disponibile solo per gli utenti con privilegi di root. xattr opera sul namespace user
  di default, ma questo si può cambiare utilizzando il parametro 
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path of the file.
  <info>int   </info>  <strong>$flags   </strong>  Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<comment>Return:</comment>
  <info>array</info>  This function returns an array with names of extended attributes.

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


id: xattr_remove
type: function
doc:
<comment>Description:</comment>
  Remove an extended attribute
    
  
  This function removes an extended attribute of a file.
  
  Gli attributi estesi hanno due namespace differenti: user
  e root. Il namespace user è disponibile per tutti gli utenti mentre il namespace root
  è disponibile solo per gli utenti con privilegi di root. xattr opera sul namespace user
  di default, ma questo si può cambiare utilizzando il parametro 
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file from which we remove the attribute.
  <info>string</info>  <strong>$name    </strong>  The name of the attribute to remove.
  <info>int   </info>  <strong>$flags   </strong>  Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted)
                     namespace. Requires root privileges.

<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>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_get()</strong>


id: xattr_set
type: function
doc:
<comment>Description:</comment>
  Set an extended attribute
    
  
  This function sets the value of an extended attribute of a file.
  
  Gli attributi estesi hanno due namespace differenti: user
  e root. Il namespace user è disponibile per tutti gli utenti mentre il namespace root
  è disponibile solo per gli utenti con privilegi di root. xattr opera sul namespace user
  di default, ma questo si può cambiare utilizzando il parametro 
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file in which we set the attribute.
  <info>string</info>  <strong>$name    </strong>  The name of the extended attribute. This attribute will be created if  it
                     doesn't exist or replaced otherwise. You can change this behaviour  by using
                     the <strong>$flags</strong> parameter.
  <info>string</info>  <strong>$value   </strong>  The value of the attribute.
  <info>int   </info>  <strong>$flags   </strong>  Supported xattr flags<info>XATTR_CREATE</info>Function will fail if extended attribute
                     already exists.<info>XATTR_REPLACE</info>Function will fail if extended attribute doesn't
                     exist.<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but operate on symbolic
                     link itself.<info>XATTR_ROOT</info>Set attribute in root (trusted) namespace. Requires root
                     privileges.

<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>xattr_get()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_supported
type: function
doc:
<comment>Description:</comment>
  Check if filesystem supports extended attributes
    
  
  This functions checks if the filesystem holding the given file supports  extended attributes. Read
  access to the file is required.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path of the tested file.
  <info>int   </info>  <strong>$flags   </strong>  Supported xattr flags<info>XATTR_DONTFOLLOW</info>Do not follow the symbolic link but
                     operate on symbolic link itself.

<comment>Return:</comment>
  <info>bool</info>  This function returns <info>true</info> if filesystem supports extended attributes, <info>false</info> if it doesn't
        and <info>null</info> if it can't be determined (for example wrong path or lack of permissions to file).

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_list()</strong>


id: xdiff_file_bdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two files
  
  Makes a binary diff of two files and stores the result in a patch file. This function works with
  both text and binary files. Resulting patch file can be later applied using
  <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest    </strong>  Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

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


id: xdiff_file_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Read a size of file created by applying a binary diff
  
  Returns a size of a result file that would be created after applying binary patch from file <strong>$file</strong>
  to the original file.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  The path to the binary patch created by <strong>xdiff_string_bdiff()</strong> or
                 <strong>xdiff_string_rabdiff()</strong> function.

<comment>Return:</comment>
  <info>int</info>  Returns the size of file that would be created.

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bpatch
type: function
doc:
<comment>Description:</comment>
  Patch a file with a binary diff
  
  Patches a <strong>$file</strong> with a binary <strong>$patch</strong> and stores the result in a file <strong>$dest</strong>.  This function accepts
  patches created both via <strong>xdiff_file_bdiff()</strong>  and <strong>xdiff_file_rabdiff()</strong> functions or their string
  counterparts.

<comment>Param:</comment>
  <info>string</info>  <strong>$file </strong>  The original file.
  <info>string</info>  <strong>$patch</strong>  The binary patch file.
  <info>string</info>  <strong>$dest </strong>  Path of the resulting file.

<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>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>


id: xdiff_file_diff
type: function
doc:
<comment>Description:</comment>
  Make unified diff of two files
  
  Makes an unified diff containing differences between <strong>$old_file</strong> and <strong>$new_file</strong> and stores it in
  <strong>$dest</strong> file. The resulting file is human-readable. An optional <strong>$context</strong> parameter specifies how
  many lines of context should be added around each change. Setting <strong>$minimal</strong> parameter to true will
  result in outputting the shortest patch file possible (can take a long time).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest    </strong>  Path of the resulting patch file.
  <info>int   </info>  <strong>$context </strong>  Indicates how many lines of context you want to include in diff result.
  <info>bool  </info>  <strong>$minimal </strong>  Set this parameter to <info>true</info> if you want to minimalize size of the result (can
                     take a long time).

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


id: xdiff_file_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias of xdiff_file_bdiff
  
  Makes a binary diff of two files and stores the result in a patch file. This function works with
  both text and binary files. Resulting patch file can be later applied using <strong>xdiff_file_bpatch()</strong>.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_file_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest    </strong>  Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

<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>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_merge3
type: function
doc:
<comment>Description:</comment>
  Merge 3 files into one
  
  Merges three files into one and stores the result in a file <strong>$dest</strong>.  The <strong>$old_file</strong> is an original
  version while <strong>$new_file1</strong> and <strong>$new_file2</strong> are modified versions of an original.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file </strong>  Path to the first file. It acts as "old" file.
  <info>string</info>  <strong>$new_file1</strong>  Path to the second file. It acts as modified version of <strong>$old_file</strong>.
  <info>string</info>  <strong>$new_file2</strong>  Path to the third file. It acts as modified version of <strong>$old_file</strong>.
  <info>string</info>  <strong>$dest     </strong>  Path of the resulting file, containing merged changed from both <strong>$new_file1</strong> and
                      <strong>$new_file2</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if merge was successful, string with rejected chunks if it was not or <info>false</info> if
         an internal error happened.

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


id: xdiff_file_patch
type: function
doc:
<comment>Description:</comment>
  Patch a file with an unified diff
  
  Patches a <strong>$file</strong> with a <strong>$patch</strong> and stores the result in a file. <strong>$patch</strong> has to be an unified diff
  created by  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> function.  An optional <strong>$flags</strong> parameter
  specifies mode of operation.

<comment>Param:</comment>
  <info>string</info>  <strong>$file </strong>  The original file.
  <info>string</info>  <strong>$patch</strong>  The unified patch file. It has to be created using <strong>xdiff_string_diff()</strong>,
                  <strong>xdiff_file_diff()</strong> functions or compatible tools.
  <info>string</info>  <strong>$dest </strong>  Path of the resulting file.
  <info>int   </info>  <strong>$flags</strong>  Can be either <info>XDIFF_PATCH_NORMAL</info> (default mode, normal patch) or
                  <info>XDIFF_PATCH_REVERSE</info> (reversed patch).
                  
                  Starting from version 1.5.0, you can also use binary OR to enable
                  <info>XDIFF_PATCH_IGNORESPACE</info> flag.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>false</info> if an internal error happened, string with rejected chunks if patch couldn't
         be applied or <info>true</info> if patch has been successfully applied.

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


id: xdiff_file_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias of xdiff_file_bpatch
  
  Patches a <strong>$file</strong> with a binary <strong>$patch</strong> and stores the result in a file <strong>$dest</strong>.  This function accepts
  patches created both via <strong>xdiff_file_bdiff()</strong>  or <strong>xdiff_file_rabdiff()</strong> functions or their string
  counterparts.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file </strong>  The original file.
  <info>string</info>  <strong>$patch</strong>  The binary patch file.
  <info>string</info>  <strong>$dest </strong>  Path of the resulting file.

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


id: xdiff_file_rabdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two files using the Rabin's polynomial fingerprinting algorithm
  
  Makes a binary diff of two files and stores the result in a patch file. The difference between
  this function and <strong>xdiff_file_bdiff()</strong> is different algorithm used which should result in faster
  execution and smaller diff produced. This function works with both text and binary files.
  Resulting patch file can be later applied using <strong>xdiff_file_bpatch()</strong>/<strong>xdiff_string_bpatch()</strong>.
  
  For more details about differences between algorithm used please check libxdiff  website.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Path to the first file. This file acts as "old" file.
  <info>string</info>  <strong>$new_file</strong>  Path to the second file. This file acts as "new" file.
  <info>string</info>  <strong>$dest    </strong>  Path of the resulting patch file. Resulting file contains differences between
                     "old" and "new" files. It is in binary format and is human-unreadable.

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


id: xdiff_string_bdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two strings
  
  Makes a binary diff of two strings and returns the result. This function works with both text and
  binary data. Resulting patch can be later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with binary diff containing differences between "old" and "new" data or
          <info>false</info> if an internal error occurred.

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


id: xdiff_string_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Read a size of file created by applying a binary diff
  
  Returns a size of a result file that would be created after applying binary <strong>$patch</strong> to the original
  file.

<comment>Param:</comment>
  <info>string</info>  <strong>$patch</strong>  The binary patch created by <strong>xdiff_string_bdiff()</strong> or  <strong>xdiff_string_rabdiff()</strong>
                  function.

<comment>Return:</comment>
  <info>int</info>  Returns the size of file that would be created.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bpatch
type: function
doc:
<comment>Description:</comment>
  Patch a string with a binary diff
  
  Patches a string <strong>$str</strong> with a binary <strong>$patch</strong>. This function accepts patches created both via
  <strong>xdiff_string_bdiff()</strong>  and <strong>xdiff_string_rabdiff()</strong> functions or their file counterparts.

<comment>Param:</comment>
  <info>string</info>  <strong>$str  </strong>  The original binary string.
  <info>string</info>  <strong>$patch</strong>  The binary patch string.

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

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_diff
type: function
doc:
<comment>Description:</comment>
  Make unified diff of two strings
  
  Makes an unified diff containing differences between <strong>$old_data</strong> string and <strong>$new_data</strong> string and
  returns it. The resulting diff is human-readable.  An optional <strong>$context</strong> parameter specifies how
  many lines of context should be added around each change. Setting <strong>$minimal</strong> parameter  to true will
  result in outputting the shortest patch file possible (can take a long time).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with data. It acts as "new" data.
  <info>int   </info>  <strong>$context </strong>  Indicates how many lines of context you want to include in the diff result.
  <info>bool  </info>  <strong>$minimal </strong>  Set this parameter to <info>true</info> if you want to minimalize the size of the result
                     (can take a long time).

<comment>Return:</comment>
  <info>string</info>  Returns string with resulting diff or <info>false</info> if an internal error happened.

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


id: xdiff_string_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias of xdiff_string_bdiff
  
  Makes a binary diff of two strings and returns the result. This function works with both text and
  binary data. Resulting patch can be later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_string_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with result or <info>false</info> if an internal error happened.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_merge3
type: function
doc:
<comment>Description:</comment>
  Merge 3 strings into one
  
  Merges three strings into one and returns the result. The <strong>$old_data</strong> is an original version of data
  while <strong>$new_data1</strong> and <strong>$new_data2</strong> are modified  versions of an original. An optional <strong>$error</strong> is used
  to pass any rejected parts during merging process.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data </strong>  First string with data. It acts as "old" data.
  <info>string</info>  <strong>$new_data1</strong>  Second string with data. It acts as modified version of <strong>$old_data</strong>.
  <info>string</info>  <strong>$new_data2</strong>  Third string with data. It acts as modified version of <strong>$old_data</strong>.
  <info>string</info>  <strong>$error    </strong>  If provided then rejected parts are stored inside this variable.

<comment>Return:</comment>
  <info>mixed</info>  Returns the merged string, <info>false</info> if an internal error happened, or <info>true</info> if merged string is
         empty.

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


id: xdiff_string_patch
type: function
doc:
<comment>Description:</comment>
  Patch a string with an unified diff
  
  Patches a <strong>$str</strong> string with an unified patch in <strong>$patch</strong> parameter  and returns the result. <strong>$patch</strong>
  has to be an unified diff created by  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong> function.  An optional
  <strong>$flags</strong> parameter specifies mode of operation. Any rejected parts of the patch will be stored
  inside <strong>$error</strong> variable if  it is provided.

<comment>Param:</comment>
  <info>string</info>  <strong>$str  </strong>  The original string.
  <info>string</info>  <strong>$patch</strong>  The unified patch string. It has to be created using <strong>xdiff_string_diff()</strong>,
                  <strong>xdiff_file_diff()</strong> functions or compatible tools.
  <info>int   </info>  <strong>$flags</strong>  <strong>$flags</strong> can be either <info>XDIFF_PATCH_NORMAL</info> (default mode, normal patch) or
                  <info>XDIFF_PATCH_REVERSE</info> (reversed patch).
                  
                  Starting from version 1.5.0, you can also use binary OR to enable
                  <info>XDIFF_PATCH_IGNORESPACE</info> flag.
  <info>string</info>  <strong>$error</strong>  If provided then rejected parts are stored inside this variable.

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

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


id: xdiff_string_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias of xdiff_string_bpatch
  
  Patches a string <strong>$str</strong> with a binary <strong>$patch</strong>. This function accepts patches created both via
  <strong>xdiff_string_bdiff()</strong>  and <strong>xdiff_string_rabdiff()</strong> functions or their file counterparts.
  
  Starting with version 1.5.0 this function is an alias of <strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str  </strong>  The original binary string.
  <info>string</info>  <strong>$patch</strong>  The binary patch string.

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

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_rabdiff
type: function
doc:
<comment>Description:</comment>
  Make binary diff of two strings using the Rabin's polynomial fingerprinting algorithm
  
  Makes a binary diff of two strings and returns the result. The difference between this function
  and <strong>xdiff_string_bdiff()</strong> is different algorithm used which should result in faster execution and
  smaller diff produced. This function works with both text and binary data. Resulting patch can be
  later applied using <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  For more details about differences between algorithm used please check libxdiff  website.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  First string with binary data. It acts as "old" data.
  <info>string</info>  <strong>$new_data</strong>  Second string with binary data. It acts as "new" data.

<comment>Return:</comment>
  <info>string</info>  Returns string with binary diff containing differences between "old" and "new" data or
          <info>false</info> if an internal error occurred.

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


id: xhprof_disable
type: function
doc:
<comment>Description:</comment>
  Stops xhprof profiler
  
  Stops the profiler, and returns xhprof data from the run.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of xhprof data, from the run.


id: xhprof_enable
type: function
doc:
<comment>Description:</comment>
  Start xhprof profiler
  
  Start xhprof profiling.

<comment>Param:</comment>
  <info>int  </info>  <strong>$flags  </strong>  Optional flags to add additional information to the profiling. See the XHprof
                   constants for further information about these flags, e.g., <info>XHPROF_FLAGS_MEMORY</info> to
                   enable memory profiling.
  <info>array</info>  <strong>$options</strong>  An <info>array</info> of optional options, namely, the 'ignored_functions' option to pass in
                   functions to be ignored during profiling.

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

<comment>See Also:</comment>
   * <strong>xhprof_disable()</strong>
   * <strong>xhprof_sample_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xhprof_sample_disable
type: function
doc:
<comment>Description:</comment>
  Stops xhprof sample profiler
  
  Stops the sample mode xhprof profiler, and

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of xhprof sample data, from the run.


id: xhprof_sample_enable
type: function
doc:
<comment>Description:</comment>
  Start XHProf profiling in sampling mode
  
  Starts profiling in sample mode, which is a lighter weight version of <strong>xhprof_enable()</strong>. The
  sampling interval is 0.1 seconds, and samples record the full function call stack. The main use
  case is when lower overhead is required when doing performance monitoring and diagnostics.

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

<comment>See Also:</comment>
   * <strong>xhprof_sample_disable()</strong>
   * <strong>xhprof_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xml_error_string
type: function
doc:
<comment>Description:</comment>
  Restituisce la stringa di errore dal parser XML
  
  Restituisce la stringa di errore dal parser XML associata al <strong>$code</strong>  fornito.

<comment>Param:</comment>
  <info>int</info>  <strong>$code</strong>  Un codice di errore da <strong>xml_get_error_code()</strong>.

<comment>Return:</comment>
  <info>string</info>  Restituisce una stringa con una descrizione testuale del <strong>$code</strong> di errore, o <info>false</info> se non
          viene trovata nessuna descrizione.

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


id: xml_get_current_byte_index
type: function
doc:
<comment>Description:</comment>
  Restituisce l'indice del byte corrente per un parser XML
  
  Restituisce l'indice del byte corrente per il parser XML fornito.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML per ottenere l'indice del byte da esso.

<comment>Return:</comment>
  <info>int</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, o
       altrimenti viene restituito l'indice del byte sul quale è correntemente il parser nel suo
       buffer di dati (a partire da 0).

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_column_number
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero di colonna corrente per un parser XML
    
  
  Restituisce il numero di colonna corrente di un dato parser XML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML dal quale ottenere il numero di colonna.

<comment>Return:</comment>
  <info>int</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, altrimenti
       restituisce in quale colonna sulla linea corrente (come indicato da
       <strong>xml_get_current_line_number()</strong>) si trova il parser.

<comment>See Also:</comment>
   * <strong>xml_get_current_byte_index()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_line_number
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero di linea corrente per un parser XML
  
  Restituisce il numero di linea corrente per il parser XML fornito.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML dal quale ottenere il numero di linea.

<comment>Return:</comment>
  <info>int</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, altrimenti
       la funzione restituisce in quale linea del buffer dati si trova attualmente il parser.

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_byte_index()</strong>


id: xml_get_error_code
type: function
doc:
<comment>Description:</comment>
  Restituisce il codice di errore dal parser XML
  
  Restituisce il codice di errore dal parser XML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML da cui si vuole ottenere il codice di errore.

<comment>Return:</comment>
  <info>int</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, altrimenti
       la funzione restituisce uno  dei codici di errore elencati nella sezione dei codici di
       errore.

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


id: xml_parse
type: function
doc:
<comment>Description:</comment>
  Inizia il parsing di un documento XML
  
  <strong>xml_parse()</strong> esegue il parsing di un documento XML. Gli handler configurati per la gestione degli
  eventi saranno richiamati ogni volta che si renderà necessario.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser  </strong>  Un riferimento al parser XML da utilizzare.
  <info>string  </info>  <strong>$data    </strong>  Segmento di dati da analizzare. Un documento può essere elaborato a segmenti
                       richiamando <strong>xml_parse()</strong> diverse volte con nuovi dati, con il parametro
                       <strong>$e_finale</strong> settato e <info>true</info> quando si elabora l'ultimo segmento.
  <info>bool    </info>  <strong>$is_final</strong>  Se valorizzato a <info>true</info>, il parametro <strong>$data</strong> rappresenta l'ultimo segmento dei
                       dati inviati al parser.

<comment>Return:</comment>
  <info>int</info>  Restituisce 1 in caso di successo o 0 in caso di fallimento.
       
       In caso di parsing non riuscito, si possono recuperare informazioni sull'errore con
       <strong>xml_get_error_code()</strong>, <strong>xml_error_string()</strong>, <strong>xml_get_current_line_number()</strong>,
       <strong>xml_get_current_column_number()</strong> e <strong>xml_get_current_byte_index()</strong>.
       
       Gli errori nelle entità sono riportati alla fine dei dati quindi solo se <strong>$is_final</strong> è
       impostato a <info>true</info>.


id: xml_parse_into_struct
type: function
doc:
<comment>Description:</comment>
  Analizza i dati XML in una struttura array
  
  Questa funzione analizza una stringa XML in 2 strutture array parallele, una (<strong>$index</strong>) contiene i
  puntatori alla posizione dei valori opportuni nell'array <strong>$values</strong>. Quest'ultimi due parametri
  devono essere passati per riferimento.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML.
  <info>string  </info>  <strong>$data  </strong>  Una stringa contenente i dati XML.
  <info>array   </info>  <strong>$values</strong>  Una array contenente i valori dei dati XML
  <info>array   </info>  <strong>$index </strong>  Un array contenente i puntatori alla posizione degli opportuni valori in
                     $values.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_parse_into_struct()</strong> restituisce 0 per fallimento e 1 per successo. Questo non è lo stesso
       di <info>false</info> e <info>true</info>, fare attenzione con gli operatori come ===.


id: xml_parser_create
type: function
doc:
<comment>Description:</comment>
  Crea un parser XML
  
  <strong>xml_parser_create()</strong> crea un nuovo parser XML e restituisce un handle che si riferisce ad esso da
  utilizzarsi con le altre funzioni XML.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding</strong>  Il parametro opzionale <strong>$encoding</strong> indica la codifica dei caratteri in input ed
                     output per il PHP 4. A partire dal PHP 5, la codifica dell'input è determinata
                     automaticamente, pertanto il parametro <strong>$encoding</strong> indica solo dal codifica
                     dell'output. In PHP 4, la codifica di default dell'output è la medesima
                     utilizzata dall'input. Se si indica una stringa vuota, il parser tenta di
                     inviduare  la codifica utilizzata per il documento guardando l'intestazione
                     dello stesso per 3 o 4 byte. In PHP 5.0.0 a 5.0.1, il set di caratteri di
                     default è l' ISO-8859-1, mentre in PHP 5.0.2 e successivi è UTF-8. Le codifiche
                     supportate sono <return>ISO-8859-1</return>, <return>UTF-8</return> e <return>US-ASCII</return>.

<comment>Return:</comment>
  <info>resource</info>  Restituisce un handle della risorsa per il nuovo parser XML.

<comment>See Also:</comment>
   * <strong>xml_parser_create_ns()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_create_ns
type: function
doc:
<comment>Description:</comment>
  Crea un parser XML con il supporto dello spazio dei nomi
  
  <strong>xml_parser_create_ns()</strong> crea un nuovo parser XML con il supporto dello spazio dei nomi XML e
  restituisce un handle che si riferisce ad esso  da utilizzarsi con le altre funzioni XML.

<comment>Param:</comment>
  <info>string</info>  <strong>$encoding </strong>  Il parametro opzionale <strong>$encoding</strong> indica la codifica dei caratteri in input ed
                      output per il PHP 4. A partire dal PHP 5, la codifica dell'input è determinata
                      automaticamente, pertanto il parametro <strong>$encoding</strong> indica solo dal codifica
                      dell'output. In PHP 4, la codifica di default dell'output è la medesima
                      utilizzata dall'input. In PHP 5.0.0 a 5.0.1, il set di caratteri di default è
                      l' ISO-8859-1, mentre in PHP 5.0.2 e successivi è UTF-8. Le codifiche
                      supportate sono <return>ISO-8859-1</return>, <return>UTF-8</return> e <return>US-ASCII</return>.
  <info>string</info>  <strong>$separator</strong>  Con un parser che gestisce gli spazi dei nomi, i tag passati alle varie
                      funzioni handler saranno composti dallo spazio dei nomi e dal nome del tag
                      separati dalla stringa specificata in <strong>$separator</strong>

<comment>Return:</comment>
  <info>resource</info>  Restituisce un handle della risorsa per il nuovo parser XML.

<comment>See Also:</comment>
   * <strong>xml_parser_create()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_free
type: function
doc:
<comment>Description:</comment>
  Cancella un parser XML
  
  Cancella il <strong>$parser</strong> XML fornito.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML da cancellare.

<comment>Return:</comment>
  <info>bool</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido,
        altrimenti cancella il parser e restituisce <info>true</info>.


id: xml_parser_get_option
type: function
doc:
<comment>Description:</comment>
  Restituisce le opzioni da un parser XML
  
  Restituisce un'opzione da un parser XML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML dal quale ottenere un'opzione.
  <info>int     </info>  <strong>$option</strong>  Quale opzione ottenere. Sono disponibili <info>XML_OPTION_CASE_FOLDING</info> e
                     <info>XML_OPTION_TARGET_ENCODING</info>. Vedere <strong>xml_parser_set_option()</strong> per la loro
                     descrizione.

<comment>Return:</comment>
  <info>mixed</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, o se
         <strong>$option</strong> non è valido (viene anche generato un <info>E_WARNING</info>). Altrimenti viene restituito il
         valore dell'opzione.


id: xml_parser_set_option
type: function
doc:
<comment>Description:</comment>
  Valorizza le opzioni di un parser XML
  
  Valorizza un opzione in un parser XML.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser</strong>  Un riferimento al parser XML del quale impostare un'opzione.
  <info>int     </info>  <strong>$option</strong>  Quale opzione impostare.  Vedere sotto.
                     
                     Sono disponibili le seguenti opzioni: Opazioni del parser XMLCostante
                     dell'opzioneTipo datiDescrizione<info>XML_OPTION_CASE_FOLDING</info>integer Controlla se
                     case-folding è abilitato per questo parser XML.  Abilitato per impostazione
                     predefinita. <info>XML_OPTION_SKIP_TAGSTART</info>integer Specifica quanti catatteri devono
                     essere ignorati all'inizio di un nome di tag. <info>XML_OPTION_SKIP_WHITE</info>integer
                     Indica se si devono saltare i valori che consistono in caratteri di spazio.
                     <info>XML_OPTION_TARGET_ENCODING</info>string Imposta quale codifica di destinazione usare
                     in questo parser XML.Per impostazione predefinita, è impostata la stessa
                     codifica del sorgente utilizzata da <strong>xml_parser_create()</strong>. Le codifiche di
                     destinazione supportate sono <return>ISO-8859-1</return>, <return>US-ASCII</return> e <return>UTF-8</return>.
  <info>mixed   </info>  <strong>$value </strong>  Il nuovo valore dell'opzione.

<comment>Return:</comment>
  <info>bool</info>  Questa funzione restituisce <info>false</info> se <strong>$parser</strong> non si riferisce ad un parser valido, o se
        l'opzione non può essere impostata. Altrimenti l' opzione viene impostata e la funzione
        restituisce <info>true</info>.


id: xml_set_character_data_handler
type: function
doc:
<comment>Description:</comment>
  Valorizza il gestore dei dati
  
  Imposta la funzione che gestisce i dati carattere per il parser XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser </strong>  Un riferimento al parser XML per impostare la funzione che gestisce i dati
                      carattere.
  <info>callable</info>  <strong>$handler</strong>  <strong>$handler</strong> è una stringa contenente il nome di una funzione che deve esistere
                      quando <strong>xml_parse()</strong> è chiamata per <strong>$parser</strong>.
                      
                      La funzione indicata da <strong>$handler</strong> deve accettare due parametri:
                      handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> Il primo parametro, parser, è un
                      riferimento al parser XML che chiama il gestore. <strong>$data</strong> Il secondo parametro,
                      <strong>$data</strong>, contiene i dati dei caratteri come stringa.
                      
                      Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
                      
                      Il secondo parametro, <strong>$data</strong>, contiene i dati dei caratteri come stringa.
                      
                      Il gestore dei dati carattere è chiamato per ogni pezzo di un testo nel
                      documento XML. Può essere chiamato più volte all'interno di ogni frammento (ad
                      esempio per stringhe non-ASCII).
                      
                      Se una funzione del gestore è impostata con una stringa vuota, oppure a <info>false</info>,
                      il gestore in questione viene disabilitato.
                      
                      Invece di un nome di funzione, può
                      essere passato anche un array contenente un riferimento ad oggetto e un
                      nome di metodo.
  <info>resource</info>  <strong>$parser </strong>  Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
  <info>string  </info>  <strong>$data   </strong>  Il secondo parametro, <strong>$data</strong>, contiene i dati dei caratteri come stringa.

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


id: xml_set_default_handler
type: function
doc:
<comment>Description:</comment>
  Imposta il gestore predefinito
  
  Imposta la funzione di gestione predefinita per il parser XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser </strong>  Un riferimento al parser XML per impostare la funzione di gestione
                      predefinita.
  <info>callable</info>  <strong>$handler</strong>  <strong>$handler</strong> è una stringa che contiene il nome di una funzione che deve esistere
                      quando <strong>xml_parse()</strong> è chiamata per <strong>$parser</strong>.
                      
                      La funzione indicata da <strong>$handler</strong> deve accettare due parametri:
                      handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> Il primo parametro, parser, è un
                      riferimento al parser XML che chiama il gestore. <strong>$data</strong> Il secondo parametro,
                      <strong>$data</strong>, contiene i dati carattere.Questo può essere la dichiarazione XML, la
                      dichiarazione del tipo del documento, entità o altri dati per i quali non
                      esistono altri gestori.
                      
                      Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
                      
                      Il secondo parametro, <strong>$data</strong>, contiene i dati carattere.Questo può essere la
                      dichiarazione XML, la dichiarazione del tipo del documento, entità o altri
                      dati per i quali non esistono altri gestori.
                      
                      Se una funzione del gestore è impostata con una stringa vuota, oppure a <info>false</info>,
                      il gestore in questione viene disabilitato.
                      
                      Invece di un nome di funzione, può
                      essere passato anche un array contenente un riferimento ad oggetto e un
                      nome di metodo.
  <info>resource</info>  <strong>$parser </strong>  Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
  <info>string  </info>  <strong>$data   </strong>  Il secondo parametro, <strong>$data</strong>, contiene i dati carattere.Questo può essere la
                      dichiarazione XML, la dichiarazione del tipo del documento, entità o altri
                      dati per i quali non esistono altri gestori.

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


id: xml_set_element_handler
type: function
doc:
<comment>Description:</comment>
  Valorizza i gestori di inizio e fine elemento
  
  Imposta le funzioni di gestione per il <strong>$parser</strong> XML. <strong>$start_element_handler</strong> e <strong>$end_element_handler</strong>
  sono stringhe contenenti i nomi di funzioni che devono esistere quando viene eseguito <strong>xml_parse()</strong>
  per il <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser               </strong>  Un riferimento al parser XML per impostare le funzioni di
                                    gestione degli elementi inizio e fine.
  <info>callable</info>  <strong>$start_element_handler</strong>  La funzione indicata da <strong>$start_element_handler</strong> deve accettare
                                    tre parametri:
                                    start_element_handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$name</strong><info>array</info><strong>$attribs</strong>
                                    <strong>$parser</strong> Il primo parametro, parser, è un riferimento al parser
                                    XML che chiama il gestore. <strong>$name</strong> Il secondo parametro, <strong>$name</strong>,
                                    contiene il nome dell'elemento per il quale questo gestore viene
                                    chiamato.Se il case-folding è attivato per questo parser, il
                                    nome dell'elemento sarà in lettere maiuscole. <strong>$attribs</strong> Il terzo
                                    parametro, <strong>$attribs</strong>, contiene un array associativo con gli
                                    attributi degli elementi (eventuali).Le chiavi di questo array
                                    sono i nomi degli attributi, i valori sono i valori degli
                                    attributi.I nomi degli attributi sono case-folded con gli stessi
                                    criteri con i nomi degli elementi.I valori degli attributi not
                                    sono case-folded.  L'ordine originale degli attributi può essere
                                    recuperato percorrendo gli <strong>$attribs</strong> normalmente, utilizzando
                                    <strong>each()</strong>.La prima chiave nell'array era il primo attributo, e così
                                    via.
                                    
                                    Il primo parametro, parser, è un riferimento al parser XML che
                                    chiama il gestore.
                                    
                                    Il secondo parametro, <strong>$name</strong>, contiene il nome dell'elemento per
                                    il quale questo gestore viene chiamato.Se il case-folding è
                                    attivato per questo parser, il nome dell'elemento sarà in
                                    lettere maiuscole.
                                    
                                    Il terzo parametro, <strong>$attribs</strong>, contiene un array associativo con
                                    gli attributi degli elementi (eventuali).Le chiavi di questo
                                    array sono i nomi degli attributi, i valori sono i valori degli
                                    attributi.I nomi degli attributi sono case-folded con gli stessi
                                    criteri con i nomi degli elementi.I valori degli attributi not
                                    sono case-folded.
                                    
                                    L'ordine originale degli attributi può essere recuperato
                                    percorrendo gli <strong>$attribs</strong> normalmente, utilizzando <strong>each()</strong>.La
                                    prima chiave nell'array era il primo attributo, e così via.
                                    
                                    Invece di un nome di funzione, può
                                    essere passato anche un array contenente un riferimento ad
                                    oggetto e un
                                    nome di metodo.
  <info>resource</info>  <strong>$parser               </strong>  Il primo parametro, parser, è un riferimento al parser XML che
                                    chiama il gestore.
  <info>string  </info>  <strong>$name                 </strong>  Il secondo parametro, <strong>$name</strong>, contiene il nome dell'elemento per
                                    il quale questo gestore viene chiamato.Se il case-folding è
                                    attivato per questo parser, il nome dell'elemento sarà in
                                    lettere maiuscole.
  <info>array   </info>  <strong>$attribs              </strong>  Il terzo parametro, <strong>$attribs</strong>, contiene un array associativo con
                                    gli attributi degli elementi (eventuali).Le chiavi di questo
                                    array sono i nomi degli attributi, i valori sono i valori degli
                                    attributi.I nomi degli attributi sono case-folded con gli stessi
                                    criteri con i nomi degli elementi.I valori degli attributi not
                                    sono case-folded.
                                    
                                    L'ordine originale degli attributi può essere recuperato
                                    percorrendo gli <strong>$attribs</strong> normalmente, utilizzando <strong>each()</strong>.La
                                    prima chiave nell'array era il primo attributo, e così via.
  <info>callable</info>  <strong>$end_element_handler  </strong>  La funzione indicata da <strong>$end_element_handler</strong> deve accettare due
                                    parametri: end_element_handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$name</strong> <strong>$parser</strong>
                                    Il primo parametro, parser, è un riferimento al parser XML che
                                    chiama il gestore. <strong>$name</strong> Il secondo parametro, <strong>$name</strong>, contiene
                                    il nome dell'elemento per il quale questo gestore viene
                                    chiamato.Se il case-folding è attivato per questo parser, il
                                    nome dell'elemento sarà in lettere maiuscole.
                                    
                                    Il primo parametro, parser, è un riferimento al parser XML che
                                    chiama il gestore.
                                    
                                    Il secondo parametro, <strong>$name</strong>, contiene il nome dell'elemento per
                                    il quale questo gestore viene chiamato.Se il case-folding è
                                    attivato per questo parser, il nome dell'elemento sarà in
                                    lettere maiuscole.
                                    
                                    Se una funzione di gestione è impostata con una stringa vuota,
                                    oppure a <info>false</info>, il gestore in questione è disabilitato.
  <info>resource</info>  <strong>$parser               </strong>  Il primo parametro, parser, è un riferimento al parser XML che
                                    chiama il gestore.
  <info>string  </info>  <strong>$name                 </strong>  Il secondo parametro, <strong>$name</strong>, contiene il nome dell'elemento per
                                    il quale questo gestore viene chiamato.Se il case-folding è
                                    attivato per questo parser, il nome dell'elemento sarà in
                                    lettere maiuscole.

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


id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Valorizza il gestore della dichiarazione dello spazio dei nomi
  
  Imposta un handler da chiamare quando si esce dal campo di azione di una dichiarazione di spazio
  di nomi. Questa verrà chiamata, per ogni dichiarazione dello spazio dei nomi, dopo che il gestore
  per il tag finale dell'elemento nel quale lo spazio dei nomi è stato dichiarato.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser </strong>  Un riferimento al parser XML.
  <info>callable</info>  <strong>$handler</strong>  <strong>$handler</strong> è una stringa contenente il nome di una funzione che deve esistere
                      quando <strong>xml_parse()</strong> è chiamata per il <strong>$parser</strong>.
                      
                      La funzione chiamata <strong>$handler</strong> deve accettare due parametri, e dovrebbe
                      ritornare un numero intero. Se il valore restituito dall'handler è <info>false</info> (che
                      sarà se non è restituito nessun valore), il parser XML fermerà il parsing e
                      <strong>xml_get_error_code()</strong> restituirà <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
                      handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$prefix</strong> <strong>$parser</strong> Il primo parametro, parser, è un
                      riferimento al parser XML che chiama il gestore. <strong>$prefix</strong> Il prefisso è una
                      stringa utilizzata per riferirsi allo spazio dei nomi all'interno di un
                      oggetto XML.
                      
                      Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
                      
                      Il prefisso è una stringa utilizzata per riferirsi allo spazio dei nomi
                      all'interno di un oggetto XML.
                      
                      Se una funzione di gestione è impostata con una stringa vuota, oppure <info>false</info>,
                      il gestore in questione è disabilitato.
                      
                      Invece di un nome di funzione, può
                      essere passato anche un array contenente un riferimento ad oggetto e un
                      nome di metodo.
  <info>resource</info>  <strong>$parser </strong>  Il primo parametro, parser, è un riferimento al parser XML che chiama il
                      gestore.
  <info>string  </info>  <strong>$prefix </strong>  Il prefisso è una stringa utilizzata per riferirsi allo spazio dei nomi
                      all'interno di un oggetto XML.

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


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  Valorizza il gestore dei riferimenti a entità esterne
  
  Valorizza la funzione del gestore dei riferimenti a entità esterne per il parser XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$parser           </strong>  Un riferimento al parser XML per impostare la funzione del gestore
                                dei riferimenti a entità esterne.
  <info>callable</info>  <strong>$handler          </strong>  <strong>$handler</strong> è una stringa contenente il nome di una funzione che deve
                                esistere quando <strong>xml_parse()</strong> è chiamata per il <strong>$parser</strong>.
                                
                                La funzione chiamata <strong>$handler</strong> deve accettare cinque parametri, e
                                dovrebbe ritornare un numero intero. Se il valore restituito
                                dall'handler è <info>false</info> (che sarà se non è restituito nessun valore),
                                il parser XML fermerà il parsing e <strong>xml_get_error_code()</strong> restituirà
                                <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
                                handler<info>resource</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><strong>$public_id</strong>
                                <strong>$parser</strong> Il primo parametro, parser, è un riferimento al parser XML
                                che chiama il gestore. <strong>$open_entity_names</strong> Il secondo parametro,
                                <strong>$open_entity_names</strong>, è un elenco separato da spazi dei nomi delle
                                entità che sono aperti per l'analisi di queste entità (incluso il
                                nome dell'entità referenziata). <strong>$base</strong> Questa è la base per risolvere
                                l'identificatore del sistema (<strong>$system_id</strong>) delle entità
                                esterne.Attualmente questo parametro sarà sempre impostato ad una
                                stringa vuota. <strong>$system_id</strong> Il quarto parametro, <strong>$system_id</strong>, è l'
                                identificatore del sistema come specificato nella dichiarazione
                                delle entità. <strong>$public_id</strong> Il quinto parametro, <strong>$public_id</strong>, è l'
                                identificatore pubblico come specificato nella dichiarazione delle
                                entità, oppure una stringa vuota se non è stato specificato; lo
                                spazio nell' identificatore pubblico sarà normalizzato come
                                richiesto dalle specifiche di XML.
                                
                                Il primo parametro, parser, è un riferimento al parser XML che
                                chiama il gestore.
                                
                                Il secondo parametro, <strong>$open_entity_names</strong>, è un elenco separato da
                                spazi dei nomi delle entità che sono aperti per l'analisi di queste
                                entità (incluso il nome dell'entità referenziata).
                                
                                Questa è la base per risolvere l'identificatore del sistema
                                (<strong>$system_id</strong>) delle entità esterne.Attualmente questo parametro sarà
                                sempre impostato ad una stringa vuota.
                                
                                Il quarto parametro, <strong>$system_id</strong>, è l' identificatore del sistema
                                come specificato nella dichiarazione delle entità.
                                
                                Il quinto parametro, <strong>$public_id</strong>, è l' identificatore pubblico come
                                specificato nella dichiarazione delle entità, oppure una stringa
                                vuota se non è stato specificato; lo spazio nell' identificatore
                                pubblico sarà normalizzato come richiesto dalle specifiche di XML.
                                
                                Se una funzione di gestione è impostata con una stringa vuota,
                                oppure <info>false</info>, il gestore in questione è disabilitato.
                                
                                Invece di un nome di funzione, può
                                essere passato anche un array contenente un riferimento ad oggetto e
                                un
                                nome di metodo.
  <info>resource</info>  <strong>$parser           </strong>  Il primo parametro, parser, è un riferimento al parser XML che
                                chiama il gestore.
  <info>string  </info>  <strong>$open_entity_names</strong>  Il secondo parametro, <strong>$open_entity_names</strong>, è un elenco separato da
                                spazi dei nomi delle entità che sono aperti per l'analisi di queste
                                entità (incluso il nome dell'entità referenziata).
  <info>string  </info>  <strong>$base             </strong>  Questa è la base per risolvere l'identificatore del sistema
                                (<strong>$system_id</strong>) delle entità esterne.Attualmente questo parametro sarà
                                sempre impostato ad una stringa vuota.
  <info>string  </info>  <strong>$system_id        </strong>  Il quarto parametro, <strong>$system_id</strong>, è l' identificatore del sistema
                                come specificato nella dichiarazione delle entità.
  <info>string  </info>  <strong>$public_id        </strong>  Il quinto parametro, <strong>$public_id</strong>, è l' identificatore pubblico come
                                specificato nella dichiarazione delle entità, oppure una stringa
                                vuota se non è stato specificato; lo spazio nell' identificatore
                                pubblico sarà normalizzato come richiesto dalle specifiche di XML.

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


