# php_manual

id: SQLite3::busyTimeout
type: function
doc:
<comment>Description:</comment>
  Sets the busy connection handler
  
  Sets a busy handler that will sleep until the database is not locked or the timeout is reached.

<comment>Param:</comment>
  <info>int</info>  <strong>$msecs</strong>  The milliseconds to sleep. Setting this value to a value less than or equal to zero,
               will turn off an already set timeout handler.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success,  sau <info>false</info> în cazul eșecului.


id: SQLite3::changes
type: function
doc:
<comment>Description:</comment>
  Returns the number of database rows that were changed (or inserted or
     deleted) by the most recent SQL statement
    
  
  Returns the number of database rows that were changed (or inserted or deleted) by the most recent
  SQL statement.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> value corresponding to the number of database rows changed (or inserted or
       deleted) by the most recent SQL statement.


id: SQLite3::close
type: function
doc:
<comment>Description:</comment>
  Closes the database connection
  
  Closes the database connection.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SQLite3::createAggregate
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL aggregate function
  
  Registers a PHP function or user-defined function for use as an SQL aggregate function for use
  within SQL statements.

<comment>Param:</comment>
  <info>string</info>  <strong>$name          </strong>  Name of the SQL aggregate to be created or redefined.
  <info>mixed </info>  <strong>$step_callback </strong>  Callback function called for each row of the result set. Your PHP
                           function should accumulate the result and store it in the aggregation
                           context.
                           
                           This function need to be defined as:
                           <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong><info>null</info>
                           for the first row; on subsequent rows it will have the value that was
                           previously returned from the step function; you should use this to
                           maintain the aggregate state. <strong>$rownumber</strong> The current row number. <strong>$value</strong>
                           The first argument passed to the aggregate. <strong>$values</strong> Further arguments
                           passed to the aggregate.  The return value of this function will be used
                           as the <strong>$context</strong> argument in the next call of the step or finalize
                           functions.
                           
                           <info>null</info> for the first row; on subsequent rows it will have the value that
                           was previously returned from the step function; you should use this to
                           maintain the aggregate state.
                           
                           The current row number.
                           
                           The first argument passed to the aggregate.
                           
                           Further arguments passed to the aggregate.
  <info>mixed </info>  <strong>$context       </strong>  <info>null</info> for the first row; on subsequent rows it will have the value that
                           was previously returned from the step function; you should use this to
                           maintain the aggregate state.
  <info>int   </info>  <strong>$rownumber     </strong>  The current row number.
  <info>mixed </info>  <strong>$value         </strong>  The first argument passed to the aggregate.
  <info>mixed </info>  <strong>$values        </strong>  Further arguments passed to the aggregate.
  <info>mixed </info>  <strong>$final_callback</strong>  Callback function to aggregate the "stepped" data from each row.  Once
                           all the rows have been processed, this function will be called and it
                           should then take the data from the aggregation context and return the
                           result. This callback function should return a type understood by SQLite
                           (i.e. scalar type).
                           
                           This function need to be defined as: <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong>
                           <strong>$context</strong> Holds the return value from the very last call to the step
                           function. <strong>$rownumber</strong> Always <return>0</return>.  The return value of this function will be
                           used as the return value for the aggregate.
                           
                           Holds the return value from the very last call to the step function.
                           
                           Always <return>0</return>.
  <info>mixed </info>  <strong>$context       </strong>  Holds the return value from the very last call to the step function.
  <info>int   </info>  <strong>$rownumber     </strong>  Always <return>0</return>.
  <info>int   </info>  <strong>$argument_count</strong>  The number of arguments that the SQL aggregate takes. If this parameter
                           is negative, then the SQL aggregate may take any number of arguments.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> upon successful creation of the aggregate,  sau <info>false</info> în cazul eșecului.


id: SQLite3::createCollation
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL collating function
  
  Registers a PHP function or user-defined function for use as a collating function within SQL
  statements.

<comment>Param:</comment>
  <info>string  </info>  <strong>$name    </strong>  Name of the SQL collating function to be created or redefined
  <info>callable</info>  <strong>$callback</strong>  The name of a PHP function or user-defined function to apply as a callback,
                       defining the behavior of the collation.  It should accept two values and
                       return as <strong>strcmp()</strong> does, i.e. it should return -1, 1, or 0 if the first
                       string sorts before, sorts after, or is equal to the second.
                       
                       This function need to be defined as: <info>int</info>collation<info>mixed</info><strong>$value1</strong><info>mixed</info><strong>$value2</strong>

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * The SQLite collation documentation: http://sqlite.org/datatype3.html#collation


id: SQLite3::createFunction
type: function
doc:
<comment>Description:</comment>
  Registers a PHP function for use as an SQL scalar function
  
  Registers a PHP function or user-defined function for use as an SQL scalar function for use within
  SQL statements.

<comment>Param:</comment>
  <info>string</info>  <strong>$name          </strong>  Name of the SQL function to be created or redefined.
  <info>mixed </info>  <strong>$callback      </strong>  The name of a PHP function or user-defined function to apply as a
                           callback, defining the behavior of the SQL function.
                           
                           This function need to be defined as: <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong>
                           <strong>$value</strong> The first argument passed to the SQL function. <strong>$values</strong> Further
                           arguments passed to the SQL function.
                           
                           The first argument passed to the SQL function.
                           
                           Further arguments passed to the SQL function.
  <info>mixed </info>  <strong>$value         </strong>  The first argument passed to the SQL function.
  <info>mixed </info>  <strong>$values        </strong>  Further arguments passed to the SQL function.
  <info>int   </info>  <strong>$argument_count</strong>  The number of arguments that the SQL function takes. If this parameter is
                           <return>-1</return>, then the SQL function may take any number of arguments.
  <info>int   </info>  <strong>$flags         </strong>  A bitwise conjunction of flags. Currently, only <info>SQLITE3_DETERMINISTIC</info> is
                           supported, which specifies that the function always returns the same
                           result given the same inputs within a single SQL statement.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> upon successful creation of the function, <info>false</info> on failure.


id: SQLite3::enableExceptions
type: function
doc:
<comment>Description:</comment>
  Enable throwing exceptions
    
  
  Controls whether the <class>SQLite3</class> instance will throw exceptions or warnings on error.

<comment>Param:</comment>
  <info></info>  <strong>$enable</strong>  When <info>true</info>, the <class>SQLite3</class> instance, and  <class>SQLite3Stmt</class> and <class>SQLite3Result</class> instances derived
             from it, will throw exceptions on error.
             
             When <info>false</info>, the <class>SQLite3</class> instance, and <class>SQLite3Stmt</class> and <class>SQLite3Result</class> instances derived
             from it, will raise warnings on error.
             
             For either mode, the error code and message, if any, will be available via
             SQLite3::lastErrorCode and SQLite3::lastErrorMsg respectively.

<comment>Return:</comment>
  <info>bool</info>  Returns the old value; <info>true</info> if exceptions were enabled, <info>false</info> otherwise.


id: SQLite3::escapeString
type: function
doc:
<comment>Description:</comment>
  Returns a string that has been properly escaped
  
  Returns a string that has been properly escaped for safe inclusion in an SQL statement.
  
  Această funcție nu funcționează stabil (deocamdată) cu date binare!
  
  To properly handle BLOB fields which may contain NUL characters, use <strong>SQLite3Stmt::bindParam()</strong>
  instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The string to be escaped.

<comment>Return:</comment>
  <info>string</info>  Returns a properly escaped string that may be used safely in an SQL statement.


id: SQLite3::exec
type: function
doc:
<comment>Description:</comment>
  Executes a result-less query against a given database
  
  Executes a result-less query against a given database.
  
  SQLite3 may need to create temporary files during the execution of queries, so the respective
  directories may have to be writable.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to execute (typically an INSERT, UPDATE, or DELETE query).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the query succeeded, <info>false</info> on failure.


id: SQLite3::lastErrorCode
type: function
doc:
<comment>Description:</comment>
  Returns the numeric result code of the most recent failed SQLite request
    
  
  Returns the numeric result code of the most recent failed SQLite request.

<comment>Return:</comment>
  <info>int</info>  Returns an integer value representing the numeric result code of the most recent failed
       SQLite request.


id: SQLite3::lastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Returns English text describing the most recent failed SQLite request
    
  
  Returns English text describing the most recent failed SQLite request.

<comment>Return:</comment>
  <info>string</info>  Returns an English string describing the most recent failed SQLite request.


id: SQLite3::lastInsertRowID
type: function
doc:
<comment>Description:</comment>
  Returns the row ID of the most recent INSERT into the database
  
  Returns the row ID of the most recent INSERT into the database.

<comment>Return:</comment>
  <info>int</info>  Returns the row ID of the most recent INSERT into the database


id: SQLite3::loadExtension
type: function
doc:
<comment>Description:</comment>
  Attempts to load an SQLite extension library
  
  Attempts to load an SQLite extension library.

<comment>Param:</comment>
  <info>string</info>  <strong>$shared_library</strong>  The name of the library to load. The library must be located in the
                           directory specified in the configure option sqlite3.extension_dir.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the extension is successfully loaded, <info>false</info> on failure.


id: SQLite3::open
type: function
doc:
<comment>Description:</comment>
  Opens an SQLite database
  
  Opens an SQLite 3 Database. If the build includes encryption, then it will attempt to use the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename      </strong>  Path to the SQLite database, or <return>:memory:</return> to use in-memory database.
  <info>int   </info>  <strong>$flags         </strong>  Optional flags used to determine how to open the SQLite database. By
                           default, open uses <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return>.
                           <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                           <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                           <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
                           
                           <return>SQLITE3_OPEN_READONLY</return>: Open the database for reading only.
                           
                           <return>SQLITE3_OPEN_READWRITE</return>: Open the database for reading and writing.
                           
                           <return>SQLITE3_OPEN_CREATE</return>: Create the database if it does not exist.
  <info>string</info>  <strong>$encryption_key</strong>  An optional encryption key used when encrypting and decrypting an SQLite
                           database. If the SQLite encryption module is not installed, this
                           parameter will have no effect.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SQLite3::openBlob
type: function
doc:
<comment>Description:</comment>
  Opens a stream resource to read a BLOB
  
  Opens a stream resource to read or write a BLOB, which would be selected by:
  
  SELECT <strong>$column</strong> FROM <strong>$dbname</strong>.<strong>$table</strong> WHERE rowid = <strong>$rowid</strong>
  
  It is not possible to change the size of a BLOB by writing to the stream. Instead, an UPDATE
  statement has to be executed, possibly using SQLite's zeroblob() function to set the desired BLOB
  size.

<comment>Param:</comment>
  <info>string</info>  <strong>$table </strong>  The table name.
  <info>string</info>  <strong>$column</strong>  The column name.
  <info>int   </info>  <strong>$rowid </strong>  The row ID.
  <info>string</info>  <strong>$dbname</strong>  The symbolic name of the DB
  <info>int   </info>  <strong>$flags </strong>  Either <info>SQLITE3_OPEN_READONLY</info> or  <info>SQLITE3_OPEN_READWRITE</info> to open the stream for
                   reading only, or for reading and writing, respectively.

<comment>Return:</comment>
  <info>resourcefalse</info>  Returns a stream resource,  sau <info>false</info> în cazul eșecului.


id: SQLite3::prepare
type: function
doc:
<comment>Description:</comment>
  Prepares an SQL statement for execution
  
  Prepares an SQL statement for execution and returns an <class>SQLite3Stmt</class> object.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to prepare.

<comment>Return:</comment>
  <info>SQLite3Stmtfalse</info>  Returns an <class>SQLite3Stmt</class> object on success sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * SQLite3Stmt::paramCount
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3::query
type: function
doc:
<comment>Description:</comment>
  Executes an SQL query
  
  Executes an SQL query, returning an <class>SQLite3Result</class> object. If the query does not yield a result
  (such as DML statements) the returned <class>SQLite3Result</class> object is not really usable. Use SQLite3::exec
  for such queries instead.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The SQL query to execute.

<comment>Return:</comment>
  <info>SQLite3Resultfalse</info>  Returns an <class>SQLite3Result</class> object,  sau <info>false</info> în cazul eșecului.


id: SQLite3::querySingle
type: function
doc:
<comment>Description:</comment>
  Executes a query and returns a single result
  
  Executes a query and returns a single result.

<comment>Param:</comment>
  <info>string</info>  <strong>$query     </strong>  The SQL query to execute.
  <info>bool  </info>  <strong>$entire_row</strong>  By default, <strong>querySingle()</strong> returns the value of the first column returned by
                       the query. If <strong>$entire_row</strong> is <info>true</info>, then it returns an array of the entire
                       first row.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value of the first column of results or an array of the entire first row (if
         <strong>$entire_row</strong> is <info>true</info>).
         
         If the query is valid but no results are returned, then <info>null</info> will be returned if
         <strong>$entire_row</strong> is <info>false</info>, otherwise an empty array is returned.
         
         Invalid or failing queries will return <info>false</info>.


id: SQLite3::setAuthorizer
type: function
doc:
<comment>Description:</comment>
  Configures a callback to be used as an authorizer to limit what a statement can do
  
  Sets a callback that will be called by SQLite every time an action is performed (reading,
  deleting, updating, etc.). This is used when preparing a SQL statement from an untrusted source to
  ensure that the SQL statements do not try to access data they are not allowed to see, or that they
  do not try to execute malicious statements that damage the database. For example, an application
  may allow a user to enter arbitrary SQL queries for evaluation by a database. But the application
  does not want the user to be able to make arbitrary changes to the database. An authorizer could
  then be put in place while the user-entered SQL is being prepared that disallows everything except
  SELECT statements.
  
  The authorizer callback may be called multiple times for each statement prepared by SQLite. A
  <return>SELECT</return> or <return>UPDATE</return> query will call the authorizer for every column that would be read or updated.
  
  The authorizer is called with up to five parameters. The first parameter is always given, and is
  an <info>int</info> (action code) matching a constant from <return>SQLite3</return>. The other parameters are only passed for
  some actions. The following table describes the second and third parameters according to the
  action: List of action codes and parametersActionSecond parameterThird
  parameter<info>SQLite3::CREATE_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TEMP_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_TEMP_VIEW</info>View
  Name<info>null</info><info>SQLite3::CREATE_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_VIEW</info>View
  Name<info>null</info><info>SQLite3::DELETE</info>Table Name<info>null</info><info>SQLite3::DROP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TEMP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_TEMP_VIEW</info>View Name<info>null</info><info>SQLite3::DROP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_VIEW</info>View Name<info>null</info><info>SQLite3::INSERT</info>Table Name<info>null</info><info>SQLite3::PRAGMA</info>Pragma NameFirst
  argument passed to the pragma, or <info>null</info><info>SQLite3::READ</info>Table NameColumn
  Name<info>SQLite3::SELECT</info><info>null</info><info>null</info><info>SQLite3::TRANSACTION</info>Operation<info>null</info><info>SQLite3::UPDATE</info>Table NameColumn
  Name<info>SQLite3::ATTACH</info>Filename<info>null</info><info>SQLite3::DETACH</info>Database Name<info>null</info><info>SQLite3::ALTER_TABLE</info>Database
  NameTable Name<info>SQLite3::REINDEX</info>Index Name<info>null</info><info>SQLite3::ANALYZE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_VTABLE</info>Table NameModule Name<info>SQLite3::DROP_VTABLE</info>Table NameModule
  Name<info>SQLite3::FUNCTION</info><info>null</info>Function Name<info>SQLite3::SAVEPOINT</info>OperationSavepoint
  Name<info>SQLite3::RECURSIVE</info><info>null</info><info>null</info>
  
  The 5th parameter will be the name of the database (<return>"main"</return>, <return>"temp"</return>, etc.) if applicable.
  
  The 6th parameter to the authorizer callback is the name of the inner-most trigger or view that is
  responsible for the access attempt or <info>null</info> if this access attempt is directly from top-level SQL
  code.
  
  When the callback returns <info>SQLite3::OK</info>, that means the operation requested is accepted. When the
  callback returns <info>SQLite3::DENY</info>, the call that triggered the authorizer will fail with an error
  message explaining that access is denied.
  
  If the action code is <info>SQLite3::READ</info> and the callback returns <info>SQLite3::IGNORE</info> then the prepared
  statement statement is constructed to substitute a <info>null</info> value in place of the table column that
  would have been read if <info>SQLite3::OK</info> had been returned. The <info>SQLite3::IGNORE</info> return can be used to
  deny an untrusted user access to individual columns of a table.
  
  When a table is referenced by a <return>SELECT</return> but no column values are extracted from that table (for
  example in a query like <return>"SELECT count(*) FROM table"</return>) then the <info>SQLite3::READ</info> authorizer callback
  is invoked once for that table with a column name that is an empty string.
  
  If the action code is <info>SQLite3::DELETE</info> and the callback returns <info>SQLite3::IGNORE</info> then the DELETE
  operation proceeds but the truncate optimization is disabled and all rows are deleted
  individually.
  
  Only a single authorizer can be in place on a database connection at a time. Each call to
  SQLite3::setAuthorizer overrides the previous call. Disable the authorizer by installing a <info>null</info>
  callback. The authorizer is disabled by default.
  
  The authorizer callback must not do anything that will modify the database connection that invoked
  the authorizer callback.
  
  Note that the authorizer is only called when a statement is prepared, not when it's executed.
  
  More details can be found in the SQLite3 documentation.

<comment>Param:</comment>
  <info>callablenull</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
                           
                           If <info>null</info> is passed instead, this will disable the current authorizer
                           callback.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SQLite3::version
type: function
doc:
<comment>Description:</comment>
  Returns the SQLite3 library version as a string constant and as a number
    
  
  Returns the SQLite3 library version as a string constant and as a number.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array with the keys "versionString" and "versionNumber".


id: SQLite3Result::columnName
type: function
doc:
<comment>Description:</comment>
  Returns the name of the nth column
  
  Returns the name of the column specified by the <strong>$column_number</strong>. Note that the name of a result
  column is the value of the <return>AS</return> clause for that column, if there is an <return>AS</return> clause. If there is no <return>AS</return>
  clause then the name of the column is unspecified and may change from one release of libsqlite3 to
  the next.

<comment>Param:</comment>
  <info>int</info>  <strong>$column_number</strong>  The numeric zero-based index of the column.

<comment>Return:</comment>
  <info>string</info>  Returns the <info>string</info> name of the column identified by <strong>$column_number</strong>.


id: SQLite3Result::columnType
type: function
doc:
<comment>Description:</comment>
  Returns the type of the nth column
  
  Returns the type of the column identified by <strong>$column_number</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$column_number</strong>  The numeric zero-based index of the column.

<comment>Return:</comment>
  <info>int</info>  Returns the data type index of the column identified by <strong>$column_number</strong> (one of
       <info>SQLITE3_INTEGER</info>, <info>SQLITE3_FLOAT</info>, <info>SQLITE3_TEXT</info>, <info>SQLITE3_BLOB</info>, or <info>SQLITE3_NULL</info>).


id: SQLite3Result::fetchArray
type: function
doc:
<comment>Description:</comment>
  Fetches a result row as an associative or numerically indexed array or both
    
  
  Fetches a result row as an associative or numerically indexed array or both. By default, fetches
  as both.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Controls how the next row will be returned to the caller. This value must be one of
              either <return>SQLITE3_ASSOC</return>, <return>SQLITE3_NUM</return>, or <return>SQLITE3_BOTH</return>. <return>SQLITE3_ASSOC</return>: returns an array
              indexed by column name as returned in the corresponding result set <return>SQLITE3_NUM</return>:
              returns an array indexed by column number as returned in the corresponding result set,
              starting at column 0 <return>SQLITE3_BOTH</return>: returns an array indexed by both column name and
              number as returned in the corresponding result set, starting at column 0
              
              <return>SQLITE3_ASSOC</return>: returns an array indexed by column name as returned in the
              corresponding result set
              
              <return>SQLITE3_NUM</return>: returns an array indexed by column number as returned in the
              corresponding result set, starting at column 0
              
              <return>SQLITE3_BOTH</return>: returns an array indexed by both column name and number as returned in
              the corresponding result set, starting at column 0

<comment>Return:</comment>
  <info>array</info>  Returns a result row as an associatively or numerically indexed array or both. Alternately
         will return <info>false</info> if there are no more rows.
         
         The types of the values of the returned array are mapped from SQLite3 types as follows:
         integers are mapped to <info>int</info> if they fit into the range <info>PHP_INT_MIN</info>..<info>PHP_INT_MAX</info>, and to
         <info>string</info> otherwise. Floats are mapped to <info>float</info>, <return>NULL</return> values are mapped to <info>null</info>, and strings
         and blobs are mapped to <info>string</info>.


id: SQLite3Result::finalize
type: function
doc:
<comment>Description:</comment>
  Closes the result set
  
  Closes the result set.

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


id: SQLite3Result::numColumns
type: function
doc:
<comment>Description:</comment>
  Returns the number of columns in the result set
  
  Returns the number of columns in the result set.

<comment>Return:</comment>
  <info>int</info>  Returns the number of columns in the result set.


id: SQLite3Result::reset
type: function
doc:
<comment>Description:</comment>
  Resets the result set back to the first row
  
  Resets the result set back to the first row.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the result set is successfully reset back to the first row, <info>false</info> on
        failure.


id: SQLite3Stmt
type: class
doc:
<comment>Description:</comment>
  A class that handles prepared statements for the SQLite 3 extension.


id: SQLite3Stmt::bindParam
type: function
doc:
<comment>Description:</comment>
  Binds a parameter to a statement variable
  
  Binds a parameter to a statement variable.
  
  Before PHP 7.2.14 and 7.3.0, respectively, SQLite3Stmt::reset must be called after the first call
  to SQLite3Stmt::execute if the bound value should be properly updated on following calls to
  SQLite3Stmt::execute. If SQLite3Stmt::reset is not called, the bound value will not change, even
  if the value assigned to the variable passed to SQLite3Stmt::bindParam has changed, or
  SQLite3Stmt::bindParam has been called again.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sql_param</strong>  Either a <info>string</info> (for named parameters) or an <info>int</info> (for positional parameters)
                     identifying the statement variable to which the value should be bound. If a
                     named parameter does not start with a colon (<return>:</return>) or an at sign (<return>@</return>), a colon (<return>:</return>)
                     is automatically preprended. Positional parameters start with <return>1</return>.
  <info>mixed</info>  <strong>$param    </strong>  The parameter to bind to a statement variable.
  <info>int  </info>  <strong>$type     </strong>  The data type of the parameter to bind. <info>SQLITE3_INTEGER</info>: The value is a signed
                     integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the
                     value. <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte
                     IEEE floating point number. <info>SQLITE3_TEXT</info>: The value is a text string, stored
                     using the database encoding (UTF-8, UTF-16BE or UTF-16-LE). <info>SQLITE3_BLOB</info>: The
                     value is a blob of data, stored exactly as it was input. <info>SQLITE3_NULL</info>: The
                     value is a NULL value.
                     
                     <info>SQLITE3_INTEGER</info>: The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8
                     bytes depending on the magnitude of the value.
                     
                     <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte IEEE
                     floating point number.
                     
                     <info>SQLITE3_TEXT</info>: The value is a text string, stored using the database encoding
                     (UTF-8, UTF-16BE or UTF-16-LE).
                     
                     <info>SQLITE3_BLOB</info>: The value is a blob of data, stored exactly as it was input.
                     
                     <info>SQLITE3_NULL</info>: The value is a NULL value.
                     
                     As of PHP 7.0.7, if <strong>$type</strong> is omitted, it is automatically detected from the
                     type of the <strong>$param</strong>: <info>bool</info> and <info>int</info> are treated as <info>SQLITE3_INTEGER</info>, <info>float</info> as
                     <info>SQLITE3_FLOAT</info>, <info>null</info> as <info>SQLITE3_NULL</info> and all others as <info>SQLITE3_TEXT</info>. Formerly,
                     if <strong>$type</strong> has been omitted, it has defaulted to <info>SQLITE3_TEXT</info>.
                     
                     If <strong>$param</strong> is <info>null</info>, it is always treated as <info>SQLITE3_NULL</info>, regardless of the
                     given <strong>$type</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the parameter is bound to the statement variable, <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3Stmt::bindValue
   * SQLite3::prepare


