# php_manual

id: Yaf_Request_Abstract::isRouted
type: function
doc:
<comment>Description:</comment>
  Determin if request has been routed

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


id: Yaf_Request_Abstract::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determine if request is AJAX 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::isGet


id: Yaf_Request_Abstract::setActionName
type: function
doc:
<comment>Description:</comment>
  Set action name
  
  set action name to request, this is usually used by custom router to set route result controller
  name.

<comment>Param:</comment>
  <info>string</info>  <strong>$action     </strong>  <info>string</info>, action name, it should in lower case style, like "index" or
                        "foo_bar"
  <info>bool  </info>  <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        lower case style, if this is set to <info>false</info> , Yaf will set the original name
                        to request.

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


id: Yaf_Request_Abstract::setBaseUri
type: function
doc:
<comment>Description:</comment>
  Set base URI
  
  Set base URI, base URI is used when doing routing, in routing phase request URI is used to route a
  request,  while base URI is used to skip the leadding part(base URI) of request URI.
   That is, if comes a request with request URI a/b/c, then if you set base URI to "a/b", only "/c"
  will be used in routing phase.  generally, you don't need to set this, Yaf will determine it
  automatically.
  
  generally, you don't need to set this, Yaf will determine it automatically.

<comment>Param:</comment>
  <info>string</info>  <strong>$uir</strong>  base URI

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


id: Yaf_Request_Abstract::setControllerName
type: function
doc:
<comment>Description:</comment>
  Set controller name
  
  set controller name to request, this is usually used by custom router to set route result
  controller name.

<comment>Param:</comment>
  <info>string</info>  <strong>$controller </strong>  <info>string</info>, controller name, this should be in camel style, like "Index" or
                        "Foo_Bar"
  <info>bool  </info>  <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        camel mode, if this is set to <info>false</info> , Yaf will set the original name to
                        request.

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


id: Yaf_Request_Abstract::setDispatched
type: function
doc:
<comment>Description:</comment>
  The setDispatched purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Abstract::setModuleName
type: function
doc:
<comment>Description:</comment>
  Set module name
  
  set module name to request, this is usually used by custom router to set route result module name.

<comment>Param:</comment>
  <info>string</info>  <strong>$module     </strong>  <info>string</info> module name, it should be in camel style, like "Index" or "Foo_Bar"
  <info>bool  </info>  <strong>$format_name</strong>  this is introduced in Yaf 3.2.0, by default Yaf will format the name into
                        camel mode, if this is set to <info>false</info> , Yaf will set the original name to
                        request.

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


id: Yaf_Request_Abstract::setParam
type: function
doc:
<comment>Description:</comment>
  Set a calling parameter to a request
  
  Set a parameter to request, which can be retrieved by Yaf_Request_Abstract::getParam

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

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

<comment>See Also:</comment>
   * Yaf_Request_Abstract::getParam
   * Yaf_Request_Abstract::getParams


id: Yaf_Request_Abstract::setRequestUri
type: function
doc:
<comment>Description:</comment>
  The setRequestUri purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Request_Abstract::setRouted
type: function
doc:
<comment>Description:</comment>
  The setRouted purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Request_Http
type: class
doc:
<comment>Description:</comment>
  Any request from client is initialized as a <class>Yaf_Request_Http</class>. you can get the request information
  like, uri query and  post parameters via methods of this class.  For security, $_GET/$_POST are
  readonly in Yaf, which means if you set a value to these global variables, you can not get it from
  Yaf_Request_Http::getQuery or Yaf_Request_Http::getPost.   But there do is some usage need such
  feature, like unit testing. thus Yaf can be built with --enable-yaf-debug, which will allow Yaf
  read the value user set via script.  in such case, Yaf will throw a E_STRICT warning to remind you
  about that:  Strict Standards: you are running yaf in debug mode
  
  For security, $_GET/$_POST are readonly in Yaf, which means if you set a value to these global
  variables, you can not get it from Yaf_Request_Http::getQuery or Yaf_Request_Http::getPost.
  
  But there do is some usage need such feature, like unit testing. thus Yaf can be built with
  --enable-yaf-debug, which will allow Yaf read the value user set via script.
  
  in such case, Yaf will throw a E_STRICT warning to remind you about that:  Strict Standards: you
  are running yaf in debug mode


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


id: Yaf_Request_Http::get
type: function
doc:
<comment>Description:</comment>
  Retrieve variable from client
  
  Retrieve variable from client, this method will search the <strong>$name</strong> in request pramas, if the name is
  not found, then will search in POST, GET, Cookie, Server

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

<comment>See Also:</comment>
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getCookie
type: function
doc:
<comment>Description:</comment>
  Retrieve Cookie variable
  
  Retrieve Cookie variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  the cookie name
  <info>string</info>  <strong>$default</strong>  if this parameter is provide, this will be returned if the cookie can not be
                    found

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

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getFiles
type: function
doc:
<comment>Description:</comment>
  The getFiles purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Http::getPost
type: function
doc:
<comment>Description:</comment>
  Retrieve POST variable
  
  Retrieve POST 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>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getQuery
type: function
doc:
<comment>Description:</comment>
  Fetch a query parameter
  
  Retrieve GET 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>mixed</info>  

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getRaw
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getRaw
type: function
doc:
<comment>Description:</comment>
  Retrieve Raw request body
  
  Retrieve Raw request body

<comment>Return:</comment>
  <info>mixed</info>  Return string on success, FALSE on failure.

<comment>See Also:</comment>
   * Yaf_Request_Http::get
   * Yaf_Request_Http::getPost
   * Yaf_Request_Http::getCookie
   * Yaf_Request_Http::getQuery
   * Yaf_Request_Abstract::getServer
   * Yaf_Request_Abstract::getParam


id: Yaf_Request_Http::getRequest
type: function
doc:
<comment>Description:</comment>
  The getRequest purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Http::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determin if request is Ajax Request
  
  Check the request whether it is a Ajax Request.  This method depends on the request header:
  HTTP_X_REQUESTED_WITH, some Javascript library doesn't set this header while doing Ajax request
  
  This method depends on the request header: HTTP_X_REQUESTED_WITH, some Javascript library doesn't
  set this header while doing Ajax request

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


id: Yaf_Request_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Request_Simple</class> is particularlly used for test puporse. ie. simulate some espacial request
  under CLI mode.


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


id: Yaf_Request_Simple::get
type: function
doc:
<comment>Description:</comment>
  The get purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Simple::getCookie
type: function
doc:
<comment>Description:</comment>
  The getCookie purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Simple::getPost
type: function
doc:
<comment>Description:</comment>
  The getPost purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Simple::getQuery
type: function
doc:
<comment>Description:</comment>
  The getQuery purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Request_Simple::isXmlHttpRequest
type: function
doc:
<comment>Description:</comment>
  Determin if request is AJAX request

<comment>Return:</comment>
  <info>void</info>  Always returns false for <class>Yaf_Request_Simple</class>

<comment>See Also:</comment>
   * Yaf_Request_Abstract::isXmlHTTPRequest
   * Yaf_Request_Http::isXmlHTTPRequest


id: Yaf_Response_Abstract::__destruct
type: function
doc:
<comment>Description:</comment>
  The __destruct purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Response_Abstract::__toString
type: function
doc:
<comment>Description:</comment>
  Retrieve all bodys as string

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


id: Yaf_Response_Abstract::appendBody
type: function
doc:
<comment>Description:</comment>
  Append to response body
  
  Append a content to a exists content block

<comment>Param:</comment>
  <info>      </info>  <strong>$body</strong>  content string
  <info>string</info>  <strong>$key </strong>  the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::clearBody
type: function
doc:
<comment>Description:</comment>
  Discard all exists response body
  
  Clear existsed content

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  the content key, if you don't specific, then all contents will be cleared.  this
                parameter is introduced as of 2.2.0
                
                this parameter is introduced as of 2.2.0

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::getBody


id: Yaf_Response_Abstract::clearHeaders
type: function
doc:
<comment>Description:</comment>
  Discard all set headers

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::setHeader


id: Yaf_Response_Abstract::getBody
type: function
doc:
<comment>Description:</comment>
  Retrieve a exists content
  
  Retrieve a exists content

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  the content key, if you don't specific, then Yaf_Response_Abstract::DEFAULT_BODY
                will be used. if you pass in a <info>null</info>, then all contents will be returned as a array
                this parameter is introduced as of 2.2.0
                
                this parameter is introduced as of 2.2.0

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::getHeader
type: function
doc:
<comment>Description:</comment>
  The getHeader purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::prependBody
type: function
doc:
<comment>Description:</comment>
  The prependBody purpose
  
  prepend a content to a exists content block

<comment>Param:</comment>
  <info>      </info>  <strong>$body</strong>  content string
  <info>string</info>  <strong>$key </strong>  the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::response
type: function
doc:
<comment>Description:</comment>
  Send response
  
  send response

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::setBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::setAllHeaders
type: function
doc:
<comment>Description:</comment>
  The setAllHeaders purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Response_Abstract::setBody
type: function
doc:
<comment>Description:</comment>
  Set content to response
  
  Set content to response

<comment>Param:</comment>
  <info>      </info>  <strong>$body</strong>  content string
  <info>string</info>  <strong>$key </strong>  the content key, you can set a content with a key, if you don't specific, then
                 Yaf_Response_Abstract::DEFAULT_BODY will be used  this parameter is introduced as
                 of 2.2.0
                 
                 this parameter is introduced as of 2.2.0

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getBody
   * Yaf_Response_Abstract::appendBody
   * Yaf_Response_Abstract::prependBody
   * Yaf_Response_Abstract::clearBody


id: Yaf_Response_Abstract::setHeader
type: function
doc:
<comment>Description:</comment>
  Set reponse header
  
  Used to send a HTTP header

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

<comment>See Also:</comment>
   * Yaf_Response_Abstract::getHeader
   * Yaf_Response_Abstract::cleanHeaders


id: Yaf_Response_Abstract::setRedirect
type: function
doc:
<comment>Description:</comment>
  The setRedirect purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_Route_Interface
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Interface</class> used for developer defined their custom route.


id: Yaf_Route_Interface::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a request
  
  this method returns a url according to the argument info, and append query strings to the url
  according to the argument query.
  
  a route should implement this method according to its own route rules, and do a reverse progress.

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

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


id: Yaf_Route_Interface::route
type: function
doc:
<comment>Description:</comment>
  Route a request
  
  Yaf_Route_Interface::route is the only method that a custom route should implement.  since of
  2.3.0, there is another method should also be implemented, see Yaf_Route_Interface::assemble.
  
  since of 2.3.0, there is another method should also be implemented, see
  Yaf_Route_Interface::assemble.
  
  if this method return <info>true</info>, then the route process will be end. otherwise, <class>Yaf_Router</class> will call
  next route in the route stack to route request.
  
  This method would set the route result to the parameter request, by calling
  Yaf_Request_Abstract::setControllerName, Yaf_Request_Abstract::setActionName and
  Yaf_Request_Abstract::setModuleName.
  
  This method should also call Yaf_Request_Abstract::setRouted to make the request routed at last.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  A <class>Yaf_Request_Abstract</class> instance.

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


id: Yaf_Route_Map
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Map</class> is a built-in route, it simply convert a URI endpoint (that part of the URI which
  comes after the base URI: see Yaf_Request_Abstract::setBaseUri) to a controller name or action
  name(depends on the parameter passed to Yaf_Route_Map::__construct) in following rule: A =&gt;
  controller A. A/B/C =&gt; controller A_B_C. A/B/C/D/E =&gt; controller A_B_C_D_E.
  
  If the second parameter of Yaf_Route_Map::__construct is specified, then only the part before
  delimiter of URI will used to routing, the part after it is used to routing request parameters
  (see the example section of Yaf_Route_Map::__construct).


id: Yaf_Route_Map::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose

<comment>Param:</comment>
  <info>string</info>  <strong>$controller_prefer</strong>  Whether the result should considering as controller or action
  <info>string</info>  <strong>$delimiter        </strong>  

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>


id: Yaf_Route_Map::assemble
type: function
doc:
<comment>Description:</comment>
  Assemble a url
  
  Assemble a url.

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

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


id: Yaf_Route_Map::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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


id: Yaf_Route_Regex
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Regex</class> is the most flexible route among the Yaf built-in routes.


id: Yaf_Route_Regex::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Regex constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$match  </strong>  A complete Regex pattern, will be used to match a request uri, if doesn't
                    matched, <class>Yaf_Route_Regex</class> will return <info>false</info>.
  <info>array </info>  <strong>$route  </strong>  When the match pattern matches the request uri, <class>Yaf_Route_Regex</class> will use this to
                    decide which m/c/a to routed.
                    
                    either of m/c/a in this array is optianl, if you don't assgian a specific value,
                    it will be routed to default.
  <info>array </info>  <strong>$map    </strong>  A array to assign name to the captrues in the match result.
  <info>array </info>  <strong>$verify </strong>  
  <info>string</info>  <strong>$reverse</strong>  a string, used to assemble url, see Yaf_Route_Regex::assemble.  this parameter
                    is introduced in 2.3.0
                    
                    this parameter is introduced in 2.3.0

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Regex::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Route a incoming request.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  If the pattern given by the first parameter of  Yaf_Route_Regex::_construct matche the
        request uri, return <info>true</info>, otherwise return <info>false</info>.


id: Yaf_Route_Rewrite
type: class
doc:
<comment>Description:</comment>
  For usage, please see the example section of Yaf_Route_Rewrite::__construct


id: Yaf_Route_Rewrite::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Rewrite constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$match </strong>  A pattern, will be used to match a request uri, if it doesn't match,
                   <class>Yaf_Route_Rewrite</class> will return <info>false</info>.
                   
                   You can use :name style to name segments matched, and use * to match the rest of
                   the URL segments.
  <info>array </info>  <strong>$route </strong>  When the match pattern matches the request uri, <class>Yaf_Route_Rewrite</class> will use this
                   to decide which module/controller/action is the destination.
                   
                   Either of module/controller/action in this array is optional, if you don't assign
                   a specific value, it will be routed to default.
  <info>array </info>  <strong>$verify</strong>  

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Rewrite::route
type: function
doc:
<comment>Description:</comment>
  The route purpose

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

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


id: Yaf_Route_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Route_Simple</class> will match the query string, and find the route info.
  
  all you need to do is tell <class>Yaf_Route_Simple</class> what key in the $_GET is module, what key is
  controller, and what key is action.
  
  Yaf_Route_Simple::route will always return <info>true</info>, so it is important put <class>Yaf_Route_Simple</class> in the
  front of the Route stack, otherwise all the other routes will not be called.


id: Yaf_Route_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Yaf_Route_Simple constructor
  
  <class>Yaf_Route_Simple</class> will get route info from query string. and the parameters of this constructor
  will used as keys while searching for the route info in $_GET.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$module_name    </strong>  The key name of the module info.
  <info>string</info>  <strong>$controller_name</strong>  the key name of the controller info.
  <info>string</info>  <strong>$action_name    </strong>  the key name of the action info.

<comment>Return:</comment>
  <info>unknown</info>  Always return <info>true</info>.

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Simple::route
type: function
doc:
<comment>Description:</comment>
  Route a request
  
  see Yaf_Route_Simple::__construct
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  always be <info>true</info>

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Static::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Static
type: class
doc:
<comment>Description:</comment>
  Defaultly, <class>Yaf_Router</class> only have a <class>Yaf_Route_Static</class> as its default route.
  
  And <class>Yaf_Route_Static</class> is designed to handle the 80% requirement.
  
  please *NOTE* that it is unnecessary to instance a <class>Yaf_Route_Static</class>, also  unecesary to add it
  into <class>Yaf_Router</class>'s routes stack, since there is always be one in <class>Yaf_Router</class>'s routes stack, and
  always be called at the last time.


id: Yaf_Route_Static::match
type: function
doc:
<comment>Description:</comment>
  The match purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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

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


id: Yaf_Route_Static::route
type: function
doc:
<comment>Description:</comment>
  Route 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>  

<comment>Return:</comment>
  <info>bool</info>  always be <info>true</info>

<comment>See Also:</comment>
   * Yaf_Route_Supervar::route
   * Yaf_Route_Simple::route
   * Yaf_Route_Regex::route
   * Yaf_Route_Rewrite::route
   * Yaf_Route_Map::route


id: Yaf_Route_Supervar::__construct
type: function
doc:
<comment>Description:</comment>
  The __construct purpose
  
  <class>Yaf_Route_Supervar</class> is similar with <class>Yaf_Route_Static</class>, the difference is <class>Yaf_Route_Supervar</class> will
  look for path info in query string, and the parameter supervar_name is the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$supervar_name</strong>  The name of key.

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Route_Supervar::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>Yaf_Request_Abstract</info>  <strong>$request</strong>  

<comment>Return:</comment>
  <info>bool</info>  If there is a key(which was defined in Yaf_Route_Supervar::__construct) in $_GET, return
        <info>true</info>. otherwise return <info>false</info>.


id: Yaf_Router
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_Router</class> is the standard framework router. Routing is the process of taking a URI endpoint (that
  part of the URI which comes after the base URI: see Yaf_Request_Abstract::setBaseUri) and
  decomposing it into parameters to determine which module, controller, and action of that
  controller should receive the request. This values of the module, controller, action and other
  parameters are packaged into a <class>Yaf_Request_Abstract</class> object which is then processed by
  <class>Yaf_Dispatcher</class>. Routing occurs only once: when the request is initially received and before the
  first controller is dispatched.
   <class>Yaf_Router</class> is designed to allow for mod_rewrite-like functionality using pure PHP structures. It
  is very loosely based on Ruby on Rails routing and does not require any prior knowledge of
  webserver URL rewriting. It is designed to work with a single Apache mod_rewrite rule (one of):
  Rewrite rule for Apache or (preferred): Rewrite rule for Apache If using Lighttpd, the following
  rewrite rule is valid: Rewrite rule for Lighttpd "/index.php?$1",
  ".*\.(js|ico|gif|jpg|png|css|html)$" => "$0", "" => "/index.php"
  )
  ]]> If using Nginx, use the following rewrite rule: Rewrite rule for Nginx


id: Yaf_Router::addConfig
type: function
doc:
<comment>Description:</comment>
  Add config-defined routes into Router
  
  Add routes defined by configs into <class>Yaf_Router</class>'s route stack

<comment>Return:</comment>
  <info>bool</info>  An <class>Yaf_Config_Abstract</class> instance, which should contains one or more valid route configs

<comment>See Also:</comment>
   * Yaf_Router::addRoute
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::addRoute
type: function
doc:
<comment>Description:</comment>
  Add new Route into Router
  
  defaultly, Yaf_Router using a <class>Yaf_Route_Static</class> as its defualt route. you can add new routes into
  router's route stack by calling this method.
  
  the newer route will be called before the older(route stack), and if the newer router return <info>true</info>,
  the router process will be end. otherwise, the older one will be called.

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

<comment>See Also:</comment>
   * Yaf_Router::addConfig
   * <class>Yaf_Route_Static</class>
   * <class>Yaf_Route_Supervar</class>
   * <class>Yaf_Route_Simple</class>
   * <class>Yaf_Route_Regex</class>
   * <class>Yaf_Route_Rewrite</class>
   * <class>Yaf_Route_Map</class>


id: Yaf_Router::getCurrentRoute
type: function
doc:
<comment>Description:</comment>
  Get the effective route name
  
  Get the name of the route which is effective in the route process.  You should call this method
  after the route process finished, since before that, this method will always return <info>null</info>.
  
  You should call this method after the route process finished, since before that, this method will
  always return <info>null</info>.

<comment>Return:</comment>
  <info>string</info>  String, the name of the effective route.

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute


id: Yaf_Router::getRoute
type: function
doc:
<comment>Description:</comment>
  Retrieve a route by name
  
  Retrieve a route by name, see also Yaf_Router::getCurrentRoute

<comment>Return:</comment>
  <info>Yaf_Route_Interface</info>  

<comment>See Also:</comment>
   * <class>Yaf_Bootstrap_Abstract</class>
   * <class>Yaf_Plugin_Abstract</class>
   * Yaf_Router::addRoute
   * Yaf_Router::getCurrentRoute


id: Yaf_Router::getRoutes
type: function
doc:
<comment>Description:</comment>
  Retrieve registered routes
  
  Retrieve registered routes

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


id: Yaf_Router::route
type: function
doc:
<comment>Description:</comment>
  The route purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


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


id: Yaf_Session::__unset
type: function
doc:
<comment>Description:</comment>
  The __unset 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_Session::del
type: function
doc:
<comment>Description:</comment>
  The del 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_Session::has
type: function
doc:
<comment>Description:</comment>
  The has 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_Session::start
type: function
doc:
<comment>Description:</comment>
  The start purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_View_Interface
type: class
doc:
<comment>Description:</comment>
  Yaf provides a ability for developers to use custom view engine instead of built-in engine which
  is <class>Yaf_View_Simple</class>. There  is a example to explain how to do this, please see
  Yaf_Dispatcher::setView.


id: Yaf_View_Interface::assign
type: function
doc:
<comment>Description:</comment>
  Assign value to View engine
  
  Assigan values to View engine, then the value can access directly by name in template.
  
  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>bool</info>  


id: Yaf_View_Interface::display
type: function
doc:
<comment>Description:</comment>
  Render and output a template
  
  Render a template and output the result immediatly.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl     </strong>  
  <info>array </info>  <strong>$tpl_vars</strong>  

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


id: Yaf_View_Interface::getScriptPath
type: function
doc:
<comment>Description:</comment>
  The getScriptPath purpose
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

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


id: Yaf_View_Interface::render
type: function
doc:
<comment>Description:</comment>
  Render a template
  
  Render a template and return the result.
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl     </strong>  
  <info>array </info>  <strong>$tpl_vars</strong>  

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


id: Yaf_View_Interface::setScriptPath
type: function
doc:
<comment>Description:</comment>
  The setScriptPath purpose
  
  Set the templates base directory, this is usually called by <class>Yaf_Dispatcher</class>
  
  Questa funzione, al momento
  non è documentata; è disponibile soltanto la lista degli argomenti.

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  A absolute path to the template directory, by default, <class>Yaf_Dispatcher</class> use
                         application.directory . "/views" as this paramter.

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


id: Yaf_View_Simple
type: class
doc:
<comment>Description:</comment>
  <class>Yaf_View_Simple</class> is the built-in template engine in Yaf, it is a simple but fast template engine,
  and only support PHP script template.


id: Yaf_View_Simple::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor of Yaf_View_Simple

<comment>Param:</comment>
  <info>string</info>  <strong>$template_dir</strong>  The base directory of the templates,  by default,  it is APPLICATOIN .
                         "/views" for Yaf.
  <info>array </info>  <strong>$options     </strong>  


id: Yaf_View_Simple::__get
type: function
doc:
<comment>Description:</comment>
  Retrieve assigned variable
  
  Retrieve assigned varaiable  parameter can be empty since 2.1.11 
  
  parameter can be empty since 2.1.11

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  the assigned variable name
                 
                 if this is empty, all assigned variables will be returned

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


id: Yaf_View_Simple::__isset
type: function
doc:
<comment>Description:</comment>
  The __isset purpose

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

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


id: Yaf_View_Simple::__set
type: function
doc:
<comment>Description:</comment>
  Set value to engine
  
  This is a alternative and easier way to  Yaf_View_Simple::assign.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  A string value name.
  <info>mixed </info>  <strong>$value</strong>  Mixed value.

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign


id: Yaf_View_Simple::assign
type: function
doc:
<comment>Description:</comment>
  Assign values
  
  assign variable to view engine

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  A string or an array.
                  
                  if is string, then the next argument $value is required.
  <info>mixed </info>  <strong>$value</strong>  mixed value

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::clear
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::assignRef
type: function
doc:
<comment>Description:</comment>
  The assignRef purpose
  
  unlike Yaf_View_Simple::assign, this method assign a ref value to engine.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  A string name which will be used to access the value in the tempalte.
  <info>mixed </info>  <strong>$value</strong>  mixed value

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::clear
type: function
doc:
<comment>Description:</comment>
  Clear Assigned values
  
  clear assigned variable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  assigned variable name
                 
                 if empty, will clear all assigned variables

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

<comment>See Also:</comment>
   * Yaf_View_Simple::assignRef
   * Yaf_View_Interface::assign
   * Yaf_View_Simple::__set


id: Yaf_View_Simple::display
type: function
doc:
<comment>Description:</comment>
  Render and display
  
  Render a template and display the result instantly.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl     </strong>  
  <info>array </info>  <strong>$tpl_vars</strong>  

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


id: Yaf_View_Simple::eval
type: function
doc:
<comment>Description:</comment>
  Render template
  
  Render a string tempalte and return the result.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl_content</strong>  string template
  <info>array </info>  <strong>$tpl_vars   </strong>  

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


id: Yaf_View_Simple::getScriptPath
type: function
doc:
<comment>Description:</comment>
  Get templates directory

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


id: Yaf_View_Simple::render
type: function
doc:
<comment>Description:</comment>
  Render template
  
  Render a template and return the result.

<comment>Param:</comment>
  <info>string</info>  <strong>$tpl     </strong>  
  <info>array </info>  <strong>$tpl_vars</strong>  

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


id: Yaf_View_Simple::setScriptPath
type: function
doc:
<comment>Description:</comment>
  Set tempaltes directory

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

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


id: Yar_Client::__call
type: function
doc:
<comment>Description:</comment>
  Call service
  
  Issue a call to remote RPC method.

<comment>Param:</comment>
  <info>string</info>  <strong>$method    </strong>  Remote RPC method name.
  <info>array </info>  <strong>$parameters</strong>  Parameters.

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

<comment>See Also:</comment>
   * Yar_Client::setOpt


id: Yar_Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create a client
  
  Create a <class>Yar_Client</class> to a <class>Yar_Server</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  Yar Server URL.

<comment>Return:</comment>
  <info>unknown</info>  <class>Yar_Client</class> instance.

<comment>See Also:</comment>
   * Yar_Client::__call
   * Yar_Client::setOpt


id: Yar_Client::setOpt
type: function
doc:
<comment>Description:</comment>
  Set calling contexts

<comment>Param:</comment>
  <info>int  </info>  <strong>$name </strong>  it can be: YAR_OPT_PACKAGER, YAR_OPT_PERSISTENT (Need server support),
                 YAR_OPT_TIMEOUT, YAR_OPT_CONNECT_TIMEOUT YAR_OPT_HEADER (Since 2.0.4)
  <info>mixed</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>Yar_Clientfalse</info>  Returns $this on success o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * Yar_Client::__call


id: Yar_Client_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type

<comment>Return:</comment>
  <info>string</info>  Returns <return>"Yar_Exception_Client"</return>.

<comment>See Also:</comment>
   * Yaf_Server_Exception::getType


id: Yar_Concurrent_Client::call
type: function
doc:
<comment>Description:</comment>
  Register a concurrent call
  
  Register a RPC call, but won't sent it immediately, it will be send while further call to
  Yar_Concurrent_Client::loop

<comment>Param:</comment>
  <info>string  </info>  <strong>$uri       </strong>  The RPC server URI(http, tcp)
  <info>string  </info>  <strong>$method    </strong>  Service name(aka the method name)
  <info>array   </info>  <strong>$parameters</strong>  Parameters
  <info>callable</info>  <strong>$callback  </strong>  A function callback, which will be called while the response return.

<comment>Return:</comment>
  <info>int</info>  An unique id, can be used to identified which call it is.

<comment>See Also:</comment>
   * Yar_Concurrent_Client::loop
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::loop
type: function
doc:
<comment>Description:</comment>
  Send all calls
  
  Send all registed remote RPC calls.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback      </strong>  If this callback is set, then Yar will call this callback after all
                             calls are sent and before any response return, with a $callinfo NULL.
                             
                             Then, if user didn't specify callback when registering concurrent call,
                             this callback will be used to handle response, otherwise, the callback
                             specified while registering will be used.
  <info>callable</info>  <strong>$error_callback</strong>  If this callback is set, then Yar will call this callback while error
                             occurred.

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

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::reset
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Concurrent_Client::reset
type: function
doc:
<comment>Description:</comment>
  Clean all registered calls
  
  Clean all registered calls

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

<comment>See Also:</comment>
   * Yar_Concurrent_Client::call
   * Yar_Concurrent_Client::loop
   * Yar_Server::__construct
   * Yar_Server::handle


id: Yar_Server::__construct
type: function
doc:
<comment>Description:</comment>
  Register a server
  
  Set up a Yar HTTP RPC Server, All the public methods of $obj will be register as a RPC service.

<comment>Param:</comment>
  <info>Object</info>  <strong>$obj</strong>  An Object, all public methods of its will be registered as RPC services.

<comment>Return:</comment>
  <info>unknown</info>  An instance of <class>Yar_Server</class>.

<comment>See Also:</comment>
   * Yar_Server::handle


id: Yar_Server::handle
type: function
doc:
<comment>Description:</comment>
  Start RPC Server
  
  Start a RPC HTTP server, and ready for accpet RPC requests.  Usual RPC calls will be issued as
  HTTP POST requests. If a HTTP GET request is issued to the uri, the service information (commented
  section above) will be printed on the page
  
  Usual RPC calls will be issued as HTTP POST requests. If a HTTP GET request is issued to the uri,
  the service information (commented section above) will be printed on the page

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

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


id: Yar_Server_Exception
type: class
doc:
<comment>Description:</comment>
  If service threw exceptions, A Yar_Server_Exception will be threw in client side.


id: Yar_Server_Exception::getType
type: function
doc:
<comment>Description:</comment>
  Retrieve exception's type
  
  Get the exception original type threw by server

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

<comment>See Also:</comment>
   * 


id: ZEND_ACC_CLASS
type: constant
doc:
<comment>Description:</comment>
  Dummy registered for consistency, the default kind of class entry. Removed as of uopz 5.0.0.


id: ZEND_ADD_INTERFACE
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the interface is being added to as the first argument,
  and the name of the interface as the second argument


id: ZEND_ADD_TRAIT
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the trait is being added to as the first argument, and
  the name of the trait as the second argument


id: ZEND_EXIT
type: constant
doc:
<comment>Description:</comment>
  Invoked by exit() and die(), receives no arguments. Return boolean <info>true</info> to exit, <info>false</info> to continue


id: ZEND_FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Invoked upon composure, receives the class the name of the class being fetched as the only
  argument


id: ZEND_INSTANCEOF
type: constant
doc:
<comment>Description:</comment>
  Invoked by instanceof operator, receives the object being verified as the first argument, and the
  name of the class which that object should be as the second argument


id: ZEND_NEW
type: constant
doc:
<comment>Description:</comment>
  Invoked by object construction, receives the class of object being created as the only argument


id: ZEND_THROW
type: constant
doc:
<comment>Description:</comment>
  Invoked by the throw construct, receives the class of exception being thrown as the only argument


id: ZMQ::CTXOPT_MAX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  The socket limit for this context. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::ERR_EAGAIN
type: constant
doc:
<comment>Description:</comment>
  Implies that the operation would block when ZMQ::MODE_DONTWAIT is used


id: ZMQ::ERR_EFSM
type: constant
doc:
<comment>Description:</comment>
  The operation can not be executed because the socket is not in correct state


id: ZMQ::MODE_NOBLOCK
type: constant
doc:
<comment>Description:</comment>
  Non-blocking operation. Deprecated, use ZMQ::MODE_DONTWAIT instead


id: ZMQ::SOCKET_STREAM
type: constant
doc:
<comment>Description:</comment>
  Used to send and receive TCP data from a non-ØMQ peer. Available if compiled against ZeroMQ 4.x or
  higher (Value: <info>int</info>).


id: ZMQ::SOCKET_XPUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_PUB, except you can receive subscriptions as messages. The subscription message
  is 0 (unsubscribe) or 1 (subscribe) followed by the topic.


id: ZMQ::SOCKET_XSUB
type: constant
doc:
<comment>Description:</comment>
  Similar to SOCKET_SUB, except you can send subscriptions as messages. See SOCKET_XPUB for format.


id: ZMQ::SOCKOPT_BACKLOG
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_BACKLOG option shall set the maximum length of the queue of outstanding peer
  connections for the specified socket; this only applies to connection-oriented transports. (Value:
  <info>int</info>)


id: ZMQ::SOCKOPT_DELAY_ATTACH_ON_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Set a CIDR string to match against incoming TCP connections. Available if compiled against ZeroMQ
  3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_HWM
type: constant
doc:
<comment>Description:</comment>
  The high water mark for inbound and outbound messages is a hard limit on the maximum number of
  outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is
  communicating with. Setting this option on a socket will only affect connections made after the
  option has been set. On ZeroMQ 3.x this is a wrapper for setting both SNDHWM and RCVHWM. (Value:
  <info>int</info>).


id: ZMQ::SOCKOPT_IPV4ONLY
type: constant
doc:
<comment>Description:</comment>
  Disable IPV6 support if 1. Available if compiled against ZeroMQ 3.x (Value: <info>int</info>)


id: ZMQ::SOCKOPT_IPV6
type: constant
doc:
<comment>Description:</comment>
  Enable IPV6. Available if compiled against ZeroMQ 4.0 or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LAST_ENDPOINT
type: constant
doc:
<comment>Description:</comment>
  Retrieve the last connected endpoint - for use with * wildcard ports. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::SOCKOPT_LINGER
type: constant
doc:
<comment>Description:</comment>
  The linger value of the socket. Specifies how long the socket blocks trying flush messages after
  it has been closed (Value: <info>int</info>)


id: ZMQ::SOCKOPT_MAXMSGSIZE
type: constant
doc:
<comment>Description:</comment>
  Limits the maximum size of the inbound message. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RATE
