# php_manual

id: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz como representación del documento de entrada
  
  Devuelve una matriz como representación del documento de entrada.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz que contiene los campos. Devuelve <info>false</info> en caso de error.


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Representa una colección de pares nombre-valore enviados al servidor Solr durante una petición.


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

<comment>Return:</comment>
  <info>unknown</info>  Nada


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  Es un objeto a cuyas propiedades también se pueden acceder usando la sintaxis de array. Todas sus
  propiedades son de sólo lectura.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un objeto Solr
  
  Crea un objeto Solr.

<comment>Return:</comment>
  <info>unknown</info>  Nada


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructor
  
  El destructor

<comment>Return:</comment>
  <info>unknown</info>  Nada.


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz de todos los nombres de las propiedades
  
  Devuelve una matriz de todos los nombres de las propiedades.

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz.


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Comprueba si la propiedad existe
  
  Comprueba si la propiedad existe. Se usa cuando el objeto es tratado como una matriz.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  El nombre de la propiedad.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Usado para recuperar una propiedad
  
  Usado para obtener el valor de una propiedad. Se utiliza cuando un objeto es tratado como una
  matriz.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Nombre de la propiedad.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve el valor de la propiedad.


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Establece el valor de una propiedad
  
  Establece el valor de una propiedad. Se usa cuando el objeto es tratado como una matriz. Este
  objeto es de sólo lectura. Esto nunva debería intentarse.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   El nombre de la propiedad.
  <info>string</info>  <strong>$property_value</strong>  El nuevo valor.

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


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Desestablece el valor de la propiedad
  
  Desestablece el valor de la propiedad. Se emplea cuando el objeto es tratado como un array. Este
  objeto es de sólo lectura. Esto nunca debe intentarse.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  El nombre de la propiedad.

<comment>Return:</comment>
  <info>void</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Classname::Method


id: SolrParams
type: class
doc:
<comment>Description:</comment>
  Representa una colección de pares nombre-valor enviado al servidor Solr durante una petición.


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  Esto es un alias de SolrParams::addParam
  
  Esto es un alias de SolrParams::addParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre del parámetro
  <info>string</info>  <strong>$value</strong>  El valor del parámetro

<comment>Return:</comment>
  <info>SolrParams</info>  Devuelve una instancia de SolrParams en caso de éxito


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Añade un parámetro al objeto
  
  Añade un parámetro al objeto. Se usa para parámetros que pueden ser especificados múltiples veces.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nombre del parámetro
  <info>string</info>  <strong>$value</strong>  alor del parámetro

<comment>Return:</comment>
  <info>SolrParams</info>  Devuelve un objeto SolrParam an caso de éxito y <info>false</info> en caso de error.


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  Este es una alias de SolrParams::getParam
  
  Este es una alias de SolrParams::getParam

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  El nombre del parámetro

<comment>Return:</comment>
  <info>mixed</info>  Devuelve una matriz o una cadena, dependiendo del tipo de parámetro


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de un parámetro
  
  Devuelve un parámetro dado con el nombre param_name

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  El nombre del parámetro

<comment>Return:</comment>
  <info>mixed</info>  Devuelve una cadena o una matriz dependiendo del tipo del parámetro


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz de parámetros URL no codificados
  
  Devuelve una matriz de parámetros URL no codificados

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz de parámetros URL no codificados


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz de parámetros URL codificados
  
  Devuelve una matriz de parámetros URL codificados

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz de parámetros URL codificados


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Usado para serialización personalizada
  
  Usado para serialización personalizada

<comment>Return:</comment>
  <info>string</info>  Usado para serialización personalizada


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  Un alas de SolrParams::setParam
  
  Un alas de SolrParams::setParam

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   El nombre del parámetro
  <info>string</info>  <strong>$value</strong>  El valor del parámatro

<comment>Return:</comment>
  <info>void</info>  Devuelve una instancia del objeto SolrParams en caso de éxito


id: SolrParams::setParam
type: function
doc:
<comment>Description:</comment>
  Establece el parámetro al valor especificado
  
  Establece el parámetro de consulta al valor especificado. Es usado para parámetros que sólo pueden
  ser especificados una vez. Subsiguientes llamadas con el mismo parámetro sobrescribirá el valor
  existente.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nomvre del parámetro
  <info>string</info>  <strong>$value</strong>  Valor del parámetro

<comment>Return:</comment>
  <info>SolrParams</info>  Devuelve un objeto SolrParam en caso de éxito y <info>false</info> sobre el valor.


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los parámetros de los pares nombre-valor del objeto
  
  Devuelve todos los parámetros de los pares nombre-valor del objeto.

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Si devolver o no valores de URL codificados

<comment>Return:</comment>
  <info>string</info>  Devuelve un string en caso de éxito y <info>false</info> en caso de fallo.


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Usado para serialización personalizada
  
  Usado para serialización personalizada

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  La representación serializada del objeto

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


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Devuelve la respuesta del servidor
  
  Devuelve la respuesta del servidor. Esto debería estar vacío ya que la petición es una petición
  HEAD.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena vacía.


id: SolrQuery
type: class
doc:
<comment>Description:</comment>
  Representa una colección de pares nombre-valor enviados al servidor Solr durante una petición.


id: SolrQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Se usa para especificar que la faceta debería ordenarse según la cuenta


id: SolrQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Se usa para especificar que la faceta debería ordenarse según el índice


id: SolrQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Se usa para especificar la forma de ordenación debería se ascendente


id: SolrQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Se usa para especificar la forma de ordenación debería se descendente


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

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Consulta de búsqueda opcional

<comment>Return:</comment>
  <info>unknown</info>  Ninguno.


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>
  Mapea a facet.date
  
  Este método permite especificar un campo que debería ser tratado como una faceta.
  
  Se puede usar mútiples veces con diferentes nombres de campos para indicar mútiples campos de
  facetas

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  El nombre del campo de fecha.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve un objeto SolrQuery.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Añade otro parámetro facet.date.other
  
  Establece el parámetro facet.date.other. Acepta la sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           El valor a usar.
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo para la sobrescritura.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Añade otro campo a la faceta
  
  Añade otro campo a la faceta

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Añade una consulta de faceta
  
  Añade una consulta de faceta

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  La consulta de faceta

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Especifica qué campos devolver en el resultado
  
  Este método se usa para especificar un conjunto de campos a devolver, restingiendo así la cantidad
  de información en la respuesta.
  
  Puede ser llamado múltiples veces, una por cada nombre de campo.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Especifica una consulta de filtro
  
  Especifica una consulta de filtro

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  La consulta de filtro

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual.


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>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<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>
  Mapea a hl.fl
  
  Mapea a hl.fl. Se usa para especificar que los trozos resaltados deberían ser generados para un
  campo en particular

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Establece un campo para usarlo para similitud
  
  Mapea a mlt.fl. Especifica que un campo debería ser usado para similitud.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Mapea a mlt.qf
  
  Mapea a mlt.qf. Se usa para especificar campos de consultas y sus boosts

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo
  <info>float</info>   <strong>$boost</strong>  Su valor boost

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Usado para controlar cómo deberían ordenarse los resultados
  
  Usado para controlar cómo deberían ordenarse los resultados.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo
  <info>int</info>     <strong>$order</strong>  La dirección de ordenación. Debería ser SolrQuery::ORDER_ASC o
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Recupera una devolución de subresultados para valores dentro de la faceta dada
  
  Recupera una devolución de subresultados para valores dentro de la faceta dada. Mapea al campo
  stats.facet

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Mapea al parámetro stats.field
  
  Mapea al parámetro stats.field. Este método añade otro parámetro stats.field.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usa el valor de retorno.


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>  Returns whether group expanding is enabled.


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>  Returns the expand filter queries.


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>  Returns the expand query.


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>  Returns the number of rows.


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>  Returns an array of fields.


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet
  
  Devuelve el valor del parámetro facet.

<comment>Return:</comment>
  <info>bool</info>  Devuelve un boolean en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet.date.end
  
  Devuelve el valor del parámetro facet.date.end. Este método acepta una sobrescritura opcional de
  campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los campos de facet.date
  
  Devuelve todos los campos de facet.date

<comment>Return:</comment>
  <info>array</info>  Devuelve todos los campos de facet.date como matriz o <info>null</info> si no se estableció nada


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet.date.gap
  
  Devuelve el valor del parámetro facet.date.gap. Acepta una sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estabelció


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet.date.hardend
  
  Devuelve el valor del parámetro facet.date.hardend. Acepta una sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet.date.other
  
  Devuelve el valor del parámetro facet.date.other. Este método acepta una sobrescritura opcional de
  campos.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>array</info>  Devuelve un <info>array</info> en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Devuelve el límite inferior del primer rango de datos para todas las facetas de fecha de este
  campo
  
  Devuelve el límite inferior del primer rango de datos para todas las facetas de fecha de este
  campo. Acepta una sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los campos facet
  
  Devuelve todos los campos facet

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz de todos los campos y <info>null</info> si no se estableció nada


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de restricciones que deberían ser devueltas por los campos  facet
  
  Devuelve el número máximo de restricciones que deberían ser devueltas por los campos  facet. Este
  método acepta una sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo a sobrescribir.

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del parámetro facet.method
  
  Devuelve el valor del parámetro facet.method. Acepta una sobrescritura opcional de campos.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se establece


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Devuelve el mínimo de facetas que deberían ser incluidas en la respuesta
  
  Devuelve el mínimo de facetas que deberían ser incluidas en la respuesta. Acepta una sobrescritura
  opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Devuelve el estado acutual del parámetro facet.missing
  
  Devuelve el estado acutual del parámetro facet.missing. Acepta una sobrescritura opcional de
  campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Devuelve un índice dentro de la lista de restricciones para ser usado en paginación
  
  Devuelve un índice dentro de la lista de restricciones para ser usado en paginación. Acepta una
  sobrescritura opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo a sobrescribir.

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Devuelve el prefijo de faceta
  
  Devuelve el prefijo de faceta

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Devuelve todas las consultas de facetas
  
  Devuelve todas las consultas de facetas

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Devuelve el tipo de ordenación de la faceta
  
  Devuelve un entero (SolrQuery::FACET_SORT_INDEX o SolrQuery::FACET_SORT_COUNT)

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero (SolrQuery::FACET_SORT_INDEX o SolrQuery::FACET_SORT_COUNT) en caso de
       éxito o <info>null</info> si no se estableció.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Devuelve la lista de campos que serán devueltos en la respuesta
  
  Devuelve la lista de campos que serán devueltos en la respuesta

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Devuelve una matriz de consultas de filtro
  
  Devuelve una matriz de consultas de filtro. Éstas son consultas que se pueden usar para restringir
  el superconjunto de documentos que pueden ser devueltos, sin influenciar en el resutlado

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


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>
  Devuelve el estado del parámtero hl
  
  Devuelve un booleano que indica si habilitar o no la generación de trozos remarcados en la
  respuesta de la consulta.

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Devuelve el campo remarcado para usarlo como copia de seguridad o como predeterminado
  
  Devuelve el campo remarcado para usarlo como copia de seguridad o como predeterminado. Acepta una
  sobrescritura opcional.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los campos que Solr debería generar para remarcación de trozos
  
  Devuelve todos los campos que Solr debería generar para remarcación de trozos

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Devuelve el formateador de la salida remarcada
  
  Devuelve el formateador de la salida remarcada

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Devuelve el generador de trozos de texto para el texto remarcado
  
  Devuelve el generador de trozos de texto para el texto remarcado. Acepta una sobrescritura
  opcional de campos.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de caracteres de fragmentos a considerar para remarcación
  
  Devuelve el número de caracteres de fragmentos a considerar para remarcación. Cero implica que no
  hay fragmentos. Debería usarse el camplo completo.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito o <info>null</info> si no se estableció


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Devuelve si habilitar o no la remarcación de consultas range/wildcard/fuzzy/prefix
  
  Devuelve si habilitar o no la remarcación de consultas range/wildcard/fuzzy/prefix

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de caracteres del campo a devolver
  
  Devuelve el número máximo de caracteres del campo a devolver

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de caracteres de un documento para buscar trozos adecuados
  
  Devuelve el número máximo de caracteres de un documento para buscar trozos adecuados

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Devuelve si colapsar o no fragmentos contiguos en un único fragmento
  
  Devuelve si colapsar o no fragmentos contiguos en un único fragmento. Acepta una sobrescritura
  opcional de campos.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de caracteres de un campo cuando se usa el fragmentador de expresiones
  regulares
  
  Devuelve el número máximo de caracteres de un campo cuando se usa el fragmentador de expresiones
  regulares

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Devuelve la expresión regular para la fragmentación
  
  Devuelve la expresión regular para la fragmentación

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Devuelve el factor de desviación del tamaño de fragmento ideal
  
  Devuelve el factor por el que el fragmentador de expresiones regulares puede desviar desde el
  tamaño de fragmeto ideal para acomodar la expresión regular

<comment>Return:</comment>
  <info>float</info>  Devuelve un doble en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Devuelve si un campo será remarcado solamente si la consulta coincide con este campo en particular
  
  Devuelve si un campo será remarcado solamente si la consulta coincide con este campo en
  particular.

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Devuelve el texto que aparece después de un término remarcado
  
  Devuelve el texto que aparece después de un término remarcado. Acepta una sobrescritura opcional
  de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Devuelve el texto que aparece antes de un término remarcado
  
  Devuelve el texto que aparece antes de un término remarcado. Acepta una sobrescritura opcional de
  campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de trozos remarcados a generar por campo
  
  Devuelve el número máximo de trozos remarcados a generar por campo. Acepta una sobrescritura
  opcional de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Devuelve el estado del parámetro hl.usePhraseHighlighter
  
  Devuelve si usar o no SpanScorer para remarcar términos de frases sólo cuando aparezcan dentro de
  la frase de consulta en el documento.

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Devuelve si los resultados MoreLikeThis deberían o no ser habilitados
  
  Devuelve si los resultados MoreLikeThis deberían o no ser habilitados

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Devuelve si la consulta será impulsada (boost) o no mediante la relevancia del térmido de interés
  
  Devuelve si la consulta será impulsada (boost) o no mediante la relevancia del térmido de interés

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de documentos similares a devolver para cada resultado
  
  Devuelve el número de documentos similares a devolver para cada resultado

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los campos a usar para similitud
  
  Devuelve todos los campos a usar para similitud

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de términos de consultas que serán incluidos en cualquier consulta
  generada
  
  Devuelve el número máximo de términos de consultas que serán incluidos en cualquier consulta
  generada

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de tokens a analizar en cada campo del documento que no esté almacenado
  con soporte TermVector
  
  Devuelve el número máximo de tokens a analizar en cada campo del documento que no esté almacenado
  con soporte TermVector

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Devuelve la longitud máxima de palabra de las palabras que serán ignoradas
  
  Devuelve la longitud máxima de palabra de las palabras que serán ignoradas

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Devuelve el umbral de frecuencia en el que las palabras que no ocurran en por lo menos tantos
  documentos como este serán ignoradas
  
  Devuelve el umbral de frecuencia en el que las palabras que no ocurran en por lo menos tantos
  documentos como este serán ignoradas

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Devuelve la frecuencia bajo la cual los términos serán ignorados en el documento fuente
  
  Devuelve la frecuencia bajo la cual los términos serán ignorados en el documento fuente

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Devuelve la longitud máxima de palabra bajo la cual las palabras serán ignoradas
  
  Devuelve la longitud máxima de palabra bajo la cual las palabras serán ignoradas

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Devuelve los campos de consultas y sus boosts
  
  Devuelve los campos de consultas y sus boosts

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Devuelve la consulta principal
  
  Devuelve la consulta de búsqueda principal

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de documentos
  
  Devuelve el número máximo de documentos del conjunto de resultados completo del cliente para cada
  consulta

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todos los campos de ordenación
  
  Devuelve todos los campos de ordenación

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció ningún parámetro.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice del conjunto de resultados completo
  
  Devuelve el índice del conjunto de resultados completo para las consultas donde el conjunto de
  documentos devueltos debería comenzar.

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Devuelve si están habilitadas o no las estadísticas
  
  Devuelve si están habilitadas o no las estadísticas

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Devuelve todas las estadísticas de las facetas que fueron establecidas
  
  Devuelve todas las estadísticas de las facetas que fueron establecidas

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Devuelve todas las estadísticas de los campos
  
  Devuelve todas las estadísticas de los campos

<comment>Return:</comment>
  <info>array</info>  Devuelve una matriz en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Devuelve si está habilitado o no TermsComponent
  
  Devuelve si está habilitado o no TermsComponent

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Devuelve el campo desde el cuál los términos son recuperados
  
  Devuelve el campo desde el cuál los términos son recuperados

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Devuelve si incluir o no el límite inferior en el conjunto de resultados
  
  Devuelve si incluir o no el límite inferior en el conjunto de resultados

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Devuelve si incluir o no el término de límite superior en el conjunto de resultados
  
  Devuelve si incluir o no el término de límite superior en el conjunto de resultados

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de términos que debería devolver Solr
  
  Devuelve el número máximo de términos que debería devolver Solr

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Devuelve el término en el que comenzar
  
  Devuelve el término en el que comenzar

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Devuelve la frecuencia de documento máxima
  
  Devuelve la frecuencia de documento máxima

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Devuelve la frecuencia de documento mínima a devolver para ser incluido
  
  Devuelve la frecuencia de documento mínima a devolver para ser incluido

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Devuelve el prefijo del término
  
  Devuelve el prefijo por el que los términos coincedentes deben ser restringidos. Restringirá las
  coincidencias sólo de los términos que empiecen con el prefijo

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Si devolver o no caracteres en bruto
  
  Devuelve un booleano indicando si devolver o no caracteres en bruto del término indexado, sin
  tener en cuenta si es legible por humanos

