# php_manual

id: MongoDB\BSON\TimestampInterface::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Returns the timestamp component of this TimestampInterface

<comment>Return:</comment>
  <info>int</info>  Returns the timestamp component of this TimestampInterface.
       
       On 32-bit systems this method may return a negative number. Although the increment and
       timestamp parts of the BSON timestamp type consists of two unsigned 32-bit values, PHP can
       not represent these on 32-bit platforms.

<comment>See Also:</comment>
   * MongoDB\BSON\Timestamp::getTimestamp


id: MongoDB\BSON\UTCDateTime
type: class
doc:
<comment>Description:</comment>
  Represents a BSON date. The value is a 64-bit integer that represents the number of milliseconds
  since the Unix epoch (Jan 1, 1970). Negative values represent dates before 1970.


id: MongoDB\BSON\UTCDateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new UTCDateTime

<comment>Param:</comment>
  <info>int|float|string|DateTimeInterface|null</info>  <strong>$milliseconds</strong>  Number of milliseconds since the Unix
                                                          epoch (Jan 1, 1970). Negative values
                                                          represent dates before 1970. This value
                                                          may be provided as a 64-bit <info>int</info>. For
                                                          compatibility on 32-bit systems, this
                                                          parameter may also be provided as a <info>float</info>
                                                          or <info>string</info>.
                                                          
                                                          If the argument is a <class>DateTimeInterface</class>,
                                                          the number of milliseconds since the Unix
                                                          epoch will be derived from that value.
                                                          
                                                          If this argument is <info>null</info>, the current time
                                                          will be used by default.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this UTCDateTime

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this UTCDateTime.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\UTCDateTime</class>.
         
         A saída é consistente com a função <strong>MongoDB\BSON\toJSON()</strong>, que usa o formato JSON estendido
         legado específico do driver. Isso não corresponde necessariamente às representações JSON
         estendidas relaxadas ou canônicas usadas por <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> e
         <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>, respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\UTCDateTime::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a UTCDateTime

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

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


id: MongoDB\BSON\UTCDateTime::toDateTime
type: function
doc:
<comment>Description:</comment>
  Returns the DateTime representation of this UTCDateTime

<comment>Return:</comment>
  <info>DateTime</info>  Returns the <class>DateTime</class> representation of this UTCDateTime. The returned <class>DateTime</class> will use
            the UTC time zone.

<comment>See Also:</comment>
   * BSON Types: Date


id: MongoDB\BSON\UTCDateTime::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a UTCDateTime

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

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


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


id: MongoDB\BSON\UTCDateTimeInterface::__toString
type: function
doc:
<comment>Description:</comment>
  Returns the string representation of this UTCDateTimeInterface

<comment>Return:</comment>
  <info>string</info>  Returns the string representation of this UTCDateTimeInterface.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::__toString


id: MongoDB\BSON\UTCDateTimeInterface::toDateTime
type: function
doc:
<comment>Description:</comment>
  Returns the DateTime representation of this UTCDateTimeInterface

<comment>Return:</comment>
  <info>DateTime</info>  Returns the <class>DateTime</class> representation of this UTCDateTimeInterface. The returned <class>DateTime</class>
            should use the UTC time zone.

<comment>See Also:</comment>
   * MongoDB\BSON\UTCDateTime::toDateTime


id: MongoDB\BSON\Undefined
type: class
doc:
<comment>Description:</comment>
  BSON type for the "Undefined" type. This BSON type is deprecated, and this class can not be
  instantiated. It will be created from a BSON undefined type while converting BSON to PHP, and can
  also be converted back into BSON while storing documents in the database.


id: MongoDB\BSON\Undefined::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Undefined (unused)
  
  <class>MongoDB\BSON\Undefined</class> objects are created through conversion from a deprecated BSON type and
  cannot be constructed directly.

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


id: MongoDB\BSON\Undefined::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON

<comment>Return:</comment>
  <info>mixed</info>  Returns data which can be serialized by <strong>json_encode()</strong> to produce an extended JSON
         representation of the <class>MongoDB\BSON\Undefined</class>.
         
         A saída é consistente com a função <strong>MongoDB\BSON\toJSON()</strong>, que usa o formato JSON estendido
         legado específico do driver. Isso não corresponde necessariamente às representações JSON
         estendidas relaxadas ou canônicas usadas por <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong> e
         <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>, respectivamente.

<comment>See Also:</comment>
   * JsonSerializable::jsonSerialize
   * <strong>json_encode()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON


id: MongoDB\BSON\Undefined::serialize
type: function
doc:
<comment>Description:</comment>
  Serialize a Undefined

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

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


id: MongoDB\BSON\Undefined::unserialize
type: function
doc:
<comment>Description:</comment>
  Unserialize a Undefined

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

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MongoDB\BSON\Unserializable
type: class
doc:
<comment>Description:</comment>
  Classes that implement this interface may be specified in a type map for unserializing BSON arrays
  and documents (both root and embedded).


id: MongoDB\BSON\Unserializable::bsonUnserialize
type: function
doc:
<comment>Description:</comment>
  Constructs the object from a BSON array or document
  
  Called during unserialization of the object from BSON. The properties of the BSON array or
  document will be passed to the method as an <info>array</info>.
  
  Remember to check for an _id property when handling data from a BSON document.
  
  This method acts as the constructor of the object. The __construct() method will not be called
  after this method.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Properties within the BSON array or document.

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

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\Serializable::bsonSerialize()</strong>
   * MongoDB\BSON\Persistable
   * 


id: MongoDB\BSON\fromJSON
type: function
doc:
<comment>Description:</comment>
  Returns the BSON representation of a JSON value
  
  Converts an extended JSON string to its BSON representation.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>  JSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The serialized BSON document as a binary string.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * <strong>MongoDB\BSON\toJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\fromPHP
type: function
doc:
<comment>Description:</comment>
  Returns the BSON representation of a PHP value
  
  Serializes a PHP array or object (e.g. document) to its BSON representation. The returned binary
  string will describe a BSON document.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$value</strong>  PHP value to be serialized.

<comment>Return:</comment>
  <info>string</info>  The serialized BSON document as a binary string.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromPHP
   * <strong>MongoDB\BSON\toPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toCanonicalExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Canonical Extended JSON representation of a BSON value
  
  Converts a BSON string to its Canonical Extended JSON representation. The canonical format prefers
  type fidelity at the expense of concise output and is most suited for producing output that can be
  converted back to BSON without any loss of type information (e.g. numeric types will remain
  differentiated).

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toCanonicalExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * Extended JSON Specification
   * MongoDB BSON


id: MongoDB\BSON\toJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Legacy Extended JSON representation of a BSON value
  
  Converts a BSON string to its Legacy Extended JSON representation.
  
  There exist several JSON formats for representing BSON. This function implements the "strict mode"
  defined in MongoDB Extended JSON, which has been superseded by the canonical and relaxed formats
  defined in the Extended JSON Specification and implemented by
  <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> and <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>, respectively.
  
  JSON does not support <info>NAN</info> and <info>INF</info> and MongoDB's Legacy Extended JSON format does not define an
  alternative representation for these values (libbson will output <return>nan</return> and <return>inf</return> literals, which may
  not be parsed as valid JSON). If you are working with BSON that may contain non-finite numbers,
  please use <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong> or <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * <strong>MongoDB\BSON\toRelaxedExtendedJSON()</strong>
   * MongoDB Extended JSON
   * MongoDB BSON


id: MongoDB\BSON\toPHP
type: function
doc:
<comment>Description:</comment>
  Returns the PHP representation of a BSON value
  
  Unserializes a BSON document (i.e. binary string) to its PHP representation. The <strong>$typeMap</strong>
  paramater may be used to control the PHP types used for converting BSON arrays and documents (both
  root and embedded).
  
  Os documentos BSON tecnicamente podem conter chaves duplicadas porque os documentos são
  armazenados como uma lista de pares chave-valor; no entanto, as aplicações devem evitar a geração
  de documentos com chaves duplicadas, pois o comportamento do servidor e do driver pode ser
  indefinido. Como os objetos e arrays do PHP não podem ter chaves duplicadas, os dados também podem
  ser perdidos ao decodificar um documento BSON com chaves duplicadas.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>     BSON value to be unserialized.
  <info>array</info>   <strong>$typeMap</strong>  Configuração de mapeamento de tipos.

<comment>Return:</comment>
  <info>array|object</info>  The unserialized PHP value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::toPHP
   * <strong>MongoDB\BSON\fromPHP()</strong>
   * MongoDB BSON
   * 


id: MongoDB\BSON\toRelaxedExtendedJSON
type: function
doc:
<comment>Description:</comment>
  Returns the Relaxed Extended JSON representation of a BSON value
  
  Converts a BSON string to its Relaxed Extended JSON representation. The relaxed format prefers use
  of JSON type primitives at the expense of type fidelity and is most suited for producing output
  that can be easily consumed by web APIs and humans.

<comment>Param:</comment>
  <info>string</info>  <strong>$bson</strong>  BSON value to be converted.

<comment>Return:</comment>
  <info>string</info>  The converted JSON value.

<comment>See Also:</comment>
   * MongoDB\BSON\Document::fromJSON
   * MongoDB\BSON\Document::toRelaxedExtendedJSON
   * <strong>MongoDB\BSON\fromJSON()</strong>
   * <strong>MongoDB\BSON\toCanonicalExtendedJSON()</strong>
   * Extended JSON 
   * MongoDB BSON


id: MongoDB\Driver\BulkWrite
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\BulkWrite</class> collects one or more write operations that should be sent to the
  server. After adding any number of insert, update, and delete operations, the collection may be
  executed via MongoDB\Driver\Manager::executeBulkWrite.
  
  Write operations may either be ordered (default) or unordered. Ordered write operations are sent
  to the server, in the order provided, for serial execution. If a write fails, any remaining
  operations will be aborted. Unordered operations are sent to the server in an arbitrary order
  where they may be executed in parallel. Any errors that occur are reported after all operations
  have been attempted.


id: MongoDB\Driver\BulkWrite::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new BulkWrite
  
  Constructs a new <class>MongoDB\Driver\BulkWrite</class>, which is a mutable object to which one or more write
  operations may be added. The write(s) may then be executed with
  MongoDB\Driver\Manager::executeBulkWrite.

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  optionsOptionTypeDescriptionDefaultbypassDocumentValidation<info>bool</info> If <info>true</info>,
                        allows insert and update operations to circumvent document level validation.
                        This option is available in MongoDB 3.2+ and is ignored for older server
                        versions, which do not support document level validation. <info>false</info>comment<info>mixed</info>
                        An arbitrary comment to help trace the operation through the database
                        profiler, currentOp output, and logs.  This option is available in MongoDB
                        4.4+ and will result in an exception at execution time if specified for an
                        older server version. let<info>array</info><info>object</info></info> Mapa de nomes e valores de parâmetros.
                        Os valores devem ser expressões constantes ou fechadas que não fazem
                        referência a campos do documento. Os parâmetros podem então ser acessados
                        como variáveis em um contexto de expressão agregada (por exemplo, <return>$$var</return>).
                        Esta opção está disponível no MongoDB 5.0+ e resultará em uma exceção em
                        tempo de execução se for especificada para uma versão de servidor mais
                        antiga. ordered<info>bool</info> Ordered operations (<info>true</info>) are executed serially on the
                        MongoDB server, while unordered operations (<info>false</info>) are sent to the server in
                        an arbitrary order and may be executed in parallel. <info>true</info>
                        
                        If <info>true</info>, allows insert and update operations to circumvent document level
                        validation.
                        
                        This option is available in MongoDB 3.2+ and is ignored for older server
                        versions, which do not support document level validation.
                        
                        An arbitrary comment to help trace the operation through the database
                        profiler, currentOp output, and logs.
                        
                        This option is available in MongoDB 4.4+ and will result in an exception at
                        execution time if specified for an older server version.
                        
                        Mapa de nomes e valores de parâmetros. Os valores devem ser expressões
                        constantes ou fechadas que não fazem referência a campos do documento. Os
                        parâmetros podem então ser acessados como variáveis em um contexto de
                        expressão agregada (por exemplo, <return>$$var</return>).
                        
                        Esta opção está disponível no MongoDB 5.0+ e resultará em uma exceção em
                        tempo de execução se for especificada para uma versão de servidor mais
                        antiga.

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