type: constant
doc:
<comment>Description:</comment>
  Set rate for multicast sockets (pgm) (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RCVHWM
type: constant
doc:
<comment>Description:</comment>
  The SOCKOPT_RCVHWM option shall set the high water mark for inbound messages on the specified
  socket. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_RCVTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for receive operation on the socket. Value -1 means no limit. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_RECONNECT_IVL
type: constant
doc:
<comment>Description:</comment>
  Set the initial reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECONNECT_IVL_MAX
type: constant
doc:
<comment>Description:</comment>
  Set the max reconnection interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_RECOVERY_IVL
type: constant
doc:
<comment>Description:</comment>
  Set multicast recovery interval (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_ROUTER_RAW
type: constant
doc:
<comment>Description:</comment>
  Sets the raw mode on the ROUTER, when set to 1. In raw mode when using tcp:// transport the socket
  will read and write without ZeroMQ framing. Available if compiled against ZeroMQ 4.0 or higher
  (Value: <info>string</info>)


id: ZMQ::SOCKOPT_SNDBUF
type: constant
doc:
<comment>Description:</comment>
  Set kernel transmit buffer size (Value: <info>int</info> &gt;= 0)


id: ZMQ::SOCKOPT_SNDHWM
type: constant
doc:
<comment>Description:</comment>
  The ZMQ_SNDHWM option shall set the high water mark for outbound messages on the specified socket.
  Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>).


id: ZMQ::SOCKOPT_SNDTIMEO
type: constant
doc:
<comment>Description:</comment>
  Sets the timeout for send operation on the socket. Value -1 means no limit. Available if compiled
  against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_SUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Establish message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_CNT
type: constant
doc:
<comment>Description:</comment>
  Count time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_IDLE
type: constant
doc:
<comment>Description:</comment>
  Idle time for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TCP_KEEPALIVE_INTVL
type: constant
doc:
<comment>Description:</comment>
  Interval for TCP keepalive. Available if compiled against ZeroMQ 3.x or higher (Value: <info>int</info>)


id: ZMQ::SOCKOPT_TYPE
type: constant
doc:
<comment>Description:</comment>
  Get the socket type. Valid for getSockOpt (Value: <info>int</info>)


id: ZMQ::SOCKOPT_UNSUBSCRIBE
type: constant
doc:
<comment>Description:</comment>
  Remove message filter. Valid for subscriber socket (Value: <info>string</info>)


id: ZMQ::SOCKOPT_XPUB_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  Set the XPUB to receive an application message on each instance of a subscription. Available if
  compiled against ZeroMQ 3.x or higher (Value: <info>string</info>)


id: ZMQ::__construct
type: function
doc:
<comment>Description:</comment>
  ZMQ constructor
  
  Private constructor to prevent direct initialization. This class holds the constants for ZMQ
  extension.


id: ZMQContext::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQContext object
  
  Constructs a new ZMQ context. The context is used to initialize sockets. A persistent context is
  required  to initialize persistent sockets.

<comment>Param:</comment>
  <info>int </info>  <strong>$io_threads   </strong>  Number of io-threads in the context.
  <info>bool</info>  <strong>$is_persistent</strong>  Whether the context is persistent. Persistent context is stored over
                        multiple requests and is a requirement for persistent sockets.

<comment>Return:</comment>
  <info>unknown</info>  Throws ZMQContextException if context initialization fails.


id: ZMQContext::getOpt
type: function
doc:
<comment>Description:</comment>
  Get context option
  
  Returns the value of a context option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::CTXOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQContextException on error.


id: ZMQContext::getSocket
type: function
doc:
<comment>Description:</comment>
  Create a new socket
  
  Shortcut for creating new sockets from the context. If the context is not persistent the
  <strong>$persistent_id</strong>  parameter is ignored and the socket falls back to being non-persistent. The
  <strong>$on_new_socket</strong> is called only when a new underlying socket structure is created.

<comment>Param:</comment>
  <info>int     </info>  <strong>$type         </strong>  <info>ZMQ::SOCKET_*</info> constant to specify socket type.
  <info>string  </info>  <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                            multiple requests.
  <info>callable</info>  <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                            created. This function does not get invoked if the underlying persistent
                            connection is re-used. The callback takes ZMQSocket and persistent_id as
                            two arguments.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns a ZMQSocket object on success. Throws ZMQSocketException on error.


id: ZMQContext::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the context is persistent
  
  Whether the context is persistent. Persistent context is needed for persistent connections as each
  socket is allocated from a context.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the context is persistent and <info>false</info> if the context is non-persistent.


id: ZMQContext::setOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ context option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int  </info>  <strong>$key  </strong>  One of the <info>ZMQ::CTXOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQContext</info>  Returns the current object. Throws ZMQContextException on error.


id: ZMQDevice::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new device
  
  "ØMQ devices can do intermediation of addresses, services, queues, or any other abstraction you
  care to define above the message and socket layers." -- zguide

<comment>Param:</comment>
  <info>ZMQSocket</info>  <strong>$frontend</strong>  Frontend parameter for the devices. Usually where there messages are coming.
  <info>ZMQSocket</info>  <strong>$backend </strong>  Backend parameter for the devices. Usually where there messages going to.
  <info>ZMQSocket</info>  <strong>$listener</strong>  Listener socket, which receives a copy of all messages going both
                        directions. The type of this socket should be SUB, PULL or DEALER.

<comment>Return:</comment>
  <info>unknown</info>  Call to this method will prepare the device. Usually devices are very long running
           processes so running this method from interactive script is not recommended. This method
           throw ZMQDeviceException if the device cannot be started.


id: ZMQDevice::getIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Get the idle timeout
  
  Gets the idle callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the idle callback timeout value.


id: ZMQDevice::getTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Get the timer timeout
  
  Gets the timer callback timeout value. Added in ZMQ extension version 1.1.0.

<comment>Return:</comment>
  <info>ZMQDevice</info>  This method returns the timer timeout value.


id: ZMQDevice::run
type: function
doc:
<comment>Description:</comment>
  Run the new device
  
  Runs the device.

<comment>Return:</comment>
  <info>void</info>  Call to this method will block until the device is running. It is not recommended that
        devices are used from interactive scripts. On failure this method will throw
        ZMQDeviceException.


id: ZMQDevice::setIdleCallback
type: function
doc:
<comment>Description:</comment>
  Set the idle callback function
  
  Sets the idle callback function. If idle timeout is defined the idle callback function shall be
  called if the internal poll loop times out without events. If the callback function returns false
  or a value that evaluates to false the device is stopped.
   The callback function signature is callback (mixed $user_data).

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func  </strong>  Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int     </info>  <strong>$timeout  </strong>  How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed   </info>  <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setIdleTimeout
type: function
doc:
<comment>Description:</comment>
  Set the idle timeout
  
  Sets the idle callback timeout value. The idle callback is invoked periodically when the device is
  idle.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The idle callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerCallback
type: function
doc:
<comment>Description:</comment>
  Set the timer callback function
  
  Sets the timer callback function. The timer callback will be invoked after timeout has passed. The
  difference between idle and timer callbacks are that idle callback is invoked only when the device
  is idle.
   The callback function signature is callback (mixed $user_data). Added in ZMQ extension version
  1.1.0.

<comment>Param:</comment>
  <info>callable</info>  <strong>$cb_func  </strong>  Callback function to invoke when the device is idle. Returning false or a
                        value that evaluates to false from this function will cause the  device to
                        stop.
  <info>int     </info>  <strong>$timeout  </strong>  How often to invoke the idle callback in milliseconds. The idle callback is
                        invoked periodically when there is no activity on the device. The timeout
                        value guarantees that there is at least this amount of milliseconds between
                        invocations of the callback function.
  <info>mixed   </info>  <strong>$user_data</strong>  Additional data to pass to the callback function.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQDevice::setTimerTimeout
type: function
doc:
<comment>Description:</comment>
  Set the timer timeout
  
  Sets the timer callback timeout value. The timer callback is invoked periodically if it's set.
  Added in ZMQ extension version 1.1.0.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  The timer callback timeout value.

<comment>Return:</comment>
  <info>ZMQDevice</info>  On success this method returns the current object.


id: ZMQPoll::add
type: function
doc:
<comment>Description:</comment>
  Add item to the poll set
  
  Adds a new item to the poll set and returns the internal id of the added item. The item can be
  removed from the poll set using the returned string id.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$entry</strong>  ZMQSocket object or a PHP stream resource
  <info>int  </info>  <strong>$type </strong>  Defines what activity the socket is polled for.  See <info>ZMQ::POLL_IN</info> and <info>ZMQ::POLL_OUT</info>
                 constants.

<comment>Return:</comment>
  <info>string</info>  Returns a string id of the added item which can be later used to remove the item.  Throws
          ZMQPollException on error.


id: ZMQPoll::clear
type: function
doc:
<comment>Description:</comment>
  Clear the poll set
  
  Clears all elements from the poll set.

<comment>Return:</comment>
  <info>ZMQPoll</info>  Returns the current object.


id: ZMQPoll::count
type: function
doc:
<comment>Description:</comment>
  Count items in the poll set
  
  Count the items in the poll set.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the amount of items in the poll set.


id: ZMQPoll::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Get poll errors
  
  Returns the ids of the objects that had errors in the last poll.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing ids for the items that had errors in the last poll. Empty array
         is  returned if there were no errors.


id: ZMQPoll::poll
type: function
doc:
<comment>Description:</comment>
  Poll the items
  
  Polls the items in the current poll set. The readable and writable items are returned in the
  <strong>$readable</strong> and <strong>$writable</strong> parameters.  <strong>ZMQPoll::getLastErrors()</strong> can be used to check if there were
  errors.

<comment>Param:</comment>
  <info>array</info>  <strong>$readable</strong>  Array where readable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>array</info>  <strong>$writable</strong>  Array where writable ZMQSockets/PHP streams are returned. The array will be
                    cleared at the beginning of the operation.
  <info>int  </info>  <strong>$timeout </strong>  Timeout for the operation. -1 means that poll waits until at least one item has
                    activity. Please note that starting from  version 1.0.0 the poll timeout is
                    defined in milliseconds, rather than microseconds.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing amount of items with activity. Throws ZMQPollException on
       error.


id: ZMQPoll::remove
type: function
doc:
<comment>Description:</comment>
  Remove item from poll set
  
  Remove item from the poll set. The <strong>$item</strong> parameter can be ZMQSocket object, a stream resource or
  the id returned from <strong>ZMQPoll::add()</strong> method.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  The ZMQSocket object, PHP stream or <info>string</info> id of the item.

<comment>Return:</comment>
  <info>bool</info>  Returns true if the item was removed and false if the object  with given id does not exist
        in the poll set.


id: ZMQSocket::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new ZMQSocket
  
  Constructs a ZMQSocket object. <strong>$persistent_id</strong> parameter can be used to allocated a persistent
  socket. A persistent socket has to be allocated from a persistent context and it stays connected
  over multiple requests. The <strong>$persistent_id</strong> parameter can be used to recall the same socket over
  multiple requests. The      <strong>$on_new_socket</strong> is called only when a new underlying socket structure
  is created.

<comment>Param:</comment>
  <info>ZMQContext</info>  <strong>$context      </strong>  ZMQContext object.
  <info>int       </info>  <strong>$type         </strong>  The socket type. See <info>ZMQ::SOCKET_*</info> constants.
  <info>string    </info>  <strong>$persistent_id</strong>  If <strong>$persistent_id</strong> is specified the socket will be persisted over
                              multiple requests. If <strong>$context</strong> is not persistent the socket falls back
                              to non-persistent mode.
  <info>callable  </info>  <strong>$on_new_socket</strong>  Callback function, which is executed when a new socket structure is
                              created. This function does not get invoked if the underlying
                              persistent connection is re-used.

<comment>Return:</comment>
  <info>unknown</info>  Throws ZMQSocketException on error.


id: ZMQSocket::bind
type: function
doc:
<comment>Description:</comment>
  Bind the socket
  
  Bind the socket to an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn  </strong>  The bind dsn, for example <return>transport://address</return>.
  <info>bool  </info>  <strong>$force</strong>  Tries to bind even if the socket has already been bound to the given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::connect
type: function
doc:
<comment>Description:</comment>
  Connect the socket
  
  Connect the socket to a remote endpoint. The endpoint is defined in format <return>transport://address</return>
  where  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn  </strong>  The connect dsn, for example <return>transport://address</return>.
  <info>bool  </info>  <strong>$force</strong>  Tries to connect even if the socket has already been connected to given endpoint.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::disconnect
type: function
doc:
<comment>Description:</comment>
  Disconnect a socket
  
  Disconnect the socket from a previously connected remote endpoint. The endpoint is defined in
  format <return>transport://address</return> where transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The connect dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::getEndpoints
type: function
doc:
<comment>Description:</comment>
  Get list of endpoints
  
  Returns a list of endpoints where the socket is connected or bound to.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing elements 'bind' and 'connect'.


id: ZMQSocket::getPersistentId
type: function
doc:
<comment>Description:</comment>
  Get the persistent id
  
  Returns the persistent id of the socket.

<comment>Return:</comment>
  <info>string</info>  Returns the persistent id string assigned of the object and <info>null</info> if socket is not
          persistent.


id: ZMQSocket::getSockOpt
type: function
doc:
<comment>Description:</comment>
  Get socket option
  
  Returns the value of a socket option.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  An integer representing the option. See the <info>ZMQ::SOCKOPT_*</info> constants.

<comment>Return:</comment>
  <info>mixed</info>  Returns either a <info>string</info> or an <info>int</info> depending on <strong>$key</strong>. Throws ZMQSocketException on error.


id: ZMQSocket::getSocketType
type: function
doc:
<comment>Description:</comment>
  Get the socket type
  
  Gets the socket type.

<comment>Return:</comment>
  <info>int</info>  Returns an integer representing the socket type. The integer can be compared against
       <info>ZMQ::SOCKET_*</info> constants.


id: ZMQSocket::isPersistent
type: function
doc:
<comment>Description:</comment>
  Whether the socket is persistent
  
  Check whether the socket is persistent.

<comment>Return:</comment>
  <info>bool</info>  Returns a <info>bool</info> based on whether the socket is persistent or not.


id: ZMQSocket::recv
type: function
doc:
<comment>Description:</comment>
  Receives a message
  
  Receive a message from a socket. By default receiving will block until a message is available
  unless <info>ZMQ::MODE_DONTWAIT</info> flag is used. <info>ZMQ::SOCKOPT_RCVMORE</info> socket option can be used for
  receiving multi-part messages. See <strong>ZMQSocket::setSockOpt()</strong>  for more information.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>string</info>  Returns the message. Throws ZMQSocketException in error.  If <info>ZMQ::MODE_DONTWAIT</info> is used
          and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::recvMulti
type: function
doc:
<comment>Description:</comment>
  Receives a multipart message
  
  Receive an array multipart message from a socket. By default receiving will block until a message
  is available unless <info>ZMQ::MODE_NOBLOCK</info> flag is used.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
              <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>array</info>  Returns the array of message parts. Throws ZMQSocketException in error.  If
         <info>ZMQ::MODE_NOBLOCK</info> is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::send
type: function
doc:
<comment>Description:</comment>
  Sends a message
  
  Send a message using the socket. The operation can block unless <info>ZMQ::MODE_NOBLOCK</info> is used.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The message to send.
  <info>int   </info>  <strong>$mode   </strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
                    <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.  If <info>ZMQ::MODE_NOBLOCK</info>
             is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::sendmulti
type: function
doc:
<comment>Description:</comment>
  Sends a multipart message
  
  Send a multipart message using the socket. The operation can block unless <info>ZMQ::MODE_NOBLOCK</info> is
  used.

<comment>Param:</comment>
  <info>array</info>  <strong>$message</strong>  The message to send - an array of strings
  <info>int  </info>  <strong>$mode   </strong>  Pass mode flags to receive multipart messages or non-blocking operation.  See
                   <info>ZMQ::MODE_*</info> constants.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.  If <info>ZMQ::MODE_NOBLOCK</info>
             is used and the operation would  block <info>bool</info> false shall be returned.


id: ZMQSocket::setSockOpt
type: function
doc:
<comment>Description:</comment>
  Set a socket option
  
  Sets a ZMQ socket option. The type of the <strong>$value</strong> depends on the <strong>$key</strong>. See ZMQ Constant Types for
  more information.

<comment>Param:</comment>
  <info>int  </info>  <strong>$key  </strong>  One of the <info>ZMQ::SOCKOPT_*</info> constants.
  <info>mixed</info>  <strong>$value</strong>  The value of the parameter.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZMQSocket::unbind
type: function
doc:
<comment>Description:</comment>
  Unbind the socket
  
  Unbind the socket from an endpoint. The endpoint is defined in format <return>transport://address</return> where
  transport is one of the following: inproc, ipc, tcp, pgm or epgm.

<comment>Param:</comment>
  <info>string</info>  <strong>$dsn</strong>  The previously bound dsn, for example <return>transport://address</return>.

<comment>Return:</comment>
  <info>ZMQSocket</info>  Returns the current object. Throws ZMQSocketException on error.


id: ZipArchive::CHECKCONS
type: constant
doc:
<comment>Description:</comment>
  Perform additional consistency checks on the archive, and error if they fail.


id: ZipArchive::CM_LZMA2
type: constant
doc:
<comment>Description:</comment>
  LZMA2 algorithm. Available as of PHP 7.4.3 and PECL zip 1.16.0, respectively, if built against
  libzip ≥ 1.6.0.


id: ZipArchive::CM_XZ
type: constant
doc:
<comment>Description:</comment>
  XZ algorithm. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against libzip
  ≥ 1.6.0.


id: ZipArchive::CM_ZSTD
type: constant
doc:
<comment>Description:</comment>
  Zstandard algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.1, respectively, if built against
  libzip ≥ 1.8.0.


id: ZipArchive::EM_AES_128
type: constant
doc:
<comment>Description:</comment>
  AES 128 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_AES_192
type: constant
doc:
<comment>Description:</comment>
  AES 192 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_AES_256
type: constant
doc:
<comment>Description:</comment>
  AES 256 encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively, if built against
  libzip ≥ 1.2.0.


id: ZipArchive::EM_NONE
type: constant
doc:
<comment>Description:</comment>
  No encryption. Available as of PHP 7.2.0 and PECL zip 1.14.0, respectively.


id: ZipArchive::EM_TRAD_PKWARE
type: constant
doc:
<comment>Description:</comment>
  Traditional PKWARE encryption. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.


id: ZipArchive::EM_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Unknown encryption algorithm. Available as of PHP 8.0.0 and PECL zip 1.19.0, respectively.


id: ZipArchive::ER_CANCELLED
type: constant
doc:
<comment>Description:</comment>
  Operation cancelled. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against
  libzip ≥ 1.6.0.


id: ZipArchive::ER_ENCRNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  Encryption method not supported. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_NOPASSWD
type: constant
doc:
<comment>Description:</comment>
  No password provided. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Read-only archive. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::ER_WRONGPASSWD
type: constant
doc:
<comment>Description:</comment>
  Wrong password provided. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively.


id: ZipArchive::FL_ENCRYPTED
type: constant
doc:
<comment>Description:</comment>
  Read encrypted data (implies FL_COMPRESSED). Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::FL_OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  If file with name exists, overwrite (replace) it. Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::FL_RECOMPRESS
type: constant
doc:
<comment>Description:</comment>
  Force recompression of data. Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::LIBZIP_VERSION
type: constant
doc:
<comment>Description:</comment>
  Zip library version. Available as of PHP 7.4.3 and PECL zip 1.16.0.


id: ZipArchive::OVERWRITE
type: constant
doc:
<comment>Description:</comment>
  If archive exists, ignore its current contents. In other words, handle it the same way as an empty
  archive.


id: ZipArchive::RDONLY
type: constant
doc:
<comment>Description:</comment>
  Open archive in read only mode. Available as of PHP 7.4.3 and PECL zip 1.17.1, respectively, if
  built against libzip ≥ 1.0.0.


id: ZipArchive::ZIP_ER_COMPRESSED_DATA
type: constant
doc:
<comment>Description:</comment>
  Compressed data invalid. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.6.0.


id: ZipArchive::ZIP_ER_INUSE
type: constant
doc:
<comment>Description:</comment>
  Resource still in use. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.0.0.


id: ZipArchive::ZIP_ER_OPNOTSUPP
type: constant
doc:
<comment>Description:</comment>
  Operation not supported. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built
  against libzip ≥ 1.0.0.


id: ZipArchive::ZIP_ER_TELL
type: constant
doc:
<comment>Description:</comment>
  Tell error. Available as of PHP 7.4.3 and PECL zip 1.16.1, respectively, if built against libzip ≥
  1.0.0.


id: ZipArchive::ZIP_FL_CENTRAL
type: constant
doc:
<comment>Description:</comment>
  In central directory. Available as of PHP 8.0.0 and PECL zip 1.18.0.


id: ZipArchive::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  Add a new directory
  
  Adds an empty directory in the archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$dirname</strong>  The directory to add.
  <info>int   </info>  <strong>$flags  </strong>  Bitmask consisting of <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                    <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these constants is described on the
                    ZIP constants page.

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


id: ZipArchive::addFile
type: function
doc:
<comment>Description:</comment>
  Adds a file to a ZIP archive from the given path
  
  Adds a file to a ZIP archive from a given path.
  
  For maximum portability, it is recommended to always use forward slashes (<return>/</return>) as directory
  separator in ZIP filenames.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename </strong>  The path to the file to add.
  <info>string</info>  <strong>$entryname</strong>  If supplied, this is the local name inside the ZIP archive that will override
                      the <strong>$filename</strong>.
  <info>int   </info>  <strong>$start    </strong>  For partial copy, start position.
  <info>int   </info>  <strong>$length   </strong>  For partial copy, length to be copied, if 0 or -1 the whole file (starting
                      from <strong>$start</strong>) is used.
  <info>int   </info>  <strong>$flags    </strong>  Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                      <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these
                      constants is described on the ZIP constants page.

<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>
   * ZipArchive::replaceFile


id: ZipArchive::addFromString
type: function
doc:
<comment>Description:</comment>
  Add a file to a ZIP archive using its contents
  
  Add a file to a ZIP archive using its contents.
  
  For maximum portability, it is recommended to always use forward slashes (<return>/</return>) as directory
  separator in ZIP filenames.

<comment>Param:</comment>
  <info>string</info>  <strong>$name    </strong>  The name of the entry to create.
  <info>string</info>  <strong>$contents</strong>  The contents to use to create the entry. It is used in a binary safe mode.
  <info>int   </info>  <strong>$flags   </strong>  Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                     <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these
                     constants is described on the ZIP constants page.

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


id: ZipArchive::addGlob
type: function
doc:
<comment>Description:</comment>
  Add files from a directory by glob pattern
  
  Add files from a directory which match the glob <strong>$pattern</strong>.
  
  For maximum portability, it is recommended to always use forward slashes (<return>/</return>) as directory
  separator in ZIP filenames.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  A <strong>glob()</strong> pattern against which files will be matched.
  <info>int   </info>  <strong>$flags  </strong>  A bit mask of <return>glob()</return> flags.
  <info>array </info>  <strong>$options</strong>  An associative array of options. Available options are: <return>"add_path"</return> Prefix to
                    prepend when translating to the local path of the file within the archive. This
                    is applied after any remove operations defined by the <return>"remove_path"</return> or
                    <return>"remove_all_path"</return> options. <return>"remove_path"</return> Prefix to remove from matching file
                    paths before adding to the archive. <return>"remove_all_path"</return><info>true</info> to use the file name
                    only and add to the root of the archive. <return>"flags"</return> Bitmask consisting of
                    <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                    <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these constants is described on the
                    ZIP constants page. <return>"comp_method"</return> Compression method, one of the
                    <info>ZipArchive::CM_*</info> constants, see ZIP constants page. <return>"comp_flags"</return> Compression
                    level. <return>"enc_method"</return> Encryption method, one of the <info>ZipArchive::EM_*</info> constants,
                    see ZIP constants page. <return>"enc_password"</return> Password used for encryption.
                    
                    <return>"add_path"</return>
                    
                    Prefix to prepend when translating to the local path of the file within the
                    archive. This is applied after any remove operations defined by the
                    <return>"remove_path"</return> or <return>"remove_all_path"</return> options.
                    
                    <return>"remove_path"</return>
                    
                    Prefix to remove from matching file paths before adding to the archive.
                    
                    <return>"remove_all_path"</return>
                    
                    <info>true</info> to use the file name only and add to the root of the archive.
                    
                    <return>"flags"</return>
                    
                    Bitmask consisting of <info>ZipArchive::FL_OVERWRITE</info>, <info>ZipArchive::FL_ENC_GUESS</info>,
                    <info>ZipArchive::FL_ENC_UTF_8</info>, <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these
                    constants is described on the ZIP constants page.
                    
                    <return>"comp_method"</return>
                    
                    Compression method, one of the <info>ZipArchive::CM_*</info> constants, see ZIP constants
                    page.
                    
                    <return>"comp_flags"</return>
                    
                    Compression level.
                    
                    <return>"enc_method"</return>
                    
                    Encryption method, one of the <info>ZipArchive::EM_*</info> constants, see ZIP constants
                    page.
                    
                    <return>"enc_password"</return>
                    
                    Password used for encryption.

<comment>Return:</comment>
  <info>arrayfalse</info>  An <info>array</info> of added files on success  o <info>false</info> in caso di fallimento

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addPattern


id: ZipArchive::addPattern
type: function
doc:
<comment>Description:</comment>
  Add files from a directory by PCRE pattern
  
  Add files from a directory which match the regular expression <strong>$pattern</strong>. The operation is not
  recursive. The pattern will be matched against the file name only.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  A PCRE pattern against which files will be matched.
  <info>string</info>  <strong>$path   </strong>  The directory that will be scanned. Defaults to the current working directory.
  <info>array </info>  <strong>$options</strong>  An associative array of options accepted by ZipArchive::addGlob.

<comment>Return:</comment>
  <info>arrayfalse</info>  An <info>array</info> of added files on success  o <info>false</info> in caso di fallimento

<comment>See Also:</comment>
   * ZipArchive::addFile
   * ZipArchive::addGlob


id: ZipArchive::close
type: function
doc:
<comment>Description:</comment>
  Close the active archive (opened or newly created)
  
  Close opened or created archive and save changes. This method is automatically called at the end
  of the script.

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


id: ZipArchive::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of files in the archive

<comment>Return:</comment>
  <info>int</info>  Returns the number of files in the archive.


id: ZipArchive::deleteIndex
type: function
doc:
<comment>Description:</comment>
  Delete an entry in the archive using its index
  
  Delete an entry in the archive using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry to delete.

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


id: ZipArchive::deleteName
type: function
doc:
<comment>Description:</comment>
  Delete an entry in the archive using its name
  
  Delete an entry in the archive using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the entry to delete.

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


id: ZipArchive::extractTo
type: function
doc:
<comment>Description:</comment>
  Extract the archive contents
  
  Extract the complete archive or the given files to the specified destination.
  
  The default permissions for extracted files and directories give the widest possible access. This
  can be restricted by setting the current umask, which can be changed using <strong>umask()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$destination</strong>  Location where to extract the files.
  <info>mixed </info>  <strong>$entries    </strong>  The entries to extract. It accepts either a single entry name or an array of
                        names.

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


id: ZipArchive::getArchiveComment
type: function
doc:
<comment>Description:</comment>
  Returns the Zip archive comment
  
  Returns the Zip archive comment.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
               returned.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the Zip archive comment o <info>false</info> in caso di fallimento.


id: ZipArchive::getCommentIndex
type: function
doc:
<comment>Description:</comment>
  Returns the comment of an entry using the entry index
  
  Returns the comment of an entry using the entry index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
               returned.

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


id: ZipArchive::getCommentName
type: function
doc:
<comment>Description:</comment>
  Returns the comment of an entry using the entry name
  
  Returns the comment of an entry using the entry name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of the entry
  <info>int   </info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged comment is
                  returned.

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


id: ZipArchive::getExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  Retrieve the external attributes of an entry defined by its index
  
  Retrieve the external attributes of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$opsys</strong>  On success, receive the operating system code defined by one of the
               ZipArchive::OPSYS_ constants.
  <info>int</info>  <strong>$attr </strong>  On success, receive the external attributes. Value depends on operating system.
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged attributes are
               returned.

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


id: ZipArchive::getExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  Retrieve the external attributes of an entry defined by its name
  
  Retrieve the external attributes of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of the entry.
  <info>int   </info>  <strong>$opsys</strong>  On success, receive the operating system code defined by one of the
                  ZipArchive::OPSYS_ constants.
  <info>int   </info>  <strong>$attr </strong>  On success, receive the external attributes. Value depends on operating system.
  <info>int   </info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged attributes are
                  returned.

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


id: ZipArchive::getFromIndex
type: function
doc:
<comment>Description:</comment>
  Returns the entry contents using its index
  
  Returns the entry contents using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index </strong>  Index of the entry
  <info>int</info>  <strong>$length</strong>  The length to be read from the entry. If <return>0</return>, then the entire entry is read.
  <info>int</info>  <strong>$flags </strong>  The flags to use to open the archive. the following values may be ORed to it.
                <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info>
                
                <info>ZipArchive::FL_UNCHANGED</info>
                
                <info>ZipArchive::FL_COMPRESSED</info>

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the contents of the entry on success o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * ZipArchive::getFromName


id: ZipArchive::getFromName
type: function
doc:
<comment>Description:</comment>
  Returns the entry contents using its name
  
  Returns the entry contents using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name  </strong>  Name of the entry
  <info>int   </info>  <strong>$length</strong>  The length to be read from the entry. If <return>0</return>, then the entire entry is read.
  <info>int   </info>  <strong>$flags </strong>  The flags to use to find the entry. The following values may be ORed.
                   <info>ZipArchive::FL_UNCHANGED</info><info>ZipArchive::FL_COMPRESSED</info><info>ZipArchive::FL_NOCASE</info>
                   
                   <info>ZipArchive::FL_UNCHANGED</info>
                   
                   <info>ZipArchive::FL_COMPRESSED</info>
                   
                   <info>ZipArchive::FL_NOCASE</info>

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the contents of the entry on success o <info>false</info> in caso di fallimento.

<comment>See Also:</comment>
   * ZipArchive::getFromIndex


id: ZipArchive::getNameIndex
type: function
doc:
<comment>Description:</comment>
  Returns the name of an entry using its index
  
  Returns the name of an entry using its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$flags</strong>  If flags is set to <info>ZipArchive::FL_UNCHANGED</info>, the original unchanged name is returned.

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


id: ZipArchive::getStatusString
type: function
doc:
<comment>Description:</comment>
  Returns the status error message, system and/or zip messages
  
  Returns the status error message, system and/or zip messages.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns a <info>string</info> with the status message on success o <info>false</info> in caso di fallimento.


id: ZipArchive::getStream
type: function
doc:
<comment>Description:</comment>
  Get a file handler to the entry defined by its name (read only)
  
  Get a file handler to the entry defined by its name. For now it only supports read operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the entry to use.

<comment>Return:</comment>
  <info>resourcefalse</info>  Returns a file pointer (resource) on success o <info>false</info> in caso di fallimento.


id: ZipArchive::isCompressionMethodSupported
type: function
doc:
<comment>Description:</comment>
  Check if a compression method is supported by libzip
  
  Check if a compression method is supported by libzip.

<comment>Param:</comment>
  <info>int </info>  <strong>$method</strong>  The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>bool</info>  <strong>$encode</strong>  If <info>true</info> check for compression, else check for decompression.

<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>
   * ZipArchive::setCompressionIndex
   * ZipArchive::setCompressionName


id: ZipArchive::isEncryptionMethodSupported
type: function
doc:
<comment>Description:</comment>
  Check if a encryption method is supported by libzip
  
  Check if a compression method is supported by libzip.

<comment>Param:</comment>
  <info>int </info>  <strong>$method</strong>  The encryption method, one of the <info>ZipArchive::EM_*</info> constants.
  <info>bool</info>  <strong>$encode</strong>  If <info>true</info> check for encryption, else check for decryption.

<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>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::locateName
type: function
doc:
<comment>Description:</comment>
  Returns the index of the entry in the archive
  
  Locates an entry using its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  The name of the entry to look up
  <info>int   </info>  <strong>$flags</strong>  The flags are specified by ORing the following values, or 0 for none of them.
                  <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>

<comment>Return:</comment>
  <info>intfalse</info>  Returns the index of the entry on success o <info>false</info> in caso di fallimento.


id: ZipArchive::open
type: function
doc:
<comment>Description:</comment>
  Open a ZIP file archive
  
  Opens a new or existing zip archive for reading, writing or modifying.
  
  Since libzip 1.6.0, a empty file is not a valid archive any longer.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file name of the ZIP archive to open.
  <info>int   </info>  <strong>$flags   </strong>  The mode to use to open the archive.
                     <info>ZipArchive::OVERWRITE</info><info>ZipArchive::CREATE</info><info>ZipArchive::RDONLY</info><info>ZipArchive::EXCL</info><info>ZipArchive::CHECKCONS</info>
                     
                     <info>ZipArchive::OVERWRITE</info>
                     
                     <info>ZipArchive::CREATE</info>
                     
                     <info>ZipArchive::RDONLY</info>
                     
                     <info>ZipArchive::EXCL</info>
                     
                     <info>ZipArchive::CHECKCONS</info>

<comment>Return:</comment>
  <info>mixed</info>  <strong>$Error codes</strong> Returns <info>true</info> on success or the error code. <info>ZipArchive::ER_EXISTS</info> File already
         exists. <info>ZipArchive::ER_INCONS</info> Zip archive inconsistent. <info>ZipArchive::ER_INVAL</info> Invalid
         argument. <info>ZipArchive::ER_MEMORY</info> Malloc failure. <info>ZipArchive::ER_NOENT</info> No such file.
         <info>ZipArchive::ER_NOZIP</info> Not a zip archive. <info>ZipArchive::ER_OPEN</info> Can't open file.
         <info>ZipArchive::ER_READ</info> Read error. <info>ZipArchive::ER_SEEK</info> Seek error.
         
         Returns <info>true</info> on success or the error code. <info>ZipArchive::ER_EXISTS</info> File already exists.
         <info>ZipArchive::ER_INCONS</info> Zip archive inconsistent. <info>ZipArchive::ER_INVAL</info> Invalid argument.
         <info>ZipArchive::ER_MEMORY</info> Malloc failure. <info>ZipArchive::ER_NOENT</info> No such file.
         <info>ZipArchive::ER_NOZIP</info> Not a zip archive. <info>ZipArchive::ER_OPEN</info> Can't open file.
         <info>ZipArchive::ER_READ</info> Read error. <info>ZipArchive::ER_SEEK</info> Seek error.
         
         <info>ZipArchive::ER_EXISTS</info>
         
         File already exists.
         
         <info>ZipArchive::ER_INCONS</info>
         
         Zip archive inconsistent.
         
         <info>ZipArchive::ER_INVAL</info>
         
         Invalid argument.
         
         <info>ZipArchive::ER_MEMORY</info>
         
         Malloc failure.
         
         <info>ZipArchive::ER_NOENT</info>
         
         No such file.
         
         <info>ZipArchive::ER_NOZIP</info>
         
         Not a zip archive.
         
         <info>ZipArchive::ER_OPEN</info>
         
         Can't open file.
         
         <info>ZipArchive::ER_READ</info>
         
         Read error.
         
         <info>ZipArchive::ER_SEEK</info>
         
         Seek error.


id: ZipArchive::registerCancelCallback
type: function
doc:
<comment>Description:</comment>
  Register a callback to allow cancellation during archive close.
  
  Register a <strong>$callback</strong> function to allow cancellation during archive close.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  If this function return 0 operation will continue, other value it will be
                       cancelled.

<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>
   * ZipArchive::registerProgressCallback


id: ZipArchive::registerProgressCallback
type: function
doc:
<comment>Description:</comment>
  Register a callback to provide updates during archive close.
  
  Register a <strong>$callback</strong> function to provide updates during archive close.

<comment>Param:</comment>
  <info>float   </info>  <strong>$rate    </strong>  Change between each call of the callback (from 0.0 to 1.0).
  <info>callable</info>  <strong>$callback</strong>  This function will receive the current <strong>$state</strong> as a <info>float</info> (from 0.0 to 1.0).

<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>
   * ZipArchive::registerCancelCallback


id: ZipArchive::renameIndex
type: function
doc:
<comment>Description:</comment>
  Renames an entry defined by its index
  
  Renames an entry defined by its index.

<comment>Param:</comment>
  <info>int   </info>  <strong>$index  </strong>  Index of the entry to rename.
  <info>string</info>  <strong>$newname</strong>  New name.

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


id: ZipArchive::renameName
type: function
doc:
<comment>Description:</comment>
  Renames an entry defined by its name
  
  Renames an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  Name of the entry to rename.
  <info>string</info>  <strong>$newname</strong>  New name.

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


id: ZipArchive::replaceFile
type: function
doc:
<comment>Description:</comment>
  Replace file in ZIP archive with a given path
  
  Replace file in ZIP archive with a given path.
  
  For maximum portability, it is recommended to always use forward slashes (<return>/</return>) as directory
  separator in ZIP filenames.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The path to the file to add.
  <info>int   </info>  <strong>$index   </strong>  The index of the file to be replaced, its name is unchanged.
  <info>int   </info>  <strong>$start   </strong>  For partial copy, start position.
  <info>int   </info>  <strong>$length  </strong>  For partial copy, length to be copied, if 0 or -1 the whole file (starting from
                     <strong>$start</strong>) is used.
  <info>int   </info>  <strong>$flags   </strong>  Bitmask consisting of <info>ZipArchive::FL_ENC_GUESS</info>, <info>ZipArchive::FL_ENC_UTF_8</info>,
                     <info>ZipArchive::FL_ENC_CP437</info>. The behaviour of these constants is described on the
                     ZIP constants page.

<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>
   * ZipArchive::addFile


id: ZipArchive::setArchiveComment
type: function
doc:
<comment>Description:</comment>
  Set the comment of a ZIP archive
  
  Set the comment of a ZIP archive.

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


id: ZipArchive::setCommentIndex
type: function
doc:
<comment>Description:</comment>
  Set the comment of an entry defined by its index
  
  Set the comment of an entry defined by its index.

<comment>Param:</comment>
  <info>int   </info>  <strong>$index  </strong>  Index of the entry.
  <info>string</info>  <strong>$comment</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.


id: ZipArchive::setCommentName
type: function
doc:
<comment>Description:</comment>
  Set the comment of an entry defined by its name
  
  Set the comment of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name   </strong>  Name of the entry.
  <info>string</info>  <strong>$comment</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.


id: ZipArchive::setCompressionIndex
type: function
doc:
<comment>Description:</comment>
  Set the compression method of an entry defined by its index
  
  Set the compression method of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index      </strong>  Index of the entry.
  <info>int</info>  <strong>$comp_method</strong>  The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>int</info>  <strong>$comp_flags </strong>  Compression level.

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


id: ZipArchive::setCompressionName
type: function
doc:
<comment>Description:</comment>
  Set the compression method of an entry defined by its name
  
  Set the compression method of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name       </strong>  Name of the entry.
  <info>int   </info>  <strong>$comp_method</strong>  The compression method, one of the <info>ZipArchive::CM_*</info> constants.
  <info>int   </info>  <strong>$comp_flags </strong>  Compression level.

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


id: ZipArchive::setEncryptionIndex
type: function
doc:
<comment>Description:</comment>
  Set the encryption method of an entry defined by its index
  
  Set the encryption method of an entry defined by its index.

<comment>Param:</comment>
  <info>int   </info>  <strong>$index   </strong>  Index of the entry.
  <info>int   </info>  <strong>$method  </strong>  The encryption method defined by one of the ZipArchive::EM_ constants.
  <info>string</info>  <strong>$password</strong>  Optional password, default used when missing.

<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>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionName


id: ZipArchive::setEncryptionName
type: function
doc:
<comment>Description:</comment>
  Set the encryption method of an entry defined by its name
  
  Set the encryption method of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name    </strong>  Name of the entry.
  <info>int   </info>  <strong>$method  </strong>  The encryption method defined by one of the ZipArchive::EM_ constants.
  <info>string</info>  <strong>$password</strong>  Optional password, default used when missing.

<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>
   * ZipArchive::setPassword
   * ZipArchive::setEncryptionIndex


id: ZipArchive::setExternalAttributesIndex
type: function
doc:
<comment>Description:</comment>
  Set the external attributes of an entry defined by its index
  
  Set the external attributes of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.
  <info>int</info>  <strong>$opsys</strong>  The operating system code defined by one of the ZipArchive::OPSYS_ constants.
  <info>int</info>  <strong>$attr </strong>  The external attributes. Value depends on operating system.
  <info>int</info>  <strong>$flags</strong>  Optional flags. Currently unused.

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


id: ZipArchive::setExternalAttributesName
type: function
doc:
<comment>Description:</comment>
  Set the external attributes of an entry defined by its name
  
  Set the external attributes of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of the entry.
  <info>int   </info>  <strong>$opsys</strong>  The operating system code defined by one of the ZipArchive::OPSYS_ constants.
  <info>int   </info>  <strong>$attr </strong>  The external attributes. Value depends on operating system.
  <info>int   </info>  <strong>$flags</strong>  Optional flags. Currently unused.

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


id: ZipArchive::setMtimeIndex
type: function
doc:
<comment>Description:</comment>
  Set the modification time of an entry defined by its index
  
  Set the modification time of an entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index    </strong>  Index of the entry.
  <info>int</info>  <strong>$timestamp</strong>  The modification time (unix timestamp) of the file.
  <info>int</info>  <strong>$flags    </strong>  Optional flags, unused for now.

<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>
   * ZipArchive::setMtimeName


id: ZipArchive::setMtimeName
type: function
doc:
<comment>Description:</comment>
  Set the modification time of an entry defined by its name
  
  Set the modification time of an entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name     </strong>  Name of the entry.
  <info>int   </info>  <strong>$timestamp</strong>  The modification time (unix timestamp) of the file.
  <info>int   </info>  <strong>$flags    </strong>  Optional flags, unused for now.

<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>
   * ZipArchive::setMtimeIndex


id: ZipArchive::setPassword
type: function
doc:
<comment>Description:</comment>
  Set the password for the active archive
  
  Sets the password for the active archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$password</strong>  The password to be used for the archive.

<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>
   * ZipArchive::setEncryptionIndex
   * ZipArchive::setEncryptionName


id: ZipArchive::statIndex
type: function
doc:
<comment>Description:</comment>
  Get the details of an entry defined by its index
  
  The  function  obtains  information  about the entry defined by its index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry
  <info>int</info>  <strong>$flags</strong>  <info>ZipArchive::FL_UNCHANGED</info> may be ORed to it to request information  about  the
               original  file  in  the archive, ignoring any changes made.

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an array containing the entry details o <info>false</info> in caso di fallimento.


id: ZipArchive::statName
type: function
doc:
<comment>Description:</comment>
  Get the details of an entry defined by its name
  
  The function obtains information about the entry defined by its name.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of the entry
  <info>int   </info>  <strong>$flags</strong>  The flags argument specifies how the name lookup should be done. Also,
                  <info>ZipArchive::FL_UNCHANGED</info> may be ORed to it to request information  about  the
                  original  file  in  the archive, ignoring any changes made.
                  <info>ZipArchive::FL_NOCASE</info><info>ZipArchive::FL_NODIR</info><info>ZipArchive::FL_UNCHANGED</info>
                  
                  <info>ZipArchive::FL_NOCASE</info>
                  
                  <info>ZipArchive::FL_NODIR</info>
                  
                  <info>ZipArchive::FL_UNCHANGED</info>

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns an array containing the entry details  o <info>false</info> in caso di fallimento.


id: ZipArchive::unchangeAll
type: function
doc:
<comment>Description:</comment>
  Undo all changes done in the archive
  
  Undo all changes done in the archive.

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


id: ZipArchive::unchangeArchive
type: function
doc:
<comment>Description:</comment>
  Revert all global changes done in the archive
  
  Revert all global changes to the archive.  For now, this only reverts archive comment changes.

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


id: ZipArchive::unchangeIndex
type: function
doc:
<comment>Description:</comment>
  Revert all changes done to an entry at the given index
  
  Revert all changes done to an entry at the given index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index of the entry.

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


id: ZipArchive::unchangeName
type: function
doc:
<comment>Description:</comment>
  Revert all changes done to an entry with the given name
  
  Revert all changes done to an entry.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the entry.

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


id: Zookeeper::APIERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value are API errors (while values less than this
  indicate a Zookeeper::SYSTEMERROR).


id: Zookeeper::CHANGED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has changed
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::CHILD_EVENT
type: constant
doc:
<comment>Description:</comment>
  A change as occurred in the list of children
  
  This is only generated by watches on the child list of a node. These watches are set using
  Zookeeper::getChildren.


id: Zookeeper::CREATED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been created
  
  This is only generated by watches on non-existent nodes. These watches are set using
  Zookeeper::exists.


id: Zookeeper::DELETED_EVENT
type: constant
doc:
<comment>Description:</comment>
  A node has been deleted
  
  This is only generated by watches on nodes. These watches are set using Zookeeper::exists and
  Zookeeper::get.


id: Zookeeper::EPHEMERAL
type: constant
doc:
<comment>Description:</comment>
  If Zookeeper::EPHEMERAL flag is set, the node will automatically get removed if the client session
  goes away.


id: Zookeeper::NEWCONFIGNOQUORUM
type: constant
doc:
<comment>Description:</comment>
  No quorum of new config is connected and up-to-date with the leader of last committed config - try
  invoking reconfiguration after new servers are connected and synced.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::NOTWATCHING_EVENT
type: constant
doc:
<comment>Description:</comment>
  A watch has been removed
  
  This is generated when the server for some reason, probably a resource constraint, will no longer
  watch a node for a client.


id: Zookeeper::RECONFIGDISABLED
type: constant
doc:
<comment>Description:</comment>
  Attempts to perform a reconfiguration operation when reconfiguration feature is disabled.


id: Zookeeper::RECONFIGINPROGRESS
type: constant
doc:
<comment>Description:</comment>
  Reconfiguration requested while another reconfiguration is currently in progress. This is
  currently not supported. Please retry.
  
  Available as of ZooKeeper 3.5.0


id: Zookeeper::SEQUENCE
type: constant
doc:
<comment>Description:</comment>
  If the Zookeeper::SEQUENCE flag is set, a unique monotonically increasing sequence number is
  appended to the path name. The sequence number is always fixed length of 10 digits, 0 padded.


id: Zookeeper::SESSION_EVENT
type: constant
doc:
<comment>Description:</comment>
  A session has been lost
  
  This is generated when a client loses contact or reconnects with a server.


id: Zookeeper::SYSTEMERROR
type: constant
doc:
<comment>Description:</comment>
  This is never thrown by the server, it shouldn't be used other than to indicate a range.
  Specifically error codes greater than this value, but lesser than Zookeeper::APIERROR, are system
  errors.


id: Zookeeper::__construct
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string  </info>  <strong>$host        </strong>  comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb  </strong>  the global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int     </info>  <strong>$recv_timeout</strong>  the timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

<comment>See Also:</comment>
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::addAuth
type: function
doc:
<comment>Description:</comment>
  Specify application credentials
  
  The application calls this function to specify its credentials for purposes of authentication. The
  server will use the security provider specified by the scheme parameter to authenticate the client
  connection. If the authentication request has failed: - the server connection is dropped. - the
  watcher is called with the ZOO_AUTH_FAILED_STATE value as the state parameter.

<comment>Param:</comment>
  <info>string  </info>  <strong>$scheme       </strong>  The id of authentication scheme. Natively supported: "digest"
                            password-based authentication
  <info>string  </info>  <strong>$cert         </strong>  Application credentials. The actual value depends on the scheme.
  <info>callable</info>  <strong>$completion_cb</strong>  The routine to invoke when the request completes. One of the following
                            result codes may be passed into the completion callback: - ZOK operation
                            completed successfully - ZAUTHFAILED authentication failed

<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>
   * Zookeeper::create
   * Zookeeper::setAcl
   * Zookeeper::getAcl
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::close
type: function
doc:
<comment>Description:</comment>
  Close the zookeeper handle and free up any resources

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

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::connect
type: function
doc:
<comment>Description:</comment>
  Create a handle to used communicate with zookeeper
  
  This method creates a new handle and a zookeeper session that corresponds to that handle. Session
  establishment is asynchronous, meaning that the session should not be considered established until
  (and unless) an event of state ZOO_CONNECTED_STATE is received.

<comment>Param:</comment>
  <info>string  </info>  <strong>$host        </strong>  Comma separated host:port pairs, each corresponding to a zk server. e.g.
                           "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002"
  <info>callable</info>  <strong>$watcher_cb  </strong>  The global watcher callback function. When notifications are triggered
                           this function will be invoked.
  <info>int     </info>  <strong>$recv_timeout</strong>  The timeout for this session, only valid if the connections is currently
                           connected (ie. last watcher state is ZOO_CONNECTED_STATE).

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

<comment>See Also:</comment>
   * Zookeeper::__construct
   * <class>ZookeeperException</class>


id: Zookeeper::create
type: function
doc:
<comment>Description:</comment>
  Create a node synchronously
  
  This method will create a node in ZooKeeper. A node can only be created if it does not already
  exists. The Create Flags affect the creation of nodes. If ZOO_EPHEMERAL flag is set, the node will
  automatically get removed if the client session goes away. If the ZOO_SEQUENCE flag is set, a
  unique monotonically increasing sequence number is appended to the path name.

<comment>Param:</comment>
  <info>string</info>  <strong>$path </strong>  The name of the node. Expressed as a file name with slashes separating ancestors
                  of the node.
  <info>string</info>  <strong>$value</strong>  The data to be stored in the node.
  <info>array </info>  <strong>$acls </strong>  The initial ACL of the node. The ACL must not be null or empty.
  <info>int   </info>  <strong>$flags</strong>  this parameter can be set to 0 for normal create or an OR of the Create Flags

<comment>Return:</comment>
  <info>string</info>  Returns the path of the new node (this might be different than the supplied path because
          of the ZOO_SEQUENCE flag) on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::delete
   * Zookeeper::getChildren
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::delete
type: function
doc:
<comment>Description:</comment>
  Delete a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path   </strong>  The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int   </info>  <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.

<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>
   * Zookeeper::create
   * Zookeeper::getChildren
   * <class>ZookeeperException</class>


id: Zookeeper::exists
type: function
doc:
<comment>Description:</comment>
  Checks the existence of a node in zookeeper synchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$path      </strong>  The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  if nonzero, a watch will be set at the server to notify the client if the
                         node changes. The watch will be set even if the node does not

<comment>Return:</comment>
  <info>array</info>  Returns the value of stat for the path if the given node exists, otherwise false.

<comment>See Also:</comment>
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::get
type: function
doc:
<comment>Description:</comment>
  Gets the data associated with a node synchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$path      </strong>  The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array   </info>  <strong>$stat      </strong>  If not NULL, will hold the value of stat for the path on return.
  <info>int     </info>  <strong>$max_size  </strong>  Max size of the data. If 0 is used, this method will return the whole data.

<comment>Return:</comment>
  <info>string</info>  Returns the data on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::set
   * <class>ZookeeperException</class>


id: Zookeeper::getAcl
type: function
doc:
<comment>Description:</comment>
  Gets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The name of the node. Expressed as a file name with slashes separating ancestors of
                 the node.

<comment>Return:</comment>
  <info>array</info>  Return acl array on success and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::setAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::getChildren
type: function
doc:
<comment>Description:</comment>
  Lists the children of a node synchronously

<comment>Param:</comment>
  <info>string  </info>  <strong>$path      </strong>  The name of the node. Expressed as a file name with slashes separating
                         ancestors of the node.
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.

<comment>Return:</comment>
  <info>array</info>  Returns an array with children paths on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::create
   * Zookeeper::delete
   * <class>ZookeeperException</class>


id: Zookeeper::getClientId
type: function
doc:
<comment>Description:</comment>
  Return the client session id, only valid if the connections is currently connected (ie. last
  watcher
  state is ZOO_CONNECTED_STATE)

<comment>Return:</comment>
  <info>int</info>  Returns the client session id on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getState
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::getConfig
type: function
doc:
<comment>Description:</comment>
  Get instance of ZookeeperConfig

<comment>Return:</comment>
  <info>ZookeeperConfig</info>  Returns instance of ZookeeperConfig.

<comment>See Also:</comment>
   * <class>ZookeeperConfig</class>


id: Zookeeper::getRecvTimeout
type: function
doc:
<comment>Description:</comment>
  Return the timeout for this session, only valid if the connections is currently connected (ie.
  last
  watcher state is ZOO_CONNECTED_STATE). This value may change after a server re-connect

<comment>Return:</comment>
  <info>int</info>  Returns the timeout for this session on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::getState
type: function
doc:
<comment>Description:</comment>
  Get the state of the zookeeper connection

<comment>Return:</comment>
  <info>int</info>  Returns the state of zookeeper connection on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::isRecoverable
type: function
doc:
<comment>Description:</comment>
  Checks if the current zookeeper connection state can be recovered
  
  The application must close the handle and try to reconnect.

<comment>Return:</comment>
  <info>bool</info>  Returns true/false on success, and false on failure.

<comment>See Also:</comment>
   * Zookeeper::__construct
   * Zookeeper::connect
   * Zookeeper::getClientId
   * ZooKeeper States
   * <class>ZookeeperException</class>


id: Zookeeper::set
type: function
doc:
<comment>Description:</comment>
  Sets the data associated with a node

<comment>Param:</comment>
  <info>string</info>  <strong>$path   </strong>  The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>string</info>  <strong>$value  </strong>  The data to be stored in the node.
  <info>int   </info>  <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array </info>  <strong>$stat   </strong>  If not NULL, will hold the value of stat for the path on 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>
   * Zookeeper::create
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: Zookeeper::setAcl
type: function
doc:
<comment>Description:</comment>
  Sets the acl associated with a node synchronously

<comment>Param:</comment>
  <info>string</info>  <strong>$path   </strong>  The name of the node. Expressed as a file name with slashes separating ancestors
                    of the node.
  <info>int   </info>  <strong>$version</strong>  The expected version of the path.
  <info>array </info>  <strong>$acl    </strong>  The acl to be set on the path.

<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>
   * Zookeeper::create
   * Zookeeper::getAcl
   * ZooKeeper Permissions
   * <class>ZookeeperException</class>


id: Zookeeper::setDebugLevel
type: function
doc:
<comment>Description:</comment>
  Sets the debugging level for the library

<comment>Param:</comment>
  <info>int</info>  <strong>$logLevel</strong>  ZooKeeper log level 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>
   * ZooKeeper Log Levels
   * <class>ZookeeperException</class>


id: Zookeeper::setDeterministicConnOrder
type: function
doc:
<comment>Description:</comment>
  Enable/disable quorum endpoint order randomization
  
  If passed a true value, will make the client connect to quorum peers in the order as specified in
  the zookeeper_init() call. A false value causes zookeeper_init() to permute the peer endpoints
  which is good for more even client connection distribution among the quorum peers. ZooKeeper C
  Client uses false by default.

<comment>Param:</comment>
  <info>bool</info>  <strong>$yesOrNo</strong>  Disable/enable quorum endpoint order randomization.

<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>
   * Zookeeper::__construct
   * Zookeeper::connect
   * <class>ZookeeperException</class>


id: Zookeeper::setLogStream
type: function
doc:
<comment>Description:</comment>
  Sets the stream to be used by the library for logging
  
  The zookeeper library uses stderr as its default log stream. Application must make sure the stream
  is writable. Passing in NULL resets the stream to its default value (stderr).

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream to be used by the library for logging.

<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>
   * Zookeeper::setDebugLevel
   * <class>ZookeeperException</class>


id: Zookeeper::setWatcher
type: function
doc:
<comment>Description:</comment>
  Set a watcher function

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  A watch will be set at the server to notify the client if the node changes.

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

<comment>See Also:</comment>
   * Zookeeper::exists
   * Zookeeper::get
   * <class>ZookeeperException</class>


id: ZookeeperConfig::add
type: function
doc:
<comment>Description:</comment>
  Add servers to the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of servers to be added to the ensemble. Each has a
                    configuration line for a server to be added (as would appear in a configuration
                    file), only for maj. quorums.
  <info>int   </info>  <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array </info>  <strong>$stat   </strong>  If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::set
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::get
type: function
doc:
<comment>Description:</comment>
  Gets the last committed configuration of the ZooKeeper cluster as it is known to the server to
  which
  the client is connected, synchronously

<comment>Param:</comment>
  <info>callable</info>  <strong>$watcher_cb</strong>  If nonzero, a watch will be set at the server to notify the client if the
                         node changes.
  <info>array   </info>  <strong>$stat      </strong>  If not NULL, will hold the value of stat for the path on return.

<comment>Return:</comment>
  <info>string</info>  Returns the configuration string on success, and false on failure.

<comment>See Also:</comment>
   * ZookeeperConfig::set
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperConfig::remove
type: function
doc:
<comment>Description:</comment>
  Remove servers from the ensemble

<comment>Param:</comment>
  <info>string</info>  <strong>$id_list</strong>  Comma separated list of server IDs to be removed from the ensemble. Each has an
                    id of a server to be removed, only for maj. quorums.
  <info>int   </info>  <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array </info>  <strong>$stat   </strong>  If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::set
   * <class>ZookeeperException</class>


id: ZookeeperConfig::set
type: function
doc:
<comment>Description:</comment>
  Change ZK cluster ensemble membership and roles of ensemble peers

<comment>Param:</comment>
  <info>string</info>  <strong>$members</strong>  Comma separated list of new membership (e.g., contents of a membership
                    configuration file) - for use only with a non-incremental reconfiguration.
  <info>int   </info>  <strong>$version</strong>  The expected version of the node. The function will fail if the actual version
                    of the node does not match the expected version. If -1 is used the version check
                    will not take place.
  <info>array </info>  <strong>$stat   </strong>  If not NULL, will hold the value of stat for the path on return.

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

<comment>See Also:</comment>
   * ZookeeperConfig::get
   * ZookeeperConfig::add
   * ZookeeperConfig::remove
   * <class>ZookeeperException</class>


id: ZookeeperMarshallingException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (while marshalling or unmarshalling data) handling class.


id: ZookeeperNoNodeException
type: class
doc:
<comment>Description:</comment>
  The ZooKeeper exception (when node does not exist) handling class.


id: __CLASS__
type: constant
doc:
<comment>Description:</comment>
  Il nome della classe. Il nome della classe include il namespace in cui è stata dichiarata (es.
  <return>Foo\Bar</return>). Notare che da PHP 5.4 __CLASS__ funziona anche nei traits. Quando usata in un metodo
  trait, __CLASS__ è il nome della classe in cui il trait è usato.


id: __DIR__
type: constant
doc:
<comment>Description:</comment>
  La cartella del file.  Se utilizzato all'interno di un'inclusione, viene restituita la cartella
  del file incluso. Questo è equivalente a <return>dirname(__FILE__)</return>. Il nome della cartella non ha slash a
  meno che non sia la directory root.


id: __FILE__
type: constant
doc:
<comment>Description:</comment>
  Il percorso completo e il nome del file con i link simbolici risolti. Se utilizzato all'interno di
  un'inclusione, viene restituito il nome del file incluso.


id: __TRAIT__
type: constant
doc:
<comment>Description:</comment>
  Il nome del trait. Il nome del trait include il namespace in cui è stato dichiarato (es. <return>Foo\Bar</return>).


id: __autoload
type: function
doc:
<comment>Description:</comment>
  Attempt to load undefined class
  
  You can define this function to enable classes autoloading.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Name of the class to load

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

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


id: __halt_compiler
type: function
doc:
<comment>Description:</comment>
  Blocca l'esecuzione del compilatore.
    
  
  Blocca l'esecuzione del compilatore. Può essere utile per inserire dati negli script PHP, come i
  file di installazione.
  
  La posizione in byte iniziale dei dati può essere determinata dalla costante
  <info>__COMPILER_HALT_OFFSET__</info> che viene definita solo se è invocata la funzione <strong>__halt_compiler()</strong> nel
  file.

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


id: addcslashes
type: function
doc:
<comment>Description:</comment>
  Esegue il quoting di una stringa con gli slash nello stile del C
  
  La funzione restituisce una stringa con il carattere di backslash '\' anteposto ai caratteri che
  sono indicati nel parametro <strong>$charlist</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str     </strong>  La stringa su cui effettuare l'escape.
  <info>string</info>  <strong>$charlist</strong>  Una lista dei caratteri su cui effettuare l'escape. Se <strong>$charlist</strong> contiene i
                     caratteri <return>\n</return>, <return>\r</return> ecc., essi sono convertiti nello stile C-like, mentre gli
                     altri caratteri non alfanumerici con codici ASCII minori di 32 e maggiori di
                     126 sono convertiti nella rappresentazione ottale.
                     
                     Quando si definisce una sequenza di caratteri nel parametro charlist
                     assicurarsi di sapere quali caratteri sono presenti tra i caratteri che si sono
                     impostati come inizio e la fine dell'intervallo. ord()</strong> per trovare il valore
                     ASCII per un carattere.
                     ]]>
                     
                     Occorre prestare attenzione se si imposta di anteporre il carattere di escape
                     ai caratteri 0, a, b, f, n, r, t e v. Questi saranno convertiti in \0, \a, \b,
                     \f, \n, \r, \t e \v, i quali sono sequenze di escape predefinite in C. Molte di
                     queste sequenze sono anche definite in altri linguaggi derivati da C, incluso
                     PHP, il che significa che non si possono ottenere i risultati desiderati se si
                     usa l'output di <strong>addcslashes()</strong> per generare codice in questi linguaggi con
                     questi caratteri definiti in <strong>$charlist</strong>.