<comment>Return:</comment>
  <info>bool</info>  Devuelve un booleano en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Devuelve un entero indicando cómo son ordenados los términos
  
  SolrQuery::TERMS_SORT_INDEX indica que los términos son devueltos por orden de índice.
  SolrQuery::TERMS_SORT_COUNT implica que los términos son ordenados según la frecuencia del término
  (la más alta cuenta como la primera)

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Devuelve el término en donde parar
  
  Devuelve el término en donde parar

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena en caso de éxito y <info>null</info> si no se estableció.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Devuelve el tiempo en milisegundos permitido para que la consulta finalice
  
  Devuelve el tiempo en milisegundos permitido para que la consulta finalice.

<comment>Return:</comment>
  <info>int</info>  Devuelve un entero en caso de éxito y <info>null</info> si no se estableció.


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>
  Elimina uno de los campos de faceta de fecha
  
  El nombre del campo

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo de fecha a eliminar

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los parámetros facet.date.other
  
  Elimina uno de los parámetros facet.date.other.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           El valor
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los parámetros facet.date
  
  Elimina uno de los parámetros facet.date.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los parámetros facet.query
  
  Elimina uno de los parámetros facet.query.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Elimina un campo de la lista de campos
  
  Elimina un campo de la lista de campos

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Elimina una consulta de filtro
  
  Elimina una consulta de filtro.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  La consulta de filtro a eliminar

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los campos usados para remarcación
  
  Elimina uno de los campos usados para remarcación.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los campos moreLikeThis
  
  Elimina uno de los campos moreLikeThis.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los campos de consulta moreLikeThis
  
  Elimina uno de los campos de consulta moreLikeThis.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  El campo de consulta

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los campos de ordenación
  
  Elimina uno de los campos de ordenación.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los parámetros stats.facet
  
  Elimina uno de los parámetros stats.facet

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Elimina uno de los parámetros stats.field
  
  Elimina uno de los parámetros stats.field

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Conmuta el parámetro echoHandler
  
  Si está establecido a true, Solr coloca los nombres de los gestores usados en la respuesta al
  cliente para propósitos de depuración.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Determina qué tipo de parámetros incluir en la respuesta
  
  Ordena a Solr qué tipos de parámetros de solicitud deberían ser incluidos en la respuesta para
  propósitos de depuración, valores legales incluidos:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  El tipo de parámetros a incluir

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


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>
  Establece el parámetro de consulta común explainOther
  
  Establece el parámetro de consulta común explainOther

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La consulta Lucene para identificar un conjuntos de documentos

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Mapea al parámetro facet. Habilita o deshabilta las facetas
  
  Habilita o deshabilta las facetas.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> habilita las facetas y <info>false</info> las deshabilita.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.date.end
  
  Mapea a facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Véase facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.date.gap
  
  Mapea a facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Véase facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.date.hardend
  
  Mapea a facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           Véase facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.date.start
  
  Mapea a facet.date.start

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Véase facet.date.start
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Establece la frecuencia de documento mínima usada para determinar la cuenta de términos
  
  Establece la frecuencia de documento mínima usada para determinar la cuenta de términos

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           La frecuencia mínima
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.limit
  
  Mapea a facet.limit. Establece el número máximo de restricciones que deberían ser devueltas por
  los campos de facetas.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           El número máximo de restricciones
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Especifica el tipo de algoritmo a usar cuando se hace una faceta a un campo
  
  Especifica el tipo de algoritmo a usar cuando se hace una faceta a un campo. Este método acepta la
  sobrescritura opcional de campos.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          El método a usar.
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.mincount
  
  Establece el mínimo de campos de faceta que deberían ser incluidos en la respuesta

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        El mínimo
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Mapea a facet.missing
  
  Usado para indicar que además de las restricciones basdas en términos de un campo de faceta,
  debería ser computada una cuenta de todos los resultados coincidentes que no tienen valor para el
  campo

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> activa esta característica. <info>false</info> la desactiva.
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Establece el índice de la lista de restricciones para tener en cuenta la paginación
  
  Establece el índice de la lista de restricciones para tener en cuenta la paginación.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          El índice
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Especifica un prefijo de cadena con el que limitar los términos a los que hacer una faceta
  
  Especifica un prefijo de cadena con el que limitar los términos a los que hacer una faceta.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>          La cadena de prefijo
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Determina el orden de las restricciones de campos de faceta
  
  Determina el orden de las restricciones de campos de faceta

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Use SolrQuery::FACET_SORT_INDEX para ordenar por índice o
                           SolrQuery::FACET_SORT_COUNT para ordenar por cuenta.
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


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 <info>true</info>, the result of the first field grouping command is used as the main result list in the
  response, using <return>group.format=simple</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  If <info>true</info>, the result of the first field grouping command is used as the main result
                  list in the response.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<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>
  Habilita o deshabilita la remarcación
  
  Establecerlo a <info>true</info> habilita los trozos remarcados para ser generados en la respuesta de consulta.
  
  Establecerlo a <info>false</info> deshabilita la remarcación

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Habilita o deshabilita la remarcación

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Especifica el campo de copia de seguridad a usar
  
  Si un trozo no se puede generar debido a que no hay términos coincidentes, se puede especificar un
  campo para usarlo como copia de seguridad del sumario predeterminado

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           El nombre del campo de copia de seguridad
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo que se va a sobrescribir.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Especifica un formateador para la salida remarcada
  
  Especifica un formateador para la salida remarcada.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       Actualemte, el único valor legal es "simple"
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Establece el generador de trozos de código para texto remarcado
  
  Especifica un generador de trozos de código para texto remarcado.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      El fragmentador estándar es el hueco. Otra opción son las expresiones
                           regulares, que intentan crear fragmentos que se parecen a ciertas
                           expresiones regulares
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  El tamaño de los fragmentos a considerara para remarcación
  
  Establece el tamaño, en caracteres, de los fragmentos a considerara para remarcación. "0" indica
  que debería usarse el campo completo (sin fragmentación).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            El tamaño, en caracteres, de los fragmentos a considerara para
                           remarcación
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Usa SpanScorer para remarcar términos de frases
  
  Usa SpanScorer para remarcar términos de frases sólo cuando aparecen dentro de la frase de
  consulta del documento.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Si usar o no SpanScorer para remarcar términos de frases sólo cuando aparecen dentro
               de la frase de consulta del documento.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Establece el número máximo de caracteres del campo a devolver
  
  Si SolrQuery::setHighlightAlternateField() se le pasó el valor <info>true</info>, este parámetro especifica el
  número máximo de caracteres del campo a devolver
  
  Cualquier valor menor o igual que 0 significa ilimitado.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     La longitud del campo
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Especifica el número de caracteres de un documento para buscar trozos apropiados
  
  Especifica el número de caracteres de un documento para buscar trozos apropiados

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  El número de caracteres de un documento para buscar trozos apropiados

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Si colapsar o no fragmentos contiguos en un único fragmento
  
  Si colapsar o no fragmentos contiguos en un único fragmento.

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Si colapsar o no fragmentos contiguos en un único fragmento
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Especifica el número máximo de caracteres a analizar
  
  Especifica el número máximo de caracteres a analizar de un campo cuando se usa el fragmentador de
  expresiones regulares

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  El número máximo de caracteres a analizar de un campo cuando se usa el
                          fragmentador de expresiones regulares

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Especifica la expresión regular para la fragmentación
  
  Especifica la expresión regular para la fragmentación. Esto podría usarse para extraer sentencias

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  La expresión regular para la fragmentación. Esto podría usarse para extraer
                  sentencias

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Establece el factor por el cual el fragmentador de expresiones regulares puede desviarse del
  tamaño
  de fragmento ideal
  
  El factor por el cual el fragmentador de expresiones regulares puede desviarse del tamaño de
  fragmento ideal (especificado por SolrQuery::setHighlightFragsize) para acomodar la expresión
  regular

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  El factor por el cual el fragmentador de expresiones regulares puede desviarse del
                  tamaño de fragmento ideal

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual si se usó el valor de retorno.


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Requerir la coincicencia de campos durante el remarcado
  
  Si es <info>true</info>, un campo sólo será remarcado si la consulta coincide con este campo en particular.
  
  Esto sólo funciona si SolrQuery::setHighlightUsePhraseHighlighter() se estableció a <info>true</info>

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Establece el texto que aparece antes de un término remarcado
  
  Establece el texto que aparece después de un término remarcado

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Establece el texto que aparece después de un término remarcado
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Establece el texto que aparece antes de un término remarcado
  
  Establece el texto que aparece antes de un término remarcado.
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       El texto que aparece antes de un término remarcado
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Establece el número máximo de trozos remarcados para generar por campo
  
  Establece el número máximo de trozos remarcados para generar por campo

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           El número máximo de trozos remarcados para generar por campo
  <info>string</info>  <strong>$field_override</strong>  El nombre del campo.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Si remarcar o no términos de frases sólo cuando aparecen en la frase de consulta
  
  Establece si usar o no SpanScorer para remarcar o no términos de frases sólo cuando aparecen en la
  frase de consulta del documento

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Si usar o no SpanScorer para remarcar o no términos de frases sólo cuando aparecen en la
            frase de consulta del documento

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Habilita o deshabilita moreLikeThis
  
  Habilita o deshabilita moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> lo habilita y <info>false</info> lo desactiva.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Establecer si la consulta será impulsada (boost) por la relevancia del término de interés
  
  Establecer si la consulta será impulsada (boost) por la relevancia del término de interés

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Establece a <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Establece el número de documentos similares a devolver en cada resultado
  
  Establece el número de documentos similares a devolver en cada resultado

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  El número de documentos similares a devolver en cada resultado

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Establece el número máximo de términos de consulta incluidos
  
  Establece el número máximo de términos de consulta que serán incluidos en cualquier consulta
  generada.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  El número máximo de términos de consulta que serán incluidos en cualquier consulta
               generada

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Especifica el número máximo de tokens a analizar
  
  Especifica el número máximo de tokens a analizar en cada campo de documento de ejemplo que no esté
  almacenado con soporte TermVector.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  El número máximo de tokens a analizar

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Establece la longitud de palabra máxima
  
  Establece la longitud de palabra máxima sobre la que las palabras serán ignoradas.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  La longitud de palabra máxima sobre la que las palabras serán ignoradas

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Establece la frecuencia de mltMinDoc
  
  La frecuencia en la que las palabras que no ocurran en por lo menos tantos documentos como este
  serán ignoradas.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  Establece la frecuencia en la que las palabras que no ocurran en por lo
                         menos tantos documentos como este serán ignoradas.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Establece la frecuencia bajo la cual los términos serán ignorados en los documentos fuente
  
  Establece la frecuencia bajo la cual los términos serán ignorados en los documentos fuente

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  La frecuencia bajo la cual los términos serán ignorados en los documentos
                          fuente

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Establece la longitud de palabra mínima
  
  Establece la longitud de palabra mínima bajo la cual las palabras serán ignoradas.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  La longitud de palabra mínima bajo la cual las palabras serán ignoradas.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Excluye la cabecera de los resultados devueltos
  
  Excluye la cabecera de los resultados devueltos.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> excluye la cabecera del resultado

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Establece la consulta de búsqueda
  
  Establece la consulta de búsqueda.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La consulta de búsqueda

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Especifica el número máximo de filas a devolver en el resultado
  
  Especifica el número máximo de filas a devolver en el resultado

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  El número máximo de filas a devolver

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Bandera para mostrar información de depuración
  
  Si mostrar o no información de depuración

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Si mostrar o no información de depuración. <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Especifica el número de filas que se van a saltar
  
  Especifica el número de filas que se van a saltar. Útil en paginación de resultados.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  El número de filas a saltar.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Habilita o deshablita el componente de estadísticas
  
  Habilita o deshablita el componente de estadísticas.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> habilita el componente de estadísticas y <info>false</info> lo deshabilita.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Habilita o deshablita TermsComponent
  
  Habilita o deshablita TermsComponent

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> lo habilita. <info>false</info> lo desactiva

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Establece el nombre del campo del que obtener los términos
  
  Establece el nombre del campo del que obtener los términos

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  El nombre del campo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Incluir el término de límite inferior en el conjunto de resultados
  
  Incluir el término de límite inferior en el conjunto de resultados.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Incluir el término de límite inferior en el conjunto de resultados

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Incluir el término de límite superior en el conjunto de resultados
  
  Incluir el término de límite superior en el conjunto de resultados.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Establece el número máximo de términos a devolver
  
  Establece el número máximo de términos a devolver

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  El número máximo de términos a devolver. Si el límite es negativo se devolverán todos
               los términos.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Especifica el término de donde empezar
  
  Especifica el término de donde empezar

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  El término límite inferior

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Establece la frecuencia máxima de documentos
  
  Establece la frecuencia máxima de documentos.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  La frecuencia máxima de documentos.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Establece la frecuencia mínima de documentos
  
  Establece la frecuencia mínima de documentos a devolver para ser incluidos

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  La frecuencia mínima

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restringe las coincidencias de términos que comienzan con el prefijo
  
  Restringe las coincidencias de términos que comienzan con el prefijo

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Restringe las coincidencias de términos que comienzan con el prefijo

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Devuelve los caracteres en bruto del término indexado
  
  Si es true, devuelve los caracteres en bruto del término indexado, sin tener en cuenta si es
  legible por humanos.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> o <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Especifica cómo ordenar los términos devueltos
  
  Si se usa SolrQuery::TERMS_SORT_COUNT, ordena los términos según la frecuencia del término (la
  mayor primero). Si se usa SolrQuery::TERMS_SORT_INDEX, devuelve los términos ordenados por índice

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX o SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Establece el término en el que parar
  
  Establece el término en el que parar

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  El término en el que parar

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  El tiempo permitido para que la búsqueda finalice
  
  El tiempo permitido para que la búsqueda finalice. Este valor sólo se aplica a la búsqueda y no a
  las solicitudes en general. Se mide en milisegundos. Los valores menores o iguales a cero implican
  la no restricción de tiempo. Se pueden devolver resultados parciales, si los hubiera.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  El tiempo permitido para que la búsqueda finalice.

<comment>Return:</comment>
  <info>SolrQuery</info>  Devuelve el objeto SolrQuery actual, si se usó el valor de retorno.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Devuelve la respueste XML como información de PHP serializada
  
  Devuelve la respueste XML como información de PHP serializada

<comment>Return:</comment>
  <info>string</info>  Devuelve la respueste XML como información de PHP serializada


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Devuelve el estado HTTP de la respuesta
  
  Devuelve el estado HTTP de la respuesta.

<comment>Return:</comment>
  <info>int</info>  Devuelve el estado HTTP de la respuesta.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Devuelve más detalles del estado HTTP
  
  Devuelve más detalles del estado HTTP.

<comment>Return:</comment>
  <info>string</info>  Devuelve más detalles del estado HTTP


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Devuelve la respuesta en bruto enviada al servidor Solr
  
  Devuelve la respuesta en bruto enviada al servidor Solr.

<comment>Return:</comment>
  <info>string</info>  Devuelve la respuesta en bruto enviada al servidor Solr


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr
  
  Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr,

<comment>Return:</comment>
  <info>string</info>  Devuelve las cabeceras de respuesta sin tratar enviadas al servidor Solr


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Devuelve la respuesta sin tratar del servidor
  
  Devuelve la respuesta sin tratar del servidor.

<comment>Return:</comment>
  <info>string</info>  Devuelve la respuesta sin tratar del servidor.


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Devuelve las cabeceras de respuesta sin tratar del servidor
  
  Devuelve las cabeceras de respuesta sin tratar del servidor.

<comment>Return:</comment>
  <info>string</info>  Devuelve las cabeceras de respuesta sin tratar del servidor.


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Devuelve la URL completa a la que se envió la respuesta
  
  Devuelve la URL completa a la que se envió la respuesta.

<comment>Return:</comment>
  <info>string</info>  Devuelve la URL completa a la que se envió la respuesta


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Devuelve un objeto SolrObject que representa la respuesta XML del servidor
  
  Devuelve un objeto SolrObject que representa la respuesta XML del servidor.

<comment>Return:</comment>
  <info>SolrObject</info>  Devuelve un objeto SolrObject que representa la respuesta XML del servidor


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Establece el modo de análisis
  
  Establece el modo de análisis.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC analiza los documentos en instancias de
                     SolrDocument. SolrResponse::PARSE_SOLR_OBJ convierte un documento a un objeto
                     SolrObjects.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  ¿Tuvo éxito la petición?
  
  Se usa para verificar si la petición al servidor tuvo éxito.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si se tuvo éxito y <info>false</info> si no lo tuvo.


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  Una excepción lanzada cuando hay un error producido por el propio servidor Solr.


