# php_manual

id: MongoDB\Driver\ClientEncryption::encryptExpression
type: function
doc:
<comment>Description:</comment>
  Encrypts a match or aggregate expression
  
  Encrypts a match or aggregate expression to query a range index.
  
  To query with a range encrypted payload, the <class>MongoDB\Driver\Manager</class> must be configured with the
  <return>"autoEncryption"</return> driver option. The <return>"bypassQueryAnalysis"</return> auto encryption option may be <info>true</info>. The
  <return>"bypassAutoEncryption"</return> auto encryption option must be <info>false</info>.
  
  The range algorithm is experimental only. It is not intended for public use.
  
  The PHP driver does not yet support range queries for decimal128 BSON field types.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$expr</strong>     The match or aggregate expression to be encrypted. Expressions must use at
                          least one of the <return>$gt</return>, <return>$gte</return>, <return>$lt</return>, or <return>$lte</return> operators. A top-level <return>$and</return>
                          operator is required, even if only a single comparison operator is used.
                          
                          An example of a supported match expression (applies to queries and the
                          <return>$match</return> aggregation stage) is as follows:
                          
                          An example of a supported aggregate expression is as follows:
  <info>array|null</info>    <strong>$options</strong>  Encryption optionsOptionTypeDescriptionalgorithm<info>string</info> The encryption
                          algorithm to be used. This option is required. Specify one of the
                          following ClientEncryption constants:
                          <info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC</info><info>MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED</info><info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>contentionFactor<info>int</info>
                          The contention factor for evaluating queries with indexed, encrypted
                          payloads.  This option only applies and may only be specified when
                          <return>algorithm</return> is <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                          Identifies a key vault collection document by <return>keyAltName</return>. This option is
                          mutually exclusive with <return>keyId</return> and exactly one is required.
                          keyId<class>MongoDB\BSON\Binary</class> Identifies a data key by <return>_id</return>. The value is a UUID
                          (binary subtype 4). This option is mutually exclusive with <return>keyAltName</return> and
                          exactly one is required. queryType<info>int</info> The query type for evaluating
                          queries with indexed, encrypted payloads. Specify one of the following
                          ClientEncryption constants:
                          <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>This
                          option only applies and may only be specified when <return>algorithm</return> is
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                          Index options for a queryable encryption field supporting "rangePreview"
                          queries. The options below must match the values set in the
                          <return>encryptedFields</return> of the target collection. For double and decimal128 BSON
                          field types, <return>min</return>, <return>max</return>, and <return>precision</return> must all be set, or all be unset.
                          Range index optionsOptionTypeDescriptionmin<info>mixed</info>Required if <return>precision</return> is
                          set.max<info>mixed</info>Required if <return>precision</return> is
                          set.sparsity<info>int</info>Required.precision<info>int</info>Optional. May only be set for double
                          or decimal128 BSON field types.
                          
                          The encryption algorithm to be used. This option is required. Specify one
                          of the following ClientEncryption constants:
                          
                          The contention factor for evaluating queries with indexed, encrypted
                          payloads.
                          
                          This option only applies and may only be specified when <return>algorithm</return> is
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Identifies a key vault collection document by <return>keyAltName</return>. This option is
                          mutually exclusive with <return>keyId</return> and exactly one is required.
                          
                          Identifies a data key by <return>_id</return>. The value is a UUID (binary subtype 4). This
                          option is mutually exclusive with <return>keyAltName</return> and exactly one is required.
                          
                          The query type for evaluating queries with indexed, encrypted payloads.
                          Specify one of the following ClientEncryption constants:
                          
                          This option only applies and may only be specified when <return>algorithm</return> is
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> or
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Index options for a queryable encryption field supporting "rangePreview"
                          queries. The options below must match the values set in the
                          <return>encryptedFields</return> of the target collection. For double and decimal128 BSON
                          field types, <return>min</return>, <return>max</return>, and <return>precision</return> must all be set, or all be unset.
                          
                          Range index optionsOptionTypeDescriptionmin<info>mixed</info>Required if <return>precision</return> is
                          set.max<info>mixed</info>Required if <return>precision</return> is
                          set.sparsity<info>int</info>Required.precision<info>int</info>Optional. May only be set for double
                          or decimal128 BSON field types.

<comment>Return:</comment>
  <info>object</info>  Returns the encrypted expression as an object.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\ClientEncryption::getKey
type: function
doc:
<comment>Description:</comment>
  Gets a key document
  
  Finds a single key document in the key vault collection with the given UUID <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>  A <class>MongoDB\BSON\Binary</class> instance with subtype 4 (UUID) identifying the
                               key document.

<comment>Return:</comment>
  <info>object|null</info>  Returns the key document, or <info>null</info> if no document matched.


id: MongoDB\Driver\ClientEncryption::getKeyByAltName
type: function
doc:
<comment>Description:</comment>
  Gets a key document by an alternate name
  
  Finds a single key document in the key vault collection with the given alternate name <strong>$keyAltName</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$keyAltName</strong>  Alternate name for the key document.

<comment>Return:</comment>
  <info>object|null</info>  Returns the key document, or <info>null</info> if no document matched.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::addKeyAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::removeKeyAltName()</strong>


id: MongoDB\Driver\ClientEncryption::getKeys
type: function
doc:
<comment>Description:</comment>
  Gets all key documents
  
  Finds all key documents in the key vault collection.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.


id: MongoDB\Driver\ClientEncryption::removeKeyAltName
type: function
doc:
<comment>Description:</comment>
  Removes an alternate name from a key document
  
  Removes <strong>$keyAltName</strong> from the set of alternate names for the key document with the given UUID
  <strong>$keyId</strong>.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$keyId</strong>       A <class>MongoDB\BSON\Binary</class> instance with subtype 4 (UUID) identifying
                                    the key document.
  <info>string</info>               <strong>$keyAltName</strong>  Alternate name to remove from the key document.

<comment>Return:</comment>
  <info>object|null</info>  Returns the previous version of the key document, or <info>null</info> if no document matched.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::addKeyAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::getKeyByAltName()</strong>