<comment>Return:</comment>
  <info>string</info>  Restituisce la stringa con l'escape.

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>


id: addslashes
type: function
doc:
<comment>Description:</comment>
  Esegue il quoting di una stringa con gli slash
  
  La funzione restituisce una stringa con il carattere backslash anteposto ai caratteri che
  richiedono l'escape. Questi caratteri sono: virgoletta singola (<return>'</return>)doppia virgoletta (<return>"</return>)backslash
  (<return>\</return>)NUL (il byte NUL)
  
  Un caso d'uso di <strong>addslashes()</strong> è fare l'escape dei suddetti caratteri in una stringa che deve
  essere eseguita come script da PHP:
  ]]>
  
  Prima di PHP 5.4.0, la direttiva PHP magic_quotes_gpc era <return>on</return> per impostazione predefinita ed
  essenzialmente eseguiva <strong>addslashes()</strong> su tutti i dati GET, POST e COOKIE. <strong>addslashes()</strong> non deve
  essere usato su stringhe su cui è già stato effettuato l'escape con magic_quotes_gpc, poiché sulle
  stringhe verrebbe fatto un doppio escape. <strong>get_magic_quotes_gpc()</strong> può essere usata per controllare
  se magic_quotes_gpc è <return>on</return>.
  
  A volte <strong>addslashes()</strong> è erroneamente utilizzato per provare a prevenire SQL Injection. Invece,
  dovrebbero essere usate funzioni di escape specifiche per il database e/o prepared statement.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  La stringa su cui fare l'escape.

<comment>Return:</comment>
  <info>string</info>  Restituisce la stringa trasformata dopo l'escape.

<comment>See Also:</comment>
   * <strong>stripcslashes()</strong>
   * <strong>stripslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>quotemeta()</strong>
   * <strong>get_magic_quotes_gpc()</strong>


id: apache_child_terminate
type: function
doc:
<comment>Description:</comment>
  Interrompe il processo apache dopo la presente richiesta
  
  <strong>apache_child_terminate()</strong> informa il processo Apache che sta eseguendo la richiesta PHP corrente di
  terminare quando l'esecuzione del codice PHP è stata completata. Può essere usata per
  interrompere un processo dopo che sia stato eseguito uno script con alta occupazione di memoria
  dal momento che la memoria viene normalmente liberata internamente ma non restituita  al sistema
  operativo.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se PHP è eseguito come modulo Apache 1, la versione di Apache non è
        multithread, e la direttiva PHP child_terminate è attivata (è disattivata di default). Se
        queste condizioni non sono raggiunte, viene restituito <info>false</info> e viene generato un errore di
        livello <info>E_WARNING</info>.

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


id: apache_get_modules
type: function
doc:
<comment>Description:</comment>
  Get a list of loaded Apache modules
  
  Get a list of loaded Apache modules.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of loaded Apache modules.


id: apache_get_version
type: function
doc:
<comment>Description:</comment>
  Fetch Apache version
  
  Fetch the Apache version.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the Apache version on success o <info>false</info> in caso di fallimento.

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


id: apache_getenv
type: function
doc:
<comment>Description:</comment>
  Get an Apache subprocess_env variable
  
  Retrieve an Apache environment variable specified by  <strong>$variable</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$variable   </strong>  The Apache environment variable
  <info>bool  </info>  <strong>$walk_to_top</strong>  Whether to get the top-level variable available to all Apache layers.

<comment>Return:</comment>
  <info>stringfalse</info>  The value of the Apache environment variable on success, or <info>false</info> on failure

<comment>See Also:</comment>
   * <strong>apache_setenv()</strong>
   * <strong>getenv()</strong>
   * Superglobals


id: apache_lookup_uri
type: function
doc:
<comment>Description:</comment>
  Esegue una richiesta parziale della URI specificata e restituisce
       tutte le informazioni


id: apache_request_headers
type: function
doc:
<comment>Description:</comment>
  Estrae tutti gli header della richiesta HTTP
  
  Estrae tutti gli header della richiesta HTTP. Funziona nei web server Apache, FastCGI, CLI, FPM e
  nel modulo server NSAPI in Netscape/iPlanet/SunONE.

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

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


id: apache_reset_timeout
type: function
doc:
<comment>Description:</comment>
  Reset the Apache write timer
  
  <strong>apache_reset_timeout()</strong> resets the Apache write timer, which defaults to 300 seconds. With
  <return>set_time_limit(0); ignore_user_abort(true)</return> and periodic <strong>apache_reset_timeout()</strong> calls, Apache can
  theoretically run forever.
  
  This function requires Apache 1.

<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>set_time_limit()</strong>
   * <strong>ignore_user_abort()</strong>


id: apache_response_headers
type: function
doc:
<comment>Description:</comment>
  Estrae tutti gli header della risposta HTTP
  
  Estrae tutti gli header della risposta HTTP.  Funziona nei web server Apache, FastCGI, CLI, FPM e
  nel modulo server NSAPI in Netscape/iPlanet/SunONE.

<comment>Return:</comment>
  <info>arrayfalse</info>  Un array di tutti gli header della risposta di Apache in caso di successo o <info>false</info> in
              caso di fallimento.

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


id: apcu_add
type: function
doc:
<comment>Description:</comment>
  Cache a new variable in the data store
    
  
  Caches a variable in the data store, only if it's not already stored.
  
  Unlike many other mechanisms in PHP, variables stored using <strong>apcu_add()</strong> will persist between
  requests (until the value is removed from the cache).

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  Store the variable using this name. <strong>$key</strong>s are cache-unique, so attempting to use
                   <strong>apcu_add()</strong> to store data with a key that already exists will not overwrite the
                   existing data, and will instead return <info>false</info>. (This is the only difference
                   between <strong>apcu_add()</strong> and <strong>apcu_store()</strong>.)
  <info>mixed </info>  <strong>$var   </strong>  The variable to store
  <info>int   </info>  <strong>$ttl   </strong>  Time To Live; store <strong>$var</strong> in the cache for <strong>$ttl</strong> seconds. After the <strong>$ttl</strong> has
                   passed, the stored variable will be expunged from the cache (on the next
                   request). If no <strong>$ttl</strong> is supplied (or if the <strong>$ttl</strong> is <return>0</return>), the value will persist
                   until it is removed from the cache manually, or otherwise fails to exist in the
                   cache (clear, restart, etc.).
  <info>array </info>  <strong>$values</strong>  Names in key, variables in value.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second
        syntax returns array with error keys.

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_cache_info
type: function
doc:
<comment>Description:</comment>
  Retrieves cached information from APCu's data store
    
  
  Retrieves cached information and meta-data from APC's data store.