id: SolrServerException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Devuelve información interna de dónde fue lanzada la excepción
  
  Devuelve información interna de dónde fue lanzada la excepción.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene información interna de dónde se lanzó la excepción.
         Utilizado solamente con propósitos de depuración para desarrolladores de extensiones.


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Contiene métodos de utilidad para recuperar la versión de la extensión actual y preparar frases de
  consultas.
  
  También contiene métodos para escapar cadenas de consultas y analizar respuestas XML.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Convierte una cadena de respuesta XML a un objeto SolrObject
  
  Este método convierte una cadena de respuesta XML del servidor Apache Solr a un objeto SolrObject.
  Lanza una excepción SolrException si hubo un error.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  La cadena de respuesta XML del servidor Solr.
  <info>int</info>     <strong>$parse_mode</strong>   Use SolrResponse::PARSE_SOLR_OBJ o SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Devuelve el objeto SolrObject que representa la respuesta XML.
              
              Si el parámetro parse_mode setá establecido a SolrResponse::PARSE_SOLR_OBJ Solr los
              documentos serán analizados como instancias de SolrObject.
              
              si está establecido a SolrResponse::PARSE_SOLR_DOC, serán analizados como instancias
              de SolrDocument.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Escapa un string de consulta lucene
  
  Lucene soporta el escape de caracteres especiales que son parte de la sintaxis de la consulta.
  
  La lista actual de caracteres especiales es:
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  Este es el string de consulta a ser escapda.

<comment>Return:</comment>
  <info>string</info>  Devuelve el string escapado  o <info>false</info> en caso de error.


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Devuelve la versión actual de la extensión Solr
  
  Devuelve la versión actual de Solr.

<comment>Return:</comment>
  <info>string</info>  La versión actual de la extensión Apache Solr.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prepara una frase desde una cadena lucene sin escapar
  
  Prepara una frase desde una cadena lucene sin escapar.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  La frase lucene.

<comment>Return:</comment>
  <info>string</info>  Devuelve la frase entre comillas dobles.


id: SplDoublyLinkedList
type: class
doc:
<comment>Description:</comment>
  La clase SplDoublyLinkedList proporciona las principales funcionalidades de una lista doblemente
  enlazada.


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  La lista será iterada en un orden de entrada y salida, como una cola.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  La lista será iterada en un orden de última entrada, primera salida, como una pila.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Añadir/insertar un nuevo valor en el índice especificado
  
  Inserta el valor dado por <strong>$value</strong> en el índice especificado por <strong>$index</strong>, reorganizando el valor
  anterior a ese índice (y todos los valores subsiguientes) a través de la lista.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  El índice donde insertar el nuevo valor.
  <info>mixed</info>  <strong>$value</strong>  El nuevo valor para <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Examinar el nodo del comienzo de la lista doblemente enlazada

<comment>Return:</comment>
  <info>mixed</info>  El valor de el primer nodo.


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Cuenta el número de elementos de la lista doblemente enlazada

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de elementos de la lista doblemente enlazada.


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  Devuelve la entrada actual del array
  
  Obtiene el nodo actual de la lista doblemente enlazada.

<comment>Return:</comment>
  <info>mixed</info>  El valor del nodo actual.


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Devuelve el modo de iteración

<comment>Return:</comment>
  <info>int</info>  Devuelve los diferentes modos y banderas que afectan la iteración.


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  Comprueba si la lista doblemente enlazada está vacía

<comment>Return:</comment>
  <info>bool</info>  Devuelve si la lista doblemente enlazada está vacía.


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice del nodo actual
  
  Esta función devuelve el índice del nodo actual.

<comment>Return:</comment>
  <info>int</info>  El índice del nodo actual.


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  Avanza a la siguiente entrada
  
  Mueve el iterador al siguiente nodo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  Devuelve si el índice solicitado existe

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice a comprobar.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el índice <strong>$index</strong> solicitado existe, <info>false</info> en caso contrario.


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor del índice específicado

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice con el valor.

<comment>Return:</comment>
  <info>mixed</info>  El valor específicado en <strong>$index</strong>.


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  Establece el valor del índice específicado
  
  Establece el valor del índice dado por <strong>$index</strong> al valor especificado por <strong>$value</strong>.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  El índice a establer. Si <info>null</info>, el siguiente valor se añadirá después del último
                    elemento.
  <info>mixed</info>     <strong>$value</strong>  El nuevo valor para <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Borra el valor de el índice específicado
  
  Borra el valor del índice específicado.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice a borrar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Extrae un nodo del final de la lista doblementa enlazada

<comment>Return:</comment>
  <info>mixed</info>  El valor del nodo a extraer.


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Retrocede a la entrada anterior
  
  Mueve el iterador al nodo anterior.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  Inserta un elemento al final de la lista doblemente enlazada
  
  Inserta el valor dado por <strong>$value</strong> al final de la lista doblemente enlazada.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor a insertar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador hasta el inicio
  
  Rebobina el iterador hasta el inicio.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::serialize
type: function
doc:
<comment>Description:</comment>
  Serializa el almacenamiento
  
  Serializa el almacenamiento.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>string</info>  El string serializado.

<comment>See Also:</comment>
   * SplDoublyLinkedList::unserialize


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Establece el modo de iteración

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Hay dos conjuntos ortogonales de los modos que se pueden establecer:
              
              La dirección de la iteración (ya sea uno o el otro):
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (Estilo de pila)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (Estilo de cola)
              
              El comportamiento del iterador (ya sea uno o el otro):
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (Los elementos son eliminados por el iterador)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (Los elementos son recorridos por el iterador)
              
              El modo predeterminado es: <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info>
              
              La dirección de iteración no se puede cambiar para las clases <class>SplStack</class> y <class>SplQueue</class>,
              siempre es <info>SplDoublyLinkedList::IT_MODE_FIFO</info>. Si se intenta modificar, se producirá
              una <class>RuntimeException</class>.

<comment>Return:</comment>
  <info>int</info>  Devuelve los diferentes modos y banderas que afectan a la iteración.


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  Quita un nodo del inicio de la lista doblemente enlazada

<comment>Return:</comment>
  <info>mixed</info>  El valor del nodo a quitar.


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Examina el nodo del final de la lista doblemente enlazada

<comment>Return:</comment>
  <info>mixed</info>  El valor del último nodo.


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializa el almacenamiento
  
  Deserializa el almacenamiento, desde SplDoublyLinkedList::serialize.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Es string serializada.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplDoublyLinkedList::serialize


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Antepone un elemento a la lista doblemente enlazada
  
  Antepone el valor dado por <strong>$value</strong> al inicio de la lista doblemente enlazada.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor a anteponer.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si la lista doblemente enlazada contiene más nodos
  
  Comprueba si la lista doblemente enlazada contiene más nodos.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la lista doblemente enlazada contiene más nodos, o <info>false</info> en caso contrario.


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  La clase SplFileInfo ofrece un interfaz de alto nivel orientado a objetos para la información de
  un fichero individual.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un objeto nuevo SplFileInfo
  
  Crea un nuevo objeto para el SplFileInfo nombre_archivo especificado. El fichero no tiene por qué
  existir, o ser de lectura.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Ruta del fichero.


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  Devuelve la ruta de el fichero como un string
  
  Este método retornará el nombre de fichero de el fichero referenciado.

<comment>Return:</comment>
  <info>string</info>  Devuelve la ruta a el fichero.


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  Obtiene la hora del último acceso al fichero
  
  Obtiene la hora del último acceso al fichero.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve el tiempo del ultimo acceso al fichero en caso de éxito, o <info>false</info> en caso de
             error.

<comment>See Also:</comment>
   * <strong>fileatime()</strong>
   * SplFileInfo::getCTime
   * SplFileInfo::getMTime


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  Obtiene el nombre base del fichero
  
  Este método devuelve el nombre base del fichero, directorio o enlace sin informacion de la ruta de
  acceso.
  
  <strong>SplFileInfo::getBasename()</strong> es consciente de la configuración regional, por lo que para que vea el
  nombre base correcto con rutas de caracteres multibyte, la configuración regional correspondiente
  debe con la función <strong>setlocale()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Sufijo opcional para omitir el nombre de la base devuelta.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre de la base, sin información de la ruta de acceso.

<comment>See Also:</comment>
   * SplFileInfo::getFilename


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  Obtiene el i-nodo de el cambio de tiempo
  
  Devuelve el i-nodo de el cambio de tiempo para el fichero. El tiempo es retornado en formato Unix
  timestamp.

<comment>Return:</comment>
  <info>int|false</info>  El último cambio del tiempo, en formato Unix timestamp en caso de éxito, o <info>false</info> en
             caso de error.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Obtiene la extensión del fichero
  
  Devuelve la extensión del fichero.

<comment>Return:</comment>
  <info>string</info>  Devuelve un <info>string</info>  que contiene la extensión del fichero, o un vacío <info>string</info> si el archivo
          no tiene extensión.

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Obtiene un objeto SplFileInfo para el fichero
  
  Este método obtiene un objeto <class>SplFileInfo</class> para el fichero de referencia.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Nombre de una clase <class>SplFileInfo</class> derivada de su uso.

<comment>Return:</comment>
  <info>SplFileInfo</info>  Un objeto <class>SplFileInfo</class> creado para el fichero.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Obtiene el nombre del fichero
  
  Obtiene el nombre del fichero sin ningún tipo de información de la ruta de acceso.

<comment>Return:</comment>
  <info>string</info>  El nombre del fichero.

<comment>See Also:</comment>
   * SplFileInfo::getBasename


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  Obtiene el grupo de el fichero
  
  Obtiene el grupo del fichero. El ID del grupo es retornado en formato numérico.

<comment>Return:</comment>
  <info>int|false</info>  El ID del grupo en formato numérico en caso de éxito, o <info>false</info> en caso de error.

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


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Obtiene el i-nodo de el fichero
  
  Obtiene el número de i-nodo de el objeto filesystem.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve el número de i-nodo de el objeto filesystem en caso de éxito, o <info>false</info> en caso
             de error.

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Obtiene el destino de un enlace del sistema de ficheros
  
  Obtiene el destino de un enlace del sistema de ficheros.
  
  El destino no puede ser una ruta real en el sistema de ficheros. Use SplFileInfo::getRealPath para
  determinar la ruta verdadera en el sistema de fucheros.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve el destino de el enlace del sistema de ficheros en caso de éxito, o <info>false</info>
                en caso de error.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  Obtiene la fecha de la última modificación
  
  Devuelve el tiempo cuando el contenido de el fichero ha sido cambiado. El tiempo retornado en
  formato Unix timestamp.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve la fecha de modificación de el fichero, en formato Unix timestamp en caso de
             éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  Obtiene el dueño de el fichero
  
  Obtiene el dueño de el fichero. El ID del dueño retornado en formato numérico.

<comment>Return:</comment>
  <info>int|false</info>  El id del dueño en formato numérico en caso de éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  Obtiene la ruta sin el nombre de fichero
  
  Devuelve la ruta de el fichero, omitiendo el nombre del fichero y cualquier barra.

<comment>Return:</comment>
  <info>string</info>  Devuelve la ruta a el fichero.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Obtiene un objeto SplFileInfo para la ruta
  
  Obtiene un objeto <class>SplFileInfo</class> para el padre de el fichero actual.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Nombre de una clase <class>SplFileInfo</class> derivada a usar, o ella misma si <info>null</info>.

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  Devuelve un objeto <class>SplFileInfo</class> para la ruta padre de el fichero en caso de
                    éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Obtiene la ruta de un fichero
  
  Devuelve la ruta de el fichero.

<comment>Return:</comment>
  <info>string</info>  la ruta de el fichero.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Obtiene los permisos del fichero
  
  Obtiene los permisos del fichero.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve los permisos de el fichero en caso de éxito, o <info>false</info> en caso de error.


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  Obtiene la ruta absoluta al fichero
  
  Este método expande todos los enlaces simbólicos, resuelve las referencias relativas y retorna la
  ruta real al fichero.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve la ruta al fichero, o <info>false</info> si el fichero no existe.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Obtiene el tamaño de el fichero
  
  Devuelve el tamaño de el fichero en bytes para el fichero referenciado.

<comment>Return:</comment>
  <info>int|false</info>  El tamaño del fichero en bytes en caso de éxito, o <info>false</info> en caso de error.

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


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  Obtiene el tipo del fichero
  
  Devuelve el tipo de el fichero referenciado.

<comment>Return:</comment>
  <info>string|false</info>  Un <info>string</info> representando el tipo de la entrada. Puede ser <return>file</return>, <return>link</return>, <return>dir</return>, <return>block</return>,
                <return>fifo</return>, <return>char</return>, <return>socket</return>, o <return>unknown</return>, o <info>false</info> en caso de error.


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Dice si el fichero es un directorio
  
  Este método puede ser usado para determinar si el fichero es un directorio.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si es un directorio, <info>false</info> en caso contrario.


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Comprueba si el fichero es ejecutable
  
  Comprueba si el fichero es ejecutable.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si es ejecutable, en caso contrario <info>false</info>.


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Dice is el objeto hace referencia a un fichero normal
  
  Comprueba si el fichero que el objecto SplFileInfo hace referencia existe es un fichero regular.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el fichero existe y si es un fichero normal (no un enlace), <info>false</info> en caso
        contrario.


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  Comprueba si el fichero es un link
  
  Use este método para comprobar si el fichero referenciado por el objeto SplFileInfo es un link.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el fichero es un link, en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  Comprueba si el fichero se puede leer
  
  Comprueba si el fichero se puede leer.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si se puede leer, en caso contrario <info>false</info>.


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  Comprueba si se puede escribir en el fichero
  
  Comprueba si se puede escribir en el fichero actual.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si se puede escribir, en caso contrario <info>false</info>;


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Obtiene un objeto SplFileObject para el fichero
  
  Crea un <info>object</info> <class>SplFileObject</class> de el fichero. Esto es útil porque <class>SplFileObject</class> contiene otros
  métodos para manipular el fichero mientras que <class>SplFileInfo</class> sólo es útil para obtener información,
  por ejemplo si el fichero tiene permisos de escritura.

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            El modo para abrir el fichero. Véase la documentación de <strong>fopen()</strong>
                                  para una descripción de los posibles modos. Por omisión es de sólo
                                  lectura.
  <info>bool</info>           <strong>$useIncludePath</strong>  Cuando está definido a <info>true</info>, el fichero también es buscado
                                  dentro de include_path
  <info>resource|null</info>  <strong>$context</strong>         Se refiere a context
                                  sección del manual para una descripción de <return>contexts</return>.

<comment>Return:</comment>
  <info>SplFileObject</info>  El fichero abierto como un <info>objeto</info> <class>SplFileObject</class>.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * <strong>stream_context_create()</strong>
   * <strong>fopen()</strong>


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Establece la clase empleada con SplFileInfo::openFile
  
  Este método se emplea para establecer una clase propia que será utilizada cuando se invoque a
  SplFileInfo::openFile. El nombre de la clase pasado a este método debe ser <class>SplFileObject</class> o una
  clase derivada de <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  El nombre de la clase a emplear cuando se invoca a SplFileInfo::openFile.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileInfo::openFile


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  Establece la clase empleada con SplFileInfo::getFileInfo y SplFileInfo::getPathInfo
  
  Este método se emplea para establecer una clase propia que será utilizada cuando se invoque a
  SplFileInfo::getFileInfo y SplFileInfo::getPathInfo. El nombre de la clase pasado a este método
  debe ser <class>SplFileInfo</class> o una clase derivada de <class>SplFileInfo</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  El nombre de la clase a emplear cuando se invoca a SplFileInfo::getFileInfo y
                  SplFileInfo::getPathInfo.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileInfo::getFileInfo


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  La clase SplFileObject ofrece una interfaz orientada a objetos para un fichero.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Saltar líneas vacías en el fichero. Esto requiere que la bandera <info>READ_AHEAD</info> esté activada para que
  funcione como se tenía previsto.


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo objeto de fichero
  
  Construye un nuevo objeto de fichero.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        El fichero a leer.
                                  
                                  Se puede emplear un URL como
                                  nombre de fichero con esta función si las envolturas de fopen han
                                  sido activadas.
                                  Véase <strong>fopen()</strong> para más información de cómo especificar el nombre
                                  de fichero. Véanse las ; continen enlaces con información
                                  sobre las diferentes capacidades que tienen las envolturas, notas
                                  sobre su empleo,
                                  e información de cualquier variable predefinida que podría
                                  proporcionarse.
  <info>string</info>         <strong>$mode</strong>            El modo en el que abrir el fichero. Véase <strong>fopen()</strong> para una lista
                                  de los modos permitidos.
  <info>bool</info>           <strong>$useIncludePath</strong>  Si se va a buscar <strong>$filename</strong> en el include_path.
  <info>resource|null</info>  <strong>$context</strong>         Un contexto válido creado con <strong>stream_context_create()</strong>.

