# php_manual

id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  Checks if a given text contains any suspicious characters
  
  Checks if given string contains any suspicious characters like letters which are almost identical
  visually, but are Unicode characters from different sets.

<comment>Param:</comment>
  <info>string</info>  <strong>$text </strong>  String to test.
  <info>string</info>  <strong>$error</strong>  This variable is set by-reference to string containing an error, if there were
                  any.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there are suspicious characters, <info>false</info> otherwise.


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  Locales to use when running checks
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Set the checks to run
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: SqlStatement::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.


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

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


id: SqlStatement::execute
type: function
doc:
<comment>Description:</comment>
  Execute the operation
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getNextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getResult
type: function
doc:
<comment>Description:</comment>
  Get result
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check for more results
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has more objects to fetch.


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows from result
  
  Fetch all the rows from the result set.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>array</info>  A numerical array with all results from the query; each result is an associative array. An
         empty array is returned if no rows are present.


id: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get single row
  
  Fetch one row from the result set.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array. In case there is not any result, null will be
         returned.


id: SqlStatementResult::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  Get affected row count
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: SqlStatementResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  Get column names
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: SqlStatementResult::getColumns
type: function
doc:
<comment>Description:</comment>
  Get columns
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>Array</info>  


id: SqlStatementResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  Get column count
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>int</info>  The number of columns; 0 if there are none.


id: SqlStatementResult::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Get generated ids
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>array</info>  An array of generated _id's from the last operation,  or an empty array if there are none.


id: SqlStatementResult::getLastInsertId
type: function
doc:
<comment>Description:</comment>
  Get last insert id
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>String</info>  The ID for the last insert operation.


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>int</info>  The number of warnings raised during the last CRUD operation.


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  Check if result has data
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has data.


id: SqlStatementResult::nextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  The next Result object from the result set.


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check if more results
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Represents a connection between PHP and a Stomp compliant Message Broker.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Opens a connection
  
  Stile orientato agli oggetti (constructor):
  
  Stile procedurale:
  
  Opens a connection to a stomp compliant Message Broker.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker  </strong>  The broker URI
  <info>string</info>  <strong>$username</strong>  The username.
  <info>string</info>  <strong>$password</strong>  The password.
  <info>array </info>  <strong>$headers </strong>  Array associativo che contiene le intestazioni addizionali (per esempio:
                     receipt).

<comment>Return:</comment>
  <info>resource</info>  Può essere definita un'intestazione di transazione, che indica che la conferma del
            messaggio deve essere parte della transazione specificata.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Closes stomp connection
  
  Stile orientato agli oggetti (destructor):
  
  Stile procedurale:
  
  Closes a previously opened connection.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                   <strong>stomp_connect()</strong>.

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


id: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Rolls back a transaction in progress
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Rolls back a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link          </strong>  Solo stile procedurale: l'identificatore di connessione stomp
                             restituito da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$transaction_id</strong>  The transaction to abort.
  <info>array   </info>  <strong>$headers       </strong>  Array associativo che contiene le intestazioni addizionali (per
                             esempio: receipt).

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


id: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Acknowledges consumption of a message
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Acknowledges consumption of a message from a subscription using client acknowledgment.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link   </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                      <strong>stomp_connect()</strong>.
  <info>mixed   </info>  <strong>$msg    </strong>  The message/messageId to be acknowledged.
  <info>array   </info>  <strong>$headers</strong>  Array associativo che contiene le intestazioni addizionali (per esempio:
                      receipt).

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


id: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Starts a transaction
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Starts a transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link          </strong>  Solo stile procedurale: l'identificatore di connessione stomp
                             restituito da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$transaction_id</strong>  The transaction id.
  <info>array   </info>  <strong>$headers       </strong>  Array associativo che contiene le intestazioni addizionali (per
                             esempio: receipt).

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


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Commits a transaction in progress
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Commits a transaction in progress.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link          </strong>  Solo stile procedurale: l'identificatore di connessione stomp
                             restituito da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$transaction_id</strong>  The transaction id.
  <info>array   </info>  <strong>$headers       </strong>  Array associativo che contiene le intestazioni addizionali (per
                             esempio: receipt).

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


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Gets the last stomp error
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Gets the last stomp error.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Returns an error string or <info>false</info> if no error occurred.


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Gets read timeout
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Gets read timeout

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with 2 elements: sec and usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Gets the current stomp session ID
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Gets the current stomp session ID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>stringfalse</info>  <info>string</info> session id on success o <info>false</info> in caso di fallimento.


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indicates whether or not there is a frame ready to read
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Indicates whether or not there is a frame ready to read.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a frame is ready to read, or <info>false</info> otherwise.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Reads the next frame
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Reads the next frame. It is possible to instantiate an object of a specific class, and pass
  parameters to that class's constructor.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link      </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito da
                         <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$class_name</strong>  The name of the class to instantiate. If not specified, a stompFrame object
                         is returned.

<comment>Return:</comment>
  <info>stompframe</info>  Può essere definita un'intestazione di transazione, che indica che la conferma del
              messaggio deve essere parte della transazione specificata.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Sends a message to the Message Broker.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link       </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito
                          da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$destination</strong>  Where to send the message
  <info>mixed   </info>  <strong>$msg        </strong>  Message to send.
  <info>array   </info>  <strong>$headers    </strong>  Array associativo che contiene le intestazioni addizionali (per esempio:
                          receipt).

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


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Sets read timeout
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Sets read timeout.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link        </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito
                           da <strong>stomp_connect()</strong>.
  <info>int     </info>  <strong>$seconds     </strong>  The seconds part of the timeout to be set.
  <info>int     </info>  <strong>$microseconds</strong>  The microseconds part of the timeout to be set.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Registers to listen to a given destination
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Registers to listen to a given destination.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link       </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito
                          da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$destination</strong>  Destination to subscribe to.
  <info>array   </info>  <strong>$headers    </strong>  Array associativo che contiene le intestazioni addizionali (per esempio:
                          receipt).

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


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Removes an existing subscription
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Removes an existing subscription.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link       </strong>  Solo stile procedurale: l'identificatore di connessione stomp restituito
                          da <strong>stomp_connect()</strong>.
  <info>string  </info>  <strong>$destination</strong>  Subscription to remove.
  <info>array   </info>  <strong>$headers    </strong>  Array associativo che contiene le intestazioni addizionali (per esempio:
                          receipt).

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


id: StompException
type: class
doc:
<comment>Description:</comment>
  Represents an error raised by the stomp extension. See Exceptions for more information about
  Exceptions in PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Get exception details
  
  Get exception details.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> containing the error details.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Represents a message which was sent or received from a Stomp compliant Message Broker.


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Constructor.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Frame command
  <info>array </info>  <strong>$headers</strong>  Frame headers (<info>array</info>).
  <info>string</info>  <strong>$body   </strong>  Frame body.


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<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>void</info>  


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously.

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename  </strong>  The name of the file.
  <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>void</info>  


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>void</info>  


id: Swoole\Async::writeFile
type: function
doc:
<comment>Description:</comment>
  Description
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<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>string  </info>  <strong>$flags   </strong>  

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


id: Swoole\Atomic::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a swoole atomic object.
  
  Swoole atomic object is a integer variable allows any processor to atomically test and modify.  It
  is implemented based on CPU atomic instructions. The Swoole atomic variables have to  defined
  before swoole_server-&gt;start.
  
  Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization.
  It compares the content of a memory location with a given value and, only if they are the same,
  modifies the content of that memory location to a new given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value of the atomic object.


id: Swoole\Atomic::add
type: function
doc:
<comment>Description:</comment>
  Add a number to the value to the atomic object.
  
  Add a number to the value to the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$add_value</strong>  The value which will be added to the current value.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::cmpset
type: function
doc:
<comment>Description:</comment>
  Compare and set the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$cmp_value</strong>  The value to compare with the current value of the atomic object.
  <info>int</info>  <strong>$new_value</strong>  The value to set to the atomic object if the cmp_value is the same as the current
                   value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::get
type: function
doc:
<comment>Description:</comment>
  Get the current value of the atomic object.
  
  Get the current value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::set
type: function
doc:
<comment>Description:</comment>
  Set a new value to the atomic object.
  
  Set a new value to the atomic object.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value to set to the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::sub
type: function
doc:
<comment>Description:</comment>
  Subtract a number to the value of the atomic object.
  
  Subtract a number to the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$sub_value</strong>  The value which will be subtracted to the current value.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Buffer::__construct
type: function
doc:
<comment>Description:</comment>
  Fixed size memory blocks allocation.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the memory to allocate.


id: Swoole\Buffer::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole memory buffer.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Swoole\Buffer::__toString
type: function
doc:
<comment>Description:</comment>
  Get the string value of the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The string value of the memory buffer.


id: Swoole\Buffer::append
type: function
doc:
<comment>Description:</comment>
  Append the string or binary data at the end of the memory buffer and return the new size of memory
  allocated.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string or binary data to append at the end of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::clear
type: function
doc:
<comment>Description:</comment>
  Reset the memory buffer.

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


id: Swoole\Buffer::expand
type: function
doc:
<comment>Description:</comment>
  Expand the size of memory buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new size of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::read
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset.
  <info>int</info>  <strong>$length</strong>  The length.

<comment>Return:</comment>
  <info>string</info>  The data readed from the memory buffer.


id: Swoole\Buffer::recycle
type: function
doc:
<comment>Description:</comment>
  Release the memory to OS which is not used by the memory buffer.

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


id: Swoole\Buffer::substr
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length. Or remove data from the memory
  buffer.
  
  If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer.
  The memory for storing the data will be released when the buffer object is deconstructed.

<comment>Param:</comment>
  <info>int </info>  <strong>$offset</strong>  The offset.
  <info>int </info>  <strong>$length</strong>  The length.
  <info>bool</info>  <strong>$remove</strong>  Whether to remove the data from the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The data or string readed from the memory buffer.


id: Swoole\Buffer::write
type: function
doc:
<comment>Description:</comment>
  Write data to the memory buffer. The memory allocated for the buffer will not be changed.

<comment>Param:</comment>
  <info>int   </info>  <strong>$offset</strong>  The offset.
  <info>string</info>  <strong>$data  </strong>  The data to write to the memory buffer.

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


id: Swoole\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole Channel
  
  Swoole channel is memory data structure works like Chan in Golang, implemented based on  shared
  memory and mutex locks. It can be used as high performance message queue in memory. Construct a
  swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. Exceptions will be
  thrown if there is not enough memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  The size of the Swoole channel.


id: Swoole\Channel::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct a Swoole channel.

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


id: Swoole\Channel::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from swoole channel.

<comment>Return:</comment>
  <info>mixed</info>  If the channel is empty, the function will return false, or return the unserialized data.


id: Swoole\Channel::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into Swoole channel.
  
  Data can be any non-empty PHP variable, the variable will be serialized if it is not string type.
  
  If size of the data is more than 8KB, swoole channel will use temp files storage.
  
  The function will return true if the write operation is succeeded, or return false if there is not
  enough space.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to push into the Swoole channel.

<comment>Return:</comment>
  <info>bool</info>  Wheter the data is pushed into he Swoole channel.


id: Swoole\Channel::stats
type: function
doc:
<comment>Description:</comment>
  Get stats of swoole channel.
  
  Get the numbers of queued elements and total size of the memory used by the queue.

<comment>Return:</comment>
  <info>array</info>  The stats of the Swoole channel.


id: Swoole\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create Swoole sync or async TCP/UDP client, with or without SSL.

<comment>Param:</comment>
  <info>int</info>  <strong>$sock_type</strong>  The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL,
                   SWOOLE_KEEP.
  <info>int</info>  <strong>$is_async </strong>  Synchronous or asynchronous client.


id: Swoole\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole client.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Swoole\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the connection established.

<comment>Param:</comment>
  <info>bool</info>  <strong>$force</strong>  Whether force to close the connection.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is closed.


id: Swoole\Client::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote TCP or UDP port.

<comment>Param:</comment>
  <info>string</info>  <strong>$host   </strong>  The host name of the remote address.
  <info>int   </info>  <strong>$port   </strong>  The port number of the remote address.
  <info>int   </info>  <strong>$timeout</strong>  The timeout(second) of connect/send/recv, the dafault value is 0.1s
  <info>int   </info>  <strong>$flag   </strong>  If the type of client is UDP, the $flag means if to enable the configuration
                    udp_connect.  If the configuration udp_connect is enabled, the client will only
                    receive the data from specified ip:port. If the type of client is TCP and the
                    $flag is set to 1, it must use swoole_client_select to check the connection
                    status before send/recv.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::getpeername
type: function
doc:
<comment>Description:</comment>
  Get the remote socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the remote socket.


id: Swoole\Client::getsockname
type: function
doc:
<comment>Description:</comment>
  Get the local socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the local socket.


id: Swoole\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the connection is established.
  
  This method returns the connection status of application layer.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::on
type: function
doc:
<comment>Description:</comment>
  Add callback functions triggered by events.

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

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


id: Swoole\Client::pause
type: function
doc:
<comment>Description:</comment>
  Pause receiving data.

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


id: Swoole\Client::pipe
type: function
doc:
<comment>Description:</comment>
  Redirect the data to another file descriptor.

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

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


id: Swoole\Client::recv
type: function
doc:
<comment>Description:</comment>
  Receive data from the remote socket.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  
  <info>string</info>  <strong>$flag</strong>  

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


id: Swoole\Client::resume
type: function
doc:
<comment>Description:</comment>
  Resume receiving data.

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


id: Swoole\Client::send
type: function
doc:
<comment>Description:</comment>
  Send data to the remote TCP socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to send which can be string or binary
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>int</info>  If the client sends data successfully, it returns the length of data sent.  Or it returns
       false and sets $swoole_client-&gt;errCode. For sync client,  there is no limit for the data
       to send. For async client, The limit  for the data to send is socket_buffer_size.


id: Swoole\Client::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the remote TCP socket.
  
  This is a wrapper of the Linux sendfile system call.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  File path of the file to send.
  <info>int   </info>  <strong>$offset  </strong>  Offset of the file to send

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


id: Swoole\Client::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.
  
  The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip  </strong>  The IP address of remote host, IPv4 or IPv6.
  <info>int   </info>  <strong>$port</strong>  The port number of remote host.
  <info>string</info>  <strong>$data</strong>  The data to send which should be less-than 64K.

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


id: Swoole\Client::set
type: function
doc:
<comment>Description:</comment>
  Set the Swoole client parameters before the connection is established.

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

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


id: Swoole\Client::sleep
type: function
doc:
<comment>Description:</comment>
  Remove the TCP client from system event loop.
  
  Remove the TCP client from system event loop.

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


id: Swoole\Client::wakeup
type: function
doc:
<comment>Description:</comment>
  Add the TCP client back into the system event loop.

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


id: Swoole\Connection\Iterator::count
type: function
doc:
<comment>Description:</comment>
  Count connections.
  
  Gets the number of connections.

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


id: Swoole\Connection\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Return current connection entry.
  
  Get current connection entry.

<comment>Return:</comment>
  <info>Connection</info>  The current connection entry.


id: Swoole\Connection\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Return key of the current connection.
  
  This function returns key of the current connection.

<comment>Return:</comment>
  <info>int</info>  Key of the current connection.


id: Swoole\Connection\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Move to the next connection.
  
  The iterator to the next connection.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Check if offet exists.
  
  Check if offset exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The offset being checked.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the offset exists, otherwise FALSE.


id: Swoole\Connection\Iterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset to retrieve.
  
  Return the connection at specified offset.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  The offset to retrieve.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Assign a Connection to the specified offset.
  
  Assign a Connection to the specified offset.

<comment>Param:</comment>
  <info>int  </info>  <strong>$offset    </strong>  The offset to assign the Connection to.
  <info>mixed</info>  <strong>$connection</strong>  The connection to set.

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


id: Swoole\Connection\Iterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unset an offset.
  
  Unsets an offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset to unset.

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


id: Swoole\Connection\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds iterator

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


id: Swoole\Connection\Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Check if current position is valid.
  
  Checks if the current position is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the current iterator position is valid, otherwise FALSE.


id: Swoole\Coroutine::call_user_func
type: function
doc:
<comment>Description:</comment>
  Call a callback given by the first parameter
  
  Calls the <strong>$callback</strong> given by the first parameter and passes the remaining parameters as arguments.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
  <info>mixed   </info>  <strong>$args    </strong>  Zero or more parameters to be passed to the callback.

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


id: Swoole\Coroutine::call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Call a callback with an array of parameters
  
  Calls the callback given by the first parameter with the parameters in param_array.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback   </strong>  The <info>callable</info> to be called.
  <info>array   </info>  <strong>$param_array</strong>  Zero or more parameters in the array to be passed to the callback.

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


id: Swoole\Coroutine::cli_wait
type: function
doc:
<comment>Description:</comment>
  Description

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Coroutine::create
type: function
doc:
<comment>Description:</comment>
  Description
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>ReturnType</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>string  </info>  <strong>$events        </strong>  

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


id: Swoole\Event::defer
type: function
doc:
<comment>Description:</comment>
  Add a callback function to the next event loop.

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

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


id: Swoole\Event::del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket.

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

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


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at 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>string</info>  <strong>$read_callback </strong>  
  <info>string</info>  <strong>$write_callback</strong>  
  <info>string</info>  <strong>$events        </strong>  

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


id: Swoole\Event::wait
type: function
doc:
<comment>Description:</comment>
  Description
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Swoole\Event::write
type: function
doc:
<comment>Description:</comment>
  Write data to the socket.

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

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


id: Swoole\Http\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Construct the async HTTP client.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  The hostname of the remote host.
  <info>string</info>  <strong>$port</strong>  The port number of the remote host.
  <info>bool  </info>  <strong>$ssl </strong>  Whether to enable SSL.


id: Swoole\Http\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP client.

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


id: Swoole\Http\Client::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file to the post form.

<comment>Param:</comment>
  <info>string</info>  <strong>$path    </strong>  
  <info>string</info>  <strong>$name    </strong>  
  <info>string</info>  <strong>$type    </strong>  
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$offset  </strong>  

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


id: Swoole\Http\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the http connection.

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


id: Swoole\Http\Client::download
type: function
doc:
<comment>Description:</comment>
  Download a file from the remote server.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  
  <info>string  </info>  <strong>$file    </strong>  
  <info>callable</info>  <strong>$callback</strong>  
  <info>int     </info>  <strong>$offset  </strong>  

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


id: Swoole\Http\Client::execute
type: function
doc:
<comment>Description:</comment>
  Send the HTTP request after setting the parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$path    </strong>  
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::get
type: function
doc:
<comment>Description:</comment>
  Send GET http request to the remote server.

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

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


id: Swoole\Http\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the HTTP connection is connected.

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


id: Swoole\Http\Client::on
type: function
doc:
<comment>Description:</comment>
  Register callback function by event name.

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

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


id: Swoole\Http\Client::post
type: function
doc:
<comment>Description:</comment>
  Send POST http request to the remote server.

<comment>Param:</comment>
  <info>string  </info>  <strong>$path    </strong>  
  <info>string  </info>  <strong>$data    </strong>  
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::push
type: function
doc:
<comment>Description:</comment>
  Push data to websocket client.

<comment>Param:</comment>
  <info>string</info>  <strong>$data  </strong>  
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\Http\Client::set
type: function
doc:
<comment>Description:</comment>
  Update the HTTP client paramters.

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

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


id: Swoole\Http\Client::setCookies
type: function
doc:
<comment>Description:</comment>
  Set the http request cookies.

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

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


id: Swoole\Http\Client::setData
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request body data.
  
  The HTTP method will be changed to be POST.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Client::setHeaders
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request headers.

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

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


id: Swoole\Http\Client::setMethod
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request method.

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

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


id: Swoole\Http\Client::upgrade
type: function
doc:
<comment>Description:</comment>
  Upgrade to websocket protocol.

<comment>Param:</comment>
  <info>string</info>  <strong>$path    </strong>  
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Request::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP request.

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


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Get the raw HTTP POST body.
  
  This method is used for the POST data which isn't in the form of
  `application/x-www-form-urlencoded`.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Swoole\Http\Response::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP response.

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


id: Swoole\Http\Response::cookie
type: function
doc:
<comment>Description:</comment>
  Set the cookies of the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name    </strong>  
  <info>string</info>  <strong>$value   </strong>  
  <info>string</info>  <strong>$expires </strong>  
  <info>string</info>  <strong>$path    </strong>  
  <info>string</info>  <strong>$domain  </strong>  
  <info>string</info>  <strong>$secure  </strong>  
  <info>string</info>  <strong>$httponly</strong>  

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


id: Swoole\Http\Response::end
type: function
doc:
<comment>Description:</comment>
  Send data for the HTTP request and finish the response.

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

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


id: Swoole\Http\Response::gzip
type: function
doc:
<comment>Description:</comment>
  Enable the gzip of response content.
  
  
  The header about Content-Encoding will be added automatically.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::header
type: function
doc:
<comment>Description:</comment>
  Set the HTTP response headers.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  
  <info>string</info>  <strong>$value  </strong>  
  <info>string</info>  <strong>$ucwords</strong>  

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


id: Swoole\Http\Response::initHeader
type: function
doc:
<comment>Description:</comment>
  Init the HTTP response header.
  
  Init the HTTP response header.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::rawcookie
type: function
doc:
<comment>Description:</comment>
  Set the raw cookies to the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name    </strong>  
  <info>string</info>  <strong>$value   </strong>  
  <info>string</info>  <strong>$expires </strong>  
  <info>string</info>  <strong>$path    </strong>  
  <info>string</info>  <strong>$domain  </strong>  
  <info>string</info>  <strong>$secure  </strong>  
  <info>string</info>  <strong>$httponly</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file through the HTTP response.
  
  Send file through the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>int   </info>  <strong>$offset  </strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::status
type: function
doc:
<comment>Description:</comment>
  Set the status code of the HTTP response.
  
  Set the status code of the HTTP response.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::write
type: function
doc:
<comment>Description:</comment>
  Append HTTP body content to the HTTP response.
  
  Append HTTP body content to the HTTP response.

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

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


id: Swoole\Http\Server::on
type: function
doc:
<comment>Description:</comment>
  Bind callback function to HTTP server by event name.
  
  Bind callback function to HTTP server by event name.

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

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


id: Swoole\Http\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the swoole http server.
  
  Start the swoole http server.

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


id: Swoole\Lock::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a memory lock.
  
  Swoole lock is used for data synchronization between multiple theads or processes.

<comment>Param:</comment>
  <info>string</info>  <strong>$type              </strong>  
  <info>string</info>  <strong>$file_lock_location</strong>  


id: Swoole\Lock::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory a Swoole memory lock.

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


id: Swoole\Lock::lock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock. It will block if the lock is not available.

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


id: Swoole\Lock::lock_read
type: function
doc:
<comment>Description:</comment>
  Lock a read-write lock for reading.
  
  Lock a read-write lock for reading.

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


id: Swoole\Lock::trylock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock and return straight away even the lock is not available.

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


id: Swoole\Lock::trylock_read
type: function
doc:
<comment>Description:</comment>
  Try to lock a read-write lock for reading and return straight away even the lock is not available.

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


id: Swoole\Lock::unlock
type: function
doc:
<comment>Description:</comment>
  Release the lock.

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


id: Swoole\Mmap::open
type: function
doc:
<comment>Description:</comment>
  Map a file into memory and return the stream resource which can be used by PHP stream operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$size    </strong>  
  <info>string</info>  <strong>$offset  </strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\MySQL::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an async MySQL client.
  
  Construct an async MySQL client.


id: Swoole\MySQL::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the async MySQL client.

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


id: Swoole\MySQL::close
type: function
doc:
<comment>Description:</comment>
  Close the async MySQL connection.

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


id: Swoole\MySQL::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote MySQL server.
  
  Connect to the remote MySQL server.

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

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


id: Swoole\MySQL::on
type: function
doc:
<comment>Description:</comment>
  Register callback function based on event name.
  
  Register callback function based on event name, current only 'close' event is supported.

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

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


id: Swoole\MySQL::query
type: function
doc:
<comment>Description:</comment>
  Run the SQL query.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a process.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback                 </strong>  
  <info>bool    </info>  <strong>$redirect_stdin_and_stdout</strong>  
  <info>int     </info>  <strong>$pipe_type                </strong>  


id: Swoole\Process::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the process.

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


id: Swoole\Process::alarm
type: function
doc:
<comment>Description:</comment>
  High precision timer which triggers signal with fixed interval.

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

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


id: Swoole\Process::close
type: function
doc:
<comment>Description:</comment>
  Close the pipe to the child process.
  
  Close the pipe to the child process.

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


id: Swoole\Process::daemon
type: function
doc:
<comment>Description:</comment>
  Change the process to be a daemon process.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>bool</info>  <strong>$nochdir</strong>  
  <info>bool</info>  <strong>$noclose</strong>  

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


id: Swoole\Process::exec
type: function
doc:
<comment>Description:</comment>
  Execute system commands.
  
  The process will be replaced to be the system command process, but the pipe to the parent process
  will be kept.

<comment>Param:</comment>
  <info>string</info>  <strong>$exec_file</strong>  
  <info>string</info>  <strong>$args     </strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::exit
type: function
doc:
<comment>Description:</comment>
  Stop the child processes.

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

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


id: Swoole\Process::freeQueue
type: function
doc:
<comment>Description:</comment>
  Destroy the message queue created by swoole_process::useQueue.

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


id: Swoole\Process::kill
type: function
doc:
<comment>Description:</comment>
  Send signal to the child process.
  
  Send signal to the child process.