<comment>Param:</comment>
  <info>bool</info>  <strong>$limited</strong>  If <strong>$limited</strong> is <info>true</info>, the return value will exclude the individual list of cache
                  entries.  This is useful when trying to optimize calls for statistics gathering.

<comment>Return:</comment>
  <info>arrayfalse</info>  Array of cached data (and meta-data) o <info>false</info> in caso di fallimento
              
              <strong>apcu_cache_info()</strong> will raise a warning if it is unable to retrieve APC cache data.
              This typically occurs when APC is not enabled.

<comment>See Also:</comment>
   * APCu configuration directives
   * APCUIterator::getTotalSize
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalCount


id: apcu_cas
type: function
doc:
<comment>Description:</comment>
  Updates an old value with a new value
  
  <strong>apcu_cas()</strong> updates an already existing integer value if the  <strong>$old</strong> parameter matches the currently
  stored value  with the value of the <strong>$new</strong> parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the value being updated.
  <info>int   </info>  <strong>$old</strong>  The old value (the value currently stored).
  <info>int   </info>  <strong>$new</strong>  The new value to update 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>
   * <strong>apcu_dec()</strong>
   * <strong>apcu_store()</strong>


id: apcu_clear_cache
type: function
doc:
<comment>Description:</comment>
  Clears the APCu cache
    
  
  Clears the cache.

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

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


id: apcu_dec
type: function
doc:
<comment>Description:</comment>
  Decrease a stored number
  
  Decreases a stored integer value.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The key of the value being decreased.
  <info>int   </info>  <strong>$step   </strong>  The step, or value to decrease.
  <info>bool  </info>  <strong>$success</strong>  Optionally pass the success or fail boolean value to this referenced variable.
  <info>int   </info>  <strong>$ttl    </strong>  TTL to use if the operation inserts a new value (rather than decrementing an
                    existing one).

<comment>Return:</comment>
  <info>intfalse</info>  Returns the current value of <strong>$key</strong>'s value on success, o <info>false</info> in caso di fallimento

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


id: apcu_delete
type: function
doc:
<comment>Description:</comment>
  Removes a stored variable from the cache
    
  
  Removes a stored variable from the cache.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  A <strong>$key</strong> used to store the value as a <info>string</info> for a single key, or as an <info>array</info> of
               strings for several keys, or as an <class>APCUIterator</class> <info>object</info>.

<comment>Return:</comment>
  <info>mixed</info>  If <strong>$key</strong> is an <info>array</info>, an indexed <info>array</info> of the keys is returned. Otherwise <info>true</info> is returned
         on success, or <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_clear_cache()</strong>
   * <class>APCUIterator</class>


id: apcu_enabled
type: function
doc:
<comment>Description:</comment>
  Whether APCu is usable in the current environment
  
  Returns whether APCu is usable in the current environment.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when APCu is usable in the current environment, <info>false</info> otherwise.


id: apcu_entry
type: function
doc:
<comment>Description:</comment>
  Atomically fetch or generate a cache entry
    
  
  Atomically attempts to find <strong>$key</strong> in the cache, if it cannot be found <strong>$generator</strong> is called, passing
  <strong>$key</strong> as the only argument. The return value of the call is then cached with the optionally
  specified <strong>$ttl</strong>, and returned.
  
  When control enters <strong>apcu_entry()</strong> the lock for the cache is acquired exclusively, it is released
  when control leaves <strong>apcu_entry()</strong>:  In effect, this turns the body of <strong>$generator</strong> into a critical
  section, disallowing two processes from executing the same code paths concurrently. In addition,
  it prohibits the concurrent execution of any other APCu functions, since they will acquire the
  same lock.
  
  The only APCu function that can be called safely by <strong>$generator</strong> is <strong>apcu_entry()</strong>.

<comment>Param:</comment>
  <info>string  </info>  <strong>$key      </strong>  Identity of cache entry
  <info>callable</info>  <strong>$generator</strong>  A callable that accepts <strong>$key</strong> as the only argument and returns the value to
                        cache.
  <info>int     </info>  <strong>$ttl      </strong>  Time To Live; store <strong>$var</strong> in the cache for <strong>$ttl</strong> seconds. After the <strong>$ttl</strong> has
                        passed, the stored variable will be expunged from the cache (on the next
                        request). If no <strong>$ttl</strong> is supplied (or if the <strong>$ttl</strong> is <return>0</return>), the value will
                        persist until it is removed from the cache manually, or otherwise fails to
                        exist in the cache (clear, restart, etc.).

<comment>Return:</comment>
  <info>mixed</info>  Returns the cached value

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_exists
type: function
doc:
<comment>Description:</comment>
  Checks if entry exists
  
  Checks if one or more APCu entries exist.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$keys</strong>  A <info>string</info>, or an <info>array</info> of strings, that contain keys.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> if the key exists, otherwise <info>false</info> Or if an <info>array</info> was passed to <strong>$keys</strong>, then an
         array is returned that contains all existing keys, or an empty array if none exist.

<comment>See Also:</comment>
   * <strong>apcu_cache_info()</strong>
   * <strong>apcu_fetch()</strong>


id: apcu_fetch
type: function
doc:
<comment>Description:</comment>
  Fetch a stored variable from the cache
    
  
  Fetches an entry from the cache.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key    </strong>  The <strong>$key</strong> used to store the value (with <strong>apcu_store()</strong>). If an array is passed then
                   each element is fetched and returned.
  <info>bool </info>  <strong>$success</strong>  Set to <info>true</info> in success and <info>false</info> in failure.

<comment>Return:</comment>
  <info>mixed</info>  The stored variable or array of variables on success; <info>false</info> on failure

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_delete()</strong>
   * <class>APCUIterator</class>


id: apcu_inc
type: function
doc:
<comment>Description:</comment>
  Increase a stored number
  
  Increases a stored number.

<comment>Param:</comment>
  <info>string</info>  <strong>$key    </strong>  The key of the value being increased.
  <info>int   </info>  <strong>$step   </strong>  The step, or value to increase.
  <info>bool  </info>  <strong>$success</strong>  Optionally pass the success or fail boolean value to this referenced variable.
  <info>int   </info>  <strong>$ttl    </strong>  TTL to use if the operation inserts a new value (rather than incrementing an
                    existing one).

<comment>Return:</comment>
  <info>intfalse</info>  Returns the current value of <strong>$key</strong>'s value on success, o <info>false</info> in caso di fallimento

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


id: apcu_key_info
type: function
doc:
<comment>Description:</comment>
  Get detailed information about the cache key
    
  
  Get detailed information about the cache key

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Get detailed information about the cache key

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

<comment>See Also:</comment>
   * <strong>apcu_store()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: apcu_sma_info
type: function
doc:
<comment>Description:</comment>
  Retrieves APCu Shared Memory Allocation information
    
  
  Retrieves APCu Shared Memory Allocation information.

<comment>Param:</comment>
  <info>bool</info>  <strong>$limited</strong>  When set to <info>false</info> (default) <strong>apcu_sma_info()</strong> will return a detailed information
                  about each segment.

<comment>Return:</comment>
  <info>array</info>  Array of Shared Memory Allocation data; <info>false</info> on failure.

<comment>See Also:</comment>
   * APCu configuration directives


id: apcu_store
type: function
doc:
<comment>Description:</comment>
  Cache a variable in the data store
    
  
  Cache a variable in the data store.
  
  Unlike many other mechanisms in PHP, variables stored using <strong>apcu_store()</strong> will persist between
  requests (until the value is removed from the cache).

<comment>Param:</comment>
  <info>string</info>  <strong>$key   </strong>  Store the variable using this name. <strong>$key</strong>s are cache-unique, so storing a second
                   value with the same <strong>$key</strong> will overwrite the original value.
  <info>mixed </info>  <strong>$var   </strong>  The variable to store
  <info>int   </info>  <strong>$ttl   </strong>  Time To Live; store <strong>$var</strong> in the cache for <strong>$ttl</strong> seconds. After the <strong>$ttl</strong> has
                   passed, the stored variable will be expunged from the cache (on the next
                   request). If no <strong>$ttl</strong> is supplied (or if the <strong>$ttl</strong> is <return>0</return>), the value will persist
                   until it is removed from the cache manually, or otherwise fails to exist in the
                   cache (clear, restart, etc.).
  <info>array </info>  <strong>$values</strong>  Names in key, variables in value.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento. Second syntax returns
        array with error keys.

<comment>See Also:</comment>
   * <strong>apcu_add()</strong>
   * <strong>apcu_fetch()</strong>
   * <strong>apcu_delete()</strong>


id: array_change_key_case
type: function
doc:
<comment>Description:</comment>
  Restituisce un array con tutte le chiavi cambiate in maiuscolo o in minuscolo
  
  Restituisce un array con tutte le chiavi in <strong>$input</strong> cambiate in maiuscolo o minuscolo. Gli indici
  numerati non sono modificati.

<comment>Param:</comment>
  <info>array</info>  <strong>$input</strong>  L'array su cui lavorare
  <info>int  </info>  <strong>$case </strong>  <info>CASE_UPPER</info> oppure <info>CASE_LOWER</info> (default)

<comment>Return:</comment>
  <info>array</info>  Restituisce un array con le chiavi convertite in maiuscolo o minuscolo, oppure <info>false</info> se
         <strong>$input</strong> non è un array.


id: array_chunk
type: function
doc:
<comment>Description:</comment>
  Spezza un array in tronconi
  
  Spezza l'array in più array di dimensione <strong>$size</strong>. L'ultimo array potrebbe ovviamente avere una
  dimensione inferiore.

<comment>Param:</comment>
  <info>array</info>  <strong>$input        </strong>  L'array su cui lavorare
  <info>int  </info>  <strong>$size         </strong>  La dimensione di ogni pezzo
  <info>bool </info>  <strong>$preserve_keys</strong>  Quando è <info>true</info> le chiavi sono mantenute. Il default è <info>false</info> che reindicizza
                         le chiavi con valori numerici

<comment>Return:</comment>
  <info>array</info>  Restituisce un array multidimensionale indicizzato numericamente, a partire da zero, con
         ogni dimensione contenente <strong>$size</strong> elementi.

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


id: array_column
type: function
doc:
<comment>Description:</comment>
  Return the values from a single column in the input array
  
  <strong>array_column()</strong> returns the values from a single column of the <strong>$array</strong>, identified by the
  <strong>$column_key</strong>. Optionally, an <strong>$index_key</strong> may be provided to index the values in the returned array
  by the values from the <strong>$index_key</strong> column of the input array.

<comment>Param:</comment>
  <info>array        </info>  <strong>$array     </strong>  A multi-dimensional array or an array of objects from which to pull a
                              column of values from. If an array of objects is provided, then public
                              properties can be directly pulled. In order for protected or private
                              properties to be pulled, the class must implement both the <strong>__get()</strong> and
                              <strong>__isset()</strong> magic methods.
  <info>intstringnull</info>  <strong>$column_key</strong>  The column of values to return. This value may be an integer key of
                              the column you wish to retrieve, or it may be a string key name for an
                              associative array or property name. It may also be <info>null</info> to return
                              complete arrays or objects (this is useful together with <strong>$index_key</strong> to
                              reindex the array).
  <info>intstringnull</info>  <strong>$index_key </strong>  The column to use as the index/keys for the returned array. This value
                              may be the integer key of the column, or it may be the string key
                              name. The value is cast as usual for array keys (however, objects
                              supporting conversion to string are also allowed).

<comment>Return:</comment>
  <info>array</info>  Returns an array of values representing a single column from the input array.

<comment>See Also:</comment>
   * Recommended
     userland implementation for PHP lower than 5.5


id: array_combine
type: function
doc:
<comment>Description:</comment>
  Crea un'array utilizzando un'array per le chiavi ed un altro per i suoi valori
  
  Crea un <info>array</info> utilizzando i valori dall'array <strong>$keys</strong> per le chiavi e i valori dall'array <strong>$values</strong>
  per i valori corrispondenti.

<comment>Param:</comment>
  <info>array</info>  <strong>$keys  </strong>  Un array di chiavi da utilizzare. Valori illegali per le chiavi saranno convertiti
                  in <info>string</info>.
  <info>array</info>  <strong>$values</strong>  Un <info>Array</info> di valori da utilizzare

<comment>Return:</comment>
  <info>array</info>  Restituisce l'<info>array</info> combinato, <info>false</info> se il numero degli elementi per ogni array non è
         uguale.

<comment>See Also:</comment>
   * <strong>array_merge()</strong>
   * <strong>array_walk()</strong>
   * <strong>array_values()</strong>


id: array_diff_assoc
type: function
doc:
<comment>Description:</comment>
  Calcola la differenza tra due o più array con un ulteriore controllo sull'indice


id: array_diff_key
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays using keys for comparison
  
  Compares the keys from <strong>$array</strong> against the keys from <strong>$arrays</strong> and returns the difference. This
  function is like <strong>array_diff()</strong> except the comparison is done on the keys instead of the values.

<comment>Param:</comment>
  <info>array</info>  <strong>$array </strong>  The array to compare from
  <info>array</info>  <strong>$arrays</strong>  Arrays to compare against

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all the entries from <strong>$array</strong> whose keys are absent from all of
         the other arrays.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_diff_uassoc
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays with additional index check which is performed by a user
  supplied
  callback function
  
  Compares <strong>$array</strong> against <strong>$arrays</strong> and returns the difference. Unlike <strong>array_diff()</strong> the array keys are
  used in the comparison.
  
  Unlike <strong>array_diff_assoc()</strong> a user supplied callback function is used for the indices comparison,
  not internal function.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array           </strong>  The array to compare from
  <info>array   </info>  <strong>$arrays          </strong>  Arrays to compare against
  <info>callable</info>  <strong>$key_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                               maggiore di zero se il primo argomento è considerato essere minore,
                               uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all the entries from <strong>$array</strong> that are not present in any of the
         other arrays.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_diff_ukey
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays using a callback function on the keys for comparison
  
  Compares the keys from <strong>$array</strong> against the keys from <strong>$arrays</strong> and returns the difference. This
  function is like <strong>array_diff()</strong> except the comparison is done on the keys instead of the values.
  
  Unlike <strong>array_diff_key()</strong> a user supplied callback function is used for the indices comparison, not
  internal function.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array           </strong>  The array to compare from
  <info>array   </info>  <strong>$arrays          </strong>  Arrays to compare against
  <info>callable</info>  <strong>$key_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                               maggiore di zero se il primo argomento è considerato essere minore,
                               uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all the entries from <strong>$array</strong> that are not present in any of the
         other arrays.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_fill_keys
type: function
doc:
<comment>Description:</comment>
  Fill an array with values, specifying keys
  
  Fills an array with the value of the <strong>$value</strong> parameter, using the values of the <strong>$keys</strong> array as
  keys.

<comment>Param:</comment>
  <info>array</info>  <strong>$keys </strong>  Array of values that will be used as keys. Illegal values for key will be converted
                 to <info>string</info>.
  <info>mixed</info>  <strong>$value</strong>  Value to use for filling

<comment>Return:</comment>
  <info>array</info>  Returns the filled array

<comment>See Also:</comment>
   * <strong>array_fill()</strong>
   * <strong>array_combine()</strong>


id: array_intersect_assoc
type: function
doc:
<comment>Description:</comment>
  Calcola l'intersezione degli array con un ulteriore controllo sugli indici


id: array_intersect_key
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays using keys for comparison
  
  <strong>array_intersect_key()</strong> returns an array containing all the entries of <strong>$array</strong> which have keys that
  are present in all the arguments.

<comment>Param:</comment>
  <info>array</info>  <strong>$array </strong>  The array with master keys to check.
  <info>array</info>  <strong>$arrays</strong>  Arrays to compare keys against.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array containing all the entries of  <strong>$array</strong> which have keys that are
         present in all arguments.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_intersect_uassoc
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays with additional index check, compares indexes by a callback
  function
  
  <strong>array_intersect_uassoc()</strong> returns an array containing all the values of <strong>$array</strong> that are present in
  all the arguments. Note that the keys are used in the comparison unlike in <strong>array_intersect()</strong>.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array           </strong>  Initial array for comparison of the arrays.
  <info>array   </info>  <strong>$arrays          </strong>  Arrays to compare keys against.
  <info>callable</info>  <strong>$key_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                               maggiore di zero se il primo argomento è considerato essere minore,
                               uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns the values of <strong>$array</strong> whose values exist in all of the arguments.

<comment>See Also:</comment>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>
   * <strong>array_intersect_ukey()</strong>


id: array_intersect_ukey
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays using a callback function on the keys for comparison
  
  <strong>array_intersect_ukey()</strong> returns an array containing all the values of <strong>$array</strong> which have matching
  keys that are present in all the arguments.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array           </strong>  Initial array for comparison of the arrays.
  <info>array   </info>  <strong>$arrays          </strong>  Arrays to compare keys against.
  <info>callable</info>  <strong>$key_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                               maggiore di zero se il primo argomento è considerato essere minore,
                               uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns the values of <strong>$array</strong> whose keys exist in all the arguments.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_diff_key()</strong>
   * <strong>array_diff_ukey()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_intersect_key()</strong>


id: array_key_first
type: function
doc:
<comment>Description:</comment>
  Gets the first key of an array
  
  Get the first key of the given <strong>$array</strong> without affecting the internal array pointer.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  An array.

<comment>Return:</comment>
  <info>intstringnull</info>  Returns the first key of <strong>$array</strong> if the array is not empty; <info>null</info> otherwise.

<comment>See Also:</comment>
   * <strong>array_key_last()</strong>
   * <strong>reset()</strong>


id: array_key_last
type: function
doc:
<comment>Description:</comment>
  Gets the last key of an array
  
  Get the last key of the given <strong>$array</strong> without affecting the internal array pointer.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  An array.

<comment>Return:</comment>
  <info>intstringnull</info>  Returns the last key of <strong>$array</strong> if the array is not empty; <info>null</info> otherwise.

<comment>See Also:</comment>
   * <strong>array_key_first()</strong>
   * <strong>end()</strong>


id: array_map
type: function
doc:
<comment>Description:</comment>
  Applica la funzione callback a tutti gli elementi degli array dati
  
  <strong>array_map()</strong> restituisce un <info>array</info> contenente i risultati dell'applicazione della <strong>$callback</strong>
  all'indice corrispondente di <strong>$array1</strong> (e <strong>$...</strong> se vengono forniti più array) usati come argomenti
  per la callback. Il numero di parametri che la funzione <strong>$callback</strong> accetta dovrebbe corrispondere
  al numero di array passati ad <strong>array_map()</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Una <info>callable</info> da eseguire per ogni elemento in ogni array.
                       
                       <info>null</info> può essere passato come valore alla <strong>$callback</strong> per eseguire un'operazione
                       zip su più array. Se viene fornito solo <strong>$array1</strong>, array_map restituirà l'array
                       di input.
  <info>array   </info>  <strong>$array1  </strong>  Un array su cui eseguire la funzione <strong>$callback</strong>.
  <info>array   </info>  <strong>$...     </strong>  Lista di variabili supplementari di argomenti di array da eseguire nella
                       funzione <strong>$callback</strong>.

<comment>Return:</comment>
  <info>array</info>  Restituisce un array contenente i risultati dell'applicazione della funzione <strong>$callback</strong>
         all'indice corrispondente di <strong>$array1</strong> (e <strong>$...</strong> se vengono forniti più array) usati come
         argomenti per la callback.
         
         L'array restituito conserverà le chiavi del parametro array se e solo se viene passato
         esattamente un array. Se viene passato più di un array, l'array restituito avrà chiavi
         intere sequenziali.

<comment>See Also:</comment>
   * <strong>array_filter()</strong>
   * <strong>array_reduce()</strong>
   * <strong>array_walk()</strong>


id: array_merge_recursive
type: function
doc:
<comment>Description:</comment>
  Fonde due o più array in modo ricorsivo
  
  <strong>Array_merge_recursive()</strong> fonde gli elementi di uno o più array in modo tale che i valori di un
  array siano accodati all'array precedente.  Restituisce l'array risultante.
  
  Se gli array in input hanno le stesse chiavi stringa, i valori di queste chiavi vengono fusi in un
  array, e questo è fatto in modo ricorsivo, cioè se uno dei valori è un array, la funzione lo
  fonderà con una voce corrispondente in un altro array Comunque, se gli array hanno la stessa
  chiave numerica, l'ultimo valore non sovrascriverà il valore originale, bensì verrà accodato.

<comment>Param:</comment>
  <info>array</info>  <strong>$array1</strong>  Array iniziale da fondere.
  <info>array</info>  <strong>$...   </strong>  Lista variabile di array da fondere ricorsivamente.

<comment>Return:</comment>
  <info>array</info>  Un array di valori risultante dalla fusione degli argomenti.

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


id: array_multisort
type: function
doc:
<comment>Description:</comment>
  Ordina array multipli o multidimensionali
  
  <strong>Array_multisort()</strong> Può essere usata per ordinare parecchi array allo stesso tempo, oppure un array
  multidimensionale, rispetto a una o più dimensioni.
  
  Mantiene le chiavi associative (tipo <info>string</info>), mentre le chiavi numeriche vengono reindicizzate.

<comment>Param:</comment>
  <info>array</info>  <strong>$array1           </strong>  L'<info>array</info> da ordinare.
  <info>mixed</info>  <strong>$array1_sort_order</strong>  L'ordinamento da applicare al precedente argomento <info>array</info>. Può essere
                             <info>SORT_ASC</info> per un ordinamento crescente o <info>SORT_DESC</info> per un ordinamento
                             decrescente.
                             
                             Questo argomento può essere scambiato con <strong>$array1_sort_flags</strong> o
                             completamente omesso, nel qual caso si usa per default <info>SORT_ASC</info>.
  <info>mixed</info>  <strong>$array1_sort_flags</strong>  Opzioni di ordinamento per il precedente argomento <info>array</info>:
                             
                             Flag di tipo: <info>SORT_REGULAR</info> - confronta gli elementi in modo normale
                             (non cambiare il tipo)<info>SORT_NUMERIC</info> - confronta gli elementi
                             numericamente<info>SORT_STRING</info> - confronta gli elementi come
                             stringhe<info>SORT_LOCALE_STRING</info> - confronta gli elementi come stringhe,
                             basandosi sull'attuale impostazione di localizzazione. Usa la
                             localizzazione, che può essere cambiata con <strong>setlocale()</strong> <info>SORT_NATURAL</info> -
                             confronta gli elementi come stringhe usando l'"ordinamento naturale"
                             come <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> - può essere combinato (OR binario) con
                             <info>SORT_STRING</info> o <info>SORT_NATURAL</info> per ordinare le stringhe senza tener conte
                             delle maiuscole/minuscole
                             
                             <info>SORT_REGULAR</info> - confronta gli elementi in modo normale (non cambiare il
                             tipo)
                             
                             <info>SORT_NUMERIC</info> - confronta gli elementi numericamente
                             
                             <info>SORT_STRING</info> - confronta gli elementi come stringhe
                             
                             <info>SORT_LOCALE_STRING</info> - confronta gli elementi come stringhe, basandosi
                             sull'attuale impostazione di localizzazione. Usa la localizzazione, che
                             può essere cambiata con <strong>setlocale()</strong>
                             
                             <info>SORT_NATURAL</info> - confronta gli elementi come stringhe usando
                             l'"ordinamento naturale" come <strong>natsort()</strong>
                             
                             <info>SORT_FLAG_CASE</info> - può essere combinato (OR binario) con <info>SORT_STRING</info> o
                             <info>SORT_NATURAL</info> per ordinare le stringhe senza tener conte delle
                             maiuscole/minuscole
                             
                             Questo argomento può essere scambiato con <strong>$array1_sort_order</strong> o
                             completamente omesso, nel qual caso si usa per default <info>SORT_REGULAR</info>.
  <info>mixed</info>  <strong>$...              </strong>  Altri array, opzionalmente seguiti da opzioni di ordinamento e flag di
                             tipo.

<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>usort()</strong>
   * The confronto delle funzioni di ordinamento degli array


id: array_product
type: function
doc:
<comment>Description:</comment>
  Calculate the product of values in an array
  
  <strong>array_product()</strong> returns the product of values in an array.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  The array.

<comment>Return:</comment>
  <info>intfloat</info>  Returns the product as an integer or float.


id: array_reduce
type: function
doc:
<comment>Description:</comment>
  Riduce iterativamente l'array a un singolo valore utilizzando una funzione
       callback


id: array_replace
type: function
doc:
<comment>Description:</comment>
  Replaces elements from passed arrays into the first array
  
  <strong>array_replace()</strong> replaces the values of <strong>$array</strong> with values having the same keys in each of the
  following arrays. If a key from the first array exists in the second array, its value will be
  replaced by the value from the second array. If the key exists in the second array, and not the
  first, it will be created in the first array. If a key only exists in the first array, it will be
  left as is. If several arrays are passed for replacement, they will be processed in order, the
  later arrays overwriting the previous values.
  
  <strong>array_replace()</strong> is not recursive : it will replace values in the first array by whatever type is
  in the second array.

<comment>Param:</comment>
  <info>array</info>  <strong>$array       </strong>  The array in which elements are replaced.
  <info>array</info>  <strong>$replacements</strong>  Arrays from which elements will be extracted. Values from later arrays
                        overwrite the previous values.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info>, or <info>null</info> if an error occurs.

<comment>See Also:</comment>
   * <strong>array_replace_recursive()</strong>
   * <strong>array_merge()</strong>


id: array_replace_recursive
type: function
doc:
<comment>Description:</comment>
  Replaces elements from passed arrays into the first array recursively
  
  <strong>array_replace_recursive()</strong> replaces the values of <strong>$array</strong> with the same values from all the
  following arrays. If a key from the first array exists in the second array, its value will be
  replaced by the value from the second array. If the key exists in the second array, and not the
  first, it will be created in the first array. If a key only exists in the first array, it will be
  left as is.  If several arrays are passed for replacement, they will be processed in order, the
  later array overwriting the previous values.
  
  <strong>array_replace_recursive()</strong> is recursive : it will recurse into arrays and apply the same process to
  the inner value.
  
  When the value in the first array is scalar, it will be replaced by the value in the second array,
  may it be scalar or array. When the value in the first array and the second array are both arrays,
  <strong>array_replace_recursive()</strong> will replace their respective value recursively.

<comment>Param:</comment>
  <info>array</info>  <strong>$array       </strong>  The array in which elements are replaced.
  <info>array</info>  <strong>$replacements</strong>  Arrays from which elements will be extracted.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info>, or <info>null</info> if an error occurs.

<comment>See Also:</comment>
   * <strong>array_replace()</strong>
   * <strong>array_merge_recursive()</strong>


id: array_search
type: function
doc:
<comment>Description:</comment>
  Ricerca un dato valore in un array e ne restituisce la 
       chiave corrispondente, se la ricerca ha successo.


id: array_splice
type: function
doc:
<comment>Description:</comment>
  Rimuove una porzione dell'array e la sostituisce con
       altro


id: array_udiff
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays by using a callback function for data comparison
  
  Computes the difference of arrays by using a callback function for data comparison. This is unlike
  <strong>array_diff()</strong> which uses an internal function for comparing the data.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array             </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Arrays to compare against.
  <info>callable</info>  <strong>$value_compare_func</strong>  The callback comparison function.
                                 
                                 La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the values of <strong>$array</strong> that are not present in any of the
         other arguments.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_udiff_assoc
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays with additional index check, compares data by a callback
  function
  
  Computes the difference of arrays with additional index check, compares data by a callback
  function.
  
  Please note that this function only checks one dimension of a n-dimensional array. Of course you
  can check deeper dimensions by using, for example, <return>array_udiff_assoc($array1[0], $array2[0],
  "some_comparison_func");</return>.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array             </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Arrays to compare against.
  <info>callable</info>  <strong>$value_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  <strong>array_udiff_assoc()</strong> returns an <info>array</info> containing all the values from <strong>$array</strong> that are not
         present in any of the other arguments. Note that the keys are used in the comparison unlike
         <strong>array_diff()</strong> and <strong>array_udiff()</strong>. The comparison of arrays' data is performed by using an
         user-supplied callback. In this aspect the behaviour is opposite to the behaviour of
         <strong>array_diff_assoc()</strong> which uses internal function for comparison.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_diff_uassoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_uassoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_udiff_uassoc
type: function
doc:
<comment>Description:</comment>
  Computes the difference of arrays with additional index check, compares data and indexes by a
  callback function
  
  Computes the difference of arrays with additional index check, compares data and indexes by a
  callback function.
  
  Note that the keys are used in the comparison unlike <strong>array_diff()</strong> and <strong>array_udiff()</strong>.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array             </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Arrays to compare against.
  <info>callable</info>  <strong>$value_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.
  <info>callable</info>  <strong>$key_compare_func  </strong>  The comparison of keys (indices) is done also by the callback
                                 function <strong>$key_compare_func</strong>. This behaviour is unlike what
                                 <strong>array_udiff_assoc()</strong> does, since the latter compares the indices by
                                 using an internal function.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all the values from <strong>$array</strong> that are not present in any of the
         other arguments.

<comment>See Also:</comment>
   * <strong>array_diff()</strong>
   * <strong>array_diff_assoc()</strong>
   * <strong>array_udiff()</strong>
   * <strong>array_udiff_assoc()</strong>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays, compares data by a callback function
  
  Computes the intersection of arrays, compares data by a callback function.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array             </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Arrays to compare against.
  <info>callable</info>  <strong>$value_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the values of <strong>$array</strong> that are present in all the arguments.

<comment>See Also:</comment>
   * <strong>array_intersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_uintersect_assoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect_assoc
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays with additional index check, compares data by a callback
  function
  
  Computes the intersection of arrays with additional index check, compares data by a callback
  function.
  
  Note that the keys are used in the comparison unlike in <strong>array_uintersect()</strong>. The data is compared
  by using a callback function.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array             </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Arrays to compare against.
  <info>callable</info>  <strong>$value_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the values of <strong>$array</strong> that are present in all the arguments.

<comment>See Also:</comment>
   * <strong>array_uintersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_uintersect_uassoc()</strong>


id: array_uintersect_uassoc
type: function
doc:
<comment>Description:</comment>
  Computes the intersection of arrays with additional index check, compares data and indexes by
  separate callback functions
  
  Computes the intersection of arrays with additional index check, compares data and indexes by
  separate callback functions.

<comment>Param:</comment>
  <info>array   </info>  <strong>$array1            </strong>  The first array.
  <info>array   </info>  <strong>$arrays            </strong>  Further arrays.
  <info>callable</info>  <strong>$value_compare_func</strong>  La funzione di confronto deve restituire un intero minore, uguale o
                                 maggiore di zero se il primo argomento è considerato essere minore,
                                 uguale o maggiore del secondo.
  <info>callable</info>  <strong>$key_compare_func  </strong>  Key comparison callback function.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the values of <strong>$array1</strong> that are present in all the
         arguments.

<comment>See Also:</comment>
   * <strong>array_uintersect()</strong>
   * <strong>array_intersect_assoc()</strong>
   * <strong>array_intersect_uassoc()</strong>
   * <strong>array_uintersect_assoc()</strong>


id: array_walk_recursive
type: function
doc:
<comment>Description:</comment>
  Apply a user function recursively to every member of an array
  
  Applies the user-defined <strong>$callback</strong> function to each element of the <strong>$array</strong>. This function will
  recurse into deeper arrays.

<comment>Param:</comment>
  <info>arrayobject</info>  <strong>$array   </strong>  The input array.
  <info>callable   </info>  <strong>$callback</strong>  Typically, <strong>$callback</strong> takes on two parameters. The <strong>$array</strong> parameter's value
                          being the first, and the key/index second.
                          
                          If <strong>$callback</strong> needs to be working with the actual values of the array,
                          specify the first parameter of <strong>$callback</strong> as a reference. Then, any changes
                          made to those elements will be made in the original array itself.
  <info>mixed      </info>  <strong>$userdata</strong>  If the optional <strong>$userdata</strong> parameter is supplied, it will be passed as the
                          third parameter to the <strong>$callback</strong>.

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

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


id: arsort
type: function
doc:
<comment>Description:</comment>
  Ordina un array in ordine decrescente e mantiene le associazioni degli indici