<comment>See Also:</comment>
   * SplFileInfo::openFile
   * <strong>fopen()</strong>


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Alias de SplFileObject::fgets
  
  Este método es un alias de:  SplFileObject::fgets.


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Recupera la línea actual del fichero
  
  Recupera la línea actual del fichero.

<comment>Return:</comment>
  <info>string|array|false</info>  Recupera la línea actual del fichero. Si la flag <info>SplFileObject::READ_CSV</info> está
                      establecida, este método devuelve un array conteniendo la línea actual
                      analizada como datos CSV. Si se alcanza el final del archivo, se devuelve
                      <info>false</info>.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Comprueba si es el final del fichero
  
  Determina si el final de el fichero ha sido alcanzado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si es el final de el fichero, en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Vuelca el resultado en el fichero
  
  Fuerza a escribir en todo el búfer de salida al fichero.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * SplFileObject::fwrite


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Obtiene un caracter del fichero
  
  Obtiene un caracter del fichero.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve un string conteniendo un solo caracter leído de el fichero o <info>false</info> si es el
                final del fichero.
                
                Esta función puede
                devolver el valor booleano <info>false</info>, pero también puede devolver un valor no booleano
                que se
                evalúa como <info>false</info>. Por favor lea la sección sobre Booleanos para más
                información. Use el operador
                === para comprobar el valor devuelto por esta
                función.

<comment>See Also:</comment>
   * SplFileObject::fgets


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Obtiene la línea del archivo y analiza como campos CSV
  
  Obtiene una línea del archivo que está en formato CSV y devuelve un array que contiene los campos
  leídos.
  
  Esta función tiene en cuenta los ajustes de localización. Si <return>LC_CTYPE</return> es p.e. <return>en_US.UTF-8</return>, los
  archivos en codificaciones de un byte pueden ser leídos erróneamente por esta función.

<comment>Param:</comment>
  <info></info>        <strong>$delimiter</strong>  El delimitador de campo (un solo carácter). El valor por defecto es una coma o
                      el valor establecido usando SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  El carácter circundante de cada campo (sólo un carácter). Por omisión, son
                      comillas dobles o el valor establecido por SplFileObject::setCsvControl.
  <info>string</info>  <strong>$escape</strong>     El carácter de escape (a lo sumo un carácter). Por defecto es una barra
                      invertida (<return>\</return>) o el valor establecido usando SplFileObject::setCsvControl. Un
                      string vacío (<return>""</return>) desactiva el mecanismo de escape propio.
                      
                      Normalmente un carácter <strong>$enclosure</strong> se escapa dentro de un campo duplicándolo;
                      sin embargo, el carácter <strong>$escape</strong> puede ser usado como una alternativa. Así que
                      para los valores de parámetros por defecto <return>""</return> y <return>\"</return> tienen el mismo
                      significado. Aparte de permitir espacar el carácter <strong>$enclosure</strong> el carácter
                      <strong>$escape</strong> no tiene un significado especial; ni siquiera está destinado a escapar
                      de sí mismo.

<comment>Return:</comment>
  <info>array|false</info>  Devuelve un array indexado que contiene los campos que se leen, o <info>false</info> en caso de
               error.
               
               Una línea en blanco en un archivo CSV será devuelto como un array que comprende un
               único <info>null</info> a menos que se utilice <info>SplFileObject::SKIP_EMPTY |
               SplFileObject::DROP_NEW_LINE</info>, en cuyo caso se saltan las líneas vacías.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Obtener la línea de el fichero
  
  Obtener la línea de el fichero.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string conteniendo la siguiente línea de el fichero.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Obtiene la línea de el fichero y elimina etiquetas HTML
  
  Idéntico a SplFileObject::fgets, excepto que SplFileObject::fgetss intenta eliminar las etiquetas
  HTML y PHP de el texto que se lee. La función mantiene el estado de análisis sintáctico de llamada
  a llamada, y como tal no es equivalente a la llamada <strong>strip_tags()</strong> sobre el valor de retorno de
  SplFileObject::fgets.

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  Parámetro opcional para especificar etiquetas que no deben ser
                           eliminadas.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string conteniendo la siguiente línea de el fichero con el código HTML y PHP
          eliminado, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * El filtro string.strip_tags


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Bloqueo de ficheros portable
  
  Bloquea o desbloquea el fichero de la misma manera portable que <strong>flock()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>   <strong>$operation</strong> es una operación de las siguientes: <info>LOCK_SH</info> para adquirir un bloqueo
                    compartido (lectura). <info>LOCK_EX</info> para adquirir un bloqueo exclusivo (escritura).
                    <info>LOCK_UN</info> para liberar un bloqueo (compartido o exclusivo).
                    
                    <info>LOCK_SH</info> para adquirir un bloqueo compartido (lectura).
                    
                    <info>LOCK_EX</info> para adquirir un bloqueo exclusivo (escritura).
                    
                    <info>LOCK_UN</info> para liberar un bloqueo (compartido o exclusivo).
                    
                    También es posible añadir <info>LOCK_NB</info> como máscara de bits a una de las operaciones
                    anteriores, si <strong>flock()</strong> no debe bloquearse durante el intento de bloqueo.
  <info>int</info>  <strong>$wouldBlock</strong>  Establecer a <info>true</info> si el bloqueo hará que la función quede esperando (condición
                    de errno EWOULDBLOCK).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  Imprimir todos los datos restantes en un apuntador de fichero
  
  Lee hasta el final en el puntero de el fichero dado de la posición actual y escribe el resultado a
  el búfer de salida.
  
  Puede que se necesite llamar a SplFileObject::rewind You may need to call SplFileObject::rewind
  para reiniciar el puntero del fichero al inicio de el fichero si se tiene datos escritos en el
  fichero.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de caracteres leídos del <strong>$handle</strong> y pasados a través de la salida.

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Escribir un array de campos como una línea CSV
  
  Escribe el array <strong>$fields</strong> en el fichero como una línea CVS.

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     Un array de valores.
  <info>string</info>  <strong>$delimiter</strong>  El parámetro opcional <strong>$delimiter</strong> establece el delimitador de campos (sólo un
                      carácter).
  <info>string</info>  <strong>$enclosure</strong>  El parámetro opcional <strong>$enclosure</strong> establece el carácter circundante de cada
                      campo (sólo un carácter).
  <info>string</info>  <strong>$escape</strong>     El parámetro opcional <strong>$escape</strong> establece el carácter de escape (solamente un
                      carácter).

<comment>Return:</comment>
  <info>int</info>  Devuelve la longitud del string escrito  o <info>false</info> en caso de error.
       
       Devuelve <info>false</info>, y no escribe la línea CVS en el fichero, si el parámetro <strong>$delimiter</strong> o
       <strong>$enclosure</strong> no es un único carácter.

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


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Leer un fichero
  
  Lee de un fichero el número de bytes dado.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  El número de bytes a leer.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve el string léido desde el fichero  o <info>false</info> en caso de error.

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Analiza la entrada de un fichero de acuerdo a un formato
  
  Lee una línea de el fichero e interpreta este de acuerdo a el <strong>$format</strong>.
  
  Cualquier espacio en blanco en el <strong>$format</strong> string coincide con cualquier espacio en blanco en la
  línea de el fichero. Esto significa que incluso un (<return>\t</return>) en el formato string puede coincidir con
  un sólo caracter de espacio en la secuencia de entrada.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  The interpreted format for <strong>$string</strong>, which is described in the documentation for
                   <strong>sprintf()</strong> with following differences:  Function is not locale-aware. <return>F</return>, <return>g</return>, <return>G</return> and
                   <return>b</return> are not supported. <return>D</return> stands for decimal number. <return>i</return> stands for integer with base
                   detection. <return>n</return> stands for number of characters processed so far. <return>s</return> stops reading at
                   any whitespace character. <return>*</return> instead of <return>argnum$</return> suppresses the assignment of this
                   conversion specification.
  <info>mixed</info>   <strong>$vars</strong>    Los valores opcionales asignados.

<comment>Return:</comment>
  <info>array|int|null</info>  Si sólo se pasa un parámetro a este método, los valores analizados serán devueltos
                  como un array. De lo contrario, si se paran los parámetros opcionales, la función
                  devolverá el número de valores asignados. Los parámetros opcionales deben ser
                  pasados por referencia.

<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>
  Busca una posiciónn
  
  Mueve el puntero interno a una posición en el fichero medido en bytes desde el principio de el
  fichero obtenido, añadiendo <strong>$offset</strong> a la posición especificada por <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  El índice. Un valor negativo puede ser utilizado para mover hacía atrás por el
                fichero que será útil cuando SEEK_END es usado como un valor de <strong>$whence</strong>.
  <info>int</info>  <strong>$whence</strong>  Los valores de <strong>$whence</strong> son: <info>SEEK_SET</info> - Establece la posición igual a <strong>$offset</strong>
                bytes.<info>SEEK_CUR</info> - Establece la posición a la ubicación actual más <strong>$offset</strong>.<info>SEEK_END</info> -
                Establece la posición al final de el fichero más <strong>$offset</strong>.
                
                Si no se especifica <strong>$whence</strong>, se supone que es <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Devuelve 0 si la búsqueda fué exitosa, -1 en caso contrario. Tenga en cuenta que buscando un
       EOF pasado no se considera como un error.

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Obtiene información de el fichero
  
  Obtiene estadísticas de el fichero. Se comporta de forma idéntica a <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array con las estadísticas de el fichero; el formato de el array es descrito en
         detalle en la página del manual de <strong>stat()</strong>.

<comment>See Also:</comment>
   * <strong>fstat()</strong>
   * <strong>stat()</strong>


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  Devuelve la posición del fichero actual
  
  Devuelve la posición de el puntero de fichero que representa el índice actual en el flujo del
  fichero.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve la posición de el puntero de fichero como un integer, o <info>false</info> en caso de
             error.

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Trunca el archivo a una longitud dada
  
  Trunca el archivo a <strong>$size</strong> bytes.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  El tamaño a truncar.
              
              Si <strong>$size</strong> es más grande que el fichero este es extendido con bytes null.
              
              Si <strong>$size</strong> es más pequeño que el archivo, los datos extra se perderán.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Escribe en el fichero
  
  Escribe el contenido de un <strong>$string</strong> a el fichero.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    El string a ser escrito en el fichero.
  <info>int</info>     <strong>$length</strong>  Si se utiliza el argumento <strong>$length</strong>, la escritura se detendrá después de que se
                   han escrito <strong>$length</strong> bytes o o se llega al final del <strong>$string</strong>, lo que ocurra
                   primero.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve el número de bytes escritos, o <info>false</info> en caso de error.

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  Ningún propósito
  
  Una clase <class>SplFileObject</class> no tiene hijos así que este método devolverá <info>null</info>.

<comment>Return:</comment>
  <info>null</info>  Devuelve <info>null</info>.

<comment>See Also:</comment>
   * RecursiveIterator::getChildren


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Obtiene el carácter delimitador, el circundante y de escape para campos CSV
  
  Obtiene el carácter delimitador, el circundante y de escape usados para analizar campos CSV.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array indexado que contiene el carácter delimitador, el circundante y el de
         escape.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Obtener las flags de SplFileObject
  
  Obtiene las flags establecidas en una instancia de SplFileObject como un <info>int</info>.

<comment>Return:</comment>
  <info>int</info>  Devuelve un <info>int</info> que representa las flags.

<comment>See Also:</comment>
   * SplFileObject::setFlags


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Obtener la longitud máxima de línea
  
  Obtiene la longitud máxima de línea establecida por SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Devuelve la longitud máxima de línea si ha sido establecido con SplFileObject::setMaxLineLen,
       por omisión es <return>0</return>.

<comment>See Also:</comment>
   * SplFileObject::setMaxLineLen


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  SplFileObject no tiene hijos
  
  Una clase <class>SplFileObject</class> no tiene hijos. Este método siempre devuelve <info>false</info>.

<comment>Return:</comment>
  <info>false</info>  Devuelve <info>false</info>

<comment>See Also:</comment>
   * RecursiveIterator::hasChildren


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de línea
  
  Obtener el número de línea.
  
  Este nñumero puede no ser reflejado en la línea actual en el fichero si el método
  SplFileObject::setMaxLineLen es usado para leer posiciones fijas de el fichero.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de línea actual.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Leer la siguiente línea
  
  Mover a la siguiente línea en el fichero.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el fichero hasta la primera línea
  
  Rebobina el fichero hasta la primera línea.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Mueve el apuntador interno a la línea específicada
  
  Mueve el apuntador interno a la línea específicada en el fichero.

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  El número base cero a mover el apuntador interno.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Establece el carácter delimitador, el circundante y el de escape para campos CSV
  
  Establece el carácter delimitador, el circundante y el de escape para analizar campos CSV.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  El delimitador de campos (un sólo carácter).
  <info>string</info>  <strong>$enclosure</strong>  El carácter circundante de cada campo (un sólo carácter).
  <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>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Establece flags para el SplFileObject
  
  Establece las flags a ser usadas por el <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Bitmask de las flags a establecer. Véase las Constantes SplFileObject para una lista
               de flags disponibles.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::getFlags


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Establecer la longitud máxima de una línea
  
  Establece la longitud máxima de una línea a ser leída.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  La longitud de una línea.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplFileObject::getMaxLineLen


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si el final del finchero ha sido alcanzado
  
  Comprueba si el final del finchero ha sido alcanzado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el final no ha sido alcanzado, en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  la clase SplFixedArray proporciona la funcionalidad principal de un array. La principal diferencia
  entre SplFixedArray y un array normal de PHP es que  la clase SplFixedArray es de longitud fija y
  sólo permite enteros dentro del  rango de índices. La ventaja es que usa menos memoría que un
  <info>array</info> estándar.


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo array fijo
  
  Inicializa un array fijo con un número de valores <info>null</info> igual al tamaño dado por <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  El tamaño de el array fijo. Se exige que sea un número entre <return>0</return> y <info>PHP_INT_MAX</info>.

<comment>Return:</comment>
  <info>unknown</info>  No devuelve ningún valor.


id: SplFixedArray::__serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the SplFixedArray object
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>array</info>  No devuelve ningún valor.


id: SplFixedArray::__unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializes the data parameter into an SplFixedArray object
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The value being deserialized.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Reinicializar el array después de ser deserializado
  
  Reinicializa el array después de ser deserializado.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Devuelve el tamaño del array
  
  Devuelve el tamaño del array.

<comment>Return:</comment>
  <info>int</info>  Devuelve el tamaño del array.

<comment>See Also:</comment>
   * <strong>SplFixedArray::getSize()</strong>


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Devuelve la entrada del array actual
  
  Obtiene la entrada del elemento array actual.

<comment>Return:</comment>
  <info>mixed</info>  El valor del elemento actual.


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Importa un array PHP en una instancia SplFixedArray
  
  Importa un <strong>$array</strong> PHP en una nueva instancia <class>SplFixedArray</class>.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         El array a importar.
  <info>bool</info>   <strong>$save_indexes</strong>  Intenta guardar los índices numéricos usados en el array original.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Devuelve una instancia de <class>SplFixedArray</class> conteniendo el contenido de el array.


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve the iterator to go through the array
  
  Returns the iterator to go through the array.

<comment>Return:</comment>
  <info>Iterator</info>  An instance of an object implementing <class>Iterator</class> to go through the array.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Obtiene el tamaño de el array
  
  Obtiener el tamaño de el array.

<comment>Return:</comment>
  <info>int</info>  Devuelve el tamaño de el array, como un <info>integer</info>.

<comment>See Also:</comment>
   * SplFixedArray::count


id: SplFixedArray::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  Serializes the array to a value that can be serialized natively by <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns array data which can be serialized by <strong>json_encode()</strong>, which is a value of any type
         other than a recurso.


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  Devuelve los índices del array actual
  
  Devuelve los índice del array actual.

<comment>Return:</comment>
  <info>int</info>  Los índices del array actual.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Mover a la siguiente entrada
  
  Mover el iterador a la siguiente entrada en el array.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  Devuelve si el índice solicitado existe
  
  Comprueba si el índice <strong>$index</strong> solicitado existe.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si el indice <strong>$index</strong> existe, en caso contrario <info>false</info>.


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor en el índice específicado
  
  Devuelve el valor en el índice <strong>$index</strong> específicado.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice con el valor.

<comment>Return:</comment>
  <info>mixed</info>  El valor específicado en <strong>$index</strong>.


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  Establece un nuevo valor para el índice específicado
  
  Establece el valor en el <strong>$index</strong> específicado en <strong>$newval</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   El índice a ser establecido.
  <info>mixed</info>  <strong>$newval</strong>  El nuevo valor para <strong>$index</strong>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplFixedArray::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Destruye el valor en el índice específicado
  
  Destruye el valor en el índice específicado.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice a ser destruido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  Cambiar el tamaño de un array
  
  Cambiar el tamaño de un array al nuevo tamaño dado por el parámetro <strong>$size</strong>. Si <strong>$size</strong> es menor que
  el tamaño actual del array, cualquier valor posterior al nuevo tamaño será descartado. Si <strong>$size</strong> es
  mayoy que el tamaño actual del array, el array será rellenado con valores <info>null</info>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  El nuevo tamaño del array. Debería ser un valor entre <return>0</return> y <info>PHP_INT_MAX</info>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  Devuelve un array PHP de un array fijo
  
  Devuelve un array PHP de un array fijo.