<comment>Param:</comment>
  <info>int   </info>  <strong>$pid      </strong>  
  <info>string</info>  <strong>$signal_no</strong>  

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


id: Swoole\Process::name
type: function
doc:
<comment>Description:</comment>
  Set name of the process.

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

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


id: Swoole\Process::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from the message queue.

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

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


id: Swoole\Process::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into the message queue.

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

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


id: Swoole\Process::read
type: function
doc:
<comment>Description:</comment>
  Read data sending to the process.

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

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


id: Swoole\Process::signal
type: function
doc:
<comment>Description:</comment>
  Send signal to the child processes.

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

<comment>Return:</comment>
  <info>void</info>  If signal sent successfully, it returns TRUE, otherwise it returns FALSE.


id: Swoole\Process::start
type: function
doc:
<comment>Description:</comment>
  Start the process.

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


id: Swoole\Process::statQueue
type: function
doc:
<comment>Description:</comment>
  Get the stats of the message queue used as the communication method between processes.

<comment>Return:</comment>
  <info>array</info>  The array of status of the message queue.


id: Swoole\Process::useQueue
type: function
doc:
<comment>Description:</comment>
  Create a message queue as the communication method between the parent process and child processes.

<comment>Param:</comment>
  <info>int</info>  <strong>$key </strong>  
  <info>int</info>  <strong>$mode</strong>  

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


id: Swoole\Process::wait
type: function
doc:
<comment>Description:</comment>
  Wait for the events of child processes.

<comment>Param:</comment>
  <info>bool</info>  <strong>$blocking</strong>  

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


id: Swoole\Process::write
type: function
doc:
<comment>Description:</comment>
  Write data into the pipe and communicate with the parent process or child processes.

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

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


id: Swoole\Redis\Server::format
type: function
doc:
<comment>Description:</comment>
  Description
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$type </strong>  
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Redis\Server::setHandler
type: function
doc:
<comment>Description:</comment>
  Description
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$command               </strong>  
  <info>string</info>  <strong>$callback              </strong>  
  <info>string</info>  <strong>$number_of_string_param</strong>  
  <info>string</info>  <strong>$type_of_array_param   </strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::pack
type: function
doc:
<comment>Description:</comment>
  Serialize the data.
  
  Swoole provides a fast and high performance serialization module.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::unpack
type: function
doc:
<comment>Description:</comment>
  Unserialize the data.
  
  Unserialize the data.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host     </strong>  
  <info>int   </info>  <strong>$port     </strong>  
  <info>integr</info>  <strong>$mode     </strong>  
  <info>int   </info>  <strong>$sock_type</strong>  


id: Swoole\Server::addProcess
type: function
doc:
<comment>Description:</comment>
  Add a user defined swoole_process to the server.

<comment>Param:</comment>
  <info>swoole_process</info>  <strong>$process</strong>  

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


id: Swoole\Server::addlistener
type: function
doc:
<comment>Description:</comment>
  Add a new listener to the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host       </strong>  
  <info>int   </info>  <strong>$port       </strong>  
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int     </info>  <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback     </strong>  
  <info>string  </info>  <strong>$param        </strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::bind
type: function
doc:
<comment>Description:</comment>
  Bind the connection to a user defined user ID.

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

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


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Stop and destory a timer.
  
  Stile orientato agli oggetti (method):
  
  Stile procedurale:
  
  Stop and destory a timer

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

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


id: Swoole\Server::close
type: function
doc:
<comment>Description:</comment>
  Close a connection to the client.

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

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


id: Swoole\Server::confirm
type: function
doc:
<comment>Description:</comment>
  Check status of the connection.

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

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


id: Swoole\Server::connection_info
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

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

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


id: Swoole\Server::connection_list
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::defer
type: function
doc:
<comment>Description:</comment>
  Delay execution of the callback function at the end of current EventLoop.

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

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


id: Swoole\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the connection is existed.

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

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


id: Swoole\Server::finish
type: function
doc:
<comment>Description:</comment>
  Used in task process for sending result to the worker process when the task is finished.

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

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


id: Swoole\Server::getClientInfo
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::getClientList
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::getLastError
type: function
doc:
<comment>Description:</comment>
  Get the error code of the most recent error.

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


id: Swoole\Server::heartbeat
type: function
doc:
<comment>Description:</comment>
  Check all the connections on the server.

<comment>Param:</comment>
  <info>bool</info>  <strong>$if_close_connection</strong>  

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


id: Swoole\Server::listen
type: function
doc:
<comment>Description:</comment>
  Listen on the given IP and port, socket type.

<comment>Param:</comment>
  <info>string</info>  <strong>$host       </strong>  
  <info>int   </info>  <strong>$port       </strong>  
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::on
type: function
doc:
<comment>Description:</comment>
  Register a callback function by event name.

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

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


id: Swoole\Server::pause
type: function
doc:
<comment>Description:</comment>
  Stop receiving data from the connection.

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

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


id: Swoole\Server::protect
type: function
doc:
<comment>Description:</comment>
  Set the connection to be protected mode.

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

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


id: Swoole\Server::reload
type: function
doc:
<comment>Description:</comment>
  Restart all the worker process.

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


id: Swoole\Server::resume
type: function
doc:
<comment>Description:</comment>
  Start receving data from the connection.

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

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


id: Swoole\Server::send
type: function
doc:
<comment>Description:</comment>
  Send data to the client.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Swoole\Server::sendMessage
type: function
doc:
<comment>Description:</comment>
  Send message to worker processes by ID.

<comment>Param:</comment>
  <info>      </info>  <strong>$dst_worker_id</strong>  
  <info>string</info>  <strong>$data         </strong>  

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


id: Swoole\Server::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the connection.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Swoole\Server::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip           </strong>  
  <info>int   </info>  <strong>$port         </strong>  
  <info>string</info>  <strong>$data         </strong>  
  <info>string</info>  <strong>$server_socket</strong>  

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


id: Swoole\Server::sendwait
type: function
doc:
<comment>Description:</comment>
  Send data to the remote socket in the blocking way.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Swoole\Server::set
type: function
doc:
<comment>Description:</comment>
  Set the runtime settings of the swoole server.
  
  Set the runtime settings of the swoole server. The settings can be accessed by $server-&gt;setting
  when the swoole server has started.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the master server process, this function can be called in worker processes.

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


id: Swoole\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the Swoole server.

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


id: Swoole\Server::stats
type: function
doc:
<comment>Description:</comment>
  Get the stats of the Swoole server.

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


id: Swoole\Server::stop
type: function
doc:
<comment>Description:</comment>
  Stop the Swoole server.

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

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


id: Swoole\Server::task
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string  </info>  <strong>$data         </strong>  
  <info>int     </info>  <strong>$dst_worker_id</strong>  
  <info>callable</info>  <strong>$callback     </strong>  

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


id: Swoole\Server::taskWaitMulti
type: function
doc:
<comment>Description:</comment>
  Execute multiple tasks concurrently.

<comment>Param:</comment>
  <info>array </info>  <strong>$tasks     </strong>  
  <info>double</info>  <strong>$timeout_ms</strong>  

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


id: Swoole\Server::taskwait
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes in blocking way.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$data     </strong>  
  <info>float </info>  <strong>$timeout  </strong>  
  <info>int   </info>  <strong>$worker_id</strong>  

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


id: Swoole\Server::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

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

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


id: Swoole\Table::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole memory table with fixed size.

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


id: Swoole\Table::column
type: function
doc:
<comment>Description:</comment>
  Set the data type and size of the columns.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  
  <info>string</info>  <strong>$type</strong>  
  <info>int   </info>  <strong>$size</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::count
type: function
doc:
<comment>Description:</comment>
  Count the rows in the table, or count all the elements in the table if $mode = 1.

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


id: Swoole\Table::create
type: function
doc:
<comment>Description:</comment>
  Create the swoole memory table.

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


id: Swoole\Table::current
type: function
doc:
<comment>Description:</comment>
  Get the current row.

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


id: Swoole\Table::decr
type: function
doc:
<comment>Description:</comment>
  Decrement the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  
  <info>string</info>  <strong>$column</strong>  
  <info>int   </info>  <strong>$decrby</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::del
type: function
doc:
<comment>Description:</comment>
  Delete a row in the Swoole table by $row_key.

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

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


id: Swoole\Table::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy the Swoole table.

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


id: Swoole\Table::exist
type: function
doc:
<comment>Description:</comment>
  Check if a row is existed by $row_key.

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

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


id: Swoole\Table::get
type: function
doc:
<comment>Description:</comment>
  Get the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$row_key   </strong>  
  <info>string</info>  <strong>$column_key</strong>  

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


id: Swoole\Table::incr
type: function
doc:
<comment>Description:</comment>
  Increment the value by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  
  <info>string</info>  <strong>$column</strong>  
  <info>int   </info>  <strong>$incrby</strong>  

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


id: Swoole\Table::key
type: function
doc:
<comment>Description:</comment>
  Get the key of current row.

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


id: Swoole\Table::next
type: function
doc:
<comment>Description:</comment>
  Iterator the next row.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator.

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


id: Swoole\Table::set
type: function
doc:
<comment>Description:</comment>
  Update a row of the table by $row_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  
  <info>array </info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>VOID</info>  


id: Swoole\Table::valid
type: function
doc:
<comment>Description:</comment>
  Check current if the current row is valid.

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


id: Swoole\Timer::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.
  
  Trigger a callback function after a period of time.

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

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


id: Swoole\Timer::clear
type: function
doc:
<comment>Description:</comment>
  Delete a timer by timer ID.
  
  Delete a timer by timer ID.

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

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


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer is existed.
  
  Check if a timer 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>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int     </info>  <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback   </strong>  
  <info>string  </info>  <strong>$param      </strong>  

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


id: Swoole\WebSocket\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the file descriptor exists.

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

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


id: Swoole\WebSocket\Server::on
type: function
doc:
<comment>Description:</comment>
  Register event callback function
  
  Register event callback function

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\WebSocket\Server::pack
type: function
doc:
<comment>Description:</comment>
  Get a pack of binary data to send in a single frame.

<comment>Param:</comment>
  <info>string</info>  <strong>$data  </strong>  
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  
  <info>string</info>  <strong>$mask  </strong>  

<comment>Return:</comment>
  <info>binary</info>  


id: Swoole\WebSocket\Server::push
type: function
doc:
<comment>Description:</comment>
  Push data to the remote client.

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

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


id: Swoole\WebSocket\Server::unpack
type: function
doc:
<comment>Description:</comment>
  Unpack the binary data received from the client.

<comment>Param:</comment>
  <info>binary</info>  <strong>$data</strong>  

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


id: SyncEvent
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed event objects.  Both automatic and
  manual event objects are supported.
  
  An event object waits, without polling, for the object to be fired/set. One instance waits on the
  event object while another instance fires/sets the event.  Event objects are useful wherever a
  long-running process would otherwise poll a resource (e.g. checking to see if uploaded data needs
  to be processed).


id: SyncEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncEvent object
  
  Constructs a named or unnamed event object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  The name of the event if this is a named event object.
                    
                    If the name already exists, it must be able to be opened by the current user
                    that the process is running as or an exception will be thrown with a meaningless
                    error message.
  <info>bool  </info>  <strong>$manual </strong>  Specifies whether or not the event object must be reset manually.
                    
                    Manual reset event objects allow all waiting processes through until the object
                    is reset.
  <info>bool  </info>  <strong>$prefire</strong>  Specifies whether or not to prefire (signal) the event object.
                    
                    Only has impact if the calling process/thread is the first to create the object.

<comment>Return:</comment>
  <info>unknown</info>  The new SyncEvent object.  An exception is thrown if the event object cannot be created
           or opened.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::fire
type: function
doc:
<comment>Description:</comment>
  Fires/sets the event
  
  Fires/sets a SyncEvent object.  Lets multiple threads through that are waiting if the event object
  was created with a manual value of TRUE.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the event was fired, FALSE otherwise.

<comment>See Also:</comment>
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::reset
type: function
doc:
<comment>Description:</comment>
  Resets a manual event
  
  Resets a SyncEvent object that has been fired/set.  Only valid for manual event objects.

<comment>Return:</comment>
  <info>bool</info>  A boolean value of TRUE if the object was successfully reset, FALSE otherwise.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::wait
type: function
doc:
<comment>Description:</comment>
  Waits for the event to be fired/set
  
  Waits for the SyncEvent object to be fired.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the event to be fired. A value of -1 is
              infinite.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the event was fired, FALSE otherwise.

<comment>See Also:</comment>
   * SyncEvent::fire


id: SyncMutex
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed countable mutex objects.
  
  A mutex is a mutual exclusion object that restricts access to a shared resource (e.g. a file) to a
  single instance. Countable mutexes acquire the mutex a single time and internally track the number
  of times the mutex is locked. The mutex is unlocked as soon as it goes out of scope or is unlocked
  the same number of times that it was locked.


id: SyncMutex::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncMutex object
  
  Constructs a named or unnamed countable mutex.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the mutex if this is a named mutex object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.

<comment>Return:</comment>
  <info>unknown</info>  The new SyncMutex object.  An exception is thrown if the mutex cannot be created or
           opened.

<comment>See Also:</comment>
   * SyncMutex::lock
   * SyncMutex::unlock


id: SyncMutex::lock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive lock
  
  Obtains an exclusive lock on a SyncMutex object. If the lock is already acquired, then this
  increments an internal counter.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the exclusive lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the lock was obtained, FALSE otherwise.

<comment>See Also:</comment>
   * SyncMutex::unlock


id: SyncMutex::unlock
type: function
doc:
<comment>Description:</comment>
  Unlocks the mutex
  
  Decreases the internal counter of a SyncMutex object. When the internal counter reaches zero, the
  actual lock on the object is released.

<comment>Param:</comment>
  <info>bool</info>  <strong>$all</strong>  Specifies whether or not to set the internal counter to zero and therefore release the
              lock.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the unlock operation was successful, FALSE otherwise.

<comment>See Also:</comment>
   * SyncMutex::lock


id: SyncReaderWriter
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed reader-writer objects.
  
  A reader-writer object allows many readers or one writer to access a resource. This is an
  efficient solution for managing resources where access will primarily be read-only but exclusive
  write access is occasionally necessary.


id: SyncReaderWriter::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncReaderWriter object
  
  Constructs a named or unnamed reader-writer object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name      </strong>  The name of the reader-writer if this is a named reader-writer object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
  <info>bool  </info>  <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the reader-writer at the
                       conclusion of the PHP script.
                       
                       If an object is:  A named reader-writer with an autounlock of FALSE, the
                       object is locked for either reading or writing, and the PHP script concludes
                       before the object is unlocked, then the underlying objects will end up in an
                       inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new SyncReaderWriter object.  An exception is thrown if the reader-writer cannot be
           created or opened.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock
   * SyncReaderWriter::readunlock
   * SyncReaderWriter::writelock
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::readlock
type: function
doc:
<comment>Description:</comment>
  Waits for a read lock
  
  Obtains a read lock on a SyncReaderWriter object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the lock was obtained, FALSE otherwise.

<comment>See Also:</comment>
   * SyncReaderWriter::readunlock


id: SyncReaderWriter::readunlock
type: function
doc:
<comment>Description:</comment>
  Releases a read lock
  
  Releases a read lock on a SyncReaderWriter object.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the unlock operation was successful, FALSE otherwise.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock


id: SyncReaderWriter::writelock
type: function
doc:
<comment>Description:</comment>
  Waits for an exclusive write lock
  
  Obtains an exclusive write lock on a SyncReaderWriter object.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for a lock. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the lock was obtained, FALSE otherwise.

<comment>See Also:</comment>
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::writeunlock
type: function
doc:
<comment>Description:</comment>
  Releases a write lock
  
  Releases a write lock on a SyncReaderWriter object.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the unlock operation was successful, FALSE otherwise.

<comment>See Also:</comment>
   * SyncReaderWriter::writelock


id: SyncSemaphore
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native implementation of named and unnamed semaphore objects.
  
  A semaphore restricts access to a limited resource to a limited number of instances. Semaphores
  differ from mutexes in that they can allow more than one instance to access a resource at one time
  while a mutex only allows one instance at a time.


id: SyncSemaphore::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSemaphore object
  
  Constructs a named or unnamed semaphore.

<comment>Param:</comment>
  <info>string</info>  <strong>$name      </strong>  The name of the semaphore if this is a named semaphore object.
                       
                       If the name already exists, it must be able to be opened by the current user
                       that the process is running as or an exception will be thrown with a
                       meaningless error message.
  <info>int   </info>  <strong>$initialval</strong>  The initial value of the semaphore.  This is the number of locks that may be
                       obtained.
  <info>bool  </info>  <strong>$autounlock</strong>  Specifies whether or not to automatically unlock the semaphore at the
                       conclusion of the PHP script.
                       
                       If an object is:  A named semaphore with an autounlock of FALSE, the object
                       is locked, and the PHP script concludes before the object is unlocked, then
                       the underlying semaphore will end up in an inconsistent state.

<comment>Return:</comment>
  <info>unknown</info>  The new SyncSemaphore object.  An exception is thrown if the semaphore cannot be created
           or opened.

<comment>See Also:</comment>
   * SyncSemaphore::lock
   * SyncSemaphore::unlock


id: SyncSemaphore::lock
type: function
doc:
<comment>Description:</comment>
  Decreases the count of the semaphore or waits
  
  Decreases the count of a SyncSemaphore object or waits until the semaphore becomes non-zero.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  The number of milliseconds to wait for the semaphore. A value of -1 is infinite.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the lock operation was successful, FALSE otherwise.

<comment>See Also:</comment>
   * SyncSemaphore::unlock


id: SyncSemaphore::unlock
type: function
doc:
<comment>Description:</comment>
  Increases the count of the semaphore
  
  Increases the count of a SyncSemaphore object.

<comment>Param:</comment>
  <info>int</info>  <strong>$prevcount</strong>  Returns the previous count of the semaphore.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the unlock operation was successful, FALSE otherwise.

<comment>See Also:</comment>
   * SyncSemaphore::lock


id: SyncSharedMemory
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native, consistent implementation of named shared memory objects.
  
  Shared memory lets two separate processes communicate without the need for complex pipes or
  sockets.  There are several integer-based shared memory implementations for PHP.  Named shared
  memory is an alternative.
  
  Synchronization objects (e.g. SyncMutex) are still required to protect most uses of shared memory.


id: SyncSharedMemory::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSharedMemory object
  
  Constructs a named shared memory object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the shared memory object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.
  <info>int   </info>  <strong>$size</strong>  The size, in bytes, of shared memory to reserve.
                 
                 The amount of memory cannot be resized later.  Request sufficient storage up front.

<comment>Return:</comment>
  <info>unknown</info>  The new SyncSharedMemory object.  An exception is thrown if the shared memory object
           cannot be created or opened.

<comment>See Also:</comment>
   * SyncSharedMemory::first
   * SyncSharedMemory::size
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::first
type: function
doc:
<comment>Description:</comment>
  Check to see if the object is the first instance system-wide of named shared memory
  
  Retrieves the system-wide first instance status of a SyncSharedMemory object.

<comment>Return:</comment>
  <info>bool</info>  A boolean of TRUE if the object is the first instance system-wide, FALSE otherwise.

<comment>See Also:</comment>
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::read
type: function
doc:
<comment>Description:</comment>
  Copy data from named shared memory
  
  Copies data from named shared memory.

<comment>Param:</comment>
  <info>int</info>  <strong>$start </strong>  The start/offset, in bytes, to begin reading.
                
                If the value is negative, the starting position will begin at the specified number
                of bytes from the end of the shared memory segment.
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.
                
                If unspecified, reading will stop at the end of the shared memory segment.
                
                If the value is negative, reading will stop the specified number of bytes from the
                end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  A string containing the data read from shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the named shared memory
  
  Retrieves the shared memory size of a SyncSharedMemory object.

<comment>Return:</comment>
  <info>bool</info>  An integer containing the size of the shared memory.  This will be the same size that was
        passed to the constructor.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::write
type: function
doc:
<comment>Description:</comment>
  Copy data to named shared memory
  
  Copies data to named shared memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The data to write to shared memoy.
                   
                   If the size of the data exceeds the size of the shared memory, the number of
                   bytes written returned will be less than the length of the input.
  <info>int   </info>  <strong>$start </strong>  The start/offset, in bytes, to begin writing.
                   
                   If the value is negative, the starting position will begin at the specified
                   number of bytes from the end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  An integer containing the number of bytes written to shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: Table::count
type: function
doc:
<comment>Description:</comment>
  Get row count
  
  Fetch the number of rows in the table.

<comment>Return:</comment>
  <info>int</info>  The total number of rows in the table.


id: Table::delete
type: function
doc:
<comment>Description:</comment>
  Delete rows from table
  
  Deletes rows from a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object; use the execute() method to execute the delete
                             query.


id: Table::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if table exists in database
  
  Verifies if this table exists in the database.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if table exists in the database, else <info>false</info> if it does not.


id: Table::getName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Returns the name of this database object.

<comment>Return:</comment>
  <info>string</info>  The name of this database object.


id: Table::getSchema
type: function
doc:
<comment>Description:</comment>
  Get table schema
  
  Fetch the schema associated with the table.

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


id: Table::getSession
type: function
doc:
<comment>Description:</comment>
  Get table session
  
  Get session associated with the table.

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


id: Table::insert
type: function
doc:
<comment>Description:</comment>
  Insert table rows
  
  Inserts rows into a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns     </strong>  The columns to insert data into. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  A TableInsert object; use the execute() method to execute the insert
                             statement.


id: Table::isView
type: function
doc:
<comment>Description:</comment>
  Check if table is view
  
  Determine if the underlying object is a view or not.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the underlying object is a view, otherwise <info>false</info>.


id: Table::select
type: function
doc:
<comment>Description:</comment>
  Select rows from table
  
  Fetches data from a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns     </strong>  The columns to select data from. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns parameter definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object; use the execute() method to execute the select
                             and return a RowResult object.


id: Table::update
type: function
doc:
<comment>Description:</comment>
  Update rows in table
  
  Updates columns in a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object; use the execute() method to execute the update
                             statement.


id: TableDelete::__construct
type: function
doc:
<comment>Description:</comment>
  TableDelete constructor
  
  Initiated by using the delete() method.


id: TableDelete::bind
type: function
doc:
<comment>Description:</comment>
  Bind delete query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder and the value to bind.

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


id: TableDelete::execute
type: function
doc:
<comment>Description:</comment>
  Execute delete query
  
  Execute the delete query.

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


id: TableDelete::limit
type: function
doc:
<comment>Description:</comment>
  Limit deleted rows
  
  Sets the maximum number of records or documents to delete.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to delete.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableDelete::orderby
type: function
doc:
<comment>Description:</comment>
  Set delete sort criteria
  
  Set the order options for a result set.

<comment>Param:</comment>
  <info>string</info>  <strong>$orderby_expr</strong>  The sort definition.

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


id: TableDelete::where
type: function
doc:
<comment>Description:</comment>
  Set delete search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableInsert::__construct
type: function
doc:
<comment>Description:</comment>
  TableInsert constructor
  
  Initiated by using the insert() method.


id: TableInsert::execute
type: function
doc:
<comment>Description:</comment>
  Execute insert query
  
  Execute the statement.

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


id: TableInsert::values
type: function
doc:
<comment>Description:</comment>
  Add insert row values
  
  Set the values to be inserted.

<comment>Param:</comment>
  <info>array</info>  <strong>$row_values</strong>  Values (an array) of columns to insert.

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


id: TableSelect::__construct
type: function
doc:
<comment>Description:</comment>
  TableSelect constructor
  
  An object returned by the select() method; use execute() to  execute the query.


id: TableSelect::bind
type: function
doc:
<comment>Description:</comment>
  Bind select query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind.

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


id: TableSelect::execute
type: function
doc:
<comment>Description:</comment>
  Execute select statement
  
  Execute the select statement by chaining it with the execute() method.

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


id: TableSelect::groupBy
type: function
doc:
<comment>Description:</comment>
  Set select grouping criteria
  
  Sets a grouping criteria for the result set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>  The grouping criteria.

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


id: TableSelect::having
type: function
doc:
<comment>Description:</comment>
  Set select having condition
  
  Sets a condition for records to consider in aggregate function operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  A condition on the aggregate functions used on the grouping criteria.

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


id: TableSelect::limit
type: function
doc:
<comment>Description:</comment>
  Limit selected rows
  
  Sets the maximum number of records or documents to return.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents.

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


id: TableSelect::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute EXCLUSIVE LOCK
  
  Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect object.


id: TableSelect::lockShared
type: function
doc:
<comment>Description:</comment>
  Execute SHARED LOCK
  
  Execute a read operation with SHARED LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>.
                             Valid values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

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


id: TableSelect::offset
type: function
doc:
<comment>Description:</comment>
  Set limit offset
  
  Skip given number of rows in result.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The limit offset.

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


id: TableSelect::orderby
type: function
doc:
<comment>Description:</comment>
  Set select sort criteria
  
  Sets the order by criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr </strong>  The expressions that define the order by criteria. Can be an array with one or
                      more expressions, or a string.
  <info>mixed</info>  <strong>$sort_exprs</strong>  Additional sort_expr parameters.

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


id: TableSelect::where
type: function
doc:
<comment>Description:</comment>
  Set select search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

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


id: TableUpdate::__construct
type: function
doc:
<comment>Description:</comment>
  TableUpdate constructor
  
  Initiated by using the update() method.


id: TableUpdate::bind
type: function
doc:
<comment>Description:</comment>
  Bind update query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind, defined as a JSON
                              array.

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


id: TableUpdate::execute
type: function
doc:
<comment>Description:</comment>
  Execute update query
  
  Executes the update statement.

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


