# functions

name: MongoDB\Driver\Manager.executeQuery
purpose: Execute a database query
manual_id: mongodb-driver-manager.executequery
version: mongodb >=1.0.0
return_type: MongoDB\Driver\Cursor
return_description: <p class="para">Returns <span class="classname">MongoDB\Driver\Cursor</span> on success.</p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors (e.g. invalid query operators).</li>
  </ul>


name: MongoDB\Driver\Manager.executeReadCommand
purpose: Execute a database command that reads
manual_id: mongodb-driver-manager.executereadcommand
version: mongodb >=1.4.0
return_type: MongoDB\Driver\Cursor
return_description: <p class="para">Returns <span class="classname">MongoDB\Driver\Cursor</span> on success.</p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the <code class="literal">&quot;session&quot;</code> option is used with an associated transaction in combination with a <code class="literal">&quot;readConcern&quot;</code> or <code class="literal">&quot;writeConcern&quot;</code> option.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors (e.g. invalid command).</li>
  </ul>


name: MongoDB\Driver\Manager.executeReadWriteCommand
purpose: Execute a database command that reads and writes
manual_id: mongodb-driver-manager.executereadwritecommand
version: mongodb >=1.4.0
return_type: MongoDB\Driver\Cursor
return_description: <p class="para">Returns <span class="classname">MongoDB\Driver\Cursor</span> on success.</p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the <code class="literal">&quot;session&quot;</code> option is used with an associated transaction in combination with a <code class="literal">&quot;readConcern&quot;</code> or <code class="literal">&quot;writeConcern&quot;</code> option.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the <code class="literal">&quot;session&quot;</code> option is used in combination with an unacknowledged write concern.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors (e.g. invalid command).</li>
  </ul>


name: MongoDB\Driver\Manager.getEncryptedFieldsMap
purpose: Return the encryptedFieldsMap auto encryption option for the Manager
manual_id: mongodb-driver-manager.getencryptedfieldsmap
version: mongodb >=1.14.0
return_type: null
return_description:
<p class="para">
   The <code class="literal">encryptedFieldsMap</code> auto encryption option for the
   Manager, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if it was not specified.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
  </ul>


name: MongoDB\Driver\Manager.getReadConcern
purpose: Return the ReadConcern for the Manager
manual_id: mongodb-driver-manager.getreadconcern
version: mongodb >=1.1.0
return_type: MongoDB\Driver\ReadConcern
return_description:
<p class="para">
   The <span class="classname">MongoDB\Driver\ReadConcern</span> for the Manager.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
  </ul>


name: MongoDB\Driver\Manager.getReadPreference
purpose: Return the ReadPreference for the Manager
manual_id: mongodb-driver-manager.getreadpreference
version: mongodb >=1.0.0
return_type: MongoDB\Driver\ReadPreference
return_description:
<p class="para">
   The <span class="classname">MongoDB\Driver\ReadPreference</span> for the Manager.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
  </ul>


name: MongoDB\Driver\Manager.getServers
purpose: Return the servers to which this manager is connected
manual_id: mongodb-driver-manager.getservers
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of <span class="classname">MongoDB\Driver\Server</span>
   instances to which this manager is connected.
  </p>


name: MongoDB\Driver\Manager.getWriteConcern
purpose: Return the WriteConcern for the Manager
manual_id: mongodb-driver-manager.getwriteconcern
version: mongodb >=1.0.0
return_type: MongoDB\Driver\WriteConcern
return_description:
<p class="para">
   The <span class="classname">MongoDB\Driver\WriteConcern</span> for the Manager.
  </p>


name: MongoDB\Driver\Manager.selectServer
purpose: Select a server matching a read preference
manual_id: mongodb-driver-manager.selectserver
version: mongodb >=1.0.0
return_type: MongoDB\Driver\Server
return_description:
<p class="para">
   Returns a <span class="classname">MongoDB\Driver\Server</span> matching the read
   preference.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if a server matching the read preference could not be found.</li>
  </ul>


name: MongoDB\Driver\Manager.startSession
purpose: Start a new client session for use with this client
manual_id: mongodb-driver-manager.startsession
version: mongodb >=1.4.0
return_type: MongoDB\Driver\Session
return_description: <p class="para"> Returns a <span class="classname">MongoDB\Driver\Session</span>. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the <code class="literal">&quot;causalConsistency&quot;</code> and <code class="literal">&quot;snapshot&quot;</code> options are both <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the session could not be created (e.g. libmongoc does not support crypto).</li>
  </ul>


name: MongoDB\Driver\BulkWrite.count
purpose: Count number of write operations in the bulk
manual_id: mongodb-driver-bulkwrite.count
version: mongodb >=1.0.0
return_type: int
return_description:
<p class="para">
   Returns number of write operations added to the
   <span class="classname">MongoDB\Driver\BulkWrite</span> object.
  </p>


name: MongoDB\Driver\BulkWrite.insert
purpose: Add an insert operation to the bulk
manual_id: mongodb-driver-bulkwrite.insert
version: mongodb >=1.0.0
return_type: mixed
return_description:
<p class="para">
   Returns the <code class="literal">_id</code> of the inserted document. If the
   <code class="parameter">document</code> did not have an <code class="literal">_id</code>, the
   <span class="classname">MongoDB\BSON\ObjectId</span> generated for the insert will
   be returned.
  </p>


name: MongoDB\Driver\Session.abortTransaction
purpose: Aborts a transaction
manual_id: mongodb-driver-session.aborttransaction
version: mongodb >=1.5.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the transaction could not be aborted (e.g. a transaction was not started).</li>
  </ul>


name: MongoDB\Driver\Session.commitTransaction
purpose: Commits a transaction
manual_id: mongodb-driver-session.committransaction
version: mongodb >=1.5.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws
   <span class="classname">MongoDB\Driver\Exception\CommandException</span> if the
   server could not commit the transaction (e.g. due to conflicts, network
   issues). In case the exception's
    <span class="methodname">MongoDB\Driver\Exception\CommandException::getResultDocument</span>
   has a <code class="literal">&quot;errorLabels&quot;</code> element, and this array contains a
   <code class="literal">&quot;TransientTransactionError&quot;</code> or
   <code class="literal">&quot;UnUnknownTransactionCommitResult&quot;</code> value, it is safe to re-try
   the <em>whole</em> transaction. In newer versions of the
   driver,
    <span class="methodname">MongoDB\Driver\Exception\RuntimeException::hasErrorLabel</span>
   should be used to test for this situation instead.</li>
   <li>Throws
   <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the
   transaction could not be commited (e.g. a transaction was not
   started).</li>
  </ul>


name: MongoDB\Driver\Session.getClusterTime
purpose: Returns the cluster time for this session
manual_id: mongodb-driver-session.getclustertime
version: mongodb >=1.4.0
return_type: null
return_description:
<p class="para">
   Returns the cluster time for this session, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the session has no
   cluster time.
  </p>


name: MongoDB\Driver\Session.getOperationTime
purpose: Returns the operation time for this session
manual_id: mongodb-driver-session.getoperationtime
version: mongodb >=1.4.0
return_type: null
return_description:
<p class="para">
   Returns the operation time for this session, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the session has no
   operation time.
  </p>


name: MongoDB\Driver\Session.getServer
purpose: Returns the server to which this session is pinned
manual_id: mongodb-driver-session.getserver
version: mongodb >=1.6.0
return_type: null
return_description:
<p class="para">
   Returns the <span class="classname">MongoDB\Driver\Server</span> to which this
   session is pinned, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the session is not pinned to any server.
  </p>


name: MongoDB\Driver\Session.getTransactionOptions
purpose: Returns options for the currently running transaction
manual_id: mongodb-driver-session.gettransactionoptions
version: mongodb >=1.7.0
return_type: null
return_description:
<p class="para">
   Returns a <span class="type">array</span> containing current transaction options, or
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no transaction is running.
  </p>


name: MongoDB\Driver\Session.isInTransaction
purpose: Returns whether a multi-document transaction is in progress
manual_id: mongodb-driver-session.isintransaction
version: mongodb >=1.6.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a transaction is currently in progress for this session,
   and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Session.startTransaction
purpose: Starts a transaction
manual_id: mongodb-driver-session.starttransaction
version: mongodb >=1.5.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\CommandException</span> if the transaction could not be started because of a server-side problem (e.g. a lock could not be obtained).</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the transaction could not be started (e.g. a transaction was already started).</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.addKeyAltName
purpose: Adds an alternate name to a key document
manual_id: mongodb-driver-clientencryption.addkeyaltname
version: mongodb >=1.15.0
return_type: null
return_description:
<p class="para">
   Returns the previous version of the key document, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no document
   matched.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors.</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.createDataKey
purpose: Creates a key document
manual_id: mongodb-driver-clientencryption.createdatakey
version: mongodb >=1.7.0
return_type: MongoDB\BSON\Binary
return_description:
<p class="para">
   Returns the identifier of the new key as a
   <span class="classname">MongoDB\BSON\Binary</span> object with subtype 4 (UUID).
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors.</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.decrypt
purpose: Decrypt a value
manual_id: mongodb-driver-clientencryption.decrypt
version: mongodb >=1.7.0
return_type: mixed
return_description:
<p class="para">
   Returns the decrypted value as it was passed to
   <span class="function">MongoDB\Driver\ClientEncryption::encrypt</span>.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\EncryptionException</span> if an error occurs while decrypting the value</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.deleteKey
purpose: Deletes a key document
manual_id: mongodb-driver-clientencryption.deletekey
version: mongodb >=1.15.0
return_type: object
return_description:
<p class="para">
   Returns the result of the internal <code class="literal">deleteOne</code> operation on
   the key vault collection.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors.</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.encrypt
purpose: Encrypt a value
manual_id: mongodb-driver-clientencryption.encrypt
version: mongodb >=1.7.0
return_type: MongoDB\BSON\Binary
return_description:
<p class="para">
   Returns the encrypted value as
   <span class="classname">MongoDB\BSON\Binary</span> object with subtype 6.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\EncryptionException</span> if an error occurs while encrypting the value</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.encryptExpression
purpose: Encrypts a match or aggregate expression
manual_id: mongodb-driver-clientencryption.encryptexpression
version: mongodb >=1.16.0
return_type: object
return_description: <p class="para"> Returns the encrypted expression as an object. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\EncryptionException</span> if an error occurs while encrypting the expression</li>
  </ul>


name: MongoDB\Driver\ClientEncryption.getKey
purpose: Gets a key document
manual_id: mongodb-driver-clientencryption.getkey
version: mongodb >=1.15.0
return_type: null
return_description:
<p class="para">
   Returns the key document, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no document matched.
  </p>


name: MongoDB\Driver\ClientEncryption.rewrapManyDataKey
purpose: Rewraps data keys
manual_id: mongodb-driver-clientencryption.rewrapmanydatakey
version: mongodb >=1.15.0
return_type: object
return_description:
<p class="para">
   Returns an object, which will have an optional
   <code class="literal">bulkWriteResult</code> property containing the result of the
   internal <code class="literal">bulkWrite</code> operation as an object. If no data keys
   matched the filter or the write was unacknowledged, the
   <code class="literal">bulkWriteResult</code> property will be <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\EncryptionException</span> if an error occurs while decrypting or re-encrypting a data key.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> on other errors.</li>
  </ul>


name: MongoDB\Driver\ServerApi.serialize
purpose: Serialize a ServerApi
manual_id: mongodb-driver-serverapi.serialize
version: mongodb >=1.10.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\Driver\ServerApi</span>.
  </p>


name: MongoDB\Driver\ServerApi.unserialize
purpose: Unserialize a ServerApi
manual_id: mongodb-driver-serverapi.unserialize
version: mongodb >=1.10.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the properties cannot be unserialized (i.e. <code class="parameter">serialized</code> was malformed).</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the properties are invalid (e.g. missing fields or invalid values).</li>
  </ul>


name: MongoDB\Driver\WriteConcern.__construct
purpose: Create a new WriteConcern
manual_id: mongodb-driver-writeconcern.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">w</code> is invalid or <code class="parameter">wtimeout</code> is either negative or greater than the bounds of a signed 32-bit integer.</li>
  </ul>


name: MongoDB\Driver\WriteConcern.isDefault
purpose: Checks if this is the default write concern
manual_id: mongodb-driver-writeconcern.isdefault
version: mongodb >=1.3.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this is the default write concern and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\WriteConcern.serialize
purpose: Serialize a WriteConcern
manual_id: mongodb-driver-writeconcern.serialize
version: mongodb >=1.7.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\Driver\WriteConcern</span>.
  </p>


name: MongoDB\Driver\ReadPreference.__construct
purpose: Create a new ReadPreference
manual_id: mongodb-driver-readpreference.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">mode</code> is invalid.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">tagSets</code> is provided for a primary read preference or is malformed (i.e. not an array of zero or more documents).</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the <code class="literal">&quot;maxStalenessSeconds&quot;</code> option is provided for a primary read preference or is out of range.</li>
  </ul>


name: MongoDB\Driver\ReadPreference.getMaxStalenessSeconds
purpose: Returns the ReadPreference's "maxStalenessSeconds" option
manual_id: mongodb-driver-readpreference.getmaxstalenessseconds
version: mongodb >=1.2.0
return_type: int
return_description:
<p class="para">
   Returns the ReadPreference&#039;s &quot;maxStalenessSeconds&quot; option. If no max
   staleness has been specified,
   <strong><code><a href="class.mongodb-driver-readpreference.html#mongodb-driver-readpreference.constants.no-max-staleness">MongoDB\Driver\ReadPreference::NO_MAX_STALENESS</a></code></strong> will be
   returned.
  </p>


name: MongoDB\Driver\ReadPreference.serialize
purpose: Serialize a ReadPreference
manual_id: mongodb-driver-readpreference.serialize
version: mongodb >=1.7.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\Driver\ReadPreference</span>.
  </p>


name: MongoDB\Driver\ReadConcern.isDefault
purpose: Checks if this is the default read concern
manual_id: mongodb-driver-readconcern.isdefault
version: mongodb >=1.3.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this is the default read concern and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\ReadConcern.serialize
purpose: Serialize a ReadConcern
manual_id: mongodb-driver-readconcern.serialize
version: mongodb >=1.7.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\Driver\ReadConcern</span>.
  </p>


name: MongoDB\Driver\Cursor.current
purpose: Returns the current element
manual_id: mongodb-driver-cursor.current
version: mongodb >=1.9.0
return_type: null
return_description:
<p class="para">
   Returns the current result document as an array or object, depending on the
   cursor&#039;s type map. If iteration has not started or the current position
   is not valid, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned.
  </p>


name: MongoDB\Driver\Cursor.getId
purpose: Returns the ID for this cursor
manual_id: mongodb-driver-cursor.getid
version: mongodb >=1.0.0
return_type: MongoDB\Driver\CursorId
return_description:
<p class="para">
   Returns the <span class="classname">MongoDB\Driver\CursorId</span> for this cursor.
  </p>


name: MongoDB\Driver\Cursor.getServer
purpose: Returns the server associated with this cursor
manual_id: mongodb-driver-cursor.getserver
version: mongodb >=1.0.0
return_type: MongoDB\Driver\Server
return_description:
<p class="para">
   Returns the <span class="classname">MongoDB\Driver\Server</span> associated with this
   cursor.
  </p>


name: MongoDB\Driver\Cursor.isDead
purpose: Checks if the cursor is exhausted or may have additional results
manual_id: mongodb-driver-cursor.isdead
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there are definitely no additional results available on the
   cursor, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Cursor.next
purpose: Advances the cursor to the next result
manual_id: mongodb-driver-cursor.next
version: mongodb >=1.9.0
return_type: void
return_description: <p class="para"> Moves the current position to the next element in the cursor. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
  </ul>


name: MongoDB\Driver\Cursor.rewind
purpose: Rewind the cursor to the first result
manual_id: mongodb-driver-cursor.rewind
version: mongodb >=1.9.0
return_type: void
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li><li>Throws <span class="classname">MongoDB\Driver\Exception\ConnectionException</span> if connection to the server fails (for reasons other than authentication).</li><li>Throws <span class="classname">MongoDB\Driver\Exception\AuthenticationException</span> if authentication is needed and fails.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\LogicException</span> if this method is called after the cursor has advanced beyond its first position.</li>
  </ul>


name: MongoDB\Driver\Cursor.setTypeMap
purpose: Sets a type map to use for BSON unserialization
manual_id: mongodb-driver-cursor.settypemap
version: mongodb >=1.0.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
  </ul>
  <p class="para">
   When iterating over the cursor, the following exceptions can also be thrown
   due to an incorrect type map configuration:
   <ul class="simplelist">
    <li>
     Throws
     <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if
     a class in the type map cannot be instantiated or does not implement
     <span class="interfacename">MongoDB\BSON\Unserializable</span>.
    </li>
   </ul>
  </p>


name: MongoDB\Driver\Cursor.toArray
purpose: Returns an array containing all results for this cursor
manual_id: mongodb-driver-cursor.toarray
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> containing all results for this cursor.
  </p>


name: MongoDB\Driver\Cursor.valid
purpose: Checks if the current position in the cursor is valid
manual_id: mongodb-driver-cursor.valid
version: mongodb >=1.9.0
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current cursor position is valid, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\CursorId.serialize
purpose: Serialize a CursorId
manual_id: mongodb-driver-cursorid.serialize
version: mongodb >=1.7.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\Driver\CursorId</span>.
  </p>


name: MongoDB\Driver\CursorId.__toString
purpose: String representation of the cursor ID
manual_id: mongodb-driver-cursorid.tostring
version: mongodb >=1.0.0
return_type: string
return_description:
<p class="para">
   Returns the <span class="type">string</span> representation of the cursor ID.
  </p>


name: MongoDB\Driver\CursorInterface.isDead
purpose: Checks if the cursor may have additional results
manual_id: mongodb-driver-cursorinterface.isdead
version: mongodb >=1.6.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if additional results are not available, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: MongoDB\Driver\Server.getLatency
purpose: Returns the latency of this server in milliseconds
manual_id: mongodb-driver-server.getlatency
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the latency of this server in milliseconds, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no latency
   has been measured (e.g. client is connected to a load balancer).
  </p>


name: MongoDB\Driver\Server.getServerDescription
purpose: Returns a ServerDescription for this server
manual_id: mongodb-driver-server.getserverdescription
version: mongodb >=1.13.0
return_type: MongoDB\Driver\ServerDescription
return_description:
<p class="para">
   Returns a <span class="classname">MongoDB\Driver\ServerDescription</span> for this
   server.
  </p>


name: MongoDB\Driver\Server.getTags
purpose: Returns an array of tags describing this server in a replica set
manual_id: mongodb-driver-server.gettags
version: mongodb >=1.0.0
return_type: string
return_description:
<p class="para">
   Returns an <span class="type">array</span> of tags used to describe this server in a
   replica set.
  </p>


name: MongoDB\Driver\Server.getType
purpose: Returns an integer denoting the type of this server
manual_id: mongodb-driver-server.gettype
version: mongodb >=1.0.0
return_type: int
return_description:
<p class="para">
   Returns an <span class="type">int</span> denoting the type of this server.
  </p>


name: MongoDB\Driver\Server.isArbiter
purpose: Checks if this server is an arbiter member of a replica set
manual_id: mongodb-driver-server.isarbiter
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this server is an arbiter member of a replica set, and
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Server.isHidden
purpose: Checks if this server is a hidden member of a replica set
manual_id: mongodb-driver-server.ishidden
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this server is a hidden member of a replica set, and
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Server.isPassive
purpose: Checks if this server is a passive member of a replica set
manual_id: mongodb-driver-server.ispassive
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this server is a passive member of a replica set, and
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Server.isPrimary
purpose: Checks if this server is a primary member of a replica set
manual_id: mongodb-driver-server.isprimary
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this server is a primary member of a replica set, and
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\Server.isSecondary
purpose: Checks if this server is a secondary member of a replica set
manual_id: mongodb-driver-server.issecondary
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this server is a secondary member of a replica set, and
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\Driver\ServerDescription.getType
purpose: Returns a string denoting the type of this server
manual_id: mongodb-driver-serverdescription.gettype
version: mongodb >=1.13.0
return_type: string
return_description:
<p class="para">
   Returns a <span class="type">string</span> denoting the type of this server.
  </p>


name: MongoDB\Driver\TopologyDescription.getServers
purpose: Returns the servers in the topology
manual_id: mongodb-driver-topologydescription.getservers
version: mongodb >=1.13.0
return_type: array
return_description:
<p class="para">
   Returns an array of <span class="classname">MongoDB\Driver\ServerDescription</span>
   objects corresponding to the known servers in the topology.
  </p>


name: MongoDB\Driver\TopologyDescription.getType
purpose: Returns a string denoting the type of this topology
manual_id: mongodb-driver-topologydescription.gettype
version: mongodb >=1.13.0
return_type: string
return_description:
<p class="para">
   Returns a <span class="type">string</span> denoting the type of this topology.
  </p>


name: MongoDB\Driver\TopologyDescription.hasReadableServer
purpose: Returns whether the topology has a readable server
manual_id: mongodb-driver-topologydescription.hasreadableserver
version: mongodb >=1.13.0
return_type: bool
return_description:
<p class="para">
   Returns whether the topology has a readable server or, if
   <code class="parameter">readPreference</code> is specified, a server matching the
   specified read preference.
  </p>


name: MongoDB\Driver\WriteConcernError.getInfo
purpose: Returns metadata document for the WriteConcernError
manual_id: mongodb-driver-writeconcernerror.getinfo
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the metadata document for the WriteConcernError, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if
   no metadata is available.
  </p>


name: MongoDB\Driver\WriteError.getIndex
purpose: Returns the index of the write operation corresponding to this WriteError
manual_id: mongodb-driver-writeerror.getindex
version: mongodb >=1.0.0
return_type: int
return_description:
<p class="para">
   Returns the index of the write operation (from
   <span class="classname">MongoDB\Driver\BulkWrite</span>) corresponding to this
   WriteError.
  </p>


name: MongoDB\Driver\WriteError.getInfo
purpose: Returns metadata document for the WriteError
manual_id: mongodb-driver-writeerror.getinfo
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the metadata document for the WriteError, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no metadata is
   available.
  </p>


name: MongoDB\Driver\WriteResult.getDeletedCount
purpose: Returns the number of documents deleted
manual_id: mongodb-driver-writeresult.getdeletedcount
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the number of documents deleted, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the write was not
   acknowledged.
  </p>


name: MongoDB\Driver\WriteResult.getInsertedCount
purpose: Returns the number of documents inserted (excluding upserts)
manual_id: mongodb-driver-writeresult.getinsertedcount
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the number of documents inserted (excluding upserts), or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if
   the write was not acknowledged.
  </p>


name: MongoDB\Driver\WriteResult.getMatchedCount
purpose: Returns the number of documents selected for update
manual_id: mongodb-driver-writeresult.getmatchedcount
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the number of documents selected for update, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the write
   was not acknowledged.
  </p>


name: MongoDB\Driver\WriteResult.getModifiedCount
purpose: Returns the number of existing documents updated
manual_id: mongodb-driver-writeresult.getmodifiedcount
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns the number of existing documents updated, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the write was
   not acknowledged.
  </p>
  <p class="para">
   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 <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: MongoDB\Driver\WriteResult.getServer
purpose: Returns the server associated with this write result
manual_id: mongodb-driver-writeresult.getserver
version: mongodb >=1.0.0
return_type: MongoDB\Driver\Server
return_description:
<p class="para">
   Returns the <span class="classname">MongoDB\Driver\Server</span> associated with this
   write result.
  </p>


name: MongoDB\Driver\WriteResult.getUpsertedIds
purpose: Returns an array of identifiers for upserted documents
manual_id: mongodb-driver-writeresult.getupsertedids
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   Returns an array of identifiers (i.e. <code class="literal">&quot;_id&quot;</code> field values)
   for upserted documents. The array keys will correspond to the index of the
   write operation (from <span class="classname">MongoDB\Driver\BulkWrite</span>)
   responsible for the upsert.
  </p>


name: MongoDB\Driver\WriteResult.getWriteConcernError
purpose: Returns any write concern error that occurred
manual_id: mongodb-driver-writeresult.getwriteconcernerror
version: mongodb >=1.0.0
return_type: null
return_description:
<p class="para">
   Returns a <span class="classname">MongoDB\Driver\WriteConcernError</span> if a write
   concern error was encountered during the write operation, and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   otherwise.
  </p>


name: MongoDB\Driver\WriteResult.getWriteErrors
purpose: Returns any write errors that occurred
manual_id: mongodb-driver-writeresult.getwriteerrors
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   Returns an array of <span class="classname">MongoDB\Driver\WriteError</span> objects
   for any write errors encountered during the write operation. The array will
   be empty if no write errors occurred.
  </p>


name: MongoDB\Driver\WriteResult.isAcknowledged
purpose: Returns whether the write was acknowledged
manual_id: mongodb-driver-writeresult.isacknowledged
version: mongodb >=1.0.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the write was acknowledged, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\BSON\fromJSON
purpose: Returns the BSON representation of a JSON value
manual_id: function.mongodb.bson-fromjson
version: mongodb >=1.0.0
return_type: string
return_description: <p class="para"> The serialized BSON document as a binary string. </p>
errors:
<ul class="simplelist">
   <li>
    Throws
    <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if
    the JSON value cannot be converted to BSON (e.g. due to a syntax error).
   </li>
  </ul>


name: MongoDB\BSON\fromPHP
purpose: Returns the BSON representation of a PHP value
manual_id: function.mongodb.bson-fromphp
version: mongodb >=1.0.0
return_type: string
return_description: <p class="para"> The serialized BSON document as a binary string. </p>
errors:
<ul class="simplelist">
   <li>
    Throws
    <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if
    the PHP value cannot be converted to BSON. Possible reasons include, but are
    not limited to, encountering an unexpected
    <span class="interfacename">MongoDB\BSON\Type</span> instance or
    <span class="function">MongoDB\BSON\Serializable::bsonSerialize</span> failing to
    return an <span class="type">array</span> or <span class="classname">stdClass</span>.
   </li>
  </ul>


name: MongoDB\BSON\toCanonicalExtendedJSON
purpose: Returns the Canonical Extended JSON representation of a BSON value
manual_id: function.mongodb.bson-tocanonicalextendedjson
version: mongodb >=1.3.0
return_type: string
return_description: <p class="para"> The converted JSON value. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected <a href="https://github.com/mongodb/mongo-c-driver/tree/master/src/libbson" class="link external">&raquo;&nbsp;libbson</a> error.</li>
  </ul>


name: MongoDB\BSON\toPHP
purpose: Returns the PHP representation of a BSON value
manual_id: function.mongodb.bson-tophp
version: mongodb >=1.0.0
return_type: object
return_description: <p class="para"> The unserialized PHP value. </p>
errors:
<ul class="simplelist">
   <li>
    Throws
    <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if
    a class in the type map cannot be instantiated or does not implement
    <span class="interfacename">MongoDB\BSON\Unserializable</span>.
   </li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected <a href="https://github.com/mongodb/mongo-c-driver/tree/master/src/libbson" class="link external">&raquo;&nbsp;libbson</a> error.</li>
  </ul>


name: MongoDB\BSON\Document.fromBSON
purpose: Construct a new document instance from a BSON string
manual_id: mongodb-bson-document.frombson
version: mongodb >=1.16.0
return_type: MongoDB\BSON\Document
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if <code class="parameter">bson</code> is an invalid BSON string or contains more than a single document.</li>
  </ul>


name: MongoDB\BSON\Document.fromJSON
purpose: Construct a new document instance from a JSON string
manual_id: mongodb-bson-document.fromjson
version: mongodb >=1.16.0
return_type: MongoDB\BSON\Document
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if <code class="parameter">json</code> is not a valid document.</li>
  </ul>


name: MongoDB\BSON\Document.get
purpose: Returns the value of a key in the document
manual_id: mongodb-bson-document.get
version: mongodb >=1.16.0
return_type: mixed
return_description:
<p class="para">
   Returns the value associated with the given key. If the key is not present in
   the document, an exception is thrown.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    When encountering a value encoded as 64-bit integer in the BSON document,
    the return value of this method will be a
    <span class="classname">MongoDB\BSON\Int64</span> instance.
   </span>
  </p></blockquote>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the key is not present in the document.</li>
  </ul>