<comment>Return:</comment>
  <info>array</info>  Devuelve un <info>array</info> PHP, similar al array fijo.


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si el array contiene más elementos
  
  Comprueba si el array contiene más elementos.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el array contiene más elementos, en caso contrario <info>false</info>.


id: SplHeap
type: class
doc:
<comment>Description:</comment>
  La clase SplHeap proporciona la funcionalidad principal de un montículo.


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compara elementos con el fin de colocarlos correctamente en el montón en la parte de arriba
  
  Comparar <strong>$value1</strong> con <strong>$value2</strong>.
  
  Lanza una excepción en SplHeap::compare que puede dañar el montón y colocarlo en un estado
  bloqueado. Se puede desbloquear llamando a SplHeap::recoverFromCorruption. Sin embargo, algunos
  elementos podrían no ser colocados correctamente y por lo tanto pueden romper la propiedad del
  montón.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  El valor de el primer nodo a ser comparado.
  <info>mixed</info>  <strong>$value2</strong>  El valor de el segundo nodo a ser comparado.

<comment>Return:</comment>
  <info>int</info>  El resultado de la comparación, integer positivo si <strong>$value1</strong> es mayor que <strong>$value2</strong>, 0 si son
       iguales, en caso contrario integer negativo.
       
       No es recomendado tener múltiples elementos con el mismo valor en el montón. Estos terminarán
       con una posición arbitraria relativa.


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  Cuenta el número de elementos en el montón

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de elementos en el montón.


id: SplHeap::current
type: function
doc:
<comment>Description:</comment>
  Devuelve el nodo actual señalado por el iterador
  
  Obtiene el nodo actual.

<comment>Return:</comment>
  <info>mixed</info>  El valor de el nodo actual.


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  Extrae un nodo de la parte superior del montón

<comment>Return:</comment>
  <info>mixed</info>  El valor del nodo a ser extraído.


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  Inserta un elemento en el montón
  
  Inserta un <strong>$value</strong> en el montón.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor a ser insertado.

<comment>Return:</comment>
  <info>true</info>  Siempre devuelve <info>true</info>.


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the heap is in a corrupted state

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


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  Comprueba si el montón actual está vacío

<comment>Return:</comment>
  <info>bool</info>  Devuelve si el montón está vacío.


id: SplHeap::key
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice de el nodo actual
  
  Esta función devuelve el índice de el nodo actual.

<comment>Return:</comment>
  <info>int</info>  El índice de el nodo actual.


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  Avanzar al siguiente nodo
  
  Avanzar al siguiente nodo. Borrará el nodo superior del montón.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recuperarse de un estado dañado y permitir un mayor número de acciones en el montón

<comment>Return:</comment>
  <info>bool</info>  Siempre devuelve <info>true</info>.


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador al comienzo
  
  Esto rebobina el iterador hasta el inicio. Esto es un no-op para los montones ya que el iterador
  es virtual y, de hecho, nunca se mueve desde la parte superior de la pila.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  Observar el nodo desde el comienzo del montón

<comment>Return:</comment>
  <info>mixed</info>  El valor de el nodo del comienzo.


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba si el montón contiene más nodos
  
  Comprueba si el montón contiene más nodos.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el montón contiene más nodos, en caso contrario <info>false</info>.


id: SplMaxHeap
type: class
doc:
<comment>Description:</comment>
  La clase SplMaxHeap proporciona la funcionalidad principal de un montículo, manteniendo el máximo
  en la parte superior.


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compara elementos con el fin de colocarlos correctamente en el montón en la parte de arriba
  
  Comparar <strong>$value1</strong> con <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  El valor de el primer nodo a ser comparado.
  <info>mixed</info>  <strong>$value2</strong>  El valor de el segundo nodo a ser comparado.

<comment>Return:</comment>
  <info>int</info>  El resultado de la comparación, un integer positivo si <strong>$value1</strong> es mayor que <strong>$value2</strong>, 0 si son
       iguales, en caso contrario un integer negativo.
       
       No es recomendado tener múltiples elementos con el mismo valor en el montón. Estos terminarán
       con una posición arbitraria relativa.


id: SplMinHeap
type: class
doc:
<comment>Description:</comment>
  La clase SplMinHeap proporciona la funcionalidad principal de un montículo, manteniendo el mínimo
  en la parte superior.


id: SplMinHeap::compare
type: function
doc:
<comment>Description:</comment>
  Comparar elementos con el fin de colocarlos correctamente en el montón em la parte de arriba
  
  Compara <strong>$value1</strong> con <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  El valor de el primer nodo a ser comparado.
  <info>mixed</info>  <strong>$value2</strong>  El valor de el segundo nodo a ser comparado.

<comment>Return:</comment>
  <info>int</info>  El resultado de la comparación, un integer positivo si <strong>$value1</strong> es menor que <strong>$value2</strong>, 0 si son
       iguales, en caso contrario integer negativo.
       
       No es recomendable tener múltiples elementos con el mismo valor en el montón. Having multiple
       elements with the same value in a Heap is not recommended. Estos terminarán en una por sición
       arbitraria relativa.


id: SplObjectStorage
type: class
doc:
<comment>Description:</comment>
  La clase SplObjectStorage proporciona una correspondencia de objetos de datos o, ignorando los
  datos, un conjunto de objetos. Este doble propósito puede ser útil en muchos casos relacionados
  con la necesidad de identificar objetos de forma única.


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  Agrega todos los objetos de otro almacenamiento
  
  Agrega todos los pares de objetos de datos de un diferente almacenamiento en el almacenamiento
  actual.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  El almacenamiento que se quiere importar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::removeAll


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  Agrega un objeto en el almacenamiento
  
  Añade un <info>object</info> dentro del almacenamiento, y opcionalmente se asocian a algunos datos.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser añadido.
  <info>mixed</info>   <strong>$data</strong>    Los datos asociados con el <info>object</info>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  Comprueba si el almacenamiento contiene un objeto específico
  
  Comprueba si el almacenamiento contiene al <info>object</info> proporcionado.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el <info>object</info> está en el almacenamiento, en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * SplObjectStorage::offsetExists


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  Devuelve el número de objetos en el almacenamiento
  
  Cuenta el número de objetos en el almacenamiento.

<comment>Return:</comment>
  <info>int</info>  El número de objetos en el almacenamiento.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  Devuelve la entrada actual de almacenamiento
  
  Devuelve la entrada actual de almacenamiento.

<comment>Return:</comment>
  <info>object</info>  El <info>object</info> en la posición actual iterador.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  Quita un object de el almacenamiento
  
  Quita un <info>object</info> de el almacenamiento.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser removido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  Calcular un identificador único (hash) para los objetos contenidos
    
  
  Este método calcula un identificador para los objetos añadidos a un objeto <class>SplObjectStorage</class>.
  
  La implementación en la clase <class>SplObjectStorage</class> devuelve el mismo valor que la función
  <strong>spl_object_hash()</strong>.
  
  El objeto de almacenamiento nunca contendrá más de un objeto con el mismo identificador. Por lo
  tanto, se puede usar para implementar un conjunto (una colección de valores únicos) donde la
  cualidad de un objeto de ser único está determinada por el valor devuelto por esta función.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El objeto cuyo identificador va a ser calculado.

<comment>Return:</comment>
  <info>string</info>  Un <info>string</info> con el identificador calculado.

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


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  Devuelve los datos asociados con la entrada del iterador actual
  
  Devuelve los datos o información, asociada al objeto señalado por la posición actual de el
  iterador.

<comment>Return:</comment>
  <info>mixed</info>  Los datos asociados con la posición actual de el iterador.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


id: SplObjectStorage::key
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice en el que se encuentra el iterador actualmente
  
  Devuelve el índice en el que se encuentra el iterador actualmente.

<comment>Return:</comment>
  <info>int</info>  El índice correspondiente a la posición de el iterador.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  Mover a la siguiente entrada
  
  Mover el iterador al siguiente <info>object</info> en el almacenamiento.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SPLObjectStorage::rewind


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  Comprueba si un objeto existe en el almacenamiento
  
  Comprueba si un <info>object</info> existe en el almacenamiento.
  
  SplObjectStorage::offsetExists es un alias de SplObjectStorage::contains.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser comprobado.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el <info>object</info> existe en el almacenamiento, y <info>false</info> en caso contrario.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  Devuelve los datos asociados con un object
  
  Devuelve los datos asociados con un <info>object</info> en el almacenamiento.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser comprobado.

<comment>Return:</comment>
  <info>mixed</info>  Los datos previamente asociados con el <info>object</info> en el almacenamiento.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  Asocia datos a un objeto en el almacenamiento
  
  Asocia datos a un <info>object</info> en el almacenamiento.
  
  SplObjectStorage::offsetSet es un alias de SplObjectStorage::attach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> al que se le van a asociar datos.
  <info>mixed</info>   <strong>$data</strong>    Los datos asociados con el <info>object</info>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Quita un objeto de el almacenamiento
  
  Quitar un <info>object</info> de el almacenamiento.
  
  SplObjectStorage::offsetUnset es un alias de SplObjectStorage::detach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  El <info>object</info> a ser removido.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  Remover objetos contenidos en otro almacenamiento de el almacenamiento actual
  
  Remover objetos contenidos en otro almacenamiento de el almacenamiento actual.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  El almacenamiento que contiene los elementos a remover.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::addAll


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  Remover objetos excepto los contenidos en otro almacenamiento del almacenamiento actual
  
  Remover todos los objetos excepto los contenidos en otro almacenamiento del almacenamiento actual.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  El almacenamiento que contiene los elementos a mantener en el
                              almacenamiento actual.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina el iterador a el primer elemento de el almacenamiento
  
  Rebobina el iterador a el primer elemento de el almacenamiento.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::next


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  Serializa el almacenamiento
  
  Devuelve un string que representa el almacenamiento.

<comment>Return:</comment>
  <info>string</info>  Un string que representa el almacenamiento.

<comment>See Also:</comment>
   * SplObjectStorage::unserialize


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  Establece los datos asociados con el iterador de la entrada actual
  
  Asocia datos o información, con el objeto actualmente señalado por el iterador.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>  Los datos a ser asociados con la entrada del iterador actual.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializa un almacenamiento desde su representación string
  
  Deserializa las entradas del almacenamiento y los añade al almacenamiento actual.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  La representación serializada de el almacenamiento.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.

<comment>See Also:</comment>
   * SplObjectStorage::serialize


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  Comprobar si la entrada actual del iterador es válida
  
  Devuelve si la entrada actual del iterador es válida.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la entrada actual del iterador es válida, en caso contrario <info>false</info>.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  La interfaz <class>SplObserver</class> se utiliza junto con  <class>SplSubject</class> para implementar el patrón de diseño
  observador.


id: SplObserver::update
type: function
doc:
<comment>Description:</comment>
  Recibe actualizaciones de sujeto
  
  Este método es llamado cuando cualquier <class>SplSubject</class> se use  para llamar llamadas adjuntas
  SplSubject::notify.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  El objeto <class>SplSubject</class> notificando al observador de una actualización.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  La clase SplPriorityQueue proporciona la funcionalidad principal de una cola de prioridad,
  implementada mediante un montículo máximo.
  
  El orden de los elementos con idéntica prioridad es indefinido. Puede diferir del orden en que se
  han insertado.


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  Comparar las prioridades con el fin de colocar los elementos correctamente en el montón, mientras
  que tamizar arriba
  
  Compare <strong>$priority1</strong> con <strong>$priority2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  La prioridad del primer nodo que se compara.
  <info>mixed</info>  <strong>$priority2</strong>  La prioridad del segundo nodo que se compara.

<comment>Return:</comment>
  <info>int</info>  Resultados de la comparación, entero positivo si <strong>$priority1</strong>es mayor que <strong>$priority2</strong> , O si son
       iguales, entero negativo lo contrario.
       
       Varios elementos con la misma prioridad que se quita de la cola sin ningún orden en
       particular.


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Cuenta el número de elementos en la cola

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de elementos en la cola.


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  Volver nodo actual que apunta el iterador
  
  Obtener el nodo de estructura de datos actual.

<comment>Return:</comment>
  <info>mixed</info>  El valor de prioridad (o ambos) del nodo actual, dependiendo de la bandera extracto.


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  Extrae un nodo de la parte superior del montículo y desplaza hacia arriba

<comment>Return:</comment>
  <info>mixed</info>  El valor o prioridad (o ambos) del nodo extraído, dependiendo de la bandera de extracción.


id: SplPriorityQueue::getExtractFlags
type: function
doc:
<comment>Description:</comment>
  Get the flags of extraction
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  Returns the flags of extraction.


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  Inserta un elemento en la cola en la parte de arriba
  
  Inserta un <strong>$value</strong> con la prioridad <strong>$priority</strong> en la cola.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     El valor a insertar.
  <info>mixed</info>  <strong>$priority</strong>  La prioridad asociada.

<comment>Return:</comment>
  <info>true</info>  Siempre devuelve <info>true</info>.


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Tells if the priority queue is in a corrupted state

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the priority queue is corrupted, <info>false</info> otherwise.


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Comprueba si la cola está vacía

<comment>Return:</comment>
  <info>bool</info>  Indica si la cola está vacía.


id: SplPriorityQueue::key
type: function
doc:
<comment>Description:</comment>
  Devuelve el índice del nodo actual
  
  Este método devuelve el índice del nodo actual.

<comment>Return:</comment>
  <info>int</info>  El índice el nodo actual.


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  Pasar a la siguiente nodo
  
  Extrae el nodo superior de la cola.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Recuperar desde la condición corrupta y permitir acciones más en la cola

<comment>Return:</comment>
  <info>bool</info>  Siempre devuelve <info>true</info>.


id: SplPriorityQueue::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobinar iterador de vuelta al inicio (no-op)
  
  Este rebobina el iterador al comienzo. Se trata de un no-op de montones como el iterador es
  virtual y de hecho nunca se mueve de arriba del montón.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  Establece el modo de extracción

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Define lo que se extrae por SplPriorityQueue::current, SplPriorityQueue::top y
               SplPriorityQueue::extract.
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): Extraer los datos
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): Extraer la prioridad
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): Extraer un array con ambos
               
               El modo por omisión es <info>SplPriorityQueue::EXTR_DATA</info>.

<comment>Return:</comment>
  <info>int</info>  Devuelve las banderas de extracción.


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  Mira en el nodo de la parte superior de la cola

<comment>Return:</comment>
  <info>mixed</info>  El valor o prioridad (o ambas) del nodo superior, dependiendo de las flags.


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  Comprobar si la cola contiene más nodos
  
  Comprueba si la cola contiene más nodos.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si la cola los contiene y mas nodos, <info>false</info> de lo contrario.


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  La clase SplQueue proporciona las principales funcionalidades de una cola implementada usando una
  lista doblemente enlazada al estableciendo el modo del iterador a
  <info>SplDoublyLinkedList::IT_MODE_FIFO</info>.


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  Quita un nodo de la cola
  
  Quita un <strong>$value</strong> en la parte superior de la cola.
  
  SplQueue::dequeue es un alias de SplDoublyLinkedList::shift.

<comment>Return:</comment>
  <info>mixed</info>  El valor de el nodo a quitar de la cola.


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  Añade un elemento a la cola
  
  Añadir un <strong>$value</strong> al final de la cola.
  
  SplQueue::enqueue es un alias de SplDoublyLinkedList::push.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  El valor que se va a añadir.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplStack
type: class
doc:
<comment>Description:</comment>
  La clase SplStack proporciona la funcionalidad principal de una pila implementada mediante una
  lista doblemente enlazada estableciendo el modo iterador a <info>SplDoublyLinkedList::IT_MODE_LIFO</info>.


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  El interfaz <class>SplSubject</class> es usado en conjunto con <class>SplObserver</class> para implementar el patrón de diseño
  Observer.


id: SplSubject::attach
type: function
doc:
<comment>Description:</comment>
  Adjuntar un SplObserver
  
  Adjunta un <class>SplObserver</class> de esta forma puede ser notificado cuando hayan actualizaciones.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  El <class>SplObserver</class> a adjuntar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplSubject::detach
type: function
doc:
<comment>Description:</comment>
  Separa un observador
  
  Separa un observador del sujeto para dejar de notificarlo cuando hayan actualizaciones.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  El <class>SplObserver</class> a separar.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplSubject::notify
type: function
doc:
<comment>Description:</comment>
  Notificar un observador
  
  Notifica todos los observadores adjuntos.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SplTempFileObject
type: class
doc:
<comment>Description:</comment>
  La clase SplTempFileObject ofrece una interfaz orientada a objectos para ficheros temporales.