id: TableUpdate::limit
type: function
doc:
<comment>Description:</comment>
  Limit update row count
  
  Set the maximum number of records or documents update.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to update.

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


id: TableUpdate::orderby
type: function
doc:
<comment>Description:</comment>
  Set sorting criteria
  
  Sets the sorting criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$orderby_expr </strong>  The expressions that define the order by criteria. Can be an array with one
                         or more expressions, or a string.
  <info>mixed</info>  <strong>$orderby_exprs</strong>  Additional sort_expr parameters.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::set
type: function
doc:
<comment>Description:</comment>
  Add field to be updated
  
  Updates the column value on records in a table.

<comment>Param:</comment>
  <info>string</info>  <strong>$table_field          </strong>  The column name to be updated.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to be set on the specified column.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::where
type: function
doc:
<comment>Description:</comment>
  Set search filter
  
  Set the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  The search condition to filter documents or records.

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


id: Thread
type: class
doc:
<comment>Description:</comment>
  When the start method of a Thread is invoked, the run method code will be executed in separate
  Thread, in parallel.
  
  After the run method is executed the Thread will exit immediately, it will be joined with the
  creating Thread at the appropriate time.
  
  Relying on the engine to determine when a Thread should join may cause undesirable behaviour; the
  programmer should be explicit, where possible.


id: Thread::detach
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Detaches the referenced Thread from the calling context, dangerous!
  
  This method can cause undefined, unsafe behaviour. It should not usually be used, it is present
  for completeness and advanced use cases.

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


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the Thread that created the referenced Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Return a reference to the currently executing Thread

<comment>Return:</comment>
  <info>Thread</info>  An object representing the currently executing Thread


id: Thread::getCurrentThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the currently executing Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::getThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Will return the identity of the referenced Thread

<comment>Return:</comment>
  <info>int</info>  A numeric identity


id: Thread::globally
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Will execute a Callable in the global scope

<comment>Return:</comment>
  <info>mixed</info>  The return value of the Callable


id: Thread::isJoined
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced Thread has been joined

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Thread::isStarted
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced Thread was started

<comment>Return:</comment>
  <info>bool</info>  boolean indication of state


id: Thread::join
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Causes the calling context to wait for the referenced Thread to finish executing

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Thread::kill
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Forces the referenced Thread to terminate
  
  The programmer should not ordinarily kill Threads by force

<comment>Return:</comment>
  <info>void</info>  A boolean indication of success


id: Thread::start
type: function
doc:
<comment>Description:</comment>
  Execution
  
  Will start a new Thread to execute the implemented run method

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  An optional mask of inheritance constants, by default PTHREADS_INHERIT_ALL

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded
type: class
doc:
<comment>Description:</comment>
  Threaded objects form the basis of pthreads ability to execute user code in parallel; they expose
  synchronization methods and various useful interfaces.
  
  Threaded objects, most importantly, provide implicit safety for the programmer; all operations on
  the object scope are safe.


id: Threaded::chunk
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Fetches a chunk of the objects property table of the given size, optionally preserving keys

<comment>Param:</comment>
  <info>int </info>  <strong>$size    </strong>  The number of items to fetch
  <info>bool</info>  <strong>$preserve</strong>  Preserve the keys of members, by default false

<comment>Return:</comment>
  <info>array</info>  An array of items from the objects property table


id: Threaded::count
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Returns the number of properties for this object

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


id: Threaded::extend
type: function
doc:
<comment>Description:</comment>
  Runtime Manipulation
  
  Makes thread safe standard class at runtime

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The class to extend

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::from
type: function
doc:
<comment>Description:</comment>
  Creation
  
  Creates an anonymous Threaded object from closures

<comment>Param:</comment>
  <info>Closure</info>  <strong>$run      </strong>  The closure to use for ::run
  <info>Closure</info>  <strong>$construct</strong>  The constructor to use for anonymous object
  <info>array  </info>  <strong>$args     </strong>  The arguments to pass to constructor

<comment>Return:</comment>
  <info>Threaded</info>  A new anonymous Threaded object


id: Threaded::getTerminationInfo
type: function
doc:
<comment>Description:</comment>
  Error Detection
  
  Retrieves terminal error information from the referenced object

<comment>Return:</comment>
  <info>array</info>  array containing the termination conditions of the referenced object


id: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object is executing

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state  A object is considered running while executing the run method 
        
        A object is considered running while executing the run method


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object was terminated during execution; suffered fatal errors, or threw
  uncaught exceptions

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Threaded::isWaiting
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object is waiting for notification

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Threaded::lock
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Lock the referenced objects property table

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Merges data into the current object

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from     </strong>  The data to merge
  <info>bool </info>  <strong>$overwrite</strong>  Overwrite existing keys, by default true

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object. This unblocks at least one of the blocked threads (as
  opposed to unblocking all of them, as seen with Threaded::notify).

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Pops an item from the objects property table

<comment>Return:</comment>
  <info>bool</info>  The last item from the objects property table


id: Threaded::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  The programmer should always implement the run method for objects that are intended for execution.

<comment>Return:</comment>
  <info>void</info>  The methods return value, if used, will be ignored


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Shifts an item from the objects property table

<comment>Return:</comment>
  <info>mixed</info>  The first item from the objects property table


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Executes the block while retaining the referenced objects synchronization lock for the calling
  context

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  The block of code to execute
  <info>mixed  </info>  <strong>$args </strong>  Variable length list of arguments to use as function arguments to the block

<comment>Return:</comment>
  <info>mixed</info>  The return value from the block


id: Threaded::unlock
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Unlock the referenced objects storage for the calling context

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Will cause the calling context to wait for notification from the referenced object

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An optional timeout in microseconds

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of success


id: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> is the base interface for any object that can be thrown via a <return>throw</return> statement, including
  <class>Error</class> and <class>Exception</class>.
  
  PHP classes cannot implement the <class>Throwable</class> interface directly, and must instead extend <class>Exception</class>.


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  Gets a string representation of the thrown object

<comment>Return:</comment>
  <info>string</info>  Returns the <info>string</info> representation of the thrown object.

<comment>See Also:</comment>
   * Exception::__toString


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  Gets the exception code
  
  Returns the error code associated with the thrown object.

<comment>Return:</comment>
  <info>int</info>  Returns the exception code as <info>int</info> in <class>Exception</class> but possibly as other type in <class>Exception</class>
       descendants (for example as <info>string</info> in <class>PDOException</class>).

<comment>See Also:</comment>
   * Exception::getCode


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  Gets the file in which the object was created
  
  Get the name of the file in which the thrown object was created.

<comment>Return:</comment>
  <info>string</info>  Returns the filename in which the thrown object was created.

<comment>See Also:</comment>
   * Exception::getFile


id: Throwable::getLine
type: function
doc:
<comment>Description:</comment>
  Gets the line on which the object was instantiated
  
  Returns the line number where the thrown object was instantiated.

<comment>Return:</comment>
  <info>int</info>  Returns the line number where the thrown object was instantiated.

<comment>See Also:</comment>
   * Exception::getLine


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  Gets the message
  
  Returns the message associated with the thrown object.

<comment>Return:</comment>
  <info>string</info>  Returns the message associated with the thrown object.

<comment>See Also:</comment>
   * Exception::getMessage


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  Returns the previous Throwable
  
  Returns any previous Throwable (for example, one provided as the third parameter to
  Exception::__construct).

<comment>Return:</comment>
  <info>Throwable</info>  Returns the previous <class>Throwable</class> if available, or <info>null</info> otherwise.

<comment>See Also:</comment>
   * Exception::getPrevious


id: Throwable::getTrace
type: function
doc:
<comment>Description:</comment>
  Gets the stack trace
  
  Returns the stack trace as an <info>array</info>.

<comment>Return:</comment>
  <info>array</info>  Returns the stack trace as an <info>array</info> in the same format as <strong>debug_backtrace()</strong>.

<comment>See Also:</comment>
   * Exception::getTrace


id: Throwable::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  Gets the stack trace as a string

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

<comment>See Also:</comment>
   * Exception::getTraceAsString


id: TokyoTyrant::RDBQCFTS_EX
type: constant
doc:
<comment>Description:</comment>
  Metasearch difference between records (Tokyo Tyrant &gt;= 1.1.33)


id: TokyoTyrant::RDBQCFTS_OR
type: constant
doc:
<comment>Description:</comment>
  Metasearch intersection between records (Tokyo Tyrant &gt;= 1.1.33)


id: TokyoTyrant::RDBT_RECON
type: constant
doc:
<comment>Description:</comment>
  Whether to reconnect on connection failure.  It is recommended to have this parameter on for
  persistent connections


id: TokyoTyrant::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new TokyoTyrant object
  
  Constructs a new TokyoTyrant object and optionally connects to the database

<comment>Param:</comment>
  <info>string</info>  <strong>$host   </strong>  The hostname. Default: <info>null</info>
  <info>int   </info>  <strong>$port   </strong>  port number. Default: 1978
  <info>array </info>  <strong>$options</strong>  Connection options: timeout (default: 5.0), reconnect (default: <info>true</info>) and
                    persistent (default: <info>true</info>)

<comment>Return:</comment>
  <info>unknown</info>  Throws TokyoTyrantException if connection to database fails

<comment>See Also:</comment>
   * TokyoTyrant::connect
   * TokyoTyrant::connectUri


id: TokyoTyrant::add
type: function
doc:
<comment>Description:</comment>
  Adds to a numeric key
  
  Adds to an int or double value. This increments the value by the given amount and returns the new
  value. If the key does not exist a new key is created with initial value of the increment
  parameter.

<comment>Param:</comment>
  <info>string  </info>  <strong>$key      </strong>  The string key
  <info>intfloat</info>  <strong>$increment</strong>  The amount to increment
  <info>int     </info>  <strong>$type     </strong>  <info>TokyoTyrant::RDBREC_INT</info> or <info>TokyoTyrant::RDBREC_DBL</info> constant. If this
                        parameter is omitted the type is guessed from the <strong>$increment</strong> parameters
                        type.

<comment>Return:</comment>
  <info>intfloat</info>  Returns the new value on success

<comment>See Also:</comment>
   * TokyoTyrant::put
   * TokyoTyrant::putcat
   * TokyoTyrant::putkeep


id: TokyoTyrant::connect
type: function
doc:
<comment>Description:</comment>
  Connect to a database
  
  Connects to a remote database

<comment>Param:</comment>
  <info>string</info>  <strong>$host   </strong>  The hostname
  <info>int   </info>  <strong>$port   </strong>  The port. Default: 1978
  <info>array </info>  <strong>$options</strong>  Connection options: timeout (default: 5.0), reconnect (default: <info>true</info>) and
                    persistent (default: <info>true</info>)

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrant::connectUri


id: TokyoTyrant::connectUri
type: function
doc:
<comment>Description:</comment>
  Connects to a database
  
  Connects to a database using an uri

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  An URI to the database. For example <return>tcp://localhost:1979/</return>

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrant::connect


id: TokyoTyrant::copy
type: function
doc:
<comment>Description:</comment>
  Copies the database
  
  Makes a copy of the current database

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Path to where to copy the database. The user running the remote  database must have
                 a write access to the directory.

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrant::restore


id: TokyoTyrant::ext
type: function
doc:
<comment>Description:</comment>
  Execute a remote script
  
  Executes a remote script extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  Name of the function to execute
  <info>int   </info>  <strong>$options</strong>  Either <info>TokyoTyrant::RDBXO_LCKREC</info> for record locking and
                    <info>TokyoTyrant::RDBXO_LCKGLB</info> for global locking.
  <info>string</info>  <strong>$key    </strong>  The key to pass to the function
  <info>string</info>  <strong>$value  </strong>  The value to pass to the function

<comment>Return:</comment>
  <info>string</info>  Returns the result of the script function


id: TokyoTyrant::fwmKeys
type: function
doc:
<comment>Description:</comment>
  Returns the forward matching keys
  
  Returns the forward matching keys from the database

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix  </strong>  Prefix of the keys
  <info>int   </info>  <strong>$max_recs</strong>  Maximum records to return

<comment>Return:</comment>
  <info>array</info>  Returns an array of matching keys. The values are not returned


id: TokyoTyrant::get
type: function
doc:
<comment>Description:</comment>
  The get purpose
  
  This method is used to return a value or multiple values. This method accepts a <info>string</info> or an <info>array</info>
  as a value.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  A <info>string</info> key or an <info>array</info> of <info>string</info> keys

<comment>Return:</comment>
  <info>mixed</info>  Returns a string or an array based on the given parameters. Throws a TokyoTyrantException
         on error. If string is passed null is returned if the key is not found. In case an array is
         given as an parameter only existing keys will be returned. It is not an error to pass  a
         key that does not exist.

<comment>See Also:</comment>
   * TokyoTyrant::put


id: TokyoTyrant::getIterator
type: function
doc:
<comment>Description:</comment>
  Get an iterator
  
  Gets an iterator for iterating all keys / values in the database.

<comment>Return:</comment>
  <info>TokyoTyrantIterator</info>  This method returns TokyoTyrantIterator object and throws
                       TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrantTable::getQuery
   * TokyoTyrantTable::getIterator


id: TokyoTyrant::num
type: function
doc:
<comment>Description:</comment>
  Number of records in the database
  
  Returns the number of records in the database

<comment>Return:</comment>
  <info>int</info>  Returns number of records in the database

<comment>See Also:</comment>
   * TokyoTyrant::stat


id: TokyoTyrant::out
type: function
doc:
<comment>Description:</comment>
  Removes records
  
  Removes a record or multiple records. This method accepts a <info>string</info> for a single key or an array of
  keys for multiple records.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  A <info>string</info> key or an <info>array</info> of <info>string</info> keys

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrant::put


id: TokyoTyrant::put
type: function
doc:
<comment>Description:</comment>
  Puts values
  
  Puts a key-value pair into the database or multiple key-value pairs. If <strong>$keys</strong> is string then the
  second parameter value defines the value.  The second parameter is mandatory if <strong>$keys</strong> is a string.
  If the key exists the value will be replaced with new value.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$keys </strong>  A string key or an array of key-value pairs
  <info>string</info>  <strong>$value</strong>  The value in case a string key is used

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns a reference to the current object and throws TokyoTyrantException
               on failure.

<comment>See Also:</comment>
   * TokyoTyrant::putKeep
   * TokyoTyrant::putCat


id: TokyoTyrant::putCat
type: function
doc:
<comment>Description:</comment>
  Concatenates to a record
  
  Appends a value into existing key or multiple values if <strong>$keys</strong> is an array. The second parameter is
  mandatory if <strong>$keys</strong> is a string. If the record does  not exist a new record is created.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$keys </strong>  A <info>string</info> key or an <info>array</info> of key-value pairs
  <info>string</info>  <strong>$value</strong>  The value in case a string key is used

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns a reference to the current object and throws TokyoTyrantException
               on failure.

<comment>See Also:</comment>
   * TokyoTyrant::put
   * TokyoTyrant::putKeep


id: TokyoTyrant::putKeep
type: function
doc:
<comment>Description:</comment>
  Puts a record
  
  Puts a key-value pair into the database or multiple key-value pairs. If <strong>$keys</strong> is string then the
  second parameter value defines the value.  The second parameter is mandatory if <strong>$keys</strong> is a string.
  If the key already  exists this method throws an exception indicating that the records exists.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$keys </strong>  A <info>string</info> key or an <info>array</info> of key-value pairs
  <info>string</info>  <strong>$value</strong>  The <info>string</info> value

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns a reference to the current object and throws TokyoTyrantException
               on failure.

<comment>See Also:</comment>
   * TokyoTyrant::put
   * TokyoTyrant::putCat


id: TokyoTyrant::putNr
type: function
doc:
<comment>Description:</comment>
  Puts value
  
  Puts a key-value pair into the database or multiple key-value pairs. If <strong>$keys</strong> is string then the
  second parameter value defines the value.  The second parameter is mandatory if <strong>$keys</strong> is a string.
  This method does not wait for the response from the server.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$keys </strong>  A string key or an array of key-value pairs
  <info>string</info>  <strong>$value</strong>  The value in case a string key is used

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns a reference to the current object and throws TokyoTyrantException
               on failure.

<comment>See Also:</comment>
   * TokyoTyrant::putNr
   * TokyoTyrant::putKeep
   * TokyoTyrant::putCat


id: TokyoTyrant::putShl
type: function
doc:
<comment>Description:</comment>
  Concatenates to a record
  
  Concatenate to a record and shift to left.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  A string key
  <info>string</info>  <strong>$value</strong>  The value to concatenate
  <info>int   </info>  <strong>$width</strong>  The width of the record

<comment>Return:</comment>
  <info>mixed</info>  This method returns a reference to the current object and throws TokyoTyrantException on
         failure.

<comment>See Also:</comment>
   * TokyoTyrant::put
   * TokyoTyrant::putKeep
   * TokyoTyrant::putCat


id: TokyoTyrant::restore
type: function
doc:
<comment>Description:</comment>
  Restore the database
  
  Restore the database from the update log.
  
  This method is not supported on 32bit platforms.

<comment>Param:</comment>
  <info>string</info>  <strong>$log_dir          </strong>  Directory where the log is
  <info>int   </info>  <strong>$timestamp        </strong>  Beginning timestamp with microseconds
  <info>bool  </info>  <strong>$check_consistency</strong>  Whether to check consistency: Default: <info>true</info>

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.


id: TokyoTyrant::setMaster
type: function
doc:
<comment>Description:</comment>
  Set the replication master
  
  Sets the replication master of the database
  
  This method is not supported on 32bit platforms.

<comment>Param:</comment>
  <info>string</info>  <strong>$host             </strong>  Hostname of the replication master. If <info>null</info> the replication is
                              disabled.
  <info>int   </info>  <strong>$port             </strong>  Port of the replication master
  <info>int   </info>  <strong>$timestamp        </strong>  Beginning timestamp with microseconds
  <info>bool  </info>  <strong>$check_consistency</strong>  Whether to check consistency.

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * Classname::Method


id: TokyoTyrant::size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the value
  
  Returns the size of a value by key

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of which size to fetch

<comment>Return:</comment>
  <info>int</info>  Returns the size of the key or throw TokyoTyrantException on error


id: TokyoTyrant::stat
type: function
doc:
<comment>Description:</comment>
  Get statistics
  
  Returns statistics of the remote database

<comment>Return:</comment>
  <info>array</info>  Returns an array of key value pairs describing the statistics

<comment>See Also:</comment>
   * Classname::Method


id: TokyoTyrant::sync
type: function
doc:
<comment>Description:</comment>
  Synchronize the database
  
  Synchronizes the database on to the physical device

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.


id: TokyoTyrant::tune
type: function
doc:
<comment>Description:</comment>
  Tunes connection values
  
  Tunes database connection options.

<comment>Param:</comment>
  <info>float</info>  <strong>$timeout</strong>  The objects timeout value (default: 5.0)
  <info>int  </info>  <strong>$options</strong>  Bitmask of options to tune. This can be either 0 or <info>TokyoTyrant::RDBT_RECON</info>.  It
                   is recommended not to change the second parameter.

<comment>Return:</comment>
  <info>TokyoTyrant</info>  This method returns a reference to the current object and throws TokyoTyrantException
               on failure.


id: TokyoTyrant::vanish
type: function
doc:
<comment>Description:</comment>
  Empties the database
  
  Empties a remote database

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrant::out


id: TokyoTyrantIterator
type: class
doc:
<comment>Description:</comment>
  Provides an iterator for TokyoTyrant and TokyoTyrantTable objects. The iterator iterates over all
  keys and values in the database. TokyoTyrantIterator was added in version 0.2.0.


id: TokyoTyrantIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an iterator
  
  Construct a new TokyoTyrantIterator object. One connection can have multiple iterators but it is
  not quaranteed that all items are traversed in that case. <strong>$object</strong> parameter can be either an of
  instance  TokyoTyrant or TokyoTyrantTable.

<comment>Return:</comment>
  <info>unknown</info>  Throws an exception if iterator initialization fails.

<comment>See Also:</comment>
   * TokyoTyrantIterator::key
   * TokyoTyrantIterator::current
   * TokyoTyrantIterator::next
   * TokyoTyrantIterator::rewind
   * TokyoTyrantIterator::key


id: TokyoTyrantIterator::current
type: function
doc:
<comment>Description:</comment>
  Get the current value
  
  Returns the current value during iteration.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current value on success and false on failure.

<comment>See Also:</comment>
   * TokyoTyrantIterator::valid
   * TokyoTyrantIterator::key
   * TokyoTyrantIterator::next
   * TokyoTyrantIterator::rewind


id: TokyoTyrantIterator::key
type: function
doc:
<comment>Description:</comment>
  Returns the current key
  
  Returns the current key.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current key on success and false on failure.

<comment>See Also:</comment>
   * TokyoTyrantIterator::valid
   * TokyoTyrantIterator::current
   * TokyoTyrantIterator::next
   * TokyoTyrantIterator::rewind


id: TokyoTyrantIterator::next
type: function
doc:
<comment>Description:</comment>
  Move to next key
  
  Move to next key during iteration and return it's value.

<comment>Return:</comment>
  <info>mixed</info>  Returns the next value on success and false on failure.

<comment>See Also:</comment>
   * TokyoTyrantIterator::valid
   * TokyoTyrantIterator::key
   * TokyoTyrantIterator::current
   * TokyoTyrantIterator::rewind


id: TokyoTyrantIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds the iterator
  
  Rewinds the iterator for new iteration. Called automatically at the beginning of foreach.

<comment>Return:</comment>
  <info>void</info>  Throws TokyoTyrantException if iterator initialization fails.

<comment>See Also:</comment>
   * TokyoTyrantIterator::valid
   * TokyoTyrantIterator::current
   * TokyoTyrantIterator::next
   * TokyoTyrantIterator::rewind


id: TokyoTyrantIterator::valid
type: function
doc:
<comment>Description:</comment>
  Rewinds the iterator
  
  Checks whether the internal pointer points to valid element.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current item is valid and <info>false</info> if not.

<comment>See Also:</comment>
   * TokyoTyrantIterator::key
   * TokyoTyrantIterator::current
   * TokyoTyrantIterator::next
   * TokyoTyrantIterator::rewind


id: TokyoTyrantQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new query
  
  Construct a new query object

<comment>Param:</comment>
  <info>TokyoTyrantTable</info>  <strong>$table</strong>  TokyoTyrantTable object with active database connection

<comment>Return:</comment>
  <info>unknown</info>  Returns a new TokyoTyrantQuery object and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantTable::getQuery


id: TokyoTyrantQuery::addCond
type: function
doc:
<comment>Description:</comment>
  Adds a condition to the query
  
  Adds a condition to the query. Condition can be something like: get all keys which value matches
  expr.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the column in the condition
  <info>int   </info>  <strong>$op  </strong>  The operator. One of the <info>TokyoTyrant::RDBQC_*</info> constants
  <info>string</info>  <strong>$expr</strong>  The expression

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * Classname::Method


id: TokyoTyrantQuery::count
type: function
doc:
<comment>Description:</comment>
  Counts records
  
  Returns a count of how many records a query returns.

<comment>Return:</comment>
  <info>int</info>  Returns a count of matching rows and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantQuery::out
   * TokyoTyrantQuery::search
   * TokyoTyrantQuery::metaSearch


id: TokyoTyrantQuery::current
type: function
doc:
<comment>Description:</comment>
  Returns the current element
  
  Returns the current element. Part of Iterator interface

<comment>Return:</comment>
  <info>array</info>  Returns the current row

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::hint
type: function
doc:
<comment>Description:</comment>
  Get the hint string of the query
  
  Get the hint string of the query. The hint string contains information about an executed query and
  it could be compared to for example MySQL EXPLAIN statement.

<comment>Return:</comment>
  <info>string</info>  This method always returns a string

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::key
type: function
doc:
<comment>Description:</comment>
  Returns the current key
  
  Returns the current key. Part of the Iterator interface

<comment>Return:</comment>
  <info>string</info>  Returns the current key and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::metaSearch
type: function
doc:
<comment>Description:</comment>
  Retrieve records with multiple queries
  
  Executes multiple queries on a database and returns matching records. The current object is always
  the left most object in the search.

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  Array of TokyoTyrantQuery objects
  <info>int  </info>  <strong>$type   </strong>  One of the <info>TokyoTyrant::RDBMS_*</info> constants

<comment>Return:</comment>
  <info>array</info>  Returns the matching rows and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantQuery::search


id: TokyoTyrantQuery::next
type: function
doc:
<comment>Description:</comment>
  Moves the iterator to next entry
  
  Returns the next result in the resultset. Part of the Iterator interface.

<comment>Return:</comment>
  <info>array</info>  Returns the next row and throws TokyoTyrantException on error.

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::out
type: function
doc:
<comment>Description:</comment>
  Removes records based on query
  
  Removes all records that match the query. Works exactly like search but removes the records
  instead of returning them.

<comment>Return:</comment>
  <info>TokyoTyrantQuery</info>  This method returns the current object and throws TokyoTyrantException on
                    failure.

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds the iterator
  
  Rewind the resultset and executes the query if it has not been executed. Part of the Iterator
  interface.

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

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantQuery::search
type: function
doc:
<comment>Description:</comment>
  Searches records
  
  Executes a search on the table database. Returns an array of arrays containing the matching
  records. In the returned array the first level is the primary key of the data and the second level
  is the row data.

<comment>Return:</comment>
  <info>array</info>  Returns the matching rows and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantQuery::out
   * TokyoTyrantQuery::metaSearch


id: TokyoTyrantQuery::setLimit
type: function
doc:
<comment>Description:</comment>
  Limit results
  
  Set the maximum amount of records to return on a query.