name: MongoDB\BSON\Document.getIterator
purpose: Returns an iterator for the BSON document
manual_id: mongodb-bson-document.getiterator
version: mongodb >=1.16.0
return_type: MongoDB\BSON\Iterator
return_description:
<p class="para">
   Returns a <span class="classname">MongoDB\BSON\Iterator</span> instance that can be
   used to iterate over all keys in the document.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the BSON iterator could not be initialized.</li>
  </ul>


name: MongoDB\BSON\Document.has
purpose: Returns whether a key is present in the document
manual_id: mongodb-bson-document.has
version: mongodb >=1.16.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the key is present in the document and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\BSON\Document.serialize
purpose: Serialize a Document
manual_id: mongodb-bson-document.serialize
version: mongodb >=1.16.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Document</span>.
  </p>


name: MongoDB\BSON\Document.toPHP
purpose: Returns the PHP representation of the BSON document
manual_id: mongodb-bson-document.tophp
version: mongodb >=1.16.0
return_type: object
return_description:
<p class="para">
   The decoded PHP value.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    When encountering a value encoded as 64-bit integer in the BSON document,
    the return value of this method will be a
    <span class="classname">MongoDB\BSON\Int64</span> instance.
   </span>
  </p></blockquote>

errors:
<ul class="simplelist">
   <li>
    Throws
    <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if
    a class in the type map cannot be instantiated or does not implement
    <span class="interfacename">MongoDB\BSON\Unserializable</span>.
   </li>
  </ul>


name: MongoDB\BSON\Document.unserialize
purpose: Unserialize a BSON document
manual_id: mongodb-bson-document.unserialize
version: mongodb >=1.16.0
return_type: void
return_description: <p class="para"> No value is returned. </p>
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the properties cannot be unserialized (i.e. <code class="parameter">data</code> was malformed).</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the properties are invalid (e.g. missing fields or invalid values).</li>
  </ul>


name: MongoDB\BSON\PackedArray.fromPHP
purpose: Construct a new BSON array instance from PHP data
manual_id: mongodb-bson-packedarray.fromphp
version: mongodb >=1.16.0
return_type: MongoDB\BSON\PackedArray
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if the given array is not a list (i.e. has sequential numeric keys starting with <code class="literal">0</code>).</li>
  </ul>


name: MongoDB\BSON\PackedArray.get
purpose: Returns the value of an index in the array
manual_id: mongodb-bson-packedarray.get
version: mongodb >=1.16.0
return_type: mixed
return_description:
<p class="para">
   Returns the value associated with the given index. If the index is not
   present in the document, an exception is thrown.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    When encountering a value encoded as 64-bit integer in the BSON array,
    the return value of this method will be a
    <span class="classname">MongoDB\BSON\Int64</span> instance.
   </span>
  </p></blockquote>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\RuntimeException</span> if the index is not present in the array.</li>
  </ul>


name: MongoDB\BSON\PackedArray.getIterator
purpose: Returns an iterator for the BSON array
manual_id: mongodb-bson-packedarray.getiterator
version: mongodb >=1.16.0
return_type: MongoDB\BSON\Iterator
return_description:
<p class="para">
   Returns a <span class="classname">MongoDB\BSON\Iterator</span> instance that can be
   used to iterate over all indexes in the array.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\UnexpectedValueException</span> if the BSON iterator could not be initialized.</li>
  </ul>


name: MongoDB\BSON\PackedArray.has
purpose: Returns whether a index is present in the array
manual_id: mongodb-bson-packedarray.has
version: mongodb >=1.16.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the index is present in the array and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\BSON\PackedArray.serialize
purpose: Serialize a BSON array
manual_id: mongodb-bson-packedarray.serialize
version: mongodb >=1.16.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\PackedArray</span>.
  </p>


name: MongoDB\BSON\PackedArray.toPHP
purpose: Returns the PHP representation of the BSON array
manual_id: mongodb-bson-packedarray.tophp
version: mongodb >=1.16.0
return_type: object
return_description:
<p class="para">
   The decoded PHP value.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    When encountering a value encoded as 64-bit integer in the BSON array,
    the return value of this method will be a
    <span class="classname">MongoDB\BSON\Int64</span> instance.
   </span>
  </p></blockquote>

errors:
<ul class="simplelist">
   <li>
    Throws
    <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if
    a class in the type map cannot be instantiated or does not implement
    <span class="interfacename">MongoDB\BSON\Unserializable</span>.
   </li>
  </ul>


name: MongoDB\BSON\Iterator.current
purpose: Returns the current element
manual_id: mongodb-bson-iterator.current
version: mongodb >=1.16.0
return_type: mixed
return_description:
<p class="para">
   Returns the value of the current element.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    When encountering a value encoded as 64-bit integer in the BSON structure,
    the return value of this method will be a
    <span class="classname">MongoDB\BSON\Int64</span> instance.
   </span>
  </p></blockquote>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\LogicException</span> if the iterator is not valid.</li>
  </ul>


name: MongoDB\BSON\Iterator.key
purpose: Returns the key of the current element
manual_id: mongodb-bson-iterator.key
version: mongodb >=1.16.0
return_type: int
return_description:
<p class="para">
   Returns the key of the current element. When iterating a BSON document, the
   key will always be a <span class="type">string</span>. When iterating a BSON array, the
   key will be an <span class="type">int</span>.
  </p>

errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\LogicException</span> if the iterator is not valid.</li>
  </ul>


name: MongoDB\BSON\Iterator.valid
purpose: Checks if current position is valid
manual_id: mongodb-bson-iterator.valid
version: mongodb >=1.16.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current iterator position is valid, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: MongoDB\BSON\Binary.__construct
purpose: Construct a new Binary
manual_id: mongodb-bson-binary.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">type</code> is not an unsigned 8-bit integer.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">type</code> is <strong><code><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-uuid">MongoDB\BSON\Binary::TYPE_UUID</a></code></strong> or <strong><code><a href="class.mongodb-bson-binary.html#mongodb-bson-binary.constants.type-old-uuid">MongoDB\BSON\Binary::TYPE_OLD_UUID</a></code></strong> and <code class="parameter">data</code> is not exactly 16 bytes in length.</li>
  </ul>


name: MongoDB\BSON\Binary.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-binary.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Binary</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Binary.serialize
purpose: Serialize a Binary
manual_id: mongodb-bson-binary.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Binary</span>.
  </p>


name: MongoDB\BSON\Decimal128.__construct
purpose: Construct a new Decimal128
manual_id: mongodb-bson-decimal128.construct
version: mongodb >=1.2.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">value</code> is not a valid decimal string.</li>
  </ul>


name: MongoDB\BSON\Decimal128.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-decimal128.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Decimal128</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Decimal128.serialize
purpose: Serialize a Decimal128
manual_id: mongodb-bson-decimal128.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Decimal128</span>.
  </p>


name: MongoDB\BSON\Javascript.__construct
purpose: Construct a new Javascript
manual_id: mongodb-bson-javascript.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">code</code> contains null bytes.</li>
  </ul>


name: MongoDB\BSON\Javascript.getScope
purpose: Returns the Javascript's scope document
manual_id: mongodb-bson-javascript.getscope
version: mongodb >=1.2.0
return_type: null
return_description:
<p class="para">
   Returns the Javascript&#039;s scope document, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the is no scope.
  </p>


name: MongoDB\BSON\Javascript.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-javascript.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Javascript</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Javascript.serialize
purpose: Serialize a Javascript
manual_id: mongodb-bson-javascript.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Javascript</span>.
  </p>


name: MongoDB\BSON\MaxKey.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-maxkey.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\MaxKey</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\MaxKey.serialize
purpose: Serialize a MaxKey
manual_id: mongodb-bson-maxkey.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\MaxKey</span>.
  </p>


name: MongoDB\BSON\MinKey.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-minkey.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\MinKey</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\MinKey.serialize
purpose: Serialize a MinKey
manual_id: mongodb-bson-minkey.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\MinKey</span>.
  </p>


name: MongoDB\BSON\ObjectId.__construct
purpose: Construct a new ObjectId
manual_id: mongodb-bson-objectid.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">id</code> is not a 24-character hexadecimal string.</li>
  </ul>


name: MongoDB\BSON\ObjectId.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-objectid.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\ObjectId</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\ObjectId.serialize
purpose: Serialize an ObjectId
manual_id: mongodb-bson-objectid.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\ObjectId</span>.
  </p>


name: MongoDB\BSON\Regex.__construct
purpose: Construct a new Regex
manual_id: mongodb-bson-regex.construct
version: mongodb >=1.0.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if <code class="parameter">pattern</code> or <code class="parameter">flags</code> contain null bytes.</li>
  </ul>


name: MongoDB\BSON\Regex.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-regex.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Regex</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Regex.serialize
purpose: Serialize a Regex
manual_id: mongodb-bson-regex.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Regex</span>.
  </p>


name: MongoDB\BSON\Timestamp.getIncrement
purpose: Returns the increment component of this Timestamp
manual_id: mongodb-bson-timestamp.getincrement
version: mongodb >=1.3.0
return_type: int
return_description:
<p class="para">
   Returns the increment component of this Timestamp.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    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.
   </p>
  </div>


name: MongoDB\BSON\Timestamp.getTimestamp
purpose: Returns the timestamp component of this Timestamp
manual_id: mongodb-bson-timestamp.gettimestamp
version: mongodb >=1.3.0
return_type: int
return_description:
<p class="para">
   Returns the timestamp component of this Timestamp.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    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.
   </p>
  </div>


name: MongoDB\BSON\Timestamp.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-timestamp.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Timestamp</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Timestamp.serialize
purpose: Serialize a Timestamp
manual_id: mongodb-bson-timestamp.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Timestamp</span>.
  </p>


name: MongoDB\BSON\UTCDateTime.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-utcdatetime.jsonserialize
version: mongodb >=1.2.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\UTCDateTime</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\UTCDateTime.serialize
purpose: Serialize a UTCDateTime
manual_id: mongodb-bson-utcdatetime.serialize
version: mongodb >=1.2.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\UTCDateTime</span>.
  </p>


name: MongoDB\BSON\UTCDateTime.toDateTime
purpose: Returns the DateTime representation of this UTCDateTime
manual_id: mongodb-bson-utcdatetime.todatetime
version: mongodb >=1.0.0
return_type: DateTime
return_description:
<p class="para">
   Returns the <span class="classname">DateTime</span> representation of this
   UTCDateTime. The returned <span class="classname">DateTime</span> will use the UTC
   time zone.
  </p>


name: MongoDB\BSON\Persistable.bsonSerialize
purpose: Provides an array or document to serialize as BSON
manual_id: mongodb-bson-persistable.bsonserialize
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span>, <span class="classname">stdClass</span>, or <span class="classname">MongoDB\BSON\Document</span>
   to be serialized as a BSON document.
  </p>


name: MongoDB\BSON\Serializable.bsonSerialize
purpose: Provides an array or document to serialize as BSON
manual_id: mongodb-bson-serializable.bsonserialize
version: mongodb >=1.0.0
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span>, <span class="classname">stdClass</span>, <span class="classname">MongoDB\BSON\Document</span>,
   or <span class="classname">MongoDB\BSON\PackedArray</span> to be serialized as a BSON
   array or document.
  </p>


name: MongoDB\BSON\TimestampInterface.getIncrement
purpose: Returns the increment component of this TimestampInterface
manual_id: mongodb-bson-timestampinterface.getincrement
version: mongodb >=1.3.0
return_type: int
return_description:
<p class="para">
   Returns the increment component of this TimestampInterface.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    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.
   </p>
  </div>


name: MongoDB\BSON\TimestampInterface.getTimestamp
purpose: Returns the timestamp component of this TimestampInterface
manual_id: mongodb-bson-timestampinterface.gettimestamp
version: mongodb >=1.3.0
return_type: int
return_description:
<p class="para">
   Returns the timestamp component of this TimestampInterface.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="simpara">
    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.
   </p>
  </div>


name: MongoDB\BSON\UTCDateTimeInterface.toDateTime
purpose: Returns the DateTime representation of this UTCDateTimeInterface
manual_id: mongodb-bson-utcdatetimeinterface.todatetime
version: mongodb >=1.3.0
return_type: DateTime
return_description:
<p class="para">
   Returns the <span class="classname">DateTime</span> representation of this
   UTCDateTimeInterface. The returned <span class="classname">DateTime</span> should use
   the UTC time zone.
  </p>


name: MongoDB\BSON\DBPointer.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-dbpointer.jsonserialize
version: mongodb >=1.4.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\DBPointer</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\DBPointer.serialize
purpose: Serialize a DBPointer
manual_id: mongodb-bson-dbpointer.serialize
version: mongodb >=1.4.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\DBPointer</span>.
  </p>


name: MongoDB\BSON\Int64.__construct
purpose: Construct a new Int64
manual_id: mongodb-bson-int64.construct
version: mongodb >=1.5.0
errors:
<ul class="simplelist">
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> on argument parsing errors.</li>
   <li>Throws <span class="classname">MongoDB\Driver\Exception\InvalidArgumentException</span> if string <code class="parameter">value</code> cannot be parsed as a 64-bit integer.</li>
  </ul>


name: MongoDB\BSON\Int64.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-int64.jsonserialize
version: mongodb >=1.5.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Int64</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span> function, which
    uses the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON format. This differs from other BSON classes, which use the
    driver-specific legacy extended JSON format
    (<span class="function">MongoDB\BSON\toJSON</span>), in order to ensure that the
    64-bit integer value is correctly represented on 32-bit platforms.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Int64.serialize
purpose: Serialize an Int64
manual_id: mongodb-bson-int64.serialize
version: mongodb >=1.5.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Int64</span>.
  </p>


name: MongoDB\BSON\Symbol.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-symbol.jsonserialize
version: mongodb >=1.4.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Symbol</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Symbol.serialize
purpose: Serialize a Symbol
manual_id: mongodb-bson-symbol.serialize
version: mongodb >=1.4.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Symbol</span>.
  </p>


name: MongoDB\BSON\Undefined.jsonSerialize
purpose: Returns a representation that can be converted to JSON
manual_id: mongodb-bson-undefined.jsonserialize
version: mongodb >=1.4.0
return_type: mixed
return_description:
<p class="para">
   Returns data which can be serialized by <span class="function">json_encode</span> to
   produce an extended JSON representation of the
   <span class="classname">MongoDB\BSON\Undefined</span>.
  </p>
  
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The output is consistent with the <span class="function">MongoDB\BSON\toJSON</span>
    function, which uses the driver-specific legacy extended JSON format. This
    does not necessarily match the
    <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#relaxed-extended-json-example" class="link external">&raquo;&nbsp;relaxed</a>
    or <a href="https://github.com/mongodb/specifications/blob/master/source/extended-json.rst#canonical-extended-json-example" class="link external">&raquo;&nbsp;canonical</a>
    extended JSON representations used by
    <span class="function">MongoDB\BSON\toRelaxedExtendedJSON</span> and
    <span class="function">MongoDB\BSON\toCanonicalExtendedJSON</span>, respectively.
   </span>
  </p></blockquote>


name: MongoDB\BSON\Undefined.serialize
purpose: Serialize a Undefined
manual_id: mongodb-bson-undefined.serialize
version: mongodb >=1.4.0
return_type: string
return_description:
<p class="para">
   Returns the serialized representation of the
   <span class="classname">MongoDB\BSON\Undefined</span>.
  </p>


name: MongoDB\Driver\Monitoring\CommandFailedEvent.getError
purpose: Returns the Exception associated with the failed command
manual_id: mongodb-driver-monitoring-commandfailedevent.geterror
version: mongodb >=1.3.0
return_type: Exception
return_description:
<p class="para">
   Returns the <span class="classname">Exception</span> associated with the failed command.
  </p>


name: MongoDB\Driver\Monitoring\CommandFailedEvent.getReply
purpose: Returns the command reply document
manual_id: mongodb-driver-monitoring-commandfailedevent.getreply
version: mongodb >=1.5.0
return_type: stdClass
return_description:
<p class="para">
   Returns the command reply document as a <span class="classname">stdClass</span>
   object.
  </p>


name: MongoDB\Driver\Monitoring\CommandFailedEvent.getServer
purpose: Returns the Server on which the command was executed
manual_id: mongodb-driver-monitoring-commandfailedevent.getserver
version: mongodb >=1.3.0
return_type: MongoDB\Driver\Server
return_description:
<p class="para">
   Returns the <span class="classname">MongoDB\Driver\Server</span> on which the command
   was executed.
  </p>


name: MongoDB\Driver\Monitoring\CommandFailedEvent.getServerConnectionId
purpose: Returns the server connection ID for the command
manual_id: mongodb-driver-monitoring-commandfailedevent.getserverconnectionid
version: mongodb >=1.14.0
return_type: null
return_description:
<p class="para">
   Returns the server connection ID, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if it is not available.
  </p>


name: MongoDB\Driver\Monitoring\CommandFailedEvent.getServiceId
purpose: Returns the load balancer service ID for the command
manual_id: mongodb-driver-monitoring-commandfailedevent.getserviceid
version: mongodb >=1.11.0
return_type: null
return_description:
<p class="para">
   Returns the load balancer service ID, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the driver is not
   connected to a load balancer.
  </p>


name: MongoDB\Driver\Monitoring\CommandStartedEvent.getCommand
purpose: Returns the command document
manual_id: mongodb-driver-monitoring-commandstartedevent.getcommand
version: mongodb >=1.3.0
return_type: stdClass
return_description:
<p class="para">
   Returns the command document as a <span class="classname">stdClass</span> object.
  </p>


name: MongoDB\Driver\Monitoring\ServerChangedEvent.getNewDescription
purpose: Returns the new description for the server
manual_id: mongodb-driver-monitoring-serverchangedevent.getnewdescription
version: mongodb >=1.13.0
return_type: MongoDB\Driver\ServerDescription
return_description:
<p class="para">
   Returns the new <span class="classname">MongoDB\Driver\ServerDescription</span>
   for the server.
  </p>


name: MongoDB\Driver\Monitoring\ServerChangedEvent.getPreviousDescription
purpose: Returns the previous description for the server
manual_id: mongodb-driver-monitoring-serverchangedevent.getpreviousdescription
version: mongodb >=1.13.0
return_type: MongoDB\Driver\ServerDescription
return_description:
<p class="para">
   Returns the previous <span class="classname">MongoDB\Driver\ServerDescription</span>
   for the server.
  </p>


name: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent.getError
purpose: Returns the Exception associated with the failed heartbeat
manual_id: mongodb-driver-monitoring-serverheartbeatfailedevent.geterror
version: mongodb >=1.13.0
return_type: Exception
return_description:
<p class="para">
   Returns the <span class="classname">Exception</span> associated with the failed
   heartbeat.
  </p>


name: MongoDB\Driver\Monitoring\ServerHeartbeatFailedEvent.isAwaited
purpose: Returns whether the heartbeat used a streaming protocol
manual_id: mongodb-driver-monitoring-serverheartbeatfailedevent.isawaited
version: mongodb >=1.13.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: MongoDB\Driver\Monitoring\ServerHeartbeatSucceededEvent.getReply
purpose: Returns the heartbeat reply document
manual_id: mongodb-driver-monitoring-serverheartbeatsucceededevent.getreply
version: mongodb >=1.13.0
return_type: stdClass
return_description:
<p class="para">
   Returns the heartbeat reply document as a <span class="classname">stdClass</span>
   object.
  </p>


name: MongoDB\Driver\Monitoring\TopologyChangedEvent.getNewDescription
purpose: Returns the new description for the topology
manual_id: mongodb-driver-monitoring-topologychangedevent.getnewdescription
version: mongodb >=1.13.0
return_type: MongoDB\Driver\TopologyDescription
return_description:
<p class="para">
   Returns the new <span class="classname">MongoDB\Driver\TopologyDescription</span>
   for the topology.
  </p>


name: MongoDB\Driver\Monitoring\TopologyChangedEvent.getPreviousDescription
purpose: Returns the previous description for the topology
manual_id: mongodb-driver-monitoring-topologychangedevent.getpreviousdescription
version: mongodb >=1.13.0
return_type: MongoDB\Driver\TopologyDescription
return_description:
<p class="para">
   Returns the previous <span class="classname">MongoDB\Driver\TopologyDescription</span>
   for the topology.
  </p>


name: MongoDB\Driver\Exception\RuntimeException.hasErrorLabel
purpose: Returns whether an error label is associated with an exception
manual_id: mongodb-driver-runtimeexception.haserrorlabel
version: mongodb >= 1.6.0
return_type: bool
return_description:
<p class="para">
   Whether the given <code class="literal">errorLabel</code> is associated with this
   exception.
  </p>


name: MongoDB\Driver\Exception\WriteException.getWriteResult
purpose: Returns the WriteResult for the failed write operation
manual_id: mongodb-driver-writeexception.getwriteresult
version: mongodb >= 1.0.0
return_type: MongoDB\Driver\WriteResult
return_description:
<p class="para">
   The <span class="classname">MongoDB\Driver\WriteResult</span> for the failed write
   operation.
  </p>


name: mysqli.$affected_rows
purpose: Gets the number of affected rows in a previous MySQL operation
manual_id: mysqli.affected-rows
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   An integer greater than zero indicates the number of rows affected or
   retrieved. Zero indicates that no records were updated for an 
   <code class="literal">UPDATE</code> statement, no rows matched the
   <code class="literal">WHERE</code> clause in the query or that no query has yet been
   executed. <code class="literal">-1</code> indicates that the query returned an error or
   that <span class="function">mysqli_affected_rows</span> was called for an unbuffered
   <code class="literal">SELECT</code> query.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the number of affected rows is greater than the maximum int value
    (<strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>), the number of affected rows will be
    returned as a string.
   </p>
  </p></blockquote>


name: mysqli.autocommit
purpose: Turns on or off auto-committing database modifications
manual_id: mysqli.autocommit
version: PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
If mysqli error reporting is enabled (<strong><code><a href="mysqli.constants.html#constant.mysqli-report-error">MYSQLI_REPORT_ERROR</a></code></strong>) and the requested operation fails,
a warning is generated. If, in addition, the mode is set to <strong><code><a href="mysqli.constants.html#constant.mysqli-report-strict">MYSQLI_REPORT_STRICT</a></code></strong>,
a <span class="classname">mysqli_sql_exception</span> is thrown instead.</p>


name: mysqli.$connect_errno
purpose: Returns the error code from last connect call
manual_id: mysqli.connect-errno
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   An error code for the last connection attempt, if it failed.
   Zero means no error occurred.
  </p>


name: mysqli.$connect_error
purpose: Returns a description of the last connection error
manual_id: mysqli.connect-error
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A string that describes the error. <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned if no error occurred.
  </p>


name: mysqli.__construct
purpose: Open a new connection to the MySQL server
manual_id: mysqli.construct
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">mysqli_connect</span> returns an object which represents the connection to a MySQL Server,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
    <span class="methodname">mysqli::connect</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Prior to PHP 8.1.0, returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on success.
  </p>


name: mysqli.$errno
purpose: Returns the error code for the most recent function call
manual_id: mysqli.errno
version: PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   An error code value for the last call, if it failed. zero means no error
   occurred.
  </p>


name: mysqli.$error_list
purpose: Returns a list of errors from the last command executed
manual_id: mysqli.error-list
version: PHP 5 >= 5.4.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   A list of errors, each as an associative <span class="type">array</span>
   containing the errno, error, and sqlstate.
  </p>


name: mysqli.$error
purpose: Returns a string description of the last error
manual_id: mysqli.error
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
    A string that describes the error. An empty string if no error occurred.
  </p>


name: mysqli.execute_query
purpose: Prepares, binds parameters, and executes SQL statement
manual_id: mysqli.execute-query
version: PHP 8 >= 8.2.0
return_type: array
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. For successful queries which produce a result
   set, such as <code class="literal">SELECT, SHOW, DESCRIBE</code> or
   <code class="literal">EXPLAIN</code>, returns
   a <span class="classname">mysqli_result</span> object. For other successful queries,
   returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
  </p>


name: mysqli.get_charset
purpose: Returns a character set object
manual_id: mysqli.get-charset
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   The function returns a character set object with the following properties:
   <dl>
    
     <dt><code class="parameter">charset</code></dt>
     <dd><p class="para">Character set name</p></dd>
    
    
     <dt><code class="parameter">collation</code></dt>
     <dd><p class="para">Collation name</p></dd>
    
    
     <dt><code class="parameter">dir</code></dt>
     <dd><p class="para">Directory the charset description was fetched from (?) or &quot;&quot; for built-in character sets</p></dd>
    
    
     <dt><code class="parameter">min_length</code></dt>
     <dd><p class="para">Minimum character length in bytes</p></dd>
    
    
     <dt><code class="parameter">max_length</code></dt>
     <dd><p class="para">Maximum character length in bytes</p></dd>
    
    
     <dt><code class="parameter">number</code></dt>
     <dd><p class="para">Internal character set number</p></dd>
    
    
     <dt><code class="parameter">state</code></dt>
     <dd><p class="para">Character set status (?)</p></dd>
    
   </dl>
  </p>


name: mysqli.$client_version
purpose: Returns the MySQL client version as an integer
manual_id: mysqli.get-client-version
return_type: int
return_description:
<p class="para">
   A number that represents the MySQL client library version in format:
   <code class="literal">main_version*10000 + minor_version *100 + sub_version</code>.
   For example, 4.1.0 is returned as 40100.
  </p>
  <p class="para">
   This is useful to quickly determine the version of the client library
   to know if some capability exists.
  </p>


name: mysqli.$host_info
purpose: Returns a string representing the type of connection used
manual_id: mysqli.get-host-info
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A character string representing the server hostname and the connection type.
  </p>


name: mysqli.$server_version
purpose: Returns the version of the MySQL server as an integer
manual_id: mysqli.get-server-version
return_type: int
return_description:
<p class="para">
   An integer representing the server version.
  </p>
  <p class="para">
   The form of this version number is
   <code class="literal">main_version * 10000 + minor_version * 100 + sub_version</code>
   (i.e. version 4.1.0 is 40100).
  </p>


name: mysqli.$info
purpose: Retrieves information about the most recently executed query
manual_id: mysqli.info
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   A character string representing additional information about the most recently executed query.
  </p>


name: mysqli.init
purpose: Initializes MySQLi and returns an object for use with mysqli_real_connect()
manual_id: mysqli.init
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    <span class="methodname">mysqli::init</span> returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   <span class="function">mysqli_init</span> returns an object on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysqli.$insert_id
purpose: Returns the value generated for an AUTO_INCREMENT column by the last query
manual_id: mysqli.insert-id
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The value of the <code class="literal">AUTO_INCREMENT</code> field that was updated
   by the previous query. Returns zero if there was no previous query on the
   connection or if the query did not update an <code class="literal">AUTO_INCREMENT</code>
   value.
  </p>
  <p class="para">
   Only statements issued using the current connection affect the return value. The
   value is not affected by statements issued using other connections or clients.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the number is greater than the maximum int value, it will be returned as
    a string.
   </p>
  </p></blockquote>


name: mysqli.more_results
purpose: Check if there are any more query results from a multi query
manual_id: mysqli.more-results
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if one or more result sets (including errors) are available from a previous call to
   <span class="function">mysqli_multi_query</span>, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mysqli.multi_query
purpose: Performs one or more queries on the database
manual_id: mysqli.multi-query
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the first statement failed.
   To retrieve subsequent errors from other statements you have to call
   <span class="function">mysqli_next_result</span> first.
  </p>


name: mysqli.next_result
purpose: Prepare next result from multi_query
manual_id: mysqli.next-result
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. Also returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the next statement resulted in an error, unlike  <span class="methodname">mysqli_more_results</span>.
  </p>


name: mysqli.poll
purpose: Poll connections
manual_id: mysqli.poll
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns number of ready connections upon success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown when neither
   the <code class="parameter">read</code> nor <code class="parameter">error</code> arguments are passed.
  </p>


name: mysqli.prepare
purpose: Prepares an SQL statement for execution
manual_id: mysqli.prepare
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">mysqli_prepare</span> returns a statement object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: mysqli.query
purpose: Performs a query on the database
manual_id: mysqli.query
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. For successful queries which produce a result
   set, such as <code class="literal">SELECT, SHOW, DESCRIBE</code> or
   <code class="literal">EXPLAIN</code>, <span class="function">mysqli_query</span> will return
   a <span class="classname">mysqli_result</span> object. For other successful queries,
   <span class="function">mysqli_query</span> will
   return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
  </p>