id: assert
type: function
doc:
<comment>Description:</comment>
  Verifica se un'asserzione è false
  
  PHP 5
  
  PHP 7
  
  <strong>assert()</strong> verifica l' <strong>$assertion</strong> data e prende gli opportuni provvedimenti se il suo risultato è
  <info>false</info>.
  
  Se il parametro <strong>$assertion</strong> è una stringa, verrà valutata come codice PHP da <strong>assert()</strong>. I vantaggi
  di usare le stringhe con <strong>$assertion</strong> sono meno overhead nella verifica e la visualizzazione dei
  messaggi che contengono <strong>$assertion</strong> quando questa fallisce. Ciò significa che se si passa una
  condizione booleana come <strong>$assertion</strong>, questa condizione non sarà mostrata come parametro della
  funzione di asserzione che può essere definita con la funzione <strong>assert_options()</strong>, la condizione è
  convertita in una stringa prima di chiamare la funzione handler, e il valore booleano <info>false</info> viene
  convertito in una stringa vuota.
  
  Le asserzioni dovrebbero essere utilizzate solo per il debug. Si possono usare per controlli di
  coerenza che testano per condizioni che dovrebbero essere sempre <info>true</info> e che, in caso contrario,
  indichino errori di programmazione, oppure per verificare la presenza o meno di certe
  caratteristiche, tipo le estensioni, oppure certi limiti di sistema o caratteristiche.
  
  Le asserzioni non dovrebbero essere utilizzate per le normali operazioni di runtime quali il
  controllo dei parametri di input. Come regola si deve avere che il programma debba funzionare
  correttamente anche disabilitando le regole di  asserzione.
  
  Il comportamento di <strong>assert()</strong> può essere impostato tramite <strong>assert_options()</strong> oppure tramite
  .ini-settings come descritto nelle pagine del manuale relative a quelle funzioni.
  
  La funzione <strong>assert_options()</strong> e/o il parametro <info>ASSERT_CALLBACK</info> permettono/e di attivare una
  funzione di callback per gestire una asserzione fallita.
  
  Le callback di <strong>assert()</strong> sono particolarmente utili per costruire suite di test poiché permettono
  di catturare facilmente il codice passato all'assert, oltre alle informazioni su dove l'assert è
  scattato. Sebbene quest'ultime informazioni siano rilevabili anche con altri metodi, l'uso delle
  asserzione rende il tutto molto più veloce e semplice!
  
  Le funzioni di callback devono accettare tre parametri. Il primo conterrà il nome del file in cui
  si trova l'asserzione fallita. Il secondo parametro conterrà il numero di linea dell'asserzione
  fallita, ed il terzo parametro conterrà l'espressione dell'asserzione fallita (se qualsiasi —
  valore letterale come 1 o "due" non verrà passato con questo parametro). Gli utenti di PHP 5.4.8 e
  successivi possono anche fornire un quarto parametro opzionale, che conterrà la <strong>$description</strong> data
  all'<strong>assert()</strong>, se è stata impostata.
  
  <strong>assert()</strong> è un costrutto del linguaggio in PHP 7, consentendo la definizione delle aspettative:
  asserzioni che hanno effetto in ambienti di sviluppo e di test, ma sono ottimizzate per avere un
  costo zero in produzione.
  
  Mentre <strong>assert_options()</strong> può ancora essere utilizzata per controllare il comportamento come sopra
  descritto per ragioni di retrocompatibilità, il codice solo per PHP 7 dovrebbe usare le due nuove
  direttive di configurazione per controllare il comportamento di <strong>assert()</strong> e non chiamare
  <strong>assert_options()</strong>.

<comment>Param:</comment>
  <info>mixed    </info>  <strong>$assertion  </strong>  L'asserzione. In PHP 5, questo deve essere o una <info>string</info> da essere
                           valutata o un <info>boolean</info> da testare. In PHP 7, questo può anche essere
                           qualsiasi espressione che restituisce un valore, che verrà eseguita e il
                           risultato usato per indicare se l'asserzione è riuscita o meno.
  <info>string   </info>  <strong>$description</strong>  Una descrizione opzionale che sarà inclusa nel messaggio di fallimento se
                           l'<strong>$assertion</strong> fallisce.
  <info>Throwable</info>  <strong>$exception  </strong>  In PHP 7, il secondo parametro può essere un oggetto <class>Throwable</class> al posto
                           di una <info>string</info> descrittiva, nel qual caso questo è l'oggetto che sarà
                           sollevato se l'asserzione fallisce e la direttiva di configurazione
                           assert.exception è abilitata.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> se l'asserzione è false, <info>true</info> in caso contrario.

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


id: base64_decode
type: function
doc:
<comment>Description:</comment>
  Decodes data encoded with MIME base64
  
  Decodes a base64 encoded <strong>$string</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The encoded data.
  <info>bool  </info>  <strong>$strict</strong>  If the <strong>$strict</strong> parameter is set to <info>true</info> then the <strong>base64_decode()</strong> function will
                   return <info>false</info> if the input contains character from outside the base64 alphabet.
                   Otherwise invalid characters will be silently discarded.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the decoded data o <info>false</info> in caso di fallimento. The returned data may be
               binary.

<comment>See Also:</comment>
   * <strong>base64_encode()</strong>
   * RFC 2045 section 6.8


id: base64_encode
type: function
doc:
<comment>Description:</comment>
  Encodes data with MIME base64
  
  Encodes the given <strong>$string</strong> with base64.
  
  This encoding is designed to make binary data survive transport through transport layers that are
  not 8-bit clean, such as mail bodies.
  
  Base64-encoded data takes about 33% more space than the original data.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The data to encode.

<comment>Return:</comment>
  <info>string</info>  The encoded data, as a string.

<comment>See Also:</comment>
   * <strong>base64_decode()</strong>
   * <strong>chunk_split()</strong>
   * <strong>convert_uuencode()</strong>
   * RFC 2045 section 6.8


id: bcscale
type: function
doc:
<comment>Description:</comment>
  Imposta il valore di precisione di default per tutte le funzioni matematich BCMath


id: bind_textdomain_codeset
type: function
doc:
<comment>Description:</comment>
  Specify the character encoding in which the messages from the DOMAIN message catalog will be
  returned
  
  With <strong>bind_textdomain_codeset()</strong>, you can set in which encoding will be messages from <strong>$domain</strong>
  returned by <strong>gettext()</strong> and similar functions.

<comment>Param:</comment>
  <info>string</info>  <strong>$domain </strong>  The domain
  <info>string</info>  <strong>$codeset</strong>  The code set

<comment>Return:</comment>
  <info>stringfalse</info>  A <info>string</info> on success.


id: bindtextdomain
type: function
doc:
<comment>Description:</comment>
  Sets the path for a domain
  
  The <strong>bindtextdomain()</strong> function sets the path for a domain.

<comment>Param:</comment>
  <info>string</info>  <strong>$domain   </strong>  The domain
  <info>string</info>  <strong>$directory</strong>  The directory path

<comment>Return:</comment>
  <info>stringfalse</info>  The full pathname for the <strong>$domain</strong> currently being set.


id: blenc_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt a PHP script with BLENC
    
  
  Encrypt the <strong>$plaintext</strong> content and write it into <strong>$encodedfile</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$plaintext     </strong>  A source code to encrypt. Does not need to contain opening/closing PHP
                           tags
  <info>string</info>  <strong>$encodedfile   </strong>  The filename where BLENC will save the encoded source.
  <info>string</info>  <strong>$encryption_key</strong>  The key that BLENC will use to encrypt plaintext content. If not given
                           BLENC will create a valid key.

<comment>Return:</comment>
  <info>string</info>  BLENC will return the redistributable key that must be saved into key_file: the path of
          key_file is specified at runtime with the option blenc.key_file


id: boolval
type: function
doc:
<comment>Description:</comment>
  Get the boolean value of a variable
  
  Returns the <info>bool</info> value of <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The scalar value being converted to a <info>bool</info>.

<comment>Return:</comment>
  <info>bool</info>  The <info>bool</info> value of <strong>$value</strong>.

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


id: bson_decode
type: function
doc:
<comment>Description:</comment>
  Deserializes a BSON object into a PHP array
  
  This function is very beta and entirely useless for 99% of users.  It is only useful if you're
  doing something weird, such as writing your own driver on  top of the PHP driver.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  The BSON to be deserialized.

<comment>Return:</comment>
  <info>array</info>  Returns the deserialized BSON object.


id: bson_encode
type: function
doc:
<comment>Description:</comment>
  Serializes a PHP variable into a BSON string
  
  This function is very beta and entirely useless for 99% of users.  It is only useful if you're
  doing something weird, such as writing your own driver on  top of the PHP driver.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$anything</strong>  The variable to be serialized.

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


id: bzerror
type: function
doc:
<comment>Description:</comment>
  Restituisce il codice d'errore bzip2 e la stringa corrispondente in un array


id: cal_days_in_month
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero di giorni di un mese per un dato anno e calendario


id: call_user_func
type: function
doc:
<comment>Description:</comment>
  Call the 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.
                       
                       Note that the parameters for <strong>call_user_func()</strong> are not passed by reference.
                       <strong>call_user_func()</strong> example and references
                       ]]>Il precedente esempio visualizzerà:
                       
                       Il precedente esempio visualizzerà:

<comment>Return:</comment>
  <info>mixed</info>  Returns the return value of the callback.

<comment>See Also:</comment>
   * <strong>call_user_func_array()</strong>
   * <strong>is_callable()</strong>
   * ReflectionFunction::invoke
   * ReflectionMethod::invoke


id: call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Call a callback with an array of parameters
  
  Calls the <strong>$callback</strong> given by the first parameter with the parameters in <strong>$args</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
  <info>array   </info>  <strong>$args    </strong>  The parameters to be passed to the callback, as an indexed array.

<comment>Return:</comment>
  <info>mixed</info>  Returns the return value of the callback, or <info>false</info> on error.

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


id: chdir
type: function
doc:
<comment>Description:</comment>
  Cambia directory
  
  Cambia la directory corrente di PHP in <strong>$directory</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  La nuova directory corrente

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


id: checkdate
type: function
doc:
<comment>Description:</comment>
  Valida una data gregoriana
  
  Controlla la validità della data formata dai parametri. Una data è considerata validata se ogni
  parametro è definito opportunamente.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Il mese è tra 1 e 12 compreso.
  <info>int</info>  <strong>$day  </strong>  Il giorno è nei limiti del numero permesso di giorni per il dato  <strong>$month</strong>.  Vengono
               presi in considerazione anche gli <strong>$year</strong> bisestili.
  <info>int</info>  <strong>$year </strong>  L'anno è tra 1 e 32767 compreso.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se la data data è valida; in caso contrario restituisce <info>false</info>.

<comment>See Also:</comment>
   * <strong>mktime()</strong>
   * <strong>strtotime()</strong>


id: checkdnsrr
type: function
doc:
<comment>Description:</comment>
  Controlla i record DNS relativi ad un host Internet o
       indirizzo IP


id: chgrp
type: function
doc:
<comment>Description:</comment>
  Cambia il gruppo del file
  
  Tenta di cambiare il gruppo del file <strong>$filename</strong> in <strong>$group</strong>.
  
  Solo il superuser può cambiare arbitrariamente il gruppo di un file; gli altri utenti possono
  cambiare il gruppo di un file solo fra gruppi di cui sono membri.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Percorso del file.
  <info>mixed </info>  <strong>$group   </strong>  Un nome o un numero di gruppo.

<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>chown()</strong>
   * <strong>chmod()</strong>


id: chmod
type: function
doc:
<comment>Description:</comment>
  Cambia le impostazioni del file
  
  Tenta di cambiare le impostazioni del file specificato in quelle date in <strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Percorso del file.
  <info>int   </info>  <strong>$mode    </strong>  Si osservi che <strong>$mode</strong> non viene automaticamente assunto come valore ottale,
                     quindi per ottenere l'operazione desiderata, è necessario far precedere <strong>$mode</strong>
                     da uno zero (0). Le stringhe come "g+w" non verranno elaborate correttamente.
                     
                     
                     ]]>
                     
                     Il parametro <strong>$mode</strong> consiste in tre numeri ottali costituenti le restrizioni
                     dell'accesso per il proprietario, il gruppo utente a cui appartiene il
                     proprietario, e gli altri utenti, nell'ordine dato. Ciascun numero può essere
                     calcolato aggiungendo i permessi necessari per quel bacino di utenti di
                     destinazione. Il numero 1 indica che si abilita all'esecuzione del file, con il
                     numero 2 si assegnano i permessi di scrittura, con il numero 4 si assegna il
                     permesso di lettura del file. Sommare questi numeri per ottenere i permessi
                     richiesti. Si possono avere maggiori dettagli sui permessi dei sistemi Unix
                     usando il comando 'man 1 chmod' e 'man 2 chmod'.
                     
                     
                     ]]>

<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>chown()</strong>
   * <strong>chgrp()</strong>
   * <strong>fileperms()</strong>
   * <strong>stat()</strong>


id: chop
type: function
doc:
<comment>Description:</comment>
  Alias di di rtrim
  
  Questa funzione è sinonimo di:  <strong>rtrim()</strong>.
  
  <strong>chop()</strong> è differente rispetto alla omonima funzione di Perl <return>chop()</return>, la quale rimuove l'ultimo
  carattere della stringa.


id: chown
type: function
doc:
<comment>Description:</comment>
  Cambia il proprietario del file
  
  Tenta di cambiare il proprietario del file <strong>$filename</strong> nell'utente <strong>$user</strong>. Solo il superuser può
  cambiare il proprietario di un file.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Percorso del file.
  <info>mixed </info>  <strong>$user    </strong>  Un nome utente o un numero.

<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>chmod()</strong>
   * <strong>chgrp()</strong>


id: class_alias
type: function
doc:
<comment>Description:</comment>
  Creates an alias for a class
  
  Creates an alias named <strong>$alias</strong> based on the user defined class <strong>$original</strong>. The aliased class is
  exactly the same as the original class.

<comment>Param:</comment>
  <info>string</info>  <strong>$original</strong>  The original class.
  <info>string</info>  <strong>$alias   </strong>  The alias name for the class.
  <info>bool  </info>  <strong>$autoload</strong>  Whether to autoload if the original class is not found.

<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>get_parent_class()</strong>
   * <strong>is_subclass_of()</strong>


id: class_exists
type: function
doc:
<comment>Description:</comment>
  Verifica se la classe è stata definita
  
  Questa funzione verifica se la classe è stata definita o meno.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  Il nome della classe. Il nome è cercato in modo case-insensitive.
  <info>bool  </info>  <strong>$autoload  </strong>  Se chiamare o no __autoload per default.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se <strong>$class_name</strong> è una classe definita, <info>false</info> in caso contrario.

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


id: class_implements
type: function
doc:
<comment>Description:</comment>
  Return the interfaces which are implemented by the given class or interface
    
  
  This function returns an array with the names of the interfaces that the given <strong>$class</strong> and its
  parents implement.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$class   </strong>  An object (class instance) or a string (class or interface name).
  <info>bool </info>  <strong>$autoload</strong>  Whether to allow this function to load the class automatically through the
                    <strong>__autoload()</strong> magic method.

<comment>Return:</comment>
  <info>array</info>  An array on success, or <info>false</info> on error.

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


id: class_parents
type: function
doc:
<comment>Description:</comment>
  Return the parent classes of the given class
    
  
  This function returns an array with the name of the parent classes of the given <strong>$class</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$class   </strong>  An object (class instance) or a string (class name).
  <info>bool </info>  <strong>$autoload</strong>  Whether to allow this function to load the class automatically through the
                    <strong>__autoload()</strong> magic method.

<comment>Return:</comment>
  <info>array</info>  An array on success, or <info>false</info> on error.

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


id: class_uses
type: function
doc:
<comment>Description:</comment>
  Return the traits used by the given class
    
  
  This function returns an array with the names of the traits that the given <strong>$class</strong> uses. This does
  however not include any traits used by a parent class.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$class   </strong>  An object (class instance) or a string (class name).
  <info>bool </info>  <strong>$autoload</strong>  Whether to allow this function to load the class automatically through the
                    <strong>__autoload()</strong> magic method.

<comment>Return:</comment>
  <info>array</info>  An array on success, or <info>false</info> on error.

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


id: classkit_import
type: function
doc:
<comment>Description:</comment>
  Import new class method definitions from a file
  
  Questa funzione non
  può essere usata per manipolare il metodo attualmente in esecuzione (o concatenato).
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the class method definitions to import

<comment>Return:</comment>
  <info>array</info>  Associative array of imported methods

<comment>See Also:</comment>
   * <strong>classkit_method_add()</strong>
   * <strong>classkit_method_copy()</strong>


id: classkit_method_add
type: function
doc:
<comment>Description:</comment>
  Dynamically adds a new method to a given class
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$classname </strong>  The class to which this method will be added
  <info>string</info>  <strong>$methodname</strong>  The name of the method to add
  <info>string</info>  <strong>$args      </strong>  Comma-delimited list of arguments for the newly-created method
  <info>string</info>  <strong>$code      </strong>  The code to be evaluated when <strong>$methodname</strong> is called
  <info>int   </info>  <strong>$flags     </strong>  The type of method to create, can be <info>CLASSKIT_ACC_PUBLIC</info>,
                       <info>CLASSKIT_ACC_PROTECTED</info> or <info>CLASSKIT_ACC_PRIVATE</info>
                       
                       This parameter is only used as of PHP 5, because, prior to this, all methods
                       were public.

<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>classkit_method_copy()</strong>
   * <strong>classkit_method_redefine()</strong>
   * <strong>classkit_method_remove()</strong>
   * <strong>classkit_method_rename()</strong>
   * <strong>create_function()</strong>


id: classkit_method_copy
type: function
doc:
<comment>Description:</comment>
  Copies a method from class to another
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$dClass </strong>  Destination class for copied method
  <info>string</info>  <strong>$dMethod</strong>  Destination method name
  <info>string</info>  <strong>$sClass </strong>  Source class of the method to copy
  <info>string</info>  <strong>$sMethod</strong>  Name of the method to copy from the source class. If this parameter is omitted,
                    the value of <strong>$dMethod</strong> is assumed.

<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>classkit_method_add()</strong>
   * <strong>classkit_method_redefine()</strong>
   * <strong>classkit_method_remove()</strong>
   * <strong>classkit_method_rename()</strong>


id: classkit_method_redefine
type: function
doc:
<comment>Description:</comment>
  Dynamically changes the code of the given method
  
  Questa funzione non
  può essere usata per manipolare il metodo attualmente in esecuzione (o concatenato).
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$classname </strong>  The class in which to redefine the method
  <info>string</info>  <strong>$methodname</strong>  The name of the method to redefine
  <info>string</info>  <strong>$args      </strong>  Comma-delimited list of arguments for the redefined method
  <info>string</info>  <strong>$code      </strong>  The new code to be evaluated when <strong>$methodname</strong> is called
  <info>int   </info>  <strong>$flags     </strong>  The redefined method can be <info>CLASSKIT_ACC_PUBLIC</info>, <info>CLASSKIT_ACC_PROTECTED</info> or
                       <info>CLASSKIT_ACC_PRIVATE</info>
                       
                       This parameter is only used as of PHP 5, because, prior to this, all methods
                       were public.

<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>classkit_method_add()</strong>
   * <strong>classkit_method_copy()</strong>
   * <strong>classkit_method_remove()</strong>
   * <strong>classkit_method_rename()</strong>


id: classkit_method_remove
type: function
doc:
<comment>Description:</comment>
  Dynamically removes the given method
  
  Questa funzione non
  può essere usata per manipolare il metodo attualmente in esecuzione (o concatenato).
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$classname </strong>  The class in which to remove the method
  <info>string</info>  <strong>$methodname</strong>  The name of the method to remove

<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>classkit_method_add()</strong>
   * <strong>classkit_method_copy()</strong>
   * <strong>classkit_method_redefine()</strong>
   * <strong>classkit_method_rename()</strong>


id: classkit_method_rename
type: function
doc:
<comment>Description:</comment>
  Dynamically changes the name of the given method
  
  Questa funzione non
  può essere usata per manipolare il metodo attualmente in esecuzione (o concatenato).
  
  Questa funzione è
  SPERIMENTALE. Ovvero, il comportamento di questa funzione,
  il nome di questa funzione, in definitiva tutto ciò che è documentato qui 
  può cambiare nei futuri rilasci del PHP senza preavviso. Siete avvisati, l'uso di questa
  funzione è a vostro rischio.

<comment>Param:</comment>
  <info>string</info>  <strong>$classname </strong>  The class in which to rename the method
  <info>string</info>  <strong>$methodname</strong>  The name of the method to rename
  <info>string</info>  <strong>$newname   </strong>  The new name to give to the renamed method

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

<comment>See Also:</comment>
   * <strong>classkit_method_add()</strong>
   * <strong>classkit_method_copy()</strong>
   * <strong>classkit_method_redefine()</strong>
   * <strong>classkit_method_remove()</strong>


id: cli_get_process_title
type: function
doc:
<comment>Description:</comment>
  Returns the current process title
  
  Returns the current process title, as set by <strong>cli_set_process_title()</strong>. Note that this may not
  exactly match what is shown in ps or top, depending on your operating system.
  
  This function is available only in CLI mode.

<comment>Return:</comment>
  <info>stringnull</info>  Return a string with the current process title or <info>null</info> on error.

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


id: cli_set_process_title
type: function
doc:
<comment>Description:</comment>
  Sets the process title
  
  Sets the process title visible in tools such as top and ps. This function is available only in CLI
  mode.

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The new title.

<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>cli_get_process_title()</strong>
   * <strong>setproctitle()</strong>


id: com
type: class
doc:
<comment>Description:</comment>
  The com class allows you to instantiate an OLE compatible COM object and call its methods and
  access its properties.


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

<comment>Param:</comment>
  <info>string         </info>  <strong>$module_name</strong>  Can be a ProgID, Class ID or Moniker that names the component to
                                 load.
                                 
                                 A ProgID is typically the application or DLL name, followed by a
                                 period, followed by the object name. e.g: <return>Word.Application</return>.
                                 
                                 A Class ID is the UUID that uniquely identifies a given class.
                                 
                                 A Moniker is a special form of naming, similar in concept to a URL
                                 scheme, that identifies a resource and specifies how it should be
                                 loaded.  As an example, you could load up Word and get an object
                                 representing a word document by specifying the full path to the
                                 word document as the module name, or you can use <return>LDAP:</return> as a moniker
                                 to use the ADSI interface to LDAP.
  <info>arraystringnull</info>  <strong>$server_name</strong>  The name of the DCOM server on which the component should be loaded
                                 and run.  If <info>null</info>, the object is run using the default for the
                                 application.  The default is typically to run it on the local
                                 machine, although the administrator might have configured the
                                 application to launch on a different machine.
                                 
                                 If you specify a non-<info>null</info> value for server, PHP will refuse to load
                                 the object unless the  configuration option is set to <info>true</info>.
                                 
                                 If <strong>$server_name</strong> is an array, it should contain the following
                                 elements (case sensitive!).  Note that they are all optional
                                 (although you need to specify both Username and Password together);
                                 if you omit the Server setting, the default server will be used (as
                                 mentioned above), and the instantiation of the object will not be
                                 affected by the  directive. DCOM server
                                 namekeytypedescriptionServerstringThe name of the
                                 server.UsernamestringThe username to connect as.PasswordstringThe
                                 password for <return>Username</return>.DomainstringThe domain of
                                 <return>server</return>.FlagsintegerOne or more of the following constants,
                                 logically OR'd together: <info>CLSCTX_INPROC_SERVER</info>,
                                 <info>CLSCTX_INPROC_HANDLER</info>, <info>CLSCTX_LOCAL_SERVER</info>, <info>CLSCTX_REMOTE_SERVER</info>,
                                 <info>CLSCTX_SERVER</info> and <info>CLSCTX_ALL</info>.  The default value if not specified
                                 here is <info>CLSCTX_SERVER</info> if you also omit <return>Server</return>, or
                                 <info>CLSCTX_REMOTE_SERVER</info> if you do specify a server.  You should
                                 consult the Microsoft documentation for CoCreateInstance for more
                                 information on the meaning of these constants; you will typically
                                 never have to use them.
  <info>int            </info>  <strong>$codepage   </strong>  Specifies the codepage that is used to convert strings to
                                 unicode-strings and vice versa.  The conversion is applied whenever
                                 a PHP string is passed as a parameter or returned from a method of
                                 this COM object.  The code page is sticky, which means that it will
                                 propagate to objects and variants returned from the object.
                                 
                                 Possible values are <info>CP_ACP</info> (use system default ANSI code page - the
                                 default if this parameter is omitted), <info>CP_MACCP</info>, <info>CP_OEMCP</info>,
                                 <info>CP_SYMBOL</info>, <info>CP_THREAD_ACP</info> (use codepage/locale set for the current
                                 executing thread), <info>CP_UTF7</info> and <info>CP_UTF8</info>.  You may also use the
                                 number for a given codepage; consult the Microsoft documentation
                                 for more details on codepages and their numeric values.


id: com_create_guid
type: function
doc:
<comment>Description:</comment>
  Generate a globally unique identifier (GUID)
  
  Generates a Globally Unique Identifier (GUID).
  
  A GUID is generated in the same way as DCE UUID's, except that the Microsoft convention is to
  enclose a GUID in curly braces.

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

<comment>See Also:</comment>
   * <strong>uuid_create()</strong> in the PECL uuid extension


id: com_event_sink
type: function
doc:
<comment>Description:</comment>
  Connect events from a COM object to a PHP object
  
  Instructs COM to sink events generated by <strong>$variant</strong> into the PHP object <strong>$sink_object</strong>.
  
  Be careful how you use this feature; if you are doing something similar to the example below, then
  it doesn't really make sense to run it in a web server context.

<comment>Param:</comment>
  <info>variant        </info>  <strong>$variant       </strong>  
  <info>object         </info>  <strong>$sink_object   </strong>  <strong>$sink_object</strong> should be an instance of a class with methods named
                                    after those of the desired dispinterface; you may use
                                    <strong>com_print_typeinfo()</strong> to help generate a template class for this
                                    purpose.
  <info>arraystringnull</info>  <strong>$sink_interface</strong>  PHP will attempt to use the default dispinterface type specified
                                    by the typelibrary associated with <strong>$variant</strong>, but you may
                                    override this choice by setting <strong>$sink_interface</strong> to the name of
                                    the dispinterface that you want to use.

<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>com_print_typeinfo()</strong>
   * <strong>com_message_pump()</strong>


id: com_get_active_object
type: function
doc:
<comment>Description:</comment>
  Returns a handle to an already running instance of a COM object
  
  <strong>com_get_active_object()</strong> is similar to creating a new instance of a  object, except that it will
  only return an object to your script if the object is already running. OLE applications use
  something known as the "<return>Running Object Table</return>" to allow well-known applications to be launched only
  once; this function exposes the COM library function GetActiveObject() to get a handle on a
  running instance.

<comment>Param:</comment>
  <info>string </info>  <strong>$prog_id </strong>  <strong>$prog_id</strong> must be either the ProgID or CLSID for the object that you want to
                      access (for example <return>Word.Application</return>).
  <info>intnull</info>  <strong>$codepage</strong>  Acts in precisely the same way that it does for the  class.

<comment>Return:</comment>
  <info>variant</info>  If the requested object is running, it will be returned to your script just like any
           other COM object.


id: com_message_pump
type: function
doc:
<comment>Description:</comment>
  Process COM messages, sleeping for up to timeoutms milliseconds
  
  This function will sleep for up to <strong>$timeout_milliseconds</strong> milliseconds, or until a message arrives
  in the queue.
  
  The purpose of this function is to route COM calls between apartments and handle various
  synchronization issues.  This allows your script to wait efficiently for events to be triggered,
  while still handling other events or running other code in the background.  You should use it in a
  loop, as demonstrated by the example in the <strong>com_event_sink()</strong> function, until you are finished
  using event bound COM objects.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout_milliseconds</strong>  The timeout, in milliseconds.
                              
                              If you do not specify a value for <strong>$timeout_milliseconds</strong>, then 0 will
                              be assumed.  A 0 value means that no waiting will be performed; if
                              there are messages pending they will be dispatched as before; if there
                              are no messages pending, the function will return <info>false</info> immediately
                              without sleeping.

<comment>Return:</comment>
  <info>bool</info>  If a message or messages arrives before the timeout, they will be dispatched, and the
        function will return <info>true</info>. If the timeout occurs and no messages were processed, the return
        value will be <info>false</info>.


id: com_print_typeinfo
type: function
doc:
<comment>Description:</comment>
  Print out a PHP class definition for a dispatchable interface
  
  The purpose of this function is to help generate a skeleton class for use as an event sink.  You
  may also use it to generate a dump of any COM object, provided that it supports enough of the
  introspection interfaces, and that you know the name of the interface you want to display.

<comment>Param:</comment>
  <info>variantstring</info>  <strong>$variant           </strong>  <strong>$variant</strong> should be either an instance of a COM object, or be
                                      the name of a typelibrary (which will be resolved according to
                                      the rules set out in <strong>com_load_typelib()</strong>).
  <info>stringnull   </info>  <strong>$dispatch_interface</strong>  The name of an <return>IDispatch</return> descendant interface that you want to
                                      display.
  <info>bool         </info>  <strong>$display_sink      </strong>  If set to <info>true</info>, the corresponding sink interface will be
                                      displayed instead.

<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>com_event_sink()</strong>
   * <strong>com_load_typelib()</strong>


id: connection_aborted
type: function
doc:
<comment>Description:</comment>
  Check whether client disconnected
  
  Checks whether the client disconnected.

<comment>Return:</comment>
  <info>int</info>  Returns 1 if client disconnected, 0 otherwise.

<comment>See Also:</comment>
   * <strong>connection_status()</strong>
   * <strong>ignore_user_abort()</strong>
   * Connection Handling
     for a complete description of connection handling in PHP.
    


id: connection_status
type: function
doc:
<comment>Description:</comment>
  Returns connection status bitfield
  
  Gets the connection status bitfield.

<comment>Return:</comment>
  <info>int</info>  Returns the connection status bitfield, which can be used against the <return>CONNECTION_XXX</return>
       constants to determine the connection status.

<comment>See Also:</comment>
   * <strong>connection_aborted()</strong>
   * <strong>ignore_user_abort()</strong>
   * Connection Handling
     for a complete description of connection handling in PHP.
    


id: constant
type: function
doc:
<comment>Description:</comment>
  Ritorna il valore di una costante
  
  Ritorna il valore di una costante di nome <strong>$name</strong>.
  
  <strong>constant()</strong> è utile se si ha bisogno di ottenere il valore di una costante, ma non se ne conosce il
  nome. Per esempio se è in una variabile ritornata da una funzione.
  
  Questa funzione può essere usata anche con le costanti di classe.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Il nome della costante.

<comment>Return:</comment>
  <info>mixed</info>  Ritorna il valore della costante o <info>null</info> se la costante non è  definita.

<comment>See Also:</comment>
   * <strong>define()</strong>
   * <strong>defined()</strong>
   * La sezione Costanti


id: count
type: function
doc:
<comment>Description:</comment>
  Conta gli elementi in una variabile, o le proprietà in un oggetto


id: count_chars
type: function
doc:
<comment>Description:</comment>
  Restituisce informazioni sui caratteri usati in una stringa
  
  La funzione conta il numero di occorrenze di ogni valore dei byte (0..255) nella stringa <strong>$string</strong> e
  li restituisce in vari modi.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  La stringa esaminata.
  <info>int   </info>  <strong>$mode  </strong>  Vedere i valori restituiti.

<comment>Return:</comment>
  <info>mixed</info>  A seconda di <strong>$mode</strong> <strong>count_chars()</strong> restituisce uno dei seguenti:  0 - un array con il valore
         del byte come chiave e la frequenza di ogni byte come valore.  1 - stesso di 0 ma vengono
         elencati solo i valori dei byte con una frequenza maggiore di zero.  2 - stesso di 0 ma
         vengono elencati solo i valori dei byte con una frequenza uguale a zero.  3 - viene
         restituita una stringa contenente tutti i caratteri unici.  4 - viene restituita una
         stringa contenente tutti i caratteri non utilizzati.
         
         0 - un array con il valore del byte come chiave e la frequenza di ogni byte come valore.
         
         1 - stesso di 0 ma vengono elencati solo i valori dei byte con una frequenza maggiore di
         zero.
         
         2 - stesso di 0 ma vengono elencati solo i valori dei byte con una frequenza uguale a zero.
         
         3 - viene restituita una stringa contenente tutti i caratteri unici.
         
         4 - viene restituita una stringa contenente tutti i caratteri non utilizzati.

<comment>See Also:</comment>
   * <strong>strpos()</strong>
   * <strong>substr_count()</strong>


id: counter_bump
type: function
doc:
<comment>Description:</comment>
  Update the current value of the basic counter
       
  
  <strong>counter_bump()</strong> updates the current value of the basic interface's counter.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The amount by which to change the counter's value. Can be negative.

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

<comment>See Also:</comment>
   * <strong>counter_get()</strong>
   * <strong>counter_reset()</strong>


id: counter_bump_value
type: function
doc:
<comment>Description:</comment>
  Change the current value of a counter resource
       
  
  <strong>counter_bump_value()</strong> updates the current value of a counter resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$counter</strong>  The counter resource to operate on.
  <info>int     </info>  <strong>$offset </strong>  The amount by which to change the counter's value. Can be negative.

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

<comment>See Also:</comment>
   * <strong>counter_get_value()</strong>
   * <strong>counter_reset_value()</strong>


id: counter_create
type: function
doc:
<comment>Description:</comment>
  Creates a counter which maintains a single numeric value
       
  
  Creates a counter which maintains a single numeric value.

<comment>Return:</comment>
  <info>resource</info>  Returns a counter resource.


id: counter_get
type: function
doc:
<comment>Description:</comment>
  Get the current value of the basic counter
       
  
  <strong>counter_get()</strong> returns the current value of the basic interface's counter.

<comment>Return:</comment>
  <info>int</info>  <strong>counter_get()</strong> returns an integer.

<comment>See Also:</comment>
   * <strong>counter_bump()</strong>
   * <strong>counter_reset()</strong>


id: counter_get_meta
type: function
doc:
<comment>Description:</comment>
  Return a piece of metainformation about a counter resource
       
  
  <strong>counter_get_meta()</strong> returns metainformation about a counter resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$counter  </strong>  The counter resource to operate on.
  <info>int     </info>  <strong>$attribute</strong>  The metainformation to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  <strong>counter_get_meta()</strong> returns values of varying types based on which metainformation was
         requested.


id: counter_get_named
type: function
doc:
<comment>Description:</comment>
  Retrieve an existing named counter as a resource
       
  
  <strong>counter_get_named()</strong> returns an existing counter by name if that name exists, or <info>null</info> otherwise.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The counter name to search for.

<comment>Return:</comment>
  <info>resource</info>  <strong>counter_get_name()</strong> returns an existing counter by name if that name exists, or <info>null</info>
            otherwise.


id: counter_get_value
type: function
doc:
<comment>Description:</comment>
  Get the current value of a counter resource
       
  
  <strong>counter_get_value()</strong> returns the current value of a counter resource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$counter</strong>  The counter resource to operate on.

<comment>Return:</comment>
  <info>int</info>  <strong>counter_get_value()</strong> returns an integer.

<comment>See Also:</comment>
   * <strong>counter_bump_value()</strong>
   * <strong>counter_reset_value()</strong>