id: MongoDB\Driver\ClientEncryption::rewrapManyDataKey
type: function
doc:
<comment>Description:</comment>
  Rewraps data keys
  
  Rewraps (i.e. decrypts and re-encrypts) zero or more data keys in the key vault collection that
  match the given <strong>$filter</strong>.
  
  If the <return>"provider"</return> option is not specified, matching data keys will be rewrapped with their current
  KMS provider. Otherwise, matching data keys will be re-encrypted according to the specified
  <return>"provider"</return> and <return>"masterKey"</return> options.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>   El predicado de la consulta. Un predicado vacío coincidirá con todos los
                          documentos de una colección.
                          
                          Al evaluar criterios de consulta, MongoDB compara tipos y valores según
                          sus propias reglas de comparación para tipos BSON, lo cual difiere de las
                          reglas de comparación y manejo de tipos de PHP. Al encontrar un tipo BSON
                          especial, los criterios de consulta deben utilizar la clase BSON
                          respectiva (p.ej. usar <class>MongoDB\BSON\ObjectID</class> al encontrar un ObjectID).
  <info>array|null</info>    <strong>$options</strong>  RewrapManyDataKey optionsOptionTypeDescriptionprovider<info>string</info> The KMS
                          provider (e.g. <return>"local"</return>, <return>"aws"</return>) that will be used to re-encrypt the matched
                          data keys.  If a KMS provider is not specified, matched data keys will be
                          re-encrypted with their current KMS provider. masterKey<info>array</info> The masterKey
                          identifies a KMS-specific key used to encrypt the new data key. This
                          option should not be specified without the <return>"provider"</return> option. This option
                          is required if <return>"provider"</return> is specified and not <return>"local"</return>. <return>"aws"</return> provider
                          optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The
                          Amazon Resource Name (ARN) to the AWS customer master key
                          (CMK).endpointstringOptional. An alternate host identifier to send KMS
                          requests to. May include port number.<return>"azure"</return> provider
                          optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with
                          optional port (e.g.
                          "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional.
                          A specific version of the named key. Defaults to using the key's primary
                          version.<return>"gcp"</return> provider
                          optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional.
                          A specific version of the named key. Defaults to using the key's primary
                          version.endpointstringOptional. Host with optional port. Defaults to
                          "cloudkms.googleapis.com".<return>"kmip"</return> provider
                          optionsOptionTypeDescriptionkeyIdstringOptional. Unique identifier to a
                          96-byte KMIP secret data managed object. If unspecified, the driver
                          creates a random 96-byte KMIP secret data managed
                          object.endpointstringOptional. Host with optional port.
                          
                          The KMS provider (e.g. <return>"local"</return>, <return>"aws"</return>) that will be used to re-encrypt the
                          matched data keys.
                          
                          If a KMS provider is not specified, matched data keys will be re-encrypted
                          with their current KMS provider.
                          
                          The masterKey identifies a KMS-specific key used to encrypt the new data
                          key. This option should not be specified without the <return>"provider"</return> option.
                          This option is required if <return>"provider"</return> is specified and not <return>"local"</return>.
                          
                          <return>"aws"</return> provider
                          optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The
                          Amazon Resource Name (ARN) to the AWS customer master key
                          (CMK).endpointstringOptional. An alternate host identifier to send KMS
                          requests to. May include port number.
                          
                          <return>"azure"</return> provider
                          optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with
                          optional port (e.g.
                          "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional.
                          A specific version of the named key. Defaults to using the key's primary
                          version.
                          
                          <return>"gcp"</return> provider
                          optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional.
                          A specific version of the named key. Defaults to using the key's primary
                          version.endpointstringOptional. Host with optional port. Defaults to
                          "cloudkms.googleapis.com".
                          
                          <return>"kmip"</return> provider optionsOptionTypeDescriptionkeyIdstringOptional. Unique
                          identifier to a 96-byte KMIP secret data managed object. If unspecified,
                          the driver creates a random 96-byte KMIP secret data managed
                          object.endpointstringOptional. Host with optional port.

<comment>Return:</comment>
  <info>object</info>  Returns an object, which will have an optional <return>bulkWriteResult</return> property containing the
          result of the internal <return>bulkWrite</return> operation as an object. If no data keys matched the
          filter or the write was unacknowledged, the <return>bulkWriteResult</return> property will be <info>null</info>.


id: MongoDB\Driver\Command
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Command</class> class is a value object that represents a database command.
  
  To provide Command Helpers the <class>MongoDB\Driver\Command</class> object should be composed.


id: MongoDB\Driver\Command::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Command
  
  Constructs a new <class>MongoDB\Driver\Command</class>, which is an immutable value object that represents a
  database command. The command may then be executed with MongoDB\Driver\Manager::executeCommand.
  
  The complete command document, which includes the command name and its options, should be
  expressed in the <strong>$document</strong> parameter. The <strong>$commandOptions</strong> parameter is only used to specify
  options related to the execution of the command and the resulting <class>MongoDB\Driver\Cursor</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$document</strong>        The complete command document, which will be sent to the server.
  <info>array|null</info>    <strong>$commandOptions</strong>  Do not use this parameter to specify options described in the
                                 command's reference in the MongoDB manual. This parameter should
                                 only be used for the options explicitly listed below.
                                 
                                 commandOptionsOptionTypeDescriptionmaxAwaitTimeMS<info>int</info> Positive
                                 integer denoting the time limit in milliseconds for the server to
                                 block a getMore operation if no data is available. This option
                                 should only be used in conjunction with commands that return a
                                 tailable cursor (e.g. Change Streams).
                                 
                                 Positive integer denoting the time limit in milliseconds for the
                                 server to block a getMore operation if no data is available. This
                                 option should only be used in conjunction with commands that return
                                 a tailable cursor (e.g. Change Streams).

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeCommand
   * <class>MongoDB\Driver\Cursor</class>


id: MongoDB\Driver\Cursor
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Cursor</class> class encapsulates the results of a MongoDB command or query and may be
  returned by MongoDB\Driver\Manager::executeCommand or MongoDB\Driver\Manager::executeQuery,
  respectively.


id: MongoDB\Driver\Cursor::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Cursor (not used)
  
  <class>MongoDB\Driver\Cursor</class> objects are returned as the result of an executed command or query and
  cannot be constructed directly.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeQuery()</strong>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeQuery()</strong>


id: MongoDB\Driver\Cursor::current
type: function
doc:
<comment>Description:</comment>
  Returns the current element

<comment>Return:</comment>
  <info>array|object|null</info>  Returns the current result document as an array or object, depending on the
                     cursor's type map. If iteration has not started or the current position is not
                     valid, <info>null</info> will be returned.

<comment>See Also:</comment>
   * Iterator::current


id: MongoDB\Driver\Cursor::getId
type: function
doc:
<comment>Description:</comment>
  Returns the ID for this cursor
  
  Returns the <class>MongoDB\Driver\CursorId</class> associated with this cursor. A cursor ID uniquely identifies
  the cursor on the server.

<comment>Return:</comment>
  <info>MongoDB\Driver\CursorId</info>  Returns the <class>MongoDB\Driver\CursorId</class> for this cursor.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\CursorId</class>
   * <strong>MongoDB\Driver\CursorId::__toString()</strong>


id: MongoDB\Driver\Cursor::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the server associated with this cursor
  
  Returns the <class>MongoDB\Driver\Server</class> associated with this cursor. This is the server that executed
  the <class>MongoDB\Driver\Query</class> or <class>MongoDB\Driver\Command</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> associated with this cursor.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\Cursor::isDead
type: function
doc:
<comment>Description:</comment>
  Checks if the cursor is exhausted or may have additional results
  
  Checks whether there are definitely no additional results available on the cursor. This method is
  similar to the cursor.isExhausted() method in the MongoDB shell and is primarily useful when
  iterating tailable cursors.
  
  A cursor has no additional results and is considered "dead" when one of the following is true:
  The current batch has been fully iterated and the cursor ID is zero (i.e. a  getMore cannot be
  issued). An error was encountered while iterating the cursor.The cursor reached its configured
  limit.
  
  By design, it is not possible to always determine whether a cursor has additional results. The
  cases where a cursor may have more data available is as follows:  There are additional documents
  in the current batch, which are buffered on the client side. Iterating will fetch a document from
  the local buffer.  There are no additional documents in the current batch (i.e. local buffer), but
  the cursor ID is non-zero. Iterating will request more documents from the server via a getMore
  operation, which may or may not return additional results and/or indicate that the cursor has been
  closed on the server by returning zero for its ID.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if there are definitely no additional results available on the cursor, and
        <info>false</info> otherwise.

<comment>See Also:</comment>
   * Tailable Cursors in the MongoDB manual
   * cursor.isExhausted() in the MongoDB manual


id: MongoDB\Driver\Cursor::key
type: function
doc:
<comment>Description:</comment>
  Returns the current result's index within the cursor

<comment>Return:</comment>
  <info>int</info>  The current result's numeric index within the cursor.

<comment>See Also:</comment>
   * Iterator::key


id: MongoDB\Driver\Cursor::next
type: function
doc:
<comment>Description:</comment>
  Advances the cursor to the next result

<comment>Return:</comment>
  <info>void</info>  Moves the current position to the next element in the cursor.

<comment>See Also:</comment>
   * Iterator::next


id: MongoDB\Driver\Cursor::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the cursor to the first result
  
  If the cursor has advanced beyond its first position, it can no longer be rewound.

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

<comment>See Also:</comment>
   * Iterator::rewind


id: MongoDB\Driver\Cursor::setTypeMap
type: function
doc:
<comment>Description:</comment>
  Sets a type map to use for BSON unserialization
  
  Sets the type map configuration to use when unserializing the BSON results into PHP values.

<comment>Param:</comment>
  <info></info>  <strong>$typeMap</strong>  Configuración del mapa de tipos.

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

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Cursor::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array containing all results for this cursor
  
  Iterates the cursor and returns its results in an array. <strong>MongoDB\Driver\Cursor::setTypeMap()</strong> may
  be used to control how documents are unserialized into PHP values.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all results for this cursor.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::setTypeMap()</strong>


id: MongoDB\Driver\Cursor::valid
type: function
doc:
<comment>Description:</comment>
  Checks if the current position in the cursor is valid

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the current cursor position is valid, <info>false</info> otherwise.

<comment>See Also:</comment>
   * Iterator::valid


id: MongoDB\Driver\CursorId
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\CursorID</class> class is a value object that represents a cursor ID. Instances of this
  class are returned by <strong>MongoDB\Driver\Cursor::getId()</strong>.


id: MongoDB\Driver\CursorId::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new CursorId (not used)
  
  <class>MongoDB\Driver\CursorId</class> objects are returned from <strong>MongoDB\Driver\Cursor::getId()</strong> and cannot be
  constructed directly.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::getId()</strong>


id: MongoDB\Driver\CursorId::__toString
type: function
doc:
<comment>Description:</comment>
  String representation of the cursor ID
  
  Returns the <info>string</info> representation of the cursor ID.

<comment>Return:</comment>
  <info>string</info>  Returns the <info>string</info> representation of the cursor ID.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Cursor::getId()</strong>


id: MongoDB\Driver\CursorId::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a CursorId

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\Driver\CursorId</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\CursorId::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\CursorId::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a CursorId

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\Driver\CursorId</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\CursorId::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\CursorInterface
type: class
doc:
<comment>Description:</comment>
  This interface is implemented by <class>MongoDB\Driver\Cursor</class> to be used as a parameter, return, or
  property type in userland classes.


id: MongoDB\Driver\CursorInterface::getId
type: function
doc:
<comment>Description:</comment>
  Returns the ID for this cursor
  
  Returns the <class>MongoDB\Driver\CursorId</class> associated with this cursor. A cursor ID uniquely identifies
  the cursor on the server.

<comment>Return:</comment>
  <info>MongoDB\Driver\CursorId</info>  Returns the <class>MongoDB\Driver\CursorId</class> for this cursor.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::getId
   * <class>MongoDB\Driver\CursorId</class>
   * <strong>MongoDB\Driver\CursorId::__toString()</strong>


id: MongoDB\Driver\CursorInterface::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the server associated with this cursor
  
  Returns the <class>MongoDB\Driver\Server</class> associated with this cursor. This is the server that executed
  the <class>MongoDB\Driver\Query</class> or <class>MongoDB\Driver\Command</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> associated with this cursor.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::getServer
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\CursorInterface::isDead
type: function
doc:
<comment>Description:</comment>
  Checks if the cursor may have additional results
  
  Checks whether the cursor may have additional results available to read. A cursor is initially
  "alive" but may become "dead" for any of the following reasons: Advancing a non-tailable cursor
  did not return a documentThe cursor encountered an errorThe cursor read its last batch to
  completionThe cursor reached its configured limit This is primarily useful with tailable cursors.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if additional results are not available, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::isDead


id: MongoDB\Driver\CursorInterface::setTypeMap
type: function
doc:
<comment>Description:</comment>
  Sets a type map to use for BSON unserialization
  
  Sets the type map configuration to use when unserializing the BSON results into PHP values.

<comment>Param:</comment>
  <info></info>  <strong>$typeMap</strong>  Configuración del mapa de tipos.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::setTypeMap
   * 


id: MongoDB\Driver\CursorInterface::toArray
type: function
doc:
<comment>Description:</comment>
  Returns an array containing all results for this cursor
  
  Iterates the cursor and returns its results in an array.
  <strong>MongoDB\Driver\CursorInterface::setTypeMap()</strong> may be used to control how documents are unserialized
  into PHP values.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> containing all results for this cursor.

<comment>See Also:</comment>
   * MongoDB\Driver\Cursor::toArray
   * <strong>MongoDB\Driver\CursorInterface::setTypeMap()</strong>


id: MongoDB\Driver\Exception\CommandException::getResultDocument
type: function
doc:
<comment>Description:</comment>
  Returns the result document for the failed command
  
  Returns the result document for the failed command.

<comment>Return:</comment>
  <info>object</info>  The result document for the failed command.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>


id: MongoDB\Driver\Exception\ConnectionException
type: class
doc:
<comment>Description:</comment>
  Base class for exceptions thrown when the driver fails to establish a database connection.


id: MongoDB\Driver\Exception\ConnectionTimeoutException
type: class
doc:
<comment>Description:</comment>
  Thrown when the driver fails to establish a database connection within a specified time limit
  (connectTimeoutMS) or server selection fails (serverSelectionTimeoutMS).


id: MongoDB\Driver\Exception\Exception
type: class
doc:
<comment>Description:</comment>
  Common interface for all driver exceptions. This may be used to catch only exceptions originating
  from the driver itself.


id: MongoDB\Driver\Exception\ExecutionTimeoutException
type: class
doc:
<comment>Description:</comment>
  Thrown when a query or command fails to complete within a specified time limit (e.g. maxTimeMS).


id: MongoDB\Driver\Exception\InvalidArgumentException
type: class
doc:
<comment>Description:</comment>
  Thrown when a driver method is given invalid arguments (e.g. invalid option types).


id: MongoDB\Driver\Exception\LogicException
type: class
doc:
<comment>Description:</comment>
  Thrown when the driver is incorrectly used (e.g. rewinding a cursor).


id: MongoDB\Driver\Exception\RuntimeException
type: class
doc:
<comment>Description:</comment>
  Thrown when the driver encounters a runtime error (e.g. internal error from libmongoc).


id: MongoDB\Driver\Exception\RuntimeException::hasErrorLabel
type: function
doc:
<comment>Description:</comment>
  Returns whether an error label is associated with an exception
  
  Returns whether the <strong>$errorLabel</strong> has been set for this exception. Error labels are set by either
  the server or the driver to indicated specific situations on which you might want to decide on how
  you want to handle a specific exception. A common situation might be to find out whether you can
  safely retry a transaction that failed due to a transient error (like a networking issue, or a
  transaction conflict). Examples of error labels are <return>TransientTransactionError</return> and
  <return>UnknownTransactionCommitResult</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$errorLabel</strong>  The name of the <return>errorLabel</return> to test for.

<comment>Return:</comment>
  <info>bool</info>  Whether the given <return>errorLabel</return> is associated with this exception.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Session::commitTransaction()</strong>
   * MongoDB documentation on transactions


id: MongoDB\Driver\Exception\SSLConnectionException
type: class
doc:
<comment>Description:</comment>
  Thrown when the driver fails to establish an SSL connection with the server.


id: MongoDB\Driver\Exception\ServerException
type: class
doc:
<comment>Description:</comment>
  Base class for exceptions thrown by the server. The code of this exception and its subclasses will
  correspond to the original error code from the server.


id: MongoDB\Driver\Exception\UnexpectedValueException
type: class
doc:
<comment>Description:</comment>
  Thrown when the driver encounters an unexpected value (e.g. during BSON serialization or
  deserialization).


id: MongoDB\Driver\Exception\WriteException
type: class
doc:
<comment>Description:</comment>
  Base class for exceptions thrown by a failed write operation. The exception encapsulates a
  <class>MongoDB\Driver\WriteResult</class> object.


id: MongoDB\Driver\Exception\WriteException::getWriteResult
type: function
doc:
<comment>Description:</comment>
  Returns the WriteResult for the failed write operation
  
  Returns the <class>MongoDB\Driver\WriteResult</class> for the failed write operation. The
  <strong>MongoDB\Driver\WriteResult::getWriteErrors()</strong> and
  <strong>MongoDB\Driver\WriteResult::getWriteConcernError()</strong> methods may be used to get more details about
  the failure.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  The <class>MongoDB\Driver\WriteResult</class> for the failed write operation.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteResult</class>
   * <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong>


id: MongoDB\Driver\Manager
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Manager</class> is the main entry point to the extension. It is responsible for
  maintaining connections to MongoDB (be it standalone server, replica set, or sharded cluster).
  
  No connection to MongoDB is made upon instantiating the Manager. This means the
  <class>MongoDB\Driver\Manager</class> can always be constructed, even though one or more MongoDB servers are
  down.
  
  Any write or query can throw connection exceptions as connections are created lazily. A MongoDB
  server may also become unavailable during the life time of the script. It is therefore important
  that all actions on the Manager to be wrapped in try/catch statements.


id: MongoDB\Driver\Manager::__construct
type: function
doc:
<comment>Description:</comment>
  Create new MongoDB Manager
  
  Constructs a new <class>MongoDB\Driver\Manager</class> object with the specified options.
  
  Per the Server Discovery and Monitoring Specification, this constructor performs no I/O.
  Connections will be initialized on demand, when the first operation is executed.
  
  When specifying any SSL or TLS URI options via the connection string or <strong>$uriOptions</strong> parameter, the
  driver will implicitly enable TLS for its connections. To avoid this, either explicitly disable
  the <return>tls</return> option or don't specify any TLS options.
  
  En plataformas Unix, el controlador de MongoDB es susceptible a scripts que utilizan la llamada al
  sistema fork() sin llamar también a exec(). Los usuarios están advertidos de no reusar instancias
  de <class>MongoDB\Driver\Manager</class> en un proceso hijo bifurcado («forked»).

<comment>Param:</comment>
  <info>string|null</info>  <strong>$uri</strong>            A mongodb:// connection URI: 
                               
                               For details on supported URI options, see Connection String Options
                               in the MongoDB manual. Connection pool options are not supported, as
                               the PHP driver does not implement connection pools.
                               
                               The <strong>$uri</strong> is a URL, hence any special characters in its components
                               need to be URL encoded according to RFC 3986. This is particularly
                               relevant to the username and password, which can often include
                               special characters such as <return>@</return>, <return>:</return>, or <return>%</return>. When connecting via a Unix
                               domain socket, the socket path may contain special characters such as
                               slashes and must be encoded. The <strong>rawurlencode()</strong> function may be used
                               to encode constituent parts of the URI.
                               
                               The <return>defaultAuthDb</return> component may be used to specify the database name
                               associated with the user's credentials; however the <return>authSource</return> URI
                               option will take priority if specified. If neither <return>defaultAuthDb</return> nor
                               <return>authSource</return> are specified, the <return>admin</return> database will be used by default.
                               The <return>defaultAuthDb</return> component has no effect in the absence of user
                               credentials.
  <info>array|null</info>   <strong>$uriOptions</strong>     Additional connection string options, which will overwrite any
                               options with the same name in the <strong>$uri</strong> parameter.
                               
                               uriOptionsOptionTypeDescriptionappname<info>string</info> MongoDB 3.4+ has the
                               ability to annotate connections with metadata provided by the
                               connecting client. This metadata is included in the server's logs
                               upon establishing a connection and also recorded in slow query logs
                               when database profiling is enabled.  This option may be used to
                               specify an application name, which will be included in the metadata.
                               The value cannot exceed 128 characters in length. authMechanism<info>string</info>
                               The authentication mechanism that MongoDB will use to authenticate
                               the connection. For additional details and a list of supported
                               values, see Authentication Options in the MongoDB manual.
                               authMechanismProperties<info>array</info> Properties for the selected
                               authentication mechanism. For additional details and a list of
                               supported properties, see the Driver Authentication Specification.
                               When not specified in the URI string, this option is expressed as an
                               array of key/value pairs. The keys and values in this array should be
                               strings. authSource<info>string</info> The database name associated with the
                               user's credentials. Defaults to the database component of the
                               connection URI, or the <return>admin</return> database if both are unspecified.  For
                               authentication mechanisms that delegate credential storage to other
                               services (e.g. GSSAPI), this should be <return>"$external"</return>.
                               canonicalizeHostname<info>bool</info> If <info>true</info>, the driver will resolve the real
                               hostname for the server IP address before authenticating via SASL.
                               Some underlying GSSAPI layers already do this, but the functionality
                               may be disabled in their config (e.g. <return>krb.conf</return>). Defaults to <info>false</info>.
                               This option is a deprecated alias for the <return>"CANONICALIZE_HOST_NAME"</return>
                               property of the <return>"authMechanismProperties"</return> URI option.
                               compressors<info>string</info> A prioritized, comma-delimited list of compressors
                               that the client wants to use. Messages are only compressed if the
                               client and server share any compressors in common, and the compressor
                               used in each direction will depend on the individual configuration of
                               the server or driver. See the Driver Compression Specification for
                               more information. connectTimeoutMS<info>int</info> The time in milliseconds to
                               attempt a connection before timing out. Defaults to 10,000
                               milliseconds. directConnection<info>bool</info> This option can be used to control
                               replica set discovery behavior when only a single host is provided in
                               the connection string. By default, providing a single member in the
                               connection string will establish a direct connection or discover
                               additional members depending on whether the <return>"replicaSet"</return> URI option
                               is omitted or present, respectively. Specify <info>false</info> to force discovery
                               to occur (if <return>"replicaSet"</return> is omitted) or specify <info>true</info> to force a
                               direct connection (if <return>"replicaSet"</return> is present).
                               gssapiServiceName<info>string</info> Set the Kerberos service name when connecting
                               to Kerberized MongoDB instances. This value must match the service
                               name set on MongoDB instances (i.e. saslServiceName server
                               parameter). Defaults to <return>"mongodb"</return>.  This option is a deprecated alias
                               for the <return>"SERVICE_NAME"</return> property of the <return>"authMechanismProperties"</return> URI
                               option. heartbeatFrequencyMS<info>int</info> Specifies the interval in
                               milliseconds between the driver's checks of the MongoDB topology,
                               counted from the end of the previous check until the beginning of the
                               next one. Defaults to 60,000 milliseconds.  Per the Server Discovery
                               and Monitoring Specification, this value cannot be less than 500
                               milliseconds. journal<info>bool</info> Corresponds to the default write concern's
                               <strong>$journal</strong> parameter. If <info>true</info>, writes will require acknowledgement from
                               MongoDB that the operation has been written to the journal. For
                               details, see <class>MongoDB\Driver\WriteConcern</class>. loadBalanced<info>bool</info> Specifies
                               whether the driver is connecting to a MongoDB cluster through a load
                               balancer. If <info>true</info>, the driver may only connect to a single host
                               (specified by either the connection string or SRV lookup), the
                               <return>"directConnection"</return> URI option cannot be <info>true</info>, and the <return>"replicaSet"</return>
                               URI option must be omitted. Defaults to <info>false</info>. localThresholdMS<info>int</info>
                               The size in milliseconds of the latency window for selecting among
                               multiple suitable MongoDB instances while resolving a read
                               preference. Defaults to 15 milliseconds. maxStalenessSeconds<info>int</info>
                               Corresponds to the read preference's <return>"maxStalenessSeconds"</return>.
                               Specifies, in seconds, how stale a secondary can be before the client
                               stops using it for read operations. By default, there is no maximum
                               staleness and clients will not consider a secondary’s lag when
                               choosing where to direct a read operation. For details, see
                               <class>MongoDB\Driver\ReadPreference</class>.  If specified, the max staleness must
                               be a signed 32-bit integer greater than or equal to
                               <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info> (i.e.
                               90 seconds). password<info>string</info> The password for the user being
                               authenticated. This option is useful if the password contains special
                               characters, which would otherwise need to be URL encoded for the
                               connection URI. readConcernLevel<info>string</info> Corresponds to the read
                               concern's <strong>$level</strong> parameter. Specifies the level of read isolation.
                               For details, see <class>MongoDB\Driver\ReadConcern</class>. readPreference<info>string</info>
                               Corresponds to the read preference's <strong>$mode</strong> parameter. Defaults to
                               <return>"primary"</return>. For details, see <class>MongoDB\Driver\ReadPreference</class>.
                               readPreferenceTags<info>array</info> Corresponds to the read preference's <strong>$tagSets</strong>
                               parameter. Tag sets allow you to target read operations to specific
                               members of a replica set. For details, see
                               <class>MongoDB\Driver\ReadPreference</class>.  When not specified in the URI string,
                               this option is expressed as an array consistent with the format
                               expected by <strong>MongoDB\Driver\ReadPreference::__construct()</strong>.
                               replicaSet<info>string</info> Specifies the name of the replica set.
                               retryReads<info>bool</info> Specifies whether or not the driver should
                               automatically retry certain read operations that fail due to
                               transient network errors or replica set elections. This functionality
                               requires MongoDB 3.6+. Defaults to <info>true</info>.  See the Retryable Reads
                               Specification for more information. retryWrites<info>bool</info> Specifies whether
                               or not the driver should automatically retry certain write operations
                               that fail due to transient network errors or replica set elections.
                               This functionality requires MongoDB 3.6+. Defaults to <info>true</info>.  See
                               Retryable Writes in the MongoDB manual for more information. safe<info>bool</info>
                               If <info>true</info>, specifies <return>1</return> for the default write concern's <strong>$w</strong> parameter. If
                               <info>false</info>, <return>0</return> is specified. For details, see <class>MongoDB\Driver\WriteConcern</class>.
                               This option is deprecated and should not be used.
                               serverSelectionTimeoutMS<info>int</info> Specifies how long in milliseconds to
                               block for server selection before throwing an exception. Defaults to
                               30,000 milliseconds. serverSelectionTryOnce<info>bool</info> When <info>true</info>, instructs
                               the driver to scan the MongoDB deployment exactly once after server
                               selection fails and then either select a server or raise an error.
                               When <info>false</info>, the driver blocks and searches for a server up to the
                               <return>"serverSelectionTimeoutMS"</return> value. Defaults to <info>true</info>.
                               socketCheckIntervalMS<info>int</info> If a socket has not been used recently, the
                               driver must check it via a <return>hello</return> command before using it for any
                               operation. Defaults to 5,000 milliseconds. socketTimeoutMS<info>int</info> The
                               time in milliseconds to attempt a send or receive on a socket before
                               timing out. Defaults to 300,000 milliseconds (i.e. five minutes).
                               srvMaxHosts<info>int</info> The maximum number of SRV results to randomly select
                               when initially populating the seedlist or, during SRV polling, adding
                               new hosts to the topology. Defaults to <return>0</return> (i.e. no maximum).
                               srvServiceName<info>string</info> The service name to use for SRV lookup in
                               initial DNS seedlist discovery and SRV polling. Defaults to
                               <return>"mongodb"</return>. ssl<info>bool</info> Initiates the connection with TLS/SSL if <info>true</info>.
                               Defaults to <info>false</info>.  This option is a deprecated alias for the <return>"tls"</return>
                               URI option. tls<info>bool</info> Initiates the connection with TLS/SSL if <info>true</info>.
                               Defaults to <info>false</info>. tlsAllowInvalidCertificates<info>bool</info> Specifies whether
                               or not the driver should error when the server's TLS certificate is
                               invalid. Defaults to <info>false</info>.  Disabling certificate validation creates
                               a vulnerability. tlsAllowInvalidHostnames<info>bool</info> Specifies whether or
                               not the driver should error when there is a mismatch between the
                               server's hostname and the hostname specified by the TLS certificate.
                               Defaults to <info>false</info>.  Disabling certificate validation creates a
                               vulnerability. Allowing invalid hostnames may expose the driver to a
                               man-in-the-middle attack. tlsCAFile<info>string</info> Path to file with either a
                               single or bundle of certificate authorities to be considered trusted
                               when making a TLS connection. The system certificate store will be
                               used by default. tlsCertificateKeyFile<info>string</info> Path to the client
                               certificate file or the client private key file; in the case that
                               they both are needed, the files should be concatenated.
                               tlsCertificateKeyFilePassword<info>string</info> Password to decrypt the client
                               private key (i.e. <return>"tlsCertificateKeyFile"</return> URI option) to be used for
                               TLS connections. tlsDisableCertificateRevocationCheck<info>bool</info> If <info>true</info>,
                               the driver will not attempt to check certificate revocation status
                               (e.g. OCSP, CRL). Defaults to <info>false</info>. tlsDisableOCSPEndpointCheck<info>bool</info>
                               If <info>true</info>, the driver will not attempt to contact an OCSP responder
                               endpoint if needed (i.e. an OCSP response is not stapled). Defaults
                               to <info>false</info>. tlsInsecure<info>bool</info> Relax TLS constraints as much as possible.
                               Specifying <info>true</info> for this option has the same effect as specifying
                               <info>true</info> for both the <return>"tlsAllowInvalidCertificates"</return> and
                               <return>"tlsAllowInvalidHostnames"</return> URI options. Defaults to <info>false</info>.  Disabling
                               certificate validation creates a vulnerability. Allowing invalid
                               hostnames may expose the driver to a man-in-the-middle attack.
                               username<info>string</info> The username for the user being authenticated. This
                               option is useful if the username contains special characters, which
                               would otherwise need to be URL encoded for the connection URI.
                               w<info>int</info><info>string</info></info> Corresponds to the default write concern's <strong>$w</strong> parameter.
                               For details, see <class>MongoDB\Driver\WriteConcern</class>. wTimeoutMS<info>int</info><info>string</info></info>
                               Corresponds to the default write concern's <strong>$wtimeout</strong> parameter.
                               Specifies a time limit, in milliseconds, for the write concern. For
                               details, see <class>MongoDB\Driver\WriteConcern</class>.  If specified, <return>wTimeoutMS</return>
                               must be a signed 32-bit integer greater than or equal to zero.
                               zlibCompressionLevel<info>int</info> Specifies the compression level to use for
                               the zlib compressor. This option has no effect if <return>zlib</return> is not
                               included in the <return>"compressors"</return> URI option. See the Driver Compression
                               Specification for more information.
                               
                               MongoDB 3.4+ has the ability to annotate connections with metadata
                               provided by the connecting client. This metadata is included in the
                               server's logs upon establishing a connection and also recorded in
                               slow query logs when database profiling is enabled.
                               
                               This option may be used to specify an application name, which will be
                               included in the metadata. The value cannot exceed 128 characters in
                               length.
                               
                               The authentication mechanism that MongoDB will use to authenticate
                               the connection. For additional details and a list of supported
                               values, see Authentication Options in the MongoDB manual.
                               
                               Properties for the selected authentication mechanism. For additional
                               details and a list of supported properties, see the Driver
                               Authentication Specification.
                               
                               When not specified in the URI string, this option is expressed as an
                               array of key/value pairs. The keys and values in this array should be
                               strings.
                               
                               The database name associated with the user's credentials. Defaults to
                               the database component of the connection URI, or the <return>admin</return> database
                               if both are unspecified.
                               
                               For authentication mechanisms that delegate credential storage to
                               other services (e.g. GSSAPI), this should be <return>"$external"</return>.
                               
                               If <info>true</info>, the driver will resolve the real hostname for the server IP
                               address before authenticating via SASL. Some underlying GSSAPI layers
                               already do this, but the functionality may be disabled in their
                               config (e.g. <return>krb.conf</return>). Defaults to <info>false</info>.
                               
                               This option is a deprecated alias for the <return>"CANONICALIZE_HOST_NAME"</return>
                               property of the <return>"authMechanismProperties"</return> URI option.
                               
                               A prioritized, comma-delimited list of compressors that the client
                               wants to use. Messages are only compressed if the client and server
                               share any compressors in common, and the compressor used in each
                               direction will depend on the individual configuration of the server
                               or driver. See the Driver Compression Specification for more
                               information.
                               
                               The time in milliseconds to attempt a connection before timing out.
                               Defaults to 10,000 milliseconds.
                               
                               This option can be used to control replica set discovery behavior
                               when only a single host is provided in the connection string. By
                               default, providing a single member in the connection string will
                               establish a direct connection or discover additional members
                               depending on whether the <return>"replicaSet"</return> URI option is omitted or
                               present, respectively. Specify <info>false</info> to force discovery to occur (if
                               <return>"replicaSet"</return> is omitted) or specify <info>true</info> to force a direct connection
                               (if <return>"replicaSet"</return> is present).
                               
                               Set the Kerberos service name when connecting to Kerberized MongoDB
                               instances. This value must match the service name set on MongoDB
                               instances (i.e. saslServiceName server parameter). Defaults to
                               <return>"mongodb"</return>.
                               
                               This option is a deprecated alias for the <return>"SERVICE_NAME"</return> property of
                               the <return>"authMechanismProperties"</return> URI option.
                               
                               Specifies the interval in milliseconds between the driver's checks of
                               the MongoDB topology, counted from the end of the previous check
                               until the beginning of the next one. Defaults to 60,000 milliseconds.
                               
                               Per the Server Discovery and Monitoring Specification, this value
                               cannot be less than 500 milliseconds.
                               
                               Corresponds to the default write concern's <strong>$journal</strong> parameter. If
                               <info>true</info>, writes will require acknowledgement from MongoDB that the
                               operation has been written to the journal. For details, see
                               <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Specifies whether the driver is connecting to a MongoDB cluster
                               through a load balancer. If <info>true</info>, the driver may only connect to a
                               single host (specified by either the connection string or SRV
                               lookup), the <return>"directConnection"</return> URI option cannot be <info>true</info>, and the
                               <return>"replicaSet"</return> URI option must be omitted. Defaults to <info>false</info>.
                               
                               The size in milliseconds of the latency window for selecting among
                               multiple suitable MongoDB instances while resolving a read
                               preference. Defaults to 15 milliseconds.
                               
                               Corresponds to the read preference's <return>"maxStalenessSeconds"</return>.
                               Specifies, in seconds, how stale a secondary can be before the client
                               stops using it for read operations. By default, there is no maximum
                               staleness and clients will not consider a secondary’s lag when
                               choosing where to direct a read operation. For details, see
                               <class>MongoDB\Driver\ReadPreference</class>.
                               
                               If specified, the max staleness must be a signed 32-bit integer
                               greater than or equal to
                               <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info> (i.e.
                               90 seconds).
                               
                               Corresponds to the read preference's <strong>$mode</strong> parameter. Defaults to
                               <return>"primary"</return>. For details, see <class>MongoDB\Driver\ReadPreference</class>.
                               
                               Corresponds to the read preference's <strong>$tagSets</strong> parameter. Tag sets
                               allow you to target read operations to specific members of a replica
                               set. For details, see <class>MongoDB\Driver\ReadPreference</class>.
                               
                               When not specified in the URI string, this option is expressed as an
                               array consistent with the format expected by
                               <strong>MongoDB\Driver\ReadPreference::__construct()</strong>.
                               
                               Specifies the name of the replica set.
                               
                               Specifies whether or not the driver should automatically retry
                               certain read operations that fail due to transient network errors or
                               replica set elections. This functionality requires MongoDB 3.6+.
                               Defaults to <info>true</info>.
                               
                               See the Retryable Reads Specification for more information.
                               
                               Specifies whether or not the driver should automatically retry
                               certain write operations that fail due to transient network errors or
                               replica set elections. This functionality requires MongoDB 3.6+.
                               Defaults to <info>true</info>.
                               
                               See Retryable Writes in the MongoDB manual for more information.
                               
                               If <info>true</info>, specifies <return>1</return> for the default write concern's <strong>$w</strong> parameter. If
                               <info>false</info>, <return>0</return> is specified. For details, see <class>MongoDB\Driver\WriteConcern</class>.
                               
                               This option is deprecated and should not be used.
                               
                               Specifies how long in milliseconds to block for server selection
                               before throwing an exception. Defaults to 30,000 milliseconds.
                               
                               When <info>true</info>, instructs the driver to scan the MongoDB deployment
                               exactly once after server selection fails and then either select a
                               server or raise an error. When <info>false</info>, the driver blocks and searches
                               for a server up to the <return>"serverSelectionTimeoutMS"</return> value. Defaults to
                               <info>true</info>.
                               
                               If a socket has not been used recently, the driver must check it via
                               a <return>hello</return> command before using it for any operation. Defaults to 5,000
                               milliseconds.
                               
                               The time in milliseconds to attempt a send or receive on a socket
                               before timing out. Defaults to 300,000 milliseconds (i.e. five
                               minutes).
                               
                               The maximum number of SRV results to randomly select when initially
                               populating the seedlist or, during SRV polling, adding new hosts to
                               the topology. Defaults to <return>0</return> (i.e. no maximum).
                               
                               The service name to use for SRV lookup in initial DNS seedlist
                               discovery and SRV polling. Defaults to <return>"mongodb"</return>.
                               
                               Initiates the connection with TLS/SSL if <info>true</info>. Defaults to <info>false</info>.
                               
                               This option is a deprecated alias for the <return>"tls"</return> URI option.
                               
                               Initiates the connection with TLS/SSL if <info>true</info>. Defaults to <info>false</info>.
                               
                               Specifies whether or not the driver should error when the server's
                               TLS certificate is invalid. Defaults to <info>false</info>.
                               
                               Disabling certificate validation creates a vulnerability.
                               
                               Specifies whether or not the driver should error when there is a
                               mismatch between the server's hostname and the hostname specified by
                               the TLS certificate. Defaults to <info>false</info>.
                               
                               Disabling certificate validation creates a vulnerability. Allowing
                               invalid hostnames may expose the driver to a man-in-the-middle
                               attack.
                               
                               Path to file with either a single or bundle of certificate
                               authorities to be considered trusted when making a TLS connection.
                               The system certificate store will be used by default.
                               
                               Path to the client certificate file or the client private key file;
                               in the case that they both are needed, the files should be
                               concatenated.
                               
                               Password to decrypt the client private key (i.e.
                               <return>"tlsCertificateKeyFile"</return> URI option) to be used for TLS connections.
                               
                               If <info>true</info>, the driver will not attempt to check certificate revocation
                               status (e.g. OCSP, CRL). Defaults to <info>false</info>.
                               
                               If <info>true</info>, the driver will not attempt to contact an OCSP responder
                               endpoint if needed (i.e. an OCSP response is not stapled). Defaults
                               to <info>false</info>.
                               
                               Relax TLS constraints as much as possible. Specifying <info>true</info> for this
                               option has the same effect as specifying <info>true</info> for both the
                               <return>"tlsAllowInvalidCertificates"</return> and <return>"tlsAllowInvalidHostnames"</return> URI
                               options. Defaults to <info>false</info>.
                               
                               Disabling certificate validation creates a vulnerability. Allowing
                               invalid hostnames may expose the driver to a man-in-the-middle
                               attack.
                               
                               Corresponds to the default write concern's <strong>$w</strong> parameter. For details,
                               see <class>MongoDB\Driver\WriteConcern</class>.
                               
                               Corresponds to the default write concern's <strong>$wtimeout</strong> parameter.
                               Specifies a time limit, in milliseconds, for the write concern. For
                               details, see <class>MongoDB\Driver\WriteConcern</class>.
                               
                               If specified, <return>wTimeoutMS</return> must be a signed 32-bit integer greater than
                               or equal to zero.
                               
                               Specifies the compression level to use for the zlib compressor. This
                               option has no effect if <return>zlib</return> is not included in the <return>"compressors"</return> URI
                               option. See the Driver Compression Specification for more
                               information.
  <info>array|null</info>   <strong>$driverOptions</strong>  driverOptionsOptionTypeDescriptionallow_invalid_hostname<info>bool</info> Disables
                               hostname validation if <info>true</info>. Defaults to <info>false</info>.  Allowing invalid
                               hostnames may expose the driver to a man-in-the-middle attack.  This
                               option is a deprecated alias for the <return>"tlsAllowInvalidHostnames"</return> URI
                               option. autoEncryption<info>array</info> Provides options to enable automatic
                               client-side field level encryption.  Automatic encryption is an
                               enterprise-only feature that only applies to operations on a
                               collection. Automatic encryption is not supported for operations on a
                               database or view, and operations that are not bypassed will result in
                               error (see libmongocrypt: Auto Encryption Allow-List). To bypass
                               automatic encryption for all operations, set <return>bypassAutoEncryption</return> to
                               <info>true</info>.  Automatic encryption requires the authenticated user to have
                               the listCollections privilege action.  Explicit encryption/decryption
                               and automatic decryption is a community feature. The driver can still
                               automatically decrypt when <return>bypassAutoEncryption</return> is <info>true</info>.  The
                               following options are supported:
                                Options for automatic
                               encryptionOptionTypeDescriptionkeyVaultClient<class>MongoDB\Driver\Manager</class>The
                               Manager used to route data key queries to a separate MongoDB cluster.
                               By default, the current Manager and cluster is
                               used.keyVaultNamespace<info>string</info>A fully qualified namespace (e.g.
                               <return>"databaseName.collectionName"</return>) denoting the collection that contains
                               all data keys used for encryption and decryption. This option is
                               required.kmsProviders<info>array</info> A document containing the configuration
                               for one or more KMS providers, which are used to encrypt data keys.
                               Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return>, and
                               <return>"local"</return> and at least one must be specified.  If an empty document is
                               specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the driver will attempt to
                               configure the provider using Automatic Credentials.  The format for
                               <return>"aws"</return> is as follows: , secretAccessKey: , sessionToken:
                               }
                               ]]> The format for <return>"azure"</return> is as follows: , clientId: , clientSecret:
                               , identityPlatformEndpoint:  // Defaults to
                               "login.microsoftonline.com"
                               }
                               ]]> The format for <return>"gcp"</return> is as follows: , privateKey: |, endpoint:
                               // Defaults to "oauth2.googleapis.com"
                               }
                               ]]> The format for <return>"kmip"</return> is as follows: 
                               }
                               ]]> The format for <return>"local"</return> is as follows: |
                               }
                               ]]>tlsOptions<info>array</info> A document containing the TLS configuration for
                               one or more KMS providers. Supported providers include <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All providers support the following
                               options: : { tlsCaFile: , tlsCertificateKeyFile: ,
                               tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                               }
                               ]]>schemaMap<info>array</info><info>object</info></info> Map of collection namespaces to a local JSON
                               schema. This is used to configure automatic encryption. See Automatic
                               Encryption Rules in the MongoDB manual for more information. It is an
                               error to specify a collection in both <return>schemaMap</return> and
                               <return>encryptedFieldsMap</return>.  Supplying a <return>schemaMap</return> provides more security
                               than relying on JSON schemas obtained from the server. It protects
                               against a malicious server advertising a false JSON schema, which
                               could trick the client into sending unencrypted data that should be
                               encrypted.  Schemas supplied in the <return>schemaMap</return> only apply to
                               configuring automatic encryption for client side encryption. Other
                               validation rules in the JSON schema will not be enforced by the
                               driver and will result in an error. bypassAutoEncryption<info>bool</info> If <info>true</info>,
                               <return>mongocryptd</return> will not be spawned automatically. This is used to
                               disable automatic encryption. Defaults to <info>false</info>.
                               bypassQueryAnalysis<info>bool</info> If <info>true</info>, automatic analysis of outgoing
                               commands will be disabled and <return>mongocryptd</return> will not be spawned
                               automatically. This enables the use case of explicit encryption for
                               querying indexed fields without requiring the enterprise licensed
                               <return>crypt_shared</return> library or <return>mongocryptd</return> process. Defaults to <info>false</info>.
                               encryptedFieldsMap<info>array</info><info>object</info></info> Map of collection namespaces to an
                               <return>encryptedFields</return> document. This is used to configure queryable
                               encryption. See Field Encryption and Queryability in the MongoDB
                               manual for more information. It is an error to specify a collection
                               in both <return>encryptedFieldsMap</return> and <return>schemaMap</return>.  Supplying an
                               <return>encryptedFieldsMap</return> provides more security than relying on an
                               <return>encryptedFields</return> obtained from the server. It protects against a
                               malicious server advertising a false <return>encryptedFields</return>.
                               extraOptions<info>array</info> The <return>extraOptions</return> relate to the <return>mongocryptd</return> process.
                               The following options are supported: <return>mongocryptdURI</return> (<info>string</info>): URI to
                               connect to an existing <return>mongocryptd</return> process. Defaults to
                               <return>"mongodb://localhost:27020"</return>.<return>mongocryptdBypassSpawn</return> (<info>bool</info>): If <info>true</info>,
                               prevent the driver from spawning <return>mongocryptd</return>. Defaults to
                               <info>false</info>.<return>mongocryptdSpawnPath</return> (<info>string</info>): Absolute path to search for
                               <return>mongocryptd</return> binary. Defaults to empty string and consults system
                               paths.<return>mongocryptdSpawnArgs</return> (<info>array</info>): Array of string arguments to pass
                               to <return>mongocryptd</return> when spawning. Defaults to
                               <return>["--idleShutdownTimeoutSecs=60"]</return>.<return>cryptSharedLibPath</return> (<info>string</info>):
                               Absolute path to <return>crypt_shared</return> shared library. Defaults to empty
                               string and consults system paths.<return>cryptSharedLibRequired</return> (<info>bool</info>): If
                               <info>true</info>, require the driver to load <return>crypt_shared</return>. Defaults to <info>false</info>. See
                               the Client-Side Encryption Specification for more information.
                               Automatic encryption is an enterprise only feature that only applies
                               to operations on a collection. Automatic encryption is not supported
                               for operations on a database or view, and operations that are not
                               bypassed will result in error. To bypass automatic encryption for all
                               operations, set <return>bypassAutoEncryption=true</return> in <return>autoEncryption</return>. For more
                               information on allowed operations, see the Client-Side Encryption
                               Specification. ca_dir<info>string</info> Path to a correctly hashed certificate
                               directory. The system certificate store will be used by default.
                               ca_file<info>string</info> Path to file with either a single or bundle of
                               certificate authorities to be considered trusted when making a TLS
                               connection. The system certificate store will be used by default.
                               This option is a deprecated alias for the <return>"tlsCAFile"</return> URI option.
                               context<info>resource</info>SSL context options to be used as fallbacks if a
                               driver option or its equivalent URI option, if any, is not specified.
                               Note that the driver does not consult the default stream context
                               (i.e. <strong>stream_context_get_default()</strong>). The following context options
                               are supported: SSL context option fallbacksDriver optionContext
                               option
                               (fallback)ca_dircapathca_filecafilepem_filelocal_certpem_pwdpassphraseweak_cert_validationallow_self_signed
                               This option is supported for backwards compatibility, but should be
                               considered deprecated. crl_file<info>string</info>Path to a certificate revocation
                               list file.disableClientPersistence<info>bool</info> If <info>true</info>, this Manager will use
                               a new libmongoc client, which will not be persisted or shared with
                               other Manager objects. When this Manager object is freed, its client
                               will be destroyed and any connections will be closed. Defaults to
                               <info>false</info>.  Disabling client persistence is not generally recommended.
                               driver<info>array</info> Allows custom drivers to append their own metadata to the
                               server handshake. By default, the driver submits its own name,
                               version, and platform (i.e. PHP version) in the handshake. Custom
                               drivers can specify strings for the <return>"name"</return>, <return>"version"</return>, and <return>"platform"</return>
                               keys of this array, which will be appended to the respective field(s)
                               in the handshake document.  Handshake information is limited to 512
                               bytes. The driver will truncate handshake data to fit within this
                               512-byte string. Drivers and ODMs are encouraged to keep their own
                               metadata concise. pem_file<info>string</info> Path to a PEM encoded certificate to
                               use for client authentication.  This option is a deprecated alias for
                               the <return>"tlsCertificateKeyFile"</return> URI option. pem_pwd<info>string</info> Passphrase for
                               the PEM encoded certificate (if applicable).  This option is a
                               deprecated alias for the <return>"tlsCertificateKeyFilePassword"</return> URI option.
                               serverApi<class>MongoDB\Driver\ServerApi</class> This option is used to declare a
                               server API version for the manager. If omitted, no API version is
                               declared. weak_cert_validation<info>bool</info> Disables certificate validation if
                               <info>true</info>. Defaults to <info>false</info>  This option is a deprecated alias for the
                               <return>"tlsAllowInvalidCertificates"</return> URI option.
                               
                               Disables hostname validation if <info>true</info>. Defaults to <info>false</info>.
                               
                               Allowing invalid hostnames may expose the driver to a
                               man-in-the-middle attack.
                               
                               This option is a deprecated alias for the <return>"tlsAllowInvalidHostnames"</return>
                               URI option.
                               
                               Provides options to enable automatic client-side field level
                               encryption.
                               
                               Automatic encryption is an enterprise-only feature that only applies
                               to operations on a collection. Automatic encryption is not supported
                               for operations on a database or view, and operations that are not
                               bypassed will result in error (see libmongocrypt: Auto Encryption
                               Allow-List). To bypass automatic encryption for all operations, set
                               <return>bypassAutoEncryption</return> to <info>true</info>.
                               
                               Automatic encryption requires the authenticated user to have the
                               listCollections privilege action.
                               
                               Explicit encryption/decryption and automatic decryption is a
                               community feature. The driver can still automatically decrypt when
                               <return>bypassAutoEncryption</return> is <info>true</info>.
                               
                               The following options are supported:
                                Options for automatic
                               encryptionOptionTypeDescriptionkeyVaultClient<class>MongoDB\Driver\Manager</class>The
                               Manager used to route data key queries to a separate MongoDB cluster.
                               By default, the current Manager and cluster is
                               used.keyVaultNamespace<info>string</info>A fully qualified namespace (e.g.
                               <return>"databaseName.collectionName"</return>) denoting the collection that contains
                               all data keys used for encryption and decryption. This option is
                               required.kmsProviders<info>array</info> A document containing the configuration
                               for one or more KMS providers, which are used to encrypt data keys.
                               Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return>, and
                               <return>"local"</return> and at least one must be specified.  If an empty document is
                               specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the driver will attempt to
                               configure the provider using Automatic Credentials.  The format for
                               <return>"aws"</return> is as follows: , secretAccessKey: , sessionToken:
                               }
                               ]]> The format for <return>"azure"</return> is as follows: , clientId: , clientSecret:
                               , identityPlatformEndpoint:  // Defaults to
                               "login.microsoftonline.com"
                               }
                               ]]> The format for <return>"gcp"</return> is as follows: , privateKey: |, endpoint:
                               // Defaults to "oauth2.googleapis.com"
                               }
                               ]]> The format for <return>"kmip"</return> is as follows: 
                               }
                               ]]> The format for <return>"local"</return> is as follows: |
                               }
                               ]]>tlsOptions<info>array</info> A document containing the TLS configuration for
                               one or more KMS providers. Supported providers include <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All providers support the following
                               options: : { tlsCaFile: , tlsCertificateKeyFile: ,
                               tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                               }
                               ]]>schemaMap<info>array</info><info>object</info></info> Map of collection namespaces to a local JSON
                               schema. This is used to configure automatic encryption. See Automatic
                               Encryption Rules in the MongoDB manual for more information. It is an
                               error to specify a collection in both <return>schemaMap</return> and
                               <return>encryptedFieldsMap</return>.  Supplying a <return>schemaMap</return> provides more security
                               than relying on JSON schemas obtained from the server. It protects
                               against a malicious server advertising a false JSON schema, which
                               could trick the client into sending unencrypted data that should be
                               encrypted.  Schemas supplied in the <return>schemaMap</return> only apply to
                               configuring automatic encryption for client side encryption. Other
                               validation rules in the JSON schema will not be enforced by the
                               driver and will result in an error. bypassAutoEncryption<info>bool</info> If <info>true</info>,
                               <return>mongocryptd</return> will not be spawned automatically. This is used to
                               disable automatic encryption. Defaults to <info>false</info>.
                               bypassQueryAnalysis<info>bool</info> If <info>true</info>, automatic analysis of outgoing
                               commands will be disabled and <return>mongocryptd</return> will not be spawned
                               automatically. This enables the use case of explicit encryption for
                               querying indexed fields without requiring the enterprise licensed
                               <return>crypt_shared</return> library or <return>mongocryptd</return> process. Defaults to <info>false</info>.
                               encryptedFieldsMap<info>array</info><info>object</info></info> Map of collection namespaces to an
                               <return>encryptedFields</return> document. This is used to configure queryable
                               encryption. See Field Encryption and Queryability in the MongoDB
                               manual for more information. It is an error to specify a collection
                               in both <return>encryptedFieldsMap</return> and <return>schemaMap</return>.  Supplying an
                               <return>encryptedFieldsMap</return> provides more security than relying on an
                               <return>encryptedFields</return> obtained from the server. It protects against a
                               malicious server advertising a false <return>encryptedFields</return>.
                               extraOptions<info>array</info> The <return>extraOptions</return> relate to the <return>mongocryptd</return> process.
                               The following options are supported: <return>mongocryptdURI</return> (<info>string</info>): URI to
                               connect to an existing <return>mongocryptd</return> process. Defaults to
                               <return>"mongodb://localhost:27020"</return>.<return>mongocryptdBypassSpawn</return> (<info>bool</info>): If <info>true</info>,
                               prevent the driver from spawning <return>mongocryptd</return>. Defaults to
                               <info>false</info>.<return>mongocryptdSpawnPath</return> (<info>string</info>): Absolute path to search for
                               <return>mongocryptd</return> binary. Defaults to empty string and consults system
                               paths.<return>mongocryptdSpawnArgs</return> (<info>array</info>): Array of string arguments to pass
                               to <return>mongocryptd</return> when spawning. Defaults to
                               <return>["--idleShutdownTimeoutSecs=60"]</return>.<return>cryptSharedLibPath</return> (<info>string</info>):
                               Absolute path to <return>crypt_shared</return> shared library. Defaults to empty
                               string and consults system paths.<return>cryptSharedLibRequired</return> (<info>bool</info>): If
                               <info>true</info>, require the driver to load <return>crypt_shared</return>. Defaults to <info>false</info>. See
                               the Client-Side Encryption Specification for more information.
                               
                               A document containing the configuration for one or more KMS
                               providers, which are used to encrypt data keys. Supported providers
                               include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return>, and <return>"local"</return> and at least one
                               must be specified.
                               
                               If an empty document is specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the
                               driver will attempt to configure the provider using Automatic
                               Credentials.
                               
                               The format for <return>"aws"</return> is as follows:
                               
                               The format for <return>"azure"</return> is as follows:
                               
                               The format for <return>"gcp"</return> is as follows:
                               
                               The format for <return>"kmip"</return> is as follows:
                               
                               The format for <return>"local"</return> is as follows:
                               
                               A document containing the TLS configuration for one or more KMS
                               providers. Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, and
                               <return>"kmip"</return>. All providers support the following options:
                               
                               Map of collection namespaces to a local JSON schema. This is used to
                               configure automatic encryption. See Automatic Encryption Rules in the
                               MongoDB manual for more information. It is an error to specify a
                               collection in both <return>schemaMap</return> and <return>encryptedFieldsMap</return>.
                               
                               Supplying a <return>schemaMap</return> provides more security than relying on JSON
                               schemas obtained from the server. It protects against a malicious
                               server advertising a false JSON schema, which could trick the client
                               into sending unencrypted data that should be encrypted.
                               
                               Schemas supplied in the <return>schemaMap</return> only apply to configuring automatic
                               encryption for client side encryption. Other validation rules in the
                               JSON schema will not be enforced by the driver and will result in an
                               error.
                               
                               If <info>true</info>, automatic analysis of outgoing commands will be disabled and
                               <return>mongocryptd</return> will not be spawned automatically. This enables the use
                               case of explicit encryption for querying indexed fields without
                               requiring the enterprise licensed <return>crypt_shared</return> library or <return>mongocryptd</return>
                               process. Defaults to <info>false</info>.
                               
                               Map of collection namespaces to an <return>encryptedFields</return> document. This is
                               used to configure queryable encryption. See Field Encryption and
                               Queryability in the MongoDB manual for more information. It is an
                               error to specify a collection in both <return>encryptedFieldsMap</return> and
                               <return>schemaMap</return>.
                               
                               Supplying an <return>encryptedFieldsMap</return> provides more security than relying
                               on an <return>encryptedFields</return> obtained from the server. It protects against a
                               malicious server advertising a false <return>encryptedFields</return>.
                               
                               The <return>extraOptions</return> relate to the <return>mongocryptd</return> process. The following
                               options are supported:
                               
                               See the Client-Side Encryption Specification for more information.
                               
                               Automatic encryption is an enterprise only feature that only applies
                               to operations on a collection. Automatic encryption is not supported
                               for operations on a database or view, and operations that are not
                               bypassed will result in error. To bypass automatic encryption for all
                               operations, set <return>bypassAutoEncryption=true</return> in <return>autoEncryption</return>. For more
                               information on allowed operations, see the Client-Side Encryption
                               Specification.
                               
                               Path to a correctly hashed certificate directory. The system
                               certificate store will be used by default.
                               
                               Path to file with either a single or bundle of certificate
                               authorities to be considered trusted when making a TLS connection.
                               The system certificate store will be used by default.
                               
                               This option is a deprecated alias for the <return>"tlsCAFile"</return> URI option.
                               
                               SSL context options to be used as fallbacks if a driver option or its
                               equivalent URI option, if any, is not specified. Note that the driver
                               does not consult the default stream context (i.e.
                               <strong>stream_context_get_default()</strong>). The following context options are
                               supported:
                               
                               This option is supported for backwards compatibility, but should be
                               considered deprecated.
                               
                               If <info>true</info>, this Manager will use a new libmongoc client, which will not
                               be persisted or shared with other Manager objects. When this Manager
                               object is freed, its client will be destroyed and any connections
                               will be closed. Defaults to <info>false</info>.
                               
                               Disabling client persistence is not generally recommended.
                               
                               Allows custom drivers to append their own metadata to the server
                               handshake. By default, the driver submits its own name, version, and
                               platform (i.e. PHP version) in the handshake. Custom drivers can
                               specify strings for the <return>"name"</return>, <return>"version"</return>, and <return>"platform"</return> keys of
                               this array, which will be appended to the respective field(s) in the
                               handshake document.
                               
                               Handshake information is limited to 512 bytes. The driver will
                               truncate handshake data to fit within this 512-byte string. Drivers
                               and ODMs are encouraged to keep their own metadata concise.
                               
                               Path to a PEM encoded certificate to use for client authentication.
                               
                               This option is a deprecated alias for the <return>"tlsCertificateKeyFile"</return> URI
                               option.
                               
                               Passphrase for the PEM encoded certificate (if applicable).
                               
                               This option is a deprecated alias for the
                               <return>"tlsCertificateKeyFilePassword"</return> URI option.
                               
                               This option is used to declare a server API version for the manager.
                               If omitted, no API version is declared.
                               
                               Disables certificate validation if <info>true</info>. Defaults to <info>false</info>
                               
                               This option is a deprecated alias for the
                               <return>"tlsAllowInvalidCertificates"</return> URI option.