name: mysqli.real_escape_string
manual_id: mysqli.real-escape-string
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description: <p class="para"> Returns an escaped string. </p>
purpose:
Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection


name: mysqli.reap_async_query
purpose: Get result from async query
manual_id: mysqli.reap-async-query
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. For successful queries which produce a result set, such as <code class="literal">SELECT, SHOW, DESCRIBE</code> or
   <code class="literal">EXPLAIN</code>, <span class="function">mysqli_reap_async_query</span> will return
   a <span class="classname">mysqli_result</span> object. For other successful queries, <span class="function">mysqli_reap_async_query</span> will
   return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>.
  </p>


name: mysqli.refresh
purpose: Refreshes
manual_id: mysqli.refresh
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the refresh was a success, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: mysqli.$sqlstate
purpose: Returns the SQLSTATE error from previous MySQL operation
manual_id: mysqli.sqlstate
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a string containing the SQLSTATE error code for the last error.
   The error code consists of five characters. <code class="literal">&#039;00000&#039;</code> means no error.
  </p>


name: mysqli.ssl_set
purpose: Used for establishing secure connections using SSL
manual_id: mysqli.ssl-set
version: PHP 5, PHP 7, PHP 8
return_type: true
return_description:
<p class="para">
   Always returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. If SSL setup is
   incorrect <span class="function">mysqli_real_connect</span> will return an error
   when you attempt to connect.
  </p>


name: mysqli.stat
purpose: Gets the current system status
manual_id: mysqli.stat
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A string describing the server status. <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: mysqli.store_result
purpose: Transfers a result set from the last query
manual_id: mysqli.store-result
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a buffered result object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    <span class="function">mysqli_store_result</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in case the query
    didn&#039;t return a result set (if the query was, for example an INSERT
    statement). This function also returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the reading of the
    result set failed. You can check if you have got an error by checking
    if <span class="function">mysqli_error</span> doesn&#039;t return an empty string, if
    <span class="function">mysqli_errno</span> returns a non zero value, or if
    <span class="function">mysqli_field_count</span> returns a non zero value.
    Also possible reason for this function returning <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> after
    successful call to <span class="function">mysqli_query</span> can be too large
    result set (memory for it cannot be allocated). If
    <span class="function">mysqli_field_count</span> returns a non-zero value, the
    statement should have produced a non-empty result set.
   </p>
  </p></blockquote>


name: mysqli.thread_safe
purpose: Returns whether thread safety is given or not
manual_id: mysqli.thread-safe
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the client library is thread-safe, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mysqli.use_result
purpose: Initiate a result set retrieval
manual_id: mysqli.use-result
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an unbuffered result object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: mysqli_stmt.$affected_rows
manual_id: mysqli-stmt.affected-rows
version: PHP 5, PHP 7, PHP 8
return_type: string
purpose:
Returns the total number of rows changed, deleted, inserted, or  matched by the last statement executed

return_description:
<p class="para">
   An integer greater than zero indicates the number of rows affected or
   retrieved. Zero indicates that no records were updated for an 
   <code class="literal">UPDATE</code> statement, no rows matched the
   <code class="literal">WHERE</code> clause in the query or that no query has yet been
   executed. <code class="literal">-1</code> indicates that the query returned an error or
   that, for a <code class="literal">SELECT</code> query,
   <span class="function">mysqli_stmt_affected_rows</span> was called prior to calling
   <span class="function">mysqli_stmt_store_result</span>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the number of affected rows is greater than maximum PHP int value, the
    number of affected rows will be returned as a string value.
   </p>
  </p></blockquote>


name: mysqli_stmt.fetch
purpose: Fetch results from a prepared statement into the bound variables
manual_id: mysqli-stmt.fetch
version: PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<table id="mysqli-stmt.fetch.returnvalues" class="doctable table">
   <caption><strong>Return Values</strong></caption>
   
    <thead>
     <tr>
      <th>Value</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong></td>
      <td>Success. Data has been fetched</td>
     </tr>

     <tr>
      <td><strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong></td>
      <td>Error occurred</td>
     </tr>

     <tr>
      <td><strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong></td>
      <td>No more rows/data exists or data truncation occurred</td>
     </tr>

    </tbody>
   
  </table>


name: mysqli_stmt.get_result
purpose: Gets a result set from a prepared statement as a mysqli_result object
manual_id: mysqli-stmt.get-result
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. For successful queries which produce a result set, such as <code class="literal">SELECT, SHOW, DESCRIBE</code> or
   <code class="literal">EXPLAIN</code>, <span class="function">mysqli_stmt_get_result</span> will return
   a <span class="classname">mysqli_result</span> object. For other successful queries, <span class="function">mysqli_stmt_get_result</span> will
   return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. The <span class="function">mysqli_stmt_errno</span> function can be
   used to distinguish between the two reasons for <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>; due to a bug, prior to PHP 7.4.13,
   <span class="function">mysqli_errno</span> had to be used for this purpose.
  </p>


name: mysqli_stmt.more_results
purpose: Check if there are more query results from a multiple query
manual_id: mysqli-stmt.more-results
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if more results exist, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mysqli_stmt.$num_rows
purpose: Returns the number of rows fetched from the server
manual_id: mysqli-stmt.num-rows
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   An <span class="type">int</span> representing the number of buffered rows.
   Returns <code class="literal">0</code> in unbuffered mode unless all rows have been
   fetched from the server.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
<p class="para">If the number of rows is greater than <strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>,
the number will be returned as a <span class="type">string</span>.</p></p></blockquote>


name: mysqli_stmt.result_metadata
purpose: Returns result set metadata from a prepared statement
manual_id: mysqli-stmt.result-metadata
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a result object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: mysqli_result.fetch_array
purpose: Fetch the next row of a result set as an associative, a numeric array, or both
manual_id: mysqli-result.fetch-array
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array representing the fetched row, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there
   are no more rows in the result set,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysqli_result.fetch_assoc
purpose: Fetch the next row of a result set as an associative array
manual_id: mysqli-result.fetch-assoc
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array representing the fetched row,
   where each key in the array represents the name of one of the result
   set&#039;s columns, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there
   are no more rows in the result set,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysqli_result.fetch_column
purpose: Fetch a single column from the next row of a result set
manual_id: mysqli-result.fetch-column
version: PHP 8 >= 8.1.0
return_type: false
return_description:
<p class="para">
   Returns a single column
   from the next row of a result set or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    There is no way to return another column from the same row if you
    use this function to retrieve data.
   </p>
  </div>


name: mysqli_result.fetch_field_direct
purpose: Fetch meta-data for a single field
manual_id: mysqli-result.fetch-field-direct
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an object which contains field definition information or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if no field information for specified <code class="parameter">index</code> is
   available.
  </p>
  <table class="doctable table">
   <caption><strong>Object properties</strong></caption>
   
    <thead>
     <tr>
      <th>Property</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>name</td>
      <td>The name of the column</td>
     </tr>

     <tr>
      <td>orgname</td>
      <td>Original column name if an alias was specified</td>
     </tr>

     <tr>
      <td>table</td>
      <td>The name of the table this field belongs to (if not calculated)</td>
     </tr>

     <tr>
      <td>orgtable</td>
      <td>Original table name if an alias was specified</td>
     </tr>

     <tr>
      <td>def</td>
      <td>Unused. Always an empty string</td>
     </tr>

     <tr>
      <td>db</td>
      <td>The name of the database</td>
     </tr>

     <tr>
      <td>catalog</td>
      <td>Unused. Always <code class="literal">&quot;def&quot;</code></td>
     </tr>

     <tr>
      <td>max_length</td>
      <td>The maximum width of the field for the result set. As of PHP 8.1, this value is always <code class="literal">0</code>.</td>
     </tr>

     <tr>
      <td>length</td>
      <td>
       The width of the field in bytes. For string columns,
       the length value varies on the connection character set. For example,
       if the character set is <code class="literal">latin1</code>, a single-byte character set,
       the length value for a <code class="literal">SELECT &#039;abc&#039;</code> query is 3.
       If the character set is <code class="literal">utf8mb4</code>, a multibyte character
       set in which characters take up to 4 bytes, the length value is 12.
      </td>
     </tr>

     <tr>
      <td>charsetnr</td>
      <td>The character set number for the field.</td>
     </tr>

     <tr>
      <td>flags</td>
      <td>An integer representing the bit-flags for the field.</td>
     </tr>

     <tr>
      <td>type</td>
      <td>The data type used for this field</td>
     </tr>

     <tr>
      <td>decimals</td>
      <td>The number of decimals for numeric fields, and the fractional seconds precision for temporal fields.</td>
     </tr>

    </tbody>
   
  </table>


name: mysqli_result.fetch_field
purpose: Returns the next field in the result set
manual_id: mysqli-result.fetch-field
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an object which contains field definition information or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if no field information is available.
  </p>
  <table class="doctable table">
   <caption><strong>Object properties</strong></caption>
   
    <thead>
     <tr>
      <th>Property</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>name</td>
      <td>The name of the column</td>
     </tr>

     <tr>
      <td>orgname</td>
      <td>Original column name if an alias was specified</td>
     </tr>

     <tr>
      <td>table</td>
      <td>The name of the table this field belongs to (if not calculated)</td>
     </tr>

     <tr>
      <td>orgtable</td>
      <td>Original table name if an alias was specified</td>
     </tr>

     <tr>
      <td>def</td>
      <td>Unused. Always an empty string</td>
     </tr>

     <tr>
      <td>db</td>
      <td>The name of the database</td>
     </tr>

     <tr>
      <td>catalog</td>
      <td>Unused. Always <code class="literal">&quot;def&quot;</code></td>
     </tr>

     <tr>
      <td>max_length</td>
      <td>The maximum width of the field for the result set. As of PHP 8.1, this value is always <code class="literal">0</code>.</td>
     </tr>

     <tr>
      <td>length</td>
      <td>
       The width of the field in bytes. For string columns,
       the length value varies on the connection character set. For example,
       if the character set is <code class="literal">latin1</code>, a single-byte character set,
       the length value for a <code class="literal">SELECT &#039;abc&#039;</code> query is 3.
       If the character set is <code class="literal">utf8mb4</code>, a multibyte character
       set in which characters take up to 4 bytes, the length value is 12.
      </td>
     </tr>

     <tr>
      <td>charsetnr</td>
      <td>The character set number for the field.</td>
     </tr>

     <tr>
      <td>flags</td>
      <td>An integer representing the bit-flags for the field.</td>
     </tr>

     <tr>
      <td>type</td>
      <td>The data type used for this field</td>
     </tr>

     <tr>
      <td>decimals</td>
      <td>The number of decimals for numeric fields, and the fractional seconds precision for temporal fields.</td>
     </tr>

    </tbody>
   
  </table>


name: mysqli_result.fetch_fields
purpose: Returns an array of objects representing the fields in a result set
manual_id: mysqli-result.fetch-fields
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of objects containing field definition information.
  </p>

  <table class="doctable table">
   <caption><strong>Object properties</strong></caption>
   
    <thead>
     <tr>
      <th>Property</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>name</td>
      <td>The name of the column</td>
     </tr>

     <tr>
      <td>orgname</td>
      <td>Original column name if an alias was specified</td>
     </tr>

     <tr>
      <td>table</td>
      <td>The name of the table this field belongs to (if not calculated)</td>
     </tr>

     <tr>
      <td>orgtable</td>
      <td>Original table name if an alias was specified</td>
     </tr>

     <tr>
      <td>def</td>
      <td>Unused. Always an empty string</td>
     </tr>

     <tr>
      <td>db</td>
      <td>The name of the database</td>
     </tr>

     <tr>
      <td>catalog</td>
      <td>Unused. Always <code class="literal">&quot;def&quot;</code></td>
     </tr>

     <tr>
      <td>max_length</td>
      <td>The maximum width of the field for the result set. As of PHP 8.1, this value is always <code class="literal">0</code>.</td>
     </tr>

     <tr>
      <td>length</td>
      <td>
       The width of the field in bytes. For string columns,
       the length value varies on the connection character set. For example,
       if the character set is <code class="literal">latin1</code>, a single-byte character set,
       the length value for a <code class="literal">SELECT &#039;abc&#039;</code> query is 3.
       If the character set is <code class="literal">utf8mb4</code>, a multibyte character
       set in which characters take up to 4 bytes, the length value is 12.
      </td>
     </tr>

     <tr>
      <td>charsetnr</td>
      <td>The character set number for the field.</td>
     </tr>

     <tr>
      <td>flags</td>
      <td>An integer representing the bit-flags for the field.</td>
     </tr>

     <tr>
      <td>type</td>
      <td>The data type used for this field</td>
     </tr>

     <tr>
      <td>decimals</td>
      <td>The number of decimals for numeric fields, and the fractional seconds precision for temporal fields.</td>
     </tr>

    </tbody>
   
  </table>


name: mysqli_result.fetch_object
purpose: Fetch the next row of a result set as an object
manual_id: mysqli-result.fetch-object
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an object representing the fetched row, where each property
   represents the name of the result set&#039;s column, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there
   are no more rows in the result set,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown when
   the <code class="parameter">constructor_args</code> is non-empty with the class not having constructor.
  </p>


name: mysqli_result.fetch_row
purpose: Fetch the next row of a result set as an enumerated array
manual_id: mysqli-result.fetch-row
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an enumerated array representing the fetched row, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there
   are no more rows in the result set,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysqli_result.$lengths
purpose: Returns the lengths of the columns of the current row in the result set
manual_id: mysqli-result.lengths
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An array of integers representing the size of each column (not including
   any terminating null characters). <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>
  <p class="para">
   <span class="function">mysqli_fetch_lengths</span> is valid only for the current
   row of the result set. It returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if you call it before calling
   mysqli_fetch_row/array/object or after retrieving all rows in the result.
  </p>


name: mysqli_result.$num_rows
purpose: Gets the number of rows in the result set
manual_id: mysqli-result.num-rows
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   An <span class="type">int</span> representing the number of fetched rows.
   Returns <code class="literal">0</code> in unbuffered mode unless all rows have been
   fetched from the server.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
<p class="para">If the number of rows is greater than <strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>,
the number will be returned as a <span class="type">string</span>.</p></p></blockquote>


name: mysqli_warning.next
purpose: Fetch next warning
manual_id: mysqli-warning.next
version: PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if next warning was fetched successfully.
   If there are no more warnings, it will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: mysqli_sql_exception.getSqlState
purpose: Returns the SQLSTATE error code
manual_id: mysqli-sql-exception.getsqlstate
version: PHP 8 >= 8.1.2
return_type: string
return_description:
<p class="para">
   Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters.
  </p>


name: mysqli_get_links_stats
purpose: Return information about open and cached links
manual_id: function.mysqli-get-links-stats
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   <span class="function">mysqli_get_links_stats</span> returns an associative array
   with three elements, keyed as follows:
   <dl>
    
     <dt><code class="parameter">total</code></dt>
     <dd>
      <p class="para">
       An <span class="type">int</span> indicating the total number of open links in
       any state.
      </p>
     </dd>
    
    
     <dt><code class="parameter">active_plinks</code></dt>
     <dd>
      <p class="para">
       An <span class="type">int</span> representing the number of active persistent
       connections.
      </p>
     </dd>
    
    
     <dt><code class="parameter">cached_plinks</code></dt>
     <dd>
      <p class="para">
       An <span class="type">int</span> representing the number of inactive persistent
       connections.
      </p>
     </dd>
    
   </dl>
  </p>


name: BaseResult.getWarnings
purpose: Fetch warnings from last operation
manual_id: mysql-xdevapi-baseresult.getwarnings
return_type: array
return_description:
<p class="para">
   An array of Warning objects from the last operation. Each object
   defines an error &#039;message&#039;, error &#039;level&#039;, and error &#039;code&#039;. An empty
   array is returned if no errors are present.
  </p>


name: mysql_xdevapi\Client.close
purpose: Close client
manual_id: mysql-xdevapi-client.close
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if connections are closed.
  </p>


name: Collection.add
purpose: Add collection document
manual_id: mysql-xdevapi-collection.add
return_type: mysql_xdevapi\CollectionAdd
return_description:
<p class="para">
   A CollectionAdd object. Use execute() to return a Result that can be used to query the number 
   of affected items, the number warnings generated by the operation, or to fetch a list of 
   generated IDs for the inserted documents.
  </p>


name: Collection.dropIndex
purpose: Drop collection index
manual_id: mysql-xdevapi-collection.dropindex
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the DROP INDEX operation succeeded, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Collection.existsInDatabase
purpose: Check if collection exists in database
manual_id: mysql-xdevapi-collection.existsindatabase
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if collection exists in the database, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not.
  </p>
  <p class="para">
    A table defined with two columns (doc and _id) is considered a collection, 
    and a third _json_schema column as of MySQL 8.0.21. 
    Adding an additional column means existsInDatabase() will no longer see it as a collection.
  </p>


name: Collection.find
purpose: Search for document
manual_id: mysql-xdevapi-collection.find
return_type: mysql_xdevapi\CollectionFind
return_description:
<p class="para">
   A CollectionFind object to verify the operation,
   or fetch the found documents.
  </p>


name: Collection.getOne
purpose: Get one document
manual_id: mysql-xdevapi-collection.getone
return_type: Document
return_description:
<p class="para">
   The collection object, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the _id does not match a document.
  </p>


name: Collection.getSchema
purpose: Get schema object
manual_id: mysql-xdevapi-collection.getschema
return_type: Schema Object
return_description:
<p class="para">
   The schema object on success, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the object cannot be retrieved
   for the given collection.
  </p>


name: Collection.modify
purpose: Modify collection documents
manual_id: mysql-xdevapi-collection.modify
return_type: mysql_xdevapi\CollectionModify
return_description:
<p class="para">
   If the operation is not executed, then the function will return 
   a Modify object that can be used to add additional
   modify operations.
  </p>
  <p class="para">
   If the modify operation is executed, then the returned object will contain
   the result of the operation.
  </p>


name: Collection.remove
purpose: Remove collection documents
manual_id: mysql-xdevapi-collection.remove
return_type: mysql_xdevapi\CollectionRemove
return_description:
<p class="para">
   If the operation is not executed, then the function will return 
   a Remove object that can be used to add additional
   remove operations.
  </p>
  <p class="para">
   If the remove operation is executed, then the returned object will contain
   the result of the operation.
  </p>


name: Collection.removeOne
purpose: Remove one collection document
manual_id: mysql-xdevapi-collection.removeone
return_type: mysql_xdevapi\Result
return_description:
<p class="para">
   A Result object that can be used to query the number of affected items or the
   number warnings generated by the operation.
  </p>


name: Collection.replaceOne
purpose: Replace one collection document
manual_id: mysql-xdevapi-collection.replaceone
return_type: mysql_xdevapi\Result
return_description:
<p class="para">
   A Result object that can be used to query the number of affected items and the
   number warnings generated by the operation.
  </p>


name: CollectionAdd.execute
purpose: Execute the statement
manual_id: mysql-xdevapi-collectionadd.execute
return_type: mysql_xdevapi\Result
return_description:
<p class="para">
   A Result object that can be used to verify the status of the operation,
   such as the number of affected rows.
  </p>


name: CollectionFind.bind
purpose: Bind value to query placeholder
manual_id: mysql-xdevapi-collectionfind.bind
return_type: mysql_xdevapi\CollectionFind
return_description:
<p class="para">
   A CollectionFind object, 
   or chain with execute() to return a Result object.
  </p>


name: CollectionFind.execute
purpose: Execute the statement
manual_id: mysql-xdevapi-collectionfind.execute
return_type: mysql_xdevapi\DocResult
return_description:
<p class="para">
   A <span class="classname">mysql_xdevapi\DocResult</span> object that can be used
   to either fetch results from, or to query the status of the operation.
  </p>


name: CollectionFind.limit
purpose: Limit number of returned documents
manual_id: mysql-xdevapi-collectionfind.limit
return_type: mysql_xdevapi\CollectionFind
return_description:
<p class="para">
   A CollectionFind object that can be used for additional processing;
   chain with the execute() method to return a DocResult object.
  </p>


name: CollectionFind.sort
purpose: Set the sorting criteria
manual_id: mysql-xdevapi-collectionfind.sort
return_type: mysql_xdevapi\CollectionFind
return_description:
<p class="para">
   A CollectionFind object that can be used to execute the command, or to add additional operations.
  </p>


name: CollectionModify.arrayAppend
purpose: Append element to an array field
manual_id: mysql-xdevapi-collectionmodify.arrayappend
return_type: mysql_xdevapi\CollectionModify
return_description:
<p class="para">
   A CollectionModify object that can be used to execute the command, or to add additional operations.
  </p>


name: CollectionModify.arrayInsert
purpose: Insert element into an array field
manual_id: mysql-xdevapi-collectionmodify.arrayinsert
return_type: mysql_xdevapi\CollectionModify
return_description:
<p class="para">
   A CollectionModify object that can be used to execute the command, or to add additional operations
  </p>


name: CollectionRemove.bind
purpose: Bind value to placeholder
manual_id: mysql-xdevapi-collectionremove.bind
return_type: mysql_xdevapi\CollectionRemove
return_description:
<p class="para">
   A CollectionRemove object that can be used to execute the command, or to add additional operations.
  </p>


name: CollectionRemove.limit
purpose: Limit number of documents to remove
manual_id: mysql-xdevapi-collectionremove.limit
return_type: mysql_xdevapi\CollectionRemove
return_description:
<p class="para">
   Returns a CollectionRemove object that can be used to execute the command,
   or to add additional operations.
  </p>


name: ColumnResult.isNumberSigned
purpose: Check if signed type
manual_id: mysql-xdevapi-columnresult.isnumbersigned
return_type: int
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a given column as a signed type.
  </p>


name: ColumnResult.isPadded
purpose: Check if padded
manual_id: mysql-xdevapi-columnresult.ispadded
return_type: int
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a given column is padded.
  </p>


name: DatabaseObject.existsInDatabase
purpose: Check if object exists in database
manual_id: mysql-xdevapi-databaseobject.existsindatabase
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if object exists in the database, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not.
  </p>


name: DocResult.fetchAll
purpose: Get all rows
manual_id: mysql-xdevapi-docresult.fetchall
return_type: array
return_description:
<p class="para">
   A numerical array with all results from the query; each result is
   an associative array. An empty array is returned if no
   rows are present.
  </p>


name: DocResult.fetchOne
purpose: Get one row
manual_id: mysql-xdevapi-docresult.fetchone
return_type: array
return_description:
<p class="para">
   The result, as an associative array 
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if no results are present.
  </p>


name: Result.getGeneratedIds
purpose: Get generated ids
manual_id: mysql-xdevapi-result.getgeneratedids
return_type: array
return_description:
<p class="para">
   An array of generated _id&#039;s from the last operation, 
   or an empty array if there are none.
  </p>


name: Result.getWarnings
purpose: Get warnings from last operation
manual_id: mysql-xdevapi-result.getwarnings
return_type: array
return_description:
<p class="para">
   An array of Warning objects from the last operation. Each object
   defines an error &#039;message&#039;, error &#039;level&#039;, and error &#039;code&#039;. An
   empty array is returned if no errors are present.
  </p>


name: RowResult.getColumnNames
purpose: Get all column names
manual_id: mysql-xdevapi-rowresult.getcolumnnames
return_type: array
return_description:
<p class="para">
   A numerical array of table columns names,
   or an empty array if the result set is empty.
  </p>


name: RowResult.getColumns
purpose: Get column metadata
manual_id: mysql-xdevapi-rowresult.getcolumns
return_type: array
return_description:
<p class="para">
   An array of FieldMetadata objects representing the columns in the result, 
   or an empty array if the result set is empty.
  </p>


name: Schema.existsInDatabase
purpose: Check if exists in database
manual_id: mysql-xdevapi-schema.existsindatabase
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the schema, table, collection, or view still exists in the schema, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Schema.getCollectionAsTable
purpose: Get collection as a Table object
manual_id: mysql-xdevapi-schema.getcollectionastable
return_type: mysql_xdevapi\Table
return_description:
<p class="para">
   A <span class="classname">mysql_xdevapi\Table</span> object for the collection.
  </p>


name: Schema.getCollections
purpose: Get all schema collections
manual_id: mysql-xdevapi-schema.getcollections
return_type: array
return_description:
<p class="para">
   Array of all collections in this schema, where each array element
   value is a Collection object with the collection name as the key.
  </p>


name: Schema.getTables
purpose: Get schema tables
manual_id: mysql-xdevapi-schema.gettables
return_type: array
return_description:
<p class="para">
   Array of all tables in this schema, where each array element
   value is a Table object with the table name as the key.
  </p>


name: Session.close
purpose: Close session
manual_id: mysql-xdevapi-session.close
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the session closed.
  </p>


name: Session.dropSchema
purpose: Drop a schema
manual_id: mysql-xdevapi-session.dropschema
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the schema is dropped, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not exist
   or can&#039;t be dropped. 
  </p>
  <p class="para">
   An <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is generated if the 
   schema does not exist.
  </p>


name: Session.getDefaultSchema
purpose: Get default schema name
manual_id: mysql-xdevapi-session.getdefaultschema
return_type: string
return_description:
<p class="para">
   Name of the default schema defined by the connection, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if
   one was not set.
  </p>


name: Session.getSchemas
purpose: Get the schemas
manual_id: mysql-xdevapi-session.getschemas
return_type: array
return_description:
<p class="para">
   An array containing objects that represent all of the schemas 
   available to the session.
  </p>


name: Session.getServerVersion
purpose: Get server version
manual_id: mysql-xdevapi-session.getserverversion
return_type: int
return_description:
<p class="para">
   The MySQL server version for the session, as an integer such as &quot;80012&quot;.
  </p>


name: Session.listClients
purpose: Get client list
manual_id: mysql-xdevapi-session.listclients
return_type: array
return_description:
<p class="para">
   An array containing the currently logged clients. The array
   elements are &quot;client_id&quot;, &quot;user&quot;, &quot;host&quot;, and &quot;sql_session&quot;.
  </p>


name: SqlStatement.hasMoreResults
purpose: Check for more results
manual_id: mysql-xdevapi-sqlstatement.hasmoreresults
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the result set has more objects to fetch.
  </p>


name: SqlStatementResult.fetchOne
purpose: Get single row
manual_id: mysql-xdevapi-sqlstatementresult.fetchone
return_type: array
return_description:
<p class="para">
   The result, as an associative array. In case there is not any
   result, null will be returned.
  </p>


name: SqlStatementResult.hasData
purpose: Check if result has data
manual_id: mysql-xdevapi-sqlstatementresult.hasdata
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the result set has data.
  </p>


name: Table.delete
purpose: Delete rows from table
manual_id: mysql-xdevapi-table.delete
return_type: mysql_xdevapi\TableDelete
return_description:
<p class="para">
   A TableDelete object; use the execute() method to execute the delete query.
  </p>


name: Table.existsInDatabase
purpose: Check if table exists in database
manual_id: mysql-xdevapi-table.existsindatabase
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if table exists in the database, else <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it does not.
  </p>


name: Table.insert
purpose: Insert table rows
manual_id: mysql-xdevapi-table.insert
return_type: mysql_xdevapi\TableInsert
return_description:
<p class="para">
   A TableInsert object; use the execute() method to execute the insert statement.
  </p>


name: Table.isView
purpose: Check if table is view
manual_id: mysql-xdevapi-table.isview
return_type: bool
return_description:
<p class="para">
    <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the underlying object is a view, otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Table.select
purpose: Select rows from table
manual_id: mysql-xdevapi-table.select
return_type: mysql_xdevapi\TableSelect
return_description:
<p class="para">
   A TableSelect object; use the execute() method to execute the
   select and return a RowResult object.
  </p>


name: Table.update
purpose: Update rows in table
manual_id: mysql-xdevapi-table.update
return_type: mysql_xdevapi\TableUpdate
return_description:
<p class="para">
   A TableUpdate object; use the execute() method to execute the update statement.
  </p>