id: counter_reset
type: function
doc:
<comment>Description:</comment>
  Reset the current value of the basic counter
       
  
  <strong>counter_reset()</strong> resets the current value of the basic interface's counter to its original initial
  value.

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

<comment>See Also:</comment>
   * <strong>counter_get()</strong>
   * <strong>counter_bump()</strong>


id: counter_reset_value
type: function
doc:
<comment>Description:</comment>
  Reset the current value of a counter resource
       
  
  <strong>counter_reset_value()</strong> resets the current value of a counter resource to its original initial
  value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$counter</strong>  The counter resource to operate on.

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

<comment>See Also:</comment>
   * <strong>counter_get_value()</strong>
   * <strong>counter_bump_value()</strong>


id: create_function
type: function
doc:
<comment>Description:</comment>
  Create an anonymous (lambda-style) function
  
  Creates an anonymous function from the parameters passed, and returns a unique name for it.
  
  This function internally performs an <strong>eval()</strong> and as such has the same security issues as <strong>eval()</strong>.
  Additionally it has bad performance and memory usage characteristics.
  
  If you are using PHP 5.3.0 or newer a native anonymous function should be used instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$args</strong>  The function arguments.
  <info>string</info>  <strong>$code</strong>  The function code.

<comment>Return:</comment>
  <info>string</info>  Returns a unique function name as a string, or <info>false</info> on error.

<comment>See Also:</comment>
   * Anonymous functions


id: ctype_alnum
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri alfanumerici
  
  Controlla che tutti i caratteri della <info>string</info> <strong>$text</strong> fornita, siano alfanumerici.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong> è o una lettera o una cifra, <info>false</info> in caso
        contrario.

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


id: ctype_alpha
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri alfabetici
  
  Verifica se tutti i caratteri forniti in <info>string</info>, <strong>$text</strong>, sono alfanumerici. Nel locale standard di
  <return>C</return> le lettere sono solo  <return>[A-Za-z]</return> e <strong>ctype_alpha()</strong> è  equivalente a <return>(ctype_upper($text) ||
  ctype_lower($text))</return> se $text è solo un carattere singolo, ma altre lingue hanno caratteri che non
  sono considerati nè maiuscoli nè minuscoli.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong> è una lettera dal locale corrente, <info>false</info> in caso
        contrario.

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


id: ctype_cntrl
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri di controllo
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong>, siano caratteri di controllo. I caratteri di
  controllo sono ad esempio a capo, tab, escape.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong> è  un carattere di controllo dal locale
        corrente, <info>false</info> in caso contrario.

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


id: ctype_digit
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri numerici
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong>, fornita siano numerici.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere nella stringa <strong>$text</strong> è una cifra decimale, <info>false</info> in caso
        contrario.

<comment>See Also:</comment>
   * <strong>ctype_alnum()</strong>
   * <strong>ctype_xdigit()</strong>
   * <strong>is_numeric()</strong>
   * <strong>is_int()</strong>
   * <strong>is_string()</strong>


id: ctype_graph
type: function
doc:
<comment>Description:</comment>
  Controlla ogni carattere stampabile tranne lo spazio
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, creino output visibile.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong> è  stampabile e crea effettivamente output
        visibile (nessuno spazio), <info>false</info> in caso contrario.

<comment>See Also:</comment>
   * <strong>ctype_alnum()</strong>
   * <strong>ctype_print()</strong>
   * <strong>ctype_punct()</strong>


id: ctype_lower
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri minuscoli
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, siano lettere minuscole.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong> è  una lettera minuscola nel locale corrente.

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


id: ctype_print
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri stampabili
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, siano stampabili.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere in <strong>$text</strong>  crea effettivamente output (compresi spazi).
        Restituisce <info>false</info> se  <strong>$text</strong> contiene caratteri di controllo o caratteri  che non hanno per
        niente alcun output o funzione di controllo.

<comment>See Also:</comment>
   * <strong>ctype_cntrl()</strong>
   * <strong>ctype_graph()</strong>
   * <strong>ctype_punct()</strong>


id: ctype_punct
type: function
doc:
<comment>Description:</comment>
  Controlla ogni carattere stampabile che non è uno spazio o un
     carattere alfanumerico
    
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, siano caratteri di punteggiatura.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  La stringa da testare.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere di <strong>$text</strong>  è stampabile, ma non è una lettera, una cifra o
        uno spazio, <info>false</info> in caso contrario.

<comment>See Also:</comment>
   * <strong>ctype_cntrl()</strong>
   * <strong>ctype_graph()</strong>


id: ctype_space
type: function
doc:
<comment>Description:</comment>
  Controlla gli spazi
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, creino spazi.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$text</strong>  La stringa da testare. 
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.
                
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere di <strong>$text</strong>  crea qualsiasi tipo di spazio bianco, <info>false</info> in
        caso contrario. Oltre al  carattere spazio, questo include anche i caratteri tab, tab
        verticale, line feed (avanza di una riga), carriage return (a capo) e form feed (avanza di
        un modulo).

<comment>See Also:</comment>
   * <strong>ctype_cntrl()</strong>
   * <strong>ctype_graph()</strong>
   * <strong>ctype_punct()</strong>


id: ctype_upper
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri maiuscoli
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, siano caratteri maiuscoli.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$text</strong>  La stringa da testare. 
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.
                
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere di <strong>$text</strong> è  una lettera maiuscola nel locale corrente.

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


id: ctype_xdigit
type: function
doc:
<comment>Description:</comment>
  Controlla i caratteri che rappresentano una cifra esadecimale
    
  
  Controlla che tutti i caratteri nella <info>string</info>, <strong>$text</strong> fornita, siano 'cifre' esadecimali.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$text</strong>  La stringa da testare. 
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.
                
                Se è fornito un <info>integer</info> tra -128 e 255, viene interpretato come
                il valore ASCII di un singolo carattere (ai valori negativi viene aggiunto 256 in
                modo da
                permettere i caratteri Extended ASCII). Qualsiasi altro intero è interpretato come
                una stringa
                contenente le cifre decimali dell'intero.

<comment>Return:</comment>
  <info>bool</info>  Restituisce <info>true</info> se ogni carattere di <strong>$text</strong> è  una 'cifra' esadecimale, ovvero una cifra
        decimale o un carattere da  <return>[A-Fa-f]</return> , <info>false</info> in caso contrario.

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


id: cubrid_affected_rows
type: function
doc:
<comment>Description:</comment>
  Return the number of rows affected by the last SQL statement
  
  The <strong>cubrid_affected_rows()</strong> function is used to get the number of rows affected by the SQL
  statement (INSERT, DELETE, UPDATE).

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last link opend by <strong>cubrid_connect()</strong> is assumed.
  <info>resource</info>  <strong>$req_identifier </strong>  Request Identifier, could be returned from either <strong>cubrid_prepare()</strong> or
                              <strong>cubrid_execute()</strong>.  If the request identifier is not specified, the
                              last identifier requested by  <strong>cubrid_prepare()</strong> or <strong>cubrid_execute()</strong> is
                              assumed.

<comment>Return:</comment>
  <info>int</info>  Number of rows affected by the SQL statement, when process is successful.
       
       -1, when SQL statement is not INSERT, DELETE or UPDATE.
       
       <info>false</info>, when the request identifier is not specified, and there is no last request.

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


id: cubrid_bind
type: function
doc:
<comment>Description:</comment>
  Bind variables to a prepared statement as parameters
  
  The <strong>cubrid_bind()</strong> function is used to bind values to a corresponding named or question mark
  placeholder in the SQL statement that was passed to <strong>cubrid_prepare()</strong>. If <strong>$bind_value_type</strong> is not
  given, string will be the default.
  
  If the type of data to be bound is BLOB/CLOB, CUBRID will try to map the data as a PHP stream. If
  the actually bind value type is not stream, CUBRID will convert it to string, and use it as the
  full path and file name of a file on the client filesystem.
  
  If the type of data to be bound explicitly is ENUM, the $bind_value argument should be the enum
  element which is in string format.
  
  In CUBRID shard envrioment, the $bind_value_type must be included in  the cubrid_bind function.
  
  The following table shows the types of substitute values.
  
  CUBRID Bind Date TypesSupportBind TypeCorresponding SQL TypeSupportedSTRINGCHAR,
  VARCHARNCHARNCHAR, NVARCHARBITBIT, VARBITNUMERIC or NUMBERSHORT, INT,
  NUMERICFLOATFLOATDOUBLEDOUBLETIMETIMEDATEDATETIMESTAMPTIMESTAMPOBJECTOBJECTENUMENUMBLOBBLOBCLOBCLOBNULLNULLNot
  supportedSETSETMULTISETMULTISETSEQUENCESEQUENCE

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier </strong>  Request identifier as a result of <strong>cubrid_prepare()</strong>.
  <info>int     </info>  <strong>$bind_index     </strong>  Location of binding parameters. It starts with 1.
  <info>mixed   </info>  <strong>$bind_value     </strong>  Actual value for binding.
  <info>string  </info>  <strong>$bind_value_type</strong>  A type of the value to bind. (It is omitted by default. Thus, the
                              system internally uses string by default. However, you need to specify
                              the exact type of the value as an argument when they are NCHAR, BIT,
                              or BLOB/CLOB).

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_prepare()</strong>


id: cubrid_client_encoding
type: function
doc:
<comment>Description:</comment>
  Return the current CUBRID connection charset
  
  This function returns the current CUBRID connection charset and is similar to the CUBRID function
  <strong>cubrid_get_charset()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last link opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>string</info>  A string that represents the CUBRID connection charset; on success.
          
          <info>false</info> on failure.

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


id: cubrid_close
type: function
doc:
<comment>Description:</comment>
  Close CUBRID connection
  
  The <strong>cubrid_close()</strong> function ends the transaction currently in process, closes the connection
  handle and disconnects from server. If there is any request handles not closed yet at this point,
  they will be closed. It is similar to the CUBRID function <strong>cubrid_disconnect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection identifier. If the connection identifier is not
                              specified, the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_disconnect()</strong>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_connect_with_url()</strong>


id: cubrid_close_prepare
type: function
doc:
<comment>Description:</comment>
  Close the request handle 
  
  The <strong>cubrid_close_prepare()</strong> function closes the request handle given by the <strong>$req_identifier</strong>
  argument, and releases the memory region related to the handle. It is an alias of
  <strong>cubrid_close_request()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>bool</info>  Return <info>true</info> on success.

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


id: cubrid_close_request
type: function
doc:
<comment>Description:</comment>
  Close the request handle 
  
  The <strong>cubrid_close_request()</strong> function closes the request handle given by the <strong>$req_identifier</strong>
  argument, and releases the memory region related to the handle. It is an alias of
  <strong>cubrid_close_prepare()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>bool</info>  Return <info>true</info> on success.

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


id: cubrid_col_get
type: function
doc:
<comment>Description:</comment>
  Get contents of collection type column using OID
  
  The <strong>cubrid_col_get()</strong> function is used to get contents of the elements of the collection type (set,
  multiset, sequence) attribute you requested as an array.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to read.
  <info>string  </info>  <strong>$attr_name      </strong>  Attribute name that you want to read from the instance.

<comment>Return:</comment>
  <info>array</info>  Array (0-based numerical array) containing the elements you requested, when process is
         successful;
         
         <info>false</info> (to distinguish the error from the situation of attribute having empty collection or
         NULL, in case of error, a warning message is shown; in such case you can check the error by
         using <strong>cubrid_error_code()</strong>), when process is unsuccessful.


id: cubrid_col_size
type: function
doc:
<comment>Description:</comment>
  Get the number of elements in collection type column using OID
  
  The <strong>cubrid_col_size()</strong> function is used to get the number of elements in a collection type (set,
  multiset, sequence) attribute.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID the instance that you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute that you want to work with.

<comment>Return:</comment>
  <info>int</info>  Number of elements, when process is successful.
       
       <info>false</info>, when process is unsuccessful.


id: cubrid_column_names
type: function
doc:
<comment>Description:</comment>
  Get the column names in result
  
  The <strong>cubrid_column_names()</strong> function is used to get the column names of the query result by using
  <strong>$req_identifier</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>array</info>  Array of string values containing the column names, when process is successful.
         
         <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_prepare()</strong>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_column_types()</strong>


id: cubrid_column_types
type: function
doc:
<comment>Description:</comment>
  Get column types in result
  
  The <strong>cubrid_column_types()</strong> function gets column types of query results by using <strong>$req_identifier</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>array</info>  Array of string values containing the column types, when process is successful.
         
         <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_column_names()</strong>
   * <strong>cubrid_prepare()</strong>
   * <strong>cubrid_execute()</strong>


id: cubrid_commit
type: function
doc:
<comment>Description:</comment>
  Commit a transaction
  
  The <strong>cubrid_commit()</strong> function is used to execute commit on the transaction pointed by
  <strong>$conn_identifier</strong>, currently in progress. Connection to the server is closed after the
  <strong>cubrid_commit()</strong> function is called; However,  the connection handle is still valid.
  
  In CUBRID PHP, auto-commit mode is disabled by default for transaction management.  You can set it
  by using <strong>cubrid_set_autocommit()</strong>.  You can get its status by using <strong>cubrid_get_autocommit()</strong>. Before
  you start a transaction,  remember to disable the auto-commit mode.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_rollback()</strong>
   * <strong>cubrid_get_autocommit()</strong>
   * <strong>cubrid_set_autocommit()</strong>


id: cubrid_connect
type: function
doc:
<comment>Description:</comment>
  Open a connection to a CUBRID Server
  
  The <strong>cubrid_connect()</strong> function is used to establish the environment for connecting to your server
  by using your server address, port number, database name, user name, and password. If the user
  name and password is not given, then the "PUBLIC" connection will be made by default.

<comment>Param:</comment>
  <info>string</info>  <strong>$host    </strong>  Host name or IP address of CUBRID CAS server.
  <info>int   </info>  <strong>$port    </strong>  Port number of CUBRID CAS server (BROKER_PORT configured in
                     $CUBRID/conf/cubrid_broker.conf).
  <info>string</info>  <strong>$dbname  </strong>  Name of database.
  <info>string</info>  <strong>$userid  </strong>  User name for the database. If not given, the default value is "public".
  <info>string</info>  <strong>$passwd  </strong>  User password. If not given, the default value is "".
  <info>bool  </info>  <strong>$new_link</strong>  If a second call is made to <strong>cubrid_connect()</strong> with the same arguments, no new
                     connection will be established, but instead, the connection identifier of the
                     already opened connection will be returned. The <strong>$new_link</strong> parameter modifies
                     this behavior and makes <strong>cubrid_connect()</strong> always open a new connection, even if
                     <strong>cubrid_connect()</strong> was called before with the same parameters.

<comment>Return:</comment>
  <info>resource</info>  Connection identifier, when process is successful.
            
            <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_pconnect()</strong>
   * <strong>cubrid_connect_with_url()</strong>
   * <strong>cubrid_pconnect_with_url()</strong>
   * <strong>cubrid_disconnect()</strong>
   * <strong>cubrid_close()</strong>


id: cubrid_connect_with_url
type: function
doc:
<comment>Description:</comment>
  Establish the environment for connecting to CUBRID server
  
  The <strong>cubrid_connect_with_url()</strong> function is used to establish the environment for connecting to your
  server by using connection information passed with an url string argument. If the HA feature is
  enabled in CUBRID, you must specify the connection information of the standby server, which is
  used for failover when failure occurs, in the url string argument of this function. If the user
  name and password is not given, then the "PUBLIC" connection will be made by default.
  
  \<url&gt; ::= CUBRID:\<host&gt;:\<db_name&gt;:\<db_user&gt;:\<db_password&gt;:[?\<properties&gt;]
  
  \<properties&gt; ::= \<property&gt; [&\<property&gt;]
  
  \<properties&gt; ::= alhosts=\<alternative_hosts&gt;[ &rctime=\<time&gt;]
  
  \<properties&gt; ::= login_timeout=\<milli_sec&gt;
  
  \<properties&gt; ::= query_timeout=\<milli_sec&gt;
  
  \<properties&gt; ::= disconnect_on_query_timeout=true|false
  
  \<alternative_hosts&gt; ::= \<standby_broker1_host&gt;:\<port&gt; [,\<standby_broker2_host&gt;:\<port&gt;]
  
  \<host&gt; := HOSTNAME | IP_ADDR
  
  \<time&gt; := SECOND
  
  \<milli_sec&gt; := MILLI SECOND
  
  host : A host name or IP address of the master databasedb_name : A name of the databasedb_user : A
  name of the database userdb_password : A database user password alhosts : Specifies the broker
  information of the standby server, which is used for failover when it is impossible to connect to
  the active server.  You can specify multiple brokers for failover, and the connection to the
  brokers is attempted in the order listed in alhosts rctime : An interval between the attempts to
  connect to the active broker in which failure occurred. After a failure occurs, the system
  connects to the  broker specified by althosts (failover), terminates the transaction, and then
  attempts to connect to the active broker of the master database at every rctime.  The default
  value is 600 seconds. login_timeout : Timeout value (unit: msec.) for database login. The default
  value is 0, which means infinite postponement.  query_timeout : Timeout value (unit: msec.) for
  query request. Upon timeout, a message to cancel requesting a query transferred to server is sent.
  The return  value can depend on the disconnect_on_query_timeout configuration; even though the
  message to cancel a request is sent to server, that request may succeed.
  disconnect_on_query_timeout : Configures a value whether to immediately return an error of
  function being executed upon timeout. The default value is false.
  
  <return>?</return> and <return>:</return> that are used as identifiers in PHP connection URL can't be included in the password. The
  following is an example of a password that is invalid to use as connection URL because it contains
  "<return>?:</return>".
  
  $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100";
  
  Passwords that contain <return>?</return> or <return>:</return> may be passed as a separate parameter.
  
  $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100";
  
  $conn = cubrid_connect_with_url($url, "dba", "12?");
  
  If user or password is empty,you can't delete "<return>:</return>",the following is an example.
  
  $url = "CUBRID:localhost:33000:demodb:::";

<comment>Param:</comment>
  <info>string</info>  <strong>$conn_url</strong>  A character string that contains server connection information.
  <info>string</info>  <strong>$userid  </strong>  User name for the database.
  <info>string</info>  <strong>$passwd  </strong>  User password.
  <info>bool  </info>  <strong>$new_link</strong>  If a second call is made to <strong>cubrid_connect_with_url()</strong> with the same arguments,
                     no new connection will be established, but instead, the connection identifier
                     of the already opened connection will be returned. The <strong>$new_link</strong> parameter
                     modifies this behavior and makes <strong>cubrid_connect_with_url()</strong> always open a new
                     connection, even if <strong>cubrid_connect_with_url()</strong> was called before with the same
                     parameters.

<comment>Return:</comment>
  <info>resource</info>  Connection identifier, when process is successful.
            
            <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_pconnect()</strong>
   * <strong>cubrid_pconnect_with_url()</strong>
   * <strong>cubrid_disconnect()</strong>
   * <strong>cubrid_close()</strong>


id: cubrid_current_oid
type: function
doc:
<comment>Description:</comment>
  Get OID of the current cursor location
  
  The <strong>cubrid_current_oid()</strong> function is used to get the oid of the current cursor location from the
  query result.  To use <strong>cubrid_current_oid()</strong>, the query executed must be a updatable query, and the
  CUBRID_INCLUDE_OID option must be included during the query execution.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>string</info>  Oid of current cursor location, when process is successful
          
          <info>false</info>, when process is unsuccessful.

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


id: cubrid_data_seek
type: function
doc:
<comment>Description:</comment>
  Move the internal row pointer of the CUBRID result
  
  This function performs the moving of the internal row pointer of the CUBRID result (associated
  with the specified result identifier) to point to a specific row number. There are functions, such
  as <strong>cubrid_fetch_assoc()</strong>, which use the current stored value of <strong>$row number</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result    </strong>  The result.
  <info>int     </info>  <strong>$row_number</strong>  This is the desired row number of the new result pointer.

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


id: cubrid_db_name
type: function
doc:
<comment>Description:</comment>
  Get db name from results of cubrid_list_dbs
  
  Retrieve the database name from a call to <strong>cubrid_list_dbs()</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$result</strong>  The result pointer from a call to <strong>cubrid_list_dbs()</strong>.
  <info>int  </info>  <strong>$index </strong>  The index into the result set.

<comment>Return:</comment>
  <info>string</info>  Returns the database name on success, and <info>false</info> on failure. If <info>false</info> is returned, use
          <strong>cubrid_error()</strong> to determine the nature of the error.

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


id: cubrid_disconnect
type: function
doc:
<comment>Description:</comment>
  Close a database connection
  
  The <strong>cubrid_disconnect()</strong> function closes the connection handle and disconnects from server. If any
  request handle is not closed at this point,  it will be closed. It is similar to the CUBRID MySQL
  compatible function <strong>cubrid_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_close()</strong>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_connect_with_url()</strong>


id: cubrid_drop
type: function
doc:
<comment>Description:</comment>
  Delete an instance using OID
  
  The <strong>cubrid_drop()</strong> function is used to delete an instance from database by using the <strong>$oid</strong> of the
  instance.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  Oid of the instance that you want to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_errno
type: function
doc:
<comment>Description:</comment>
  Return the numerical value of the error message from previous CUBRID operation
  
  Returns the error number from the last CUBRID function.
  
  The <strong>cubrid_errno()</strong> function is used to get the error code of the error that occurred during the
  API execution.  Usually, it gets the error code when API returns false as its return value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection identifier. If the connection identifier is not
                              specified, the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>int</info>  Returns the error number from the last CUBRID function, or <return>0</return> (zero) if no error occurred.

<comment>See Also:</comment>
   * <strong>cubrid_error()</strong>
   * <strong>cubrid_error_code()</strong>
   * <strong>cubrid_error_msg()</strong>


id: cubrid_error
type: function
doc:
<comment>Description:</comment>
  Get the error message
  
  The <strong>cubrid_error()</strong> function is used to get the error message that occurred during the use of
  CUBRID API. Usually, it gets error message when API returns false as its return value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$connection</strong>  The CUBRID connection.

<comment>Return:</comment>
  <info>string</info>  Error message that occurred.

<comment>See Also:</comment>
   * <strong>cubrid_errno()</strong>
   * <strong>cubrid_error_code()</strong>
   * <strong>cubrid_error_msg()</strong>


id: cubrid_error_code
type: function
doc:
<comment>Description:</comment>
  Get error code for the most recent function call
  
  The <strong>cubrid_error_code()</strong> function is used to get the error code of the error that occurred during
  the API execution. Usually, it gets the error code when API returns false as its return value.

<comment>Return:</comment>
  <info>int</info>  Error code of the error that occurred, or <return>0</return> (zero) if no error occurred.

<comment>See Also:</comment>
   * <strong>cubrid_error_code_facility()</strong>
   * <strong>cubrid_error_msg()</strong>


id: cubrid_error_code_facility
type: function
doc:
<comment>Description:</comment>
  Get the facility code of error
  
  The <strong>cubrid_error_code_facility()</strong> function is used to get the facility code (level in which the
  error occurred) from the error code of the error that occurred during the API execution. Usually,
  you can get the error code when API returns false as its return value.

<comment>Return:</comment>
  <info>int</info>  Facility code of the error code that occurred: CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS,
       CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT

<comment>See Also:</comment>
   * <strong>cubrid_error_code()</strong>
   * <strong>cubrid_error_msg()</strong>


id: cubrid_error_msg
type: function
doc:
<comment>Description:</comment>
  Get last error message for the most recent function call
  
  The <strong>cubrid_error_msg()</strong> function is used to get the error message that occurred during the use of
  CUBRID API. Usually, it gets error message when API returns false as its return value.

<comment>Return:</comment>
  <info>string</info>  Error message that occurred.

<comment>See Also:</comment>
   * <strong>cubrid_error_code()</strong>
   * <strong>cubrid_error_code_facility()</strong>


id: cubrid_execute
type: function
doc:
<comment>Description:</comment>
  Execute a prepared SQL statement
  
  The <strong>cubrid_execute()</strong> function is used to execute the given SQL statement. It executes the query by
  using <strong>$conn_identifier</strong> and SQL, and then returns the request identifier created. It is used for
  simple execution of query, where the parameter binding is not needed. In addition, the
  <strong>cubrid_execute()</strong> function is used to execute the prepared statement by means of <strong>cubrid_prepare()</strong>
  and <strong>cubrid_bind()</strong>. At this time, you need to specify arguments of <strong>$request_identifier</strong> and <strong>$option</strong>.
  
  The <strong>$option</strong> is used to determine whether to get OID after query execution and whether to execute
  the query in synchronous or asynchronous mode. CUBRID_INCLUDE_OID and CUBRID_ASYNC (or
  CUBRID_EXEC_QUERY_ALL if you want to execute multiple SQL statements) can be specified by using a
  bitwise OR operator. If not specified, neither of them isselected. If the flag
  CUBRID_EXEC_QUERY_ALL is set, a synchronous mode (sync_mode) is used to retrieve query results,
  and in such cases the following rules are applied:
  
  The return value is the result of the first query. If an error occurs in any query, the execution
  is processed as a failure.  In a query composed of q1 q2 q3, if an error occurs in q2 after q1
  succeeds the execution, the result of q1 remains valid. That is, the previous successful query
  executions are not rolled back when an error occurs.  If a query is executed successfully, the
  result of the second query can be obtained using <strong>cubrid_next_result()</strong>.
  
  If the first argument is <strong>$request_identifier</strong> to execute the <strong>cubrid_prepare()</strong> function, you can
  specify an option, CUBRID_ASYNC only.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier   </strong>  Connection identifier.
  <info>string  </info>  <strong>$sql               </strong>  SQL to be executed.
  <info>int     </info>  <strong>$option            </strong>  Query execution option CUBRID_INCLUDE_OID, CUBRID_ASYNC,
                                 CUBRID_EXEC_QUERY_ALL.
  <info>resource</info>  <strong>$request_identifier</strong>  <strong>cubrid_prepare()</strong> identifier.

<comment>Return:</comment>
  <info>resource</info>  Request identifier, when process is successful and first param is conn_identifier; <info>true</info>,
            when process is successful and first argument is request_identifier.
            
            <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_prepare()</strong>
   * <strong>cubrid_bind()</strong>
   * <strong>cubrid_next_result()</strong>
   * <strong>cubrid_close_request()</strong>
   * <strong>cubrid_commit()</strong>
   * <strong>cubrid_rollback()</strong>


id: cubrid_fetch
type: function
doc:
<comment>Description:</comment>
  Fetch the next row from a result set
  
  The <strong>cubrid_fetch()</strong> function is used to get a single row from the query result.  The cursor
  automatically moves to the next row after getting the result.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$type  </strong>  Array type of the fetched result CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH,
                     CUBRID_OBJECT. If you want to operate the lob object, you can use CUBRID_LOB.

<comment>Return:</comment>
  <info>mixed</info>  Result array or object, when process is successful.
         
         <info>false</info>, when there are no more rows; NULL, when process is unsuccessful.
         
         The result can be received either as an array or as an object, and you can decide which
         data type to use by setting the <strong>$type</strong> argument. The <strong>$type</strong> variable can be set to one of the
         following values:
         
         When <strong>$type</strong> argument is omitted, the result will be received using CUBRID_BOTH option as
         default. When you want to receive query result in object data type, the column name of the
         result must obey the naming rules for identifiers in PHP.  For example, column name such as
         "count(*)" cannot be received in object type.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_fetch_array()</strong>
   * <strong>cubrid_fetch_row()</strong>
   * <strong>cubrid_fetch_assoc()</strong>
   * <strong>cubrid_fetch_object()</strong>


id: cubrid_fetch_array
type: function
doc:
<comment>Description:</comment>
  Fetch a result row as an associative array, a numeric array, or both
  
  The <strong>cubrid_fetch_array()</strong> function is used to get a single row from the query result and returns an
  array. The cursor automatically moves to the next row after getting the result.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$Result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$type  </strong>  Array type of the fetched result CUBRID_NUM, CUBRID_ASSOC, CUBRID_BOTH. If you
                     need to operate the lob object, you can use CUBRID_LOB.

<comment>Return:</comment>
  <info>array</info>  Returns an array of strings that corresponds to the fetched row, when process is
         successful.
         
         <info>false</info>, when there are no more rows; NULL, when process is unsuccessful.
         
         The type of returned array depends on how type is defined. By using CUBRID_BOTH (default),
         you'll get an array with both associative and number indices, and you can decide which data
         type to use by setting the <strong>$type</strong> argument. The <strong>$type</strong> variable can be set to one of the
         following values:

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_fetch()</strong>
   * <strong>cubrid_fetch_row()</strong>
   * <strong>cubrid_fetch_assoc()</strong>
   * <strong>cubrid_fetch_object()</strong>


id: cubrid_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Return the associative array that corresponds to the fetched row
  
  This function returns the associative array, that corresponds to the fetched row, and then moves
  the internal data pointer ahead, or returns FALSE when the end is reached.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$type  </strong>  Type can only be CUBRID_LOB, this parameter will be used only when you need to
                     operate the lob object.

<comment>Return:</comment>
  <info>array</info>  Associative array, when process is successful.
         
         <info>false</info>, when there are no more rows; NULL, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_fetch()</strong>
   * <strong>cubrid_fetch_row()</strong>
   * <strong>cubrid_fetch_array()</strong>
   * <strong>cubrid_fetch_object()</strong>


id: cubrid_fetch_field
type: function
doc:
<comment>Description:</comment>
  Get column information from a result and return as an object
  
  This function returns an object with certain properties of the specific column. The properties of
  the object are:
  
  <strong>$name</strong>column name<strong>$table</strong>name of the table that the column belongs to<strong>$def</strong>default value of the
  column<strong>$max_length</strong>maximum length of the column<strong>$not_null</strong>1 if the column cannot be NULL<strong>$primary_key</strong>1
  if the column is a primary key<strong>$unique_key</strong>1 if the column is an unique key<strong>$multiple_key</strong>1 if the
  column is a non-unique key<strong>$numeric</strong>1 if the column is numeric<strong>$blob</strong>1 if the column is a BLOB<strong>$type</strong>the
  type of the column<strong>$unsigned</strong>1 if the column is unsigned<strong>$zerofill</strong>1 if the column is zero-filled
  
  column name
  
  name of the table that the column belongs to
  
  default value of the column
  
  maximum length of the column
  
  1 if the column cannot be NULL
  
  1 if the column is a primary key
  
  1 if the column is an unique key
  
  1 if the column is a non-unique key
  
  1 if the column is numeric
  
  1 if the column is a BLOB
  
  the type of the column
  
  1 if the column is unsigned
  
  1 if the column is zero-filled

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. If the field offset is not specified, the
                           next field (that was not yet retrieved by this function) is retrieved.
                           The <strong>$field_offset</strong> starts at 0.

<comment>Return:</comment>
  <info>object</info>  Object with certain properties of the specific column, when process is successful.
          
          <info>false</info> on failure.


id: cubrid_fetch_lengths
type: function
doc:
<comment>Description:</comment>
  Return an array with the lengths of the values of each field from the current row
  
  This function returns an numeric array with the lengths of the values of each field from the
  current row of the result set or it returns FALSE on failure.
  
  If field data type is BLOB/CLOB, you should get its length by using <strong>cubrid_lob_size()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>

<comment>Return:</comment>
  <info>array</info>  An numeric array, when process is successful.
         
         <info>false</info> on failure.


id: cubrid_fetch_object
type: function
doc:
<comment>Description:</comment>
  Fetch the next row and return it as an object
  
  This function returns an object with the column names of the result set as properties. The values
  of these properties are extracted from the current row of the result.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result    </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>string  </info>  <strong>$class_name</strong>  The name of the class to instantiate. If not specified, a <class>stdClass</class>
                         (stdClass is PHP's generic empty class that's used when casting other types
                         to objects) object is returned.
  <info>array   </info>  <strong>$params    </strong>  An optional <info>array</info> of parameters to pass to the constructor for <strong>$class_name</strong>
                         objects.
  <info>int     </info>  <strong>$type      </strong>  Type can only be CUBRID_LOB, this parameter will be used only when you need
                         to operate the lob object.

<comment>Return:</comment>
  <info>object</info>  An object, when process is successful.
          
          <info>false</info>, when there are no more rows; NULL, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_fetch()</strong>
   * <strong>cubrid_fetch_array()</strong>
   * <strong>cubrid_fetch_assoc()</strong>
   * <strong>cubrid_fetch_row()</strong>


id: cubrid_fetch_row
type: function
doc:
<comment>Description:</comment>
  Return a numerical array with the values of the current row
  
  This function returns a numerical array with the values of the current row from the result set,
  starting from 0, and moves the internal data pointer ahead.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$type  </strong>  Type can only be CUBRID_LOB, this parameter will be used only when you need to
                     operate the lob object.

<comment>Return:</comment>
  <info>array</info>  A numerical array, when process is successful.
         
         <info>false</info>, when there are no more rows; NULL, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_fetch()</strong>
   * <strong>cubrid_fetch_array()</strong>
   * <strong>cubrid_fetch_assoc()</strong>
   * <strong>cubrid_fetch_object()</strong>


id: cubrid_field_flags
type: function
doc:
<comment>Description:</comment>
  Return a string with the flags of the given field offset
  
  This function returns a string with the flags of the given field offset separated by space. You
  can split the returned value using explode. The possible flags could be: <info>not_null</info>, <info>primary_key</info>,
  <info>unique_key</info>, <info>foreign_key</info>, <info>auto_increment</info>, <info>shared</info>, <info>reverse_index</info>, <info>reverse_unique</info> and <info>timestamp</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>string</info>  A string with flags, when process is successful.
          
          <info>false</info> when invalid field_offset value.
          
          -1 if SQL sentence is not SELECT.


id: cubrid_field_len
type: function
doc:
<comment>Description:</comment>
  Get the maximum length of the specified field
  
  This function returns the maximum length of the specified field on success, or it returns FALSE on
  failure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>int</info>  Maximum length, when process is successful.
       
       <info>false</info> on failure.