<comment>See Also:</comment>
   * Connection handling and persistence
   * MongoDB Connection String Format


id: MongoDB\Driver\Manager::addSubscriber
type: function
doc:
<comment>Description:</comment>
  Registers a monitoring event subscriber with this Manager
  
  Registers a monitoring event subscriber with this Manager. The subscriber will be notified of all
  events for this Manager.
  
  If <strong>$subscriber</strong> is already registered with this Manager, this function is a no-op. If <strong>$subscriber</strong>
  is also registered globally, it will still only be notified once of each event for this Manager.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  A monitoring event subscriber to register with
                                                     this Manager.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::removeSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * 


id: MongoDB\Driver\Manager::createClientEncryption
type: function
doc:
<comment>Description:</comment>
  Create a new ClientEncryption object
  
  Constructs a new <class>MongoDB\Driver\ClientEncryption</class> object with the specified options.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  optionsOptionTypeDescriptionkeyVaultClient<class>MongoDB\Driver\Manager</class>The Manager used
                   to route data key queries to a separate MongoDB cluster. By default, the current
                   Manager and cluster is used.keyVaultNamespace<info>string</info>A fully qualified namespace
                   (e.g. <return>"databaseName.collectionName"</return>) denoting the collection that contains all
                   data keys used for encryption and decryption. This option is
                   required.kmsProviders<info>array</info> A document containing the configuration for one or
                   more KMS providers, which are used to encrypt data keys. Supported providers
                   include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return>, and <return>"local"</return> and at least one must be
                   specified.  If an empty document is specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the
                   driver will attempt to configure the provider using Automatic Credentials.  The
                   format for <return>"aws"</return> is as follows: , secretAccessKey: , sessionToken:
                   }
                   ]]> The format for <return>"azure"</return> is as follows: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // Defaults to "login.microsoftonline.com"
                   }
                   ]]> The format for <return>"gcp"</return> is as follows: , privateKey: |, endpoint:  // Defaults
                   to "oauth2.googleapis.com"
                   }
                   ]]> The format for <return>"kmip"</return> is as follows: 
                   }
                   ]]> The format for <return>"local"</return> is as follows: |
                   }
                   ]]>tlsOptions<info>array</info> A document containing the TLS configuration for one or more
                   KMS providers. Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All
                   providers support the following options: : { tlsCaFile: , tlsCertificateKeyFile:
                   , tlsCertificateKeyFilePassword: , tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   A document containing the configuration for one or more KMS providers, which are
                   used to encrypt data keys. Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>,
                   <return>"kmip"</return>, and <return>"local"</return> and at least one must be specified.
                   
                   If an empty document is specified for <return>"aws"</return>, <return>"azure"</return>, or <return>"gcp"</return>, the driver will
                   attempt to configure the provider using Automatic Credentials.
                   
                   The format for <return>"aws"</return> is as follows:
                   
                   The format for <return>"azure"</return> is as follows:
                   
                   The format for <return>"gcp"</return> is as follows:
                   
                   The format for <return>"kmip"</return> is as follows:
                   
                   The format for <return>"local"</return> is as follows:
                   
                   A document containing the TLS configuration for one or more KMS providers.
                   Supported providers include <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, and <return>"kmip"</return>. All providers
                   support the following options:

<comment>Return:</comment>
  <info>MongoDB\Driver\ClientEncryption</info>  Returns a new <class>MongoDB\Driver\ClientEncryption</class> instance.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ClientEncryption::__construct()</strong>
   * Explicit (Manual) Client-Side Field Level Encryption in the MongoDB manual


id: MongoDB\Driver\Manager::executeBulkWrite
type: function
doc:
<comment>Description:</comment>
  Execute one or more write operations
  
  Executes one or more write operations on the primary server.
  
  A <class>MongoDB\Driver\BulkWrite</class> can be constructed with one or more write operations of varying types
  (e.g. updates, deletes, and inserts). The driver will attempt to send operations of the same type
  to the server in as few requests as possible to optimize round trips.

<comment>Param:</comment>
  <info>string</info>                                  <strong>$namespace</strong>  Un espacio de nombres completamente
                                                      cualificado (p. ej.
                                                      <return>"nombreBaseDatos.nombreColección"</return>).
  <info>MongoDB\Driver\BulkWrite</info>                <strong>$bulk</strong>       La/s escritura/s a ejecutar.
  <info>array|MongoDB\Driver\WriteConcern|null</info>  <strong>$options</strong>    
                                                      optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class>
                                                      Una sesión a asociar con la operación.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Un
                                                      asunto de escritura a aplicar a la operación.
                                                      
                                                      Una sesión a asociar con la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  Devuelve un <class>MongoDB\Driver\WriteResult</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Server::executeBulkWrite()</strong>


id: MongoDB\Driver\Manager::executeCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command
  
  Selects a server according to the <return>"readPreference"</return> option and executes the command on that server.
  By default, the primary server will be selected.
  
  This method applies no special logic to the command. Although this method accepts <return>"readConcern"</return>
  and <return>"writeConcern"</return> options, which will be incorporated into the command document, those options
  will not default to corresponding values from the MongoDB Connection URI nor will the MongoDB
  server version be taken into account. Users are therefore encouraged to use specific read and/or
  write command methods if possible.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$db</strong>       El nombre de la base de datos en la que
                                                      ejecutar el comando.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  El comando a ejecutar.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Un asunto de escritura a aplicar a la
                                                      operación.  Esta opción está disponible en
                                                      MongoDB 3.2+ y resultará en una excepción en
                                                      tiempo de ejecución si es especificada para
                                                      una versión de servidor más antigua.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Una preferencia de lectura a usar para
                                                      seleccionar un servidor para la operación.
                                                      session<class>MongoDB\Driver\Session</class> Una sesión a
                                                      asociar con la operación.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Un
                                                      asunto de escritura a aplicar a la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.
                                                      
                                                      Esta opción está disponible en MongoDB 3.2+ y
                                                      resultará en una excepción en tiempo de
                                                      ejecución si es especificada para una versión
                                                      de servidor más antigua.
                                                      
                                                      Una preferencia de lectura a usar para
                                                      seleccionar un servidor para la operación.
                                                      
                                                      Una sesión a asociar con la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.
                                                      
                                                      Si se usa la opción <return>"session"</return> con sesión que
                                                      tenga una transacción en progreso, no se puede
                                                      especificar una opción <return>"readConcern"</return> o
                                                      <return>"writeConcern"</return>. Esto resultarña en una
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>.
                                                      En su lugar se debería establecer estas dos
                                                      opciones al crear la transacción con
                                                      MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>


id: MongoDB\Driver\Manager::executeQuery
type: function
doc:
<comment>Description:</comment>
  Execute a database query
  
  Selects a server according to the <return>"readPreference"</return> option and executes the query on that server.
  By default, the read preference from the MongoDB Connection URI will be used.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$namespace</strong>  Un espacio de nombres completamente
                                                        cualificado (p. ej.
                                                        <return>"nombreBaseDatos.nombreColección"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      La consulta a ejecutar.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsOptionTypeDescriptionreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Una preferencia de lectura a usar para
                                                        seleccionar un servidor para la operación.
                                                        session<class>MongoDB\Driver\Session</class> Una sesión a
                                                        asociar con la operación.
                                                        
                                                        Una preferencia de lectura a usar para
                                                        seleccionar un servidor para la operación.
                                                        
                                                        Una sesión a asociar con la operación.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Cursor</class>
   * <class>MongoDB\Driver\Query</class>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Server::executeQuery()</strong>


id: MongoDB\Driver\Manager::executeReadCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that reads
  
  Selects a server according to the <return>"readPreference"</return> option and executes the command on that server.
  By default, the read preference from the MongoDB Connection URI will be used.
  
  This method will apply logic that is specific to commands that read (e.g. count) and take the
  MongoDB server version into account. The <return>"readConcern"</return> option will default to the corresponding
  value from the MongoDB Connection URI.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Un asunto de escritura a aplicar a la operación.  Esta opción
                                    está disponible en MongoDB 3.2+ y resultará en una excepción en
                                    tiempo de ejecución si es especificada para una versión de
                                    servidor más antigua.
                                    readPreference<class>MongoDB\Driver\ReadPreference</class> Una preferencia de
                                    lectura a usar para seleccionar un servidor para la operación.
                                    session<class>MongoDB\Driver\Session</class> Una sesión a asociar con la
                                    operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Esta opción está disponible en MongoDB 3.2+ y resultará en una
                                    excepción en tiempo de ejecución si es especificada para una
                                    versión de servidor más antigua.
                                    
                                    Una preferencia de lectura a usar para seleccionar un servidor
                                    para la operación.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>


id: MongoDB\Driver\Manager::executeReadWriteCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that reads and writes
  
  Executes the command on the primary server.
  
  This method will apply logic that is specific to commands that read and write (e.g. aggregate) and
  take the MongoDB server version into account. The <return>"readConcern"</return> and <return>"writeConcern"</return> options will
  default to the corresponding values from the MongoDB Connection URI.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Un asunto de escritura a aplicar a la operación.  Esta opción
                                    está disponible en MongoDB 3.2+ y resultará en una excepción en
                                    tiempo de ejecución si es especificada para una versión de
                                    servidor más antigua. session<class>MongoDB\Driver\Session</class> Una sesión a
                                    asociar con la operación.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a
                                    aplicar a la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Esta opción está disponible en MongoDB 3.2+ y resultará en una
                                    excepción en tiempo de ejecución si es especificada para una
                                    versión de servidor más antigua.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>


id: MongoDB\Driver\Manager::executeWriteCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that writes
  
  Executes the command on the primary server.
  
  This method will apply logic that is specific to commands that write (e.g. drop) and take the
  MongoDB server version into account. The <return>"writeConcern"</return> option will default to the corresponding
  value from the MongoDB Connection URI.
  
  This method is not intended to be used to execute insert, update, or delete commands. Users are
  encouraged to use <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong> for those commands.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class> Una
                                    sesión a asociar con la operación.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a
                                    aplicar a la operación.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>


id: MongoDB\Driver\Manager::getEncryptedFieldsMap
type: function
doc:
<comment>Description:</comment>
  Return the encryptedFieldsMap auto encryption option for the Manager
  
  Returns the <return>encryptedFieldsMap</return> auto encryption option for the Manager, if specified.

<comment>Return:</comment>
  <info>array|object|null</info>  The <return>encryptedFieldsMap</return> auto encryption option for the Manager, or <info>null</info> if it
                     was not specified.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getReadConcern
type: function
doc:
<comment>Description:</comment>
  Return the ReadConcern for the Manager
  
  Returns the <class>MongoDB\Driver\ReadConcern</class> for the Manager, which is derived from its URI options.
  This is the default read concern for queries and commands executed on the Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\ReadConcern</info>  The <class>MongoDB\Driver\ReadConcern</class> for the Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\ReadConcern</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getReadPreference
type: function
doc:
<comment>Description:</comment>
  Return the ReadPreference for the Manager
  
  Returns the <class>MongoDB\Driver\ReadPreference</class> for the Manager, which is derived from its URI options.
  This is the default read preference for queries and commands executed on the Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\ReadPreference</info>  The <class>MongoDB\Driver\ReadPreference</class> for the Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::getServers
type: function
doc:
<comment>Description:</comment>
  Return the servers to which this manager is connected
  
  Returns an <info>array</info> of <class>MongoDB\Driver\Server</class> instances to which this manager is connected.
  
  Since the driver connects to the database lazily, this method may return an empty <info>array</info> if called
  before executing an operation on the <class>MongoDB\Driver\Manager</class>.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of <class>MongoDB\Driver\Server</class> instances to which this manager is connected.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>
   * <strong>MongoDB\Driver\Manager::selectServer()</strong>


id: MongoDB\Driver\Manager::getWriteConcern
type: function
doc:
<comment>Description:</comment>
  Return the WriteConcern for the Manager
  
  Returns the <class>MongoDB\Driver\WriteConcern</class> for the Manager, which is derived from its URI options.
  This is the default write concern for writes and commands executed on the Manager.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteConcern</info>  The <class>MongoDB\Driver\WriteConcern</class> for the Manager.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Manager::__construct()</strong>


id: MongoDB\Driver\Manager::removeSubscriber
type: function
doc:
<comment>Description:</comment>
  Unregisters a monitoring event subscriber with this Manager
  
  Unregisters a monitoring event subscriber with this Manager.
  
  If <strong>$subscriber</strong> is not already registered with this Manager, this function is a no-op.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  A monitoring event subscriber to unregister
                                                     with this Manager.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong>
   * 


id: MongoDB\Driver\Manager::selectServer
type: function
doc:
<comment>Description:</comment>
  Select a server matching a read preference
  
  Selects a <class>MongoDB\Driver\Server</class> matching <strong>$readPreference</strong>. If <strong>$readPreference</strong> is <info>null</info> or omitted,
  the primary server will be selected by default. This may be used to preselect a server in order to
  perform version checking before executing an operation.
  
  Unlike <strong>MongoDB\Driver\Manager::getServers()</strong>, this method will initialize database connections and
  perform server discovery if necessary. See the Server Selection Specification for additional
  information.

<comment>Param:</comment>
  <info>MongoDB\Driver\ReadPreference|null</info>  <strong>$readPreference</strong>  The read preference to use for selecting a
                                                       server. If <info>null</info> or omitted, the primary
                                                       server will be selected by default.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns a <class>MongoDB\Driver\Server</class> matching the read preference.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>
   * <strong>MongoDB\Driver\Manager::getServers()</strong>
   * Server Selection Specification


id: MongoDB\Driver\Manager::startSession
type: function
doc:
<comment>Description:</comment>
  Start a new client session for use with this client
  
  Creates a <class>MongoDB\Driver\Session</class> for the given options. The session may then be specified when
  executing commands, queries, and write operations.
  
  A <class>MongoDB\Driver\Session</class> can only be used with the <class>MongoDB\Driver\Manager</class> from which it was
  created.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  optionsOptionTypeDescriptionDefaultcausalConsistency<info>bool</info> Configure causal
                        consistency in a session. If <info>true</info>, each operation in the session will be
                        causally ordered after the previous read or write operation. Set to <info>false</info> to
                        disable causal consistency.  See Casual Consistency in the MongoDB manual
                        for more information. <info>true</info>defaultTransactionOptions<info>array</info> Default options to
                        apply to newly created transactions. These options are used unless they are
                        overridden when a transaction is started with different value for each
                        option. optionsOptionTypeDescriptionmaxCommitTimeMSinteger The maximum
                        amount of time in milliseconds to allow a single <return>commitTransaction</return> command
                        to run.  If specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer
                        greater than or equal to zero. readConcern<class>MongoDB\Driver\ReadConcern</class> Un
                        asunto de escritura a aplicar a la operación.  Esta opción está disponible
                        en MongoDB 3.2+ y resultará en una excepción en tiempo de ejecución si es
                        especificada para una versión de servidor más antigua.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Una preferencia de lectura a
                        usar para seleccionar un servidor para la operación.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a aplicar a
                        la operación.  This option is available in MongoDB 4.0+. <return>[]</return>snapshot<info>bool</info>
                        Configure snapshot reads in a session. If <info>true</info>, a timestamp will be obtained
                        from the first supported read operation in the session (i.e. <return>find</return>,
                        <return>aggregate</return>, or unsharded <return>distinct</return>). Subsequent read operations within the
                        session will then utilize a <return>"snapshot"</return> read concern level to read
                        majority-committed data from that timestamp. Set to <info>false</info> to disable
                        snapshot reads.  Snapshot reads require MongoDB 5.0+ and cannot be used with
                        causal consistency, transactions, or write operations. If <return>"snapshot"</return> is
                        <info>true</info>, <return>"causalConsistency"</return> will default to <info>false</info>.  See Read Concern
                        "snapshot" in the MongoDB manual for more information. <info>false</info>
                        
                        Configure causal consistency in a session. If <info>true</info>, each operation in the
                        session will be causally ordered after the previous read or write operation.
                        Set to <info>false</info> to disable causal consistency.
                        
                        See Casual Consistency in the MongoDB manual for more information.
                        
                        Default options to apply to newly created transactions. These options are
                        used unless they are overridden when a transaction is started with different
                        value for each option.
                        
                        optionsOptionTypeDescriptionmaxCommitTimeMSinteger The maximum amount of
                        time in milliseconds to allow a single <return>commitTransaction</return> command to run.  If
                        specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than or
                        equal to zero. readConcern<class>MongoDB\Driver\ReadConcern</class> Un asunto de escritura
                        a aplicar a la operación.  Esta opción está disponible en MongoDB 3.2+ y
                        resultará en una excepción en tiempo de ejecución si es especificada para
                        una versión de servidor más antigua.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Una preferencia de lectura a
                        usar para seleccionar un servidor para la operación.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a aplicar a
                        la operación.
                        
                        The maximum amount of time in milliseconds to allow a single
                        <return>commitTransaction</return> command to run.
                        
                        If specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than
                        or equal to zero.
                        
                        Un asunto de escritura a aplicar a la operación.
                        
                        Esta opción está disponible en MongoDB 3.2+ y resultará en una excepción en
                        tiempo de ejecución si es especificada para una versión de servidor más
                        antigua.
                        
                        Una preferencia de lectura a usar para seleccionar un servidor para la
                        operación.
                        
                        Un asunto de escritura a aplicar a la operación.
                        
                        This option is available in MongoDB 4.0+.
                        
                        Configure snapshot reads in a session. If <info>true</info>, a timestamp will be obtained
                        from the first supported read operation in the session (i.e. <return>find</return>,
                        <return>aggregate</return>, or unsharded <return>distinct</return>). Subsequent read operations within the
                        session will then utilize a <return>"snapshot"</return> read concern level to read
                        majority-committed data from that timestamp. Set to <info>false</info> to disable
                        snapshot reads.
                        
                        Snapshot reads require MongoDB 5.0+ and cannot be used with causal
                        consistency, transactions, or write operations. If <return>"snapshot"</return> is <info>true</info>,
                        <return>"causalConsistency"</return> will default to <info>false</info>.
                        
                        See Read Concern "snapshot" in the MongoDB manual for more information.

<comment>Return:</comment>
  <info>MongoDB\Driver\Session</info>  Returns a <class>MongoDB\Driver\Session</class>.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Session</class>
   * Casual Consistency in the MongoDB manual


id: MongoDB\Driver\Monitoring\CommandFailedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> class encapsulates information about a failed
  command.


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getCommandName
type: function
doc:
<comment>Description:</comment>
  Returns the command name
  
  Returns the command name (e.g. <return>"find"</return>, <return>"aggregate"</return>).

<comment>Return:</comment>
  <info>string</info>  Returns the command name.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getDurationMicros
type: function
doc:
<comment>Description:</comment>
  Returns the command's duration in microseconds
  
  The command's duration is a calculated value that includes the time to send the message and
  receive the reply from the server.

<comment>Return:</comment>
  <info>int</info>  Returns the command's duration in microseconds.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getError
type: function
doc:
<comment>Description:</comment>
  Returns the Exception associated with the failed command

<comment>Return:</comment>
  <info>Exception</info>  Returns the <class>Exception</class> associated with the failed command.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Returns the command's operation ID
  
  The operation ID is generated by the driver and may be used to link events together such as bulk
  write operations, which may have been split across several commands at the protocol level.
  
  Since multiple commands may share the same operation ID, it is not reliable to use this value to
  associate event objects with each other. The request ID returned by
  MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId should be used instead.

<comment>Return:</comment>
  <info>string</info>  Returns the command's operation ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getReply
type: function
doc:
<comment>Description:</comment>
  Returns the command reply document
  
  The reply document will be converted from BSON to PHP using the default deserialization rules
  (e.g. BSON documents will be converted to <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Returns the command reply document as a <class>stdClass</class> object.

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


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Returns the command's request ID
  
  The request ID is generated by the driver and may be used to associate this
  <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> with a previous
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>.

<comment>Return:</comment>
  <info>string</info>  Returns the command's request ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the Server on which the command was executed
  
  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Returns the server connection ID for the command
  
  Returns the server connection ID for the command. The server connection ID is distinct from server
  (i.e. <strong>MongoDB\Driver\Monitoring\CommandFailedEvent::getServer()</strong>) and is returned in the
  "connectionId" field of a <return>hello</return> command response MongoDB 4.2+.

<comment>Return:</comment>
  <info>int|null</info>  Returns the server connection ID, or <info>null</info> if it is not available.


id: MongoDB\Driver\Monitoring\CommandFailedEvent::getServiceId
type: function
doc:
<comment>Description:</comment>
  Returns the load balancer service ID for the command
  
  When the driver is connected to a MongoDB cluster through a load balancer, the service ID
  corresponds to the <return>serviceId</return> field in the <return>hello</return> command response.

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId|null</info>  Returns the load balancer service ID, or <info>null</info> if the driver is not
                              connected to a load balancer.


id: MongoDB\Driver\Monitoring\CommandStartedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class> class encapsulates information about a started
  command.


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getCommand
type: function
doc:
<comment>Description:</comment>
  Returns the command document
  
  The reply document will be converted from BSON to PHP using the default deserialization rules
  (e.g. BSON documents will be converted to <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Returns the command document as a <class>stdClass</class> object.

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


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getDatabaseName
type: function
doc:
<comment>Description:</comment>
  Returns the database on which the command was executed

<comment>Return:</comment>
  <info>string</info>  Returns the database on which the command was executed.

<comment>See Also:</comment>
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Returns the command's operation ID
  
  The operation ID is generated by the driver and may be used to link events together such as bulk
  write operations, which may have been split across several commands at the protocol level.
  
  Since multiple commands may share the same operation ID, it is not reliable to use this value to
  associate event objects with each other. The request ID returned by
  MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId should be used instead.

<comment>Return:</comment>
  <info>string</info>  Returns the command's operation ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Returns the command's request ID
  
  The request ID is generated by the driver and may be used to associate this
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class> with a later
  <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class> or <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class>.

<comment>Return:</comment>
  <info>string</info>  Returns the command's request ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the Server on which the command was executed
  
  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandFailedEvent::getServer
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandStartedEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Returns the server connection ID for the command
  
  Returns the server connection ID for the command. The server connection ID is distinct from server
  (i.e. <strong>MongoDB\Driver\Monitoring\CommandStartedEvent::getServer()</strong>) and is returned in the
  "connectionId" field of a <return>hello</return> command response MongoDB 4.2+.

<comment>Return:</comment>
  <info>int|null</info>  Returns the server connection ID, or <info>null</info> if it is not available.


id: MongoDB\Driver\Monitoring\CommandSubscriber
type: class
doc:
<comment>Description:</comment>
  Classes may implement this interface to register an event subscriber that is notified for each
  started, successful, and failed command event. See  for additional information.


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandFailed
type: function
doc:
<comment>Description:</comment>
  Notification method for a failed command
  
  If the subscriber has been registered, the driver will call this method when a command has failed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandFailedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                        about the failed command.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandFailedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandStarted
type: function
doc:
<comment>Description:</comment>
  Notification method for a started command
  
  If the subscriber has been registered, the driver will call this method when a command has
  started.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandStartedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                         about the started command.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSubscriber::commandSucceeded
type: function
doc:
<comment>Description:</comment>
  Notification method for a successful command
  
  If the subscriber has been registered, the driver will call this method when a command has
  succeeded.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\CommandSucceededEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                           about the successful command.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class> class encapsulates information about a
  successful command.


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getOperationId
type: function
doc:
<comment>Description:</comment>
  Returns the command's operation ID
  
  The operation ID is generated by the driver and may be used to link events together such as bulk
  write operations, which may have been split across several commands at the protocol level.
  
  Since multiple commands may share the same operation ID, it is not reliable to use this value to
  associate event objects with each other. The request ID returned by
  MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId should be used instead.

<comment>Return:</comment>
  <info>string</info>  Returns the command's operation ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getOperationId
   * MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId
type: function
doc:
<comment>Description:</comment>
  Returns the command's request ID
  
  The request ID is generated by the driver and may be used to associate this
  <class>MongoDB\Driver\Monitoring\CommandSucceededEvent</class> with a previous
  <class>MongoDB\Driver\Monitoring\CommandStartedEvent</class>.

<comment>Return:</comment>
  <info>string</info>  Returns the command's request ID.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the Server on which the command was executed
  
  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> on which the command was executed.

<comment>See Also:</comment>
   * MongoDB\Driver\Monitoring\CommandStartedEvent::getServer
   * MongoDB\Driver\Cursor::getServer
   * MongoDB\Driver\WriteResult::getServer
   * 


id: MongoDB\Driver\Monitoring\CommandSucceededEvent::getServerConnectionId
type: function
doc:
<comment>Description:</comment>
  Returns the server connection ID for the command
  
  Returns the server connection ID for the command. The server connection ID is distinct from server
  (i.e. <strong>MongoDB\Driver\Monitoring\CommandSucceededEvent::getServer()</strong>) and is returned in the
  "connectionId" field of a <return>hello</return> command response MongoDB 4.2+.

<comment>Return:</comment>
  <info>int|null</info>  Returns the server connection ID, or <info>null</info> if it is not available.


id: MongoDB\Driver\Monitoring\SDAMSubscriber
type: class
doc:
<comment>Description:</comment>
  Classes may implement this interface to register an event subscriber that is notified for various
  SDAM events. See the Server Discovery and Monitoring and SDAM Monitoring specifications for
  additional information.


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverChanged
type: function
doc:
<comment>Description:</comment>
  Notification method for a server description change
  
  If the subscriber has been registered, the driver will call this method when a server's
  description has changed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerChangedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                        about the changed server description.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverClosed
type: function
doc:
<comment>Description:</comment>
  Notification method for closing a server
  
  If the subscriber has been registered, the driver will call this method when a server is closed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerClosedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                       about the closed server.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerClosedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatFailed
type: function
doc:
<comment>Description:</comment>
  Notification method for a failed server heartbeat
  
  If the subscriber has been registered, the driver will call this method when a server heartbeat
  (i.e. hello command issued through server monitoring) has failed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</info>  <strong>$event</strong>  An event object encapsulating
                                                                information about the failed server
                                                                heartbeat.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatStarted
type: function
doc:
<comment>Description:</comment>
  Notification method for a started server heartbeat
  
  If the subscriber has been registered, the driver will call this method when a server heartbeat
  (i.e. hello command issued through server monitoring) has started.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</info>  <strong>$event</strong>  An event object encapsulating
                                                                 information about the started
                                                                 server heartbeat.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverHeartbeatSucceeded
type: function
doc:
<comment>Description:</comment>
  Notification method for a successful server heartbeat
  
  If the subscriber has been registered, the driver will call this method when a server heartbeat
  (i.e. hello command issued through server monitoring) has succeeded.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</info>  <strong>$event</strong>  An event object encapsulating
                                                                   information about the successful
                                                                   server heartbeat.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::serverOpening
type: function
doc:
<comment>Description:</comment>
  Notification method for opening a server
  
  If the subscriber has been registered, the driver will call this method when a server is opened.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\ServerOpeningEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                        about the opened server.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\ServerOpeningEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyChanged
type: function
doc:
<comment>Description:</comment>
  Notification method for a topology description change
  
  If the subscriber has been registered, the driver will call this method when the topology's
  description has changed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyChangedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                          about the changed topology description.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyClosed
type: function
doc:
<comment>Description:</comment>
  Notification method for closing the topology
  
  If the subscriber has been registered, the driver will call this method when the topology is
  closed.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyClosedEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                         about the closed topology.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyClosedEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\SDAMSubscriber::topologyOpening
type: function
doc:
<comment>Description:</comment>
  Notification method for opening the topology
  
  If the subscriber has been registered, the driver will call this method when the topology is
  opened.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\TopologyOpeningEvent</info>  <strong>$event</strong>  An event object encapsulating information
                                                          about the opened topology.

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

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Monitoring\TopologyOpeningEvent</class>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>


id: MongoDB\Driver\Monitoring\ServerChangedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class> class encapsulates information about a changed
  server description.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getHost
type: function
doc:
<comment>Description:</comment>
  Returns the hostname of the server

<comment>Return:</comment>
  <info>string</info>  Returns the hostname of the server.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getNewDescription
type: function
doc:
<comment>Description:</comment>
  Returns the new description for the server

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Returns the new <class>MongoDB\Driver\ServerDescription</class> for the server.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getPort
type: function
doc:
<comment>Description:</comment>
  Returns the port on which this server is listening

<comment>Return:</comment>
  <info>int</info>  Returns the port on which this server is listening.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getPreviousDescription
type: function
doc:
<comment>Description:</comment>
  Returns the previous description for the server

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Returns the previous <class>MongoDB\Driver\ServerDescription</class> for the
                                    server.


id: MongoDB\Driver\Monitoring\ServerChangedEvent::getTopologyId
type: function
doc:
<comment>Description:</comment>
  Returns the topology ID associated with this server

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId</info>  Returns the topology ID.


id: MongoDB\Driver\Monitoring\ServerClosedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerClosedEvent</class> class encapsulates information about a closed
  server.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent</class> class encapsulates information about a
  failed server heartbeat.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getDurationMicros
type: function
doc:
<comment>Description:</comment>
  Returns the heartbeat's duration in microseconds
  
  The heartbeat's duration is a calculated value that includes the time to send the message and
  receive the reply from the server.

<comment>Return:</comment>
  <info>int</info>  Returns the heartbeat's duration in microseconds.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::getError
type: function
doc:
<comment>Description:</comment>
  Returns the Exception associated with the failed heartbeat

<comment>Return:</comment>
  <info>Exception</info>  Returns the <class>Exception</class> associated with the failed heartbeat.


id: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent::isAwaited
type: function
doc:
<comment>Description:</comment>
  Returns whether the heartbeat used a streaming protocol
  
  Returns whether the heartbeat used a streaming protocol. The PHP driver does not use the streaming
  protocol for monitoring, so this method will always return <info>false</info>.

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


id: MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerHeartbeatStartedEvent</class> class encapsulates information about a
  started server heartbeat.


id: MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent</class> class encapsulates information about a
  successful server heartbeat.


id: MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent::getReply
type: function
doc:
<comment>Description:</comment>
  Returns the heartbeat reply document
  
  The reply document will be converted from BSON to PHP using the default deserialization rules
  (e.g. BSON documents will be converted to <info>stdClass</info>).

<comment>Return:</comment>
  <info>object</info>  Returns the heartbeat reply document as a <class>stdClass</class> object.

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


id: MongoDB\Driver\Monitoring\ServerOpeningEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\ServerOpeningEvent</class> class encapsulates information about an opened
  server.


id: MongoDB\Driver\Monitoring\Subscriber
type: class
doc:
<comment>Description:</comment>
  Base interface for event subscribers. This is used as a parameter type in the functions
  <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong> and <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong> and
  should not be implemented directly.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class> class encapsulates information about a changed
  topology description.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getNewDescription
type: function
doc:
<comment>Description:</comment>
  Returns the new description for the topology

<comment>Return:</comment>
  <info>MongoDB\Driver\TopologyDescription</info>  Returns the new <class>MongoDB\Driver\TopologyDescription</class> for the
                                      topology.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getPreviousDescription
type: function
doc:
<comment>Description:</comment>
  Returns the previous description for the topology

<comment>Return:</comment>
  <info>MongoDB\Driver\TopologyDescription</info>  Returns the previous <class>MongoDB\Driver\TopologyDescription</class> for
                                      the topology.


id: MongoDB\Driver\Monitoring\TopologyChangedEvent::getTopologyId
type: function
doc:
<comment>Description:</comment>
  Returns the topology ID

<comment>Return:</comment>
  <info>MongoDB\BSON\ObjectId</info>  Returns the topology ID.


id: MongoDB\Driver\Monitoring\TopologyClosedEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\TopologyClosedEvent</class> class encapsulates information about a closed
  topology.


id: MongoDB\Driver\Monitoring\TopologyOpeningEvent
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Monitoring\TopologyOpeningEvent</class> class encapsulates information about an opened
  topology.


id: MongoDB\Driver\Monitoring\addSubscriber
type: function
doc:
<comment>Description:</comment>
  Registers a monitoring event subscriber globally
  
  Registers a monitoring event subscriber globally. The subscriber will be notified of all events in
  the driver for any Manager.
  
  If <strong>$subscriber</strong> is already registered globally, this function is a no-op. If <strong>$subscriber</strong> is also
  registered with one or more Managers, it will still only be notified once of each event for each
  Manager.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  A monitoring event subscriber to register
                                                     globally.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Monitoring\removeSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Manager::addSubscriber()</strong>
   * 


id: MongoDB\Driver\Monitoring\removeSubscriber
type: function
doc:
<comment>Description:</comment>
  Unregisters a monitoring event subscriber globally
  
  Unregisters a monitoring event subscriber globally.
  
  If <strong>$subscriber</strong> is not already registered globally, this function is a no-op.

<comment>Param:</comment>
  <info>MongoDB\Driver\Monitoring\Subscriber</info>  <strong>$subscriber</strong>  A monitoring event subscriber to unregister
                                                     globally.

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

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>
   * MongoDB\Driver\Monitoring\Subscriber
   * MongoDB\Driver\Monitoring\CommandSubscriber
   * <strong>MongoDB\Driver\Manager::removeSubscriber()</strong>
   * 


id: MongoDB\Driver\Query
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Query</class> class is a value object that represents a database query.


id: MongoDB\Driver\Query::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Query
  
  Constructs a new <class>MongoDB\Driver\Query</class>, which is an immutable value object that represents a
  database query. The query may then be executed with MongoDB\Driver\Manager::executeQuery.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>        El predicado de la consulta. Un predicado vacío coincidirá con todos
                               los documentos de una colección.
                               
                               Al evaluar criterios de consulta, MongoDB compara tipos y valores
                               según sus propias reglas de comparación para tipos BSON, lo cual
                               difiere de las reglas de comparación y manejo de tipos de PHP. Al
                               encontrar un tipo BSON especial, los criterios de consulta deben
                               utilizar la clase BSON respectiva (p.ej. usar <class>MongoDB\BSON\ObjectID</class>
                               al encontrar un ObjectID).
  <info>array|null</info>    <strong>$queryOptions</strong>  queryOptionsOptionTypeDescriptionallowDiskUse<info>bool</info> Allows MongoDB to
                               use temporary disk files to store data exceeding the 100 megabyte
                               system memory limit while processing a blocking sort operation.
                               allowPartialResults<info>bool</info> For queries against a sharded collection,
                               returns partial results from the mongos if some shards are
                               unavailable instead of throwing an error.  Falls back to the
                               deprecated <return>"partial"</return> option if not specified. awaitData<info>bool</info> Use in
                               conjunction with the <return>"tailable"</return> option to block a getMore operation
                               on the cursor temporarily if at the end of data rather than returning
                               no data. After a timeout period, the query returns as normal.
                               batchSize<info>int</info> The number of documents to return in the first batch.
                               Defaults to 101. A batch size of 0 means that the cursor will be
                               established, but no documents will be returned in the first batch.
                               In versions of MongoDB before 3.2, where queries use the legacy wire
                               protocol OP_QUERY, a batch size of 1 will close the cursor
                               irrespective of the number of matched documents.
                               collation<info>array|object</info>Collation, o cotejamiento, permite a los
                               usuarios especificar reglas específcas del lenguaje para comparar
                               cadenas, tales como reglas para mayúsculas/minúsculas y marcas de
                               acento. Cuando se especifica el cotejamiento, el cambpo <return>"locale"</return> es
                               obligatorio; todos los demás campos de cotejamiento son opcionales.
                               Para la descripción de los campos, véase la Documentación de
                               Collation.  Si no se especifica el cotejamiento y la colección tiene
                               un cotejamiento predeterminado, la operación usará el cotejamiento
                               especificado por la colección. Si no se especifica el cotejamiento
                               para la colección o para la operación, MongoDB usará la comparación
                               binaria simple utilizada en versiones anteriores para comparar
                               cadenas.  Esta opción está disponible en MongoDB 3.4+ y resultará en
                               una excepción durante la ejecución si se especifica para una versión
                               más antigua del servidor. comment<info>mixed</info> An arbitrary comment to help
                               trace the operation through the database profiler, currentOp output,
                               and logs.  The comment can be any valid BSON type for MongoDB 4.4+.
                               Earlier server versions only support string values.  Falls back to
                               the deprecated <return>"$comment"</return> modifier if not specified. exhaust<info>bool</info>
                               Stream the data down full blast in multiple "more" packages, on the
                               assumption that the client will fully read all data queried. Faster
                               when you are pulling a lot of data and know you want to pull it all
                               down. Note: the client is not allowed to not read all the data unless
                               it closes the connection.  This option is not supported by the find
                               command in MongoDB 3.2+ and will force the driver to use the legacy
                               wire protocol version (i.e. OP_QUERY). explain<info>bool</info> If <info>true</info>, the
                               returned <class>MongoDB\Driver\Cursor</class> will contain a single document that
                               describes the process and indexes used to return the query.  Falls
                               back to the deprecated <return>"$explain"</return> modifier if not specified.  This
                               option is not supported by the find command in MongoDB 3.2+ and will
                               only be respected when using the legacy wire protocol version (i.e.
                               OP_QUERY). The explain command should be used on MongoDB 3.0+.
                               hint<info>string</info><info>array</info><info>object</info></info> Index specification. Specify either the index
                               name as a string or the index key pattern. If specified, then the
                               query system will only consider plans using the hinted index.  Falls
                               back to the deprecated <return>"hint"</return> option if not specified. let<info>array</info><info>object</info></info>
                               Map of parameter names and values. Values must be constant or closed
                               expressions that do not reference document fields. Parameters can
                               then be accessed as variables in an aggregate expression context
                               (e.g. <return>$$var</return>).  This option is available in MongoDB 5.0+ and will
                               result in an exception at execution time if specified for an older
                               server version. limit<info>int</info> The maximum number of documents to return.
                               If unspecified, then defaults to no limit. A limit of 0 is equivalent
                               to setting no limit.  A negative limit is will be interpreted as a
                               positive limit with the <return>"singleBatch"</return> option set to <info>true</info>. This
                               behavior is supported for backwards compatibility, but should be
                               considered deprecated. max<info>array</info><info>object</info></info> The exclusive upper bound for a
                               specific index.  Falls back to the deprecated <return>"$max"</return> modifier if not
                               specified. maxAwaitTimeMS<info>int</info> Positive integer denoting the time limit
                               in milliseconds for the server to block a getMore operation if no
                               data is available. This option should only be used in conjunction
                               with the <return>"tailable"</return> and <return>"awaitData"</return> options. maxScan<info>int</info> This option
                               is deprecated and should not be used.  Positive integer denoting the
                               maximum number of documents or index keys to scan when executing the
                               query.  Falls back to the deprecated <return>"$maxScan"</return> modifier if not
                               specified. maxTimeMS<info>int</info> The cumulative time limit in milliseconds for
                               processing operations on the cursor. MongoDB aborts the operation at
                               the earliest following interrupt point.  Falls back to the deprecated
                               <return>"$maxTimeMS"</return> modifier if not specified. min<info>array</info><info>object</info></info> The inclusive
                               lower bound for a specific index.  Falls back to the deprecated
                               <return>"$min"</return> modifier if not specified. modifiers<info>array</info>Meta operators
                               modifying the output or behavior of a query. Use of these operators
                               is deprecated in favor of named options. noCursorTimeout<info>bool</info> Prevents
                               the server from timing out idle cursors after an inactivity period
                               (10 minutes). oplogReplay<info>bool</info> Internal use for replica sets. To use
                               oplogReplay, you must include the following condition in the filter:
                               [ '$gte' =>  ] ]
                               ]]>This option is deprecated as of the 1.8.0
                               release.projection<info>array</info><info>object</info></info> The projection specification to
                               determine which fields to include in the returned documents.  If you
                               are using the ODM functionality to deserialise documents as their
                               original PHP class, make sure that you include the __pclass field in
                               the projection. This is required for the deserialization to work and
                               without it, the driver will return (by default) a <class>stdClass</class> object
                               instead. readConcern<class>MongoDB\Driver\ReadConcern</class> A read concern to
                               apply to the operation. By default, the read concern from the MongoDB
                               Connection URI will be used.  This option is available in MongoDB
                               3.2+ and will result in an exception at execution time if specified
                               for an older server version. returnKey<info>bool</info> If <info>true</info>, returns only the
                               index keys in the resulting documents. Default value is <info>false</info>. If
                               <info>true</info> and the find command does not use an index, the returned
                               documents will be empty.  Falls back to the deprecated <return>"$returnKey"</return>
                               modifier if not specified. showRecordId<info>bool</info> Determines whether to
                               return the record identifier for each document. If <info>true</info>, adds a
                               top-level <return>"$recordId"</return> field to the returned documents.  Falls back to
                               the deprecated <return>"$showDiskLoc"</return> modifier if not specified.
                               singleBatch<info>bool</info> Determines whether to close the cursor after the
                               first batch. Defaults to <info>false</info>. skip<info>int</info>Number of documents to skip.
                               Defaults to 0.snapshot<info>bool</info> This option is deprecated and should not
                               be used.  Prevents the cursor from returning a document more than
                               once because of an intervening write operation.  Falls back to the
                               deprecated <return>"$snapshot"</return> modifier if not specified. sort<info>array</info><info>object</info></info>The
                               sort specification for the ordering of the results. Falls back to the
                               deprecated <return>"$orderby"</return> modifier if not specified. tailable<info>bool</info>Returns
                               a tailable cursor for a capped collection.
                               
                               Allows MongoDB to use temporary disk files to store data exceeding
                               the 100 megabyte system memory limit while processing a blocking sort
                               operation.
                               
                               For queries against a sharded collection, returns partial results
                               from the mongos if some shards are unavailable instead of throwing an
                               error.
                               
                               Falls back to the deprecated <return>"partial"</return> option if not specified.
                               
                               The number of documents to return in the first batch. Defaults to
                               101. A batch size of 0 means that the cursor will be established, but
                               no documents will be returned in the first batch.
                               
                               In versions of MongoDB before 3.2, where queries use the legacy wire
                               protocol OP_QUERY, a batch size of 1 will close the cursor
                               irrespective of the number of matched documents.
                               
                               Collation, o cotejamiento, permite a los usuarios especificar reglas
                               específcas del lenguaje para comparar cadenas, tales como reglas para
                               mayúsculas/minúsculas y marcas de acento. Cuando se especifica el
                               cotejamiento, el cambpo <return>"locale"</return> es obligatorio; todos los demás
                               campos de cotejamiento son opcionales. Para la descripción de los
                               campos, véase la Documentación de Collation.
                               
                               Si no se especifica el cotejamiento y la colección tiene un
                               cotejamiento predeterminado, la operación usará el cotejamiento
                               especificado por la colección. Si no se especifica el cotejamiento
                               para la colección o para la operación, MongoDB usará la comparación
                               binaria simple utilizada en versiones anteriores para comparar
                               cadenas.
                               
                               Esta opción está disponible en MongoDB 3.4+ y resultará en una
                               excepción durante la ejecución si se especifica para una versión más
                               antigua del servidor.
                               
                               An arbitrary comment to help trace the operation through the database
                               profiler, currentOp output, and logs.
                               
                               The comment can be any valid BSON type for MongoDB 4.4+. Earlier
                               server versions only support string values.
                               
                               Falls back to the deprecated <return>"$comment"</return> modifier if not specified.
                               
                               Stream the data down full blast in multiple "more" packages, on the
                               assumption that the client will fully read all data queried. Faster
                               when you are pulling a lot of data and know you want to pull it all
                               down. Note: the client is not allowed to not read all the data unless
                               it closes the connection.
                               
                               This option is not supported by the find command in MongoDB 3.2+ and
                               will force the driver to use the legacy wire protocol version (i.e.
                               OP_QUERY).
                               
                               If <info>true</info>, the returned <class>MongoDB\Driver\Cursor</class> will contain a single
                               document that describes the process and indexes used to return the
                               query.
                               
                               Falls back to the deprecated <return>"$explain"</return> modifier if not specified.
                               
                               This option is not supported by the find command in MongoDB 3.2+ and
                               will only be respected when using the legacy wire protocol version
                               (i.e. OP_QUERY). The explain command should be used on MongoDB 3.0+.
                               
                               Index specification. Specify either the index name as a string or the
                               index key pattern. If specified, then the query system will only
                               consider plans using the hinted index.
                               
                               Falls back to the deprecated <return>"hint"</return> option if not specified.
                               
                               Map of parameter names and values. Values must be constant or closed
                               expressions that do not reference document fields. Parameters can
                               then be accessed as variables in an aggregate expression context
                               (e.g. <return>$$var</return>).
                               
                               This option is available in MongoDB 5.0+ and will result in an
                               exception at execution time if specified for an older server version.
                               
                               The maximum number of documents to return. If unspecified, then
                               defaults to no limit. A limit of 0 is equivalent to setting no limit.
                               
                               A negative limit is will be interpreted as a positive limit with the
                               <return>"singleBatch"</return> option set to <info>true</info>. This behavior is supported for
                               backwards compatibility, but should be considered deprecated.
                               
                               The exclusive upper bound for a specific index.
                               
                               Falls back to the deprecated <return>"$max"</return> modifier if not specified.
                               
                               Positive integer denoting the time limit in milliseconds for the
                               server to block a getMore operation if no data is available. This
                               option should only be used in conjunction with the <return>"tailable"</return> and
                               <return>"awaitData"</return> options.
                               
                               This option is deprecated and should not be used.
                               
                               Positive integer denoting the maximum number of documents or index
                               keys to scan when executing the query.
                               
                               Falls back to the deprecated <return>"$maxScan"</return> modifier if not specified.
                               
                               The cumulative time limit in milliseconds for processing operations
                               on the cursor. MongoDB aborts the operation at the earliest following
                               interrupt point.
                               
                               Falls back to the deprecated <return>"$maxTimeMS"</return> modifier if not specified.
                               
                               The inclusive lower bound for a specific index.
                               
                               Falls back to the deprecated <return>"$min"</return> modifier if not specified.
                               
                               Internal use for replica sets. To use oplogReplay, you must include
                               the following condition in the filter:
                               
                                [ '$gte' =>  ] ]
                               ]]>
                               
                               This option is deprecated as of the 1.8.0 release.
                               
                               The projection specification to determine which fields to include in
                               the returned documents.
                               
                               If you are using the ODM functionality to deserialise documents as
                               their original PHP class, make sure that you include the __pclass
                               field in the projection. This is required for the deserialization to
                               work and without it, the driver will return (by default) a <class>stdClass</class>
                               object instead.
                               
                               A read concern to apply to the operation. By default, the read
                               concern from the MongoDB Connection URI will be used.
                               
                               This option is available in MongoDB 3.2+ and will result in an
                               exception at execution time if specified for an older server version.
                               
                               If <info>true</info>, returns only the index keys in the resulting documents.
                               Default value is <info>false</info>. If <info>true</info> and the find command does not use an
                               index, the returned documents will be empty.
                               
                               Falls back to the deprecated <return>"$returnKey"</return> modifier if not specified.
                               
                               Determines whether to return the record identifier for each document.
                               If <info>true</info>, adds a top-level <return>"$recordId"</return> field to the returned
                               documents.
                               
                               Falls back to the deprecated <return>"$showDiskLoc"</return> modifier if not
                               specified.
                               
                               This option is deprecated and should not be used.
                               
                               Prevents the cursor from returning a document more than once because
                               of an intervening write operation.
                               
                               Falls back to the deprecated <return>"$snapshot"</return> modifier if not specified.
                               
                               The sort specification for the ordering of the results.
                               
                               Falls back to the deprecated <return>"$orderby"</return> modifier if not specified.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeQuery
   * <class>MongoDB\Driver\Cursor</class>