name: mysql_affected_rows
purpose: Get number of affected rows in previous MySQL operation
manual_id: function.mysql-affected-rows
version: PHP 4, PHP 5
return_type: int
return_description:
<p class="para">
   Returns the number of affected rows on success, and -1 if the last query
   failed.
  </p>
  <p class="para">
   If the last query was a DELETE query with no WHERE clause, all
   of the records will have been deleted from the table but this
   function will return zero with MySQL versions prior to 4.1.2.
  </p>
  <p class="para">
   When using UPDATE, MySQL will not update columns where the new value is the 
   same as the old value.  This creates the possibility that 
   <span class="function">mysql_affected_rows</span> may not actually equal the number 
   of rows matched, only the number of rows that were literally affected by 
   the query.
  </p>
  <p class="para">
   The REPLACE statement first deletes the record with the same primary key 
   and then inserts the new record. This function returns the number of 
   deleted records plus the number of inserted records.
  </p> 
  <p class="para">
   In the case of &quot;INSERT ... ON DUPLICATE KEY UPDATE&quot; queries, the 
   return value will be <code class="literal">1</code> if an insert was performed, 
   or <code class="literal">2</code> for an update of an existing row.   
  </p>


name: mysql_connect
purpose: Open a connection to a MySQL Server
manual_id: function.mysql-connect
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   Returns a MySQL link identifier on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_db_name
purpose: Retrieves database name from the call to mysql_list_dbs
manual_id: function.mysql-db-name
version: PHP 4, PHP 5
return_type: string
return_description:
<p class="para">
   Returns the database name on success, and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. If <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   is returned, use <span class="function">mysql_error</span> to determine the nature
   of the error.
  </p>


name: mysql_db_query
purpose: Selects a database and executes a query on it
manual_id: function.mysql-db-query
version: PHP 4, PHP 5
return_type: bool
return_description:
<p class="para">
   Returns a positive MySQL result resource to the query result,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. The function also returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>/<strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for
   <code class="literal">INSERT</code>/<code class="literal">UPDATE</code>/<code class="literal">DELETE</code>
   queries to indicate success/failure.
  </p>


name: mysql_errno
purpose: Returns the numerical value of the error message from previous MySQL operation
manual_id: function.mysql-errno
version: PHP 4, PHP 5
return_type: int
return_description:
<p class="para">
   Returns the error number from the last MySQL function, or
   <code class="literal">0</code> (zero) if no error occurred.
  </p>


name: mysql_error
purpose: Returns the text of the error message from previous MySQL operation
manual_id: function.mysql-error
version: PHP 4, PHP 5
return_type: string
return_description:
<p class="para">
   Returns the error text from the last MySQL function, or
   <code class="literal">&#039;&#039;</code> (empty string) if no error occurred.
  </p>


name: mysql_fetch_array
purpose: Fetch a result row as an associative array, a numeric array, or both
manual_id: function.mysql-fetch-array
version: PHP 4, PHP 5
return_type: array
return_description:
<p class="para">
   Returns an array of strings that corresponds to the fetched row, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if there are no more rows. The type of returned array depends on
   how <code class="parameter">result_type</code> is defined. By using 
   <strong><code><a href="mysql.constants.html#constant.mysql-both">MYSQL_BOTH</a></code></strong> (default), you&#039;ll get an array with both 
   associative and number indices. Using <strong><code><a href="mysql.constants.html#constant.mysql-assoc">MYSQL_ASSOC</a></code></strong>, you 
   only get associative indices (as <span class="function">mysql_fetch_assoc</span> 
   works), using <strong><code><a href="mysql.constants.html#constant.mysql-num">MYSQL_NUM</a></code></strong>, you only get number indices 
   (as <span class="function">mysql_fetch_row</span> works).
  </p>
  <p class="para">
   If two or more columns of the result have the same field names,
   the last column will take precedence. To access the other column(s)
   of the same name, you must use the numeric index of the column or
   make an alias for the column. For aliased columns, you cannot
   access the contents with the original column name.
  </p>


name: mysql_fetch_assoc
purpose: Fetch a result row as an associative array
manual_id: function.mysql-fetch-assoc
version: PHP 4 >= 4.0.3, PHP 5
return_type: array
return_description:
<p class="para">
   Returns an associative array of strings that corresponds to the fetched row, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows.
  </p>
  <p class="para">
   If two or more columns of the result have the same field names,
   the last column will take precedence. To access the other
   column(s) of the same name, you either need to access the
   result with numeric indices by using
   <span class="function">mysql_fetch_row</span> or add alias names.
   See the example at the <span class="function">mysql_fetch_array</span>
   description about aliases.
  </p>


name: mysql_fetch_field
purpose: Get column information from a result and return as an object
manual_id: function.mysql-fetch-field
version: PHP 4, PHP 5
return_type: object
return_description:
<p class="para">
   Returns an <span class="type">object</span> containing field information. The properties 
   of the object are:
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      name - column name
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      table - name of the table the column belongs to, which is the alias name if one is defined
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      max_length - maximum length of the column
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      not_null - 1 if the column cannot be <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      primary_key - 1 if the column is a primary key
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      unique_key - 1 if the column is a unique key
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      multiple_key - 1 if the column is a non-unique key
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      numeric - 1 if the column is numeric
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      blob - 1 if the column is a BLOB
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      type - the type of the column
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      unsigned - 1 if the column is unsigned
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      zerofill - 1 if the column is zero-filled
     </span>
    </li>
   </ul>
  </p>


name: mysql_fetch_lengths
purpose: Get the length of each output in a result
manual_id: function.mysql-fetch-lengths
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> of lengths on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_fetch_object
purpose: Fetch a result row as an object
manual_id: function.mysql-fetch-object
version: PHP 4, PHP 5
return_type: object
return_description:
<p class="para">
   Returns an <span class="type">object</span> with string properties that correspond to the
   fetched row, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows.
  </p>


name: mysql_fetch_row
purpose: Get a result row as an enumerated array
manual_id: function.mysql-fetch-row
version: PHP 4, PHP 5
return_type: array
return_description:
<p class="para">
   Returns an numerical array of strings that corresponds to the fetched row, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows.
  </p>
  <p class="para">
   <span class="function">mysql_fetch_row</span> fetches one row of data from
   the result associated with the specified result identifier.  The
   row is returned as an array.  Each result column is stored in an
   array offset, starting at offset 0.
  </p>


name: mysql_field_flags
purpose: Get the flags associated with the specified field in a result
manual_id: function.mysql-field-flags
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   Returns a string of flags associated with the result or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   The following flags are reported, if your version of MySQL
   is current enough to support them: <code class="literal">&quot;not_null&quot;</code>, 
   <code class="literal">&quot;primary_key&quot;</code>, <code class="literal">&quot;unique_key&quot;</code>, 
   <code class="literal">&quot;multiple_key&quot;</code>, <code class="literal">&quot;blob&quot;</code>, 
   <code class="literal">&quot;unsigned&quot;</code>, <code class="literal">&quot;zerofill&quot;</code>,
   <code class="literal">&quot;binary&quot;</code>, <code class="literal">&quot;enum&quot;</code>, 
   <code class="literal">&quot;auto_increment&quot;</code> and <code class="literal">&quot;timestamp&quot;</code>.
  </p>


name: mysql_field_len
purpose: Returns the length of the specified field
manual_id: function.mysql-field-len
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   The length of the specified field index on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_field_name
purpose: Get the name of the specified field in a result
manual_id: function.mysql-field-name
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   The name of the specified field index on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_field_type
purpose: Get the type of the specified field in a result
manual_id: function.mysql-field-type
version: PHP 4, PHP 5
return_type: string
return_description:
<p class="para">
   The returned field type
   will be one of <code class="literal">&quot;int&quot;</code>, <code class="literal">&quot;real&quot;</code>, 
   <code class="literal">&quot;string&quot;</code>, <code class="literal">&quot;blob&quot;</code>, and others as
   detailed in the <a href="http://dev.mysql.com/doc/" class="link external">&raquo;&nbsp;MySQL
   documentation</a>.
  </p>


name: mysql_free_result
purpose: Free result memory
manual_id: function.mysql-free-result
version: PHP 4, PHP 5
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   If a non-resource is used for the <code class="parameter">result</code>, an
   error of level E_WARNING will be emitted.  It&#039;s worth noting that
   <span class="function">mysql_query</span> only returns a <span class="type">resource</span>
   for SELECT, SHOW, EXPLAIN, and DESCRIBE queries.
  </p>


name: mysql_get_host_info
purpose: Get MySQL host info
manual_id: function.mysql-get-host-info
version: PHP 4 >= 4.0.5, PHP 5
return_type: false
return_description:
<p class="para">
   Returns a string describing the type of MySQL connection in use for the
   connection or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_get_proto_info
purpose: Get MySQL protocol info
manual_id: function.mysql-get-proto-info
version: PHP 4 >= 4.0.5, PHP 5
return_type: false
return_description:
<p class="para">
   Returns the MySQL protocol on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_get_server_info
purpose: Get MySQL server info
manual_id: function.mysql-get-server-info
version: PHP 4 >= 4.0.5, PHP 5
return_type: false
return_description:
<p class="para">
   Returns the MySQL server version on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_info
purpose: Get information about the most recent query
manual_id: function.mysql-info
version: PHP 4 >= 4.3.0, PHP 5
return_type: string
return_description:
<p class="para">
   Returns information about the statement on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure. See the example below for which statements provide information,
   and what the returned value may look like. Statements that are not listed 
   will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mysql_insert_id
purpose: Get the ID generated in the last query
manual_id: function.mysql-insert-id
version: PHP 4, PHP 5
return_type: int
return_description:
<p class="para">
   The ID generated for an AUTO_INCREMENT column by the previous 
   query on success, <code class="literal">0</code> if the previous
   query does not generate an AUTO_INCREMENT value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   no MySQL connection was established.
  </p>


name: mysql_list_dbs
purpose: List databases available on a MySQL server
manual_id: function.mysql-list-dbs
version: PHP 4, PHP 5
return_type: resource
return_description:
<p class="para">
   Returns a result pointer <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure. Use the <span class="function">mysql_tablename</span> function to traverse 
   this result pointer, or any function for result tables, such as 
   <span class="function">mysql_fetch_array</span>.
  </p>


name: mysql_list_fields
purpose: List MySQL table fields
manual_id: function.mysql-list-fields
version: PHP 4, PHP 5
return_type: resource
return_description:
<p class="para">
   A result pointer <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure.
  </p>
  <p class="para">
   The returned result can be used with <span class="function">mysql_field_flags</span>,
   <span class="function">mysql_field_len</span>,
   <span class="function">mysql_field_name</span> and
   <span class="function">mysql_field_type</span>.
  </p>


name: mysql_list_processes
purpose: List MySQL processes
manual_id: function.mysql-list-processes
version: PHP 4 >= 4.3.0, PHP 5
return_type: false
return_description:
<p class="para">
   A result pointer <span class="type">resource</span> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_list_tables
purpose: List tables in a MySQL database
manual_id: function.mysql-list-tables
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   A result pointer <span class="type">resource</span> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Use the <span class="function">mysql_tablename</span> function to
   traverse this result pointer, or any function for result tables,
   such as <span class="function">mysql_fetch_array</span>.
  </p>


name: mysql_num_fields
purpose: Get number of fields in result
manual_id: function.mysql-num-fields
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   Returns the number of fields in the result set <span class="type">resource</span> on
   success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_num_rows
purpose: Get number of rows in result
manual_id: function.mysql-num-rows
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   The number of rows in a result set on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_pconnect
purpose: Open a persistent connection to a MySQL server
manual_id: function.mysql-pconnect
version: PHP 4, PHP 5
return_type: resource
return_description:
<p class="para">
   Returns a MySQL persistent link identifier on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on 
   failure.
  </p>


name: mysql_ping
purpose: Ping a server connection or reconnect if there is no connection
manual_id: function.mysql-ping
version: PHP 4 >= 4.3.0, PHP 5
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the connection to the server MySQL server is working, 
   otherwise <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: mysql_query
purpose: Send a MySQL query
manual_id: function.mysql-query
version: PHP 4, PHP 5
return_type: mixed
return_description:
<p class="para">
   For SELECT, SHOW, DESCRIBE, EXPLAIN and other statements returning resultset,
   <span class="function">mysql_query</span> 
   returns a <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>
  <p class="para">
   For other type of SQL statements, INSERT, UPDATE, DELETE, DROP, etc,
   <span class="function">mysql_query</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>
  <p class="para">
   The returned result resource should be passed to
   <span class="function">mysql_fetch_array</span>, and other
   functions for dealing with result tables, to access the returned data.
  </p>
  <p class="para">
   Use <span class="function">mysql_num_rows</span> to find out how many rows
   were returned for a SELECT statement or
   <span class="function">mysql_affected_rows</span> to find out how many
   rows were affected by a DELETE, INSERT, REPLACE, or UPDATE
   statement.
  </p>
  <p class="para">
   <span class="function">mysql_query</span> will also fail and return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if the user does not have permission to access the table(s) referenced by
   the query.
  </p>


name: mysql_real_escape_string
purpose: Escapes special characters in a string for use in an SQL statement
manual_id: function.mysql-real-escape-string
version: PHP 4 >= 4.3.0, PHP 5
return_type: string
return_description:
<p class="para">
   Returns the escaped string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>

errors:
<p class="para">
   Executing this function without a MySQL connection present will
   also emit <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level PHP errors. Only
   execute this function with a valid MySQL connection present.
  </p>


name: mysql_result
purpose: Get result data
manual_id: function.mysql-result
version: PHP 4, PHP 5
return_type: string
return_description:
<p class="para">
   The contents of one cell from a MySQL result set on success, or 
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_stat
purpose: Get current system status
manual_id: function.mysql-stat
version: PHP 4 >= 4.3.0, PHP 5
return_type: string
return_description:
<p class="para">
   Returns a string with the status for uptime, threads, queries, open tables,
   flush tables and queries per second. For a complete list of other status
   variables, you have to use the <code class="literal">SHOW STATUS</code> SQL command.
   If <code class="parameter">link_identifier</code> is invalid, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned.
  </p>


name: mysql_tablename
purpose: Get table name of field
manual_id: function.mysql-tablename
version: PHP 4, PHP 5
return_type: false
return_description:
<p class="para">
   The name of the table on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Use the <span class="function">mysql_tablename</span> function to
   traverse this result pointer, or any function for result tables,
   such as <span class="function">mysql_fetch_array</span>.
  </p>


name: mysql_thread_id
purpose: Return the current thread ID
manual_id: function.mysql-thread-id
version: PHP 4 >= 4.3.0, PHP 5
return_type: false
return_description:
<p class="para">
   The thread ID on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mysql_unbuffered_query
purpose: Send an SQL query to MySQL without fetching and buffering the result rows
manual_id: function.mysql-unbuffered-query
version: PHP 4 >= 4.0.6, PHP 5
return_type: resource
return_description:
<p class="para">
   For SELECT, SHOW, DESCRIBE or EXPLAIN statements,
   <span class="function">mysql_unbuffered_query</span> 
   returns a <span class="type">resource</span> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>
  <p class="para">
   For other type of SQL statements, UPDATE, DELETE, DROP, etc,
   <span class="function">mysql_unbuffered_query</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_close
purpose: Closes an Oracle connection
manual_id: function.oci-close
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when <a href="oci8.configuration.html#ini.oci8.old-oci-close-semantics" class="link">oci8.old_oci_close_semantics</a> is enabled,
   or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> otherwise.
  </p>


name: oci_connect
purpose: Connect to an Oracle database
manual_id: function.oci-connect
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns a connection identifier or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_error
purpose: Returns the last error found
manual_id: function.oci-error
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   If no error is found, <span class="function">oci_error</span> returns
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Otherwise, <span class="function">oci_error</span> returns the
   error information as an associative array.
  </p>
  <p class="para">
   <table class="doctable table">
   <caption><strong><span class="function">oci_error</span> Array Description</strong></caption>

    
     <thead>
      <tr>
       <th>Array key</th>
       <th>Type</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">code</code></td>
       <td><span class="type">int</span></td>
       <td>
         The Oracle error number.
       </td>
      </tr>

      <tr>
       <td><code class="literal">message</code></td>
       <td><span class="type">string</span></td>
       <td>
         The Oracle error text.
       </td>
      </tr>

      <tr>
       <td><code class="literal">offset</code></td>
       <td><span class="type">int</span></td>
       <td>
         The byte position of an error in the SQL statement.  If there
         was no statement, this is <code class="literal">0</code>
       </td>
      </tr>

      <tr>
       <td><code class="literal">sqltext</code></td>
       <td><span class="type">string</span></td>
       <td>
         The SQL statement text.  If there was no statement, this is
         an empty string.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: oci_fetch_all
purpose: Fetches multiple rows from a query into a two-dimensional array
manual_id: function.oci-fetch-all
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: int
return_description:
<p class="para">
   Returns the number of rows in <code class="parameter">output</code>, which
   may be 0 or more.
  </p>


name: oci_fetch_array
purpose: Returns the next row from a query as an associative or numeric array
manual_id: function.oci-fetch-array
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns an array with associative and/or numeric indices. If there
   are no more rows in the <code class="parameter">statement</code> then
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>
  <p class="para">
    By default, <code class="literal">LOB</code> columns are returned as LOB descriptors.
  </p>
  <p class="para">
   <code class="literal">DATE</code> columns are returned as strings formatted
   to the current date format.  The default format can be changed with
   Oracle environment variables such as <code class="literal">NLS_LANG</code> or
   by a previously executed <code class="literal">ALTER SESSION SET
   NLS_DATE_FORMAT</code> command.
  </p>
  <p class="para">
   Oracle&#039;s default, non-case sensitive column names will have
   uppercase associative indices in the result array.  Case-sensitive
   column names will have array indices using the exact column case.
   Use <span class="function">var_dump</span> on the result array to verify the
   appropriate case to use for each query. 
  </p>
  <p class="para">
   The table name is not included in the array index.  If your query
   contains two different columns with the same name,
   use <strong><code><a href="oci8.constants.html#constant.oci-num">OCI_NUM</a></code></strong> or add a column alias to the query
   to ensure name uniqueness, see example #7. Otherwise only one
   column will be returned via PHP.
  </p>


name: oci_fetch_assoc
purpose: Returns the next row from a query as an associative array
manual_id: function.oci-fetch-assoc
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns an associative array. If there are no more rows in
   the <code class="parameter">statement</code> then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: oci_fetch_object
purpose: Returns the next row from a query as an object
manual_id: function.oci-fetch-object
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns an object.  Each attribute of the object corresponds to a
   column of the row.  If there are no more rows in
   the <code class="parameter">statement</code> then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>
  <p class="para">
    Any <code class="literal">LOB</code> columns are returned as LOB descriptors.
  </p>
  <p class="para">
   <code class="literal">DATE</code> columns are returned as strings formatted
   to the current date format.  The default format can be changed with
   Oracle environment variables such as <code class="literal">NLS_LANG</code> or
   by a previously executed <code class="literal">ALTER SESSION SET
   NLS_DATE_FORMAT</code> command.
  </p>
  <p class="para">
   Oracle&#039;s default, non-case sensitive column names will have
   uppercase attribute names.  Case-sensitive column names will have
   attribute names using the exact column case.
   Use <span class="function">var_dump</span> on the result object to verify
   the appropriate case for attribute access.
  </p>
  <p class="para">
    Attribute values will be <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for any <code class="literal">NULL</code>
    data fields.
  </p>


name: oci_fetch_row
purpose: Returns the next row from a query as a numeric array
manual_id: function.oci-fetch-row
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns a numerically indexed array.  If there are no more rows in
   the <code class="parameter">statement</code> then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: oci_fetch
purpose: Fetches the next row from a query into internal buffers
manual_id: function.oci-fetch
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows in the
   <code class="parameter">statement</code>.
  </p>


name: oci_field_is_null
purpose: Checks if a field in the currently fetched row is null
manual_id: function.oci-field-is-null
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">column</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. 
  </p>


name: oci_field_name
purpose: Returns the name of a field from the statement
manual_id: function.oci-field-name
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the name as a string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_field_precision
purpose: Tell the precision of a field
manual_id: function.oci-field-precision
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the precision as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_field_scale
purpose: Tell the scale of the field
manual_id: function.oci-field-scale
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the scale as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_field_size
purpose: Returns field's size
manual_id: function.oci-field-size
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the size of a <code class="parameter">column</code> in bytes, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_field_type_raw
purpose: Tell the raw Oracle data type of the field
manual_id: function.oci-field-type-raw
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns Oracle&#039;s raw data type as a number, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_field_type
purpose: Returns a field's data type name
manual_id: function.oci-field-type
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the field data type as a <span class="type">string</span> or an <span class="type">int</span>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_get_implicit_resultset
manual_id: function.oci-get-implicit-resultset
version: PHP 5 >= 5.6.0, PHP 7, PHP 8, PECL OCI8 >= 2.0.0
return_type: false
purpose:
Returns the next child statement resource from a parent statement resource that has Oracle Database Implicit Result Sets

return_description:
<p class="para">
   Returns a statement handle for the next child statement available
   on <code class="parameter">statement</code>.  Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when child
   statements do not exist, or all child statements have been returned
   by previous calls
   to <span class="function">oci_get_implicit_resultset</span>.
  </p>


name: oci_lob_is_equal
purpose: Compares two LOB/FILE locators for equality
manual_id: function.oci-lob-is-equal
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if these objects are equal, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: oci_new_collection
purpose: Allocates new collection object
manual_id: function.oci-new-collection
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns a new <span class="classname">OCICollection</span> object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error.
  </p>


name: oci_new_cursor
purpose: Allocates and returns a new cursor (statement handle)
manual_id: function.oci-new-cursor
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns a new statement handle, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_new_descriptor
purpose: Initializes a new empty LOB or FILE descriptor
manual_id: function.oci-new-descriptor
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: null
return_description:
<p class="para">
   Returns a new LOB or FILE descriptor on success, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>


name: oci_num_rows
purpose: Returns number of rows affected during statement execution
manual_id: function.oci-num-rows
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the number of rows affected as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: oci_parse
purpose: Prepares an Oracle statement for execution
manual_id: function.oci-parse
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns a statement handle on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_password_change
purpose: Changes password of Oracle's user
manual_id: function.oci-password-change
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: resource
return_description:
<p class="para">
   When <code class="parameter">database_name</code> is provided, <span class="function">oci_password_change</span> returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. When <code class="parameter">connection</code> is provided, <span class="function">oci_password_change</span> returns
   the connection resource on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: oci_result
purpose: Returns field's value from the fetched row
manual_id: function.oci-result
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: mixed
return_description:
<p class="para">
   Returns everything as strings except for abstract types (ROWIDs, LOBs and
   FILEs). Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_server_version
purpose: Returns the Oracle Database version
manual_id: function.oci-server-version
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the version information as a string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: oci_statement_type
purpose: Returns the type of a statement
manual_id: function.oci-statement-type
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the type of <code class="parameter">statement</code> as one of the
   following strings.
   <table class="doctable table">
    <caption><strong>Statement type</strong></caption>
    
     <thead>
      <tr>
       <th>Return String</th>
       <th>Notes</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">ALTER</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">BEGIN</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">CALL</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">CREATE</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">DECLARE</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">DELETE</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">DROP</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">INSERT</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">SELECT</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">UPDATE</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

      <tr>
       <td><code class="literal">UNKNOWN</code></td>
       <td class="empty">&nbsp;</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: OCICollection.getElem
purpose: Returns value of the element
manual_id: ocicollection.getelem
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if such element doesn&#039;t exist; <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if element is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>;
   string if element is column of a string datatype or number if element is
   numeric field.
  </p>


name: OCICollection.max
purpose: Returns the maximum number of elements in the collection
manual_id: ocicollection.max
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the maximum number as an integer, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on errors.
  </p>
  <p class="para">
   If the returned value is 0, then the number of elements is not limited.
  </p>


name: OCICollection.size
purpose: Returns size of the collection
manual_id: ocicollection.size
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the number of elements in the collection or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error. 
  </p>


name: OCILob.eof
purpose: Tests for end-of-file on a large object's descriptor
manual_id: ocilob.eof
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if internal pointer of large object is at the end of LOB.
   Otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: OCILob.erase
purpose: Erases a specified portion of the internal LOB data
manual_id: ocilob.erase
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the actual number of characters/bytes erased  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: OCILob.flush
purpose: Flushes/writes buffer of the LOB to the server
manual_id: ocilob.flush
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if buffering was not enabled or an error occurred.
  </p>


name: OCILob.getBuffering
purpose: Returns current state of buffering for the large object
manual_id: ocilob.getbuffering
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if buffering for the large object is off and <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if
   buffering is used.
  </p>


name: OCILob.load
purpose: Returns large object's contents
manual_id: ocilob.load
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the contents of the object, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on errors.
  </p>


name: OCILob.read
purpose: Reads part of the large object
manual_id: ocilob.read
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the contents as a string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: OCILob.setBuffering
purpose: Changes current state of buffering for the large object
manual_id: ocilob.setbuffering
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. Repeated calls to this method with the same flag will
   return <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>. 
  </p>


name: OCILob.size
purpose: Returns size of large object
manual_id: ocilob.size
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns length of large object value  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   Empty objects have zero length.
  </p>


name: OCILob.tell
purpose: Returns the current position of internal pointer of large object
manual_id: ocilob.tell
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns current position of a LOB&#039;s internal pointer or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an
   error occurred.
  </p>


name: OCILob.write
purpose: Writes data to the large object
manual_id: ocilob.write
version: PHP 5, PHP 7, PHP 8, PECL OCI8 >= 1.1.0
return_type: false
return_description:
<p class="para">
   Returns the number of bytes written  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_affected_rows
purpose: Returns number of affected records (tuples)
manual_id: function.pg-affected-rows
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of rows affected by the query. If no tuple is
   affected, it will return <code class="literal">0</code>.
  </p>


name: pg_cancel_query
purpose: Cancel an asynchronous query
manual_id: function.pg-cancel-query
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>


name: pg_connect_poll
purpose: Poll the status of an in-progress asynchronous PostgreSQL connection attempt
manual_id: function.pg-connect-poll
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <strong><code><a href="pgsql.constants.html#constant.pgsql-polling-failed">PGSQL_POLLING_FAILED</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-polling-reading">PGSQL_POLLING_READING</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-polling-writing">PGSQL_POLLING_WRITING</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-polling-ok">PGSQL_POLLING_OK</a></code></strong>, or
   <strong><code><a href="pgsql.constants.html#constant.pgsql-polling-active">PGSQL_POLLING_ACTIVE</a></code></strong>.
  </p>


name: pg_connect
purpose: Open a PostgreSQL connection
manual_id: function.pg-connect
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">PgSql\Connection</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_connection_busy
purpose: Get connection is busy or not
manual_id: function.pg-connection-busy
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the connection is busy, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
   </p>


name: pg_connection_status
purpose: Get connection status
manual_id: function.pg-connection-status
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
    <strong><code><a href="pgsql.constants.html#constant.pgsql-connection-ok">PGSQL_CONNECTION_OK</a></code></strong> or 
    <strong><code><a href="pgsql.constants.html#constant.pgsql-connection-bad">PGSQL_CONNECTION_BAD</a></code></strong>.
   </p>


name: pg_consume_input
purpose: Reads input on the connection
manual_id: function.pg-consume-input
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if no error occurred, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there was an error. Note that
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> does not necessarily indicate that input was waiting to be read.
  </p>


name: pg_convert
purpose: Convert associative array values into forms suitable for SQL statements
manual_id: function.pg-convert
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> of converted values,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> or <span class="classname">TypeError</span> is thrown
   when the value or type of field does not match properly with a PostgreSQL&#039;s type.
  </p>


name: pg_copy_to
purpose: Copy a table to an array
manual_id: function.pg-copy-to
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    An <span class="type">array</span> with one element for each line of <code class="literal">COPY</code> data,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>


name: pg_dbname
purpose: Get the database name
manual_id: function.pg-dbname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the name of the database the 
   <code class="parameter">connection</code> is to.
  </p>


name: pg_delete
purpose: Deletes records
manual_id: function.pg-delete
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.  Returns <span class="type">string</span> if <strong><code><a href="pgsql.constants.html#constant.pgsql-dml-string">PGSQL_DML_STRING</a></code></strong> is passed
   via <code class="parameter">flags</code>.
  </p>


name: pg_execute
purpose: Sends a request to execute a prepared statement with given parameters, and waits for the result
manual_id: function.pg-execute
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    An <span class="classname">PgSql\Result</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_fetch_all
purpose: Fetches all rows from a result as an array
manual_id: function.pg-fetch-all
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> with all rows in the result.  Each row is an array
   of field values indexed by field name.
  </p>