id: SQLite3Stmt::bindValue
type: function
doc:
<comment>Description:</comment>
  Binds the value of a parameter to a statement variable
  
  Binds the value of a parameter to a statement variable.
  
  Before PHP 7.2.14 and 7.3.0, respectively, once the statement has been executed,
  SQLite3Stmt::reset  needs to be called to be able to change the value of bound parameters.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sql_param</strong>  Either a <info>string</info> (for named parameters) or an <info>int</info> (for positional parameters)
                     identifying the statement variable to which the value should be bound. If a
                     named parameter does not start with a colon (<return>:</return>) or an at sign (<return>@</return>), a colon (<return>:</return>)
                     is automatically preprended. Positional parameters start with <return>1</return>.
  <info>mixed</info>  <strong>$value    </strong>  The value to bind to a statement variable.
  <info>int  </info>  <strong>$type     </strong>  The data type of the value to bind. <info>SQLITE3_INTEGER</info>: The value is a signed
                     integer, stored in 1, 2, 3, 4, 6, or 8 bytes depending on the magnitude of the
                     value. <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte
                     IEEE floating point number. <info>SQLITE3_TEXT</info>: The value is a text string, stored
                     using the database encoding (UTF-8, UTF-16BE or UTF-16-LE). <info>SQLITE3_BLOB</info>: The
                     value is a blob of data, stored exactly as it was input. <info>SQLITE3_NULL</info>: The
                     value is a NULL value.
                     
                     <info>SQLITE3_INTEGER</info>: The value is a signed integer, stored in 1, 2, 3, 4, 6, or 8
                     bytes depending on the magnitude of the value.
                     
                     <info>SQLITE3_FLOAT</info>: The value is a floating point value, stored as an 8-byte IEEE
                     floating point number.
                     
                     <info>SQLITE3_TEXT</info>: The value is a text string, stored using the database encoding
                     (UTF-8, UTF-16BE or UTF-16-LE).
                     
                     <info>SQLITE3_BLOB</info>: The value is a blob of data, stored exactly as it was input.
                     
                     <info>SQLITE3_NULL</info>: The value is a NULL value.
                     
                     As of PHP 7.0.7, if <strong>$type</strong> is omitted, it is automatically detected from the
                     type of the <strong>$value</strong>: <info>bool</info> and <info>int</info> are treated as <info>SQLITE3_INTEGER</info>, <info>float</info> as
                     <info>SQLITE3_FLOAT</info>, <info>null</info> as <info>SQLITE3_NULL</info> and all others as <info>SQLITE3_TEXT</info>. Formerly,
                     if <strong>$type</strong> has been omitted, it has defaulted to <info>SQLITE3_TEXT</info>.
                     
                     If <strong>$value</strong> is <info>null</info>, it is always treated as <info>SQLITE3_NULL</info>, regardless of the
                     given <strong>$type</strong>.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the value is bound to the statement variable,  sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * SQLite3Stmt::bindParam
   * SQLite3::prepare


id: SQLite3Stmt::clear
type: function
doc:
<comment>Description:</comment>
  Clears all current bound parameters
  
  Clears all current bound parameters (sets them to <info>null</info>).
  
  This method needs to be used with SQLite3Stmt::reset. If used alone, any call to
  SQLite3Stmt::bindValue or SQLite3Stmt::bindParam will be of no effect and all bound parameters
  will have the <info>null</info> value.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on successful clearing of bound parameters, <info>false</info> on failure.


id: SQLite3Stmt::close
type: function
doc:
<comment>Description:</comment>
  Closes the prepared statement
  
  Closes the prepared statement.
  
  Note that all <class>SQLite3Result</class>s that have been retrieved by executing this statement will be
  invalidated when the statement is closed.

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


id: SQLite3Stmt::execute
type: function
doc:
<comment>Description:</comment>
  Executes a prepared statement and returns a result set object
  
  Executes a prepared statement and returns a result set object.
  
  Result set objects retrieved by calling this method on the same statement object are not
  independent, but rather share the same underlying structure. Therefore it is recommended to call
  SQLite3Result::finalize, before calling SQLite3Stmt::execute on the same statement object again.

<comment>Return:</comment>
  <info>SQLite3Result</info>  Returns an <class>SQLite3Result</class> object on successful execution of the prepared statement,
                 <info>false</info> on failure.

<comment>See Also:</comment>
   * SQLite3::prepare
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3Stmt::getSQL
type: function
doc:
<comment>Description:</comment>
  Get the SQL of the statement
  
  Retrieves the SQL of the prepared statement. If <strong>$expanded</strong> is <info>false</info>, the unmodified SQL is
  retrieved. If <strong>$expanded</strong> is <info>true</info>, all query parameters are replaced with their bound values, or
  with an SQL <return>NULL</return>, if not already bound.

<comment>Param:</comment>
  <info>bool</info>  <strong>$expanded</strong>  Whether to retrieve the expanded SQL. Passing <info>true</info> is only supported as of
                   libsqlite 3.14.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the SQL of the prepared statement,  sau <info>false</info> în cazul eșecului.


id: SQLite3Stmt::paramCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of parameters within the prepared statement
  
  Returns the number of parameters within the prepared statement.

<comment>Return:</comment>
  <info>int</info>  Returns the number of parameters within the prepared statement.

<comment>See Also:</comment>
   * SQLite3::prepare


id: SQLite3Stmt::readOnly
type: function
doc:
<comment>Description:</comment>
  Returns whether a statement is definitely read only
  
  Returns whether a statement is definitely read only. A statement is considered read only, if it
  makes no direct changes to the content of the database file. Note that user defined SQL functions
  might change the database indirectly as a side effect.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a statement is definitely read only, <info>false</info> otherwise.


id: SQLite3Stmt::reset
type: function
doc:
<comment>Description:</comment>
  Resets the prepared statement
  
  Resets the prepared statement to its state prior to execution. All bindings remain intact after
  reset.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the statement is successfully reset,  sau <info>false</info> în cazul eșecului.


id: SSH2_DEFAULT_TERMINAL
type: constant
doc:
<comment>Description:</comment>
  Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_HEIGHT
type: constant
doc:
<comment>Description:</comment>
  Default terminal height requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_UNIT
type: constant
doc:
<comment>Description:</comment>
  Default terminal units requested by <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_WIDTH
type: constant
doc:
<comment>Description:</comment>
  Default terminal width requested by <strong>ssh2_shell()</strong>.


id: SSH2_FINGERPRINT_HEX
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as a string of hexits.


id: SSH2_FINGERPRINT_MD5
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as an MD5 hash.


id: SSH2_FINGERPRINT_RAW
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as a raw string of 8-bit characters.


id: SSH2_FINGERPRINT_SHA1
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fingerprint()</strong> requesting hostkey fingerprint as an SHA1 hash.


id: SSH2_STREAM_STDERR
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fetch_stream()</strong> requesting STDERR subchannel.


id: SSH2_STREAM_STDIO
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_fetch_stream()</strong> requesting STDIO subchannel.


id: SSH2_TERM_UNIT_CHARS
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_shell()</strong> specifying that <strong>$width</strong> and <strong>$height</strong> are provided as character sizes.


id: SSH2_TERM_UNIT_PIXELS
type: constant
doc:
<comment>Description:</comment>
  Flag to <strong>ssh2_shell()</strong> specifying that <strong>$width</strong> and <strong>$height</strong> are provided in pixel units.


id: STREAM_CAST_AS_STREAM
type: constant
doc:
<comment>Description:</comment>
  Stream casting, when <strong>stream_cast()</strong> is called  otherwise (see above).


id: STREAM_CAST_FOR_SELECT
type: constant
doc:
<comment>Description:</comment>
  Stream casting, for when <strong>stream_select()</strong> is  calling <strong>stream_cast()</strong>.


id: STREAM_CLIENT_ASYNC_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Open client socket asynchronously. This option must be used together with the
  <info>STREAM_CLIENT_CONNECT</info> flag. Used with <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Open client socket connection. Client sockets should always include this flag. Used with
  <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Client socket opened with <strong>stream_socket_client()</strong> should remain persistent between page loads.


id: STREAM_FILTER_ALL
type: constant
doc:
<comment>Description:</comment>
  This constant is equivalent to  STREAM_FILTER_READ | STREAM_FILTER_WRITE


id: STREAM_FILTER_READ
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_filter_append()</strong> and <strong>stream_filter_prepend()</strong> to indicate that the specified filter
  should only be applied when reading


id: STREAM_FILTER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_filter_append()</strong> and <strong>stream_filter_prepend()</strong> to indicate that the specified filter
  should only be applied when writing


id: STREAM_META_ACCESS
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chmod()</strong> call.


id: STREAM_META_GROUP
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chgrp()</strong> call.


id: STREAM_META_OWNER
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>chown()</strong> call.


id: STREAM_META_TOUCH
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_metadata()</strong>, to specify <strong>touch()</strong> call.


id: STREAM_NOTIFY_AUTH_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  Additional authorization is required to access the specified resource. Typical issued with
  <strong>$severity</strong> level of <info>STREAM_NOTIFY_SEVERITY_ERR</info>.


id: STREAM_NOTIFY_FAILURE
type: constant
doc:
<comment>Description:</comment>
  A generic error occurred on the stream, consult <strong>$message</strong> and <strong>$message_code</strong> for details.


id: STREAM_NOTIFY_MIME_TYPE_IS
type: constant
doc:
<comment>Description:</comment>
  The <return>mime-type</return> of resource has been identified, refer to <strong>$message</strong> for a description of the
  discovered type.


id: STREAM_NOTIFY_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  Indicates current progress of the stream transfer in <strong>$bytes_transferred</strong> and possibly <strong>$bytes_max</strong> as
  well.


id: STREAM_NOTIFY_REDIRECTED
type: constant
doc:
<comment>Description:</comment>
  The external resource has redirected the stream to an alternate location.  Refer to <strong>$message</strong>.


id: STREAM_NOTIFY_RESOLVE
type: constant
doc:
<comment>Description:</comment>
  A remote address required for this stream has been resolved, or the resolution failed.  See
  <strong>$severity</strong> for an indication of which happened.


id: STREAM_REPORT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  <return>Flag</return> indicating if the <return>wrapper</return> is responsible for raising errors using <strong>trigger_error()</strong>  during
  opening of the stream.  If this flag is not set, you should not raise any errors.


id: STREAM_SERVER_BIND
type: constant
doc:
<comment>Description:</comment>
  Tells a stream created with <strong>stream_socket_server()</strong> to bind to the specified target.  Server
  sockets should always include this flag.


id: STREAM_SERVER_LISTEN
type: constant
doc:
<comment>Description:</comment>
  Tells a stream created with <strong>stream_socket_server()</strong> and bound using the <info>STREAM_SERVER_BIND</info> flag to
  start listening on the socket. Connection-orientated transports (such as TCP) must use this flag,
  otherwise the server socket will not be enabled. Using this flag for connect-less transports (such
  as UDP) is an error.


id: STREAM_SHUT_RD
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further receptions. Added in PHP 5.2.1.


id: STREAM_SHUT_RDWR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further receptions and transmissions. Added in PHP
  5.2.1.


id: STREAM_SHUT_WR
type: constant
doc:
<comment>Description:</comment>
  Used with <strong>stream_socket_shutdown()</strong> to disable further transmissions. Added in PHP 5.2.1.


id: STREAM_SOCK_DGRAM
type: constant
doc:
<comment>Description:</comment>
  Provides datagrams, which are connectionless messages (UDP, for example).


id: STREAM_SOCK_RAW
type: constant
doc:
<comment>Description:</comment>
  Provides a raw socket, which provides access to internal network protocols and interfaces. Usually
  this type of socket is just available to the root user.


id: STREAM_SOCK_STREAM
type: constant
doc:
<comment>Description:</comment>
  Provides sequenced, two-way byte streams with a transmission mechanism for out-of-band data (TCP,
  for example).


id: STREAM_USE_PATH
type: constant
doc:
<comment>Description:</comment>
  <return>Flag</return> indicating if the <return>stream</return> used the include path.


id: ST_UID
type: constant
doc:
<comment>Description:</comment>
  Argumentul secvenței conține UID-uri în loc de numere de secvență


id: SVM::EPSILON_SVR
type: constant
doc:
<comment>Description:</comment>
  A SVM type for regression (predicting a value rather than just a class)


id: SVM::KERNEL_LINEAR
type: constant
doc:
<comment>Description:</comment>
  A very simple kernel, can work well on large document classification problems


id: SVM::KERNEL_RBF
type: constant
doc:
<comment>Description:</comment>
  The common Gaussian RBD kernel. Handles non-linear problems well and is a good default for
  classification


id: SVM::KERNEL_SIGMOID
type: constant
doc:
<comment>Description:</comment>
  A kernel based on the sigmoid function. Using this makes the SVM very similar to a two layer
  sigmoid based neural network


id: SVM::ONE_CLASS
type: constant
doc:
<comment>Description:</comment>
  One class SVM type. Train just on a single class, using outliers as negative examples


id: SVM::OPT_C
type: constant
doc:
<comment>Description:</comment>
  The option for the cost parameter that controls tradeoff between errors and generality -
  effectively the penalty for misclassifying training examples.


id: SVM::OPT_EPS
type: constant
doc:
<comment>Description:</comment>
  The option key for the Epsilon parameter, used in epsilon regression


id: SVM::OPT_NU
type: constant
doc:
<comment>Description:</comment>
  The option key for the nu parameter, only used in the NU_ SVM types


id: SVM::OPT_PROBABILITY
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to collect and use probability estimates


id: SVM::OPT_SHRINKING
type: constant
doc:
<comment>Description:</comment>
  Training parameter, boolean, for whether to use the shrinking heuristics


id: SVM::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SVM object
  
  Constructs a new SVM object ready to accept training data.

<comment>Return:</comment>
  <info>unknown</info>  Throws SVMException if the libsvm library could not be loaded


id: SVM::crossvalidate
type: function
doc:
<comment>Description:</comment>
  Test training params on subsets of the training data
  
  Crossvalidate can be used to test the effectiveness of the current  parameter set on a subset of
  the training data. Given a problem set  and a n "folds", it separates the problem set into n
  subsets, and the  repeatedly trains on one subset and tests on another. While the accuracy  will
  generally be lower than a SVM trained on the enter data set, the  accuracy score returned should
  be relatively useful, so it can be used to  test different training parameters.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem        </strong>  The problem data. This can either be in the form of an array, the URL  of
                           an SVMLight formatted file, or a stream to an opened SVMLight  formatted
                           datasource.
  <info>int  </info>  <strong>$number_of_folds</strong>  The number of sets the data should be divided into and cross tested.  A
                           higher number means smaller training sets and less reliability. 5 is  a
                           good number to start with.

<comment>Return:</comment>
  <info>float</info>  The correct percentage, expressed as a floating point number from 0-1.  In the case of
         NU_SVC or EPSILON_SVR kernels the mean squared error will  returned instead.

<comment>See Also:</comment>
   * SVM::train


id: SVM::getOptions
type: function
doc:
<comment>Description:</comment>
  Return the current training parameters
  
  Retrieve an array containing the training parameters.  The parameters will be keyed on the
  predefined SVM constants.

<comment>Return:</comment>
  <info>array</info>  Returns an array of configuration settings.


id: SVM::setOptions
type: function
doc:
<comment>Description:</comment>
  Set training parameters
  
  Set one or more training parameters.

<comment>Param:</comment>
  <info>array</info>  <strong>$params</strong>  An array of training parameters, keyed on the SVM constants.

<comment>Return:</comment>
  <info>bool</info>  Return true on success, throws SVMException on error.


id: SVM::train
type: function
doc:
<comment>Description:</comment>
  Create a SVMModel based on training data
  
  Train a support vector machine based on the supplied training data.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>  The problem can be provided in three different ways.  An array, where the data
                   should start with the class label  (usually 1 or -1) then followed by a sparse
                   data set of  dimension =&gt; data pairs.  A URL to a file containing a SVM Light
                   formatted problem, with the  each line being a new training example, the start of
                   each line  containing the class (1, -1) then a series of tab separated data
                   values shows as key:value.  A opened stream pointing to a data source formatted
                   as in the file above.
  <info>array</info>  <strong>$weights</strong>  Weights are an optional set of weighting parameters for the different  classes,
                   to help account for unbalanced training sets. For example,  if the classes were 1
                   and -1, and -1 had significantly more example  than one, the weight for -1 could
                   be 0.5. Weights should be in the range 0-1.

<comment>Return:</comment>
  <info>SVMModel</info>  Returns an SVMModel that can be used to classify previously unseen data. Throws
            SVMException on error


id: SVMModel
type: class
doc:
<comment>Description:</comment>
  The SVMModel is the end result of the training process. It can be used to classify previously
  unseen data.


id: SVMModel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SVMModel
  
  Build a new SVMModel. Models will usually be created from the  SVM::train function, but then saved
  models may be restored directly.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename for the saved model file this model should load.

<comment>Return:</comment>
  <info>unknown</info>  Throws SVMException on error

<comment>See Also:</comment>
   * SVMModel::load


id: SVMModel::checkProbabilityModel
type: function
doc:
<comment>Description:</comment>
  Returns true if the model has probability information
  
  Returns true if the model contains probability information.

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


id: SVMModel::getLabels
type: function
doc:
<comment>Description:</comment>
  Get the labels the model was trained on
  
  Return an array of labels that the model was trained on. For regression and one class models an
  empty array is returned.

<comment>Return:</comment>
  <info>array</info>  Return an array of labels

<comment>See Also:</comment>
   * SVMModel::getNrClass


id: SVMModel::getNrClass
type: function
doc:
<comment>Description:</comment>
  Returns the number of classes the model was trained with
  
  Returns the number of classes the model was trained with, will return 2 for one class and
  regression models.

<comment>Return:</comment>
  <info>int</info>  Return an integer number of classes


id: SVMModel::getSvmType
type: function
doc:
<comment>Description:</comment>
  Get the SVM type the model was trained with
  
  Returns an integer value representing the type of the SVM model used, e.g SVM::C_SVC.

<comment>Return:</comment>
  <info>int</info>  Return an integer SVM type


id: SVMModel::getSvrProbability
type: function
doc:
<comment>Description:</comment>
  Get the sigma value for regression types
  
  For regression models, returns a sigma value. If there is no probability information or the model
  is not SVR, 0 is returned.

<comment>Return:</comment>
  <info>float</info>  Returns a sigma value


id: SVMModel::load
type: function
doc:
<comment>Description:</comment>
  Load a saved SVM Model
  
  Load a model file ready for classification or regression.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the model.

<comment>Return:</comment>
  <info>bool</info>  Throws SVMException on error. Returns true on success.

<comment>See Also:</comment>
   * SVMModel::save


id: SVMModel::predict
type: function
doc:
<comment>Description:</comment>
  Predict a value for previously unseen data
  
  This function accepts an array of data and attempts to predict the class  or regression value
  based on the model extracted from previously trained data.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The array to be classified. This should be a series of key =&gt; value  pairs in
                increasing key order, but not necessarily continuous.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::train


id: SVMModel::predict_probability
type: function
doc:
<comment>Description:</comment>
  Return class probabilities for previous unseen data
  
  This function accepts an array of data and attempts to predict the class, as with the predict
  function. Additionally, however, this function returns an array of probabilities, one per class in
  the model, which represent the estimated chance of the data supplied being a member of that class.
  Requires that the model to be used has been trained with the probability parameter set to true.

<comment>Param:</comment>
  <info>array</info>  <strong>$data         </strong>  The array to be classified. This should be a series of key =&gt; value
                         pairs in increasing key order, but not necessarily continuous.
  <info>     </info>  <strong>$probabilities</strong>  The supplied value will be filled with the probabilities. This will be
                         either null, in the case  of a model without probability information, or an
                         array where the index is the class name and the value the predicted
                         probability.

<comment>Return:</comment>
  <info>float</info>  Float the predicted value. This will be a class label in the case of  classification, a
         real value in the case of regression. Throws SVMException on error

<comment>See Also:</comment>
   * SVM::predict


id: SVMModel::save
type: function
doc:
<comment>Description:</comment>
  Save a model to a file
  
  Save the model data to a file, for later use.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The file to save the model to.

<comment>Return:</comment>
  <info>bool</info>  Throws SVMException on error.  Returns true on success.

<comment>See Also:</comment>
   * SVMModel::load


id: SVN_AUTH_PARAM_DEFAULT_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  Property for default password to use when performing basic authentication


id: SVN_AUTH_PARAM_DEFAULT_USERNAME
type: constant
doc:
<comment>Description:</comment>
  Property for default username to use when performing basic authentication


id: SVN_WC_STATUS_CONFLICTED
type: constant
doc:
<comment>Description:</comment>
  Item's local modifications conflicted with repository modifications


id: SVN_WC_STATUS_MERGED
type: constant
doc:
<comment>Description:</comment>
  Item's local modifications were merged with repository modifications


id: Schema::__construct
type: function
doc:
<comment>Description:</comment>
  constructor
  
  The Schema object provides full access to the schema (database).


id: Schema::createCollection
type: function
doc:
<comment>Description:</comment>
  Add collection to schema
  
  Create a collection within the schema.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

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

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


id: Schema::dropCollection
type: function
doc:
<comment>Description:</comment>
  Drop collection from schema
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

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

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


id: Schema::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if exists in database
  
  Checks if the current object (schema, table, collection, or view) exists in the schema object.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema, table, collection, or view still exists in the schema, else <info>false</info>.


id: Schema::getCollection
type: function
doc:
<comment>Description:</comment>
  Get collection from schema
  
  Get a collection from the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Collection name to retrieve.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  The Collection object for the selected collection.


id: Schema::getCollectionAsTable
type: function
doc:
<comment>Description:</comment>
  Get collection table object
  
  Get a collection, but as a Table object instead of a Collection object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the collection to instantiate a Table object from.

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  A table object for the collection.


id: Schema::getCollections
type: function
doc:
<comment>Description:</comment>
  Get all schema collections
  
  Fetch a list of collections for this schema.

<comment>Return:</comment>
  <info>array</info>  Array of all collections in this schema, where each array element value is a Collection
         object with the collection name as the key.


id: Schema::getName
type: function
doc:
<comment>Description:</comment>
  Get schema name
  
  Get the name of the schema.

<comment>Return:</comment>
  <info>string</info>  The name of the schema connected to the schema object, as a string.


id: Schema::getSession
type: function
doc:
<comment>Description:</comment>
  Get schema session
  
  Get a new Session object from the Schema object.

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


id: Schema::getTable
type: function
doc:
<comment>Description:</comment>
  Get schema table
  
  Fetch a Table object for the provided table in the schema.

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

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


id: Schema::getTables
type: function
doc:
<comment>Description:</comment>
  Get schema tables
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>array</info>  Array of all tables in this schema, where each array element value is a Table object with
         the table name as the key.


id: SchemaObject::getSchema
type: function
doc:
<comment>Description:</comment>
  Get schema object
  
  Used by other objects to retrieve a schema object.

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


id: SeasLog::__construct
type: function
doc:
<comment>Description:</comment>
  Description
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.


id: SeasLog::alert
type: function
doc:
<comment>Description:</comment>
  Record alert log information
  
  Record alert log information.  "ALERT" - Action must be taken immediately. Immediate attention
  should be given to relevant personnel for emergency repairs.
  
  "ALERT" - Action must be taken immediately. Immediate attention should be given to relevant
  personnel for emergency repairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::analyzerCount
type: function
doc:
<comment>Description:</comment>
  Get log count by level, log_path and key_word
  
  `SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`  use system pipe and
  return to PHP (array or int).

<comment>Param:</comment>
  <info>string</info>  <strong>$level   </strong>  String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.

<comment>Return:</comment>
  <info>mixed</info>  If `level` is SEASLOG_ALL or Empty, return all levels count as `array`. If `level` is
         SEASLOG_INFO or the other level, return count as `int`.

<comment>See Also:</comment>
   * SeasLog::analyzerDetail


id: SeasLog::analyzerDetail
type: function
doc:
<comment>Description:</comment>
  Get log detail by level, log_path, key_word, start, limit, order
  
  `SeasLog` get results of  `grep -ai '{level}' | grep -ai '{key_word}' |  sed -n
  '{start},{limit}'p`  use system pipe and return array to PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$level   </strong>  String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.
  <info>int   </info>  <strong>$start   </strong>  Int. Default is `1`.
  <info>int   </info>  <strong>$limit   </strong>  Int. Default is `20`.
  <info>int   </info>  <strong>$order   </strong>  Int. Default is SEASLOG_DETAIL_ORDER_ASC. See also:
                     SEASLOG_DETAIL_ORDER_ASCSEASLOG_DETAIL_ORDER_DESC

<comment>Return:</comment>
  <info>mixed</info>  Return results as array.  When `start`,`limit` is not NULL and in Windows,  SeasLog will
         threw exception with message 'Param start and limit don't support Windows'.
         
         When `start`,`limit` is not NULL and in Windows,  SeasLog will threw exception with message
         'Param start and limit don't support Windows'.

<comment>See Also:</comment>
   * SeasLog::analyzerCount


id: SeasLog::closeLoggerStream
type: function
doc:
<comment>Description:</comment>
  Manually release stream flow from logger
  
  Manually release stream flow from logger. SeasLog caches the stream handle opened by the log
  logger to save the overhead of creating a stream. The handle will be automatically released at the
  end of the request. If in CLI mode, the process will also automatically release when it exits. Or
  you can use the following functions to manually release(manually release function needs to update
  SeasLog 1.8.6 or updated version).