id: MongoDB\Driver\ReadConcern
type: class
doc:
<comment>Description:</comment>
  <class>MongoDB\Driver\ReadConcern</class> controls the level of isolation for read operations for replica sets
  and replica set shards. This option requires MongoDB 3.2 or later.


id: MongoDB\Driver\ReadConcern::AVAILABLE
type: constant
doc:
<comment>Description:</comment>
  Default for reads against secondaries when <return>afterClusterTime</return>and <return>level</return> are unspecified.
  
  The query returns the instance's most recent data. Provides no guarantee that the data has been
  written to a majority of the replica set members (i.e. may be rolled back).
  
  For unsharded collections (including collections in a standalone deployment or a replica set
  deployment), <return>"local"</return> and <return>"available"</return> read concerns behave identically.
  
  For a sharded cluster, <return>"available"</return> read concern provides greater tolerance for partitions since it
  does not wait to ensure consistency guarantees. However, a query with <return>"available"</return> read concern may
  return orphan documents if the shard is undergoing chunk migrations since the <return>"available"</return> read
  concern, unlike <return>"local"</return> read concern, does not contact the shard's primary nor the config servers
  for updated metadata.


id: MongoDB\Driver\ReadConcern::LINEARIZABLE
type: constant
doc:
<comment>Description:</comment>
  The query returns data that reflects all successful writes issued with a write concern of
  <return>"majority"</return> and acknowledged prior to the start of the read operation. For replica sets that run
  with <return>writeConcernMajorityJournalDefault</return> set to <info>true</info>, linearizable read concern returns data that
  will never be rolled back.
  
  With <return>writeConcernMajorityJournalDefault</return> set to <info>false</info>, MongoDB will not wait for <return>w: "majority"</return>
  writes to be durable before acknowledging the writes. As such, <return>"majority"</return> write operations could
  possibly roll back in the event of a loss of a replica set member.
  
  You can specify linearizable read concern for read operations on the primary only.
  
  Linearizable read concern guarantees only apply if read operations specify a query filter that
  uniquely identifies a single document.
  
  Always use <return>maxTimeMS</return> with linearizable read concern in case a majority of data bearing members are
  unavailable. <return>maxTimeMS</return> ensures that the operation does not block indefinitely and instead ensures
  that the operation returns an error if the read concern cannot be fulfilled.
  
  Linearizable read concern requires MongoDB 3.4.


id: MongoDB\Driver\ReadConcern::LOCAL
type: constant
doc:
<comment>Description:</comment>
  Default for reads against primary if <return>level</return> is unspecified and for reads against secondaries if
  <return>level</return> is unspecified but <return>afterClusterTime</return> is specified.
  
  The query returns the instance's most recent data. Provides no guarantee that the data has been
  written to a majority of the replica set members (i.e. may be rolled back).


id: MongoDB\Driver\ReadConcern::MAJORITY
type: constant
doc:
<comment>Description:</comment>
  The query returns the instance's most recent data acknowledged as having been written to a
  majority of members in the replica set.
  
  To use read concern level of <return>"majority"</return>, replica sets must use WiredTiger storage engine and
  election protocol version 1.


id: MongoDB\Driver\ReadConcern::SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Read concern <return>"snapshot"</return> is available for multi-document transactions, and starting in MongoDB 5.0,
  certain read operations outside of multi-document transactions.
  
  If the transaction is not part of a causally consistent session, upon transaction commit with
  write concern <return>"majority"</return>, the transaction operations are guaranteed to have read from a snapshot
  of majority-committed data.
  
  If the transaction is part of a causally consistent session, upon transaction commit with write
  concern <return>"majority"</return>, the transaction operations are guaranteed to have read from a snapshot of
  majority-committed data that provides causal consistency with the operation immediately preceding
  the transaction start.
  
  Outside of multi-document transactions, read concern <return>"snapshot"</return> is available on primaries and
  secondaries for the following read operations: <return>find</return>, <return>aggregate</return>, and <return>distinct</return> (on unsharded
  collections). All other read commands prohibit <return>"snapshot"</return>.


id: MongoDB\Driver\ReadConcern::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new ReadConcern
  
  Constructs a new <class>MongoDB\Driver\ReadConcern</class>, which is an immutable value object.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$level</strong>  The read concern level. You may use, but are not limited to, one of the class
                       constants.

<comment>See Also:</comment>
   * Read Concern reference


id: MongoDB\Driver\ReadConcern::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns an object for BSON serialization

<comment>Return:</comment>
  <info>stdClass</info>  Returns an object for serializing the ReadConcern as BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Read Concern reference


id: MongoDB\Driver\ReadConcern::getLevel
type: function
doc:
<comment>Description:</comment>
  Returns the ReadConcern's "level" option

<comment>Return:</comment>
  <info>string|null</info>  Returns the ReadConcern's "level" option.

<comment>See Also:</comment>
   * Read Concern reference


id: MongoDB\Driver\ReadConcern::isDefault
type: function
doc:
<comment>Description:</comment>
  Checks if this is the default read concern
  
  Returns whether this is the default read concern (i.e. no options are specified). This method is
  primarily intended to be used in conjunction with MongoDB\Driver\Manager::getReadConcern to
  determine whether the Manager has been constructed without any read concern options.
  
  The driver will not include a default read concern in its read operations (e.g.
  MongoDB\Driver\Manager::executeQuery) in order order to allow the server to apply its own default.
  Libraries that access the Manager's read concern to include it in their own read commands should
  use this method to ensure that default read concerns are left unset.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this is the default read concern and <info>false</info> otherwise.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::getReadConcern
   * Read Concern reference


id: MongoDB\Driver\ReadConcern::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a ReadConcern

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\Driver\ReadConcern</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\ReadConcern::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\ReadConcern::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a ReadConcern

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\Driver\ReadConcern</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\ReadConcern::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\ReadPreference::NEAREST
type: constant
doc:
<comment>Description:</comment>
  Operations read from member of the replica set with the least network latency, irrespective of the
  member's type.


id: MongoDB\Driver\ReadPreference::NO_MAX_STALENESS
type: constant
doc:
<comment>Description:</comment>
  The default value for the <return>"maxStalenessSeconds"</return> option is to specify no limit on maximum
  staleness, which means that the driver will not consider a secondary's lag when choosing where to
  direct a read operation.


id: MongoDB\Driver\ReadPreference::PRIMARY
type: constant
doc:
<comment>Description:</comment>
  All operations read from the current replica set primary. This is the default read preference for
  MongoDB.


id: MongoDB\Driver\ReadPreference::PRIMARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  In most situations, operations read from the primary but if it is unavailable, operations read
  from secondary members.


id: MongoDB\Driver\ReadPreference::RP_SECONDARY
type: constant
doc:
<comment>Description:</comment>
  All operations read from the secondary members of the replica set.


id: MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED
type: constant
doc:
<comment>Description:</comment>
  In most situations, operations read from secondary members but if no secondary members are
  available, operations read from the primary.


id: MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS
type: constant
doc:
<comment>Description:</comment>
  The minimum value for the <return>"maxStalenessSeconds"</return> option is 90 seconds. The driver estimates
  secondaries' staleness by periodically checking the latest write date of each replica set member.
  Since these checks are infrequent, the staleness estimate is coarse. Thus, the driver cannot
  enforce a max staleness value of less than 90 seconds.


id: MongoDB\Driver\ReadPreference::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new ReadPreference
  
  Constructs a new <class>MongoDB\Driver\ReadPreference</class>, which is an immutable value object.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$mode</strong>     Read preference
                        modeValueDescription<info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info> or <return>"primary"</return>
                        All operations read from the current replica set primary. This is the
                        default read preference for MongoDB.
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY_PREFERRED</info> or <return>"primaryPreferred"</return> In
                        most situations, operations read from the primary but if it is unavailable,
                        operations read from secondary members.
                        <info>MongoDB\Driver\ReadPreference::RP_SECONDARY</info> or <return>"secondary"</return> All operations
                        read from the secondary members of the replica set.
                        <info>MongoDB\Driver\ReadPreference::RP_SECONDARY_PREFERRED</info> or
                        <return>"secondaryPreferred"</return> In most situations, operations read from secondary
                        members but if no secondary members are available, operations read from the
                        primary. <info>MongoDB\Driver\ReadPreference::RP_NEAREST</info> or <return>"nearest"</return> Operations
                        read from member of the replica set with the least network latency,
                        irrespective of the member's type.
                        
                        All operations read from the current replica set primary. This is the
                        default read preference for MongoDB.
                        
                        In most situations, operations read from the primary but if it is
                        unavailable, operations read from secondary members.
                        
                        All operations read from the secondary members of the replica set.
                        
                        In most situations, operations read from secondary members but if no
                        secondary members are available, operations read from the primary.
                        
                        Operations read from member of the replica set with the least network
                        latency, irrespective of the member's type.
  <info>array|null</info>  <strong>$tagSets</strong>  Tag sets allow you to target read operations to specific members of a
                        replica set. This parameter should be an array of associative arrays, each
                        of which contain zero or more key/value pairs. When selecting a server for a
                        read operation, the driver attempt to select a node having all tags in a set
                        (i.e. the associative array of key/value pairs). If selection fails, the
                        driver will attempt subsequent sets. An empty tag set (<return>array()</return>) will match
                        any node and may be used as a fallback.
                        
                        Tags are not compatible with the <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info>
                        mode and, in general, only apply when selecting a secondary member of a set
                        for a read operation. However, the <info>MongoDB\Driver\ReadPreference::RP_NEAREST</info>
                        mode, when combined with a tag set, selects the matching member with the
                        lowest network latency. This member may be a primary or secondary.
  <info>array|null</info>  <strong>$options</strong>  optionsOptionTypeDescriptionhedge<info>object</info><info>array</info></info>Specifies whether to use hedged
                        reads, which are supported by MongoDB 4.4+ for sharded queries. Server
                        hedged reads are available for all non-primary read preferences and are
                        enabled by default when using the <return>"nearest"</return> mode. This option allows
                        explicitly enabling server hedged reads for non-primary read preferences by
                        specifying <return>['enabled' =&gt; true]</return>, or explicitly disabling server hedged
                        reads for the <return>"nearest"</return> read preference by specifying <return>['enabled' =&gt;
                        false]</return>. maxStalenessSeconds<info>int</info> Specifies a maximum replication lag, or
                        "staleness", for reads from secondaries. When a secondary's estimated
                        staleness exceeds this value, the driver stops using it for read operations.
                        If specified, the max staleness must be a signed 32-bit integer greater than
                        or equal to <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info>.
                        Defaults to <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info>, which means
                        that the driver will not consider a secondary's lag when choosing where to
                        direct a read operation.  This option is not compatible with the
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info> mode. Specifying a max staleness
                        also requires all MongoDB instances in the deployment to be using MongoDB
                        3.4+. An exception will be thrown at execution time if any MongoDB instances
                        in the deployment are of an older server version.
                        
                        Specifies whether to use hedged reads, which are supported by MongoDB 4.4+
                        for sharded queries.
                        
                        Server hedged reads are available for all non-primary read preferences and
                        are enabled by default when using the <return>"nearest"</return> mode. This option allows
                        explicitly enabling server hedged reads for non-primary read preferences by
                        specifying <return>['enabled' =&gt; true]</return>, or explicitly disabling server hedged
                        reads for the <return>"nearest"</return> read preference by specifying <return>['enabled' =&gt;
                        false]</return>.
                        
                        Specifies a maximum replication lag, or "staleness", for reads from
                        secondaries. When a secondary's estimated staleness exceeds this value, the
                        driver stops using it for read operations.
                        
                        If specified, the max staleness must be a signed 32-bit integer greater than
                        or equal to <info>MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS</info>.
                        
                        Defaults to <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info>, which means
                        that the driver will not consider a secondary's lag when choosing where to
                        direct a read operation.
                        
                        This option is not compatible with the
                        <info>MongoDB\Driver\ReadPreference::RP_PRIMARY</info> mode. Specifying a max staleness
                        also requires all MongoDB instances in the deployment to be using MongoDB
                        3.4+. An exception will be thrown at execution time if any MongoDB instances
                        in the deployment are of an older server version.

<comment>See Also:</comment>
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns an object for BSON serialization

<comment>Return:</comment>
  <info>stdClass</info>  Returns an object for serializing the ReadPreference as BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::getHedge
type: function
doc:
<comment>Description:</comment>
  Returns the ReadPreference's "hedge" option

<comment>Return:</comment>
  <info>object|null</info>  Returns the ReadPreference's "hedge" option.

<comment>See Also:</comment>
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::getMaxStalenessSeconds
type: function
doc:
<comment>Description:</comment>
  Returns the ReadPreference's "maxStalenessSeconds" option

<comment>Return:</comment>
  <info>int</info>  Returns the ReadPreference's "maxStalenessSeconds" option. If no max staleness has been
       specified, <info>MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</info> will be returned.