id: cubrid_field_name
type: function
doc:
<comment>Description:</comment>
  Return the name of the specified field index
  
  This function returns the name of the specified field index on success or it returns FALSE on
  failure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>string</info>  Name of specified field index, on success.
          
          <info>false</info> on failure.


id: cubrid_field_seek
type: function
doc:
<comment>Description:</comment>
  Move the result set cursor to the specified field offset
  
  This function moves the result set cursor to the specified field offset. This offset is used by
  <strong>cubrid_fetch_field()</strong> if it doesn't include a field offset. It returns TRUE on success or FALSE on
  failure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> on success.
        
        <info>false</info> on failure.


id: cubrid_field_table
type: function
doc:
<comment>Description:</comment>
  Return the name of the table of the specified field
  
  This function returns the name of the table of the specified field. This is useful when using
  large select queries with JOINS.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>string</info>  Name of the table of the specified field, on success.
          
          <info>false</info> when invalid field_offset value.
          
          -1 if SQL sentence is not SELECT.


id: cubrid_field_type
type: function
doc:
<comment>Description:</comment>
  Return the type of the column corresponding to the given field offset
  
  This function returns the type of the column corresponding to the given field offset. The returned
  field type could be one of the following: "int", "real", "string", etc.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result      </strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$field_offset</strong>  The numerical field offset. The <strong>$field_offset</strong> starts at 0. If
                           <strong>$field_offset</strong> does not exist, an error of level <info>E_WARNING</info> is also issued.

<comment>Return:</comment>
  <info>string</info>  Type of the column, on success.
          
          <info>false</info> when invalid field_offset value.
          
          -1 if SQL sentence is not SELECT.


id: cubrid_free_result
type: function
doc:
<comment>Description:</comment>
  Free the memory occupied by the result data
  
  This function frees the memory occupied by the result data. It returns TRUE on success or FALSE on
  failure. Note that it can only frees the client fetch buffer now, and if you want free all memory,
  use function <strong>cubrid_close_request()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  This is the request identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> on success.
        
        <info>false</info> on failure.


id: cubrid_get
type: function
doc:
<comment>Description:</comment>
  Get a column using OID
  
  The <strong>cubrid_get()</strong> function is used to get the attribute of the instance of the given <strong>$oid</strong>.  You can
  get single attribute by using string data type for the <strong>$attr</strong> argument, or many attributes by using
  array data type for the <strong>$attr</strong> argument.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to read.
  <info>mixed   </info>  <strong>$attr           </strong>  Name of the attribute that you want to read.

<comment>Return:</comment>
  <info>mixed</info>  Content of the requested attribute, when process is successful; When <strong>$attr</strong> is set with
         string data type, the result is returned as a string; when <strong>$attr</strong> is set with array data
         type (0-based numerical array), then the result is returned in associative array. When
         <strong>$attr</strong> is omitted, then all attributes are received in array form.
         
         <info>false</info> when process is unsuccessful or result is NULL (If error occurs to distinguish empty
         string from NULL, then it prints the warning message. You can check the error by using
         <strong>cubrid_error_code()</strong>)

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


id: cubrid_get_autocommit
type: function
doc:
<comment>Description:</comment>
  Get auto-commit mode of the connection
  
  The <strong>cubrid_get_autocommit()</strong> function is used to get the status of CUBRID database connection
  auto-commit mode.
  
  For CUBRID 8.4.0, auto-commit mode is disabled by default for transaction management.
  
  For CUBRID 8.4.1, auto-commit mode is enabled by default for transaction management.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when auto-commit is on.
        
        <info>false</info>, when auto-commit is off.
        
        <info>null</info> on error.

<comment>See Also:</comment>
   * <strong>cubrid_set_autocommit()</strong>
   * <strong>cubrid_commit()</strong>


id: cubrid_get_charset
type: function
doc:
<comment>Description:</comment>
  Return the current CUBRID connection charset
  
  This function returns the current CUBRID connection charset and is similar to the CUBRID MySQL
  compatible function <strong>cubrid_client_encoding()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection.

<comment>Return:</comment>
  <info>string</info>  A string that represents the CUBRID connection charset; on success.
          
          <info>false</info> on failure.

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


id: cubrid_get_class_name
type: function
doc:
<comment>Description:</comment>
  Get the class name using OID
  
  The <strong>cubrid_get_class_name()</strong> function is used to get the class name from <strong>$oid</strong>. It doesn't work when
  selecting data from the system tables, for example db_class.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to check the existence.

<comment>Return:</comment>
  <info>string</info>  Class name when process is successful.
          
          <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_is_instance()</strong>
   * <strong>cubrid_drop()</strong>


id: cubrid_get_client_info
type: function
doc:
<comment>Description:</comment>
  Return the client library version
  
  This function returns a string that represents the client library version.

<comment>Return:</comment>
  <info>string</info>  A string that represents the client library version; on success.
          
          <info>false</info> on failure.


id: cubrid_get_db_parameter
type: function
doc:
<comment>Description:</comment>
  Returns the CUBRID database parameters
  
  This function returns the CUBRID database parameters or it returns FALSE on failure. It returns an
  associative array with the values for the following parameters:
  
  <info>PARAM_ISOLATION_LEVEL</info><info>PARAM_LOCK_TIMEOUT</info><info>PARAM_MAX_STRING_LENGTH</info><info>PARAM_AUTO_COMMIT</info>
  
  Database parametersParameterDescriptionPARAM_ISOLATION_LEVELThe transaction isolation
  level.LOCK_TIMEOUTCUBRID provides the lock timeout feature, which sets the waiting time (in
  seconds) for the lock until the transaction lock setting is allowed. The default value of the
  lock_timeout_in_secs parameter is -1, which means the application client will wait indefinitely
  until the transaction lock is allowed. PARAM_AUTO_COMMITIn CUBRID PHP, auto-commit mode is
  disabled by default for transaction management. It can be set by using <strong>cubrid_set_autocommit()</strong>.
  
  The following table shows the isolation levels from 1 to 6. It consists of table schema (row) and
  isolation level: Levels of Isolation Supported by CUBRIDNameDescriptionSERIALIZABLE (6)In this
  isolation level, problems concerning concurrency (e.g. dirty read, non-repeatable read, phantom
  read, etc.) do not occur.REPEATABLE READ CLASS with REPEATABLE READ INSTANCES (5)Another
  transaction T2 cannot update the schema of table A while transaction T1 is viewing table A.
  Transaction T1 may experience phantom read for the record R that was inserted by another
  transaction T2 when it is repeatedly retrieving a specific record.REPEATABLE READ CLASS with READ
  COMMITTED INSTANCES (or CURSOR STABILITY) (4)Another transaction T2 cannot update the schema of
  table A while transaction T1 is viewing table A. Transaction T1 may experience R read
  (non-repeatable read) that was updated and committed by another transaction T2 when it is
  repeatedly retrieving the record R.REPEATABLE READ CLASS with READ UNCOMMITTED INSTANCES
  (3)Default isolation level.  Another transaction T2 cannot update the schema of table A  while
  transaction T1 is viewing table A. Transaction T1 may experience R' read (dirty read) for the
  record that was updated but not committed by another transaction T2.READ COMMITTED CLASS with READ
  COMMITTED INSTANCES (2)Transaction T1 may experience A' read (non-repeatable read) for the table
  that was updated and committed by another transaction  T2 while it is viewing table A repeatedly.
  Transaction T1 may experience R' read (non-repeatable read) for the record that was updated and
  committed by another transaction T2 while it is retrieving the record R repeatedly.READ COMMITTED
  CLASS with READ UNCOMMITTED INSTANCES (1)Transaction T1 may experience A' read (non-repeatable
  read) for the table that was updated and committed by another transaction T2 while it is
  repeatedly viewing table A.  Transaction T1 may experience R' read (dirty read) for the record
  that was updated but not committed by another transaction T2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last link opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>array</info>  An associative array with CUBRID database parameters; on success.
         
         <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_set_db_parameter()</strong>
   * <strong>cubrid_get_autocommit()</strong>


id: cubrid_get_query_timeout
type: function
doc:
<comment>Description:</comment>
  Get the query timeout value of the request
  
  The <strong>cubrid_get_query_timeout()</strong> function is used to get the query timeout of the request.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.

<comment>Return:</comment>
  <info>int</info>  Success: the query timeout value of the current request. Units of msec.
       
       Failure: FALSE

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


id: cubrid_get_server_info
type: function
doc:
<comment>Description:</comment>
  Return the CUBRID server version
  
  This function returns a string that represents the CUBRID server version.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection.

<comment>Return:</comment>
  <info>string</info>  A string that represents the CUBRID server version; on success.
          
          <info>false</info> on failure.


id: cubrid_insert_id
type: function
doc:
<comment>Description:</comment>
  Return the ID generated for the last updated AUTO_INCREMENT column
  
  The <strong>cubrid_insert_id()</strong> function retrieves the ID generated for the AUTO_INCREMENT column which is
  updated by the previous INSERT query. It returns 0 if the previous query does not generate new
  rows, or FALSE on failure.
  
  CUBRID supports AUTO_INCREMENT for more than one columns in a table. In most cases, there will be
  a single AUTO_INCREMENT column in a table. If there are multiple AUTO_INCREMENT columns, this
  function should not be used even if it will return a value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The connection identifier previously obtained by a call to
                              <strong>cubrid_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  A string representing the ID generated for an AUTO_INCREMENT column by the previous query,
          on success.
          
          0, if the previous query does not generate new rows.
          
          <info>false</info> on failure.


id: cubrid_is_instance
type: function
doc:
<comment>Description:</comment>
  Check whether the instance pointed by OID exists
  
  The <strong>cubrid_is_instance()</strong> function is used to check whether the instance pointed by the given <strong>$oid</strong>
  exists or not.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to check the existence.

<comment>Return:</comment>
  <info>int</info>  1, if such instance exists;
       
       0, if such instance does not exist;
       
       -1, in case of error

<comment>See Also:</comment>
   * <strong>cubrid_drop()</strong>
   * <strong>cubrid_get_class_name()</strong>


id: cubrid_list_dbs
type: function
doc:
<comment>Description:</comment>
  Return an array with the list of all existing CUBRID databases
  
  This function returns an array with the list of all existing Cubrid databases.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection.

<comment>Return:</comment>
  <info>array</info>  An numeric array with all existing Cubrid databases; on success.
         
         <info>false</info> on failure.


id: cubrid_load_from_glo
type: function
doc:
<comment>Description:</comment>
  Read data from a GLO instance and save it in a file
  
  The <strong>cubrid_load_from_glo()</strong> function is used to read a data from a glo instance, and saves it in a
  designated file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  Oid of the glo instance that you want to read the data from.
  <info>string  </info>  <strong>$file_name      </strong>  Name of the file where you want to save the data in.

<comment>Return:</comment>
  <info>int</info>  <info>true</info>, when process is successful.
       
       <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_new_glo()</strong>
   * <strong>cubrid_save_to_glo()</strong>
   * <strong>cubrid_send_glo()</strong>


id: cubrid_lob2_bind
type: function
doc:
<comment>Description:</comment>
  Bind a lob object or a string as a lob object to a prepared statement as parameters
  
  The <strong>cubrid_lob2_bind()</strong> function is used to bind BLOB/CLOB datas to a corresponding question mark
  placeholder in the SQL statement that was passed  to <strong>cubrid_prepare()</strong>. If <strong>$bind_value_type</strong>  is not
  given, string will be "BLOB" as the default. But if you use <strong>cubrid_lob2_new()</strong> before,
  <strong>$bind_value_type</strong> will be consistent with <strong>$type</strong> in <strong>cubrid_lob2_new()</strong> as the default.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier </strong>  Request identifier as a result of <strong>cubrid_prepare()</strong>.
  <info>int     </info>  <strong>$bind_index     </strong>  Location of binding parameters. It starts with 1.
  <info>mixed   </info>  <strong>$bind_value     </strong>  Actual value for binding.
  <info>string  </info>  <strong>$bind_value_type</strong>  It must be "BLOB" or "CLOB" and it won't be case-sensitive. If it not
                              be given, the default value is "BLOB".

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_new()</strong>
   * <strong>cubrid_lob2_close()</strong>


id: cubrid_lob2_close
type: function
doc:
<comment>Description:</comment>
  Close LOB object
  
  The <strong>cubrid_lob2_close()</strong> function is used to close LOB object returned from <strong>cubrid_lob2_new()</strong> or
  got from the result set.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, on success.
        
        <info>false</info>, on failure.

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


id: cubrid_lob2_export
type: function
doc:
<comment>Description:</comment>
  Export the lob object to a file
  
  The <strong>cubrid_lob2_export()</strong> function is used to save the  contents of BLOB/CLOB data to a file. To
  use this function, you must use <strong>cubrid_lob2_new()</strong> or fetch a lob object from CUBRID  database
  first. If the file already exists, the operation will fail.  This function will not influence the
  cursor position of the lob object.  It operates the entire lob object.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>        </info>  <strong>$filename      </strong>  File name you want to store BLOB/CLOB data. It also supports the path
                             of the file.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the process is successful and <info>false</info> for failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_new()</strong>
   * <strong>cubrid_lob2_close()</strong>
   * <strong>cubrid_lob2_import()</strong>
   * <strong>cubrid_lob2_bind()</strong>


id: cubrid_lob2_import
type: function
doc:
<comment>Description:</comment>
  Import BLOB/CLOB data from a file
  
  The <strong>cubrid_lob2_import()</strong> function is used to save the contents of BLOB/CLOB data from a file. To
  use this function, you must use <strong>cubrid_lob2_new()</strong> or fetch a lob object from CUBRID database
  first. If the file already exists, the operation will fail.  This function will not influence the
  cursor position of the lob object.  It operates the entire lob object.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>        </info>  <strong>$filename      </strong>  File name you want to import BLOB/CLOB data. It also supports the path
                             of the file.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the process is successful and <info>false</info> for failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_new()</strong>
   * <strong>cubrid_lob2_close()</strong>
   * <strong>cubrid_lob2_export()</strong>
   * <strong>cubrid_lob2_bind()</strong>


id: cubrid_lob2_new
type: function
doc:
<comment>Description:</comment>
  Create a lob object
  
  The <strong>cubrid_lob2_new()</strong> function is used to create a lob object (both BLOB and CLOB).  This function
  should be used before you bind a lob object.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier. If the connection identifier is not specified,
                              the last connection opened by <strong>cubrid_connect()</strong> or
                              <strong>cubrid_connect_with_url()</strong> is assumed.
  <info>string  </info>  <strong>$type           </strong>  It may be "BLOB" or "CLOB", it won't be case-sensitive. The default
                              value is "BLOB".

<comment>Return:</comment>
  <info>resource</info>  Lob identifier when it is successful.
            
            <info>false</info>  on failure.

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


id: cubrid_lob2_read
type: function
doc:
<comment>Description:</comment>
  Read from BLOB/CLOB data
  
  The <strong>cubrid_lob2_read()</strong> function reads <strong>$len</strong> bytes from the  LOB data and returns the bytes read.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>int     </info>  <strong>$len           </strong>  Length from buffer you want to read from the lob data.

<comment>Return:</comment>
  <info>string</info>  Returns the contents as a string.
          
          <info>false</info> when there is no more data.
          
          NULL on failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_seek
type: function
doc:
<comment>Description:</comment>
  Move the cursor of a lob object
  
  The <strong>cubrid_lob2_seek()</strong> function is used to move the cursor position of a lob object by the value
  set in the <strong>$offset</strong> argument, to the direction set in the <strong>$origin</strong> argument.
  
  To set the <strong>$origin</strong> argument, you can use CUBRID_CURSOR_FIRST to set the cursor position moving
  forward <strong>$offset</strong> units from the first beginning. In this case, <strong>$offset</strong> must be a positive value.
  
  If you use CUBRID_CURSOR_CURRENT for <strong>$origin</strong>, you can move  forward or backward. and <strong>$offset</strong> can
  be positive or negative.
  
  If you use CUBRID_CURSOR_LAST for <strong>$origin</strong>, you can move  backward <strong>$offset</strong> units from the end of
  LOB object and <strong>$offset</strong> only can be positive.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>int     </info>  <strong>$offset        </strong>  Number of units you want to move the cursor.
  <info>int     </info>  <strong>$origin        </strong>  This parameter can be the following values:
                             
                             CUBRID_CURSOR_FIRST: move forward from the first beginning.
                             
                             CUBRID_CURSOR_CURRENT: move forward or backward from the current
                             position.
                             
                             CUBRID_CURSOR_LAST: move backward at the end of LOB object.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the process is successful and <info>false</info> for failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_seek64
type: function
doc:
<comment>Description:</comment>
  Move the cursor of a lob object
  
  The <strong>cubrid_lob2_seek64()</strong> function is used to move the cursor position of a lob object by the value
  set in the <strong>$offset</strong>  argument, to the direction set in the <strong>$origin</strong> argument.  If the <strong>$offset</strong> you
  want to move is larger than an integer  data can be stored, you can use this function.
  
  To set the <strong>$origin</strong> argument, you can use CUBRID_CURSOR_FIRST to set the cursor position moving
  forward <strong>$offset</strong> units from the first beginning. In this case, <strong>$offset</strong> must be a positive value.
  
  If you use CUBRID_CURSOR_CURRENT for <strong>$origin</strong>, you can move forward or backward. and <strong>$offset</strong> can be
  positive or negative.
  
  If you use CUBRID_CURSOR_LAST for <strong>$origin</strong>, you can move backward <strong>$offset</strong> units from the end of LOB
  object and <strong>$offset</strong> only can be positive.
  
  If you use this function to move the cursor position of the lob object, you should pass <strong>$offset</strong> as
  a string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>string  </info>  <strong>$offset        </strong>  Number of units you want to move the cursor.
  <info>int     </info>  <strong>$origin        </strong>  This parameter can be the following values:
                             
                             CUBRID_CURSOR_FIRST: move forward from the first beginning.
                             
                             CUBRID_CURSOR_CURRENT: move forward or backward from the current
                             position.
                             
                             CUBRID_CURSOR_LAST: move backward at the end of LOB object.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the process is successful and <info>false</info> for failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_size
type: function
doc:
<comment>Description:</comment>
  Get a lob object's size
  
  The <strong>cubrid_lob2_size()</strong> function is used to get the size of a lob object.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.

<comment>Return:</comment>
  <info>int</info>  It will return the size of the LOB object when it processes successfully.
       
       <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_size64
type: function
doc:
<comment>Description:</comment>
  Get a lob object's size
  
  The <strong>cubrid_lob2_size64()</strong> function is used to get the size of a lob object.  If the size of a lob
  object is larger than an integer data can be stored, you can use this function and it will return
  the size as a string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.

<comment>Return:</comment>
  <info>string</info>  It will return the size of the LOB object as a string when it processes successfully.
          
          <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>


id: cubrid_lob2_tell
type: function
doc:
<comment>Description:</comment>
  Tell the cursor position of the LOB object
  
  The <strong>cubrid_lob2_tell()</strong> function is used to tell the cursor position of the LOB object.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.

<comment>Return:</comment>
  <info>int</info>  It will return the cursor position on the LOB object when it processes successfully.
       
       <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_tell64
type: function
doc:
<comment>Description:</comment>
  Tell the cursor position of the LOB object
  
  The <strong>cubrid_lob2_tell64()</strong> function is used to tell the  cursor position of the LOB object. If the
  size of a lob object is larger than an integer data can be stored, you can use this function and
  it will return the position information as a string.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.

<comment>Return:</comment>
  <info>string</info>  It will return the cursor position on the LOB object as a string when it processes
          successfully.
          
          <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_write()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob2_write
type: function
doc:
<comment>Description:</comment>
  Write to a lob object
  
  The <strong>cubrid_lob2_write()</strong> function reads as much as data from <strong>$buf</strong> and stores it to the LOB object.
  Note that this function can only append characters now.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  Lob identifier as a result of <strong>cubrid_lob2_new()</strong> or get from the result
                             set.
  <info>string  </info>  <strong>$buf           </strong>  Data that need to be written to the lob object.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the process is successful and <info>false</info> for failure.

<comment>See Also:</comment>
   * <strong>cubrid_lob2_read()</strong>
   * <strong>cubrid_lob2_seek()</strong>
   * <strong>cubrid_lob2_seek64()</strong>
   * <strong>cubrid_lob2_tell()</strong>
   * <strong>cubrid_lob2_tell64()</strong>
   * <strong>cubrid_lob2_size()</strong>
   * <strong>cubrid_lob2_size64()</strong>


id: cubrid_lob_close
type: function
doc:
<comment>Description:</comment>
  Close BLOB/CLOB data
  
  <strong>cubrid_lob_close()</strong> is used to close all BLOB/CLOB returned from <strong>cubrid_lob_get()</strong>.

<comment>Param:</comment>
  <info>array</info>  <strong>$lob_identifier_array</strong>  LOB identifier array return from cubrid_lob_get.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob_get()</strong>
   * <strong>cubrid_lob_size()</strong>
   * <strong>cubrid_lob_export()</strong>
   * <strong>cubrid_lob_send()</strong>


id: cubrid_lob_export
type: function
doc:
<comment>Description:</comment>
  Export BLOB/CLOB data to file
  
  <strong>cubrid_lob_export()</strong> is used to get BLOB/CLOB data from CUBRID database, and saves its contents to
  a file. To use this function, you must use <strong>cubrid_lob_get()</strong> first to get BLOB/CLOB info from
  CUBRID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>resource</info>  <strong>$lob_identifier </strong>  LOB identifier.
  <info>string  </info>  <strong>$path_name      </strong>  Path name of the file.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob_get()</strong>
   * <strong>cubrid_lob_close()</strong>
   * <strong>cubrid_lob_size()</strong>
   * <strong>cubrid_lob_send()</strong>


id: cubrid_lob_get
type: function
doc:
<comment>Description:</comment>
  Get BLOB/CLOB data
  
  <strong>cubrid_lob_get()</strong> is used to get BLOB/CLOB meta info from CUBRID database,  CUBRID gets BLOB/CLOB
  by executing the SQL statement, and returns all LOBs as a resource array.  Be sure that the SQL
  retrieves only one column and its data type is BLOB or CLOB.
  
  Remember to use <strong>cubrid_lob_close()</strong> to release the LOBs if you don't need it any more.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$sql            </strong>  SQL statement to be executed.

<comment>Return:</comment>
  <info>array</info>  Return an array of LOB resources, when process is successful.
         
         <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob_close()</strong>
   * <strong>cubrid_lob_size()</strong>
   * <strong>cubrid_lob_export()</strong>
   * <strong>cubrid_lob_send()</strong>


id: cubrid_lob_send
type: function
doc:
<comment>Description:</comment>
  Read BLOB/CLOB data and send straight to browser
  
  <strong>cubrid_lob_send()</strong> reads BLOB/CLOB data and passes it straight through to the browser.   To use
  this function, you must use <strong>cubrid_lob_get()</strong> first to get BLOB/CLOB info from CUBRID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>resource</info>  <strong>$lob_identifier </strong>  LOB identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob_get()</strong>
   * <strong>cubrid_lob_close()</strong>
   * <strong>cubrid_lob_size()</strong>
   * <strong>cubrid_lob_export()</strong>


id: cubrid_lob_size
type: function
doc:
<comment>Description:</comment>
  Get BLOB/CLOB data size
  
  <strong>cubrid_lob_size()</strong> is used to get BLOB/CLOB data size.

<comment>Param:</comment>
  <info>resource</info>  <strong>$lob_identifier</strong>  LOB identifier.

<comment>Return:</comment>
  <info>string</info>  A string representing LOB data size, when process is successful.
          
          <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_lob_get()</strong>
   * <strong>cubrid_lob_close()</strong>
   * <strong>cubrid_lob_export()</strong>
   * <strong>cubrid_lob_send()</strong>


id: cubrid_lock_read
type: function
doc:
<comment>Description:</comment>
  Set a read lock on the given OID
  
  The <strong>cubrid_lock_read()</strong> function is used to put read lock on the instance pointed by given <strong>$oid</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to put read lock on.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_lock_write
type: function
doc:
<comment>Description:</comment>
  Set a write lock on the given OID
  
  The <strong>cubrid_lock_write()</strong> function is used to put write lock on the instance pointed by the given
  <strong>$oid</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to put write lock on.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_move_cursor
type: function
doc:
<comment>Description:</comment>
  Move the cursor in the result
  
  The <strong>cubrid_move_cursor()</strong> function is used to move the current cursor location of <strong>$req_identifier</strong>
  by the value set in the <strong>$offset</strong> argument, to the direction set in the <strong>$origin</strong> argument. To set the
  <strong>$origin</strong> argument, you can use CUBRID_CURSOR_FIRST for the first part of the result,
  CUBRID_CURSOR_CURRENT for the current location of the result, or CUBRID_CURSOR_LAST for the last
  part of the result.  If <strong>$origin</strong> argument is not explicitly designated, then the function uses
  CUBRID_CURSOR_CURRENT as its default value.
  
  If the value of cursor movement range goes over the valid limit, then the cursor moves to the next
  location after the valid range for the cursor. For example, if you move 20 units in the result
  with the size of 10, then the cursor will move to 11th place and return CUBRID_NO_MORE_DATA.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.
  <info>int     </info>  <strong>$offset        </strong>  Number of units you want to move the cursor.
  <info>int     </info>  <strong>$origin        </strong>  Location where you want to move the cursor from CUBRID_CURSOR_FIRST,
                             CUBRID_CURSOR_CURRENT, CUBRID_CURSOR_LAST.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsucceful.

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


id: cubrid_new_glo
type: function
doc:
<comment>Description:</comment>
  Create a glo instance
  
  The <strong>cubrid_new_glo()</strong> function is used to create a glo instance in the requested class (glo class).
  The glo created is a LO type, and is stored in the <strong>$file_name</strong> file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$class_name     </strong>  Name of the class that you want to create a glo in.
  <info>string  </info>  <strong>$file_name      </strong>  The file name that you want to save in the newly created glo.

<comment>Return:</comment>
  <info>string</info>  Oid of the instance created, when process is successful.
          
          <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_save_to_glo()</strong>
   * <strong>cubrid_load_from_glo()</strong>
   * <strong>cubrid_send_glo()</strong>


id: cubrid_next_result
type: function
doc:
<comment>Description:</comment>
  Get result of next query when executing multiple SQL statements
  
  The <strong>cubrid_next_result()</strong> function is used to get results of next query if multiple SQL statements
  are executed and CUBRID_EXEC_QUERY_ALL flag is set upon <strong>cubrid_execute()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_num_cols
type: function
doc:
<comment>Description:</comment>
  Return the number of columns in the result set
  
  The <strong>cubrid_num_cols()</strong> function is used to get the number of columns from the query result. It can
  only be used when the query executed is a select statement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  Result.

<comment>Return:</comment>
  <info>int</info>  Number of columns, when process is successful.
       
       <info>false</info>, if SQL statement is not SELECT.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_num_rows()</strong>


id: cubrid_num_fields
type: function
doc:
<comment>Description:</comment>
  Return the number of columns in the result set
  
  This function returns the number of columns in the result set, on success, or it returns FALSE on
  failure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>, <strong>cubrid_query()</strong> and
                     <strong>cubrid_prepare()</strong>

<comment>Return:</comment>
  <info>int</info>  Number of columns, on success.
       
       -1 if SQL sentence is not SELECT.
       
       <info>false</info> when process is unsuccessful.


id: cubrid_num_rows
type: function
doc:
<comment>Description:</comment>
  Get the number of rows in the result set
  
  The <strong>cubrid_num_rows()</strong> function is used to get the number of rows from the query result.  You can
  use it only when the query executed is a select statement.  When you want to know such value for
  INSERT, UPDATE, or DELETE query, you have to use the <strong>cubrid_affected_rows()</strong> function.
  
  Note: The <strong>cubrid_num_rows()</strong> function can only be used for synchronous query; it returns 0 when it
  is used for asynchronous query.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>, <strong>cubrid_query()</strong> and
                     <strong>cubrid_prepare()</strong>

<comment>Return:</comment>
  <info>int</info>  Number of rows, when process is successful.
       
       0 when the query was done in async mode.
       
       -1, if SQL statement is not SELECT.
       
       <info>false</info> when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_num_cols()</strong>
   * <strong>cubrid_affected_rows()</strong>


id: cubrid_pconnect
type: function
doc:
<comment>Description:</comment>
  Open a persistent connection to a CUBRID server
  
  Establishes a persistent connection to a CUBRID server.
  
  <strong>cubrid_pconnect()</strong> acts very much like <strong>cubrid_connect()</strong> with two major differences.
  
  First, when connecting, the function would first try to find a (persistent) link that's already
  open with the same host, port, dbname and userid. If one is found, an identifier for it will be
  returned instead of opening a new connection.
  
  Second, the connection to the SQL server will not be closed when the execution of the script ends.
  Instead, the link will remain open for future use (<strong>cubrid_close()</strong> or <strong>cubrid_disconnect()</strong> will not
  close links established by <strong>cubrid_pconnect()</strong>).
  
  This type of link is therefore called 'persistent'.

<comment>Param:</comment>
  <info>string</info>  <strong>$host  </strong>  Host name or IP address of CUBRID CAS server.
  <info>int   </info>  <strong>$port  </strong>  Port number of CUBRID CAS server (BROKER_PORT configured in
                   $CUBRID/conf/cubrid_broker.conf).
  <info>string</info>  <strong>$dbname</strong>  Name of database.
  <info>string</info>  <strong>$userid</strong>  User name for the database.
  <info>string</info>  <strong>$passwd</strong>  User password.

<comment>Return:</comment>
  <info>resource</info>  Connection identifier, when process is successful.
            
            <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_connect_with_url()</strong>
   * <strong>cubrid_pconnect_with_url()</strong>
   * <strong>cubrid_disconnect()</strong>
   * <strong>cubrid_close()</strong>


id: cubrid_pconnect_with_url
type: function
doc:
<comment>Description:</comment>
  Open a persistent connection to CUBRID server
  
  Establishes a persistent connection to a CUBRID server.
  
  <strong>cubrid_pconnect_with_url()</strong> acts very much like <strong>cubrid_connect_with_url()</strong> with two major
  differences.
  
  First, when connecting, the function would first try to find a (persistent) link that's already
  open with the same host, port, dbname and userid. If one is found, an identifier for it will be
  returned instead of opening a new connection.
  
  Second, the connection to the SQL server will not be closed when the execution of the script ends.
  Instead, the link will remain open for future use (<strong>cubrid_close()</strong> or <strong>cubrid_disconnect()</strong> will not
  close links established by <strong>cubrid_pconnect_with_url()</strong>).
  
  This type of link is therefore called 'persistent'.
  
  \<url&gt; ::= CUBRID:\<host&gt;:\<db_name&gt;:\<db_user&gt;:\<db_password&gt;:[?\<properties&gt;]
  
  \<properties&gt; ::= \<property&gt; [&\<property&gt;]
  
  \<properties&gt; ::= alhosts=\<alternative_hosts&gt;[ &rctime=\<time&gt;]
  
  \<properties&gt; ::= login_timeout=\<milli_sec&gt;
  
  \<properties&gt; ::= query_timeout=\<milli_sec&gt;
  
  \<properties&gt; ::= disconnect_on_query_timeout=true|false
  
  \<alternative_hosts&gt; ::= \<standby_broker1_host&gt;:\<port&gt; [,\<standby_broker2_host&gt;:\<port&gt;]
  
  \<host&gt; := HOSTNAME | IP_ADDR
  
  \<time&gt; := SECOND
  
  \<milli_sec&gt; := MILLI SECOND
  
  host : A host name or IP address of the master databasedb_name : A name of the databasedb_user : A
  name of the database userdb_password : A database user password alhosts : Specifies the broker
  information of the standby server, which is used for failover when it is impossible to connect to
  the active server.  You can specify multiple brokers for failover, and the connection to the
  brokers is attempted in the order listed in alhosts rctime : An interval between the attempts to
  connect to the active broker in which failure occurred. After a failure occurs, the system
  connects to the  broker specified by althosts (failover), terminates the transaction, and then
  attempts to connect to the active broker of the master database at every rctime.  The default
  value is 600 seconds. login_timeout : Timeout value (unit: msec.) for database login. The default
  value is 0, which means infinite postponement.  query_timeout : Timeout value (unit: msec.) for
  query request. Upon timeout, a message to cancel requesting a query transferred to server is sent.
  The return  value can depend on the disconnect_on_query_timeout configuration; even though the
  message to cancel a request is sent to server, that request may succeed.
  disconnect_on_query_timeout : Configures a value whether to immediately return an error of
  function being executed upon timeout. The default value is false.
  
  <return>?</return> and <return>:</return> that are used as identifiers in PHP connection URL can't be included in the password. The
  following is an example of a password that is invalid to use as connection URL because it contains
  "<return>?:</return>".
  
  $url = "CUBRID:localhost:33000:tdb:dba:12?:?login_timeout=100";
  
  Passwords that contain <return>?</return> or <return>:</return> may be passed as a separate parameter.
  
  $url = "CUBRID:localhost:33000:tbd:::?login_timeout=100";
  
  $conn = cubrid_pconnect_with_url ($url, "dba", "12?");
  
  If user or password is empty,you can't delete "<return>:</return>",the following is an example.
  
  $url = "CUBRID:localhost:33000:demodb:::";

<comment>Param:</comment>
  <info>string</info>  <strong>$conn_url</strong>  A character string that contains server connection information.
  <info>string</info>  <strong>$userid  </strong>  User name for the database.
  <info>string</info>  <strong>$passwd  </strong>  User password.

<comment>Return:</comment>
  <info>resource</info>  Connection identifier, when process is successful.
            
            <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_connect_with_url()</strong>
   * <strong>cubrid_pconnect()</strong>
   * <strong>cubrid_disconnect()</strong>
   * <strong>cubrid_close()</strong>