id: MongoDB\Driver\BulkWrite::count
type: function
doc:
<comment>Description:</comment>
  Count number of write operations in the bulk
  
  Returns the number of write operations added to the <class>MongoDB\Driver\BulkWrite</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns number of write operations added to the <class>MongoDB\Driver\BulkWrite</class> object.


id: MongoDB\Driver\BulkWrite::delete
type: function
doc:
<comment>Description:</comment>
  Add a delete operation to the bulk
  
  Adds a delete operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         O predicado de consulta. Um predicado vazio corresponderá a todos os
                                documentos da coleção.
                                
                                Ao avaliar os critérios de consulta, o MongoDB compara os tipos e
                                valores de acordo com suas próprias regras de comparação para tipos
                                BSON, que diferem das regras de comparação e do malabarismo de tipos
                                do PHP. Ao corresponder a um tipo especial de BSON, os critérios de
                                consulta devem usar a respectiva classe BSON (por exemplo, use
                                <class>MongoDB\BSON\ObjectId</class> para corresponder a um ObjectId).
  <info>array|null</info>    <strong>$deleteOptions</strong>  
                                deleteOptionsOptionTypeDescriptionDefaultcollation<info>array</info><info>object</info></info>Collation
                                permite que os usuários especifiquem regras específicas do idioma
                                para comparação de strings, como regras para maiúsculas e minúsculas
                                e acentos. Ao especificar a collation, o campo <return>"locale"</return> é
                                obrigatório; todos os outros campos de collation são opcionais. Para
                                obter descrições dos campos, veja o Documento de Collation.  Se a
                                collation não for especificada, mas a coleção tiver uma collation
                                padrão, a operação usará a collation especificada para a coleção. Se
                                nenhuma collation for especificada para a coleção ou para a
                                operação, o MongoDB usará a comparação binária simples usada em
                                versões anteriores para comparações de strings.  Esta opção está
                                disponível no MongoDB 3.4+ e resultará em uma exceção em tempo de
                                execução se for especificada para uma versão de servidor mais
                                antiga. 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.  This option is available in MongoDB 4.4+ and will result in
                                an exception at execution time if specified for an older server
                                version. limit<info>bool</info>Delete all matching documents (<info>false</info>), or only the
                                first matching document (<info>true</info>)<info>false</info>
                                
                                Collation permite que os usuários especifiquem regras específicas do
                                idioma para comparação de strings, como regras para maiúsculas e
                                minúsculas e acentos. Ao especificar a collation, o campo <return>"locale"</return> é
                                obrigatório; todos os outros campos de collation são opcionais. Para
                                obter descrições dos campos, veja o Documento de Collation.
                                
                                Se a collation não for especificada, mas a coleção tiver uma
                                collation padrão, a operação usará a collation especificada para a
                                coleção. Se nenhuma collation for especificada para a coleção ou
                                para a operação, o MongoDB usará a comparação binária simples usada
                                em versões anteriores para comparações de strings.
                                
                                Esta opção está disponível no MongoDB 3.4+ e resultará em uma
                                exceção em tempo de execução se for especificada para uma versão de
                                servidor mais antiga.
                                
                                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.
                                
                                This option is available in MongoDB 4.4+ and will result in an
                                exception at execution time if specified for an older server
                                version.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MongoDB\Driver\BulkWrite::insert
type: function
doc:
<comment>Description:</comment>
  Add an insert operation to the bulk
  
  Adds an insert operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$document</strong>  A document to insert.

<comment>Return:</comment>
  <info>mixed</info>  Returns the <return>_id</return> of the inserted document. If the <strong>$document</strong> did not have an <return>_id</return>, the
         <class>MongoDB\BSON\ObjectId</class> generated for the insert will be returned.

<comment>See Also:</comment>
   * MongoDB\Driver\Manager::executeBulkWrite
   * <class>MongoDB\Driver\WriteResult</class>
   * <class>MongoDB\BSON\ObjectId</class>
   * MongoDB\BSON\Persistable


id: MongoDB\Driver\BulkWrite::update
type: function
doc:
<comment>Description:</comment>
  Add an update operation to the bulk
  
  Adds an update operation to the <class>MongoDB\Driver\BulkWrite</class>.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$filter</strong>         O predicado de consulta. Um predicado vazio corresponderá a todos os
                                documentos da coleção.
                                
                                Ao avaliar os critérios de consulta, o MongoDB compara os tipos e
                                valores de acordo com suas próprias regras de comparação para tipos
                                BSON, que diferem das regras de comparação e do malabarismo de tipos
                                do PHP. Ao corresponder a um tipo especial de BSON, os critérios de
                                consulta devem usar a respectiva classe BSON (por exemplo, use
                                <class>MongoDB\BSON\ObjectId</class> para corresponder a um ObjectId).
  <info>array|object</info>  <strong>$newObj</strong>         A document containing either update operators (e.g. <return>$set</return>), a
                                replacement document (i.e. only <return>field:value</return> expressions), or an
                                aggregation pipeline.
  <info>array|null</info>    <strong>$updateOptions</strong>  updateOptionsOptionTypeDescriptionDefaultarrayFilters<info>array</info> An array
                                of filter documents that determines which array elements to modify
                                for an update operation on an array field. See Specify arrayFilters
                                for Array Update Operations in the MongoDB manual for more
                                information.  This option is available in MongoDB 3.6+ and will
                                result in an exception at execution time if specified for an older
                                server version. collation<info>array</info><info>object</info></info>Collation permite que os
                                usuários especifiquem regras específicas do idioma para comparação
                                de strings, como regras para maiúsculas e minúsculas e acentos. Ao
                                especificar a collation, o campo <return>"locale"</return> é obrigatório; todos os
                                outros campos de collation são opcionais. Para obter descrições dos
                                campos, veja o Documento de Collation.  Se a collation não for
                                especificada, mas a coleção tiver uma collation padrão, a operação
                                usará a collation especificada para a coleção. Se nenhuma collation
                                for especificada para a coleção ou para a operação, o MongoDB usará
                                a comparação binária simples usada em versões anteriores para
                                comparações de strings.  Esta opção está disponível no MongoDB 3.4+
                                e resultará em uma exceção em tempo de execução se for especificada
                                para uma versão de servidor mais antiga. 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.  This option is available in
                                MongoDB 4.2+ and will result in an exception at execution time if
                                specified for an older server version. multi<info>bool</info> Update only the
                                first matching document if <info>false</info>, or all matching documents <info>true</info>.
                                This option cannot be <info>true</info> if <strong>$newObj</strong> is a replacement document.
                                <info>false</info>upsert<info>bool</info> If <strong>$filter</strong> does not match an existing document,
                                insert a single document. The document will be created from <strong>$newObj</strong>
                                if it is a replacement document (i.e. no update operators);
                                otherwise, the operators in <strong>$newObj</strong> will be applied to <strong>$filter</strong> to
                                create the new document. <info>false</info>
                                
                                An array of filter documents that determines which array elements to
                                modify for an update operation on an array field. See Specify
                                arrayFilters for Array Update Operations in the MongoDB manual for
                                more information.
                                
                                This option is available in MongoDB 3.6+ and will result in an
                                exception at execution time if specified for an older server
                                version.
                                
                                Collation permite que os usuários especifiquem regras específicas do
                                idioma para comparação de strings, como regras para maiúsculas e
                                minúsculas e acentos. Ao especificar a collation, o campo <return>"locale"</return> é
                                obrigatório; todos os outros campos de collation são opcionais. Para
                                obter descrições dos campos, veja o Documento de Collation.
                                
                                Se a collation não for especificada, mas a coleção tiver uma
                                collation padrão, a operação usará a collation especificada para a
                                coleção. Se nenhuma collation for especificada para a coleção ou
                                para a operação, o MongoDB usará a comparação binária simples usada
                                em versões anteriores para comparações de strings.
                                
                                Esta opção está disponível no MongoDB 3.4+ e resultará em uma
                                exceção em tempo de execução se for especificada para uma versão de
                                servidor mais antiga.
                                
                                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.
                                
                                This option is available in MongoDB 4.2+ and will result in an
                                exception at execution time if specified for an older server
                                version.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MongoDB\Driver\ClientEncryption
type: class
doc:
<comment>Description:</comment>
  The <class>MongoDB\Driver\ClientEncryption</class> class handles creation of data keys for client-side
  encryption, as well as manually encrypting and decrypting values.


id: MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for deterministic encryption, which is suitable for querying.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for an indexed, encrypted payload, which can be used with queryable
  encryption.
  
  To insert or query with an indexed, 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>.


id: MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Specifies an algorithm for a range, encrypted payload, which can be used with queryable
  encryption.
  
  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.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY
type: constant
doc:
<comment>Description:</comment>
  Specifies an equality query type, which is used in conjunction with
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info>.


id: MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW
type: constant
doc:
<comment>Description:</comment>
  Specifies a range query type, which is used in conjunction with
  <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.