<comment>See Also:</comment>
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::getMode
type: function
doc:
<comment>Description:</comment>
  Returns the ReadPreference's "mode" option

<comment>Return:</comment>
  <info>int</info>  Returns the ReadPreference's "mode" option.

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::getModeString
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::getModeString
type: function
doc:
<comment>Description:</comment>
  Returns the ReadPreference's "mode" option as a string

<comment>Return:</comment>
  <info>string</info>  Returns the ReadPreference's "mode" option as a string.

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::getMode
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::getTagSets
type: function
doc:
<comment>Description:</comment>
  Returns the ReadPreference's "tagSets" option

<comment>Return:</comment>
  <info>array</info>  Returns the ReadPreference's "tagSets" option.

<comment>See Also:</comment>
   * Read Preference reference


id: MongoDB\Driver\ReadPreference::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a ReadPreference

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\Driver\ReadPreference</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\ReadPreference::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a ReadPreference

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\Driver\ReadPreference</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\ReadPreference::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\Server::TYPE_LOAD_BALANCER
type: constant
doc:
<comment>Description:</comment>
  Load balancer server type, returned by MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set possible primary server type, returned by MongoDB\Driver\Server::getType.
  
  A server may be identified as a possible primary if it has not yet been checked but another memory
  of the replica set thinks it is the primary.


id: MongoDB\Driver\Server::TYPE_RS_ARBITER
type: constant
doc:
<comment>Description:</comment>
  Replica set arbiter server type, returned by MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_RS_GHOST
type: constant
doc:
<comment>Description:</comment>
  Replica set ghost server type, returned by MongoDB\Driver\Server::getType.
  
  Servers may be identified as such in at least three situations: briefly during server startup; in
  an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set
  config). They cannot be queried, nor can their host list be used to discover the current replica
  set configuration; however, the client may monitor this server in hope that it transitions to a
  more useful state.


id: MongoDB\Driver\Server::TYPE_RS_OTHER
type: constant
doc:
<comment>Description:</comment>
  Replica set other server type, returned by MongoDB\Driver\Server::getType.
  
  Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts
  lists are useful for discovering the current replica set configuration.


id: MongoDB\Driver\Server::TYPE_RS_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set primary server type, returned by MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_RS_SECONDARY
type: constant
doc:
<comment>Description:</comment>
  Replica set secondary server type, returned by MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::TYPE_STANDALONE
type: constant
doc:
<comment>Description:</comment>
  Standalone server type, returned by MongoDB\Driver\Server::getType.


id: MongoDB\Driver\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Server (not used)
  
  <class>MongoDB\Driver\Server</class> objects are created internally by <class>MongoDB\Driver\Manager</class> when a database
  connection is established and may be returned by <strong>MongoDB\Driver\Manager::getServers()</strong> and
  <strong>MongoDB\Driver\Manager::selectServer()</strong>.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::getServers()</strong>
   * <strong>MongoDB\Driver\Manager::selectServer()</strong>


id: MongoDB\Driver\Server::executeBulkWrite
type: function
doc:
<comment>Description:</comment>
  Execute one or more write operations on this server
  
  Executes one or more write operations on this server.
  
  A <class>MongoDB\Driver\BulkWrite</class> can be constructed with one or more write operations of varying types
  (e.g. updates, deletes, and inserts). The driver will attempt to send operations of the same type
  to the server in as few requests as possible to optimize round trips.

<comment>Param:</comment>
  <info>string</info>                                  <strong>$namespace</strong>  Un espacio de nombres completamente
                                                      cualificado (p. ej.
                                                      <return>"nombreBaseDatos.nombreColección"</return>).
  <info>MongoDB\Driver\BulkWrite</info>                <strong>$bulk</strong>       La/s escritura/s a ejecutar.
  <info>array|MongoDB\Driver\WriteConcern|null</info>  <strong>$options</strong>    
                                                      optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class>
                                                      Una sesión a asociar con la operación.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Un
                                                      asunto de escritura a aplicar a la operación.
                                                      
                                                      Una sesión a asociar con la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  Devuelve un <class>MongoDB\Driver\WriteResult</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\Driver\WriteConcern</class>
   * <strong>MongoDB\Driver\Manager::executeBulkWrite()</strong>


id: MongoDB\Driver\Server::executeCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command on this server
  
  Executes the command on this server.
  
  This method applies no special logic to the command. Although this method accepts <return>"readConcern"</return>
  and <return>"writeConcern"</return> options, which will be incorporated into the command document, those options
  will not default to corresponding values from the MongoDB Connection URI nor will the MongoDB
  server version be taken into account. Users are therefore encouraged to use specific read and/or
  write command methods if possible.
  
  La opción <return>"readPreference"</return> no controla el servidor al cual el controlador emite la opración;
  siempre se ejecutará en este objeto de servidor. En su lugar, podría usarse al emitir una
  operación a un secundario (desde una conexión de cojunto réplica, no solo) o a un nodo de mongo
  para asegurarse de que el controlador establece el protocolo de escritura en consecuencia, o añade
  la preferencia de lectura a la operación, respectivamente.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$db</strong>       El nombre de la base de datos en la que
                                                      ejecutar el comando.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  El comando a ejecutar.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Un asunto de escritura a aplicar a la
                                                      operación.  Esta opción está disponible en
                                                      MongoDB 3.2+ y resultará en una excepción en
                                                      tiempo de ejecución si es especificada para
                                                      una versión de servidor más antigua.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Una preferencia de lectura a usar para
                                                      seleccionar un servidor para la operación.
                                                      session<class>MongoDB\Driver\Session</class> Una sesión a
                                                      asociar con la operación.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Un
                                                      asunto de escritura a aplicar a la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.
                                                      
                                                      Esta opción está disponible en MongoDB 3.2+ y
                                                      resultará en una excepción en tiempo de
                                                      ejecución si es especificada para una versión
                                                      de servidor más antigua.
                                                      
                                                      Una preferencia de lectura a usar para
                                                      seleccionar un servidor para la operación.
                                                      
                                                      Una sesión a asociar con la operación.
                                                      
                                                      Un asunto de escritura a aplicar a la
                                                      operación.
                                                      
                                                      Si se usa la opción <return>"session"</return> con sesión que
                                                      tenga una transacción en progreso, no se puede
                                                      especificar una opción <return>"readConcern"</return> o
                                                      <return>"writeConcern"</return>. Esto resultarña en una
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>.
                                                      En su lugar se debería establecer estas dos
                                                      opciones al crear la transacción con
                                                      MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeCommand()</strong>


id: MongoDB\Driver\Server::executeQuery
type: function
doc:
<comment>Description:</comment>
  Execute a database query on this server
  
  Executes the query on this server.
  
  The <return>"readPreference"</return> option does not control the server to which the driver issues the operation;
  it will always be executed on this server object. Instead, it may be used when issuing the
  operation to a secondary (from a replica set connection, not standalone) or mongos node to ensure
  that the driver sets the wire protocol accordingly or adds the read preference to the operation,
  respectively.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$namespace</strong>  Un espacio de nombres completamente
                                                        cualificado (p. ej.
                                                        <return>"nombreBaseDatos.nombreColección"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      La consulta a ejecutar.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsOptionTypeDescriptionreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Una preferencia de lectura a usar para
                                                        seleccionar un servidor para la operación.
                                                        session<class>MongoDB\Driver\Session</class> Una sesión a
                                                        asociar con la operación.
                                                        
                                                        Una preferencia de lectura a usar para
                                                        seleccionar un servidor para la operación.
                                                        
                                                        Una sesión a asociar con la operación.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Cursor</class>
   * <class>MongoDB\Driver\Query</class>
   * <class>MongoDB\Driver\ReadPreference</class>
   * <strong>MongoDB\Driver\Manager::executeQuery()</strong>


id: MongoDB\Driver\Server::executeReadCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that reads on this server
  
  Executes the command on this server.
  
  This method will apply logic that is specific to commands that read (e.g. count) and take the
  MongoDB server version into account. The <return>"readConcern"</return> option will default to the corresponding
  value from the MongoDB Connection URI.
  
  La opción <return>"readPreference"</return> no controla el servidor al cual el controlador emite la opración;
  siempre se ejecutará en este objeto de servidor. En su lugar, podría usarse al emitir una
  operación a un secundario (desde una conexión de cojunto réplica, no solo) o a un nodo de mongo
  para asegurarse de que el controlador establece el protocolo de escritura en consecuencia, o añade
  la preferencia de lectura a la operación, respectivamente.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Un asunto de escritura a aplicar a la operación.  Esta opción
                                    está disponible en MongoDB 3.2+ y resultará en una excepción en
                                    tiempo de ejecución si es especificada para una versión de
                                    servidor más antigua.
                                    readPreference<class>MongoDB\Driver\ReadPreference</class> Una preferencia de
                                    lectura a usar para seleccionar un servidor para la operación.
                                    session<class>MongoDB\Driver\Session</class> Una sesión a asociar con la
                                    operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Esta opción está disponible en MongoDB 3.2+ y resultará en una
                                    excepción en tiempo de ejecución si es especificada para una
                                    versión de servidor más antigua.
                                    
                                    Una preferencia de lectura a usar para seleccionar un servidor
                                    para la operación.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadCommand()</strong>


id: MongoDB\Driver\Server::executeReadWriteCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that reads and writes on this server
  
  Executes the command on this server.
  
  This method will apply logic that is specific to commands that read and write (e.g. aggregate) and
  take the MongoDB server version into account. The <return>"readConcern"</return> and <return>"writeConcern"</return> options will
  default to the corresponding values from the MongoDB Connection URI.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Un asunto de escritura a aplicar a la operación.  Esta opción
                                    está disponible en MongoDB 3.2+ y resultará en una excepción en
                                    tiempo de ejecución si es especificada para una versión de
                                    servidor más antigua. session<class>MongoDB\Driver\Session</class> Una sesión a
                                    asociar con la operación.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a
                                    aplicar a la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Esta opción está disponible en MongoDB 3.2+ y resultará en una
                                    excepción en tiempo de ejecución si es especificada para una
                                    versión de servidor más antigua.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeReadWriteCommand()</strong>


id: MongoDB\Driver\Server::executeWriteCommand
type: function
doc:
<comment>Description:</comment>
  Execute a database command that writes on this server
  
  Executes the command on this server.
  
  This method will apply logic that is specific to commands that write (e.g. drop) and take the
  MongoDB server version into account. The <return>"writeConcern"</return> option will default to the corresponding
  value from the MongoDB Connection URI.
  
  This method is not intended to be used to execute insert, update, or delete commands. Users are
  encouraged to use <strong>MongoDB\Driver\Server::executeBulkWrite()</strong> for those commands.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       El nombre de la base de datos en la que ejecutar el comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  El comando a ejecutar.
  <info>array|null</info>              <strong>$options</strong>  optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class> Una
                                    sesión a asociar con la operación.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a
                                    aplicar a la operación.
                                    
                                    Una sesión a asociar con la operación.
                                    
                                    Un asunto de escritura a aplicar a la operación.
                                    
                                    Si se usa la opción <return>"session"</return> con sesión que tenga una
                                    transacción en progreso, no se puede especificar una opción
                                    <return>"readConcern"</return> o <return>"writeConcern"</return>. Esto resultarña en una
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class>. En su lugar
                                    se debería establecer estas dos opciones al crear la transacción
                                    con MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Devuelve un <class>MongoDB\Driver\Cursor</class> en caso de éxito.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Command</class>
   * <class>MongoDB\Driver\Cursor</class>
   * <strong>MongoDB\Driver\Server::executeCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadCommand()</strong>
   * <strong>MongoDB\Driver\Server::executeReadWriteCommand()</strong>
   * <strong>MongoDB\Driver\Manager::executeWriteCommand()</strong>


id: MongoDB\Driver\Server::getHost
type: function
doc:
<comment>Description:</comment>
  Returns the hostname of this server
  
  Returns the hostname of this server.

<comment>Return:</comment>
  <info>string</info>  Returns the hostname of this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getHost()</strong>


id: MongoDB\Driver\Server::getInfo
type: function
doc:
<comment>Description:</comment>
  Returns an array of information describing this server
  
  Returns an array of information describing the server. This array is derived from the most recent
  hello command response obtained through server monitoring.
  
  When the driver is connected to a load balancer, this method will return the backing server's
  hello command response from the initial connection handshake. This is in contrast to other methods
  (e.g. <strong>MongoDB\Driver\Server::getType()</strong>), which will return information about the load balancer
  itself.

<comment>Return:</comment>
  <info>array</info>  Returns an array of information describing this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\ServerDescription::getHelloResponse()</strong>
   * hello command in the MongoDB manual
   * Server Discovery and Monitoring Specification


id: MongoDB\Driver\Server::getLatency
type: function
doc:
<comment>Description:</comment>
  Returns the latency of this server in milliseconds
  
  Returns the latency of this server in milliseconds. This is the client's measured round trip time
  of a <return>hello</return> command.

<comment>Return:</comment>
  <info>integer|null</info>  Returns the latency of this server in milliseconds, or <info>null</info> if no latency has been
                measured (e.g. client is connected to a load balancer).

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getRoundTripTime()</strong>
   * Server Discovery and Monitoring Specification


id: MongoDB\Driver\Server::getPort
type: function
doc:
<comment>Description:</comment>
  Returns the port on which this server is listening
  
  Returns the port on which this server is listening.

<comment>Return:</comment>
  <info>int</info>  Returns the port on which this server is listening.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getPort()</strong>


id: MongoDB\Driver\Server::getServerDescription
type: function
doc:
<comment>Description:</comment>
  Returns a ServerDescription for this server
  
  Returns a <class>MongoDB\Driver\ServerDescription</class> for this server. This is an immutable value object that
  will describe the server at the time this method is called.

<comment>Return:</comment>
  <info>MongoDB\Driver\ServerDescription</info>  Returns a <class>MongoDB\Driver\ServerDescription</class> for this server.


id: MongoDB\Driver\Server::getTags
type: function
doc:
<comment>Description:</comment>
  Returns an array of tags describing this server in a replica set
  
  Returns an <info>array</info> of tags used to describe this server in a replica set. The array will contain
  zero or more <info>string</info> key and value pairs.

<comment>Return:</comment>
  <info>array</info>  Returns an <info>array</info> of tags used to describe this server in a replica set.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::getType
type: function
doc:
<comment>Description:</comment>
  Returns an integer denoting the type of this server
  
  Returns an <info>int</info> denoting the type of this server. The value will correlate with a
  <class>MongoDB\Driver\Server</class> constant.

<comment>Return:</comment>
  <info>int</info>  Returns an <info>int</info> denoting the type of this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * <strong>MongoDB\Driver\ServerDescription::getType()</strong>


id: MongoDB\Driver\Server::isArbiter
type: function
doc:
<comment>Description:</comment>
  Checks if this server is an arbiter member of a replica set
  
  Returns whether this server is an arbiter member of a replica set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this server is an arbiter member of a replica set, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isHidden
type: function
doc:
<comment>Description:</comment>
  Checks if this server is a hidden member of a replica set
  
  Returns whether this server is a hidden member of a replica set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this server is a hidden member of a replica set, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isPassive
type: function
doc:
<comment>Description:</comment>
  Checks if this server is a passive member of a replica set
  
  Returns whether this server is a passive member of a replica set (i.e. its priority is <return>0</return>).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this server is a passive member of a replica set, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isPrimary
type: function
doc:
<comment>Description:</comment>
  Checks if this server is a primary member of a replica set
  
  Returns whether this server is a primary member of a replica set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this server is a primary member of a replica set, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\Server::isSecondary
type: function
doc:
<comment>Description:</comment>
  Checks if this server is a secondary member of a replica set
  
  Returns whether this server is a secondary member of a replica set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this server is a secondary member of a replica set, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>


id: MongoDB\Driver\ServerApi::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new ServerApi instance
  
  Creates a new <class>MongoDB\Driver\ServerApi</class> instance used to declare an API version when creating a
  <class>MongoDB\Driver\Manager</class>.

<comment>Param:</comment>
  <info>string</info>     <strong>$version</strong>            A server API version.
                                 
                                 Supported API versions are provided as constants in
                                 <class>MongoDB\Driver\ServerApi</class>. The only supported API version is
                                 <info>MongoDB\Driver\ServerApi::V1</info>.
  <info>bool|null</info>  <strong>$strict</strong>             If the <strong>$strict</strong> parameter is set to <info>true</info>, the server will yield an
                                 error for any command that is not part of the specified API
                                 version. If no value is provided, the server default value (<info>false</info>)
                                 is used.
  <info>bool|null</info>  <strong>$deprecationErrors</strong>  If the <strong>$deprecationErrors</strong> parameter is set to <info>true</info>, the server will
                                 yield an error when using a command that is deprecated in the
                                 specified API version. If no value is provided, the server default
                                 value (<info>false</info>) is used.


id: MongoDB\Driver\ServerApi::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns an object for BSON serialization

<comment>Return:</comment>
  <info>stdClass</info>  Returns an object for serializing the ServerApi as BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize


id: MongoDB\Driver\ServerApi::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a ServerApi

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\Driver\ServerApi</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\ServerApi::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\ServerApi::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a ServerApi

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\Driver\ServerApi</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\ServerApi::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\ServerDescription
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\ServerDescription</class> class is a value object that represents a server to which the
  driver is connected. Instances of this class are returned by
  <strong>MongoDB\Driver\Server::getServerDescription()</strong> and <class>MongoDB\Driver\Monitoring\ServerChangedEvent</class>
  methods.


id: MongoDB\Driver\ServerDescription::TYPE_LOAD_BALANCER
type: constant
doc:
<comment>Description:</comment>
  Load balancer server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_MONGOS
type: constant
doc:
<comment>Description:</comment>
  Mongos server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_POSSIBLE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set possible primary server type, returned by MongoDB\Driver\ServerDescription::getType.
  
  A server may be identified as a possible primary if it has not yet been checked but another memory
  of the replica set thinks it is the primary.


id: MongoDB\Driver\ServerDescription::TYPE_RS_ARBITER
type: constant
doc:
<comment>Description:</comment>
  Replica set arbiter server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_RS_GHOST
type: constant
doc:
<comment>Description:</comment>
  Replica set ghost server type, returned by MongoDB\Driver\ServerDescription::getType.
  
  Servers may be identified as such in at least three situations: briefly during server startup; in
  an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set
  config). They cannot be queried, nor can their host list be used to discover the current replica
  set configuration; however, the client may monitor this server in hope that it transitions to a
  more useful state.


id: MongoDB\Driver\ServerDescription::TYPE_RS_OTHER
type: constant
doc:
<comment>Description:</comment>
  Replica set other server type, returned by MongoDB\Driver\ServerDescription::getType.
  
  Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts
  lists are useful for discovering the current replica set configuration.


id: MongoDB\Driver\ServerDescription::TYPE_RS_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set primary server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_RS_SECONDARY
type: constant
doc:
<comment>Description:</comment>
  Replica set secondary server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_STANDALONE
type: constant
doc:
<comment>Description:</comment>
  Standalone server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::TYPE_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Unknown server type, returned by MongoDB\Driver\ServerDescription::getType.


id: MongoDB\Driver\ServerDescription::getHelloResponse
type: function
doc:
<comment>Description:</comment>
  Returns the server's most recent "hello" response
  
  Returns an array of information describing the server. This array is derived from the most recent
  (at the time the <class>MongoDB\Driver\ServerDescription</class> was constructed) hello command response obtained
  through server monitoring.
  
  When the driver is connected to a load balancer, this method will return an empty array since load
  balancers are not monitored. This is in contrast to <strong>MongoDB\Driver\Server::getInfo()</strong>, which would
  return the backing server's hello command response from the initial connection handshake.

<comment>Return:</comment>
  <info>array</info>  Returns an array of information describing this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getInfo()</strong>
   * hello command in the MongoDB manual
   * Server Discovery and Monitoring Specification


id: MongoDB\Driver\ServerDescription::getHost
type: function
doc:
<comment>Description:</comment>
  Returns the hostname of this server
  
  Returns the hostname of this server.

<comment>Return:</comment>
  <info>string</info>  Returns the hostname of this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getHost()</strong>


id: MongoDB\Driver\ServerDescription::getLastUpdateTime
type: function
doc:
<comment>Description:</comment>
  Returns the server's last update time in microseconds
  
  Returns the server's last update time in microseconds.
  
  The returned value is a monotonic timestamp, which starts at an arbitrary point. As such, it is
  only suitable to compare with other return values from
  <strong>MongoDB\Driver\ServerDescription::getLastUpdateTime()</strong>.

<comment>Return:</comment>
  <info>int</info>  Returns the server's last update time in microseconds.


id: MongoDB\Driver\ServerDescription::getPort
type: function
doc:
<comment>Description:</comment>
  Returns the port on which this server is listening
  
  Returns the port on which this server is listening.

<comment>Return:</comment>
  <info>int</info>  Returns the port on which this server is listening.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getPort()</strong>


id: MongoDB\Driver\ServerDescription::getRoundTripTime
type: function
doc:
<comment>Description:</comment>
  Returns the server's round trip time in milliseconds
  
  Returns the server's round trip time in milliseconds. This is the client's measurement of the
  duration of a hello command.

<comment>Return:</comment>
  <info>int|null</info>  Returns the server's round trip time in milliseconds.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getLatency()</strong>


id: MongoDB\Driver\ServerDescription::getType
type: function
doc:
<comment>Description:</comment>
  Returns a string denoting the type of this server
  
  Returns a <info>string</info> denoting the type of this server. The value will correlate with a
  <class>MongoDB\Driver\ServerDescription</class> constant.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> denoting the type of this server.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Server::getType()</strong>


id: MongoDB\Driver\Session
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\Session</class> class represents a client session and is returned by
  MongoDB\Driver\Manager::startSession. Commands, queries, and write operations may then be
  associated the session.


id: MongoDB\Driver\Session::TRANSACTION_STARTING
type: constant
doc:
<comment>Description:</comment>
  A transaction has been started, but no operation has been sent to the server.


id: MongoDB\Driver\Session::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new Session (not used)
  
  <class>MongoDB\Driver\Session</class> objects are returned by MongoDB\Driver\Manager::startSession and cannot be
  constructed directly.

<comment>See Also:</comment>
   * <strong>MongoDB\Driver\Manager::startSession()</strong>


id: MongoDB\Driver\Session::abortTransaction
type: function
doc:
<comment>Description:</comment>
  Aborts a transaction
  
  Terminates the multi-document transaction and rolls back any data changes made by the operations
  within the transaction. That is, the transaction ends without saving any of the changes made by
  the operations in the transaction.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::startTransaction


id: MongoDB\Driver\Session::advanceClusterTime
type: function
doc:
<comment>Description:</comment>
  Advances the cluster time for this session
  
  Advances the cluster time for this session. If the cluster time is less than or equal to the
  session's current cluster time, this function is a no-op.
  
  By using this method in conjunction with MongoDB\Driver\Session::advanceOperationTime to copy the
  cluster and operation times from another session, you can ensure that operations in this session
  are causally consistent with the last operation in the other session.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$clusterTime</strong>  The cluster time is a document containing a logical timestamp and
                              server signature. Typically, this value will be obtained by calling
                              MongoDB\Driver\Session::getClusterTime on another session object.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceOperationTime
   * MongoDB\Driver\Session::getClusterTime


id: MongoDB\Driver\Session::advanceOperationTime
type: function
doc:
<comment>Description:</comment>
  Advances the operation time for this session
  
  Advances the operation time for this session. If the operation time is less than or equal to the
  session's current operation time, this function is a no-op.
  
  By using this method in conjunction with MongoDB\Driver\Session::advanceClusterTime to copy the
  operation and cluster times from another session, you can ensure that operations in this session
  are causally consistent with the last operation in the other session.

<comment>Param:</comment>
  <info>MongoDB\BSON\TimestampInterface</info>  <strong>$operationTime</strong>  The operation time is a logical timestamp.
                                                   Typically, this value will be obtained by calling
                                                   MongoDB\Driver\Session::getOperationTime on
                                                   another session object.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceClusterTime
   * MongoDB\Driver\Session::getClusterTime


id: MongoDB\Driver\Session::commitTransaction
type: function
doc:
<comment>Description:</comment>
  Commits a transaction
  
  Saves the changes made by the operations in the multi-document transaction and ends the
  transaction. Until the commit, none of the data changes made from within the transaction are
  visible outside the transaction.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::abortTransaction
   * MongoDB\Driver\Session::startTransaction
   * MongoDB\Driver\Exception\RuntimeException::hasErrorLabel


id: MongoDB\Driver\Session::endSession
type: function
doc:
<comment>Description:</comment>
  Terminates a session
  
  This method closes an existing session. If a transaction was associated with this session, the
  transaction will be aborted. After calling this method, applications should not invoke other
  methods on the session.
  
  Sessions are also closed during garbage collection. It should not be necessary to call this method
  under normal circumstances.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::abortTransaction
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::startTransaction


id: MongoDB\Driver\Session::getClusterTime
type: function
doc:
<comment>Description:</comment>
  Returns the cluster time for this session
  
  Returns the cluster time for this session. If the session has not been used for any operation and
  MongoDB\Driver\Session::advanceClusterTime has not been called, the cluster time will be <info>null</info>.

<comment>Return:</comment>
  <info>object|null</info>  Returns the cluster time for this session, or <info>null</info> if the session has no cluster
               time.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceClusterTime


id: MongoDB\Driver\Session::getLogicalSessionId
type: function
doc:
<comment>Description:</comment>
  Returns the logical session ID for this session
  
  Returns the logical session ID for this session, which may be used to identify this session's
  operations on the server.

<comment>Return:</comment>
  <info>object</info>  Returns the logical session ID for this session.


id: MongoDB\Driver\Session::getOperationTime
type: function
doc:
<comment>Description:</comment>
  Returns the operation time for this session
  
  Returns the operation time for this session. If the session has not been used for any operation
  and MongoDB\Driver\Session::advanceOperationTime has not been called, the operation time will be
  <info>null</info>

<comment>Return:</comment>
  <info>MongoDB\BSON\Timestamp|null</info>  Returns the operation time for this session, or <info>null</info> if the session
                               has no operation time.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::advanceOperationTime


id: MongoDB\Driver\Session::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the server to which this session is pinned
  
  Returns the <class>MongoDB\Driver\Server</class> to which this session is pinned. If the session is not pinned to
  a server, <info>null</info> will be returned.
  
  Session pinning is primarily used for sharded transactions, as all commands within a sharded
  transaction must be sent to the same mongos instance. This method is intended to be used by
  libraries built atop the extension to allow use of a pinned server instead of invoking server
  selection.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server|null</info>  Returns the <class>MongoDB\Driver\Server</class> to which this session is pinned, or
                              <info>null</info> if the session is not pinned to any server.


id: MongoDB\Driver\Session::getTransactionOptions
type: function
doc:
<comment>Description:</comment>
  Returns options for the currently running transaction
  
  Returns options for the currently running transaction.

<comment>Return:</comment>
  <info>array|null</info>  Returns a <info>array</info> containing current transaction options, or <info>null</info> if no transaction is
              running.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::getTransactionState


id: MongoDB\Driver\Session::getTransactionState
type: function
doc:
<comment>Description:</comment>
  Returns the current transaction state for this session
  
  Returns the transaction state for this session.

<comment>Return:</comment>
  <info>string</info>  Returns the current transaction state for this session.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::isInTransaction
   * MongoDB\Driver\Session::getTransactionOptions


id: MongoDB\Driver\Session::isDirty
type: function
doc:
<comment>Description:</comment>
  Returns whether the session has been marked as dirty
  
  Returns whether the session has been marked as dirty (i.e. it has been used with a command that
  encountered a network error).

<comment>Return:</comment>
  <info>bool</info>  Returns whether the session has been marked as dirty.


id: MongoDB\Driver\Session::isInTransaction
type: function
doc:
<comment>Description:</comment>
  Returns whether a multi-document transaction is in progress
  
  Returns whether a multi-document transaction is currently in progress for this session. A
  transaction is considered "in progress" if it has been started but has not been committed or
  aborted.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a transaction is currently in progress for this session, and <info>false</info>
        otherwise.

<comment>See Also:</comment>
   * MongoDB\Driver\Session::getTransactionState


id: MongoDB\Driver\Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Starts a transaction
  
  Starts a multi-document transaction associated with the session. At any given time, you can have
  at most one open transaction for a session. After starting a transaction, the session object must
  be passed to each operation via the <return>"session"</return> option (e.g.
  MongoDB\Driver\Manager::executeBulkWrite) in order to associate that operation with the
  transaction.
  
  Transactions can be committed through MongoDB\Driver\Session::commitTransaction, and aborted with
  MongoDB\Driver\Session::abortTransaction. Transactions are also automatically aborted when the
  session is closed from garbage collection or by explicitly calling
  MongoDB\Driver\Session::endSession.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  Options can be passed as argument to this method. Each element in this
                        options array overrides the corresponding option from the
                        <return>"defaultTransactionOptions"</return> option, if set when starting the session with
                        MongoDB\Driver\Manager::startSession.
                        
                        optionsOptionTypeDescriptionmaxCommitTimeMSinteger The maximum amount of
                        time in milliseconds to allow a single <return>commitTransaction</return> command to run.  If
                        specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than or
                        equal to zero. readConcern<class>MongoDB\Driver\ReadConcern</class> Un asunto de escritura
                        a aplicar a la operación.  Esta opción está disponible en MongoDB 3.2+ y
                        resultará en una excepción en tiempo de ejecución si es especificada para
                        una versión de servidor más antigua.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> Una preferencia de lectura a
                        usar para seleccionar un servidor para la operación.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Un asunto de escritura a aplicar a
                        la operación.
                        
                        The maximum amount of time in milliseconds to allow a single
                        <return>commitTransaction</return> command to run.
                        
                        If specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than
                        or equal to zero.
                        
                        Un asunto de escritura a aplicar a la operación.
                        
                        Esta opción está disponible en MongoDB 3.2+ y resultará en una excepción en
                        tiempo de ejecución si es especificada para una versión de servidor más
                        antigua.
                        
                        Una preferencia de lectura a usar para seleccionar un servidor para la
                        operación.
                        
                        Un asunto de escritura a aplicar a la operación.

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

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::startSession
   * MongoDB\Driver\Session::commitTransaction
   * MongoDB\Driver\Session::abortTransaction


id: MongoDB\Driver\TopologyDescription
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\TopologyDescription</class> class is a value object that represents a topology to which
  the driver is connected. Instances of this class are returned by
  <class>MongoDB\Driver\Monitoring\TopologyChangedEvent</class> methods.


id: MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED
type: constant
doc:
<comment>Description:</comment>
  Load balanced topology, returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set with no primary server, returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  Replica set with a primary server, returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_SHARDED
type: constant
doc:
<comment>Description:</comment>
  Sharded cluster, returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_SINGLE
type: constant
doc:
<comment>Description:</comment>
  Single server (i.e. direct connection), returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  Unknown topology type, returned by MongoDB\Driver\TopologyDescription::getType.


id: MongoDB\Driver\TopologyDescription::getServers
type: function
doc:
<comment>Description:</comment>
  Returns the servers in the topology
  
  Returns an array of <class>MongoDB\Driver\ServerDescription</class> objects corresponding to the known servers in
  the topology.

<comment>Return:</comment>
  <info>array</info>  Returns an array of <class>MongoDB\Driver\ServerDescription</class> objects corresponding to the known
         servers in the topology.


id: MongoDB\Driver\TopologyDescription::getType
type: function
doc:
<comment>Description:</comment>
  Returns a string denoting the type of this topology
  
  Returns a <info>string</info> denoting the type of this topology. The value will correlate with a
  <class>MongoDB\Driver\TopologyDescription</class> constant.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> denoting the type of this topology.