name: pg_fetch_array
purpose: Fetch a row as an array
manual_id: function.pg-fetch-array
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> indexed numerically (beginning with 0) or
   associatively (indexed by field name), or both.
   Each value in the <span class="type">array</span> is represented as a 
   <span class="type">string</span>.  Database <code class="literal">NULL</code>
   values are returned as <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">row</code> exceeds the number
   of rows in the set, there are no more rows, or on any other error.
   Fetching from the result of a query other than SELECT will also return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: pg_fetch_assoc
purpose: Fetch a row as an associative array
manual_id: function.pg-fetch-assoc
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> indexed associatively (by field name).
   Each value in the <span class="type">array</span> is represented as a 
   <span class="type">string</span>.  Database <code class="literal">NULL</code>
   values are returned as <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">row</code> exceeds the number
   of rows in the set, there are no more rows, or on any other error.
  </p>


name: pg_fetch_object
purpose: Fetch a row as an object
manual_id: function.pg-fetch-object
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">object</span> with one attribute for each field
   name in the result.  Database <code class="literal">NULL</code>
   values are returned as <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">row</code> exceeds the number
   of rows in the set, there are no more rows, or on any other error.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown when
   the <code class="parameter">constructor_args</code> is non-empty with the class not having constructor.
  </p>


name: pg_fetch_result
purpose: Returns values from a result instance
manual_id: function.pg-fetch-result
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Boolean is returned as &quot;t&quot; or &quot;f&quot;.  All
   other types, including arrays are returned as strings formatted
   in the same default PostgreSQL manner that you would see in the
   <strong class="command">psql</strong> program.  Database <code class="literal">NULL</code>
   values are returned as <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">row</code> exceeds the number
   of rows in the set, or on any other error.
  </p>


name: pg_fetch_row
purpose: Get a row as an enumerated array
manual_id: function.pg-fetch-row
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span>, indexed from 0 upwards, with each value
   represented as a <span class="type">string</span>.  Database <code class="literal">NULL</code>
   values are returned as <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>
  <p class="para">
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if <code class="parameter">row</code> exceeds the number
   of rows in the set, there are no more rows, or on any other error.
  </p>


name: pg_field_is_null
purpose: Test if a field is SQL NULL
manual_id: function.pg-field-is-null
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <code class="literal">1</code> if the field in the given row is SQL <code class="literal">NULL</code>, <code class="literal">0</code>
   if not.  <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned if the row is out of range, or upon any other error.
  </p>


name: pg_field_size
purpose: Returns the internal storage size of the named field
manual_id: function.pg-field-size
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The internal field storage size (in bytes).  -1 indicates a variable
   length field.
  </p>


name: pg_field_table
purpose: Returns the name or oid of the tables field
manual_id: function.pg-field-table
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   On success either the fields table name or oid,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_field_type
purpose: Returns the type name for the corresponding field number
manual_id: function.pg-field-type
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the base name of the field&#039;s type.
  </p>


name: pg_flush
purpose: Flush outbound query data on the connection
manual_id: function.pg-flush
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the flush was successful or no data was waiting to be
   flushed, <code class="literal">0</code> if part of the pending data was flushed but
   more remains or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_get_notify
purpose: Gets SQL NOTIFY message
manual_id: function.pg-get-notify
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> containing the <code class="literal">NOTIFY</code> message name and backend PID.
   If supported by the server, the array also contains the server version and the payload.
   Otherwise if no <code class="literal">NOTIFY</code> is waiting, then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: pg_get_result
purpose: Get asynchronous query result
manual_id: function.pg-get-result
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="classname">PgSql\Result</span> instance, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no more results are available.
  </p>


name: pg_host
purpose: Returns the host name associated with the connection
manual_id: function.pg-host
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the name of the host the
   <code class="parameter">connection</code> is to, or an empty string on error.
  </p>


name: pg_insert
purpose: Insert array into table
manual_id: function.pg-insert
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.. Or returns a <span class="type">string</span> on success if <strong><code><a href="pgsql.constants.html#constant.pgsql-dml-string">PGSQL_DML_STRING</a></code></strong> is passed
   via <code class="parameter">flags</code>.
  </p>

errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown when the specified table is invalid.
  </p>
  <p class="para">
   A <span class="classname">ValueError</span> or <span class="classname">TypeError</span> is thrown
   when the value or type of field does not match properly with a PostgreSQL&#039;s type.
  </p>


name: pg_last_error
purpose: Get the last error message string of a connection
manual_id: function.pg-last-error
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the last error message on the 
   given <code class="parameter">connection</code>.
  </p>


name: pg_last_notice
purpose: Returns the last notice message from PostgreSQL server
manual_id: function.pg-last-notice
version: PHP 4 >= 4.0.6, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   A <span class="type">string</span> containing the last notice on the 
   given <code class="parameter">connection</code> with
   <strong><code><a href="pgsql.constants.html#constant.pgsql-notice-last">PGSQL_NOTICE_LAST</a></code></strong>,
   an <span class="type">array</span> with <strong><code><a href="pgsql.constants.html#constant.pgsql-notice-all">PGSQL_NOTICE_ALL</a></code></strong>,
   a <span class="type">bool</span> with <strong><code><a href="pgsql.constants.html#constant.pgsql-notice-clear">PGSQL_NOTICE_CLEAR</a></code></strong>.
  </p>


name: pg_last_oid
purpose: Returns the last row's OID
manual_id: function.pg-last-oid
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> or <span class="type">string</span> containing the OID assigned to the most recently inserted
   row in the specified <code class="parameter">connection</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error or
   no available OID.
  </p>


name: pg_lo_create
purpose: Create a large object
manual_id: function.pg-lo-create
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   A large object <var class="varname">OID</var>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_lo_import
purpose: Import a large object from file
manual_id: function.pg-lo-import
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The <var class="varname">OID</var> of the newly created large object,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_lo_open
purpose: Open a large object
manual_id: function.pg-lo-open
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="classname">PgSql\Lob</span> instance,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_lo_read
purpose: Read a large object
manual_id: function.pg-lo-read
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing <code class="parameter">length</code> bytes from the
   large object, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: pg_lo_tell
purpose: Returns current seek position a of large object
manual_id: function.pg-lo-tell
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The current seek offset (in number of bytes) from the beginning of the large
   object.  If there is an error, the return value is negative.
  </p>


name: pg_lo_write
purpose: Write to a large object
manual_id: function.pg-lo-write
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The number of bytes written to the large object, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: pg_meta_data
purpose: Get meta data for table
manual_id: function.pg-meta-data
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> of the table definition,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_num_rows
purpose: Returns the number of rows in a result
manual_id: function.pg-num-rows
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of rows in the result. On error, <code class="literal">-1</code> is returned.
  </p>


name: pg_options
purpose: Get the options associated with the connection
manual_id: function.pg-options
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the <code class="parameter">connection</code>
   options.
  </p>


name: pg_parameter_status
purpose: Looks up a current parameter setting of the server
manual_id: function.pg-parameter-status
version: PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">A <span class="type">string</span> containing the value of the parameter, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure or invalid
  <code class="parameter">param_name</code>.</p>


name: pg_port
purpose: Return the port number associated with the connection
manual_id: function.pg-port
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the port number of the database
   server the <code class="parameter">connection</code> is to, 
   or empty string on error.
  </p>


name: pg_prepare
manual_id: function.pg-prepare
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
purpose:
Submits a request to create a prepared statement with the   given parameters, and waits for completion

return_description:
<p class="para">
   An <span class="classname">PgSql\Result</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_query_params
manual_id: function.pg-query-params
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
purpose:
Submits a command to the server and waits for the result, with the ability to pass parameters separately from the SQL command text

return_description:
<p class="para">
    An <span class="classname">PgSql\Result</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_result_error_field
purpose: Returns an individual field of an error report
manual_id: function.pg-result-error-field
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">A <span class="type">string</span> containing the contents of the error field, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the field does not exist or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  on failure.</p>


name: pg_result_error
purpose: Get error message associated with result
manual_id: function.pg-result-error
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="type">string</span>. Returns empty string if there is no error. If there is an error associated with the
   <code class="parameter">result</code> parameter, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: pg_result_status
purpose: Get status of query result
manual_id: function.pg-result-status
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Possible return values are <strong><code><a href="pgsql.constants.html#constant.pgsql-empty-query">PGSQL_EMPTY_QUERY</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-command-ok">PGSQL_COMMAND_OK</a></code></strong>, <strong><code><a href="pgsql.constants.html#constant.pgsql-tuples-ok">PGSQL_TUPLES_OK</a></code></strong>, <strong><code><a href="pgsql.constants.html#constant.pgsql-copy-out">PGSQL_COPY_OUT</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-copy-in">PGSQL_COPY_IN</a></code></strong>, <strong><code><a href="pgsql.constants.html#constant.pgsql-bad-response">PGSQL_BAD_RESPONSE</a></code></strong>, <strong><code><a href="pgsql.constants.html#constant.pgsql-nonfatal-error">PGSQL_NONFATAL_ERROR</a></code></strong> and
   <strong><code><a href="pgsql.constants.html#constant.pgsql-fatal-error">PGSQL_FATAL_ERROR</a></code></strong> if <strong><code><a href="pgsql.constants.html#constant.pgsql-status-long">PGSQL_STATUS_LONG</a></code></strong> is
   specified.  Otherwise, a <span class="type">string</span> containing the PostgreSQL command tag is returned.
  </p>


name: pg_select
purpose: Select records
manual_id: function.pg-select
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <span class="type">string</span> if <strong><code><a href="pgsql.constants.html#constant.pgsql-dml-string">PGSQL_DML_STRING</a></code></strong> is passed
   via <code class="parameter">flags</code>, otherwise it returns an <span class="type">array</span> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_send_execute
manual_id: function.pg-send-execute
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
purpose:
Sends a request to execute a prepared statement with given parameters, without waiting for the result(s)

return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> or <code class="literal">0</code> on failure.  Use <span class="function">pg_get_result</span>
   to determine the query result.
  </p>


name: pg_send_prepare
manual_id: function.pg-send-prepare
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
purpose:
Sends a request to create a prepared statement with the given parameters, without waiting for completion

return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> or <code class="literal">0</code> on failure.  Use <span class="function">pg_get_result</span>
   to determine the query result.
  </p>


name: pg_send_query_params
purpose: Submits a command and separate parameters to the server without waiting for the result(s)
manual_id: function.pg-send-query-params
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
    Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> or <code class="literal">0</code> on failure.  Use <span class="function">pg_get_result</span>
    to determine the query result.
  </p>


name: pg_set_client_encoding
purpose: Set the client encoding
manual_id: function.pg-set-client-encoding
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns <code class="literal">0</code> on success or <code class="literal">-1</code> on error.
  </p>


name: pg_set_error_context_visibility
manual_id: function.pg-set-error-context-visibility
version: PHP 8 >= 8.3.0
return_type: int
purpose:
Determines the visibility of the context's error messages returned by pg_last_error   and pg_result_error

return_description:
<p class="para">
   The previous visibility level: <strong><code><a href="pgsql.constants.html#constant.pgsql-show-context-never">PGSQL_SHOW_CONTEXT_NEVER</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-show-context-errors">PGSQL_SHOW_CONTEXT_ERRORS</a></code></strong>
   or <strong><code><a href="pgsql.constants.html#constant.pgsql-show-context-always">PGSQL_SHOW_CONTEXT_ALWAYS</a></code></strong>.
  </p>


name: pg_set_error_verbosity
purpose: Determines the verbosity of messages returned by pg_last_error and pg_result_error
manual_id: function.pg-set-error-verbosity
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The previous verbosity level: <strong><code><a href="pgsql.constants.html#constant.pgsql-errors-terse">PGSQL_ERRORS_TERSE</a></code></strong>,
   <strong><code><a href="pgsql.constants.html#constant.pgsql-errors-default">PGSQL_ERRORS_DEFAULT</a></code></strong>
   or <strong><code><a href="pgsql.constants.html#constant.pgsql-errors-verbose">PGSQL_ERRORS_VERBOSE</a></code></strong>.
  </p>


name: pg_socket
purpose: Get a read only handle to the socket underlying a PostgreSQL connection
manual_id: function.pg-socket
version: PHP 5 >= 5.6.0, PHP 7, PHP 8
return_type: resource
return_description:
<p class="para">
   A socket resource on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pg_transaction_status
purpose: Returns the current in-transaction status of the server
manual_id: function.pg-transaction-status
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">The status can be <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-idle">PGSQL_TRANSACTION_IDLE</a></code></strong> (currently idle),
    <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-active">PGSQL_TRANSACTION_ACTIVE</a></code></strong> (a command is in progress),
    <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-intrans">PGSQL_TRANSACTION_INTRANS</a></code></strong> (idle, in a valid transaction block),
    or <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-inerror">PGSQL_TRANSACTION_INERROR</a></code></strong> (idle, in a failed transaction block).
    <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-unknown">PGSQL_TRANSACTION_UNKNOWN</a></code></strong> is reported if the connection is bad.
    <strong><code><a href="pgsql.constants.html#constant.pgsql-transaction-active">PGSQL_TRANSACTION_ACTIVE</a></code></strong> is reported only when a query
    has been sent to the server and not yet completed.
  </p>


name: pg_tty
purpose: Return the TTY name associated with the connection
manual_id: function.pg-tty
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   A <span class="type">string</span> containing the debug TTY of the <code class="parameter">connection</code>.
  </p>


name: pg_version
purpose: Returns an array with client, protocol and server version (when available)
manual_id: function.pg-version
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array with <code class="literal">client</code>, <code class="literal">protocol</code> 
   and <code class="literal">server</code> keys and values (if available).
  </p>


name: SQLite3.busyTimeout
purpose: Sets the busy connection handler
manual_id: sqlite3.busytimeout
version: PHP 5 >= 5.3.3, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.changes
manual_id: sqlite3.changes
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
purpose:
Returns the number of database rows that were changed (or inserted or   deleted) by the most recent SQL statement

return_description:
<p class="para">
   Returns an <span class="type">int</span> value corresponding to the number of
   database rows changed (or inserted or deleted) by the most recent SQL
   statement.
  </p>


name: SQLite3.createAggregate
purpose: Registers a PHP function for use as an SQL aggregate function
manual_id: sqlite3.createaggregate
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> upon successful creation of the aggregate,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.createFunction
purpose: Registers a PHP function for use as an SQL scalar function
manual_id: sqlite3.createfunction
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> upon successful creation of the function, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.enableExceptions
purpose: Enable throwing exceptions
manual_id: sqlite3.enableexceptions
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns the old value; <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if exceptions were enabled, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SQLite3.escapeString
purpose: Returns a string that has been properly escaped
manual_id: sqlite3.escapestring
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a properly escaped string that may be used safely in an SQL
   statement.
  </p>


name: SQLite3.exec
purpose: Executes a result-less query against a given database
manual_id: sqlite3.exec
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the query succeeded, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.lastErrorCode
purpose: Returns the numeric result code of the most recent failed SQLite request
manual_id: sqlite3.lasterrorcode
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns an integer value representing the numeric result code of the most
   recent failed SQLite request.
  </p>


name: SQLite3.lastErrorMsg
purpose: Returns English text describing the most recent failed SQLite request
manual_id: sqlite3.lasterrormsg
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns an English string describing the most recent failed SQLite request.
  </p>


name: SQLite3.lastInsertRowID
purpose: Returns the row ID of the most recent INSERT into the database
manual_id: sqlite3.lastinsertrowid
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the row ID of the most recent INSERT into the database.
   If no successful INSERTs into rowid tables have ever occurred on this database connection,
   then  <span class="methodname">SQLite3::lastInsertRowID</span> returns <code class="literal">0</code>.
  </p>


name: SQLite3.loadExtension
purpose: Attempts to load an SQLite extension library
manual_id: sqlite3.loadextension
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the extension is successfully loaded, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.openBlob
purpose: Opens a stream resource to read a BLOB
manual_id: sqlite3.openblob
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a stream resource,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.prepare
purpose: Prepares an SQL statement for execution
manual_id: sqlite3.prepare
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">SQLite3Stmt</span> object on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.query
purpose: Executes an SQL query
manual_id: sqlite3.query
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">SQLite3Result</span> object,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3.querySingle
purpose: Executes a query and returns a single result
manual_id: sqlite3.querysingle
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: mixed
return_description:
<p class="para">
   Returns the value of the first column of results or an array of the entire
   first row (if <code class="parameter">entireRow</code> is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>).
  </p>
  <p class="para">
   If the query is valid but no results are returned, then <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be
   returned if <code class="parameter">entireRow</code> is <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, otherwise an
   empty array is returned.
  </p>
  <p class="para">
   Invalid or failing queries will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: SQLite3.setAuthorizer
purpose: Configures a callback to be used as an authorizer to limit what a statement can do
manual_id: sqlite3.setauthorizer
version: PHP 8
return_type: int
errors:
<p class="para">
   This method doesn&#039;t throw any error, but if an authorizer is enabled and returns an
   invalid value, the statement preparation will throw an error (or exception, depending
   on the use of the  <span class="methodname">SQLite3::enableExceptions</span> method).
  </p>


name: SQLite3.version
purpose: Returns the SQLite3 library version as a string constant and as a number
manual_id: sqlite3.version
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative array with the keys &quot;versionString&quot; and
   &quot;versionNumber&quot;.
  </p>


name: SQLite3Stmt.bindParam
purpose: Binds a parameter to a statement variable
manual_id: sqlite3stmt.bindparam
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the parameter is bound to the statement variable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   on failure.
  </p>


name: SQLite3Stmt.bindValue
purpose: Binds the value of a parameter to a statement variable
manual_id: sqlite3stmt.bindvalue
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the value is bound to the statement variable,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3Stmt.clear
purpose: Clears all current bound parameters
manual_id: sqlite3stmt.clear
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on successful clearing of bound parameters, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure.
  </p>


name: SQLite3Stmt.close
purpose: Closes the prepared statement
manual_id: sqlite3stmt.close
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
  </p>


name: SQLite3Stmt.execute
purpose: Executes a prepared statement and returns a result set object
manual_id: sqlite3stmt.execute
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="classname">SQLite3Result</span> object on successful execution of the prepared
   statement, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3Stmt.getSQL
purpose: Get the SQL of the statement
manual_id: sqlite3stmt.getsql
version: PHP 7 >= 7.4.0, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the SQL of the prepared statement,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   If <code class="parameter">expand</code> is <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, but the libsqlite version is less
   than 3.14, an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> or an <span class="classname">Exception</span>
   is issued, according to  <span class="methodname">SQLite3::enableExceptions</span>.
  </p>


name: SQLite3Stmt.readOnly
purpose: Returns whether a statement is definitely read only
manual_id: sqlite3stmt.readonly
version: PHP 5 >= 5.3.6, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if a statement is definitely read only, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: SQLite3Stmt.reset
purpose: Resets the prepared statement
manual_id: sqlite3stmt.reset
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the statement is successfully reset,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: SQLite3Result.columnName
purpose: Returns the name of the nth column
manual_id: sqlite3result.columnname
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the <span class="type">string</span> name of the column identified by
   <code class="parameter">column</code>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the column does not exist.
  </p>


name: SQLite3Result.columnType
purpose: Returns the type of the nth column
manual_id: sqlite3result.columntype
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the data type index of the column identified by
   <code class="parameter">column</code> (one of
   <strong><code><a href="sqlite3.constants.html#constant.sqlite3-integer">SQLITE3_INTEGER</a></code></strong>, <strong><code><a href="sqlite3.constants.html#constant.sqlite3-float">SQLITE3_FLOAT</a></code></strong>,
   <strong><code><a href="sqlite3.constants.html#constant.sqlite3-text">SQLITE3_TEXT</a></code></strong>, <strong><code><a href="sqlite3.constants.html#constant.sqlite3-blob">SQLITE3_BLOB</a></code></strong>, or
   <strong><code><a href="sqlite3.constants.html#constant.sqlite3-null">SQLITE3_NULL</a></code></strong>), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the column does not exist.
  </p>


name: SQLite3Result.fetchArray
purpose: Fetches a result row as an associative or numerically indexed array or both
manual_id: sqlite3result.fetcharray
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a result row as an associatively or numerically indexed array or
   both. Alternately will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there are no more rows.
  </p>
  <p class="para">
   The types of the values of the returned array are mapped from SQLite3 types
   as follows: integers are mapped to <span class="type">int</span> if they fit into the
   range <strong><code><a href="reserved.constants.html#constant.php-int-min">PHP_INT_MIN</a></code></strong>..<strong><code><a href="reserved.constants.html#constant.php-int-max">PHP_INT_MAX</a></code></strong>, and
   to <span class="type">string</span> otherwise. Floats are mapped to <span class="type">float</span>,
   <code class="literal">NULL</code> values are mapped to <span class="type">null</span>, and strings
   and blobs are mapped to <span class="type">string</span>.
  </p>


name: SQLite3Result.reset
purpose: Resets the result set back to the first row
manual_id: sqlite3result.reset
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the result set is successfully reset
   back to the first row, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: sqlsrv_client_info
purpose: Returns information about the client and specified connection
manual_id: function.sqlsrv-client-info
return_type: array
return_description:
<p class="para">
   Returns an associative array with keys described in the table below. 
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise. 
   <table class="doctable table">
   <caption><strong>Array returned by sqlsrv_client_info</strong></caption>
   
    <thead>
     <tr>
      <th>Key</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>DriverDllName</td>
      <td>SQLNCLI10.DLL</td>
     </tr>

     <tr>
      <td>DriverODBCVer</td>
      <td>ODBC version (xx.yy)</td>
     </tr>

     <tr>
      <td>DriverVer</td>
      <td>SQL Server Native Client DLL version (10.5.xxx)</td>
     </tr>

     <tr>
      <td>ExtensionVer</td>
      <td>php_sqlsrv.dll version (2.0.xxx.x)</td>
     </tr>

    </tbody>
   
  </table>

  </p>


name: sqlsrv_connect
purpose: Opens a connection to a Microsoft SQL Server database
manual_id: function.sqlsrv-connect
return_type: resource
return_description:
<p class="para">
   A connection resource. If a connection cannot be successfully opened, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: sqlsrv_errors
purpose: Returns error and warning information about the last SQLSRV operation performed
manual_id: function.sqlsrv-errors
return_type: mixed
return_description:
<p class="para">
   If errors and/or warnings occurred on the last sqlsrv operation, an array of 
   arrays containing error information is returned. If no errors and/or warnings 
   occurred on the last sqlsrv operation, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> is returned. The following table 
   describes the structure of the returned arrays:
   <table class="doctable table">
   <caption><strong>Array returned by sqlsrv_errors</strong></caption>
   
    <thead>
     <tr>
      <th>Key</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>SQLSTATE</td>
      <td>For errors that originate from the ODBC driver, the SQLSTATE returned 
      by ODBC. For errors that originate from the Microsoft Drivers for PHP for 
      SQL Server, a SQLSTATE of IMSSP. For warnings that originate from the 
      Microsoft Drivers for PHP for SQL Server, a SQLSTATE of 01SSP.
      </td>
     </tr>

     <tr>
      <td>code</td>
      <td>For errors that originate from SQL Server, the native SQL Server 
      error code. For errors that originate from the ODBC driver, the error 
      code returned by ODBC. For errors that originate from the Microsoft Drivers 
      for PHP for SQL Server, the Microsoft Drivers for PHP for SQL Server error code.
      </td>
     </tr>

     <tr>
      <td>message</td>
      <td>A description of the error.</td>
     </tr>

    </tbody>
   
  </table>

  </p>


name: sqlsrv_fetch_array
purpose: Returns a row as an array
manual_id: function.sqlsrv-fetch-array
return_type: array
return_description:
<p class="para">
   Returns an array on success, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there are no more rows to return, and 
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs.
  </p>


name: sqlsrv_fetch_object
purpose: Retrieves the next row of data in a result set as an object
manual_id: function.sqlsrv-fetch-object
return_type: mixed
return_description:
<p class="para"> 
   Returns an object on success, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there are no more rows to return, 
   and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs or if the specified class does not exist.
  </p>


name: sqlsrv_fetch
purpose: Makes the next row in a result set available for reading
manual_id: function.sqlsrv-fetch
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the next row of a result set was successfully retrieved, 
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs, and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there are no more rows in the result set.
  </p>


name: sqlsrv_field_metadata
purpose: Retrieves metadata for the fields of a statement prepared by sqlsrv_prepare or sqlsrv_query
manual_id: function.sqlsrv-field-metadata
return_type: mixed
return_description:
<p class="para">
   Returns an array of arrays on success. Otherwise, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned. 
   Each returned array is described by the following table:
   <table class="doctable table">
   <caption><strong>Array returned by sqlsrv_field_metadata</strong></caption>
   
    <thead>
     <tr>
      <th>Key</th>
      <th>Description</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>Name</td>
      <td>The name of the field.</td>
     </tr>

     <tr>
      <td>Type</td>
      <td>The numeric value for the SQL type.</td>
     </tr>

     <tr>
      <td>Size</td>
      <td>The number of characters for fields of character type, the number of 
      bytes for fields of binary type, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for other types.</td>
     </tr>

     <tr>
      <td>Precision</td>
      <td>The precision for types of variable precision, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for other types.</td>
     </tr>

     <tr>
      <td>Scale</td>
      <td>The scale for types of variable scale, <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> for other types.</td>
     </tr>

     <tr>
      <td>Nullable</td>
      <td>An enumeration indicating whether the column is nullable, not nullable, 
      or if it is not known.</td>
     </tr>

    </tbody>
   
  </table>

  For more information, see <a href="http://msdn.microsoft.com/en-us/library/cc296197.aspx" class="link external">&raquo;&nbsp;sqlsrv_field_metadata</a> 
  in the Microsoft SQLSRV documentation.
  </p>


name: sqlsrv_get_config
purpose: Returns the value of the specified configuration setting
manual_id: function.sqlsrv-get-config
return_type: mixed
return_description:
<p class="para">
   Returns the value of the specified setting. If an invalid setting is specified, 
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: sqlsrv_get_field
purpose: Gets field data from the currently selected row
manual_id: function.sqlsrv-get-field
return_type: mixed
return_description:
<p class="para">
   Returns data from the specified field on success. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: sqlsrv_has_rows
purpose: Indicates whether the specified statement has rows
manual_id: function.sqlsrv-has-rows
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the specified statement has rows and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the statement 
   does not have rows or if an error occurred.
  </p>


name: sqlsrv_next_result
purpose: Makes the next result of the specified statement active
manual_id: function.sqlsrv-next-result
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the next result was successfully retrieved, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error 
   occurred, and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there are no more results to retrieve.
  </p>


name: sqlsrv_num_fields
purpose: Retrieves the number of fields (columns) on a statement
manual_id: function.sqlsrv-num-fields
return_type: mixed
return_description:
<p class="para">
   Returns the number of fields on success. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: sqlsrv_num_rows
purpose: Retrieves the number of rows in a result set
manual_id: function.sqlsrv-num-rows
return_type: mixed
return_description:
<p class="para">
   Returns the number of rows retrieved on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred. 
   If a forward cursor (the default) or dynamic cursor is used, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: sqlsrv_prepare
purpose: Prepares a query for execution
manual_id: function.sqlsrv-prepare
return_type: mixed
return_description:
<p class="para">
   Returns a statement resource on success and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: sqlsrv_rows_affected
purpose: Returns the number of rows modified by the last INSERT, UPDATE, or DELETE query executed
manual_id: function.sqlsrv-rows-affected
return_type: false
return_description:
<p class="para">
   Returns the number of rows affected by the last INSERT, UPDATE, or DELETE query. 
   If no rows were affected, 0 is returned. If the number of affected rows cannot 
   be determined, -1 is returned. If an error occurred, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: sqlsrv_send_stream_data
purpose: Sends data from parameter streams to the server
manual_id: function.sqlsrv-send-stream-data
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is more data to send and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there is not.
  </p>


name: sqlsrv_server_info
purpose: Returns information about the server
manual_id: function.sqlsrv-server-info
return_type: array
return_description:
<p class="para">
   Returns an array as described in the following table:
  <table class="doctable table">
  <caption><strong>Returned Array</strong></caption>
   
    <thead>
     <tr>
      <th>CurrentDatabase</th>
      <th>The connected-to database.</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>SQLServerVersion</td>
      <td>The SQL Server version.</td>
     </tr>

     <tr>
      <td>SQLServerName</td>
      <td>The name of the server.</td>
     </tr>

    </tbody>
   
  </table>
 
</p>