id: SplTempFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un nuevo objeto de fichero temporal
  
  Construir un nuevo objeto de fichero temporal.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  La cantidad máxima de memoria (en bytes, por omisión es 2 MB) para el fichero
                   temporal a usar. Su el fichero temporal supera este tamaño, Este será movido a un
                   archivo en el directorio temporal del sistema.
                   
                   Si <strong>$maxMemory</strong> es negativo, se usará memoria. Si <strong>$maxMemory</strong> es cero, no se usará
                   memoria.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * PHP input/output streams
     (para <return>php://temp</return> y <return>php://memory</return>)
    


id: Spoofchecker::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


id: Spoofchecker::areConfusable
type: function
doc:
<comment>Description:</comment>
  Comprobar si un texto dado contiene carateres que pueden ser confusos
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$s1</strong>     
  <info>string</info>  <strong>$s2</strong>     
  <info>string</info>  <strong>$error</strong>  

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


id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  Comprobar si un texto dad contiene caracteres sospechosos
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>   
  <info>string</info>  <strong>$error</strong>  

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


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  Las configuraciones regionales a usar cuando se ejecutan las comprobaciones
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Establecer las comprobaciones a ejecutar
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  Set the restriction level
  
  Sets the restriction level of SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  The restriction level of SpoofChecker::isSuspicious. One of <info>Spoofchecker::ASCII</info>,
               <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>, <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>,
               <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>, <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, or
               <info>Spoofchecker::UNRESTRICTIVE</info>. Defaults to <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>.

<comment>Return:</comment>
  <info>void</info>  No devuelve ningún valor.


id: SqlStatement::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.


id: SqlStatement::bind
type: function
doc:
<comment>Description:</comment>
  Bind statement parameters
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: SqlStatement::execute
type: function
doc:
<comment>Description:</comment>
  Execute the operation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatement::getNextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatement::getResult
type: function
doc:
<comment>Description:</comment>
  Get result
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check for more results
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows from result
  
  Fetch all the rows from the result set.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get single row
  
  Fetch one row from the result set.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  Get affected row count
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  Get column names
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getColumns
type: function
doc:
<comment>Description:</comment>
  Get columns
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  Get column count
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Get generated ids
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getLastInsertId
type: function
doc:
<comment>Description:</comment>
  Get last insert id
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  Check if result has data
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: SqlStatementResult::nextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check if more results
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Representa una conexión entre PHP y un Message Brokers que cumpla con las normas del protocolo
  Stomp.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Abre una conexión
  
  Estilo orientado a objetos (constructor):
  
  Estilo por procedimientos:
  
  Abre una conexión con un Message Broker compatible con el protocolo STOMP.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    La URI broker
  <info>string</info>  <strong>$username</strong>  El nombre de usuario.
  <info>string</info>  <strong>$password</strong>  La contraseña.
  <info>array</info>   <strong>$headers</strong>   Array asociativo conteniendo los headers adicionales (ejemplo: receipt).

<comment>Return:</comment>
  <info>resource</info>  Un header de transacción puede ser especificado, indicando que el mensaje de
            Acknowledgment debería formar parte del nombre de la transacción.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Cierra una conexión stomp
  
  Estilo orientado a objetos (destructor):
  
  Estilo por procedimientos:
  
  Cierra una conexión previamente abierta.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Deshacer una transacción en curso
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Deshacer una transacción en curso.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Sólo estilo por procediminetos: El identificador de enlace Stomp
                             devuelto por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  La transacción a abortar.
  <info>array</info>     <strong>$headers</strong>         Array asociativo conteniendo los headers adicionales (ejemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Confirmar la recepción y el consumo de un mensaje
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Confirmar el consumo de un mensaje desde una suscripción enviando el cliente una trama ACK de
  confirmación.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                      <strong>stomp_connect()</strong>.
  <info>mixed</info>     <strong>$msg</strong>      El mensaje/Id del mensaje a ser confirmado.
  <info>array</info>     <strong>$headers</strong>  Array asociativo conteniendo los headers adicionales (ejemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Iniciar una transacción
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Inicia una transacción.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Sólo estilo por procediminetos: El identificador de enlace Stomp
                             devuelto por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  La identificación de la transacción.
  <info>array</info>     <strong>$headers</strong>         Array asociativo conteniendo los headers adicionales (ejemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Validar una transacción en curso
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Valida una transacción en curso.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Sólo estilo por procediminetos: El identificador de enlace Stomp
                             devuelto por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  La identificación de la transacción.
  <info>array</info>     <strong>$headers</strong>         Array asociativo conteniendo los headers adicionales (ejemplo:
                             receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Obtiene el último error stomp
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Obtiene el último error stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Devuelve una cadena de error o <info>false</info> si no hay errores.


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Obtener la lectura del tiempo de espera de la solicitud
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Obtiene la lectura del tiempo de espera de la solicitud

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array con dos elementos: sec y usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Obtiene el identificador de sesión actual stomp
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Obtiene el identificador de sesión actual stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> session id on success o <info>false</info> en caso de error.


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indica si existe o no una trama lista para leer
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Indica si existe o no una trama lista para leer.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto por
                   <strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si hay una trama lista para leer, o <info>false</info> en caso contrario.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Leer la siguiente trama
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Lee la siguiente trama. Es posible crear una instancia de un objeto de una clase específica, y
  pasar parámetros al constructor de esa clase.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto
                         por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$class_name</strong>  El nombre de la clase a instanciar. Si no se especifica, un objeto
                         stompFrame es devuelto.

<comment>Return:</comment>
  <info>stompframe</info>  Un header de transacción puede ser especificado, indicando que el mensaje de
              Acknowledgment debería formar parte del nombre de la transacción.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Envía un mensaje
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Envía un mensaje a el Message Broker.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto
                          por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  A dónde eenviar el mensaje
  <info>mixed</info>     <strong>$msg</strong>          Mensaje a enviar.
  <info>array</info>     <strong>$headers</strong>      Array asociativo conteniendo los headers adicionales (ejemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Establecer el tiempo de espera de lectura
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Establece el tiempo de espera de lectura.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto
                           por <strong>stomp_connect()</strong>.
  <info>int</info>       <strong>$seconds</strong>       Los segundos parte de el tiempo de espera a ser establecido.
  <info>int</info>       <strong>$microseconds</strong>  Los microsegundos parte de el tiempo de espera a ser establecido.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Registrarse para escuchar a un destino dado
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Registrarse para escuchar a un destino dado.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto
                          por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Destino al que suscribirse.
  <info>array</info>     <strong>$headers</strong>      Array asociativo conteniendo los headers adicionales (ejemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Dar de baja una suscripción existente
  
  Estilo orientado a objetos (método):
  
  Estilo por procedimientos:
  
  Dar de baja una suscripción existente.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Sólo estilo por procediminetos: El identificador de enlace Stomp devuelto
                          por <strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Suscripción a eliminar
  <info>array</info>     <strong>$headers</strong>      Array asociativo conteniendo los headers adicionales (ejemplo: receipt).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: StompException
type: class
doc:
<comment>Description:</comment>
  Representa un error proveniente desde la extensión stomp. Vea Exceptions para obtener más
  información acerca de las excepciones en PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Obtener detalles de la excepción
  
  Obtener detalles de la excepción.

<comment>Return:</comment>
  <info>string</info>  <info>string</info> que contiene los detalles del error.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Representa un mensaje el cual fue enviado o recibido desde un Message Brokers que cumple con las
  normas del protocolo Stomp.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Comando del frame
  <info>array</info>   <strong>$headers</strong>  encabezados del frame (<info>array</info>).
  <info>string</info>  <strong>$body</strong>     cuerpo del frame


id: Stringable
type: class
doc:
<comment>Description:</comment>
  The Stringable interface denotes a class as having a __toString() method.  Unlike most interfaces,
  Stringable is implicitly present on any class that has the magic __toString() method defined,
  although it can and should be declared explicitly.
  
  Its primary value is to allow functions to type check against the union type <return>string|Stringable</return> to
  accept either a string primitive or an object that can be cast to a string.


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  Gets a string representation of the object

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

<comment>See Also:</comment>
   * __toString()


id: Superglobals
type: function
doc:
<comment>Description:</comment>
  Superglobals son variables internas que están disponibles siempre en todos los ámbitos
  
  Algunas variables predefinidas en PHP son "superglobales", lo que significa que están disponibles
  en todos los ámbitos a lo largo del script. No es necesario emplear global $variable; para acceder
  a ellas dentro de las funciones o métodos.
  
  Las variables superglobals son: $GLOBALS$_SERVER$_GET$_POST$_FILES$_COOKIE$_SESSION$_REQUEST$_ENV

<comment>See Also:</comment>
   * ámbito de las variables
   * La directiva variables_order
   * La extensión filter


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


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

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

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


id: Swoole\Async::set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options.

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

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


id: Swoole\Async::write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously.

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

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


id: Swoole\Async::writeFile
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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


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

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

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


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

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

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


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

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


id: Swoole\Atomic::set
type: function
doc:
<comment>Description:</comment>
  Set a new value to the atomic object.
  
  Set a new value to the atomic object.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


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

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


id: Swoole\Buffer::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole memory buffer.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


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

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


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

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

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


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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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

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


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

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


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

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


id: Swoole\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole client.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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

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


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

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


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

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

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


id: Swoole\Client::recv
type: function
doc:
<comment>Description:</comment>
  Receive data from the remote socket.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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

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


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

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

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


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

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


id: Swoole\Coroutine::create
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: Swoole\Event::add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop.

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

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


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

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

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


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

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

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


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at client side.

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


id: Swoole\Event::set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket.

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

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


id: Swoole\Event::wait
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


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

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

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


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

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


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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Get the raw HTTP POST body.
  
  This method is used for the POST data which isn't in the form of
  `application/x-www-form-urlencoded`.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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


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

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

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


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


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

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


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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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

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


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

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


id: Swoole\Process::daemon
type: function
doc:
<comment>Description:</comment>
  Change the process to be a daemon process.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


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

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

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


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

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


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

<comment>Param:</comment>
  <info>int</info>  <strong>$pid</strong>        Process pid
  <info>int</info>  <strong>$signal_no</strong>  Signal to be sent

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$process_name</strong>  Set name of the process.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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

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


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

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

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


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

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

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


id: Swoole\Redis\Server::format
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: Swoole\Redis\Server::setHandler
type: function
doc:
<comment>Description:</comment>
  Description
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Stop and destory a timer.
  
  Estilo orientado a objetos (method):
  
  Estilo por procedimientos:
  
  Stop and destory a timer

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            File descriptors.
  <info>int</info>   <strong>$reactor_id</strong>    The Reactor thread ID where the connection is made.
  <info>bool</info>  <strong>$ignore_error</strong>  Whether to ignore errors, if set to true, connection information will be
                       returned even if the connection is closed.

<comment>Return:</comment>
  <info>array</info>  Returns information about the client connection.


id: Swoole\Server::getClientList
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


id: Swoole\Server::send
type: function
doc:
<comment>Description:</comment>
  Send data to the client.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


id: Swoole\Server::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the connection.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


id: Swoole\Server::sendwait
type: function
doc:
<comment>Description:</comment>
  Send data to the remote socket in the blocking way.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


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

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


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

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


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

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


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

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

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


id: Swoole\Server::task
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


id: Swoole\Server::taskwait
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes in blocking way.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


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

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

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


id: Swoole\Server\Port::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory server port

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


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

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

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


id: Swoole\Server\Port::set
type: function
doc:
<comment>Description:</comment>
  Set protocol of the server port.

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

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


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

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


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

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

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


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

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


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

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


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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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


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

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


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

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


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

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

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


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

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


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

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

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


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

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

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


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer is existed.
  
  Check if a timer is existed.

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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


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

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

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncEvent</class> object.

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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


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

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

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncMutex</class> object.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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


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

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

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncReaderWriter</class> object.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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


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

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

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSemaphore</class> object.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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


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

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

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSharedMemory</class> object.

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.

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


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

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

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

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


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

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

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


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

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

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

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


id: TCP_NODELAY
type: constant
doc:
<comment>Description:</comment>
  Usada para deshabilitar el algoritmo Nagle TCP. Añadido en PHP 5.2.7.


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

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


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

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


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

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


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

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


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

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


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

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


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

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

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


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

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


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

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

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


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

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


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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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


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

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


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

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

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


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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


id: Thread
type: class
doc:
<comment>Description:</comment>
  Cuando se invoca al método start de Thread, se ejecutará el código del método run en un Thread
  diferente, en paralelo.
  
  Después de ejecutar el método run, el Thread terminará inmediatamente; será unido al Thread
  creador en el momento apropiado.
  
  Depender del motor para determinar cuándo un Thread debería unirse podría ocasionar un
  comportamiento no deseado; el programador debería ser explícito siempre que sea posible.


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  Identificación
  
  Devolverá la identificación del hilo que creó el hilo referenciado.

<comment>Return:</comment>
  <info>integer</info>  Una identificación numérica


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Identificación
  
  Devuelve una referencia al hilo que está siendo ejecutado.

<comment>Return:</comment>
  <info>Thread</info>  Un objeto representando la ejecución del hilo actual.


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

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


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

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


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Threaded
type: class
doc:
<comment>Description:</comment>
  Los objetos Threaded forman la base de la capacidad de pthreads para ejecutar código de usuario en
  paralelo; exponen métodos de sincronización y varias interfaces útiles.
  
  Lo más importante de los objetos Threaded es que proporcionan seguridad implícita para el
  programador; todas las operaciones en el ámbito del objeto son seguras.


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

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

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


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

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


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

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

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object is executing

<comment>Return:</comment>
  <info>bool</info>  A boolean indication of state  A object is considered running while executing the run method 
        
        A object is considered running while executing the run method


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Tell if the referenced object was terminated during execution; suffered fatal errors, or threw
  uncaught exceptions

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


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Merges data into the current object

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>       The data to merge
  <info>bool</info>   <strong>$overwrite</strong>  Overwrite existing keys, by default true

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object. This unblocks at least one of the blocked threads (as
  opposed to unblocking all of them, as seen with Threaded::notify).

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Pops an item from the objects property table

<comment>Return:</comment>
  <info>bool</info>  The last item from the objects property table


id: Threaded::run
type: function
doc:
<comment>Description:</comment>
  Execution
  
  The programmer should always implement the run method for objects that are intended for execution.

<comment>Return:</comment>
  <info>void</info>  The methods return value, if used, will be ignored


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Shifts an item from the objects property table

<comment>Return:</comment>
  <info>mixed</info>  The first item from the objects property table


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Executes the block while retaining the referenced objects synchronization lock for the calling
  context

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  The block of code to execute
  <info>mixed</info>    <strong>$args</strong>   Variable length list of arguments to use as function arguments to the block

<comment>Return:</comment>
  <info>mixed</info>  The return value from the block


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Will cause the calling context to wait for notification from the referenced object

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  An optional timeout in microseconds

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.


id: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> es la interfaz base para cualquier objeto que pueda ser lanzado mediante una sentencia
  <return>throw</return>, incluyendo <class>Error</class> y <class>Exception</class>.
  
  Las clases de PHP no pueden implementar la interfaz <class>Throwable</class> directamente, por lo que deben
  extender en su lugar <class>Exception</class>.


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  Obtiene un representación de string del objeto lanzado

<comment>Return:</comment>
  <info>string</info>  Devuelve la representación de <info>string</info> del objeto lanzado.

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


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  Obtener el código de la excepción
  
  Devuelve el código de error asociado al objeto lanzado.

<comment>Return:</comment>
  <info>int</info>  Devuelve el código de la excepción como un <info>int</info> en <class>Exception</class>, aunque posiblemente como otro
       tipo en los descendientes de <class>Exception</class> (por ejemplo, como <info>string</info> en <class>PDOException</class>).

<comment>See Also:</comment>
   * Exception::getCode


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  Obtiene el fichero en el que se creó el objeto
  
  Obtiene el nombre del fichero en el que se creó el objeto lanzado.

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre del fichero en el que se creó la el objeto lanzado.

<comment>See Also:</comment>
   * Exception::getFile


id: Throwable::getLine
type: function
doc:
<comment>Description:</comment>
  Obtiene la línea en la que el objeto fue instanciado
  
  Devuelve el número de línea en la que el objeto fue instanciado.

<comment>Return:</comment>
  <info>int</info>  Devuelve el número de línea en la que el objeto fue instanciado.

<comment>See Also:</comment>
   * Exception::getLine


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  Obtiene el mensaje
  
  Devuelve el mensaje asociado al objeto lanzado.

<comment>Return:</comment>
  <info>string</info>  Devuelve el mensaje asociado al objeto lanzado.

<comment>See Also:</comment>
   * Exception::getMessage


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  Devuelve el objeto Throwable previo
  
  Devuelve el objeto Throwable previo (por ejemplo, uno proporcionado como tercer parámetro de
  Exception::__construct).

<comment>Return:</comment>
  <info>Throwable|null</info>  Devuelve el objeto <class>Throwable</class> anterior si está disponible, o <info>null</info> si no lo está.

<comment>See Also:</comment>
   * Exception::getPrevious


id: Throwable::getTrace
type: function
doc:
<comment>Description:</comment>
  Obtener la traza de la pila
  
  Devuelve la traza de la pila como un <info>array</info>.

<comment>Return:</comment>
  <info>array</info>  Devuelve la traza de la pila como un <info>array</info> con el mismo formato que en <strong>debug_backtrace()</strong>.

<comment>See Also:</comment>
   * Exception::getTrace


id: Throwable::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  Obtener la traza de la pila como un string

<comment>Return:</comment>
  <info>string</info>  Devuelve la traza de la pila como un string.

<comment>See Also:</comment>
   * Exception::getTraceAsString


id: Transliterator
type: class
doc:
<comment>Description:</comment>
  La clase Transliterator proporciona transliteraciones de cadenas.


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor privado para denegar la instanciación
  
  Este método no debería ser llamada. Su único propósito es denegar la instanciación con el operador
  new.
  
  En su lugar use los métodos de fábrica Transliterator::create o Transliterator::createFromRules.

<comment>Return:</comment>
  <info>unknown</info>  Este método no debería ser ejecutado. Si lo es (p.ej. a través de reflexión), devuelve un
           valor no especificado.

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


id: Transliterator::create
type: function
doc:
<comment>Description:</comment>
  Crear un transliterador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Abrir un transliterador mediante su ID.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>         El identificador.
  <info>int</info>     <strong>$direction</strong>  La dirección, por defecto es &gt;Transliterator::FORWARD. También se puede
                      establecer a Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator</info>  Devuelve un objeto de la clase <class>Transliterator</class> en caso de éxito, o <info>null</info> en caso de
                  error.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Transliterator::createFromRules
type: function
doc:
<comment>Description:</comment>
  Crear un transliterador desdes normas
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Crea un transliterador desdes normas.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$rules</strong>      Las normas.
  <info>string</info>  <strong>$direction</strong>  La dirección, por defecto es &gt;Transliterator::FORWARD. También se puede
                      establecer a Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator</info>  Devuelve un objeto de la clase <class>Transliterator</class> en caso de éxito, o <info>null</info> en caso de
                  error.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::createInverse
type: function
doc:
<comment>Description:</comment>
  Cerar una transliteración inversa
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Abre el transliterador inverso.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>Transliterator</info>  Devuelve un objeto de la clase <class>Transliterator</class> en caso de éxito, o <info>null</info> en caso de
                  error

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el código del último error
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el código del último error de este transliterador.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El código del error en caso de éxito, o <info>false</info> si no existe o en caso de error.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


id: Transliterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el mensaje del último error
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el mensaje del último error para este transliterador.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>string</info>  El código del error en caso de éxito, o <info>false</info> si no existe o en caso de error.

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


id: Transliterator::listIDs
type: function
doc:
<comment>Description:</comment>
  Obtener los IDs de los transliterardores
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Devuelve un array con los IDs de los transliteradores registrados.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>array</info>  Un <info>array</info> con los IDs de los transliteradores registrados en caso de éxito. o <info>false</info> en caso
         de error.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  Transliterar una cadena
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Translitera una cadena o parte de la misma utilizando el transliterador de ICU.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$transliterator</strong>  En la versión por procedimientos, un objeto de la clase <class>Transliterator</class> o
                           un <info>string</info> desde el cual se puede construir un objeto de la clase
                           <class>Transliterator</class>.
  <info>string</info>  <strong>$subject</strong>         La cadena a transformar.
  <info>int</info>     <strong>$start</strong>           El índice de inicio (en unidades de código UTF-16) desde el cual se
                           empezará a transformar la cadena, inclusive. La indexación comienza en 0.
                           El texto anterior a este índice se dejará tal cual.
  <info>int</info>     <strong>$end</strong>             El índice final (en unidades de código UTF-16) hasta el cual será
                           transformala la cadena, exclusive. La indexación comienza en 0. El texto
                           posterior a este índice se dejará tal cual.

<comment>Return:</comment>
  <info>string</info>  La cadena transformada en caso de éxito,  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  Interfaz para detectar si una clase puede recorrerse mediante foreach.
  
  Una interfaz abstracta base no puede ser implementada sola. En su lugar, debe ser implementada con
  IteratorAggregate o con Iterator.


id: UConverter::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un objeto UConverter
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$destination_encoding</strong>  
  <info>string</info>  <strong>$source_encoding</strong>       


id: UConverter::convert
type: function
doc:
<comment>Description:</comment>
  Convertir un string de un juego de caracteres a otro
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>      
  <info>bool</info>    <strong>$reverse</strong>  

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


id: UConverter::fromUCallback
type: function
doc:
<comment>Description:</comment>
  Función de retrollamada "from" predeterminada
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>integer</info>  <strong>$reason</strong>     
  <info>string</info>   <strong>$source</strong>     
  <info>string</info>   <strong>$codePoint</strong>  
  <info>integer</info>  <strong>$error</strong>      

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


id: UConverter::getAliases
type: function
doc:
<comment>Description:</comment>
  Obtener los alias del nombre dado
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: UConverter::getAvailable
type: function
doc:
<comment>Description:</comment>
  Obtener los nombres canónicos de los convertidores disponibles
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::getDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Obtener la codificación de destino
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::getDestinationType
type: function
doc:
<comment>Description:</comment>
  Obtener el tipo del convertidor de destino
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: UConverter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el código del último error del objeto
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: UConverter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el último mensaje de error del objeto
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::getSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Obtener la codificación de origen
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::getSourceType
type: function
doc:
<comment>Description:</comment>
  Obtener el tipo de convertidor de origen
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>integer</info>  


id: UConverter::getStandards
type: function
doc:
<comment>Description:</comment>
  Obtener los estándares asociados a los nombres de los convertidores
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::getSubstChars
type: function
doc:
<comment>Description:</comment>
  Obtener los caracteres de sustitución
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UConverter::reasonText
type: function
doc:
<comment>Description:</comment>
  Obtener la representación de string de la razón de la retrollamada
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>integer</info>  <strong>$reason</strong>  

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


id: UConverter::setDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Establecer la codificación destino
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: UConverter::setSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Establecer la codificación origen
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: UConverter::setSubstChars
type: function
doc:
<comment>Description:</comment>
  Establecer los caracteres de sustitución
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  Función de retrollamada "to" predeterminada
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>integer</info>  <strong>$reason</strong>     
  <info>string</info>   <strong>$source</strong>     
  <info>string</info>   <strong>$codeUnits</strong>  
  <info>integer</info>  <strong>$error</strong>      

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


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  Convertir un string de un juego de caracteres a otro
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>           
  <info>string</info>  <strong>$toEncoding</strong>    
  <info>string</info>  <strong>$fromEncoding</strong>  
  <info>array</info>   <strong>$options</strong>       

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


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  An Area represents a canvas which can be used to draw, and respond to mouse and key events.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the ALT key is active


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the CTRL key is active


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Draw Callback
  
  Shall be invoked when this Area requires redrawing

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen</strong>        A Pen suitable for drawing in this Area
  <info>UI\Size</info>      <strong>$areaSize</strong>   The size of the Area
  <info>UI\Point</info>     <strong>$clipPoint</strong>  The clip point of the Area
  <info>UI\Size</info>      <strong>$clipSize</strong>   The clip size of the Area


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Key Callback
  
  Shall be executed on key events

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key pressed
  <info>int</info>     <strong>$ext</strong>    The extended key pressed
  <info>int</info>     <strong>$flags</strong>  Event modifiers


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Mouse Callback
  
  Shall be executed on mouse events

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  The co-ordinates of the event
  <info>UI\Size</info>   <strong>$areaSize</strong>   The size of the area of the event
  <info>int</info>       <strong>$flags</strong>      Event modifiers


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Area Scroll
  
  Scroll this Area

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to scroll to
  <info>UI\Size</info>   <strong>$size</strong>   The size of the scroll pane


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Sets the size of this Area

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  The new size


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Get Parent Control
  
  Shall return the parent Control

<comment>Return:</comment>
  <info>UI\Control</info>  


id: UI\Control::getTopLevel
type: function
doc:
<comment>Description:</comment>
  Get Top Level
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Determine if Control is enabled
  
  Shall detect if this Control is enabled

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


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Determine if Control is visible
  
  Shall detect if this Control is visible

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


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Set Parent Control
  
  Shall set the parent Control of this Control

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  The parent Control


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Box
  
  Shall construct a new box

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal or Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the given control to this Box

<comment>Param:</comment>
  <info>Control</info>  <strong>$control</strong>   The control to append
  <info>bool</info>     <strong>$stretchy</strong>  Set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index from this Box

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to delete

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Get Orientation
  
  Shall retrieve the orientation of this Box

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


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Box

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


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Box

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


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Button
  
  Shall construct a new Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for this Button


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall retrieve the text (label) for this Button

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\Check::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Check
  
  Shall construct a new Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the Check box


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text (label) for this Check

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Checked Detection
  
  Shall detect the status of this Check

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


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Toggle Callback
  
  Shall be executed when the status of this Check is changed


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall change the status of this Check

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  A Color Button is a button which displays a color picker when clicked


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall retrieve the currently selected Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the selected Color is changed


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the currently selected Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The new color


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  A Combo control represents a list of options, like the familiar select HTML element.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Append an option to this Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the option selected in this Combo

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


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when an option is selected in this Combo


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Combo

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  An Editable Combo is a Combo which allows the user to enter custom options


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Get the value of the currently selected option in this Editable Combo

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


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Editable Combobox changes


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text of the currently selected option in this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Entry
  
  Construct a new entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password, or Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text from this Entry

<comment>Return:</comment>
  <info>string</info>  The current text


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Detect Read Only
  
  Shall detect if this Entry is read only

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


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Entry changes


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only for this Entry

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


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  A Form is a control which allows the arrangement of other controls into a familiar layout (the
  form).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the control to the form, and set the label

<comment>Param:</comment>
  <info>string</info>      <strong>$label</strong>     The text for the label
  <info>UI\Control</info>  <strong>$control</strong>   A control
  <info>bool</info>        <strong>$stretchy</strong>  Should be set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index in this Form

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of succcess


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Form

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


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Form

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


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  A Grid is a control which is allows the arrangement of children into a grid


id: UI\Controls\Grid::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to append
  <info>int</info>         <strong>$left</strong>     
  <info>int</info>         <strong>$top</strong>      
  <info>int</info>         <strong>$xspan</strong>    
  <info>int</info>         <strong>$yspan</strong>    
  <info>bool</info>        <strong>$hexpand</strong>  
  <info>int</info>         <strong>$halign</strong>   
  <info>bool</info>        <strong>$vexpand</strong>  
  <info>int</info>         <strong>$valign</strong>   


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Grid

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


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding for this Grid

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


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Group
  
  Shall construct a new Group with the given title

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the title label


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append a control to this Group

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The control to append


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall return the current title for this Group

<comment>Return:</comment>
  <info>string</info>  The current title


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if this Group has a margin

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


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins for this Group

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


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Set Title
  
  Shall set the title for this Group

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the new title


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  A Label is a single line of text, meant to identify, for the user, some element of the interface.


id: UI\Controls\Label::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Label
  
  Shall construct a new Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for this label


id: UI\Controls\Label::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text for this Label
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  A Multiline Entry is a text entry control able to hold multiple lines of text, with or without
  wrapping.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Multiline Entry
  
  Shall construct a new Multiline Entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap or MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Append Text
  
  Shall append the given text to the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text to append


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text in this Multiline Entry

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


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Read Only Detection
  
  Shall detect if this Multiline Entry is read only

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


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Multiline Entry is changed


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only on this Multiline Entry

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


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker
  interface to the user.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Picker
  
  Construct a new Picker of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time, or Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  A Progress control is a familiar Progress bar: It represents progress as a percentage, with a
  possible range of 0 to 100 (inclusive).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Shall retrieve the current value of this Progress bar

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


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Progress bar

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  An integer between 0 and 100 (inclusive)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Radio

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the option


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the currently selected option in this Radio

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


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when the option selected in this Radio changes


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Radio

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  A Separator represents a control separator, it has no other function.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Separator
  
  Shall construct a new Separator of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal or Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  A Slider is a control which represents a range, and a current value in the range. The sliding
  element of the control (sometimes called the "thumb") reflects the value, and can be adjusted
  within the range.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Slider
  
  Construct a new Slider with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum allowed value
  <info>int</info>  <strong>$max</strong>  The maximum allowed value


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value from this Slider

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


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Slider changes


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Slider

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  A Spin box is a text box with an up-down control which changes the integer value in the box,
  within a defined range


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Spin
  
  Constructs a new Spin with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum value allowed
  <info>int</info>  <strong>$max</strong>  The maximum value allowed


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value in this Spin

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


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value in this Spin changes


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Set the value in this Spin

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  A Tab can contain many pages of Controls, each with a title, each selectable by the user.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Append Page
  
  Append a new page to this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Delete Page
  
  Shall remove the selected page from this Tab

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the page to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if the given page has a margin.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  The index of the page

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


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Insert Page
  
  Shall insert a new page into this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>int</info>         <strong>$page</strong>     The index to perform the insertion before
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Page Count
  
  Shall return the number of pages in this Tab

<comment>Return:</comment>
  <info>int</info>  The number of pages in this Tab


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins on the selected page

<comment>Param:</comment>
  <info>int</info>   <strong>$page</strong>    The page to select
  <info>bool</info>  <strong>$margin</strong>  Margin switch


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Brush
  
  Shall construct a solid brush using the given color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall return a UI\Draw\Color for this brush

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  The current color of the brush


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the color of this brush to the color provided

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA

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


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Shall at a stop of the given color at the given position

<comment>Param:</comment>
  <info>float</info>          <strong>$position</strong>  The position for the new stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the new stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::delStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation

<comment>Param:</comment>
  <info>int</info>            <strong>$index</strong>     The index of the stop to set
  <info>float</info>          <strong>$position</strong>  The position for the stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Linear Gradient
  
  Shall construct a new linear gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end</strong>    


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Radial Gradient
  
  Shall construct a new radial gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>   
  <info>UI\Point</info>  <strong>$outer</strong>   
  <info>float</info>     <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Represents RGBA colours, individual channels are accessible via public properties.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo color
  
  Construirá un nuevo color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Puede ser UI\Draw\Color o RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Manipulación de color
  
  Recuperará el valor de un canal

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  La identidad del canal constante

<comment>Return:</comment>
  <info>float</info>  El valor actual del canal solicitado


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Manipulación de color
  
  Pondrá el canal seleccionado en el valor dado

<comment>Param:</comment>
  <info>int</info>    <strong>$channel</strong>  La identidad del canal constante
  <info>float</info>  <strong>$value</strong>    El nuevo valor para el canal seleccionado

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


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Detección de invertido
  
  Detectará si esta Matriz puede ser invertida

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


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Multiplica la matriz
  
  Multiplicará esta matriz con la matriz dada

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  La nueva matriz


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Rota la matriz
  
  Rotar esta Matriz

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>float</info>     <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Escala la Matriz
  
  Escalará esta Matriz

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point</strong>   


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Inclina la Matriz
  
  Inclinará esta Matriz

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Traduce la matriz
  
  Traducirá esta Matriz

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path
type: class
doc:
<comment>Description:</comment>
  A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Construye una nueva ruta
  
  Construirá una nueva ruta en el modo dado

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding o Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Dibuja un rectángulo
  
  Trazará la ruta de un rectángulo del tamaño dado, en el punto dado

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  El punto de partida de la forma
  <info>UI\Size</info>   <strong>$size</strong>   El tamaño del rectángulo


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Dibuja un arco
  
  Trazará la ruta para un arco

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     El punto de partida del mapeo
  <info>float</info>     <strong>$radius</strong>    El radio del arco
  <info>float</info>     <strong>$angle</strong>     El ángulo del arco
  <info>float</info>     <strong>$sweep</strong>     El alcance del arco
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Draw Bezier Curve
  
  Shall draw a bezier curve

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point at which to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the curve
  <info>float</info>     <strong>$angle</strong>     The angle of the curve
  <info>float</info>     <strong>$sweep</strong>     The sweep of the curve
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Dibuja una línea
  
  Trazará la ruta para una línea

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     El punto de partida del mapeo
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Dibuja figura
  
  Trazará una nueva figura en el punto dado

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  El punto de partida del mapeo


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Dibuja figura con arco

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and
  writing to Draw Paths.


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Clip a Path
  
  Shall clip the given Path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  The path to clip


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Llena una ruta
  
  Llenará la ruta dada

<comment>Param:</comment>
  <info>UI\Draw\Path</info>   <strong>$path</strong>  La ruta a llenar
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  El color o el pincel para rellenar


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Traza una ruta
  
  Trazará la ruta dada

<comment>Param:</comment>
  <info>UI\Draw\Path</info>    <strong>$path</strong>    La ruta del trazo
  <info>UI\Draw\Brush</info>   <strong>$with</strong>    El color o el pincel con el que trazar
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  La configuración del trazo


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Transformación de la matriz
  
  Realizará la transformación de la matriz

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  La matriz a usar


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Dibuja el texto en el punto
  
  Dibujará la disposición del texto en el punto dado

<comment>Param:</comment>
  <info>UI\Point</info>             <strong>$point</strong>   El punto a realizar el dibujo
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  La disposición del texto a dibujar


id: UI\Draw\Stroke::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo trazo
  
  Construirá un nuevo trazo

<comment>Param:</comment>
  <info>int</info>    <strong>$cap</strong>         UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, o UI\Draw\Line\Cap::Square
  <info>int</info>    <strong>$join</strong>        UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness</strong>   El grosor del trazo
  <info>float</info>  <strong>$miterLimit</strong>  Límite de inglete (el valor por defecto es válido para todas las plataformas)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Get Line Cap
  
  Shall retrieve the line cap setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Obtiene la unión de línea
  
  Recuperaremos el ajuste de la línea de unión de este trazo

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Obtiene el límite de inglete
  
  Recuperará el límite de ingletes de este trazo

<comment>Return:</comment>
  <info>float</info>  El actual límite de ingletes


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Obtiene el grosor
  
  Recuperará el grosor de este trazo

<comment>Return:</comment>
  <info>float</info>  El grosor actual


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Set Line Cap
  
  Shall set the line cap setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Establece la línea de unión
  
  Establecerá la línea de unión para este trazo

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, o UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Establece el límite de ingletes
  
  Establece el límite de ingletes para este trazo

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  El nuevo límite


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Establece el grosor
  
  Establecerá el grosor de este trazo

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  El nuevo grosor


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Construye una nueva fuente
  
  Construirá una nueva fuente usando el descriptor dado

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  El descriptor de la fuente


id: UI\Draw\Text\Font::getAscent
type: function
doc:
<comment>Description:</comment>
  Métricas de la fuente

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font Descriptor
  
  Shall construct a new Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family</strong>   The name of a valid family of fonts
  <info>float</info>   <strong>$size</strong>     The preferred size
  <info>int</info>     <strong>$weight</strong>   UI\Draw\Text\Font\Weight constant
  <info>int</info>     <strong>$italic</strong>   UI\Draw\Text\Font\Italic constant
  <info>int</info>     <strong>$stretch</strong>  UI\Draw\Text\Font\Stretch constant


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Get Font Family
  
  Shall return the requested font family

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


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return constant setting

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


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Size Detection
  
  Shall return the requested size

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return requested stretch

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


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Weight Detection
  
  Shall return requested weight

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


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Recuperar las familias de fuentes
  
  Devuelve un array con las familas de fuentes válidas para el sistema actual

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


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  A Text Layout represents the layout of text which will be drawn by the Pen


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Construir un nuevo diseño de texto
  
  Construirá un nuevo diseño de texto

<comment>Param:</comment>
  <info>string</info>             <strong>$text</strong>   El texto para el diseño
  <info>UI\Draw\Text\Font</info>  <strong>$font</strong>   El tipo de letra a utilizar para escribir
  <info>float</info>              <strong>$width</strong>  El ancho del diseño


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Establece el color
  
  Establecerá el color para todo o un rango del texto en el diseño

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  El color a usar
  <info>int</info>            <strong>$start</strong>  El carácter inicial
  <info>int</info>            <strong>$end</strong>    El carácter final, por defecto el final del string


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Establece el ancho
  
  Establecerá el ancho del diseño del texto

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  El nuevo ancho


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  This facility schedules repetitive execution of a callback, useful for animations and other such
  activities.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Executor
  
  Shall construct an executor with the given interval, will not start executing until main loop is
  entered

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       Seconds between executions
  <info>int</info>  <strong>$microseconds</strong>  Microseconds between executions


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Stop Executor
  
  Shall stop an executor, the executor cannot be restarted

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


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Execution Callback
  
  Shall be repetitively queued for execution in the main thread

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


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Interval Manipulation
  
  Shall set the new interval. An interval of 0 will pause the executor until a new interval has been
  set

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Menus must be constructed before the first Window, and can be shown on any Window


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo menú
  
  Construirá un nuevo menú

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre (texto) del menú


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Añade elemento de menú
  
  Añadirá un nuevo elemento del menú

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre (texto) del nuevo elemento
  <info>string</info>  <strong>$type</strong>  El tipo para el nuevo elemento

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Un objeto construido del tipo dado


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Añade elemento de menú Acerca de
  
  Se añadirá un elemento del menú Acerca de

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  El tipo para el nuevo elemento

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Un elemento del menú Acerca de construido del tipo dado


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Añade un elemento de menú comprobable
  
  Se añadirá un elemento del menú comprobable

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  El nombre (texto) del nuevo elemento
  <info>string</info>  <strong>$type</strong>  El tipo para el nuevo elemento

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Un elemento de menú construido y comprobable del tipo dado


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Añade elemento de menú de preferencias
  
  Se añadirá un elemento del menú de Preferencias

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  El tipo para el nuevo elemento

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Un elemento de menú de Preferencias construido del tipo dado


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Añade elemento de menú salir
  
  Se añadirá un elemento del menú de salida

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  El tipo para el nuevo elemento

<comment>Return:</comment>
  <info>UI\MenuItem</info>  Un elemento del menú de salida construido del tipo dado


id: UI\Menu::appendSeparator
type: function
doc:
<comment>Description:</comment>
  Añade separador de elementos del menú
  
  Se añadirá un separador


id: UI\MenuItem::disable
type: function
doc:
<comment>Description:</comment>
  Desactiva elemento del menú
  
  Desactivará este elemento del menú


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Detecta Marcado
  
  Detecta si este elemento del menú está marcado

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


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  Llamada de retorno On Click
  
  Se ejecutará cuando se haga clic en este elemento del menú


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Establece marcado
  
  Establecerá el estado marcado de este elemento del menú

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  El nuevo estado


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Points are used throughout UI to represent co-ordinates on a screen, control, or area.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo punto
  
  Construye un nuevo punto usando nuevas coordenadas

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  La nueva coordenada X
  <info>float</info>  <strong>$y</strong>  La nueva coordenada Y


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Tamaño de coerción
  
  Devolverá un objeto de punto UI donde x y y son iguales a los suministrados, ya sea en forma
  flotante o de tamaño UI.

<comment>Param:</comment>
  <info>float</info>    <strong>$point</strong>  El valor de x y y
  <info>UI\Size</info>  <strong>$size</strong>   El tamaño a convertir

<comment>Return:</comment>
  <info>UI\Point</info>  El punto resultante


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Recupera X
  
  Recupera la coordenada X

<comment>Return:</comment>
  <info>float</info>  La coordenada X actual


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Recupera Y
  
  Recupera la coordenada Y

<comment>Return:</comment>
  <info>float</info>  La coordenada Y actual


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Establece X
  
  Establece la coordenada X

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  La nueva coordenada X


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Establece Y
  
  Establece la coordenada Y

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  La nueva coordenada Y


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Sizes are used throughout UI to represent the size of a screen, control, or area.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo tamaño
  
  Construye un nuevo tamaño usando un nuevo ancho y alto

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>   El nuevo ancho
  <info>float</info>  <strong>$height</strong>  El nuevo alto


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Recupera la altura
  
  Recupera la altura

<comment>Return:</comment>
  <info>float</info>  La altura actual


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Recupera el ancho
  
  Recupera el ancho

<comment>Return:</comment>
  <info>float</info>  El ancho actual


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Punto de coerción
  
  Devolverá un objeto de tamaño UI en el que el ancho y la altura son iguales a los suministrados,
  ya sea en forma flotante o en forma de UI.

<comment>Param:</comment>
  <info>float</info>     <strong>$size</strong>   El valor de la anchura y la altura
  <info>UI\Point</info>  <strong>$point</strong>  El punto a convertir

<comment>Return:</comment>
  <info>UI\Size</info>  El tamaño resultante


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Establece la altura
  
  Establece una nueva altura

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  La nueva altura


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Establece el ancho
  
  Establece un nuevo ancho

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  El nuevo ancho


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Construye una nueva ventana
  
  Construirá una nueva ventana

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  El título de la Ventana
  <info>Size</info>    <strong>$size</strong>   El tamaño de la Ventana
  <info>bool</info>    <strong>$menu</strong>   Interruptor del menú


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Añade un control
  
  Añadirá un control a esta ventana

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  El control a añadir


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Mostrar cuadro de error
  
  Mostrará un cuadro de error

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  El título del cuadro de error
  <info>string</info>  <strong>$msg</strong>    El mensaje para el cuadro de error


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Obtiene el tamaño de la ventana
  
  Devolverá el tamaño de esta ventana

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Obtiene el título
  
  Recuperará el título de esta Ventana

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


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Detección del Borde
  
  Detectará si se usan bordes en esta ventana

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


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Detección de Margen
  
  Detectará si se usan márgenes en esta ventana

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


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Detección de pantalla completa
  
  Detectará si esta ventana se utiliza toda la pantalla

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


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Mostrar Cuadro de Mensajes
  
  Mostrará un cuadro de mensajes

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  El título del cuadro de mensajes
  <info>string</info>  <strong>$msg</strong>    El mensaje


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Cierre de la devolución de llamada
  
  Debería destruir con agilidad esta ventana

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


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Abrir Diálogo
  
  Mostrará un diálogo de archivo abierto

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre del archivo seleccionado para su apertura


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Guarda Diálogo
  
  Mostrará un diálogo a guardar

<comment>Return:</comment>
  <info>string</info>  Devuelve el nombre del archivo seleccionado para ser guardado


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Uso de Bordes
  
  Habilitará o deshabilitará el uso de los bordes en esta ventana

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


id: UI\Window::setFullScreen
type: function
doc:
<comment>Description:</comment>
  Uso de la pantalla completa
  
  Activará o desactivará el uso de la pantalla completa para esta ventana
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Uso del Margen
  
  Habilitará o deshabilitará el uso de los márgenes para esta Ventana

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


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Establece Tamaño
  
  Establecerá el tamaño de esta ventana

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Título de la Vetana
  
  Pondrá el título de esta ventana

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  El nuevo título


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Quit UI Loop
  
  Shall cause the main loop to be exited

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


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Enter UI Loop
  
  Shall cause PHP to enter into the main loop, by default control will not be returned to the caller

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Set UI\Loop to return control, and UI\Wait to return control after waiting

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


id: UnitEnum
type: class
doc:
<comment>Description:</comment>
  The <class>UnitEnum</class> interface is automatically applied to all enumerations by the engine.  It may not be
  implemented by user-defined classes. Enumerations may not override its methods, as default
  implementations are provided by the engine.  It is available only for type checks.


id: UnitEnum::cases
type: function
doc:
<comment>Description:</comment>
  Generates a list of cases on an enum
  
  This method will return a packed array of all cases in an enumeration, in order of declaration.

<comment>Return:</comment>
  <info>array</info>  An array of all defined cases of this enumeration, in order of declaration.


id: V8Js
type: class
doc:
<comment>Description:</comment>
  Esta es la clase principal para la extensión de V8Js. Cada instancia creada a partir de esta clase
  tiene su propio contexto en el que todo el Javascript es compilado y ejecutado.
  
  Véase <strong>V8Js::__construct()</strong> para más información.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name</strong>                 The name of the object passed to Javascript.
  <info>array</info>   <strong>$variables</strong>                   Map of PHP variables that will be available in Javascript.
                                       Must be an associative <info>array</info> in format <return>array("name-for-js"
                                       =&gt; "name-of-php-variable")</return>. Defaults to empty array.
  <info>array</info>   <strong>$extensions</strong>                  List of extensions registered using <strong>V8Js::registerExtension()</strong>
                                       which should be available  in the Javascript context of the
                                       created <class>V8Js</class> object.  Extensions registered to be enabled
                                       automatically do not need to be listed in this array. Also if
                                       an extension has dependencies, those dependencies can be
                                       omitted as well. Defaults to empty array.
                                       
                                       Extensions registered to be enabled automatically do not need
                                       to be listed in this array. Also if an extension has
                                       dependencies, those dependencies can be omitted as well.
                                       Defaults to empty array.
  <info>bool</info>    <strong>$report_uncaught_exceptions</strong>  Controls whether uncaught Javascript exceptions are reported
                                       immediately or not. Defaults to <info>true</info>. If set to <info>false</info> the
                                       uncaught exception can be accessed using
                                       <strong>V8Js::getPendingException()</strong>.


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  Execute a string as Javascript code
  
  Compiles and executes the string passed with <strong>$script</strong> as Javascript code.

<comment>Param:</comment>
  <info>string</info>  <strong>$script</strong>      The code string to be executed.
  <info>string</info>  <strong>$identifier</strong>  Identifier string for the executed code. Used for debugging.
  <info>int</info>     <strong>$flags</strong>       Execution flags. This value must be one of the <return>V8Js::FLAG_*</return> constants,
                       defaulting to <info>V8Js::FLAG_NONE</info>. <info>V8Js::FLAG_NONE</info>: no flags
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays
                       
                       <info>V8Js::FLAG_NONE</info>: no flags
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info>: forces all Javascript objects passed to PHP to be
                       associative arrays

<comment>Return:</comment>
  <info>mixed</info>  Returns the last variable instantiated in the Javascript code converted to matching PHP
         variable type.


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  Devolver un array de extensiones registradas
  
  Esta función devuelve el array de extensiones Javascript registradas mediante
  <strong>V8Js::registerExtension()</strong>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array de extensiones registradas o un array vacío si no hay ninguna.


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  Return pending uncaught Javascript exception
  
  Returns any pending uncaught Javascript exception as <class>V8JsException</class> left from earlier
  <strong>V8Js::executeString()</strong> call(s).

<comment>Return:</comment>
  <info>V8JsException</info>  Either <class>V8JsException</class> or <info>null</info>.


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  Register Javascript extensions for V8Js
  
  Registers passed Javascript <strong>$script</strong> as extension to be used in <class>V8Js</class> contexts.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  Name of the extension to be registered.
  <info>string</info>  <strong>$script</strong>          The Javascript code to be registered.
  <info>array</info>   <strong>$dependencies</strong>    Array of extension names the extension to be registered depends on. Any
                           such extension is enabled automatically when this extension is loaded.
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
                           
                           All extensions, including the dependencies, must be registered before any
                           <class>V8Js</class> are created which use them.
  <info>bool</info>    <strong>$auto_enable</strong>     If set to <info>true</info>, the extension will be enabled automatically in all <class>V8Js</class>
                           contexts.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if extension was registered successfully, <info>false</info> otherwise.


id: V8JsException::getJsFileName
type: function
doc:
<comment>Description:</comment>
  El propósito getJsFileName
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: V8JsException::getJsLineNumber
type: function
doc:
<comment>Description:</comment>
  El propósito getJsLineNumber
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: V8JsException::getJsSourceLine
type: function
doc:
<comment>Description:</comment>
  El propósito getJsSourceLine
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: V8JsException::getJsTrace
type: function
doc:
<comment>Description:</comment>
  El propósito getJsTrace
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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


id: VARCMP_GT
type: constant
doc:
<comment>Description:</comment>
  El <return>bstr</return> izquierdo es mayor que el <return>bstr</return> derecho.


id: VARCMP_LT
type: constant
doc:
<comment>Description:</comment>
  El <return>bstr</return> izquierdo es menor que el <return>bstr</return> derecho.


id: VAR_REPRESENTATION_SINGLE_LINE
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that newlines  should not be used for whitespace in variable
  representations.


id: VAR_REPRESENTATION_UNESCAPED
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that strings should be encoded as single quoted strings with
  unescaped control characters.


id: VIRTUALPIXELMETHOD_HORIZONTALTILE
type: constant
doc:
<comment>Description:</comment>
  Esta constante está disponible si Imagick ha sido compilado con ImageMagick en su versión  6.4.3 o
  superior.


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  Si el indicador de tipo se combina con <info>VT_ARRAY</info> mediante un operador OR, el valor es un puntero a
  un <return>SAFEARRAY</return>. <info>VT_ARRAY</info>  puede usar OR con los siguientes tipos de datos: <info>VT_I1</info>,  <info>VT_UI1</info>, <info>VT_I2</info>,
  <info>VT_UI2</info>,  <info>VT_I4</info>, <info>VT_UI4</info>, <info>VT_INT</info>,  <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>,  <info>VT_BOOL</info>, <info>VT_DECIMAL</info>, <info>VT_ERROR</info>,  <info>VT_CY</info>,
  <info>VT_DATE</info>, <info>VT_BSTR</info>,  <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> y  <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  Si el indicador de tipo se combina con <info>VT_BYREF</info>  mediante un operador OR, el valor es una
  referencia. Los tipos de referencias son interpretados como una referencia a datos, similar al
  tipo de referencia en C++.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  Un número de coma flotante de 64 bits que representa el número de días (no segundos) desde el 31
  de diciembre de 1899. Por ejemplo, <return>January 1, 1900</return>, es 2.0, <return>January 2, 1900</return>,  es 3.0, y así
  sucesivamente). Se almacena con la misma representación que <info>VT_R8</info>.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Una propiedad con un indicador de tipo <info>VT_EMPTY</info> no tiene información asociada a ella; es decir, el
  tamaño del valor es cero.


id: VT_ERROR
type: constant
doc:
<comment>Description:</comment>
  Código de error; contienen el código de estado asociado con el error.


id: VT_INT
type: constant
doc:
<comment>Description:</comment>
  Valor integer con signo de 4 bytes (equivalente a <info>VT_I4</info>).


id: VT_UINT
type: constant
doc:
<comment>Description:</comment>
  Valor integer sin signo de 4 bytes (equivalente a <info>VT_UI4</info>).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  Un indicador de tipo seguido del valor correspondiente. <info>VT_VARIANT</info> sólo se puede usar con
  <info>VT_BYREF</info>.