id: MongoDB\Driver\TopologyDescription::hasReadableServer
type: function
doc:
<comment>Description:</comment>
  Returns whether the topology has a readable server
  
  Returns whether the topology has a readable server or, if <strong>$readPreference</strong> is specified, a server
  matching the specified read preference.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the topology has a readable server or, if <strong>$readPreference</strong> is specified, a
        server matching the specified read preference.


id: MongoDB\Driver\TopologyDescription::hasWritableServer
type: function
doc:
<comment>Description:</comment>
  Returns whether the topology has a writable server
  
  Returns whether the topology has a writable server.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the topology has a writable server.


id: MongoDB\Driver\WriteConcern
type: class
doc:
<comment>Description:</comment>
  <class>MongoDB\Driver\WriteConcern</class> describes the level of acknowledgement requested from MongoDB for
  write operations to a standalone <return>mongod</return> or to replica sets or to sharded clusters. In sharded
  clusters, <return>mongos</return> instances will pass the write concern on to the shards.


id: MongoDB\Driver\WriteConcern::MAJORITY
type: constant
doc:
<comment>Description:</comment>
  Majority of all the members in the set; arbiters, non-voting members, passive members, hidden
  members and delayed members are all included in the definition of majority write concern.


id: MongoDB\Driver\WriteConcern::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new WriteConcern
  
  Constructs a new <class>MongoDB\Driver\WriteConcern</class>, which is an immutable value object.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$w</strong>         Write concernValueDescription1 Requests acknowledgement that the write
                         operation has propagated to the standalone <return>mongod</return> or the primary in a
                         replica set. This is the default write concern for MongoDB. 0 Requests no
                         acknowledgment of the write operation. However, this may return information
                         about socket exceptions and networking errors to the application. \<integer greater than 1&gt; Numbers greater than 1 are valid only for replica sets to request acknowledgement from specified number of members, including the primary. <info>MongoDB\Driver\WriteConcern::MAJORITY</info> Requests acknowledgment that write operations have propagated to the majority of voting nodes, including the primary, and have been written to the on-disk journal for these nodes.  Prior to MongoDB 3.0, this refers to the majority of replica set members (not just voting nodes). string A string value is interpereted as a tag set. Requests acknowledgement that the write operations have propagated to a replica set member with the specified tag.
                         
                         Requests acknowledgment that write operations have propagated to the
                         majority of voting nodes, including the primary, and have been written to
                         the on-disk journal for these nodes.
                         
                         Prior to MongoDB 3.0, this refers to the majority of replica set members
                         (not just voting nodes).
  <info>int|null</info>    <strong>$wtimeout</strong>  How long to wait (in milliseconds) for secondaries before failing.
                         
                         <return>wtimeout</return> causes write operations to return with an error
                         (<class>WriteConcernError</class>) after the specified limit, even if the required write
                         concern will eventually succeed. When these write operations return,
                         MongoDB does not undo successful data modifications performed before the
                         write concern exceeded the <return>wtimeout</return> time limit.
                         
                         If specified, <return>wtimeout</return> must be a signed 64-bit integer greater than or
                         equal to zero.
                         
                         Write concern timeoutValueDescription0Block indefinitely. This is the
                         default.\<integer greater than 0&gt; Milliseconds to wait until returning.
  <info>bool|null</info>   <strong>$journal</strong>   Wait until mongod has applied the write to the journal.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::bsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns an object for BSON serialization

<comment>Return:</comment>
  <info>stdClass</info>  Returns an object for serializing the WriteConcern as BSON.

<comment>See Also:</comment>
   * MongoDB\BSON\Serializable::bsonSerialize
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::getJournal
type: function
doc:
<comment>Description:</comment>
  Returns the WriteConcern's "journal" option

<comment>Return:</comment>
  <info>bool|null</info>  Returns the WriteConcern's "journal" option.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::getW
type: function
doc:
<comment>Description:</comment>
  Returns the WriteConcern's "w" option

<comment>Return:</comment>
  <info>string|int|null</info>  Returns the WriteConcern's "w" option.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::getWtimeout
type: function
doc:
<comment>Description:</comment>
  Returns the WriteConcern's "wtimeout" option

<comment>Return:</comment>
  <info>int</info>  Returns the WriteConcern's "wtimeout" option.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::isDefault
type: function
doc:
<comment>Description:</comment>
  Checks if this is the default write concern
  
  Returns whether this is the default write concern (i.e. no options are specified). This method is
  primarily intended to be used in conjunction with MongoDB\Driver\Manager::getWriteConcern to
  determine whether the Manager has been constructed without any write concern options.
  
  The driver will not include a default write concern in its write operations (e.g.
  MongoDB\Driver\Manager::executeBulkWrite) in order to allow the server to apply its own default,
  which may have been modified. Libraries that access the Manager's write concern to include it in
  their own write commands should use this method to ensure that default write concerns are left
  unset.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if this is the default write concern and <info>false</info> otherwise.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::getWriteConcern
   * Modify Default Write Concern in the MongoDB manual
   * Write Concern reference


id: MongoDB\Driver\WriteConcern::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a WriteConcern

<comment>Return:</comment>
  <info>string</info>  Returns the serialized representation of the <class>MongoDB\Driver\WriteConcern</class>.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteConcern::unserialize
   * <strong>serialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\WriteConcern::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a WriteConcern

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The serialized <class>MongoDB\Driver\WriteConcern</class>.

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

<comment>See Also:</comment>
   * MongoDB\Driver\WriteConcern::serialize
   * <strong>unserialize()</strong>
   * Serializing Objects


id: MongoDB\Driver\WriteConcernError
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\WriteConcernError</class> class encapsulates information about a write concern error
  and may be returned by MongoDB\Driver\WriteResult::getWriteConcernError.


id: MongoDB\Driver\WriteConcernError::getCode
type: function
doc:
<comment>Description:</comment>
  Returns the WriteConcernError's error code

<comment>Return:</comment>
  <info>int</info>  Returns the WriteConcernError's error code.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcernError::getInfo
type: function
doc:
<comment>Description:</comment>
  Returns metadata document for the WriteConcernError

<comment>Return:</comment>
  <info>object|null</info>  Returns the metadata document for the WriteConcernError, or <info>null</info> if no metadata is
               available.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteConcernError::getMessage
type: function
doc:
<comment>Description:</comment>
  Returns the WriteConcernError's error message

<comment>Return:</comment>
  <info>string</info>  Returns the WriteConcernError's error message.

<comment>See Also:</comment>
   * Write Concern reference


id: MongoDB\Driver\WriteError
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\WriteError</class> class encapsulates information about a write error and may be
  returned as an array element from MongoDB\Driver\WriteResult::getWriteErrors.


id: MongoDB\Driver\WriteError::getCode
type: function
doc:
<comment>Description:</comment>
  Returns the WriteError's error code

<comment>Return:</comment>
  <info>int</info>  Returns the WriteError's error code.


id: MongoDB\Driver\WriteError::getIndex
type: function
doc:
<comment>Description:</comment>
  Returns the index of the write operation corresponding to this WriteError

<comment>Return:</comment>
  <info>int</info>  Returns the index of the write operation (from <class>MongoDB\Driver\BulkWrite</class>) corresponding to
       this WriteError.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\BulkWrite</class>


id: MongoDB\Driver\WriteError::getInfo
type: function
doc:
<comment>Description:</comment>
  Returns metadata document for the WriteError

<comment>Return:</comment>
  <info>object|null</info>  Returns the metadata document for the WriteError, or <info>null</info> if no metadata is
               available.


id: MongoDB\Driver\WriteError::getMessage
type: function
doc:
<comment>Description:</comment>
  Returns the WriteError's error message

<comment>Return:</comment>
  <info>string</info>  Returns the WriteError's error message.


id: MongoDB\Driver\WriteResult
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\WriteResult</class> class encapsulates information about an executed
  <class>MongoDB\Driver\BulkWrite</class> and may be returned by MongoDB\Driver\Manager::executeBulkWrite.


id: MongoDB\Driver\WriteResult::getDeletedCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of documents deleted

<comment>Return:</comment>
  <info>int|null</info>  Returns the number of documents deleted, or <info>null</info> if the write was not acknowledged.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getInsertedCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of documents inserted (excluding upserts)

<comment>Return:</comment>
  <info>int|null</info>  Returns the number of documents inserted (excluding upserts), or <info>null</info> if the write was
            not acknowledged.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getMatchedCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of documents selected for update
  
  If the update operation results in no change to the document (e.g. setting the value of a field to
  its current value), the matched count may be greater than the value returned by
  MongoDB\Driver\WriteResult::getModifiedCount.

<comment>Return:</comment>
  <info>int|null</info>  Returns the number of documents selected for update, or <info>null</info> if the write was not
            acknowledged.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getModifiedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getModifiedCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of existing documents updated
  
  If the update operation results in no change to the document (e.g. setting the value of a field to
  its current value), the modified count may be less than the value returned by
  MongoDB\Driver\WriteResult::getMatchedCount.

<comment>Return:</comment>
  <info>int|null</info>  Returns the number of existing documents updated, or <info>null</info> if the write was not
            acknowledged.
            
            The modified count is not available on versions of MongoDB before 2.6, which used the
            legacy wire protocol version (i.e. OP_UPDATE). If this is the case, the modified count
            will also be <info>null</info>.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getMatchedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getServer
type: function
doc:
<comment>Description:</comment>
  Returns the server associated with this write result
  
  Returns the <class>MongoDB\Driver\Server</class> associated with this write result. This is the server that
  executed the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Return:</comment>
  <info>MongoDB\Driver\Server</info>  Returns the <class>MongoDB\Driver\Server</class> associated with this write result.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\Server</class>


id: MongoDB\Driver\WriteResult::getUpsertedCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of documents inserted by an upsert

<comment>Return:</comment>
  <info>int|null</info>  Returns the number of documents inserted by an upsert.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getUpsertedIds
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getUpsertedIds
type: function
doc:
<comment>Description:</comment>
  Returns an array of identifiers for upserted documents

<comment>Return:</comment>
  <info>array</info>  Returns an array of identifiers (i.e. <return>"_id"</return> field values) for upserted documents. The array
         keys will correspond to the index of the write operation (from <class>MongoDB\Driver\BulkWrite</class>)
         responsible for the upsert.

<comment>See Also:</comment>
   * MongoDB\Driver\WriteResult::getUpsertedCount
   * MongoDB\Driver\WriteResult::isAcknowledged


id: MongoDB\Driver\WriteResult::getWriteConcernError
type: function
doc:
<comment>Description:</comment>
  Returns any write concern error that occurred

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteConcernError|null</info>  Returns a <class>MongoDB\Driver\WriteConcernError</class> if a write
                                         concern error was encountered during the write operation,
                                         and <info>null</info> otherwise.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * Write Concern reference


id: MongoDB\Driver\WriteResult::getWriteErrors
type: function
doc:
<comment>Description:</comment>
  Returns any write errors that occurred

<comment>Return:</comment>
  <info>array</info>  Returns an array of <class>MongoDB\Driver\WriteError</class> objects for any write errors encountered
         during the write operation. The array will be empty if no write errors occurred.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteError</class>


id: MongoDB\Driver\WriteResult::isAcknowledged
type: function
doc:
<comment>Description:</comment>
  Returns whether the write was acknowledged
  
  If the write is acknowledged, other count fields will be available on the
  <class>MongoDB\Driver\WriteResult</class> object.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the write was acknowledged, and <info>false</info> otherwise.

<comment>See Also:</comment>
   * <class>MongoDB\Driver\WriteConcern</class>
   * Write Concern reference


id: MultipleIterator
type: class
doc:
<comment>Description:</comment>
  Un iterador que secuencialmente recorre todos los iteradores adjuntos.


id: MultipleIterator::MIT_KEYS_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Las claves se crean desde la información asociada de los subiteradores.


id: MultipleIterator::MIT_NEED_ALL
type: constant
doc:
<comment>Description:</comment>
  Requiere que todos los subiteradores sean válidos en la iteración.


id: MultipleIterator::MIT_NEED_ANY
type: constant
doc:
<comment>Description:</comment>
  No requiere que todos los subiteradores sean válidos en la iteración.


id: MultipleIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo MultipleIterator
  
  Construye un nuevo MultipleIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Las flags a ser establecidas, de acuerdo a las constantes Flag.
               <info>MultipleIterator::MIT_NEED_ALL</info> or <info>MultipleIterator::MIT_NEED_ANY</info>
               <info>MultipleIterator::MIT_KEYS_NUMERIC</info> or <info>MultipleIterator::MIT_KEYS_ASSOC</info>
               
               Por omisión <info>MultipleIterator::MIT_NEED_ALL</info>|<info>MultipleIterator::MIT_KEYS_NUMERIC</info>.

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

<comment>See Also:</comment>
   * Constantes Flag
   * MultipleIterator::valid


id: MultipleIterator::attachIterator
type: function
doc:
<comment>Description:</comment>
  Adjunta información al iterador
  
  Adjunta información al iterador.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El nuevo iterador para ser adjuntado.
  <info>string</info>    <strong>$infos</strong>     La información asociada al iterador, debe ser un <info>integer</info>,  un <info>string</info>, o <info>null</info>.

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

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


id: MultipleIterator::containsIterator
type: function
doc:
<comment>Description:</comment>
  Comprueba si un iterador está adjunto
  
  Comprueba si un iterador está adjunto o no.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El iterador a comprobar.

<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>
   * MultipleIterator::valid


id: MultipleIterator::countIterators
type: function
doc:
<comment>Description:</comment>
  Obtiene el número de instancias de iteradores adjuntos
  
  Obtiene el número de instancias de iteradores adjuntos.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  El número de instancias de iteradores adjuntos (como un <info>integer</info>).

<comment>See Also:</comment>
   * MultipleIterator::containsIterator


id: MultipleIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtiene las instancias registradas del iterador
  
  Obtiene las instancias registradas del iterador del resultado current().
  
  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> conteniendo los valores actuales de cada iterador adjuntado, o <info>false</info> si no hay
         ningún iterador adjuntado.

<comment>See Also:</comment>
   * MultipleIterator::valid


id: MultipleIterator::detachIterator
type: function
doc:
<comment>Description:</comment>
  Desasocia un iterador
  
  Desasocia un iterador.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El iterador a ser desasociado.

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

<comment>See Also:</comment>
   * MultipleIterator::attachIterator


id: MultipleIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Obtiene información de las flags
  
  Obtiene información acerca de las flags.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>int</info>  Información acerca de las flags, como un <info>integer</info>.

<comment>See Also:</comment>
   * Constantes Flag
   * MultipleIterator::__construct
   * MultipleIterator::setFlags


id: MultipleIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene las instancias registradas del iterador
  
  Obtiene las instancias registradas del iterador del resultado key().
  
  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 todas las instancias registradas del iterador, o <info>false</info> si ninguna instancia ha
         sido adjuntada.

<comment>See Also:</comment>
   * MultipleIterator::current


id: MultipleIterator::next
type: function
doc:
<comment>Description:</comment>
  Mueve todas las instancias de iterador adjuntadas hacía la siguiente
  
  Mueve todas las instancias de iterador adjuntadas hacía la siguiente.
  
  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.

<comment>See Also:</comment>
   * MultipleIterator::rewind


id: MultipleIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rebobina todas las instancias de iterador adjuntadas
  
  Rebobina todas las instancias de iterador adjuntadas.
  
  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.

<comment>See Also:</comment>
   * MultipleIterator::next


id: MultipleIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Establece las flags
  
  Establece las flags.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Las flags a ser establecidas, de acuerdo a las Constantes Flag

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

<comment>See Also:</comment>
   * Constantes Flag
   * MultipleIterator::__construct
   * MultipleIterator::getFlags


id: MultipleIterator::valid
type: function
doc:
<comment>Description:</comment>
  Comprueba la validez de los subiteradores
  
  Comprueba la validez de los subiteradores.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si uno o todos los subiteradores son válidos dependiendo de las flags, o <info>false</info>
        en caso contrario.

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


id: NORM_IGNOREKASHIDA
type: constant
doc:
<comment>Description:</comment>
  Ignorar caractares kashida árabes.
  
  La disponibilidad depende de la biblioteca subyacente.


id: NoRewindIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un NoRewindIterator
  
  Construye un NoRewindIterator.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  El iterador a ser usado.

<comment>Return:</comment>
  <info>unknown</info>  Un NoRewindIterator basado en el  <strong>$iterator</strong> pasado.

<comment>See Also:</comment>
   * NoRewindIterator::valid


id: NoRewindIterator::current
type: function
doc:
<comment>Description:</comment>
  Obtener el valor actual
  
  Obtiene el valor actual.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>See Also:</comment>
   * NoRewindIterator::key


id: NoRewindIterator::key
type: function
doc:
<comment>Description:</comment>
  Obtiene la clave actual
  
  Obtener la clave actual.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Return:</comment>
  <info>mixed</info>  La clave actual.

<comment>See Also:</comment>
   * NoRewindIterator::next


id: NoRewindIterator::next
type: function
doc:
<comment>Description:</comment>
  Avanza al siguiente elemento
  
  Avanzar al siguiente elemento.
  
  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.

<comment>See Also:</comment>
   * NoRewindIterator::rewind


id: NoRewindIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Evita la operación de rebobinado en el iterador interno
  
  Evita la operación de rebobinado en el iterador interno.

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


id: NoRewindIterator::valid
type: function
doc:
<comment>Description:</comment>
  Valida el iterador
  
  Comprueba si el iterador es válido.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<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>
   * NoRewindIterator::getInnerIterator


id: Normalizer
type: class
doc:
<comment>Description:</comment>
  La normalización es un proceso que involucra la transformación de caracteres y secuencias de
  caracteres en una representación subyacente formalmente definida. Este proceso es más importante
  cuando el texto necesita ser comparado para propósitos de ordenación y búsqueda, pero también se
  usa al almacenar texto para asegurarse de que éste se almacena en una representación consistente.
  
  El Consorcio Unicode ha definido varias formas de normalización que reflejan las diferentes
  necesidades de las aplicaciones: Forma de Normalización D (NFD) - Descomposición Canónica Forma de
  Normalización C (NFC) - Descomposición Canónica seguida de Composición Canónica  Forma de
  Normalización KD (NFKD) - Descomposición por Compatibilidad  Forma de Normalización KC (NFKC) -
  Descomposición por Compatibilidad seguida de Composición Canónica  Las diferentes formas están
  definidas en términos de un conjunto de transformaciones realizadas sobre el texto,
  tranformaciones que están expresadas por un algoritmo y un conjunto de ficheros de datos.


id: Normalizer::FORM_C
type: constant
doc:
<comment>Description:</comment>
  Forma de Normalización C (NFC) - Descomposición Canónica seguida de Composición Canónica


id: Normalizer::FORM_KC
type: constant
doc:
<comment>Description:</comment>
  Forma de Normalización KC (NFKC) - Descomposición por Compatibilidad seguida de Composición
  Canónica


id: Normalizer::FORM_KD
type: constant
doc:
<comment>Description:</comment>
  Forma de Normalización KD (NFKD) - Descomposición por Compatibilidad


id: Normalizer::getRawDecomposition
type: function
doc:
<comment>Description:</comment>
  Gets the Decomposition_Mapping property for the given UTF-8 encoded code point
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Gets the Decomposition_Mapping property, as specified in the Unicode Character Database (UCD), for
  the given UTF-8 encoded code point.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The input string, which should be a single, UTF-8 encoded, code point.

<comment>Return:</comment>
  <info>string|null</info>  Returns a <info>string</info> containing the Decomposition_Mapping property, if present in the
               UCD.
               
               Returns <info>null</info> if there is no Decomposition_Mapping property for the character.

<comment>See Also:</comment>
   * Normalizer::normalize
   * Normalizer::isNormalized


id: Normalizer::isNormalized
type: function
doc:
<comment>Description:</comment>
  Comprobar si la cadena proporcionada ya está en la forma de normalización especificada.
    
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Comprueba si la cadena proporcionada ya está en la forma de normalización  especificada.

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>  La cadena de entrada a normalizar
  <info>int</info>     <strong>$form</strong>   Una de las formas de normalización.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si está normalizada, <info>false</info> si no o si hay un error

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


id: Normalizer::normalize
type: function
doc:
<comment>Description:</comment>
  Normaliza la entrada provista y devuelve la cadena normalizada
    
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Normaliza la entrada provista y devuelve la cadena normalizada

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>  La cadena de entrada a normalizar
  <info>int</info>     <strong>$form</strong>   Una de las formas de normalización.

<comment>Return:</comment>
  <info>string</info>  La cadena normalizada o <info>false</info> si ocurrió un error.

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


id: NumberFormatter
type: class
doc:
<comment>Description:</comment>
  Los programas almacenan y operan sobre números utilizando una representación binaria independiente
  de la configuración regional. Cuando se muestra o imprime un número, éste es convertido a una
  cadena específica regional. Por ejemplo, el número 12345.67 es "12,345.67" en los Estados Unidos,
  "12 345,67" en Francia y "12.345,67" en Alemania.
  
  Al invocar a los métodos proporcionados por la clase NumberFormatter, se pueden formatear números,
  valores monetarios y porcentajes de acuerdo a la configuración regional especificada o
  predeterminada. NumberFormatter es sensible a la configuración regional, por lo que se necesita
  crear un nuevo objeto NumberFormatter para cada región. Los métodos de NumberFormatter dan formato
  a números de tipo primitivo, tales como los de tipo double, e imprimien el número como una cadena
  específica según la región.
  
  Para los valores monetarios se puede utilizar el tipo de formato de moneda para crear un
  formateador que devuelva una cadena con el número formateado y el símbolo de moneda apropiada. Por
  supuesto, la clase NumberFormatter ignora los tipos de cambio monetarios, por lo que el número
  impreso es el mismo sin tener en cuenta la moneda especificada. Esto significa que el mismo número
  tiene diferentes valores monetarios dependiendo de la moneda regional. Si el numero fuese el
  9988776.65, los resultados serían: 9 988 776,65 € en Francia9.988.776,65 € en
  Alemania$9,988,776.65 en los Estados Unidos
  
  Para dar formato a los porcentajes, se debe crear un formateador específico de la región con el
  tipo de formato de porcentaje. Con este formateador, una fracción decimal como 0.75 será mostrada
  como 75%.
  
  Para un formateo más complejo, como los números escritos con palabras, se usan los formateadores
  de números basados en reglas.


id: NumberFormatter::DEFAULT_RULESET
type: constant
doc:
<comment>Description:</comment>
  El conjunto de reglas predeterminadas. Sólo está disponible con formateadores basados en reglas.


id: NumberFormatter::LENIENT_PARSE
type: constant
doc:
<comment>Description:</comment>
  Modo de proceso poco riguroso usado por los formatos basados en reglas.


id: NumberFormatter::PADDING_POSITION
type: constant
doc:
<comment>Description:</comment>
  La posición en la que el relleno tendrá lugar. Véase las constantes de posición de relleno para
  los posibles valores de los argumentos.


id: NumberFormatter::PUBLIC_RULESETS
type: constant
doc:
<comment>Description:</comment>
  Los conjuntos de reglas públicas. Sólo está disponible con formateadores basados en reglas. Este
  atributo es de sólo lectura. Los conjuntos de reglas públicas son devueltos como una cadena
  simple, con cada conjunto de reglas deliminado por ';' (semicolon).


id: NumberFormatter::ROUND_HALFDOWN
type: constant
doc:
<comment>Description:</comment>
  Modo de redondeo para redondear hacia el "vecino más cercano" a menos que ambos vecinos sean
  equidistantes, en cuyo caso se redondea hacia abajo.


id: NumberFormatter::ROUND_HALFEVEN
type: constant
doc:
<comment>Description:</comment>
  Modo de redondeo para redondear hacia el "vecino más cercano" a menos que ambos vecinos sean
  equidistantes, en cuyo caso se redondea hacia el vecino par.


id: NumberFormatter::ROUND_HALFUP
type: constant
doc:
<comment>Description:</comment>
  Modo de redondeo para redondear hacia el "vecino más cercano" a menos que ambos vecinos sean
  equidistantes, en cuyo caso se redondea hacia arriba.


id: NumberFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Crear un formateador de números
  
  Estilo orientado a objetos (método)
  
  Estilo por procedimientos
  
  Estilo orientado a objetos (constructor)
  
  Crea un formateador de números.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>   La configuración regional en la que el número deberá ser formateado (nombre de
                    la configuración regional, p.ej. en_CA).
  <info>int</info>     <strong>$style</strong>    El estilo de formo, una de las constanes de  estilo de formato. Si se le pasa
                    <info>NumberFormatter::PATTERN_DECIMAL</info> o <info>NumberFormatter::PATTERN_RULEBASED</info>, el
                    formato numérico es abierto usando el patrón dado, el cual debe ajustarse a la
                    sintaxis descrita en la documentación de DecimalFormat de ICU o en la
                    documentación de RuleBasedNumberFormat de ICU, respectivamente.
  <info>string</info>  <strong>$pattern</strong>  Una cadena con el patrón si el estilo elegido requiere de un patrón.

<comment>Return:</comment>
  <info>NumberFormatter</info>  Devuelve un objeto de la clase <class>NumberFormatter</class> o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse()</strong>


id: NumberFormatter::format
type: function
doc:
<comment>Description:</comment>
  Dar formato a un número
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Dar formato a un valor numérico según las reglas del formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>    Objeto <class>NumberFormatter</class>.
  <info>number</info>           <strong>$value</strong>  El valor de formato. Puede ser <info>integer</info> o <info>float</info>, otros valores se
                           convierten en un valor numérico.
  <info>int</info>              <strong>$type</strong>   The  tipo de formato a usar.

<comment>Return:</comment>
  <info>string</info>  Devuelve un string con el valor formateado, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format_currency()</strong>
   * <strong>numfmt_parse()</strong>


id: NumberFormatter::formatCurrency
type: function
doc:
<comment>Description:</comment>
  Dar formato a un valor monetario
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Dar formato al valor monetario según las reglas del formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>       Objeto <class>NumberFormatter</class>.
  <info>float</info>            <strong>$value</strong>     El valor numérico monetario.
  <info>string</info>           <strong>$currency</strong>  El código 3-letter ISO 4217 de moneda que indica la moneda a usar.

<comment>Return:</comment>
  <info>string</info>  Un string representando el valor de moneda formateado,  o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse_currency()</strong>


id: NumberFormatter::getAttribute
type: function
doc:
<comment>Description:</comment>
  Obtener un atributo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener un atributo numérico asociado con el formateador. Un ejemplo de  un atributo numérico es
  el número de dígitos enteros que el formateador producirá.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>   Objeto <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>  Especificador de atributo - una de las constantes   numeric attribute.

<comment>Return:</comment>
  <info>int</info>  Devuelve el valor de atributo en caso de éxito, o de lo contrario <info>false</info>.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_text_attribute()</strong>
   * <strong>numfmt_set_attribute()</strong>


id: NumberFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Obtener el último código de error del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener el código de error de la última función realizada por el formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>  Objeto <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>int</info>  Devuelve el código de error de la última llamada al formateador.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_message()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: NumberFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Obtener el último mensaje de error del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener mensaje de error de la última función realizada por el formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>  Objeto <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>string</info>  Devuelve el mensaje de error de la última llamada al formateador.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>intl_get_error_code()</strong>
   * <strong>intl_is_failure()</strong>


id: NumberFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  Obtener la configuración regional de un formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtener el nombre de la configuración regional de un formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>   Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$type</strong>  Se puede escoger entre una configuración regional válida y real (
                          <info>Locale::VALID_LOCALE</info> y <info>Locale::ACTUAL_LOCALE</info>, respectivamente). La
                          configuración regional real es la predeterminada.

<comment>Return:</comment>
  <info>string</info>  El nombre de la configuración regional usado para crear el formateador.

<comment>See Also:</comment>
   * <strong>numfmt_create()</strong>
   * <strong>numfmt_get_error_code()</strong>


id: NumberFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Obtener el patrón del formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Extrae el patrón usado por el formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>  Un objeto de la clase <class>NumberFormatter</class>.

<comment>Return:</comment>
  <info>string</info>  El <info>string</info>  con el patroón que es usado por el formateador, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_pattern()</strong>
   * <strong>numfmt_create()</strong>


id: NumberFormatter::getSymbol
type: function
doc:
<comment>Description:</comment>
  Obtener el valor de un símbolo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene el símbolo asociado con el formateador. El formateador utiliza símbolos para representar
  los caracteres especiales dependientes de la configuración regional en un número, por ejemplo el
  signo de porcentaje. Esta API no está soportada por formateadores basados en reglas.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>   Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>  El especificador del símbolo, una de las constantes de   símbolo de
                          formato.

<comment>Return:</comment>
  <info>string</info>  La cadena con el símbolo o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_set_symbol()</strong>


id: NumberFormatter::getTextAttribute
type: function
doc:
<comment>Description:</comment>
  Obtiene un atributo de texto
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Obtiene un atributo de texto asociado al formateador. Un ejemplo de un atributo de texto es el
  sufijo de números positivos. Si el formateador no entiende el atributo, se producirá un error de
  tipo <info>U_UNSUPPORTED_ERROR</info>. Los formateadores basados en reglas sólo entienden
  <info>NumberFormatter::DEFAULT_RULESET</info> y <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>   Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>  El especificador del atributo - una de las constantes de  atributo de
                          texto.

<comment>Return:</comment>
  <info>string</info>  Devuelve el valor del atributo en caso de éxito, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::parse
type: function
doc:
<comment>Description:</comment>
  Analiza un número
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Pasar de un string a un número usando las reglas actuales de formateo.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>       <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$type</strong>      El  tipo de formateo a usar. Por defecto, se utiliza
                              <info>NumberFormatter::TYPE_DOUBLE</info>.
  <info>int</info>              <strong>$position</strong>  Lugar del string a partir del cual se debe convertir. Al regresar,
                              este valor contendrá el lugar en el que la conversión ha finalizado.

<comment>Return:</comment>
  <info>mixed</info>  El valor del número convertido o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_format()</strong>
   * <strong>numfmt_parse_currency()</strong>


id: NumberFormatter::parseCurrency
type: function
doc:
<comment>Description:</comment>
  Procesa un número monetario
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Convierte una cadena en un valor de tipo double y en un valor monetario usando el formateador
  actual.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>       Un objeto de la clase <class>NumberFormatter</class>.
  <info>string</info>           <strong>$currency</strong>  Parámetro que recibe el nombre de la moneda (código de moneda ISO 4217
                              de 3 letras).
  <info>int</info>              <strong>$position</strong>  Índice de la cadena en la que comenzar el proceso. Cuando el método
                              devuelve, este valor contendrá el índice en el que finalizón el
                              proceso.

<comment>Return:</comment>
  <info>float</info>  El valor numérico procesado o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * <strong>numfmt_get_error_code()</strong>
   * <strong>numfmt_parse()</strong>
   * <strong>numfmt_format_currency()</strong>


id: NumberFormatter::setAttribute
type: function
doc:
<comment>Description:</comment>
  Establecer un atributo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece un atributo numértico asociado con el formateador. Un ejemplo de un atributo numérico es
  el número de dígitos enteros que producirá el formateador.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>    Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>   El especificador del atributo - una de las constantes de  atributo
                           numérico.
  <info>int</info>              <strong>$value</strong>  El valor del atributo.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_attribute()</strong>
   * <strong>numfmt_set_text_attribute()</strong>


id: NumberFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  Establecer el patrón de un formateador
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece el patrón usado por el formateador. No se puede usar en formateadores basados en reglas.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>      Un objeto de la clase <class>NumberFormatter</class>.
  <info>string</info>           <strong>$pattern</strong>  Un patrón con la sintaxis descrita en la documentación de DecimalFormat
                             de ICU.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_create()</strong>
   * <strong>numfmt_get_pattern()</strong>