name: cal_from_jd
purpose: Converts from Julian Day Count to a supported calendar
manual_id: function.cal-from-jd
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array containing calendar information like month, day, year,
   day of week (<code class="literal">dow</code>), abbreviated and full names of weekday and month and the
   date in string form &quot;month/day/year&quot;.
   The day of week ranges from <code class="literal">0</code> (Sunday) to
   <code class="literal">6</code> (Saturday).
  </p>


name: easter_date
purpose: Get Unix timestamp for midnight on Easter of a given year
manual_id: function.easter-date
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> The easter date as a unix timestamp. </p>
errors:
<p class="para">
   A <span class="classname">ValueError</span> is thrown if the year is earlier than 1970 or later than 2037
   when running on a 32-bit system, or later than 2,000,000,000 on a 64-bit system.
  </p>


name: easter_days
purpose: Get number of days after March 21 on which Easter falls for a given year
manual_id: function.easter-days
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The number of days after March 21st that the Easter Sunday
   is in the given <code class="parameter">year</code>.
  </p>


name: gregoriantojd
purpose: Converts a Gregorian date to Julian Day Count
manual_id: function.gregoriantojd
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The julian day for the given gregorian date as an integer.
   Dates outside the valid range return <code class="literal">0</code>.
  </p>


name: jdmonthname
purpose: Returns a month name
manual_id: function.jdmonthname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The month name for the given Julian Day and <code class="parameter">mode</code>.
  </p>


name: jdtofrench
purpose: Converts a Julian Day Count to the French Republican Calendar
manual_id: function.jdtofrench
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The french revolution date as a string in the form &quot;month/day/year&quot;
  </p>


name: jdtojewish
purpose: Converts a Julian day count to a Jewish calendar date
manual_id: function.jdtojewish
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The Jewish date as a string in the form &quot;month/day/year&quot;, or an ISO-8859-8
   encoded Hebrew date string, according to the <code class="parameter">hebrew</code>
   parameter.
  </p>


name: jdtounix
purpose: Convert Julian Day to Unix timestamp
manual_id: function.jdtounix
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   The unix timestamp for the start (midnight, not noon) of the given Julian day
  </p>

errors:
<p class="para">
   If <code class="parameter">julian_day</code> is outside of the allowed range,
   a <span class="classname">ValueError</span> is thrown.
  </p>


name: unixtojd
purpose: Convert Unix timestamp to Julian Day
manual_id: function.unixtojd
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   A julian day number as integer,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: DateTime.add
purpose: Modifies a DateTime object, with added amount of days, months, years, hours, minutes and seconds
manual_id: datetime.add
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: DateTime
return_description:
<p class="para">
   Returns the modified <span class="classname">DateTime</span> object for method chaining.
  </p>


name: DateTime.__construct
purpose: Returns new DateTime object
manual_id: datetime.construct
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_description: <p class="para"> Returns a new DateTime instance. </p>
errors:
<p class="para">
    If an invalid Date/Time string is passed,
    <span class="exceptionname">DateMalformedStringException</span> is thrown.
    Previous to PHP 8.3, this was <span class="exceptionname">Exception</span>.
  </p>


name: DateTime.createFromFormat
purpose: Parses a time string according to a specified format
manual_id: datetime.createfromformat
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new DateTime instance or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   This method throws <span class="exceptionname">ValueError</span> when the
   <code class="parameter">datetime</code> contains NULL-bytes.
  </p>


name: DateTime.modify
purpose: Alters the timestamp
manual_id: datetime.modify
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the modified <span class="classname">DateTime</span> object for method chaining or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
    Object Orientated API only: If an invalid Date/Time string is passed,
    <span class="exceptionname">DateMalformedStringException</span> is thrown.
  </p>


name: DateTime.setTimezone
purpose: Sets the time zone for the DateTime object
manual_id: datetime.settimezone
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   Returns the <span class="classname">DateTime</span> object for method chaining. The
   underlaying point-in-time is not changed when calling this method.
  </p>


name: DateTime.sub
purpose: Subtracts an amount of days, months, years, hours, minutes and seconds from a DateTime object
manual_id: datetime.sub
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: DateTime
errors:
<p class="para">
    Object Orientated API only: If an unsupported operation is attempted, such as using a
    <span class="classname">DateInterval</span> object representing relative time
    specifications such as <code class="literal">next weekday</code>, a
    <span class="exceptionname">DateInvalidOperationException</span> is thrown.
  </p>


name: DateTimeImmutable.add
purpose: Returns a new object, with added amount of days, months, years, hours, minutes and seconds
manual_id: datetimeimmutable.add
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: DateTimeImmutable
return_description:
<p class="para">
   Returns a new <span class="classname">DateTimeImmutable</span> object with the modified data.
  </p>


name: DateTimeImmutable.createFromFormat
purpose: Parses a time string according to a specified format
manual_id: datetimeimmutable.createfromformat
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new DateTimeImmutable instance or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   This method throws <span class="exceptionname">ValueError</span> when the
   <code class="parameter">datetime</code> contains NULL-bytes.
  </p>


name: DateTimeImmutable.getLastErrors
purpose: Returns the warnings and errors
manual_id: datetimeimmutable.getlasterrors
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns array containing info about warnings and errors, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if there
   are neither warnings nor errors.
  </p>


name: DateTimeImmutable.modify
purpose: Creates a new object with modified timestamp
manual_id: datetimeimmutable.modify
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: DateTimeImmutable
return_description:
<p class="para">
   Returns a new modified DateTimeImmutable object or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
    If an invalid Date/Time string is passed,
    <span class="exceptionname">DateMalformedStringException</span> is thrown.
    Previous to PHP 8.3, this was a warning.
  </p>


name: DateTimeImmutable.setTimezone
purpose: Sets the time zone
manual_id: datetimeimmutable.settimezone
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: DateTimeImmutable
return_description:
<p class="para">
   Returns a new modified <span class="classname">DateTimeImmutable</span> object for
   method chaining. The underlaying point-in-time is not changed when calling
   this method.
  </p>


name: DateTimeImmutable.sub
purpose: Subtracts an amount of days, months, years, hours, minutes and seconds
manual_id: datetimeimmutable.sub
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: DateTimeImmutable
errors:
<p class="para">
    If an unsupported operation is attempted, such as using a
    <span class="classname">DateInterval</span> object representing relative time
    specifications such as <code class="literal">next weekday</code>, a
    <span class="exceptionname">DateInvalidOperationException</span> is thrown.
  </p>


name: DateTimeInterface.diff
purpose: Returns the difference between two DateTime objects
manual_id: datetime.diff
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: DateInterval
return_description:
<p class="para">
   The <span class="classname">DateInterval</span> object represents the
   difference between the two dates.
  </p>
  <p class="para">
   The return value more specifically represents the clock-time interval to
   apply to the original object (<code class="parameter">$this</code> or
   <code class="parameter">$originObject</code>) to arrive at the
   <code class="parameter">$targetObject</code>. This process is not always
   reversible.
  </p>
  <p class="para">
   The method is aware of DST changeovers, and hence can return an interval of
   <code class="literal">24 hours and 30 minutes</code>, as per one of the examples. If
   you want to calculate with absolute time, you need to convert both the
   <code class="parameter">$this</code>/<code class="parameter">$baseObject</code>, and
   <code class="parameter">$targetObject</code> to UTC first.
  </p>


name: DateTimeInterface.getTimestamp
purpose: Gets the Unix timestamp
manual_id: datetime.gettimestamp
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: int
return_description: <p class="para"> Returns the Unix timestamp representing the date. </p>
errors:
<p class="para">
   If the timestamp cannot be represented as <span class="type">int</span>, a
   <span class="exceptionname">DateRangeError</span> is thrown. Prior to PHP
   8.3.0, a <span class="exceptionname">ValueError</span> is thrown. And, prior to
   PHP 8.0.0, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> was returned in this case. Still, the timestamp can be
   retrieved as <span class="type">string</span> by using
    <span class="methodname">DateTimeInterface::format</span> with the
   <code class="literal">U</code> format.
  </p>


name: DateTimeInterface.getTimezone
purpose: Return time zone relative to given DateTime
manual_id: datetime.gettimezone
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="classname">DateTimeZone</span> object on success
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: DateTimeZone.__construct
purpose: Creates new DateTimeZone object
manual_id: datetimezone.construct
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns <span class="classname">DateTimeZone</span> on success.
   Procedural style returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   This method throws
   <span class="exceptionname">DateInvalidTimeZoneException</span> if the timezone supplied is not
   recognised as a valid timezone. Prior to PHP 8.3, this was an
   <span class="exceptionname">Exception</span> instead.
  </p>


name: DateTimeZone.getLocation
purpose: Returns location information for a timezone
manual_id: datetimezone.getlocation
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Array containing location information about timezone or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: DateTimeZone.getName
purpose: Returns the name of the timezone
manual_id: datetimezone.getname
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Depending on zone type, UTC offset (type 1), timezone abbreviation (type
   2), and timezone identifiers as published in the IANA timezone database
   (type 3), the descriptor string to create a new
   <span class="classname">DateTimeZone</span> object with the same offset and/or
   rules. For example <code class="literal">02:00</code>, <code class="literal">CEST</code>, or
   one of the timezone names in the <a href="timezones.html" class="link">list of
   timezones</a>.
  </p>


name: DateTimeZone.getTransitions
purpose: Returns all transitions for the timezone
manual_id: datetimezone.gettransitions
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a numerically indexed array of
   transition arrays on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. DateTimeZone
   objects wrapping type 1 (UTC offsets) and type 2 (abbreviations) do not
   contain any transitions, and calling this method on them will return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <p class="para">
   If <code class="parameter">timestampBegin</code> is given, the first entry in the
   returned array will contain a transition element at the time of
   <code class="parameter">timestampBegin</code>.
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Transition Array Structure</strong></caption>
    
     <thead>
      <tr>
       <th>Key</th>
       <th>Type</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">ts</code></td>
       <td><span class="type">int</span></td>
       <td>Unix timestamp</td>
      </tr>

      <tr>
       <td><code class="literal">time</code></td>
       <td><span class="type">string</span></td>
       <td><strong><code><a href="class.datetimeinterface.html#datetimeinterface.constants.iso8601-expanded">DateTimeInterface::ISO8601_EXPANDED</a></code></strong> (PHP
       8.2 and later), or <strong><code><a href="class.datetimeinterface.html#datetimeinterface.constants.iso8601">DateTimeInterface::ISO8601</a></code></strong> (PHP
       8.1 and lower) time string</td>
      </tr>

      <tr>
       <td><code class="literal">offset</code></td>
       <td><span class="type">int</span></td>
       <td>Offset to UTC in seconds</td>
      </tr>

      <tr>
       <td><code class="literal">isdst</code></td>
       <td><span class="type">bool</span></td>
       <td>Whether daylight saving time is active</td>
      </tr>

      <tr>
       <td><code class="literal">abbr</code></td>
       <td><span class="type">string</span></td>
       <td>Timezone abbreviation</td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: DateTimeZone.listIdentifiers
purpose: Returns a numerically indexed array containing all defined timezone identifiers
manual_id: datetimezone.listidentifiers
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns the array of timezone identifiers. Only non-outdated items are
   returned. To get all, including outdated timezone identifiers, use the
   <code class="literal">DateTimeZone::ALL_WITH_BC</code> as value for
   <code class="parameter">timezoneGroup</code>.
  </p>


name: DateInterval.__construct
purpose: Creates a new DateInterval object
manual_id: dateinterval.construct
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws an <span class="classname">DateMalformedIntervalStringException</span> when
   the <code class="parameter">duration</code> cannot be parsed as an interval. Prior
   to PHP 8.3, this was <span class="exceptionname">Exception</span>.
  </p>


name: DateInterval.createFromDateString
purpose: Sets up a DateInterval from the relative parts of the string
manual_id: dateinterval.createfromdatestring
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new <span class="classname">DateInterval</span> instance on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: DatePeriod.__construct
purpose: Creates a new DatePeriod object
manual_id: dateperiod.construct
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
errors:
<p class="para">
   Throws an <span class="classname">DateMalformedPeriodStringException</span> when
   the <code class="parameter">isostr</code> cannot be parsed as a valid ISO 8601
   period. Prior to PHP 8.3, this was
   <span class="exceptionname">Exception</span>.
  </p>


name: DatePeriod.createFromISO8601String
purpose: Creates a new DatePeriod object from an ISO8601 string
manual_id: dateperiod.createfromiso8601string
version: PHP 8 >= 8.3.0
return_type: static
return_description:
<p class="para">
   Creates a new DatePeriod object.
  </p>
  <p class="para">
   <span class="classname">DatePeriod</span> objects created with this method can be
   used as an iterator to generate a number of
   <span class="classname">DateTimeImmutable</span> objects.
  </p>

errors:
<p class="para">
   Throws an <span class="classname">DateMalformedPeriodStringException</span> when
   the <code class="parameter">specification</code> cannot be parsed as a valid ISO 8601
   period.
  </p>


name: DatePeriod.getDateInterval
purpose: Gets the interval
manual_id: dateperiod.getdateinterval
version: PHP 5 >= 5.6.5, PHP 7, PHP 8
return_type: object
return_description:
<p class="para">
   Returns a <span class="classname">DateInterval</span> <span class="type">object</span>
  </p>


name: DatePeriod.getEndDate
purpose: Gets the end date
manual_id: dateperiod.getenddate
version: PHP 5 >= 5.6.5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if the <span class="classname">DatePeriod</span> does
   not have an end date. For example, when initialized with the
   <code class="parameter">recurrences</code> parameter, or the
   <code class="parameter">isostr</code> parameter without an
   end date.
  </p>
  <p class="para">
   Returns a <span class="classname">DateTimeImmutable</span> <span class="type">object</span>
   when the <span class="classname">DatePeriod</span> is initialized with a
   <span class="classname">DateTimeImmutable</span> <span class="type">object</span>
   as the <code class="parameter">end</code> parameter.
  </p>
  <p class="para">
   Returns a cloned <span class="classname">DateTime</span> <span class="type">object</span>
   representing the end date otherwise.
  </p>


name: DatePeriod.getRecurrences
purpose: Gets the number of recurrences
manual_id: dateperiod.getrecurrences
version: PHP 7 >= 7.2.17/7.3.4, PHP 8
return_type: null
return_description:
<p class="para">
   The number of recurrences as set by explicitly passing the
   <code class="literal">$recurrences</code> to the contructor of the
   <span class="classname">DatePeriod</span> class, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> otherwise.
  </p>


name: DatePeriod.getStartDate
purpose: Gets the start date
manual_id: dateperiod.getstartdate
version: PHP 5 >= 5.6.5, PHP 7, PHP 8
return_type: DateTimeInterface
return_description:
<p class="para">
   Returns a <span class="classname">DateTimeImmutable</span> <span class="type">object</span>
   when the <span class="classname">DatePeriod</span> is initialized with a
   <span class="classname">DateTimeImmutable</span> <span class="type">object</span>
   as the <code class="parameter">start</code> parameter.
  </p>
  <p class="para">
   Returns a <span class="classname">DateTime</span> <span class="type">object</span>
   otherwise.
  </p>


name: checkdate
purpose: Validate a Gregorian date
manual_id: function.checkdate
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the date given is valid; otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: date_create_immutable
purpose: create a new DateTimeImmutable object
manual_id: function.date-create-immutable
version: PHP 5 >= 5.5.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new DateTimeImmutable instance  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: date_create
purpose: create a new DateTime object
manual_id: function.date-create
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a new DateTime instance  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: date_default_timezone_set
purpose: Sets the default timezone used by all date/time functions in a script
manual_id: function.date-default-timezone-set
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   <code class="parameter">timezoneId</code> isn&#039;t valid, or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
   otherwise.
  </p>


name: date_parse_from_format
purpose: Get info about given date formatted according to the specified format
manual_id: function.date-parse-from-format
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns associative array with detailed info about given date/time.
  </p>
  <p class="para">
   The returned array has keys for <code class="literal">year</code>,
   <code class="literal">month</code>, <code class="literal">day</code>, <code class="literal">hour</code>,
   <code class="literal">minute</code>, <code class="literal">second</code>,
   <code class="literal">fraction</code>, and <code class="literal">is_localtime</code>.
  </p>
  <p class="para">
   If <code class="literal">is_localtime</code> is present then
   <code class="literal">zone_type</code> indicates the type of timezone. For type
   <code class="literal">1</code> (UTC offset) the <code class="literal">zone</code>,
   <code class="literal">is_dst</code> fields are added; for type <code class="literal">2</code>
   (abbreviation) the fields <code class="literal">tz_abbr</code>,
   <code class="literal">is_dst</code> are added; and for type <code class="literal">3</code>
   (timezone identifier) the <code class="literal">tz_abbr</code>,
   <code class="literal">tz_id</code> are added.
  </p>
  <p class="para">
   The array includes <code class="literal">warning_count</code> and
   <code class="literal">warnings</code> fields. The first one indicate how many
   warnings there were.
   The keys of elements <code class="literal">warnings</code> array indicate the
   position in the given <code class="parameter">datetime</code> where the warning
   occurred, with the string value describing the warning itself. An example
   below shows such a warning.
  </p>
  <p class="para">
   The array also contains <code class="literal">error_count</code> and
   <code class="literal">errors</code> fields. The first one indicate how many errors
   were found.
   The keys of elements <code class="literal">errors</code> array indicate the
   position in the given <code class="parameter">datetime</code> where the error
   occurred, with the string value describing the error itself. An example
   below shows such an error.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    The number of array elements in the <code class="literal">warnings</code> and
    <code class="literal">errors</code> arrays might be less than
    <code class="literal">warning_count</code> or <code class="literal">error_count</code> if they
    occurred at the same position.
   </p>
  </div>

errors:
<p class="para">
   This functions throws <span class="exceptionname">ValueError</span> when the
   <code class="parameter">datetime</code> contains NULL-bytes.
  </p>


name: date_parse
purpose: Returns associative array with detailed info about given date/time
manual_id: function.date-parse
version: PHP 5 >= 5.2.0, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns <span class="type">array</span> with information about the parsed date/time.
  </p>
  <p class="para">
   The returned array has keys for <code class="literal">year</code>,
   <code class="literal">month</code>, <code class="literal">day</code>, <code class="literal">hour</code>,
   <code class="literal">minute</code>, <code class="literal">second</code>,
   <code class="literal">fraction</code>, and <code class="literal">is_localtime</code>.
  </p>
  <p class="para">
   If <code class="literal">is_localtime</code> is present then
   <code class="literal">zone_type</code> indicates the type of timezone. For type
   <code class="literal">1</code> (UTC offset) the <code class="literal">zone</code>,
   <code class="literal">is_dst</code> fields are added; for type <code class="literal">2</code>
   (abbreviation) the fields <code class="literal">tz_abbr</code>,
   <code class="literal">is_dst</code> are added; and for type <code class="literal">3</code>
   (timezone identifier) the <code class="literal">tz_abbr</code>,
   <code class="literal">tz_id</code> are added.
  </p>
  <p class="para">
   If relative time elements are present in the
   <code class="parameter">datetime</code> string such as <code class="literal">+3 days</code>,
   the then returned array includes a nested array with the key
   <code class="literal">relative</code>. This array then contains the keys
   <code class="literal">year</code>, <code class="literal">month</code>, <code class="literal">day</code>,
   <code class="literal">hour</code>, <code class="literal">minute</code>,
   <code class="literal">second</code>, and if necessary <code class="literal">weekday</code>, and
   <code class="literal">weekdays</code>, depending on the string that was passed in.
  </p>
  <p class="para">
   The array includes <code class="literal">warning_count</code> and
   <code class="literal">warnings</code> fields. The first one indicate how many
   warnings there were.
   The keys of elements <code class="literal">warnings</code> array indicate the
   position in the given <code class="parameter">datetime</code> where the warning
   occurred, with the string value describing the warning itself.
  </p>
  <p class="para">
   The array also contains <code class="literal">error_count</code> and
   <code class="literal">errors</code> fields. The first one indicate how many errors
   were found.
   The keys of elements <code class="literal">errors</code> array indicate the
   position in the given <code class="parameter">datetime</code> where the error
   occurred, with the string value describing the error itself.
  </p>
  <div class="warning"><strong class="warning">Warning</strong>
   <p class="para">
    The number of array elements in the <code class="literal">warnings</code> and
    <code class="literal">errors</code> arrays might be less than
    <code class="literal">warning_count</code> or <code class="literal">error_count</code> if they
    occurred at the same position.
   </p>
  </div>

errors:
<p class="para">
   In case the date/time format has an error, the element &#039;errors&#039; will
   contain the error messages.
  </p>