<comment>Param:</comment>
  <info>int</info>  <strong>$max </strong>  Maximum amount of records. Default: -1
  <info>int</info>  <strong>$skip</strong>  How many records to skip from the start. Default: -1

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.


id: TokyoTyrantQuery::setOrder
type: function
doc:
<comment>Description:</comment>
  Orders results
  
  Sets the order of a query

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The column name to apply the ordering on.
  <info>int   </info>  <strong>$type</strong>  The <strong>$type</strong> can be one of the following  constants:
                 
                 <info>TokyoTyrant::RDBQO_STRASC</info> - String ascending
                 
                 <info>TokyoTyrant::RDBQO_STRDESC</info> - String descending
                 
                 <info>TokyoTyrant::RDBQO_NUMASC</info> - Numberic ascending
                 
                 <info>TokyoTyrant::RDBQO_NUMDESC</info> - String descending

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object.


id: TokyoTyrantQuery::valid
type: function
doc:
<comment>Description:</comment>
  Checks the validity of current item
  
  Checks if the current item is valid. Part of the Iterator interface

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current item is valid and <info>false</info> if not.

<comment>See Also:</comment>
   * TokyoTyrantQuery::addCond


id: TokyoTyrantTable
type: class
doc:
<comment>Description:</comment>
  Provides an API to the table databases. A table database can be create using the following
  command: <return>ttserver -port 1979 /tmp/tt_table.tct</return>. In Tokyo Tyrant the table API is a schemaless
  database which can store arbitrary amount of key-value pairs under a single primary key.


id: TokyoTyrantTable::add
type: function
doc:
<comment>Description:</comment>
  Adds a record
  
  This method is not supported with table databases.

<comment>Param:</comment>
  <info>string</info>  <strong>$key      </strong>  The string key
  <info>mixed </info>  <strong>$increment</strong>  The amount to increment
  <info>string</info>  <strong>$type     </strong>  <info>TokyoTyrant::RDB_RECINT</info> or <info>TokyoTyrant::RDB_RECDBL</info> constant. If this parameter
                      is omitted the type is guessed from the <strong>$increment</strong> parameters type.

<comment>Return:</comment>
  <info>void</info>  This method throws an TokyoTyrantException if used through this class.

<comment>See Also:</comment>
   * TokyoTyrant::add


id: TokyoTyrantTable::genUid
type: function
doc:
<comment>Description:</comment>
  Generate unique id
  
  Generates an unique id inside the table database. In table databases rows are referenced using a
  numeric primary key.

<comment>Return:</comment>
  <info>int</info>  Returns an unique id or throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantTable::put


id: TokyoTyrantTable::get
type: function
doc:
<comment>Description:</comment>
  Get a row
  
  Gets a row from table database. <strong>$keys</strong> is a single integer for  the primary key of the row or an
  array of integers for multiple rows.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  The primary key, can be a string or an integer

<comment>Return:</comment>
  <info>array</info>  Returns the row as an array

<comment>See Also:</comment>
   * TokyoTyrantTable::put


id: TokyoTyrantTable::getIterator
type: function
doc:
<comment>Description:</comment>
  Get an iterator
  
  Gets an iterator for iterating all keys / values in the database.

<comment>Return:</comment>
  <info>TokyoTyrantIterator</info>  This method returns TokyoTyrantIterator object and throws
                       TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrantTable::getQuery
   * TokyoTyrant::getIterator


id: TokyoTyrantTable::getQuery
type: function
doc:
<comment>Description:</comment>
  Get a query object
  
  Get a query object to execute searches on the database

<comment>Return:</comment>
  <info>TokyoTyrantQuery</info>  Returns TokyoTyrantQuery on success and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantQuery::search
   * TokyoTyrantQuery::out


id: TokyoTyrantTable::out
type: function
doc:
<comment>Description:</comment>
  Remove records
  
  Removes records from a table database.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  A single integer key or an array of integers

<comment>Return:</comment>
  <info>void</info>  This method returns the current object and throws TokyoTyrantException on failure.

<comment>See Also:</comment>
   * TokyoTyrantTable::put


id: TokyoTyrantTable::put
type: function
doc:
<comment>Description:</comment>
  Store a row
  
  Puts a new row into the database. This method parameters are <strong>$key</strong> which is  the primary key of the
  row, passing <info>null</info> will generate a new unique id. <strong>$value</strong> is an array containing the row contents
  which is usually key value pairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The primary key of the row
  <info>array </info>  <strong>$columns</strong>  The row contents

<comment>Return:</comment>
  <info>int</info>  Returns the primary key on success and throws TokyoTyrantException on error

<comment>See Also:</comment>
   * TokyoTyrantTable::get


id: TokyoTyrantTable::putCat
type: function
doc:
<comment>Description:</comment>
  Concatenates to a row
  
  This method can be used to add new columns to existing records. Existing keys will be left
  unmodified but any new columns will be appended to the row. Passing null as key will generate a
  new row.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The primary key of the row or <info>null</info>
  <info>array </info>  <strong>$columns</strong>  Array of row contents

<comment>Return:</comment>
  <info>void</info>  Returns the primary key and throws TokyoTyrantException on error.

<comment>See Also:</comment>
   * TokyoTyrantTable::put


id: TokyoTyrantTable::putKeep
type: function
doc:
<comment>Description:</comment>
  Put a new record
  
  Puts a new record into the database. If the key already exists this method throws an exception
  indicating that the records exists.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The primary key of the row or <info>null</info>
  <info>array </info>  <strong>$columns</strong>  Array of the row contents

<comment>Return:</comment>
  <info>void</info>  Returns the primary key and throws TokyoTyrantException on error.

<comment>See Also:</comment>
   * TokyoTyrantTable::put


id: TokyoTyrantTable::putNr
type: function
doc:
<comment>Description:</comment>
  Puts value
  
  This method is not supported on table databases. Calling this method through TokyoTyrantTable  is
  considered an error and an TokyoTyrantException will be thrown.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$keys </strong>  A string key or an array of key-value pairs
  <info>string</info>  <strong>$value</strong>  The value in case a string key is used

<comment>Return:</comment>
  <info>void</info>  This method is not supported on table databases. Calling this method through
        TokyoTyrantTable  is considered an error and an TokyoTyrantException will be thrown.

<comment>See Also:</comment>
   * TokyoTyrant::putNr
   * TokyoTyrant::putKeep
   * TokyoTyrant::putCat


id: TokyoTyrantTable::putShl
type: function
doc:
<comment>Description:</comment>
  Concatenates to a record
  
  This method is not supported on table databases. Calling this method through TokyoTyrantTable  is
  considered an error and an TokyoTyrantException will be thrown.

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  A string key
  <info>string</info>  <strong>$value</strong>  The value to concatenate
  <info>int   </info>  <strong>$width</strong>  The width of the record

<comment>Return:</comment>
  <info>void</info>  This method is not supported on table databases.

<comment>See Also:</comment>
   * TokyoTyrant::put
   * TokyoTyrant::putKeep
   * TokyoTyrant::putCat
   * TokyoTyrantTable::put
   * TokyoTyrantTable::putKeep
   * TokyoTyrantTable::putCat


id: TokyoTyrantTable::setIndex
type: function
doc:
<comment>Description:</comment>
  Sets index
  
  Sets an index on a specified column. The index type is one of the <info>TokyoTyrant::RDBIT_*</info> constants.
  Passing <info>TokyoTyrant::RDBIT_VOID</info> removes the index.

<comment>Param:</comment>
  <info>string</info>  <strong>$column</strong>  The name of the column
  <info>int   </info>  <strong>$type  </strong>  The index type

<comment>Return:</comment>
  <info>mixed</info>  This method returns the current object and throws TokyoTyrantException on failure.


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  Private constructor to deny instantiation
  
  This method should not be called. Its only purpose is to deny instantiation with the new operator.
  
  Use the factory methods Transliterator::create or Transliterator::createFromRules instead.

<comment>Return:</comment>
  <info>unknown</info>  This method should not be executed. If it is (e.g. through reflection), then its return
           value is unspecified.

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


id: Transliterator::create
type: function
doc:
<comment>Description:</comment>
  Create a transliterator
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Opens a Transliterator by ID.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$id       </strong>  The ID. A list of all registered transliterator IDs can be retrieved by using
                      Transliterator::listIDs.
  <info>int   </info>  <strong>$direction</strong>  The direction, defaults to  Transliterator::FORWARD. May also be set to
                      Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Transliterator::createFromRules
type: function
doc:
<comment>Description:</comment>
  Create transliterator from rules
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Creates a Transliterator from rules.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$rules    </strong>  The rules as defined in Transform Rules Syntax of UTS #35: Unicode LDML.
  <info>string</info>  <strong>$direction</strong>  The direction, defaults to  &gt;Transliterator::FORWARD. May also be set to
                      Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::createInverse
type: function
doc:
<comment>Description:</comment>
  Create an inverse transliterator
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Opens the inverse transliterator.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>Transliterator</info>  Returns a <class>Transliterator</class> object on success, or <info>null</info> on failure

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get last error code
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Gets the last error code for this transliterator.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$trans</strong>  

<comment>Return:</comment>
  <info>int</info>  The error code on success, or <info>false</info> if none exists, or on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


id: Transliterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get last error message
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Gets the last error message for this transliterator.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$trans</strong>  

<comment>Return:</comment>
  <info>string</info>  The error message on success, or <info>false</info> if none exists, or on failure.

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


id: Transliterator::listIDs
type: function
doc:
<comment>Description:</comment>
  Get transliterator IDs
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns an array with the registered transliterator IDs.

<comment>Return:</comment>
  <info>arrayfalse</info>  An <info>array</info> of registered transliterator IDs on success, o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  Transliterate a string
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Transforms a string or part thereof using an ICU transliterator.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$transliterator</strong>  In the procedural version, either a <class>Transliterator</class> or a <info>string</info> from which
                           a <class>Transliterator</class> can be built.
  <info>string</info>  <strong>$subject       </strong>  The string to be transformed.
  <info>int   </info>  <strong>$start         </strong>  The start index (in UTF-16 code units) from which the string will start
                           to be transformed, inclusive. Indexing starts at 0. The text before will
                           be left as is.
  <info>int   </info>  <strong>$end           </strong>  The end index (in UTF-16 code units) until which the string will be
                           transformed, exclusive. Indexing starts at 0. The text after will be left
                           as is.

<comment>Return:</comment>
  <info>stringfalse</info>  The transformed string on success,  o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  Interface to detect if a class is traversable using foreach.
  
  Abstract base interface that cannot be implemented alone. Instead it must be implemented by either
  IteratorAggregate or Iterator.
  
  Internal (built-in) classes that implement this interface can be used in a foreach construct and
  do not need to implement IteratorAggregate or Iterator.
  
  This is an internal engine interface which cannot be implemented in PHP scripts. Either
  IteratorAggregate or Iterator must be used instead. When implementing an interface which extends
  Traversable, make sure to list IteratorAggregate or Iterator before its name in the implements
  clause.


id: UConverter::__construct
type: function
doc:
<comment>Description:</comment>
  Create UConverter object
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$destination_encoding</strong>  
  <info>string</info>  <strong>$source_encoding     </strong>  


id: UConverter::convert
type: function
doc:
<comment>Description:</comment>
  Convert string from one charset to another
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$str    </strong>  
  <info>bool  </info>  <strong>$reverse</strong>  

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


id: UConverter::fromUCallback
type: function
doc:
<comment>Description:</comment>
  Default "from" callback function
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>int   </info>  <strong>$reason   </strong>  
  <info>string</info>  <strong>$source   </strong>  
  <info>string</info>  <strong>$codePoint</strong>  
  <info>int   </info>  <strong>$error    </strong>  

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


id: UConverter::getAliases
type: function
doc:
<comment>Description:</comment>
  Get the aliases of the given name
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: UConverter::getAvailable
type: function
doc:
<comment>Description:</comment>
  Get the available canonical converter names
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Get the destination encoding
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getDestinationType
type: function
doc:
<comment>Description:</comment>
  Get the destination converter type
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Get last error code on the object
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Get last error message on the object
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Get the source encoding
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getSourceType
type: function
doc:
<comment>Description:</comment>
  Get the source converter type
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getStandards
type: function
doc:
<comment>Description:</comment>
  Get standards associated to converter names
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::getSubstChars
type: function
doc:
<comment>Description:</comment>
  Get substitution chars
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UConverter::reasonText
type: function
doc:
<comment>Description:</comment>
  Get string representation of the callback reason
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: UConverter::setDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Set the destination encoding
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: UConverter::setSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Set the source encoding
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: UConverter::setSubstChars
type: function
doc:
<comment>Description:</comment>
  Set the substitution chars
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  Default "to" callback function
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>int   </info>  <strong>$reason   </strong>  
  <info>string</info>  <strong>$source   </strong>  
  <info>string</info>  <strong>$codeUnits</strong>  
  <info>int   </info>  <strong>$error    </strong>  

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


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  Convert string from one charset to another
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$str         </strong>  
  <info>string</info>  <strong>$toEncoding  </strong>  
  <info>string</info>  <strong>$fromEncoding</strong>  
  <info>array </info>  <strong>$options     </strong>  

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


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  An Area represents a canvas which can be used to draw, and respond to mouse and key events.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the ALT key is active


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the CTRL key is active


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Draw Callback
  
  Shall be invoked when this Area requires redrawing

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen      </strong>  A Pen suitable for drawing in this Area
  <info>UI\Size    </info>  <strong>$areaSize </strong>  The size of the Area
  <info>UI\Point   </info>  <strong>$clipPoint</strong>  The clip point of the Area
  <info>UI\Size    </info>  <strong>$clipSize </strong>  The clip size of the Area


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Key Callback
  
  Shall be executed on key events

<comment>Param:</comment>
  <info>string</info>  <strong>$key  </strong>  The key pressed
  <info>int   </info>  <strong>$ext  </strong>  The extended key pressed
  <info>int   </info>  <strong>$flags</strong>  Event modifiers


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Mouse Callback
  
  Shall be executed on mouse events

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  The co-ordinates of the event
  <info>UI\Size </info>  <strong>$areaSize </strong>  The size of the area of the event
  <info>int     </info>  <strong>$flags    </strong>  Event modifiers


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Area Scroll
  
  Scroll this Area

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to scroll to
  <info>UI\Size </info>  <strong>$size </strong>  The size of the scroll pane


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Sets the size of this Area

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  The new size


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Get Parent Control
  
  Shall return the parent Control

<comment>Return:</comment>
  <info>UI\Control</info>  


id: UI\Control::getTopLevel
type: function
doc:
<comment>Description:</comment>
  Get Top Level
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Determine if Control is enabled
  
  Shall detect if this Control is enabled

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


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Determine if Control is visible
  
  Shall detect if this Control is visible

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


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Set Parent Control
  
  Shall set the parent Control of this Control

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  The parent Control


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Box
  
  Shall construct a new box

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal or Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the given control to this Box

<comment>Param:</comment>
  <info>Control</info>  <strong>$control </strong>  The control to append
  <info>bool   </info>  <strong>$stretchy</strong>  Set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index from this Box

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to delete

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Get Orientation
  
  Shall retrieve the orientation of this Box

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


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Box

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


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Box

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Button
  
  Shall construct a new Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for this Button


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall retrieve the text (label) for this Button

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\Check::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Check
  
  Shall construct a new Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the Check box


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text (label) for this Check

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Checked Detection
  
  Shall detect the status of this Check

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


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Toggle Callback
  
  Shall be executed when the status of this Check is changed


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall change the status of this Check

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  A Color Button is a button which displays a color picker when clicked


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall retrieve the currently selected Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the selected Color is changed


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the currently selected Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The new color


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  A Combo control represents a list of options, like the familiar select HTML element.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Append an option to this Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the option selected in this Combo

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


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when an option is selected in this Combo


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Combo

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  An Editable Combo is a Combo which allows the user to enter custom options


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Get the value of the currently selected option in this Editable Combo

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


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Editable Combobox changes


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text of the currently selected option in this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Entry
  
  Construct a new entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password, or Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text from this Entry

<comment>Return:</comment>
  <info>string</info>  The current text


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Detect Read Only
  
  Shall detect if this Entry is read only

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


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Entry changes


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only for this Entry

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  A Form is a control which allows the arrangement of other controls into a familiar layout (the
  form).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the control to the form, and set the label

<comment>Param:</comment>
  <info>string    </info>  <strong>$label   </strong>  The text for the label
  <info>UI\Control</info>  <strong>$control </strong>  A control
  <info>bool      </info>  <strong>$stretchy</strong>  Should be set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index in this Form

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of succcess


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Form

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


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Form

<comment>Param:</comment>
  <info>bool</info>  <strong>$padded</strong>  


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  A Grid is a control which is allows the arrangement of children into a grid


id: UI\Controls\Grid::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to append
  <info>int       </info>  <strong>$left   </strong>  
  <info>int       </info>  <strong>$top    </strong>  
  <info>int       </info>  <strong>$xspan  </strong>  
  <info>int       </info>  <strong>$yspan  </strong>  
  <info>bool      </info>  <strong>$hexpand</strong>  
  <info>int       </info>  <strong>$halign </strong>  
  <info>bool      </info>  <strong>$vexpand</strong>  
  <info>int       </info>  <strong>$valign </strong>  


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Grid

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


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding for this Grid

<comment>Param:</comment>
  <info>bool</info>  <strong>$padding</strong>  


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Group
  
  Shall construct a new Group with the given title

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the title label


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append a control to this Group

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The control to append


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall return the current title for this Group

<comment>Return:</comment>
  <info>string</info>  The current title


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if this Group has a margin

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


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins for this Group

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Set Title
  
  Shall set the title for this Group

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the new title


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  A Label is a single line of text, meant to identify, for the user, some element of the interface.


id: UI\Controls\Label::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Label
  
  Shall construct a new Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for this label


id: UI\Controls\Label::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text for this Label
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  A Multiline Entry is a text entry control able to hold multiple lines of text, with or without
  wrapping.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Multiline Entry
  
  Shall construct a new Multiline Entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap or MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Append Text
  
  Shall append the given text to the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text to append


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text in this Multiline Entry

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


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Read Only Detection
  
  Shall detect if this Multiline Entry is read only

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


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Multiline Entry is changed


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only on this Multiline Entry

<comment>Param:</comment>
  <info>bool</info>  <strong>$readOnly</strong>  


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker
  interface to the user.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Picker
  
  Construct a new Picker of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time, or Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  A Progress control is a familiar Progress bar: It represents progress as a percentage, with a
  possible range of 0 to 100 (inclusive).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Shall retrieve the current value of this Progress bar

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


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Progress bar

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  An integer between 0 and 100 (inclusive)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Radio

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the option


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the currently selected option in this Radio

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


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when the option selected in this Radio changes


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Radio

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  A Separator represents a control separator, it has no other function.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Separator
  
  Shall construct a new Separator of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal or Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  A Slider is a control which represents a range, and a current value in the range. The sliding
  element of the control (sometimes called the "thumb") reflects the value, and can be adjusted
  within the range.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Slider
  
  Construct a new Slider with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum allowed value
  <info>int</info>  <strong>$max</strong>  The maximum allowed value


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value from this Slider

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


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Slider changes


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Slider

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  A Spin box is a text box with an up-down control which changes the integer value in the box,
  within a defined range


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Spin
  
  Constructs a new Spin with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum value allowed
  <info>int</info>  <strong>$max</strong>  The maximum value allowed


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value in this Spin

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


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value in this Spin changes


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Set the value in this Spin

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  A Tab can contain many pages of Controls, each with a title, each selectable by the user.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Append Page
  
  Append a new page to this Tab

<comment>Param:</comment>
  <info>string    </info>  <strong>$name   </strong>  The name for the new page
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Delete Page
  
  Shall remove the selected page from this Tab

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the page to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if the given page has a margin.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  The index of the page

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


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Insert Page
  
  Shall insert a new page into this Tab

<comment>Param:</comment>
  <info>string    </info>  <strong>$name   </strong>  The name for the new page
  <info>int       </info>  <strong>$page   </strong>  The index to perform the insertion before
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Page Count
  
  Shall return the number of pages in this Tab

<comment>Return:</comment>
  <info>int</info>  The number of pages in this Tab


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins on the selected page

<comment>Param:</comment>
  <info>int </info>  <strong>$page  </strong>  The page to select
  <info>bool</info>  <strong>$margin</strong>  Margin switch


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Brush
  
  Shall construct a solid brush using the given color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall return a UI\Draw\Color for this brush

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  The current color of the brush


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the color of this brush to the color provided

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA

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


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Shall at a stop of the given color at the given position

<comment>Param:</comment>
  <info>float        </info>  <strong>$position</strong>  The position for the new stop
  <info>UI\Draw\Color</info>  <strong>$color   </strong>  The color for the new stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::delStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation

<comment>Param:</comment>
  <info>int          </info>  <strong>$index   </strong>  The index of the stop to set
  <info>float        </info>  <strong>$position</strong>  The position for the stop
  <info>UI\Draw\Color</info>  <strong>$color   </strong>  The color for the stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Linear Gradient
  
  Shall construct a new linear gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end  </strong>  


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Radial Gradient
  
  Shall construct a new radial gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start </strong>  
  <info>UI\Point</info>  <strong>$outer </strong>  
  <info>float   </info>  <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Represents RGBA colours, individual channels are accessible via public properties.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Construct new Color
  
  Shall construct a new color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  May be UI\Draw\Color or RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall retrieve the value for a channel

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Constant channel identity

<comment>Return:</comment>
  <info>float</info>  The current value of the requested channel


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall set the selected channel to the given value

<comment>Param:</comment>
  <info>int  </info>  <strong>$channel</strong>  Constant channel identity
  <info>float</info>  <strong>$value  </strong>  The new value for the selected channel

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


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Invertible Detection
  
  Shall detect if this Matrix may be inverted

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


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Multiply Matrix
  
  Shall multiply this matrix with the given matrix

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  The new Matrix


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Rotate Matrix
  
  Shall rotate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point </strong>  
  <info>float   </info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Scale Matrix
  
  Shall scale this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point </strong>  


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Skew Matrix
  
  Shall skew this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point </strong>  
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Translate Matrix
  
  Shall translate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path
type: class
doc:
<comment>Description:</comment>
  A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Path
  
  Shall construct a new path in the given mode

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding or Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Draw a Rectangle
  
  Shall map the path of a rectangle of the given size, at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin the shape
  <info>UI\Size </info>  <strong>$size </strong>  The size of the rectangle


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Draw an Arc
  
  Shall map the path for an arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point   </strong>  The point to begin mapping
  <info>float   </info>  <strong>$radius  </strong>  The radius of the arc
  <info>float   </info>  <strong>$angle   </strong>  The angle of the arc
  <info>float   </info>  <strong>$sweep   </strong>  The sweep of the arc
  <info>float   </info>  <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Draw Bezier Curve
  
  Shall draw a bezier curve

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point   </strong>  The point at which to begin mapping
  <info>float   </info>  <strong>$radius  </strong>  The radius of the curve
  <info>float   </info>  <strong>$angle   </strong>  The angle of the curve
  <info>float   </info>  <strong>$sweep   </strong>  The sweep of the curve
  <info>float   </info>  <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Draw a Line
  
  Shall map the path for a line

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point   </strong>  The point to begin mapping
  <info>float   </info>  <strong>$radius  </strong>  
  <info>float   </info>  <strong>$angle   </strong>  
  <info>float   </info>  <strong>$sweep   </strong>  
  <info>float   </info>  <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Draw Figure
  
  Shall map a new figure at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin mapping


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Draw Figure with Arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point   </strong>  
  <info>float   </info>  <strong>$radius  </strong>  
  <info>float   </info>  <strong>$angle   </strong>  
  <info>float   </info>  <strong>$sweep   </strong>  
  <info>float   </info>  <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and
  writing to Draw Paths.


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Clip a Path
  
  Shall clip the given Path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  The path to clip


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Fill a Path
  
  Shall fill the given path

<comment>Param:</comment>
  <info>UI\Draw\Path </info>  <strong>$path</strong>  The path to fill
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  The color or brush to fill with


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Stroke a Path
  
  Shall stroke the given path

<comment>Param:</comment>
  <info>UI\Draw\Path  </info>  <strong>$path  </strong>  The path to stroke
  <info>UI\Draw\Brush </info>  <strong>$with  </strong>  The color or brush to stroke with
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  The configuration of the stroke


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Matrix Transform
  
  Shall perform matrix transformation

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  The matrix to use


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Draw Text at Point
  
  Shall draw the given text layout at the given point

<comment>Param:</comment>
  <info>UI\Point           </info>  <strong>$point </strong>  The point to perform the drawing
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  The layout of the text to draw


id: UI\Draw\Stroke::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Stroke
  
  Shall construct a new Stroke

<comment>Param:</comment>
  <info>int  </info>  <strong>$cap       </strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square
  <info>int  </info>  <strong>$join      </strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or
                      UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness </strong>  The thickness of the stroke
  <info>float</info>  <strong>$miterLimit</strong>  Miter limit (default is sensible for all supported platforms)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Get Line Cap
  
  Shall retrieve the line cap setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Get Line Join
  
  Shall retrieve the line join setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Get Miter Limit
  
  Shall retrieve the miter limit of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current miter limit


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Get Thickness
  
  Shall retrieve the thickness of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current thickness


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Set Line Cap
  
  Shall set the line cap setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Set Line Join
  
  Shall set the line join setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Set Miter Limit
  
  Set the miter limit for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  The new limit


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Set Thickness
  
  Shall set the thickness for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  The new thickness


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font
  
  Shall construct a new Font using the given descriptor

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  The descriptor for the Font


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font Descriptor
  
  Shall construct a new Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family </strong>  The name of a valid family of fonts
  <info>float </info>  <strong>$size   </strong>  The preferred size
  <info>int   </info>  <strong>$weight </strong>  UI\Draw\Text\Font\Weight constant
  <info>int   </info>  <strong>$italic </strong>  UI\Draw\Text\Font\Italic constant
  <info>int   </info>  <strong>$stretch</strong>  UI\Draw\Text\Font\Stretch constant


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Get Font Family
  
  Shall return the requested font family

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


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return constant setting

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


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Size Detection
  
  Shall return the requested size

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return requested stretch

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


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Weight Detection
  
  Shall return requested weight

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


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Retrieve Font Families
  
  Returns an array of valid font families for the current system

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


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  A Text Layout represents the layout of text which will be drawn by the Pen


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Text Layout
  
  Shall construct a new Text Layout