<comment>Param:</comment>
  <info>int   </info>  <strong>$model </strong>  Constant int.
                   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALLSEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
  <info>string</info>  <strong>$logger</strong>  The logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on released stream flow success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::setLogger
   * SeasLog::getLastLogger


id: SeasLog::critical
type: function
doc:
<comment>Description:</comment>
  Record critical log information
  
  Record critical log information.  "CRITICAL" - Critical conditions.Need to be repaired
  immediately, and the program component is unavailable.
  
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::debug
type: function
doc:
<comment>Description:</comment>
  Record debug log information
  
  Record debug log information.  "DEBUG" - Detailed debug information.Fine-grained information
  events.
  
  "DEBUG" - Detailed debug information.Fine-grained information events.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::emergency
type: function
doc:
<comment>Description:</comment>
  Record emergency log information
  
  Record emergency log information.  "EMERGENCY" - System is unusable. 
  
  "EMERGENCY" - System is unusable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::log


id: SeasLog::error
type: function
doc:
<comment>Description:</comment>
  Record error log information
  
  Record error log information.  "ERROR" - Runtime errors that do not require immediate action but
  should typically.
  
  "ERROR" - Runtime errors that do not require immediate action but should typically.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::flushBuffer
type: function
doc:
<comment>Description:</comment>
  Flush logs buffer, dump to appender file, or send to remote api with tcp/udp
  
  Flush logs buffer by seaslog.appender:  dump to file, or send to remote api with tcp/udp.  See
  also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port
  
  See also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on flush buffer success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::getBuffer


id: SeasLog::getBasePath
type: function
doc:
<comment>Description:</comment>
  Get SeasLog base path.
  
  Use the Function SeasLog::getBasePath will get the value of seaslog.default_basepath what
  configured in php.ini(seaslog.ini).
  
  If you use Seaslog::setBasePath, will change the result.

<comment>Return:</comment>
  <info>string</info>  Return seaslog.default_basepath as string.


id: SeasLog::getBuffer
type: function
doc:
<comment>Description:</comment>
  Get the logs buffer in memory as array

<comment>Return:</comment>
  <info>array</info>  Return an array from logs buffer in memory.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::flushBuffer


id: SeasLog::getBufferEnabled
type: function
doc:
<comment>Description:</comment>
  Determin if buffer enabled
  
  Result join seaslog.use_buffer  and seaslog.buffer_disabled_in_cli.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on seaslog.use_buffer is true. If switch seaslog.buffer_disabled_in_cli on, and
        running in cli,  seaslog.use_buffer setting will be discarded, Seaslog write to the Data
        Store IMMEDIATELY.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBuffer
   * SeasLog::flushBuffer


id: SeasLog::getDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Get SeasLog datetime format style
  
  Get SeasLog datetime format style. Use the Function SeasLog::getDatetimeFormat will  get the value
  of seaslog.default_datetime_format  what configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Get SeasLog datetime format style of  seaslog.default_datetime_format. Use the Function
          SeasLog::setDatetimeFormat  will change this value.

<comment>See Also:</comment>
   * SeasLog::setDatetimeFormat


id: SeasLog::getLastLogger
type: function
doc:
<comment>Description:</comment>
  Get SeasLog last logger path
  
  Use the Function SeasLog::getLastLogger will  get the value of seaslog.default_logger  what
  configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Use the Function SeasLog::setLogger  will change the value of function
          SeasLog::getLastLogger.

<comment>See Also:</comment>
   * SeasLog::setLogger


id: SeasLog::getRequestID
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Return:</comment>
  <info>string</info>  Return string generated by the built-in `static char *get_uniqid ()` function, or setted
          by SeasLog::setRequestId function.

<comment>See Also:</comment>
   * SeasLog::setRequestID
   * The Variable `%Q` in 
   Seaslog Default Variable Table.


id: SeasLog::getRequestVariable
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request variable
  
  Get SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Constant int.
             SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP

<comment>Return:</comment>
  <info>bool</info>  Return request variable value on set success.

<comment>See Also:</comment>
   * SeasLog::setRequestVariable


id: SeasLog::info
type: function
doc:
<comment>Description:</comment>
  Record info log information
  
  Record info log information.  "INFO" - Interesting events.Emphasizes the running process of the
  application.
  
  "INFO" - Interesting events.Emphasizes the running process of the application.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::log
type: function
doc:
<comment>Description:</comment>
  The Common Record Log Function
  
  The Common Record Log Function.

<comment>Param:</comment>
  <info>string</info>  <strong>$level  </strong>  Can use level in:
                    SEASLOG_DEBUGSEASLOG_INFOSEASLOG_NOTICESEASLOG_WARNINGSEASLOG_ERRORSEASLOG_CRITICALSEASLOG_ALERTSEASLOG_EMERGENCY
                    Or you can create a new level self-help.
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency


id: SeasLog::notice
type: function
doc:
<comment>Description:</comment>
  Record notice log information
  
  Record notice log information.  "NOTICE" - Normal but significant events.Information that is more
  important than the INFO level during execution.
  
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::setBasePath
type: function
doc:
<comment>Description:</comment>
  Set SeasLog base path
  
  Set SeasLog base path.

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

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted base path success, FALSE on failure.


id: SeasLog::setDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Set SeasLog datetime format style
  
  Set SeasLog datetime format style.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at
                   <strong>date()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted datetime format success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getDateTimeFormat


id: SeasLog::setLogger
type: function
doc:
<comment>Description:</comment>
  Set SeasLog logger name
  
  Use the Function SeasLog::setLogger will change the value of function SeasLog::getLastLogger.
  Than's mean, SeasLog will record loginfo into the logger directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$logger</strong>  Logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on created logger disectory success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getLastLogger
   * SeasLog::closeLoggerStream


id: SeasLog::setRequestID
type: function
doc:
<comment>Description:</comment>
  Set SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

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

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set request_id success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestID


id: SeasLog::setRequestVariable
type: function
doc:
<comment>Description:</comment>
  Manually set SeasLog request variable
  
  Manually set SeasLog request variable.

<comment>Param:</comment>
  <info>int   </info>  <strong>$key  </strong>  Constant int.
                  SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP
  <info>string</info>  <strong>$value</strong>  The request variable value.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getRequestVariable


id: SeasLog::warning
type: function
doc:
<comment>Description:</comment>
  Record warning log information
  
  Record warning log information.  "WARNING" - Exceptional occurrences that are not errors.
  Potentially aberrant information that needs attention and needs to be repaired.
  
  "WARNING" - Exceptional occurrences that are not errors. Potentially aberrant information that
  needs attention and needs to be repaired.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array </info>  <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger </strong>  The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeekableIterator::seek
type: function
doc:
<comment>Description:</comment>
  Seeks to a position
  
  Seeks to a given position in the iterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The position to seek to.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * <class>SeekableIterator</class>
   * <class>Iterator</class>


id: Serializable
type: class
doc:
<comment>Description:</comment>
  Interface for customized serializing.
  
  Classes that implement this interface no longer support __sleep() and __wakeup(). The method
  serialize is called whenever an instance needs to be serialized. This does not invoke __destruct()
  or have any other side effect unless programmed inside the method. When the data is unserialized
  the class is known and the appropriate unserialize() method is called as a constructor instead of
  calling __construct(). If you need to execute the standard constructor you may do so in the
  method.


id: Serializable::serialize
type: function
doc:
<comment>Description:</comment>
  String representation of object
  
  Should return the string representation of the object.

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of the object or <info>null</info>

<comment>See Also:</comment>
   * __sleep()
   * __serialize()


id: Serializable::unserialize
type: function
doc:
<comment>Description:</comment>
  Constructs the object
  
  Called during unserialization of the object.
  
  This method acts as the constructor of the object. The __construct() method will not be called
  after this method.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  The string representation of the object.

<comment>Return:</comment>
  <info>void</info>  The return value from this method is ignored.

<comment>See Also:</comment>
   * __wakeup()
   * __unserialize()


id: Session::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  A Session object, as initiated by getSession().


id: Session::close
type: function
doc:
<comment>Description:</comment>
  Close session
  
  Close the session with the server.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the session closed.


id: Session::commit
type: function
doc:
<comment>Description:</comment>
  Commit transaction
  
  Commit the transaction.

<comment>Return:</comment>
  <info>Object</info>  An SqlStatementResult object.


id: Session::createSchema
type: function
doc:
<comment>Description:</comment>
  Create new schema
  
  Creates a new schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to create.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object on success, and emits an exception on failure.


id: Session::dropSchema
type: function
doc:
<comment>Description:</comment>
  Drop a schema
  
  Drop a schema (database).

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to drop.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema is dropped, or <info>false</info> if it does not exist or can't be dropped.
        
        An <info>E_WARNING</info> level error is generated if the  schema does not exist.


id: Session::generateUUID
type: function
doc:
<comment>Description:</comment>
  Get new UUID
  
  Generate a Universal Unique IDentifier (UUID) generated according to  RFC 4122.

<comment>Return:</comment>
  <info>string</info>  The UUID; a string with a length of 32.


id: Session::getDefaultSchema
type: function
doc:
<comment>Description:</comment>
  Get default schema name
  
  Retrieve name of the default schema that's typically set in the connection URI.

<comment>Return:</comment>
  <info>string</info>  Name of the default schema defined by the connection, or <info>null</info> if one was not set.


id: Session::getSchema
type: function
doc:
<comment>Description:</comment>
  Get a new schema object
  
  A new Schema object for the provided schema name.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema (database) to fetch a Schema object for.

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


id: Session::getSchemas
type: function
doc:
<comment>Description:</comment>
  Get the schemas
  
  Get schema objects for all schemas available to the session.

<comment>Return:</comment>
  <info>array</info>  An array containing objects that represent all of the schemas  available to the session.


id: Session::getServerVersion
type: function
doc:
<comment>Description:</comment>
  Get server version
  
  Retrieve the MySQL server version for the session.

<comment>Return:</comment>
  <info>int</info>  The MySQL server version for the session, as an integer such as "80012".


id: Session::listClients
type: function
doc:
<comment>Description:</comment>
  Get client list
  
  Get a list of client connections to the session's MySQL server.

<comment>Return:</comment>
  <info>array</info>  An array containing the currently logged clients. The array elements are "client_id",
         "user", "host", and "sql_session".


id: Session::quoteName
type: function
doc:
<comment>Description:</comment>
  Add quotes
  
  A quoting function to escape SQL names and identifiers. It escapes the identifier  given in
  accordance to the settings of the current connection. This escape  function should not be used to
  escape values.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The string to quote.

<comment>Return:</comment>
  <info>string</info>  The quoted string.


id: Session::releaseSavepoint
type: function
doc:
<comment>Description:</comment>
  Release set savepoint
  
  Release a previously set savepoint.

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

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollback
type: function
doc:
<comment>Description:</comment>
  Rollback transaction
  
  Rollback the transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollbackTo
type: function
doc:
<comment>Description:</comment>
  Rollback transaction to savepoint
  
  Rollback the transaction back to the savepoint.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the savepoint to rollback to; case-insensitive.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::setSavepoint
type: function
doc:
<comment>Description:</comment>
  Create savepoint
  
  Create a new savepoint for the transaction.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the savepoint. The name is auto-generated if the optional <return>name</return>
                 parameter is not defined as 'SAVEPOINT1', 'SAVEPOINT2', and so on.

<comment>Return:</comment>
  <info>string</info>  The name of the save point.


id: Session::sql
type: function
doc:
<comment>Description:</comment>
  Execute SQL query
  
  Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the
  <return>execute</return> method to execute the SQL statement.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  SQL statement to execute.

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  An SqlStatement object.


id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Start transaction
  
  Start a new transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandler</class> is a special class that can be used to expose the current internal PHP session save
  handler by inheritance. There are seven methods which wrap the seven internal session save handler
  callbacks (<strong>$open</strong>, <strong>$close</strong>, <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> and <strong>$create_sid</strong>).  By default, this class
  will wrap whatever internal save handler is set as defined by the session.save_handler
  configuration directive which is usually <strong>$files</strong> by default.  Other internal session save handlers
  are provided by PHP extensions such as SQLite (as <strong>$sqlite</strong>), Memcache (as <strong>$memcache</strong>), and Memcached
  (as <strong>$memcached</strong>).
  
  When a plain instance of <class>SessionHandler</class> is set as the save handler using
  <strong>session_set_save_handler()</strong> it will wrap the current save handlers. A class extending from
  <class>SessionHandler</class> allows you to override the methods or intercept or filter them by calls the parent
  class methods which ultimately wrap the internal PHP session handlers.
  
  This allows you, for example, to intercept the <strong>$read</strong> and <strong>$write</strong> methods to encrypt/decrypt the
  session data and then pass the result to and from the parent class. Alternatively one might chose
  to entirely override a method like the garbage collection callback <strong>$gc</strong>.
  
  Because the <class>SessionHandler</class> wraps the current internal save handler methods, the above example of
  encryption can be applied to any internal save handler without having to know the internals of the
  handlers.
  
  To use this class, first set the save handler you wish to expose using session.save_handler and
  then pass an instance of <class>SessionHandler</class> or one extending it to <strong>session_set_save_handler()</strong>.
  
  Please note the callback methods of this class are designed to be called internally by PHP and are
  not meant to be called from user-space code.  The return values are equally processed internally
  by PHP.  For more information on the session workflow, please refer <strong>session_set_save_handler()</strong>.


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  Close the session
  
  Closes the current session. This method is automatically executed internally by PHP when closing
  the session, or explicitly via <strong>session_write_close()</strong> (which first calls the
  <strong>SessionHandler::write()</strong>).
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was activated by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritiance, calling the parent <strong>$close</strong> method will invoke the
  wrapper for this method and therefore invoke the associated internal callback.  This allows the
  method to be overridden and or intercepted.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  Return a new session ID
  
  Generates and returns a new session ID.