name: date_sun_info
purpose: Returns an array with information about sunset/sunrise and twilight begin/end
manual_id: function.date-sun-info
version: PHP 5 >= 5.1.2, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns array on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The structure of the array is detailed in the following list:
  </p>
  <p class="para">
   <dl>
    
     <dt><code class="literal">sunrise</code></dt>
     <dd>
      <span class="simpara">
       The timestamp of the sunrise (zenith angle = 90°35&#039;).
      </span>
     </dd> 
    
    
     <dt><code class="literal">sunset</code></dt>
     <dd>
      <span class="simpara">
       The timestamp of the sunset (zenith angle = 90°35&#039;).
      </span>
     </dd> 
    
    
     <dt><code class="literal">transit</code></dt>
     <dd>
      <span class="simpara">
       The timestamp when the sun is at its zenith, i.e. has reached its topmost
       point.
      </span>
     </dd> 
    
    
     <dt><code class="literal">civil_twilight_begin</code></dt>
     <dd>
      <span class="simpara">
       The start of the civil dawn (zenith angle = 96°). It ends at
       <code class="literal">sunrise</code>.
      </span>
     </dd> 
    
    
     <dt><code class="literal">civil_twilight_end</code></dt>
     <dd>
      <span class="simpara">
       The end of the civil dusk (zenith angle = 96°). It starts at
       <code class="literal">sunset</code>.
      </span>
     </dd> 
    
    
     <dt><code class="literal">nautical_twilight_begin</code></dt>
     <dd>
      <span class="simpara">
       The start of the nautical dawn (zenith angle = 102°). It ends at
       <code class="literal">civil_twilight_begin</code>.
      </span>
     </dd> 
    
    
     <dt><code class="literal">nautical_twilight_end</code></dt>
     <dd>
      <span class="simpara">
       The end of the nautical dusk (zenith angle = 102°). It starts at
       <code class="literal">civil_twilight_end</code>.
      </span>
     </dd> 
    
    
     <dt><code class="literal">astronomical_twilight_begin</code></dt>
     <dd>
      <span class="simpara">
       The start of the astronomical dawn (zenith angle = 108°). It ends at
       <code class="literal">nautical_twilight_begin</code>.
      </span>
     </dd> 
    
    
     <dt><code class="literal">astronomical_twilight_end</code></dt>
     <dd>
      <span class="simpara">
       The end of the astronomical dusk (zenith angle = 108°). It starts at
       <code class="literal">nautical_twilight_end</code>.
      </span>
     </dd> 
    
   </dl>
  </p>
  <p class="para"> 
   The values of the array elements are either UNIX timestamps, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   sun is below the respective zenith for the whole day, or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the sun is
   above the respective zenith for the whole day.
  </p>


name: date_sunrise
purpose: Returns time of sunrise for a given day and location
manual_id: function.date-sunrise
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the sunrise time in a specified <code class="parameter">returnFormat</code> on
   success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. One potential reason for failure is that the
   sun does not rise at all, which happens inside the polar circles for part of
   the year.
  </p>

errors:
<p class="para">
Every call to a date/time function will generate a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>
if the time zone is not valid. See also <span class="function">date_default_timezone_set</span></p>


name: date_sunset
purpose: Returns time of sunset for a given day and location
manual_id: function.date-sunset
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the sunset time in a specified <code class="parameter">returnFormat</code> on
   success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure. One potential reason for failure is that the
   sun does not set at all, which happens inside the polar circles for part of
   the year.
  </p>

errors:
<p class="para">
Every call to a date/time function will generate a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>
if the time zone is not valid. See also <span class="function">date_default_timezone_set</span></p>


name: getdate
purpose: Get date/time information
manual_id: function.getdate
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an associative <span class="type">array</span> of information related to
   the <code class="parameter">timestamp</code>. Elements from the returned 
   associative array are as follows:
  </p>
  <p class="para">
   <table class="doctable table">
    <caption><strong>Key elements of the returned associative array</strong></caption>
    
     <thead>
      <tr>
       <th>Key</th>
       <th>Description</th>
       <th>Example returned values</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">&quot;seconds&quot;</code></td>
       <td>Numeric representation of seconds</td>
       <td><code class="literal">0</code> to <code class="literal">59</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;minutes&quot;</code></td>
       <td>Numeric representation of minutes</td>
       <td><code class="literal">0</code> to <code class="literal">59</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;hours&quot;</code></td>
       <td>Numeric representation of hours</td>
       <td><code class="literal">0</code> to <code class="literal">23</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;mday&quot;</code></td>
       <td>Numeric representation of the day of the month</td>
       <td><code class="literal">1</code> to <code class="literal">31</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;wday&quot;</code></td>
       <td>Numeric representation of the day of the week</td>
       <td><code class="literal">0</code> (for Sunday) through <code class="literal">6</code> (for Saturday)</td>
      </tr>

      <tr>
       <td><code class="literal">&quot;mon&quot;</code></td>
       <td>Numeric representation of a month</td>
       <td><code class="literal">1</code> through <code class="literal">12</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;year&quot;</code></td>
       <td>A full numeric representation of a year, 4 digits</td>
       <td>Examples: <code class="literal">1999</code> or <code class="literal">2003</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;yday&quot;</code></td>
       <td>Numeric representation of the day of the year</td>
       <td><code class="literal">0</code> through <code class="literal">365</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;weekday&quot;</code></td>
       <td>A full textual representation of the day of the week</td>
       <td><code class="literal">Sunday</code> through <code class="literal">Saturday</code></td>
      </tr>

      <tr>
       <td><code class="literal">&quot;month&quot;</code></td>
       <td>A full textual representation of a month, such as January or March</td>
       <td><code class="literal">January</code> through <code class="literal">December</code></td>
      </tr>

      <tr>
       <td><code class="literal">0</code></td>
       <td>
        Seconds since the Unix Epoch, similar to the values returned by
        <span class="function">time</span> and used by <span class="function">date</span>.
       </td>
       <td>
        System Dependent, typically <code class="literal">-2147483648</code> through
        <code class="literal">2147483647</code>.
       </td>
      </tr>

     </tbody>
    
   </table>

  </p>


name: gettimeofday
purpose: Get current time
manual_id: function.gettimeofday
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   By default an <span class="type">array</span> is returned. If <code class="parameter">as_float</code>
   is set, then a <span class="type">float</span> is returned.
  </p>
  <p class="para">
   Array keys:
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      &quot;sec&quot; - seconds since the Unix Epoch
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;usec&quot; - microseconds
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;minuteswest&quot; - minutes west of Greenwich
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;dsttime&quot; - type of dst correction
     </span>
    </li>
   </ul>
  </p>


name: gmmktime
purpose: Get Unix timestamp for a GMT date
manual_id: function.gmmktime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a <span class="type">int</span> Unix timestamp on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the
   timestamp doesn&#039;t fit in a PHP integer.
  </p>


name: gmstrftime
purpose: Format a GMT/UTC time/date according to locale settings
manual_id: function.gmstrftime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string formatted according to the given format string
   using the given <code class="parameter">timestamp</code> or the current
   local time if no timestamp is given.  Month and weekday names and
   other language dependent strings respect the current locale set
   with <span class="function">setlocale</span>.
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: idate
purpose: Format a local time/date part as integer
manual_id: function.idate
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an <span class="type">int</span> on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   As <span class="function">idate</span> always returns an <span class="type">int</span> and
   as they can&#039;t start with a &quot;0&quot;, <span class="function">idate</span> may return
   fewer digits than you would expect. See the example below.
  </p>


name: localtime
purpose: Get the local time
manual_id: function.localtime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   If <code class="parameter">associative</code> is set to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> or not supplied then 
   the array is returned as a regular, numerically indexed array.
   If <code class="parameter">associative</code> is set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> then
   <span class="function">localtime</span> returns an associative array containing
   the elements of the structure returned by the C
   function call to localtime. 
   The keys of the associative array are as follows:
  </p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <span class="simpara">
      &quot;tm_sec&quot; - seconds, <code class="literal">0</code> to <code class="literal">59</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_min&quot; - minutes, <code class="literal">0</code> to <code class="literal">59</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_hour&quot; - hours, <code class="literal">0</code> to <code class="literal">23</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_mday&quot; - day of the month, <code class="literal">1</code> to <code class="literal">31</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_mon&quot; - month of the year, <code class="literal">0</code> (Jan) to <code class="literal">11</code> (Dec)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_year&quot; - years since 1900
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_wday&quot; - day of the week, <code class="literal">0</code> (Sun) to <code class="literal">6</code> (Sat)
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_yday&quot; - day of the year, <code class="literal">0</code> to <code class="literal">365</code>
     </span>
    </li>
    <li class="listitem">
     <span class="simpara">
      &quot;tm_isdst&quot; - is daylight savings time in effect?
     </span>
     <span class="simpara">
      Positive if yes, <code class="literal">0</code> if not, negative if unknown.
     </span>
    </li>
   </ul>
  </p>


name: microtime
purpose: Return current Unix timestamp with microseconds
manual_id: function.microtime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: float
return_description:
<p class="para">
   By default, <span class="function">microtime</span> returns a <span class="type">string</span> in
   the form &quot;msec sec&quot;, where <code class="literal">sec</code> is the number of seconds 
   since the Unix epoch (0:00:00 January 1,1970 GMT), and <code class="literal">msec</code> 
   measures microseconds that have elapsed since <code class="literal">sec</code> 
   and is also expressed in seconds as a decimal fraction.
  </p>
  <p class="para">
   If <code class="parameter">as_float</code> is set to <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>, then
   <span class="function">microtime</span> returns a <span class="type">float</span>, which
   represents the current time in seconds since the Unix epoch accurate to the
   nearest microsecond.
  </p>


name: mktime
purpose: Get Unix timestamp for a date
manual_id: function.mktime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">mktime</span> returns the Unix timestamp of the arguments
   given, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the timestamp doesn&#039;t fit in a PHP integer.
  </p>


name: strftime
purpose: Format a local time/date according to locale settings
manual_id: function.strftime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string formatted according <code class="parameter">format</code>
   using the given <code class="parameter">timestamp</code> or the current
   local time if no timestamp is given.  Month and weekday names and
   other language-dependent strings respect the current locale set
   with <span class="function">setlocale</span>.
   The function returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if <code class="parameter">format</code> is empty, contains unsupported
   conversion specifiers, or if the length of the returned string would be greater than
   <code class="literal">4095</code>.
  </p>

errors:
<p class="para">
Every call to a date/time function will generate a <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>
if the time zone is not valid. See also <span class="function">date_default_timezone_set</span></p>
  <p class="para">
   As the output is dependent upon the underlying C library, some conversion
   specifiers are not supported. On Windows, supplying unknown conversion
   specifiers will result in 5 <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> messages and
   return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. On other operating systems you may not get any
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> messages and the output may contain the
   conversion specifiers unconverted.
  </p>


name: strptime
purpose: Parse a time/date generated with strftime
manual_id: function.strptime
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
    Returns an array or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>

    <p class="para">
     <table class="doctable table">
      <caption><strong>The following parameters are returned in the array</strong></caption>
      
       <thead>
        <tr>
         <th>parameters</th>
         <th>Description</th>
        </tr>

       </thead>

       <tbody class="tbody">
        <tr>
         <td><code class="literal">&quot;tm_sec&quot;</code></td>
         <td>Seconds after the minute (0-61)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_min&quot;</code></td>
         <td>Minutes after the hour (0-59)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_hour&quot;</code></td>
         <td>Hour since midnight (0-23)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_mday&quot;</code></td>
         <td>Day of the month (1-31)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_mon&quot;</code></td>
         <td>Months since January (0-11)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_year&quot;</code></td>
         <td>Years since 1900</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_wday&quot;</code></td>
         <td>Days since Sunday (0-6)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;tm_yday&quot;</code></td>
         <td>Days since January 1 (0-365)</td>
        </tr>

        <tr>
         <td><code class="literal">&quot;unparsed&quot;</code></td>
         <td>the <code class="parameter">timestamp</code> part which was not
          recognized using the specified <code class="parameter">format</code></td>
        </tr>

       </tbody>
      
     </table>

    </p>


name: strtotime
purpose: Parse about any English textual datetime description into a Unix timestamp
manual_id: function.strtotime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a timestamp on success, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: timezone_name_from_abbr
purpose: Returns a timezone name by guessing from abbreviation and UTC offset
manual_id: function.timezone-name-from-abbr
version: PHP 5 >= 5.1.3, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns time zone name on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: timezone_version_get
purpose: Gets the version of the timezonedb
manual_id: function.timezone-version-get
version: PHP 5 >= 5.3.0, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a <span class="type">string</span> in the format
   <code class="literal">YYYY.increment</code>, such as <code class="literal">2022.2</code>.
  </p>
  <p class="para">
   If you have a timezone database version that is old (for example, it
   doesn&#039;t show the current year), then you can update the timezone information
   by either upgrading your PHP version, or installing the <a href="https://pecl.php.net/package/timezonedb" class="link external">&raquo;&nbsp;timezonedb</a> PECL package.
  </p>
  <p class="para">
   Some Linux distributions patch PHP&#039;s date/time support to use an
   alternative source for timezone information. In which case this function
   will return <code class="literal">0.system</code>. You are encouraged to install the
   <a href="https://pecl.php.net/package/timezonedb" class="link external">&raquo;&nbsp;timezonedb</a> PECL
   package in that case as well.
  </p>


name: HRTime\StopWatch.isRunning
purpose: Whether the measurement is running
manual_id: hrtime-stopwatch.isrunning
version: PECL hrtime >= 0.4.3
return_type: bool
return_description:
<p class="para">
  Returns <span class="type">bool</span> indicating whether the measurement is running. 
  </p>


name: dio_open
manual_id: function.dio-open
version: PHP 4 >= 4.2.0, PHP 5 < 5.1.0
return_type: resource
purpose:
Opens a file (creating it if necessary) at a lower level than the   C library input/ouput stream functions allow

return_description:
<p class="para">
   A file descriptor or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: dio_stat
purpose: Gets stat information about the file descriptor fd
manual_id: function.dio-stat
version: PHP 4 >= 4.2.0, PHP 5 < 5.1.0
return_type: array
return_description:
<p class="para">
   Returns an associative array with the following keys:
   <ul class="itemizedlist">
    <li class="listitem">
     <p class="para">
      &quot;device&quot; - device
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;inode&quot; - inode
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;mode&quot; - mode
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;nlink&quot; - number of hard links
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;uid&quot; - user id
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;gid&quot; - group id
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;device_type&quot; - device type (if inode device)
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;size&quot; - total size in bytes
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;blocksize&quot; - blocksize
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;blocks&quot; - number of blocks allocated
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;atime&quot; - time of last access
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;mtime&quot; - time of last modification
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      &quot;ctime&quot; - time of last change
     </p>
    </li>
   </ul>
   On error <span class="function">dio_stat</span> returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>.
  </p>


name: dio_write
purpose: Writes data to fd with optional truncation at length
manual_id: function.dio-write
version: PHP 4 >= 4.2.0, PHP 5 < 5.1.0
return_type: int
return_description:
<p class="para">
   Returns the number of bytes written to <code class="parameter">fd</code>.
  </p>


name: chdir
purpose: Change directory
manual_id: function.chdir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Throws an error of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> on failure.
  </p>


name: dir
purpose: Return an instance of the Directory class
manual_id: function.dir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an instance of <span class="classname">Directory</span>, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> in case of error.
  </p>


name: getcwd
purpose: Gets the current working directory
manual_id: function.getcwd
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the current working directory on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure.
  </p> 
  <p class="para">
   On some Unix variants, <span class="function">getcwd</span> will return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if any one of the parent directories does not have the
   readable or search mode set, even if the current directory
   does. See <span class="function">chmod</span> for more information on
   modes and permissions.
  </p>


name: opendir
purpose: Open directory handle
manual_id: function.opendir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a directory handle <span class="type">resource</span> on success,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>

errors:
<p class="para">
Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>
  <p class="para">
   This may happen if <code class="parameter">directory</code> is not a valid directory,
   the directory can not be opened due to permission restrictions,
   or due to filesystem errors.
  </p>


name: readdir
purpose: Read entry from directory handle
manual_id: function.readdir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the entry name on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p> 
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: scandir
purpose: List files and directories inside the specified path
manual_id: function.scandir
version: PHP 5, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of filenames on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on 
   failure. If <code class="parameter">directory</code> is not a directory, then 
   boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned, and an error of level 
   <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is generated.
  </p>


name: finfo_buffer
purpose: Return information about a string buffer
manual_id: function.finfo-buffer
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL fileinfo >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns a textual description of the <code class="parameter">string</code>
   argument, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: finfo_file
purpose: Return information about a file
manual_id: function.finfo-file
version: PHP >= 5.3.0, PHP 7, PHP 8, PECL fileinfo >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns a textual description of the contents of the
   <code class="parameter">filename</code> argument, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.
  </p>


name: finfo_open
purpose: Create a new finfo instance
manual_id: function.finfo-open
version: PHP >= 5.3.0, PHP 7, PHP 8, PECL fileinfo >= 0.1.0
return_type: false
return_description:
<p class="para">
   (Procedural style only)
   Returns an <span class="classname">finfo</span> instance on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: mime_content_type
purpose: Detect MIME Content-type for a file
manual_id: function.mime-content-type
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the content type in MIME format, like 
   <code class="literal">text/plain</code> or <code class="literal">application/octet-stream</code>,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: chmod
purpose: Changes file mode
manual_id: function.chmod
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
  </p>


name: dirname
purpose: Returns a parent directory's path
manual_id: function.dirname
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns the path of a parent directory. If there are no slashes in
   <code class="parameter">path</code>, a dot (&#039;<code class="literal">.</code>&#039;) is returned,
   indicating the current directory. Otherwise, the returned string is
   <code class="parameter">path</code> with any trailing
   <code class="literal">/component</code> removed.
  </p>

  <div class="caution"><strong class="caution">Caution</strong>
   <p class="para">
    Be careful when using this function in a loop that can reach the
    top-level directory as this can result in an infinite loop.
    <div class="informalexample">
     <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />dirname</span><span style="color: #007700">(</span><span style="color: #DD0000">'.'</span><span style="color: #007700">);    </span><span style="color: #FF8000">// Will return '.'.<br /></span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #DD0000">'/'</span><span style="color: #007700">);    </span><span style="color: #FF8000">// Will return `\` on Windows and '/' on *nix systems.<br /></span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #DD0000">'\\'</span><span style="color: #007700">);   </span><span style="color: #FF8000">// Will return `\` on Windows and '.' on *nix systems.<br /></span><span style="color: #0000BB">dirname</span><span style="color: #007700">(</span><span style="color: #DD0000">'C:\\'</span><span style="color: #007700">); </span><span style="color: #FF8000">// Will return 'C:\' on Windows and '.' on *nix systems.<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
     </div>

    </div>
   </p>
  </div>


name: disk_free_space
purpose: Returns available space on filesystem or disk partition
manual_id: function.disk-free-space
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of available bytes as a float
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: disk_total_space
purpose: Returns the total size of a filesystem or disk partition
manual_id: function.disk-total-space
version: PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the total number of bytes as a float
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: feof
purpose: Tests for end-of-file on a file pointer
manual_id: function.feof
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file pointer is at EOF or an error occurs
   (including socket timeout); otherwise returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: fgetc
purpose: Gets character from file pointer
manual_id: function.fgetc
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string containing a single character read from the file pointed
   to by <code class="parameter">stream</code>. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on EOF.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: fgetcsv
purpose: Gets line from file pointer and parse for CSV fields
manual_id: function.fgetcsv
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an indexed array containing the fields read on success,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    A blank line in a CSV file will be returned as an array
    comprising a single <span class="type">null</span> field, and will not be treated
    as an error.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">If PHP is not properly recognizing
the line endings when reading files either on or created by a Macintosh
computer, enabling the
<a href="filesystem.configuration.html#ini.auto-detect-line-endings" class="link">auto_detect_line_endings</a>
run-time configuration option may help resolve the problem.</span></p></blockquote>


name: fgets
purpose: Gets line from file pointer
manual_id: function.fgets
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a string of up to <code class="parameter">length</code> - 1 bytes read from
   the file pointed to by <code class="parameter">stream</code>. If there is no more data 
   to read in the file pointer, then <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>
  <p class="para">
   If an error occurs, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: fgetss
purpose: Gets line from file pointer and strip HTML tags
manual_id: function.fgetss
version: PHP 4, PHP 5, PHP 7
return_type: string
return_description:
<p class="para">
   Returns a string of up to <code class="parameter">length</code> - 1 bytes read from
   the file pointed to by <code class="parameter">handle</code>, with all HTML and PHP
   code stripped.
  </p>
  <p class="para">
   If an error occurs, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: file_exists
purpose: Checks whether a file or directory exists
manual_id: function.file-exists
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file or directory specified by
   <code class="parameter">filename</code> exists; <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    This function will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> for symlinks pointing to non-existing
    files.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The check is done using the real UID/GID instead of the effective one.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>

errors:
<p class="para">
Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
</p>


name: file_get_contents
purpose: Reads entire file into a string
manual_id: function.file-get-contents
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   The function returns the read data  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>

errors:
<p class="para">
   An <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is generated if <code class="parameter">filename</code> cannot be found, <code class="parameter">length</code>
   is less than zero, or if seeking to the specified <code class="parameter">offset</code> in the stream fails.
  </p>
  <p class="para">
   When <span class="function">file_get_contents</span> is called on a directory,
   an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error is generated on Windows,
   and as of PHP 7.4 on other operating systems as well.
  </p>


name: file_put_contents
purpose: Write data to a file
manual_id: function.file-put-contents
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   This function returns the number of bytes that were written to the file, or
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: file
purpose: Reads entire file into an array
manual_id: function.file
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the file in an array. Each element of the array corresponds to a
   line in the file, with the newline still attached. Upon failure,
   <span class="function">file</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    Each line in the resulting array will include the line ending, unless
    <strong><code><a href="filesystem.constants.html#constant.file-ignore-new-lines">FILE_IGNORE_NEW_LINES</a></code></strong> is used.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">If PHP is not properly recognizing
the line endings when reading files either on or created by a Macintosh
computer, enabling the
<a href="filesystem.configuration.html#ini.auto-detect-line-endings" class="link">auto_detect_line_endings</a>
run-time configuration option may help resolve the problem.</span></p></blockquote>

errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error if the file
   does not exist.
  </p>


name: fileatime
purpose: Gets last access time of file
manual_id: function.fileatime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the time the file was last accessed,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The time is returned as a Unix timestamp.
  </p>


name: filectime
purpose: Gets inode change time of file
manual_id: function.filectime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the time the file was last changed,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The time is returned as a Unix timestamp.
  </p>


name: filegroup
purpose: Gets file group
manual_id: function.filegroup
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the group ID of the file, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if
   an error occurs. The group ID is returned in numerical format, use
   <span class="function">posix_getgrgid</span> to resolve it to a group name.
   Upon failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>

errors:
<p class="para">
   Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
  </p>


name: fileinode
purpose: Gets file inode
manual_id: function.fileinode
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the inode number of the file,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: filemtime
purpose: Gets file modification time
manual_id: function.filemtime
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the time the file was last modified,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The time is returned as a Unix timestamp, which is
   suitable for the <span class="function">date</span> function.
  </p>


name: fileowner
purpose: Gets file owner
manual_id: function.fileowner
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the user ID of the owner of the file,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   The user ID is returned in numerical format, use
   <span class="function">posix_getpwuid</span> to resolve it to a username.
  </p>


name: fileperms
purpose: Gets file permissions
manual_id: function.fileperms
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the file&#039;s permissions as a numeric mode. Lower bits of this mode
   are the same as the permissions expected by <span class="function">chmod</span>,
   however on most platforms the return value will also include information on
   the type of file given as <code class="parameter">filename</code>. The examples
   below demonstrate how to test the return value for specific permissions and
   file types on POSIX systems, including Linux and macOS.
  </p>
  <p class="para">
   For local files, the specific return value is that of the
   <code class="literal">st_mode</code> member of the structure returned by the C
   library&#039;s <span class="function">stat</span> function. Exactly which bits are set
   can vary from platform to platform, and looking up your specific platform&#039;s
   documentation is recommended if parsing the non-permission bits of the
   return value is required.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: filesize
purpose: Gets file size
manual_id: function.filesize
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the size of the file in bytes, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> (and generates an error
   of level <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>) in case of an error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>


name: filetype
purpose: Gets file type
manual_id: function.filetype
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the type of the file. Possible values are fifo, char,
   dir, block, link, file, socket and unknown.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs. <span class="function">filetype</span> will also
   produce an <strong><code><a href="errorfunc.constants.html#constant.e-notice">E_NOTICE</a></code></strong> message if the stat call fails
   or if the file type is unknown.
  </p>


name: fnmatch
purpose: Match filename against a pattern
manual_id: function.fnmatch
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if there is a match, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: fopen
purpose: Opens file or URL
manual_id: function.fopen
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a file pointer resource on success,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: fpassthru
purpose: Output all remaining data on a file pointer
manual_id: function.fpassthru
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the number of characters read from <code class="parameter">stream</code>
   and passed through to the output.
  </p>


name: fputcsv
purpose: Format line as CSV and write to file pointer
manual_id: function.fputcsv
version: PHP 5 >= 5.1.0, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the length of the written string  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: fread
purpose: Binary-safe file read
manual_id: function.fread
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the read string  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: fscanf
purpose: Parses input from a file according to a format
manual_id: function.fscanf
version: PHP 4 >= 4.0.1, PHP 5, PHP 7, PHP 8
return_type: null
return_description:
<p class="para">
   If only two parameters were passed to this function, the values parsed will be
   returned as an array. Otherwise, if optional parameters are passed, the
   function will return the number of assigned values. The optional
   parameters must be passed by reference. 
  </p>
  <p class="para">
   If there are more substrings expected in the <code class="parameter">format</code>
   than there are available within <code class="parameter">string</code>,
   <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> will be returned. On other errors, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> will be returned.
  </p>


name: fstat
purpose: Gets information about a file using an open file pointer
manual_id: function.fstat
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array with the statistics of the file; the format of the array
   is described in detail on the <span class="function">stat</span> manual page.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ftell
purpose: Returns the current position of the file read/write pointer
manual_id: function.ftell
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the position of the file pointer referenced by
   <code class="parameter">stream</code> as an integer; i.e., its offset into the file stream.
  </p>
  <p class="para">
   If an error occurs, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>


name: fwrite
purpose: Binary-safe file write
manual_id: function.fwrite
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="simpara">
   <span class="function">fwrite</span> returns the number of bytes
   written,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   <span class="function">fwrite</span> raises <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> on failure.
  </p>


name: glob
purpose: Find pathnames matching a pattern
manual_id: function.glob
version: PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an array containing the matched files/directories, an empty array
   if no file matched or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    On some systems it is impossible to distinguish between empty match and an
    error.
   </p>
  </p></blockquote>


name: is_dir
purpose: Tells whether the filename is a directory
manual_id: function.is-dir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the filename exists and is a directory, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: is_executable
purpose: Tells whether the filename is executable
manual_id: function.is-executable
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the filename exists and is executable, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   error. On POSIX systems, a file is executable if the executable bit of the
   file permissions is set. For Windows, see the note below.
  </p>


name: is_file
purpose: Tells whether the filename is a regular file
manual_id: function.is-file
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the filename exists and is a regular file, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>


name: is_link
purpose: Tells whether the filename is a symbolic link
manual_id: function.is-link
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the filename exists and is a symbolic link, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>


name: is_readable
purpose: Tells whether a file exists and is readable
manual_id: function.is-readable
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the file or directory specified by
   <code class="parameter">filename</code> exists and is readable, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>


name: is_writable
purpose: Tells whether the filename is writable
manual_id: function.is-writable
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the <code class="parameter">filename</code> exists and is
   writable.  
  </p>


name: link
purpose: Create a hard link
manual_id: function.link
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   The function fails, and issues <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>, if <code class="parameter">link</code>
   already exists, or if <code class="parameter">target</code> does not exist.
  </p>


name: linkinfo
purpose: Gets information about a link
manual_id: function.linkinfo
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <span class="function">linkinfo</span> returns the <code class="literal">st_dev</code> field
   of the Unix C stat structure returned by the <code class="literal">lstat</code>
   system call. Returns a non-negative integer on success, -1 in case the link was not found, 
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an open.base_dir violation occurs.
  </p>


name: lstat
purpose: Gives information about a file or symbolic link
manual_id: function.lstat
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   See the manual page for <span class="function">stat</span> for information on
   the structure of the array that <span class="function">lstat</span> returns.
   This function is identical to the <span class="function">stat</span> function
   except that if the <code class="parameter">filename</code> parameter is a symbolic
   link, the status of the symbolic link is returned, not the status of the
   file pointed to by the symbolic link.
  </p>
  <p class="para">
   On failure, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is returned.
  </p>


name: mkdir
purpose: Makes directory
manual_id: function.mkdir
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the directory to be created already exists, that is considered an error
    and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> will still be returned.  Use <span class="function">is_dir</span> or
    <span class="function">file_exists</span> to check if the directory already exists
    before trying to create it.
   </p>
  </p></blockquote>

errors:
<p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error if the directory
   already exists.
  </p>
  <p class="para">
   Emits an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> level error if the relevant
   permissions prevent creating the directory.
  </p>


name: move_uploaded_file
purpose: Moves an uploaded file to a new location
manual_id: function.move-uploaded-file
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> on success.
  </p>
  <p class="para">
   If <code class="parameter">from</code> is not a valid upload file,
   then no action will occur, and
   <span class="function">move_uploaded_file</span> will return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <p class="para">
   If <code class="parameter">from</code> is a valid upload file, but
   cannot be moved for some reason, no action will occur, and
   <span class="function">move_uploaded_file</span> will return
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Additionally, a warning will be issued.
  </p>


name: parse_ini_file
purpose: Parse a configuration file
manual_id: function.parse-ini-file
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The settings are returned as an associative <span class="type">array</span> on success,
   and <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: pathinfo
purpose: Returns information about a file path
manual_id: function.pathinfo
version: PHP 4 >= 4.0.3, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   If the <code class="parameter">flags</code> parameter is not passed, an
   associative <span class="type">array</span> containing the following elements is
   returned:
   <code class="literal">dirname</code>, <code class="literal">basename</code>,
   <code class="literal">extension</code> (if any), and <code class="literal">filename</code>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the <code class="parameter">path</code> has more than one extension,
    <strong><code><a href="filesystem.constants.html#constant.pathinfo-extension">PATHINFO_EXTENSION</a></code></strong> returns only the last one and
    <strong><code><a href="filesystem.constants.html#constant.pathinfo-filename">PATHINFO_FILENAME</a></code></strong> only strips the last one.
    (see first example below).
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the <code class="parameter">path</code> does not have an extension, no
    <code class="literal">extension</code> element will be returned
    (see second example below).
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    If the <code class="literal">basename</code> of the <code class="parameter">path</code> starts
    with a dot, the following characters are interpreted as
    <code class="literal">extension</code>, and the <code class="literal">filename</code> is empty
    (see third example below).
   </p>
  </p></blockquote>
  <p class="para">
   If <code class="parameter">flags</code> is present, returns a
   <span class="type">string</span> containing the requested element.
  </p>


name: pclose
purpose: Closes process file pointer
manual_id: function.pclose
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   Returns the termination status of the process that was run. In case of 
   an error then <code class="literal">-1</code> is returned.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
 <p class="para">
  If PHP has been compiled with --enable-sigchild, the return value of this function is undefined.
 </p>
</p></blockquote>


name: popen
purpose: Opens process file pointer
manual_id: function.popen
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a file pointer identical to that returned by
   <span class="function">fopen</span>, except that it is unidirectional (may
   only be used for reading or writing) and must be closed with
   <span class="function">pclose</span>. This pointer may be used with
   <span class="function">fgets</span>, <span class="function">fgetss</span>, and
   <span class="function">fwrite</span>. When the mode is &#039;r&#039;, the returned
   file pointer equals to the STDOUT of the command, when the mode
   is &#039;w&#039;, the returned file pointer equals to the STDIN of the
   command.
  </p>
  <p class="para">
   If an error occurs, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: readfile
purpose: Outputs a file
manual_id: function.readfile
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the number of bytes read from the file on success,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure
  </p>


name: readlink
purpose: Returns the target of a symbolic link
manual_id: function.readlink
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the contents of the symbolic link path or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <span class="simpara">
    The function fails if <code class="parameter">path</code> is not a symlink,
    except on Windows, where the normalized path will be returned.
   </span>
  </p></blockquote>


name: realpath_cache_get
purpose: Get realpath cache entries
manual_id: function.realpath-cache-get
version: PHP 5 >= 5.3.2, PHP 7, PHP 8
return_type: array
return_description:
<p class="para">
   Returns an array of realpath cache entries. The keys are original path
   entries, and the values are arrays of data items, containing the resolved
   path, expiration date, and other options kept in the cache.
   </p>


name: realpath
purpose: Returns canonicalized absolute pathname
manual_id: function.realpath
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the canonicalized absolute pathname on success. The resulting path 
   will have no symbolic link, <code class="literal">/./</code> or <code class="literal">/../</code> components. Trailing delimiters,
   such as <code class="literal">\</code> and <code class="literal">/</code>, are also removed.
  </p>
  <p class="para">
   <span class="function">realpath</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure, e.g. if
   the file does not exist.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The running script must have executable permissions on all directories in
    the hierarchy, otherwise <span class="function">realpath</span> will return
    <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    For case-insensitive filesystems <span class="function">realpath</span> may or may
    not normalize the character case.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    The function <span class="function">realpath</span> will not work for a file which
    is inside a Phar as such path would be a virtual path, not a real one.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    On Windows, junctions and symbolic links to directories are only expanded by
    one level.
   </p>
  </p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>


name: stat
purpose: Gives information about a file
manual_id: function.stat
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   <table class="doctable table">
    <caption><strong><span class="function">stat</span> and <span class="function">fstat</span> result
     format</strong></caption>
    
     <thead>
      <tr>
       <th>Numeric</th>
       <th>Associative</th>
       <th>Description</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td>0</td>
       <td>dev</td>
       <td>device number ***</td>
      </tr>

      <tr>
       <td>1</td>
       <td>ino</td>
       <td>inode number ****</td>
      </tr>

      <tr>
       <td>2</td>
       <td>mode</td>
       <td>inode protection mode *****</td>
      </tr>

      <tr>
       <td>3</td>
       <td>nlink</td>
       <td>number of links</td>
      </tr>

      <tr>
       <td>4</td>
       <td>uid</td>
       <td>userid of owner *</td>
      </tr>

      <tr>
       <td>5</td>
       <td>gid</td>
       <td>groupid of owner *</td>
      </tr>

      <tr>
       <td>6</td>
       <td>rdev</td>
       <td>device type, if inode device</td>
      </tr>

      <tr>
       <td>7</td>
       <td>size</td>
       <td>size in bytes</td>
      </tr>

      <tr>
       <td>8</td>
       <td>atime</td>
       <td>time of last access (Unix timestamp)</td>
      </tr>

      <tr>
       <td>9</td>
       <td>mtime</td>
       <td>time of last modification (Unix timestamp)</td>
      </tr>

      <tr>
       <td>10</td>
       <td>ctime</td>
       <td>time of last inode change (Unix timestamp)</td>
      </tr>

      <tr>
       <td>11</td>
       <td>blksize</td>
       <td>blocksize of filesystem IO **</td>
      </tr>

      <tr>
       <td>12</td>
       <td>blocks</td>
       <td>number of 512-byte blocks allocated **</td>
      </tr>

     </tbody>
    
   </table>

  </p>
  <p class="para">
   * On Windows this will always be <code class="literal">0</code>.
  </p>
  <p class="para">
   ** Only valid on systems supporting the st_blksize type - other
   systems (e.g. Windows) return <code class="literal">-1</code>.
  </p>
  <p class="para">
   *** On Windows, as of PHP 7.4.0, this is the serial number of the volume that contains the file,
   which is a 64-bit <em>unsigned</em> integer, so may overflow.
   Previously, it was the numeric representation of the drive letter (e.g. <code class="literal">2</code>
   for <code class="literal">C:</code>) for <span class="function">stat</span>, and <code class="literal">0</code> for
   <span class="function">lstat</span>.
  </p>
  <p class="para">
   **** On Windows, as of PHP 7.4.0, this is the identifier associated with the file,
   which is a 64-bit <em>unsigned</em> integer, so may overflow.
   Previously, it was always <code class="literal">0</code>.
  </p>
  <p class="para">
   ***** On Windows, the writable permission bit is set according to the read-only
   file attribute, and the same value is reported for all users, group and owner.
   The ACL is not taken into account, contrary to <span class="function">is_writable</span>.
  </p>
  <p class="para">
  The value of <code class="literal">mode</code> contains information read by several functions. 
  When written in octal, starting from the right, the first three digits are returned by
  <span class="function">chmod</span>. The next digit is ignored by PHP. The next two digits indicate
  the file type:
   <table class="doctable table">
    <caption><strong><code class="literal">mode</code> file types</strong></caption>
    
     <thead>
      <tr>
       <th><code class="literal">mode</code> in octal</th>
       <th>Meaning</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">0140000</code></td>
       <td>socket</td>
      </tr>

      <tr>
       <td><code class="literal">0120000</code></td>
       <td>link</td>
      </tr>

      <tr>
       <td><code class="literal">0100000</code></td>
       <td>regular file</td>
      </tr>

      <tr>
       <td><code class="literal">0060000</code></td>
       <td>block device</td>
      </tr>

      <tr>
       <td><code class="literal">0040000</code></td>
       <td>directory</td>
      </tr>

      <tr>
       <td><code class="literal">0020000</code></td>
       <td>character device</td>
      </tr>

      <tr>
       <td><code class="literal">0010000</code></td>
       <td>fifo</td>
      </tr>

     </tbody>
    
   </table>

   So for example a regular file could be <code class="literal">0100644</code> and a directory could be
   <code class="literal">0040755</code>.
  </p>
  <p class="para">
   In case of error, <span class="function">stat</span> returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
    Because PHP&#039;s integer type is signed and many platforms use 32bit integers,
    some filesystem functions may return unexpected results for files which
    are larger than 2GB.
   </span></p></blockquote>

errors:
<p class="para">
   Upon failure, an <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong> is emitted.
  </p>


name: symlink
purpose: Creates a symbolic link
manual_id: function.symlink
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: bool
errors:
<p class="para">
   The function fails, and issues <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>,
   if <code class="parameter">link</code> already exists.
   On Windows, the function also fails, and issues <strong><code><a href="errorfunc.constants.html#constant.e-warning">E_WARNING</a></code></strong>,
   if <code class="parameter">target</code> does not exist.
  </p>


name: tempnam
purpose: Create file with unique file name
manual_id: function.tempnam
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the new temporary filename (with path), or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on
   failure.
  </p>


name: tmpfile
purpose: Creates a temporary file
manual_id: function.tmpfile
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a file handle, similar to the one returned by
   <span class="function">fopen</span>, for the new file or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: umask
purpose: Changes the current umask
manual_id: function.umask
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: int
return_description:
<p class="para">
   If <code class="parameter">mask</code> is <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>, <span class="function">umask</span> 
   simply returns the current umask otherwise the old umask is returned.
  </p>


name: inotify_add_watch
purpose: Add a watch to an initialized inotify instance
manual_id: function.inotify-add-watch
version: PECL inotify >= 0.1.2
return_type: false
return_description:
<p class="para">
   The return value is a unique (inotify instance wide) watch descriptor,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: inotify_init
purpose: Initialize an inotify instance
manual_id: function.inotify-init
version: PECL inotify >= 0.1.2
return_type: false
return_description:
<p class="para">
   A stream resource or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: inotify_read
purpose: Read events from an inotify instance
manual_id: function.inotify-read
version: PECL inotify >= 0.1.2
return_type: array
return_description:
<p class="para">
   An array of inotify events or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no events was pending and
   <code class="parameter">inotify_instance</code> is non-blocking. Each event is an array with the following keys:
   <ul class="simplelist">
    <li>wd is a watch descriptor returned by
     <span class="function">inotify_add_watch</span></li>
    <li>mask is a bit mask of <a href="inotify.constants.html" class="link">events</a></li>
    <li>cookie is a unique id to connect related events (e.g. <strong><code>IN_MOVE_FROM</code></strong>
     and <strong><code>IN_MOVE_TO</code></strong>)</li>
    <li>name is the name of a file (e.g. if a file was modified in a
     watched directory)</li>
   </ul>
  </p>


name: xattr_get
purpose: Get an extended attribute
manual_id: function.xattr-get
version: PECL xattr >= 0.9.0
return_type: string
return_description:
<p class="para">
   Returns a string containing the value or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if the attribute doesn&#039;t 
   exist. 
  </p>


name: xattr_supported
purpose: Check if filesystem supports extended attributes
manual_id: function.xattr-supported
version: PECL xattr >= 1.0.0
return_type: bool
return_description:
<p class="para">
   This function returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if filesystem supports extended attributes,
   <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if it doesn&#039;t and <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if it can&#039;t be determined (for example
   wrong path or lack of permissions to file).
  </p>


name: xdiff_file_merge3
purpose: Merge 3 files into one
manual_id: function.xdiff-file-merge3
version: PECL xdiff >= 0.2.0
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if merge was successful, string with rejected chunks if
   it was not or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error happened.
  </p>


name: xdiff_file_patch
purpose: Patch a file with an unified diff
manual_id: function.xdiff-file-patch
version: PECL xdiff >= 0.2.0
return_type: mixed
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error happened, string with rejected
   chunks if patch couldn&#039;t be applied or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if patch has been successfully applied.
  </p>


name: xdiff_string_bdiff
purpose: Make binary diff of two strings
manual_id: function.xdiff-string-bdiff
version: PECL xdiff >= 1.5.0
return_type: string
return_description:
<p class="para">
   Returns string with binary diff containing differences between &quot;old&quot; and &quot;new&quot;
   data or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error occurred.
  </p>


name: xdiff_string_bpatch
purpose: Patch a string with a binary diff
manual_id: function.xdiff-string-bpatch
version: PECL xdiff >= 1.5.0
return_type: string
return_description:
<p class="para">
   Returns the patched string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: xdiff_string_diff_binary
purpose: Alias of xdiff_string_bdiff
manual_id: function.xdiff-string-diff-binary
version: PECL xdiff >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns string with result or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error happened.
  </p>


name: xdiff_string_diff
purpose: Make unified diff of two strings
manual_id: function.xdiff-string-diff
version: PECL xdiff >= 0.2.0
return_type: string
return_description:
<p class="para">
   Returns string with resulting diff or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error happened.
  </p>


name: xdiff_string_merge3
purpose: Merge 3 strings into one
manual_id: function.xdiff-string-merge3
version: PECL xdiff >= 0.2.0
return_type: mixed
return_description:
<p class="para">
   Returns the merged string, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an internal error happened, or <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong>
   if merged string is empty.
  </p>


name: enchant_broker_describe
purpose: Enumerates the Enchant providers
manual_id: function.enchant-broker-describe
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of available Enchant providers with their details.
  </p>


name: enchant_broker_dict_exists
purpose: Whether a dictionary exists or not. Using non-empty tag
manual_id: function.enchant-broker-dict-exists
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> when the tag exist or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when not.
  </p>


name: enchant_broker_get_dict_path
purpose: Get the directory path for a given backend
manual_id: function.enchant-broker-get-dict-path
version: PHP 5 >= 5.3.1, PHP 7, PHP 8, PECL enchant >= 1.0.1
return_type: false
return_description:
<p class="para">
   Returns the path of the dictionary directory on
   success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: enchant_broker_get_error
purpose: Returns the last error of the broker
manual_id: function.enchant-broker-get-error
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: false
return_description:
<p class="para">
   Return the msg string if an error was found or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: enchant_broker_init
purpose: Create a new broker object capable of requesting
manual_id: function.enchant-broker-init
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns a broker resource on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: enchant_broker_list_dicts
purpose: Returns a list of available dictionaries
manual_id: function.enchant-broker-list-dicts
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 1.0.1
return_type: array
return_description:
<p class="para">
   Returns an <span class="type">array</span> of available dictionaries with their details.
  </p>


name: enchant_broker_request_dict
purpose: Create a new dictionary using a tag
manual_id: function.enchant-broker-request-dict
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns a dictionary resource on success or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: enchant_dict_check
purpose: Check whether a word is correctly spelled or not
manual_id: function.enchant-dict-check
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the word is spelled correctly, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if not.
  </p>


name: enchant_dict_get_error
purpose: Returns the last error of the current spelling-session
manual_id: function.enchant-dict-get-error
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant >= 0.1.0
return_type: false
return_description:
<p class="para">
   Returns the error message as string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if no error occurred.
  </p>


name: enchant_dict_is_added
purpose: Whether or not 'word' exists in this spelling-session
manual_id: function.enchant-dict-is-added
version: PHP 8
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the word exists or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: enchant_dict_quick_check
purpose: Check the word is correctly spelled and provide suggestions
manual_id: function.enchant-dict-quick-check
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL enchant:0.2.0-1.0.1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the word is correctly spelled or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
  </p>


name: Gender\Gender.country
purpose: Get textual country representation
manual_id: gender-gender.country
version: PECL gender >= 0.8.0
return_type: false
return_description:
<p class="para">
    Returns an array with the short and full names of the country on success
     or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
   </p>


name: bind_textdomain_codeset
manual_id: function.bind-textdomain-codeset
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: false
return_description: <p class="para"> A <span class="type">string</span> on success. </p>
purpose:
Specify or get the character encoding in which the messages from the DOMAIN message catalog will be returned


name: bindtextdomain
purpose: Sets or gets the path for a domain
manual_id: function.bindtextdomain
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   The full pathname for the <code class="parameter">domain</code> currently being set,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: gettext
purpose: Lookup a message in the current domain
manual_id: function.gettext
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns a translated <span class="type">string</span> if one is found in the 
   translation table, or the submitted message if not found.
  </p>


name: ngettext
purpose: Plural version of gettext
manual_id: function.ngettext
version: PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   Returns correct plural form of message identified by 
   <code class="parameter">singular</code> and <code class="parameter">plural</code>
   for count <code class="parameter">count</code>. 
  </p>


name: textdomain
purpose: Sets the default domain
manual_id: function.textdomain
version: PHP 4, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   If successful, this function returns the current message
   domain, after possibly changing it.
  </p>


name: iconv_get_encoding
purpose: Retrieve internal configuration variables of iconv extension
manual_id: function.iconv-get-encoding
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the current value of the internal configuration variable if
   successful or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <p class="para">
   If <code class="parameter">type</code> is omitted or set to &quot;all&quot;,
   <span class="function">iconv_get_encoding</span> returns an array that
   stores all these variables.
  </p>


name: iconv_mime_decode_headers
purpose: Decodes multiple MIME header fields at once
manual_id: function.iconv-mime-decode-headers
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an associative array that holds a whole set of
   <code class="literal">MIME</code> header fields specified by
   <code class="parameter">headers</code> on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   if an error occurs during the decoding.
  </p>
  <p class="para">
   Each key of the return value represents an individual
   field name and the corresponding element represents a field value.
   If more than one field of the same name are present,
   <span class="function">iconv_mime_decode_headers</span> automatically incorporates
   them into a numerically indexed array in the order of occurrence.
   Note that header names are not <em>case-insensitive</em>.
  </p>


name: iconv_mime_decode
purpose: Decodes a MIME header field
manual_id: function.iconv-mime-decode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns a decoded <code class="literal">MIME</code> field on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs during the decoding.
  </p>


name: iconv_mime_encode
purpose: Composes a MIME header field
manual_id: function.iconv-mime-encode
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns an encoded <code class="literal">MIME</code> field on success,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs during the encoding.
  </p>


name: iconv_strlen
purpose: Returns the character count of string
manual_id: function.iconv-strlen
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the character count of <code class="parameter">string</code>, as an integer,
   or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurs during the encoding.
  </p>


name: iconv_strpos
purpose: Finds position of first occurrence of a needle within a haystack
manual_id: function.iconv-strpos
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the numeric position of the first occurrence of
   <code class="parameter">needle</code> in <code class="parameter">haystack</code>.
  </p>
  <p class="para">
   If <code class="parameter">needle</code> is not found,
   <span class="function">iconv_strpos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: iconv_strrpos
purpose: Finds the last occurrence of a needle within a haystack
manual_id: function.iconv-strrpos
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the numeric position of the last occurrence of
   <code class="parameter">needle</code> in <code class="parameter">haystack</code>.
  </p>
  <p class="para">
   If <code class="parameter">needle</code> is not found,
   <span class="function">iconv_strrpos</span> will return <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: iconv_substr
purpose: Cut out part of a string
manual_id: function.iconv-substr
version: PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the portion of <code class="parameter">string</code> specified by the
   <code class="parameter">offset</code> and <code class="parameter">length</code> parameters.
  </p>
  <p class="para">
   If <code class="parameter">string</code> is shorter than <code class="parameter">offset</code>
   characters long, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> will be returned.
   If <code class="parameter">string</code> is exactly <code class="parameter">offset</code>
   characters long, an empty string will be returned.
  </p>


name: iconv
purpose: Convert a string from one character encoding to another
manual_id: function.iconv
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: false
return_description:
<p class="para">
   Returns the converted string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: ob_iconv_handler
purpose: Convert character encoding as output buffer handler
manual_id: function.ob-iconv-handler
version: PHP 4 >= 4.0.5, PHP 5, PHP 7, PHP 8
return_type: string
return_description:
<p class="para">
   See <span class="function">ob_start</span> for information about this handler
   return values.
  </p>


name: Collator.compare
purpose: Compare two Unicode strings
manual_id: collator.compare
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">Return comparison result:</p>
  <p class="para">
   <ul class="itemizedlist">
    <li class="listitem">
     <p class="para">
      1 if <code class="parameter">string1</code> is <em>greater</em> than 
      <code class="parameter">string2</code> ;
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      0 if <code class="parameter">string1</code> is <em>equal</em> to 
      <code class="parameter">string2</code>;
     </p>
    </li>
    <li class="listitem">
     <p class="para">
      -1 if <code class="parameter">string1</code> is <em>less</em> than 
      <code class="parameter">string2</code> .
     </p>
    </li>
   </ul>
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: Collator.__construct
purpose: Create a collator
manual_id: collator.construct
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
errors:
<p class="para">
   Returns an &quot;empty&quot; object on error. 
   Use <span class="function">intl_get_error_code</span>
   and/or <span class="function">intl_get_error_message</span>
   to know what happened.
  </p>


name: Collator.create
purpose: Create a collator
manual_id: collator.create
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   Return new instance of <span class="classname">Collator</span> object, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong>
   on error.
  </p>


name: Collator.getAttribute
purpose: Get collation attribute value
manual_id: collator.getattribute
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Attribute value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Collator.getErrorCode
purpose: Get collator's last error code
manual_id: collator.geterrorcode
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Error code returned by the last Collator <acronym class="acronym">API</acronym> function call,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Collator.getErrorMessage
purpose: Get text for collator's last error code
manual_id: collator.geterrormessage
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Description of an error occurred in the last Collator <acronym class="acronym">API</acronym> function call,
    or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Collator.getLocale
purpose: Get the locale name of the collator
manual_id: collator.getlocale
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Real locale name from which the collation data comes. If the collator was
   instantiated from rules or an error occurred, returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>.
  </p>


name: Collator.getSortKey
purpose: Get sorting key for a string
manual_id: collator.getsortkey
version: PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 1.0.3
return_type: false
return_description:
<p class="para">Returns the collation key for the string,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.</p>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function may
return Boolean <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>, but may also return a non-Boolean value which
evaluates to <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>. Please read the section on <a href="language.types.boolean.html" class="link">Booleans</a> for more
information. Use <a href="language.operators.comparison.html" class="link">the ===
operator</a> for testing the return value of this
function.</p></div>


name: Collator.getStrength
purpose: Get current collation strength
manual_id: collator.getstrength
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: int
return_description:
<p class="para">
   Returns current collation strength, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: NumberFormatter.create
purpose: Create a number formatter
manual_id: numberformatter.create
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   Returns <span class="classname">NumberFormatter</span> object or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on error.
  </p>


name: NumberFormatter.formatCurrency
purpose: Format a currency value
manual_id: numberformatter.formatcurrency
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   String representing the formatted currency value,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: NumberFormatter.format
purpose: Format a number
manual_id: numberformatter.format
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Returns the string containing formatted value, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: NumberFormatter.getAttribute
purpose: Get an attribute
manual_id: numberformatter.getattribute
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Return attribute value on success, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: NumberFormatter.getLocale
purpose: Get formatter locale
manual_id: numberformatter.getlocale
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The locale name used to create the formatter, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: NumberFormatter.getPattern
purpose: Get formatter pattern
manual_id: numberformatter.getpattern
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Pattern <span class="type">string</span> that is used by the formatter, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error happens.
  </p>


name: NumberFormatter.getSymbol
purpose: Get a symbol value
manual_id: numberformatter.getsymbol
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The symbol string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: NumberFormatter.parseCurrency
purpose: Parse a currency number
manual_id: numberformatter.parsecurrency
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The parsed numeric value or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: NumberFormatter.parse
purpose: Parse a number
manual_id: numberformatter.parse
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The value of the parsed number or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error.
  </p>


name: Locale.acceptFromHttp
purpose: Tries to find out best available locale based on HTTP "Accept-Language" header
manual_id: locale.acceptfromhttp
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The corresponding locale identifier.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when the length of <code class="parameter">header</code> exceeds
   <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.
  </p>


name: Locale.canonicalize
purpose: Canonicalize the locale string
manual_id: locale.canonicalize
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   Canonicalized locale string.
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.composeLocale
purpose: Returns a correctly ordered and delimited locale ID
manual_id: locale.composelocale
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The corresponding locale identifier, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> when <code class="parameter">subtags</code> is empty.
  </p>


name: Locale.filterMatches
purpose: Checks if a language tag filter matches with locale
manual_id: locale.filtermatches
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if <code class="parameter">locale</code> matches <code class="parameter">languageTag</code> <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.getAllVariants
purpose: Gets the variants for the input locale
manual_id: locale.getallvariants
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The <span class="type">array</span> containing the list of all variants subtag for the locale
   or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not present
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.getDisplayLanguage
purpose: Returns an appropriately localized display name for language of the inputlocale
manual_id: locale.getdisplaylanguage
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Display name of the language for the <code class="parameter">locale</code> in the format appropriate for
   <code class="parameter">displayLocale</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Locale.getDisplayName
purpose: Returns an appropriately localized display name for the input locale
manual_id: locale.getdisplayname
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Display name of the locale in the format appropriate for <code class="parameter">displayLocale</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Locale.getDisplayRegion
purpose: Returns an appropriately localized display name for region of the input locale
manual_id: locale.getdisplayregion
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Display name of the region for the <code class="parameter">locale</code> in the format appropriate for
   <code class="parameter">displayLocale</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Locale.getDisplayScript
purpose: Returns an appropriately localized display name for script of the input locale
manual_id: locale.getdisplayscript
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Display name of the script for the <code class="parameter">locale</code> in the format appropriate for
   <code class="parameter">displayLocale</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Locale.getDisplayVariant
purpose: Returns an appropriately localized display name for variants of the input locale
manual_id: locale.getdisplayvariant
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   Display name of the variant for the <code class="parameter">locale</code> in the format appropriate for
   <code class="parameter">displayLocale</code>,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: Locale.getKeywords
purpose: Gets the keywords for the input locale
manual_id: locale.getkeywords
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   Associative <span class="type">array</span> containing the keyword-value pairs for this locale
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.getPrimaryLanguage
purpose: Gets the primary language for the input locale
manual_id: locale.getprimarylanguage
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The language code associated with the language.
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.getRegion
purpose: Gets the region for the input locale
manual_id: locale.getregion
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The region subtag for the locale or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not present
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.getScript
purpose: Gets the script for the input locale
manual_id: locale.getscript
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The script subtag for the locale or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if not present
  </p>


name: Locale.lookup
purpose: Searches the language tag list for the best match to the language
manual_id: locale.lookup
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The closest matching language tag or default value.
  </p>
  <p class="para">Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.</p>


name: Locale.parseLocale
purpose: Returns a key-value array of locale ID subtag elements
manual_id: locale.parselocale
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   Returns an array containing a list of key-value pairs, where the keys
   identify the particular locale ID subtags, and the values are the
   associated subtag values. The array will be ordered as the locale id
   subtags e.g. in the locale id if variants are &#039;-varX-varY-varZ&#039; then the
   returned array will have variant0=&gt;varX , variant1=&gt;varY ,
   variant2=&gt;varZ
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> when the length of <code class="parameter">locale</code> exceeds
   <strong><code><a href="intl.constants.html#constant.intl-max-locale-len">INTL_MAX_LOCALE_LEN</a></code></strong>.
  </p>


name: Normalizer.getRawDecomposition
purpose: Gets the Decomposition_Mapping property for the given UTF-8 encoded code point
manual_id: normalizer.getrawdecomposition
version: PHP 7 >= 7.3, PHP 8
return_type: null
return_description:
<p class="para">
   Returns a <span class="type">string</span> containing the Decomposition_Mapping property, if present in the UCD.
  </p>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> if there is no Decomposition_Mapping property for the character.
  </p>


name: Normalizer.isNormalized
purpose: Checks if the provided string is already in the specified normalization form
manual_id: normalizer.isnormalized
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: bool
return_description:
<p class="para"><strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if normalized, <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise or if there an error</p>


name: Normalizer.normalize
purpose: Normalizes the input provided and returns the normalized string
manual_id: normalizer.normalize
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">The normalized string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred.</p>


name: MessageFormatter.create
purpose: Constructs a new Message Formatter
manual_id: messageformatter.create
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: null
return_description:
<p class="para">
   The formatter <span class="type">object</span>, or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on failure.
  </p>

errors:
<p class="para">
   When invoked as constructor, on failure an <span class="classname">IntlException</span>
   is thrown.
  </p>


name: MessageFormatter.formatMessage
purpose: Quick format message
manual_id: messageformatter.formatmessage
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The formatted pattern string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred
  </p>


name: MessageFormatter.format
purpose: Format the message
manual_id: messageformatter.format
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The formatted string, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> if an error occurred
  </p>


name: MessageFormatter.getPattern
purpose: Get the pattern used by the formatter
manual_id: messageformatter.getpattern
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   The pattern <span class="type">string</span> for this message formatter,  or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: MessageFormatter.parseMessage
purpose: Quick parse input string
manual_id: messageformatter.parsemessage
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: false
return_description:
<p class="para">
   An <span class="type">array</span> containing items extracted, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: MessageFormatter.parse
purpose: Parse input string according to pattern
manual_id: messageformatter.parse
version: PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> containing the items extracted, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on error
  </p>


name: IntlCalendar.after
purpose: Whether this objectʼs time is after that of the passed object
manual_id: intlcalendar.after
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this objectʼs current time is after that of the
   <code class="parameter">calendar</code> argumentʼs time. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">On failure <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned. To detect error conditions use <span class="function">intl_get_error_code</span>, or set up Intl to throw <a href="intl.configuration.html#ini.intl.use-exceptions" class="link">exceptions</a>.</p>


name: IntlCalendar.before
purpose: Whether this objectʼs time is before that of the passed object
manual_id: intlcalendar.before
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if this objectʼs current time is before that of the
   <code class="parameter">calendar</code> argumentʼs time. Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> otherwise.
  </p>
  <p class="para">On failure <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned. To detect error conditions use <span class="function">intl_get_error_code</span>, or set up Intl to throw <a href="intl.configuration.html#ini.intl.use-exceptions" class="link">exceptions</a>.</p>


name: IntlCalendar.createInstance
purpose: Create a new IntlCalendar
manual_id: intlcalendar.createinstance
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: null
return_description:
<p class="para">
   The created <span class="classname">IntlCalendar</span> instance or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> on
   failure.
  </p>


name: IntlCalendar.equals
purpose: Compare time of two IntlCalendar objects for equality
manual_id: intlcalendar.equals
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: bool
return_description:
<p class="para">
   Returns <strong><code><a href="reserved.constants.html#constant.true">true</a></code></strong> if the current time of both this and the passed in
   <span class="classname">IntlCalendar</span> object are the same, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong>
   otherwise.
  </p>
  <p class="para">On failure <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> is also returned. To detect error conditions use <span class="function">intl_get_error_code</span>, or set up Intl to throw <a href="intl.configuration.html#ini.intl.use-exceptions" class="link">exceptions</a>.</p>


name: IntlCalendar.fieldDifference
purpose: Calculate difference between given time and this objectʼs time
manual_id: intlcalendar.fielddifference
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   Returns a (signed) difference of time in the unit associated with the
   specified field or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.fromDateTime
purpose: Create an IntlCalendar from a DateTime object or string
manual_id: intlcalendar.fromdatetime
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a2
return_type: null
return_description:
<p class="para">
   The created <span class="classname">IntlCalendar</span> object or <strong><code><a href="reserved.constants.html#constant.null">null</a></code></strong> in case of
   failure. If a <span class="type">string</span> is passed, any exception that occurs
   inside the <span class="classname">DateTime</span> constructor is propagated.
  </p>


name: IntlCalendar.getActualMaximum
purpose: The maximum value for a field, considering the objectʼs current time
manual_id: intlcalendar.getactualmaximum
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing the maximum value in the units associated
   with the given <code class="parameter">field</code> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getActualMinimum
purpose: The minimum value for a field, considering the objectʼs current time
manual_id: intlcalendar.getactualminimum
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing the minimum value in the fieldʼs
   unit or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getAvailableLocales
purpose: Get array of locales for which there is data
manual_id: intlcalendar.getavailablelocales
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: array
return_description:
<p class="para">
   An <span class="type">array</span> of <span class="type">string</span>s, one for which locale. 
  </p>


name: IntlCalendar.getDayOfWeekType
purpose: Tell whether a day is a weekday, weekend or a day that has a transition between the two
manual_id: intlcalendar.getdayofweektype
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   Returns one of the constants 
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-type-weekday">IntlCalendar::DOW_TYPE_WEEKDAY</a></code></strong>,
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-type-weekend">IntlCalendar::DOW_TYPE_WEEKEND</a></code></strong>,
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-type-weekend-offset">IntlCalendar::DOW_TYPE_WEEKEND_OFFSET</a></code></strong> or
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-type-weekend-cease">IntlCalendar::DOW_TYPE_WEEKEND_CEASE</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getErrorCode
purpose: Get last error code on the object
manual_id: intlcalendar.geterrorcode
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An ICU error code indicating either success, failure or a warning.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getErrorMessage
purpose: Get last error message on the object
manual_id: intlcalendar.geterrormessage
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   The error message associated with last error that occurred in a function call
   on this object, or a string indicating the non-existence of an error.
   Returns <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getFirstDayOfWeek
purpose: Get the first day of the week for the calendarʼs locale
manual_id: intlcalendar.getfirstdayofweek
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   One of the constants <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-sunday">IntlCalendar::DOW_SUNDAY</a></code></strong>,
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-monday">IntlCalendar::DOW_MONDAY</a></code></strong>, …,
   <strong><code><a href="class.intlcalendar.html#intlcalendar.constants.dow-saturday">IntlCalendar::DOW_SATURDAY</a></code></strong> or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getGreatestMinimum
purpose: Get the largest local minimum value for a field
manual_id: intlcalendar.getgreatestminimum
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing a field value, in the fieldʼs
   unit, or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getKeywordValuesForLocale
purpose: Get set of locale keyword values
manual_id: intlcalendar.getkeywordvaluesforlocale
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An iterator that yields strings with the locale keyword
   values or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getLeastMaximum
purpose: Get the smallest local maximum for a field
manual_id: intlcalendar.getleastmaximum
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing a field value in the fieldʼs
   unit or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getLocale
purpose: Get the locale associated with the object
manual_id: intlcalendar.getlocale
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   A locale string or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


name: IntlCalendar.getMinimalDaysInFirstWeek
purpose: Get minimal number of days the first week in a year or month can have
manual_id: intlcalendar.getminimaldaysinfirstweek
version: PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1
return_type: false
return_description:
<p class="para">
   An <span class="type">int</span> representing a number of days or <strong><code><a href="reserved.constants.html#constant.false">false</a></code></strong> on failure.
  </p>