<comment>Param:</comment>
  <info>string           </info>  <strong>$text </strong>  The text for the layout
  <info>UI\Draw\Text\Font</info>  <strong>$font </strong>  The font to use for writing
  <info>float            </info>  <strong>$width</strong>  The width of the layout


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the Color for all of, or a range of the text in the Layout

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The color to use
  <info>int          </info>  <strong>$start</strong>  The starting character
  <info>int          </info>  <strong>$end  </strong>  The ending character, by default the end of the string


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Shall set the width of this Text Layout

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  The new width


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  This facility schedules repetitive execution of a callback, useful for animations and other such
  activities.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Executor
  
  Shall construct an executor with the given interval, will not start executing until main loop is
  entered

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds     </strong>  Seconds between executions
  <info>int</info>  <strong>$microseconds</strong>  Microseconds between executions


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Stop Executor
  
  Shall stop an executor, the executor cannot be restarted

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


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Execution Callback
  
  Shall be repetitively queued for execution in the main thread

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


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Interval Manipulation
  
  Shall set the new interval. An interval of 0 will pause the executor until a new interval has been
  set

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds     </strong>  
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Menus must be constructed before the first Window, and can be shown on any Window


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Menu
  
  Shall construct a new Menu

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the menu


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Append Menu Item
  
  Shall append a new Menu Item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed object of the given type


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Append About Menu Item
  
  Shall append an About menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed About menu item of the given type


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Append Checkable Menu Item
  
  Shall append a checkable menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed checkable menu item of the given type


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Append Preferences Menu Item
  
  Shall append a Preferences menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Preferences menu item of the given type


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Append Quit Menu Item
  
  Shall append a Quit menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Quit menu item of the given type


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Detect Checked
  
  Shall detect if this Menu Item is checked

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


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  On Click Callback
  
  Shall be executed when this Menu Item is clicked


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall set the checked status of this Menu Item

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Points are used throughout UI to represent co-ordinates on a screen, control, or area.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Point
  
  Construct a new Point using new co-ordinates

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The new X co-ordinate
  <info>float</info>  <strong>$y</strong>  The new Y co-ordinate


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Size Coercion
  
  Shall return a UI\Point object where x and y are equal to those supplied, either in float or
  UI\Size form

<comment>Param:</comment>
  <info>float  </info>  <strong>$point</strong>  The value for x and y
  <info>UI\Size</info>  <strong>$size </strong>  The Size to convert

<comment>Return:</comment>
  <info>UI\Point</info>  The resulting Point


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Retrieves X
  
  Retrieves the X co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current X co-ordinate


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Retrieves Y
  
  Retrieves the Y co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current Y co-ordinate


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Set X
  
  Set the X co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new X co-ordinate


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Set Y
  
  Set the Y co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new Y co-ordinate


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Sizes are used throughout UI to represent the size of a screen, control, or area.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Size
  
  Construct a new Size using new width and height

<comment>Param:</comment>
  <info>float</info>  <strong>$width </strong>  The new width
  <info>float</info>  <strong>$height</strong>  The new height


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Retrieves Height
  
  Retrieves the Height

<comment>Return:</comment>
  <info>float</info>  The current Height


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Retrives Width
  
  Retrieves the Width

<comment>Return:</comment>
  <info>float</info>  The current Width


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Point Coercion
  
  Shall return a UI\Size object where width and height are equal to those supplied, either in float
  or UI\Point form

<comment>Param:</comment>
  <info>float   </info>  <strong>$size </strong>  The value for width and height
  <info>UI\Point</info>  <strong>$point</strong>  The Point to convert

<comment>Return:</comment>
  <info>UI\Size</info>  The resulting Size


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Set Height
  
  Set new Height

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Height


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Set new Width

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Width


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Window
  
  Shall construct a new Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the Window
  <info>Size  </info>  <strong>$size </strong>  The size of the Window
  <info>bool  </info>  <strong>$menu </strong>  Menu switch


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Add a Control
  
  Shall add a Control to this Window

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to add


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Show Error Box
  
  Shall show an error box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the error box
  <info>string</info>  <strong>$msg  </strong>  The message for the error box


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Get Window Size
  
  Shall return the size of this Window

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall retrieve the title of this Window

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


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Border Detection
  
  Shall detect if borders are used on this Window

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


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if margins are used on this Window

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


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Detection
  
  Shall detect if this Window us using the whole screen

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


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Show Message Box
  
  Shall show a message box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the message box
  <info>string</info>  <strong>$msg  </strong>  The message


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Closing Callback
  
  Should gracefully destroy this Window

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


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Open Dialog
  
  Shall show an open file dialog

<comment>Return:</comment>
  <info>string</info>  Returns the name of the file selected for opening


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Save Dialog
  
  Shall show a save dialog

<comment>Return:</comment>
  <info>string</info>  Returns the file name selecting for saving


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Border Use
  
  Shall enable or disable the use of borders on this Window

<comment>Param:</comment>
  <info>bool</info>  <strong>$borders</strong>  


id: UI\Window::setFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Use
  
  Shall enable or disable the use of the full screen for this Window
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>bool</info>  <strong>$full</strong>  


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Margin Use
  
  Shall enable or disable the use of margins for this Window

<comment>Param:</comment>
  <info>bool</info>  <strong>$margin</strong>  


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Shall set the size of this Window

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Window Title
  
  Shall set the title for this Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The new title


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Quit UI Loop
  
  Shall cause the main loop to be exited

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


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Enter UI Loop
  
  Shall cause PHP to enter into the main loop, by default control will not be returned to the caller

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Set UI\Loop to return control, and UI\Wait to return control after waiting

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


id: V8Js
type: class
doc:
<comment>Description:</comment>
  This is the core class for V8Js extension. Each instance created from this class has own context
  in which all JavaScript is compiled and executed.
  
  See <strong>V8Js::__construct()</strong> for more information.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name               </strong>  The name of the object passed to Javascript.
  <info>array </info>  <strong>$variables                 </strong>  Map of PHP variables that will be available in Javascript.
                                       Must be an associative <info>array</info> in format <return>array("name-for-js"
                                       =&gt; "name-of-php-variable")</return>. Defaults to empty array.
  <info>array </info>  <strong>$extensions                </strong>  List of extensions registered using <strong>V8Js::registerExtension()</strong>
                                       which should be available  in the Javascript context of the
                                       created <class>V8Js</class> object.  Extensions registered to be enabled
                                       automatically do not need to be listed in this array. Also if
                                       an extension has dependencies, those dependencies can be
                                       omitted as well. Defaults to empty array.
                                       
                                       Extensions registered to be enabled automatically do not need
                                       to be listed in this array. Also if an extension has
                                       dependencies, those dependencies can be omitted as well.
                                       Defaults to empty array.
  <info>bool  </info>  <strong>$report_uncaught_exceptions</strong>  Controls whether uncaught Javascript exceptions are reported
                                       immediately or not. Defaults to <info>true</info>. If set to <info>false</info> the
                                       uncaught exception can be accessed using
                                       <strong>V8Js::getPendingException()</strong>.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new V8Js context object.


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  Execute a string as Javascript code
  
  Compiles and executes the string passed with <strong>$script</strong> as Javascript code.

<comment>Param:</comment>
  <info>string</info>  <strong>$script    </strong>  The code string to be executed.
  <info>string</info>  <strong>$identifier</strong>  Identifier string for the executed code. Used for debugging.
  <info>int   </info>  <strong>$flags     </strong>  Execution flags. This value must be one of the <return>V8Js::FLAG_*</return> constants,
                       defaulting to <info>V8Js::FLAG_NONE</info>. <info>V8Js::FLAG_NONE</info>: no flags
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays
                       
                       <info>V8Js::FLAG_NONE</info>: no flags
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays

<comment>Return:</comment>
  <info>mixed</info>  Returns the last variable instantiated in the Javascript code converted to matching PHP
         variable type.


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  Return an array of registered extensions
  
  This function returns array of Javascript extensions registered using <strong>V8Js::registerExtension()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array of registered extensions or an empty array if there are none.


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  Return pending uncaught Javascript exception
  
  Returns any pending uncaught Javascript exception as <class>V8JsException</class> left from earlier
  <strong>V8Js::executeString()</strong> call(s).

<comment>Return:</comment>
  <info>V8JsException</info>  Either <class>V8JsException</class> or <info>null</info>.


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  Register Javascript extensions for V8Js
  
  Registers passed Javascript <strong>$script</strong> as extension to be used in <class>V8Js</class> contexts.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  Name of the extension to be registered.
  <info>string</info>  <strong>$script        </strong>  The Javascript code to be registered.
  <info>array </info>  <strong>$dependencies  </strong>  Array of extension names the extension to be registered depends on. Any
                           such extension is enabled automatically when this extension is loaded.
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
                           
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
  <info>bool  </info>  <strong>$auto_enable   </strong>  If set to <info>true</info>, the extension will be enabled automatically in all <class>V8Js</class>
                           contexts.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if extension was registered successfully, <info>false</info> otherwise.


id: V8JsException::getJsFileName
type: function
doc:
<comment>Description:</comment>
  The getJsFileName purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: V8JsException::getJsLineNumber
type: function
doc:
<comment>Description:</comment>
  The getJsLineNumber purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: V8JsException::getJsSourceLine
type: function
doc:
<comment>Description:</comment>
  The getJsSourceLine purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: V8JsException::getJsTrace
type: function
doc:
<comment>Description:</comment>
  The getJsTrace purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: VARCMP_GT
type: constant
doc:
<comment>Description:</comment>
  The left <return>bstr</return> is greater than right  <return>bstr</return>.


id: VARCMP_LT
type: constant
doc:
<comment>Description:</comment>
  The left <return>bstr</return> is less than right  <return>bstr</return>.


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  If the type indicator is combined with  <info>VT_ARRAY</info> by an OR operator, the value is a pointer to a
  <return>SAFEARRAY</return>. <info>VT_ARRAY</info>  can use the OR with the following data types: <info>VT_I1</info>,  <info>VT_UI1</info>, <info>VT_I2</info>, <info>VT_UI2</info>,
  <info>VT_I4</info>, <info>VT_UI4</info>, <info>VT_INT</info>,  <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>,  <info>VT_BOOL</info>, <info>VT_DECIMAL</info>, <info>VT_ERROR</info>,  <info>VT_CY</info>, <info>VT_DATE</info>,
  <info>VT_BSTR</info>,  <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> and  <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  If the type indicator is combined with <info>VT_BYREF</info>  by an OR operator, the value is a reference.
  Reference types are  interpreted as a reference to data, similar to the reference type in  C++.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  A 64-bit floating point number representing the number of days  (not seconds) since December 31,
  1899. For example,  <return>January 1, 1900</return>, is 2.0, <return>January 2, 1900</return>,  is 3.0, and so on). This is stored
  in the same representation as  <info>VT_R8</info>.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  A property with a type indicator of <info>VT_EMPTY</info> has  no data associated with it; that is, the size of
  the value is zero.


id: VT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Error code; containing the status code associated with the  error.


id: VT_I8
type: constant
doc:
<comment>Description:</comment>
  8-byte signed integer value.
  
  Available as of PHP 7.0.0 (x64 only).


id: VT_UI8
type: constant
doc:
<comment>Description:</comment>
  8-byte unsigned integer.
  
  Available as of PHP 7.0.0 (x64 only).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  A type indicator followed by the corresponding value.  <info>VT_VARIANT</info> can be used only with  <info>VT_BYREF</info>.


id: VarnishAdmin::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishAdmin constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishAdmin::auth
type: function
doc:
<comment>Description:</comment>
  Authenticate on a varnish instance

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


id: VarnishAdmin::ban
type: function
doc:
<comment>Description:</comment>
  Ban URLs using a VCL expression

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Varnish VCL expression. It's based on the varnish ban command.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::banUrl
type: function
doc:
<comment>Description:</comment>
  Ban an URL using a VCL expression

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  URL regular expression in PCRE compatible syntax. It's based on the ban.url
                      varnish command.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::clearPanic
type: function
doc:
<comment>Description:</comment>
  Clear varnish instance panic messages

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::connect
type: function
doc:
<comment>Description:</comment>
  Connect to a varnish instance administration interface

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


id: VarnishAdmin::disconnect
type: function
doc:
<comment>Description:</comment>
  Disconnect from a varnish instance administration interface

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


id: VarnishAdmin::getPanic
type: function
doc:
<comment>Description:</comment>
  Get the last panic message on a varnish instance

<comment>Return:</comment>
  <info>string</info>  Returns the last panic message on the current varnish instance.


id: VarnishAdmin::getParams
type: function
doc:
<comment>Description:</comment>
  Fetch current varnish instance configuration parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array with the varnish configuration parameters.


id: VarnishAdmin::isRunning
type: function
doc:
<comment>Description:</comment>
  Check if the varnish slave process is currently running

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


id: VarnishAdmin::setCompat
type: function
doc:
<comment>Description:</comment>
  Set the class compat configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$compat</strong>  Varnish compatibility option.

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


id: VarnishAdmin::setHost
type: function
doc:
<comment>Description:</comment>
  Set the class host configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Connection host configuration parameter.

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


id: VarnishAdmin::setIdent
type: function
doc:
<comment>Description:</comment>
  Set the class ident configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$ident</strong>  Connection ident configuration parameter.

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


id: VarnishAdmin::setParam
type: function
doc:
<comment>Description:</comment>
  Set configuration param on the current varnish instance

<comment>Param:</comment>
  <info>string   </info>  <strong>$name </strong>  Varnish configuration param name.
  <info>stringint</info>  <strong>$value</strong>  Varnish configuration param value.

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::setPort
type: function
doc:
<comment>Description:</comment>
  Set the class port configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  Connection port configuration parameter.

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


id: VarnishAdmin::setSecret
type: function
doc:
<comment>Description:</comment>
  Set the class secret configuration param

<comment>Param:</comment>
  <info>string</info>  <strong>$secret</strong>  Connection secret configuration parameter.

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


id: VarnishAdmin::setTimeout
type: function
doc:
<comment>Description:</comment>
  Set the class timeout configuration param

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Connection timeout configuration parameter.

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


id: VarnishAdmin::start
type: function
doc:
<comment>Description:</comment>
  Start varnish worker process

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishAdmin::stop
type: function
doc:
<comment>Description:</comment>
  Stop varnish worker process

<comment>Return:</comment>
  <info>int</info>  Returns the varnish command status.


id: VarnishLog::__construct
type: function
doc:
<comment>Description:</comment>
  Varnishlog constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishLog::getLine
type: function
doc:
<comment>Description:</comment>
  Get next log line

<comment>Return:</comment>
  <info>array</info>  Returns an array with the log line data.


id: VarnishLog::getTagName
type: function
doc:
<comment>Description:</comment>
  Get the log tag string representation by its index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Log tag index.

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


id: VarnishStat::__construct
type: function
doc:
<comment>Description:</comment>
  VarnishStat constructor

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Configuration arguments. The possible keys are:
                


id: VarnishStat::getSnapshot
type: function
doc:
<comment>Description:</comment>
  Get the current varnish instance statistics snapshot

<comment>Return:</comment>
  <info>array</info>  Array with the varnish statistic snapshot. The array keys are identical to that in the
         varnishstat tool.


id: Volatile
type: class
doc:
<comment>Description:</comment>
  The <class>Volatile</class> class is new to pthreads v3. Its introduction is a consequence of the new
  immutability semantics of <class>Threaded</class> members of <class>Threaded</class> classes. The <class>Volatile</class> class enables for
  mutability of its <class>Threaded</class> members, and is also used to store PHP arrays in <class>Threaded</class> contexts.


id: Vtiful\Kernel\Excel::__construct
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constructor
  
  <class>Vtiful\Kernel\Excel</class> constructor, create a class object.

<comment>Param:</comment>
  <info>array</info>  <strong>$config</strong>  XLSX file export configuration

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::addSheet
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel addSheet
  
  Create a new worksheet in the xlsx file.

<comment>Param:</comment>
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::autoFilter
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel autoFilter
  
  Add autofilter to a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Cell start and end coordinate string.

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::constMemory
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel constMemory
  
  Write a large file with constant memory usage.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName </strong>  XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::data
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel data
  
  Write a data in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  worksheet data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::fileName
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel fileName
  
  Create a brand new xlsx file and create a worksheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName </strong>  XLSX file name
  <info>string</info>  <strong>$sheetName</strong>  Worksheet name

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::getHandle
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel getHandle
  
  Get the xlsx text resource handle.

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Excel::header
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel header
  
  Write a header in the worksheet.

<comment>Param:</comment>
  <info>array</info>  <strong>$headerData</strong>  worksheet header data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertFormula
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertFormula
  
  Insert calculation formula.

<comment>Param:</comment>
  <info>int   </info>  <strong>$row    </strong>  cell row
  <info>int   </info>  <strong>$column </strong>  cell column
  <info>string</info>  <strong>$formula</strong>  formula string

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertImage
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertImage
  
  Insert a local image into the cell.

<comment>Param:</comment>
  <info>int   </info>  <strong>$row           </strong>  cell row
  <info>int   </info>  <strong>$column        </strong>  cell column
  <info>string</info>  <strong>$localImagePath</strong>  local image path

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::insertText
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel insertText
  
  Write text in a cell.

<comment>Param:</comment>
  <info>int   </info>  <strong>$row   </strong>  cell row
  <info>int   </info>  <strong>$column</strong>  cell column
  <info>string</info>  <strong>$data  </strong>  data to be written
  <info>string</info>  <strong>$format</strong>  String format

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::mergeCells
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel mergeCells
  
  Merge Cells.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  cell start and end coordinate strings
  <info>string</info>  <strong>$data </strong>  string data

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::output
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel output
  
  Output xlsx file to disk.

<comment>Return:</comment>
  <info>unknown</info>  XLSX file path;


id: Vtiful\Kernel\Excel::setColumn
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setColumn
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string  </info>  <strong>$range </strong>  cell start and end coordinate strings
  <info>float   </info>  <strong>$width </strong>  column width
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Excel::setRow
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Excel setRow
  
  Set the format of the column.

<comment>Param:</comment>
  <info>string  </info>  <strong>$range </strong>  cell start and end coordinate strings
  <info>float   </info>  <strong>$height</strong>  row height
  <info>resource</info>  <strong>$format</strong>  cell format resource

<comment>Return:</comment>
  <info>unknown</info>  <class>Vtiful\Kernel\Excel</class> instance


id: Vtiful\Kernel\Format::align
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format align
  
  set cell align

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int     </info>  <strong>$style </strong>  <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::bold
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format bold
  
  <class>Vtiful\Kernel\Format</class> bold format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::italic
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format italic
  
  <class>Vtiful\Kernel\Format</class> italic format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::underline
type: function
doc:
<comment>Description:</comment>
  Vtiful\Kernel\Format underline
  
  <class>Vtiful\Kernel\Format</class> underline format

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  xlsx file handle
  <info>int     </info>  <strong>$style </strong>  <class>Vtiful\Kernel\Format</class> constant

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: WIN32_ABOVE_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has priority above WIN32_NORMAL_PRIORITY_CLASS but below WIN32_HIGH_PRIORITY_CLASS.


id: WIN32_BELOW_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has priority above WIN32_IDLE_PRIORITY_CLASS but below WIN32_NORMAL_PRIORITY_CLASS.


id: WIN32_ERROR_ACCESS_DENIED
type: constant
doc:
<comment>Description:</comment>
  The handle to the SCM database does not have the appropriate access rights.


id: WIN32_ERROR_DEPENDENT_SERVICES_RUNNING
type: constant
doc:
<comment>Description:</comment>
  0x0000041B
  
  The service cannot be stopped because other running services are dependent on it.


id: WIN32_ERROR_DUPLICATE_SERVICE_NAME
type: constant
doc:
<comment>Description:</comment>
  The display name already exists in the service control manager database either as a service name
  or as another display name.


id: WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT
type: constant
doc:
<comment>Description:</comment>
  This error is returned if the program is being run as a console application rather than as a
  service. If the program will be run as a console application for debugging purposes, structure it
  such that service-specific code is not called.


id: WIN32_ERROR_INSUFFICIENT_BUFFER
type: constant
doc:
<comment>Description:</comment>
  0x0000007A
  
  The buffer is too small for the service status structure. Nothing was written to the structure.


id: WIN32_ERROR_INVALID_DATA
type: constant
doc:
<comment>Description:</comment>
  0x0000000D
  
  The specified service status structure is invalid.


id: WIN32_ERROR_INVALID_HANDLE
type: constant
doc:
<comment>Description:</comment>
  The handle to the specified service control manager database is invalid.


id: WIN32_ERROR_INVALID_LEVEL
type: constant
doc:
<comment>Description:</comment>
  0x0000007C
  
  The InfoLevel parameter contains an unsupported value.


id: WIN32_ERROR_INVALID_SERVICE_ACCOUNT
type: constant
doc:
<comment>Description:</comment>
  The user account name specified in the <strong>$user</strong> parameter does not exist. See <strong>win32_create_service()</strong>.


id: WIN32_ERROR_INVALID_SERVICE_CONTROL
type: constant
doc:
<comment>Description:</comment>
  0x0000041C
  
  The requested control code is not valid, or it is unacceptable to the service.


id: WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL
type: constant
doc:
<comment>Description:</comment>
  The requested control code cannot be sent to the service because the state of the service is
  <info>WIN32_SERVICE_STOPPED</info>, <info>WIN32_SERVICE_START_PENDING</info>, or <info>WIN32_SERVICE_STOP_PENDING</info>.


id: WIN32_ERROR_SERVICE_DEPENDENCY_DELETED
type: constant
doc:
<comment>Description:</comment>
  The service depends on a service that does not exist or has been marked for deletion.


id: WIN32_ERROR_SERVICE_DEPENDENCY_FAIL
type: constant
doc:
<comment>Description:</comment>
  0x0000042C
  
  The service depends on another service that has failed to start.


id: WIN32_ERROR_SERVICE_LOGON_FAILED
type: constant
doc:
<comment>Description:</comment>
  0x0000042D
  
  The service did not start due to a logon failure. This error occurs if the service is configured
  to run under an account that does not have the "Log on as a service" right.


id: WIN32_ERROR_SERVICE_REQUEST_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  0x0000041D
  
  The process for the service was started, but it did not call StartServiceCtrlDispatcher, or the
  thread that called StartServiceCtrlDispatcher may be blocked in a control handler function.


id: WIN32_ERROR_SERVICE_SPECIFIC_ERROR
type: constant
doc:
<comment>Description:</comment>
  0x0000042A
  
  The service has returned a service-specific error code.


id: WIN32_ERROR_SHUTDOWN_IN_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  0x0000045B
  
  The system is shutting down; this function cannot be called.


id: WIN32_HIGH_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that performs time-critical tasks that must be executed immediately. The threads of the
  process preempt the threads of normal or idle priority class processes. An example is the Task
  List, which must respond quickly when called by the user, regardless of the load on the operating
  system. Use extreme care when using the high-priority class, because a high-priority class
  application can use nearly all available CPU time.


id: WIN32_IDLE_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process whose threads run only when the system is idle. The threads of the process are preempted
  by the threads of any process running in a higher priority class. An example is a screen saver.
  The idle-priority class is inherited by child processes.


id: WIN32_REALTIME_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Process that has the highest possible priority. The threads of the process preempt the threads of
  all other processes, including operating system processes performing important tasks. For example,
  a real-time process that executes for more than a very brief interval can cause disk caches not to
  flush or cause the mouse to be unresponsive.


id: WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's hardware profile has changed. This enables the system
  to send  <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>  notifications to the service.


id: WIN32_SERVICE_ACCEPT_NETBINDCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is a network component that can accept changes in its  binding without being stopped
  and restarted. This control code allows the service to receive  <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>,
  <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,  <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, and
  <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info> notifications.


id: WIN32_SERVICE_ACCEPT_PARAMCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service can reread its startup parameters without being stopped and restarted. This control
  code allows the service to receive  <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info> notifications.


id: WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE
type: constant
doc:
<comment>Description:</comment>
  The service can be paused and continued. This control code allows the service to receive
  <info>WIN32_SERVICE_CONTROL_PAUSE</info> and <info>WIN32_SERVICE_CONTROL_CONTINUE</info> notifications.


id: WIN32_SERVICE_ACCEPT_POWEREVENT
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's power status has changed. This enables the system to
  send  <info>WIN32_SERVICE_CONTROL_POWEREVENT</info> notifications  to the service.


id: WIN32_SERVICE_ACCEPT_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  The service can perform preshutdown tasks. This control code enables the service to receive
  <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info> notifications. This value is not supported by Windows Server
  2003 and Windows XP/2000.


id: WIN32_SERVICE_ACCEPT_SESSIONCHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the computer's session status has changed. This enables the system to
  send  <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info> notifications  to the service. Windows 2000:  This value
  is not supported