id: cubrid_ping
type: function
doc:
<comment>Description:</comment>
  Ping a server connection or reconnect if there is no connection
  
  Checks whether or not the connection to the server is working.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection identifier. If the connection identifier is not
                              specified, the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the connection to the server CUBRID server is working, otherwise <info>false</info>.


id: cubrid_prepare
type: function
doc:
<comment>Description:</comment>
  Prepare a SQL statement for execution
  
  The <strong>cubrid_prepare()</strong> function is a sort of API which represents SQL statements  compiled
  previously to a given connection handle. This pre-compiled SQL statement will be included  in the
  <strong>cubrid_prepare()</strong>.
  
  Accordingly, you can use this statement effectively to execute several times repeatedly or to
  process long data. Only a single statement can be used and a parameter may put a question mark (?)
  to appropriate area in the SQL statement. Add a parameter when you bind a value in the VALUES
  clause of INSERT statement or in the WHERE clause. Note that it is allowed to bind a value to a
  MARK(?) by using the <strong>cubrid_bind()</strong> function only.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$prepare_stmt   </strong>  Prepare query.
  <info>int     </info>  <strong>$option         </strong>  OID return option CUBRID_INCLUDE_OID.

<comment>Return:</comment>
  <info>resource</info>  Request identifier, if process is successful;
            
            <info>false</info>, if process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_execute()</strong>
   * <strong>cubrid_bind()</strong>


id: cubrid_put
type: function
doc:
<comment>Description:</comment>
  Update a column using OID
  
  The <strong>cubrid_put()</strong> function is used to update an attribute of the instance of the given <strong>$oid</strong>.
  
  You can update single attribute by using string data type to set <strong>$attr</strong>.  In such case, you can use
  integer, floating point or string type data for the <strong>$value</strong> argument. To update multiple number of
  attributes, you can disregard the <strong>$attr</strong> argument, and set <strong>$value</strong> argument with associative array
  data type.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance that you want to update.
  <info>string  </info>  <strong>$attr           </strong>  Name of the attribute that you want to update.
  <info>mixed   </info>  <strong>$value          </strong>  New value that you want to assign to the attribute.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_get()</strong>
   * <strong>cubrid_set_add()</strong>
   * <strong>cubrid_set_drop()</strong>
   * <strong>cubrid_seq_insert()</strong>
   * <strong>cubrid_seq_drop()</strong>
   * <strong>cubrid_seq_put()</strong>


id: cubrid_query
type: function
doc:
<comment>Description:</comment>
  Send a CUBRID query
  
  <strong>cubrid_query()</strong> sends a unique query (multiple queries are not supported) to the  currently active
  database on the server that's associated with the specified <strong>$conn_identifier</strong>.

<comment>Param:</comment>
  <info>string  </info>  <strong>$query          </strong>  An SQL query
                              
                              Data inside the query should be properly escaped.
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>resource</info>  For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset,
            <strong>cubrid_query()</strong> returns a <info>resource</info> on success, or <info>false</info> on error.
            
            For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc, <strong>cubrid_query()</strong>
            returns <info>true</info> on success or <info>false</info> on error.
            
            The returned result resource should be passed to <strong>cubrid_fetch_array()</strong>, and other
            functions for dealing with result tables, to access the returned data.
            
            Use <strong>cubrid_num_rows()</strong> to find out how many rows were returned for a SELECT statement or
            <strong>cubrid_affected_rows()</strong> to find out how many rows were affected by a DELETE, INSERT,
            REPLACE, or UPDATE statement.
            
            <strong>cubrid_query()</strong> will also fail and return <info>false</info> if the user does not have permission to
            access the table(s) referenced by the query.

<comment>See Also:</comment>
   * <strong>cubrid_connect()</strong>
   * <strong>cubrid_error()</strong>
   * <strong>cubrid_real_escape_string()</strong>
   * <strong>cubrid_result()</strong>
   * <strong>cubrid_fetch_assoc()</strong>
   * <strong>cubrid_unbuffered_query()</strong>


id: cubrid_real_escape_string
type: function
doc:
<comment>Description:</comment>
  Escape special characters in a string for use in an SQL statement
  
  This function returns the escaped string version of the given string. It will escape the following
  characters: <info>'</info>.
   In general, single quotations are used to enclose character string. Double quotations may be used
  as well depending on the value of ansi_quotes, which is a parameter related to SQL statement. If
  the ansi_quotes value is set to no, character string enclosed by double quotations is handled as
  character string, not as an identifier. The default value is yes.
   If you want to include a single quote as part of a character string, enter two single quotes in a
  row.

<comment>Param:</comment>
  <info>string  </info>  <strong>$unescaped_string</strong>  The string that is to be escaped.
  <info>resource</info>  <strong>$conn_identifier </strong>  The CUBRID connection. If the connection identifier is not specified,
                               the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>string</info>  Escaped string version of the given string, on success.
          
          <info>false</info> on failure.


id: cubrid_result
type: function
doc:
<comment>Description:</comment>
  Return the value of a specific field in a specific row
  
  This function returns the value of a specific field in a specific row from a result set.

<comment>Param:</comment>
  <info>resource</info>  <strong>$result</strong>  <strong>$result</strong> comes from a call to <strong>cubrid_execute()</strong>
  <info>int     </info>  <strong>$row   </strong>  The row number from the result that is being retrieved. Row numbers start at 0.
  <info>mixed   </info>  <strong>$field </strong>  The name or offset of the <strong>$field</strong> being retrieved. It can be the field's offset,
                     the field's name, or the field's table dot field name (tablename.fieldname). If
                     the column name has been aliased ('select foo as bar from...'), use the alias
                     instead of the column name. If undefined, the first field is retrieved.

<comment>Return:</comment>
  <info>string</info>  Value of a specific field, on success (NULL if value if null).
          
          <info>false</info> on failure.


id: cubrid_rollback
type: function
doc:
<comment>Description:</comment>
  Roll back a transaction
  
  The <strong>cubrid_rollback()</strong> function executes rollback on the transaction pointed by <strong>$conn_identifier</strong>,
  currently in progress.
  
  Connection to server is closed after calling <strong>cubrid_rollback()</strong>. Connection handle, however, is
  still valid.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_commit()</strong>
   * <strong>cubrid_disconnect()</strong>


id: cubrid_save_to_glo
type: function
doc:
<comment>Description:</comment>
  Save requested file in a GLO instance
  
  The <strong>cubrid_save_to_glo()</strong> function is used to save requested file in a glo instance.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  Oid of the glo instance that you want to save a file in.
  <info>string  </info>  <strong>$file_name      </strong>  The name of the file that you want to save.

<comment>Return:</comment>
  <info>int</info>  <info>true</info>, when process is successful.
       
       <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_new_glo()</strong>
   * <strong>cubrid_load_from_glo()</strong>
   * <strong>cubrid_send_glo()</strong>


id: cubrid_schema
type: function
doc:
<comment>Description:</comment>
  Get the requested schema information
  
  The <strong>cubrid_schema()</strong> function is used to get the requested schema information from database. You
  have to designate <strong>$class_name</strong>, if you want to get information on certain class, <strong>$attr_name</strong>, if you
  want to get information on certain attribute (can be used only with CUBRID_ SCH_ATTR_PRIVILEGE).
  
  The result of the cubrid_schema function is returned as a two-dimensional array (column
  (associative array) * row (numeric array)). The following tables shows types of schema and the
  column structure of the result array to be returned based on the schema type.
  
  Result Composition of Each TypeSchemaColumn NumberColumn
  NameValueCUBRID_SCH_CLASS1NAME2TYPE0:system class 1:vclass
  2:classCUBRID_SCH_VCLASS1NAME2TYPE1:vclassCUBRID_SCH_QUERY_SPEC1QUERY_SPECCUBRID_SCH_ATTRIBUTE /
  CUBRID_SCH_CLASS_ATTRIBUTE1ATTR_NAME2DOMAIN3SCALE4PRECISION5INDEXED1:indexed6NOT NULL1:not
  null7SHARED1:shared8UNIQUE1:unique9DEFAULT10ATTR_ORDERbase:111CLASS_NAME12SOURCE_CLASS13IS_KEY1:keyCUBRID_SCH_METHOD
  /
  CUBRID_SCH_CLASS_METHOD1NAME2RET_DOMAIN3ARG_DOMAINCUBRID_SCH_METHOD_FILE1METHOD_FILECUBRID_SCH_SUPERCLASS
  / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS1CLASS_NAME2TYPE0:system class 1:vclass
  2:classCUBRID_SCH_CONSTRAINT1TYPE0:unique 1:index 2:reverse unique 3:reverse
  index2NAME3ATTR_NAME4NUM_PAGES5NUM_KEYS6PRIMARY_KEY1:primary
  key7KEY_ORDERbase:1CUBRID_SCH_TRIGGER1NAME2STATUS3EVENT4TARGET_CLASS5TARGET_ATTR6ACTION_TIME7ACTION8PRIORITY9CONDITION_TIME10CONDITIONCUBRID_SCH_CLASS_PRIVILEGE
  / CUBRID_SCH_ATTR_PRIVILEGE1CLASS_NAME /
  ATTR_NAME2PRIVILEGE3GRANTABLECUBRID_SCH_PRIMARY_KEY1CLASS_NAME2ATTR_NAME3KEY_SEQbase:14KEY_NAMECUBRID_SCH_IMPORTED_KEYS
  / CUBRID_SCH_EXPORTED_KEYS /
  CUBRID_SCH_CROSS_REFERENCE1PKTABLE_NAME2PKCOLUMN_NAME3FKTABLE_NAMEbase:14FKCOLUMN_NAME5KEY_SEQbase:16UPDATE_ACTION0:cascade
  1:restrict 2:no action 3:set null7DELETE_ACTION0:cascade 1:restrict 2:no action 3:set
  null8FK_NAME9PK_NAME

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>int     </info>  <strong>$schema_type    </strong>  Schema data that you want to know.
  <info>string  </info>  <strong>$class_name     </strong>  Class you want to know the schema of.
  <info>string  </info>  <strong>$attr_name      </strong>  Attribute you want to know the schema of.

<comment>Return:</comment>
  <info>array</info>  Array containing the schema information, when process is successful;
         
         <info>false</info>, when process is unsuccessful


id: cubrid_send_glo
type: function
doc:
<comment>Description:</comment>
  Read data from glo and send it to std output
  
  The <strong>cubrid_send_glo()</strong> function is used to read data from glo instance and sends it to the PHP
  standard output.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  Oid of the glo instance that you want to read data from.

<comment>Return:</comment>
  <info>int</info>  <info>true</info>, when process is successful.
       
       <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_new_glo()</strong>
   * <strong>cubrid_save_to_glo()</strong>
   * <strong>cubrid_load_from_glo()</strong>


id: cubrid_seq_drop
type: function
doc:
<comment>Description:</comment>
  Delete an element from sequence type column using OID
  
  The <strong>cubrid_seq_drop()</strong> function is used to delete an element you request from the given sequence
  type attribute in the database.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute that you want to delete an element from.
  <info>int     </info>  <strong>$index          </strong>  Index of the element that you want to delete (1-based).

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_seq_insert()</strong>
   * <strong>cubrid_seq_put()</strong>


id: cubrid_seq_insert
type: function
doc:
<comment>Description:</comment>
  Insert an element to a sequence type column using OID
  
  The <strong>cubrid_col_insert()</strong> function is used to insert an element to a sequence type attribute in a
  requested location.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute you want to insert an instance to.
  <info>int     </info>  <strong>$index          </strong>  Location of the element, you want to insert the element to (1-based).
  <info>string  </info>  <strong>$seq_element    </strong>  Content of the element that you want to insert.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_seq_drop()</strong>
   * <strong>cubrid_seq_put()</strong>


id: cubrid_seq_put
type: function
doc:
<comment>Description:</comment>
  Update the element value of sequence type column using OID
  
  The <strong>cubrid_seq_put()</strong> function is used to update the content of the requested element in a sequent
  type attribute using OID.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute that you want to update an element.
  <info>int     </info>  <strong>$index          </strong>  Index (1-based) of the element that you want to update.
  <info>string  </info>  <strong>$seq_element    </strong>  New content that you want to use for the update.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_seq_drop()</strong>
   * <strong>cubrid_seq_insert()</strong>


id: cubrid_set_add
type: function
doc:
<comment>Description:</comment>
  Insert a single element to set type column using OID
  
  The <strong>cubrid_set_add()</strong> function is used to insert a single element to a set type attribute (set,
  multiset, sequence) you requested.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute you want to insert an element.
  <info>string  </info>  <strong>$set_element    </strong>  Content of the element you want to insert.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_set_autocommit
type: function
doc:
<comment>Description:</comment>
  Set autocommit mode of the connection
  
  The <strong>cubrid_set_autocommit()</strong> function is used to set the CUBRID database auto-commit mode of the
  current database connection.
  
  In CUBRID PHP, auto-commit mode is disabled by default for transaction management. When
  auto-commit mode is truned from off to on, any pending work is automatically committed.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>bool    </info>  <strong>$mode           </strong>  Auto-commit mode. The following constants can be used:
                              
                              <info>CUBRID_AUTOCOMMIT_FALSE</info><info>CUBRID_AUTOCOMMIT_TRUE</info>

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

<comment>See Also:</comment>
   * <strong>cubrid_get_autocommit()</strong>
   * <strong>cubrid_commit()</strong>


id: cubrid_set_db_parameter
type: function
doc:
<comment>Description:</comment>
  Sets the CUBRID database parameters
  
  The <strong>cubrid_set_db_parameter()</strong> function is used to set the CUBRID database parameters. It can set
  the following CUBRID database parameters:
  
  <info>PARAM_ISOLATION_LEVEL</info><info>PARAM_LOCK_TIMEOUT</info>
  
  The auto-commit mode can be set by using <strong>cubrid_set_autocommit()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last link opened by <strong>cubrid_connect()</strong> is assumed.
  <info>int     </info>  <strong>$param_type     </strong>  Database parameter type.
  <info>int     </info>  <strong>$param_value    </strong>  Isolation level value (1-6) or lock timeout (in seconds) value.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> on success.
        
        <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>cubrid_get_db_parameter()</strong>
   * <strong>cubrid_set_autocommit()</strong>


id: cubrid_set_drop
type: function
doc:
<comment>Description:</comment>
  Delete an element from set type column using OID
  
  The <strong>cubrid_set_drop()</strong> function is used to delete an element that you request from the given set
  type (set, multiset) attribute of the database.

<comment>Param:</comment>
  <info>resource</info>  <strong>$conn_identifier</strong>  Connection identifier.
  <info>string  </info>  <strong>$oid            </strong>  OID of the instance you want to work with.
  <info>string  </info>  <strong>$attr_name      </strong>  Name of the attribute you want to delete an element from.
  <info>string  </info>  <strong>$set_element    </strong>  Content of the element you want to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_set_query_timeout
type: function
doc:
<comment>Description:</comment>
  Set the timeout time of query execution
  
  The <strong>cubrid_set_query_timeout()</strong> function is used to set the timeout time of query execution.

<comment>Param:</comment>
  <info>resource</info>  <strong>$req_identifier</strong>  Request identifier.
  <info>int     </info>  <strong>$timeout       </strong>  Timeout time, unit of msec.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info>, when process is successful.
        
        <info>false</info>, when process is unsuccessful.

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


id: cubrid_unbuffered_query
type: function
doc:
<comment>Description:</comment>
  Perform a query without fetching the results into memory
  
  This function performs a query without waiting for that all query results have been complete. It
  will return  when the results are being generated.

<comment>Param:</comment>
  <info>string  </info>  <strong>$query          </strong>  A SQL query.
  <info>resource</info>  <strong>$conn_identifier</strong>  The CUBRID connection. If the connection identifier is not specified,
                              the last connection opened by <strong>cubrid_connect()</strong> is assumed.

<comment>Return:</comment>
  <info>resource</info>  For SELECT, SHOW, DESCRIBE or EXPLAIN statements returns a request identifier resource
            on success.
            
            For other type of SQL statements, UPDATE, DELETE, DROP, etc, returns <info>true</info> on success.
            
            <info>false</info> on failure.


id: cubrid_version
type: function
doc:
<comment>Description:</comment>
  Get the CUBRID PHP module's version
  
  The <strong>cubrid_version()</strong> function is used to get the CUBRID PHP module's version.

<comment>Return:</comment>
  <info>string</info>  Version information (eg. "8.3.1.0001").

<comment>See Also:</comment>
   * <strong>cubrid_error_code()</strong>
   * <strong>cubrid_error_code_facility()</strong>


id: curl_close
type: function
doc:
<comment>Description:</comment>
  Chiude una sessione cURL
  
  Chiude una sessione cURL e libera tutte le risorse.  Anche il gestore cURL, <strong>$ch</strong>, viene eliminato.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
                 <strong>curl_init()</strong>.

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

<comment>See Also:</comment>
   * <strong>curl_init()</strong>
   * <strong>curl_multi_close()</strong>


id: curl_copy_handle
type: function
doc:
<comment>Description:</comment>
  Copy a cURL handle along with all of its preferences
  
  Copies a cURL handle keeping the same preferences.

<comment>Param:</comment>
  <info></info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
         <strong>curl_init()</strong>.

<comment>Return:</comment>
  <info>CurlHandlefalse</info>  Returns a new cURL handle,  o <info>false</info> in caso di fallimento.


id: curl_errno
type: function
doc:
<comment>Description:</comment>
  Restituisce il numero dell'ultimo errore
  
  Restituisce il numero dell'errore per l'ultima operazione cURL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
                 <strong>curl_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Restituisce il numero dell'errore o <return>0</return> (zero) se non si è verificato nessun errore.

<comment>See Also:</comment>
   * <strong>curl_error()</strong>
   * Curl error codes


id: curl_error
type: function
doc:
<comment>Description:</comment>
  Restituisce una stringa contenente l'ultimo errore relativo alla sessione corrente
  
  Restituisce un messaggio di errore esplicativo per l'ultima operazione cURL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
                 <strong>curl_init()</strong>.

<comment>Return:</comment>
  <info>string</info>  Restituisce il messaggio di errore o <return>''</return> (la stringa vuota) se non si verifica nessun
          errore.

<comment>See Also:</comment>
   * <strong>curl_errno()</strong>
   * Codici di errore di curl


id: curl_escape
type: function
doc:
<comment>Description:</comment>
  URL encodes the given string
  
  This function URL encodes the given string according to RFC 3986.

<comment>Param:</comment>
  <info>      </info>  <strong>$ch    </strong>  Un identificativo cURL restituito da 
                   <strong>curl_init()</strong>.
  <info>string</info>  <strong>$string</strong>  The string to be encoded.

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

<comment>See Also:</comment>
   * <strong>curl_unescape()</strong>
   * <strong>urlencode()</strong>
   * <strong>rawurlencode()</strong>
   * RFC 3986


id: curl_exec
type: function
doc:
<comment>Description:</comment>
  Esegue una sessione cURL
  
  Esegue la sessione cURL data.
  
  Questa funzione dovrebbe essere chiamata dopo aver inizializzato una sessione cURL e dopo aver
  impostato tutte le opzioni per la sessione.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
                 <strong>curl_init()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Restituisce <info>true</info> in caso di successo, <info>false</info> in caso di fallimento. Tuttavia, se l'opzione
         <info>CURLOPT_RETURNTRANSFER</info> è set, essa restituirà il risultato in caso di successo, <info>false</info> in
         caso di fallimento.

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


id: curl_file_create
type: function
doc:
<comment>Description:</comment>
  Create a CURLFile object
  
  Questa funzione è sinonimo di:  CURLFile::__construct


id: curl_getinfo
type: function
doc:
<comment>Description:</comment>
  Ottiene informazioni riguardo ad uno specifico trasferimento
  
  Ottiene informazioni sull'ultimo trasferimento.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ch </strong>  Un identificativo cURL restituito da 
                  <strong>curl_init()</strong>.
  <info>int     </info>  <strong>$opt</strong>  Questo potrebbe essere una delle seguenti costanti: <info>CURLINFO_EFFECTIVE_URL</info> -
                  L'ultimo URL effettivo <info>CURLINFO_HTTP_CODE</info> - L'ultimo codice HTTP ricevuto
                  <info>CURLINFO_FILETIME</info> - L'orario remoto del documento recuperato, se viene restituito
                  -1 l'orario del documento è sconosciuto <info>CURLINFO_TOTAL_TIME</info> - Il tempo totale in
                  secondi della transazione per l'ultimo trasferimento <info>CURLINFO_NAMELOOKUP_TIME</info> - Il
                  tempo in secondi finchè la risoluzione dei nomi non è stata completata
                  <info>CURLINFO_CONNECT_TIME</info> - Il tempo in secondi impiegato per stabilire la connessione
                  <info>CURLINFO_PRETRANSFER_TIME</info> - Il tempo in secondi dall'inizio fino a poco prima che
                  il trasferimento del file cominciasse <info>CURLINFO_STARTTRANSFER_TIME</info> - Il tempo in
                  secondi fino a quando il primo byte è in procinto di essere trasferito
                  <info>CURLINFO_REDIRECT_COUNT</info> - Il numero dei reindirizzamenti, con l'opzione
                  <info>CURLOPT_FOLLOWLOCATION</info> abilitata <info>CURLINFO_REDIRECT_TIME</info> - Il tempo in secondi di
                  tutti le fasi di reindirizzamento prima che la transazione finale non venga
                  avviata, con l'opzione <info>CURLOPT_FOLLOWLOCATION</info> abilitata <info>CURLINFO_REDIRECT_URL</info> -
                  Con l'opzione <info>CURLOPT_FOLLOWLOCATION</info> disabilitata: l'URL di reindirizzamento
                  trovato nell'ultima transazione, che dovrebbe essere richiesto manualmente dopo.
                  Con l'opzione <info>CURLOPT_FOLLOWLOCATION</info> abilitata: questo è vuoto. L'URL di
                  reindirizzamento in questo caso è disponibile in <info>CURLINFO_EFFECTIVE_URL</info>
                  <info>CURLINFO_PRIMARY_IP</info> - L'indirizzo IP della connessione più recente
                  <info>CURLINFO_PRIMARY_PORT</info> - La porta di destinazione della connessione più recente
                  <info>CURLINFO_LOCAL_IP</info> - L'indirizzo IP locale (sorgente) della connessione più recente
                  <info>CURLINFO_LOCAL_PORT</info> - La porta locale (sorgente) della connessione più recente
                  <info>CURLINFO_SIZE_UPLOAD</info> - Numero totale di byte caricati (in upload)
                  <info>CURLINFO_SIZE_DOWNLOAD</info> - Numero totale di byte scaricati <info>CURLINFO_SPEED_DOWNLOAD</info> -
                  Velocità di download media <info>CURLINFO_SPEED_UPLOAD</info> - Velocità di upload media
                  <info>CURLINFO_HEADER_SIZE</info> - Dimensione totale di tutti gli header ricevuti
                  <info>CURLINFO_HEADER_OUT</info> - La stringa di richiesta inviata. Per farlo  funzionare,
                  aggiungere l'opzione <info>CURLINFO_HEADER_OUT</info> al gestore chiamando  <strong>curl_setopt()</strong>
                  <info>CURLINFO_REQUEST_SIZE</info> - Dimensione totale delle richieste effettuate, attualmente
                  solo per le richieste HTTP <info>CURLINFO_SSL_VERIFYRESULT</info> - Risultato della verifica
                  del certificato SSL richiesto dall'impostazione <info>CURLOPT_SSL_VERIFYPEER</info>
                  <info>CURLINFO_CONTENT_LENGTH_DOWNLOAD</info> - dimensione-del-contenuto del download, letto
                  dal campo <return>Content-Length:</return> <info>CURLINFO_CONTENT_LENGTH_UPLOAD</info> - Dimensione specificata
                  dell'upload <info>CURLINFO_CONTENT_TYPE</info> - Il <return>Content-Type:</return> del documento richiesto, NULL
                  indica che il server non ha inviato un header <return>Content-Type:</return> valido
                  <info>CURLINFO_PRIVATE</info> - Dati privati associati con questo gestore cURL, precedentemente
                  impostati con l'opzione <info>CURLOPT_PRIVATE</info> di <strong>curl_setopt()</strong>
                  
                  <info>CURLINFO_EFFECTIVE_URL</info> - L'ultimo URL effettivo
                  
                  <info>CURLINFO_HTTP_CODE</info> - L'ultimo codice HTTP ricevuto
                  
                  <info>CURLINFO_FILETIME</info> - L'orario remoto del documento recuperato, se viene restituito
                  -1 l'orario del documento è sconosciuto
                  
                  <info>CURLINFO_TOTAL_TIME</info> - Il tempo totale in secondi della transazione per l'ultimo
                  trasferimento
                  
                  <info>CURLINFO_NAMELOOKUP_TIME</info> - Il tempo in secondi finchè la risoluzione dei nomi non
                  è stata completata
                  
                  <info>CURLINFO_CONNECT_TIME</info> - Il tempo in secondi impiegato per stabilire la connessione
                  
                  <info>CURLINFO_PRETRANSFER_TIME</info> - Il tempo in secondi dall'inizio fino a poco prima che
                  il trasferimento del file cominciasse
                  
                  <info>CURLINFO_STARTTRANSFER_TIME</info> - Il tempo in secondi fino a quando il primo byte è in
                  procinto di essere trasferito
                  
                  <info>CURLINFO_REDIRECT_COUNT</info> - Il numero dei reindirizzamenti, con l'opzione
                  <info>CURLOPT_FOLLOWLOCATION</info> abilitata
                  
                  <info>CURLINFO_REDIRECT_TIME</info> - Il tempo in secondi di tutti le fasi di reindirizzamento
                  prima che la transazione finale non venga avviata, con l'opzione
                  <info>CURLOPT_FOLLOWLOCATION</info> abilitata
                  
                  <info>CURLINFO_REDIRECT_URL</info> - Con l'opzione <info>CURLOPT_FOLLOWLOCATION</info> disabilitata: l'URL
                  di reindirizzamento trovato nell'ultima transazione, che dovrebbe essere richiesto
                  manualmente dopo. Con l'opzione <info>CURLOPT_FOLLOWLOCATION</info> abilitata: questo è vuoto.
                  L'URL di reindirizzamento in questo caso è disponibile in <info>CURLINFO_EFFECTIVE_URL</info>
                  
                  <info>CURLINFO_PRIMARY_IP</info> - L'indirizzo IP della connessione più recente
                  
                  <info>CURLINFO_PRIMARY_PORT</info> - La porta di destinazione della connessione più recente
                  
                  <info>CURLINFO_LOCAL_IP</info> - L'indirizzo IP locale (sorgente) della connessione più recente
                  
                  <info>CURLINFO_LOCAL_PORT</info> - La porta locale (sorgente) della connessione più recente
                  
                  <info>CURLINFO_SIZE_UPLOAD</info> - Numero totale di byte caricati (in upload)
                  
                  <info>CURLINFO_SIZE_DOWNLOAD</info> - Numero totale di byte scaricati
                  
                  <info>CURLINFO_SPEED_DOWNLOAD</info> - Velocità di download media
                  
                  <info>CURLINFO_SPEED_UPLOAD</info> - Velocità di upload media
                  
                  <info>CURLINFO_HEADER_SIZE</info> - Dimensione totale di tutti gli header ricevuti
                  
                  <info>CURLINFO_HEADER_OUT</info> - La stringa di richiesta inviata. Per farlo  funzionare,
                  aggiungere l'opzione <info>CURLINFO_HEADER_OUT</info> al gestore chiamando  <strong>curl_setopt()</strong>
                  
                  <info>CURLINFO_REQUEST_SIZE</info> - Dimensione totale delle richieste effettuate, attualmente
                  solo per le richieste HTTP
                  
                  <info>CURLINFO_SSL_VERIFYRESULT</info> - Risultato della verifica del certificato SSL richiesto
                  dall'impostazione <info>CURLOPT_SSL_VERIFYPEER</info>
                  
                  <info>CURLINFO_CONTENT_LENGTH_DOWNLOAD</info> - dimensione-del-contenuto del download, letto
                  dal campo <return>Content-Length:</return>
                  
                  <info>CURLINFO_CONTENT_LENGTH_UPLOAD</info> - Dimensione specificata dell'upload
                  
                  <info>CURLINFO_CONTENT_TYPE</info> - Il <return>Content-Type:</return> del documento richiesto, NULL indica che
                  il server non ha inviato un header <return>Content-Type:</return> valido
                  
                  <info>CURLINFO_PRIVATE</info> - Dati privati associati con questo gestore cURL, precedentemente
                  impostati con l'opzione <info>CURLOPT_PRIVATE</info> di <strong>curl_setopt()</strong>

<comment>Return:</comment>
  <info>mixed</info>  Se viene dato <strong>$opt</strong>, viene restituito il suo valore. Altrimenti, restituisce un array
         associativo con i seguenti elementi  (che corrispondono a <strong>$opt</strong>), o <info>false</info> in caso di
         fallimento:  "url"  "content_type"  "http_code"  "header_size"  "request_size"  "filetime"
         "ssl_verify_result"  "redirect_count"  "total_time"  "namelookup_time"  "connect_time"
         "pretransfer_time"  "size_upload"  "size_download"  "speed_download"  "speed_upload"
         "download_content_length"  "upload_content_length"  "starttransfer_time"  "redirect_time"
         "certinfo"  "primary_ip"  "primary_port"  "local_ip"  "local_port"  "redirect_url"
         "request_header" (Questo è impostato solo se <info>CURLINFO_HEADER_OUT</info>  è stato impostato da una
         chiamata precedente a <strong>curl_setopt()</strong>)  Notare che i dati privati non sono inclusi nell'array
         associativo e dovrebbero essere recuperati individualmente con l'opzione <info>CURLINFO_PRIVATE</info>.
         
         "url"
         
         "content_type"
         
         "http_code"
         
         "header_size"
         
         "request_size"
         
         "filetime"
         
         "ssl_verify_result"
         
         "redirect_count"
         
         "total_time"
         
         "namelookup_time"
         
         "connect_time"
         
         "pretransfer_time"
         
         "size_upload"
         
         "size_download"
         
         "speed_download"
         
         "speed_upload"
         
         "download_content_length"
         
         "upload_content_length"
         
         "starttransfer_time"
         
         "redirect_time"
         
         "certinfo"
         
         "primary_ip"
         
         "primary_port"
         
         "local_ip"
         
         "local_port"
         
         "redirect_url"
         
         "request_header" (Questo è impostato solo se <info>CURLINFO_HEADER_OUT</info>  è stato impostato da una
         chiamata precedente a <strong>curl_setopt()</strong>)


id: curl_init
type: function
doc:
<comment>Description:</comment>
  Inizializza una sessione CURL
  
  Inizializza una nuova sessione e restituisce un gestore cURL da usare con le funzioni
  <strong>curl_setopt()</strong>, <strong>curl_exec()</strong>, e <strong>curl_close()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>  Se viene fornita, l'opzione <info>CURLOPT_URL</info> verrà impostata al suo valore. Si può
                impostare manualmente quest'ultima, usando la  funzione <strong>curl_setopt()</strong>.
                
                Il protocollo <return>file</return> viene disabilitato da cURL se viene impostato open_basedir.

<comment>Return:</comment>
  <info>resource</info>  Restituisce un gestore cURL in caso di successo, <info>false</info> in caso di errore.

<comment>See Also:</comment>
   * <strong>curl_close()</strong>
   * <strong>curl_multi_init()</strong>


id: curl_multi_add_handle
type: function
doc:
<comment>Description:</comment>
  Aggiunge un normale gestore cURL ad un gestore multiplo cURL
  
  Aggiunge il gestore <strong>$ch</strong> al gestore multiplo  <strong>$mh</strong>

<comment>Param:</comment>
  <info>resource</info>  <strong>$mh</strong>  Un identificativo multiplo rstituito da
                 <strong>curl_multi_init()</strong>.
  <info>resource</info>  <strong>$ch</strong>  Un identificativo cURL restituito da 
                 <strong>curl_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Restituisce 0 in caso di successo, o uno dei codici di errore <info>CURLM_XXX</info>.

<comment>See Also:</comment>
   * <strong>curl_multi_remove_handle()</strong>
   * <strong>curl_multi_init()</strong>
   * <strong>curl_init()</strong>


id: curl_multi_close
type: function
doc:
<comment>Description:</comment>
  Chiude un set di gestori cURL
  
  Chiude un set di gestori cURL.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mh</strong>  Un identificativo multiplo rstituito da
                 <strong>curl_multi_init()</strong>.

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

<comment>See Also:</comment>
   * <strong>curl_multi_init()</strong>
   * <strong>curl_close()</strong>


id: curl_multi_errno
type: function
doc:
<comment>Description:</comment>
  Return the last multi curl error number
  
  Return an integer containing the last multi curl error number.

<comment>Param:</comment>
  <info></info>  <strong>$mh</strong>  Un identificativo multiplo rstituito da
         <strong>curl_multi_init()</strong>.

<comment>Return:</comment>
  <info>int</info>  Return an integer containing the last multi curl error number.

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


id: curl_multi_exec
type: function
doc:
<comment>Description:</comment>
  Esegue la sotto-connessione dell'handle cURL corrente
  
  Processa ogni handle nello stack.  Questo metodo può essere chiamato anche quando un handle
  necessita di leggere o scrivere dati.

<comment>Param:</comment>
  <info>resource</info>  <strong>$mh           </strong>  Un identificativo multiplo rstituito da
                            <strong>curl_multi_init()</strong>.
  <info>int     </info>  <strong>$still_running</strong>  Un riferimento ad un flag per dire se le operazioni sono ancora in
                            esecuzione.

<comment>Return:</comment>
  <info>int</info>  Un codice cURL definito nelle Costanti Predefinite di cURL.
       
       Questa funzione restituisce solo errori riguardanti l'intero stack multiplo. Potrebbero
       essersi verificati problemi su singoli trasferimenti anche quando questa funzione restituisce
       <info>CURLM_OK</info>.

<comment>See Also:</comment>
   * <strong>curl_multi_init()</strong>
   * <strong>curl_multi_select()</strong>
   * <strong>curl_exec()</strong>