id: NumberFormatter::setSymbol
type: function
doc:
<comment>Description:</comment>
  Establecer un valor de símbolo
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece un símbolo asociado con el formateador. Los formateadores utilizan símbolos para
  representar los caracteres especiales dependientes de la configuración regional en un número, por
  ejemplo el signo de porcentaje. Esta API no está soportada por formateadores basados en reglas.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>    Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>   El especificador del símbolo, una de las constantes de  símbolo de
                           formato.
  <info>string</info>           <strong>$value</strong>  El texto para el símbolo.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_symbol()</strong>


id: NumberFormatter::setTextAttribute
type: function
doc:
<comment>Description:</comment>
  Set a text attribute
  
  Estilo orientado a objetos
  
  Estilo por procedimientos
  
  Establece un atributo de texto asociado al formateador. Un ejemplo de un atributo de texto es el
  sufijo de números positivos. Si el formateador no entiende el atributo, se producirá un error de
  tipo <info>U_UNSUPPORTED_ERROR</info>. Los formateadores basados en reglas sólo entienden
  <info>NumberFormatter::DEFAULT_RULESET</info> y <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$fmt</strong>    Un objeto de la clase <class>NumberFormatter</class>.
  <info>int</info>              <strong>$attr</strong>   El especificador del atributo - una de las constanes de atributo de
                           texto.
  <info>string</info>           <strong>$value</strong>  El texto para el valor del atributo.

<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>numfmt_get_error_code()</strong>
   * <strong>numfmt_get_text_attribute()</strong>
   * <strong>numfmt_set_attribute()</strong>


id: OAUTH_AUTH_TYPE_AUTHORIZATION
type: constant
doc:
<comment>Description:</comment>
  Esta constante representa los parámetros OAuth en la cabecera de   <return>Authorization</return>.


id: OAUTH_AUTH_TYPE_FORM
type: constant
doc:
<comment>Description:</comment>
  Esta constante representa los parámetros OAuth como una parte del cuerpo  HTTP POST.


id: OAUTH_AUTH_TYPE_URI
type: constant
doc:
<comment>Description:</comment>
  Esta constante representa los parámetros OAuth en la   URI de petición.


id: OAUTH_BAD_NONCE
type: constant
doc:
<comment>Description:</comment>
  El valor oauth_nonce que fue usado en una anterior petición, y no se puede utilizar ahora.


id: OAUTH_BAD_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  El valor oauth_timestamp que no fue aceptado por el proveedor de servicio.  En este caso, la
  respuesta deberá estar también contenida en el parámetro oauth_acceptable_timestamps.


id: OAUTH_CONSUMER_KEY_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  oauth_consumer_key es temporalmehte inaceptable para el proveedor de servicio. Por ejemplo, el
  proveedor de servicio se ha sobrecargado.


id: OAUTH_INVALID_SIGNATURE
type: constant
doc:
<comment>Description:</comment>
  La firma oauth_signature es inválida, no coincide la firma del cliente con la del proveedor.


id: OAUTH_PARAMETER_ABSENT
type: constant
doc:
<comment>Description:</comment>
  Un parámetro no fue recibido. En ese caso, la respuesta debe también  contener el parámetro
  oauth_parameters_absent.


id: OAUTH_REQENGINE_CURL
type: constant
doc:
<comment>Description:</comment>
  Utiliza el método OAuth::setRequestEngine para definir el motor de  Curl, en lugar de
  <info>OAUTH_REQENGINE_STREAMS</info> para PHP streams.


id: OAUTH_REQENGINE_STREAMS
type: constant
doc:
<comment>Description:</comment>
  Utiliza el método OAuth::setRequestEngine para definir el motor de  PHP streams, en lugar de
  <info>OAUTH_REQENGINE_CURL</info> para  Curl.


id: OAUTH_SIGNATURE_METHOD_REJECTED
type: constant
doc:
<comment>Description:</comment>
  El método oauth_signature_method no fue aceptado por el proveedor de servicio.


id: OAUTH_TOKEN_REJECTED
type: constant
doc:
<comment>Description:</comment>
  El oauth_token no fue aceptado por el proveedor de servicio. La razón es desconocida, pero puede
  deberse a que el token nunca fue usado, ya había sido consumido, ya había expirado, y/o olvidado
  por el proveedor de servicio.


id: OAUTH_TOKEN_USED
type: constant
doc:
<comment>Description:</comment>
  El oauth_token ha sido consumido. No se puede utilizar más  debido a que ya había sido usada en
  la/s petición/peticiones anterior/es.


id: OAuth
type: class
doc:
<comment>Description:</comment>
  La extensión OAuth provee una interfaz simple para interactuar con  proveedores de datos usando la
  especificación HTTP OAuth para proteger los recursos privados.


id: OAuth::__construct
type: function
doc:
<comment>Description:</comment>
  Crea un nuevo objeto OAuth
  
  Crea un nuevo objeto OAuth

<comment>Param:</comment>
  <info>string</info>  <strong>$consumer_key</strong>      La clave de lectura proporcionada por el proveedor de servicios.
  <info>string</info>  <strong>$consumer_secret</strong>   El secreto de lectura proporcionada por el proveedor de servicios.
  <info>string</info>  <strong>$signature_method</strong>  Este parámetro es opcional define cual método usar, por omisión es
                             <info>OAUTH_SIG_METHOD_HMACSHA1</info> (HMAC-SHA1).
  <info>int</info>     <strong>$auth_type</strong>         Este parámetro es opcional define como pasar los parámetros OAuth  al
                             lector, por omisión es  <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> (en la cabecerá
                             <return>Authorization</return>).


id: OAuth::__destruct
type: function
doc:
<comment>Description:</comment>
  El destructor
  
  El destructor.
  
  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.

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


id: OAuth::disableDebug
type: function
doc:
<comment>Description:</comment>
  Desactiva la depuración detallada
  
  Desactiva la solicitud de información detallada (desactivado por omisión). Alternativamente, la
  propiedad debug puede  ser establecida al valor <info>false</info> para desactivar el depurador.

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

<comment>See Also:</comment>
   * OAuth::enableDebug


id: OAuth::disableRedirects
type: function
doc:
<comment>Description:</comment>
  Desactiva las redirecciones
  
  Desactiva las redirecciones automáticas, permitiendo que la petición sea manualmente redirigida.
  
  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>

<comment>See Also:</comment>
   * OAuth::enableRedirects


id: OAuth::disableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Desactiva la verificación SSL
  
  Desactiva la verificación del certificado y servidor SSL, esto no se recomiendo para entornos en
  producción. Alternativamente, el miembro   <strong>$sslChecks</strong> puede ser puesto <info>false</info>  para desactivar la
  revisión.

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

<comment>See Also:</comment>
   * OAuth::enableSSLChecks


id: OAuth::enableDebug
type: function
doc:
<comment>Description:</comment>
  Activa la depuración detallada
  
  Activa la solititud de información detallada útil para depurar, la información de depuración es
  almacenada en el miembro <strong>$debugInfo</strong>.  Alternativamente, el miembro <strong>$debug</strong> puede  ser establecido a
  un valor no-<info>false</info> para activar el depurador.

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

<comment>See Also:</comment>
   * OAuth::disableDebug


id: OAuth::enableRedirects
type: function
doc:
<comment>Description:</comment>
  Activa las re-direcciones 
  
  Sigue y firma las re-direcciones automáticamente, el cual está en activado por omisión.
  
  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>

<comment>See Also:</comment>
   * OAuth::disableRedirects


id: OAuth::enableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Activa la verificación SSL
  
  Activa la verificación del certificado y servidor SSL (activado por omisión). Alternativamente, el
  miembro <strong>$sslChecks</strong> puede ser puesto a un valor distinto a <info>false</info> para desactivar la revisión.

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

<comment>See Also:</comment>
   * OAuth::disableSSLChecks


id: OAuth::fetch
type: function
doc:
<comment>Description:</comment>
  Obtiene un recurso protegido por OAuth
  
  Obtiene un recurso.

<comment>Param:</comment>
  <info>string</info>  <strong>$protected_resource_url</strong>  URL del recurso OAuth protegio.
  <info>array</info>   <strong>$extra_parameters</strong>        Parámetros adicionales para enviar con la petición del recurso.
  <info>string</info>  <strong>$http_method</strong>             Una de las <info>OAUTH_HTTP_METHOD_*</info> constantes OAUTH, which includes
                                   GET, POST, PUT, HEAD, or DELETE.
                                   
                                   HEAD (<info>OAUTH_HTTP_METHOD_HEAD</info>) can be useful for discovering
                                   information prior to the request (if OAuth credentials are in the
                                   <return>Authorization</return> header).
  <info>array</info>   <strong>$http_headers</strong>            Encabezados cliente HTTP (como por ejemplo User-Agent, Accept,
                                   etc.)

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

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::generateSignature
type: function
doc:
<comment>Description:</comment>
  Generar una firma
  
  Generar una firma basada en el método HTTP final, URL y un string/array de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       Método HTTP para la solicitud
  <info>string</info>  <strong>$url</strong>               URL de solicitud
  <info>mixed</info>   <strong>$extra_parameters</strong>  String o array de parámetros adicionales.

<comment>Return:</comment>
  <info>string</info>  Un string que contiene la firma generada  o <info>false</info> en caso de error


id: OAuth::getAccessToken
type: function
doc:
<comment>Description:</comment>
  Obtiene el token de acceso
  
  Obtiene un token de acceso, secreto y cualquier parámetro de respuesta adicional del proveedor de
  servicio.

<comment>Param:</comment>
  <info>string</info>  <strong>$access_token_url</strong>     URL al token de acceso de la API.
  <info>string</info>  <strong>$auth_session_handle</strong>  El manejador de autorización de sesión, este parámetro no existe  en
                                la especificación OAuth 1.0 pero puede ser implementada  por muchos
                                proveedores.  Visite ScalableOAuth para más información.
  <info>string</info>  <strong>$verifier_token</strong>       Para los proveedores de servicio que soportan 1.0a, Un parámetro
                                <strong>$verifier_token</strong> debe ser pasado mientras se solicita el token de
                                acceso.  Si el parámetro <strong>$verifier_token</strong> está presente en <strong>$_GET</strong>  o
                                <strong>$_POST</strong> es pasado automáticamente y el solicitante ya no necesita
                                especificar el <strong>$verifier_token</strong> (usualmente el token de acceso  es
                                intercambiado en la URL del oauth_callback). Visite ScalableOAuth
                                para más información.
  <info>string</info>  <strong>$http_method</strong>          Método HTTP a usar, por ejemplo <return>GET</return> o <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array que contiene las respuestas OAuth analizadas al tener éxito o <info>false</info> al
         fallar.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::getCAPath
type: function
doc:
<comment>Description:</comment>
  Obtiene la información CA
  
  Obtiene la información del certificado de Autoridad, el cual incluye los  ca_path y ca_info
  establecidos por OAuth::setCaPath.
  
  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 información del Certificado de Autoridad, específicamente como claves  <return>ca_path</return>
         y <return>ca_info</return> dentro del array asociativo devuelto.

<comment>See Also:</comment>
   * OAuth::setCAPath
   * OAuth::getLastResponseInfo


id: OAuth::getLastResponse
type: function
doc:
<comment>Description:</comment>
  Obtiene la última respuesta
  
  Obtiene la respuesta original de la más reciente petición.

<comment>Return:</comment>
  <info>string</info>  Devuelve la cadena conteniendo la última respuesta.

<comment>See Also:</comment>
   * OAuth::getLastResponseInfo
   * OAuth::fetch


id: OAuth::getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Obtener encabezados de la última respuesta
  
  Obtiene los encabezados de la última respuesta.

<comment>Return:</comment>
  <info>string</info>  Un string que contiene los encabezados de la última respuesta  o <info>false</info> en caso de error


id: OAuth::getLastResponseInfo
type: function
doc:
<comment>Description:</comment>
  Obtiene la información HTTP sobre la última respuesta
  
  Obtiene la información HTTP sobre la última respuesta.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array conteniendo la información de respuesta de la última petición. Constantes
         de  <strong>curl_getinfo()</strong> pueden ser usadas.

<comment>See Also:</comment>
   * OAuth::fetch
   * OAuth::getLastResponse


id: OAuth::getRequestHeader
type: function
doc:
<comment>Description:</comment>
  Generar un string de firma de cabecera OAuth
  
  Generar un string de firma de cabecera OAuth basada en el método HTTP final, el URL y los
  parámetros de string/array

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       Método HTTP para la petición.
  <info>string</info>  <strong>$url</strong>               URL para la petición.
  <info>mixed</info>   <strong>$extra_parameters</strong>  String o array de parámetros adicionales.

<comment>Return:</comment>
  <info>string</info>  Un string que contiene la cabecera solicitada generada  o <info>false</info> en caso de error


id: OAuth::getRequestToken
type: function
doc:
<comment>Description:</comment>
  Obtiene un token de petición
  
  Obtiene un token de petición, secreto y cualquier parámetro adicional de respuesta del proveedor
  de servicio.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_token_url</strong>  URL al token de solicitud de la API.
  <info>string</info>  <strong>$callback_url</strong>       URL del callback OAuth. Si <strong>$callback_url</strong> es pasado y es un valor
                              vacío, este es puesto a "oob" para satisfacer las exigencias de OAuth
                              2009.1 advisory.
  <info>string</info>  <strong>$http_method</strong>        Método HTTP a usar, por ejemplo <return>GET</return> o <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Devuelve un array conteniendo las respuestas OAuth analizadas al tener éxitoo <info>false</info> al
         fallar.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo


id: OAuth::setAuthType
type: function
doc:
<comment>Description:</comment>
  Establece el tipo de autorización
  
  Establece donde un parámetro OAuthdebería ser pasado.

<comment>Param:</comment>
  <info>int</info>  <strong>$auth_type</strong>  <strong>$auth_type</strong> puede ser una de las siguientes banderas (in orden descendente de
                   preferencia según OAuth 1.0 sección 5.2): <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> Pasa los
                   parámetros OAuth en la cabecera de <return>Authorization</return> HTTP. <info>OAUTH_AUTH_TYPE_FORM</info> Anexa
                   los parámetros OAuth al cuerpo de petición HTTP POST. <info>OAUTH_AUTH_TYPE_URI</info> Anexa
                   los parámetros OAuth a la URI de petición. <info>OAUTH_AUTH_TYPE_NONE</info> Ninguno.
                   
                   Pasa los parámetros OAuth en la cabecera de <return>Authorization</return> HTTP.
                   
                   Anexa los parámetros OAuth al cuerpo de petición HTTP POST.
                   
                   Anexa los parámetros OAuth a la URI de petición.
                   
                   Ninguno.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el parámetro es correctamente establecido, de otra manera <info>false</info> (Ejemplo,
        si un inválido parámetro <strong>$auth_type</strong> es pasado.)


id: OAuth::setCAPath
type: function
doc:
<comment>Description:</comment>
  Establece la ruta a CA y su información
  
  Establece el Certificado de Autoridad (CA), tanto la ruta  como la información.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$ca_path</strong>  La ruta CA a ser establecida.
  <info>string</info>  <strong>$ca_info</strong>  La ruta de información CA a ser establecido.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> al tener éxitos, o <info>false</info> si tanto <strong>$ca_path</strong> o <strong>$ca_info</strong> son considerados como
         inválidos.

<comment>See Also:</comment>
   * OAuth::getCaPath


id: OAuth::setNonce
type: function
doc:
<comment>Description:</comment>
  Configura el nonce para las solicitudes posteriores
  
  Establece el nonce para todas las solicitudes posteriores.

<comment>Param:</comment>
  <info>string</info>  <strong>$nonce</strong>  El valor para oauth_nonce.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> si tiene éxito, o  <info>false</info> si  <strong>$nonce</strong> es considerado como inválido.

<comment>See Also:</comment>
   * OAuth::setToken
   * OAuth::setAuthType
   * OAuth::setVersion


id: OAuth::setRSACertificate
type: function
doc:
<comment>Description:</comment>
  establece el certificado RSA
  
  Establece el certificado RSA.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$cert</strong>  El certificado RSA.

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info> si tiene éxito, o <info>false</info> al fallar (Ejemplo, el certificado RSA  no se pudo
         procesar.)

<comment>See Also:</comment>
   * OAuth::setCaPath


id: OAuth::setRequestEngine
type: function
doc:
<comment>Description:</comment>
  El propósito de setRequestEngine
  
  Establece el motor de peticiones, que estará enviando las peticiones HTTP.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>int</info>  <strong>$reqengine</strong>  El motor de peticiones deseado. Poner a <info>OAUTH_REQENGINE_STREAMS</info> para usar el
                   Stream PHP, o <info>OAUTH_REQENGINE_CURL</info> para usar  Curl.

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

<comment>See Also:</comment>
   * Curl
   * PHP streams
   * <class>OAuthException</class>


id: OAuth::setSSLChecks
type: function
doc:
<comment>Description:</comment>
  Ajustar controles específicos de SSL para las solicitudes
  
  Ajusta controles específicos de SSL para las solicitudes.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

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


id: OAuth::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Establece el timestamp
  
  Establece el timestamp de OAuth para las subsecuentes peticiones.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>mixed</info>  Devuelve <info>true</info>, a menos que <strong>$timestamp</strong> sea inválido, en cuyo caso  <info>false</info> será devuelto.

<comment>See Also:</comment>
   * OAuth::setNonce


id: OAuth::setToken
type: function
doc:
<comment>Description:</comment>
  Establece el token y el secreto
  
  Establece el token y el secreto para las subsecuentes peticiones.

<comment>Param:</comment>
  <info>string</info>  <strong>$token</strong>         El token OAuth.
  <info>string</info>  <strong>$token_secret</strong>  El secreto OAuth.

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


id: OAuth::setVersion
type: function
doc:
<comment>Description:</comment>
  Configura la versión OAuth
  
  Establece la versión OAuth para las subsecuentes peticiones

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>  Versión OAuth, el valor por omisión es siempre "1.0"

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


id: OAuthException
type: class
doc:
<comment>Description:</comment>
  Esta excepción es lanzada cuando un error excepcional durante el uso de la extensión OAuth y
  contiene información útil de depuración.


id: OAuthProvider
type: class
doc:
<comment>Description:</comment>
  Administra una clase OAuthProvider.
  
  Vea también el tutorial externo llamado  Escribiendo un proveedor de servicios OAuth, Que tiene un
  enfoque práctico a la prestación de este servicio. También hay  Ejemplos de proveedor OAuth en la
  fuente de la extensión  Oauth.


id: OAuthProvider::__construct
type: function
doc:
<comment>Description:</comment>
  Construye un nuevo objeto OAuthProvider
  
  Inicia un nuevo <info>object</info> <class>OAuthProvider</class> .
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>array</info>  <strong>$params_array</strong>  La configuración de estos parámetros opcionales se limita al    CLI SAPI.

<comment>Return:</comment>
  <info>unknown</info>  Un <info>object</info> <class>OAuthProvider</class> .

<comment>See Also:</comment>
   * OAuthProvider::setParam


id: OAuthProvider::addRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Agregar parámetros necesarios
  
  Agregar parámetros requeridos por el proveedor OAuth.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  Los parámetros requeridos.

<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>
   * OAuthProvider::removeRequiredParameter


id: OAuthProvider::callTimestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Llama al callback timestampNonceHandler
  
  Llama a la función callback del timestamp registrado, que fue establecido  con
  OAuthProvider::timestampNonceHandler.
  
  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.

<comment>See Also:</comment>
   * OAuthProvider::timestampNonceHandler


id: OAuthProvider::callconsumerHandler
type: function
doc:
<comment>Description:</comment>
  Llama al callback consumerNonceHandler
  
  Llama al callback del manejador del consumidor registrado, la cual es establecida  con
  OAuthProvider::consumerHandler.
  
  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.

<comment>See Also:</comment>
   * OAuthProvider::consumerHandler


id: OAuthProvider::calltokenHandler
type: function
doc:
<comment>Description:</comment>
  Llama al callback tokenNonceHandler
  
  Llama a la función callback del token registrado, que fue establecido   con
  OAuthProvider::tokenHandler.
  
  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.

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::checkOAuthRequest
type: function
doc:
<comment>Description:</comment>
  Revisa una petición OAuth
  
  Revisa una petición OAuth.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>     La URI opcional, o punto final.
  <info>string</info>  <strong>$method</strong>  El métodoHTTP. opcionalmente pasar una de las   <info>OAUTH_HTTP_METHOD_*</info> Constantes
                   OAuth.

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

<comment>See Also:</comment>
   * OAuthProvider::reportProblem


id: OAuthProvider::consumerHandler
type: function
doc:
<comment>Description:</comment>
  Establece el manejador callback consumerHandler
  
  Establece el manejador callback, que más tarde será llamado con
  OAuthProvider::callConsumerHandler.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  El nombre de la función <info>callable</info>.

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

<comment>See Also:</comment>
   * OAuthProvider::callConsumerHandler


id: OAuthProvider::generateToken
type: function
doc:
<comment>Description:</comment>
  Genera un token aleatorio
  
  Genera una <info>string</info> de bytes pseudo-aleatorios.

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>    La longitud The desired token length, in terms of bytes.
  <info>bool</info>  <strong>$strong</strong>  Establecer a <info>true</info> significa que <return>/dev/random</return> será usada para  la entropía, de lo
                 contrario <return>/dev/urandom</return> será usado. Este parámetro es ignorado en Windows.

<comment>Return:</comment>
  <info>string</info>  El token generado, como un <info>string</info> de bytes.

<comment>See Also:</comment>
   * <strong>openssl_random_pseudo_bytes()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: OAuthProvider::is2LeggedEndpoint
type: function
doc:
<comment>Description:</comment>
  is2LeggedEndpoint
  
  El flujo de 2-piernas, o la suscripción de petición. No requiere token.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

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

<comment>Return:</comment>
  <info>void</info>  An <class>OAuthProvider</class> <info>object</info>.

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


id: OAuthProvider::isRequestTokenEndpoint
type: function
doc:
<comment>Description:</comment>
  Establece isRequestTokenEndpoint
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>bool</info>  <strong>$will_issue_request_token</strong>  Establece si emitirá o no una emisión de petición de token,
                                   determinando si  OAuthProvider::tokenHandler necesita ser
                                   llamado.

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

<comment>See Also:</comment>
   * OAuthProvider::setRequestTokenPath
   * OAuthProvider::reportProblem


id: OAuthProvider::removeRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Remueve un parámetro requerido
  
  Remueve un parámetro requerido.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  El parámetro requerido a ser removido.

<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>
   * OAuthProvider::setParam
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::reportProblem
type: function
doc:
<comment>Description:</comment>
  Reportar un problema
  
  Sucede en un problema como <class>OAuthException</class>, con posibles problemas listados  en la sección OAuth
  constants.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$oauthexception</strong>  La <class>OAuthException</class>.

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

<comment>See Also:</comment>
   * OAuthProvider::checkOAuthRequest
   * OAuthProvider::isRequestTokenEndpoint


id: OAuthProvider::setParam
type: function
doc:
<comment>Description:</comment>
  Establece un parámetro
  
  Establece un parámetro.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$param_key</strong>  La clave del parámetro.
  <info>mixed</info>   <strong>$param_val</strong>  El valor opcional del parámetro.
                      
                      Para excluir un parámetro de la verificación de firmas, colocar este valor a
                      <info>null</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>
   * OAuthProvider::addRequiredParameter


id: OAuthProvider::setRequestTokenPath
type: function
doc:
<comment>Description:</comment>
  Establece la ruta de petición del token
  
  Establece la ruta de petición del token.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  La ruta.

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

<comment>See Also:</comment>
   * OAuthProvider::tokenHandler


id: OAuthProvider::timestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  Establece el callback timestampNonceHandler
  
  Establece el manejador callback timestamp nonce, el cual será llamado luego con
  OAuthProvider::callTimestampNonceHandler. Errores relacionados con timestamp/nonce son lanzados a
  este callback.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  El nombre de la función <info>callable</info>.

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

<comment>See Also:</comment>
   * OAuthProvider::callTimestampNonceHandler


id: OAuthProvider::tokenHandler
type: function
doc:
<comment>Description:</comment>
  Establece el manejador callback de tokenHandler
  
  Establece el token del callback, que será llamado después con  OAuthProvider::callTokenHandler.
  
  Esta función
  no está documentada actualmente, solamente se encuentra disponible la lista de parámetros.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  El nombre de la función <info>callable</info>.

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

<comment>See Also:</comment>
   * OAuthProvider::callTokenHandler


id: OCICollection
type: class
doc:
<comment>Description:</comment>
  Funcionalidad de OCI8 Collection.
  
  La clase <class>OCI-Collection</class> ha sido renombrada a <class>OCILob</class> en PHP 8 y PECL OCI8 3.0.0 para ajustarse a
  los estándares de nomenclatura de PHP.


id: OCICollection::append
type: function
doc:
<comment>Description:</comment>
  Añade un elemento a la colección
  
  Añade un elemento al final de la colección.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  El valor a añadir a la colecció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>
   * 


id: OCICollection::assign
type: function
doc:
<comment>Description:</comment>
  Asigna un valor a la colección desde otra colección existente
  
  Asigna un valor a la colección desde otra colección previamente creada. Ambas colecciones deben
  crearse con <strong>oci_new_collection()</strong> antes de utilizarlas.

<comment>Param:</comment>
  <info>OCICollection</info>  <strong>$from</strong>  Una instancia de OCICollection.

<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>
   * 


id: OCICollection::assignElem
type: function
doc:
<comment>Description:</comment>
  Asigna un valor a un elemento de la colección
  
  Asigna un valor al elemento con índice <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>  El índice del elemento. El primer índice es 0.
  <info>string</info>  <strong>$value</strong>  Puede ser una cadena de caracteres o un número.

<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>
   * 


id: OCICollection::free
type: function
doc:
<comment>Description:</comment>
  Libera los recursos asociados con el objeto colección
  
  Libera los recursos asociados con el objeto colecció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>
   * 


id: OCICollection::getElem
type: function
doc:
<comment>Description:</comment>
  Devuelve el valor de un elemento
  
  Devuelve el valor del elemento cuyo índice es <strong>$index</strong> (basado en 0).

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  El índice del elemento. El primer índice es 0.

<comment>Return:</comment>
  <info>string|float|null|false</info>  Devuelve <info>false</info> si el elemento no existe; <info>null</info> si el elemento es <info>null</info>; un
                           string si el elemento es una columna del tipo de datos string, o un
                           número si es un campo numérico.

<comment>See Also:</comment>
   * 


id: OCICollection::max
type: function
doc:
<comment>Description:</comment>
  Devuelve el número máximo de elementos de la colección
  
  Devuelve el número máximo de elementos de la colección.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve el número máximo como un entero, o <info>false</info> en caso de error.
             
             Si el valor devuelto es 0, entonces el número de elementos no está limitado.

<comment>See Also:</comment>
   * 


id: OCICollection::size
type: function
doc:
<comment>Description:</comment>
  Devuelve el tamaño de la colección
  
  Devuelve el tamaño de la colección.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve el número de elementos de la colección o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * 


id: OCICollection::trim
type: function
doc:
<comment>Description:</comment>
  Elimina elementos del final de la colección
  
  Elimina el número de elementos dado por <strong>$num</strong> del final de la colección.

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  El número de elementos a eliminar.

<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>
   * 


id: OCILob
type: class
doc:
<comment>Description:</comment>
  Funcionaliada de OCI8 LOB para objetos grandes binarios (BLOB) y de carácter (CLOB).
  
  La clase <class>OCI-Lob</class> ha sido renombrada a <class>OCILob</class> en PHP 8 y PECL OCI8 3.0.0 para ajustarse a los
  estándares de nomenclatura de PHP.


id: OCILob::append
type: function
doc:
<comment>Description:</comment>
  Añade datos a un objeto grande (LOB) desde otro
  
  Añade datos de un objeto grande (LOB) al final de otro.
  
  La escritura del objeto grande con este método fallará si el uso del búfer estaba previamente
  habilitado. Se debe deshabilitar el uso del búfer antes de la agregación. Podría ser necesario
  vaciar los búferes con  antes de deahabilitarlos.

<comment>Param:</comment>
  <info></info>  <strong>$lob_from</strong>  El LOB copiado.

<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>
   * 
   * 
   * 


id: OCILob::close
type: function
doc:
<comment>Description:</comment>
  Cierra un descriptor de LOB
  
  Cierra un descriptor de LOB o FILE. Esta función debería usarse únicamente con .

<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>
   * 


id: OCILob::eof
type: function
doc:
<comment>Description:</comment>
  Comprueba la marca de final de fichero en un descriptor de objetos grandes
  
  Indica si el puntero interno de objetos grandes está al final del LOB.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> si el puntero interno de objetos grandes está al final del LOB. Otherwise
        returns <info>false</info>.

<comment>See Also:</comment>
   * 


id: OCILob::erase
type: function
doc:
<comment>Description:</comment>
  Borra la porción especificada de los datos internos de un LOB
  
  Borra una porción especificada de los datos internos de un LOB comenzando en el índice dado por
  <strong>$offset</strong>. Si se invoca sin parámetros, borrará todos los datos del LOB.
  
  Para BLOBs, el hecho de borrar significa que el valor del LOB existente se sobrescribe con bytes
  cero. Para CLOBs, el valor del LOB existente se sobrescribe con espacios.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$offset</strong>  
  <info>int|null</info>  <strong>$length</strong>  

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

<comment>See Also:</comment>
   * 


id: OCILob::export
type: function
doc:
<comment>Description:</comment>
  Exporta el contenido de un LOB a un fichero
  
  Exporta el contenido de un LOB a un fichero.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  La ruta del fichero.
  <info></info>          <strong>$start</strong>     Indica desde dónde se empieza a exportar.
  <info>int|null</info>  <strong>$length</strong>    Indica la longitud de los datos a exportar.

<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>
   * 


id: OCILob::flush
type: function
doc:
<comment>Description:</comment>
  Vacía/escribe el búfer de un LOB al servidor
  
  <strong>OCILob::flush()</strong> en realidad escribe datos en el servidor.

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>  Por omisión, los recursos no son liberados, aunque usando la bandera
              <info>OCI_LOB_BUFFER_FREE</info> se puede hacer explícitamente. Asegúrese de saber lo que está
              haciendo: la siguiente operación de lectura/escritura a la misma parte del LOB
              supondrá un viaje de ida y vuelta al servidor e inicilizará nuevos recursos de búfer.
              Se recomienda usar la bandera <info>OCI_LOB_BUFFER_FREE</info> solamente cuando no se vaya a
              trabajar más con el LOB.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error.
        
        Devuelve <info>false</info> si el uso del búfer no estaba habilitado u ocurrió un error.

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


id: OCILob::free
type: function
doc:
<comment>Description:</comment>
  Libera los recursos asociados con el descriptor del LOB
  
  Libera los recursos asociados con el descriptor, previamente asignados con <strong>oci_new_descriptor()</strong>.

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


id: OCILob::getBuffering
type: function
doc:
<comment>Description:</comment>
  Devuelve el estado actual del uso del búfer para un objeto grande
  
  Indica si el almacenamiento en búfer para objetos grandes está activado o no.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>false</info> si el almacenamiento en búfer de objetos grandes está desactivado, y <info>true</info> si
        se utiliza dicho almacenamiento.

<comment>See Also:</comment>
   * 