id: WIN32_SERVICE_ACCEPT_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  The service is notified when system shutdown occurs. This control code allows the service to
  receive <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info> notifications.


id: WIN32_SERVICE_ACCEPT_STOP
type: constant
doc:
<comment>Description:</comment>
  The service can be stopped. This control code allows the service to receive
  <info>WIN32_SERVICE_CONTROL_STOP</info> notifications.


id: WIN32_SERVICE_ACCEPT_TIMECHANGE
type: constant
doc:
<comment>Description:</comment>
  The service is notified when the system time has changed. This enables the system to send
  <info>WIN32_SERVICE_CONTROL_TIMECHANGE</info> notifications to the service. Windows Server 2008, Windows Vista,
  Windows Server 2003,  and Windows XP/2000:  This control code is not supported.


id: WIN32_SERVICE_ACCEPT_TRIGGEREVENT
type: constant
doc:
<comment>Description:</comment>
  The service is notified when an event for which the service has registered occurs. This enables
  the system to send  <info>WIN32_SERVICE_CONTROL_TRIGGEREVENT</info> notifications to the service. Windows
  Server 2008, Windows Vista, Windows Server 2003,  and Windows XP/2000:  This control code is not
  supported.


id: WIN32_SERVICE_AUTO_START
type: constant
doc:
<comment>Description:</comment>
  A service started automatically by the service control manager during system startup.


id: WIN32_SERVICE_BOOT_START
type: constant
doc:
<comment>Description:</comment>
  A device driver started by the system loader. This value is valid only for driver services.


id: WIN32_SERVICE_CONTROL_INTERROGATE
type: constant
doc:
<comment>Description:</comment>
  Notifies a service that it should report its current status information to the service control
  manager.


id: WIN32_SERVICE_CONTROL_NETBINDADD
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that there is a new component for binding.


id: WIN32_SERVICE_CONTROL_NETBINDDISABLE
type: constant
doc:
<comment>Description:</comment>
  0x0000000A
  
  Notifies a network service that one of its bindings has been disabled.


id: WIN32_SERVICE_CONTROL_NETBINDENABLE
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that a disabled binding has been enabled.


id: WIN32_SERVICE_CONTROL_NETBINDREMOVE
type: constant
doc:
<comment>Description:</comment>
  Notifies a network service that a component for binding has been removed.


id: WIN32_SERVICE_CONTROL_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  0x0000000F
  
  Notifies a service that the system will be shutting down. A service that handles this notification
  blocks system shutdown until the service stops or the preshutdown time-out interval expires. This
  value is not supported by Windows Server 2003 and Windows XP/2000.


id: WIN32_SERVICE_CONTROL_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Notifies a service that the system is shutting down so the service can perform cleanup tasks. If a
  service accepts this control code, it must stop after it performs its cleanup tasks. After the SCM
  sends this control code, it will not send other control codes to the service.


id: WIN32_SERVICE_DEMAND_START
type: constant
doc:
<comment>Description:</comment>
  A service started by the service control manager when a process calls the StartService function.


id: WIN32_SERVICE_DISABLED
type: constant
doc:
<comment>Description:</comment>
  A service that cannot be started. Attempts to start the service result in the error code
  <info>WIN32_ERROR_SERVICE_DISABLED</info>.


id: WIN32_SERVICE_ERROR_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log, if possible. If the last-known-good
  configuration is being started, the startup  operation fails. Otherwise, the system is restarted
  with the  last-known good configuration.


id: WIN32_SERVICE_ERROR_IGNORE
type: constant
doc:
<comment>Description:</comment>
  The startup program ignores the error and continues the startup operation.


id: WIN32_SERVICE_ERROR_NORMAL
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log but continues the startup operation.


id: WIN32_SERVICE_ERROR_SEVERE
type: constant
doc:
<comment>Description:</comment>
  The startup program logs the error in the event log. If the last-known-good configuration is being
  started, the startup  operation continues. Otherwise, the system is restarted with the
  last-known-good configuration.


id: WIN32_SERVICE_INTERACTIVE_PROCESS
type: constant
doc:
<comment>Description:</comment>
  The service can interact with the desktop. This option is not available on Windows Vista or later.


id: WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS
type: constant
doc:
<comment>Description:</comment>
  The service runs in a system process that must always be running.


id: WIN32_SERVICE_SYSTEM_START
type: constant
doc:
<comment>Description:</comment>
  A device driver started by the IoInitSystem function. This value is valid only for driver
  services.


id: WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  The service runs in its own process and can interact with the desktop. This option is not
  available on Windows Vista or later.


id: Warning::__construct
type: function
doc:
<comment>Description:</comment>
  Warning constructor
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.


id: WeakMap::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new map
  
  Constructs a new map.

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


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of live entries in the map
  
  Counts the number of live entries in the map.

<comment>Return:</comment>
  <info>int</info>  Returns the number of live entries in the map.


id: WeakMap::current
type: function
doc:
<comment>Description:</comment>
  Returns the current value under iteration
  
  Returns the current value being iterated on in the map.

<comment>Return:</comment>
  <info>mixed</info>  The value currently being iterated on.


id: WeakMap::key
type: function
doc:
<comment>Description:</comment>
  Returns the current key under iteration
  
  Returns the object serving as key in the map, at the current iterating position.

<comment>Return:</comment>
  <info>object</info>  The object key currently being iterated.


id: WeakMap::next
type: function
doc:
<comment>Description:</comment>
  Advances to the next map element
  
  Advances to the next map element.

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


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks whether a certain object is in the map
  
  Checks whether the passed object is referenced in the map.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Object to check for.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the object is contained in the map, <info>false</info> otherwise.


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value pointed to by a certain object
  
  Returns the value pointed to by a certain object.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Some object contained as key in the map.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value associated to the object passed as argument, <info>null</info> otherwise.


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  Updates the map with a new key-value pair
  
  Updates the map with a new key-value pair. If the key already existed in the map, the old value is
  replaced with the new.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object serving as key of the key-value pair.
  <info>mixed </info>  <strong>$value </strong>  The arbitrary data serving as value of the key-value pair.

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


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes an entry from the map
  
  Removes an entry from the map.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The key object to remove from the map.

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


id: WeakMap::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds the iterator to the beginning of the map
  
  Rewinds the iterator to the beginning of the map.

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


id: WeakMap::valid
type: function
doc:
<comment>Description:</comment>
  Returns whether the iterator is still on a valid map element
  
  Returns whether the iterator is still on a valid map element.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the iterator is on a valid element that can be accessed, <info>false</info> otherwise.


id: WeakRef
type: class
doc:
<comment>Description:</comment>
  The WeakRef class provides a gateway to objects without preventing the garbage collector from
  freeing those objects. It also provides a way to turn a weak reference into a strong one.
  
  The class <class>WeakRef</class> is not to be confused with the class <class>WeakReference</class>.


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  Weak references allow the programmer to retain a reference to an object which does not prevent the
  object from being destroyed. They are useful for implementing cache like structures.
  
  The class <class>WeakReference</class> is not to be confused with the class <class>WeakRef</class> of the Weakref extension.
  
  <class>WeakReference</class>s cannot be serialized.


id: WeakReference::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor that disallows instantiation
  
  This method exists only to disallow instantiation of the <class>WeakReference</class> class. Weak references are
  to be instantiated with the factory method WeakReference::create.

<comment>See Also:</comment>
   * WeakReference::create


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  Create a new weak reference
  
  Creates a new <class>WeakReference</class>.

<comment>Param:</comment>
  <info>object</info>  <strong>$referent</strong>  The object to be weakly referenced.

<comment>Return:</comment>
  <info>WeakReference</info>  Returns the freshly instantiated object.


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  Get a weakly referenced Object
  
  Gets a weakly referenced object. If the object has already been destroyed, <info>null</info> is returned.

<comment>Return:</comment>
  <info>objectnull</info>  Returns the referenced <info>object</info>, or <info>null</info> if the object has been destroyed.


id: Weakref::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new weak reference
  
  Constructs a new weak reference.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object to reference.

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


id: Weakref::acquire
type: function
doc:
<comment>Description:</comment>
  Acquires a strong reference on that object
  
  Acquires a strong reference on that object, virtually turning the weak reference into a strong
  one.
  
  The <class>Weakref</class> instance maintains an internal acquired counter to track outstanding strong
  references. If the call to  Weakref::acquire is successful, this counter  will be incremented by
  one.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the reference was valid and could be turned into a strong reference, <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * Weakref::release


id: Weakref::get
type: function
doc:
<comment>Description:</comment>
  Returns the object pointed to by the weak reference
  
  Returns the object pointed to by the weak reference.

<comment>Return:</comment>
  <info>object</info>  Returns the object if the reference is still valid, <info>null</info> otherwise.

<comment>See Also:</comment>
   * Weakref::valid


id: Weakref::release
type: function
doc:
<comment>Description:</comment>
  Releases a previously acquired reference
  
  Releases a previously acquired reference, potentially turning a strong reference back into a weak
  reference.
  
  The <class>Weakref</class> instance maintains an internal acquired counter to track outstanding strong
  references. If the call to  Weakref::release is successful, this counter  will be decremented by
  one. Once this counter reaches zero, the strong reference is turned back into a weak reference.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the reference was previously acquired and thus could be released, <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * Weakref::acquire


id: Weakref::valid
type: function
doc:
<comment>Description:</comment>
  Checks whether the object referenced still exists
  
  Checks whether the object referenced still exists.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the object still exists and is thus still accessible via Weakref::get, <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * Weakref::get


id: Worker
type: class
doc:
<comment>Description:</comment>
  Worker Threads have a persistent context, as such should be used over Threads in most cases.
  
  When a Worker is started, the run method will be executed, but the Thread will not leave until one
  of the following conditions are met:
  
  the Worker goes out of scope (no more references remain)
  
  the programmer calls shutdown
  
  the script dies
  
  This means the programmer can reuse the context throughout execution; placing objects on the stack
  of the Worker will cause the Worker to execute the stacked objects run method.


id: Worker::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the worker to collect references determined to be garbage by the optionally given
  collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks on the worker's stack to be collected.


id: Worker::getStacked
type: function
doc:
<comment>Description:</comment>
  Gets the remaining stack size
  
  Returns the number of tasks left on the stack

<comment>Return:</comment>
  <info>int</info>  Returns the number of tasks currently waiting to be executed by the worker


id: Worker::isShutdown
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Whether the worker has been shutdown or not.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the worker has been shutdown or not.


id: Worker::isWorking
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if a Worker is executing Stackables

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state


id: Worker::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the worker
  
  Shuts down the worker after executing all of the stacked tasks.

<comment>Return:</comment>
  <info>bool</info>  Whether the worker was successfully shutdown or not.


id: Worker::stack
type: function
doc:
<comment>Description:</comment>
  Stacking work
  
  Appends the new work to the stack of the referenced worker.

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$work</strong>  A <class>Threaded</class> object to be executed by the worker.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: Worker::unstack
type: function
doc:
<comment>Description:</comment>
  Unstacking work
  
  Removes the first task (the oldest one) in the stack.

<comment>Return:</comment>
  <info>int</info>  The new size of the stack.


id: XATTR_DONTFOLLOW
type: constant
doc:
<comment>Description:</comment>
  Do not follow the symbolic link but operate on symbolic link itself.


id: XATTR_ROOT
type: constant
doc:
<comment>Description:</comment>
  Set attribute in root (trusted) namespace. Requires root privileges.


id: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  This flag indicates that <strong>xdiff_string_patch()</strong> and <strong>xdiff_file_patch()</strong> functions should create
  result by applying patch to original content thus creating newer version of file. This is the
  default mode of operation.


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  This flag indicated that <strong>xdiff_string_patch()</strong> and <strong>xdiff_file_patch()</strong> functions should create
  result by reversing patch changed from newer content thus creating original version.


id: XMLDiff\Base
type: class
doc:
<comment>Description:</comment>
  Base abstract class for all the comparsion classes in the extension.


id: XMLDiff\Base::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Base constructor for all the worker classes in the xmldiff extension.

<comment>Param:</comment>
  <info>string</info>  <strong>$nsname</strong>  Custom namespace name for the diff document. The default namespace is
                   http://www.locus.cz/diffmark and that's enough to avoid namespace conflicts. Use
                   this parameter if you want to change it for some reason.


id: XMLDiff\Base::diff
type: function
doc:
<comment>Description:</comment>
  Produce diff of two XML documents
  
  Abstract diff method to be implemented by inheriting classes.
  
  The basic purpose of this method is to produce diff of the two documents. The param order matters
  and will produce different output.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>  Source XML document.
  <info>mixed</info>  <strong>$to  </strong>  Target XML document.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\Base::merge
type: function
doc:
<comment>Description:</comment>
  Produce new XML document based on diff
  
  Abstract merge method to be implemented by inheriting classes.
  
  Basically the method purpose is to produce a new XML document based on the diff information.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$src </strong>  Source XML document.
  <info>mixed</info>  <strong>$diff</strong>  Document produced by the diff method.

<comment>Return:</comment>
  <info>mixed</info>  Implementation dependent.


id: XMLDiff\DOM::diff
type: function
doc:
<comment>Description:</comment>
  Diff two DOMDocument objects
  
  Diff two DOMDocument instances and produce the new one containing the diff information.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$from</strong>  Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$to  </strong>  Target DOMDocument object.

<comment>Return:</comment>
  <info>DOMDocument</info>  DOMDocument with the diff information or NULL.


id: XMLDiff\DOM::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged DOMDocument
  
  Create new DOMDocument based on the diff.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$src </strong>  Source DOMDocument object.
  <info>DOMDocument</info>  <strong>$diff</strong>  DOMDocument object containing the diff information.

<comment>Return:</comment>
  <info>DOMDocument</info>  Merged DOMDocument or NULL.


id: XMLDiff\File::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML files
  
  Diff two local XML files and produce string with the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Path to the source document.
  <info>string</info>  <strong>$to  </strong>  Path to the target document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\File::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src </strong>  Path to the source XML document.
  <info>string</info>  <strong>$diff</strong>  Path to the XML document with the diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLDiff\Memory::diff
type: function
doc:
<comment>Description:</comment>
  Diff two XML documents
  
  Diff two strings containing XML documents and produce the diff information.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Source XML document.
  <info>string</info>  <strong>$to  </strong>  Target XML document.

<comment>Return:</comment>
  <info>string</info>  String with the XML document containing the diff information or NULL.


id: XMLDiff\Memory::merge
type: function
doc:
<comment>Description:</comment>
  Produce merged XML document
  
  Create new XML document based on diffs and source document.

<comment>Param:</comment>
  <info>string</info>  <strong>$src </strong>  Source XML document.
  <info>string</info>  <strong>$diff</strong>  XML document containing diff information.

<comment>Return:</comment>
  <info>string</info>  String with the new XML document or NULL.


id: XMLReader
type: class
doc:
<comment>Description:</comment>
  The XMLReader extension is an XML Pull parser. The reader acts as a  cursor going forward on the
  document stream and stopping at each node  on the way.


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  Set the data containing the XML to parse
  
  Set the data containing the XML to parse.

<comment>Param:</comment>
  <info>string    </info>  <strong>$source  </strong>  String containing the XML to be parsed.
  <info>stringnull</info>  <strong>$encoding</strong>  The document encoding or <info>null</info>.
  <info>int       </info>  <strong>$flags   </strong>  A bitmask of the LIBXML_*  constants.

<comment>Return:</comment>
  <info>boolXMLReader</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento. If called
                 statically, returns an <class>XMLReader</class> o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::close


id: XMLReader::close
type: function
doc:
<comment>Description:</comment>
  Close the XMLReader input
  
  Closes the input the XMLReader object is currently parsing.

<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>
   * XMLReader::open
   * XMLReader::xml


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  Returns a copy of the current node as a DOM object
  
  This method copies the current node and returns the appropriate DOM object.

<comment>Param:</comment>
  <info>DOMNodenull</info>  <strong>$baseNode</strong>  A <class>DOMNode</class> defining the target <class>DOMDocument</class> for the created DOM object.

<comment>Return:</comment>
  <info>DOMNodefalse</info>  The resulting <class>DOMNode</class> or <info>false</info> on error.


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  Get the value of a named attribute
  
  Returns the value of a named attribute or <info>null</info> if the attribute does not exist or not positioned
  on an element node.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the attribute.

<comment>Return:</comment>
  <info>stringnull</info>  The value of the attribute, or <info>null</info> if no attribute with the given <strong>$name</strong> is found or
              not positioned on an element node.

<comment>See Also:</comment>
   * XMLReader::getAttributeNo
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNo
type: function
doc:
<comment>Description:</comment>
  Get the value of an attribute by index
  
  Returns the value of an attribute based on its position or an  empty string if attribute does not
  exist or not positioned on  an element node.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position of the attribute.

<comment>Return:</comment>
  <info>stringnull</info>  The value of the attribute, or an empty string (before PHP 5.6) or <info>null</info> (from PHP 5.6
              onwards) if no attribute exists at <strong>$index</strong> or is not positioned on the element.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  Get the value of an attribute by localname and URI
  
  Returns the value of an attribute by name and namespace URI or an empty  string if attribute does
  not exist or not positioned on an element node.

<comment>Param:</comment>
  <info>string</info>  <strong>$name     </strong>  The local name.
  <info>string</info>  <strong>$namespace</strong>  The namespace URI.

<comment>Return:</comment>
  <info>stringnull</info>  The value of the attribute, or an empty string (before PHP 5.6) or <info>null</info> (from PHP 5.6
              onwards) if no attribute with the given <strong>$name</strong> and <strong>$namespace</strong> is found or not
              positioned of element.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNo


id: XMLReader::getParserProperty
type: function
doc:
<comment>Description:</comment>
  Indicates if specified property has been set
    
  
  Indicates if specified property has been set.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  One of the parser option  constants.

<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>
   * XMLReader::setParserProperty


id: XMLReader::isValid
type: function
doc:
<comment>Description:</comment>
  Indicates if the parsed document is valid
  
  Returns a boolean indicating if the document being parsed is currently valid.

<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>
   * XMLReader::setParserProperty
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  Lookup namespace for a prefix
  
  Lookup in scope namespace for a given prefix.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  String containing the prefix.

<comment>Return:</comment>
  <info>stringnull</info>  The value of the namespace, or <info>null</info> if no namespace exists.


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  Move cursor to a named attribute
  
  Positions cursor on the named attribute.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the attribute.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNo
type: function
doc:
<comment>Description:</comment>
  Move cursor to an attribute by index
  
  Positions cursor on attribute based on its position.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The position of the attribute.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  Move cursor to a named attribute
  
  Positions cursor on the named attribute in specified namespace.

<comment>Param:</comment>
  <info>string</info>  <strong>$name     </strong>  The local name.
  <info>string</info>  <strong>$namespace</strong>  The namespace URI.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  Position cursor on the parent Element of current Attribute
  
  Moves cursor to the parent Element of current Attribute.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if successful and <info>false</info> if it fails or not positioned on  Attribute when this
        method is called.

<comment>See Also:</comment>
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  Position cursor on the first Attribute
  
  Moves cursor to the first Attribute.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToNextAttribute


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  Position cursor on the next Attribute
  
  Moves cursor to the next Attribute if positioned on an Attribute or  moves to first attribute if
  positioned on an Element.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  Move cursor to next node skipping all subtrees
  
  Positions cursor on the next node skipping all subtrees.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$name</strong>  The name of the next node to move to.

<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>
   * XMLReader::moveToNextAttribute
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  Set the URI containing the XML to parse
  
  Set the URI containing the XML document to be parsed.

<comment>Param:</comment>
  <info>string    </info>  <strong>$uri     </strong>  URI pointing to the document.
  <info>stringnull</info>  <strong>$encoding</strong>  The document encoding or <info>null</info>.
  <info>int       </info>  <strong>$flags   </strong>  A bitmask of the LIBXML_*  constants.

<comment>Return:</comment>
  <info>boolXMLReader</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento. If called
                 statically, returns an <class>XMLReader</class> o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * XMLReader::xml
   * XMLReader::close


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  Move to next node in document
  
  Moves cursor to the next node in the document.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::next


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  Retrieve XML from current node
  
  Reads the contents of the current node, including child nodes and markup.

<comment>Return:</comment>
  <info>string</info>  Returns the contents of the current node as a string. Empty string on failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readOuterXml
type: function
doc:
<comment>Description:</comment>
  Retrieve XML from current node, including itself
  
  Reads the contents of the current node, including the node itself.

<comment>Return:</comment>
  <info>string</info>  Returns the contents of current node, including itself, as a string. Empty string on
          failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readString
type: function
doc:
<comment>Description:</comment>
  Reads the contents of the current node as a string
  
  Reads the contents of the current node as a string.

<comment>Return:</comment>
  <info>string</info>  Returns the content of the current node as a string. Empty string on failure.

<comment>See Also:</comment>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::setParserProperty
type: function
doc:
<comment>Description:</comment>
  Set parser options
  
  Set parser options. The options must be set after XMLReader::open or  XMLReader::xml are called
  and before  the first XMLReader::read call.

<comment>Param:</comment>
  <info>int </info>  <strong>$property</strong>  One of the parser option  constants.
  <info>bool</info>  <strong>$value   </strong>  If set to <info>true</info> the option will be enabled otherwise will  be disabled.

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


id: XMLReader::setRelaxNGSchema
type: function
doc:
<comment>Description:</comment>
  Set the filename or URI for a RelaxNG Schema
  
  Set the filename or URI for the RelaxNG Schema to use for validation.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$filename</strong>  filename or URI pointing to a RelaxNG Schema.

<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>
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  Set the data containing a RelaxNG Schema
  
  Set the data containing a RelaxNG Schema to use for validation.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$source</strong>  String containing the RelaxNG Schema.

<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>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  Validate document against XSD
  
  Use W3C XSD schema to validate the document as it is processed. Activation is only possible before
  the first Read().

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$filename</strong>  The filename of the XSD schema.

<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>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::isValid


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  End attribute
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current attribute.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  End current CDATA
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current CDATA section.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startCdata
   * XMLWriter::writeCdata


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  Create end comment
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current comment.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startComment
   * XMLWriter::writeComment


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  End current document
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current document.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDocument


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  End current DTD
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the DTD of the document.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtd
   * XMLWriter::writeDtd


id: XMLWriter::endDtdAttlist
type: function
doc:
<comment>Description:</comment>
  End current DTD AttList
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current DTD attribute list.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  End current DTD element
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current DTD element.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  End current DTD Entity
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current DTD entity.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  End current element
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current element.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  End current PI
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Ends the current processing instruction.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::startPi
   * XMLWriter::writePi


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  Flush current buffer
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Flushes the current buffer.

<comment>Param:</comment>
  <info>    </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                    La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                    chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>  <strong>$empty    </strong>  Whether to empty the buffer or not. Default is <info>true</info>.

<comment>Return:</comment>
  <info>stringint</info>  If you opened the writer in memory, this function returns the generated XML buffer,
             Else, if using URI, this function will write the buffer and return the number of
             written bytes.


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  End current element
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  End the current xml element. Writes an end tag even if the element is empty.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::endElement


id: XMLWriter::openMemory
type: function
doc:
<comment>Description:</comment>
  Create new xmlwriter using memory for string output
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Creates a new <class>XMLWriter</class> using memory for string output.

<comment>Return:</comment>
  <info>bool</info>  Stile orientato agli oggetti: Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di
        fallimento.
        
        Stile procedurale: Returns a new <class>XMLWriter</class> for later use with the xmlwriter functions on
        success,  o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * XMLWriter::openUri


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  Create new xmlwriter using source uri for output
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Creates a new <class>XMLWriter</class> using  <strong>$uri</strong> for the output.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  The URI of the resource for the output.

<comment>Return:</comment>
  <info>bool</info>  Stile orientato agli oggetti: Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di
        fallimento.
        
        Stile procedurale: Returns a new <class>XMLWriter</class> instance for later use with the xmlwriter
        functions on success,  o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * XMLWriter::openMemory


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  Returns current buffer
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Returns the current buffer.

<comment>Param:</comment>
  <info>    </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                    La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                    chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>  <strong>$flush    </strong>  Whether to flush the output buffer or not. Default is <info>true</info>.

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

<comment>See Also:</comment>
   * XMLWriter::flush


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  Toggle indentation on/off
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Toggles indentation on or off.

<comment>Param:</comment>
  <info>    </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                    La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                    chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>  <strong>$enable   </strong>  Whether indentation is enabled.

<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>
   * XMLWriter::setIndentString


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  Set string used for indenting
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Sets the string which will be used to indent each element/attribute of the resulting xml.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter  </strong>  Solo per chiamate procedurali. 
                        La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                        chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$indentation</strong>  The indentation string.

<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>
   * XMLWriter::setIndent


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  Create start attribute
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts an attribute.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The attribute name.

<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>
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  Create start namespaced attribute
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a namespaced attribute.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>stringnull</info>  <strong>$prefix   </strong>  The namespace prefix.
  <info>string    </info>  <strong>$name     </strong>  The attribute name.
  <info>stringnull</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                          be omitted.

<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>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  Create start CDATA tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a CDATA.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::endCdata
   * XMLWriter::writeCdata


id: XMLWriter::startComment
type: function
doc:
<comment>Description:</comment>
  Create start comment
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a comment.

<comment>Param:</comment>
  <info></info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una chiamata
                a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.

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

<comment>See Also:</comment>
   * XMLWriter::endComment
   * XMLWriter::writeComment


id: XMLWriter::startDocument
type: function
doc:
<comment>Description:</comment>
  Create document tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a document.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter </strong>  Solo per chiamate procedurali. 
                           La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da
                           una chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>stringnull</info>  <strong>$version   </strong>  The version number of the document as part of the XML declaration.
  <info>stringnull</info>  <strong>$encoding  </strong>  The encoding of the document as part of the XML declaration.
  <info>stringnull</info>  <strong>$standalone</strong>  <return>yes</return> or <return>no</return>.