id: MongoDB\Driver\ClientEncryption::__construct
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. This option is required (unlike with
                   <strong>MongoDB\Driver\Manager::createClientEncryption()</strong>).keyVaultNamespace<info>string</info>Um
                   namespace totalmente qualificado (por exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>)
                   denotando a coleção que contém todas as chaves de dados usadas para criptografia
                   e descriptografia. Esta opção é obrigatória.kmsProviders<info>array</info> Um documento
                   contendo a configuração de um ou mais provedores KMS, que são usados para
                   criptografar chaves de dados. Os provedores compatíveis incluem <return>"aws"</return>, <return>"azure"</return>,
                   <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo menos um deve ser especificado.  Se um documento
                   vazio for especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver tentará configurar
                   o provedor usando Credenciais Automáticas.  O formato para <return>"aws"</return> é o seguinte: ,
                   secretAccessKey: , sessionToken:
                   }
                   ]]> O formato para <return>"azure"</return> é o seguinte: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // O padrão é "login.microsoftonline.com"
                   }
                   ]]> O formato para <return>"gcp"</return> é o seguinte: , privateKey: |, endpoint:  // O padrão é
                   "oauth2.googleapis.com"
                   }
                   ]]> O formato para <return>"kmip"</return> é o seguinte: 
                   }
                   ]]> O formato para <return>"local"</return> é o seguinte: |
                   }
                   ]]>tlsOptions<info>array</info> Um documento contendo a configuração TLS para um ou mais
                   provedores KMS. Os provedores suportados incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>.
                   Todos os provedores suportam as seguintes opções: : { tlsCaFile: ,
                   tlsCertificateKeyFile: , tlsCertificateKeyFilePassword: ,
                   tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   Um documento contendo a configuração de um ou mais provedores KMS, que são usados
                   para criptografar chaves de dados. Os provedores compatíveis incluem <return>"aws"</return>,
                   <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo menos um deve ser especificado.
                   
                   Se um documento vazio for especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver
                   tentará configurar o provedor usando Credenciais Automáticas.
                   
                   O formato para <return>"aws"</return> é o seguinte:
                   
                   O formato para <return>"azure"</return> é o seguinte:
                   
                   O formato para <return>"gcp"</return> é o seguinte:
                   
                   O formato para <return>"kmip"</return> é o seguinte:
                   
                   O formato para <return>"local"</return> é o seguinte:
                   
                   Um documento contendo a configuração TLS para um ou mais provedores KMS. Os
                   provedores suportados incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>. Todos os provedores
                   suportam as seguintes opções:

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


id: MongoDB\Driver\ClientEncryption::addKeyAltName
type: function
doc:
<comment>Description:</comment>
  Adds an alternate name to a key document
  
  Adds <strong>$keyAltName</strong> to 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 add to 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::getKeyByAltName()</strong>
   * <strong>MongoDB\Driver\ClientEncryption::removeKeyAltName()</strong>


id: MongoDB\Driver\ClientEncryption::createDataKey
type: function
doc:
<comment>Description:</comment>
  Creates a key document
  
  Creates a new key document and inserts it into the key vault collection.

<comment>Param:</comment>
  <info>string</info>      <strong>$kmsProvider</strong>  The KMS provider (e.g. <return>"local"</return>, <return>"aws"</return>) that will be used to encrypt the
                            new data key.
  <info>array|null</info>  <strong>$options</strong>      Data key optionsOptionTypeDescriptionmasterKey<info>array</info> The masterKey
                            document identifies a KMS-specific key used to encrypt the new data key.
                            This option is required unless <strong>$kmsProvider</strong> is <return>"local"</return>. Opções do
                            provedor
                            <return>"aws"</return>OpçãoTipoDescriçãoregionstringObrigatória.keystringObrigatória. O
                            Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da
                            AWS.endpointstringOpcional. Um identificador de servidor alternativo
                            para o qual enviar requisições KMS. Pode incluir o número da
                            porta.Opções do provedor
                            <return>"azure"</return>OpçãoTipoDescriçãokeyVaultEndpointstringObrigatória. Servidor com
                            porta opcional (por exemplo,
                            "example.vault.azure.net").keyNamestringObrigatória.keyVersionstringOpcional.
                            Uma versão específica da chave nomeada. O padrão é usar a versão
                            primária da chave.Opções do provedor
                            <return>"gcp"</return>OpçãoTipoDescriçãoprojectIdstringObrigatória.locationstringObrigatória.keyRingstringObrigatória.keyNamestringObrigatória.keyVersionstringOpcional.
                            Uma versão específica da chave nomeada. O padrão é usar a versão
                            primária da chave.endpointstringOpcional. Servidor com porta opcional. O
                            padrão é "cloudkms.googleapis.com".Opções do provedor
                            <return>"kmip"</return>OpçãoTipoDescriçãokeyIdstringOpcional. Identificador único para um
                            objeto gerenciado de dados secretos KMIP de 96 bytes. Se não
                            especificado, o driver cria um objeto gerenciado de dados secretos KMIP
                            aleatório de 96 bytes.endpointstringOpcional. Servidor com porta
                            opcional.keyAltNames<info>array</info> An optional list of string alternate names
                            used to reference a key. If a key is created with alternate names, then
                            encryption may refer to the key by the unique alternate name instead of
                            by <return>_id</return>. keyMaterial<class>MongoDB\BSON\Binary</class> An optional 96-byte value to use
                            as custom key material for the data key being created. If keyMaterial is
                            given, the custom key material is used for encrypting and decrypting
                            data. Otherwise, the key material for the new data key is generated from
                            a cryptographically secure random device.
                            
                            The masterKey document identifies a KMS-specific key used to encrypt the
                            new data key. This option is required unless <strong>$kmsProvider</strong> is <return>"local"</return>.
                            
                            Opções do provedor
                            <return>"aws"</return>OpçãoTipoDescriçãoregionstringObrigatória.keystringObrigatória. O
                            Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da
                            AWS.endpointstringOpcional. Um identificador de servidor alternativo
                            para o qual enviar requisições KMS. Pode incluir o número da porta.
                            
                            Opções do provedor
                            <return>"azure"</return>OpçãoTipoDescriçãokeyVaultEndpointstringObrigatória. Servidor com
                            porta opcional (por exemplo,
                            "example.vault.azure.net").keyNamestringObrigatória.keyVersionstringOpcional.
                            Uma versão específica da chave nomeada. O padrão é usar a versão
                            primária da chave.
                            
                            Opções do provedor
                            <return>"gcp"</return>OpçãoTipoDescriçãoprojectIdstringObrigatória.locationstringObrigatória.keyRingstringObrigatória.keyNamestringObrigatória.keyVersionstringOpcional.
                            Uma versão específica da chave nomeada. O padrão é usar a versão
                            primária da chave.endpointstringOpcional. Servidor com porta opcional. O
                            padrão é "cloudkms.googleapis.com".
                            
                            Opções do provedor <return>"kmip"</return>OpçãoTipoDescriçãokeyIdstringOpcional.
                            Identificador único para um objeto gerenciado de dados secretos KMIP de
                            96 bytes. Se não especificado, o driver cria um objeto gerenciado de
                            dados secretos KMIP aleatório de 96 bytes.endpointstringOpcional.
                            Servidor com porta opcional.
                            
                            An optional list of string alternate names used to reference a key. If a
                            key is created with alternate names, then encryption may refer to the
                            key by the unique alternate name instead of by <return>_id</return>.
                            
                            An optional 96-byte value to use as custom key material for the data key
                            being created. If keyMaterial is given, the custom key material is used
                            for encrypting and decrypting data. Otherwise, the key material for the
                            new data key is generated from a cryptographically secure random device.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Returns the identifier of the new key as a <class>MongoDB\BSON\Binary</class> object with
                       subtype 4 (UUID).


id: MongoDB\Driver\ClientEncryption::decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypt a value
  
  Decrypts the value.

<comment>Param:</comment>
  <info>MongoDB\BSON\Binary</info>  <strong>$value</strong>  A <class>MongoDB\BSON\Binary</class> instance with subtype 6 containing the
                               encrypted value.

<comment>Return:</comment>
  <info>mixed</info>  Returns the decrypted value as it was passed to <strong>MongoDB\Driver\ClientEncryption::encrypt()</strong>.

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


id: MongoDB\Driver\ClientEncryption::deleteKey
type: function
doc:
<comment>Description:</comment>
  Deletes a key document
  
  Removes the key document with the given UUID <strong>$keyId</strong> from the key vault collection.

<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</info>  Returns the result of the internal <return>deleteOne</return> operation on the key vault collection.


id: MongoDB\Driver\ClientEncryption::encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt a value
  
  Encrypts the value.

<comment>Param:</comment>
  <info>mixed</info>       <strong>$value</strong>    The value to be encrypted. Any value that can be inserted into MongoDB can
                        be encrypted using this method.
  <info>array|null</info>  <strong>$options</strong>  Opções de criptografiaOpçãoTipoDescriçãoalgorithm<info>string</info> O algoritmo de
                        criptografia a ser usado. Esta opção é obrigatória. Especifique uma das
                        seguintes constantes ClientEncryption:
                        <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>
                        O fator de contenção para avaliar consultas com cargas indexadas e
                        criptografadas.  Esta opção só se aplica e só pode ser especificada quando
                        <return>algorithm</return> for <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                        Identifica um documento de coleção de cofres de chaves por <return>keyAltName</return>. Esta
                        opção é mutuamente exclusiva com <return>keyId</return> e exatamente uma é necessária.
                        keyId<class>MongoDB\BSON\Binary</class> Identifica uma chave de dados por <return>_id</return>. O valor é um
                        UUID (subtipo binário 4). Esta opção é mutuamente exclusiva com <return>keyAltName</return> e
                        exatamente uma é necessária. queryType<info>int</info> O tipo de consulta para avaliar
                        consultas com cargas indexadas e criptografadas. Especifique uma das
                        seguintes constantes ClientEncryption:
                        <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>Esta
                        opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                        Opções de índice para um campo de criptografia consultável compatível com
                        consultas "rangePreview". As opções abaixo devem corresponder aos valores
                        definidos nos <return>encryptedFields</return> da coleção de destino. Para tipos de campo
                        double e decimal128 BSON, <return>min</return>, <return>max</return> e <return>precision</return> devem ser todos definidos ou
                        nenhum definido. Opções de índice de
                        intervaloOpçãoTipoDescriçãomin<info>mixed</info>Obrigatória se <return>precision</return> for
                        definida.max<info>mixed</info>Obrigatória se <return>precision</return> for
                        definida.sparsity<info>int</info>Obrigatória.precision<info>int</info>Opcional. Só pode ser definida
                        para tipos de campo double ou decimal128 BSON.
                        
                        O algoritmo de criptografia a ser usado. Esta opção é obrigatória.
                        Especifique uma das seguintes constantes ClientEncryption:
                        
                        O fator de contenção para avaliar consultas com cargas indexadas e
                        criptografadas.
                        
                        Esta opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Identifica um documento de coleção de cofres de chaves por <return>keyAltName</return>. Esta
                        opção é mutuamente exclusiva com <return>keyId</return> e exatamente uma é necessária.
                        
                        Identifica uma chave de dados por <return>_id</return>. O valor é um UUID (subtipo binário
                        4). Esta opção é mutuamente exclusiva com <return>keyAltName</return> e exatamente uma é
                        necessária.
                        
                        O tipo de consulta para avaliar consultas com cargas indexadas e
                        criptografadas. Especifique uma das seguintes constantes ClientEncryption:
                        
                        Esta opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                        <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                        
                        Opções de índice para um campo de criptografia consultável compatível com
                        consultas "rangePreview". As opções abaixo devem corresponder aos valores
                        definidos nos <return>encryptedFields</return> da coleção de destino. Para tipos de campo
                        double e decimal128 BSON, <return>min</return>, <return>max</return> e <return>precision</return> devem ser todos definidos ou
                        nenhum definido.
                        
                        Opções de índice de intervaloOpçãoTipoDescriçãomin<info>mixed</info>Obrigatória se
                        <return>precision</return> for definida.max<info>mixed</info>Obrigatória se <return>precision</return> for
                        definida.sparsity<info>int</info>Obrigatória.precision<info>int</info>Opcional. Só pode ser definida
                        para tipos de campo double ou decimal128 BSON.

<comment>Return:</comment>
  <info>MongoDB\BSON\Binary</info>  Returns the encrypted value as <class>MongoDB\BSON\Binary</class> object with subtype 6.

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


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>  Opções de criptografiaOpçãoTipoDescriçãoalgorithm<info>string</info> O algoritmo de
                          criptografia a ser usado. Esta opção é obrigatória. Especifique uma das
                          seguintes constantes ClientEncryption:
                          <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>
                          O fator de contenção para avaliar consultas com cargas indexadas e
                          criptografadas.  Esta opção só se aplica e só pode ser especificada quando
                          <return>algorithm</return> for <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. keyAltName<info>string</info>
                          Identifica um documento de coleção de cofres de chaves por <return>keyAltName</return>.
                          Esta opção é mutuamente exclusiva com <return>keyId</return> e exatamente uma é necessária.
                          keyId<class>MongoDB\BSON\Binary</class> Identifica uma chave de dados por <return>_id</return>. O valor é
                          um UUID (subtipo binário 4). Esta opção é mutuamente exclusiva com
                          <return>keyAltName</return> e exatamente uma é necessária. queryType<info>int</info> O tipo de consulta
                          para avaliar consultas com cargas indexadas e criptografadas. Especifique
                          uma das seguintes constantes ClientEncryption:
                          <info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY</info><info>MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEW</info>Esta
                          opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>. rangeOpts<info>array</info>
                          Opções de índice para um campo de criptografia consultável compatível com
                          consultas "rangePreview". As opções abaixo devem corresponder aos valores
                          definidos nos <return>encryptedFields</return> da coleção de destino. Para tipos de campo
                          double e decimal128 BSON, <return>min</return>, <return>max</return> e <return>precision</return> devem ser todos definidos
                          ou nenhum definido. Opções de índice de
                          intervaloOpçãoTipoDescriçãomin<info>mixed</info>Obrigatória se <return>precision</return> for
                          definida.max<info>mixed</info>Obrigatória se <return>precision</return> for
                          definida.sparsity<info>int</info>Obrigatória.precision<info>int</info>Opcional. Só pode ser definida
                          para tipos de campo double ou decimal128 BSON.
                          
                          O algoritmo de criptografia a ser usado. Esta opção é obrigatória.
                          Especifique uma das seguintes constantes ClientEncryption:
                          
                          O fator de contenção para avaliar consultas com cargas indexadas e
                          criptografadas.
                          
                          Esta opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Identifica um documento de coleção de cofres de chaves por <return>keyAltName</return>.
                          Esta opção é mutuamente exclusiva com <return>keyId</return> e exatamente uma é necessária.
                          
                          Identifica uma chave de dados por <return>_id</return>. O valor é um UUID (subtipo binário
                          4). Esta opção é mutuamente exclusiva com <return>keyAltName</return> e exatamente uma é
                          necessária.
                          
                          O tipo de consulta para avaliar consultas com cargas indexadas e
                          criptografadas. Especifique uma das seguintes constantes ClientEncryption:
                          
                          Esta opção só se aplica e só pode ser especificada quando <return>algorithm</return> for
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED</info> ou
                          <info>MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE_PREVIEW</info>.
                          
                          Opções de índice para um campo de criptografia consultável compatível com
                          consultas "rangePreview". As opções abaixo devem corresponder aos valores
                          definidos nos <return>encryptedFields</return> da coleção de destino. Para tipos de campo
                          double e decimal128 BSON, <return>min</return>, <return>max</return> e <return>precision</return> devem ser todos definidos
                          ou nenhum definido.
                          
                          Opções de índice de intervaloOpçãoTipoDescriçãomin<info>mixed</info>Obrigatória se
                          <return>precision</return> for definida.max<info>mixed</info>Obrigatória se <return>precision</return> for
                          definida.sparsity<info>int</info>Obrigatória.precision<info>int</info>Opcional. Só pode ser definida
                          para tipos de campo double ou decimal128 BSON.

<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>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.


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>   O predicado de consulta. Um predicado vazio corresponderá a todos os
                          documentos da coleção.
                          
                          Ao avaliar os critérios de consulta, o MongoDB compara os tipos e valores
                          de acordo com suas próprias regras de comparação para tipos BSON, que
                          diferem das regras de comparação e do malabarismo de tipos do PHP. Ao
                          corresponder a um tipo especial de BSON, os critérios de consulta devem
                          usar a respectiva classe BSON (por exemplo, use <class>MongoDB\BSON\ObjectId</class> para
                          corresponder a um 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>. Opções do provedor
                          <return>"aws"</return>OpçãoTipoDescriçãoregionstringObrigatória.keystringObrigatória. O
                          Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da
                          AWS.endpointstringOpcional. Um identificador de servidor alternativo para
                          o qual enviar requisições KMS. Pode incluir o número da porta.Opções do
                          provedor <return>"azure"</return>OpçãoTipoDescriçãokeyVaultEndpointstringObrigatória.
                          Servidor com porta opcional (por exemplo,
                          "example.vault.azure.net").keyNamestringObrigatória.keyVersionstringOpcional.
                          Uma versão específica da chave nomeada. O padrão é usar a versão primária
                          da chave.Opções do provedor
                          <return>"gcp"</return>OpçãoTipoDescriçãoprojectIdstringObrigatória.locationstringObrigatória.keyRingstringObrigatória.keyNamestringObrigatória.keyVersionstringOpcional.
                          Uma versão específica da chave nomeada. O padrão é usar a versão primária
                          da chave.endpointstringOpcional. Servidor com porta opcional. O padrão é
                          "cloudkms.googleapis.com".Opções do provedor
                          <return>"kmip"</return>OpçãoTipoDescriçãokeyIdstringOpcional. Identificador único para um
                          objeto gerenciado de dados secretos KMIP de 96 bytes. Se não especificado,
                          o driver cria um objeto gerenciado de dados secretos KMIP aleatório de 96
                          bytes.endpointstringOpcional. Servidor com porta opcional.
                          
                          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>.
                          
                          Opções do provedor
                          <return>"aws"</return>OpçãoTipoDescriçãoregionstringObrigatória.keystringObrigatória. O
                          Nome de Recurso da Amazon (ARN) para a chave mestra do cliente (CMK) da
                          AWS.endpointstringOpcional. Um identificador de servidor alternativo para
                          o qual enviar requisições KMS. Pode incluir o número da porta.
                          
                          Opções do provedor
                          <return>"azure"</return>OpçãoTipoDescriçãokeyVaultEndpointstringObrigatória. Servidor com
                          porta opcional (por exemplo,
                          "example.vault.azure.net").keyNamestringObrigatória.keyVersionstringOpcional.
                          Uma versão específica da chave nomeada. O padrão é usar a versão primária
                          da chave.
                          
                          Opções do provedor
                          <return>"gcp"</return>OpçãoTipoDescriçãoprojectIdstringObrigatória.locationstringObrigatória.keyRingstringObrigatória.keyNamestringObrigatória.keyVersionstringOpcional.
                          Uma versão específica da chave nomeada. O padrão é usar a versão primária
                          da chave.endpointstringOpcional. Servidor com porta opcional. O padrão é
                          "cloudkms.googleapis.com".
                          
                          Opções do provedor <return>"kmip"</return>OpçãoTipoDescriçãokeyIdstringOpcional.
                          Identificador único para um objeto gerenciado de dados secretos KMIP de 96
                          bytes. Se não especificado, o driver cria um objeto gerenciado de dados
                          secretos KMIP aleatório de 96 bytes.endpointstringOpcional. Servidor com
                          porta opcional.

<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>  Configuração de mapeamento de tipos.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Configuração de mapeamento de tipos.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<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.
  
  Em plataformas Unix, o driver do MongoDB é sensível a scripts que usam a chamada de sistema fork()
  sem chamar também exec(). Os usuários são aconselhados a não reusar instâncias de
  <class>MongoDB\Driver\Manager</class> em um processo filho bifurcado.

<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>O
                               Manager usado para rotear consultas de chave de dados para um cluster
                               MongoDB separado. Por padrão, o Manager e o cluster atuais são
                               usados.keyVaultNamespace<info>string</info>Um namespace totalmente qualificado
                               (por exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>) denotando a coleção
                               que contém todas as chaves de dados usadas para criptografia e
                               descriptografia. Esta opção é obrigatória.kmsProviders<info>array</info> Um
                               documento contendo a configuração de um ou mais provedores KMS, que
                               são usados para criptografar chaves de dados. Os provedores
                               compatíveis incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo
                               menos um deve ser especificado.  Se um documento vazio for
                               especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver tentará
                               configurar o provedor usando Credenciais Automáticas.  O formato para
                               <return>"aws"</return> é o seguinte: , secretAccessKey: , sessionToken:
                               }
                               ]]> O formato para <return>"azure"</return> é o seguinte: , clientId: , clientSecret:
                               , identityPlatformEndpoint:  // O padrão é
                               "login.microsoftonline.com"
                               }
                               ]]> O formato para <return>"gcp"</return> é o seguinte: , privateKey: |, endpoint:  //
                               O padrão é "oauth2.googleapis.com"
                               }
                               ]]> O formato para <return>"kmip"</return> é o seguinte: 
                               }
                               ]]> O formato para <return>"local"</return> é o seguinte: |
                               }
                               ]]>tlsOptions<info>array</info> Um documento contendo a configuração TLS para um
                               ou mais provedores KMS. Os provedores suportados incluem <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>. Todos os provedores suportam as seguintes
                               opções: : { 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>O
                               Manager usado para rotear consultas de chave de dados para um cluster
                               MongoDB separado. Por padrão, o Manager e o cluster atuais são
                               usados.keyVaultNamespace<info>string</info>Um namespace totalmente qualificado
                               (por exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>) denotando a coleção
                               que contém todas as chaves de dados usadas para criptografia e
                               descriptografia. Esta opção é obrigatória.kmsProviders<info>array</info> Um
                               documento contendo a configuração de um ou mais provedores KMS, que
                               são usados para criptografar chaves de dados. Os provedores
                               compatíveis incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo
                               menos um deve ser especificado.  Se um documento vazio for
                               especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver tentará
                               configurar o provedor usando Credenciais Automáticas.  O formato para
                               <return>"aws"</return> é o seguinte: , secretAccessKey: , sessionToken:
                               }
                               ]]> O formato para <return>"azure"</return> é o seguinte: , clientId: , clientSecret:
                               , identityPlatformEndpoint:  // O padrão é
                               "login.microsoftonline.com"
                               }
                               ]]> O formato para <return>"gcp"</return> é o seguinte: , privateKey: |, endpoint:  //
                               O padrão é "oauth2.googleapis.com"
                               }
                               ]]> O formato para <return>"kmip"</return> é o seguinte: 
                               }
                               ]]> O formato para <return>"local"</return> é o seguinte: |
                               }
                               ]]>tlsOptions<info>array</info> Um documento contendo a configuração TLS para um
                               ou mais provedores KMS. Os provedores suportados incluem <return>"aws"</return>,
                               <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>. Todos os provedores suportam as seguintes
                               opções: : { 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.
                               
                               Um documento contendo a configuração de um ou mais provedores KMS,
                               que são usados para criptografar chaves de dados. Os provedores
                               compatíveis incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo
                               menos um deve ser especificado.
                               
                               Se um documento vazio for especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>,
                               o driver tentará configurar o provedor usando Credenciais
                               Automáticas.
                               
                               O formato para <return>"aws"</return> é o seguinte:
                               
                               O formato para <return>"azure"</return> é o seguinte:
                               
                               O formato para <return>"gcp"</return> é o seguinte:
                               
                               O formato para <return>"kmip"</return> é o seguinte:
                               
                               O formato para <return>"local"</return> é o seguinte:
                               
                               Um documento contendo a configuração TLS para um ou mais provedores
                               KMS. Os provedores suportados incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>.
                               Todos os provedores suportam as seguintes opções:
                               
                               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>  Nenhum valor é retornado.

<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>O Manager usado
                   para rotear consultas de chave de dados para um cluster MongoDB separado. Por
                   padrão, o Manager e o cluster atuais são usados.keyVaultNamespace<info>string</info>Um
                   namespace totalmente qualificado (por exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>)
                   denotando a coleção que contém todas as chaves de dados usadas para criptografia
                   e descriptografia. Esta opção é obrigatória.kmsProviders<info>array</info> Um documento
                   contendo a configuração de um ou mais provedores KMS, que são usados para
                   criptografar chaves de dados. Os provedores compatíveis incluem <return>"aws"</return>, <return>"azure"</return>,
                   <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo menos um deve ser especificado.  Se um documento
                   vazio for especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver tentará configurar
                   o provedor usando Credenciais Automáticas.  O formato para <return>"aws"</return> é o seguinte: ,
                   secretAccessKey: , sessionToken:
                   }
                   ]]> O formato para <return>"azure"</return> é o seguinte: , clientId: , clientSecret: ,
                   identityPlatformEndpoint:  // O padrão é "login.microsoftonline.com"
                   }
                   ]]> O formato para <return>"gcp"</return> é o seguinte: , privateKey: |, endpoint:  // O padrão é
                   "oauth2.googleapis.com"
                   }
                   ]]> O formato para <return>"kmip"</return> é o seguinte: 
                   }
                   ]]> O formato para <return>"local"</return> é o seguinte: |
                   }
                   ]]>tlsOptions<info>array</info> Um documento contendo a configuração TLS para um ou mais
                   provedores KMS. Os provedores suportados incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>.
                   Todos os provedores suportam as seguintes opções: : { tlsCaFile: ,
                   tlsCertificateKeyFile: , tlsCertificateKeyFilePassword: ,
                   tlsDisableOCSPEndpointCheck:
                   }
                   ]]>
                   
                   Um documento contendo a configuração de um ou mais provedores KMS, que são usados
                   para criptografar chaves de dados. Os provedores compatíveis incluem <return>"aws"</return>,
                   <return>"azure"</return>, <return>"gcp"</return>, <return>"kmip"</return> e <return>"local"</return> e pelo menos um deve ser especificado.
                   
                   Se um documento vazio for especificado para <return>"aws"</return>, <return>"azure"</return>, ou <return>"gcp"</return>, o driver
                   tentará configurar o provedor usando Credenciais Automáticas.
                   
                   O formato para <return>"aws"</return> é o seguinte:
                   
                   O formato para <return>"azure"</return> é o seguinte:
                   
                   O formato para <return>"gcp"</return> é o seguinte:
                   
                   O formato para <return>"kmip"</return> é o seguinte:
                   
                   O formato para <return>"local"</return> é o seguinte:
                   
                   Um documento contendo a configuração TLS para um ou mais provedores KMS. Os
                   provedores suportados incluem <return>"aws"</return>, <return>"azure"</return>, <return>"gcp"</return> e <return>"kmip"</return>. Todos os provedores
                   suportam as seguintes opções:

<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>  Um namespace totalmente qualificado (por
                                                      exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>).
  <info>MongoDB\Driver\BulkWrite</info>                <strong>$bulk</strong>       As gravações a serem executadas.
  <info>array|MongoDB\Driver\WriteConcern|null</info>  <strong>$options</strong>    
                                                      optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class>
                                                      Uma sessão para associar à operação.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Um
                                                      write concern a ser aplicado à operação.
                                                      
                                                      Uma sessão para associar à operação.
                                                      
                                                      Um write concern a ser aplicado à operação.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  Retorna <class>MongoDB\Driver\WriteResult</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o
                                                      comando.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  O comando a ser executado.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Um read concern a ser aplicado à operação.
                                                      Esta opção está disponível no MongoDB 3.2+ e
                                                      resultará em uma exceção em tempo de execução
                                                      se for especificada para uma versão de
                                                      servidor mais antiga.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Uma preferência de leitura a ser usada para
                                                      selecionar um servidor para a operação.
                                                      session<class>MongoDB\Driver\Session</class> Uma sessão para
                                                      associar à operação.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Um
                                                      write concern a ser aplicado à operação.
                                                      
                                                      Um read concern a ser aplicado à operação.
                                                      
                                                      Esta opção está disponível no MongoDB 3.2+ e
                                                      resultará em uma exceção em tempo de execução
                                                      se for especificada para uma versão de
                                                      servidor mais antiga.
                                                      
                                                      Uma preferência de leitura a ser usada para
                                                      selecionar um servidor para a operação.
                                                      
                                                      Uma sessão para associar à operação.
                                                      
                                                      Um write concern a ser aplicado à operação.
                                                      
                                                      Se uma <return>"session"</return> que tem uma transação em
                                                      andamento estiver sendo usada, uma opção
                                                      <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode ser
                                                      especificada. Isso resultará em uma exceção
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>
                                                      sendo lançada. Em vez disso, essas duas opções
                                                      devem ser definidas ao criar a transação com
                                                      MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>  Um namespace totalmente qualificado (por
                                                        exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      A consulta a ser executada.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsOptionTypeDescriptionreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Uma preferência de leitura a ser usada para
                                                        selecionar um servidor para a operação.
                                                        session<class>MongoDB\Driver\Session</class> Uma sessão
                                                        para associar à operação.
                                                        
                                                        Uma preferência de leitura a ser usada para
                                                        selecionar um servidor para a operação.
                                                        
                                                        Uma sessão para associar à operação.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Um read concern a ser aplicado à operação.  Esta opção está
                                    disponível no MongoDB 3.2+ e resultará em uma exceção em tempo
                                    de execução se for especificada para uma versão de servidor mais
                                    antiga. readPreference<class>MongoDB\Driver\ReadPreference</class> Uma
                                    preferência de leitura a ser usada para selecionar um servidor
                                    para a operação. session<class>MongoDB\Driver\Session</class> Uma sessão para
                                    associar à operação.
                                    
                                    Um read concern a ser aplicado à operação.
                                    
                                    Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                                    exceção em tempo de execução se for especificada para uma versão
                                    de servidor mais antiga.
                                    
                                    Uma preferência de leitura a ser usada para selecionar um
                                    servidor para a operação.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Um read concern a ser aplicado à operação.  Esta opção está
                                    disponível no MongoDB 3.2+ e resultará em uma exceção em tempo
                                    de execução se for especificada para uma versão de servidor mais
                                    antiga. session<class>MongoDB\Driver\Session</class> Uma sessão para associar à
                                    operação. writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write
                                    concern a ser aplicado à operação.
                                    
                                    Um read concern a ser aplicado à operação.
                                    
                                    Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                                    exceção em tempo de execução se for especificada para uma versão
                                    de servidor mais antiga.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Um write concern a ser aplicado à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class> Uma
                                    sessão para associar à operação.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write concern a ser
                                    aplicado à operação.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Um write concern a ser aplicado à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>  Nenhum valor é retornado.

<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 A quantidade
                        máxima de tempo em milissegundos para permitir que um único comando
                        <return>commitTransaction</return> seja executado.  Se especificada, <return>maxCommitTimeMS</return> deve ser
                        um inteiro de 32 bits com sinal com valor maior ou igual a zero.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Um read concern a ser aplicado à
                        operação.  Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                        exceção em tempo de execução se for especificada para uma versão de servidor
                        mais antiga. readPreference<class>MongoDB\Driver\ReadPreference</class> Uma preferência de
                        leitura a ser usada para selecionar um servidor para a operação.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write concern a ser aplicado à
                        operação.  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 A quantidade máxima de
                        tempo em milissegundos para permitir que um único comando <return>commitTransaction</return>
                        seja executado.  Se especificada, <return>maxCommitTimeMS</return> deve ser um inteiro de 32
                        bits com sinal com valor maior ou igual a zero.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Um read concern a ser aplicado à
                        operação.  Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                        exceção em tempo de execução se for especificada para uma versão de servidor
                        mais antiga. readPreference<class>MongoDB\Driver\ReadPreference</class> Uma preferência de
                        leitura a ser usada para selecionar um servidor para a operação.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write concern a ser aplicado à
                        operação.
                        
                        A quantidade máxima de tempo em milissegundos para permitir que um único
                        comando <return>commitTransaction</return> seja executado.
                        
                        Se especificada, <return>maxCommitTimeMS</return> deve ser um inteiro de 32 bits com sinal
                        com valor maior ou igual a zero.
                        
                        Um read concern a ser aplicado à operação.
                        
                        Esta opção está disponível no MongoDB 3.2+ e resultará em uma exceção em
                        tempo de execução se for especificada para uma versão de servidor mais
                        antiga.
                        
                        Uma preferência de leitura a ser usada para selecionar um servidor para a
                        operação.
                        
                        Um write concern a ser aplicado à operação.
                        
                        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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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\LogSubscriber
type: class
doc:
<comment>Description:</comment>
  Classes implementing this interface may be registered as a subscriber and receive log messages
  from the driver. This is similar to stream-based debug logging (i.e. mongodb.debug) except that
  trace-level log messages are not received.
  
  As with stream-based logging, it is only possible to register a logger globally using
  <strong>MongoDB\Driver\Monitoring\addSubscriber()</strong>. The driver is not able to distinguish log messages for
  individual <class>MongoDB\Driver\Manager</class> objects.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  Critical log level. An error condition with slightly less severity. This constant exists for
  consistency with libmongoc; however, the driver is unlikely to use it in practice.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Debug log level. Detailed information that may be helpful when debugging an application.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_ERROR
type: constant
doc:
<comment>Description:</comment>
  Error log level. An error condition that the driver is unable to report through its API. This is
  the most severe log level in the driver.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_INFO
type: constant
doc:
<comment>Description:</comment>
  Info log level. High-level information about normal driver behavior.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_MESSAGE
type: constant
doc:
<comment>Description:</comment>
  Message or notice log level. Indicates an event that is unusual but not problematic.


id: MongoDB\Driver\Monitoring\LogSubscriber::LEVEL_WARNING
type: constant
doc:
<comment>Description:</comment>
  Warning log level. Indicates a situation where undesirable application behavior may occur.


id: MongoDB\Driver\Monitoring\LogSubscriber::log
type: function
doc:
<comment>Description:</comment>
  Notification method for a log message
  
  If the subscriber has been registered, the driver will call this method for each logged message.

<comment>Param:</comment>
  <info>int</info>     <strong>$level</strong>    The severity level. This will be one of the interface constants.
  <info>string</info>  <strong>$domain</strong>   The name of the driver component that emitted the log message.
  <info>string</info>  <strong>$message</strong>  The log message.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>        O predicado de consulta. Um predicado vazio corresponderá a todos os
                               documentos da coleção.
                               
                               Ao avaliar os critérios de consulta, o MongoDB compara os tipos e
                               valores de acordo com suas próprias regras de comparação para tipos
                               BSON, que diferem das regras de comparação e do malabarismo de tipos
                               do PHP. Ao corresponder a um tipo especial de BSON, os critérios de
                               consulta devem usar a respectiva classe BSON (por exemplo, use
                               <class>MongoDB\BSON\ObjectId</class> para corresponder a um 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</info><info>object</info></info>Collation permite que os usuários especifiquem
                               regras específicas do idioma para comparação de strings, como regras
                               para maiúsculas e minúsculas e acentos. Ao especificar a collation, o
                               campo <return>"locale"</return> é obrigatório; todos os outros campos de collation são
                               opcionais. Para obter descrições dos campos, veja o Documento de
                               Collation.  Se a collation não for especificada, mas a coleção tiver
                               uma collation padrão, a operação usará a collation especificada para
                               a coleção. Se nenhuma collation for especificada para a coleção ou
                               para a operação, o MongoDB usará a comparação binária simples usada
                               em versões anteriores para comparações de strings.  Esta opção está
                               disponível no MongoDB 3.4+ e resultará em uma exceção em tempo de
                               execução se for especificada para uma versão de servidor mais antiga.
                               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> Mapa de nomes e valores de
                               parâmetros. Os valores devem ser expressões constantes ou fechadas
                               que não fazem referência a campos do documento. Os parâmetros podem
                               então ser acessados como variáveis em um contexto de expressão
                               agregada (por exemplo, <return>$$var</return>).  Esta opção está disponível no MongoDB
                               5.0+ e resultará em uma exceção em tempo de execução se for
                               especificada para uma versão de servidor mais antiga. 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 permite que os usuários especifiquem regras específicas do
                               idioma para comparação de strings, como regras para maiúsculas e
                               minúsculas e acentos. Ao especificar a collation, o campo <return>"locale"</return> é
                               obrigatório; todos os outros campos de collation são opcionais. Para
                               obter descrições dos campos, veja o Documento de Collation.
                               
                               Se a collation não for especificada, mas a coleção tiver uma
                               collation padrão, a operação usará a collation especificada para a
                               coleção. Se nenhuma collation for especificada para a coleção ou para
                               a operação, o MongoDB usará a comparação binária simples usada em
                               versões anteriores para comparações de strings.
                               
                               Esta opção está disponível no MongoDB 3.4+ e resultará em uma exceção
                               em tempo de execução se for especificada para uma versão de servidor
                               mais antiga.
                               
                               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.
                               
                               Mapa de nomes e valores de parâmetros. Os valores devem ser
                               expressões constantes ou fechadas que não fazem referência a campos
                               do documento. Os parâmetros podem então ser acessados como variáveis
                               em um contexto de expressão agregada (por exemplo, <return>$$var</return>).
                               
                               Esta opção está disponível no MongoDB 5.0+ e resultará em uma exceção
                               em tempo de execução se for especificada para uma versão de servidor
                               mais antiga.
                               
                               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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Um namespace totalmente qualificado (por
                                                      exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>).
  <info>MongoDB\Driver\BulkWrite</info>                <strong>$bulk</strong>       As gravações a serem executadas.
  <info>array|MongoDB\Driver\WriteConcern|null</info>  <strong>$options</strong>    
                                                      optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class>
                                                      Uma sessão para associar à operação.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Um
                                                      write concern a ser aplicado à operação.
                                                      
                                                      Uma sessão para associar à operação.
                                                      
                                                      Um write concern a ser aplicado à operação.

<comment>Return:</comment>
  <info>MongoDB\Driver\WriteResult</info>  Retorna <class>MongoDB\Driver\WriteResult</class> em caso de sucesso.

<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.
  
  A opção <return>"readPreference"</return> não controla o servidor ao qual o driver emite a operação; ela sempre
  será executada neste objeto servidor. Em vez disso, ela pode ser usada ao emitir a operação para
  um servidor secundário (de uma conexão de conjunto de réplicas, não autônomas) ou nós mongo para
  garantir que o driver defina o protocolo de conexão de acordo ou adicione a preferência de leitura
  à operação, respectivamente.

<comment>Param:</comment>
  <info>string</info>                                    <strong>$db</strong>       O nome do banco de dados no qual executar o
                                                      comando.
  <info>MongoDB\Driver\Command</info>                    <strong>$command</strong>  O comando a ser executado.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>  
                                                      optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                                      Um read concern a ser aplicado à operação.
                                                      Esta opção está disponível no MongoDB 3.2+ e
                                                      resultará em uma exceção em tempo de execução
                                                      se for especificada para uma versão de
                                                      servidor mais antiga.
                                                      readPreference<class>MongoDB\Driver\ReadPreference</class>
                                                      Uma preferência de leitura a ser usada para
                                                      selecionar um servidor para a operação.
                                                      session<class>MongoDB\Driver\Session</class> Uma sessão para
                                                      associar à operação.
                                                      writeConcern<class>MongoDB\Driver\WriteConcern</class> Um
                                                      write concern a ser aplicado à operação.
                                                      
                                                      Um read concern a ser aplicado à operação.
                                                      
                                                      Esta opção está disponível no MongoDB 3.2+ e
                                                      resultará em uma exceção em tempo de execução
                                                      se for especificada para uma versão de
                                                      servidor mais antiga.
                                                      
                                                      Uma preferência de leitura a ser usada para
                                                      selecionar um servidor para a operação.
                                                      
                                                      Uma sessão para associar à operação.
                                                      
                                                      Um write concern a ser aplicado à operação.
                                                      
                                                      Se uma <return>"session"</return> que tem uma transação em
                                                      andamento estiver sendo usada, uma opção
                                                      <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode ser
                                                      especificada. Isso resultará em uma exceção
                                                      <class>MongoDB\Driver\Exception\InvalidArgumentException</class>
                                                      sendo lançada. Em vez disso, essas duas opções
                                                      devem ser definidas ao criar a transação com
                                                      MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>  Um namespace totalmente qualificado (por
                                                        exemplo, <return>"nomeDoBancoDados.nomeDaColecao"</return>).
  <info>MongoDB\Driver\Query</info>                      <strong>$query</strong>      A consulta a ser executada.
  <info>array|MongoDB\Driver\ReadPreference|null</info>  <strong>$options</strong>    
                                                        optionsOptionTypeDescriptionreadPreference<class>MongoDB\Driver\ReadPreference</class>
                                                        Uma preferência de leitura a ser usada para
                                                        selecionar um servidor para a operação.
                                                        session<class>MongoDB\Driver\Session</class> Uma sessão
                                                        para associar à operação.
                                                        
                                                        Uma preferência de leitura a ser usada para
                                                        selecionar um servidor para a operação.
                                                        
                                                        Uma sessão para associar à operação.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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.
  
  A opção <return>"readPreference"</return> não controla o servidor ao qual o driver emite a operação; ela sempre
  será executada neste objeto servidor. Em vez disso, ela pode ser usada ao emitir a operação para
  um servidor secundário (de uma conexão de conjunto de réplicas, não autônomas) ou nós mongo para
  garantir que o driver defina o protocolo de conexão de acordo ou adicione a preferência de leitura
  à operação, respectivamente.

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Um read concern a ser aplicado à operação.  Esta opção está
                                    disponível no MongoDB 3.2+ e resultará em uma exceção em tempo
                                    de execução se for especificada para uma versão de servidor mais
                                    antiga. readPreference<class>MongoDB\Driver\ReadPreference</class> Uma
                                    preferência de leitura a ser usada para selecionar um servidor
                                    para a operação. session<class>MongoDB\Driver\Session</class> Uma sessão para
                                    associar à operação.
                                    
                                    Um read concern a ser aplicado à operação.
                                    
                                    Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                                    exceção em tempo de execução se for especificada para uma versão
                                    de servidor mais antiga.
                                    
                                    Uma preferência de leitura a ser usada para selecionar um
                                    servidor para a operação.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    Um read concern a ser aplicado à operação.  Esta opção está
                                    disponível no MongoDB 3.2+ e resultará em uma exceção em tempo
                                    de execução se for especificada para uma versão de servidor mais
                                    antiga. session<class>MongoDB\Driver\Session</class> Uma sessão para associar à
                                    operação. writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write
                                    concern a ser aplicado à operação.
                                    
                                    Um read concern a ser aplicado à operação.
                                    
                                    Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                                    exceção em tempo de execução se for especificada para uma versão
                                    de servidor mais antiga.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Um write concern a ser aplicado à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>       O nome do banco de dados no qual executar o comando.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  O comando a ser executado.
  <info>array|null</info>              <strong>$options</strong>  optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class> Uma
                                    sessão para associar à operação.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write concern a ser
                                    aplicado à operação.
                                    
                                    Uma sessão para associar à operação.
                                    
                                    Um write concern a ser aplicado à operação.
                                    
                                    Se uma <return>"session"</return> que tem uma transação em andamento estiver
                                    sendo usada, uma opção <return>"readConcern"</return> ou <return>"writeConcern"</return> não pode
                                    ser especificada. Isso resultará em uma exceção
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> sendo lançada.
                                    Em vez disso, essas duas opções devem ser definidas ao criar a
                                    transação com MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Retorna <class>MongoDB\Driver\Cursor</class> em caso de sucesso.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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 A quantidade máxima de
                        tempo em milissegundos para permitir que um único comando <return>commitTransaction</return>
                        seja executado.  Se especificada, <return>maxCommitTimeMS</return> deve ser um inteiro de 32
                        bits com sinal com valor maior ou igual a zero.
                        readConcern<class>MongoDB\Driver\ReadConcern</class> Um read concern a ser aplicado à
                        operação.  Esta opção está disponível no MongoDB 3.2+ e resultará em uma
                        exceção em tempo de execução se for especificada para uma versão de servidor
                        mais antiga. readPreference<class>MongoDB\Driver\ReadPreference</class> Uma preferência de
                        leitura a ser usada para selecionar um servidor para a operação.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> Um write concern a ser aplicado à
                        operação.
                        
                        A quantidade máxima de tempo em milissegundos para permitir que um único
                        comando <return>commitTransaction</return> seja executado.
                        
                        Se especificada, <return>maxCommitTimeMS</return> deve ser um inteiro de 32 bits com sinal
                        com valor maior ou igual a zero.
                        
                        Um read concern a ser aplicado à operação.
                        
                        Esta opção está disponível no MongoDB 3.2+ e resultará em uma exceção em
                        tempo de execução se for especificada para uma versão de servidor mais
                        antiga.
                        
                        Uma preferência de leitura a ser usada para selecionar um servidor para a
                        operação.
                        
                        Um write concern a ser aplicado à operação.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<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>  Nenhum valor é retornado.

<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>
  An Iterator that sequentially iterates over all attached iterators


id: MultipleIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new MultipleIterator
  
  Construct a new MultipleIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The flags to set, according to the Flag Constants. <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>
               
               Defaults to <info>MultipleIterator::MIT_NEED_ALL</info>|<info>MultipleIterator::MIT_KEYS_NUMERIC</info>.

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


id: MultipleIterator::attachIterator
type: function
doc:
<comment>Description:</comment>
  Attaches iterator information
  
  Attaches iterator information.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Iterator</info>         <strong>$iterator</strong>  The new iterator to attach.
  <info>string|int|null</info>  <strong>$info</strong>      The associative information for the Iterator, which must be an <info>int</info>, a
                              <info>string</info>, or <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>
  Checks if an iterator is attached
  
  Checks if an iterator is attached or not.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator to check.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: MultipleIterator::countIterators
type: function
doc:
<comment>Description:</comment>
  Gets the number of attached iterator instances
  
  Gets the number of attached iterator instances.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  The number of attached iterator instances (as an <info>int</info>).

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


id: MultipleIterator::current
type: function
doc:
<comment>Description:</comment>
  Gets the registered iterator instances
  
  Get the registered iterator instances current() result.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> containing the current values of each attached iterator.

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


id: MultipleIterator::detachIterator
type: function
doc:
<comment>Description:</comment>
  Detaches an iterator
  
  Detaches an iterator.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator to detach.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MultipleIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Gets the flag information
  
  Gets information about the flags.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>int</info>  Information about the flags, as an <info>int</info>.

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


id: MultipleIterator::key
type: function
doc:
<comment>Description:</comment>
  Gets the registered iterator instances
  
  Get the registered iterator instances key() result.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of all registered iterator instances.

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


id: MultipleIterator::next
type: function
doc:
<comment>Description:</comment>
  Moves all attached iterator instances forward
  
  Moves all attached iterator instances forward.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MultipleIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds all attached iterator instances
  
  Rewinds all attached iterator instances.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MultipleIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Sets flags
  
  Sets flags.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  The flags to set, according to the Flag Constants

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: MultipleIterator::valid
type: function
doc:
<comment>Description:</comment>
  Checks the validity of sub iterators
  
  Checks the validity of sub iterators.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if one or all sub iterators are valid depending on flags, otherwise <info>false</info>

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


id: NORM_IGNOREKASHIDA
type: constant
doc:
<comment>Description:</comment>
  Ignore Arabic kashida characters.
  
  Availability is dependent upon under lying library.


id: NoRewindIterator
type: class
doc:
<comment>Description:</comment>
  This iterator ignores rewind operations. This allows processing an iterator in multiple partial
  foreach loops.


id: NoRewindIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a NoRewindIterator
  
  Constructs a NoRewindIterator.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  The iterator being used.

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


id: NoRewindIterator::current
type: function
doc:
<comment>Description:</comment>
  Get the current value
  
  Gets the current value.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mixed</info>  The current value.

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


id: NoRewindIterator::key
type: function
doc:
<comment>Description:</comment>
  Get the current key
  
  Gets the current key.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>mixed</info>  The current key.

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


id: NoRewindIterator::next
type: function
doc:
<comment>Description:</comment>
  Forward to the next element
  
  Forwards to the next element.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: NoRewindIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Prevents the rewind operation on the inner iterator
  
  Prevents the rewind operation on the inner iterator.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.


id: NoRewindIterator::valid
type: function
doc:
<comment>Description:</comment>
  Validates the iterator
  
  Checks whether the iterator is valid.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


id: Normalizer
type: class
doc:
<comment>Description:</comment>
  Normalization is a process that involves transforming characters and sequences of characters into
  a formally-defined underlying representation. This process is most important when text needs to be
  compared for sorting and searching, but it is also used when storing text to ensure that the text
  is stored in a consistent representation.
  
  The Unicode Consortium has defined a number of normalization forms reflecting the various needs of
  applications: Normalization Form D (NFD) - Canonical Decomposition Normalization Form C (NFC) -
  Canonical Decomposition followed by Canonical Composition  Normalization Form KD (NFKD) -
  Compatibility Decomposition  Normalization Form KC (NFKC) - Compatibility Decomposition followed
  by Canonical Composition  The different forms are defined in terms of a set of transformations on
  the text, transformations that are expressed by both an algorithm and a set of data files.


id: Normalizer::FORM_C
type: constant
doc:
<comment>Description:</comment>
  Normalization Form C (NFC) - Canonical Decomposition followed by Canonical Composition


id: Normalizer::FORM_KC
type: constant
doc:
<comment>Description:</comment>
  Normalization Form KC (NFKC) - Compatibility Decomposition, followed by Canonical Composition


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 procedural
  
  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>
  Verifica se a string fornecida já está na forma normalizada
     na forma especificada.
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Verifica se a string fornecida já está na forma normalizada na forma especificada.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada para verificar a normalização
  <info>int</info>     <strong>$form</strong>    Uma das formas de normalização.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> se a string estiver normalizada, <info>false</info> caso contrário ou se houver um erro

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


id: Normalizer::normalize
type: function
doc:
<comment>Description:</comment>
  Normaliza a entrada fornecida e retorna a string normalizada
    
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Normaliza a entrada fornecida e retorna a string normalizada

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  A string de entrada a ser normalizada
  <info>int</info>     <strong>$form</strong>    Uma das formas de normalização.

<comment>Return:</comment>
  <info>string|false</info>  A string normalizada ou <info>false</info> se ocorrer um erro.

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


id: NumberFormatter
type: class
doc:
<comment>Description:</comment>
  Programs store and operate on numbers using a locale-independent binary representation. When
  displaying or printing a number it is converted to a locale-specific string. For example, the
  number 12345.67 is "12,345.67" in the US, "12 345,67" in France and "12.345,67" in Germany.
  
  By invoking the methods provided by the NumberFormatter class, you can format numbers, currencies,
  and percentages according to the specified or default locale. NumberFormatter is locale-sensitive
  so you need to create a new NumberFormatter for each locale. NumberFormatter methods format
  primitive-type numbers, such as double and output the number as a locale-specific string.
  
  For currencies you can use currency format type to create a formatter that returns a string with
  the formatted number and the appropriate currency sign. Of course, the NumberFormatter class is
  unaware of exchange rates so, the number output is the same regardless of the specified currency.
  This means that the same number has different monetary values depending on the currency locale. If
  the number is 9988776.65 the results will be: 9 988 776,65 € in France9.988.776,65 € in
  Germany$9,988,776.65 in the United States
  
  In order to format percentages, create a locale-specific formatter with percentage format type.
  With this formatter, a decimal fraction such as 0.75 is displayed as 75%.
  
  For more complex formatting, like spelled-out numbers, the rule-based number formatters are used.


id: NumberFormatter::CURRENCY_ACCOUNTING
type: constant
doc:
<comment>Description:</comment>
  Currency format for accounting, e.g., <return>($3.00)</return> for negative currency amount instead of <return>-$3.00</return>.
  Available as of PHP 7.4.1 and ICU 53.


id: NumberFormatter::DEFAULT_RULESET
type: constant
doc:
<comment>Description:</comment>
  The default rule set. This is only available with rule-based formatters.


id: NumberFormatter::PADDING_POSITION
type: constant
doc:
<comment>Description:</comment>
  The position at which padding will take place. See pad position constants for possible argument
  values.


id: NumberFormatter::PUBLIC_RULESETS
type: constant
doc:
<comment>Description:</comment>
  The public rule sets. This is only available with rule-based formatters. This is a read-only
  attribute. The public rulesets are returned as a single string, with each ruleset name delimited
  by ';' (semicolon).


id: NumberFormatter::ROUND_HALFDOWN
type: constant
doc:
<comment>Description:</comment>
  Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which
  case round down.


id: NumberFormatter::ROUND_HALFEVEN
type: constant
doc:
<comment>Description:</comment>
  Rounding mode to round towards the "nearest neighbor" unless both neighbors are equidistant, in
  which case, round towards the even neighbor.


id: NumberFormatter::ROUND_HALFUP
type: constant
doc:
<comment>Description:</comment>
  Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which
  case round up.


id: NumberFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  Create a number formatter
  
  Estilo orientado a objetos (method)
  
  Estilo procedural
  
  Estilo orientado a objetos (constructor):
  
  Creates a number formatter.

<comment>Param:</comment>
  <info>string</info>       <strong>$locale</strong>   Locale in which the number would be formatted (locale name, e.g. en_CA).
  <info>int</info>          <strong>$style</strong>    Style of the formatting, one of the  format style constants. If
                         <info>NumberFormatter::PATTERN_DECIMAL</info> or <info>NumberFormatter::PATTERN_RULEBASED</info> is
                         passed then the number format is opened using the given pattern, which must
                         conform to the syntax described in ICU DecimalFormat documentation or ICU
                         RuleBasedNumberFormat documentation, respectively.
  <info>string|null</info>  <strong>$pattern</strong>  Pattern string if the chosen style requires a pattern.

<comment>Return:</comment>
  <info>NumberFormatter|null</info>  Returns <class>NumberFormatter</class> object or <info>null</info> on error.

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


id: NumberFormatter::format
type: function
doc:
<comment>Description:</comment>
  Format a number
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Format a numeric value according to the formatter rules.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int|float</info>        <strong>$num</strong>        The value to format. Can be <info>int</info> or <info>float</info>, other values will be
                               converted to a numeric value.
  <info>int</info>              <strong>$type</strong>       The  formatting type to use. Note that <info>NumberFormatter::TYPE_CURRENCY</info>
                               is not supported; use NumberFormatter::formatCurrency instead.

<comment>Return:</comment>
  <info>string|false</info>  Returns the string containing formatted value, or <info>false</info> on error.

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


id: NumberFormatter::formatCurrency
type: function
doc:
<comment>Description:</comment>
  Format a currency value
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Format the currency value according to the formatter rules.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>float</info>            <strong>$amount</strong>     The numeric currency value.
  <info>string</info>           <strong>$currency</strong>   The 3-letter ISO 4217 currency code indicating the currency to use.

<comment>Return:</comment>
  <info>string|false</info>  String representing the formatted currency value,  ou <info>false</info> em caso de falha.

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


id: NumberFormatter::getAttribute
type: function
doc:
<comment>Description:</comment>
  Get an attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get a numeric attribute associated with the formatter. An example of a numeric attribute is the
  number of integer digits the formatter will produce.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the  numeric attribute constants.

<comment>Return:</comment>
  <info>int|float|false</info>  Return attribute value on success, or <info>false</info> on error.

<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>
  Get formatter's last error code
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get error code from the last function performed by the formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.

<comment>Return:</comment>
  <info>int</info>  Returns error code from last formatter call.

<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>
  Get formatter's last error message
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get error message from the last function performed by the formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.

<comment>Return:</comment>
  <info>string</info>  Returns error message from last formatter call.

<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>
  Get formatter locale
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get formatter locale name.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$type</strong>       You can choose between valid and actual locale (
                               <info>Locale::VALID_LOCALE</info>, <info>Locale::ACTUAL_LOCALE</info>, respectively). The
                               default is the actual locale.

<comment>Return:</comment>
  <info>string|false</info>  The locale name used to create the formatter, or <info>false</info> on failure.

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


id: NumberFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  Get formatter pattern
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Extract pattern used by the formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.

<comment>Return:</comment>
  <info>string|false</info>  Pattern <info>string</info> that is used by the formatter, or <info>false</info> if an error happens.

<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>
  Get a symbol value
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get a symbol associated with the formatter. The formatter uses symbols to represent the special
  locale-dependent characters in a number, for example the percent sign. This API is not supported
  for rule-based formatters.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$symbol</strong>     Symbol specifier, one of the  format symbol constants.

<comment>Return:</comment>
  <info>string|false</info>  The symbol string or <info>false</info> on 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>
  Get a text attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Get a text attribute associated with the formatter. An example of a text attribute is the suffix
  for positive numbers. If the formatter does not understand the attribute, <info>U_UNSUPPORTED_ERROR</info>
  error is produced. Rule-based formatters only understand <info>NumberFormatter::DEFAULT_RULESET</info> and
  <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the  text attribute constants.

<comment>Return:</comment>
  <info>string|false</info>  Return attribute value on success, or <info>false</info> on 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>
  Parse a number
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Parse a string into a number using the current formatter rules.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$string</strong>     The string to parse for the number.
  <info>int</info>              <strong>$type</strong>       The  formatting type to use. By default, <info>NumberFormatter::TYPE_DOUBLE</info>
                               is used. Note that <info>NumberFormatter::TYPE_CURRENCY</info> is not supported;
                               use NumberFormatter::parseCurrency instead.
  <info>int</info>              <strong>$offset</strong>     Offset in the string at which to begin parsing. On return, this value
                               will hold the offset at which parsing ended.

<comment>Return:</comment>
  <info>int|float|false</info>  The value of the parsed number or <info>false</info> on 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>
  Parse a currency number
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Parse a string into a float and a currency using the current formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$currency</strong>   Parameter to receive the currency name (3-letter ISO 4217 currency
                               code).
  <info>int</info>              <strong>$offset</strong>     Offset in the string at which to begin parsing. On return, this value
                               will hold the offset at which parsing ended.

<comment>Return:</comment>
  <info>float|false</info>  The parsed numeric value or <info>false</info> on 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>
  Set an attribute
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Set a numeric attribute associated with the formatter. An example of a numeric attribute is the
  number of integer digits the formatter will produce.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the  numeric attribute constants.
  <info>int|float</info>        <strong>$value</strong>      The attribute value.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<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>
  Set formatter pattern
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Set the pattern used by the formatter. Can not be used on a rule-based formatter.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>string</info>           <strong>$pattern</strong>    Pattern in syntax described in ICU DecimalFormat documentation.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<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>
  Set a symbol value
  
  Estilo orientado a objetos
  
  Estilo procedural
  
  Set a symbol associated with the formatter. The formatter uses symbols to represent the special
  locale-dependent characters in a number, for example the percent sign. This API is not supported
  for rule-based formatters.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$symbol</strong>     Symbol specifier, one of the  format symbol constants.
  <info>string</info>           <strong>$value</strong>      Text for the symbol.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<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 procedural
  
  Set a text attribute associated with the formatter. An example of a text attribute is the suffix
  for positive numbers. If the formatter does not understand the attribute, <info>U_UNSUPPORTED_ERROR</info>
  error is produced. Rule-based formatters only understand <info>NumberFormatter::DEFAULT_RULESET</info> and
  <info>NumberFormatter::PUBLIC_RULESETS</info>.

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> object.
  <info>int</info>              <strong>$attribute</strong>  Attribute specifier - one of the text attribute constants.
  <info>string</info>           <strong>$value</strong>      Text for the attribute value.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<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>
  This constant represents putting OAuth parameters in the <return>Authorization</return> header.


id: OAUTH_AUTH_TYPE_FORM
type: constant
doc:
<comment>Description:</comment>
  This constant represents putting OAuth parameters as part of the HTTP POST body.


id: OAUTH_AUTH_TYPE_URI
type: constant
doc:
<comment>Description:</comment>
  This constant represents putting OAuth parameters in the request URI.


id: OAUTH_BAD_NONCE
type: constant
doc:
<comment>Description:</comment>
  The oauth_nonce value was used in a previous request, therefore it cannot be used now.


id: OAUTH_BAD_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  The oauth_timestamp value was not accepted by the service provider. In this case, the response
  should also contain the oauth_acceptable_timestamps parameter.


id: OAUTH_CONSUMER_KEY_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  The oauth_consumer_key is temporarily unacceptable to the service provider. For example, the
  service provider may be throttling the consumer.


id: OAUTH_INVALID_SIGNATURE
type: constant
doc:
<comment>Description:</comment>
  The oauth_signature is invalid, as it does not match the signature computed by the service
  provider.


id: OAUTH_PARAMETER_ABSENT
type: constant
doc:
<comment>Description:</comment>
  A required parameter was not received. In this case, the response should also contain the
  oauth_parameters_absent parameter.


id: OAUTH_REQENGINE_CURL
type: constant
doc:
<comment>Description:</comment>
  Used by OAuth::setRequestEngine to set the engine to  Curl, as opposed to  <info>OAUTH_REQENGINE_STREAMS</info>
  for PHP streams.


id: OAUTH_REQENGINE_STREAMS
type: constant
doc:
<comment>Description:</comment>
  Used by OAuth::setRequestEngine to set the engine to  PHP streams, as opposed to
  <info>OAUTH_REQENGINE_CURL</info> for  Curl.


id: OAUTH_TOKEN_REJECTED
type: constant
doc:
<comment>Description:</comment>
  The oauth_token was not accepted by the service provider. The reason is not known, but it might be
  because the token was never issued, already consumed, expired, and/or forgotten by the service
  provider.


id: OAUTH_TOKEN_USED
type: constant
doc:
<comment>Description:</comment>
  The oauth_token has been consumed. It can no longer be used because it has already been used in
  the previous request(s).


id: OAuth
type: class
doc:
<comment>Description:</comment>
  The OAuth extension provides a simple interface to interact with data providers using the OAuth
  HTTP specification to protect private resources.


id: OAuth::__construct
type: function
doc:
<comment>Description:</comment>
  Create a new OAuth object
  
  Creates a new OAuth object

<comment>Param:</comment>
  <info>string</info>  <strong>$consumer_key</strong>      The consumer key provided by the service provider.
  <info>string</info>  <strong>$consumer_secret</strong>   The consumer secret provided by the service provider.
  <info>string</info>  <strong>$signature_method</strong>  This optional parameter defines which signature method to use, by
                             default it is <info>OAUTH_SIG_METHOD_HMACSHA1</info> (HMAC-SHA1).
  <info>int</info>     <strong>$auth_type</strong>         This optional parameter defines how to pass the OAuth parameters to a
                             consumer, by default it is <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> (in the
                             <return>Authorization</return> header).


id: OAuth::__destruct
type: function
doc:
<comment>Description:</comment>
  The destructor
  
  The destructor.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

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


id: OAuth::disableDebug
type: function
doc:
<comment>Description:</comment>
  Turn off verbose debugging
  
  Turns off verbose request information (off by default). Alternatively, the debug property can be
  set to a <info>false</info> value to turn debug off.

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

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


id: OAuth::disableRedirects
type: function
doc:
<comment>Description:</comment>
  Turn off redirects
  
  Disable redirects from being followed automatically, thus allowing the request to be manually
  redirected.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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


id: OAuth::disableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Turn off SSL checks
  
  Turns off the usual SSL peer certificate and host checks, this is not for production environments.
  Alternatively, the <strong>$sslChecks</strong> member can be set to <info>false</info> to turn SSL checks off.

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

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


id: OAuth::enableDebug
type: function
doc:
<comment>Description:</comment>
  Turn on verbose debugging
  
  Turns on verbose request information useful for debugging, the debug information is stored in the
  <strong>$debugInfo</strong> member. Alternatively, the <strong>$debug</strong> member can  be set to a non-<info>false</info> value to turn debug
  on.

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

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


id: OAuth::enableRedirects
type: function
doc:
<comment>Description:</comment>
  Turn on redirects
  
  Follow and sign redirects automatically, which is enabled by default.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

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


id: OAuth::enableSSLChecks
type: function
doc:
<comment>Description:</comment>
  Turn on SSL checks
  
  Turns on the usual SSL peer certificate and host checks (enabled by default). Alternatively, the
  <strong>$sslChecks</strong> member can be set to a non-<info>false</info> value to turn SSL checks off.

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

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


id: OAuth::fetch
type: function
doc:
<comment>Description:</comment>
  Fetch an OAuth protected resource
  
  Fetch a resource.

<comment>Param:</comment>
  <info>string</info>  <strong>$protected_resource_url</strong>  URL to the OAuth protected resource.
  <info>array</info>   <strong>$extra_parameters</strong>        Extra parameters to send with the request for the resource.
  <info>string</info>  <strong>$http_method</strong>             One of the <info>OAUTH_HTTP_METHOD_*</info> OAUTH constants, 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>            HTTP client headers (such as User-Agent, Accept, etc.)

<comment>Return:</comment>
  <info>mixed</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::generateSignature
type: function
doc:
<comment>Description:</comment>
  Generate a signature
  
  Generate a signature based on the final HTTP method, URL and a string/array of parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP method for request
  <info>string</info>  <strong>$url</strong>               URL for request
  <info>mixed</info>   <strong>$extra_parameters</strong>  String or array of additional parameters.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the generated signature ou <info>false</info> em caso de falha


id: OAuth::getAccessToken
type: function
doc:
<comment>Description:</comment>
  Fetch an access token
  
  Fetch an access token, secret and any additional response parameters from the service provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$access_token_url</strong>     URL to the access token API.
  <info>string</info>  <strong>$auth_session_handle</strong>  Authorization session handle, this parameter does not have any
                                citation in the core OAuth 1.0 specification but may be  implemented
                                by large providers.  See ScalableOAuth for more information.
  <info>string</info>  <strong>$verifier_token</strong>       For service providers which support 1.0a, a <strong>$verifier_token</strong> must be
                                passed while exchanging the request token for the access token. If
                                the <strong>$verifier_token</strong> is present in <strong>$_GET</strong>  or <strong>$_POST</strong> it is passed
                                automatically and the caller  does not need to specify a
                                <strong>$verifier_token</strong> (usually if the access token  is exchanged at the
                                oauth_callback URL). See ScalableOAuth for more information.
  <info>string</info>  <strong>$http_method</strong>          HTTP method to use, e.g. <return>GET</return> or <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the parsed OAuth response on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo
   * OAuth::setToken


id: OAuth::getCAPath
type: function
doc:
<comment>Description:</comment>
  Gets CA information
  
  Gets the Certificate Authority information, which includes the ca_path and ca_info set by
  OAuth::setCaPath.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Return:</comment>
  <info>array</info>  An <info>array</info> of Certificate Authority information, specifically as <return>ca_path</return> and <return>ca_info</return> keys
         within the returned associative array.

<comment>See Also:</comment>
   * OAuth::setCAPath
   * OAuth::getLastResponseInfo


id: OAuth::getLastResponse
type: function
doc:
<comment>Description:</comment>
  Get the last response
  
  Get the raw response of the most recent request.

<comment>Return:</comment>
  <info>string</info>  Returns a string containing the last response.

<comment>See Also:</comment>
   * OAuth::getLastResponseInfo
   * OAuth::fetch


id: OAuth::getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Get headers for last response
  
  Get headers for last response.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the last response's headers ou <info>false</info> em caso de falha


id: OAuth::getLastResponseInfo
type: function
doc:
<comment>Description:</comment>
  Get HTTP information about the last response
  
  Get HTTP information about the last response.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the response information for the last request. Constants from
         <strong>curl_getinfo()</strong> may be used.

<comment>See Also:</comment>
   * OAuth::fetch
   * OAuth::getLastResponse


id: OAuth::getRequestHeader
type: function
doc:
<comment>Description:</comment>
  Generate OAuth header string signature
  
  Generate OAuth header string signature based on the final HTTP method, URL and a string/array of
  parameters

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       HTTP method for request.
  <info>string</info>  <strong>$url</strong>               URL for request.
  <info>mixed</info>   <strong>$extra_parameters</strong>  String or array of additional parameters.

<comment>Return:</comment>
  <info>string|false</info>  A string containing the generated request header ou <info>false</info> em caso de falha


id: OAuth::getRequestToken
type: function
doc:
<comment>Description:</comment>
  Fetch a request token
  
  Fetch a request token, secret and any additional response parameters from the service provider.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_token_url</strong>  URL to the request token API.
  <info>string</info>  <strong>$callback_url</strong>       OAuth callback URL. If <strong>$callback_url</strong> is passed and is an empty value,
                              it is set to "oob" to address the OAuth 2009.1 advisory.
  <info>string</info>  <strong>$http_method</strong>        HTTP method to use, e.g. <return>GET</return> or <return>POST</return>.

<comment>Return:</comment>
  <info>array</info>  Returns an array containing the parsed OAuth response on success or <info>false</info> on failure.

<comment>See Also:</comment>
   * OAuth::getLastResponse
   * OAuth::getLastResponseInfo


id: OAuth::setAuthType
type: function
doc:
<comment>Description:</comment>
  Set authorization type
  
  Set where the OAuth parameters should be passed.

<comment>Param:</comment>
  <info>int</info>  <strong>$auth_type</strong>  <strong>$auth_type</strong> can be one of the following flags (in order of decreasing preference
                   as per OAuth 1.0 section 5.2): <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> Pass the OAuth
                   parameters in the HTTP <return>Authorization</return> header. <info>OAUTH_AUTH_TYPE_FORM</info> Append the
                   OAuth parameters to the HTTP POST request body. <info>OAUTH_AUTH_TYPE_URI</info> Append the
                   OAuth parameters to the request URI. <info>OAUTH_AUTH_TYPE_NONE</info> None.
                   
                   Pass the OAuth parameters in the HTTP <return>Authorization</return> header.
                   
                   Append the OAuth parameters to the HTTP POST request body.
                   
                   Append the OAuth parameters to the request URI.
                   
                   None.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if a parameter is correctly set, otherwise <info>false</info> (e.g., if an invalid
        <strong>$auth_type</strong> is passed in.)


id: OAuth::setCAPath
type: function
doc:
<comment>Description:</comment>
  Set CA path and info
  
  Sets the Certificate Authority (CA), both for path and info.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$ca_path</strong>  The CA Path being set.
  <info>string</info>  <strong>$ca_info</strong>  The CA Info being set.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> if either <strong>$ca_path</strong> or <strong>$ca_info</strong> are considered invalid.

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


id: OAuth::setNonce
type: function
doc:
<comment>Description:</comment>
  Set the nonce for subsequent requests
  
  Sets the nonce for all subsequent requests.

<comment>Param:</comment>
  <info>string</info>  <strong>$nonce</strong>  The value for oauth_nonce.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> if the <strong>$nonce</strong> is considered invalid.

<comment>See Also:</comment>
   * OAuth::setToken
   * OAuth::setAuthType
   * OAuth::setVersion


id: OAuth::setRSACertificate
type: function
doc:
<comment>Description:</comment>
  Set the RSA certificate
  
  Sets the RSA certificate.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$cert</strong>  The RSA certificate.

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info> on success, or <info>false</info> on failure (e.g., the RSA certificate cannot be parsed.)

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


id: OAuth::setRequestEngine
type: function
doc:
<comment>Description:</comment>
  The setRequestEngine purpose
  
  Sets the Request Engine, that will be sending the HTTP requests.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>int</info>  <strong>$reqengine</strong>  The desired request engine. Set to <info>OAUTH_REQENGINE_STREAMS</info> to use PHP Streams, or
                   <info>OAUTH_REQENGINE_CURL</info> to use Curl.

<comment>Return:</comment>
  <info>void</info>  Nenhum valor é retornado.

<comment>See Also:</comment>
   * Curl
   * PHP streams
   * <class>OAuthException</class>


id: OAuth::setSSLChecks
type: function
doc:
<comment>Description:</comment>
  Tweak specific SSL checks for requests
  
  Tweak specific SSL checks for requests.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: OAuth::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Set the timestamp
  
  Sets the OAuth timestamp for subsequent requests.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

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

<comment>Return:</comment>
  <info>mixed</info>  Returns <info>true</info>, unless the <strong>$timestamp</strong> is invalid, in which case <info>false</info> is returned.

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


id: OAuth::setToken
type: function
doc:
<comment>Description:</comment>
  Sets the token and secret
  
  Set the token and secret for subsequent requests.

<comment>Param:</comment>
  <info>string</info>  <strong>$token</strong>         The OAuth token.
  <info>string</info>  <strong>$token_secret</strong>  The OAuth token secret.

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


id: OAuth::setVersion
type: function
doc:
<comment>Description:</comment>
  Set the OAuth version
  
  Sets the OAuth version for subsequent requests

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>  OAuth version, default value is always "1.0"

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.


id: OAuthException
type: class
doc:
<comment>Description:</comment>
  This exception is thrown when exceptional errors occur while using the OAuth extension and
  contains useful debugging information.


id: OAuthProvider
type: class
doc:
<comment>Description:</comment>
  Manages an OAuth provider class.
  
  See also an external in-depth tutorial titled Writing an OAuth Provider Service, which takes a
  hands-on approach to providing this service. There are also  OAuth provider examples within the
  OAuth extensions sources.


id: OAuthProvider::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new OAuthProvider object
  
  Initiates a new <class>OAuthProvider</class> <info>object</info>.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>array</info>  <strong>$params_array</strong>  Setting these optional parameters is limited to the CLI SAPI.

<comment>Return:</comment>
  <info>unknown</info>  An <class>OAuthProvider</class> <info>object</info>.

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


id: OAuthProvider::addRequiredParameter
type: function
doc:
<comment>Description:</comment>
  Add required parameters
  
  Add required oauth provider parameters.
  
  Esta função não
  está documentada; apenas a lista de argumentos está disponível.

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  The required parameters.

<comment>Return:</comment>
  <info>bool</info>  Retorna <info>true</info> em caso de sucesso ou <info>false</info> em caso de falha.

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