id: OCILob::import
type: function
doc:
<comment>Description:</comment>
  Importa datos de un fichero a un LOB
  
  Escribe datos desde el fichero dado por <strong>$filename</strong> a la posición actual del objeto grande.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  La ruta del 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>
   * 
   * 


id: OCILob::load
type: function
doc:
<comment>Description:</comment>
  Devuelve el contenido de un objeto grande
  
  Devuelve el contenido de un objeto grande. Ya que la ejecución de un script finaliza cuando se
  alcanza el valor de memory_limit, asegúrese de que el LOB no execede dicho límite. En la mayoría
  de los casos se recomienda usar en su lugar .

<comment>Return:</comment>
  <info>string|false</info>  Devuelve el contenido del objeto, o <info>false</info> en caso de error.

<comment>See Also:</comment>
   * 


id: OCILob::read
type: function
doc:
<comment>Description:</comment>
  Lee parte del objeto grande
  
  Lee <strong>$length</strong> bytes desde la posición actual del puntero interno del LOB.
  
  La lectura se detiene cuando se han leído <strong>$length</strong> bytes o se alcance el final del objeto grande.
  El puntero interno del objeto grande será desplazado a la cantidad de bytes leídos.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  La longitud de los datos a leer, en bytes. Los valores grandes serán redondeados a 1
                MB.

<comment>Return:</comment>
  <info>string|false</info>  Devuelve el contenido como un string,  o <info>false</info> en caso de error.

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


id: OCILob::rewind
type: function
doc:
<comment>Description:</comment>
  Mueve el puntero interno al comienzo de un objeto grande
  
  Establece el puntero interno al comienzo de un objeto grande.

<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>
   * 
   * 


id: OCILob::save
type: function
doc:
<comment>Description:</comment>
  Guarda datos en un objeto grande
  
  Guarda los datos dados por <strong>$data</strong> en un objeto grande.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    Los datos a guardar.
  <info>int</info>     <strong>$offset</strong>  Se puede usar para señalar el índice desde el comienzo del objeto grande.

<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>
   * 
   * 


id: OCILob::saveFile
type: function
doc:
<comment>Description:</comment>
  Alias de OCILob::import
  
  Esta función es un alias de:   <strong>OCILob::import()</strong>.


id: OCILob::seek
type: function
doc:
<comment>Description:</comment>
  Ubica el puntero interno de un objeto grande
  
  Ubica el puntero interno de un objeto grande.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  Indica la cantidad de bytes que se moverá el puntero interno según el modo dado por
                <strong>$whence</strong>.
  <info>int</info>  <strong>$whence</strong>  Puede ser una de las siguientes constantes: <info>OCI_SEEK_SET</info> - establece la posición
                igual a <strong>$offset</strong> <info>OCI_SEEK_CUR</info> - añade <strong>$offset</strong>  bytes a la posición actual
                <info>OCI_SEEK_END</info> - añade <strong>$offset</strong> bytes al final del objeto grande (use un valor negativo
                para moverse a una posición anterior del final del objeto grande)

<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>
   * 
   * 
   * 


id: OCILob::setBuffering
type: function
doc:
<comment>Description:</comment>
  Cambia el estado actual del uso del búfer para objetos grandes
  
  Establece el uso del búfer para objetos grandes, dependiendo del valor del parámetro <strong>$on_off</strong>.
  
  El uso de esta función podría proporcionar mejoras en el rendimiento mediante el almacenamiento en
  búfer de lecturas y escrituras pequeñas de LOBs, reduciendo del número de viajes de ida y vuelta
  de la red y las versiones del LOB.  Debería usarse <strong>OCILob::flush()</strong> para vaciar los búferes cuando
  se haya finalizado de trabajar con el objeto grande.

<comment>Param:</comment>
  <info></info>  <strong>$on_off</strong>  <info>true</info> para activarlo y <info>false</info> para desactivarlo.

<comment>Return:</comment>
  <info>bool</info>  Devuelve <info>true</info> en caso de éxito o <info>false</info> en caso de error. Repetidas llamadas a este método
        con la misma bandera devolverán <info>true</info>.

<comment>See Also:</comment>
   * 


id: OCILob::size
type: function
doc:
<comment>Description:</comment>
  Devuelve el tamaño de un objeto grande
  
  Obtiene el tamaño de un objeto grande.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve la longitud del valor del objeto grande  o <info>false</info> en caso de error. Los objetos
             vacíos tienen una longitud de cero.


id: OCILob::tell
type: function
doc:
<comment>Description:</comment>
  Devuelve la posición actual del puntero interno de un objeto grande
  
  Obtiene la posición actual del puntero interno de un LOB.

<comment>Return:</comment>
  <info>int|false</info>  Devuelve la posición actual del puntero interno de un LOB o <info>false</info> si ocurrió algún
             error.

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


id: OCILob::truncate
type: function
doc:
<comment>Description:</comment>
  Trunca un objeto grande
  
  Trunca un LOB.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  Si se proporciona, este método truncará el LOB en <strong>$length</strong> bytes. De lo contrario, lo
                eliminará por completo.

<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>
   * 


id: OCILob::write
type: function
doc:
<comment>Description:</comment>
  Escribe datos en un objeto grande
  
  Escribe los datos del parámetro <strong>$data</strong> en la posición actual del puntero interno del LOB.

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>    Los datos a escribir en el LOB.
  <info>int|null</info>  <strong>$length</strong>  Si se proporciona este parámetro, la escritura se dentendrá después de que se
                     hayan escrito <strong>$length</strong> bytes o se alcance el final de <strong>$data</strong>, lo que suceda
                     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>
   * 


id: OCILob::writeTemporary
type: function
doc:
<comment>Description:</comment>
  Escribe un objeto grande temporal
  
  Crea un objeto grande temporal y escribe los datos dados por <strong>$data</strong> en él.
  
  Debería usarse  al finalizar el uso de este objeto.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Los datos a escribir.
  <info></info>        <strong>$lob_type</strong>  Puede ser una de las siguientes constantes: <info>OCI_TEMP_BLOB</info> se utiliza para crear
                     BLOBs temporales <info>OCI_TEMP_CLOB</info> se utiliza para crear CLOBs temporales

<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>
   * 


id: OCILob::writeToFile
type: function
doc:
<comment>Description:</comment>
  Alias de OCILob::export
  
  Esta función es un alias de:  <strong>OCILob::export()</strong>.


id: OCI_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_fetch_all()</strong> y con <strong>oci_fetch_array()</strong> para obtener los resultados como un array
  asociativo.


id: OCI_BOTH
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_fetch_all()</strong> y con <strong>oci_fetch_array()</strong> para obtener los resultados como un array con
  índeces tanto asociativos como numéricos.


id: OCI_B_BFILE
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan BFILEs.


id: OCI_B_BIN
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> para vincular valores RAW.


id: OCI_B_BLOB
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan BLOBs.


id: OCI_B_BOL
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> para vincular una variable BOOLEAN de PL/SQL.


id: OCI_B_CFILEE
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan CFILEs.


id: OCI_B_CLOB
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan CLOBs.


id: OCI_B_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan cursores, previamente asignados con
  <strong>oci_new_descriptor()</strong>.


id: OCI_B_INT
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_array_by_name()</strong> para vincular arrays de tipo INTEGER.


id: OCI_B_NTY
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan tipos de datos con nombre. Nota: en PHP
  \< 5.0 se le denominaba <info>OCI_B_SQLT_NTY</info>.


id: OCI_B_NUM
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_array_by_name()</strong> para vincular arrays de tipo NUMBER.


id: OCI_B_ROWID
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_bind_by_name()</strong> cuando se vinculan ROWIDs.


id: OCI_COMMIT_ON_SUCCESS
type: constant
doc:
<comment>Description:</comment>
  El modo de ejecución de sentencias para <strong>oci_execute()</strong>. Automáticamente consolida los cambios
  cuando la sentencia ha tenido éxito.


id: OCI_CRED_EXT
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_connect()</strong> para utilizar la autenticación externa de Oracle o la del SO. Introducida
  en PHP 5.3 y PECL OCI8 1.3.4.


id: OCI_DESCRIBE_ONLY
type: constant
doc:
<comment>Description:</comment>
  Modo de ejecución de sentencias para <strong>oci_execute()</strong>. Se ha de usar este modo si se quieren obtener
  metadatos tales como los nombres de las columnas, pero no se desea obtener filas de la consulta.


id: OCI_DTYPE_FILE
type: constant
doc:
<comment>Description:</comment>
  Esta bandera indica a <strong>oci_new_descriptor()</strong> que inicialice un nuevo descriptor FILE.


id: OCI_DTYPE_LOB
type: constant
doc:
<comment>Description:</comment>
  Esta bandera indica a <strong>oci_new_descriptor()</strong> que inicialice un nuevo descriptor LOB.


id: OCI_DTYPE_ROWID
type: constant
doc:
<comment>Description:</comment>
  Esta bandera indica a <strong>oci_new_descriptor()</strong> que inicialice un nuevo descriptor ROWID.


id: OCI_EXACT_FETCH
type: constant
doc:
<comment>Description:</comment>
  Obsoleta. El modo de obtención de sentencias. Usada cuando la aplicación conoce de antemano
  exactamente cuántas filas se obtendrán. Este modo desactiva la precarga del modo de Oracle versión
  8 o posterior. El cursor es cancelado después de obtener las filas deseadas, lo que puede reducir
  el uso de recursos por parte del servidor.


id: OCI_NO_AUTO_COMMIT
type: constant
doc:
<comment>Description:</comment>
  Modo de ejecución de sentencias para <strong>oci_execute()</strong>. La transacción no se consolida automáticamente
  cuando se usa este modo. Para una mejor legibilidad en código nuevo, use este valor en lugar de la
  cosntante antigua y equivalente <info>OCI_DEFAULT</info>. Introducida en PHP 5.3.2 (PECL OCI8 1.4).


id: OCI_NUM
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_fetch_all()</strong> y con <strong>oci_fetch_array()</strong> para obtener los resultados como un array
  enumerado.


id: OCI_RETURN_LOBS
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_fetch_array()</strong> para obtener el valor de los datos del LOB en lugar del descriptor.


id: OCI_RETURN_NULLS
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_fetch_array()</strong> para obtener elementos de array vacíos si el valor de los elementos de
  la fila es <info>null</info>.


id: OCI_SYSDBA
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_connect()</strong> para conectarse con el privilegio SYSDBA. El ajuste de php.ini
  oci8.privileged_connect debería estar habilitado para poder usar esta constante.


id: OCI_SYSOPER
type: constant
doc:
<comment>Description:</comment>
  Usada con <strong>oci_connect()</strong> para conectarse con el privilegio SYSOPER. El ajuste de php.ini
  oci8.privileged_connect debería estar habilitado para poder usar esta constante.


id: OPENSSL_ALGO_MD2
type: constant
doc:
<comment>Description:</comment>
  A partir de PHP 5.2.13 y PHP 5.3.2, esta constante únicamete está disponible si PHP está compilado
  con soporte para MD2. Esto requiere pasar -DHAVE_OPENSSL_MD2_H CFLAG al compilar PHP, y enable-md2
  al compilar OpenSSL 1.0.0+.


id: OPENSSL_ALGO_SHA1
type: constant
doc:
<comment>Description:</comment>
  Usado como algoritmo predeterminado por <strong>openssl_sign()</strong> y <strong>openssl_verify()</strong>.


id: OPENSSL_KEYTYPE_EC
type: constant
doc:
<comment>Description:</comment>
  Esta constante únicamente está disponible cuando PHP está compilado con OpenSSL 0.9.8+.


id: OP_HALFOPEN
type: constant
doc:
<comment>Description:</comment>
  Para nombres IMAP y NNTP, abre una conexion, pero no abre un buzón.


id: OuterIterator
type: class
doc:
<comment>Description:</comment>
  Las clases que implementan <class>OuterIterator</class> pueden ser usadas para iterar sobre iteradores.


id: OuterIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  Devuelve el iterador interno de la entrada actual
  
  Devuelve el iterador interno de la entrada actual.

<comment>Return:</comment>
  <info>Iterator</info>  El iterador interno de la entrada actual.


id: PASSWORD_ARGON2I
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2I</info> se utiliza para crear una nuevos hashes de contraseña mediante el algoritmo
  Argon2.
  
  Opciones admitidas:
  
  <return>memory_cost</return> (<info>integer</info>) - Máximo de memoria (en bytes) que puede ser usado para calcular el hash
  Argon2. Por defecto es <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info>.
  
  <return>time_cost</return> (<info>integer</info>) - Máximo de tiempo que puede ser usado para calcular el hash Argon2. Por
  defecto es <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info>.
  
  <return>threads</return> (<info>integer</info>) - Número de hilos a utilizar para calcular el hash Argon2. Por defecto es
  <info>PASSWORD_ARGON2_DEFAULT_THREADS</info>.
  
  Disponible desde PHP 7.2.0.


id: PASSWORD_ARGON2_DEFAULT_MEMORY_COST
type: constant
doc:
<comment>Description:</comment>
  Cantidad de memoria en bytes por defecto que utilizará Argon2lib para tratar de calcular un hash.
  
  Disponible desde PHP 7.2.0.


id: PASSWORD_ARGON2_DEFAULT_THREADS
type: constant
doc:
<comment>Description:</comment>
  Número de hilos por defecto que utilizará Argon2lib.
  
  Disponible desde PHP 7.2.0.


id: PASSWORD_ARGON2_DEFAULT_TIME_COST
type: constant
doc:
<comment>Description:</comment>
  Cantidad de tiempo por defecto que utilizará Argon2lib para tratar de calcular un hash.
  
  Disponible desde PHP 7.2.0.


id: PASSWORD_BCRYPT
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_BCRYPT</info> se utiliza para crear nuevos hash de contraseñas empleando el algoritmo
  <info>CRYPT_BLOWFISH</info>.
  
  Siempre resultará en un hash que utiliza el formato criptgráfico "$2y$",  el cual siempre tiene un
  ancho de 60.
  
  Opciones admitidas:
  
  <return>salt</return> (<info>string</info>) - para proporcionar manualmente una sal cuando se realiza el hash de la contraseña.
  Observe que esto sobrescribirá, previniendo así que se genere una sal automáticamente.
  
  Si se omite, se generará una sal aleatoria mediante <strong>password_hash()</strong> para cada contraseña con hash.
  Este es el modo de operación previsto y a partir de PHP 7.0.0 la opción salt ha sido marcada como
  obsoleta.
  
  <return>cost</return> (<info>integer</info>) - el cual denota el coste algorítmico que debería utilizarse. Se pueden encontrar
  ejemplos de estos valores en la página de <strong>crypt()</strong>.
  
  Si se omite, se usará un valor predeterminado de <return>10</return>. Este es un buen coste base, aunque se podría
  considerar aumentarlo dependiendo del hardware utilizado.


id: PASSWORD_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  El algoritmo que se utilizará por defecto si no se especifica otro distinto. Esto puede cambiar en
  versiones futuras de PHP, cuando métodos más nuevos y fuertes de hashing estén disponibles.
  
  Cabe señalar que con el tiempo esta constante puede (y probablemente lo hará) cambiar. Por tanto,
  se debería considerar que la longitud del hash resultante puede cambiar. Así, si se emplea
  <info>PASSWORD_DEFAULT</info> se debería almacenar el hash resultante de forma que se pueda almacenar más de 60
  caracteres (255 es el ancho recomendado).
  
  Valores para esta constante:
  
  PHP 5.5.0 - <info>PASSWORD_BCRYPT</info>


id: PCRE_VERSION
type: constant
doc:
<comment>Description:</comment>
  Versión y fecha de distribución de PCRE (p.ej. "<return>7.0 18-Dec-2006</return>").
  
  5.2.4


id: PDO
type: class
doc:
<comment>Description:</comment>
  Representa una conexión entre PHP y un servidor de bases de datos.


id: PDO::ATTR_AUTOCOMMIT
type: constant
doc:
<comment>Description:</comment>
  Si este valor es <info>false</info>, PDO intenta desactivar la autoconsigna para que la conexión comience una
  transacción.


id: PDO::ATTR_CASE
type: constant
doc:
<comment>Description:</comment>
  Forzar a los nombres de las columnas a emplear las mayúsculas/minúsculas especificadas por las
  constantes <info>PDO::CASE_*</info>.


id: PDO::ATTR_CLIENT_VERSION
type: constant
doc:
<comment>Description:</comment>
  Este es un atributo de sólo lectura; devuelve información sobre la versión de las bibliotecas
  cliente que está usando el controlador PDO.


id: PDO::ATTR_CURSOR
type: constant
doc:
<comment>Description:</comment>
  Selecciona el tipo de cursor. PDO actualmente admite <info>PDO::CURSOR_FWDONLY</info> y <info>PDO::CURSOR_SCROLL</info>.
  Cíñase a <info>PDO::CURSOR_FWDONLY</info> a menos que necesite un cursor desplazable.


id: PDO::ATTR_CURSOR_NAME
type: constant
doc:
<comment>Description:</comment>
  Obtener o establecer el nombre del cursor a utilizar. Es más útil cuando se emplean cursores
  desplazables y actualizaciones posicionadas.


id: PDO::ATTR_DRIVER_NAME
type: constant
doc:
<comment>Description:</comment>
  Devuelve el nombre del controlador.
  
  Uso de <info>PDO::ATTR_DRIVER_NAME</info>getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') { echo "Ejecutándose
  sobre mysql; hacer algo específico de mysql aquí\n";
  }
  ?>
  ]]>


id: PDO::ATTR_ERRMODE
type: constant
doc:
<comment>Description:</comment>
  Véase la sección Errores y su manejo para obtener más información sobre este atributo.


id: PDO::ATTR_FETCH_CATALOG_NAMES
type: constant
doc:
<comment>Description:</comment>
  Anteponer el nombre del catálogo contenedor a cada nombre de columna devuelto en el conjunto de
  resultados. El nombre del catálogo y el nombre de columna están separados por un carácter punto
  (.). El soporte de este atributo es a nivel del controlador; podría no estar admitido por el
  controlador que se esté utilizando.


id: PDO::ATTR_FETCH_TABLE_NAMES
type: constant
doc:
<comment>Description:</comment>
  Anteponer el nombre de la tabla contenedora a cada nombre de columna devuelto en el conjunto de
  resultados. El nombre de la tabla y el nombre de columna están separados por un carácter punto
  (.). El soporte de este atributo es a nivel del controlador; podría no estar admitido por el
  controlador que se esté utilizando.


id: PDO::ATTR_ORACLE_NULLS
type: constant
doc:
<comment>Description:</comment>
  Convertir string vacíos a valores NULL de SQL en la obtención de datos.


id: PDO::ATTR_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Solicitar una conexión persistente, en vez de crear una nueva conexión. Véase Conexiones y su
  administración para obtener más información sobre este atributo.


id: PDO::ATTR_PREFETCH
type: constant
doc:
<comment>Description:</comment>
  Establecer el tamaño de la precarga permite obtener un equilibrio entre rapidez y utilización de
  memoria para la aplicación. No todas las combinaciones de base de datos y controlador permiten
  establecer el tamaño de la precarga. Un valor más grande de precarga da como resultado un aumento
  del rendimiento a costa de un mayor uso de memoria.


id: PDO::ATTR_SERVER_INFO
type: constant
doc:
<comment>Description:</comment>
  Este es un atributo de sólo lectura; devuelve alguna metainformación sobre el servidor de bases de
  datos al que está conectado PDO.


id: PDO::ATTR_SERVER_VERSION
type: constant
doc:
<comment>Description:</comment>
  Este es un atributo de sólo lectura; devuelve información sobre la versión del servidor de bases
  de datos al que está conectado PDO.


id: PDO::ATTR_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  Establece el valor del tiempo de espera, en segundos, para las comunicaciones con la base de
  datos.


id: PDO::CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Dejar los nombres de las columnas tal como son devueltos por el controlador de la base de datos.


id: PDO::CURSOR_FWDONLY
type: constant
doc:
<comment>Description:</comment>
  Crear un objeto <class>PDOStatement</class> con un cursor de sólo avance. Este es la elección del cursor
  predeterminada, ya que es el patrón de acceso a datos más rápido y común en PHP.


id: PDO::CURSOR_SCROLL
type: constant
doc:
<comment>Description:</comment>
  Crear un objeto <class>PDOStatement</class> con un cursor desplazable. De deben pasar las constantes
  <info>PDO::FETCH_ORI_*</info> para controlar las filas obtenidas del conjunto de resultados.


id: PDO::ERRMODE_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  Lanzar una <class>PDOException</class> si ocurre algún error. Véase Errores y su manejo para obtener más
  información sobre este atributo.


id: PDO::ERRMODE_SILENT
type: constant
doc:
<comment>Description:</comment>
  No emitir ningún error o excepción si ocurrieran. El desarrollador es responsable de comprobar
  explícitamente los errores. Este es el modo predeterminado. Véase Errores y su manejo para obtener
  más información sobre este atributo.


id: PDO::ERRMODE_WARNING
type: constant
doc:
<comment>Description:</comment>
  Emitir un mensaje <info>E_WARNING</info> de PHP si ocurre algún error. Véase Errores y su manejo para obtener
  más información sobre este atributo.


id: PDO::ERR_NONE
type: constant
doc:
<comment>Description:</comment>
  Corresponde al SQLSTATE '00000', el cual significa que la sentencia SQL fue ejecutada con éxito,
  sin errores ni advertencias. Esta constante sirve para la comprobación de <strong>PDO::errorCode()</strong> o
  <strong>PDOStatement::errorCode()</strong> para determinar si ha ocurrido algún error. En cualquier caso,
  normalmente se sabrá si este es el caso examinando el código devuelto por el método que provocó la
  condición de error.


id: PDO::FB_ATTR_TIMESTAMP_FORMAT
type: constant
doc:
<comment>Description:</comment>
  Establece el formato de marca de tiempo.
  
  Disponible desde PHP 5.3.0.


id: PDO::FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un array indexado por los
  nombres de las columnas devueltos en el correspondiente conjunto de resultados. Si éste contiene
  varias columnas con el mismo nombre, <info>PDO::FETCH_ASSOC</info> devuelve un único valor por nombre de
  columna.


id: PDO::FETCH_BOTH
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un array indexado tanto por los
  nombres como por los números de las columnas devueltos en el correspondiente conjunto de
  resultados, comenzando por la columna 0.


id: PDO::FETCH_BOUND
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver TRUE y asignar los valores de las columnas del
  conjunto de resultados a las variables de PHP a las cuales están vinculadas con los métodos
  <strong>PDOStatement::bindParam()</strong> o <strong>PDOStatement::bindColumn()</strong>.


id: PDO::FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver una nueva instancia de la clase solicitada,
  haciendo corresponder las columnas con los nombres de las propiedades de la clase.
  
  El método mágico __set se invoca si la propiedad no existe en la clase solicitada.


id: PDO::FETCH_CLASSTYPE
type: constant
doc:
<comment>Description:</comment>
  Determinar el nombre de la clase desde el valor de la primera columna.


id: PDO::FETCH_COLUMN
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver una única columna solicitada de la siguiente
  fila del conjunto de resultados.


id: PDO::FETCH_FUNC
type: constant
doc:
<comment>Description:</comment>
  Permite personalizar completamente la forma en que los datos son tratados sobre la marcha
  (únicamente válida dentro de <strong>PDOStatement::fetchAll()</strong>).


id: PDO::FETCH_GROUP
type: constant
doc:
<comment>Description:</comment>
  Grupo devuelto según valores. Usualmente combinada con <info>PDO::FETCH_COLUMN</info> o <info>PDO::FETCH_KEY_PAIR</info>.


id: PDO::FETCH_INTO
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtencion debe actualizar una instancia existente de la clase
  solicitada, haciendo corresponder las columnas con los nombres de las propiedades de la clase.


id: PDO::FETCH_KEY_PAIR
type: constant
doc:
<comment>Description:</comment>
  Obtener un resultado de dos columnas como un array donde la primera columna es la clave y la
  segunda el valor. Disponible desde PHP 5.2.3.


id: PDO::FETCH_LAZY
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un objeto con los nombres de
  las variables equivalentes a los nombres de las columnas devueltos en el conjunto de resultados.
  <info>PDO::FETCH_LAZY</info> crea los nombres de las variables del objeto a medida que se acceden a ellas. No
  es válida dentro de <strong>PDOStatement::fetchAll()</strong>.


id: PDO::FETCH_NAMED
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un array indexado por los
  nombres de las columnas devueltos en el correspondiente conjunto de resultados. Si éste contiene
  varias columnas con el mismo nombre, <info>PDO::FETCH_NAMED</info> devuelve un array de valores por nombre de
  columna.


id: PDO::FETCH_NUM
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un array indexado por los
  números de columna devueltos en el correspondiente conjunto de resultados, comenzando por la
  columna 0.


id: PDO::FETCH_OBJ
type: constant
doc:
<comment>Description:</comment>
  Especifica que el método de obtención debe devolver cada fila como un objeto con los nombres de
  sus propiedades equivalentes a los nombres de las columnas devueltos en el conjunto de resultados.


id: PDO::FETCH_ORI_ABS
type: constant
doc:
<comment>Description:</comment>
  Obtener la fila solicitada del conjunto de resultados mediante el número de fila. Únicamente
  válida para cursores desplazables.


id: PDO::FETCH_ORI_FIRST
type: constant
doc:
<comment>Description:</comment>
  Obtener la primera fila del conjunto de resultados. Únicamente válida para cursores desplazables.


id: PDO::FETCH_ORI_LAST
type: constant
doc:
<comment>Description:</comment>
  Obtener la última fila del conjunto de resultados. Únicamente válida para cursores desplazables.


id: PDO::FETCH_ORI_NEXT
type: constant
doc:
<comment>Description:</comment>
  Obtener la siguiente fila del conjunto de resultados. Únicamente válida para cursores
  desplazables.


id: PDO::FETCH_ORI_PRIOR
type: constant
doc:
<comment>Description:</comment>
  Obtener la fila anterior del conjunto de resultados. Únicamente válida para cursores desplazables.


id: PDO::FETCH_ORI_REL
type: constant
doc:
<comment>Description:</comment>
  Obtener la fila solicitada del conjunto de resultados mediante la posición relativa de la posición
  actual del cursor. Únicamente válida para cursores desplazables.


id: PDO::FETCH_PROPS_LATE
type: constant
doc:
<comment>Description:</comment>
  Llamar al contructor antes de establecer propiedades. Disponible desde PHP 5.2.0


id: PDO::FETCH_SERIALIZE
type: constant
doc:
<comment>Description:</comment>
  Igual que <info>PDO::FETCH_INTO</info> salvo que el objeto es proporcionado como una cadena serializada.
  Disponible desde PHP 5.1.0. Desde PHP 5.3.0, nunca se llama al constructor de la clase si está
  establecido este indicador.


id: PDO::MYSQL_ATTR_MULTI_STATEMENTS
type: constant
doc:
<comment>Description:</comment>
  Inhabilita la ejecución de multiconsultas tanto en <strong>PDO::prepare()</strong> como en <strong>PDO::query()</strong> cuando se
  setablece a <info>false</info>.
  
  Observe que esta constante solamente se puede emplear en el array <strong>$driver_options</strong>  al construir un
  nuevo manejador de base de datos.
  
  Existe a partir de PHP  5.5.21 y PHP 5.6.5.


id: PDO::MYSQL_ATTR_SSL_CIPHER
type: constant
doc:
<comment>Description:</comment>
  Una lista de uno o más cifradores permisibles a usar para la encriptación SSL, en un formato
  entendido por OpenSSL. Por ejemplo: <return>DHE-RSA-AES256-SHA:AES128-SHA</return>
  
  Existe a partir de PHP  5.3.7.


id: PDO::MYSQL_ATTR_SSL_KEY
type: constant
doc:
<comment>Description:</comment>
  La ruta al fichero de la clave SSL.
  
  Existe a partir de PHP  5.3.7.


id: PDO::PARAM_EVT_EXEC_POST
type: constant
doc:
<comment>Description:</comment>
  Evento provocado después de la ejecución de una sentencia preparada.


id: PDO::PARAM_EVT_EXEC_PRE
type: constant
doc:
<comment>Description:</comment>
  Evento provocado antes de la ejecución de una sentencia preparada.


id: PDO::PARAM_EVT_FETCH_POST
type: constant
doc:
<comment>Description:</comment>
  Evento provocado después de la obtención de un resultado de un conjunto de resultados.


id: PDO::PARAM_EVT_FETCH_PRE
type: constant
doc:
<comment>Description:</comment>
  Evento provocado antes de la obtención de un resultado de un conjunto de resultados.


id: PDO::PARAM_EVT_NORMALIZE
type: constant
doc:
<comment>Description:</comment>
  Evento provocado durante el registro de un parámetro vinculado, permitiendo al controlador
  normalizar el nombre del parámetro.


id: PDO::PARAM_INPUT_OUTPUT
type: constant
doc:
<comment>Description:</comment>
  Especifica que el parámetro es de entrada/salida (INOUT) para un procedimiento almacenado. Se debe
  realizar un OR a nivel de bit con un tipo de datos PDO::PARAM_* explícito.


id: PDO::PARAM_STMT
type: constant
doc:
<comment>Description:</comment>
  Representa un tipo de conjunto de registros. No está soportado actualmente por ningún controlador.


id: PDO::PARAM_STR
type: constant
doc:
<comment>Description:</comment>
  Representa el tipo de dato CHAR, VARCHAR de SQL, u otro tipo de datos de cadena.


id: PDO::SQLSRV_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  Indicates that a query should be executed directly, without being prepared.  This constant can be
  passed to PDO::setAttribute, and PDO::prepare. For more  information, see  Direct and Prepared
  Statement Execution.


id: PDO::SQLSRV_ATTR_QUERY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  A non-negative integer representing the timeout period, in seconds. Zero (0)  is the default and
  means no timeout. This constant can be passed to  PDOStatement::setAttribute, PDO::setAttribute,
  and PDO::prepare.


id: PDO::SQLSRV_ENCODING_BINARY
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved as a raw byte stream to/from the server  without performing
  encoding or translation. This constant can be passed to  PDOStatement::setAttribute, PDO::prepare,
  PDOStatement::bindColumn, and  PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server according to  PDO::SQLSRV_ENCODING_SYSTEM
  if specified during connection. The connection's  encoding is used if specified in a prepare
  statement. This constant can be  passed to PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_SYSTEM
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server as 8-bit characters  as specified in the
  code page of the Windows locale that is set on the system.  Any multi-byte characters or
  characters that do not map into this code page  are substituted with a single byte question mark
  (?) character. This constant  can be passed to PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_ENCODING_UTF8
type: constant
doc:
<comment>Description:</comment>
  Specifies that data is sent/retrieved to/from the server in UTF-8 encoding.  This is the default
  encoding. This constant can be passed to  PDOStatement::setAttribute, PDO::setAttribute,
  PDO::prepare,  PDOStatement::bindColumn, and PDOStatement::bindParam.


id: PDO::SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  Esta constante es un valor aceptable para la clave TransactionIsolation del DSN de SQLSRV.  Esta
  constante establece el nivel de aislamiento para la conexión a Read Committed.


id: PDO::SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  Esta constante es un valor aceptable para la clave TransactionIsolation del DSN de SQLSRV.  Esta
  constante establece el nivel de aislamiento para la conexión a Read Uncommitted.


id: PDO::SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  Esta constante es un valor aceptable para la clave TransactionIsolation del DSN de SQLSRV.  Esta
  constante establece el nivel de aislamiento para la conexión a Repeateable Read.


id: PDO::SQLSRV_TXN_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  Esta constante es un valor aceptable para la clave TransactionIsolation del DSN de SQLSRV.  Esta
  constante establece el nivel de aislamiento para la conexión a Serializable.