<comment>Return:</comment>
  <info>string</info>  A session ID valid for the default session handler.

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy a session
  
  Destroys a session. Called internally by PHP with <strong>session_regenerate_id()</strong> (assuming the <strong>$destroy</strong>
  is set to <info>true</info>, by <strong>session_destroy()</strong> or when <strong>session_decode()</strong> fails.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritiance, calling the parent <strong>$destroy</strong> method will invoke the
  wrapper for this method and therefore invoke the associated internal callback.  This allows this
  method to be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::destroy()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID being destroyed.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  Cleanup old sessions
  
  Cleans up expired sessions. Called randomly by PHP internally when a session starts or when
  <strong>session_start()</strong> is invoked.  The frequency this is called is based on the session.gc_divisor and
  session.gc_probability configuration directives.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritiance, calling the parent <strong>$gc</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows this method to
  be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::gc()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions that have not updated for the last <strong>$max_lifetime</strong> seconds will be
                      removed.

<comment>Return:</comment>
  <info>intbool</info>  Returns the number of deleted sessions on success,  sau <info>false</info> în cazul eșecului. Note
           this value is returned internally to PHP for processing.


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  Initialize session
  
  Create new session, or re-initialize existing session. Called internally by PHP when a session
  starts either automatically or when <strong>session_start()</strong> is invoked.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritiance, calling the parent <strong>$open</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows this method to
  be overridden and or intercepted and filtered.
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path where to store/retrieve the session.
  <info>string</info>  <strong>$name</strong>  The session name.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.

<comment>See Also:</comment>
   * 
     The session.auto-start
     configuration directive.
    


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  Read session data
  
  Reads the session data from the session storage, and returns the result back to PHP for internal
  processing. This method is called automatically by PHP when a session is started (either
  automatically or explicitly with <strong>session_start()</strong> and is preceded by an internal call to the
  <strong>SessionHandler::open()</strong>.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritance, calling the parent <strong>$read</strong> method will invoke the wrapper
  for this method and therefore invoke the associated internal callback.  This allows the method to
  be overridden and or intercepted and filtered (for example, decrypting <strong>$data</strong> value returned by the
  parent <strong>$read</strong> method).
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::read()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session id to read data for.

<comment>Return:</comment>
  <info>string</info>  Returns an encoded string of the read data. If nothing was read, it must return an empty
          string. Note this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  Write session data
  
  Writes the session data to the session storage. Called by normal PHP shutdown, by
  <strong>session_write_close()</strong>, or when <strong>session_register_shutdown()</strong> fails. PHP will call
  <strong>SessionHandler::close()</strong> immediately after this method returns.
  
  This method wraps the internal PHP save handler defined in the session.save_handler ini setting
  that was set before this handler was set by <strong>session_set_save_handler()</strong>.
  
  If this class is extended by inheritiance, calling the parent <strong>$write</strong> method will invoke the
  wrapper for this method and therefore invoke the associated internal callback.  This allows this
  method to be overridden and or intercepted and filtered (for example, encrypting the <strong>$data</strong> value
  before sending it to the parent <strong>$write</strong> method).
  
  For more information on what this method is expected to do, please refer to the documentation at
  <strong>SessionHandlerInterface::write()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id  </strong>  The session id.
  <info>string</info>  <strong>$data</strong>  The encoded session data.  This data is the result of the PHP internally encoding
                 the $_SESSION superglobal to a serialized string and passing it as this parameter.
                 Please note sessions use an alternative serialization method.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> is an interface which defines the minimal prototype for creating a custom
  session handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong> using its
  OOP invocation, the class can implement this interface.
  
  Please note the callback methods of this class are designed to be called internally by PHP and are
  not meant to be called from user-space code.


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  Close the session
  
  Closes the current session. This function is automatically executed when closing the session, or
  explicitly via <strong>session_write_close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy a session
  
  Destroys a session. Called by <strong>session_regenerate_id()</strong> (with $destroy = <info>true</info>), <strong>session_destroy()</strong>
  and when <strong>session_decode()</strong> fails.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID being destroyed.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  Cleanup old sessions
  
  Cleans up expired sessions. Called by <strong>session_start()</strong>, based on session.gc_divisor,
  session.gc_probability and session.gc_maxlifetime settings.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Sessions that have not updated for the last <strong>$max_lifetime</strong> seconds will be
                      removed.

<comment>Return:</comment>
  <info>intbool</info>  Returns the number of deleted sessions on success,  sau <info>false</info> în cazul eșecului. Note
           this value is returned internally to PHP for processing.


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  Initialize session
  
  Re-initialize existing session, or creates a new one. Called when a session starts or when
  <strong>session_start()</strong> is invoked.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  The path where to store/retrieve the session.
  <info>string</info>  <strong>$name</strong>  The session name.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * 
     The session.auto-start
     configuration directive.
    


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  Read session data
  
  Reads the session data from the session storage, and returns the results. Called right after the
  session starts or when <strong>session_start()</strong> is called. Please note that before this method is called
  <strong>SessionHandlerInterface::open()</strong> is invoked.
  
  This method is called by PHP itself when the session is started. This method should retrieve the
  session data from storage by the session ID provided. The string returned by this method must be
  in the same serialized format as when originally passed to the <strong>SessionHandlerInterface::write()</strong> If
  the record was not found, return an empty string.
  
  The data returned by this method will be decoded internally by PHP using the unserialization
  method specified in session.serialize_handler. The resulting data will be used to populate the
  $_SESSION superglobal.
  
  Note that the serialization scheme is not the same as <strong>unserialize()</strong> and can be accessed by
  <strong>session_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session id.

<comment>Return:</comment>
  <info>string</info>  Returns an encoded string of the read data. If nothing was read, it must return an empty
          string. Note this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  Write session data
  
  Writes the session data to the session storage. Called by <strong>session_write_close()</strong>, when
  <strong>session_register_shutdown()</strong> fails, or during a normal shutdown. Note:
  <strong>SessionHandlerInterface::close()</strong> is called immediately after this function.
  
  PHP will call this method when the session is ready to be saved and closed. It encodes the session
  data from the $_SESSION superglobal to a serialized string and passes this along with the session
  ID to this method for storage.  The serialization method used is specified in the
  session.serialize_handler setting.
  
  Note this method is normally called by PHP after the output buffers have been closed unless
  explicitly called by <strong>session_write_close()</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$id  </strong>  The session id.
  <info>string</info>  <strong>$data</strong>  The encoded session data.  This data is the result of the PHP internally encoding
                 the $_SESSION superglobal to a serialized string and passing it as this parameter.
                 Please note sessions use an alternative serialization method.

<comment>Return:</comment>
  <info>bool</info>  Valoarea întoarsă (de regulă <info>true</info> în
        caz de succes, <info>false</info> în caz de eșec). Notă: această valoare este întoarsă
        intern către PHP pentru procesare.

<comment>See Also:</comment>
   * 
     The session.serialize_handler
     configuration directive.
    


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> is an interface which defines optional methods for creating a custom session
  handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong> using its OOP
  invocation, the class can implement this interface.
  
  Note that the callback methods of classes implementing this interface are designed to be called
  internally by PHP and are not meant to be called from user-space code.


id: SessionIdInterface::create_sid
type: function
doc:
<comment>Description:</comment>
  Create session ID
  
  Creates a new session ID.This function is automatically executed when a new session ID needs to be
  created.

<comment>Return:</comment>
  <info>string</info>  The new session ID. Note that this value is returned internally to PHP for processing.

<comment>See Also:</comment>
   * SessionHandler::create_sid


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> is an interface which defines optional methods for creating
  a custom session handler. In order to pass a custom session handler to <strong>session_set_save_handler()</strong>
  using its OOP invocation, the class can implement this interface.
  
  Note that the callback methods of classes implementing this interface are designed to be called
  internally by PHP and are not meant to be called from user-space code.


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  Update timestamp
  
  Updates the last modification timestamp of the session. This function is automatically executed
  when a session is updated.

<comment>Param:</comment>
  <info>string</info>  <strong>$id  </strong>  The session ID.
  <info>string</info>  <strong>$data</strong>  The session data.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the timestamp was updated, <info>false</info> otherwise. Note that this value is returned
        internally to PHP for processing.


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  Validate ID
  
  Validates a given session ID. A session ID is valid, if a session with that ID already exists.
  This function is automatically executed when a session is to be started, a session ID is supplied
  and session.use_strict_mode is enabled.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The session ID.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> for valid ID, <info>false</info> otherwise. Note that this value is returned internally to
        PHP for processing.


id: Shmop
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>shmop</return> resources as of PHP 8.0.0.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data       </strong>  A well-formed XML string or the path or URL to an XML document if
                        <strong>$data_is_url</strong> is <info>true</info>.
  <info>int   </info>  <strong>$options    </strong>  Optionally used to specify additional Libxml parameters, which affect
                        reading of XML documents. Options which affect the output of XML documents
                        (e.g. <info>LIBXML_NOEMPTYTAG</info>) are silently ignored.
                        
                        It may be necessary to pass <info>LIBXML_PARSEHUGE</info> to be able to process deeply
                        nested XML or very large text nodes.
  <info>bool  </info>  <strong>$data_is_url</strong>  By default, <strong>$data_is_url</strong> is <info>false</info>. Use <info>true</info> to specify that <strong>$data</strong> is a path
                        or URL to an XML  document instead of <info>string</info> data.
  <info>string</info>  <strong>$ns         </strong>  Namespace prefix or URI.
  <info>bool  </info>  <strong>$is_prefix  </strong>  <info>true</info> if <strong>$ns</strong> is a prefix, <info>false</info> if it's a URI; defaults to <info>false</info>.

<comment>Return:</comment>
  <info>unknown</info>  Returns a <info>SimpleXMLElement</info> object representing  <strong>$data</strong>.

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string content
  
  Returns text content that is directly in this element. Does not return text content that is inside
  this element's children.

<comment>Return:</comment>
  <info>string</info>  Returns the string content on success or an empty string on failure.

<comment>See Also:</comment>
   * SimpleXMLElement::asXML


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  Adds an attribute to the SimpleXML element
    
  
  Adds an attribute to the SimpleXML element.

<comment>Param:</comment>
  <info>string</info>  <strong>$name     </strong>  The name of the attribute to add.
  <info>string</info>  <strong>$value    </strong>  The value of the attribute.
  <info>string</info>  <strong>$namespace</strong>  If specified, the namespace to which the attribute belongs.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SimpleXMLElement::addChild
   * 


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  Adds a child element to the XML node
    
  
  Adds a child element to the node and returns a SimpleXMLElement of the child.

<comment>Param:</comment>
  <info>string</info>  <strong>$name     </strong>  The name of the child element to add.
  <info>string</info>  <strong>$value    </strong>  If specified, the value of the child element.
  <info>string</info>  <strong>$namespace</strong>  If specified, the namespace to which the child element belongs.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  The <return>addChild</return> method returns a <info>SimpleXMLElement</info> object representing the child
                    added to the XML node.

<comment>See Also:</comment>
   * SimpleXMLElement::addAttribute
   * 


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  Return a well-formed XML string based on SimpleXML element
    
  
  The <return>asXML</return> method formats the parent object's data in XML version 1.0.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  If specified, the function writes the data to the file rather than returning
                     it.

<comment>Return:</comment>
  <info>mixed</info>  If the <strong>$filename</strong> isn't specified, this function returns a <info>string</info> on success and <info>false</info> on
         error. If the parameter is specified, it returns <info>true</info> if the file was written successfully
         and <info>false</info> otherwise.

<comment>See Also:</comment>
   * SimpleXMLElement::__toString
   * 


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  Identifies an element's attributes
  
  This function provides the attributes and values defined within an xml tag.
  
  SimpleXML a creat o regulă de a adăuga proprietăți iterative la
  majoritatea metodelor. Ele nu pot fi vizualizate cu ajutorul <strong>
  var_dump()</strong> sau orice altceva ce poate examina obiecte.

<comment>Param:</comment>
  <info>string</info>  <strong>$ns       </strong>  An optional namespace for the retrieved attributes
  <info>bool  </info>  <strong>$is_prefix</strong>  Default to <info>false</info>

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Returns a <class>SimpleXMLElement</class> object that can be iterated over to loop through the
                    attributes on the tag.
                    
                    Returns <info>null</info> if called on a <class>SimpleXMLElement</class> object that already represents an
                    attribute and not a tag.

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  Finds children of given node
  
  This method finds the children of an element. The result follows normal iteration rules.
  
  SimpleXML a creat o regulă de a adăuga proprietăți iterative la
  majoritatea metodelor. Ele nu pot fi vizualizate cu ajutorul <strong>
  var_dump()</strong> sau orice altceva ce poate examina obiecte.

<comment>Param:</comment>
  <info>string</info>  <strong>$ns       </strong>  An XML namespace.
  <info>bool  </info>  <strong>$is_prefix</strong>  If <strong>$is_prefix</strong> is <info>true</info>, <strong>$ns</strong> will be regarded as a prefix. If <info>false</info>, <strong>$ns</strong> will be
                      regarded as a namespace URL.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Returns a <class>SimpleXMLElement</class> element, whether the node  has children or not.

<comment>See Also:</comment>
   * SimpleXMLElement::count
   * <strong>count()</strong>


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  Counts the children of an element
  
  This method counts the number of children of an element.

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements of an element.

<comment>See Also:</comment>
   * SimpleXMLElement::children


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  Returns namespaces declared in document
    
  
  Returns namespaces declared in document

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  If specified, returns all namespaces declared in parent and child nodes.
                    Otherwise, returns only namespaces declared in root node.
  <info>bool</info>  <strong>$from_root</strong>  Allows you to recursively check namespaces under a child node instead of from
                    the root of the XML doc.

<comment>Return:</comment>
  <info>array</info>  The <return>getDocNamespaces</return> method returns an <info>array</info>  of namespace names with their associated
         URIs.

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  Gets the name of the XML element
  
  Gets the name of the XML element.

<comment>Return:</comment>
  <info>string</info>  The <return>getName</return> method returns as a <info>string</info> the  name of the XML tag referenced by the
          SimpleXMLElement object.


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  Returns namespaces used in document
    
  
  Returns namespaces used in document

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  If specified, returns all namespaces used in parent and child nodes.  Otherwise,
                    returns only namespaces used in root node.

<comment>Return:</comment>
  <info>array</info>  The <return>getNamespaces</return> method returns an <info>array</info> of  namespace names with their associated URIs.

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::registerXPathNamespace
type: function
doc:
<comment>Description:</comment>
  Creates a prefix/ns context for the next XPath query
    
  
  Creates a prefix/ns context for the next XPath query. In particular, this is helpful if the
  provider of the given XML document alters the namespace prefixes. <return>registerXPathNamespace</return> will
  create a prefix for the associated namespace, allowing one to access nodes in that namespace
  without the need to change code to allow for the new prefixes dictated by the provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  The namespace prefix to use in the XPath query for the namespace given in  <strong>$ns</strong>.
  <info>string</info>  <strong>$ns    </strong>  The namespace to use for the XPath query. This must match a namespace in use by
                   the XML document or the XPath query using  <strong>$prefix</strong> will not return any results.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  Pseudonim pentru SimpleXMLElement::asXML
  
  Această metodă este pseudonim pentru:  SimpleXMLElement::asXML


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  Runs XPath query on XML data
  
  The <return>xpath</return> method searches the SimpleXML node for children matching the XPath <strong>$path</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  An XPath path

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of SimpleXMLElement objects or <info>false</info> in case of an error.

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  The SimpleXMLIterator provides recursive iteration over all nodes of a <class>SimpleXMLElement</class> object.


id: SimpleXMLIterator::current
type: function
doc:
<comment>Description:</comment>
  Returns the current element
  
  This method returns the current element as a <class>SimpleXMLIterator</class> object or <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  Returns the current element as a <class>SimpleXMLIterator</class> object or <info>null</info> on failure.

<comment>See Also:</comment>
   * SimpleXMLIterator::key
   * SimpleXMLIterator::next
   * SimpleXMLIterator::rewind
   * SimpleXMLIterator::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  Returns the sub-elements of the current element
  
  This method returns a <class>SimpleXMLIterator</class> object containing sub-elements of the current
  <class>SimpleXMLIterator</class> element.

<comment>Return:</comment>
  <info>SimpleXMLIterator</info>  Returns a <class>SimpleXMLIterator</class> object containing the sub-elements of the current
                     element.


id: SimpleXMLIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  Checks whether the current element has sub elements
  
  This method checks whether the current <class>SimpleXMLIterator</class> element has sub-elements.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current element has sub-elements, otherwise <info>false</info>


id: SimpleXMLIterator::key
type: function
doc:
<comment>Description:</comment>
  Return current key
  
  This method gets the XML tag name of the current element.

<comment>Return:</comment>
  <info>mixed</info>  Returns the XML tag name of the element referenced by the current <class>SimpleXMLIterator</class> object
         or <info>false</info>


id: SimpleXMLIterator::next
type: function
doc:
<comment>Description:</comment>
  Move to next element
  
  This method moves the <class>SimpleXMLIterator</class> to the next element.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SimpleXMLIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind to the first element
  
  This method rewinds the <class>SimpleXMLIterator</class> to the first element.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SimpleXMLIterator::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the current element is valid
  
  This method checks if the current element is valid after calls to SimpleXMLIterator::rewind or
  SimpleXMLIterator::next.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the current element is valid, otherwise <info>false</info>


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  The SoapClient class provides a client for SOAP 1.1, SOAP 1.2 servers. It can be used in WSDL or
  non-WSDL mode.


id: SoapClient::SoapClient
type: function
doc:
<comment>Description:</comment>
  SoapClient constructor
  
  This constructor creates <class>SoapClient</class> objects  in <return>WSDL</return> or <return>non-WSDL</return> mode.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$wsdl   </strong>  URI of the <return>WSDL</return> file or <info>null</info> if working in  <return>non-WSDL</return> mode.
                   
                   During development, WSDL caching may be disabled by the use of the
                   <return>soap.wsdl_cache_ttl</return> php.ini setting otherwise changes made to the WSDL file will
                   have no effect until <return>soap.wsdl_cache_ttl</return> is expired.
  <info>array</info>  <strong>$options</strong>  An array of options. If working in WSDL mode, this parameter is optional. If
                   working in non-WSDL mode, the <return>location</return> and  <return>uri</return> options must be set, where
                   <return>location</return> is the URL of the SOAP server to send the request to, and <return>uri</return> is the
                   target namespace of the SOAP service.
                   
                   The <return>style</return> and <return>use</return> options only work in non-WSDL mode. In WSDL mode, they come
                   from the WSDL file.
                   
                   The <return>soap_version</return> option should be one of either <info>SOAP_1_1</info> or <info>SOAP_1_2</info> to select
                   SOAP 1.1 or 1.2, respectively. If omitted, 1.1 is used.
                   
                   For HTTP authentication, the <return>login</return> and <return>password</return> options can be used to supply
                   credentials.  For making an HTTP connection through a proxy server, the options
                   <return>proxy_host</return>, <return>proxy_port</return>, <return>proxy_login</return> and <return>proxy_password</return> are also available. For
                   HTTPS client certificate authentication use <return>local_cert</return> and <return>passphrase</return> options. An
                   authentication may be supplied in the <return>authentication</return>  option. The authentication
                   method may be either  <info>SOAP_AUTHENTICATION_BASIC</info> (default) or
                   <info>SOAP_AUTHENTICATION_DIGEST</info>.
                   
                   The <return>compression</return> option allows to use compression of HTTP SOAP requests and
                   responses.
                   
                   The <return>encoding</return> option defines internal character  encoding. This option does not
                   change the encoding of SOAP requests (it is always utf-8), but converts strings
                   into it.
                   
                   The <return>trace</return> option enables tracing of request so faults  can be backtraced. This
                   defaults to <info>false</info>
                   
                   The <return>classmap</return> option can be used to map some WSDL  types to PHP classes. This
                   option must be an array with WSDL types  as keys and names of PHP classes as
                   values.
                   
                   Setting the boolean <return>trace</return> option enables use of the methods
                   SoapClient-&gt;__getLastRequest,   SoapClient-&gt;__getLastRequestHeaders,
                   SoapClient-&gt;__getLastResponse and  SoapClient-&gt;__getLastResponseHeaders.
                   
                   The <return>exceptions</return> option is a boolean value defining whether soap errors throw
                   exceptions of type  SoapFault.
                   
                   The <return>connection_timeout</return> option defines a timeout in seconds  for the connection to
                   the SOAP service. This option does not define a timeout for services with slow
                   responses. To limit the time to wait for calls to finish the
                   default_socket_timeout setting is available.
                   
                   The <return>typemap</return> option is an array of type mappings. Type mapping is an array with
                   keys <return>type_name</return>, <return>type_ns</return> (namespace URI), <return>from_xml</return> (callback accepting one string
                   parameter) and <return>to_xml</return> (callback accepting one object parameter).
                   
                   The <return>cache_wsdl</return> option is one of <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                   <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.
                   
                   The <return>user_agent</return> option specifies string to use in <return>User-Agent</return> header.
                   
                   The <return>stream_context</return> option is a <info>resource</info> for context.
                   
                   The <return>features</return> option is a bitmask of <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>,
                   <info>SOAP_USE_XSI_ARRAY_TYPE</info>, <info>SOAP_WAIT_ONE_WAY_CALLS</info>.
                   
                   The <return>keep_alive</return> option is a boolean value defining whether to send the <return>Connection:
                   Keep-Alive</return> header or  <return>Connection: close</return>.
                   
                   The <return>ssl_method</return> option is one of <info>SOAP_SSL_METHOD_TLS</info>, <info>SOAP_SSL_METHOD_SSLv2</info>,
                   <info>SOAP_SSL_METHOD_SSLv3</info> or <info>SOAP_SSL_METHOD_SSLv23</info>.


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  Calls a SOAP function (deprecated)
  
  Calling this method directly is deprecated. Usually, SOAP functions can be called as methods of
  the <class>SoapClient</class> object; in situations where this is not possible or additional options are needed,
  use <strong>SoapClient::__soapCall()</strong>.

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


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  SoapClient constructor
  
  Această funcție este pseudonim pentru:  SoapClient::SoapClient


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  Performs a SOAP request
  
  Performs SOAP request over HTTP.
  
  This method can be overridden in subclasses to implement different transport layers, perform
  additional XML processing or other purpose.

<comment>Param:</comment>
  <info>string</info>  <strong>$request </strong>  The XML SOAP request.
  <info>string</info>  <strong>$location</strong>  The URL to request.
  <info>string</info>  <strong>$action  </strong>  The SOAP action.
  <info>int   </info>  <strong>$version </strong>  The SOAP version.
  <info>bool  </info>  <strong>$oneWay  </strong>  If <return>one_way</return> is set to 1, this method returns nothing.  Use this where a response
                     is not expected.

<comment>Return:</comment>
  <info>stringnull</info>  The XML SOAP response.


id: SoapClient::__getCookies
type: function
doc:
<comment>Description:</comment>
  Get list of cookies
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

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


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  Returns list of available SOAP functions
  
  Returns an array of functions described in the WSDL for the Web service.
  
  Această funcție funcționează doar în modul WSDL.

<comment>Return:</comment>
  <info>arraynull</info>  The <info>array</info> of SOAP function prototypes, detailing the return type, the function name and
             type-hinted parameters.

<comment>See Also:</comment>
   * SoapClient::SoapClient


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  Returns last SOAP request
  
  Returns the XML sent in the last SOAP request.
  
  This method works only if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>stringnull</info>  The last SOAP request, as an XML string.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the SOAP headers from the last request
  
  Returns the SOAP headers from the last request.
  
  This function only works if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>stringnull</info>  The last SOAP request headers.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  Returns last SOAP response
  
  Returns the XML received in the last SOAP response.
  
  This method works only if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>stringnull</info>  The last SOAP response, as an XML string.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the SOAP headers from the last response
  
  Returns the SOAP headers from the last response.
  
  This function only works if the <class>SoapClient</class> object was created with the <return>trace</return> option set to <info>true</info>.

<comment>Return:</comment>
  <info>stringnull</info>  The last SOAP response headers.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  Returns a list of SOAP types
  
  Returns an array of types described in the WSDL for the Web service.
  
  Această funcție funcționează doar în modul WSDL.

<comment>Return:</comment>
  <info>arraynull</info>  The <info>array</info> of SOAP types, detailing all structures and types.

<comment>See Also:</comment>
   * SoapClient::SoapClient


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  The __setCookie purpose
  
  Defines a cookie to be sent along with the SOAP requests.
  
  Calling this method will affect all following calls to  <class>SoapClient</class> methods.

<comment>Param:</comment>
  <info>string    </info>  <strong>$name </strong>  The name of the cookie.
  <info>stringnull</info>  <strong>$value</strong>  The value of the cookie. If not specified, the cookie will be deleted.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  Sets the location of the Web service to use
  
  Sets the endpoint URL that will be touched by following SOAP requests. This is equivalent to
  specifying the <return>location</return> option when constructing the SoapClient.
  
  Calling this method is optional.  The SoapClient uses the endpoint from the WSDL file by default.

<comment>Param:</comment>
  <info>string</info>  <strong>$location</strong>  The new endpoint URL.

<comment>Return:</comment>
  <info>stringnull</info>  The old endpoint URL.

<comment>See Also:</comment>
   * SoapClient::SoapClient


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  Sets SOAP headers for subsequent calls
  
  Defines headers to be sent along with the SOAP requests.
  
  Calling this method will replace any previous values.

<comment>Param:</comment>
  <info>SoapHeaderarraynull</info>  <strong>$headers</strong>  The headers to be set. It could be <class>SoapHeader</class> object or array of
                                 <class>SoapHeader</class> objects. If not specified or set to <info>null</info>, the headers
                                 will be deleted.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  Calls a SOAP function
  
  This is a low level API function that is used to make a SOAP call. Usually, in WSDL mode, SOAP
  functions can be called as methods of the <class>SoapClient</class> object. This method is useful in non-WSDL
  mode when <return>soapaction</return> is unknown, <return>uri</return> differs from the default or when sending and/or receiving
  SOAP Headers.
  
  On error, a call to a SOAP function can cause PHP to throw exceptions or return a <class>SoapFault</class> object
  if exceptions are disabled. To check if the function call failed to catch the SoapFault
  exceptions, check the result with <strong>is_soap_fault()</strong>.

<comment>Param:</comment>
  <info>string             </info>  <strong>$name         </strong>  The name of the SOAP function to call.
  <info>array              </info>  <strong>$args         </strong>  An array of the arguments to pass to the function. This can
                                       be either an ordered or an associative array. Note that most
                                       SOAP servers require parameter names to be provided, in which
                                       case this must be an associative array.
  <info>arraynull          </info>  <strong>$options      </strong>  An associative array of options to pass to the client.
                                       
                                       The <return>location</return> option is the URL of the remote Web service.
                                       
                                       The <return>uri</return> option is the target namespace of the SOAP service.
                                       
                                       The <return>soapaction</return> option is the action to call.
  <info>SoapHeaderarraynull</info>  <strong>$inputHeaders </strong>  An array of headers to be sent along with the SOAP request.
  <info>array              </info>  <strong>$outputHeaders</strong>  If supplied, this array will be filled with the headers from
                                       the SOAP response.

<comment>Return:</comment>
  <info>mixed</info>  SOAP functions may return one, or multiple values. If only one value is returned by the
         SOAP function, the return value of <return>__soapCall</return> will be a simple value (e.g. an integer, a
         string, etc). If multiple values are returned, <return>__soapCall</return> will return an associative array
         of named output parameters.
         
         On error, if the SoapClient object was constructed with the <return>exceptions</return> option set to <info>false</info>,
         a SoapFault object will be returned.

<comment>See Also:</comment>
   * SoapClient::SoapClient
   * SoapParam::SoapParam
   * SoapVar::SoapVar
   * SoapHeader::SoapHeader
   * SoapFault::SoapFault
   * <strong>is_soap_fault()</strong>


id: SoapFault::SoapFault
type: function
doc:
<comment>Description:</comment>
  SoapFault constructor
  
  This class is used to send SOAP fault responses from the PHP handler. <strong>$faultcode</strong>, <strong>$faultstring</strong>,
  <strong>$faultactor</strong> and <strong>$detail</strong> are standard elements of a SOAP Fault.

<comment>Param:</comment>
  <info>string</info>  <strong>$faultcode  </strong>  The error code of the <class>SoapFault</class>.
  <info>string</info>  <strong>$faultstring</strong>  The error message of the <class>SoapFault</class>.
  <info>string</info>  <strong>$faultactor </strong>  A string identifying the actor that caused the error.
  <info>string</info>  <strong>$detail     </strong>  More details about the cause of the error.
  <info>string</info>  <strong>$faultname  </strong>  Can be used to select the proper fault encoding from WSDL.
  <info>string</info>  <strong>$headerfault</strong>  Can be used during SOAP header handling to report an error in the response
                        header.

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  SoapFault constructor
  
  Această funcție este pseudonim pentru:  SoapFault::SoapFault


id: SoapFault::__toString
type: function
doc:
<comment>Description:</comment>
  Obtain a string representation of a SoapFault
  
  Returns a string representation of the SoapFault.

<comment>Return:</comment>
  <info>string</info>  A string describing the SoapFault.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace     </strong>  The namespace of the SOAP header element.
  <info>string</info>  <strong>$name          </strong>  The name of the SoapHeader object.
  <info>mixed </info>  <strong>$data          </strong>  A SOAP header's content. It can be a PHP value or a <class>SoapVar</class> object.
  <info>      </info>  <strong>$mustUnderstand</strong>  Value of the <return>mustUnderstand</return> attribute of the SOAP  header element.
  <info>string</info>  <strong>$actor         </strong>  Value of the <return>actor</return> attribute of the SOAP header  element.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::SoapVar
   * SoapParam::SoapParam
   * SoapServer::addSoapHeader


id: SoapHeader::__construct
type: function
doc:
<comment>Description:</comment>
  SoapHeader constructor
  
  Această funcție este pseudonim pentru:  SoapHeader::SoapHeader


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

<comment>Param:</comment>
  <info>mixed </info>  <strong>$data</strong>  The data to pass or return. This parameter can be passed directly as PHP value, but
                 in this case it will be named as <return>paramN</return> and the SOAP service may not understand it.
  <info>string</info>  <strong>$name</strong>  The parameter name.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::SoapVar


id: SoapParam::__construct
type: function
doc:
<comment>Description:</comment>
  SoapParam constructor
  
  Această funcție este pseudonim pentru:  SoapParam::SoapParam


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  The SoapServer class provides a server for the SOAP 1.1 and SOAP 1.2 protocols. It can be used
  with or without a WSDL service description.


id: SoapServer::SoapServer
type: function
doc:
<comment>Description:</comment>
  SoapServer constructor
  
  This constructor allows the creation of <class>SoapServer</class> objects in WSDL or non-WSDL mode.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$wsdl   </strong>  To use the SoapServer in WSDL mode, pass the URI of a WSDL file. Otherwise, pass
                   <info>null</info> and set the <return>uri</return> option to the target namespace for the server.
  <info>array</info>  <strong>$options</strong>  Allow setting a default SOAP version (<return>soap_version</return>), internal character encoding
                   (<return>encoding</return>), and actor URI (<return>actor</return>).
                   
                   The <return>classmap</return> option can be used to map some WSDL  types to PHP classes. This
                   option must be an array with WSDL types  as keys and names of PHP classes as
                   values.
                   
                   The <return>typemap</return> option is an array of type mappings. Type mapping is an array with
                   keys <return>type_name</return>, <return>type_ns</return> (namespace URI), <return>from_xml</return> (callback accepting one string
                   parameter) and <return>to_xml</return> (callback accepting one object parameter).
                   
                   The <return>cache_wsdl</return> option is one of <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                   <info>WSDL_CACHE_MEMORY</info> or <info>WSDL_CACHE_BOTH</info>.
                   
                   There is also a <return>features</return> option which can be set to <info>SOAP_WAIT_ONE_WAY_CALLS</info>,
                   <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>, <info>SOAP_USE_XSI_ARRAY_TYPE</info>.
                   
                   The <return>send_errors</return> option can be set to <info>false</info> to sent a generic error message
                   ("Internal error") instead of the specific error message sent otherwise.

<comment>See Also:</comment>
   * SoapClient::SoapClient


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  SoapServer constructor
  
  Această funcție este pseudonim pentru:  SoapServer::SoapServer


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  Adds one or more functions to handle SOAP requests
  
  Exports one or more functions for remote clients

<comment>Param:</comment>
  <info>arraystringint</info>  <strong>$functions</strong>  To export one function, pass the function name into this parameter as
                              a string.
                              
                              To export several functions, pass an array of function names.
                              
                              To export all the functions, pass a special constant
                              <info>SOAP_FUNCTIONS_ALL</info>.
                              
                              <strong>$functions</strong> must receive all input arguments in the same order as
                              defined in the WSDL file (They should not receive any output
                              parameters as arguments) and return one or more values. To return
                              several values they must return an array with named output parameters.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapServer::SoapServer
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  Add a SOAP header to the response
  
  Adds a SOAP header to be returned with the response to the current request.

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  The header to be returned.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  Issue SoapServer fault indicating an error
  
  Sends a response to the client of the current request indicating an error.
  
  This can only be called when handling a request.

<comment>Param:</comment>
  <info>string</info>  <strong>$code   </strong>  The error code to return
  <info>string</info>  <strong>$string </strong>  A brief description of the error
  <info>string</info>  <strong>$actor  </strong>  A string identifying the actor that caused the fault.
  <info>mixed </info>  <strong>$details</strong>  More details of the fault
  <info>string</info>  <strong>$name   </strong>  The name of the fault. This can be used to select a name from a WSDL file.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapFault::SoapFault


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  Returns list of defined functions
  
  Returns a list of the defined functions in the SoapServer object. This method returns the list of
  all functions added by  SoapServer::addFunction or  SoapServer::setClass.

<comment>Return:</comment>
  <info>array</info>  An <return>array</return> of the defined functions.

<comment>See Also:</comment>
   * SoapServer::SoapServer
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  Handles a SOAP request
  
  Processes a SOAP request, calls necessary functions, and sends a response  back.

<comment>Param:</comment>
  <info>stringnull</info>  <strong>$request</strong>  The SOAP request. If this argument is omitted, the request is assumed to be
                        in the raw POST data of the HTTP request.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapServer::SoapServer


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  Sets the class which handles SOAP requests
  
  Exports all methods from specified class.
  
  The object can be made persistent across request for a given PHP session  with the
  SoapServer::setPersistence method.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  The name of the exported class.
  <info>mixed </info>  <strong>$args </strong>  These optional parameters will be passed to the default class constructor during
                  object creation.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapServer::SoapServer
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  Sets the object which will be used to handle SOAP requests
  
  This sets a specific object as the handler for SOAP requests, rather than just a class as in
  SoapServer::setClass.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  The object to handle the requests.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapServer::setPersistence
type: function
doc:
<comment>Description:</comment>
  Sets SoapServer persistence mode
  
  This function allows changing the persistence state of a SoapServer object between requests. This
  function allows saving data between requests utilizing PHP sessions.  This method only has an
  affect on a SoapServer after it has exported functions utilizing SoapServer::setClass.
  
  The persistence of <info>SOAP_PERSISTENCE_SESSION</info> makes only objects of the given class persistent, but
  not the class static data. In this  case, use $this-&gt;bar instead of self::$bar.
  
  <info>SOAP_PERSISTENCE_SESSION</info> serializes data on the class object between requests. In order to
  properly utilize resources (e.g. <class>PDO</class>), __wakeup() and __sleep() magic methods should be utilized.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  One of the <return>SOAP_PERSISTENCE_XXX</return> constants.
              
              <info>SOAP_PERSISTENCE_REQUEST</info> - SoapServer data does not persist between requests. This is
              the default behavior of any SoapServer object after setClass is called.
              
              <info>SOAP_PERSISTENCE_SESSION</info> - SoapServer data persists between requests. This is
              accomplished by serializing the SoapServer class data into
              $_SESSION['_bogus_session_name'], because of this  <strong>session_start()</strong> must be called
              before this persistence mode is set.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SoapServer::setClass


id: SoapVar
type: class
doc:
<comment>Description:</comment>
  A class representing a variable or object for use with SOAP services.


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

<comment>Param:</comment>
  <info>mixed </info>  <strong>$data          </strong>  The data to pass or return.
  <info>string</info>  <strong>$encoding      </strong>  The encoding ID, one of the <return>XSD_...</return> constants.
  <info>string</info>  <strong>$type_name     </strong>  The type name.
  <info>string</info>  <strong>$type_namespace</strong>  The type namespace.
  <info>string</info>  <strong>$node_name     </strong>  The XML node name.
  <info>string</info>  <strong>$node_namespace</strong>  The XML node namespace.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::SoapParam


id: SoapVar::__construct
type: function
doc:
<comment>Description:</comment>
  SoapVar constructor
  
  Această funcție este pseudonim pentru:  SoapVar::SoapVar


id: Socket
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>Socket</return> resources as of PHP 8.0.0.


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Used to send requests to a Solr server. Currently, cloning and serialization of SolrClient
  instances is not supported.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the system servlet used to obtain Solr Server information


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  This is the initial value for the terms servlet used for the TermsComponent


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor for the SolrClient object
  
  Constructor for the SolrClient object

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  This is an array containing one of the following keys :
                         
                         

<comment>See Also:</comment>
   * SolrClient::getOptions


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor for SolrClient
  
  Destructor

<comment>Return:</comment>
  <info>void</info>  Destructor for SolrClient

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


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Adds a document to the index
  
  This method adds a document to the index.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc         </strong>  The SolrInputDocument instance.
  <info>bool             </info>  <strong>$overwrite   </strong>  Whether to overwrite existing document or not. If <info>false</info> there
                                    will be duplicates (several documents with the same ID).
                                    
                                    PECL Solr
                                    \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                                    
                                    $allowDups = false is the same as $overwrite = true
  <info>int              </info>  <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this
                                    document. Available since Solr 1.4 . Default (0) means disabled.
                                    
                                    When this value specified, it leaves the control of when to do
                                    the commit to Solr itself, optimizing number of commits to a
                                    minimum while still fulfilling the update latency requirements,
                                    and Solr will automatically do a commit when the oldest add in
                                    the buffer is due.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> object or throws an Exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Adds a collection of SolrInputDocument instances to the index
  
  Adds a collection of documents to the index.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs        </strong>  An array containing the collection of SolrInputDocument instances. This
                        array must be an actual variable.
  <info>bool </info>  <strong>$overwrite   </strong>  Whether to overwrite existing documents or not. If <info>false</info> there will be
                        duplicates (several documents with the same ID).
                        
                        PECL Solr
                        \< 2.0 $allowDups was used instead of $overwrite, which does the same functionality with exact opposite bool flag.
                        
                        $allowDups = false is the same as $overwrite = true
  <info>int  </info>  <strong>$commitWithin</strong>  Number of milliseconds within which to auto commit this document. Available
                        since Solr 1.4 . Default (0) means disabled.
                        
                        When this value specified, it leaves the control of when to do the commit to
                        Solr itself, optimizing number of commits to a minimum while still
                        fulfilling the update latency requirements, and Solr will automatically do a
                        commit when the oldest add in the buffer is due.

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrUpdateResponse</info> object or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Finalizes all add/deletes made to the index
  
  This method finalizes all add/deletes made to the index.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit    </strong>  This will refresh the 'view' of the index in a more performant manner, but
                         without "on-disk" guarantees. (Solr4.0+)
                         
                         A soft commit is much faster since it only makes index changes visible and
                         does not fsync index files or write a new index descriptor.  If the JVM
                         crashes or there is a loss of power, changes that occurred after the last
                         hard commit will be lost.  Search collections that have near-real-time
                         requirements (that want index changes to be quickly visible to searches)
                         will want to soft commit often but hard commit less frequently.
  <info>bool</info>  <strong>$waitSearcher  </strong>  block until a new searcher is opened and registered as the main query
                         searcher, making the changes visible.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Merge segments with deletes away. (Solr1.4+)

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <class>SolrUpdateResponse</class> object on success or throws an exception on
                      failure.

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Delete by Id
  
  Deletes the document with the specified ID. Where ID is the value of the uniqueKey field declared
  in the schema

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The value of the uniqueKey field declared in the schema

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Deletes by Ids
  
  Deletes a collection of documents with the specified set of ids.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  An array of IDs representing the uniqueKey field declared in the schema for each
               document to be deleted. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Removes all documents matching any of the queries
  
  Removes all documents matching any of the queries

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  The array of queries. This must be an actual php variable.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success and throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


id: SolrClient::deleteByQuery
type: function
doc:
<comment>Description:</comment>
  Deletes all documents matching the given query
  
  Deletes all documents matching the given query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The query

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success and throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Get Document By Id. Utilizes Solr Realtime Get (RTG)
  
  Get Document By Id. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Document ID

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getByIds


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
  
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Document ids

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

<comment>See Also:</comment>
   * SolrClient::getById


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Returns the debug data for the last connection attempt
  
  Returns the debug data for the last connection attempt

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and null if there is nothing to return.


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Returns the client options set internally
  
  Returns the client options set internally. Very useful for debugging. The values returned are
  readonly and can only be set when the object is instantiated.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing all the options for the SolrClient object set internally.

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


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Defragments the index
  
  Defragments the index for faster search performance.

<comment>Param:</comment>
  <info>int </info>  <strong>$maxSegments </strong>  Optimizes down to at most this number of segments. Since Solr 1.3
  <info>bool</info>  <strong>$softCommit  </strong>  This will refresh the 'view' of the index in a more performant manner, but
                       without "on-disk" guarantees. (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  Block until a new searcher is opened and registered as the main query
                       searcher, making the changes visible.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws an exception on failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Checks if Solr server is still up
  
  Checks if the Solr server is still alive. Sends a HEAD request to the Apache Solr server.

<comment>Return:</comment>
  <info>SolrPingResponse</info>  Returns a <info>SolrPingResponse</info> object on success and throws an exception on failure.


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Sends a query to the server
  
  Sends a query to the server.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  A <info>SolrParams</info> object. It is recommended to use <info>SolrQuery</info> for advanced queries.

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  Returns a <info>SolrQueryResponse</info> object on success and throws an exception on
                     failure.


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Sends a raw update request
  
  Sends a raw XML update request to the server

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  An XML string with the raw request to the server.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a <info>SolrUpdateResponse</info> on success. Throws an exception on failure.


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Rollbacks all add/deletes made to the index since the last commit
  
  Rollbacks all add/deletes made to the index since the last commit. It neither calls any event
  listeners nor creates a new searcher.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Returns a SolrUpdateResponse on success or throws a SolrClientException on
                      failure.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Sets the response writer used to prepare the response from Solr
  
  Sets the response writer used to prepare the response from Solr

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  One of the following:

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Changes the specified servlet type to a new value
  
  Changes the specified servlet type to a new value

<comment>Param:</comment>
  <info>int   </info>  <strong>$type </strong>  One of the following :
                  
                  
  <info>string</info>  <strong>$value</strong>  The new value for the servlet

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Retrieve Solr Server information
  
  Retrieve Solr Server information

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrGenericResponse</info> object on success.


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  Checks the threads status
  
  Checks the threads status

<comment>Return:</comment>
  <info>void</info>  Returns a SolrGenericResponse object.


id: SolrClientException
type: class
doc:
<comment>Description:</comment>
  An exception thrown when there is an error while making a request to the server from the client.


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Collapse Function constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The field name to collapse on.
                  
                  In order to collapse a result. The field type must be a single valued String, Int
                  or Float.

<comment>See Also:</comment>
   * SolrQuery::collapse


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns a string representing the constructed collapse function
  
  Returns a string representing the constructed collapse function

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Returns the field that is being collapsed on
  
  Returns the field that is being collapsed on.

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setField


id: SolrCollapseFunction::getHint
type: function
doc:
<comment>Description:</comment>
  Returns collapse hint
  
  Returns collapse hint

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setHint


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Returns max parameter
  
  Returns max parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMax


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Returns min parameter
  
  Returns min parameter

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setMin


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Returns null policy
  
  Returns null policy used or null

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setNullPolicy


id: SolrCollapseFunction::getSize
type: function
doc:
<comment>Description:</comment>
  Returns size parameter
  
  Gets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>See Also:</comment>
   * SolrCollapseFunction::setSize


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Sets the field to collapse on
  
  The field name to collapse on.  In order to collapse a result. The field type must be a single
  valued String, Int or Float.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Sets collapse hint
  
  Sets collapse hint

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  Currently there is only one hint available "top_fc", which stands for top level
                 FieldCache

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Selects the group heads by the max value of a numeric field or function query
  
  Selects the group heads by the max value of a numeric field or function query.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Sets the NULL Policy
  
  Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. Accepts
  ignore, expand, or collapse policies.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by count (Duplicated for easier migration)


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by index (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in acending order (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in descending order (Duplicated for easier migration)


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Class Constructor
  
  Class constructor initializes the object and sets the q parameter if passed

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Search Query (q parameter)

<comment>See Also:</comment>
   * 


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Bigram Field (pf2 parameter)
  
  Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is
  optional

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop </strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Adds a boost query field with value and optional boost (bq parameter)
  
  Adds a Boost Query field with value [and boost] (bq parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Field (pf parameter)
  
  Adds a Phrase Field (pf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop </strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Add a query field with optional boost (qf parameter)
  
  Add a query field with optional boost (qf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  Boost value. Boosts documents with matching terms.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeQueryField


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Trigram Phrase Field (pf3 parameter)
  
  Adds a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name
  <info>string</info>  <strong>$boost</strong>  Field Boost
  <info>string</info>  <strong>$slop </strong>  Field Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Adds a field to User Fields Parameter (uf)
  
  Adds a field to The User Fields Parameter (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes phrase bigram field (pf2 parameter)
  
  Removes a Bigram Phrase Field (pf2 parameter) that was previously added using
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Removes a boost query partial by field name (bq)
  
  Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was
  used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Phrase Field (pf parameter)
  
  Removes a Phrase Field (pf parameter) that was previously added using
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Removes a Query Field (qf parameter)
  
  Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField
  
  qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search
  in, and boosts for those fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addQueryField


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Trigram Phrase Field (pf3 parameter)
  
  Removes a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::removeUserField
type: function
doc:
<comment>Description:</comment>
  Removes a field from The User Fields Parameter (uf)
  
  Removes a field from The User Fields Parameter (uf)
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets Bigram Phrase Fields (pf2) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields boosts (slops)

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Slop (ps2 parameter)
  
  Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * 


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Sets a Boost Function (bf parameter)
  
  Sets Boost Function (bf parameter).
  
  Functions (with optional boosts) that will be included in the user's query to influence the score.
  Any function supported natively by Solr can be used, along with a boost value. e.g.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * 


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Directly Sets Boost Query Parameter (bq)
  
  Sets Boost Query Parameter (bq)

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  query

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Set Minimum "Should" Match (mm)
  
  Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if
  the default query operator (q.op) is OR, then mm=0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Minimum match value/expression

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets  Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets  Phrase Fields (pf) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields, boosts [, slops]

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets the default slop on phrase queries (ps parameter)
  
  Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields
  (affects boosting). "ps" parameter

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * 


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Set Query Alternate (q.alt parameter)
  
  Set Query Alternate (q.alt parameter)
  
  When the main q parameter is not specified or is blank. The q.alt parameter is used

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Query String

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Specifies the amount of slop permitted on phrase queries explicitly included in the user's query
  string (qf parameter)
  
  The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the
  user's query string with the qf parameter.
  
  slop refers to the number of positions one token needs to be moved in relation to another token in
  order to match a phrase specified in a query.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Amount of slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Sets Tie Breaker parameter (tie parameter)
  
  Sets Tie Breaker parameter (tie parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  The tie parameter specifies a float value (which should be something much
                       less than 1) to use as tiebreaker in DisMax queries.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Directly Sets Trigram Phrase Fields (pf3 parameter)
  
  Directly Sets Trigram Phrase Fields (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Trigram Phrase Fields

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Trigram Phrase Slop (ps3 parameter)
  
  Sets Trigram Phrase Slop (ps3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Phrase slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Sets User Fields parameter (uf)
  
  Sets User Fields parameter (uf)
  
  User Fields: Specifies which schema fields the end user shall be allowed to query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields names separated by space
                   
                   This parameter supports wildcards.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be DisMax Query Parser
  
  Switch QueryParser to be DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::useDisMaxQueryParser


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be EDisMax
  
  Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched
  using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * 


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument object
  
  Creates a copy of a SolrDocument object. Not to be called directly.

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


id: SolrDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor for SolrDocument.

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


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  Access the field as a property
  
  Magic method for accessing the field as a property.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField instance.


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Adds another field to the document
  
  Adds another field to the document. Used to set the fields as new properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName </strong>  Name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  Field value.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::__unset
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document when the field is access as an object property.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  This method adds a field to the SolrDocument instance.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName </strong>  The name of the field
  <info>string</info>  <strong>$fieldValue</strong>  The value of the field.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::clear
type: function
doc:
<comment>Description:</comment>
  Drops all the fields in the document
  
  Resets the current object. Discards all the fields and resets the document boost to zero.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  Retrieves the current field
  
  Retrieves the current field

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns the field


id: SolrDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists in the document
  
  Checks if the requested field as a valid fieldname in the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field is present and <info>false</info> if it does not.


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrDocument)
  
  Returns an array of child documents (SolrDocument)

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field by name.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField on success and <info>false</info> on failure.


id: SolrDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in this document
  
  Returns the number of fields in this document. Multi-value fields are only counted once.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>false</info> on failure.


id: SolrDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields names in the document
  
  Returns an array of fields names in the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the names of the fields in this document.


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Returns a SolrInputDocument equivalent of the object
  
  Returns a SolrInputDocument equivalent of the object. This is useful if one wishes to
  resubmit/update a document retrieved from a query.

<comment>Return:</comment>
  <info>SolrInputDocument</info>  Returns a SolrInputDocument on success and <info>null</info> on failure.


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Checks whether the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  Retrieves the current key
  
  Retrieves the current key.

<comment>Return:</comment>
  <info>string</info>  Returns the current key.


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges source to the current SolrDocument
  
  Merges source to the current SolrDocument.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool        </info>  <strong>$overwrite</strong>  If this is <info>true</info> then fields with the same name in the destination
                            document will be overwritten.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::next
type: function
doc:
<comment>Description:</comment>
  Moves the internal pointer to the next field
  
  Moves the internal pointer to the next field.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if a particular field exists
  
  Checks if a particular field exists. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retrieves a field
  
  This is used to retrieve the field when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object.


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  Used when the object is treated as an array to add a field to the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName </strong>  The name of the field.
  <info>string</info>  <strong>$fieldValue</strong>  The value for this field.

<comment>Return:</comment>
  <info>void</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Removes a field
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>void</info>  No return value.


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  This is an alias to SolrDocument::clear()
  
  This is an alias to SolrDocument::clear()

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  Resets the internal pointer to the beginning
  
  Resets the internal pointer to the beginning.

<comment>Return:</comment>
  <info>void</info>  This method has no return value.


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization.

<comment>Return:</comment>
  <info>string</info>  Returns a string representing the serialized Solr document.


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields in the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy  </strong>  The sort criteria.
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the document
  
  Returns an array representation of the document.

<comment>Return:</comment>
  <info>array</info>  Returns an array representation of the document.


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Custom serialization of SolrDocument objects
  
  Custom serialization of SolrDocument objects

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  An XML representation of the document.

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


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current position internally is still valid
  
  Checks if the current position internally is still valid. It is used during foreach operations.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success and <info>false</info> if the current position is no longer valid.


id: SolrDocumentField
type: class
doc:
<comment>Description:</comment>
  This represents a field in a Solr document. All its properties are read-only.


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

<comment>Return:</comment>
  <info>unknown</info>  None.


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

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


id: SolrException
type: class
doc:
<comment>Description:</comment>
  This is the base class for all exception thrown by the Solr extension classes.


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

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrGenericResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor.

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


id: SolrIllegalArgumentException
type: class
doc:
<comment>Description:</comment>
  This object is thrown when an illegal or invalid argument is passed to a method.


id: SolrIllegalArgumentException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Returns internal information where the Exception was thrown
  
  Returns internal information where the Exception was thrown.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing internal information where the error was thrown. Used only for
         debugging by extension developers.


id: SolrIllegalOperationException
type: class
doc:
<comment>Description:</comment>
  This object is thrown when an illegal or unsupported operation is performed on an object.


id: SolrInputDocument
type: class
doc:
<comment>Description:</comment>
  This class represents a Solr document that is about to be submitted to the Solr index.


id: SolrInputDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Creates a copy of a SolrDocument
  
  Should not be called directly. It is used to create a deep copy of a SolrInputDocument.

<comment>Return:</comment>
  <info>void</info>  Creates a new SolrInputDocument instance.


id: SolrInputDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

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


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Adds a child document for block indexing
  
  Adds a child document to construct a document block with nested documents.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  A <info>SolrInputDocument</info> object.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Adds an array of child documents
  
  Adds an array of child documents to the current input document.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  An <info>array</info> of <info>SolrInputDocument</info> objects.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  Adds a field to the document
  
  For multi-value fields, if a valid boost value is specified, the specified value will be
  multiplied by the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName      </strong>  The name of the field
  <info>string</info>  <strong>$fieldValue     </strong>  The value for the field.
  <info>float </info>  <strong>$fieldBoostValue</strong>  The index time boost for the field. Though this cannot be negative, you
                            can still pass values less than 1.0 but they must be greater than zero.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::clear
type: function
doc:
<comment>Description:</comment>
  Resets the input document
  
  Resets the document by dropping all the fields and resets the document boost to zero.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the document
  
  Removes a field from the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Checks if a field exists
  
  Checks if a field exists

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Name of the field.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the field was found and <info>false</info> if it was not found.


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the current boost value for the document
  
  Retrieves the current boost value for the document.

<comment>Return:</comment>
  <info>float</info>  Returns the boost value on success and <info>false</info> on failure.


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrInputDocument)
  
  Returns an array of child documents (SolrInputDocument)

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  Retrieves a field by name
  
  Retrieves a field in the document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Returns a SolrDocumentField object on success and <info>false</info> on failure.


id: SolrInputDocument::getFieldBoost
type: function
doc:
<comment>Description:</comment>
  Retrieves the boost value for a particular field
  
  Retrieves the boost value for a particular field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  The name of the field.

<comment>Return:</comment>
  <info>float</info>  Returns the boost value for the field or <info>false</info> if there was an error.


id: SolrInputDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of fields in the document
  
  Returns the number of fields in the document.

<comment>Return:</comment>
  <info>intfalse</info>  Returns an integer on success sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Returns an array containing all the fields in the document
  
  Returns an array containing all the fields in the document.

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


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns true if the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Merges one input document into another
  
  Merges one input document into another.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  The source document.
  <info>bool             </info>  <strong>$overwrite</strong>  If this is <info>true</info> it will replace matching fields in the destination
                                 document.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului. In the future, this will be modified to return the
        number of fields in the new document.


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  This is an alias of SolrInputDocument::clear
  
  This is an alias of SolrInputDocument::clear

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::setBoost
type: function
doc:
<comment>Description:</comment>
  Sets the boost value for this document
  
  Sets the boost value for this document.

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  The index-time boost value for this document.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  Sets the index-time boost value for a field
  
  Sets the index-time boost value for a field. This replaces the current boost value for this field.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName      </strong>  The name of the field.
  <info>float </info>  <strong>$fieldBoostValue</strong>  The index time boost value.

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


id: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the fields within the document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy  </strong>  The sort criteria
  <info>int</info>  <strong>$sortDirection</strong>  The sort direction

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array representation of the input document
  
  Returns an array representation of the input document.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the fields. It returns <info>false</info> on failure.


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Represents a collection of name-value pairs sent to the Solr server during a request.


id: SolrModifiableParams::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  Destructor

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


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  This is an object whose properties can also by accessed using the array syntax. All its properties
  are read-only.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Creates Solr object
  
  Creates Solr object.

<comment>Return:</comment>
  <info>unknown</info>  None

<comment>See Also:</comment>
   * Classname::Method


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  The destructor

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


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Returns an array of all the names of the properties
  
  Returns an array of all the names of the properties

<comment>Return:</comment>
  <info>array</info>  Returns an array.


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Checks if the property exists
  
  Checks if the property exists. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  The name of the property.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Used to retrieve a property
  
  Used to get the value of a property. This is used when the object is treated as an array.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Name of the property.

<comment>Return:</comment>
  <info>mixed</info>  Returns the property value.


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value for a property
  
  Sets the value for a property. This is used when the object is treated as an array. This object is
  read-only. This should never be attempted.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name </strong>  The name of the property.
  <info>string</info>  <strong>$property_value</strong>  The new value.

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


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value for the property
  
  Unsets the value for the property. This is used when the object is treated as an array. This
  object is read-only. This should never be attempted.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  The name of the property.

<comment>Return:</comment>
  <info>void</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * Classname::Method


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  This is an alias for SolrParams::addParam
  
  This is an alias for SolrParams::addParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  The name of the parameter
  <info>string</info>  <strong>$value</strong>  The value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParams instance on success


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Adds a parameter to the object
  
  Adds a parameter to the object. This is used for parameters that can be specified multiple times.

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of parameter
  <info>string</info>  <strong>$value</strong>  Value of parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on failure.


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  This is an alias for SolrParams::getParam
  
  This is an alias for SolrParams::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Then name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns an array or string depending on the type of parameter


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Returns a parameter value
  
  Returns a parameter with name param_name

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  The name of the parameter

<comment>Return:</comment>
  <info>mixed</info>  Returns a string or an array depending on the type of the parameter


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of non URL-encoded parameters
  
  Returns an array of non URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array of non URL-encoded parameters


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Returns an array of URL-encoded parameters
  
  Returns an array on URL-encoded parameters

<comment>Return:</comment>
  <info>array</info>  Returns an array on URL-encoded parameters


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Return:</comment>
  <info>string</info>  Used for custom serialization


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  An alias of SolrParams::setParam
  
  An alias of SolrParams::setParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Then name of the parameter
  <info>string</info>  <strong>$value</strong>  The parameter value

<comment>Return:</comment>
  <info>void</info>  Returns an instance of the SolrParams object on success


id: SolrParams::setParam
type: function
doc:
<comment>Description:</comment>
  Sets the parameter to the specified value
  
  Sets the query parameter to the specified value. This is used for parameters that can only be
  specified once. Subsequent calls with the same parameter name will override the existing value

<comment>Param:</comment>
  <info>string</info>  <strong>$name </strong>  Name of the parameter
  <info>string</info>  <strong>$value</strong>  Value of the parameter

<comment>Return:</comment>
  <info>SolrParams</info>  Returns a SolrParam object on success and <info>false</info> on value.


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Returns all the name-value pair parameters in the object
  
  Returns all the name-value pair parameters in the object

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Whether to return URL-encoded values

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>false</info> on failure.


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Used for custom serialization
  
  Used for custom serialization

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  The serialized representation of the object

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


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns the response from the server
  
  Returns the response from the server. This should be empty because the request as a HEAD request.

<comment>Return:</comment>
  <info>string</info>  Returns an empty string.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Optional search query

<comment>Return:</comment>
  <info>unknown</info>  None


id: SolrQuery::addExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Overrides main filter query, determines which documents to include in the main group
  
  Overrides main filter query, determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Orders the documents within the expanded groups (expand.sort parameter)
  
  Orders the documents within the expanded groups (expand.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
                  
                  Default: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date
  
  This method allows you to specify a field which should be treated as a facet.
  
  It can be used multiple times with different field names to indicate multiple facet fields

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  The name of the date field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns a SolrQuery object.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Adds another facet.date.other parameter
  
  Sets the facet.date.other parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$value         </strong>  The value to use.
  <info>string</info>  <strong>$field_override</strong>  The field name for the override.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Adds another field to the facet
  
  Adds another field to the facet

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Adds a facet query
  
  Adds a facet query

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  The facet query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Specifies which fields to return in the result
  
  This method is used to used to specify a set of fields to return, thereby restricting the amount
  of data returned in the response.
  
  It should be called multiple time, once for each field name.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Specifies a filter query
  
  Specifies a filter query

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query

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


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Add a field to be used to group results
  
  The name of the field by which to group results. The field must be single-valued, and either be
  indexed or a field type that has a value source and works in a function query, such as
  ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses
  group.field parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Allows grouping results based on the unique values of a function query (group.func parameter)
  
  Adds a group function (group.func parameter) Allows grouping results based on the unique values of
  a function query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Allows grouping of documents that match the given query
  
  Allows grouping of documents that match the given query. Adds query to the group.query parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Add a group sort field (group.sort parameter)
  
  Allow sorting group documents, using group sort field (group.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field name
  <info>int   </info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Maps to hl.fl
  
  Maps to hl.fl. This is used to specify that highlighted snippets should be generated for a
  particular field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Sets a field to use for similarity
  
  Maps to mlt.fl. It specifies that a field should be used for similarity.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Maps to mlt.qf
  
  Maps to mlt.qf. It is used to specify query fields and their boosts

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>float </info>  <strong>$boost</strong>  Its boost value

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Used to control how the results should be sorted
  
  Used to control how the results should be sorted.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field
  <info>int   </info>  <strong>$order</strong>  The sort direction. This should be either SolrQuery::ORDER_ASC or
                  SolrQuery::ORDER_DESC.

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


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Requests a return of sub results for values within the given facet 
  
  Requests a return of sub results for values within the given facet. Maps to the stats.facet field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Maps to stats.field parameter
  
  Maps to stats.field parameter This methods adds another stats.field parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::collapse
type: function
doc:
<comment>Description:</comment>
  Collapses the result set to a single document per group
  
  Collapses the result set to a single document per group before it forwards the result set to the
  rest of the search components.
  
  So all downstream components (faceting, highlighting, etc...) will work with the collapsed result
  set.

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current <info>SolrQuery</info> object


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Returns true if group expanding is enabled
  
  Returns <info>true</info> if group expanding is enabled

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


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns the expand filter queries
  
  Returns the expand filter queries

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


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Returns the expand query expand.q parameter
  
  Returns the expand query expand.q parameter

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


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Returns The number of rows to display in each group (expand.rows)
  
  Returns The number of rows to display in each group (expand.rows)

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


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields
  
  Returns an array of fields

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


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet parameter
  
  Returns the value of the facet parameter.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.end parameter
  
  Returns the value for the facet.date.end parameter. This method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet.date fields
  
  Returns all the facet.date fields

<comment>Return:</comment>
  <info>array</info>  Returns all the facet.date fields as an array or <info>null</info> if none was set


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.gap parameter
  
  Returns the value of the facet.date.gap parameter. It accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.date.hardend parameter
  
  Returns the value of the facet.date.hardend parameter. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Returns the value for the facet.date.other parameter
  
  Returns the value for the facet.date.other parameter. This method accepts an optional field
  override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> on success and <info>null</info> if not set.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Returns the  lower bound for the first date range for all date faceting on this field
  
  Returns the  lower bound for the first date range for all date faceting on this field. Accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Returns all the facet fields
  
  Returns all the facet fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of all the fields and <info>null</info> if none was set


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of constraint counts that should be returned for the facet fields
  
  Returns the maximum number of constraint counts that should be returned for the facet fields. This
  method accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Returns the value of the facet.method parameter
  
  Returns the value of the facet.method parameter. This accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum counts for facet fields should be included in the response
  
  Returns the minimum counts for facet fields should be included in the response. It accepts an
  optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Returns the current state of the facet.missing parameter
  
  Returns the current state of the facet.missing parameter. This accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Returns an offset into the list of constraints to be used for pagination
  
  Returns an offset into the list of constraints to be used for pagination. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field to override for.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the facet prefix
  
  Returns the facet prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the facet queries
  
  Returns all the facet queries

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Returns the facet sort type
  
  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer (SolrQuery::FACET_SORT_INDEX or SolrQuery::FACET_SORT_COUNT) on success or
       <info>null</info> if not set.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Returns the list of fields that will be returned in the response
  
  Returns the list of fields that will be returned in the response

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns an array of filter queries
  
  Returns an array of filter queries. These are queries that can be used to restrict the super set
  of documents that can be returned, without influencing score

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Returns true if grouping is enabled
  
  Returns true if grouping is enabled

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

<comment>See Also:</comment>
   * SolrQuery::setGroup


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Returns group cache percent value
  
  Returns group cache percent value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupCachePercent


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Returns the group.facet parameter value
  
  Returns the group.facet parameter value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupFacet


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Returns group fields (group.field parameter values)
  
  Returns group fields (group.field parameter values)

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

<comment>See Also:</comment>
   * SolrQuery::addGroupField


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Returns the group.format value
  
  Returns the group.format value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupFormat


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Returns group functions (group.func parameter values)
  
  Returns group functions (group.func parameter values)

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

<comment>See Also:</comment>
   * SolrQuery::addGroupFunction


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Returns the group.limit value
  
  Returns the group.limit value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupLimit


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Returns the group.main value
  
  Returns the group.main value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupMain


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Returns the group.ngroups value
  
  Returns the group.ngroups value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupNGroups


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Returns the group.offset value
  
  Returns the group.offset value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupOffset


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the group.query parameter values
  
  Returns all the group.query parameter values

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

<comment>See Also:</comment>
   * SolrQuery::addGroupQuery


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Returns the group.sort value
  
  Returns the group.sort value

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

<comment>See Also:</comment>
   * SolrQuery::addGroupSortField


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Returns the group.truncate value
  
  Returns the group.truncate value

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

<comment>See Also:</comment>
   * SolrQuery::setGroupTruncate


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl parameter
  
  Returns a boolean indicating whether or not to enable highlighted snippets to be generated in the
  query response.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Returns the highlight field to use as backup or default
  
  Returns the highlight field to use as backup or default. It accepts an optional override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields that Solr should generate highlighted snippets for
  
  Returns all the fields that Solr should generate highlighted snippets for

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Returns the formatter for the highlighted output
  
  Returns the formatter for the highlighted output

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Returns the text snippet generator for highlighted text
  
  Returns the text snippet generator for highlighted text. Accepts an optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Returns the number of characters of fragments to consider for highlighting
  
  Returns the number of characters of fragments to consider for highlighting. Zero implies no
  fragmenting. The entire field should be used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success or <info>null</info> if not set.


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries
  
  Returns whether or not to enable highlighting for range/wildcard/fuzzy/prefix queries

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters of the field to return
  
  Returns the maximum number of characters of the field to return

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters into a document to look for suitable snippets
  
  Returns the maximum number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the collapse contiguous fragments into a single fragment
  
  Returns whether or not the collapse contiguous fragments into a single fragment. Accepts an
  optional field override.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of characters from a field when using the regex fragmenter
  
  Returns the maximum number of characters from a field when using the regex fragmenter

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Returns the regular expression for fragmenting
  
  Returns the regular expression used for fragmenting

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Returns the deviation factor from the ideal fragment size
  
  Returns the factor by which the regex fragmenter can deviate from the ideal fragment size to
  accomodate the regular expression

<comment>Return:</comment>
  <info>float</info>  Returns a double on success and <info>null</info> if not set.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Returns if a field will only be highlighted if the query matched in this particular field
  
  Returns if a field will only be highlighted if the query matched in this particular field.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears after a highlighted term
  
  Returns the text which appears after a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Returns the text which appears before a highlighted term
  
  Returns the text which appears before a highlighted term. Accepts an optional field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of highlighted snippets to generate per field
  
  Returns the maximum number of highlighted snippets to generate per field. Accepts an optional
  field override

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Returns the state of the hl.usePhraseHighlighter parameter
  
  Returns whether or not to use SpanScorer to highlight phrase terms only when they appear within
  the query phrase in the document.

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Returns whether or not MoreLikeThis results should be enabled
  
  Returns whether or not MoreLikeThis results should be enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the query will be boosted by the interesting term relevance
  
  Returns whether or not the query will be boosted by the interesting term relevance

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of similar documents to return for each result
  
  Returns the number of similar documents to return for each result

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Returns all the fields to use for similarity
  
  Returns all the fields to use for similarity

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of query terms that will be included in any generated query
  
  Returns the maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support
  
  Returns the maximum number of tokens to parse in each document field that is not stored with
  TermVector support

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the maximum word length above which words will be ignored
  
  Returns the maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs
  
  Returns the treshold frequency at which words will be ignored which do not occur in at least this
  many docs

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Returns the frequency below which terms will be ignored in the source document
  
  Returns the frequency below which terms will be ignored in the source document

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Returns the minimum word length below which words will be ignored
  
  Returns the minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Returns the query fields and their boosts
  
  Returns the query fields and their boosts

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Returns the main query
  
  Returns the main search query

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of documents
  
  Returns the maximum number of documents from the complete result set to return to the client for
  every request

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Returns all the sort fields
  
  Returns all the sort fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if none of the parameters was set.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Returns the offset in the complete result set 
  
  Returns the offset in the complete result set for the queries where the set of returned documents
  should begin.

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Returns whether or not stats is enabled
  
  Returns whether or not stats is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Returns all the stats facets that were set
  
  Returns all the stats facets that were set

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Returns all the statistics fields
  
  Returns all the statistics fields

<comment>Return:</comment>
  <info>array</info>  Returns an array on success and <info>null</info> if not set.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Returns whether or not the TermsComponent is enabled
  
  Returns whether or not the TermsComponent is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Returns the field from which the terms are retrieved
  
  Returns the field from which the terms are retrieved

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the lower bound in the result set
  
  Returns whether or not to include the lower bound in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns whether or not to include the upper bound term in the result set
  
  Returns whether or not to include the upper bound term in the result set

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Returns the maximum number of terms Solr should return
  
  Returns the maximum number of terms Solr should return

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to start at
  
  Returns the term to start at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Returns the maximum document frequency
  
  Returns the maximum document frequency

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Returns the minimum document frequency to return in order to be included
  
  Returns the minimum document frequency to return in order to be included

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Returns the term prefix
  
  Returns the prefix to which matching terms must be restricted. This will restrict matches to only
  terms that start with the prefix

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Whether or not to return raw characters
  
  Returns a boolean indicating whether or not to return the raw characters of the indexed term,
  regardless of if it is human readable

<comment>Return:</comment>
  <info>bool</info>  Returns a boolean on success and <info>null</info> if not set.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Returns an integer indicating how terms are sorted
  
  SolrQuery::TERMS_SORT_INDEX indicates that the terms are returned by index order.
  SolrQuery::TERMS_SORT_COUNT implies that the terms are sorted by term frequency (highest count
  first)

<comment>Return:</comment>
  <info>int</info>  Returns an integer on success and <info>null</info> if not set.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Returns the term to stop at
  
  Returns the term to stop at

<comment>Return:</comment>
  <info>string</info>  Returns a string on success and <info>null</info> if not set.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Returns the time in milliseconds allowed for the query to finish
  
  Returns the time in milliseconds allowed for the query to finish.

<comment>Return:</comment>
  <info>int</info>  Returns and integer on success and <info>null</info> if it is not set.


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes an expand filter query
  
  Removes an expand filter query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Removes an expand sort field from the expand.sort parameter
  
  Removes an expand sort field from the expand.sort parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet date fields
  
  The name of the field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the date field to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date.other parameters
  
  Removes one of the facet.date.other parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$value         </strong>  The value
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.date parameters
  
  Removes one of the facet.date parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Removes one of the facet.query parameters
  
  Removes one of the facet.query parameters.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Removes a field from the list of fields
  
  Removes a field from the list of fields

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes a filter query
  
  Removes a filter query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  The filter query to remove

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Removes one of the fields used for highlighting
  
  Removes one of the fields used for highlighting.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis fields
  
  Removes one of the moreLikeThis fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Removes one of the moreLikeThis query fields
  
  Removes one of the moreLikeThis query fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  The query field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Removes one of the sort fields
  
  Removes one of the sort fields

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.facet parameters
  
  Removes one of the stats.facet parameters

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Removes one of the stats.field parameters
  
  Removes one of the stats.field parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Toggles the echoHandler parameter
  
  If set to true, Solr places the name of the handle used in the response to the client for
  debugging purposes.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Determines what kind of parameters to include in the response
  
  Instructs Solr what kinds of Request parameters should be included in the response for debugging
  purposes, legal values include:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type of parameters to include

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Enables/Disables the Expand Component
  
  Enables/Disables the Expand Component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  Bool flag

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Sets the expand.q parameter
  
  Sets the expand.q parameter.
  
  Overrides the main q parameter,  determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Sets the number of rows to display in each group (expand.rows). Server Default 5
  
  Sets the number of rows to display in each group (expand.rows). Server Default 5

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Sets the explainOther common query parameter
  
  Sets the explainOther common query parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The Lucene query to identify a set of documents

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Maps to the facet parameter. Enables or disables facetting
  
  Enables or disables faceting.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> enables faceting and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.end
  
  Maps to facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value         </strong>  See facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.gap
  
  Maps to facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value         </strong>  See facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.hardend
  
  Maps to facet.date.hardend

<comment>Param:</comment>
  <info>bool  </info>  <strong>$value         </strong>  See facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  The name of the field

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Maps to facet.date.start
  
  Maps to facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value         </strong>  See facet.date.start
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency used for determining term count
  
  Sets the minimum document frequency used for determining term count

<comment>Param:</comment>
  <info>      </info>  <strong>$value         </strong>  The minimum frequency
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Maps to facet.limit
  
  Maps to facet.limit. Sets the maximum number of constraint counts that should be returned for the
  facet fields.

<comment>Param:</comment>
  <info>int   </info>  <strong>$limit         </strong>  The maximum number of constraint counts
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Specifies the type of algorithm to use when faceting a field
  
  Specifies the type of algorithm to use when faceting a field. This method accepts optional field
  override.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Maps to facet.mincount
  
  Sets the minimum counts for facet fields that should be included in the response

<comment>Param:</comment>
  <info>int   </info>  <strong>$mincount      </strong>  The minimum count
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Maps to facet.missing
  
  Used to indicate that in addition to the Term-based constraints of a facet field, a count of all
  matching results which have no value for the field should be computed

<comment>Param:</comment>
  <info>bool  </info>  <strong>$flag          </strong>  <info>true</info> turns this feature on. <info>false</info> disables it.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Sets the offset into the list of constraints to allow for pagination
  
  Sets the offset into the list of constraints to allow for pagination.

<comment>Param:</comment>
  <info>int   </info>  <strong>$offset        </strong>  The offset
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Specifies a string prefix with which to limits the terms on which to facet
  
  Specifies a string prefix with which to limits the terms on which to facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix        </strong>  The prefix string
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Determines the ordering of the facet field constraints
  
  Determines the ordering of the facet field constraints

<comment>Param:</comment>
  <info>int   </info>  <strong>$facetSort     </strong>  Use SolrQuery::FACET_SORT_INDEX for sorting by index order or
                           SolrQuery::FACET_SORT_COUNT for sorting by count.
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Enable/Disable result grouping (group parameter)
  
  Enable/Disable result grouping (group parameter)

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Enables caching for result grouping
  
  Setting this parameter to a number greater than 0 enables caching for result grouping. Result
  Grouping executes two searches; this option caches the second search. The server default value is
  0.  Testing has shown that group caching only improves search time with Boolean, wildcard, and
  fuzzy queries. For simple queries like term or "match all" queries, group caching degrades
  performance. group.cache.percent parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Sets group.facet parameter
  
  Determines whether to compute grouped facets for the field facets specified in facet.field
  parameters. Grouped facets are computed based on the first specified group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Sets the group format, result structure (group.format parameter)
  
  Sets the group.format parameter. If this parameter is set to simple, the grouped documents are
  presented in a single flat list, and the start and rows parameters affect the numbers of documents
  instead of groups. Accepts: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the number of results to return for each group. The server default value is 1
  
  Specifies the number of results to return for each group. The server default value is 1.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple
  
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  If true, Solr includes the number of groups that have matched the query in the results
  
  If true, Solr includes the number of groups that have matched the query in the results.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Sets the group.offset parameter
  
  Sets the group.offset parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  If true, facet counts are based on the most relevant document of each group matching the query
  
  If true, facet counts are based on the most relevant document of each group matching the query.
  The server default value is false. group.truncate parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Enables or disables highlighting
  
  Setting it to <info>true</info> enables highlighted snippets to be generated in the query response.
  
  Setting it to <info>false</info> disables highlighting

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Enable or disable highlighting

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Specifies the backup field to use
  
  If a snippet cannot be generated because there were no matching terms, one can specify a field to
  use as the backup or default summary

<comment>Param:</comment>
  <info>string</info>  <strong>$field         </strong>  The name of the backup field
  <info>string</info>  <strong>$field_override</strong>  The name of the field we are overriding this setting for.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Specify a formatter for the highlight output
  
  Specify a formatter for the highlight output.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter     </strong>  Currently the only legal value is "simple"
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Sets a text snippet generator for highlighted text
  
  Specify a text snippet generator for highlighted text.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter    </strong>  The standard fragmenter is gap. Another option is regex, which tries to
                           create fragments that resembles a certain regular expression
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  The size of fragments to consider for highlighting
  
  Sets the size, in characters, of fragments to consider for highlighting. "0" indicates that the
  whole field value should be used (no fragmenting).

<comment>Param:</comment>
  <info>int   </info>  <strong>$size          </strong>  The size, in characters, of fragments to consider for highlighting
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Use SpanScorer to highlight phrase terms
  
  Use SpanScorer to highlight phrase terms only when they appear within the query phrase in the
  document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear
               within the query phrase in the document.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of characters of the field to return
  
  If SolrQuery::setHighlightAlternateField() was passed the value <info>true</info>, this parameter specifies the
  maximum number of characters of the field to return
  
  Any value less than or equal to 0 means unlimited.

<comment>Param:</comment>
  <info>int   </info>  <strong>$fieldLength   </strong>  The length of the field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specifies the number of characters into a document to look for suitable snippets
  
  Specifies the number of characters into a document to look for suitable snippets

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The number of characters into a document to look for suitable snippets

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Whether or not to collapse contiguous fragments into a single fragment
  
  Whether or not to collapse contiguous fragments into a single fragment

<comment>Param:</comment>
  <info>      </info>  <strong>$value         </strong>  Whether or not to collapse contiguous fragments into a single fragment
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Specify the maximum number of characters to analyze
  
  Specify the maximum number of characters to analyze from a field when using the regex fragmenter

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  The maximum number of characters to analyze from a field when using the
                          regex fragmenter

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Specify the regular expression for fragmenting
  
  Specifies the regular expression for fragmenting. This could be used to extract sentences

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The regular expression for fragmenting. This could be used to extract sentences

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Sets the factor by which the regex fragmenter can stray from the ideal fragment size
  
  The factor by which the regex fragmenter can stray from the ideal fragment size ( specfied by
  SolrQuery::setHighlightFragsize )to accommodate the regular expression

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  The factor by which the regex fragmenter can stray from the ideal fragment size

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Require field matching during highlighting
  
  If <info>true</info>, then a field will only be highlighted if the query matched in this particular field.
  
  This will only work if SolrQuery::setHighlightUsePhraseHighlighter() was set to <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears after a highlighted term
  
  Sets the text which appears before a highlighted term

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost    </strong>  Sets the text which appears after a highlighted term
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Sets the text which appears before a highlighted term
  
  Sets the text which appears before a highlighted term
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre     </strong>  The text which appears before a highlighted term
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of highlighted snippets to generate per field
  
  Sets the maximum number of highlighted snippets to generate per field

<comment>Param:</comment>
  <info>int   </info>  <strong>$value         </strong>  The maximum number of highlighted snippets to generate per field
  <info>string</info>  <strong>$field_override</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Whether to highlight phrase terms only when they appear within the query phrase
  
  Sets whether or not to use SpanScorer to highlight phrase terms only when they appear within the
  query phrase in the document

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Whether or not to use SpanScorer to highlight phrase terms only when they appear within
            the query phrase in the document

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Enables or disables moreLikeThis
  
  Enables or disables moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it and <info>false</info> turns it off.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Set if the query will be boosted by the interesting term relevance
  
  Set if the query will be boosted by the interesting term relevance

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Sets to <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Set the number of similar documents to return for each result
  
  Set the number of similar documents to return for each result

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  The number of similar documents to return for each result

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of query terms included
  
  Sets the maximum number of query terms that will be included in any generated query.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of query terms that will be included in any generated query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of tokens to parse
  
  Specifies the maximum number of tokens to parse in each example doc field that is not stored with
  TermVector support.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The maximum number of tokens to parse

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the maximum word length
  
  Sets the maximum word length above which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  The maximum word length above which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the mltMinDoc frequency
  
  The frequency at which words will be ignored which do not occur in at least this many docs.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Sets the frequency at which words will be ignored which do not occur in at
                         least this many docs.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Sets the frequency below which terms will be ignored in the source docs
  
  Sets the frequency below which terms will be ignored in the source docs

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  The frequency below which terms will be ignored in the source docs

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Sets the minimum word length
  
  Sets the minimum word length below which words will be ignored.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  The minimum word length below which words will be ignored

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Exclude the header from the returned results
  
  Exclude the header from the returned results.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> excludes the header from the result.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Sets the search query
  
  Sets the search query.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  The search query

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Specifies the maximum number of rows to return in the result
  
  Specifies the maximum number of rows to return in the result

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of rows to return

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


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Flag to show debug information
  
  Whether to show debug info

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Whether to show debug info. <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Specifies the number of rows to skip
  
  Specifies the number of rows to skip. Useful in pagination of results.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  The number of rows to skip.

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


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Enables or disables the Stats component
  
  Enables or disables the Stats component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> turns on the stats component and <info>false</info> disables it.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Enables or disables the TermsComponent
  
  Enables or disables the TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> enables it. <info>false</info> turns it off

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Sets the name of the field to get the Terms from
  
  Sets the name of the field to get the terms from

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  The field name

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Include the lower bound term in the result set
  
  Include the lower bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Include the lower bound term in the result set

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Include the upper bound term in the result set
  
  Include the upper bound term in the result set.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Sets the maximum number of terms to return
  
  Sets the maximum number of terms to return

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  The maximum number of terms to return. All the terms will be returned if the limit is
               negative.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Specifies the Term to start from
  
  Specifies the Term to start from

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  The lower bound Term

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Sets the maximum document frequency
  
  Sets the maximum document frequency.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The maximum document frequency.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Sets the minimum document frequency
  
  Sets the minimum doc frequency to return in order to be included

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  The minimum frequency

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restrict matches to terms that start with the prefix
  
  Restrict matches to terms that start with the prefix

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Restrict matches to terms that start with the prefix

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Return the raw characters of the indexed term
  
  If true, return the raw characters of the indexed term, regardless of if it is human readable

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> or <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Specifies how to sort the returned terms
  
  If SolrQuery::TERMS_SORT_COUNT, sorts the terms by the term frequency (highest count first). If
  SolrQuery::TERMS_SORT_INDEX, returns the terms in index order

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX or SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Sets the term to stop at
  
  Sets the term to stop at

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  The term to stop at

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  The time allowed for search to finish
  
  The time allowed for a search to finish. This value only applies to the search and not to requests
  in general. Time is in milliseconds. Values less than or equal to zero implies no time
  restriction. Partial results may be returned, if there are any.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  The time allowed for a search to finish.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current SolrQuery object, if the return value is used.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Returns the XML response as serialized PHP data
  
  Returns the XML response as serialized PHP data

<comment>Return:</comment>
  <info>string</info>  Returns the XML response as serialized PHP data


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Returns the HTTP status of the response
  
  Returns the HTTP status of the response.

<comment>Return:</comment>
  <info>int</info>  Returns the HTTP status of the response.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Returns more details on the HTTP status
  
  Returns more details on the HTTP status.

<comment>Return:</comment>
  <info>string</info>  Returns more details on the HTTP status


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Returns the raw request sent to the Solr server
  
  Returns the raw request sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request sent to the Solr server


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw request headers sent to the Solr server
  
  Returns the raw request headers sent to the Solr server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw request headers sent to the Solr server


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Returns the raw response from the server
  
  Returns the raw response from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response from the server.


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Returns the raw response headers from the server
  
  Returns the raw response headers from the server.

<comment>Return:</comment>
  <info>string</info>  Returns the raw response headers from the server.


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Returns the full URL the request was sent to
  
  Returns the full URL the request was sent to.

<comment>Return:</comment>
  <info>string</info>  Returns the full URL the request was sent to


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Returns a SolrObject representing the XML response from the server
  
  Returns a SolrObject representing the XML response from the server.

<comment>Return:</comment>
  <info>SolrObject</info>  Returns a SolrObject representing the XML response from the server


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Sets the parse mode
  
  Sets the parse mode.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC parses documents in SolrDocument instances.
                     SolrResponse::PARSE_SOLR_OBJ parses document into SolrObjects.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  Was the request a success
  
  Used to check if the request to the server was successful.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if it was successful and <info>false</info> if it was not.


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  An exception thrown when there is an error produced by the Solr Server itself.


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Contains utility methods for retrieving the current extension version and preparing query phrases.
  
  Also contains method for escaping query strings and parsing XML responses.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Parses an response XML string into a SolrObject
  
  This method parses an response XML string from the Apache Solr server into a SolrObject. It throws
  a SolrException if there was an error.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  The XML response string from the Solr server.
  <info>int   </info>  <strong>$parse_mode </strong>  Use SolrResponse::PARSE_SOLR_OBJ or SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Returns the SolrObject representing the XML response.
              
              If the parse_mode parameter is set to SolrResponse::PARSE_SOLR_OBJ Solr documents will
              be parses as SolrObject instances.
              
              If it is set to SolrResponse::PARSE_SOLR_DOC, they will be parsed as SolrDocument
              instances.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Escapes a lucene query string
  
  Lucene supports escaping special characters that are part of the query syntax.
  
  The current list special characters are:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  This is the query string to be escaped.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the escaped string sau <info>false</info> în cazul eșecului.


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Returns the current version of the Solr extension
  
  Returns the current Solr version.

<comment>Return:</comment>
  <info>string</info>  The current version of the Apache Solr extension.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prepares a phrase from an unescaped lucene string
  
  Prepares a phrase from an unescaped lucene string.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  The lucene phrase.

<comment>Return:</comment>
  <info>string</info>  Returns the phrase contained in double quotes.


id: SphinxClient
type: class
doc:
<comment>Description:</comment>
  The SphinxClient class provides object-oriented interface to Sphinx.


id: SphinxClient::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new SphinxClient object
  
  Creates a new <class>SphinxClient</class> object.


id: SphinxClient::addQuery
type: function
doc:
<comment>Description:</comment>
  Add query to multi-query batch
  
  Adds query with the current settings to multi-query batch. This method doesn't affect current
  settings (sorting, filtering, grouping etc.) in any way.

<comment>Param:</comment>
  <info>string</info>  <strong>$query  </strong>  Query string.
  <info>string</info>  <strong>$index  </strong>  An index name (or names).
  <info>string</info>  <strong>$comment</strong>  

<comment>Return:</comment>
  <info>int</info>  Returns an index in an array of results that will be returned by  call or false on error.

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


id: SphinxClient::buildExcerpts
type: function
doc:
<comment>Description:</comment>
  Build text snippets
  
  Connects to searchd, requests it to generate excerpts (snippets) from the given documents, and
  returns the results.

<comment>Param:</comment>
  <info>array </info>  <strong>$docs </strong>  Array of strings with documents' contents.
  <info>string</info>  <strong>$index</strong>  Index name.
  <info>string</info>  <strong>$words</strong>  Keywords to highlight.
  <info>array </info>  <strong>$opts </strong>  Associative array of additional highlighting options (see below).

<comment>Return:</comment>
  <info>arrayfalse</info>  Returns array of snippets on success sau <info>false</info> în cazul eșecului.


id: SphinxClient::buildKeywords
type: function
doc:
<comment>Description:</comment>
  Extract keywords from query
  
  Extracts keywords from <strong>$query</strong> using tokenizer  settings for the given <strong>$index</strong>, optionally with
  per-keyword occurrence statistics.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  A query to extract keywords from.
  <info>string</info>  <strong>$index</strong>  An index to get tokenizing settings and keyword occurrence statistics from.
  <info>bool  </info>  <strong>$hits </strong>  A boolean flag to enable/disable keyword statistics generation.

<comment>Return:</comment>
  <info>array</info>  Returns an array of associative arrays with per-keyword information.


id: SphinxClient::close
type: function
doc:
<comment>Description:</comment>
  Closes previously opened persistent connection
  
  Closes previously opened persistent connection.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * 


id: SphinxClient::escapeString
type: function
doc:
<comment>Description:</comment>
  Escape special characters
  
  Escapes characters that are treated as special operators by the query language parser.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  String to escape.

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


id: SphinxClient::getLastError
type: function
doc:
<comment>Description:</comment>
  Get the last error message
  
  Returns string with the last error message. If there were no errors during the previous API call,
  empty string is returned. This method doesn't reset the error message, so you can safely call it
  several times.

<comment>Return:</comment>
  <info>string</info>  Returns the last error message or an empty string if there were no errors.

<comment>See Also:</comment>
   * 


id: SphinxClient::getLastWarning
type: function
doc:
<comment>Description:</comment>
  Get the last warning
  
  Returns last warning message. If there were no warnings during  the previous API call, empty
  string is returned. This method doesn't reset the warning, so you can safely call it several
  times.

<comment>Return:</comment>
  <info>string</info>  Returns the last warning message or an empty string if there were no warnings.

<comment>See Also:</comment>
   * 


id: SphinxClient::open
type: function
doc:
<comment>Description:</comment>
  Opens persistent connection to the server
  
  Opens persistent connection to the server.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * 


id: SphinxClient::query
type: function
doc:
<comment>Description:</comment>
  Execute search query
  
  Connects to searchd server, runs the given search query with the current settings, obtains and
  returns the result set.

<comment>Param:</comment>
  <info>string</info>  <strong>$query  </strong>  Query string.
  <info>string</info>  <strong>$index  </strong>  An index name (or names).
  <info>string</info>  <strong>$comment</strong>  

<comment>Return:</comment>
  <info>array</info>  On success, <strong>SphinxClient::query()</strong> returns a list of  found matches and additional per-query
         statistics. The result set is a  hash utilize other structures instead of hash) with the
         following keys and values: Result set structureKeyValue description"matches"An array with
         found document IDs as keys and their weight and attributes values as values"total"Total
         number of matches found and retrieved (depends on your settings)"total_found"Total number
         of found documents matching the query"words"An array with words (case-folded and stemmed)
         as keys and per-word statistics as values"error"Query error message reported by
         searchd"warning"Query warning reported by searchd

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


id: SphinxClient::resetFilters
type: function
doc:
<comment>Description:</comment>
  Clear all filters
  
  Clears all currently set filters. This call is normally required when using multi-queries. You
  might want to set different filters for different queries in the batch. To do that, you should
  call <strong>SphinxClient::resetFilters()</strong> and add new filters using  the respective calls.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * 


id: SphinxClient::resetGroupBy
type: function
doc:
<comment>Description:</comment>
  Clear all group-by settings
  
  Clears all currently group-by settings, and disables group-by.  This call is normally required
  only when using multi-queries.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * 


id: SphinxClient::runQueries
type: function
doc:
<comment>Description:</comment>
  Run a batch of search queries
  
  Connects to searchd, runs a batch of all queries added using , obtains and returns the result
  sets.

<comment>Return:</comment>
  <info>array</info>  Returns <info>false</info> on failure and array of result sets on success.

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


id: SphinxClient::setArrayResult
type: function
doc:
<comment>Description:</comment>
  Change the format of result set array
  
  Controls the format of search results set arrays (whether matches should be returned as an array
  or a hash).

<comment>Param:</comment>
  <info>bool</info>  <strong>$array_result</strong>  If <strong>$array_result</strong> is <info>false</info>, matches are returned as a hash with document IDs
                       as keys, and other information (weight, attributes) as values. If
                       <strong>$array_result</strong> is <info>true</info>, matches  are returned as a plain array with complete
                       per-match information including document IDs.

<comment>Return:</comment>
  <info>bool</info>  Always returns <info>true</info>.


id: SphinxClient::setConnectTimeout
type: function
doc:
<comment>Description:</comment>
  Set connection timeout
  
  Sets connection timeout (in seconds) for searchd connection.

<comment>Param:</comment>
  <info>float</info>  <strong>$timeout</strong>  Timeout in seconds.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * 


id: SphinxClient::setFieldWeights
type: function
doc:
<comment>Description:</comment>
  Set field weights
  
  Binds per-field weights by name.
  
  Match ranking can be affected by per-field weights. See Sphinx documentation for an explanation on
  how phrase proximity ranking is affected. This call lets you specify  non-default weights for
  full-text fields.
  
  The weights must be positive 32-bit integers, so be careful not to hit 32-bit integer maximum. The
  final weight is a 32-bit integer too.  Default weight value is 1. Unknown field names are silently
  ignored.

<comment>Param:</comment>
  <info>array</info>  <strong>$weights</strong>  Associative array of field names and field weights.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * 


id: SphinxClient::setFilter
type: function
doc:
<comment>Description:</comment>
  Add new integer values set filter
  
  Adds new integer values set filter to the existing list of filters.

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  An attribute name.
  <info>array </info>  <strong>$values   </strong>  Plain array of integer values.
  <info>bool  </info>  <strong>$exclude  </strong>  If set to <info>true</info>, matching documents are excluded from the result set.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setFilterFloatRange
type: function
doc:
<comment>Description:</comment>
  Add new float range filter
  
  Adds new float range filter to the existing list of filters. Only those documents which have
  <strong>$attribute</strong>  value stored in the index between <strong>$min</strong> and <strong>$max</strong> (including values that are exactly
  equal  to <strong>$min</strong> or <strong>$max</strong>) will  be matched (or rejected, if <strong>$exclude</strong> is <info>true</info>).

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  An attribute name.
  <info>float </info>  <strong>$min      </strong>  Minimum value.
  <info>float </info>  <strong>$max      </strong>  Maximum value.
  <info>bool  </info>  <strong>$exclude  </strong>  If set to <info>true</info>, matching documents are excluded from the result set.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setFilterRange
type: function
doc:
<comment>Description:</comment>
  Add new integer range filter
  
  Adds new integer range filter to the existing list of filters. Only those documents which have
  <strong>$attribute</strong>  value stored in the index between <strong>$min</strong> and <strong>$max</strong> (including values that are exactly
  equal  to <strong>$min</strong> or <strong>$max</strong>) will  be matched (or rejected, if <strong>$exclude</strong> is <info>true</info>).

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  An attribute name.
  <info>int   </info>  <strong>$min      </strong>  Minimum value.
  <info>int   </info>  <strong>$max      </strong>  Maximum value.
  <info>bool  </info>  <strong>$exclude  </strong>  If set to <info>true</info>, matching documents are excluded from the result set.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setGeoAnchor
type: function
doc:
<comment>Description:</comment>
  Set anchor point for a geosphere distance calculations
  
  Sets anchor point for a geosphere distance (geodistance) calculations and enables them.
  
  Once an anchor point is set, you can use magic "@geodist" attribute name in your filters and/or
  sorting expressions.

<comment>Param:</comment>
  <info>string</info>  <strong>$attrlat  </strong>  Name of a latitude attribute.
  <info>string</info>  <strong>$attrlong </strong>  Name of a longitude attribute.
  <info>float </info>  <strong>$latitude </strong>  Anchor latitude in radians.
  <info>float </info>  <strong>$longitude</strong>  Anchor longitude in radians.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setGroupBy
type: function
doc:
<comment>Description:</comment>
  Set grouping attribute
  
  Sets grouping attribute, function, and group sorting mode, and enables grouping.
  
  Grouping feature is very similar to GROUP BY clause in SQL. Results produced by this function call
  are going to be the same as produced by the following pseudo code: SELECT ... GROUP BY
  $func($attribute) ORDER BY $groupsort.

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  A string containing group-by attribute name.
  <info>int   </info>  <strong>$func     </strong>  Constant, which sets a function applied to the attribute value in order to
                      compute group-by key.
  <info>string</info>  <strong>$groupsort</strong>  An optional clause controlling how the groups are sorted.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setGroupDistinct
type: function
doc:
<comment>Description:</comment>
  Set attribute name for per-group distinct values count calculations
  
  Sets attribute name for per-group distinct values count calculations. Only available for grouping
  queries.  For each group, all values of <strong>$attribute</strong> will be stored, then the amount of distinct
  values will be calculated and returned to the client. This feature is similar to COUNT(DISTINCT)
  clause in SQL.

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  A string containing group-by attribute name.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setIDRange
type: function
doc:
<comment>Description:</comment>
  Set a range of accepted document IDs
  
  Sets an accepted range of document IDs. Default range is from 0 to 0, i.e. no limit. Only those
  records that have document ID between <strong>$min</strong> and <strong>$max</strong>  (including IDs exactly equal to <strong>$min</strong> or <strong>$max</strong>)
  will be matched.

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  Minimum ID value.
  <info>int</info>  <strong>$max</strong>  Maximum ID value.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setIndexWeights
type: function
doc:
<comment>Description:</comment>
  Set per-index weights
  
  Sets per-index weights and enables weighted summing of match weights across different indexes.

<comment>Param:</comment>
  <info>array</info>  <strong>$weights</strong>  An associative array mapping string index names to integer weights. Default is
                   empty array, i.e. weighting summing is disabled.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setLimits
type: function
doc:
<comment>Description:</comment>
  Set offset and limit of the result set
  
  Sets <strong>$offset</strong> into server-side result set and amount of matches to return to client starting from
  that offset (<strong>$limit</strong>). Can additionally control maximum server-side result set size for current
  query (<strong>$max_matches</strong>) and the threshold amount of matches to stop searching at (<strong>$cutoff</strong>).

<comment>Param:</comment>
  <info>int</info>  <strong>$offset     </strong>  Result set offset.
  <info>int</info>  <strong>$limit      </strong>  Amount of matches to return.
  <info>int</info>  <strong>$max_matches</strong>  Controls how much matches searchd will keep in RAM while searching.
  <info>int</info>  <strong>$cutoff     </strong>  Used for advanced performance control. It tells searchd to forcibly  stop
                     search query once <strong>$cutoff</strong> matches have been  found and processed.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setMatchMode
type: function
doc:
<comment>Description:</comment>
  Set full-text query matching mode
  
  Sets full-text query matching mode. <strong>$mode</strong> is one of the constants listed below. Match
  modesConstantDescriptionSPH_MATCH_ALLMatch all query words (default mode).SPH_MATCH_ANYMatch any
  of query words.SPH_MATCH_PHRASEMatch query as a phrase, requiring perfect
  match.SPH_MATCH_BOOLEANMatch query as a boolean expression.SPH_MATCH_EXTENDEDMatch query as an
  expression in Sphinx internal query language.SPH_MATCH_FULLSCANEnables
  fullscan.SPH_MATCH_EXTENDED2The same as <info>SPH_MATCH_EXTENDED</info> plus ranking and quorum searching
  support.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Matching mode.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::setMaxQueryTime
type: function
doc:
<comment>Description:</comment>
  Set maximum query time
  
  Sets maximum search query time.

<comment>Param:</comment>
  <info>int</info>  <strong>$qtime</strong>  Maximum query time, in milliseconds. It must be a non-negative integer. Default value
               is 0, i.e. no limit.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setOverride
type: function
doc:
<comment>Description:</comment>
  Sets temporary per-document attribute value
     overrides
  
  Sets temporary (per-query) per-document attribute value overrides. Override feature lets you
  "temporary" update attribute values for some documents within a single query, leaving all other
  queries unaffected. This might be useful for personalized data

<comment>Param:</comment>
  <info>string</info>  <strong>$attribute</strong>  An attribute name.
  <info>int   </info>  <strong>$type     </strong>  An attribute type. Only supports scalar attributes.
  <info>array </info>  <strong>$values   </strong>  Array of attribute values that maps document IDs to overridden attribute
                      values.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setRankingMode
type: function
doc:
<comment>Description:</comment>
  Set ranking mode
  
  Sets ranking mode. Only available in <info>SPH_MATCH_EXTENDED2</info> matching mode. Ranking
  modesConstantDescriptionSPH_RANK_PROXIMITY_BM25Default ranking mode which uses both proximity and
  BM25 ranking.SPH_RANK_BM25Statistical ranking mode which uses BM25 ranking only (similar to most
  of other full-text engines). This mode is faster, but may result in worse quality on queries which
  contain more than 1 keyword.SPH_RANK_NONEDisables ranking. This mode is the fastest. It is
  essentially equivalent to boolean searching, a weight of 1 is assigned to all matches.

<comment>Param:</comment>
  <info>int</info>  <strong>$ranker</strong>  Ranking mode.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * 


id: SphinxClient::setRetries
type: function
doc:
<comment>Description:</comment>
  Set retry count and delay
  
  Sets distributed retry count and delay.
  
  On temporary failures searchd will attempt up to <strong>$count</strong> retries per agent. <strong>$delay</strong> is the delay
  between the retries,  in milliseconds. Retries are disabled by default.  Note that this call will
  not make the API itself retry on temporary failure; it only tells searchd to do so.

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  Number of retries.
  <info>int</info>  <strong>$delay</strong>  Delay between retries, in milliseconds.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setSelect
type: function
doc:
<comment>Description:</comment>
  Set select clause
  
  Sets the select clause, listing specific attributes to fetch, and expressions to compute and
  fetch.

<comment>Param:</comment>
  <info>string</info>  <strong>$clause</strong>  SQL-like clause.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setServer
type: function
doc:
<comment>Description:</comment>
  Set searchd host and port
  
  Sets searchd host name and TCP port. All subsequent requests will use the new host and port
  settings. Default host and port are 'localhost' and 3312, respectively.

<comment>Param:</comment>
  <info>string</info>  <strong>$server</strong>  IP or hostname.
  <info>int   </info>  <strong>$port  </strong>  Port number.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.


id: SphinxClient::setSortMode
type: function
doc:
<comment>Description:</comment>
  Set matches sorting mode
  
  Sets matches sorting mode. See available modes below. Sorting
  modesConstantDescriptionSPH_SORT_RELEVANCESort by relevance in descending order (best matches
  first).SPH_SORT_ATTR_DESCSort by an attribute in descending order (bigger attribute values
  first).SPH_SORT_ATTR_ASCSort by an attribute in ascending order (smaller attribute values
  first).SPH_SORT_TIME_SEGMENTSSort by time segments (last hour/day/week/month) in descending order,
  and then by relevance in descending order.SPH_SORT_EXTENDEDSort by SQL-like combination of columns
  in ASC/DESC order.SPH_SORT_EXPRSort by an arithmetic expression.

<comment>Param:</comment>
  <info>int   </info>  <strong>$mode  </strong>  Sorting mode.
  <info>string</info>  <strong>$sortby</strong>  

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SphinxClient::status
type: function
doc:
<comment>Description:</comment>
  Queries searchd status
  
  Queries searchd status, and returns an array of status variable name and value pairs.

<comment>Return:</comment>
  <info>array</info>  Returns an associative array of search server statistics sau <info>false</info> în cazul eșecului.


id: SphinxClient::updateAttributes
type: function
doc:
<comment>Description:</comment>
  Update document attributes
  
  Instantly updates given attribute values in given documents.

<comment>Param:</comment>
  <info>string</info>  <strong>$index     </strong>  Name of the index (or indexes) to be updated.
  <info>array </info>  <strong>$attributes</strong>  Array of attribute names, listing attributes that are updated.
  <info>array </info>  <strong>$values    </strong>  Associative array containing document IDs as keys and array of attribute
                       values as values.

<comment>Return:</comment>
  <info>int</info>  Returns number of actually updated documents (0 or more) on success, or <info>false</info> on failure.


id: SplBool
type: class
doc:
<comment>Description:</comment>
  The SplBool class is used to enforce strong typing of the bool type.


id: SplDoublyLinkedList
type: class
doc:
<comment>Description:</comment>
  The SplDoublyLinkedList class provides the main functionalities of a doubly linked list.


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a first in, first out order, like a queue.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  The list will be iterated in a last in, first out order, like a stack.


id: SplDoublyLinkedList::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new doubly linked list
  
  This constructs a new empty doubly linked list.

<comment>Return:</comment>
  <info>unknown</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Add/insert a new value at the specified index
  
  Insert the value <strong>$newval</strong> at the specified <strong>$index</strong>, shuffling the previous value at that index (and
  all subsequent values) up through the list.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index </strong>  The index where the new value is to be inserted.
  <info>mixed</info>  <strong>$newval</strong>  The new value for the <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the first node.


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Counts the number of elements in the doubly linked list

<comment>Return:</comment>
  <info>int</info>  Returns the number of elements in the doubly linked list.


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current doubly linked list node.

<comment>Return:</comment>
  <info>mixed</info>  The current node value.


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Returns the mode of iteration

<comment>Return:</comment>
  <info>int</info>  Returns the different modes and flags that affect the iteration.


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  Checks whether the doubly linked list is empty

<comment>Return:</comment>
  <info>bool</info>  Returns whether the doubly linked list is empty.


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  Return current node index
  
  This function returns the current node index

<comment>Return:</comment>
  <info>mixed</info>  The current node index.


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next node.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested $index exists

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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  Returns the value at the specified $index

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index with the value.

<comment>Return:</comment>
  <info>mixed</info>  The value at the specified <strong>$index</strong>.


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  Sets the value at the specified $index to $newval
  
  Sets the value at the specified <strong>$index</strong> to <strong>$newval</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index </strong>  The index being set.
  <info>mixed</info>  <strong>$newval</strong>  The new value for the <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unsets the value at the specified $index
  
  Unsets the value at the specified index.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$index</strong>  The index being unset.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Pops a node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the popped node.


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Move to previous entry
  
  Move the iterator to the previous node.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  Pushes an element at the end of the doubly linked list
  
  Pushes <strong>$value</strong> at the end of the doubly linked list.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to push.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind iterator back to the start
  
  This rewinds the iterator to the beginning.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the storage
  
  Serializes the storage.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Return:</comment>
  <info>string</info>  The serialized string.

<comment>See Also:</comment>
   * SplDoublyLinkedList::unserialize


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Sets the mode of iteration

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  There are two orthogonal sets of modes that can be set:
              
              The direction of the iteration (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (Stack style)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (Queue style)
              
              The behavior of the iterator (either one or the other):
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (Elements are deleted by the iterator)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (Elements are traversed by the iterator)
              
              The default mode is: <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info>

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  Shifts a node from the beginning of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the shifted node.


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Peeks at the node from the end of the doubly linked list

<comment>Return:</comment>
  <info>mixed</info>  The value of the last node.


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserializes the storage
  
  Unserializes the storage, from SplDoublyLinkedList::serialize.
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

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

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplDoublyLinkedList::serialize


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Prepends the doubly linked list with an element
  
  Prepends <strong>$value</strong> at the beginning of the doubly linked list.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to unshift.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  Check whether the doubly linked list contains more nodes
  
  Checks if the doubly linked list contains any more nodes.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the doubly linked list contains any more nodes, <info>false</info> otherwise.


id: SplEnum
type: class
doc:
<comment>Description:</comment>
  SplEnum gives the ability to emulate and create enumeration objects natively in PHP.


id: SplEnum::getConstList
type: function
doc:
<comment>Description:</comment>
  Returns all consts (possible values) as an array
  
  Această funcție nu este documentată în prezent; este disponibilă numai
  lista sa de argumente.

<comment>Param:</comment>
  <info>bool</info>  <strong>$include_default</strong>  Whether to include <return>__default</return> property.

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


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  The SplFileInfo class offers a high-level object oriented interface to information for an
  individual file.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new SplFileInfo object
  
  Creates a new SplFileInfo object for the file_name specified. The file does not need to exist, or
  be readable.

<comment>Param:</comment>
  <info>string</info>  <strong>$file_name</strong>  Path to the file.


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the path to the file as a string
  
  This method will return the file name of the referenced file.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  Gets last access time of the file
  
  Gets the last access time for the file.

<comment>Return:</comment>
  <info>int</info>  Returns the time the file was last accessed.

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


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  Gets the base name of the file
  
  This method returns the base name of the file, directory, or link without path info.
  
  <strong>SplFileInfo::getBasename()</strong> is locale aware, so for it to see the  correct basename with multibyte
  character paths, the matching locale must  be set using the <strong>setlocale()</strong> function.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Optional suffix to omit from the base name returned.

<comment>Return:</comment>
  <info>string</info>  Returns the base name without path information.

<comment>See Also:</comment>
   * SplFileInfo::getFilename


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  Gets the inode change time
  
  Returns the inode change time for the file. The time returned is a Unix timestamp.

<comment>Return:</comment>
  <info>int</info>  The last change time, in a Unix timestamp.

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


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Gets the file extension
  
  Retrieves the file extension.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> containing the file extension, or an empty <info>string</info> if the file has no
          extension.

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the file
  
  This method gets an <class>SplFileInfo</class> object for the referenced file.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  Name of an <class>SplFileInfo</class> derived class to use.

<comment>Return:</comment>
  <info>SplFileInfo</info>  An <class>SplFileInfo</class> object created for the file.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Gets the filename
  
  Gets the filename without any path information.

<comment>Return:</comment>
  <info>string</info>  The filename.

<comment>See Also:</comment>
   * SplFileInfo::getBasename


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  Gets the file group
  
  Gets the file group. The group ID is returned in numerical format.

<comment>Return:</comment>
  <info>int</info>  The group id in numerical format.

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


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Gets the inode for the file
  
  Gets the inode number for the filesystem object.

<comment>Return:</comment>
  <info>int</info>  Returns the inode number for the filesystem object.

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Gets the target of a link
  
  Gets the target of a filesystem link.
  
  The target may not be the real path on the filesystem. Use SplFileInfo::getRealPath to determine
  the true path on the filesystem.

<comment>Return:</comment>
  <info>string</info>  Returns the target of the filesystem link.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  Gets the last modified time
  
  Returns the time when the contents of the file were changed. The time returned is a Unix
  timestamp.

<comment>Return:</comment>
  <info>int</info>  Returns the last modified time for the file, in a Unix timestamp.

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


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  Gets the owner of the file
  
  Gets the file owner. The owner ID is returned in numerical format.

<comment>Return:</comment>
  <info>int</info>  The owner id in numerical format.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  Gets the path without filename
  
  Returns the path to the file, omitting the filename and any trailing slash.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileInfo object for the path
  
  Gets an <class>SplFileInfo</class> object for the parent of the current file.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  Name of an <class>SplFileInfo</class> derived class to use.

<comment>Return:</comment>
  <info>SplFileInfo</info>  Returns an <class>SplFileInfo</class> object for the parent path of the file.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Gets the path to the file
  
  Returns the path to the file.

<comment>Return:</comment>
  <info>string</info>  The path to the file.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Gets file permissions
  
  Gets the file permissions for the file.

<comment>Return:</comment>
  <info>int</info>  Returns the file permissions.


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  Gets absolute path to file
  
  This method expands all symbolic links, resolves relative references and returns the real path to
  the file.

<comment>Return:</comment>
  <info>string</info>  Returns the path to the file, or <info>false</info> if the file does not exist.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Gets file size
  
  Returns the filesize in bytes for the file referenced.

<comment>Return:</comment>
  <info>int</info>  The filesize in bytes.

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


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  Gets file type
  
  Returns the type of the file referenced.

<comment>Return:</comment>
  <info>string</info>  A <info>string</info> representing the type of the entry. May be one of <return>file</return>, <return>link</return>, or <return>dir</return>


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a directory
  
  This method can be used to determine if the file is a directory.

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


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Tells if the file is executable
  
  Checks if the file is executable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if executable, <info>false</info> otherwise.


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Tells if the object references a regular file
  
  Checks if the file referenced by this SplFileInfo object exists and is a regular file.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the file exists and is a regular file (not a link), <info>false</info> otherwise.


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  Tells if the file is a link
  
  Use this method to check if the file referenced by the SplFileInfo object is a link.

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

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  Tells if file is readable
  
  Check if the file is readable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if readable, <info>false</info> otherwise.


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  Tells if the entry is writable
  
  Checks if the current entry is writable.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if writable, <info>false</info> otherwise;


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Gets an SplFileObject object for the file
  
  Creates an <class>SplFileObject</class> <info>object</info> of the file. This is useful because <class>SplFileObject</class> contains
  additional methods for manipulating the file whereas <class>SplFileInfo</class> is only useful for gaining
  information, like whether the file is writable.

<comment>Param:</comment>
  <info>string  </info>  <strong>$open_mode       </strong>  The mode for opening the file. See the <strong>fopen()</strong> documentation for
                               descriptions of possible modes. The default  is read only.
  <info>bool    </info>  <strong>$use_include_path</strong>  Când este stabilit în <info>true</info>, fișierul
                               este căutat și în căile specificate în include_path
  <info>resource</info>  <strong>$context         </strong>  Accesați secțiunea
                               context
                               a manualului pentru descrierea
                               <return>contextelor</return>.

<comment>Return:</comment>
  <info>SplFileObject</info>  The opened file as an <class>SplFileObject</class> <info>object</info>.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * <strong>stream_context_create()</strong>
   * <strong>fopen()</strong>


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::openFile
  
  Use this method to set a custom class which will be used when SplFileInfo::openFile is called. The
  class name passed to this method must be <class>SplFileObject</class> or a class derived from <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  The class name to use when SplFileInfo::openFile is called.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileInfo::openFile


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo
  
  Use this method to set a custom class which will be used when SplFileInfo::getFileInfo and
  SplFileInfo::getPathInfo are called. The class name passed to this method must be <class>SplFileInfo</class> or a
  class derived from <class>SplFileInfo</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>  The class name to use when SplFileInfo::getFileInfo and
                       SplFileInfo::getPathInfo are called.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileInfo::getFileInfo


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  The SplFileObject class offers an object oriented interface for a file.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Skips empty lines in the file. This requires the <info>READ_AHEAD</info> flag be enabled, to work as expected.


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new file object
  
  Construct a new file object.

<comment>Param:</comment>
  <info>string  </info>  <strong>$filename        </strong>  The file to read.
                               
                               Un URL poate fi utilizat în calitate de denumire a fișierului în
                               această funcție dacă învelișurile
                               fopen au fost activate. Accesați <strong>fopen()</strong> pentru mai
                               multe detalii despre modul de specificare a denumirii fișierului.
                               Accesați
                                pentru referințe la informații despre posibilitățile
                               pe care le oferă diferite învelișuri, note despre utilizarea lor și
                               informații
                               despre variabile predefinite pe care le oferă.
  <info>string  </info>  <strong>$open_mode       </strong>  The mode in which to open the file. See <strong>fopen()</strong> for a list of allowed
                               modes.
  <info>bool    </info>  <strong>$use_include_path</strong>  Whether to search in the include_path for <strong>$filename</strong>.
  <info>resource</info>  <strong>$context         </strong>  A valid context resource created with <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>unknown</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileInfo::openFile
   * <strong>fopen()</strong>


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Pseudonim al SplFileObject::fgets
  
  Această metodă este pseudonim pentru:  SplFileObject::fgets.


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Retrieve current line of file
  
  Retrieves the current line of the file.

<comment>Return:</comment>
  <info>stringarray</info>  Retrieves the current line of the file. If the <info>SplFileObject::READ_CSV</info> flag is set,
               this method returns an array containing the current line parsed as CSV data.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Reached end of file
  
  Determine whether the end of file has been reached

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if file is at EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Flushes the output to the file
  
  Forces a write of all buffered output to the file.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

<comment>See Also:</comment>
   * SplFileObject::fwrite


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Gets character from file
  
  Gets a character from the file.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing a single character read from the file or <info>false</info> on EOF.
          
          Această funcție poate întoarce valoarea Boolean <info>false</info>, dar poate de
          asemenea întoarce o valoare non-Boolean care evaluează în <info>false</info>. Vă rugăm să
          citiți secțiunea despre tipul Boolean
          pentru informații suplimentare. Utilizați
          operatorul === pentru a
          verifica valoarea întoarsă de această funcție.

<comment>See Also:</comment>
   * SplFileObject::fgets


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Gets line from file and parse as CSV fields
  
  Gets a line from the file which is in CSV format and returns an array containing the fields read.
  
  The locale settings are taken into account by this function. If <return>LC_CTYPE</return> is e.g. <return>en_US.UTF-8</return>,
  files in one-byte encodings may be read wrongly by this function.

<comment>Param:</comment>
  <info>string</info>  <strong>$delimiter</strong>  The field delimiter (one character only). Defaults as a comma or the value set
                      using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one character only). Defaults as a double
                      quotation mark or the value set using SplFileObject::setCsvControl.
  <info>string</info>  <strong>$escape   </strong>  The escape character (at most one character). Defaults as a backslash (<return>\</return>) or
                      the value set using SplFileObject::setCsvControl. An empty string (<return>""</return>)
                      disables the proprietary escape mechanism.
                      
                      Usually an <strong>$enclosure</strong> character is escpaped inside a field by doubling it;
                      however, the <strong>$escape</strong> character can be used as an alternative. So for the
                      default parameter values <return>""</return> and <return>\"</return> have the same meaning. Other than allowing
                      to escape the <strong>$enclosure</strong> character the <strong>$escape</strong> character has no special
                      meaning; it isn't even meant to escape itself.

<comment>Return:</comment>
  <info>array</info>  Returns an indexed array containing the fields read, or <info>false</info> on error.
         
         A blank line in a CSV file will be returned as an array comprising a single <info>null</info> field
         unless using <info>SplFileObject::SKIP_EMPTY | SplFileObject::DROP_NEW_LINE</info>,  in which case empty
         lines are skipped.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Gets line from file
  
  Gets a line from the file.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line from the file, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Gets line from file and strip HTML tags
  
  Identical to SplFileObject::fgets, except that SplFileObject::fgetss attempts to strip any HTML
  and PHP tags from the text it reads. The function retains the parsing state from call to call, and
  as such is not equivalent to calling <strong>strip_tags()</strong> on the return value of SplFileObject::fgets.

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  Optional parameter to specify tags which should not be stripped.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the next line of the file with HTML and PHP code stripped, or
          <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * The string.strip_tags filter


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Portable file locking
  
  Locks or unlocks the file in the same portable way as <strong>flock()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$operation </strong>  <strong>$operation</strong> is one of the following: <info>LOCK_SH</info> to acquire a shared lock (reader).
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer). <info>LOCK_UN</info> to release a lock (shared
                    or exclusive).
                    
                    <info>LOCK_SH</info> to acquire a shared lock (reader).
                    
                    <info>LOCK_EX</info> to acquire an exclusive lock (writer).
                    
                    <info>LOCK_UN</info> to release a lock (shared or exclusive).
                    
                    It is also possible to add <info>LOCK_NB</info> as a bitmask to one  of the above operations,
                    if <strong>flock()</strong> should not block during the locking attempt.
  <info>int</info>  <strong>$wouldblock</strong>  Set to <info>true</info> if the lock would block (EWOULDBLOCK errno condition).

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  Output all remaining data on a file pointer
  
  Reads to EOF on the given file pointer from the current position and writes the results to the
  output buffer.
  
  You may need to call SplFileObject::rewind to reset the file pointer to the beginning of the file
  if you have already written data to the file.

<comment>Return:</comment>
  <info>int</info>  Returns the number of characters read from <strong>$handle</strong> and passed through to the output.

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Write a field array as a CSV line
  
  Writes the <strong>$fields</strong> array to the file as a CSV line.

<comment>Param:</comment>
  <info>array </info>  <strong>$fields   </strong>  An array of values.
  <info>string</info>  <strong>$delimiter</strong>  The optional <strong>$delimiter</strong> parameter sets the field delimiter (one character
                      only).
  <info>string</info>  <strong>$enclosure</strong>  The optional <strong>$enclosure</strong> parameter sets the field enclosure (one character
                      only).
  <info>string</info>  <strong>$escape   </strong>  The optional <strong>$escape</strong> parameter sets the escape character (at most one
                      character). An empty string (<return>""</return>) disables the proprietary escape mechanism.

<comment>Return:</comment>
  <info>intfalse</info>  Returns the length of the written string sau <info>false</info> în cazul eșecului.
            
            Returns <info>false</info>, and does not write the CSV line to the file, if the <strong>$delimiter</strong> or
            <strong>$enclosure</strong> parameter is not a single character.

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


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Read from file
  
  Reads the given number of bytes from the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.

<comment>Return:</comment>
  <info>stringfalse</info>  Returns the string read from the file  sau <info>false</info> în cazul eșecului.

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Parses input from file according to a format
  
  Reads a line from the file and interprets it according to the specified <strong>$format</strong>, which is
  described in the documentation for <strong>sprintf()</strong>.
  
  Any whitespace in the <strong>$format</strong> string matches any whitespace in the line from the file. This means
  that even a tab <return>\t</return> in the format string can match a single space character in the input stream.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Șirul de formatare este compus din zero sau mai multe directive: caractere
                   obișnuite (în afară de <return>%</return>), care sunt copiate direct în rezultat și specificatori
                   de conversie, fiecare având parametrul său.
                   
                   Un specificator de conversie e compus după următorul prototip:
                   <return>%[argnum$][flags][width][.precision]specifier</return>.
                   
                   Un întreg urmat de senmul dolar <return>$</return>, pentru a specifica ce argument de număr
                   trebuie tratat în conversie.
                   
                   FlagsFlagDescriere<return>-</return> Alinierea spre stânga în limitele lungimii câmpului; Implicit
                   se efectuează alinierea spre dreapta <return>+</return> Prefixează numerele pozitive cu semnul
                   plus <return>+</return>; implicit doar numerele negative sunt prefixate cu semnul minus. <return> </return>(spațiu)
                   Completează rezultatul cu spații. Acesta este comportamentul implicit. <return>0</return>
                   Completează numerele cu zerouri în stânga. Cu specificatorii <return>s</return> se poate de
                   completat cu zerouri și în dreapta. <return>'</return>(char) Completează rezultatul cu caracterul
                   (char).
                   
                   Un număr întreg ce indică câte caractere (minimum) trebuie să aibă rezultatul
                   conversiei.
                   
                   Un punct <return>.</return>, urmat de un număr întreg, însemnătatea căruia depinde de
                   specificator:  Pentru specificatorii <return>e</return>, <return>E</return>, <return>f</return> și <return>F</return>: acesta este numărul de cifre
                   ce vor fi tipărite după punctul zecimal (implicit acesta este 6).  Pentru
                   specificatorii <return>g</return> și <return>G</return>: acesta este numărul maxim de cifre semnificative ce va fi
                   tipărit.  Pentru specificatorul <return>s</return>: acesta funcționează ca punct de oprire,
                   stabilind limita maximă a numărului de caractere din șir.   Dacă punctul este
                   specificat fără o valoare explicită pentru precizie, se presupune că aceasta este
                   0.
                   
                   Pentru specificatorii <return>e</return>, <return>E</return>, <return>f</return> și <return>F</return>: acesta este numărul de cifre ce vor fi
                   tipărite după punctul zecimal (implicit acesta este 6).
                   
                   Pentru specificatorii <return>g</return> și <return>G</return>: acesta este numărul maxim de cifre semnificative ce
                   va fi tipărit.
                   
                   Pentru specificatorul <return>s</return>: acesta funcționează ca punct de oprire, stabilind limita
                   maximă a numărului de caractere din șir.
                   
                   Dacă punctul este specificat fără o valoare explicită pentru precizie, se
                   presupune că aceasta este 0.
                   
                   Încercarea de a folosi un specificator de poziție mai mare decât <info>PHP_INT_MAX</info> va
                   genera avertizări.
                   
                   SpecifiersSpecifierDescriere<return>%</return> Specifică caracterul procent. Nu este necesar
                   vre-un argument. <return>b</return> Argumentul este tratat ca un întreg și prezentat ca număr
                   binar. <return>c</return> Argumentul este tratat ca un întreg și prezentat ca caracter cu acest
                   cod ASCII. <return>d</return> Argumentul este tratat ca un întreg și prezentat ca număr zecimal
                   (cu semn). <return>e</return> Argumentul este tratat ca număr în notație exponențială (de ex.
                   1.2e+2). Specificatorul de precizie semnifică numărul de cifre după virgulă
                   începând cu PHP 5.2.1. În versiuni anterioare el specifica numărul de cifre
                   semnificative (cu una mai puțin). <return>E</return> La fel ca și specificatorul <return>e</return>, dar folosește
                   caracterul majuscul (de ex. 1.2E+2). <return>f</return> Argumentul este tratat ca număr cu virgulă
                   și prezentat ca atare (în dependență de setările de localizare). <return>F</return> Argumentul
                   este tratat ca număr cu virgulă și prezentat ca atare (fără a se ține cont de
                   setările de localizare). Disponibil începând cu PHP 5.0.3. <return>g</return> Format general.  Fie
                   că P este egal cu precizia, dacă nu este zero, 6 dacă precizia este omisă, sau 1
                   dacă precizia este zero. Atunci dacă o conversie cu stilul E ar avea un exponent
                   X:  Dacă P &gt; X ≥ −4, atunci conversia este de stilul f și precizia P − (X +
                   1). În caz contrar, conversia este de stilul e și precizia P − 1. <return>G</return> La fel ca și
                   specificatorul <return>g</return>, dar utilizează <return>E</return> și <return>f</return>. <return>o</return> Argumentul este tratat ca întreg și
                   prezentat ca număr octal. <return>s</return> Argumentul este tratat și prezentat ca șir de
                   caractere. <return>u</return> Argumentul este tratat ca întreg și prezentat ca număr zecimal fără
                   semn. <return>x</return> Argumentul este tratat ca întreg și prezentat ca număr hexazecimal (cu
                   caractere minuscule). <return>X</return> Argumentul este tratat ca întreg și prezentat ca număr
                   hexazecimal (cu caractere majuscule).
                   
                   Format general.
                   
                   Fie că P este egal cu precizia, dacă nu este zero, 6 dacă precizia este omisă,
                   sau 1 dacă precizia este zero. Atunci dacă o conversie cu stilul E ar avea un
                   exponent X:
                   
                   Dacă P &gt; X ≥ −4, atunci conversia este de stilul f și precizia P − (X + 1). În
                   caz contrar, conversia este de stilul e și precizia P − 1.
                   
                   Specificatorul de tip <return>c</return> ignoră completarea cu spații și lungimea
                   
                   Încercarea de a folosi o combinație din specificatori de șiruri de caractere și
                   lungime cu seturi de caractere ce necesită mai mult de un octet per caracter
                   poate da rezultate imprevizibile
                   
                   Variabilele vor fi aduse la un tip potrivit pentru specificatorul: Manipularea
                   tipurilorTipulSpecificatorii<return>string</return><return>s</return><return>integer</return><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><return>double</return><return>g</return>, <return>G</return>, <return>e</return>, <return>E</return>, <return>f</return>,
                   <return>F</return>
  <info>mixed </info>  <strong>$vars  </strong>  The optional assigned values.

<comment>Return:</comment>
  <info>mixed</info>  If only one parameter is passed to this method, the values parsed will be returned as an
         array. Otherwise, if optional parameters are passed, the function will return the number of
         assigned values. The optional parameters must be passed by reference.

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  Seek to a position
  
  Seek to a position in the file measured in bytes from the beginning of the file, obtained by
  adding <strong>$offset</strong> to the position specified by <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset. A negative value can be used to move backwards through the file which is
                useful when SEEK_END is used as the <strong>$whence</strong> value.
  <info>int</info>  <strong>$whence</strong>  <strong>$whence</strong> values are: <info>SEEK_SET</info> - Set position equal to <strong>$offset</strong> bytes.<info>SEEK_CUR</info> - Set
                position to current location plus <strong>$offset</strong>.<info>SEEK_END</info> - Set position to end-of-file
                plus <strong>$offset</strong>.
                
                If <strong>$whence</strong> is not specified, it is assumed to be <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Returns 0 if the seek was successful, -1 otherwise. Note that seeking past EOF is not
       considered an error.

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Gets information about the file
  
  Gathers the statistics of the file. Behaves identically to <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Returns an array with the statistics of the file; the format of the array is described in
         detail on the <strong>stat()</strong> manual page.

<comment>See Also:</comment>
   * <strong>fstat()</strong>
   * <strong>stat()</strong>


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  Return current file position
  
  Returns the position of the file pointer which represents the current offset in the file stream.

<comment>Return:</comment>
  <info>int</info>  Returns the position of the file pointer as an integer, or <info>false</info> on error.

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Truncates the file to a given length
  
  Truncates the file to <strong>$size</strong> bytes.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size to truncate to.
              
              If <strong>$size</strong> is larger than the file it is extended with null bytes.
              
              If <strong>$size</strong> is smaller than the file, the extra data will be lost.

<comment>Return:</comment>
  <info>bool</info>  Întoarce valoarea <info>true</info> în cazul
        succesului sau <info>false</info> în cazul eșecului.

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


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Write to file
  
  Writes the contents of <strong>$string</strong> to the file

<comment>Param:</comment>
  <info>string</info>  <strong>$str   </strong>  The string to be written to the file.
  <info>int   </info>  <strong>$length</strong>  If the <strong>$length</strong> argument is given, writing will stop after <strong>$length</strong> bytes have been
                   written or the end of <strong>$string</strong> is reached, whichever comes first.

<comment>Return:</comment>
  <info>int</info>  Returns the number of bytes written, or <info>false</info> on error.

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  No purpose
  
  An <class>SplFileObject</class> does not have children so this method returns <info>null</info>.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * RecursiveIterator::getChildren


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Get the delimiter, enclosure and escape character for CSV
  
  Gets the delimiter, enclosure and escape character used for parsing CSV fields.

<comment>Return:</comment>
  <info>array</info>  Returns an indexed array containing the delimiter, enclosure and escape character.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Gets flags for the SplFileObject
  
  Gets the flags set for an instance of SplFileObject as an <info>int</info>.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> representing the flags.

<comment>See Also:</comment>
   * SplFileObject::setFlags


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Get maximum line length
  
  Gets the maximum line length as set by SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Returns the maximum line length if one has been set with SplFileObject::setMaxLineLen,
       default is <return>0</return>.

<comment>See Also:</comment>
   * SplFileObject::setMaxLineLen


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  SplFileObject does not have children
  
  An <class>SplFileObject</class> does not have children so this method always return <info>false</info>.

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

<comment>See Also:</comment>
   * RecursiveIterator::hasChildren


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Get line number
  
  Gets the current line number.
  
  This number may not reflect the actual line number in the file  if SplFileObject::setMaxLineLen is
  used to  read fixed lengths of the file.

<comment>Return:</comment>
  <info>int</info>  Returns the current line number.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Read next line
  
  Moves ahead to the next line in the file.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the file to the first line
  
  Rewinds the file back to the first line.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Seek to specified line
  
  Seek to specified line in the file.

<comment>Param:</comment>
  <info>int</info>  <strong>$line_pos</strong>  The zero-based line number to seek to.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Set the delimiter, enclosure and escape character for CSV
  
  Sets the delimiter, enclosure and escape character for parsing CSV fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$delimiter</strong>  The field delimiter (one character only).
  <info>string</info>  <strong>$enclosure</strong>  The field enclosure character (one character only).
  <info>string</info>  <strong>$escape   </strong>  The field escape character (at most one character). An empty string (<return>""</return>)
                      disables the proprietary escape mechanism.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets flags for the SplFileObject
  
  Sets the flags to be used by the <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Bit mask of the flags to set. See  SplFileObject constants  for the available flags.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::getFlags


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Set maximum line length
  
  Sets the maximum length of a line to be read.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_len</strong>  The maximum length of a line.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.

<comment>See Also:</comment>
   * SplFileObject::getMaxLineLen


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Not at EOF
  
  Check whether EOF has been reached.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if not reached EOF, <info>false</info> otherwise.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  The SplFixedArray class provides the main functionalities of array. The  main differences between
  a SplFixedArray and a normal PHP array is that  the SplFixedArray is of fixed length and allows
  only integers within  the range as indexes. The advantage is that it uses less memory than a
  standard <info>array</info>.


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new fixed array
  
  Initializes a fixed array with a number of <info>null</info> values equal to <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the fixed array.  This expects a number between <return>0</return> and <info>PHP_INT_MAX</info>.

<comment>Return:</comment>
  <info>unknown</info>  Nu este întoarsă nici o valoare.


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Reinitialises the array after being unserialised
  
  Reinitialises the array after being unserialised.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Returns the size of the array
  
  Returns the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array.

<comment>See Also:</comment>
   * SplFixedArray::getSize


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Return current array entry
  
  Get the current array element.

<comment>Return:</comment>
  <info>mixed</info>  The current element value.


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Import a PHP array in a SplFixedArray instance
  
  Import the PHP array <strong>$array</strong>  in a new <class>SplFixedArray</class> instance

<comment>Param:</comment>
  <info>array</info>  <strong>$array       </strong>  The array to import.
  <info>bool </info>  <strong>$save_indexes</strong>  Try to save the numeric indexes used in the original array.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Returns an instance of <class>SplFixedArray</class>  containing the array content.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Gets the size of the array
  
  Gets the size of the array.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the array, as an <info>int</info>.

<comment>See Also:</comment>
   * SplFixedArray::count


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  Return current array index
  
  Returns the current array index.

<comment>Return:</comment>
  <info>int</info>  The current array index.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Move to next entry
  
  Move the iterator to the next array entry.

<comment>Return:</comment>
  <info>void</info>  Nu este întoarsă nici o valoare.


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  Returns whether the requested index exists
  
  Checks whether the requested index <strong>$index</strong>  exists.

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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested <strong>$index</strong> exists, otherwise <info>false</info>