<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>
   * XMLWriter::endDocument


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  Create start DTD tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a DTD.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter    </strong>  Solo per chiamate procedurali. 
                              La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da
                              una chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string    </info>  <strong>$qualifiedName</strong>  The qualified name of the document type to create.
  <info>stringnull</info>  <strong>$publicId     </strong>  The external subset public identifier.
  <info>stringnull</info>  <strong>$systemId     </strong>  The external subset system 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>
   * XMLWriter::endDtd
   * XMLWriter::writeDtd


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Create start DTD AttList
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a DTD attribute list.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The attribute list name.

<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>
   * XMLWriter::endDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  Create start DTD element
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a DTD element.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter    </strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$qualifiedName</strong>  The qualified name of the document type to create.

<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>
   * XMLWriter::endDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  Create start DTD Entity
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a DTD entity.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The name of the entity.
  <info>bool  </info>  <strong>$isParam  </strong>  

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

<comment>See Also:</comment>
   * XMLWriter::endDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  Create start element tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts an element.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The element name.

<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>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  Create start namespaced element tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a namespaced element.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>stringnull</info>  <strong>$prefix   </strong>  The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string    </info>  <strong>$name     </strong>  The element name.
  <info>stringnull</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                          be omitted.

<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>
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  Create start PI tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Starts a processing instruction tag.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$target   </strong>  The target of the processing instruction.

<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>
   * XMLWriter::endPi
   * XMLWriter::writePi


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  Write text
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a text.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$content  </strong>  The contents of the text. The characters <return>\<</return>, <return>&gt;</return>, <return>&</return> and <return>"</return> are written as entity references (i.e. , , and , respectively). All other characters including <return>'</return> are written literally. To write the special XML characters literally, or to write literal entity references, <strong>xmlwriter_write_raw()</strong> has to be used.

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


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  Write full attribute
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full attribute.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The name of the attribute.
  <info>string</info>  <strong>$value    </strong>  The value of the attribute.

<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>
   * XMLWriter::writeAttributeNs
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  Write full namespaced attribute
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full namespaced attribute.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>stringnull</info>  <strong>$prefix   </strong>  The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string    </info>  <strong>$name     </strong>  The attribute name.
  <info>stringnull</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                          be omitted.
  <info>string    </info>  <strong>$value    </strong>  The attribute value.

<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>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  Write full CDATA tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full CDATA.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$content  </strong>  The contents of the CDATA.

<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>
   * XMLWriter::startCdata
   * XMLWriter::endCdata


id: XMLWriter::writeComment
type: function
doc:
<comment>Description:</comment>
  Write full comment tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full comment.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$content  </strong>  The contents of the comment.

<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>
   * XMLWriter::startComment
   * XMLWriter::endComment


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  Write full DTD tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full DTD.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string    </info>  <strong>$name     </strong>  The DTD name.
  <info>stringnull</info>  <strong>$publicId </strong>  The external subset public identifier.
  <info>stringnull</info>  <strong>$systemId </strong>  The external subset system identifier.
  <info>stringnull</info>  <strong>$content  </strong>  The content of the DTD.

<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>
   * XMLWriter::startDtd
   * XMLWriter::endDtd


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Write full DTD AttList tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a DTD attribute list.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The name of the DTD attribute list.
  <info>string</info>  <strong>$content  </strong>  The content of the DTD attribute list.

<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>
   * XMLWriter::startDtdAttlist
   * XMLWriter::endDtdAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  Write full DTD element tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full DTD element.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The name of the DTD element.
  <info>string</info>  <strong>$content  </strong>  The content of the element.

<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>
   * XMLWriter::startDtdElement
   * XMLWriter::endDtdElement


id: XMLWriter::writeDtdEntity
type: function
doc:
<comment>Description:</comment>
  Write full DTD Entity tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full DTD entity.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$name     </strong>  The name of the entity.
  <info>string</info>  <strong>$content  </strong>  The content of the entity.

<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>
   * XMLWriter::startDtdEntity
   * XMLWriter::endDtdEntity


id: XMLWriter::writeElement
type: function
doc:
<comment>Description:</comment>
  Write full element tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full element tag.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string    </info>  <strong>$name     </strong>  The element name.
  <info>stringnull</info>  <strong>$content  </strong>  The element contents.

<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>
   * XMLWriter::startElement
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::writeElementNs
type: function
doc:
<comment>Description:</comment>
  Write full namespaced element tag
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a full namespaced element tag.

<comment>Param:</comment>
  <info>          </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                          La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                          chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>stringnull</info>  <strong>$prefix   </strong>  The namespace prefix. If <strong>$prefix</strong> is <info>null</info>, the namespace will be omitted.
  <info>string    </info>  <strong>$name     </strong>  The element name.
  <info>stringnull</info>  <strong>$namespace</strong>  The namespace URI. If <strong>$namespace</strong> is <info>null</info>, the namespace declaration will
                          be omitted.
  <info>stringnull</info>  <strong>$content  </strong>  The element contents.

<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>
   * XMLWriter::startElementNs
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::writePi
type: function
doc:
<comment>Description:</comment>
  Writes a PI
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a processing instruction.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$target   </strong>  The target of the processing instruction.
  <info>string</info>  <strong>$content  </strong>  The content of the processing instruction.

<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>
   * XMLWriter::startPi
   * XMLWriter::endPi


id: XMLWriter::writeRaw
type: function
doc:
<comment>Description:</comment>
  Write a raw XML text
  
  Stile orientato agli oggetti
  
  Stile procedurale
  
  Writes a raw xml text.

<comment>Param:</comment>
  <info>      </info>  <strong>$xmlwriter</strong>  Solo per chiamate procedurali. 
                      La <info>resource</info> XMLWriter che è stata modificata. Questa risorsa deriva da una
                      chiamata a <strong>xmlwriter_open_uri()</strong> or <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>  <strong>$content  </strong>  The text string to write.

<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>
   * XMLWriter::text


id: XML_SAX_IMPL
type: constant
doc:
<comment>Description:</comment>
  Contiene l'implementazione del metodo SAX. Può essere <return>libxml</return> o <return>expat</return>.


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

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


id: XSLTProcessor::getParameter
type: function
doc:
<comment>Description:</comment>
  Get value of a parameter
  
  Gets a parameter if previously set by <strong>XSLTProcessor::setParameter()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  The namespace URI of the XSLT parameter.
  <info>string</info>  <strong>$name     </strong>  The local name of the XSLT parameter.

<comment>Return:</comment>
  <info>stringfalse</info>  The value of the parameter (as a string), or <info>false</info> if it's not set.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::getSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Get security preferences
  
  Gets the security preferences.

<comment>Return:</comment>
  <info>int</info>  A bitmask consisting of <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>,
       <info>XSL_SECPREF_CREATE_DIRECTORY</info>, <info>XSL_SECPREF_READ_NETWORK</info>, <info>XSL_SECPREF_WRITE_NETWORK</info>.


id: XSLTProcessor::hasExsltSupport
type: function
doc:
<comment>Description:</comment>
  Determine if PHP has EXSLT support
  
  This method determines if PHP was built with the EXSLT library.

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


id: XSLTProcessor::importStylesheet
type: function
doc:
<comment>Description:</comment>
  Import stylesheet
  
  This method imports the stylesheet into the  <class>XSLTProcessor</class> for transformations.

<comment>Param:</comment>
  <info>object</info>  <strong>$stylesheet</strong>  The imported style sheet as a <class>DOMDocument</class> or <class>SimpleXMLElement</class> object.

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


id: XSLTProcessor::registerPHPFunctions
type: function
doc:
<comment>Description:</comment>
  Enables the ability to use PHP functions as XSLT functions
  
  This method enables the ability to use PHP functions as XSLT functions within XSL stylesheets.

<comment>Param:</comment>
  <info>arraystringnull</info>  <strong>$functions</strong>  Use this parameter to only allow certain functions to be called from
                               XSLT.
                               
                               This parameter can be either a string (a function name) or an array
                               of functions.

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


id: XSLTProcessor::removeParameter
type: function
doc:
<comment>Description:</comment>
  Remove parameter
  
  Removes a parameter, if set. This will make the processor use the default value for the parameter
  as specified in the stylesheet.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  The namespace URI of the XSLT parameter.
  <info>string</info>  <strong>$name     </strong>  The local name of the XSLT parameter.

<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>XSLTProcessor::setParameter()</strong>
   * <strong>XSLTProcessor::getParameter()</strong>


id: XSLTProcessor::setParameter
type: function
doc:
<comment>Description:</comment>
  Set value for a parameter
  
  Sets the value of one or more parameters to be used in subsequent  transformations with
  <class>XSLTProcessor</class>. If the  parameter doesn't exist in the stylesheet it will be ignored.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  The namespace URI of the XSLT parameter.
  <info>string</info>  <strong>$name     </strong>  The local name of the XSLT parameter.
  <info>string</info>  <strong>$value    </strong>  The new value of the XSLT parameter.
  <info>array </info>  <strong>$options  </strong>  An array of  <return>name =&gt; value</return> pairs.

<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>XSLTProcessor::getParameter()</strong>
   * <strong>XSLTProcessor::removeParameter()</strong>


id: XSLTProcessor::setProfiling
type: function
doc:
<comment>Description:</comment>
  Sets profiling output file
  
  Sets the file to output profiling information when processing  a stylesheet.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$filename</strong>  Path to the file to dump profiling information.

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


id: XSLTProcessor::setSecurityPrefs
type: function
doc:
<comment>Description:</comment>
  Set security preferences
  
  Sets the security preferences.

<comment>Param:</comment>
  <info>int</info>  <strong>$preferences</strong>  The new security preferences. The following constants can be ORed:
                     <info>XSL_SECPREF_READ_FILE</info>, <info>XSL_SECPREF_WRITE_FILE</info>, <info>XSL_SECPREF_CREATE_DIRECTORY</info>,
                     <info>XSL_SECPREF_READ_NETWORK</info>, <info>XSL_SECPREF_WRITE_NETWORK</info>. Alternatively,
                     <info>XSL_SECPREF_NONE</info> or <info>XSL_SECPREF_DEFAULT</info> can be passed.

<comment>Return:</comment>
  <info>int</info>  Returns the old security preferences.


id: XSLTProcessor::transformToDoc
type: function
doc:
<comment>Description:</comment>
  Transform to a DOMDocument
  
  Transforms the source node to a <class>DOMDocument</class> applying the stylesheet given by the
  <strong>XSLTProcessor::importStylesheet()</strong> method.

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  The node to be transformed.

<comment>Return:</comment>
  <info>DOMDocumentfalse</info>  The resulting <class>DOMDocument</class> or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToUri()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToUri
type: function
doc:
<comment>Description:</comment>
  Transform to URI
  
  Transforms the source node to an URI applying the stylesheet given by the
  <strong>XSLTProcessor::importStylesheet()</strong> method.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$doc</strong>  The document to transform.
  <info>string     </info>  <strong>$uri</strong>  The target URI for the transformation.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes written or <info>false</info> if an error occurred.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToXml()</strong>


id: XSLTProcessor::transformToXml
type: function
doc:
<comment>Description:</comment>
  Transform to XML
  
  Transforms the source node to a string applying the stylesheet given by the
  <strong>xsltprocessor::importStylesheet()</strong> method.

<comment>Param:</comment>
  <info>object</info>  <strong>$document</strong>  The <info>DOMDocument</info> or <info>SimpleXMLElement</info> object to be transformed.

<comment>Return:</comment>
  <info>stringfalsenull</info>  The result of the transformation as a string or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>XSLTProcessor::transformToDoc()</strong>
   * <strong>XSLTProcessor::transformToUri()</strong>


id: XSL_SECPREF_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Disallows all write access, i.e. a bitmask of <info>XSL_SECPREF_WRITE_NETWORK</info> |
  <info>XSL_SECPREF_CREATE_DIRECTORY</info> | <info>XSL_SECPREF_WRITE_FILE</info>.


id: XmlParser
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>xml</return> resources as of PHP 8.0.0.


id: Yac::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  prefix is used to prepended to keys, this could be used to avoiding conflicts between apps.

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


id: Yac::__get
type: function
doc:
<comment>Description:</comment>
  Getter
  
  Retrieve values from cache

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

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, <info>null</info> on failure


id: Yac::__set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  store a item into cache

<comment>Param:</comment>
  <info>string</info>  <strong>$keys </strong>  <info>string</info> key
  <info>mixed </info>  <strong>$value</strong>  mixed value, All php value type could be stored except resource

<comment>Return:</comment>
  <info>mixed</info>  Always return the value self


id: Yac::add
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Added a item into cache.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys </strong>  <info>string</info> key
  <info>mixed </info>  <strong>$value</strong>  mixed value, All php value type could be stored except resource
  <info>int   </info>  <strong>$ttl  </strong>  expire time

<comment>Return:</comment>
  <info>bool</info>  <info>bool</info>, <info>true</info> on success, <info>false</info> on failure  Yac::add may fail if cas lock could not obtain, so,
        if you need the value to be stored properly, you may write codes like: Make sure the item is
        storedset("key", "vale)); ]]>
        
        Yac::add may fail if cas lock could not obtain, so, if you need the value to be stored
        properly, you may write codes like: Make sure the item is storedset("key", "vale)); ]]>


id: Yac::delete
type: function
doc:
<comment>Description:</comment>
  Remove items from cache
  
  remove items from cache

<comment>Param:</comment>
  <info>stringarray</info>  <strong>$keys</strong>  string key, or array of multiple keys to be removed
  <info>int        </info>  <strong>$ttl </strong>  if delay is set, delete will mark the items to be invalid in ttl second.

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


id: Yac::dump
type: function
doc:
<comment>Description:</comment>
  Dump cache
  
  Dump values stored in cache

<comment>Param:</comment>
  <info></info>  <strong>$num</strong>  Maximum number of items should be returned

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


id: Yac::flush
type: function
doc:
<comment>Description:</comment>
  Flush the cache
  
  Remove all cached values

<comment>Return:</comment>
  <info>bool</info>  bool, always true


id: Yac::get
type: function
doc:
<comment>Description:</comment>
  Retrieve values from cache
  
  Retrieve values from cache

<comment>Param:</comment>
  <info>stringarray</info>  <strong>$key</strong>  <info>string</info> keys, or <info>array</info> of multiple keys.
  <info>int        </info>  <strong>$cas</strong>  if not <info>null</info>, it will be set to the retrieved item's cas.

<comment>Return:</comment>
  <info>mixed</info>  mixed on success, false on failure


id: Yac::info
type: function
doc:
<comment>Description:</comment>
  Status of cache
  
  Get status of cache system

<comment>Return:</comment>
  <info>array</info>  Return an array, consistent with: "memory_size", "slots_memory_size", "values_memory_size",
         "segment_size", "segment_num", "miss", "hits", "fails", "kicks", "recycles", "slots_size",
         "slots_used"


id: Yac::set
type: function
doc:
<comment>Description:</comment>
  Store into cache
  
  Add a item into cache, it the key is already exists, override it.

<comment>Param:</comment>
  <info>string</info>  <strong>$keys </strong>  <info>string</info> key
  <info>mixed </info>  <strong>$value</strong>  mixed value, All php value type could be stored except resource
  <info>int   </info>  <strong>$ttl  </strong>  expire time

<comment>Return:</comment>
  <info>bool</info>  the value self


id: Yaconf
type: class
doc:
<comment>Description:</comment>
  Yaconf is a configurations container, it parses INIT files, stores the result in PHP when PHP is
  started, the result lives  with the whole PHP lifecycle.


id: Yaconf::get
type: function
doc:
<comment>Description:</comment>
  Retrieve a item

<comment>Param:</comment>
  <info>string</info>  <strong>$name         </strong>  Configuration key, the key looks like "filename.key", or
                          "filename.sectionName,key".
  <info>mixed </info>  <strong>$default_value</strong>  if the key doesn't exists, Yaconf::get will return this as result.

<comment>Return:</comment>
  <info>mixed</info>  Returns configuration result(string or array) if the key exists, return default_value if
         not.


id: Yaconf::has
type: function
doc:
<comment>Description:</comment>
  Determine if a item exists

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

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


id: Yaf_Action_Abstract
type: class
doc:
<comment>Description:</comment>
  A action can be defined in a separate file in Yaf(see <class>Yaf_Controller_Abstract</class>). that is a action
  method can also be a <class>Yaf_Action_Abstract</class> class.
  
  Since there should be a entry point which can be called by Yaf (as of PHP 5.3,  there is a new
  magic method __invoke, but Yaf is not only works with PHP 5.3+,  Yaf choose another magic method
  execute), you must implement the abstract method Yaf_Action_Abstract::execute in your custom
  action class.


id: Yaf_Action_Abstract::execute
type: function
doc:
<comment>Description:</comment>
  Action entry point
  
  user should always define this method for a action, this is the entry point of an action.
  Yaf_Action_Abstract::execute may have agruments.  The value retrived from the request is not safe.
  you should do some filtering work before you use it.
  
  The value retrived from the request is not safe. you should do some filtering work before you use
  it.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$args</strong>  

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

<comment>See Also:</comment>
   * 


id: Yaf_Action_Abstract::getController
type: function
doc:
<comment>Description:</comment>
  Retrieve controller object
  
  retrieve current controller object.

<comment>Return:</comment>
  <info>Yaf_Controller_Abstract</info>  <class>Yaf_Controller_Abstract</class> instance


id: Yaf_Action_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  Get controller name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Application
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Application</class> provides a bootstrapping facility  for applications which provides reusable
  resources, common- and  module-based bootstrap classes and dependency checking.
  
  <class>Yaf_Application</class> implements the singleton pattern, and <class>Yaf_Application</class> can not be serialized or
  unserialized which will cause problem when you try  to use PHPUnit to write some test case for
  Yaf.  You may use @backupGlobals annotation of PHPUnit to control the  backup and restore
  operations for global variables. thus can solve  this problem.
  
  <class>Yaf_Application</class> implements the singleton pattern, and <class>Yaf_Application</class> can not be serialized or
  unserialized which will cause problem when you try  to use PHPUnit to write some test case for
  Yaf.
  
  You may use @backupGlobals annotation of PHPUnit to control the  backup and restore operations for
  global variables. thus can solve  this problem.


id: Yaf_Application::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Application constructor
  
  Instance a <class>Yaf_Application</class>.

<comment>Param:</comment>
  <info>mixed </info>  <strong>$config </strong>  A ini config file path, or a config array
                    
                    If is a ini config file, there should be a section named as the one defined by
                    yaf.environ, which is "product" by default.  If you use a ini configuration file
                    as your applicatioin's config container. you would open the yaf.cache_config to
                    improve performance.
                    
                    If you use a ini configuration file as your applicatioin's config container. you
                    would open the yaf.cache_config to improve performance.
                    
                    And the config entry(and there default value) list blow: A ini config file
                    example
  <info>string</info>  <strong>$envrion</strong>  Which section will be loaded as the final config

<comment>See Also:</comment>
   * <class>Yaf_Config_Ini</class>


id: Yaf_Application::__destruct
type: function
doc:
<comment>Description:</comment>
  The __destruct purpose

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


id: Yaf_Application::app
type: function
doc:
<comment>Description:</comment>
  Retrieve an Application instance
  
  Retrieve the <class>Yaf_Application</class> instance. Alternatively, we also could use
  Yaf_Dispatcher::getApplication.

<comment>Return:</comment>
  <info>mixed</info>  A Yaf_Application instance, if no Yaf_Application was initialized before, <info>null</info> will be
         returned.

<comment>See Also:</comment>
   * Yaf_Dispatcher::getApplication


id: Yaf_Application::bootstrap
type: function
doc:
<comment>Description:</comment>
  Call bootstrap
  
  Run a Bootstrap, all the methods defined in the Bootstrap and named with prefix "_init" will be
  called according to their declaration order, if the parameter bootstrap is not supplied, Yaf will
  look for a Bootstrap under application.directory.

<comment>Param:</comment>
  <info>Yaf_Bootstrap_Abstract</info>  <strong>$bootstrap</strong>  A <class>Yaf_Bootstrap_Abstract</class> instance

<comment>Return:</comment>
  <info>void</info>  <class>Yaf_Application</class> instance

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>


id: Yaf_Application::clearLastError
type: function
doc:
<comment>Description:</comment>
  Clear the last error info

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::environ
type: function
doc:
<comment>Description:</comment>
  Retrive environ
  
  Retrive environ which was defined in yaf.environ which has a default value "product".

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


id: Yaf_Application::execute
type: function
doc:
<comment>Description:</comment>
  Execute a callback
  
  This method is typically used to run Yaf_Application in a crontab work. Make the crontab work can
  also use the autoloader and Bootstrap mechanism.

<comment>Param:</comment>
  <info>callable</info>  <strong>$entry</strong>  a valid callback
  <info>string  </info>  <strong>$args </strong>  parameters will pass to the callback

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


id: Yaf_Application::getAppDirectory
type: function
doc:
<comment>Description:</comment>
  Get the application directory

<comment>Param:</comment>
  <info></info>  <strong>$directory</strong>  

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Application::getConfig
type: function
doc:
<comment>Description:</comment>
  Retrive the config instance

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  A <class>Yaf_Config_Abstract</class> instance


id: Yaf_Application::getDispatcher
type: function
doc:
<comment>Description:</comment>
  Get Yaf_Dispatcher instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Application::getLastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Get message of the last occurred error

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


id: Yaf_Application::getLastErrorNo
type: function
doc:
<comment>Description:</comment>
  Get code of last occurred error

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


id: Yaf_Application::getModules
type: function
doc:
<comment>Description:</comment>
  Get defined module names
  
  Get the modules list defined in config, if no one defined, there will always be a module named
  "Index".

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


id: Yaf_Application::run
type: function
doc:
<comment>Description:</comment>
  Start Yaf_Application
  
  Run a Yaf_Application, let the Yaf_Application accept a request and route this request, dispatch
  to controller/action and render response. Finally, return the response to the client.

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


id: Yaf_Application::setAppDirectory
type: function
doc:
<comment>Description:</comment>
  Change the application directory

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

<comment>Return:</comment>
  <info>Yaf_Application</info>  


id: Yaf_Bootstrap_Abstract
type: class
doc:
<comment>Description:</comment>
  Bootstrap is a mechanism used to do some initial config before a Application run.
  
  User may define their own Bootstrap class by inheriting <class>Yaf_Bootstrap_Abstract</class>
  
  Any method declared in Bootstrap class with leading "_init", will be called by
  Yaf_Application::bootstrap one by one  according to their defined order.


id: Yaf_Config_Abstract::get
type: function
doc:
<comment>Description:</comment>
  Getter
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Abstract::readonly
type: function
doc:
<comment>Description:</comment>
  Find a config whether readonly
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Abstract::set
type: function
doc:
<comment>Description:</comment>
  Setter
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>Yaf_Config_Abstract</info>  


id: Yaf_Config_Abstract::toArray
type: function
doc:
<comment>Description:</comment>
  Cast to array
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini
type: class
doc:
<comment>Description:</comment>
  Yaf_Config_Ini enables developers to store configuration data in a familiar INI format and read
  them in the application by using nested object property syntax. The INI format is specialized to
  provide both the ability to have a hierarchy of configuration data keys and inheritance between
  configuration data sections. Configuration data hierarchies are supported by separating the keys
  with the dot or period character ("."). A section may extend or inherit from another section by
  following the section name with a colon character (":") and the name of the section from which
  data are to be inherited.      Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please
  review this documentation to be aware of its specific behaviors, which propagate to
  Yaf_Config_Ini, such as how the special values of "<info>true</info>", "<info>false</info>", "yes", "no", and "<info>null</info>" are
  handled.
  
  Yaf_Config_Ini utilizes the » parse_ini_file() PHP function. Please review this documentation to
  be aware of its specific behaviors, which propagate to Yaf_Config_Ini, such as how the special
  values of "<info>true</info>", "<info>false</info>", "yes", "no", and "<info>null</info>" are handled.


id: Yaf_Config_Ini::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Config_Ini constructor
  
  <class>Yaf_Config_Ini</class> constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$config_file</strong>  path to an INI configure file
  <info>string</info>  <strong>$section    </strong>  which section in that INI file you want to be parsed


id: Yaf_Config_Ini::__get
type: function
doc:
<comment>Description:</comment>
  Retrieve a element
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Ini::__isset
type: function
doc:
<comment>Description:</comment>
  Determine if a key is exists
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Ini::__set
type: function
doc:
<comment>Description:</comment>
  The __set purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  
  <info>mixed </info>  <strong>$value</strong>  

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


id: Yaf_Config_Ini::count
type: function
doc:
<comment>Description:</comment>
  Count all elements in Yaf_Config.ini
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::current
type: function
doc:
<comment>Description:</comment>
  Retrieve the current value
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::key
type: function
doc:
<comment>Description:</comment>
  Fetch current element's key
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::next
type: function
doc:
<comment>Description:</comment>
  Advance the internal pointer
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::offsetExists
type: function
doc:
<comment>Description:</comment>
  The offsetExists purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Ini::offsetGet
type: function
doc:
<comment>Description:</comment>
  The offsetGet purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Ini::offsetSet
type: function
doc:
<comment>Description:</comment>
  The offsetSet purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  
  <info>string</info>  <strong>$value</strong>  

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


id: Yaf_Config_Ini::offsetUnset
type: function
doc:
<comment>Description:</comment>
  The offsetUnset purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Ini::readonly
type: function
doc:
<comment>Description:</comment>
  The readonly purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::rewind
type: function
doc:
<comment>Description:</comment>
  The rewind purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Ini::toArray
type: function
doc:
<comment>Description:</comment>
  Return config as a PHP array
  
  Returns a PHP array from the <class>Yaf_Config_Ini</class>

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


id: Yaf_Config_Ini::valid
type: function
doc:
<comment>Description:</comment>
  The valid purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>array</info>  <strong>$configs </strong>  
  <info>bool </info>  <strong>$readonly</strong>  


id: Yaf_Config_Simple::__get
type: function
doc:
<comment>Description:</comment>
  The __get purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Simple::__isset
type: function
doc:
<comment>Description:</comment>
  The __isset purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Config_Simple::__set
type: function
doc:
<comment>Description:</comment>
  The __set purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  
  <info>string</info>  <strong>$value</strong>  

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


id: Yaf_Config_Simple::count
type: function
doc:
<comment>Description:</comment>
  The count purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Simple::current
type: function
doc:
<comment>Description:</comment>
  The current purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Simple::key
type: function
doc:
<comment>Description:</comment>
  The key purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Simple::next
type: function
doc:
<comment>Description:</comment>
  The next purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Config_Simple::toArray
type: function
doc:
<comment>Description:</comment>
  Returns a PHP array
  
  Returns a PHP array from the <class>Yaf_Config_Simple</class>

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


id: Yaf_Controller_Abstract
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Controller_Abstract</class> is the heart of Yaf's  system. MVC stands for Model-View-Controller and is
  a design pattern  targeted at separating application logic from display logic.
  
  Every custom controller shall inherit <class>Yaf_Controller_Abstract</class>.
  
  You will find that you can not define __construct function for your custom controller, thus,
  <class>Yaf_Controller_Abstract</class> provides a magic method: Yaf_Controller_Abstract::init.
  
  If you have defined a init() method in your custom controller, it will be called as long as the
  controller was instantiated.
  
  Action may have arguments, when a request coming, if there are the same name variable in the
  request parameters(see Yaf_Request_Abstract::getParam) after routed,  Yaf will pass them to the
  action method (see Yaf_Action_Abstract::execute).  These arguments are directly fetched without
  filtering, it should be  carefully processed before use them.
  
  These arguments are directly fetched without filtering, it should be  carefully processed before
  use them.


id: Yaf_Controller_Abstract::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Controller_Abstract constructor
  
  Yaf_Controller_Abstract::__construct is final, which means it can not be overridden. You may want
  to see Yaf_Controller_Abstract::init instead.

<comment>See Also:</comment>
   * Yaf_Controller_Abstract::init


id: Yaf_Controller_Abstract::display
type: function
doc:
<comment>Description:</comment>
  The display purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl       </strong>  
  <info>array </info>  <strong>$parameters</strong>  

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


id: Yaf_Controller_Abstract::forward
type: function
doc:
<comment>Description:</comment>
  Foward to another action
  
  forward current execution process to other action.  this method doesn't switch to the destination
  action immediately, it will take place after current flow finish.
  
  this method doesn't switch to the destination action immediately, it will take place after current
  flow finish.

<comment>Param:</comment>
  <info>string</info>  <strong>$module    </strong>  destination module name, if NULL was given, then default module name is
                       assumed
  <info>string</info>  <strong>$controller</strong>  destination controller name
  <info>string</info>  <strong>$action    </strong>  destination action name
  <info>array </info>  <strong>$paramters </strong>  calling arguments

<comment>Return:</comment>
  <info>void</info>  return FALSE on failure

<comment>See Also:</comment>
   * Yaf_Request_Abstrace::getParam


id: Yaf_Controller_Abstract::getInvokeArg
type: function
doc:
<comment>Description:</comment>
  The getInvokeArg purpose

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

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


id: Yaf_Controller_Abstract::getInvokeArgs
type: function
doc:
<comment>Description:</comment>
  The getInvokeArgs purpose

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


id: Yaf_Controller_Abstract::getModuleName
type: function
doc:
<comment>Description:</comment>
  Get module name
  
  get the controller's module name

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


id: Yaf_Controller_Abstract::getName
type: function
doc:
<comment>Description:</comment>
  Get self name
  
  get the controller's name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, controller name


id: Yaf_Controller_Abstract::getRequest
type: function
doc:
<comment>Description:</comment>
  Retrieve current request object
  
  retrieve current request object

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  <class>Yaf_Request_Abstract</class> instance


id: Yaf_Controller_Abstract::getResponse
type: function
doc:
<comment>Description:</comment>
  Retrieve current response object
  
  retrieve current response object

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  <class>Yaf_Response_Abstract</class> instance


id: Yaf_Controller_Abstract::getView
type: function
doc:
<comment>Description:</comment>
  Retrieve the view engine
  
  retrieve view engine

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Controller_Abstract::getViewpath
type: function
doc:
<comment>Description:</comment>
  The getViewpath purpose

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


id: Yaf_Controller_Abstract::init
type: function
doc:
<comment>Description:</comment>
  Controller initializer
  
  Yaf_Controller_Abstract::__construct is final, which means users can not override it. but users
  can define Yaf_Controller_Abstract::init, which will be called after controller object is
  instantiated.

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

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


id: Yaf_Controller_Abstract::initView
type: function
doc:
<comment>Description:</comment>
  The initView purpose

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

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


id: Yaf_Controller_Abstract::redirect
type: function
doc:
<comment>Description:</comment>
  Redirect to a URL
  
  redirect to a URL by sending a 302 header

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  a location URL

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


id: Yaf_Controller_Abstract::render
type: function
doc:
<comment>Description:</comment>
  Render view template

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl       </strong>  
  <info>array </info>  <strong>$parameters</strong>  

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


id: Yaf_Controller_Abstract::setViewpath
type: function
doc:
<comment>Description:</comment>
  The setViewpath purpose

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

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


id: Yaf_Dispatcher
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Dispatcher</class> purpose is to initialize  the request environment, route the incoming request, and
  then dispatch any discovered actions; it aggregates any responses and returns them  when the
  process is complete.
  
  <class>Yaf_Dispatcher</class> also implements the Singleton pattern,  meaning only a single instance of it may be
  available at any given time. This allows it to also act as a registry on which the other objects
  in the dispatch process may draw.


id: Yaf_Dispatcher::autoRender
type: function
doc:
<comment>Description:</comment>
  Switch on/off autorendering
  
  <class>Yaf_Dispatcher</class> will render automatically after  dispatches a incoming request, you can prevent the
  rendering by calling this method with <strong>$flag</strong> <info>true</info>  you can simply return <info>false</info> in a action to
  prevent the auto-rendering of that action
  
  you can simply return <info>false</info> in a action to prevent the auto-rendering of that action

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  since 2.2.0, if this parameter is not given, then the current state will be
               renturned
               
               since 2.2.0, if this parameter is not given, then the current state will be renturned

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::catchException
type: function
doc:
<comment>Description:</comment>
  Switch on/off exception catching
  
  While the application.dispatcher.throwException is On(you can also calling to
  Yaf_Dispatcher::throwException(TRUE) to enable it),  Yaf will throw Exception when error occurrs
  instead of trigger error.
  
  then if you enable Yaf_Dispatcher::catchException(also can enabled by set
  application.dispatcher.catchException),  all uncaught Exceptions will be caught by
  ErrorController::error if you have defined one.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Dispatcher::setErrorHandler


id: Yaf_Dispatcher::disableView
type: function
doc:
<comment>Description:</comment>
  Disable view rendering
  
  disable view engine, used in some app that user will output by theirself  you can simply return
  <info>false</info> in a action to prevent the auto-rendering of that action
  
  you can simply return <info>false</info> in a action to prevent the auto-rendering of that action

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


id: Yaf_Dispatcher::dispatch
type: function
doc:
<comment>Description:</comment>
  Dispatch a request
  
  This method does the heavy work of the <class>Yaf_Dispatcher</class>. It take a request object.
  
  The dispatch process has three distinct events: RoutingDispatchingResponse Routing takes place
  exactly once, using the values in the request object when dispatch() is called. Dispatching takes
  place in a loop; a request may either indicate multiple actions to dispatch, or the controller or
  a plugin may reset the request object to force additional actions to dispatch(see
  <class>Yaf_Plugin_Abstract</class>. When all is done, the  <class>Yaf_Dispatcher</class> returns a response.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>Yaf_Response_Abstract</info>  


id: Yaf_Dispatcher::enableView
type: function
doc:
<comment>Description:</comment>
  Enable view rendering

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::flushInstantly
type: function
doc:
<comment>Description:</comment>
  Switch on/off the instant flushing

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool  since 2.2.0, if this parameter is not given, then the current state will be
               renturned
               
               since 2.2.0, if this parameter is not given, then the current state will be renturned

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getApplication
type: function
doc:
<comment>Description:</comment>
  Retrive the application
  
  Retrive the <class>Yaf_Application</class> instance. same as Yaf_Application::app.

<comment>Return:</comment>
  <info>Yaf_Application</info>  

<comment>See Also:</comment>
   * Yaf_Application::app


id: Yaf_Dispatcher::getDefaultAction
type: function
doc:
<comment>Description:</comment>
  Retrive the default action name
  
  get the default action name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default action name, default is "index"


id: Yaf_Dispatcher::getDefaultController
type: function
doc:
<comment>Description:</comment>
  Retrive the default controller name
  
  get the default controller name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, default controller name, default is "Index"


id: Yaf_Dispatcher::getDefaultModule
type: function
doc:
<comment>Description:</comment>
  Retrive the default module name
  
  get the default module name

<comment>Return:</comment>
  <info>string</info>  <info>string</info>, module name, default is "Index"


id: Yaf_Dispatcher::getInstance
type: function
doc:
<comment>Description:</comment>
  Retrive the dispatcher instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::getRequest
type: function
doc:
<comment>Description:</comment>
  Retrive the request instance

<comment>Return:</comment>
  <info>Yaf_Request_Abstract</info>  


id: Yaf_Dispatcher::getRouter
type: function
doc:
<comment>Description:</comment>
  Retrive router instance

<comment>Return:</comment>
  <info>Yaf_Router</info>  


id: Yaf_Dispatcher::initView
type: function
doc:
<comment>Description:</comment>
  Initialize view and return it

<comment>Param:</comment>
  <info>string</info>  <strong>$templates_dir</strong>  
  <info>array </info>  <strong>$options      </strong>  

<comment>Return:</comment>
  <info>Yaf_View_Interface</info>  


id: Yaf_Dispatcher::registerPlugin
type: function
doc:
<comment>Description:</comment>
  Register a plugin
  
  Register a plugin(see <class>Yaf_Plugin_Abstract</class>). Generally, we register plugins in Bootstrap(see
  <class>Yaf_Bootstrap_Abstract</class>).

<comment>Param:</comment>
  <info>Yaf_Plugin_Abstract</info>  <strong>$plugin</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_Plugin_Abstract</class>
   * <class>Yaf_Bootstrap_Abstract</class>


id: Yaf_Dispatcher::returnResponse
type: function
doc:
<comment>Description:</comment>
  The returnResponse purpose

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultAction
type: function
doc:
<comment>Description:</comment>
  Change default action name

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultController
type: function
doc:
<comment>Description:</comment>
  Change default controller name

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setDefaultModule
type: function
doc:
<comment>Description:</comment>
  Change default module name

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

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setErrorHandler
type: function
doc:
<comment>Description:</comment>
  Set error handler
  
  Set error handler for Yaf. when application.dispatcher.throwException is off, Yaf will trigger
  catchable error while unexpected errors occrred.
  
  Thus, this error handler will be called while the error raise.

<comment>Param:</comment>
  <info>call</info>  <strong>$callback   </strong>  A callable callback
  <info>int </info>  <strong>$error_types</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::throwException
   * Yaf_Application::getLastErrorNo
   * Yaf_Application::getLastErrorMsg


id: Yaf_Dispatcher::setRequest
type: function
doc:
<comment>Description:</comment>
  The setRequest purpose

<comment>Param:</comment>
  <info></info>  <strong>$plugin</strong>  

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  


id: Yaf_Dispatcher::setView
type: function
doc:
<comment>Description:</comment>
  Set a custom view engine
  
  This method provides a solution if you want use a custom view engine instead of <class>Yaf_View_Simple</class>

<comment>Param:</comment>
  <info>Yaf_View_Interface</info>  <strong>$view</strong>  A Yaf_View_Interface instance

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * <class>Yaf_View_Interface</class>
   * <class>Yaf_View_Simple</class>


id: Yaf_Dispatcher::throwException
type: function
doc:
<comment>Description:</comment>
  Switch on/off exception throwing
  
  Siwtch on/off exception throwing while unexpected error occurring. When this is on, Yaf will
  throwing exceptions instead of triggering catchable errors.
  
  You can also use  application.dispatcher.throwException to achieve the  same purpose.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  bool

<comment>Return:</comment>
  <info>Yaf_Dispatcher</info>  

<comment>See Also:</comment>
   * Yaf_Dispatcher::catchException
   * <class>Yaf_Exception</class>


id: Yaf_Exception::getPrevious
type: function
doc:
<comment>Description:</comment>
  The getPrevious purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Loader</class> introduces a comprehensive autoloading solution for Yaf.
  
  The first time an instance of <class>Yaf_Application</class> is retrieved,  <class>Yaf_Loader</class> will instance a singleton,
  and registers itself with spl_autoload.  You retrieve an instance using the
  Yaf_Loader::getInstance
  
  <class>Yaf_Loader</class> attempt to load a class only one shot, if failed, depend on yaf.use_spl_auload, if this
  config is On Yaf_Loader::autoload will return  <info>false</info>, thus give the chance to other autoload
  function. if it is Off  (by default), Yaf_Loader::autoload will return  <info>true</info>, and more important
  is that a very useful warning will be triggered  (very useful to find out why a class could not be
  loaded).   Please keep yaf.use_spl_autoload Off unless there is some library have their own
  autoload mechanism and impossible to rewrite it.
  
  Please keep yaf.use_spl_autoload Off unless there is some library have their own autoload
  mechanism and impossible to rewrite it.
  
  By default, <class>Yaf_Loader</class> assume all library (class defined script) store in the global library
  directory, which is defined in the php.ini(yaf.library).
  
  If you want <class>Yaf_Loader</class> search some classes(libraries) in the local class directory(which is
  defined in application.ini, and by default, it is application.directory . "/library"),  you should
  register the class prefix using the Yaf_Loader::registerLocalNameSpace
  
  Let's see some examples(assuming APPLICATION_PATH is application.directory): Config example
   Assuming the following local name space is registered: Register
  localnamespaceregisterLocalNameSpace(array("Foo", "Bar")); }
  ?>
  ]]>
   Then the autoload examples: Load class example // APPLICATION_PATH/library/Foo/Bar/Test.php 
  class GLO_Name  => // /global_dir/Glo/Name.php 
  class BarNon_Test // /global_dir/Barnon/Test.php
  ]]>
   As of PHP 5.3, you can use namespace: Load namespace class example //
  APPLICATION_PATH/library/Foo/Bar/Dummy.php
  
  class \FooBar\Bar\Dummy => // /global_dir/FooBar/Bar/Dummy.php
  ]]>
  
  You may noticed that all the folder with the first letter capitalized, you can make them lowercase
  by set yaf.lowcase_path = On in php.ini
  
  <class>Yaf_Loader</class> is also designed to load the MVC classes, and the rule is: MVC class loading example
  // APPLICATION_PATH/controllers/
  
  Model Classes =>
  // APPLICATION_PATH/models/
  
  Plugin Classes =>
  // APPLICATION_PATH/plugins/
  ]]>
   Yaf identify a class's suffix(this is by default, you can also change to the prefix by change the
  configure yaf.name_suffix) to decide whether it is a MVC class: MVC class distinctions //
  ***Controller
  
  Model Classes => // ***Model
  
  Plugin Classes => // ***Plugin
  ]]>
   some examples: MVC loading example // APPLICATION_PATH/models/Data.php
  
  class DummyPlugin => // APPLICATION_PATH/plugins/Dummy.php
  
  class A_B_TestModel => // APPLICATION_PATH/models/A/B/Test.php
  ]]>
    As of 2.1.18, Yaf supports Controllers autoloading for user script side, (which means the
  autoloading triggered by user php script, eg: access a controller static property in Bootstrap or
  Plugins), but autoloader only try to locate controller class script under the default module
  folder, which is "APPLICATION_PATH/controllers/".  also, the directory will be affected by
  yaf.lowcase_path.
  
  As of 2.1.18, Yaf supports Controllers autoloading for user script side, (which means the
  autoloading triggered by user php script, eg: access a controller static property in Bootstrap or
  Plugins), but autoloader only try to locate controller class script under the default module
  folder, which is "APPLICATION_PATH/controllers/".


id: Yaf_Loader::autoload
type: function
doc:
<comment>Description:</comment>
  The autoload purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader::clearLocalNamespace
type: function
doc:
<comment>Description:</comment>
  The clearLocalNamespace purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader::getInstance
type: function
doc:
<comment>Description:</comment>
  The getInstance purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader::getLibraryPath
type: function
doc:
<comment>Description:</comment>
  Get the library path
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Loader::getLocalNamespace
type: function
doc:
<comment>Description:</comment>
  Retrive all register namespaces info
  
  get registered namespaces info

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


id: Yaf_Loader::getNamespacePath
type: function
doc:
<comment>Description:</comment>
  Retieve path of a registered namespace
  
  retrieve path of a registered namespace

<comment>Param:</comment>
  <info></info>  <strong>$namespace</strong>  a string of namespace.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> path, if the namespace is not registered, then <info>null</info> default library will be
          returned


id: Yaf_Loader::import
type: function
doc:
<comment>Description:</comment>
  The import purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader::isLocalName
type: function
doc:
<comment>Description:</comment>
  The isLocalName purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Loader::registerLocalNamespace
type: function
doc:
<comment>Description:</comment>
  Register local class prefix
  
  Register local class prefix name, <class>Yaf_Loader</class> search classes in two library directories, the one is
  configured via application.library.directory(in application.ini) which is called local libraray
  directory; the other is configured via yaf.library (in php.ini) which is callled global library
  directory, since it can be shared by many applications in the same server.
  
  When an autloading is trigger, <class>Yaf_Loader</class> will determine which library directory should be
  searched in by exame the prefix name of the missed classname.
   If the prefix name is registered as a localnamespack then look for it in local library directory,
  otherwise look for it in global library directory.  If yaf.library is not configured, then the
  global library directory is assumed to be the local library directory. in that case, all
  autoloading will look for local library directory.
   But if you want your Yaf application be strong, then always register your own classes as local
  classes.
  
  If yaf.library is not configured, then the global library directory is assumed to be the local
  library directory. in that case, all autoloading will look for local library directory.
   But if you want your Yaf application be strong, then always register your own classes as local
  classes.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$prefix</strong>  a string or a array of class name prefix. all class prefix with these prefix will
                  be loaded in local library path.

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


id: Yaf_Loader::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Register namespace with searching path
  
  Register a namespace with searching path, <class>Yaf_Loader</class> searchs classes under this namespace in path,
  the one is also could be  configureded via  application.library.directory.namespace(in
  application.ini);
  
   Yaf still think underline as folder separator. 
  
  Yaf still think underline as folder separator.

<comment>Param:</comment>
  <info>      </info>  <strong>$namespace</strong>  a string of namespace, or a array of namespaces with paths.
  <info>string</info>  <strong>$path     </strong>  a string of path, it it better to use abosolute path here for performance

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


id: Yaf_Loader::setLibraryPath
type: function
doc:
<comment>Description:</comment>
  Change the library path
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Return:</comment>
  <info>Yaf_Loader</info>  


id: Yaf_Plugin_Abstract
type: class
doc:
<comment>Description:</comment>
  Plugins allow for easy extensibility and customization of the framework.
  
  Plugins are classes. The actual class definition will vary based on the component -- you may need
  to implement this interface, but the fact  remains that the plugin is itself a class.
  
  A plugin could be loaded into Yaf by using Yaf_Dispatcher::registerPlugin,  after registering, All
  the methods which the plugin implemented according to this interface, will be called at the proper
  time.


id: Yaf_Plugin_Abstract::dispatchLoopShutdown
type: function
doc:
<comment>Description:</comment>
  The dispatchLoopShutdown purpose
  
  This is the latest hook in Yaf plugin hook system, if a custom plugin implement this method, then
  it will be called after the dispatch loop finished.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch


id: Yaf_Plugin_Abstract::dispatchLoopStartup
type: function
doc:
<comment>Description:</comment>
  Hook before dispatch loop

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


id: Yaf_Plugin_Abstract::postDispatch
type: function
doc:
<comment>Description:</comment>
  The postDispatch purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


id: Yaf_Plugin_Abstract::preDispatch
type: function
doc:
<comment>Description:</comment>
  The preDispatch purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


id: Yaf_Plugin_Abstract::preResponse
type: function
doc:
<comment>Description:</comment>
  The preResponse purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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


id: Yaf_Plugin_Abstract::routerShutdown
type: function
doc:
<comment>Description:</comment>
  The routerShutdown purpose
  
  This hook will be trigged after the route process finished, this hook is usually used for login
  check.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerStartup
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Plugin_Abstract::routerStartup
type: function
doc:
<comment>Description:</comment>
  RouterStartup hook
  
  This is the earliest hook in Yaf plugin hook system, if a custom plugin implement this method,
  then it will be called before routing a request.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract </info>  <strong>$request </strong>  
  <info>Yaf_Response_Abstract</info>  <strong>$response</strong>  

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

<comment>See Also:</comment>
   * Yaf_Plugin_Abstract::routerShutdown
   * Yaf_Plugin_Abstract::dispatchLoopStartup
   * Yaf_Plugin_Abstract::preDispatch
   * Yaf_Plugin_Abstract::postDispatch
   * Yaf_Plugin_Abstract::dispatchLoopShutdown


id: Yaf_Registry
type: class
doc:
<comment>Description:</comment>
  All methods of <class>Yaf_Registry</class> declared as static, making it unversally accessible. This provides the
  ability to get or set any custom data from anyway in your code as necessary.


id: Yaf_Registry::del
type: function
doc:
<comment>Description:</comment>
  Remove an item from registry
  
  Remove an item from registry

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

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


id: Yaf_Registry::get
type: function
doc:
<comment>Description:</comment>
  Retrieve an item from registry
  
  Retrieve an item from registry

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

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


id: Yaf_Registry::has
type: function
doc:
<comment>Description:</comment>
  Check whether an item exists
  
  Check whether an item exists

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

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


id: Yaf_Registry::set
type: function
doc:
<comment>Description:</comment>
  Add an item into registry
  
  Add an item into registry

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  
  <info>string</info>  <strong>$value</strong>  

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


id: Yaf_Request_Abstract::clearParams
type: function
doc:
<comment>Description:</comment>
  Remove all params
  
  Remove all params set by router, or Yaf_Request_Abstract::setParam

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::getActionName
type: function
doc:
<comment>Description:</comment>
  The getActionName purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getBaseUri
type: function
doc:
<comment>Description:</comment>
  The getBaseUri purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getControllerName
type: function
doc:
<comment>Description:</comment>
  The getControllerName purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getEnv
type: function
doc:
<comment>Description:</comment>
  Retrieve ENV varialbe
  
  Retrieve ENV variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the varialbe can not be
                    found

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Abstract::getException
type: function
doc:
<comment>Description:</comment>
  The getException purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getLanguage
type: function
doc:
<comment>Description:</comment>
  Retrieve client's prefered language

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


id: Yaf_Request_Abstract::getMethod
type: function
doc:
<comment>Description:</comment>
  Retrieve the request method

<comment>Return:</comment>
  <info>string</info>  Return a string, like "POST", "GET" etc.

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::getModuleName
type: function
doc:
<comment>Description:</comment>
  The getModuleName purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getParam
type: function
doc:
<comment>Description:</comment>
  Retrieve calling parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  
  <info>string</info>  <strong>$default</strong>  

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::setParam


id: Yaf_Request_Abstract::getParams
type: function
doc:
<comment>Description:</comment>
  Retrieve all calling parameters

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::setParam


id: Yaf_Request_Abstract::getRequestUri
type: function
doc:
<comment>Description:</comment>
  The getRequestUri purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::getServer
type: function
doc:
<comment>Description:</comment>
  Retrieve SERVER variable
  
  Retrieve SERVER variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  the variable name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the variable can not be
                    found

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getEnv


id: Yaf_Request_Abstract::isCli
type: function
doc:
<comment>Description:</comment>
  Determine if request is CLI request

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isDispatched
type: function
doc:
<comment>Description:</comment>
  Determin if the request is dispatched

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

<comment>See Also:</comment>
   * Yaf_Dispatcher::dispatch


id: Yaf_Request_Abstract::isGet
type: function
doc:
<comment>Description:</comment>
  Determine if request is GET request

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isHead
type: function
doc:
<comment>Description:</comment>
  Determine if request is HEAD request

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isOptions
type: function
doc:
<comment>Description:</comment>
  Determine if request is OPTIONS request

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


id: Yaf_Request_Abstract::isPost
type: function
doc:
<comment>Description:</comment>
  Determine if request is POST request

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isPut
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


id: Yaf_Request_Abstract::isPut
type: function
doc:
<comment>Description:</comment>
  Determine if request is PUT request

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isHead
   * Yaf_Request_Abstract::isCli
   * Yaf_Request_Abstract::isPost
   * Yaf_Request_Abstract::isGet
   * Yaf_Request_Abstract::isOptions
   * Yaf_Request_Abstract::isXmlHTTPRequest


