# php_manual

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

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       The name of the database on which to execute the command.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  The command to execute.
  <info>array|null</info>              <strong>$options</strong>  
                                    optionsOptionTypeDescriptionreadConcern<class>MongoDB\Driver\ReadConcern</class>
                                    A read concern to apply to the operation.  This option is
                                    available in MongoDB 3.2+ and will result in an exception at
                                    execution time if specified for an older server version.
                                    session<class>MongoDB\Driver\Session</class> A session to associate with the
                                    operation. writeConcern<class>MongoDB\Driver\WriteConcern</class> A write
                                    concern to apply to the operation.
                                    
                                    A read concern to apply to the operation.
                                    
                                    This option is available in MongoDB 3.2+ and will result in an
                                    exception at execution time if specified for an older server
                                    version.
                                    
                                    A session to associate with the operation.
                                    
                                    A write concern to apply to the operation.
                                    
                                    If you are using a <return>"session"</return> which has a transaction in
                                    progress, you cannot specify a <return>"readConcern"</return> or <return>"writeConcern"</return>
                                    option. This will result in an
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> being thrown.
                                    Instead, you should set these two options when you create the
                                    transaction with MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Returns <class>MongoDB\Driver\Cursor</class> on success.

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


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

<comment>Param:</comment>
  <info>string</info>                  <strong>$db</strong>       The name of the database on which to execute the command.
  <info>MongoDB\Driver\Command</info>  <strong>$command</strong>  The command to execute.
  <info>array|null</info>              <strong>$options</strong>  optionsOptionTypeDescriptionsession<class>MongoDB\Driver\Session</class> A
                                    session to associate with the operation.
                                    writeConcern<class>MongoDB\Driver\WriteConcern</class> A write concern to apply
                                    to the operation.
                                    
                                    A session to associate with the operation.
                                    
                                    A write concern to apply to the operation.
                                    
                                    If you are using a <return>"session"</return> which has a transaction in
                                    progress, you cannot specify a <return>"readConcern"</return> or <return>"writeConcern"</return>
                                    option. This will result in an
                                    <class>MongoDB\Driver\Exception\InvalidArgumentException</class> being thrown.
                                    Instead, you should set these two options when you create the
                                    transaction with MongoDB\Driver\Session::startTransaction.

<comment>Return:</comment>
  <info>MongoDB\Driver\Cursor</info>  Returns <class>MongoDB\Driver\Cursor</class> on success.

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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


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


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


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


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


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


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


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


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


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


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


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

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

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


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

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

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


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

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


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

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

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


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

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

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


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

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

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


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


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


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

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


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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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

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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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

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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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

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

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


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

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


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

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

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


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

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


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

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

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


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

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

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


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

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


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

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

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


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

<comment>Param:</comment>
  <info>array|null</info>  <strong>$options</strong>  Options can be passed as argument to this method. Each element in this
                        options array overrides the corresponding option from the
                        <return>"defaultTransactionOptions"</return> option, if set when starting the session with
                        MongoDB\Driver\Manager::startSession.
                        
                        optionsOptionTypeDescriptionmaxCommitTimeMSinteger The maximum amount of
                        time in milliseconds to allow a single <return>commitTransaction</return> command to run.  If
                        specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than or
                        equal to zero. readConcern<class>MongoDB\Driver\ReadConcern</class> A read concern to apply
                        to the operation.  This option is available in MongoDB 3.2+ and will result
                        in an exception at execution time if specified for an older server version.
                        readPreference<class>MongoDB\Driver\ReadPreference</class> A read preference to use for
                        selecting a server for the operation.
                        writeConcern<class>MongoDB\Driver\WriteConcern</class> A write concern to apply to the
                        operation.
                        
                        The maximum amount of time in milliseconds to allow a single
                        <return>commitTransaction</return> command to run.
                        
                        If specified, <return>maxCommitTimeMS</return> must be a signed 32-bit integer greater than
                        or equal to zero.
                        
                        A read concern to apply to the operation.
                        
                        This option is available in MongoDB 3.2+ and will result in an exception at
                        execution time if specified for an older server version.
                        
                        A read preference to use for selecting a server for the operation.
                        
                        A write concern to apply to the operation.

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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


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


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


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


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


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


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


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

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


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

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


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

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


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

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


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


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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


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


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

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

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


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

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

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


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

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

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


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


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

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


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

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

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


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

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


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

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


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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


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

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

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


id: MultipleIterator::__construct
type: function
doc:
<comment>Description:</comment>
  新しい MultipleIterator を作成する
  
  新しい MultipleIterator を作成します。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  設定するフラグ。 フラグ定数 を参照ください。 <info>MultipleIterator::MIT_NEED_ALL</info> あるいは
               <info>MultipleIterator::MIT_NEED_ANY</info> <info>MultipleIterator::MIT_KEYS_NUMERIC</info> あるいは
               <info>MultipleIterator::MIT_KEYS_ASSOC</info>
               
               デフォルトは <info>MultipleIterator::MIT_NEED_ALL</info>|<info>MultipleIterator::MIT_KEYS_NUMERIC</info> です。

<comment>See Also:</comment>
   * フラグ定数
   * MultipleIterator::valid


id: MultipleIterator::attachIterator
type: function
doc:
<comment>Description:</comment>
  イテレータの情報をアタッチする
  
  イテレータの情報をアタッチします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>         <strong>$iterator</strong>  アタッチする新しいイテレータ。
  <info>string|int|null</info>  <strong>$info</strong>      イテレータに関連する情報。 <info>int</info>、<info>string</info> あるいは <info>null</info> でなければなりま
                              せん。

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

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


id: MultipleIterator::containsIterator
type: function
doc:
<comment>Description:</comment>
  イテレータがアタッチされているかどうかを調べる
  
  イテレータがアタッチされているかどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  調べたいイタレータ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: MultipleIterator::countIterators
type: function
doc:
<comment>Description:</comment>
  アタッチされているイテレータインスタンスの数を取得する
  
  アタッチされているイテレータインスタンスの数を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  アタッチされているイテレータインスタンスの数を (<info>int</info> で) 返します

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


id: MultipleIterator::current
type: function
doc:
<comment>Description:</comment>
  登録されているイテレータインスタンスを取得する
  
  登録されているイテレータインスタンスの current() の結果を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  アタッチされている各イテレータの現在の値を含む配列を返します。

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


id: MultipleIterator::detachIterator
type: function
doc:
<comment>Description:</comment>
  イテレータをデタッチする
  
  イテレータをデタッチします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  デタッチするイテレータ。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: MultipleIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  フラグの情報を取得する
  
  フラグについての情報を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>int</info>  フラグについての情報を <info>int</info> で返します。

<comment>See Also:</comment>
   * フラグ定数
   * MultipleIterator::__construct
   * MultipleIterator::setFlags


id: MultipleIterator::key
type: function
doc:
<comment>Description:</comment>
  登録されているイテレータインスタンスを取得する
  
  登録されているイテレータインスタンスの key() の結果を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  登録されているイテレータインスタンスの配列を返します。

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


id: MultipleIterator::next
type: function
doc:
<comment>Description:</comment>
  アタッチしているすべてのイテレータインスタンスを次に移動させる
  
  アタッチしているすべてのイテレータインスタンスを次に移動させます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: MultipleIterator::rewind
type: function
doc:
<comment>Description:</comment>
  アタッチしているすべてのイテレータインスタンスを巻き戻す
  
  アタッチしているすべてのイテレータインスタンスを巻き戻します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: MultipleIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  フラグを設定する
  
  フラグを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  設定するフラグ。 フラグ定数 を参照ください。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * フラグ定数
   * MultipleIterator::__construct
   * MultipleIterator::getFlags


id: MultipleIterator::valid
type: function
doc:
<comment>Description:</comment>
  サブイテレータの有効性を調べる
  
  サブイテレータの有効性を調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  サブイテレータのひとつあるいはすべて (フラグによって異なります) が有効な場合に <info>true</info>、 それ以
        外の場合に <info>false</info> を返します。

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


id: NoRewindIterator
type: class
doc:
<comment>Description:</comment>
  このイテレータは巻き戻しの操作を無視します。 これにより、一部のみを走査する 複数の foreach ループ
  でイテレータを処理することが可能になります。


id: NoRewindIterator::__construct
type: function
doc:
<comment>Description:</comment>
  NoRewindIterator を作成する
  
  NoRewindIterator を作成します。

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  使用するイテレータ。

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


id: NoRewindIterator::current
type: function
doc:
<comment>Description:</comment>
  現在の値を取得する
  
  現在の値を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  現在の値を返します。

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


id: NoRewindIterator::key
type: function
doc:
<comment>Description:</comment>
  現在のキーを取得する
  
  現在のキーを取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>mixed</info>  現在のキーを返します。

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


id: NoRewindIterator::next
type: function
doc:
<comment>Description:</comment>
  次の要素に移動する
  
  次の要素に移動します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: NoRewindIterator::rewind
type: function
doc:
<comment>Description:</comment>
  内部イテレータの巻き戻し操作を阻止する
  
  内部イテレータの巻き戻し操作を阻止します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: NoRewindIterator::valid
type: function
doc:
<comment>Description:</comment>
  イテレータの有効性を検証する
  
  イテレータが有効かどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: Normalizer
type: class
doc:
<comment>Description:</comment>
  正規化とは、文字や文字列を正式に決められた表現に変換する処理のことです。 これは、検索や並べ替えな
  どの際に比較をするときに特に重要となります。 ただ、それだけではなく、テキストを保存する際に表記を
  統一するために用いることもあります。
  
  Unicode Consortium では、 アプリケーション側でのさまざまなニーズにあわせていくつかの正規化方式を定
  義しています。 Normalization Form D (NFD) - Canonical Decomposition Normalization Form C (NFC) -
  Canonical Decomposition followed by Canonical Composition  Normalization Form KD (NFKD) -
  Compatibility Decomposition  Normalization Form KC (NFKC) - Compatibility Decomposition followed
  by Canonical Composition  これらの方式は、テキストに対する変換 (transformation) のセットとして定義
  されます。変換 (transformation) は、アルゴリズムとデータファイルの両方で表現します。


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


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


id: Normalizer::getRawDecomposition
type: function
doc:
<comment>Description:</comment>
  UTF-8 エンコードされているコードポイントから、Decomposition_Mapping プロパティの値を取得する
  
  オブジェクト指向型
  
  手続き型
  
  指定された UTF-8 エンコードされているコードポイントから、 Unicode Character Database (UCD) で指定
  されている Decomposition_Mapping プロパティの値を取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  入力文字列。 この値は単一の文字で、 UTF-8 エンコードされているコードポイントで
                   す。

<comment>Return:</comment>
  <info>string|null</info>  Unicode Character Database (UCD) に存在する場合、 Decomposition_Mapping プロパティの
               値を含む文字列を返します。
               
               指定された文字に Decomposition_Mapping プロパティの値がない場合は、 <info>null</info> を返します。

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


id: Normalizer::isNormalized
type: function
doc:
<comment>Description:</comment>
  渡された文字列が、指定した正規化を適用済みかどうかを調べる
    
  
  オブジェクト指向型
  
  手続き型
  
  渡された文字列が、指定した正規化を適用済みかどうかを調べます。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  正規化する入力文字列。
  <info>int</info>     <strong>$form</strong>    正規化方式のいずれか。

<comment>Return:</comment>
  <info>bool</info>  正規化されている場合に <info>true</info>、正規化されていない場合やエラーが発生した場合に <info>false</info> を返しま
        す。

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


id: Normalizer::normalize
type: function
doc:
<comment>Description:</comment>
  渡された入力を正規化し、正規化後の文字列を返す
    
  
  オブジェクト指向型
  
  手続き型
  
  渡された入力を正規化し、正規化後の文字列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  正規化する入力文字列。
  <info>int</info>     <strong>$form</strong>    正規化方式のいずれか。

<comment>Return:</comment>
  <info>string|false</info>  正規化後の文字列、あるいはエラーが発生した場合に <info>false</info> を返します。

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


id: NumberFormatter
type: class
doc:
<comment>Description:</comment>
  プログラムで数値を保存したり操作したりする際には、 ロケールに依存しないバイナリ表現を使用します。
  数値を表示するときに、ロケールにあわせた文字列形式に変換します。 たとえば 12345.67 という数値の表
  記はアメリカでは "12,345.67"、 フランスでは "12 345,67"、そしてドイツでは "12.345,67" となります。
  
  NumberFormatter クラスのメソッドを実行すると、 数値や通貨、パーセンテージなどの値をロケールに応じ
  た形式にフォーマットすることができます。 NumberFormatter はロケールを考慮した処理を行うので、 ロ
  ケールごとに別の NumberFormatter を用意する必要があります。 NumberFormatter のメソッドは、浮動小数
  点数値のような数値を ロケールにあわせた文字列に変換します。
  
  通貨の場合は、通貨用の書式を使用してフォーマッタを作成します。 これは、ロケールにあわせて数値を適
  切な書式にして通貨記号をつけた文字列を返します。 もちろん、NumberFormatter クラスは為替レートの変
  換などは考慮しません。 指定した通貨にかかわらず、出力される数値は同じものとなります。 つまり、ロ
  ケールによって同じ数値が違う額を表すことになるということです。 9988776.65 という数値を指定したとき
  の結果は次のようになります。 9 988 776,65 € (フランス)9.988.776,65 € (ドイツ)$9,988,776.65 (アメリ
  カ)
  
  パーセンテージをフォーマットするには、 パーセンテージ用の書式を指定したフォーマッタを作成します。
  これを使用すると、たとえば 0.75 のような小数が 75% と表示されるようになります。
  
  spelled-out numbers のような複雑な書式を設定する場合は、 ルールベースの数値フォーマッタを使用しま
  す。


id: NumberFormatter::CURRENCY_ACCOUNTING
type: constant
doc:
<comment>Description:</comment>
  会計処理のための通貨フォーマット。例: 負の通貨量の場合、<return>-$3.00</return> ではなく、<return>($3.00)</return> になります。 PHP
  7.4.1 と ICU 53 から利用可能です。


id: NumberFormatter::PUBLIC_RULESETS
type: constant
doc:
<comment>Description:</comment>
  パブリックルールセット。 これは、ルールベースのフォーマッタでのみ有効です。 これは読み込み専用の属
  性です。 パブリックルールセットは文字列として返され、 個々のルールセットは ';' (セミコロン) で区切
  られています。


id: NumberFormatter::__construct
type: function
doc:
<comment>Description:</comment>
  数値フォーマッタを作成する
  
  オブジェクト指向型 (メソッド)
  
  手続き型
  
  オブジェクト指向型 (コンストラクタ):
  
  数値フォーマッタを作成します。

<comment>Param:</comment>
  <info>string</info>       <strong>$locale</strong>   数値フォーマットするロケール (ロケール名。たとえば en_CA)。
  <info>int</info>          <strong>$style</strong>    フォーマットの形式。  フォーマット形式 定数のいずれか。
                         <info>NumberFormatter::PATTERN_DECIMAL</info> あるいは
                         <info>NumberFormatter::PATTERN_RULEBASED</info> を指定した場合は指定したパターンの数値
                         フォーマットをオープンします。 これは、それぞれ ICU DecimalFormat ドキュメ
                         ント あるいは ICU RuleBasedNumberFormat ドキュメント で述べられている構文を
                         満たす必要があります。
  <info>string|null</info>  <strong>$pattern</strong>  選択した形式がパターンを要求するものである場合のパターン文字列。

<comment>Return:</comment>
  <info>NumberFormatter|null</info>  <class>NumberFormatter</class> オブジェクト、 あるいはエラー時に <info>null</info> を返します。

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


id: NumberFormatter::format
type: function
doc:
<comment>Description:</comment>
  数値をフォーマットする
  
  オブジェクト指向型
  
  手続き型
  
  数値をフォーマット規則にしたがってフォーマットします。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int|float</info>        <strong>$num</strong>        フォーマットする値。<info>int</info> あるいは <info>float</info> で指定します。その他の型は数値
                               に変換されます。
  <info>int</info>              <strong>$type</strong>       使用する  フォーマット形式。 <info>NumberFormatter::TYPE_CURRENCY</info> はサポー
                               トされていないので注意して下さい。 <info>NumberFormatter::TYPE_CURRENCY</info> を
                               使いたい場合、 代わりに NumberFormatter::formatCurrency を使いましょ
                               う。

<comment>Return:</comment>
  <info>string|false</info>  フォーマットした値を文字列で返します。 エラー時には <info>false</info> を返します。

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


id: NumberFormatter::formatCurrency
type: function
doc:
<comment>Description:</comment>
  通貨の値をフォーマットする
  
  オブジェクト指向型
  
  手続き型
  
  通貨の値をフォーマット規則にしたがってフォーマットします。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>float</info>            <strong>$amount</strong>     通貨の値。
  <info>string</info>           <strong>$currency</strong>   使用する通貨を表す、3 文字の ISO 4217 通貨コード。

<comment>Return:</comment>
  <info>string|false</info>  通貨の値をフォーマットした文字列を返します。 失敗した場合に <info>false</info> を返します

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


id: NumberFormatter::getAttribute
type: function
doc:
<comment>Description:</comment>
  属性を取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタの数値属性を取得します。 数値属性の例としては、フォーマッタが作成する整数部の桁数など
  があります。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$attribute</strong>  属性指定子。  数値属性 定数のいずれか。

<comment>Return:</comment>
  <info>int|float|false</info>  成功した場合に属性の値、エラー時に <info>false</info> を返します。

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


id: NumberFormatter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  フォーマッタの直近のエラーコードを取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタが直近に実行した関数のエラーコードを取得します。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。

<comment>Return:</comment>
  <info>int</info>  直近の関数コールのエラーコードを返します。

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


id: NumberFormatter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  フォーマッタの直近のエラーメッセージを取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタが直近に実行した関数のエラーメッセージを取得します。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。

<comment>Return:</comment>
  <info>string</info>  直近の関数コールのエラーメッセージを返します。

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


id: NumberFormatter::getLocale
type: function
doc:
<comment>Description:</comment>
  フォーマッタのロケールを取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタのロケール名を取得します。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$type</strong>       妥当なロケールあるいは正確なロケールのいずれか (
                               <info>Locale::VALID_LOCALE</info>, <info>Locale::ACTUAL_LOCALE</info>, respectively) を選択しま
                               す。デフォルトは実際のロケールです。

<comment>Return:</comment>
  <info>string|false</info>  フォーマッタの作成時に使用したロケールを返します。 失敗した場合は <info>false</info> を返します。

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


id: NumberFormatter::getPattern
type: function
doc:
<comment>Description:</comment>
  フォーマッタのパターンを取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタが使用するパターンを取り出します。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。

<comment>Return:</comment>
  <info>string|false</info>  このフォーマッタが使用するパターン文字列、 あるいはエラー発生時に <info>false</info> を返します。

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


id: NumberFormatter::getSymbol
type: function
doc:
<comment>Description:</comment>
  記号を取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタに関連づけられている記号を取得します。 フォーマッタでは、この記号で数値の中のロケール
  に依存する文字 (パーセント記号など) を扱います。 この API は、ルールベースのフォーマッタではサポー
  トしていません。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$symbol</strong>     記号指定子。  フォーマット記号 定数のいずれか。

<comment>Return:</comment>
  <info>string|false</info>  記号文字列、あるいはエラー時に <info>false</info> を返します。

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


id: NumberFormatter::getTextAttribute
type: function
doc:
<comment>Description:</comment>
  テキストの属性を取得する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタに関連づけられているテキスト属性を取得します。 テキスト属性の例としては、正の数字のサ
  フィックスなどがあります。 属性が理解できない場合は、エラー <info>U_UNSUPPORTED_ERROR</info> が発生します。
  ルールベースのフォーマッタでは、 <info>NumberFormatter::DEFAULT_RULESET</info> および
  <info>NumberFormatter::PUBLIC_RULESETS</info> のみが使用できます。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$attribute</strong>  属性指定子。  テキスト属性 定数のいずれか。

<comment>Return:</comment>
  <info>string|false</info>  成功した場合に属性の値、あるいはエラー時に <info>false</info> を返します。

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


id: NumberFormatter::parse
type: function
doc:
<comment>Description:</comment>
  数値をパースする
  
  オブジェクト指向型
  
  手続き型
  
  現在のフォーマット規則を使用して、文字列を数値にパースします。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>string</info>           <strong>$string</strong>     数値としてパースする文字列。
  <info>int</info>              <strong>$type</strong>       使用する  フォーマット形式。デフォルトでは
                               <info>NumberFormatter::TYPE_DOUBLE</info> を使用します。
                               <info>NumberFormatter::TYPE_CURRENCY</info> はサポートされていないので注意して下さ
                               い。 <info>NumberFormatter::TYPE_CURRENCY</info> を使いたい場合、 代わりに
                               NumberFormatter::parseCurrency を使いましょう。
  <info>int</info>              <strong>$offset</strong>     文字列中でパースを開始する位置のオフセット。 結果を返す際に、この値は
                               パース終了時のオフセットを保持します。

<comment>Return:</comment>
  <info>int|float|false</info>  パースした数値、あるいはエラー時に <info>false</info> を返します。

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


id: NumberFormatter::parseCurrency
type: function
doc:
<comment>Description:</comment>
  通貨をパースする
  
  オブジェクト指向型
  
  手続き型
  
  現在のフォーマッタを使用して、文字列を浮動小数点と通貨にパースします。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>string</info>           <strong>$currency</strong>   通貨名 (3 文字の ISO 4217 通貨コード) を受け取るパラメータ。
  <info>int</info>              <strong>$offset</strong>     文字列中でパースを開始する位置のオフセット。 結果を返す際に、この値は
                               パース終了時のオフセットを保持します。

<comment>Return:</comment>
  <info>float|false</info>  パースした数値、あるいはエラー時に <info>false</info> を返します。

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


id: NumberFormatter::setAttribute
type: function
doc:
<comment>Description:</comment>
  属性を設定する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタに関連づけられている数値属性を設定します。 数値属性の例としては、フォーマッタが作成す
  る整数部の桁数などがあります。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$attribute</strong>  属性指定子。  数値属性 定数のいずれか。
  <info>int|float</info>        <strong>$value</strong>      属性の値。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: NumberFormatter::setPattern
type: function
doc:
<comment>Description:</comment>
  フォーマッタのパターンを設定する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタが使用するパターンを設定します。 ルールベースのフォーマッタでは使用できません。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>string</info>           <strong>$pattern</strong>    ICU DecimalFormat ドキュメント で述べられている構文によるパターン。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: NumberFormatter::setSymbol
type: function
doc:
<comment>Description:</comment>
  記号の値を設定する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタに関連づけられている記号を設定します。 フォーマッタでは、この記号で数値の中のロケール
  に依存する文字 (パーセント記号など) を扱います。 この API は、ルールベースのフォーマッタではサポー
  トしていません。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$symbol</strong>     記号指定子。  フォーマット記号 定数のいずれか。
  <info>string</info>           <strong>$value</strong>      その記号に対応するテキスト。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: NumberFormatter::setTextAttribute
type: function
doc:
<comment>Description:</comment>
  テキスト属性を設定する
  
  オブジェクト指向型
  
  手続き型
  
  フォーマッタに関連づけられているテキスト属性を設定します。 テキスト属性の例としては、正の数字のサ
  フィックスなどがあります。 属性が理解できない場合は、エラー <info>U_UNSUPPORTED_ERROR</info> が発生します。
  ルールベースのフォーマッタでは、 <info>NumberFormatter::DEFAULT_RULESET</info> および
  <info>NumberFormatter::PUBLIC_RULESETS</info> のみが使用できます。

<comment>Param:</comment>
  <info>NumberFormatter</info>  <strong>$formatter</strong>  <class>NumberFormatter</class> オブジェクト。
  <info>int</info>              <strong>$attribute</strong>  属性指定子。 テキスト属性 定数のいずれか。
  <info>string</info>           <strong>$value</strong>      属性の値を表すテキスト。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OAUTH_AUTH_TYPE_AUTHORIZATION
type: constant
doc:
<comment>Description:</comment>
  この定数は、OAuth パラメータを <return>Authorization</return> ヘッダ内に記述することを表します。


id: OAUTH_BAD_TIMESTAMP
type: constant
doc:
<comment>Description:</comment>
  oauth_timestamp の値がサービスプロバイダに受け入れられませんでした。 この場合、レスポンスには
  oauth_acceptable_timestamps パラメータが含まれていなければなりません。


id: OAUTH_CONSUMER_KEY_UNKNOWN
type: constant
doc:
<comment>Description:</comment>
  oauth_consumer_key が、一時的にサービスプロバイダに受け入れられませんでした。 プロバイダ側でコン
  シューマに制限をかけているなどの可能性が考えられます。


id: OAUTH_PARAMETER_ABSENT
type: constant
doc:
<comment>Description:</comment>
  必須パラメータが含まれていません。 この場合、レスポンスには oauth_parameters_absent パラメータが含
  まれていなければなりません。


id: OAUTH_REQENGINE_CURL
type: constant
doc:
<comment>Description:</comment>
  OAuth::setRequestEngine で使用するもので、 エンジンを Curl に設定します。 PHP streams を使う場合は
  <info>OAUTH_REQENGINE_STREAMS</info> を用います。


id: OAUTH_REQENGINE_STREAMS
type: constant
doc:
<comment>Description:</comment>
  OAuth::setRequestEngine で使用するもので、 エンジンを PHP ストリーム に設定します。 Curl を使う場
  合は <info>OAUTH_REQENGINE_CURL</info> を用います。


id: OAUTH_TOKEN_REJECTED
type: constant
doc:
<comment>Description:</comment>
  oauth_token がサービスプロバイダに受け入れられませんでした。 理由は不明ですが、 トークンが発行され
  ていない・すでに使用済みである・プロバイダ側で忘れられてしまった といった原因が考えられます。


id: OAuth
type: class
doc:
<comment>Description:</comment>
  OAuth 拡張モジュールは、データプロバイダとやりとりするためのシンプルなインターフェイスを提供しま
  す。 OAuth HTTP 仕様を用いることで、プライベートなリソースを保護します。


id: OAuth::__construct
type: function
doc:
<comment>Description:</comment>
  新しい OAuth オブジェクトを作成する
  
  新しい OAuth オブジェクトを作成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$consumer_key</strong>      サービスプロバイダが提供する consumer key。
  <info>string</info>  <strong>$consumer_secret</strong>   サービスプロバイダが提供する consumer secret。
  <info>string</info>  <strong>$signature_method</strong>  このオプションのパラメータで、使用する署名方式を定義します。 デフォルト
                             は <info>OAUTH_SIG_METHOD_HMACSHA1</info> (HMAC-SHA1) です。
  <info>int</info>     <strong>$auth_type</strong>         このオプションのパラメータで、OAuth パラメータをコンシューマに渡す方法
                             を定義します。 デフォルトは <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info>
                             (<return>Authorization</return> ヘッダを使用する) です。


id: OAuth::__destruct
type: function
doc:
<comment>Description:</comment>
  デストラクタ
  
  デストラクタです。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuth::disableDebug
type: function
doc:
<comment>Description:</comment>
  デバッグを無効にする
  
  冗長なリクエスト情報を無効にします (デフォルトは無効です)。 あるいは、debug プロパティに <info>false</info> を
  設定することによってもデバッグを無効にできます。

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

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


id: OAuth::disableRedirects
type: function
doc:
<comment>Description:</comment>
  リダイレクトを無効にする
  
  リダイレクト先を自動的にたどる機能を無効にし、リクエストを手動でリダイレクトできるようにします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: OAuth::disableSSLChecks
type: function
doc:
<comment>Description:</comment>
  SSL チェックを無効にする
  
  通常の SSL ピア証明書およびホストのチェックを無効にします。 これは実運用に使うものではありません。
  あるいは、<strong>$sslChecks</strong> メンバーに <info>false</info> を設定することによっても SSL チェックを無効にできます。

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

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


id: OAuth::enableDebug
type: function
doc:
<comment>Description:</comment>
  デバッグを有効にする
  
  デバッグに使用できる、冗長なリクエスト情報の出力を有効にします。 デバッグ情報は <strong>$debugInfo</strong> メン
  バーに格納されます。 あるいは、<strong>$debug</strong> メンバーに <info>false</info> 以外の値を設定することによってもデバッグを
  有効にできます。

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

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


id: OAuth::enableRedirects
type: function
doc:
<comment>Description:</comment>
  リダイレクトを有効にする
  
  自動的にリダイレクトをたどりまず。デフォルトで有効となっています。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

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


id: OAuth::enableSSLChecks
type: function
doc:
<comment>Description:</comment>
  SSL チェックを有効にする
  
  通常の SSL ピア証明書およびホストのチェックを有効にします (デフォルトは有効です)。 あるいは、
  <strong>$sslChecks</strong> メンバーに <info>false</info> 以外の値を設定することによっても SSL チェックを有効にできます。

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

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


id: OAuth::fetch
type: function
doc:
<comment>Description:</comment>
  OAuth で保護されたリソースを取得する
  
  リソースを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$protected_resource_url</strong>  OAuth で保護されたリソースへの URL。
  <info>array</info>   <strong>$extra_parameters</strong>        リソースへのリクエストとともに送信する追加パラメータ。
  <info>string</info>  <strong>$http_method</strong>             <info>OAUTH_HTTP_METHOD_*</info>OAUTH 定数 のいずれか。 GET、POST、PUT、HEAD
                                   そして DELETE があります。
                                   
                                   HEAD (<info>OAUTH_HTTP_METHOD_HEAD</info>) は、 実際のリクエストの前に (OAuth
                                   認証情報が <return>Authorization</return> ヘッダにあるかどうかなどの) 情報を取得す
                                   るときに有用です。
  <info>array</info>   <strong>$http_headers</strong>            HTTP クライアントヘッダ (User-Agent や Accept など)。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OAuth::generateSignature
type: function
doc:
<comment>Description:</comment>
  シグネチャを生成する
  
  最後の HTTP メソッド、URL そしてパラメータ文字列あるいは配列にもとづいてシグネチャを生成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       リクエストの HTTP メソッド。
  <info>string</info>  <strong>$url</strong>               リクエストの URL。
  <info>mixed</info>   <strong>$extra_parameters</strong>  パラメータ文字列あるいは配列。

<comment>Return:</comment>
  <info>string|false</info>  生成されたシグネチャを文字列で返します。失敗した場合に <info>false</info> を返します


id: OAuth::getAccessToken
type: function
doc:
<comment>Description:</comment>
  アクセストークンを取得する
  
  アクセストークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$access_token_url</strong>     アクセストークン API の URL。
  <info></info>        <strong>$auth_session_handle</strong>  認証セッションハンドル。このパラメータはコア OAuth 1.0 仕様を引用し
                                ていませんが、大手プロバイダでは実装されているでしょう。 詳細な情報
                                は ScalableOAuth を参照ください。
  <info>string</info>  <strong>$verifier_token</strong>       1.0a をサポートするサービスプロバイダでは、リクエストトークンとアク
                                セストークンを交換する際に <strong>$verifier_token</strong> を渡す必要があります。
                                <strong>$verifier_token</strong> が <strong>$_GET</strong> あるいは <strong>$_POST</strong> に存在する場合は自動的にそ
                                れが渡され、 呼び出し側が <strong>$verifier_token</strong> を指定する必要はありません
                                (通常、アクセストークンを oauth_callback URL で交換する場合はこのよ
                                うになります)。 詳細な情報は ScalableOAuth を参照ください。
  <info>string</info>  <strong>$http_method</strong>          利用する HTTP メソッド。<return>GET</return> や <return>POST</return> など。

<comment>Return:</comment>
  <info>array</info>  成功した場合は OAuth レスポンスをパースした配列、失敗した場合は <info>false</info> を返します。

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


id: OAuth::getCAPath
type: function
doc:
<comment>Description:</comment>
  CA 情報を取得する
  
  認証局の情報を取得します。ここには、 OAuth::setCaPath で設定した ca_path や ca_info が含まれます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>array</info>  認証局の情報を含む配列を返します。返される連想配列のキーには <return>ca_path</return> と <return>ca_info</return> が含まれま
         す。

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


id: OAuth::getLastResponse
type: function
doc:
<comment>Description:</comment>
  直近のレスポンスを取得する
  
  直近のリクエストに対するレスポンスをそのままの形式で取得します。

<comment>Return:</comment>
  <info>string</info>  直近のレスポンスを含む文字列を返します。

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


id: OAuth::getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  最後のレスポンスのヘッダを取得する
  
  最後のレスポンスのヘッダを取得します。

<comment>Return:</comment>
  <info>string|false</info>  最後のレスポンスのヘッダを文字列で返します。失敗した場合に <info>false</info> を返します


id: OAuth::getLastResponseInfo
type: function
doc:
<comment>Description:</comment>
  直近のレスポンスの HTTP 情報を取得する
  
  直近のレスポンスに関する HTTP 情報を取得します。

<comment>Return:</comment>
  <info>array</info>  直近のリクエストに対するレスポンスの情報を含む配列を返します。 <strong>curl_getinfo()</strong> の定数が使わ
         れます。

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


id: OAuth::getRequestHeader
type: function
doc:
<comment>Description:</comment>
  OAuth ヘッダ文字列シグネチャを生成する
  
  最後の HTTP メソッド、URL そしてパラメータ文字列あるいは配列にもとづいて OAuth ヘッダ文字列シグネ
  チャを生成します。

<comment>Param:</comment>
  <info>string</info>  <strong>$http_method</strong>       リクエストの HTTP メソッド。
  <info>string</info>  <strong>$url</strong>               リクエストの URL。
  <info>mixed</info>   <strong>$extra_parameters</strong>  パラメータ文字列あるいは配列。

<comment>Return:</comment>
  <info>string|false</info>  生成されたリクエストヘッダを文字列で返します。失敗した場合に <info>false</info> を返します


id: OAuth::getRequestToken
type: function
doc:
<comment>Description:</comment>
  リクエストトークンを取得する
  
  リクエストトークン、secret そして追加のレスポンスパラメータをサービスプロバイダから取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$request_token_url</strong>  リクエストトークン API の URL。
  <info>string</info>  <strong>$callback_url</strong>       OAuth コールバック URL。<strong>$callback_url</strong> に空の値を渡すと、"oob" に設定さ
                              れて OAuth 2009.1 advisory を指すことになります。
  <info>string</info>  <strong>$http_method</strong>        利用する HTTP メソッド。<return>GET</return> や <return>POST</return> など。

<comment>Return:</comment>
  <info>array</info>  成功した場合は OAuth レスポンスをパースした配列、失敗した場合は <info>false</info> を返します。

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


id: OAuth::setAuthType
type: function
doc:
<comment>Description:</comment>
  認証方式を設定する
  
  OAuth パラメータをどこで渡すかを設定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$auth_type</strong>  <strong>$auth_type</strong> は、次のフラグ (OAuth 1.0 section 5.2 において優先度の高い順) のいずれ
                   かです。 <info>OAUTH_AUTH_TYPE_AUTHORIZATION</info> OAuth パラメータを HTTP <return>Authorization</return> ヘッ
                   ダで渡します。 <info>OAUTH_AUTH_TYPE_FORM</info> OAuth パラメータを HTTP POST リクエストの本文
                   に追加します。 <info>OAUTH_AUTH_TYPE_URI</info> OAuth パラメータをリクエスト URI に追加しま
                   す。 <info>OAUTH_AUTH_TYPE_NONE</info> 何もなし。
                   
                   OAuth パラメータを HTTP <return>Authorization</return> ヘッダで渡します。
                   
                   OAuth パラメータを HTTP POST リクエストの本文に追加します。
                   
                   OAuth パラメータをリクエスト URI に追加します。
                   
                   何もなし。

<comment>Return:</comment>
  <info>bool</info>  パラメータを正しく設定した場合に <info>true</info> を返します。 それ以外の場合 (無効な <strong>$auth_type</strong> を渡し
        た場合など) は <info>false</info> を返します。


id: OAuth::setCAPath
type: function
doc:
<comment>Description:</comment>
  CA パスおよび情報を設定する
  
  認証局 (CA) のパスと情報を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$ca_path</strong>  設定したい CA パス。
  <info>string</info>  <strong>$ca_info</strong>  設定したい CA 情報。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info> を返します。<strong>$ca_path</strong> あるいは <strong>$ca_info</strong> が無効な形式の場合は <info>false</info> を返
         します。

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


id: OAuth::setNonce
type: function
doc:
<comment>Description:</comment>
  続くリクエスト用のノンスを設定する
  
  それ以降のすべてのリクエスト用のノンスを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$nonce</strong>  oauth_nonce の値。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info> を返します。 <strong>$nonce</strong> が無効な場合に <info>false</info> を返します。

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


id: OAuth::setRSACertificate
type: function
doc:
<comment>Description:</comment>
  RSA 証明書を設定する
  
  RSA 証明書を設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$cert</strong>  RSA 証明書。

<comment>Return:</comment>
  <info>mixed</info>  成功した場合に <info>true</info>、失敗した場合 (RSA 証明書がパースできなかった場合はど) に <info>false</info> を返し
         ます。

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


id: OAuth::setRequestEngine
type: function
doc:
<comment>Description:</comment>
  setRequestEngine
  
  HTTP リクエストの送信に使うリクエストエンジンを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int</info>  <strong>$reqengine</strong>  使いたいリクエストエンジン。<info>OAUTH_REQENGINE_STREAMS</info> は PHP のストリームを使い、
                   <info>OAUTH_REQENGINE_CURL</info> は Curl を使います。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuth::setSSLChecks
type: function
doc:
<comment>Description:</comment>
  リクエストに固有の SSL チェックを調整する
  
  リクエストに固有の SSL チェックを調整します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: OAuth::setTimestamp
type: function
doc:
<comment>Description:</comment>
  タイムスタンプを設定する
  
  それ以降のリクエスト用の OAuth タイムスタンプを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$timestamp</strong>  タイムスタンプ。

<comment>Return:</comment>
  <info>mixed</info>  <info>true</info> を返します。 <strong>$timestamp</strong> が無効な形式の場合は <info>false</info> を返します。

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


id: OAuth::setToken
type: function
doc:
<comment>Description:</comment>
  トークンと secret を設定する
  
  それ以降のリクエスト用のトークンと secret を設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$token</strong>         OAuth トークン。
  <info>string</info>  <strong>$token_secret</strong>  OAuth トークン secret。

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


id: OAuth::setVersion
type: function
doc:
<comment>Description:</comment>
  OAuth のバージョンを設定する
  
  それ以降のリクエスト用の OAuth のバージョンを設定します。

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>  OAuth のバージョン。デフォルトは常に "1.0"。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: OAuthException
type: class
doc:
<comment>Description:</comment>
  この例外は、OAuth 拡張モジュールの使用中に例外エラーが発生したときにスローされます。 デバッグに有
  用な情報が含まれています。


id: OAuthProvider
type: class
doc:
<comment>Description:</comment>
  OAuth プロバイダを管理するクラスです。
  
  別のサイトで公開されている詳細なチュートリアル Writing an OAuth Provider Service には、このサービ
  スを作成する方法がハンズオン形式で公開されています。 OAuth 拡張モジュールのソースの中には OAuth プ
  ロバイダのサンプル もあります。


id: OAuthProvider::__construct
type: function
doc:
<comment>Description:</comment>
  新しい OAuthProvider オブジェクトを作る
  
  新しい <class>OAuthProvider</class> オブジェクトのインスタンスを作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$params_array</strong>  これらのオプションパラメータを設定できるのは CLI SAPI のみです。

<comment>Return:</comment>
  <info>unknown</info>  <class>OAuthProvider</class> オブジェクトを返します。

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


id: OAuthProvider::addRequiredParameter
type: function
doc:
<comment>Description:</comment>
  必須パラメータを追加する
  
  oauth プロバイダの必須パラメータを追加します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  必須パラメータ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OAuthProvider::callTimestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  timestampNonceHandler コールバックをコールする
  
  タイムスタンプハンドラコールバックとして登録した関数をコールします。この関数は
  OAuthProvider::timestampNonceHandler で登録します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::callconsumerHandler
type: function
doc:
<comment>Description:</comment>
  consumerNonceHandler コールバックをコールする
  
  コンシューマハンドラコールバックとして登録した関数をコールします。この関数は
  OAuthProvider::consumerHandler で登録します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::calltokenHandler
type: function
doc:
<comment>Description:</comment>
  tokenNonceHandler コールバックをコールする
  
  トークンハンドラコールバックとして登録した関数をコールします。この関数は
  OAuthProvider::tokenHandler でコールします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::checkOAuthRequest
type: function
doc:
<comment>Description:</comment>
  oauth リクエストをチェックする
  
  OAuth リクエストをチェックします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>     オプションの URI、あるいはエンドポイント。
  <info>string</info>  <strong>$method</strong>  HTTP メソッド。 <info>OAUTH_HTTP_METHOD_*</info> OAuth 定数 のいずれかをオプションで渡します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::consumerHandler
type: function
doc:
<comment>Description:</comment>
  consumerHandler コールバックを設定する
  
  コンシューマハンドラコールバックを設定します。これは OAuthProvider::callConsumerHandler でコールさ
  れる関数です。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  <info>callable</info> 関数名。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::generateToken
type: function
doc:
<comment>Description:</comment>
  ランダムなトークンを生成する
  
  擬似乱数を使ってランダムなバイトの文字列を生成します。

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>    トークンの長さ。バイト単位で指定します。
  <info>bool</info>  <strong>$strong</strong>  <info>true</info> に設定すると、エントロピーとして <return>/dev/random</return> を使います。 それ以外の場合は、ブ
                 ロックされることのない <return>/dev/urandom</return> を使います。 このパラメータは、Windows では無視
                 されます。

<comment>Return:</comment>
  <info>string</info>  生成されたトークンをバイト文字列で返します。

<comment>See Also:</comment>
   * <strong>openssl_random_pseudo_bytes()</strong>
   * <strong>mcrypt_create_iv()</strong>


id: OAuthProvider::is2LeggedEndpoint
type: function
doc:
<comment>Description:</comment>
  is2LeggedEndpoint
  
  2-legged フローあるいはリクエストの署名。トークンは不要です。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$params_array</strong>  

<comment>Return:</comment>
  <info>void</info>  <class>OAuthProvider</class> オブジェクトを返します。

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


id: OAuthProvider::isRequestTokenEndpoint
type: function
doc:
<comment>Description:</comment>
  isRequestTokenEndpoint を設定する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>bool</info>  <strong>$will_issue_request_token</strong>  リクエストトークンを発行するか否かを設定します。つまり
                                   OAuthProvider::tokenHandler がコールされる必要があるかどうかを決
                                   めるということです。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * OAuthProvider::setRequestTokenPath
   * OAuthProvider::reportProblem


id: OAuthProvider::removeRequiredParameter
type: function
doc:
<comment>Description:</comment>
  必須パラメータを削除する
  
  必須パラメータを削除します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$req_params</strong>  削除したい必須パラメータ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OAuthProvider::reportProblem
type: function
doc:
<comment>Description:</comment>
  問題を報告する
  
  問題を、<class>OAuthException</class> 形式で渡します。設定できる問題については OAuth 定数 のセクションを参照くだ
  さい。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$oauthexception</strong>  <class>OAuthException</class>。

<comment>Return:</comment>
  <info>string</info>  値を返しません。

<comment>See Also:</comment>
   * OAuthProvider::checkOAuthRequest
   * OAuthProvider::isRequestTokenEndpoint


id: OAuthProvider::setParam
type: function
doc:
<comment>Description:</comment>
  パラメータを設定する
  
  パラメータを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$param_key</strong>  パラメータのキー。
  <info>mixed</info>   <strong>$param_val</strong>  パラメータの値。
                      
                      パラメータをシグネチャの検証から除外するには、この値を <info>null</info> にします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OAuthProvider::setRequestTokenPath
type: function
doc:
<comment>Description:</comment>
  リクエストトークンのパスを設定する
  
  リクエストトークンのパスを設定します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  パス。

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

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


id: OAuthProvider::timestampNonceHandler
type: function
doc:
<comment>Description:</comment>
  timestampNonceHandler コールバックを設定する
  
  タイムスタンプ ノンス ハンドラコールバックを設定します。これは
  OAuthProvider::callTimestampNonceHandler でコールされる関数です。タイムスタンプやノンスに関するエ
  ラーはこのコールバックにスローされます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  <info>callable</info> 関数名。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OAuthProvider::tokenHandler
type: function
doc:
<comment>Description:</comment>
  tokenHandler コールバックを設定する
  
  トークンハンドラコールバックを設定します。これは OAuthProvider::callTokenHandler でコールされる関
  数です。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback_function</strong>  <info>callable</info> 関数名。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

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


id: OCICollection
type: class
doc:
<comment>Description:</comment>
  OCI8 コレクション機能です。
  
  <class>OCI-Collection</class> クラスは、 PHP 8 と OCI8 3.0.0 で、 PHP の名前付けの規約に従い <class>OCICollection</class> に名前
  が変更されました。


id: OCICollection::append
type: function
doc:
<comment>Description:</comment>
  コレクションに要素を追加する
  
  コレクションの最後に要素を追加します。

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  コレクションに追加する値を指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::assign
type: function
doc:
<comment>Description:</comment>
  コレクションに他の存在するコレクションから値を割り当てる
  
  事前に生成された他のコレクションからコレクションの値を割り当てます。 両方のコレクションは、使用す
  る前に <strong>oci_new_collection()</strong> を使って生成される必要があります。

<comment>Param:</comment>
  <info>OCICollection</info>  <strong>$from</strong>  OCICollection インスタンスを指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::assignElem
type: function
doc:
<comment>Description:</comment>
  コレクションの要素に値を割り当てる
  
  インデックス <strong>$index</strong> の要素に値を割り当てます。

<comment>Param:</comment>
  <info>int</info>     <strong>$index</strong>  要素のインデックス。最初のインデックスは 0 です。
  <info>string</info>  <strong>$value</strong>  文字列あるいは数値です。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::free
type: function
doc:
<comment>Description:</comment>
  コレクションオブジェクトに関連付けられたリソースを解放する
  
  コレクションオブジェクトに関連付けられたリソースを解放します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::getElem
type: function
doc:
<comment>Description:</comment>
  要素の値を返す
  
  インデックス <strong>$index</strong> (0 から始まる) を持つ要素の値を返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  要素のインデックス。最初のインデックスは 0 です。

<comment>Return:</comment>
  <info>string|float|null|false</info>  もし要素が存在しない場合 <info>false</info> 、要素が <info>null</info> 文字列なら <info>null</info> 、要素が文字
                           データ型なら文字列、 要素が数値フィールドなら数値を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::max
type: function
doc:
<comment>Description:</comment>
  コレクション内の要素の最大数を取得する
  
  コレクション内の要素の最大数を返します。

<comment>Return:</comment>
  <info>int|false</info>  コレクション内の要素の最大数、あるいはエラー時に <info>false</info> を返します。
             
             戻り値が 0 の場合、要素の数に制限はありません。

<comment>See Also:</comment>
   * 


id: OCICollection::size
type: function
doc:
<comment>Description:</comment>
  コレクションのサイズを返す
  
  コレクションのサイズを返します。

<comment>Return:</comment>
  <info>int|false</info>  コレクション内の要素の数、もしくはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCICollection::trim
type: function
doc:
<comment>Description:</comment>
  コレクションの最後から要素を切り取る
  
  コレクションの最後から <strong>$num</strong> 個の要素を切り取ります。

<comment>Param:</comment>
  <info>int</info>  <strong>$num</strong>  切り取る要素の数。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob
type: class
doc:
<comment>Description:</comment>
  ラージバイナリ (BLOB) および キャラクタオブジェクト (CLOB) に対する OCI8 ラージオブジェクト (LOB)
  機能です。
  
  <class>OCI-Lob</class> クラスは、 PHP 8 および PECL OCI8 3.0.0 以降、 PHP の名前付けの規約に従って <class>OCILob</class>に名前が
  変更されました。


id: OCILob::append
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトのデータを他のラージオブジェクトに追加する
  
  ラージオブジェクトのデータを他のラージオブジェクトに追加します。
  
  前もってバッファリングが有効になっている場合、 ラージオブジェクトの書き込みは失敗するでしょう。 追
  加の前にバッファリングを無効にしなければなりません。 バッファリングを無効にする前に、  によって
  バッファをフラッシュする必要があるかも知れません。

<comment>Param:</comment>
  <info>OCILob</info>  <strong>$from</strong>  コピーする LOB。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OCILob::close
type: function
doc:
<comment>Description:</comment>
  LOB ディスクリプタを閉じる
  
  LOB あるいは FILE のディスクリプタを閉じます。 この関数は  を併用した場合のみ使用されるべきです。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::eof
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトのディスクリプタが EOF かどうかを調べる
  
  ラージオブジェクトの内部ポインタが LOB の最後にあるかどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  もし、ラージオブジェクトの内部ポインタが LOB の最後にあるとき、 <info>true</info> を返します。その他の場
        合は <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::erase
type: function
doc:
<comment>Description:</comment>
  内部 LOB データの特定の位置を消去する
  
  指定された <strong>$offset</strong> から始まる内部 LOB データの特定の位置を消去します。 パラメータなしでコールする
  と、すべての LOB データを消去します。
  
  BLOB の場合、消去するということは存在する LOB の値が 0 バイトで上書きされる、ということを意味しま
  す。 CLOB の場合、存在する LOB の値はスペースで上書きされる、ということです。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$offset</strong>  
  <info>int|null</info>  <strong>$length</strong>  

<comment>Return:</comment>
  <info>int|false</info>  消去された実際の文字数あるいはバイト数、失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * 


id: OCILob::export
type: function
doc:
<comment>Description:</comment>
  LOB の内容をファイルに出力する
  
  LOB の内容をファイルに出力します。

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  ファイルへのパス。
  <info>int|null</info>  <strong>$offset</strong>    出力を開始する位置。
  <info>int|null</info>  <strong>$length</strong>    出力するデータの長さ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::flush
type: function
doc:
<comment>Description:</comment>
  LOB のバッファをサーバーにフラッシュする、あるいは書き込む
  
  <strong>OCILob::flush()</strong> は実際にサーバーにデータを書き込みます。

<comment>Param:</comment>
  <info>int</info>  <strong>$flag</strong>  デフォルトではリソースは解放されませんが、フラグ <info>OCI_LOB_BUFFER_FREE</info> を使用することで
              明示的に行うことができます。 あなたが何をしようとしているかを理解しておいてください -
              次に LOB の同じ箇所に読み書きしようとする場合、 サーバーへのラウンドトリップを伴い、
              新しいバッファリソースが初期化されるでしょう。 もはや LOB に対して何も行わない場合の
              み、 <info>OCI_LOB_BUFFER_FREE</info> フラグを使用することが推奨されます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。
        
        バッファリングが有効でない、あるいはエラーが発生した場合、 <info>false</info> を返します。

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


id: OCILob::free
type: function
doc:
<comment>Description:</comment>
  LOB ディスクリプタに関連付けられたりソースを解放する
  
  事前に <strong>oci_new_descriptor()</strong> を使用して割り当てられた ディスクリプタに関連付けられたりソースを解放
  します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: OCILob::getBuffering
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトに対する現在のバッファリングの状態を返す
  
  ラージオブジェクトに対するバッファリングが有効か無効かを調べます。

<comment>Return:</comment>
  <info>bool</info>  もしラージオブジェクトに対するバッファリングが無効な場合は <info>false</info>、 有効な場合は <info>true</info> を返し
        ます。

<comment>See Also:</comment>
   * 


id: OCILob::import
type: function
doc:
<comment>Description:</comment>
  ファイルデータを LOB にインポートする
  
  <strong>$filename</strong> からのデータをラージオブジェクトの現在の位置に書き込みます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルへのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OCILob::load
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトの内容を返す
  
  ラージオブジェクトの内容を返します。 memory_limit に達した場合、 スクリプトの実行が終了されますの
  で、 LOB がこの制限を超えないことを確認してください。 多くの場合、代わりに  を使用することが推奨さ
  れます。

<comment>Return:</comment>
  <info>string|false</info>  オブジェクトの内容、あるいはエラー時に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::read
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトの一部を読み込む
  
  LOB の内部ポインタの現在位置から <strong>$length</strong> バイト(BLOB) または、 <strong>$length</strong> 文字 (CLOB) を読み込みま
  す。
  
  現在の LOB の内部ポイントから、 <strong>$length</strong> バイト(BLOB) や <strong>$length</strong> 文字(CLOB) を読み取った場合、 ある
  いはラージオブジェクトの終わりに達したとき、読み込みを停止します。 ラージオブジェクトの内部ポイン
  タは、 読み込まれたバイト/文字数分だけシフトされます。

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  読み込むバイト数(BLOB) または文字数 (CLOB)。 大きな値を指定すると、1 MB に切り捨てら
                れます。

<comment>Return:</comment>
  <info>string|false</info>  読み込んだ内容を表す文字列、失敗した場合に <info>false</info> を返します

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


id: OCILob::rewind
type: function
doc:
<comment>Description:</comment>
  内部ポインタをラージオブジェクトの先頭に移動する
  
  内部ポインタをラージオブジェクトの先頭にセットします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OCILob::save
type: function
doc:
<comment>Description:</comment>
  データをラージオブジェクトに保存する
  
  <strong>$data</strong> をラージオブジェクトに保存します。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    保存するデータ。
  <info>int</info>     <strong>$offset</strong>  ラージオブジェクトの先頭からのオフセットを指定するために利用します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OCILob::saveFile
type: function
doc:
<comment>Description:</comment>
  のエイリアス OCILob::import
  
  この関数は次の関数のエイリアスです。  <strong>OCILob::import()</strong>


id: OCILob::seek
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトの内部ポインタをセットする
  
  ラージオブジェクトの内部ポインタをセットします。

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  内部ポインタを <strong>$whence</strong> で示された位置から移動させるバイト数を表します。
  <info>int</info>  <strong>$whence</strong>  以下のいずれかです。 <info>OCI_SEEK_SET</info> - <strong>$offset</strong> と等しい位置にセットします <info>OCI_SEEK_CUR</info>
                - 現在の位置に <strong>$offset</strong> バイト追加します <info>OCI_SEEK_END</info> - ラージオブジェクトの終端に
                <strong>$offset</strong> バイト追加します (ラージオブジェクトの終端より前の位置に移動するには負の値を
                指定します)

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: OCILob::setBuffering
type: function
doc:
<comment>Description:</comment>
  現在のラージオブジェクト用のバッファリング状態を変更する
  
  ラージオブジェクト用のバッファリングを <strong>$mode</strong> パラメータの値で設定します。
  
  この関数を使用することで、LOB の細かな読み込みや書き込みがバッファリングされことにより ネットワー
  クのラウンドトリップや LOB バージョニングの回数が低減され、 パフォーマンスが改善されます。
  <strong>OCILob::flush()</strong> はラージオブジェクトの処理が完了した際、 バッファをフラッシュするために使用しま
  す。

<comment>Param:</comment>
  <info>bool</info>  <strong>$mode</strong>  <info>true</info> は有効、<info>false</info> は無効を表します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。  同じフラグで繰り返しコールすると
        <info>true</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::size
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトのサイズを返す
  
  ラージオブジェクトのサイズを取得します。

<comment>Return:</comment>
  <info>int|false</info>  ラージオブジェクトのサイズを返します。 失敗した場合に <info>false</info> を返します。 空のオブジェク
             トは長さ 0 となります。


id: OCILob::tell
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトの内部ポインタの現在位置を返す
  
  LOB の内部ポインタの現在位置を取得します。

<comment>Return:</comment>
  <info>int|false</info>  LOB の内部ポインタの現在位置を返します。 エラーの場合、<info>false</info> を返します。

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


id: OCILob::truncate
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを切りつめる
  
  LOB を切りつめます。

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  指定した場合は、このメソッドはラージオブジェクトを <strong>$length</strong> バイトに切りつめます。 そ
                うでない場合は、LOB を完全に消去します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::write
type: function
doc:
<comment>Description:</comment>
  データをラージオブジェクトに書き込む
  
  パラメータ <strong>$data</strong> からのデータを LOB の内部ポインタの現在位置に書き込みます。

<comment>Param:</comment>
  <info>string</info>    <strong>$data</strong>    LOB に書き込むデータ。
  <info>int|null</info>  <strong>$length</strong>  このパラメータに整数を指定すると、 <strong>$length</strong> バイト書き込むか <strong>$data</strong> の終端に達す
                     るか、 いずれか早い方の後に書き込みが停止します。

<comment>Return:</comment>
  <info>int|false</info>  書き込んだバイト数、失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * 


id: OCILob::writeTemporary
type: function
doc:
<comment>Description:</comment>
  一時的なラージオブジェクトを書き込む
  
  一時的なラージオブジェクトを生成し、 <strong>$data</strong> を書き込みます。
  
  オブジェクトの使用後、 を使用するべきです。

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  書き込むデータ。
  <info>int</info>     <strong>$type</strong>  以下のいずれかです。 <info>OCI_TEMP_BLOB</info> が一時的な BLOB を生成するために使われます
                 <info>OCI_TEMP_CLOB</info> が一時的な CLOB を生成するために使われます

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 


id: OCILob::writeToFile
type: function
doc:
<comment>Description:</comment>
  のエイリアス OCILob::export
  
  この関数は次の関数のエイリアスです。 <strong>OCILob::export()</strong>.


id: OCI_ASSOC
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_fetch_all()</strong> と <strong>oci_fetch_array()</strong> で結果を連想配列で取得するために使います。


id: OCI_BOTH
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_fetch_all()</strong> と <strong>oci_fetch_array()</strong> で結果を配列と連想配列の両方で取得するために使います。


id: OCI_B_BOL
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_by_name()</strong> で PL/SQL の BOOLEAN 変数をバインドする場合に使います。


id: OCI_B_CURSOR
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_by_name()</strong> で <strong>oci_new_descriptor()</strong> によってあらかじめ割り当てられたカーソルをバインドする
  場合に使います。


id: OCI_B_INT
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で INTEGER の配列をバインドする場合に使います。


id: OCI_B_NUM
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_bind_array_by_name()</strong> で NUMBER の配列をバインドする場合に使います。


id: OCI_COMMIT_ON_SUCCESS
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_execute()</strong> のステートメント実行モード。 ステートメントが成功したときに、自動的に変更をコミット
  します。


id: OCI_CRED_EXT
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_connect()</strong> と組み合わせ、 Oracles の External 認証あるいは OS 認証を利用します。


id: OCI_DESCRIBE_ONLY
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_execute()</strong> のステートメント実行モード。 このモードをは、カラム名などのメタデータは欲しいけれど
  クエリから行を取得したくないという場合に使います。


id: OCI_DTYPE_FILE
type: constant
doc:
<comment>Description:</comment>
  このフラグは <strong>oci_new_descriptor()</strong> に新しい FILE ディスクリプタを初期化するように伝えます。


id: OCI_DTYPE_LOB
type: constant
doc:
<comment>Description:</comment>
  このフラグは <strong>oci_new_descriptor()</strong> に新しい LOB ディスクリプタを初期化するように伝えます。


id: OCI_DTYPE_ROWID
type: constant
doc:
<comment>Description:</comment>
  このフラグは <strong>oci_new_descriptor()</strong> に新しい ROWID ディスクリプタを初期化するように伝えます。


id: OCI_EXACT_FETCH
type: constant
doc:
<comment>Description:</comment>
  現在はサポートされていません。文の取得モードを指定します。 アプリケーションがあらかじめ何行取得す
  ればよいか分かっている場合に使います。 このモードは Oracle リリース 8 以降ではプリフェッチ機能をオ
  フにします。 カーソルは希望する行を取得した後キャンセルされ、 サーバー側のリソースの使用は軽減され
  ます。


id: OCI_NO_AUTO_COMMIT
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_execute()</strong> のステートメント実行モード。 このモードでは、トランザクションの自動コミットは行われ
  ません。 コードの可読性を考慮して、今までの <info>OCI_DEFAULT</info> ではなくこちらを使うようにしましょう。


id: OCI_NUM
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_fetch_all()</strong> と <strong>oci_fetch_array()</strong> で結果を配列で取得するために使います。


id: OCI_RETURN_LOBS
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_fetch_array()</strong> でディスクリプタの代わりに LOB の値を取得するために使います。


id: OCI_RETURN_NULLS
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_fetch_array()</strong> でフィールド値が <info>null</info> の場合に空の配列要素を取得するために使います。


id: OCI_SYSDBA
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_connect()</strong> で、SYSDBA として接続するために使います。 php.ini 設定 oci8.privileged_connect を有
  効にしないと使えません。


id: OCI_SYSOPER
type: constant
doc:
<comment>Description:</comment>
  <strong>oci_connect()</strong> で、SYSOPER として接続するために使います。 php.ini 設定 oci8.privileged_connect を有
  効にしないと使えません。


id: OPENSSL_ALGO_MD2
type: constant
doc:
<comment>Description:</comment>
  この定数が使えるのは PHP のコンパイル時に MD2 サポートを有効にした場合だけになりました。 MD2 サ
  ポートを有効にするには、PHP のコンパイル時に -DHAVE_OPENSSL_MD2_H CFLAG を渡し、かつ OpenSSL 1.0.0
  以降のコンパイル時に enable-md2 を指定する必要があります。


id: OPENSSL_ALGO_SHA1
type: constant
doc:
<comment>Description:</comment>
  <strong>openssl_sign()</strong> および <strong>openssl_verify()</strong> のデフォルトアルゴリズムとして用いられます。


id: OPENSSL_CMS_BINARY
type: constant
doc:
<comment>Description:</comment>
  通常、入力されるメッセージは 行末を <return>CR</return> と <return>LF</return> として用いる "canonical" フォーマットに変換されます:
  これは、CMS の仕様です。 このオプションが指定されると、変換は行われません。 これは、 CMS フォー
  マットではない可能性があるバイナリデータを扱うのに便利です。


id: OPENSSL_CMS_DETACHED
type: constant
doc:
<comment>Description:</comment>
  メッセージに署名する際、 MIMEタイプ <return>"multipart/signed"</return> を使って、 平文で署名します。 これは、
  <strong>openssl_cms_sign()</strong> で何も <strong>$flags</strong> を指定しなかったときのデフォルトの動作です。 このオプションを無効
  にした場合、メッセージは opaque 署名を使って署名されます。 これは、メールがリレーされる際の変換を
  防ぐ一方で、 S/MIME をサポートしていないエージェントでは読めなくなります。


id: OPENSSL_CMS_NOATTR
type: constant
doc:
<comment>Description:</comment>
  通常、メッセージが署名済みの場合、 署名した時刻やサポートされている共通鍵アルゴリズムの情報が含ま
  れる、 一連の属性情報が付加されます。 このオプションを使うと、その属性を含めないようにすることがで
  きます。


id: OPENSSL_CMS_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  メッセージに署名する場合、 通常は署名者の証明書がメッセージに付加されます - このオプションを使う
  と、その証明書を除去できます。 証明書を除去すると、署名済みのメッセージのサイズが減りますが、 (た
  とえば、<strong>openssl_cms_verify()</strong> 関数に <strong>$untrusted_certificates_filename</strong> を使って渡すなどして) 検証す
  る側が署名者の証明書をローカルに持っておく必要があります。


id: OPENSSL_CMS_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  メッセージを検証する際、 通常は(もしあれば)メッセージに含まれる証明書を 署名に用いた証明書として探
  します。 このオプションを使うと、 <strong>openssl_cms_verify()</strong> 関数の <strong>$untrusted_certificates_filename</strong> 引
  数で指定した証明書だけを検証に使うようになります。 ここで証明書を指定しても、 それは信頼されない証
  明書のまま引き続き使われます。


id: OPENSSL_CMS_OLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  PHP 8.3.0 以降で利用可能です。 メッセージを暗号化する場合に、content-type の値として
  <return>application/pkcs7-mime</return> ではなく <return>application/x-pkcs7-mime</return> を設定します。


id: OPENSSL_CMS_TEXT
type: constant
doc:
<comment>Description:</comment>
  暗号化済み/署名済み のメッセージに対して text/plain のヘッダを追加します。 復号化 または 検証する
  際に、これらのヘッダは出力から削除されます - もし 複号化済み/検証済み メッセージの MIMEタイプ が
  text/plain でない場合、エラーが発生します。


id: OPENSSL_RAW_DATA
type: constant
doc:
<comment>Description:</comment>
  <strong>openssl_encrypt()</strong> や <strong>openssl_decrypt()</strong> 関数で この値が設定されると、生のデータがそのまま返されま
  す。 設定されない場合、Base64 エンコードされたデータが呼び出し側に返されます。


id: OPENSSL_ZERO_PADDING
type: constant
doc:
<comment>Description:</comment>
  デフォルトでは、暗号化の操作は標準的なブロックパディングを使ってパディングされ、 追加されたパディ
  ングは、復号化される際にチェックされ、除去されます。 <strong>openssl_encrypt()</strong> や <strong>openssl_decrypt()</strong> の
  <strong>$options</strong> に <info>OPENSSL_ZERO_PADDING</info> が指定された場合、パディングは行われないので、 暗号化または復号化
  されるデータの総量はブロックサイズの倍数でなければなりません。 そうでない場合、エラーが発生しま
  す。


id: OpenSSLCertificate
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>OpenSSL X.509</return> リソースを置き換える完全不透明クラスです。


id: OpenSSLCertificateSigningRequest
type: class
doc:
<comment>Description:</comment>
  PHP 8.0.0 以降、 <return>OpenSSL X.509 CSR</return> リソースを置き換える完全不透明クラスです。


id: OuterIterator::getInnerIterator
type: function
doc:
<comment>Description:</comment>
  現在のエントリの内部イテレータを返す
  
  現在のイテレータエントリの内部イテレータを返します。

<comment>Return:</comment>
  <info>Iterator|null</info>  現在のエントリの内部イテレータが存在する場合、それを返します。 存在しない場合、<info>null</info>
                 を返します。


id: PASSWORD_ARGON2I
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2I</info> を使うと、 Argon2i アルゴリズムで新たなパスワードハッシュを作ります。
  
  サポートするオプション
  
  <return>memory_cost</return> (<info>int</info>) - Argon2 ハッシュの計算に用いるメモリの最大値 (キロバイト数) を設定します。 デ
  フォルトは <info>PASSWORD_ARGON2_DEFAULT_MEMORY_COST</info> です。
  
  <return>time_cost</return> (<info>int</info>) - Argon2 ハッシュの計算にかける時間の最大値を設定します。 デフォルトは
  <info>PASSWORD_ARGON2_DEFAULT_TIME_COST</info> です。
  
  <return>threads</return> (<info>int</info>) - Argon2 ハッシュの計算に用いるスレッド数を設定します。 デフォルトは
  <info>PASSWORD_ARGON2_DEFAULT_THREADS</info> です。 libargon2 を使う場合のみ利用可能で、 libsodium の実装には含
  まれていません。
  
  PHP 7.2.0 以降で利用可能です。


id: PASSWORD_ARGON2ID
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_ARGON2ID</info> を使うと、 Argon2id アルゴリズムで新たなパスワードハッシュを作ります。 サポート
  されるオプションは、 <info>PASSWORD_ARGON2I</info> と同じです。
  
  PHP 7.3.0 以降で利用可能です。


id: PASSWORD_ARGON2_DEFAULT_THREADS
type: constant
doc:
<comment>Description:</comment>
  Argon2lib が用いるデフォルトのスレッド数。 libsodium の実装では利用できません。
  
  PHP 7.2.0 以降で利用可能です。


id: PASSWORD_BCRYPT
type: constant
doc:
<comment>Description:</comment>
  <info>PASSWORD_BCRYPT</info> を使うと、 <info>CRYPT_BLOWFISH</info> アルゴリズムで新たなパスワードハッシュを作ります。
  
  これは常に、"$2y$" crypt フォーマットを使ったハッシュになります。 長さは常に 60 文字です。
  
  サポートするオプション
  
  <return>salt</return> (<info>string</info>) - パスワードのハッシュに使うソルトを手動で設定します。 これは、自動生成されたソルト
  を上書きすることに注意しましょう。
  
  省略した場合は、パスワードをハッシュするたびに <strong>password_hash()</strong> がランダムなソルトを自動生成しま
  す。これは意図したとおりの操作モードです。 および PHP 7.0.0 以降でソルト・オプションは非推奨になり
  ました。
  
  <return>cost</return> (<info>int</info>) - 利用するアルゴリズムのコストを表します。 値の例については <strong>crypt()</strong> のページを参照くだ
  さい。
  
  省略した場合のデフォルトは <return>10</return> です。この値でもかまいませんが、 ハードウェアの性能が許すならもう少
  し高くすることもできます。


id: PASSWORD_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  アルゴリズムを指定しなかったときのデフォルトとして使うアルゴリズム。 PHP のバージョンが上がるとき
  に、 その時点でより強力なハッシュアルゴリズムに対応していればデフォルトが変わる可能性があります。
  
  この定数の値は、今後変わる可能性がある (きっと変わる) ことに注意しましょう。 つまり、生成される
  ハッシュの長さも変わる可能性があるということです。 したがって、<info>PASSWORD_DEFAULT</info> を使う場合は、
  ハッシュの格納先は 60 文字以上でも格納できるようにしておく必要があります (255 文字程度にしておくこ
  とをおすすめします)。
  
  この定数の値
  
  PHP 5.5.0 - <info>PASSWORD_BCRYPT</info>


id: PCRE_VERSION
type: constant
doc:
<comment>Description:</comment>
  PCRE のバージョンおよびリリース日 (例: "<return>7.0 18-Dec-2006</return>")。
  
  5.2.4


id: PDO::ATTR_AUTOCOMMIT
type: constant
doc:
<comment>Description:</comment>
  この値が <info>false</info> の場合、PDO は接続がトランザクションを開始できるように オートコミットを無効にしよう
  とします。


id: PDO::ATTR_DEFAULT_STR_PARAM
type: constant
doc:
<comment>Description:</comment>
  デフォルトの文字列のパラメータタイプを設定します。 <info>PDO::PARAM_STR_NATL</info>  と <info>PDO::PARAM_STR_CHAR</info> の
  うち、いずれかひとつを選べます。
  
  PHP 7.2.0 以降で利用可能です。


id: PDO::ATTR_DRIVER_NAME
type: constant
doc:
<comment>Description:</comment>
  ドライバ名を返します。
  
  <info>PDO::ATTR_DRIVER_NAME</info> の使用例getAttribute(PDO::ATTR_DRIVER_NAME) == 'mysql') { echo "mysql 上で動
  作しています。何か mysql 固有のことをここで行います\n";
  }
  ?>
  ]]>


id: PDO::ATTR_PREFETCH
type: constant
doc:
<comment>Description:</comment>
  独自アプリケーションにおけるメモリ使用量に対する速度のバランスを 調整するためのプリフェッチサイズ
  を設定します。 全てのデータベースとドライバの組み合わせでプリフェッチサイズの設定を サポートしてい
  るわけではありません。


id: PDO::CURSOR_FWDONLY
type: constant
doc:
<comment>Description:</comment>
  前進のみ可能なカーソルを有する <class>PDOStatement</class> オブジェクトを生成します。 これにより、アプリケーショ
  ンの性能は改善しますが、 PDOStatementオブジェクトは前方にある結果セットから一度に一行を 取得すると
  いう制約を受けます。


id: PDO::CURSOR_SCROLL
type: constant
doc:
<comment>Description:</comment>
  スクローラブルカーソルを有する <class>PDOStatement</class> オブジェクトを作成します。 結果セットから取得した行を
  制御するための <return>PDO::FETCH_ORI_*</return> 定数を指定して ください。


id: PDO::ERRMODE_SILENT
type: constant
doc:
<comment>Description:</comment>
  エラー時にエラーもしくは例外を発生しません。 開発者の方は明示的にエラーをチェックするようにしてく
  ださい。 これはデフォルトのモードです。


id: PDO::ERR_NONE
type: constant
doc:
<comment>Description:</comment>
  SQLSTATE '00000' は SQL ステートメントがエラーや警告がなく発行に成功したことを意味します。 この定
  数はエラーが発生したかどうかを判別するために PDO::errorCode もしくは PDOStatement::errorCode を
  チェックする際に 便利です。この場合、通常はエラー状態を発生したメソッドからの戻りコードを 検査する
  ことによって検知します。


id: PDO::FETCH_ASSOC
type: constant
doc:
<comment>Description:</comment>
  結果セットの対応するカラム名にふられているものと同じキーを付けた 連想配列として各行を返す取得方法
  を指定します。 もし結果セットが複数のカラムを同名で含む場合、 <info>PDO::FETCH_ASSOC</info> はカラム名毎に 1 つ
  の値のみ返します。


id: PDO::FETCH_BOUND
type: constant
doc:
<comment>Description:</comment>
  結果セットのカラムの値を PDOStatement::bindParam または PDOStatement::bindColumn メソッドでバイン
  ドされた PHP変数に代入し、TRUEを返すという取得方法を指定します。


id: PDO::FETCH_CLASS
type: constant
doc:
<comment>Description:</comment>
  カラムをクラスのプロパティにマップしつつ、 指定されたクラスの新規インスタンスを返す取得方法を指定
  します。
  
  要求されたクラスにプロパティが存在しない場合は、マジックメソッド __set がコールされます。


id: PDO::FETCH_FUNC
type: constant
doc:
<comment>Description:</comment>
  データをその場で扱う方法を完全にカスタマイズできるようにします (PDOStatement::fetchAll の中でしか
  使えません)。


id: PDO::FETCH_GROUP
type: constant
doc:
<comment>Description:</comment>
  値で返すグループ。 <info>PDO::FETCH_COLUMN</info> あるいは <info>PDO::FETCH_KEY_PAIR</info> と組み合わせます。


id: PDO::FETCH_LAZY
type: constant
doc:
<comment>Description:</comment>
  取得する方法として、 結果セットが返すカラム名と同じ名前の変数を有するオブジェクトとして各行を返す
  方法を 指定します。 <info>PDO::FETCH_LAZY</info> は、アクセスされたものと同じ名前のオブジェクト変数を作成しま
  す。 PDOStatement::fetchAll の中では使えません。


id: PDO::FETCH_NAMED
type: constant
doc:
<comment>Description:</comment>
  結果セットの対応するカラム名にふられているものと同じキーを付けた 連想配列として各行を返す取得方法
  を指定します。 もし結果セットが複数のカラムを同名で含む場合、 <info>PDO::FETCH_NAMED</info> はカラム名毎に値の
  配列を返します。


id: PDO::FETCH_NUM
type: constant
doc:
<comment>Description:</comment>
  結果セットの対応するカラム番号にふられているものと同じ添字を付けた 配列として各行を返す取得方法を
  指定します。番号は0から始まります。


id: PDO::FETCH_ORI_REL
type: constant
doc:
<comment>Description:</comment>
  結果セットのカーソルの現在の位置を基準とする相対位置により指定された行を 取得します。スクローラブ
  ルなカーソルでのみ有効です。


id: PDO::FETCH_SERIALIZE
type: constant
doc:
<comment>Description:</comment>
  <info>PDO::FETCH_INTO</info> と同様ですが、 シリアライズした文字列としてオブジェクトを提供します。 このフラグを
  設定した場合はコンストラクタが呼ばれません。 PHP 8.1.0 以降は、この定数は推奨されなくなりました。


id: PDO::MYSQL_ATTR_INIT_COMMAND
type: constant
doc:
<comment>Description:</comment>
  MySQL サーバーへの接続時に実行するコマンドを指定します。 再接続の際には自動的に再実行されます。
  
  この定数を使うのは、新しいデータベースハンドルを作るときの <strong>$driver_options</strong> 配列内だけであることに
  注意しましょう。


id: PDO::MYSQL_ATTR_LOCAL_INFILE
type: constant
doc:
<comment>Description:</comment>
  <return>LOAD LOCAL INFILE</return> を有効にします。
  
  この定数を使うのは、新しいデータベースハンドルを作るときの <strong>$driver_options</strong> 配列内だけであることに
  注意しましょう。


id: PDO::MYSQL_ATTR_LOCAL_INFILE_DIRECTORY
type: constant
doc:
<comment>Description:</comment>
  LOCAL DATA 文によるファイルのロードを、 ここで指定したディレクトリに制限する機能を有効にします。
  PHP 8.1.0 以降で利用可能です。
  
  この定数を使うのは、新しいデータベースハンドルを作るときの <strong>$driver_options</strong> 配列内だけであることに
  注意しましょう。


id: PDO::MYSQL_ATTR_MAX_BUFFER_SIZE
type: constant
doc:
<comment>Description:</comment>
  バッファの最大サイズ。デフォルトは 1 MiB です。 mysqlnd を指定してコンパイルした場合は、この定数は
  サポートされていません。


id: PDO::MYSQL_ATTR_MULTI_STATEMENTS
type: constant
doc:
<comment>Description:</comment>
  <info>false</info> にすると、<strong>PDO::prepare()</strong> や <strong>PDO::query()</strong> でのマルチクエリの実行を無効にします。
  
  この定数が使えるのは、データベースハンドルを新規作成する際の <strong>$driver_options</strong> 配列内だけであること
  に注意しましょう。


id: PDO::MYSQL_ATTR_READ_DEFAULT_FILE
type: constant
doc:
<comment>Description:</comment>
  my.cnf ではなく、 指定した名前のファイルからオプションを読み込みます。 このオプションは、mysqlnd
  を使っている場合は利用できません。 mysqlnd は mysql の設定ファイルを読んでいないからです。


id: PDO::MYSQL_ATTR_READ_DEFAULT_GROUP
type: constant
doc:
<comment>Description:</comment>
  my.cnf あるいは 別のファイル (<info>MYSQL_READ_DEFAULT_FILE</info> で指定したもの) の中の、指定した名前のグルー
  プからオプションを読み込みます。 このオプションは、mysqlnd を使っている場合は利用できません。
  mysqlnd は mysql の設定ファイルを読んでいないからです。


id: PDO::MYSQL_ATTR_SSL_CIPHER
type: constant
doc:
<comment>Description:</comment>
  SSL 暗号化に使うひとつ以上の暗号の一覧。 OpenSSL で有効なフォーマットで指定します。 例:
  <return>DHE-RSA-AES256-SHA:AES128-SHA</return>


id: PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT
type: constant
doc:
<comment>Description:</comment>
  サーバーの SSL 証明書の検証を無効にする方法を提供します。
  
  これが使えるようになった PHP のバージョンは  7.0.18 および PHP 7.1.4.


id: PDO::MYSQL_ATTR_USE_BUFFERED_QUERY
type: constant
doc:
<comment>Description:</comment>
  デフォルトでは、全てのステートメントが バッファモード. で実行されます。 この値を <info>false</info> に設定する
  と、 <class>PDO</class> オブジェクトの場合、 MySQL ドライバは非バッファモードを使います。
  
  MySQL の非バッファモードを使うsetAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, false);
  $unbufferedResult = $pdo->query("SELECT Name FROM City");
  foreach ($unbufferedResult as $row) { echo $row['Name'] . PHP_EOL;
  }
  ?>
  ]]>


id: PDO::OCI_ATTR_ACTION
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the action on the database session.
  
  これが使えるようになった PHP のバージョンは  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_CLIENT_IDENTIFIER
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the client identifier on the database session.
  
  これが使えるようになった PHP のバージョンは  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_CLIENT_INFO
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the client info on the database session.
  
  これが使えるようになった PHP のバージョンは  7.2.16 and 7.3.3


id: PDO::OCI_ATTR_MODULE
type: constant
doc:
<comment>Description:</comment>
  Provides a way to specify the module on the database session.
  
  これが使えるようになった PHP のバージョンは  7.2.16 and 7.3.3


id: PDO::ODBC_ATTR_ASSUME_UTF8
type: constant
doc:
<comment>Description:</comment>
  Windows のみ有効です。 <info>true</info> の場合、UTF-16 でエンコードされた文字データ( <return>CHAR</return>, <return>VARCHAR</return>,
  <return>LONGVARCHAR</return>) を データベースから読み取ったり、書き込んだりする際に UTF-8 に変換します。 <info>false</info> の場
  合(デフォルト)、 エンコーディングの変換はドライバが行う可能性があります。


id: PDO::ODBC_ATTR_USE_CURSOR_LIBRARY
type: constant
doc:
<comment>Description:</comment>
  このオプションは、ODBC のカーソルライブラリが使うかを制御します。 ODBC カーソルライブラリは、ドラ
  イバが実装していない高度なODBCの機能 (例: スクロール可能なブロックカーソル) をいくつかサポートしま
  す。 サポートしている値は以下の通りです: <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (デフォルト): ODBC カーソルラ
  イブラリを必要な時に使います。 <info>PDO::ODBC_SQL_USE_DRIVER</info>: ODBC カーソルライブラリを使いません。
  <info>PDO::ODBC_SQL_USE_ODBC</info>: ODBC カーソルライブラリを常に使います。
  
  <info>PDO::ODBC_SQL_USE_IF_NEEDED</info> (デフォルト): ODBC カーソルライブラリを必要な時に使います。
  
  <info>PDO::ODBC_SQL_USE_DRIVER</info>: ODBC カーソルライブラリを使いません。
  
  <info>PDO::ODBC_SQL_USE_ODBC</info>: ODBC カーソルライブラリを常に使います。


id: PDO::PARAM_INPUT_OUTPUT
type: constant
doc:
<comment>Description:</comment>
  パラメータがストアドプロシージャ用の入力パラメータであることを指定します。 この値は、PDO::PARAM_*
  データ型とのビットORとして指定する必要があります。


id: PDO::PGSQL_ATTR_DISABLE_PREPARES
type: constant
doc:
<comment>Description:</comment>
  SQL文とパラメータを一緒に、一回のコールでサーバーに送信します。 これによって、名前付きのプリペアド
  ステートメントを別々に作ることを避けられます。 SQL文が一度しか実行されない場合、 不要なサーバーと
  の通信を避けられるので、レイテンシを抑えることができます。


id: PDO::SQLITE_DETERMINISTIC
type: constant
doc:
<comment>Description:</comment>
  PDO::sqliteCreateFunction で作られる関数が決定論的であることを指定します。 つまり、同じ入力が与え
  られると、単一のSQLステートメントの範疇では同じ結果が常に返されます。 (PHP 7.1.4 以降で使用可能で
  す)


id: PDO::SQLSRV_ATTR_DIRECT_QUERY
type: constant
doc:
<comment>Description:</comment>
  クエリを直接実行し、準備しないことを指示します。 この定数は、PDO::setAttribute および PDO::prepare
  に渡せます。詳細な情報は Direct and Prepared Statement Execution を参照ください。


id: PDO::SQLSRV_ATTR_QUERY_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  非負の整数で、タイムアウト秒数を指定します。ゼロがデフォルトで、これはタイムアウトしないことを意味
  します。 この定数は、PDOStatement::setAttribute、PDO::setAttribute および PDO::prepare に渡せま
  す。


id: PDO::SQLSRV_ENCODING_BINARY
type: constant
doc:
<comment>Description:</comment>
  サーバーとの間のデータの送受信を生のバイトストリームで行い、 符号化や変換を一切しないように指示し
  ます。 この定数は、 PDOStatement::setAttribute、PDO::prepare、PDOStatement::bindColumn および
  PDOStatement::bindParam に渡せます。


id: PDO::SQLSRV_ENCODING_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  サーバーとの間のデータの送受信を、接続時に指定した PDO::SQLSRV_ENCODING_SYSTEM に従って行います。
  プリペアドステートメントの中で指定された場合は、 その接続で設定されているエンコーディングを利用し
  ます。この定数は、 PDOStatement::setAttribute、PDO::setAttribute、PDO::prepare、
  PDOStatement::bindColumn および PDOStatement::bindParam に渡せます。


id: PDO::SQLSRV_ENCODING_SYSTEM
type: constant
doc:
<comment>Description:</comment>
  サーバーとの間のデータの送受信を 8 ビット文字として行い、 システムに設定された Windows のロケール
  のコードページを利用します。 このコードページにマップできない文字はすべて、シングルバイトのクエス
  チョンマークに置き換えられます。 この定数は、PDOStatement::setAttribute、PDO::setAttribute、
  PDO::prepare、 PDOStatement::bindColumn および PDOStatement::bindParam に渡せます。


id: PDO::SQLSRV_ENCODING_UTF8
type: constant
doc:
<comment>Description:</comment>
  サーバーとの間のデータの送受信を UTF-8 エンコーディングで行います。 これが、デフォルトの符号化方式
  です。この定数は、 PDOStatement::setAttribute、PDO::setAttribute、PDO::prepare、
  PDOStatement::bindColumn および PDOStatement::bindParam に渡せます。


id: PDO::SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  この定数は、SQLSRV DSN のキー TransactionIsolation で使えます。 この接続のトランザクション隔離レベ
  ルを、Read Committed に設定します。


id: PDO::SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  この定数は、SQLSRV DSN のキー TransactionIsolation で使えます。 この接続のトランザクション隔離レベ
  ルを、Read Uncommitted に設定します。


id: PDO::SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  この定数は、SQLSRV DSN のキー TransactionIsolation で使えます。 この接続のトランザクション隔離レベ
  ルを、Repeateable Read に設定します。


id: PDO::SQLSRV_TXN_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  この定数は、SQLSRV DSN のキー TransactionIsolation で使えます。 この接続のトランザクション隔離レベ
  ルを、Serializable に設定します。


id: PDO::SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  この定数は、SQLSRV DSN のキー TransactionIsolation で使えます。 この接続のトランザクション隔離レベ
  ルを、Snapshot に設定します。


id: PDO::__construct
type: function
doc:
<comment>Description:</comment>
  データベースへの接続を表す PDO インスタンスを生成する
    
  
  指定されたデータベースへの接続を表す PDO インスタンスを生成します。

<comment>Param:</comment>
  <info>string</info>       <strong>$dsn</strong>       データソース名(Data Source Name)またはDSN。データベースに接続するために 必
                          要な情報が含まれます。
                          
                          一般に、DSNはPDOドライバ名の後にコロンが続き、 各PDOドライバに固有の接続構
                          文が続きます。より多くの情報は PDO driver-specific documentation にありま
                          す。
                          
                          <strong>$dsn</strong> パラメータは、データベースへの接続を生成する ために必要な引数を指定す
                          る方法として、3種類の方法をサポートします。
                          
                          ドライバ呼び出し<strong>$dsn</strong> に完全な DSN を指定します。 URI 呼び出し<strong>$dsn</strong> は、uri:
                          の後に DSN 文字列を含むファイルの位置を定義する URI が続く形式となります。
                          この URI には、ローカルファイルまたはリモート URL を指定することができま
                          す。 uri:file:///path/to/dsnfileエイリアス<strong>$dsn</strong> は、DSN 文字列を定義する
                          php.ini の <return>pdo.dsn.name</return> へマップする名前 <strong>$name</strong> からなります。  エイリアス
                          は、.htaccess や httpd.conf ではなく、 php.ini で定義する必要があります。
                          
                          <strong>$dsn</strong> に完全な DSN を指定します。
                          
                          <strong>$dsn</strong> は、uri: の後に DSN 文字列を含むファイルの位置を定義する URI が続く形
                          式となります。 この URI には、ローカルファイルまたはリモート URL を指定す
                          ることができます。
                          
                          uri:file:///path/to/dsnfile
                          
                          <strong>$dsn</strong> は、DSN 文字列を定義する php.ini の <return>pdo.dsn.name</return> へマップする名前
                          <strong>$name</strong> からなります。
                          
                          エイリアスは、.htaccess や httpd.conf ではなく、 php.ini で定義する必要が
                          あります。
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> に完全な DSN を指定します。
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> は、uri: の後に DSN 文字列を含むファイルの位置を定義する URI が続く形
                          式となります。 この URI には、ローカルファイルまたはリモート URL を指定す
                          ることができます。
                          
                          uri:file:///path/to/dsnfile
  <info>string</info>       <strong>$dsn</strong>       <strong>$dsn</strong> は、DSN 文字列を定義する php.ini の <return>pdo.dsn.name</return> へマップする名前
                          <strong>$name</strong> からなります。
                          
                          エイリアスは、.htaccess や httpd.conf ではなく、 php.ini で定義する必要が
                          あります。
  <info>string|null</info>  <strong>$username</strong>  DSN 文字列のユーザー名。このパラメータは、いくつかの PDO ドライバではオプ
                          ションです。
  <info>string|null</info>  <strong>$password</strong>  DSN 文字列のパスワード。このパラメータは、いくつかの PDO ドライバではオプ
                          ションです。
  <info>array|null</info>   <strong>$options</strong>   ドライバ固有の接続オプションを指定するキー=&gt; 値の配列。


id: PDO::beginTransaction
type: function
doc:
<comment>Description:</comment>
  トランザクションを開始する
    
  
  オートコミットモードをオフにします。オートコミットモードがオフの間、 PDO オブジェクトを通じてデー
  タベースに加えた変更は PDO::commit をコールするまでコミットされません。 PDO::rollBack をコールする
  と、 データベースへの全ての変更をロールバックし、 オートコミットモードに設定された接続を返します。
  
  MySQL を含むいくつかのデータベースでは、DROP TABLE や CREATE TABLE のようなデータベース定義言語
  (DDL) ステートメントがトランザクション中に 発行される場合、暗黙的なコミットが自動的に発行されま
  す。 この暗黙的なコミットにより、そのトランザクション境界で 他のあらゆる変更をロールバックすること
  ができなくなるでしょう。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::commit
   * PDO::rollBack
   * トランザクションおよび自動コミット


id: PDO::commit
type: function
doc:
<comment>Description:</comment>
  トランザクションをコミットする
    
  
  トランザクションをコミットし、 次に PDO::beginTransaction で新たなトランザクションが開始されるま
  で、 データベース接続をオートコミットモードに戻します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::beginTransaction
   * PDO::rollBack
   * トランザクションおよび自動コミット


id: PDO::cubrid_schema
type: function
doc:
<comment>Description:</comment>
  指定したスキーマ情報を取得する
  
  指定したスキーマ情報をデータベースから取得します。 テーブルの情報を知りたい場合は <strong>$table_name</strong> を指
  定しなければなりません。また、 カラムの情報を知りたければ <strong>$col_name</strong> を指定しなければなりません
  (PDO::CUBRID_SCH_COL_PRIVILEGE とともにしか使えません)。
  
  この関数の返す結果は二次元の配列になります (column (associative array) * row (numeric array))。 次
  の表は、スキーマの型と戻り値の構造を示したものです。
  
  型ごとの戻り値の構造スキーマカラム番号カラム名値PDO::CUBRID_SCH_TABLE1NAME2TYPE0:システムテーブル
  1:ビュー 2:テーブルPDO::CUBRID_SCH_VIEW1NAME2TYPE1:ビュー
  PDO::CUBRID_SCH_QUERY_SPEC1QUERY_SPECPDO::CUBRID_SCH_ATTRIBUTE /
  PDO::CUBRID_SCH_TABLE_ATTRIBUTE1ATTR_NAME2DOMAIN3SCALE4PRECISION5INDEXED1:インデックス6NOT
  NULL1:not null7SHARED1:共有
  8UNIQUE1:unique9DEFAULT10ATTR_ORDERbase:111CLASS_NAME12SOURCE_CLASS13IS_KEY1:キー
  PDO::CUBRID_SCH_METHOD /
  PDO::CUBRID_SCH_TABLE_METHOD1NAME2RET_DOMAIN3ARG_DOMAINPDO::CUBRID_SCH_METHOD_FILE1METHOD_FILEPDO::CUBRID_SCH_SUPER_TABLE
  / PDO::CUBRID_SCH_DIRECT_SUPER_TABLE / PDO::CUBRID_SCH_SUB_TABLE1CLASS_NAME2TYPE0:システムテーブル
  1:ビュー 2:テーブルPDO::CUBRID_SCH_CONSTRAINT1TYPE0:unique 1:index 2:reverse unique 3:reverse
  index2NAME3ATTR_NAME4NUM_PAGES5NUM_KEYS6PRIMARY_KEY1:主キー
  7KEY_ORDERbase:1PDO::CUBRID_SCH_TRIGGER1NAME2STATUS3EVENT4TARGET_CLASS5TARGET_ATTR6ACTION_TIME7ACTION8PRIORITY9CONDITION_TIME10CONDITIONPDO::CUBRID_SCH_TABLE_PRIVILEGE
  / PDO::CUBRID_SCH_COL_PRIVILEGE1CLASS_NAME /
  ATTR_NAME2PRIVILEGE3GRANTABLEPDO::CUBRID_SCH_PRIMARY_KEY1CLASS_NAME2ATTR_NAME3KEY_SEQbase:14KEY_NAMEPDO::CUBRID_SCH_IMPORTED_KEYS
  / PDO::CUBRID_SCH_EXPORTED_KEYS /
  PDO::CUBRID_SCH_CROSS_REFERENCE1PKTABLE_NAME2PKCOLUMN_NAME3FKTABLE_NAMEbase:14FKCOLUMN_NAME5KEY_SEQbase:16UPDATE_ACTION0:cascade
  1:restrict 2:no action 3:set null7DELETE_ACTION0:cascade 1:restrict 2:no action 3:set
  null8FK_NAME9PK_NAME

<comment>Param:</comment>
  <info>int</info>     <strong>$schema_type</strong>  知りたいスキーマの型。
  <info>string</info>  <strong>$table_name</strong>   スキーマを知りたいテーブル。
  <info>string</info>  <strong>$col_name</strong>     スキーマを知りたいカラム。

<comment>Return:</comment>
  <info>array</info>  処理に成功すると、スキーマ情報を含む配列を返します。
         
         処理に失敗した場合は FALSE を返します。


id: PDO::errorCode
type: function
doc:
<comment>Description:</comment>
  データベースハンドラにおける直近の操作に関連する SQLSTATE を取得する

<comment>Return:</comment>
  <info>string|null</info>  SQLSTATE を返します。これは、ANSI SQL-92 標準で定義された英数 5 文字の ID です。簡潔
               に言えば、SQLSTATE は 2文字のクラス値の後に 3 文字のサブクラス値が続きます。クラス値
               01 はワーニングを表し、 戻り値のコード SQL_SUCCESS_WITH_INFO を伴います。 クラス 'IM'
               を除く '01' 以外のクラス値はエラーを表します。 クラス 'IM' は PDO 自身の実装 (もしく
               は ODBC ドライバを使用している場合は ODBC かも知れません) に由来するワーニングやエ
               ラーに固有の値です。 あらゆるクラスでのサブクラス値 '000' は SQLSTATE に対するサブク
               ラスがない事を示しています。
               
               PDO::errorCode はデータベースハンドラに 直接行った操作に対するエラーコードのみを取得
               します。 もし PDO::prepare や PDO::query を通して PDOStatement オブジェクトを生成し、
               文でエラーが発生した場合、PDO::errorCode はエラーを反映しません。 特定の文ハンドラに
               対して実行された操作についてのエラーコードを返すには PDOStatement::errorCode をコール
               しなければなりません。
               
               そのデータベースハンドル上で何も操作が行われていない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * PDO::errorInfo
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::errorInfo
type: function
doc:
<comment>Description:</comment>
  データベースハンドラにおける直近の操作に関連する拡張エラー情報を取得する

<comment>Return:</comment>
  <info>array</info>  PDO::errorInfo は、 このデータベースハンドラによって実行された直近の操作に関するエラー情報
         を 配列として返します。この配列は少なくとも次のフィールドを含みます。 要素情報0SQLSTATE エ
         ラーコード (これは、ANSI SQL 標準で定義された英数 5 文字の ID)1ドライバ固有のエラーコード
         2ドライバ固有のエラーメッセージ
         
         SQLSTATE エラーコードが設定されていない場合やドライバ固有のエラーがない場合は、 要素 0 に続
         く要素は <info>null</info> となります。
         
         PDO::errorInfo はデータベースハンドラに 直接行った操作に対するエラーコードのみを取得しま
         す。 もし PDO::prepare や PDO::query を通して PDOStatement オブジェクトを生成し、 文でエ
         ラーが発生した場合、PDO::errorInfo はそのエラーを反映しません。 特定の文ハンドラに対して実
         行された操作についてのエラーコードを返すには PDOStatement::errorInfo をコールしなければなり
         ません。

<comment>See Also:</comment>
   * PDO::errorCode
   * PDOStatement::errorCode
   * PDOStatement::errorInfo


id: PDO::exec
type: function
doc:
<comment>Description:</comment>
  SQL ステートメントを実行し、作用した行数を返す
    
  
  PDO::exec は、一度の関数コールで SQL 文を実行し、文によって作用した行数を返します。
  
  PDO::exec は SELECT 文からは結果を返しません。 プログラム中で一度だけ発行が必要になる SELECT 文に
  対しては、 PDO::query の発行を検討してください。 複数回発行が必要な文については、PDO::prepare によ
  る PDOStatement オブジェクトの準備と PDOStatement::execute による文の発行を行ってください。

<comment>Param:</comment>
  <info>string</info>  <strong>$statement</strong>  準備、実行する SQL ステートメントを指定します。
                      
                      クエリ内のデータは 適切にエスケープ する必要があります。

<comment>Return:</comment>
  <info>int|false</info>  PDO::exec は、発行した SQL ステートメントによって更新もしくは 削除された行数を返しま
             す。 1 行も作用しなかった場合、PDO::exec は <return>0</return> を返します。
             
             この関数は論理値
             <info>false</info> を返す可能性がありますが、<info>false</info> として評価される値を返す可能性もあります。
             詳細については 論理値の
             セクションを参照してください。この関数の返り値を調べるには
             ===演算子 を
             使用してください。
             
             以下の例は PDO::exec の戻り値の使用法を間違っています。結果として一行も更新されなかった
             場合に <strong>die()</strong> がコールされてしまうからです。 exec() or die(print_r($db->errorInfo(),
             true)); // 間違っている
             ?>
             ]]>

<comment>See Also:</comment>
   * PDO::prepare
   * PDO::query
   * PDOStatement::execute


id: PDO::getAttribute
type: function
doc:
<comment>Description:</comment>
  データベース接続の属性を取得する
    
  
  この関数はデータベース接続の属性値を返します。PDOStatement 属性を取得する場合、
  PDOStatement::getAttribute を参照ください。
  
  いくつかのデータベースもしくはドライバは、 データベース接続の属性の全てのをサポートしていないかも
  知れないことに 注意してください。

<comment>Param:</comment>
  <info>int</info>  <strong>$attribute</strong>  <return>PDO_ATTR_*</return> 定数の 1 つを指定します。 データベース接続に適用される一般的な属性は以
                   下の通りです。
                   <return>PDO::ATTR_AUTOCOMMIT</return><return>PDO::ATTR_CASE</return><return>PDO::ATTR_CLIENT_VERSION</return><return>PDO::ATTR_CONNECTION_STATUS</return><return>PDO::ATTR_DRIVER_NAME</return><return>PDO::ATTR_ERRMODE</return><return>PDO::ATTR_ORACLE_NULLS</return><return>PDO::ATTR_PERSISTENT</return><return>PDO::ATTR_PREFETCH</return><return>PDO::ATTR_SERVER_INFO</return><return>PDO::ATTR_SERVER_VERSION</return><return>PDO::ATTR_TIMEOUT</return>
                   
                   ドライバによっては、 そのドライバ固有の属性を使っているかもしれません。 そういう
                   属性は、他のドライバでは使っては いけない ことに注意して下さい。

<comment>Return:</comment>
  <info>mixed</info>  コールに成功した場合は要求された PDO 属性の値を返します。 コールに失敗した場合は <return>null</return> を返
         します。

<comment>See Also:</comment>
   * PDO::setAttribute
   * PDOStatement::getAttribute
   * PDOStatement::setAttribute


id: PDO::getAvailableDrivers
type: function
doc:
<comment>Description:</comment>
  利用可能な PDO ドライバの配列を返す
    
  
  この関数は、PDO::__construct の <strong>$DSN</strong> パラメータで利用可能な全ての有効な PDO ドライバを返します。

<comment>Return:</comment>
  <info>array</info>  PDO::getAvailableDrivers は PDO ドライバ名の配列を返します。 もしドライバが何も利用できない
         場合、空の配列を返します。


id: PDO::inTransaction
type: function
doc:
<comment>Description:</comment>
  トランザクション内かどうかを調べる
    
  
  ドライバ内で、現在トランザクションがアクティブになっているかどうかを調べます。 このメソッドが機能
  するのは、トランザクションをサポートしているデータベースドライバのみです。

<comment>Return:</comment>
  <info>bool</info>  トランザクションが現在アクティブな場合に <info>true</info>、 そうでないときに <info>false</info> を返します。


id: PDO::lastInsertId
type: function
doc:
<comment>Description:</comment>
  最後に挿入された行の ID あるいはシーケンスの値を返す
    
  
  最後に挿入された行の ID、 あるいはシーケンスオブジェクトから次の値をを返します。 これは、構成して
  いるドライバに依存します。例えば PDO_PGSQL の場合、<strong>$name</strong> パラメータにシーケンスオブジェクト名を指
  定することができます。
  
  このメソッドは、異なる PDO ドライバ間で意味のあるもしくは 一貫性のある結果を返さないかも知れませ
  ん。 構成しているデータベースが自動インクリメントフィールド、 もしくはシーケンスの概念をサポートし
  ていないかも知れないためです。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  ID が返されるべきシーケンスオブジェクト名を指定します。

<comment>Return:</comment>
  <info>string|false</info>  もし <strong>$name</strong> パラメータにシーケンス名が指定されなかった場合、 PDO::lastInsertId はデー
                タベースに挿入された最後の行の行IDに相当する文字列を返します。
                
                もし <strong>$name</strong> パラメータにシーケンス名が指定された場合、 PDO::lastInsertId は指定された
                シーケンスオブジェクトから取得した最後の値に相当する 文字列を返します。
                
                もし PDO ドライバがサポートしていない場合、 PDO::lastInsertId は <return>IM001</return> SQLSTATE を発
                生させます。


id: PDO::pgsqlCopyFromArray
type: function
doc:
<comment>Description:</comment>
  PHP の配列から、データをテーブルにコピーする
  
  <strong>$rows</strong> 配列からデータをテーブル <strong>$table_name</strong> にコピーします。 その際、<strong>$delimiter</strong> をフィールドのデリ
  ミタ、そして <strong>$fields</strong> のリストを使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  テーブル名を含む文字列
  <info>array</info>   <strong>$rows</strong>        <strong>$delimiter</strong> で区切られたフィールドの文字列の配列
  <info>string</info>  <strong>$delimiter</strong>   <strong>$rows</strong> 配列で使われているデリミタ
  <info>string</info>  <strong>$null_as</strong>     どのように null 値を扱うかを指定します
  <info>string</info>  <strong>$fields</strong>      挿入するフィールドの一覧

<comment>Return:</comment>
  <info>bool</info>  成功したら <info>true</info> を返します。 失敗した場合に <info>false</info> を返します


id: PDO::pgsqlCopyFromFile
type: function
doc:
<comment>Description:</comment>
  ファイルからデータをテーブルにコピーする
  
  <strong>$filename</strong> で指定されたファイルからデータをテーブル <strong>$table_name</strong> にコピーします。 その際、<strong>$delimiter</strong>
  をフィールドのデリミタ、そして <strong>$fields</strong> のリストを使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  テーブル名を含む文字列
  <info>string</info>  <strong>$filename</strong>    インポートするデータを含むファイル名
  <info>string</info>  <strong>$delimiter</strong>   <strong>$filename</strong> で指定されたファイルで使われているデリミタ
  <info>string</info>  <strong>$null_as</strong>     どのように null 値を扱うかを指定します
  <info>string</info>  <strong>$fields</strong>      挿入するフィールドの一覧

<comment>Return:</comment>
  <info>bool</info>  成功したら <info>true</info> を返します。 失敗した場合に <info>false</info> を返します


id: PDO::pgsqlCopyToArray
type: function
doc:
<comment>Description:</comment>
  データベーステーブルからのデータをPHPの配列にコピーする
  
  <strong>$table</strong> からのデータを配列にコピーします。 その際、<strong>$delimiter</strong> をフィールドのデリミタ、そして
  <strong>$fields</strong> のリストを使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  テーブル名を含む文字列
  <info>string</info>  <strong>$delimiter</strong>   列で使われるデリミタ
  <info>string</info>  <strong>$null_as</strong>     どのように null 値を扱うかを指定します
  <info>string</info>  <strong>$fields</strong>      エクスポートするフィールドの一覧

<comment>Return:</comment>
  <info>array|false</info>  行の配列を返します。 失敗した場合に <info>false</info> を返します


id: PDO::pgsqlCopyToFile
type: function
doc:
<comment>Description:</comment>
  テーブルからのデータをファイルにコピーする
  
  <strong>$filename</strong> で指定されたファイルに、テーブルからデータをコピーします。 その際、<strong>$delimiter</strong> をフィール
  ドのデリミタ、そして <strong>$fields</strong> のリストを使います。

<comment>Param:</comment>
  <info>string</info>  <strong>$table_name</strong>  テーブル名を含む文字列
  <info>string</info>  <strong>$filename</strong>    エキスポートするファイル名
  <info>string</info>  <strong>$delimiter</strong>   <strong>$filename</strong> で指定されたファイルで使われているデリミタ
  <info>string</info>  <strong>$null_as</strong>     どのように null 値を扱うかを指定します
  <info>string</info>  <strong>$fields</strong>      挿入するフィールドの一覧

<comment>Return:</comment>
  <info>bool</info>  成功したら <info>true</info> を返します。 失敗した場合に <info>false</info> を返します


id: PDO::pgsqlGetNotify
type: function
doc:
<comment>Description:</comment>
  非同期に通知を取得する
  
  保留中の非同期な通知を示す結果セットを返します。

<comment>Param:</comment>
  <info>int</info>  <strong>$result_type</strong>  結果セットを返すフォーマット。 <info>PDO::FETCH_*</info> 定数で表現します。
  <info>int</info>  <strong>$ms_timeout</strong>   レスポンスを待つ時間の長さ。ミリ秒で指定します。

<comment>Return:</comment>
  <info>array|false</info>  ひとつ以上の通知が保留中だった場合、 <return>message</return> と <return>pid</return> のフィールドが入った一行を返しま
               す。 そうでなければ <info>false</info> を返します。


id: PDO::pgsqlGetPid
type: function
doc:
<comment>Description:</comment>
  サーバーのPIDを取得する
  
  サーバーのPIDを返します。

<comment>Return:</comment>
  <info>int</info>  サーバーのPIDを返します。


id: PDO::pgsqlLOBCreate
type: function
doc:
<comment>Description:</comment>
  新しいラージオブジェクトを作成する
  
  <strong>PDO::pgsqlLOBCreate()</strong> は、 ラージオブジェクトを作成してその OID を返します。 このオブジェクトに対
  するデータの読み書きを行う際には、 <strong>PDO::pgsqlLOBOpen()</strong> を使用してストリームをオープンします。 OID
  は OID 型のカラムに格納され、ラージオブジェクトを参照するために使用されます。 これにより、行のサイ
  ズがどんどん拡大してしまうことを防ぎます。 <strong>PDO::pgsqlLOBUnlink()</strong> をコールして削除するまで、 ラージ
  オブジェクトはデータベース内に残り続けます。
  
  ラージオブジェクトの大きさは最大 2GB まで拡大できますが、扱い方はめんどうです。 オブジェクトの OID
  を参照している行をデータベースから削除する際には、 必ず事前に <strong>PDO::pgsqlLOBUnlink()</strong> がコールされて
  いなければなりません。 さらに、ラージオブジェクトにはアクセス権の設定がありません。 ラージオブジェ
  クトの代替策として、bytea 型のカラムも検討ください。 最近のバージョンの PostgreSQL では bytea 型の
  カラムに最大 1GB まで保存でき、行サイズを最適化したうえでデータを透過的に扱うことができます。
  
  この関数は、トランザクション内でコールしなければなりません。

<comment>Return:</comment>
  <info>string</info>  新しく作成されたラージオブジェクトの OID、あるいは失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_create()</strong>


id: PDO::pgsqlLOBOpen
type: function
doc:
<comment>Description:</comment>
  既存のラージオブジェクトのストリームをオープンする
  
  <strong>PDO::pgsqlLOBOpen()</strong> は、<strong>$oid</strong> が指すデータにアクセスするためのストリームをオープンします。 <strong>$mode</strong> が
  <return>r</return> の場合、 ストリームは読み込み用にオープンされます。 <strong>$mode</strong> が <return>w</return> の場合、 ストリームは書き込み用に
  オープンされます。 <strong>fread()</strong>、<strong>fwrite()</strong> および <strong>fgets()</strong> のような通常のファイルシステム関数を使用して、
  ストリームの内容を操作することができます。
  
  この関数およびラージオブジェクトに対するすべての操作は、 トランザクション内で処理される必要があり
  ます。

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>   ラージオブジェクトの ID。
  <info>string</info>  <strong>$mode</strong>  モードが <return>r</return> の場合、読み込み用のストリームをオープンします。 モードが <return>w</return> の場合、書き
                 込み用のストリームをオープンします。

<comment>Return:</comment>
  <info>resource|false</info>  成功した場合にストリームリソース、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBCreate()</strong>
   * <strong>PDO::pgsqlLOBUnlink()</strong>
   * <strong>pg_lo_open()</strong>


id: PDO::pgsqlLOBUnlink
type: function
doc:
<comment>Description:</comment>
  ラージオブジェクトを削除する
  
  OID が指すラージオブジェクトをデータベースから削除します。
  
  この関数は、トランザクション内でコールしなければなりません。

<comment>Param:</comment>
  <info>string</info>  <strong>$oid</strong>  ラージオブジェクトの ID。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PDO::pgsqlLOBOpen()</strong>
   * <strong>PDO::pgsqlLOBCreate()</strong>


id: PDO::prepare
type: function
doc:
<comment>Description:</comment>
  文を実行する準備を行い、文オブジェクトを返す
    
  
  PDOStatement::execute メソッドによって実行される SQL ステートメントを準備します。 ステートメントの
  テンプレートは、文が実行されるときに実際の値に置き換えられる 0 個もしくはそれ以上の名前 (:name) も
  しくは疑問符 (?) パラメータマークを含むことができます。 名前と疑問符パラメータを同一の ステートメ
  ントのテンプレート中で使用することはできません。 どちらか一方か、他のパラメータ形式を使用してくだ
  さい。 ユーザーの入力をバインドする際にはこれらのパラメータを使います。 ユーザーの入力を直接クエリ
  に含めてはいけません。
  
  PDOStatement::execute をコールする際には、 文に渡すパラメータにはそれぞれ固有のパラメータマークを
  設定する必要があります。 エミュレーションモードが有効になっていない限り、 ひとつのプリペアドステー
  トメントの中で、同じ名前のパラメータマークを 複数使用することはできません。
  
  パラメータマーカーが表せるのは、データリテラルだけです。 リテラルの一部やキーワード、識別子、その
  他のクエリのパーツをパラメータにバインドすることはできません。 たとえば、SQL 文の IN() 句などで、
  ひとつのパラメータに複数の値を割り当てることはできません。
  
  異なるパラメータを用いて複数回実行されるような文に対し PDO::prepare と PDOStatement::execute を
  コールすることで、 ドライバがクライアントまたはサーバー側にクエリプランやメタ情報を キャッシュさせ
  るよう調整するため、 アプリケーションのパフォーマンスを最適化します。また、 パラメータに手動でク
  オートする必要がなくなるので SQL インジェクション攻撃から保護する助けになります。
  
  PDO は元々この機能をサポートしていないドライバに対して プリペアドステートメントとバインドパラメー
  タをエミュレートします。 このため、ある形式をサポートしているがその他の形式をサポートしていない ド
  ライバの場合、名前もしくは疑問符形式のパラメータを他の適当な値に 書き換えることも可能です。
  
  エミュレートされたプリペアドステートメントと、 名前パラメータやクエスチョンマークを書き換えるパー
  サは、[シングル|ダブル]クォート に対して標準とは異なるエスケープをサポートしています。 これによっ
  て、バックスラッシュのすぐ後にクォートで終了するクエリは そのままの形では認識されず、間違ったパラ
  メータとして認識され、 実行されたときにプリペアドステートメントが失敗してしまいます。 回避策は、プ
  リペアドステートメントのエミュレートをこの手のSQLクエリでは使わないようにしつつ、 ドライバによって
  サポートされているパラメータの書き換えを避けることです。
  
  PHP 7.4.0 以降では、クエスチョンマークを2回続けることで、 クエスチョンマークそのものをエスケープす
  ることができます。 これは、<return>??</return> という文字列が、 クエリをデータベースに送信する時に <return>?</return> に変換されると
  いうことです。

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>    これは対象のデータベースサーバーに対して有効な SQL 文のテンプレートでなければな
                    りません。
  <info>array</info>   <strong>$options</strong>  この配列は、このメソッドによって返される PDOStatement オブジェクトに対して 1 も
                    しくはそれ以上の key=&gt;value の組を含みます。 通常、スクロール可能なカーソルを
                    要求するために <return>PDO::ATTR_CURSOR</return> に <return>PDO::CURSOR_SCROLL</return> を設定する場合に使用するこ
                    とになるでしょう。 いくつかのドライバには、準備する際に利用可能なドライバ固有の
                    オプションがあります。

<comment>Return:</comment>
  <info>PDOStatement|false</info>  もしデータベースサーバーが正常に文を準備する場合、 PDO::prepare は
                      <class>PDOStatement</class> オブジェクトを返します。 もしデータベースサーバーが文を準備できな
                      かった場合、 PDO::prepare は <info>false</info> を返すか <class>PDOException</class> を発行します (エラー
                      処理 の方法に依存します)。
                      
                      プリペアドステートメントをエミュレートする際にデータベースサーバーとの通信は行
                      いません。 したがって PDO::prepare はステートメントのチェックを行いません。

<comment>See Also:</comment>
   * PDO::exec
   * PDO::query
   * PDOStatement::execute


id: PDO::query
type: function
doc:
<comment>Description:</comment>
  プレースホルダを指定せずに、SQL ステートメントを準備して実行する
    
  
  PDO::query は、一回の関数コールの中で SQL ステートメントを準備して実行し、 結果を <class>PDOStatement</class> オ
  ブジェクトとして返します。
  
  複数回発行する必要があるステートメントの場合、 PDO::prepare で <class>PDOStatement</class> ステートメントを準備
  し、 PDOStatement::execute でそのステートメントを 複数回発行する方がより良いパフォーマンスを得られ
  ると実感するでしょう。
  
  PDO::query を次にコールする前に 結果セット内の全てのデータを取得しない場合、そのコールは失敗しま
  す。 PDOStatement::closeCursor をコールし、 次に PDO::query をコールする前に <class>PDOStatement</class> オブジェ
  クトに関連付けられたリソースを解放してください。
  
  <strong>$query</strong> にプレースホルダーが含まれている場合、 準備と実行は別々に行う必要があります。 つまり、
  PDO::prepare を使って準備し、 PDOStatement::execute を実行しなければいけません。

<comment>Param:</comment>
  <info>string</info>    <strong>$query</strong>      準備、発行する SQL ステートメント。
                        
                        SQL にプレースホルダーが含まれている場合、 PDO::prepare と
                        PDOStatement::execute を代わりに使う必要があります。 それとは別のやり方とし
                        て、 PDO::query を呼び出す前に、 PDO::quote を使って適切にフォーマットした
                        データを使って SQL文を手動で準備することができます。 但し、PDO::quote は、ド
                        ライバがサポートしている場合に限り使えます。
  <info>int|null</info>  <strong>$fetchMode</strong>  返される <class>PDOStatement</class> のためのデフォルトのフェッチモード。 定数 <return>PDO::FETCH_*</return>
                        のうちのひとつを設定しなければいけません。
                        
                        この引数を渡すと、残りの引数は、 結果のステートメントオブジェクトに対して、
                        PDOStatement::setFetchMode を呼び出したのと同じような扱いになります。 残りの
                        引数は、選択するフェッチモードに応じて変化します。

<comment>Return:</comment>
  <info>PDOStatement|false</info>  <class>PDOStatement</class> オブジェクトを返します。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * PDO::exec
   * PDO::prepare
   * PDOStatement::execute


id: PDO::quote
type: function
doc:
<comment>Description:</comment>
  クエリ用の文字列をクオートする
    
  
  PDO::quote は入力文字列のまわりに引用符を付け (必要であれば) 、 入力文字列にあるシングルクオートを
  エスケープします。その場合、 構成しているドライバに適したクオート形式が使用されます。
  
  この関数を SQL の構築に使用する場合、 SQL ステートメントにユーザーの入力値を埋め込むための
  PDO::quote を使用する代わりに、 バインドパラメータを用いて SQL を準備するための PDO::prepare を使
  用することが強く推奨されます。 バインドパラメータを用いるプリペアドステートメントは、 補間されたク
  エリした場合に比べ、 移植性や利便性に優れ、SQL インジェクションに対する免疫力を持つだけでなく しば
  しばより高速で、サーバーやクライアント側でコンパイル済みの形式でクエリを キャッシュする事が可能で
  す。
  
  全ての PDO ドライバがこのメソッドを実装しているわけではありません (たとえば PDO_ODBC などの例があ
  ります)。 代わりにプリペアドステートメントを使用することを検討してください。
  
  サーバーレベルで設定するなりデータベース接続自身に設定させる (ドライバに依存します) なりして、 文
  字セットを明示しておく必要があります。この文字セットが PDO::quote に影響を及ぼします。詳細は  各ド
  ライバのドキュメント を参照ください。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  クオートされる文字列を指定します。
  <info>int</info>     <strong>$type</strong>    クオートするスタイルを変更するため、 ドライバにデータ型のヒントを提供します。 た
                   とえば <info>PDO_PARAM_LOB</info> は、 ドライバにバイナリデータをエスケープするように伝えま
                   す。

<comment>Return:</comment>
  <info>string|false</info>  理論上安全なクオートされた SQL ステートメントの文字列を返します。 ドライバがこの方法
                での引用符付けをサポートしていない場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute


id: PDO::rollBack
type: function
doc:
<comment>Description:</comment>
  トランザクションをロールバックする
    
  
  PDO::beginTransaction によって開始された 現在のトランザクションをロールバックします。
  
  データベースがオートコミットモードに設定されている場合、 この関数はトランザクションをロールバック
  した後に オートコミットモードを元に戻します。
  
  MySQL を含むいくつかのデータベースでは、DROP TABLE や CREATE TABLE のようなデータベース定義言語
  (DDL) ステートメントがトランザクション中に 発行される場合、暗黙的なコミットが自動的に発行されま
  す。 この暗黙的なコミットにより、そのトランザクション境界で 他のあらゆる変更をロールバックすること
  ができなくなるでしょう。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::beginTransaction
   * PDO::commit
   * トランザクションおよび自動コミット


id: PDO::setAttribute
type: function
doc:
<comment>Description:</comment>
  属性を設定する
    
  
  データベースハンドルの属性を設定します。 利用可能な通常の属性は以下の通りです。いくつかのドライバ
  では、 ドライバ固有の属性を使用することが可能です。 ドライバ固有の属性は、 他のドライバでは使って
  は いけない ことに注意して下さい。 <info>PDO::ATTR_CASE</info> 強制的にカラム名を指定したケースにします。 以下
  の値のうち、ひとつを指定できます: <info>PDO::CASE_LOWER</info> 強制的にカラム名を小文字にする。
  <info>PDO::CASE_NATURAL</info> データベースドライバによって返されるカラム名をそのままにする。 <info>PDO::CASE_UPPER</info>
  強制的にカラム名を大文字にする。 <info>PDO::ATTR_ERRMODE</info> PDO のエラーレポートモード。 以下の値のうち、ひ
  とつを指定できます: <info>PDO::ERRMODE_SILENT</info> エラーコードのみを設定する。 <info>PDO::ERRMODE_WARNING</info><info>E_WARNING</info>
  を発生させる。 <info>PDO::ERRMODE_EXCEPTION</info><class>PDOException</class> をスローします。 <info>PDO::ATTR_ORACLE_NULLS</info> この属性
  は Oracle だけでなく、全てのドライバで利用可能です。 <info>null</info> と空文字列を変換するかどうか、 および、
  どのように変換するかを指定します。 以下の値のうち、ひとつを指定できます: <info>PDO::NULL_NATURAL</info> 変換を
  行わない。 <info>PDO::NULL_EMPTY_STRING</info> 空文字列を <info>null</info> に変換する。 <info>PDO::NULL_TO_STRING</info><info>null</info> を空文字列
  に変換する。 <info>PDO::ATTR_STRINGIFY_FETCHES</info> フェッチする際、数値を文字列に変換するかどうかを指定しま
  す。 <info>bool</info> の値を指定します: 変換を有効にする場合 <info>true</info>、 無効にする場合、<info>false</info> にします。
  <info>PDO::ATTR_STATEMENT_CLASS</info> PDOStatement から派生した、 ユーザーが提供するステートメントクラスを設定
  する。 <return>array(string classname, array(mixed constructor_args))</return> の形式でなければいけません。  永続的
  な PDO インスタンスは使用できません。 <info>PDO::ATTR_TIMEOUT</info> タイムアウト秒数を指定します。 数値を指定
  します。  すべてのドライバがこのオプションに対応しているわけではありません。 また、ドライバによっ
  ては意味が異なることがあります。 たとえば SQLite は書き込み可能なロックを確保するのをこの秒数まで
  待ち続けますが、 他のドライバでは、 この秒数を接続時のタイムアウトや読み込みのタイムアウトとして扱
  うことがあります。 <info>PDO::ATTR_AUTOCOMMIT</info> OCI, Firebird, MySQL でのみ利用可能です。  それぞれの単一
  文で自動コミットするかどうか。 <info>bool</info> の値を指定します: 自動コミットを有効にする場合 <info>true</info>、 無効にす
  る場合、<info>false</info> にします。 デフォルトは <info>true</info> です。 <info>PDO::ATTR_EMULATE_PREPARES</info> OCI, Firebird, MySQL
  でのみ利用可能です。  プリペアドステートメントのエミュレーションを有効または無効にします。 ドライ
  バによっては、 ネイティブのプリペアドステートメントをサポートしていなかったり 完全には対応していな
  かったりするものがあります。 <info>true</info> を指定すると、 プリペアドステートメントを常にエミュレートしま
  す。 そうでない場合、 ネイティブのプリペアドステートメントを使おうとします。 ドライバが現在のクエ
  リを正しく準備できなかった場合は、 常にエミュレート方式を使います。
  <info>PDO::MYSQL_ATTR_USE_BUFFERED_QUERY</info> MySQL でのみ利用可能です。  バッファされたクエリを使うかどうか
  を指定します。 <info>bool</info> の値を指定します: バッファされたクエリを有効にする場合 <info>true</info>、 無効にする場合、
  <info>false</info> にします。 デフォルトは <info>true</info> です。 <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> デフォルトのフェッチモード
  を設定します。 このモードと使い方についての説明は、 PDOStatement::fetch のドキュメントを参照くださ
  い。
  
  強制的にカラム名を指定したケースにします。 以下の値のうち、ひとつを指定できます:
  
  強制的にカラム名を小文字にする。
  
  データベースドライバによって返されるカラム名をそのままにする。
  
  強制的にカラム名を大文字にする。
  
  PDO のエラーレポートモード。 以下の値のうち、ひとつを指定できます:
  
  エラーコードのみを設定する。
  
  <info>E_WARNING</info> を発生させる。
  
  <class>PDOException</class> をスローします。
  
  この属性は Oracle だけでなく、全てのドライバで利用可能です。
  
  <info>null</info> と空文字列を変換するかどうか、 および、どのように変換するかを指定します。 以下の値のうち、ひ
  とつを指定できます:
  
  変換を行わない。
  
  空文字列を <info>null</info> に変換する。
  
  <info>null</info> を空文字列に変換する。
  
  フェッチする際、数値を文字列に変換するかどうかを指定します。 <info>bool</info> の値を指定します: 変換を有効にす
  る場合 <info>true</info>、 無効にする場合、<info>false</info> にします。
  
  PDOStatement から派生した、 ユーザーが提供するステートメントクラスを設定する。 <return>array(string
  classname, array(mixed constructor_args))</return> の形式でなければいけません。
  
  永続的な PDO インスタンスは使用できません。
  
  タイムアウト秒数を指定します。 数値を指定します。
  
  すべてのドライバがこのオプションに対応しているわけではありません。 また、ドライバによっては意味が
  異なることがあります。 たとえば SQLite は書き込み可能なロックを確保するのをこの秒数まで待ち続けま
  すが、 他のドライバでは、 この秒数を接続時のタイムアウトや読み込みのタイムアウトとして扱うことがあ
  ります。
  
  OCI, Firebird, MySQL でのみ利用可能です。
  
  それぞれの単一文で自動コミットするかどうか。 <info>bool</info> の値を指定します: 自動コミットを有効にする場合
  <info>true</info>、 無効にする場合、<info>false</info> にします。 デフォルトは <info>true</info> です。
  
  OCI, Firebird, MySQL でのみ利用可能です。
  
  プリペアドステートメントのエミュレーションを有効または無効にします。 ドライバによっては、 ネイティ
  ブのプリペアドステートメントをサポートしていなかったり 完全には対応していなかったりするものがあり
  ます。 <info>true</info> を指定すると、 プリペアドステートメントを常にエミュレートします。 そうでない場合、 ネ
  イティブのプリペアドステートメントを使おうとします。 ドライバが現在のクエリを正しく準備できなかっ
  た場合は、 常にエミュレート方式を使います。
  
  MySQL でのみ利用可能です。
  
  バッファされたクエリを使うかどうかを指定します。 <info>bool</info> の値を指定します: バッファされたクエリを有効
  にする場合 <info>true</info>、 無効にする場合、<info>false</info> にします。 デフォルトは <info>true</info> です。
  
  デフォルトのフェッチモードを設定します。 このモードと使い方についての説明は、 PDOStatement::fetch
  のドキュメントを参照ください。

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  変更する属性。
  <info>mixed</info>  <strong>$value</strong>      <strong>$attribute</strong> に設定する値。 属性によっては、特定の型が必要かもしれません。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDOStatement::getAttribute
   * PDOStatement::setAttribute


id: PDO::sqliteCreateAggregate
type: function
doc:
<comment>Description:</comment>
  SQL 文で使用する集約ユーザー定義関数 (UDF) を登録する
    
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  このメソッドは  と似ていますが、 この関数で登録した関数は、クエリのすべての行の内容を集約する関数
  を登録します。
  
  この関数と  の最大の違いは、 集約関数を作成するためには 2 つの関数が必要であるということです。

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  SQL 文で使用する関数の名前。
  <info>callable</info>  <strong>$step_func</strong>      結果セットの各行についてコールされるコールバック関数。 この PHP 関数は、
                            結果を蓄積して集約コンテキストに保存しなければなりません。
                            
                            この関数は次のように定義しなければなりません。
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong> 最初
                            の行では <info>null</info>  二行目以降では、ステップ関数から以前返された値を持ちま
                            す。 この値を、集約の状態を管理するのに使うべきです。 <strong>$rownumber</strong> 現在の
                            行番号 <strong>$value</strong> 集約関数に渡されるはじめの引数 <strong>$values</strong> 集約関数に渡される
                            ふたつめ以降の引数  この関数の戻り値を、次のステップあるいはファイナライ
                            ズ関数の <strong>$context</strong> 引数として使います。
                            
                            最初の行では <info>null</info>  二行目以降では、ステップ関数から以前返された値を持ち
                            ます。 この値を、集約の状態を管理するのに使うべきです。
                            
                            現在の行番号
                            
                            集約関数に渡されるはじめの引数
                            
                            集約関数に渡されるふたつめ以降の引数
  <info>mixed</info>     <strong>$context</strong>        最初の行では <info>null</info>  二行目以降では、ステップ関数から以前返された値を持ち
                            ます。 この値を、集約の状態を管理するのに使うべきです。
  <info>int</info>       <strong>$rownumber</strong>      現在の行番号
  <info>mixed</info>     <strong>$value</strong>          集約関数に渡されるはじめの引数
  <info>mixed</info>     <strong>$values</strong>         集約関数に渡されるふたつめ以降の引数
  <info>callable</info>  <strong>$finalize_func</strong>  すべての行が処理された後でコールされるコールバック関数。 ここでは、集約
                            コンテキストからデータを取得して結果を返します。 コールバック関数の返す
                            値は、SQLite が理解できる形式 (すなわち スカラー型) でなければなりませ
                            ん。
                            
                            この関数は次のように定義しなければなりません。
                            <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rowcount</strong> <strong>$context</strong> ステップ関数を最後に呼んだ時
                            の戻り値を保持します。 <strong>$rowcount</strong> 集約関数が実行された行数を保持します。
                            この関数の戻り値が、集約の戻り値となります。
                            
                            ステップ関数を最後に呼んだ時の戻り値を保持します。
                            
                            集約関数が実行された行数を保持します。
  <info>mixed</info>     <strong>$context</strong>        ステップ関数を最後に呼んだ時の戻り値を保持します。
  <info>int</info>       <strong>$rowcount</strong>       集約関数が実行された行数を保持します。
  <info>int</info>       <strong>$num_args</strong>       コールバック関数があらかじめ定義済みの引数を受け取る場合に、 SQLite の
                            パーサに渡すヒント。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 
   * <strong>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDO::sqliteCreateCollation
type: function
doc:
<comment>Description:</comment>
  SQL文で collate 関数として使うユーザー定義関数を登録する
    
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      作成または再定義する SQL collate 関数の名前
  <info>callable</info>  <strong>$callback</strong>  collation の振る舞いを定義する、PHP関数または、 コールバックとして適用する
                       ユーザー定義関数。 2つの値を受けとり、<strong>strcmp()</strong> 関数が返すのと同じ値を返しま
                       す。つまり、 はじめの文字列が前の文字列より前にソートされる場合に-1、 後に
                       ソートされる場合に1、等しい場合に0を返します。
                       
                       この関数は、次のように定義する必要があります:
                       <info>int</info>collation<info>string</info><strong>$string1</strong><info>string</info><strong>$string2</strong>

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: PDO::sqliteCreateFunction
type: function
doc:
<comment>Description:</comment>
  SQL 文で使用するユーザー定義関数 (UDF) を登録する
    
  
  この関数は、
  実験的 なものです。この関数の動作・
  名前・その他ドキュメントに書かれている事項は、予告なく、将来的な PHP
  のリリースにおいて変更される可能性があります。
  この関数は自己責任で使用してください。
  
  このメソッドを使用すると、 PHP の関数を、UDF (User Defined Function: ユーザー定義関数) として
  SQLite に登録できるようになります。 登録した関数は、SQL 文の中で使用することが可能です。
  
  UDF は、関数をコールできるあらゆる SQL 文 (SELECT および UPDATE 文、そしてトリガなど) で使用するこ
  とが可能です。

<comment>Param:</comment>
  <info>string</info>    <strong>$function_name</strong>  SQL 文で使用する関数の名前。
  <info>callable</info>  <strong>$callback</strong>       定義した SQL 関数を処理するコールバック関数。
                            
                            コールバック関数の返す値は、SQLite が理解できる形式 (すなわち スカラー
                            型) でなければなりません。
                            
                            コールバック関数は、以下のように定義する必要があります:
                            <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$value</strong> SQL関数に渡す最初の引数
                            <strong>$values</strong> SQL関数に渡す2つ目以降の引数
                            
                            SQL関数に渡す最初の引数
                            
                            SQL関数に渡す2つ目以降の引数
  <info>mixed</info>     <strong>$value</strong>          SQL関数に渡す最初の引数
  <info>mixed</info>     <strong>$values</strong>         SQL関数に渡す2つ目以降の引数
  <info>int</info>       <strong>$num_args</strong>       SQL 関数がとる引数の数。 このパラメータが <return>-1</return> の場合、 SQL 関数は任意の数
                            の引数を取ることができます。
  <info>int</info>       <strong>$flags</strong>          ビット単位のフラグの組み合わせ。 現状は、<info>PDO::SQLITE_DETERMINISTIC</info> だけ
                            がサポートされています。 これは、単一のSQLステートメント内では、同じ入力
                            に対して常に同じ結果を返すことを指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * 
   * <strong>sqlite_create_function()</strong>
   * <strong>sqlite_create_aggregate()</strong>


id: PDOStatement::bindColumn
type: function
doc:
<comment>Description:</comment>
  カラムを PHP 変数にバインドする
    
  
  PDOStatement::bindColumn は、 クエリからの結果セット中にあるカラムにバインドされた特定の値を 取得
  するための準備をします。 PDOStatement::fetch もしくは PDOStatement::fetchAll がコールされる度に、
  カラムにバインドされた全ての変数は更新されます。
  
  カラムに関する情報はステートメントが実行されるまで常に PDO から利用できないため、移植可能なアプリ
  ケーションでは PDOStatement::execute. の 後に この関数をコールするようにしてください。
  
  しかし、LOB カラムをストリームにバインドする際に PgSQL ドライバ を使用するときには、 このメソッド
  を PDOStatement::execute の 前に コールしなければなりません。 そうしないと、ラージオブジェクトの
  OID が integer で返されます。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$column</strong>         結果セット中のカラム番号 (1 から始まる) を指定します。 カラム名を使用
                              する場合、 ドライバによって返されるカラムの大文字小文字が一致する必要
                              が あることをご承知おきください。
  <info>mixed</info>       <strong>$var</strong>            カラムがバインドされる PHP 変数名を指定します。
  <info>int</info>         <strong>$type</strong>           パラメータのデータ型を <return>PDO::PARAM_*</return> 定数 で指定します。
  <info>int</info>         <strong>$maxLength</strong>      領域を事前に確保するためのヒント。
  <info>mixed</info>       <strong>$driverOptions</strong>  ドライバのオプションパラメータ。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDOStatement::execute
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::bindParam
type: function
doc:
<comment>Description:</comment>
  指定された変数名にパラメータをバインドする
    
  
  準備された SQL ステートメント中で、 対応する名前もしくは疑問符プレースホルダにパラメータをバインド
  します。 PDOStatement::bindValue と異なり、 変数は参照としてバインドされ、PDOStatement::execute が
  コールされたときのみ評価されます。
  
  ほとんどのパラメータは入力パラメータです。つまり、クエリを構築する際、 パラメータは読み込み専用で
  使用されます(とはいえ、 <strong>$type</strong> によってはキャストされる可能性もあります)。 いくつかのドライバは、出
  力パラメータとしてデータを返す ストアドプロシージャの実行をサポートしており、 またいくつかのドライ
  バは、データを渡し更新された値を受け取る、 といった入出力パラメータもサポートしています。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>          パラメータ ID を指定します。名前付けされたプレースホルダを使った文に
                              対しては、:name 形式のパラメータ名となります。 疑問符プレースホルダを
                              使った文に対しては、1 から始まるパラメータの 位置となります。
  <info>mixed</info>       <strong>$var</strong>            SQL ステートメントパラメータにバインドする PHP 変数名を指定します。
  <info>int</info>         <strong>$type</strong>           パラメータに対して <return>PDO::PARAM_*</return> 定数 を使った明示的なデータ型を指定し
                              ます。 ストアドプロシージャからの INOUT パラメータの場合、 <strong>$type</strong> パラ
                              メータに <info>PDO::PARAM_INPUT_OUTPUT</info> ビットを設定するためにビット OR を使
                              用してください。
  <info>int</info>         <strong>$maxLength</strong>      データ型の長さを指定します。パラメータがストアドプロシージャからの OUT
                              パラメータであることを示す場合、 明示的に長さを設定しなければなりませ
                              ん。 この値は、<strong>$type</strong> パラメータに <info>PDO::PARAM_INPUT_OUTPUT</info> を指定した場
                              合のみ意味があります。
  <info>mixed</info>       <strong>$driverOptions</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindValue


id: PDOStatement::bindValue
type: function
doc:
<comment>Description:</comment>
  値をパラメータにバインドする
    
  
  プリペアドステートメントで使用する SQL 文の中で、 対応する名前あるいは疑問符のプレースホルダに値を
  バインドします。

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  パラメータ ID。名前つきプレースホルダを使用する プリペアドステートメントの場合
                      は、 :name 形式のパラメータ名となります。 疑問符プレースホルダを使用するプリペ
                      アドステートメントの場合は、 1 から始まるパラメータの位置となります。
  <info>mixed</info>       <strong>$value</strong>  パラメータにバインドする値。
  <info>int</info>         <strong>$type</strong>   パラメータに対して <return>PDO::PARAM_*</return> 定数 を使った明示的なデータ型を指定します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::bindParam


id: PDOStatement::closeCursor
type: function
doc:
<comment>Description:</comment>
  カーソルを閉じてステートメントを再実行できるようにする
    
  
  PDOStatement::closeCursor は、 他の SQL ステートメントを発行できるようにサーバーへの接続を解放しま
  すが、 ステートメントは再実行可能な状態のまま残されます。
  
  このメソッドは以前に実行された PDOStatement オブジェクトが行をまだフェッチしていない場合に
  PDOStatement オブジェクトの実行をサポートしていないデータベースドライバに対して有用です。 もし使用
  しているデータベースドライバがこの制限を受ける場合、 out-of-sequence エラーが出力されます。
  
  PDOStatement::closeCursor は、 オプションのドライバ固有のメソッド (最大の効率を得るため) もしくは
  ドライバ固有の関数がインストールされていない場合の汎用的な PDO フォールバックとして実装されていま
  す。 汎用的な PDO フォールバックは、PHP スクリプト中に以下のようなコードを書くことと意味的に等価で
  す。 fetch()) ; if (!$stmt->nextRowset()) break;
  } while (true);
  ?>
  ]]>

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

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


id: PDOStatement::columnCount
type: function
doc:
<comment>Description:</comment>
  結果セット中のカラム数を返す
    
  
  PDOStatement オブジェクトに相当する結果セットにあるカラム数を返すために PDOStatement::columnCount
  を使用します。
  
  もし PDOStatement オブジェクトが PDO::query から返された場合、カラム数は直ちに利用可能です。
  
  もし PDOStatement オブジェクトが PDO::prepare から返された場合、正確なカラム数は
  PDOStatement::execute を実行するまで利用可能になりません。

<comment>Return:</comment>
  <info>int</info>  PDOStatement オブジェクトに相当する結果セットにあるカラム数を返します。 結果セットが空である
       場合でも同様です。 もし結果セットがなければ、PDOStatement::columnCount は <return>0</return> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::rowCount


id: PDOStatement::debugDumpParams
type: function
doc:
<comment>Description:</comment>
  SQL プリペアドコマンドを出力する
    
  
  プリペアドステートメントに含まれる以下のような情報を直接出力します。 使用する <return>SQL</return> クエリ、使用する
  パラメータ数 (<return>Params</return>)、パラメータリスト、パラメータ名、 パラメータの型 (<return>paramtype</return>) をあらわす整数
  値、 そのキーの名前あるいは位置、そしてクエリ内での位置 (PDO ドライバがサポートしている場合のみ。
  サポートしていない場合は -1 となります) 、型 (<return>param_type</return>) を表す整数値、boolean 値 <return>is_param</return>。
  
  これはデバッグ用関数です。結果を標準出力にそのまま出力します。 ブラウザに直接結果を出力する
  すべてのものと同様に、出力制御関数
  を使用してこの関数の出力をキャプチャーし、(例えば)文字列
  (<info>string</info>)に保存することが可能です。
  
  ブラウザに直接結果を出力する
  すべてのものと同様に、出力制御関数
  を使用してこの関数の出力をキャプチャーし、(例えば)文字列
  (<info>string</info>)に保存することが可能です。
  
  これは、出力時にステートメント内にあるパラメータのみを出力します。 追加パラメータはステートメント
  に格納されておらず、出力されません。

<comment>Return:</comment>
  <info>bool|null</info>  <info>null</info> を返します。エラーの場合は <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::bindValue


id: PDOStatement::errorCode
type: function
doc:
<comment>Description:</comment>
  文ハンドラにおける直近の操作に関連する SQLSTATE を取得する

<comment>Return:</comment>
  <info>string|null</info>  PDOStatement::errorCode は PDOStatement オブジェクトを用いて実行された操作に対する エ
               ラーコードを取得することを除き、 PDO::errorCode と等価です。

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorInfo


id: PDOStatement::errorInfo
type: function
doc:
<comment>Description:</comment>
  文ハンドラにおける直近の操作に関連する拡張エラー情報を取得する

<comment>Return:</comment>
  <info>array</info>  PDOStatement::errorInfo は、 この文ハンドラによって実行された直近の操作に関するエラー情報を
         配列として返します。この配列は少なくとも次のフィールドを含みます。 要素情報0SQLSTATE エラー
         コード (これは、ANSI SQL 標準で定義された英数 5 文字の ID)1ドライバ固有のエラーコード2ドラ
         イバ固有のエラーメッセージ

<comment>See Also:</comment>
   * PDO::errorCode
   * PDO::errorInfo
   * PDOStatement::errorCode


id: PDOStatement::execute
type: function
doc:
<comment>Description:</comment>
  プリペアドステートメントを実行する
    
  
  プリペアドステートメントを実行します。 もし、プリペアドステートメントがパラメータマーカを含む場
  合、次のいずれかを行わなければなりません。 パラメータマーカに PHP 変数や値を(それぞれ)バインドする
  ため PDOStatement::bindParam や PDOStatement::bindValue をコールする。 関連づけされたパラメータ
  マーカがあれば、バインドされた変数は入力値を渡す もしくは出力値を受け取ります。 あるいは、入力専用
  のパラメータ値の配列を渡す
  
  パラメータマーカに PHP 変数や値を(それぞれ)バインドするため PDOStatement::bindParam や
  PDOStatement::bindValue をコールする。 関連づけされたパラメータマーカがあれば、バインドされた変数
  は入力値を渡す もしくは出力値を受け取ります。
  
  あるいは、入力専用のパラメータ値の配列を渡す

<comment>Param:</comment>
  <info>array|null</info>  <strong>$params</strong>  実行される SQL 文の中のバインドパラメータと同数の要素からなる、 値の配列。す
                       べての値は <info>PDO::PARAM_STR</info> として扱われます。
                       
                       ひとつのパラメータに対して複数の値をバインドすることはできません。 例えば、
                       IN() 句の中のひとつのパラメータに対して 2 つの値をバインドすることはできませ
                       ん。
                       
                       指定した数よりも多い値をバインドすることはできません。 <strong>$params</strong> のキーが
                       PDO::prepare で指定した SQL にある数より多い場合は、 ステートメントが失敗して
                       エラーが発生します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::bindParam
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn


id: PDOStatement::fetch
type: function
doc:
<comment>Description:</comment>
  結果セットから次の行を取得する
    
  
  PDOStatementオブジェクトに関連付けられた結果セットから1行取得します。 <strong>$mode</strong> パラメータは、PDO がそ
  の行をどの様に返すかを決定します。

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>               次のレコードを呼び出し元に返す方法を制御します。 この値は、<return>PDO::FETCH_*</return>
                           定数のどれかで、 デフォルトは <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> の値 (そのデ
                           フォルトは <info>PDO::FETCH_BOTH</info>) です。 <return>PDO::FETCH_ASSOC</return>: は、結果セットに 返
                           された際のカラム名で添字を付けた配列を返します。 <return>PDO::FETCH_BOTH</return> (デフォ
                           ルト): 結果セットに返された際のカラム名と 0 で始まるカラム番号で添字を付
                           けた配列を返します。 <return>PDO::FETCH_BOUND</return>: <info>true</info> を返し、結果セットのカラムの
                           値を PDOStatement::bindColumn メソッドでバインドされた PHP 変数に代入しま
                           す。 <return>PDO::FETCH_CLASS</return>: 結果セットのカラムがクラス内の名前付けされたプロパ
                           ティに マッピングされている、要求されたクラスの新規インスタンスを返しま
                           す。 <return>PDO::FETCH_PROPS_LATE</return> を指定していない限りは、 カラムをマッピングし
                           てからクラスのコンストラクタを呼び出します。 <strong>$mode</strong> に
                           PDO::FETCH_CLASSTYPE が 含まれている場合 (例: <return>PDO::FETCH_CLASS |
                           PDO::FETCH_CLASSTYPE</return>) は、最初のカラムの値から クラス名を決定します。
                           <return>PDO::FETCH_INTO</return>: 結果セットのカラムがクラス内の名前付けされたプロパティに
                           マッピングされている要求された既存インスタンスを更新します。
                           <return>PDO::FETCH_LAZY</return>: <return>PDO::FETCH_BOTH</return> と<return>PDO::FETCH_OBJ</return>の 組合せで、オブジェク
                           ト変数名を作成します。 <return>PDO::FETCH_NAMED</return>: <return>PDO::FETCH_ASSOC</return> と同じ形式の配
                           列を返します。 ただし、同じ名前のカラムが複数あった場合は、そのキーが指す
                           値は、 同じ名前のカラムのすべての値を含む配列になります。 <return>PDO::FETCH_NUM</return>:
                           結果セットに返された際の 0 から始まるカラム番号を添字とする配列を返しま
                           す。 <return>PDO::FETCH_OBJ</return>: 結果セットに返された際のカラム名と同名のプロパティを
                           有する 匿名のオブジェクトを返します。 <return>PDO::FETCH_PROPS_LATE</return>:
                           <return>PDO::FETCH_CLASS</return> とともに使用すると、 まずクラスのコンストラクタを呼び出
                           してから、カラムの値をプロパティに代入します。
                           
                           <return>PDO::FETCH_ASSOC</return>: は、結果セットに 返された際のカラム名で添字を付けた配列
                           を返します。
                           
                           <return>PDO::FETCH_BOTH</return> (デフォルト): 結果セットに返された際のカラム名と 0 で始ま
                           るカラム番号で添字を付けた配列を返します。
                           
                           <return>PDO::FETCH_BOUND</return>: <info>true</info> を返し、結果セットのカラムの値を
                           PDOStatement::bindColumn メソッドでバインドされた PHP 変数に代入します。
                           
                           <return>PDO::FETCH_CLASS</return>: 結果セットのカラムがクラス内の名前付けされたプロパティ
                           に マッピングされている、要求されたクラスの新規インスタンスを返します。
                           <return>PDO::FETCH_PROPS_LATE</return> を指定していない限りは、 カラムをマッピングしてから
                           クラスのコンストラクタを呼び出します。 <strong>$mode</strong> に PDO::FETCH_CLASSTYPE が
                           含まれている場合 (例: <return>PDO::FETCH_CLASS | PDO::FETCH_CLASSTYPE</return>) は、最初の
                           カラムの値から クラス名を決定します。
                           
                           <return>PDO::FETCH_INTO</return>: 結果セットのカラムがクラス内の名前付けされたプロパティに
                           マッピングされている要求された既存インスタンスを更新します。
                           
                           <return>PDO::FETCH_LAZY</return>: <return>PDO::FETCH_BOTH</return> と<return>PDO::FETCH_OBJ</return>の 組合せで、オブジェク
                           ト変数名を作成します。
                           
                           <return>PDO::FETCH_NAMED</return>: <return>PDO::FETCH_ASSOC</return> と同じ形式の配列を返します。 ただし、
                           同じ名前のカラムが複数あった場合は、そのキーが指す値は、 同じ名前のカラム
                           のすべての値を含む配列になります。
                           
                           <return>PDO::FETCH_NUM</return>: 結果セットに返された際の 0 から始まるカラム番号を添字とす
                           る配列を返します。
                           
                           <return>PDO::FETCH_OBJ</return>: 結果セットに返された際のカラム名と同名のプロパティを有す
                           る 匿名のオブジェクトを返します。
                           
                           <return>PDO::FETCH_PROPS_LATE</return>: <return>PDO::FETCH_CLASS</return> とともに使用すると、 まずクラスの
                           コンストラクタを呼び出してから、カラムの値をプロパティに代入します。
  <info>int</info>  <strong>$cursorOrientation</strong>  スクロール可能なカーソルを表す PDOStatement オブジェクトの場合、 この値に
                           より呼び出し側に返される行を定義します。 この値は、<return>PDO::FETCH_ORI_*</return> 定数
                           のどれかと する必要があり、 <return>PDO::FETCH_ORI_NEXT</return> がデフォルトとなっていま
                           す。 PDOStatement に対してスクロール可能なカーソルを要求するためには、
                           PDO::prepare を用いて SQL ステートメントを 準備する際、
                           <return>PDO::CURSOR_SCROLL</return> に <return>PDO::ATTR_CURSOR</return> 属性を設定する必要があります。
  <info>int</info>  <strong>$cursorOffset</strong>       スクロール可能なカーソルを表すPDOStatementオブジェクトの場合で、
                           <strong>$cursorOrientation</strong> パラメータが <return>PDO::FETCH_ORI_ABS</return>に設定された場合、この
                           値により 取得される結果セットの行の絶対位置が指定されます。
                           
                           スクロール可能なカーソルを表すPDOStatementオブジェクトの場合で、
                           <strong>$cursorOrientation</strong> パラメータが <return>PDO::FETCH_ORI_REL</return>に設定された場合、この
                           値は、 PDOStatement::fetch がコールされる前のカーソルの 位置を基準として
                           取得する行の位置を指定します。

<comment>Return:</comment>
  <info>mixed</info>  この関数が成功した場合の戻り値は、取得形式によって異なります。 失敗した場合、または行が残っ
         ていない場合は、常に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::prepare
   * PDOStatement::execute
   * PDOStatement::fetchAll
   * PDOStatement::fetchColumn
   * PDOStatement::fetchObject
   * PDOStatement::setFetchMode


id: PDOStatement::fetchAll
type: function
doc:
<comment>Description:</comment>
  結果セットから、残っている行を取得する

<comment>Param:</comment>
  <info>int</info>       <strong>$mode</strong>            PDOStatement::fetch で説明されている、返される配列の内容を制御します。
                             デフォルトは <info>PDO::ATTR_DEFAULT_FETCH_MODE</info> の値 (そのデフォルトは
                             <info>PDO::FETCH_BOTH</info>) です。
                             
                             結果セットから単一カラムの全ての値を含む配列を返す場合、
                             <info>PDO::FETCH_COLUMN</info> を指定します。 <strong>$column</strong> パラメータにどのカラムを返すか
                             を 指定することができます。
                             
                             結果セットから単一カラムの一意な値のみ取得する場合、 <info>PDO::FETCH_UNIQUE</info>
                             をビット OR した <info>PDO::FETCH_COLUMN</info> を指定します。
                             
                             指定したカラムの値によってグループ化した連想配列を返す場合、
                             <info>PDO::FETCH_GROUP</info> をビット OR した <info>PDO::FETCH_COLUMN</info> を指定します。
  <info>int</info>       <strong>$column</strong>          <info>PDO::FETCH_COLUMN</info> と一緒に使います。0 から始まる番号のカラムを返しま
                             す。
  <info>string</info>    <strong>$class</strong>           <info>PDO::FETCH_CLASS</info> と一緒に使います。 ここで指定したクラスのインスタンス
                             を返します。 各行のカラムがクラスのプロパティ名にマッピングされます。
  <info></info>          <strong>$constructorArg</strong>  <strong>$mode</strong> が <info>PDO::FETCH_CLASS</info> のときに使う、独自のクラスコンストラクタへの
                             引数。
  <info>callable</info>  <strong>$callback</strong>        <info>PDO::FETCH_FUNC</info> と一緒に使います。 ここで指定した関数をコールした結果を
                             返します。 各行のカラムを関数コール時のパラメータとします。

<comment>Return:</comment>
  <info>array</info>  PDOStatement::fetchAll は、 結果セットに残っている全ての行を含む配列を返します。 この配列
         は、カラム値の配列もしくは各カラム名に対応するプロパティを持つオブジェクトとして各行を表し
         ます。 取得結果がゼロ件だった場合は空の配列を返します。
         
         大きな結果セットをフェッチするためにこのメソッドを使用することは、 システムとネットワークリ
         ソースに大量の要求を行うことになります。 PHP で全てのデータ処理と操作を行うよりも、データ
         ベースサーバー側で 結果セットを操作することを検討してください。例えば、PHP で処理を行う前に
         SQL で WHERE 句や ORDER BY 句を使用し、結果を制限することです。

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchColumn
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchColumn
type: function
doc:
<comment>Description:</comment>
  結果セットの次行から単一カラムを返す
    
  
  結果セットの次行から単一カラムを返します。 行がもうない場合には <info>false</info> を返します。
  
  PDOStatement::fetchColumn は、boolean のカラムを取得するときに使っていけません。 boolean 値として
  の <info>false</info> と、もう取得する行がない場合の <info>false</info> を区別できないからです。 かわりに
  PDOStatement::fetch を使いましょう。

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  行から処理したい 0 で始まるカラム番号を指定します。 何も値が与えられない場合、
                PDOStatement::fetchColumn は最初のカラムをフェッチします。

<comment>Return:</comment>
  <info>mixed</info>  PDOStatement::fetchColumn は結果セットの次行から単一カラムを返します。 それ以上行がない場
         合、<info>false</info> を返します。
         
         PDOStatement::fetchColumn を使用してデータを処理する場合、同一行から 他のカラムを返す方法は
         ありません。

<comment>See Also:</comment>
   * PDO::query
   * PDOStatement::fetch
   * PDOStatement::fetchAll
   * PDO::prepare
   * PDOStatement::setFetchMode


id: PDOStatement::fetchObject
type: function
doc:
<comment>Description:</comment>
  次の行を取得し、それをオブジェクトとして返す
  
  次の行を取得し、それをオブジェクトとして返します。この関数は、 PDOStatement::fetch で
  <info>PDO::FETCH_CLASS</info> あるいは <info>PDO::FETCH_OBJ</info> を指定することの代替関数となります。
  
  オブジェクトを取得する際には、各カラムの値を対応するプロパティに代入してから、 そのコンストラクタ
  を実行します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>            作成されるクラスの名前。
  <info>array</info>        <strong>$constructorArgs</strong>  この配列の要素がコンストラクタに渡されます。

<comment>Return:</comment>
  <info>object|false</info>  カラム名に対応するプロパティを保持する、要求されたクラスの インスタンスを返します。
                失敗した場合に <info>false</info> を返します。

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


id: PDOStatement::getAttribute
type: function
doc:
<comment>Description:</comment>
  文の属性を取得する
    
  
  文の属性を取得します。現時点で共通の属性は存在しませんが、 ドライバ固有の属性のみ存在します。
  <return>PDO::ATTR_CURSOR_NAME</return> (Firebird と ODBC 固有): <return>UPDATE ... WHERE CURRENT OF</return> に対するカーソル名を取
  得する  ドライバ固有の属性は、 他のドライバでは使っては いけない ことに注意して下さい。
  
  <return>PDO::ATTR_CURSOR_NAME</return> (Firebird と ODBC 固有): <return>UPDATE ... WHERE CURRENT OF</return> に対するカーソル名を取
  得する

<comment>Param:</comment>
  <info>int</info>  <strong>$name</strong>  問い合わせる属性の名前。

<comment>Return:</comment>
  <info>mixed</info>  属性の値を返します。

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::setAttribute


id: PDOStatement::getColumnMeta
type: function
doc:
<comment>Description:</comment>
  結果セットのカラムに対するメタデータを返す
    
  
  結果セットの 0 から始まるカラムに対するメタデータを連想配列で取得します。
  
  PDO ドライバによっては、 PDOStatement::getColumnMeta を実装していないかもしれません。 なぜなら、こ
  れはオプションだからです。 しかし、このマニュアルでドキュメント化されている全ての PDO ドライバ は
  この関数を実装しています。

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  結果セットの 0 から始まるカラムを指定します。

<comment>Return:</comment>
  <info>array|false</info>  1つのカラムについてのメタデータに相当する次の値を含んだ連想配列を返します。
               
               要求されたカラムが結果セットに存在しない、 もしくは結果セットが存在しない場合、<info>false</info>
               を返します。

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::rowCount


id: PDOStatement::getIterator
type: function
doc:
<comment>Description:</comment>
  結果セットのイテレータを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>Iterator</info>  


id: PDOStatement::nextRowset
type: function
doc:
<comment>Description:</comment>
  複数の行セットを返す文ハンドラで次の行セットに移動する
    
  
  いくつかのデータベースサーバーは、1つ以上の行セット (結果セットとしても知られる) を返すストアドプ
  ロシージャをサポートしています。 PDOStatement::nextRowSet により、2 番目以降の PDOStatement オブ
  ジェクトに関連する行セットにアクセスすることができます。 それぞれの行セットは、 前の行セットと異な
  るカラムセットを含むことができます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::execute
   * PDOStatement::getColumnMeta
   * PDO::query


id: PDOStatement::rowCount
type: function
doc:
<comment>Description:</comment>
  直近の SQL ステートメントによって作用した行数を返す
    
  
  PDOStatement::rowCount は 相当する <return>PDOStatement</return> オブジェクトによって実行された 直近の DELETE,
  INSERT, UPDATE 文によって作用した行数を返します。
  
  <return>SELECT</return>文のような、結果セットを生成するSQLステートメントについては動作が未定義です。 動作はドライバ
  によって異なる可能性があります。 データベース(例: MySQL のバッファリングモード)によっては、文に
  よって返された行数を返すかもしれません。しかしながら、 この振る舞いは全てのデータベースで保証され
  ていません。 さまざまな場所で使用するアプリケーションでは、 これに頼ってはいけません。
  
  このメソッドは SQLite ドライバの場合はあらゆる場合に "0" (ゼロ)  を返します。 PostgreSQL ドライバ
  の場合は ステートメント属性 <info>PDO::ATTR_CURSOR</info>  の設定が <info>PDO::CURSOR_SCROLL</info> の場合にだけ "0" (ゼロ)
  を返します。

<comment>Return:</comment>
  <info>int</info>  行の数を返します。

<comment>See Also:</comment>
   * PDOStatement::columnCount
   * PDOStatement::fetchColumn
   * PDO::query


id: PDOStatement::setAttribute
type: function
doc:
<comment>Description:</comment>
  文の属性を設定する
    
  
  文の属性を設定します。現時点で共通の属性は存在しませんが、 ドライバ固有の属性のみ存在します。
  <return>PDO::ATTR_CURSOR_NAME</return> (Firebird と ODBC 固有): <return>UPDATE ... WHERE CURRENT OF</return> に対するカーソル名を取
  得する  ドライバ固有の属性は、 他のドライバでは使っては いけない ことに注意して下さい。
  
  <return>PDO::ATTR_CURSOR_NAME</return> (Firebird と ODBC 固有): <return>UPDATE ... WHERE CURRENT OF</return> に対するカーソル名を取
  得する

<comment>Param:</comment>
  <info>int</info>    <strong>$attribute</strong>  変更する属性。
  <info>mixed</info>  <strong>$value</strong>      <strong>$attribute</strong> に設定する値。 属性によっては、特定の型が必要かもしれません。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * PDO::getAttribute
   * PDO::setAttribute
   * PDOStatement::getAttribute


id: PDOStatement::setFetchMode
type: function
doc:
<comment>Description:</comment>
  この文に対するデフォルトのフェッチモードを設定する

<comment>Param:</comment>
  <info>int</info>         <strong>$mode</strong>             フェッチモードは、<return>PDO::FETCH_*</return> 定数の 1 つでなければなりません。
  <info>int</info>         <strong>$colno</strong>            カラム番号。
  <info>string</info>      <strong>$class</strong>            クラス名。
  <info>array|null</info>  <strong>$constructorArgs</strong>  コンストラクタの引数。
  <info>object</info>      <strong>$object</strong>           オブジェクト。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: PGSQL_BAD_RESPONSE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 サーバーからの応答を判別できませんでした。


id: PGSQL_BOTH
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_fetch_array()</strong> に渡します。 フィールド値の配列を、数値添字（フィールド番号で）と 連想配列
  （フィールド名で）の両方で返します。


id: PGSQL_COMMAND_OK
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 コマンドは正常に終了し、何もデータを返しませんでした。


id: PGSQL_CONNECTION_BAD
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connection_status()</strong> から返され、データベースとの 接続が不正な状態になっていることを示します。


id: PGSQL_CONNECTION_OK
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connection_status()</strong> から返され、データベースとの 接続が正常であることを示します。


id: PGSQL_CONNECT_FORCE_NEW
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connect()</strong> に渡し、既存の同一接続を無視して 新しい接続を確立させるようにします。


id: PGSQL_CONV_FORCE_NULL
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_convert()</strong> に渡します。 空文字列に対して、SQL の <return>NULL</return> を使用します。


id: PGSQL_CONV_IGNORE_NOT_NULL
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_convert()</strong> に渡します。 <info>null</info> を SQL の <return>NOT NULL</return> に変換しないように します。


id: PGSQL_COPY_IN
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 （サーバーへの）データのコピーが始まりました。


id: PGSQL_COPY_OUT
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 （サーバーからの）データのコピーが始まりました。


id: PGSQL_DIAG_CONTEXT
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーが発生した状況を指定します。現在ここに含まれているの
  は、 アクティブなプロシージャの関数や内部生成クエリのコール履歴です。 これはエントリごとに 1 行の
  データとなっており、直近のデータが 先頭にきます。


id: PGSQL_DIAG_INTERNAL_POSITION
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 <info>PG_DIAG_STATEMENT_POSITION</info> と同じ定義ですが、 こちらはカーソ
  ル位置が内部で生成されたコマンドを参照している場合に 使用されます。このフィールドが存在する場合
  は、常に <info>PG_DIAG_INTERNAL_QUERY</info> フィールドも存在します。


id: PGSQL_DIAG_INTERNAL_QUERY
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 失敗した内部生成コマンドのテキストです。例としては、PL/pgSQL
  関数で 発行された SQL クエリなどがあてはまります。


id: PGSQL_DIAG_MESSAGE_DETAIL
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 オプションの 2 番目のエラーメッセージで、問題に対する詳細な情
  報を 含みます。複数行にまたがることもあります。


id: PGSQL_DIAG_MESSAGE_HINT
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 オプションのメッセージで、問題に対してどのように対応すべきか
  を指摘 します。エラーの詳細情報と違う点は、発生した事実ではなくアドバイス （時に不適切な場合もあ
  る）をするところです。複数行にまたがることも あります。


id: PGSQL_DIAG_MESSAGE_PRIMARY
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 人間が判読できる最初のエラーメッセージ（たいてい 1 行）です。
  常に存在します。


id: PGSQL_DIAG_SEVERITY
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 深刻度です。その内容は <return>ERROR</return>、 <return>FATAL</return>、あるいは <return>PANIC</return> （エラー
  メッセージ内）、あるいは <return>WARNING</return>、 <return>NOTICE</return>、<return>DEBUG</return>、 <return>INFO</return>、あるいは <return>LOG</return> （通知メッセージ内）、あるい
  はこれらの各国語版のうちのどれかです。 常に存在します。


id: PGSQL_DIAG_SEVERITY_NONLOCALIZED
type: constant
doc:
<comment>Description:</comment>
  深刻度。 このフィールドの内容は(エラーメッセージの場合)ERROR、FATAL、もしくは、PANIC、 (注意喚起
  メッセージの場合)WARNING、NOTICE、DEBUG、INFO、もしくは、LOGです。  これは、内容が多言語化されない
  ことを除き、PG_DIAG_SEVERITY と同一です。 これはPostgreSQLのバージョン9.6以降で生成された報告にの
  み存在します / PHP 7.3.0 以降で利用可能です。


id: PGSQL_DIAG_SOURCE_FILE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーが報告された箇所の、PostgreSQL ソースコードでのファイル
  名です。


id: PGSQL_DIAG_SOURCE_FUNCTION
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーが報告された箇所の、PostgreSQL ソースコードでの関数名で
  す。


id: PGSQL_DIAG_SOURCE_LINE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーが報告された箇所の、PostgreSQL ソースコードでの行番号で
  す。


id: PGSQL_DIAG_SQLSTATE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーの SQLSTATE コードです。SQLSTATE コードは発生したエラー
  の種別を 特定します。これは、データベースエラーに対してフロントエンドの アプリケーションが適切な操
  作（エラー処理など）をできるようにするために 使用されます。このフィールドはローカライズされていま
  せん。また、 常に存在します。


id: PGSQL_DIAG_STATEMENT_POSITION
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_error_field()</strong> に渡します。 エラーカーソルの位置を、もとのステートメント中の位置として表
  す 整数値を保持する文字列です。 最初の文字の位置は 1 で、それ以降（バイト数ではなく）文字数で 位置
  を数えます。


id: PGSQL_DML_ASYNC
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_insert()</strong> や <strong>pg_select()</strong>、 <strong>pg_update()</strong>、<strong>pg_delete()</strong> に渡します。 これらの関数を使って、非同期ク
  エリを実行します。


id: PGSQL_DML_ESCAPE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_insert()</strong> や <strong>pg_select()</strong>、 <strong>pg_update()</strong>、<strong>pg_delete()</strong> に渡します。 内部的に <strong>pg_convert()</strong> を呼ぶ代
  わりに、すべてのパラメータをエスケープします。 このオプションは、メタデータのルックアップを除外し
  ます。 <strong>pg_query()</strong> や <strong>pg_send_query()</strong> と同程度の速度になります。


id: PGSQL_DML_EXEC
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_insert()</strong> や <strong>pg_select()</strong>、 <strong>pg_update()</strong>、<strong>pg_delete()</strong> に渡します。 これらの関数を使って、クエリを
  実行します。


id: PGSQL_DML_NO_CONV
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_insert()</strong> や <strong>pg_select()</strong>、 <strong>pg_update()</strong>、<strong>pg_delete()</strong> に渡します。 すべてのパラメータを、そのまま
  の形式で渡します。ユーザーから受け取ったデータを渡す際には、手動でのエスケープが必要になります。
  <strong>pg_escape_string()</strong> を使いましょう。


id: PGSQL_DML_STRING
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_insert()</strong> や <strong>pg_select()</strong>、 <strong>pg_update()</strong>、<strong>pg_delete()</strong> に渡します。 実行したクエリ文字列を返しま
  す。


id: PGSQL_ERRORS_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_verbosity()</strong> に渡します。 デフォルトで返されるメッセージで、上の内容に加えて詳細・ ヒ
  ントあるいは詳細情報を含めます（複数行にまたがるかもしれません）。


id: PGSQL_ERRORS_TERSE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_verbosity()</strong> に渡します。 返されるメッセージを指定します。ここには深刻度・短い説明およ
  び 発生位置のみを含めます。通常は 1 行に収まるでしょう。


id: PGSQL_ERRORS_VERBOSE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_verbosity()</strong> に渡します。 詳細モードでのメッセージで、有効なフィールドをすべて含めま
  す。


id: PGSQL_LIBPQ_VERSION_STR
type: constant
doc:
<comment>Description:</comment>
  PHP 8.0.0 より前のバージョンでは、 コンパイラの情報も含む 長い形式の libpq バージョン情報を表して
  いました。 PHP 8.0.0 以降は、 この値は <info>PGSQL_LIBPQ_VERSION</info> の値と等しくなりました。 よって、
  <info>PGSQL_LIBPQ_VERSION_STR</info> を使うことは推奨されなくなっています。


id: PGSQL_NONFATAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 致命的ではないエラー（通知や警告など）が発生しました。


id: PGSQL_POLLING_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connect_poll()</strong> が返す値です。 接続が、現在アクティブであることを示します。


id: PGSQL_POLLING_READING
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connect_poll()</strong> が返す値です。 接続が、PostgreSQL のソケットが読み込み可能になるのを待っているこ
  とを示します。


id: PGSQL_POLLING_WRITING
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_connect_poll()</strong> が返す値です。 接続が、PostgreSQL のソケットが書き込み可能になるのを待っているこ
  とを示します。


id: PGSQL_SHOW_CONTEXT_ALWAYS
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_context_set_visibility()</strong> に指定するために使います。コンテクストのフィールドには
  error, notice, warning メッセージが含まれます。 PHP 8.3.0 以降で利用可能です。


id: PGSQL_SHOW_CONTEXT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_context_set_visibility()</strong> に指定するために使います。コンテクストのフィールドはエラー
  メッセージのみです。 これがデフォルトの動作です。 PHP 8.3.0 以降で利用可能です。


id: PGSQL_SHOW_CONTEXT_NEVER
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_set_error_context_set_visibility()</strong> に指定するために使います。コンテクストは決して表示されませ
  ん。 PHP 8.3.0 以降で利用可能です。


id: PGSQL_STATUS_LONG
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> に渡します。 結果として数値が要求されていることを示します。


id: PGSQL_STATUS_STRING
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> に渡します。 結果としてテキストのコマンドタグが要求されていることを示します。


id: PGSQL_TRACE_REGRESS_MODE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_trace()</strong> に指定するために使います。 OID のようなフィールドを、トレースのメッセージに含めます。
  PHP 8.3.0 以降で利用可能です。


id: PGSQL_TRACE_SUPPRESS_TIMESTAMPS
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_trace()</strong> に指定するために使います。 トレースのメッセージにタイムスタンプを含めません。 PHP 8.3.0
  以降で利用可能です。


id: PGSQL_TRANSACTION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_transaction_status()</strong> から返されます。 接続内でコマンドを実行中です。クエリが接続を通じて送信さ
  れ、 まだ完了していません。


id: PGSQL_TRANSACTION_IDLE
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_transaction_status()</strong> から返されます。 接続は現在アイドル状態で、トランザクション内ではありませ
  ん。


id: PGSQL_TRANSACTION_INERROR
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_transaction_status()</strong> から返されます。 接続は現在アイドル状態で、トランザクション処理に失敗して
  います。


id: PGSQL_TRANSACTION_INTRANS
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_transaction_status()</strong> から返されます。 接続は現在アイドル状態で、トランザクションブロック内にあ
  ります。


id: PGSQL_TUPLES_OK
type: constant
doc:
<comment>Description:</comment>
  <strong>pg_result_status()</strong> から返されます。 コマンドは正常に終了し、データを返しました （<return>SELECT</return> や <return>SHOW</return> な
  ど）。


id: PHP_BINDIR
type: constant
doc:
<comment>Description:</comment>
  configure 時に設定された --bindir の値。 Windows の場合、configure 時に設定された --with-prefix の
  値になります。


id: PHP_EXTENSION_DIR
type: constant
doc:
<comment>Description:</comment>
  動的にロード可能な拡張モジュールを探すデフォルトのディレクトリ。 (但し、extension_dir で上書きされ
  た場合を除きます) デフォルトは <info>PHP_PREFIX</info> です。 (Windows では、 PHP_PREFIX . "\\ext" です。)


id: PHP_EXTRA_VERSION
type: constant
doc:
<comment>Description:</comment>
  現在の PHP の追加バージョンを文字列で表したもの (たとえば、バージョンが "5.2.7-extra" の場合は
  '-extra' となる)。 ディストリビューションのベンダーが、パッケージのバージョンを示すために使うこと
  が多い。


id: PHP_FLOAT_EPSILON
type: constant
doc:
<comment>Description:</comment>
  <return>x + 1.0 != 1.0</return> となる正の数 x のうちで、浮動小数点数値として表せる最小の数。 PHP 7.2.0 以降で利用
  可能。


id: PHP_FLOAT_MIN
type: constant
doc:
<comment>Description:</comment>
  正 の浮動小数点数値として表せる最小の数。 浮動小数点数値として表せる 負の 最小値が必要なら、<return>-
  PHP_FLOAT_MAX</return> を使って下さい。 PHP 7.2.0 以降で利用可能。


id: PHP_INT_MAX
type: constant
doc:
<comment>Description:</comment>
  この PHP がサポートする整数型の最大値。32bit のシステムでは 通常は int(2147483647)。 64bit のシス
  テムでは、int(9223372036854775807)。


id: PHP_INT_MIN
type: constant
doc:
<comment>Description:</comment>
  この PHP がサポートする整数型の最小値。通常は、32ビットシステムなら int(-2147483648)、 64ビットシ
  ステムなら int(-9223372036854775808)。 通常は PHP_INT_MIN === ~PHP_INT_MAX となる。


id: PHP_MAJOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  現在の PHP のメジャーバージョンを整数値で表したもの (たとえば、バージョンが "5.2.7-extra" の場合は
  int(5) となる)。


id: PHP_MINOR_VERSION
type: constant
doc:
<comment>Description:</comment>
  現在の PHP のマイナーバージョンを整数値で表したもの (たとえば、バージョンが "5.2.7-extra" の場合は
  int(2) となる)。


id: PHP_OS_FAMILY
type: constant
doc:
<comment>Description:</comment>
  PHP がビルドされたオペレーティングシステムファミリー。 以下のうちひとつです。 <return>'Windows'</return>, <return>'BSD'</return>,
  <return>'Darwin'</return>, <return>'Solaris'</return>, <return>'Linux'</return> or <return>'Unknown'</return>. PHP 7.2.0 以降で利用可能。


id: PHP_OUTPUT_HANDLER_CONT
type: constant
doc:
<comment>Description:</comment>
  バッファはフラッシュされたけれども、出力バッファリングはまだ続くことを表します。
  
  これは <info>PHP_OUTPUT_HANDLER_WRITE</info> のエイリアスです。


id: PHP_OUTPUT_HANDLER_END
type: constant
doc:
<comment>Description:</comment>
  出力バッファリングが終わったことを表します。
  
  これは <info>PHP_OUTPUT_HANDLER_FINAL</info> のエイリアスです。


id: PHP_OUTPUT_HANDLER_STDFLAGS
type: constant
doc:
<comment>Description:</comment>
  出力バッファのフラグのデフォルト設定。 <info>PHP_OUTPUT_HANDLER_CLEANABLE</info> | <info>PHP_OUTPUT_HANDLER_FLUSHABLE</info>
  | <info>PHP_OUTPUT_HANDLER_REMOVABLE</info> と同等です。


id: PHP_PREFIX
type: constant
doc:
<comment>Description:</comment>
  configure 時に設定された --prefix の値。 Windows の場合、configure 時に設定された --with-prefix の
  値になります。


id: PHP_QUERY_RFC1738
type: constant
doc:
<comment>Description:</comment>
  RFC 1738 と <return>application/x-www-form-urlencoded</return> メディアタイプに基づくエンコーディングを行います。
  つまり、スペースはプラス記号 (<return>+</return>) にエンコードされます。


id: PHP_QUERY_RFC3986
type: constant
doc:
<comment>Description:</comment>
  RFC 3986 に基づくエンコーディングを行います。 スペースはパーセントエンコードされて、<return>%20</return> となりま
  す。


id: PHP_RELEASE_VERSION
type: constant
doc:
<comment>Description:</comment>
  現在の PHP のリリースバージョンを整数値で表したもの (たとえば、バージョンが "5.2.7-extra" の場合は
  int(7) となる)。


id: PHP_SESSION_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  セッションが有効で、かつセッションが存在する場合の <strong>session_status()</strong> の戻り値。


id: PHP_SESSION_NONE
type: constant
doc:
<comment>Description:</comment>
  セッションが有効だけれどもセッションが存在しない場合の <strong>session_status()</strong> の戻り値。


id: PHP_SHLIB_SUFFIX
type: constant
doc:
<comment>Description:</comment>
  このプラットフォームの共有ライブラリの拡張子。"so" (多くの Unix 系 OS) や "dll" (Windows) など。


id: PHP_VERSION_ID
type: constant
doc:
<comment>Description:</comment>
  現在の PHP のバージョンを整数値で表したもの。バージョンを比較する際に有用 (たとえば、バージョンが
  "5.2.7-extra" の場合は int(50207) となる)。


id: PHP_WINDOWS_EVENT_CTRL_BREAK
type: constant
doc:
<comment>Description:</comment>
  Windows の <return>CTRL+BREAK</return> イベント。 PHP 7.4.0 から利用可能です。(Windows のみ)


id: PHP_WINDOWS_EVENT_CTRL_C
type: constant
doc:
<comment>Description:</comment>
  Windows の <return>CTRL+C</return> イベント。 PHP 7.4.0 から利用可能です。(Windows のみ)


id: PHP_WINDOWS_NT_SERVER
type: constant
doc:
<comment>Description:</comment>
  これはサーバーシステム (Server 2008/2003/2000 など) です。もしドメインコントローラである場合は
  <info>PHP_WINDOWS_NT_DOMAIN_CONTROLLER</info> と報告されることに注意しましょう。


id: PHP_WINDOWS_VERSION_MAJOR
type: constant
doc:
<comment>Description:</comment>
  Windows のメジャーバージョン。<return>4</return> (NT4/Me/98/95)、 <return>5</return> (XP/2003 R2/2003/2000) あるいは <return>6</return>
  (Vista/2008/7/8/8.1) となります。


id: PHP_WINDOWS_VERSION_MINOR
type: constant
doc:
<comment>Description:</comment>
  Windows のマイナーバージョン。<return>0</return> (Vista/2008/2000/NT4/95)、 <return>1</return> (XP)、<return>2</return> (2003 R2/2003/XP x64)、<return>10</return>
  (98) あるいは <return>90</return> (ME) となります。


id: PHP_WINDOWS_VERSION_PLATFORM
type: constant
doc:
<comment>Description:</comment>
  PHP が現在動作しているプラットフォーム。この値は Windows Vista/XP/2000/NT4, Server 2008/2003 では
  <return>2</return>、 Windows ME/98/95 では <return>1</return> となります。


id: PHP_WINDOWS_VERSION_PRODUCTTYPE
type: constant
doc:
<comment>Description:</comment>
  <return>PHP_WINDOWS_NT_*</return> 定数を決定するために使用する値を含みます。 この値は <return>PHP_WINDOWS_NT_*</return> 定数のいずれ
  かとなり、 プラットフォームの形式を示します。


id: PHP_WINDOWS_VERSION_SP_MAJOR
type: constant
doc:
<comment>Description:</comment>
  インストールされているサービスパックのメジャーバージョン。サービスパックがインストールされていない
  場合は <return>0</return> となります。たとえば Windows XP にサービスパック 3 をインストールした場合、この値は <return>3</return> と
  なります。


id: PHP_WINDOWS_VERSION_SP_MINOR
type: constant
doc:
<comment>Description:</comment>
  インストールされているサービスパックのマイナーバージョン。サービスパックがインストールされていない
  場合は <return>0</return> となります。


id: PHP_WINDOWS_VERSION_SUITEMASK
type: constant
doc:
<comment>Description:</comment>
  Windows のさまざまな機能がインストールされているかどうかを示すビットマスク。 各フィールドの意味に
  ついては以下の表を参照ください。


id: PKCS7_BINARY
type: constant
doc:
<comment>Description:</comment>
  通常は、入力されたメッセージは <return>CR</return> および <return>LF</return> を行端として使用した 「正規化」された形式に変換されま
  す。こらは、S/MIME の規格に 基づくものです。このオプションが指定された場合、変換は行われません。
  この機能は、MIME 形式でないバイナリデータを処理する際に 便利です。


id: PKCS7_DETACHED
type: constant
doc:
<comment>Description:</comment>
  メッセージにサインをする際、MIME型 <return>"multipart/signed"</return> を指定してクリアテキストでサインを行います。
  これは、 <strong>openssl_pkcs7_sign()</strong> において フラグを指定しなかった場合の <strong>$flags</strong> パラメータのデフォルト
  です。このオプションをオフにした場合、 メッセージは不透明なサインによりサインされます。これは、
  メールリレイによる変換に対してより耐性がありますが、S/MIME を サポートしないメールエージェントでは
  読むことはできません。


id: PKCS7_NOATTR
type: constant
doc:
<comment>Description:</comment>
  通常、メッセージがサインされる時、サインした時間やサポートされる 対象アルゴリズムを含む一連の属性
  が付加されます。このオプションを 指定した場合、それらの属性は付加されません。


id: PKCS7_NOCERTS
type: constant
doc:
<comment>Description:</comment>
  メッセージにサインする際、通常はサインをする人の証明書が挿入 されますが、このオプションを指定した
  場合はそうなりません。これに よりサイン付きのメッセージのサイズは小さくなりますが、認証 側が（例え
  ば、<strong>openssl_pkcs7_verify()</strong> の <strong>$extracerts</strong> を用いて渡すことにより） サインをした人の証明書のコピー
  をローカルに用意する必要があります。


id: PKCS7_NOCHAIN
type: constant
doc:
<comment>Description:</comment>
  サインを行った側の証明書の認証の連鎖を行いません。 この場合、サイン付きのメッセージにある証明書を
  未認証の CA として使用しません。


id: PKCS7_NOINTERN
type: constant
doc:
<comment>Description:</comment>
  メッセージを認証する際に、通常、メッセージに含まれる証明書が 証明書にサインする際に検索されます。
  このオプションでは、 <strong>openssl_pkcs7_verify()</strong> の <strong>$extracerts</strong> パラメータで指定した証明書 のみが使用さ
  れます。しかし、指定された証明書を信頼されていな い CA として使用することも可能です。


id: PKCS7_NOOLDMIMETYPE
type: constant
doc:
<comment>Description:</comment>
  PHP 8.3.0 以降で利用可能です。 メッセージを暗号化する場合に、content-type の値として
  <return>application/x-pkcs7-mime</return> ではなく <return>application/pkcs7-mime</return> を設定します。


id: PKCS7_TEXT
type: constant
doc:
<comment>Description:</comment>
  text/plain content type ヘッダを暗号化/署名されたメッセージに 追加します。復号化または認証を行う際
  には、このヘッダは出力から 取り除かれます。復号化または認証されたメッセージがMIME 型 text/plain で
  ない場合、エラーとなります。


id: POSIX_PC_NO_TRUNC
type: constant
doc:
<comment>Description:</comment>
  ファイル名(またはディレクトリ下のファイル) が <info>POSIX_PC_NAME_MAX</info> より長い場合。 PHP 8.3.0 以降で利
  用可能です。


id: POSIX_RLIMIT_AS
type: constant
doc:
<comment>Description:</comment>
  プロセスのアドレススペースの最大値をバイト単位で指定します。 PHP の memory_limit 設定ディレクティ
  ブも参照ください。


id: POSIX_RLIMIT_CPU
type: constant
doc:
<comment>Description:</comment>
  プロセスが使えるCPU時間の上限を秒単位で指定します。 プロセスがソフトリミットに達した場合、SIGXCPU
  シグナルが送られます。 これは <strong>pcntl_signal()</strong> でキャッチできます。 オペレーティングシステムによって
  は、 追加の <return>SIGXCPU</return> シグナルをハードリミットに達する まで1秒ごとに送り、ハードリミットに達すると
  <return>SIGKILL</return> シグナルを送るかもしれません。
  
  See also <strong>set_time_limit()</strong>.


id: POSIX_RLIMIT_DATA
type: constant
doc:
<comment>Description:</comment>
  プロセスのデータセグメントの最大値をバイト単位で指定します。 <strong>brk()</strong> や <strong>sbrk()</strong> を呼ぶ拡張モジュール
  でもない限り、 この設定がPHPの実行に影響を及ぼす可能性は極めて小さいです。


id: POSIX_RLIMIT_MEMLOCK
type: constant
doc:
<comment>Description:</comment>
  The maximum number of bytes that can be locked into memory. メモリ内にロックできるメモリの最大バイ
  ト数。


id: POSIX_RLIMIT_MSGQUEUE
type: constant
doc:
<comment>Description:</comment>
  POSIX メッセージキューのために確保できるバイト数の制限を指定する。 PHP は POSIX メッセージキューを
  サポートしていないので、 このリミットは POSIX メッセージキューをサポートした拡張モジュールを使って
  いない限り効果がありません。


id: POSIX_RLIMIT_NICE
type: constant
doc:
<comment>Description:</comment>
  プロセスが 設定できるnice値 の上限を指定します。 リソース制限値として負の数を指定できないため、<return>20
  - limit</return> という値が実際に使われます。


id: POSIX_RLIMIT_RTPRIO
type: constant
doc:
<comment>Description:</comment>
  <strong>sched_setscheduler()</strong> や <strong>sched_setparam()</strong> システムコール経由で 設定できる、リアルタイム優先度の最大
  値


id: POSIX_RLIMIT_RTTIME
type: constant
doc:
<comment>Description:</comment>
  リアルタイムスケジューリングを採用している場合に スケジューリングされるプロセスが、 ブロッキング型
  のシステムコールを呼び出さずに消費できる CPU時間の最大値をマイクロ秒単位で指定します。


id: PREG_BACKTRACK_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  backtrack limit に達した場合に <strong>preg_last_error()</strong> から返されます。
  
  5.2.0


id: PREG_BAD_UTF8_ERROR
type: constant
doc:
<comment>Description:</comment>
  壊れている UTF8 データによって直近のエラーが発生した場合に <strong>preg_last_error()</strong> から返されます (UTF-8
  モード で正規表現を実行した場合のみ)。
  
  5.2.0


id: PREG_BAD_UTF8_OFFSET_ERROR
type: constant
doc:
<comment>Description:</comment>
  オフセットが妥当な UTF-8 コードポイントの開始位置に対応しない場合に <strong>preg_last_error()</strong> から返されま
  す (UTF-8 モード で正規表現を実行した場合のみ)。
  
  5.3.0


id: PREG_INTERNAL_ERROR
type: constant
doc:
<comment>Description:</comment>
  PCRE 内部エラーが発生した場合に <strong>preg_last_error()</strong> から返されます。
  
  5.2.0


id: PREG_JIT_STACKLIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  直近の PCRE 関数の実行が JIT スタック空間の制限によって失敗した場合に <strong>preg_last_error()</strong> から返され
  ます。
  
  7.0.0


id: PREG_NO_ERROR
type: constant
doc:
<comment>Description:</comment>
  エラーが存在しなかった場合に <strong>preg_last_error()</strong> から返されます。
  
  5.2.0


id: PREG_PATTERN_ORDER
type: constant
doc:
<comment>Description:</comment>
  $matches[0] はパターン全体にマッチした文字列の配列、 $matches[1] は第 1 のキャプチャ用サブパターン
  にマッチした文字列の配列、 といったように結果の順序を指定します。 このフラグは、<strong>preg_match_all()</strong>
  でのみ使用されます。


id: PREG_RECURSION_LIMIT_ERROR
type: constant
doc:
<comment>Description:</comment>
  recursion limit に達した場合に <strong>preg_last_error()</strong> から返されます。
  
  5.2.0


id: PREG_SET_ORDER
type: constant
doc:
<comment>Description:</comment>
  $matches[0] は 1 回目のマッチングでキャプチャした値の配列、 $matches[1] は 2 回目のマッチングで
  キャプチャした値の配列、 といったように結果の順序を指定します。 このフラグは、<strong>preg_match_all()</strong> で
  のみ使用されます。


id: PREG_SPLIT_DELIM_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  このフラグは、<strong>preg_split()</strong> が 文字列分割用のパターン中のカッコによるサブパターンでキャプチャされた
  値も 同時に返すようにします。


id: PREG_SPLIT_OFFSET_CAPTURE
type: constant
doc:
<comment>Description:</comment>
  このフラグを設定した場合、各マッチに対応する文字列のオフセットも返されます。 これにより、戻り値は
  配列となり、配列の要素 0 はマッチした文字列、 要素 1  は対象文字列中におけるマッチした文字列のオフ
  セット値となることに注意してください。  このフラグは <strong>preg_split()</strong> のみで使用されます。


id: PREG_UNMATCHED_AS_NULL
type: constant
doc:
<comment>Description:</comment>
  このフラグは、 <strong>preg_match()</strong> と <strong>preg_match_all()</strong> 関数で マッチしなかったサブパターンがあった場合
  に、 $matches に <info>null</info> を入れることで伝えます。 このフラグがないと、マッチしなかったサブパターンは
  いかにも空文字列にマッチしたかのように空文字列として通知されます。 このフラグを設定することで、こ
  れらふたつの場合を区別できます。
  
  7.2.0


id: PSFS_ERR_FATAL
type: constant
doc:
<comment>Description:</comment>
  <return>返値</return>: ユーザー空間のフィルタにおいて、 復旧不可能なエラーが発生したことを示します。 (つまり、不正
  なデータを受け取ったということです。)


id: PSFS_FEED_ME
type: constant
doc:
<comment>Description:</comment>
  <return>返値</return>: ユーザー空間のフィルタが <strong>$out</strong> にバケットを返さなかったことを 示します。(つまり、変換された
  データを返す用意ができていないという ことです。)


id: PSFS_PASS_ON
type: constant
doc:
<comment>Description:</comment>
  <return>返値</return>: ユーザー空間のフィルタが バケットを <strong>$out</strong> に返したことを 示します。


id: PTHREADS_ALLOW_HEADERS
type: constant
doc:
<comment>Description:</comment>
  Allow new Threads to send headers to standard output (normally prohibited)


id: PTHREADS_INHERIT_ALL
type: constant
doc:
<comment>Description:</comment>
  The default options for all Threads, causes pthreads to copy the environment when new Threads are
  started


id: ParentIterator
type: class
doc:
<comment>Description:</comment>
  これは <class>FilterIterator</class> を継承したクラスで、 <class>RecursiveIteratorIterator</class> を使った再帰的な反復処理をで
  きるようにします。 ただし、子を持つ要素しか表示しません。


id: ParentIterator::__construct
type: function
doc:
<comment>Description:</comment>
  ParentIterator を作成する
  
  イテレータ上に <class>ParentIterator</class> を作成します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>RecursiveIterator</info>  <strong>$iterator</strong>  作成する元となるイテレータ。


id: ParentIterator::accept
type: function
doc:
<comment>Description:</comment>
  受け入れ可能かどうかを調べる
  
  現在の要素が子を持っているかどうかを調べます。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  受け入れ可能な場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * ParentIterator::hasChildren
   * FilterIterator::accept


id: ParentIterator::getChildren
type: function
doc:
<comment>Description:</comment>
  ParentIterator に含まれる内部イテレータの子を返す
  
  ParentIterator に含まれる内部イテレータの子を取得します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>ParentIterator</info>  オブジェクトを返します。


id: ParentIterator::hasChildren
type: function
doc:
<comment>Description:</comment>
  内部イテレータの現在の要素が子を持つかどうかをチェックする
  
  内部イテレータの現在の要素が子を持つかどうかをチェックします。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: ParentIterator::next
type: function
doc:
<comment>Description:</comment>
  イテレータを前に移動する
  
  イテレータを前に移動します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: ParentIterator::rewind
type: function
doc:
<comment>Description:</comment>
  イテレータを巻き戻す
  
  イテレータを巻き戻します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\ErrorInfo
type: class
doc:
<comment>Description:</comment>
  The class represents detailed error information as supplied by Parle\Parser::errorInfo


id: Parle\INTERNAL_UTF32
type: constant
doc:
<comment>Description:</comment>
  Flag whether the internal UTF-32 support is compiled in. Available since parle 0.7.2.


id: Parle\Lexer
type: class
doc:
<comment>Description:</comment>
  Single state lexer class. Lexemes can be defined on the fly. If the particular lexer instance is
  meant to be used with <class>Parle\Parser</class>, the token IDs need to be taken from there. Otherwise,
  arbitrary token IDs can be supplied. This lexer can give a certain performance advantage over
  <class>Parle\RLexer</class>, if no multiple states are required. Note, that <class>Parle\RParser</class> is not compatible with
  this lexer.


id: Parle\Lexer::advance
type: function
doc:
<comment>Description:</comment>
  Process next lexer rule
  
  Processes the next rule and prepares the resulting token data.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::build
type: function
doc:
<comment>Description:</comment>
  Finalize the lexer rule set
  
  Rules, previously added with Parle\Lexer::push are finalized. This method call has to be done
  after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::callout
type: function
doc:
<comment>Description:</comment>
  Define token callback
  
  Define a callback to be invoked once lexer encounters a particular token.

<comment>Param:</comment>
  <info>int</info>       <strong>$id</strong>        Token id.
  <info>callable</info>  <strong>$callback</strong>  Callable to be invoked. The callable doesn't receive any arguments and its
                       return value is ignored.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::consume
type: function
doc:
<comment>Description:</comment>
  Pass the data for processing
  
  Consume the data for lexing.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Data to be lexed.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::dump
type: function
doc:
<comment>Description:</comment>
  Dump the state machine
  
  Dump the current state machine to stdout.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::getToken
type: function
doc:
<comment>Description:</comment>
  Retrieve the current token
  
  Retrieve the current token.

<comment>Return:</comment>
  <info>Parle\Token</info>  Returns an instance of <class>Parle\Token</class>.


id: Parle\Lexer::insertMacro
type: function
doc:
<comment>Description:</comment>
  Insert regex macro
  
  Insert a regex macro, that can be later used as a shortcut and included in other regular
  expressions.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Name of the macros.
  <info>string</info>  <strong>$regex</strong>  Regular expression.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::push
type: function
doc:
<comment>Description:</comment>
  Add a lexer rule
  
  Push a pattern for lexeme recognition.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>  Regular expression used for token matching.
  <info>int</info>     <strong>$id</strong>     Token id. If the lexer instance is meant to be used standalone, this can be an
                  arbitrary number. If the lexer instance is going to be passed to the parser, it
                  has to be an id returned by Parle\Parser::tokenid.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Lexer::reset
type: function
doc:
<comment>Description:</comment>
  Reset lexer
  
  Reset lexing optionally supplying the desired offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$pos</strong>  Reset position.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser
type: class
doc:
<comment>Description:</comment>
  Parser class. Rules can be defined on the fly. Once finalized, a <class>Parle\Lexer</class> instance is required
  to deliver the token stream.


id: Parle\Parser::advance
type: function
doc:
<comment>Description:</comment>
  Process next parser rule
  
  Process next parser rule.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::build
type: function
doc:
<comment>Description:</comment>
  Finalize the grammar rules
  
  Any tokens and grammar rules previously added are finalized. The rule set becomes readonly and the
  parser is ready to start.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::consume
type: function
doc:
<comment>Description:</comment>
  Consume the data for processing
  
  Consume the data for parsing.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   Data to be parsed.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                       grammar.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::dump
type: function
doc:
<comment>Description:</comment>
  Dump the grammar
  
  Dump the current grammar to stdout.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Retrieve the error information
  
  Retrieve the error information in case Parle\Parser::action returned the error action.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Returns an instance of <class>Parle\ErrorInfo</class>.


id: Parle\Parser::left
type: function
doc:
<comment>Description:</comment>
  Declare a token with left-associativity
  
  Declare a terminal with left associativity.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::nonassoc
type: function
doc:
<comment>Description:</comment>
  Declare a token with no associativity
  
  Declare a terminal, that cannot appear more than once in the row.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::precedence
type: function
doc:
<comment>Description:</comment>
  Declare a precedence rule
  
  Declares a precedence rule for a fictitious terminal symbol. This rule can be later used in the
  specific grammar rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::push
type: function
doc:
<comment>Description:</comment>
  Add a grammar rule
  
  Push a grammar rule. The production id returned can be used later in the parsing process to
  identify the rule matched.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Rule name.
  <info>string</info>  <strong>$rule</strong>  The rule to be added. The syntax is Bison compatible.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> representing the rule index.


id: Parle\Parser::reset
type: function
doc:
<comment>Description:</comment>
  Reset parser state
  
  Reset parser state using the given token id.

<comment>Param:</comment>
  <info>int</info>  <strong>$tokenId</strong>  Token id.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::right
type: function
doc:
<comment>Description:</comment>
  Declare a token with right-associativity
  
  Declare a terminal with right associativity.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::sigil
type: function
doc:
<comment>Description:</comment>
  Retrieve a matching part of a rule
  
  Retrieve a part of the match by a rule. This method is equivalent to the pseudo variable
  functionality in Bison.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Match index, zero based.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> with the matched part.


id: Parle\Parser::sigilCount
type: function
doc:
<comment>Description:</comment>
  Number of elements in matched rule
  
  Get number of elements in the matched rule.

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


id: Parle\Parser::sigilName
type: function
doc:
<comment>Description:</comment>
  Retrieve a rule or token name
  
  Retrieve a partial rule name or token name corresponding to the sigil index.

<comment>Param:</comment>
  <info>int</info>  <strong>$idx</strong>  Match index, zero based.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> with the matched part.


id: Parle\Parser::token
type: function
doc:
<comment>Description:</comment>
  Declare a token
  
  Declare a terminal to be used in the grammar.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Parser::tokenId
type: function
doc:
<comment>Description:</comment>
  Get token id
  
  Retrieve the id of the named token.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Name of the token as used in Parle\Parser::token.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> representing the token id.


id: Parle\Parser::trace
type: function
doc:
<comment>Description:</comment>
  Trace the parser operation
  
  Retrieve the current parser operation description. This can be especially useful for studying the
  parser and to optimize the grammar.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> with the trace information.


id: Parle\Parser::validate
type: function
doc:
<comment>Description:</comment>
  Validate input
  
  Validate an input string. The string is parsed internally, thus this method is useful for the
  quick input validation.

<comment>Param:</comment>
  <info>string</info>       <strong>$data</strong>   String to be validated.
  <info>Parle\Lexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                       grammar.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>bool</info> witnessing whether the input chimes or not with the defined rules.


id: Parle\RLexer
type: class
doc:
<comment>Description:</comment>
  Multistate lexer class. Lexemes can be defined on the fly. If the particular lexer instance is
  meant to be used with <class>Parle\RParser</class>, the token IDs need to be taken from there. Otherwise,
  arbitrary token IDs can be supplied. Note, that <class>Parle\Parser</class> is not compatible with this lexer.


id: Parle\RLexer::build
type: function
doc:
<comment>Description:</comment>
  Finalize the lexer rule set
  
  Rules, previously added with Parle\RLexer::push are finalized. This method call has to be done
  after all the necessary rules was pushed. The rule set becomes read only. The lexing can begin.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\RLexer::getToken
type: function
doc:
<comment>Description:</comment>
  Retrieve the current token
  
  Retrive the current token.

<comment>Return:</comment>
  <info>Parle\Token</info>  Returns an instance of <class>Parle\Token</class>.


id: Parle\RLexer::push
type: function
doc:
<comment>Description:</comment>
  Add a lexer rule
  
  Push a pattern for lexeme recognition.
  
  A 'start state' and 'exit state' can be specified by using a suitable signature.

<comment>Param:</comment>
  <info>string</info>  <strong>$regex</strong>     Regular expression used for token matching.
  <info>int</info>     <strong>$id</strong>        Token id. If the lexer instance is meant to be used standalone, this can be an
                     arbitrary number. If the lexer instance is going to be passed to the parser, it
                     has to be an id returned by Parle\RParser::tokenid.
  <info>string</info>  <strong>$state</strong>     State name. If '*' is used as start state, then the rule is applied to all
                     lexer states.
  <info>string</info>  <strong>$newState</strong>  New state name, after the rule was applied.
                     
                     If '.' is specified as the exit state, then the lexer state is unchanged when
                     that rule matches. An exit state with '&gt;' before the name means push. Use
                     the signature without id for either continuation or to start matching, when a
                     continuation or recursion is required.
                     
                     If '\<' is specified as exit state, it means pop. In that case, the signature containing the id can be used to identify the match. Note that even in the case an id is specified, the rule will finish first when all the previous pushes popped.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\RLexer::pushState
type: function
doc:
<comment>Description:</comment>
  Push a new start state
  
  This lexer type can have more than one state machine. This allows you to lex different tokens
  depending on context, thus allowing simple parsing to take place. Once a state pushed, it can be
  used with a suitable Parle\RLexer::push signature variant.

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

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


id: Parle\RParser
type: class
doc:
<comment>Description:</comment>
  Parser class. Rules can be defined on the fly. Once finalized, a <class>Parle\RLexer</class> instance is required
  to deliver the token stream.


id: Parle\RParser::advance
type: function
doc:
<comment>Description:</comment>
  Process next parser rule
  
  Prosess next parser rule.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\RParser::consume
type: function
doc:
<comment>Description:</comment>
  Consume the data for processing
  
  Consume the data for parsing.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>   Data to be parsed.
  <info></info>        <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular grammar.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\RParser::errorInfo
type: function
doc:
<comment>Description:</comment>
  Retrieve the error information
  
  Retrieve the error information in case Parle\RParser::action returned the error action.

<comment>Return:</comment>
  <info>Parle\ErrorInfo</info>  Returns an instance of <class>Parle\ErrorInfo</class>.


id: Parle\RParser::precedence
type: function
doc:
<comment>Description:</comment>
  Declare a precedence rule
  
  Declares a precedence rule for a fictious terminal symbol. This rule can be later used in the
  specific grammar rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Token name.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\RParser::tokenId
type: function
doc:
<comment>Description:</comment>
  Get token id
  
  Retrieve the id of the named token.

<comment>Param:</comment>
  <info>string</info>  <strong>$tok</strong>  Name of the token as used in Parle\RParser::token.

<comment>Return:</comment>
  <info>int</info>  Returns <info>int</info> representing the token id.


id: Parle\RParser::trace
type: function
doc:
<comment>Description:</comment>
  Trace the parser operation
  
  Retrieve the current parser operation description. This can be especially useful to study the
  parser and to optimize the grammar.

<comment>Return:</comment>
  <info>string</info>  Returns a <info>string</info> with the trace information.


id: Parle\RParser::validate
type: function
doc:
<comment>Description:</comment>
  Validate input
  
  Validate an input string. The string is parsed internally, thus this method is useful for the
  quick input validation.

<comment>Param:</comment>
  <info>string</info>        <strong>$data</strong>   String to be validated.
  <info>Parle\RLexer</info>  <strong>$lexer</strong>  A lexer object containing the lexing rules prepared for the particular
                        grammar.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>bool</info> whitnessing whether the input chimes or not with the defined rules.


id: Parle\Stack
type: class
doc:
<comment>Description:</comment>
  <class>Parle\Stack</class> is a LIFO stack. The elements are inserted and removed only from one end.


id: Parle\Stack::pop
type: function
doc:
<comment>Description:</comment>
  Pop an item from the stack

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Stack::push
type: function
doc:
<comment>Description:</comment>
  Push an item into the stack

<comment>Param:</comment>
  <info>mixed</info>  <strong>$item</strong>  Variable to be pushed.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Parle\Token
type: class
doc:
<comment>Description:</comment>
  This class represents a token. Lexer returns instances of this class.


id: PgSql\Lob
type: class
doc:
<comment>Description:</comment>
  PHP 8.1.0 以降、<return>pgsql large object</return> リソースを置き換える、完全不定形クラスです。


id: PgSql\Result
type: class
doc:
<comment>Description:</comment>
  PHP 8.1.0 以降、<return>pgsql result</return> リソースを置き換える、完全不定形クラスです。


id: Phar::PHP
type: constant
doc:
<comment>Description:</comment>
  <strong>Phar::webPhar()</strong> の mimeoverrides パラメータに対して、その拡張子を PHP ファイルとしてパースするよう
  指示する


id: Phar::PHPS
type: constant
doc:
<comment>Description:</comment>
  <strong>Phar::webPhar()</strong> の mimeoverrides パラメータに対して、その拡張子を PHP ファイルとしてパースして
  <strong>highlight_file()</strong> を通すよう指示する


id: Phar::__construct
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブオブジェクトを作成する

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  既存の Phar アーカイブ、あるいは作成したいアーカイブへのパス。 ファイル名
                          の拡張子は .phar にする必要があります。
  <info>int</info>          <strong>$flags</strong>     親クラス <class>RecursiveDirectoryIterator</class> に渡すフラグ。
  <info>string|null</info>  <strong>$alias</strong>     ストリーム機能をコールする場合に Phar アーカイブが参照するエイリアス。


id: Phar::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  空のディレクトリを phar アーカイブに追加する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドを使用すると、空のディレクトリが <return>dirname</return> に作成されます。このメソッドは
  <strong>ZipArchive::addEmptyDir()</strong> と同じようなものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  phar アーカイブ内に作成する空のディレクトリの名前。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>PharData::addEmptyDir()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addFromString()</strong>


id: Phar::addFile
type: function
doc:
<comment>Description:</comment>
  ファイルシステム上のファイルを phar アーカイブに追加する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドを使用すると、任意のファイルあるいは URL を phar アーカイブに追加することができます。
  オプションの 2 番目のパラメータ <strong>$localName</strong> が文字列の場合、 ファイルはその名前でアーカイブ内に格納
  されます。指定しなかった場合は、 <return>file</return> パラメータをアーカイブ内のパスとして使用します。 URL を使用
  する場合は、localname を指定しないと例外がスローされます。 このメソッドは <strong>ZipArchive::addFile()</strong> と
  同じようなものです。

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   phar アーカイブに追加したいディスク上のファイルへのフルパスあるいは相対パ
                           ス。
  <info>string|null</info>  <strong>$localName</strong>  ファイルをアーカイブ内に格納するときのパス。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::addFromString
type: function
doc:
<comment>Description:</comment>
  文字列から、ファイルを phar アーカイブに追加する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドを使用すると、任意の文字列を phar アーカイブに追加することができます。 アーカイブ内の
  ファイル名は <return>localname</return> で指定したものとなります。 このメソッドは <strong>ZipArchive::addFromString()</strong> と同
  じようなものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  ファイルをアーカイブ内に格納するときのパス。
  <info>string</info>  <strong>$contents</strong>   ファイルに保存する内容。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>Phar::addEmptyDir()</strong>


id: Phar::apiVersion
type: function
doc:
<comment>Description:</comment>
  API のバージョンを返す
  
  phar ファイルフォーマットの API バージョンを返します。 phar を作成する際にこのバージョンが使用され
  ます。 Phar 拡張モジュールが読み込みをサポートしているのは、 バージョン 1.0.0 以降の API です。
  SHA-256 や SHA-512 を使用するには API バージョン 1.1.0 以降が、 そして空のディレクトリを格納するに
  は API バージョン 1.1.1 以降が必要です。

<comment>Return:</comment>
  <info>string</info>  API のバージョンを、<return>"1.0.0"</return> のような文字列で返します。


id: Phar::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  ディレクトリ内のファイルから phar を作成する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  ディレクトリの中身をもとに phar アーカイブを作成します。 オプションの 2 番目のパラメータで正規表現
  (pcre) を指定すると、特定のファイルを除外することができます。 正規表現にマッチするすべてのファイル
  がアーカイブに含められ、 それ以外のファイルは除外されます。より詳細に制御するには
  <strong>Phar::buildFromIterator()</strong> を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  アーカイブに追加するすべてのファイルを含むディレクトリへの フルパスあるいは相
                      対パス。
  <info>string</info>  <strong>$pattern</strong>    オプションで指定する pcre 正規表現。 これを使用してファイル一覧をフィルタリン
                      グします。 正規表現にマッチするファイルパスのみがアーカイブに追加されます。

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> は、連想配列を返します。これは、 ファイルの内部パスをファイルシ
         ステム上のフルパスを対応させたものです。

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: Phar::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  イテレータから phar アーカイブを作成する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar アーカイブをイテレータから作成します。 サポートするイテレータは二種類で、 phar 内のファイル名
  とディスク上の実際のファイル名を対応させたものか、あるいは DirectoryIterator のように SplFileInfo
  オブジェクトを返すものです。 SplFileInfo オブジェクトを返すイテレータの場合は、2 番目のパラメータ
  が必要となります。

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       phar ファイルと実際の場所の関連を返すイテレータ、 あるいは
                               SplFileInfo オブジェクトを返すイテレータ。
  <info>string|null</info>  <strong>$baseDirectory</strong>  SplFileInfo オブジェクトを返すイテレータを指定した際、 phar アーカイ
                               ブへの追加時にフルパスから取り除く部分。

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromIterator()</strong> は連想配列を返します。 これは、ファイルの内部パスとファイルシステ
         ム上のフルパスを対応させたものです。

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>


id: Phar::canCompress
type: function
doc:
<comment>Description:</comment>
  phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す
  
  これは、圧縮されたファイルを含む phar を読み込む前に、 圧縮が可能かどうかを調べるために使用しま
  す。

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return> のいずれかを指定し、指定した圧縮アルゴリズムでの圧
                     縮が可能かどうかを調べます。

<comment>Return:</comment>
  <info>bool</info>  圧縮/展開 が可能な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::canWrite
type: function
doc:
<comment>Description:</comment>
  phar 拡張モジュールが phar の書き込みや作成をサポートしているかどうかを返す
  
  このstaticメソッドは、書き込みアクセスが php.ini の phar.readonly で無効にされているかどうかを調べ
  ます。

<comment>Return:</comment>
  <info>bool</info>  書き込みが可能な場合に <info>true</info>、そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * phar.readonly
   * <strong>Phar::isWritable()</strong>


id: Phar::compress
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  tar 形式あるいは phar 形式の phar アーカイブの場合は、 このメソッドはアーカイブ全体を gzip あるい
  は bzip2 で圧縮します。 できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、
  Phar 拡張モジュールで直接透過的に使用することもできます。
  
  zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮するために
  は zlib 拡張モジュールが、そして bzip2 で圧縮するためには bzip2 拡張モジュールが有効になっていなけ
  ればなりません。 この関数は phar の内容を変更するので、使用するには INI 設定 phar.readonly が off
  になっていなければなりません。
  
  さらに、このメソッドは自動的にアーカイブの名前を変更し、 <return>.gz</return> あるいは <return>.bz2</return> を追加します。
  <return>Phar::NONE</return> を渡して圧縮を解除した場合は拡張子も削除します。 もうひとつの方法として、ファイルの拡張
  子を 2 番目のパラメータで指定することもできます。

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  圧縮を行う場合には <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return>、圧縮を解除する場合には
                             <return>Phar::NONE</return> を指定します。
  <info>string|null</info>  <strong>$extension</strong>    デフォルトでは、phar 形式のアーカイブを圧縮する際の拡張子は <return>.phar.gz</return> あ
                             るいは <return>.phar.bz2</return> となり、tar 形式のアーカイブを圧縮する際の拡張子は
                             <return>.phar.tar.gz</return> あるいは <return>.phar.tar.bz2</return> となります。伸長の際は、デフォルト
                             の拡張子は <return>.phar</return> および <return>.phar.tar</return> となります。

<comment>Return:</comment>
  <info>Phar|null</info>  <class>Phar</class> オブジェクトを返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::compressFiles
type: function
doc:
<comment>Description:</comment>
  現在の Phar アーカイブ内のすべてのファイルを圧縮する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  tar 形式の phar アーカイブでは、このメソッドは <class>BadMethodCallException</class> をスローします。 というの
  も、tar ファイルフォーマットではアーカイブ内の個別のファイルの圧縮をサポートしていないからです。
  <strong>Phar::compress()</strong> を使用して、tar 形式の phar アーカイブ全体を圧縮します。
  
  zip 形式および phar 形式の phar アーカイブでは、 このメソッドは Phar アーカイブ内のすべてのファイ
  ルを指定した方式で圧縮します。 この機能を使用するには、zlib 拡張モジュールあるいは bzip2 拡張モ
  ジュールが有効になっている必要があります。さらに、 もし既に bzip2/zlib で圧縮されているファイルが
  ある場合は、 いったんその圧縮を解除するために対応する拡張モジュールが必要となります。 この関数は
  phar の内容を変更するので、使用するためには INI 設定 phar.readonly が off になっている必要がありま
  す。

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  圧縮を行う場合は <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return>、圧縮を解除するためには <return>Phar::NONE</return>
                     のいずれかを指定しなければなりません。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::convertToData
type: function
doc:
<comment>Description:</comment>
  phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する
  
  このメソッドは、実行可能な phar アーカイブを tar あるいは zip ファイルに変換します。 tar あるいは
  zip を実行可能ではない形式にするため、 phar スタブおよび phar エイリアスファイルはアーカイブから削
  除されます。
  
  何も変更しなかった場合、もしアーカイブが phar 形式ならこのメソッドは <class>BadMethodCallException</class> をス
  ローします。 tar あるいは zip 形式のアーカイブの場合は、 このメソッドはアーカイブを実行可能でない
  形式に変換します。
  
  成功した場合は、このメソッドはディスク上に新しいアーカイブを作成して <class>PharData</class> オブジェクトを返しま
  す。 古いアーカイブは削除されずディスク上に残るので、 処理を終えたら手動で削除する必要があります。

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       これは <return>Phar::TAR</return> あるいは <return>Phar::ZIP</return> のいずれかとなります。 <info>null</info> を指定
                             すると、現在のファイル形式をそのまま保持します。
  <info>int|null</info>     <strong>$compression</strong>  アーカイブ全体の圧縮を行わない場合は <return>Phar::NONE</return>、 zlib による圧縮の場合
                             は <return>Phar::GZ</return>、そして bzip による圧縮の場合は <return>Phar::BZ2</return> のいずれかを指定
                             します。
  <info>string|null</info>  <strong>$extension</strong>    このパラメータは、変換後のアーカイブのデフォルトのファイル拡張子を変更
                             します。 実行可能でない tar や zip アーカイブのファイル名としては <return>.phar</return>
                             は使用できないことに注意しましょう。
                             
                             tar 形式の phar アーカイブの場合、デフォルトの拡張子は圧縮形式によって
                             <return>.tar</return>、<return>.tar.gz</return>、 <return>.tar.bz2</return> のいずれかとなります。 zip 形式のアーカイブの
                             場合、デフォルトの拡張子は <return>.zip</return> となります。

<comment>Return:</comment>
  <info>PharData|null</info>  このメソッドは、成功した場合に <class>PharData</class> オブジェクトを返します。失敗した場合は <info>null</info>
                 を返します。

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  phar アーカイブを実行可能な別の phar アーカイブ形式に変換する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドは、phar アーカイブを別のファイル形式に変換します。 たとえば、zip 形式の実行可能な
  phar アーカイブあるいは phar 形式の実行可能な phar アーカイブから tar 形式の実行可能な phar アーカ
  イブを作成することができます。 さらに、tar あるいは phar 形式のアーカイブについてはアーカイブ全体
  を圧縮することもできます。
  
  何も変更しなかった場合、このメソッドは <class>BadMethodCallException</class> をスローします。
  
  成功した場合は、このメソッドはディスク上に新しいアーカイブを作成して <class>Phar</class> オブジェクトを返します。
  古いアーカイブは削除されずディスク上に残るので、 処理を終えたら手動で削除する必要があります。

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       これは <return>Phar::PHAR</return>、<return>Phar::TAR</return> あるいは <return>Phar::ZIP</return> のいずれかとなります。
                             <info>null</info> を指定すると、現在のファイル形式をそのまま保持します。
  <info>int|null</info>     <strong>$compression</strong>  アーカイブ全体の圧縮を行わない場合は <return>Phar::NONE</return>、 zlib による圧縮の場合
                             は <return>Phar::GZ</return>、そして bzip による圧縮の場合は <return>Phar::BZ2</return> のいずれかを指定
                             します。
  <info>string|null</info>  <strong>$extension</strong>    このパラメータは、変換後のアーカイブのデフォルトのファイル拡張子を変更
                             します。 実行可能でない tar や zip アーカイブのファイル名としては <return>.phar</return>
                             は使用できないことに注意しましょう。
                             
                             phar 形式のアーカイブに変換する場合、デフォルトの拡張子は圧縮形式によっ
                             て <return>.phar</return>、<return>.phar.gz</return> あるいは <return>.phar.bz2</return> のいずれかとなります。tar 形式の
                             アーカイブの場合、デフォルトの拡張子は <return>.phar.tar</return>、<return>.phar.tar.gz</return> および
                             <return>.phar.tar.bz2</return> です。zip 形式のアーカイブの場合、 デフォルトの拡張子は
                             <return>.phar.zip</return> となります。

<comment>Return:</comment>
  <info>Phar|null</info>  このメソッドは、成功した場合に <class>Phar</class> オブジェクトを返します。失敗した場合は <info>null</info> を返し
             ます。

<comment>See Also:</comment>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>
   * <strong>PharData::convertToData()</strong>


id: Phar::copy
type: function
doc:
<comment>Description:</comment>
  phar アーカイブ内のファイルを、phar 内で別の新しいファイルとしてコピーする
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar アーカイブ内のファイルを、そのアーカイブ内で別の新しいファイルとしてコピーします。 これは、
  phar ストリームラッパーでの <strong>copy()</strong> と同等の操作をオブジェクト指向で行うものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。しかし、より安全を期すなら try/catch ブロック内で使用して例
        外がスローされないことを確認するといいでしょう。


id: Phar::count
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブ内のエントリ (ファイル) の数を返す

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  <strong>$mode</strong> は、数え上げるモードを指定する整数です。 デフォルトは、<info>COUNT_NORMAL</info> です。 これ
              は、削除されたり、隠されたりしていない、アーカイブ内のアイテムの数を数えます。
              <info>COUNT_RECURSIVE</info> に設定すると、 削除されたり、既に隠されたものを含む、アーカイブ内のす
              べてのアイテムの数を数えます。

<comment>Return:</comment>
  <info>int</info>  この phar ファイルに含まれるファイルの数を返します。 存在しない場合は <return>0</return> (数字のゼロ) を返しま
       す。


id: Phar::createDefaultStub
type: function
doc:
<comment>Description:</comment>
  phar ファイルフォーマット用のスタブを作成する
  
  このメソッドは、phar ファイル形式のスタブを作成するためのもので、 tar 形式や zip 形式の phar アー
  カイブでは使用しません。
  
  PHP でかかれた起動ローダー (スタブ) を含む Phar アーカイブを PHP から実行するには、次のようにそれ
  をインクルードするか、  ]]> あるいは単に実行します。
  
  このメソッドは、phar アーカイブの起動時に実行するスタブ用のメソッドを作成します。 さらに、phar
  アーカイブをコマンドラインやウェブサーバーから実行する際には別のファイルを指定することもできます。
  ローダースタブは <strong>Phar::interceptFileFuncs()</strong> もコールでき、PHP のアプリケーションからファイルシステ
  ムを簡単に扱えるようになります。 phar 拡張モジュールが存在しない場合は、 ローダースタブが phar
  アーカイブの内容を一時ディレクトリに展開し、 そのファイルを操作します。 シャットダウン関数が、この
  一時ファイル群を削除します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     コマンドラインからアクセスする場合に、 実行する phar アーカイブ内の相対パ
                          ス。
  <info>string|null</info>  <strong>$webIndex</strong>  Webブラウザからアクセスする場合に、 実行する phar アーカイブ内の相対パス。

<comment>Return:</comment>
  <info>string</info>  独自の起動ローダー (スタブ) を文字列で返します。 これを用いて作成した Phar アーカイブは、
          Phar 拡張モジュールが有効になっていない環境でも実行することができます。

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::getStub()</strong>


id: Phar::decompress
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブ全体の圧縮を解除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  tar 形式あるいは phar 形式の phar アーカイブの場合は、 このメソッドはアーカイブ全体の圧縮を解除し
  ます。
  
  zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮されたファ
  イルの圧縮を解除するためには zlib 拡張モジュールが、そして bzip2 で圧縮されたファイルの圧縮を解除
  するためには bzip2 拡張モジュールが有効になっていなければなりません。 この関数は phar の内容を変更
  するので、使用するには INI 設定 phar.readonly が off になっていなければなりません。
  
  さらに、このメソッドは自動的にアーカイブの拡張子を変更し、 phar アーカイブなら <return>.phar</return>、 tar 形式の
  アーカイブなら <return>.phar.tar</return> をデフォルトで追加します。 もうひとつの方法として、ファイルの拡張子を 2
  番目のパラメータで指定することもできます。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  圧縮を解除する場合、デフォルトのファイル拡張子は <return>.phar</return> および <return>.phar.tar</return>
                           です。 このパラメータを使用すると、別の拡張子を指定することができます。
                           実行可能な phar アーカイブは、ファイル名に必ず <return>.phar</return> を含まなければならな
                           いことに注意しましょう。

<comment>Return:</comment>
  <info>Phar|null</info>  <class>Phar</class> オブジェクトを返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::decompressFiles
type: function
doc:
<comment>Description:</comment>
  現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  tar 形式の phar アーカイブでは、このメソッドは <class>BadMethodCallException</class> をスローします。 というの
  も、tar ファイルフォーマットではアーカイブ内の個別のファイルの圧縮をサポートしていないからです。
  <strong>Phar::compress()</strong> を使用して、tar 形式の phar アーカイブ全体を圧縮します。
  
  zip 形式および phar 形式の phar アーカイブでは、 このメソッドは Phar アーカイブ内のすべてのファイ
  ルの圧縮を解除します。 もし bzip2/zlib で圧縮されているファイルがある場合は、 この機能を使用するに
  は、zlib 拡張モジュールあるいは bzip2 拡張モジュールが有効になっている必要があります。 この関数は
  phar の内容を変更するので、使用するためには INI 設定 phar.readonly が off になっている必要がありま
  す。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>


id: Phar::delMetadata
type: function
doc:
<comment>Description:</comment>
  phar のグローバルメタデータを削除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar のグローバルメタデータを削除します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。しかし、より安全を期すなら try/catch ブロック内で使用して例
        外がスローされないことを確認するといいでしょう。

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::delete
type: function
doc:
<comment>Description:</comment>
  phar アーカイブ内のファイルを削除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  アーカイブ内のファイルを削除します。 これは、ストリームラッパー上で <strong>unlink()</strong> をコールするのと同じ
  意味です。以下に例を示します。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  削除したいファイルの、アーカイブ内でのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 しかし、例外がスローされているかどうかを確認したうえで 例外
        がなければ成功とみなすほうがいいでしょう。

<comment>See Also:</comment>
   * <strong>PharData::delete()</strong>
   * <strong>Phar::unlinkArchive()</strong>


id: Phar::extractTo
type: function
doc:
<comment>Description:</comment>
  phar アーカイブの内容をディレクトリに展開する
  
  phar アーカイブ内のすべてのファイルをディスクに展開します。 展開されたファイルやディレクトリは、
  アーカイブに保存されたときのパーミッションを維持しています。 オプションのパラメータを使用すると、
  どのファイルを展開するかを制御したり 既存のファイルを上書きするかどうかを指定したりすることができ
  ます。 2 番目のパラメータ <strong>$files</strong> には、 展開したいファイルやディレクトリの名前、あるいはその配列を
  指定します。 デフォルトでは、このメソッドは既存のファイルを上書きしません。 3 番目のパラメータを
  true にすると既存のファイルを上書きさせることができます。 このメソッドは <strong>ZipArchive::extractTo()</strong>
  と同じようなものです。

<comment>Param:</comment>
  <info>string</info>             <strong>$directory</strong>  指定した <strong>$files</strong> の展開先のパス。
  <info>array|string|null</info>  <strong>$files</strong>      展開したいファイル名/ディレクトリ名、あるいはその配列。 この引数を
                                 スキップするには <info>null</info> を指定します。
  <info>bool</info>               <strong>$overwrite</strong>  <info>true</info> にすると既存のファイルを上書きします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 しかし、例外がスローされているかどうかを確認したうえで 例外
        がなければ成功とみなすほうがいいでしょう。

<comment>See Also:</comment>
   * <strong>PharData::extractTo()</strong>


id: Phar::getAlias
type: function
doc:
<comment>Description:</comment>
  Phar のエイリアスを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string|null</info>  エイリアスを返します。エイリアスがない場合は <info>null</info> を返します。


id: Phar::getMetadata
type: function
doc:
<comment>Description:</comment>
  phar アーカイブのメタデータを返す
  
  アーカイブのメタデータを取得します。メタデータは、PHP の任意の変数をシリアライズしたものです。

<comment>Return:</comment>
  <info>mixed</info>  Phar アーカイブのメタデータとして保存されている、シリアライズ可能な任意の PHP の値を返しま
         す。 メタデータが保存されていない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::getModified
type: function
doc:
<comment>Description:</comment>
  phar が変更されているかどうかを返す
  
  このメソッドを使用すると、phar 内のファイルが 削除されたり変更されたりしているかどうかを判断できま
  す。

<comment>Return:</comment>
  <info>bool</info>  オープンした後でファイルが変更されている場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: Phar::getPath
type: function
doc:
<comment>Description:</comment>
  Pharアーカイブのディスク上の実際のパスを取得する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Phar::getSignature
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブの MD5/SHA1/SHA256/SHA512/OpenSSL シグネチャを返す
  
  phar アーカイブの検証用シグネチャを、 十六進文字列で返します。

<comment>Return:</comment>
  <info>array|false</info>  開いているアーカイブのシグネチャを配列で返します。 キー <return>hash</return> にはシグネチャ自体を、そ
               してキー <return>hash_type</return> には <return>MD5</return>、<return>SHA-1</return>、 <return>SHA-256</return>、<return>SHA-512</return> あるいは <return>OpenSSL</return> を格納します。
               このシグネチャは phar の中身全体から計算したハッシュで、 アーカイブの整合性を検証する
               際に使用します。 INI 設定 phar.require_hash が true の場合は、すべての実行可能な phar
               が有効なシグネチャを持っている必要があります。 シグネチャが存在しない場合、この関数は
               <info>false</info> を返します。


id: Phar::getStub
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブの PHP ローダーあるいは起動スタブを返す
  
  Phar アーカイブには、ブートストラップローダー (あるいは <return>スタブ</return>) というものが含まれています。これは
  PHP で書かれており、 そのアーカイブを PHP から実行したときに最初に実行されます。 たとえば次のよう
  にインクルードしたり、  ]]> あるいは単純に実行したりなどした場合です。

<comment>Return:</comment>
  <info>string</info>  現在の Phar アーカイブの起動用ローダー (スタブ) の内容を文字列で返します。

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::getSupportedCompression
type: function
doc:
<comment>Description:</comment>
  サポートする圧縮アルゴリズムの配列を返す

<comment>Return:</comment>
  <info>array</info>  <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return> を含む配列を返します。 これは、zlib 拡張モジュールと bz2 拡張モ
         ジュールが使用可能かどうかによって決まります。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>


id: Phar::getSupportedSignatures
type: function
doc:
<comment>Description:</comment>
  サポートするシグネチャ型の配列を返す
  
  サポートするシグネチャ型の配列を返します。

<comment>Return:</comment>
  <info>array</info>  <return>MD5</return>、<return>SHA-1</return>、 <return>SHA-256</return>、<return>SHA-512</return> あるいは <return>OpenSSL</return> を含む配列を返します。

<comment>See Also:</comment>
   * <strong>Phar::getSignature()</strong>
   * <strong>Phar::setSignatureAlgorithm()</strong>


id: Phar::getVersion
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブのバージョン情報を返す
  
  オープンした Phar アーカイブの API バージョンを返します。

<comment>Return:</comment>
  <info>string</info>  オープンしたアーカイブの API バージョンを返します。 これは、読み込んだ phar 拡張モジュール
          が新しい phar を作成する際に使用する API バージョンとは異なります。各 Phar アーカイブは、
          マニフェスト内に API バージョンをハードコードして保持しています。 詳細は Phar ファイル
          フォーマット のドキュメントを参照ください。

<comment>See Also:</comment>
   * <strong>Phar::apiVersion()</strong>


id: Phar::hasMetadata
type: function
doc:
<comment>Description:</comment>
  ファイルがグローバルなメタデータを持つかどうかを返す
  
  ファイルがグローバルなメタデータを持っているかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  メタデータが設定されている場合に <info>true</info>、されていない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>


id: Phar::interceptFileFuncs
type: function
doc:
<comment>Description:</comment>
  fopen、file_get_contents、opendir などの stat 関連の関数をすべて phar に横取りさせる
  
  <strong>fopen()</strong> や <strong>readfile()</strong>、 <strong>file_get_contents()</strong>、<strong>opendir()</strong> などの stat 関連の関数をすべて phar に横取
  りさせます。 phar アーカイブ内で相対パスを指定してこれらの関数がコールされると、 それが phar アー
  カイブ内のファイルへのアクセスに変更されます。 絶対パスの場合は、ファイルシステム上の外部ファイル
  を指すものとみなされます。
  
  この関数を使用すると、ハードディスク上で動作するように作られている PHP アプリケーションを phar ア
  プリケーションにまとめられるようになります。

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


id: Phar::isBuffering
type: function
doc:
<comment>Description:</comment>
  Phar の書き込み操作がバッファリングされるか、あるいは直接ディスクに書き込まれるかを調べる
  
  このメソッドを使用すると、その Phar が変更を即時にディスクに書き込むのか それとも
  <strong>Phar::stopBuffering()</strong> をコールしないと変更が保存されないのかがわかります。
  
  Phar の書き込みバッファリングはアーカイブ単位で処理されます。 Phar アーカイブ <return>foo.phar</return> でバッファ
  リングが有効であったとしても、それは Phar アーカイブ <return>bar.phar</return> の変更には影響しません。

<comment>Return:</comment>
  <info>bool</info>  書込み操作がバッファリングされる場合に <info>true</info>、それ以外の場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::stopBuffering()</strong>


id: Phar::isCompressed
type: function
doc:
<comment>Description:</comment>
  phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を
  返
  す
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を
  返します。 zip 形式の phar アーカイブはファイル単位で圧縮することができません。 そのため、zip 形式
  の phar アーカイブを調べたときはこのメソッドは常に <info>false</info> を返します。

<comment>Return:</comment>
  <info>int|false</info>  <return>Phar::GZ</return>、 <return>Phar::BZ2</return> あるいは <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: Phar::isFileFormat
type: function
doc:
<comment>Description:</comment>
  phar アーカイブが、パラメータで指定した tar/phar/zip のいずれかの形式である場合に true を返す

<comment>Param:</comment>
  <info>int</info>  <strong>$format</strong>  <return>Phar::PHAR</return>、<return>Phar::TAR</return> あるいは <return>Phar::ZIP</return> で、アーカイブの形式を指定します。

<comment>Return:</comment>
  <info>bool</info>  phar アーカイブのファイル形式がパラメータで指定したものと一致する場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>


id: Phar::isValidPharFilename
type: function
doc:
<comment>Description:</comment>
  指定したファイル名が正しい形式の phar ファイルかどうかを返す
  
  指定したファイル名のファイルが、phar 拡張モジュールで利用できる 正しい形式の phar ファイルであるか
  どうかを返します。 これは、phar アーカイブを実際に開く前にそのファイルを確認する際に使用します。
  これで、 無効なファイルを指定したときに当然発生するであろう例外の処理を省略することができます。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    まだ作成されていない phar アーカイブの名前あるいはフルパス。
  <info>bool</info>    <strong>$executable</strong>  このパラメータは、指定した名前のファイルを phar の実行可能アーカイブとして扱
                       うかデータのみの非実行可能アーカイブとして扱うかを指定します。

<comment>Return:</comment>
  <info>bool</info>  正しい形式のファイルである場合に <info>true</info>、そうでない場合に <info>false</info> を返します。


id: Phar::isWritable
type: function
doc:
<comment>Description:</comment>
  phar アーカイブが変更可能な場合に true を返す
  
  このメソッドは、<return>phar.readonly</return> が <return>0</return> かつディスク上の実際の phar アーカイブが読み取り専用でない場合
  に <info>true</info> を返します。

<comment>Return:</comment>
  <info>bool</info>  phar アーカイブが変更可能な場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::canWrite()</strong>
   * <strong>PharData::isWritable()</strong>


id: Phar::loadPhar
type: function
doc:
<comment>Description:</comment>
  任意の phar アーカイブを、エイリアスを指定して読み込む
  
  これを使用して、外部の Phar アーカイブの内容を読み込むことができます。 phar へのエイリアスを指定す
  ることで、その後 phar を使用する場合に短い名前を使用できるので便利です。 また、データのみが含まれ
  ており、実行したり インクルードしたりする必要のない PHP スクリプトからなる Phar アーカイブを読み込
  む際にも便利です。

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  オープンする phar アーカイブへの完全パスあるいは相対パス。
  <info>string|null</info>  <strong>$alias</strong>     この phar アーカイブをさす際に使用するエイリアス。 多くの場合は phar アー
                          カイブ内で明示的なエイリアスを指定しており、 このような場合に新しいエイリ
                          アスを指定すると、 <class>PharException</class> がスローされます。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::mapPhar()</strong>


id: Phar::mapPhar
type: function
doc:
<comment>Description:</comment>
  現在実行されている (phar 形式の) ファイルを読み込み、その内容を登録する
  
  このstaticメソッドは、直接実行されたときや 他のスクリプトからインクルードされたときに Phar アーカ
  イブのローダスタブ内で使用され、 phar を初期化します。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$alias</strong>   このアーカイブを参照する際にフルパスのかわりに使用する、 <return>phar://</return> 形式の
                        URL。
  <info>int</info>          <strong>$offset</strong>  未使用。PEAR の PHP_Archive との互換性のために用意しています。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::loadPhar()</strong>


id: Phar::mount
type: function
doc:
<comment>Description:</comment>
  外部のパスあるいはファイルを phar アーカイブ内に仮想的にマウントする
  
  Unix のファイルシステムで外部のデバイスをディレクトリツリー上にマウントできるのと同様に、
  <strong>Phar::mount()</strong> を使用すると 外部のファイルやディレクトリをあたかもアーカイブ内にあるかのように参照
  することができるようになります。 これを使用すると、外部の設定ファイルをアーカイブ内にあるかのよう
  に扱うなどの高度な抽象化が可能となります。

<comment>Param:</comment>
  <info>string</info>  <strong>$pharPath</strong>      マウントする場所として使用する phar アーカイブ内のパス。 これは phar アーカ
                         イブ内の相対パスでなければならず、また、 既に存在するパスを指定することはで
                         きません。
  <info>string</info>  <strong>$externalPath</strong>  phar アーカイブ内にマウントしたい外部ファイルあるいはディレクトリのパスある
                         いは URL。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗した場合は <class>PharException</class> をスローします。


id: Phar::mungServer
type: function
doc:
<comment>Description:</comment>
  最大 4 つまでの $_SERVER 変数を実行時に変更させる
  
  <strong>Phar::mungServer()</strong> は、 phar アーカイブのスタブ内でのみ使用します。
  
  最大 4 つまでの $_SERVER 変数を指定し、 実行時に変更させます。phar の実行時に変更できる変数は
  <return>REQUEST_URI</return>、<return>PHP_SELF</return>、 <return>SCRIPT_NAME</return> そして <return>SCRIPT_FILENAME</return> です。
  
  このメソッド自身は何も行いません。これが効力を発揮するのは <strong>Phar::webPhar()</strong> と組み合わせた場合で
  PHP ファイルがリクエストされた場合のみです。 <return>PATH_INFO</return> と <return>PATH_TRANSLATED</return> は常に変更されていること
  に注意しましょう。
  
  変更前の元の値は、SERVER 配列の中で <return>PHAR_</return> をつけた名前で保持されます。たとえば <return>SCRIPT_NAME</return> の場合
  は 変更前の値は <return>PHAR_SCRIPT_NAME</return> となります。

<comment>Param:</comment>
  <info>array</info>  <strong>$variables</strong>  <return>REQUEST_URI</return>、<return>PHP_SELF</return>、 <return>SCRIPT_NAME</return> および <return>SCRIPT_FILENAME</return> を含む、文字列の配
                     列。その他の値を指定した場合は例外が発生します。また <strong>Phar::mungServer()</strong> は大文
                     字小文字を区別します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::webPhar()</strong>
   * <strong>Phar::setStub()</strong>


id: Phar::offsetExists
type: function
doc:
<comment>Description:</comment>
  ファイルが phar 内に存在するかどうかを調べる
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、Phar アーカイブの内容に対して
  配列形式の角括弧を使用したアクセスが可能となります。
  
  offsetExists() は、<strong>isset()</strong> がコールされる際にはいつもコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Phar 内で探すファイル名 (相対パス)。

<comment>Return:</comment>
  <info>bool</info>  ファイルが phar 内に存在する場合に <info>true</info>、しない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetGet
type: function
doc:
<comment>Description:</comment>
  指定したファイルの PharFileInfo オブジェクトを取得する
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、Phar アーカイブの内容に対して
  配列形式の角括弧を使用したアクセスが可能となります。 Phar::offsetGet を使用して、Phar アーカイブか
  らファイルを取得します。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Phar 内で探すファイル名 (相対パス)。

<comment>Return:</comment>
  <info>SplFileInfo</info>  <class>PharFileInfo</class> オブジェクトを返します。 これを使用して、ファイルの内容を順に処理したり
               ファイルの情報を取得したりします。

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetSet
type: function
doc:
<comment>Description:</comment>
  内部ファイルに、外部ファイルの内容を設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、Phar アーカイブの内容に対して
  配列形式の角括弧を使用したアクセスが可能となります。 offsetSet を使用して、Phar アーカイブの既存
  ファイルの変更や 新しいファイルの追加を行います。

<comment>Param:</comment>
  <info>string</info>           <strong>$localName</strong>  Phar 内で変更するファイル名 (相対パス)。
  <info>resource|string</info>  <strong>$value</strong>      ファイルの内容。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::offsetUnset
type: function
doc:
<comment>Description:</comment>
  ファイルを phar から削除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、Phar アーカイブの内容に対して
  配列形式の角括弧を使用したアクセスが可能となります。 offsetUnset を使用して、既存のファイルを削除
  します。また <strong>unset()</strong> が使用された場合にもコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Phar 内で変更するファイル名 (相対パス)。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::offsetExists()</strong>
   * <strong>Phar::offsetGet()</strong>
   * <strong>Phar::offsetSet()</strong>
   * <strong>Phar::unlinkArchive()</strong>
   * <strong>Phar::delete()</strong>


id: Phar::running
type: function
doc:
<comment>Description:</comment>
  現在実行中の Phar アーカイブのフルパスあるいは完全な phar URL を返す
  
  実行中の phar アーカイブのフルパスを返します。これはマジック定数 <return>__FILE__</return> のような使い方を想定した
  もので、 実行中の phar アーカイブの内部でのみ有効です。
  
  アーカイブ内のスタブでは、<strong>Phar::running()</strong> は <return>""</return> を返します。現在実行中の phar にスタブ内からアクセ
  スするには、 単純に <info>__FILE__</info> を使用します。

<comment>Param:</comment>
  <info>bool</info>  <strong>$returnPhar</strong>  <info>false</info> の場合は phar アーカイブのディスク上でのフルパスを返します。 <info>true</info> の場合
                     は完全な phar URL を返します。

<comment>Return:</comment>
  <info>string</info>  ファイル名が正しい形式の場合にファイル名、それ以外の場合に空文字列を返します。


id: Phar::setAlias
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブのエイリアスを設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  Phar アーカイブのエイリアスを設定し、そのアーカイブのエイリアスとして書き込みます。 エイリアスは
  phar アーカイブで内部的に使用するもので、 <return>phar</return> ストリームラッパーがアーカイブ内のファイルにアクセ
  スする際に そのアーカイブのファイルシステム上での場所を気にせずにすむようになります。 それ以外の方
  法としては、Phar が内部的に <strong>include()</strong> を横取りすることを利用したり <strong>Phar::interceptFileFuncs()</strong> を
  使って相対パスを利用したりといったものがあります。

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  このアーカイブを指すときに使用する短い文字列。 <return>phar</return> ストリームラッパーがアクセスす
                  る際にこれを使用します。

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

<comment>See Also:</comment>
   * <strong>Phar::__construct()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: Phar::setDefaultStub
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブの PHP ローダー (起動スタブ) をデフォルトのローダーに設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドは、 <strong>Phar::createDefaultStub()</strong> と <strong>Phar::setStub()</strong> の両方の機能を組み合わせた便利なメ
  ソッドです。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     コマンドラインからアクセスした場合に実行する、 phar アーカイブ内の相対パ
                          ス。
  <info>string|null</info>  <strong>$webIndex</strong>  ウェブブラウザからアクセスした場合に実行する、 phar アーカイブ内の相対パ
                          ス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::setMetadata
type: function
doc:
<comment>Description:</comment>
  phar アーカイブのメタデータを設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  <strong>Phar::setMetadata()</strong> は、 phar アーカイブ全体に関する独自の情報を保存する場合に使用します。 ファイ
  ル固有のメタデータについては <strong>PharFileInfo::setMetadata()</strong> を使うようにしましょう。大きなメタデータ
  を使用すると、 phar アーカイブの読み込み時のパフォーマンスが低下します。
  
  メタデータの使用例として考えられるのは、 アーカイブの中で最初に実行するファイルはどれかを指定した
  り、 PEAR の package.xml のようなマニフェストの場所を指定したりすることです。 しかし、phar アーカ
  イブに関する有用なデータなら何を保存してもかまいません。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$metadata</strong>  phar アーカイブについての情報を含む、PHP の変数。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::getMetadata()</strong>
   * <strong>Phar::delMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>


id: Phar::setSignatureAlgorithm
type: function
doc:
<comment>Description:</comment>
  phar のシグネチャのアルゴリズムを設定して適用する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar のシグネチャのアルゴリズムを設定します。 シグネチャのアルゴリズムは <return>Phar::MD5</return>、 <return>Phar::SHA1</return>、
  <return>Phar::SHA256</return>、 <return>Phar::SHA512</return> あるいは <return>Phar::OPENSSL</return> のいずれかでなければなりません。
  
  実行可能な phar アーカイブについては、 <return>SHA1</return> 形式のシグネチャが デフォルトで自動的に作成されること
  に注意しましょう。 データ tar 形式あるいは zip 形式のアーカイブ (<class>PharData</class> クラスで作成したアーカイ
  ブ) の場合は、 <strong>Phar::setSignatureAlgorithm()</strong> で明示的にシグネチャを作成して設定する必要がありま
  す。

<comment>Param:</comment>
  <info>int</info>          <strong>$algo</strong>        <return>Phar::MD5</return>、 <return>Phar::SHA1</return>、<return>Phar::SHA256</return>、 <return>Phar::SHA512</return> あるいは
                            <return>Phar::OPENSSL</return> のいずれか。
  <info>string|null</info>  <strong>$privateKey</strong>  OpenSSL 秘密鍵の中身。証明書あるいは OpenSSL 鍵ファイルから取り出したも
                            の。 setSignatureAlgorithm(Phar::OPENSSL, $pkey);
                            ?> ]]> 公開鍵ファイルの名前や置き場所については phar の導入 を参照くださ
                            い。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::getSupportedSignatures()</strong>
   * <strong>Phar::getSignature()</strong>


id: Phar::setStub
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブの PHP ローダ (あるいは起動スタブ) を設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドを使用して、新しい Phar アーカイブに PHP 起動ローダスタブを追加します。あるいは、既存
  の Phar アーカイブのローダスタブを置き換えます。
  
  Phar アーカイブのローダスタブは、 このようにアーカイブを直接インクルードした際に使用されます。
  
  <return>phar</return> ストリームラッパーを使用して次のようにファイルをインクルードした際には、 ローダにはアクセスし
  ません。

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$stub</strong>    文字列あるいはオープンしたストリームハンドル。 この phar アーカイブの実
                            行スタブとして使用します。
  <info>int</info>              <strong>$length</strong>  

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::getStub()</strong>
   * <strong>Phar::createDefaultStub()</strong>


id: Phar::startBuffering
type: function
doc:
<comment>Description:</comment>
  Phar の書き込み操作のバッファリングを開始するが、ディスク上の Phar オブジェクトは変更しない
  
  技術的には必須ではありませんが、<strong>Phar::startBuffering()</strong> メソッドを使用すると、大量のファイルを含む
  Phar アーカイブの作成や変更が非常に高速になります。 通常は、Phar アーカイブ内のファイルが作成ある
  いは変更されるたびに Phar アーカイブ全体を改めて作り直します。 これによって、アーカイブが常に最新
  の状態となります。
  
  しかし、単に新しい Phar アーカイブを作りたいときや アーカイブ全体を一度に書き出したいときなどは、
  これは不要です。 同様に、いくつかの変更を行うときに、 すべての変更がうまくいったことを確認してから
  実際にディスクに書き込みたい ということもあるでしょう。 これは、ちょうどデータベースのトランザク
  ションの概念と同じようなものです。 <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong> の両メソッドが、こ
  のような場合のために用意されています。
  
  Phar の書き込みバッファリングはアーカイブ単位で処理されます。 Phar アーカイブ <return>foo.phar</return> でバッファ
  リングが有効であったとしても、それは Phar アーカイブ <return>bar.phar</return> の変更には影響しません。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::stopBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::stopBuffering
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブへの書き込みリクエストのバッファリングを終了し、変更内容をディスクに書き込む
  
  <strong>Phar::stopBuffering()</strong> は、 <strong>Phar::startBuffering()</strong> メソッドと組み合わせて使用します。
  <strong>Phar::startBuffering()</strong> メソッドを使用すると、 大量のファイルを含む Phar アーカイブの作成や変更が非
  常に高速になります。 通常は、Phar アーカイブ内のファイルが作成あるいは変更されるたびに Phar アーカ
  イブ全体を改めて作り直します。 これによって、アーカイブが常に最新の状態となります。
  
  しかし、単に新しい Phar アーカイブを作りたいときや アーカイブ全体を一度に書き出したいときなどは、
  これは不要です。 同様に、いくつかの変更を行うときに、 すべての変更がうまくいったことを確認してから
  実際にディスクに書き込みたい ということもあるでしょう。 これは、ちょうどデータベースのトランザク
  ションの概念と同じようなものです。 <strong>Phar::startBuffering()</strong>/<strong>Phar::stopBuffering()</strong> の両メソッドが、こ
  のような場合のために用意されています。
  
  Phar の書き込みバッファリングはアーカイブ単位で処理されます。 Phar アーカイブ <return>foo.phar</return> でバッファ
  リングが有効であったとしても、それは Phar アーカイブ <return>bar.phar</return> の変更には影響しません。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::startBuffering()</strong>
   * <strong>Phar::isBuffering()</strong>


id: Phar::unlinkArchive
type: function
doc:
<comment>Description:</comment>
  phar アーカイブをディスクとメモリから完全に削除する
  
  phar アーカイブをディスクとメモリから削除します。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ディスク上の phar アーカイブへのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::delete()</strong>
   * <strong>Phar::offsetUnset()</strong>


id: Phar::webPhar
type: function
doc:
<comment>Description:</comment>
  ブラウザからのリクエストを、phar アーカイブ内部のファイルに転送する
  
  <strong>Phar::webPhar()</strong> は、<strong>Phar::mapPhar()</strong> を、 ウェブベースの phar で使うものです。 このメソッドは、
  $_SERVER['REQUEST_URI'] をパースして ウェブブラウザからのリクエストを phar アーカイブ内のファイル
  に転送します。 このメソッド自体がウェブサーバーをシミュレートします。 正しいファイルにリクエストを
  転送し、正しいヘッダを出力し、 必要に応じて PHP ファイルをパースします。 <strong>Phar::mungServer()</strong> や
  <strong>Phar::interceptFileFuncs()</strong> と組み合わせて使用すると、任意のウェブアプリケーションをそのまま phar
  アーカイブ化することができます。
  
  <strong>Phar::webPhar()</strong> をコールするのは、 phar アーカイブのスタブ内からのみとしましょう (スタブって何? と
  いう方は ここ をごらんください)。

<comment>Param:</comment>
  <info>string|null</info>    <strong>$alias</strong>               <return>phar://</return> URL でこのアーカイブを指す際に、 フルパスの代わりに使
                                      用するエイリアス。
  <info>string|null</info>    <strong>$index</strong>               phar の中でディレクトリインデックスとなるファイルの場所。
  <info>string|null</info>    <strong>$fileNotFoundScript</strong>  ファイルが見つからないときに実行するスクリプトの場所。 このス
                                      クリプトは HTTP 404 ヘッダを返さなければなりません。
  <info>array</info>          <strong>$mimeTypes</strong>           ファイルの拡張子と MIME タイプを関連付けた配列。 デフォルトの
                                      マッピングで十分な場合は、空の配列を渡します。 デフォルトで、
                                      これらの関連が定義されています。  Phar::PHPS, //
                                      highlight_file() に渡します 'c' => 'text/plain', 'cc' =>
                                      'text/plain', 'cpp' => 'text/plain', 'c++' => 'text/plain',
                                      'dtd' => 'text/plain', 'h' => 'text/plain', 'log' =>
                                      'text/plain', 'rng' => 'text/plain', 'txt' => 'text/plain',
                                      'xsd' => 'text/plain', 'php' => Phar::PHP, // PHP としてパース
                                      します 'inc' => Phar::PHP, // PHP としてパースします 'avi' =>
                                      'video/avi', 'bmp' => 'image/bmp', 'css' => 'text/css', 'gif'
                                      => 'image/gif', 'htm' => 'text/html', 'html' => 'text/html',
                                      'htmls' => 'text/html', 'ico' => 'image/x-ico', 'jpe' =>
                                      'image/jpeg', 'jpg' => 'image/jpeg', 'jpeg' => 'image/jpeg',
                                      'js' => 'application/x-javascript', 'midi' => 'audio/midi',
                                      'mid' => 'audio/midi', 'mod' => 'audio/mod', 'mov' =>
                                      'movie/quicktime', 'mp3' => 'audio/mp3', 'mpg' =>
                                      'video/mpeg', 'mpeg' => 'video/mpeg', 'pdf' =>
                                      'application/pdf', 'png' => 'image/png', 'swf' =>
                                      'application/shockwave-flash', 'tif' => 'image/tiff', 'tiff'
                                      => 'image/tiff', 'wav' => 'audio/wav', 'xbm' => 'image/xbm',
                                      'xml' => 'text/xml',
                                      );
                                      ?> ]]>
  <info>callable|null</info>  <strong>$rewrite</strong>             書き換え関数は、唯一のパラメータとして文字列を受け取り、<info>string</info>
                                      あるいは <info>false</info> を返さないといけません。
                                      
                                      fast-cgi あるいは cgi を使っている場合、この関数に渡されるパラ
                                      メータは $_SERVER['PATH_INFO'] の値になります。 それ以外の場
                                      合、この関数に渡されるパラメータは $_SERVER['REQUEST_URI'] の
                                      値になります。
                                      
                                      文字列を返した場合は、内部的なファイルパスとして扱います。
                                      <info>false</info> を返した場合は、 webPhar() が HTTP 403 を送信します。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::mungServer()</strong>
   * <strong>Phar::interceptFileFuncs()</strong>


id: PharData
type: class
doc:
<comment>Description:</comment>
  PharData クラスは、実行可能形式でない tar アーカイブや zip アーカイブへのアクセスや作成のための高
  レベルインターフェイスを提供します。 これらのアーカイブにはスタブが含まれておらず、 phar 拡張モ
  ジュールから実行することはできません。 そのため、PharData クラスによる通常の zip および tar ファイ
  ルの作成や 操作は php.ini の <return>phar.readonly</return> が <return>1</return> であっても可能です。


id: PharData::__construct
type: function
doc:
<comment>Description:</comment>
  実行可能でない tar あるいは zip アーカイブオブジェクトを作成する

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>  既存の tar/zip アーカイブあるいは作成したいアーカイブへのパス。
  <info>int</info>          <strong>$flags</strong>     親クラス <class>Phar</class> の <class>RecursiveDirectoryIterator</class> に渡すフラグ。
  <info>string|null</info>  <strong>$alias</strong>     この Phar アーカイブをストリーム機能からコールするときに使うエイリアス。
  <info>int</info>          <strong>$format</strong>    <class>Phar</class> クラスの ファイルフォーマット定数 のいずれか。


id: PharData::addEmptyDir
type: function
doc:
<comment>Description:</comment>
  空のディレクトリを tar/zip アーカイブに追加する
  
  このメソッドを使用すると、空のディレクトリが <return>dirname</return> に作成されます。このメソッドは
  <strong>ZipArchive::addEmptyDir()</strong> と同じようなものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  phar アーカイブ内に作成する空のディレクトリの名前。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>Phar::addEmptyDir()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addFromString()</strong>


id: PharData::addFile
type: function
doc:
<comment>Description:</comment>
  ファイルシステム上のファイルを tar/zip アーカイブに追加する
  
  このメソッドを使用すると、任意のファイルあるいは URL を tar/zip アーカイブに追加することができま
  す。 オプションの 2 番目のパラメータ <return>localname</return> を指定すると、 ファイルはその名前でアーカイブ内に格
  納されます。指定しなかった場合は、 <return>file</return> パラメータをアーカイブ内のパスとして使用します。 URL を使
  用する場合は、localname を指定しないと例外がスローされます。 このメソッドは <strong>ZipArchive::addFile()</strong>
  と同じようなものです。

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>   phar アーカイブに追加したいディスク上のファイルへのフルパスあるいは相対パ
                           ス。
  <info>string|null</info>  <strong>$localName</strong>  ファイルをアーカイブ内に格納するときのパス。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFile()</strong>
   * <strong>PharData::addFromString()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::addFromString
type: function
doc:
<comment>Description:</comment>
  内容を文字列で指定したファイルを、tar/zip アーカイブに追加する
  
  このメソッドを使用すると、任意の文字列を tar/zip アーカイブに追加することができます。 アーカイブ内
  のファイル名は <return>localname</return> で指定したものとなります。 このメソッドは <strong>ZipArchive::addFromString()</strong> と
  同じようなものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  ファイルをアーカイブ内に格納するときのパス。
  <info>string</info>  <strong>$contents</strong>   ファイルに保存する内容。

<comment>Return:</comment>
  <info>void</info>  戻り値はありません。失敗時には例外をスローします。

<comment>See Also:</comment>
   * <strong>PharData::offsetSet()</strong>
   * <strong>Phar::addFromString()</strong>
   * <strong>PharData::addFile()</strong>
   * <strong>PharData::addEmptyDir()</strong>


id: PharData::buildFromDirectory
type: function
doc:
<comment>Description:</comment>
  ディレクトリ内のファイルから tar/zip アーカイブを作成する
  
  ディレクトリの中身をもとに tar/zip アーカイブを作成します。 オプションの 2 番目のパラメータで正規
  表現 (pcre) を指定すると、特定のファイルを除外することができます。 正規表現にマッチするすべての
  ファイルがアーカイブに含められ、 それ以外のファイルは除外されます。より詳細に制御するには
  <strong>PharData::buildFromIterator()</strong> を使用します。

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  アーカイブに追加するすべてのファイルを含むディレクトリへの フルパスあるいは相
                      対パス。
  <info>string</info>  <strong>$pattern</strong>    オプションで指定する pcre 正規表現。 これを使用してファイル一覧をフィルタリン
                      グします。 正規表現にマッチするファイルパスのみがアーカイブに追加されます。

<comment>Return:</comment>
  <info>array</info>  <strong>Phar::buildFromDirectory()</strong> は、連想配列を返します。これは、 ファイルの内部パスをファイルシ
         ステム上のフルパスを対応させたものです。 失敗した場合に <info>false</info> を返します

<comment>See Also:</comment>
   * <strong>Phar::buildFromDirectory()</strong>
   * <strong>PharData::buildFromIterator()</strong>


id: PharData::buildFromIterator
type: function
doc:
<comment>Description:</comment>
  イテレータから tar あるいは zip アーカイブを作成する
  
  tar あるいは zip アーカイブをイテレータから作成します。 サポートするイテレータは二種類で、 tar/zip
  内のファイル名とディスク上の実際のファイル名を対応させたものか、あるいは DirectoryIterator のよう
  に SplFileInfo オブジェクトを返すものです。 SplFileInfo オブジェクトを返すイテレータの場合は、2 番
  目のパラメータが必要となります。

<comment>Param:</comment>
  <info>Traversable</info>  <strong>$iterator</strong>       phar ファイルと実際の場所の関連を返すイテレータ、 あるいは
                               SplFileInfo オブジェクトを返すイテレータ。
  <info>string|null</info>  <strong>$baseDirectory</strong>  SplFileInfo オブジェクトを返すイテレータを指定した際、 tar/zip アーカ
                               イブへの追加時にフルパスから取り除く部分。

<comment>Return:</comment>
  <info>array</info>  <strong>PharData::buildFromIterator()</strong> は連想配列を返します。 これは、ファイルの内部パスとファイルシ
         ステム上のフルパスを対応させたものです。

<comment>See Also:</comment>
   * <strong>Phar::buildFromIterator()</strong>


id: PharData::compress
type: function
doc:
<comment>Description:</comment>
  tar/zip アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
  
  tar 形式のアーカイブの場合は、 このメソッドはアーカイブ全体を gzip あるいは bzip2 で圧縮します。
  できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、 Phar 拡張モジュールで直
  接透過的に使用することもできます。
  
  zip 形式のアーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮するためには
  zlib 拡張モジュールが、そして bzip2 で圧縮するためには bzip2 拡張モジュールが有効になっていなけれ
  ばなりません。
  
  さらに、このメソッドは自動的にアーカイブの名前を変更し、 <return>.gz</return> あるいは <return>.bz2</return> を追加します。
  <return>Phar::NONE</return> を渡して圧縮を解除した場合は拡張子も削除します。 もうひとつの方法として、ファイルの拡張
  子を 2 番目のパラメータで指定することもできます。

<comment>Param:</comment>
  <info>int</info>          <strong>$compression</strong>  圧縮を行う場合には <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return>、圧縮を解除する場合には
                             <return>Phar::NONE</return> を指定します。
  <info>string|null</info>  <strong>$extension</strong>    デフォルトでは、tar を圧縮する際の拡張子は <return>.tar.gz</return> あるいは <return>.tar.bz2</return>、
                             伸長する際の拡張子は <return>.tar</return> となります。

<comment>Return:</comment>
  <info>PharData|null</info>  成功した場合は <class>PharData</class> オブジェクトを返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::compress()</strong>


id: PharData::compressFiles
type: function
doc:
<comment>Description:</comment>
  現在の tar/zip アーカイブ内のすべてのファイルを圧縮する
  
  tar 形式の phar アーカイブでは、このメソッドは <class>BadMethodCallException</class> をスローします。 というの
  も、tar ファイルフォーマットではアーカイブ内の個別のファイルの圧縮をサポートしていないからです。
  <strong>PharData::compress()</strong> を使用して、tar 形式の phar アーカイブ全体を圧縮します。
  
  zip 形式のアーカイブでは、 このメソッドは Phar アーカイブ内のすべてのファイルを指定した方式で圧縮
  します。 この機能を使用するには、zlib 拡張モジュールあるいは bzip2 拡張モジュールが有効になってい
  る必要があります。さらに、 もし既に bzip2/zlib で圧縮されているファイルがある場合は、 いったんその
  圧縮を解除するために対応する拡張モジュールが必要となります。

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  圧縮を行う場合は <return>Phar::GZ</return> あるいは <return>Phar::BZ2</return>、圧縮を解除するためには <return>Phar::NONE</return>
                     のいずれかを指定しなければなりません。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::decompressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>PharData::decompress()</strong>


id: PharData::convertToData
type: function
doc:
<comment>Description:</comment>
  phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する
  
  このメソッドは、実行可能でない tar あるいは zip アーカイブを別の実行可能でない形式に変換します。
  
  何も変更しなかった場合、このメソッドは <class>BadMethodCallException</class> をスローします。 このメソッドは、tar
  アーカイブを zip 形式に変換するか あるいはその逆の変換をする場合に使用するものです。 このメソッド
  で単に tar アーカイブの圧縮方法だけを変更することもできますが、 その場合は <strong>PharData::compress()</strong> を
  使うことをおすすめします。
  
  成功した場合は、このメソッドはディスク上に新しいアーカイブを作成して <class>PharData</class> オブジェクトを返しま
  す。 古いアーカイブは削除されずディスク上に残るので、 処理を終えたら手動で削除する必要があります。

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       これは <return>Phar::TAR</return> あるいは <return>Phar::ZIP</return> のいずれかとなります。 <info>null</info> を指定
                             すると、現在のファイル形式をそのまま保持します。
  <info>int|null</info>     <strong>$compression</strong>  アーカイブ全体の圧縮を行わない場合は <return>Phar::NONE</return>、 zlib による圧縮の場合
                             は <return>Phar::GZ</return>、そして bzip による圧縮の場合は <return>Phar::BZ2</return> のいずれかを指定
                             します。
  <info>string|null</info>  <strong>$extension</strong>    このパラメータは、変換後のアーカイブのデフォルトのファイル拡張子を変更
                             します。 実行可能でない tar や zip アーカイブのファイル名としては <return>.phar</return>
                             は使用できないことに注意しましょう。
                             
                             tar 形式の phar アーカイブの場合、デフォルトの拡張子は圧縮形式によって
                             <return>.tar</return>、<return>.tar.gz</return>、 <return>.tar.bz2</return> のいずれかとなります。 zip 形式のアーカイブの
                             場合、デフォルトの拡張子は <return>.zip</return> となります。

<comment>Return:</comment>
  <info>PharData|null</info>  このメソッドは、成功した場合に <class>PharData</class> オブジェクトを返します。失敗した場合は <info>null</info>
                 を返します。

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToExecutable()</strong>


id: PharData::convertToExecutable
type: function
doc:
<comment>Description:</comment>
  実行可能でない tar/zip アーカイブを実行可能な phar アーカイブ形式に変換する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  このメソッドは、実行可能でない tar あるいは zip アーカイブを実行可能な phar 形式に変換します。実行
  可能なファイル形式 3 種類 (phar, tar あるいは zip) のどれでも使用することができ、アーカイブ全体の
  圧縮も行うことができます。
  
  何も変更しなかった場合、このメソッドは <class>BadMethodCallException</class> をスローします。
  
  成功した場合は、このメソッドはディスク上に新しいアーカイブを作成して <class>Phar</class> オブジェクトを返します。
  古いアーカイブは削除されずディスク上に残るので、 処理を終えたら手動で削除する必要があります。

<comment>Param:</comment>
  <info>int|null</info>     <strong>$format</strong>       これは <return>Phar::PHAR</return>、<return>Phar::TAR</return> あるいは <return>Phar::ZIP</return> のいずれかとなります。
                             <info>null</info> を指定すると、現在のファイル形式をそのまま保持します。
  <info>int|null</info>     <strong>$compression</strong>  アーカイブ全体の圧縮を行わない場合は <return>Phar::NONE</return>、 zlib による圧縮の場合
                             は <return>Phar::GZ</return>、そして bzip による圧縮の場合は <return>Phar::BZ2</return> のいずれかを指定
                             します。
  <info>string|null</info>  <strong>$extension</strong>    このパラメータは、変換後のアーカイブのデフォルトのファイル拡張子を変更
                             します。 実行可能でない tar や zip アーカイブのファイル名としては <return>.phar</return>
                             は使用できないことに注意しましょう。
                             
                             phar 形式のアーカイブに変換する場合、デフォルトの拡張子は圧縮形式によっ
                             て <return>.phar</return>、<return>.phar.gz</return> あるいは <return>.phar.bz2</return> のいずれかとなります。tar 形式の
                             アーカイブの場合、デフォルトの拡張子は <return>.phar.tar</return>、<return>.phar.tar.gz</return> および
                             <return>.phar.tar.bz2</return> です。zip 形式のアーカイブの場合、 デフォルトの拡張子は
                             <return>.phar.zip</return> となります。

<comment>Return:</comment>
  <info>Phar|null</info>  このメソッドは、成功した場合に <class>Phar</class> オブジェクトを返します。失敗した場合は <info>null</info> を返し
             ます。

<comment>See Also:</comment>
   * <strong>Phar::convertToExecutable()</strong>
   * <strong>Phar::convertToData()</strong>
   * <strong>PharData::convertToData()</strong>


id: PharData::copy
type: function
doc:
<comment>Description:</comment>
  phar アーカイブ内のファイルを、phar 内で別の新しいファイルとしてコピーする
  
  phar アーカイブ内のファイルを、そのアーカイブ内で別の新しいファイルとしてコピーします。 これは、
  phar ストリームラッパーでの <strong>copy()</strong> と同等の操作をオブジェクト指向で行うものです。

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  
  <info>string</info>  <strong>$to</strong>    

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。しかし、より安全を期すなら try/catch ブロック内で使用して例
        外がスローされないことを確認するといいでしょう。


id: PharData::decompress
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブ全体の圧縮を解除する
  
  tar 形式のアーカイブの場合は、 このメソッドはアーカイブ全体の圧縮を解除します。
  
  zip 形式のアーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮されたファイルの
  圧縮を解除するためには zlib 拡張モジュールが、そして bzip2 で圧縮されたファイルの圧縮を解除するた
  めには bzip2 拡張モジュールが有効になっていなければなりません。
  
  さらに、このメソッドは自動的にアーカイブの拡張子を変更し、 <return>.tar</return> をデフォルトで追加します。 もうひ
  とつの方法として、ファイルの拡張子を <strong>$extension</strong> パラメータで指定することもできます。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$extension</strong>  圧縮を解除する場合、デフォルトのファイル拡張子は <return>.tar</return> です。 このパラメー
                           タを使用すると、別の拡張子を指定することができます。 実行可能なアーカイブ
                           のみが、ファイル名に <return>.phar</return> を含むことができることに注意しましょう。

<comment>Return:</comment>
  <info>PharData|null</info>  成功した場合に <class>PharData</class> オブジェクトを返します。 失敗した場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compressFiles()</strong>
   * <strong>PharData::decompressFiles()</strong>


id: PharData::decompressFiles
type: function
doc:
<comment>Description:</comment>
  現在の zip アーカイブ内のすべてのファイルの圧縮を解除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  tar 形式の phar アーカイブでは、このメソッドは <class>BadMethodCallException</class> をスローします。 というの
  も、tar ファイルフォーマットではアーカイブ内の個別のファイルの圧縮をサポートしていないからです。
  <strong>PharData::compress()</strong> を使用して、tar 形式の phar アーカイブ全体を圧縮します。
  
  zip 形式のアーカイブでは、 このメソッドはアーカイブ内のすべてのファイルの圧縮を解除します。 もし
  bzip2/zlib で圧縮されているファイルがある場合は、 この機能を使用するには、zlib 拡張モジュールある
  いは bzip2 拡張モジュールが有効になっている必要があります。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>PharData::compressFiles()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>PharData::compress()</strong>
   * <strong>PharData::decompress()</strong>


id: PharData::delMetadata
type: function
doc:
<comment>Description:</comment>
  zip アーカイブのグローバルメタデータを削除する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  zip アーカイブのグローバルメタデータを削除します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。しかし、より安全を期すなら 例外がスローされないことを確認す
        るといいでしょう。

<comment>See Also:</comment>
   * <strong>Phar::delMetadata()</strong>


id: PharData::delete
type: function
doc:
<comment>Description:</comment>
  tar/zip アーカイブ内のファイルを削除する
  
  アーカイブ内のファイルを削除します。 これは、ストリームラッパー上で <strong>unlink()</strong> をコールするのと同じ
  意味です。以下に例を示します。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  削除したいファイルの、アーカイブ内でのパス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 しかし、例外がスローされているかどうかを確認したうえで 例外
        がなければ成功とみなすほうがいいでしょう。

<comment>See Also:</comment>
   * <strong>Phar::delete()</strong>


id: PharData::extractTo
type: function
doc:
<comment>Description:</comment>
  tar/zip アーカイブの内容をディレクトリに展開する
  
  tar/zip アーカイブ内のすべてのファイルをディスクに展開します。 展開されたファイルやディレクトリ
  は、アーカイブに保存されたときのパーミッションを維持しています。 オプションのパラメータを使用する
  と、どのファイルを展開するかを制御したり 既存のファイルを上書きするかどうかを指定したりすることが
  できます。 2 番目のパラメータ <return>files</return> には、 展開したいファイルやディレクトリの名前、あるいはその配
  列を指定します。 デフォルトでは、このメソッドは既存のファイルを上書きしません。 3 番目のパラメータ
  を true にすると既存のファイルを上書きさせることができます。 このメソッドは
  <strong>ZipArchive::extractTo()</strong> と同じようなものです。

<comment>Param:</comment>
  <info>string</info>             <strong>$directory</strong>  指定した <return>files</return> の展開先のパス。
  <info>array|string|null</info>  <strong>$files</strong>      展開したいファイル名/ディレクトリ名、あるいはその配列。
  <info>bool</info>               <strong>$overwrite</strong>  <info>true</info> にすると既存のファイルを上書きします。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 しかし、例外がスローされているかどうかを確認したうえで 例外
        がなければ成功とみなすほうがいいでしょう。

<comment>See Also:</comment>
   * <strong>Phar::extractTo()</strong>


id: PharData::isWritable
type: function
doc:
<comment>Description:</comment>
  tar/zip アーカイブが変更可能な場合に true を返す
  
  このメソッドは、ディスク上の tar/zip アーカイブが読み込み専用でない場合に <info>true</info> を返します。
  <strong>Phar::isWritable()</strong> とは異なり、 データのみの tar/zip アーカイブは <return>phar.readonly</return> が <return>1</return> であっても変
  更可能です。

<comment>Return:</comment>
  <info>bool</info>  tar/zip アーカイブが変更可能な場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::canWrite()</strong>
   * <strong>Phar::isWritable()</strong>


id: PharData::offsetSet
type: function
doc:
<comment>Description:</comment>
  tar/zip の内部のファイルに、外部ファイルあるいは文字列の内容を設定する
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、tar/zip アーカイブの内容に対し
  て配列形式の角括弧を使用したアクセスが可能となります。 offsetSet を使用して、tar/zip アーカイブの
  既存ファイルの変更や 新しいファイルの追加を行います。

<comment>Param:</comment>
  <info>string</info>           <strong>$localName</strong>  tar あるいは zip アーカイブ内で変更するファイル名 (相対パス)。
  <info>resource|string</info>  <strong>$value</strong>      ファイルの内容。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::offsetSet()</strong>


id: PharData::offsetUnset
type: function
doc:
<comment>Description:</comment>
  ファイルを tar/zip アーカイブから削除する
  
  これは ArrayAccess インターフェイスを実装したものです。 これにより、Phar アーカイブの内容に対して
  配列形式の角括弧を使用したアクセスが可能となります。 offsetUnset を使用して、既存のファイルを削除
  します。また <strong>unset()</strong> が使用された場合にもコールされます。

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  tar/zip アーカイブ内で変更するファイル名 (相対パス)。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::offsetUnset()</strong>


id: PharData::setAlias
type: function
doc:
<comment>Description:</comment>
  ダミー関数 (Phar::setAlias は PharData では使用不能)
  
  実行可能でない tar/zip アーカイブはエイリアスを持つことができないので、 このメソッドは単に例外をス
  ローします。

<comment>Param:</comment>
  <info>string</info>  <strong>$alias</strong>  このアーカイブを指すときに使用する短い文字列。 <return>phar</return> ストリームラッパーがアクセスす
                  る際にこれを使用します。 このパラメータは無視されます。

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

<comment>See Also:</comment>
   * <strong>Phar::setAlias()</strong>


id: PharData::setDefaultStub
type: function
doc:
<comment>Description:</comment>
  ダミー関数 (Phar::setDefaultStub は PharData では無効)
  
  実行可能でない tar/zip アーカイブはスタブを持つことができません。 そのため、このメソッドは単に例外
  をスローするだけです。

<comment>Param:</comment>
  <info>string|null</info>  <strong>$index</strong>     コマンドラインからアクセスした場合に実行する、 phar アーカイブ内の相対パ
                          ス。
  <info>string|null</info>  <strong>$webIndex</strong>  ウェブブラウザからアクセスした場合に実行する、 phar アーカイブ内の相対パ
                          ス。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::setDefaultStub()</strong>


id: PharData::setSignatureAlgorithm
type: function
doc:
<comment>Description:</comment>
  phar のシグネチャのアルゴリズムを設定する
  
  このメソッドは、php.ini の <return>phar.readonly</return>
  が <return>0</return> でないと <class>Phar</class>
  オブジェクトで動作しません。それ以外の場合は
  <class>PharException</class> がスローされます。
  
  phar のシグネチャのアルゴリズムを設定します。 シグネチャのアルゴリズムは <return>Phar::MD5</return>、 <return>Phar::SHA1</return>、
  <return>Phar::SHA256</return>、 <return>Phar::SHA512</return> あるいは <return>Phar::OPENSSL</return> のいずれかでなければなりません

<comment>Param:</comment>
  <info>int</info>  <strong>$algo</strong>  <return>Phar::MD5</return>、 <return>Phar::SHA1</return>、<return>Phar::SHA256</return>、 <return>Phar::SHA512</return> あるいは <return>Phar::OPENSSL</return> のいずれ
              か。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Phar::getSupportedSignatures()</strong>
   * <strong>Phar::getSignature()</strong>


id: PharData::setStub
type: function
doc:
<comment>Description:</comment>
  ダミー関数 (Phar::setStub は PharData では使用不能)
  
  実行可能でない tar/zip アーカイブはスタブを持つことができないので、 このメソッドは単に例外をスロー
  します。

<comment>Param:</comment>
  <info>string</info>  <strong>$stub</strong>  文字列あるいはオープンしたストリームハンドル。 この phar アーカイブの実行スタブとし
                 て使用します。 このパラメータは無視されます。
  <info>int</info>     <strong>$len</strong>   

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>Phar::setStub()</strong>


id: PharFileInfo
type: class
doc:
<comment>Description:</comment>
  PharFileInfo クラスは、 phar アーカイブ内の個々のファイルのコンテンツや属性への 高レベルインター
  フェイスを提供します。


id: PharFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Phar エントリオブジェクトを作成する
  
  これは直接コールしてはいけません。PharFileInfo オブジェクトを作成するには、 配列へのアクセスを通じ
  て <strong>Phar::offsetGet()</strong> をコールします。

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  ファイルを取得するための完全な url。 ファイル <return>my/file.php</return> の情報を phar
                     <return>boo.phar</return> から取得したい場合は、 このエントリは <return>phar://boo.phar/my/file.php</return> とな
                     ります。


id: PharFileInfo::chmod
type: function
doc:
<comment>Description:</comment>
  ファイル固有のパーミッションビットを設定する
  
  <strong>PharFileInfo::chmod()</strong> は、ファイルパーミッションのうち実行ビットと読み込みビットを設定します。 書
  き込みビットについては無視されます。書き込みビットは、実行時に INI 設定 phar.readonly に基づいて自
  動的に設定されます。 この関数は phar の内容を変更するので、<class>Phar</class> アーカイブ内のファイルを操作するに
  は INI 設定 phar.readonly がオフでなければなりません。 <class>PharData</class> アーカイブ内のファイルについては、
  この制約はありません。

<comment>Param:</comment>
  <info>int</info>  <strong>$perms</strong>  パーミッション (<strong>chmod()</strong> を参照ください)。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: PharFileInfo::compress
type: function
doc:
<comment>Description:</comment>
  現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する
  
  このメソッドは、Phar アーカイブ内のファイルを bzip あるいは zlib で圧縮します。 この機能を使用する
  には bzip2 拡張モジュールあるいは zlib 拡張モジュールが有効になっていなければなりません。 さらに、
  ファイルがすでに圧縮されている場合には、 その圧縮をいったん解除するために対応する拡張モジュールが
  必要となります。 この関数は phar の内容を変更するので、<class>Phar</class> アーカイブ内のファイルを扱うには INI
  設定 phar.readonly が off になっていなければなりません。 <class>PharData</class> アーカイブ内のファイルについては
  この制約はありません。

<comment>Param:</comment>
  <info>int</info>  <strong>$compression</strong>  <info>Phar::GZ</info> または <info>Phar::BZ2</info> を指定しなければいけません。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: PharFileInfo::decompress
type: function
doc:
<comment>Description:</comment>
  phar 内の現在の Phar エントリの圧縮を解除する
  
  このメソッドは、Phar アーカイブ内のファイルの圧縮を解除します。 ファイルの圧縮形式に応じて、この機
  能を使用するには bzip2 拡張モジュールあるいは zlib 拡張モジュールが有効になっていなければなりませ
  ん。 この関数は phar の内容を変更するので、<class>Phar</class> アーカイブ内のファイルを扱うには INI 設定
  phar.readonly が off になっていなければなりません。 <class>PharData</class> アーカイブ内のファイルについてはこの
  制約はありません。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compressFiles()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>


id: PharFileInfo::delMetadata
type: function
doc:
<comment>Description:</comment>
  エントリのメタデータを削除する
  
  エントリのメタデータが存在する場合にそれを削除します。

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を返します。 エントリがメタデータを持っていない場合に <info>false</info> を返します。
        この関数は phar の内容を変更するので、<class>Phar</class> アーカイブ内のファイルを操作するには INI 設定
        phar.readonly がオフでなければなりません。 <class>PharData</class> アーカイブ内のファイルについては、この制
        約はありません。

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::getCRC32
type: function
doc:
<comment>Description:</comment>
  CRC32 コードを返すか、CRC がチェックできない場合に例外をスローする
  
  Phar アーカイブ内のファイルの <strong>crc32()</strong> チェックサムを返します。

<comment>Return:</comment>
  <info>int</info>  Phar アーカイブ内のファイルの <strong>crc32()</strong> チェックサムを返します。


id: PharFileInfo::getCompressedSize
type: function
doc:
<comment>Description:</comment>
  Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す
  
  この関数は、Phar アーカイブ内でのファイルの大きさを返します。 圧縮されていないファイルの場合は、
  getCompressedSize は <strong>filesize()</strong> と同じ値を返します。

<comment>Return:</comment>
  <info>int</info>  ディスク上の Phar アーカイブ内のファイルのバイト数を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::isCompressed()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compressFiles()</strong>


id: PharFileInfo::getContent
type: function
doc:
<comment>Description:</comment>
  エントリの完全なファイルの内容を取得する
  
  この関数は <strong>file_get_contents()</strong> のように振る舞いますが、 Phar 専用です。

<comment>Return:</comment>
  <info>string</info>  ファイルの内容を返します。


id: PharFileInfo::getMetadata
type: function
doc:
<comment>Description:</comment>
  ファイルとともに保存されている、ファイル固有のメタデータを返す
  
  Phar アーカイブ内で、このファイル用のマニフェストに保存されたメタデータを返します。

<comment>Return:</comment>
  <info>mixed</info>  ファイルのメタデータとして保存されている、シリアライズ可能な任意の PHP 変数を返します。 メ
         タデータが保存されていない場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::getPharFlags
type: function
doc:
<comment>Description:</comment>
  Phar ファイルエントリのフラグを返す
  
  この関数は、Phar のマニフェスト内のフラグセットを返します。 現在の実装では、これは常に <return>0</return> を返しま
  す。

<comment>Return:</comment>
  <info>int</info>  Phar フラグを返します (現在の実装では、常に <return>0</return> となります)。


id: PharFileInfo::hasMetadata
type: function
doc:
<comment>Description:</comment>
  エントリのメタデータを返す
  
  phar アーカイブ内のファイルのメタデータを返します。

<comment>Return:</comment>
  <info>bool</info>  メタデータが設定されていないかあるいは <info>null</info> が設定されている場合に <info>false</info>、 <info>null</info> 以外のメタ
        データが設定されている場合に <info>true</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::setMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PharFileInfo::isCRCChecked
type: function
doc:
<comment>Description:</comment>
  ファイルエントリの CRC が検証されているかどうかを調べる
  
  これは、Phar アーカイブ内のファイルが CRC 検証されているかどうかを返します。

<comment>Return:</comment>
  <info>bool</info>  そのファイルの CRC が検証されている場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。


id: PharFileInfo::isCompressed
type: function
doc:
<comment>Description:</comment>
  エントリが圧縮されているかどうかを調べる
  
  これは、Phar アーカイブ内のファイルが Gzip あるいは Bzip2 で圧縮されているかどうかを返します。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$compression</strong>  <info>Phar::GZ</info> あるいは <info>Phar::BZ2</info> のいずれか。デフォルトは任意の圧縮形式となりま
                          す。

<comment>Return:</comment>
  <info>bool</info>  Phar アーカイブ内のファイルが圧縮されている場合に <info>true</info>、 そうでない場合に <info>false</info> を返します。

<comment>See Also:</comment>
   * <strong>PharFileInfo::getCompressedSize()</strong>
   * <strong>PharFileInfo::decompress()</strong>
   * <strong>PharFileInfo::compress()</strong>
   * <strong>Phar::decompress()</strong>
   * <strong>Phar::compress()</strong>
   * <strong>Phar::canCompress()</strong>
   * <strong>Phar::isCompressed()</strong>
   * <strong>Phar::getSupportedCompression()</strong>
   * <strong>Phar::decompressFiles()</strong>
   * <strong>Phar::compressFiles()</strong>


id: PharFileInfo::setMetadata
type: function
doc:
<comment>Description:</comment>
  ファイルとともに保存する、ファイル固有のメタデータを設定する
  
  <strong>PharFileInfo::setMetadata()</strong> を使用するのは、 既存のファイル情報としては表せない独自の情報を保存す
  る場合のみに限るべきです。 メタデータを使用すると、phar アーカイブの読み込み時のパフォーマンスが劇
  的に低下します。これは、 メタデータのサイズが大きい場合やメタデータを含むファイルが大量にある場合
  に顕著になります。 ファイルのパーミッションについては phar 自体でネイティブにサポートしており、
  <strong>PharFileInfo-&gt;chmod()</strong> で設定できることを覚えておきましょう。 この関数は phar の内容を変更するの
  で、<class>Phar</class> アーカイブ内のファイルを操作するには INI 設定 phar.readonly がオフでなければなりません。
  <class>PharData</class> アーカイブ内のファイルについては、この制約はありません。
  
  メタデータの使用例として考えられるのは、ユーザー/グループ を指定し、phar からディスクに展開する際
  にそれを設定することなどです。 ほかには、MIME 型として返す値を明示的に指定することなどがあります。
  その他、ファイルについて説明するデータであるが ファイル自体に含むべきでないものを保存したりしま
  す。

<comment>Param:</comment>
  <info>mixed</info>  <strong>$metadata</strong>  ファイルとともに保存する情報を含む、PHP の変数。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>PharFileInfo::hasMetadata()</strong>
   * <strong>PharFileInfo::getMetadata()</strong>
   * <strong>PharFileInfo::delMetadata()</strong>
   * <strong>Phar::setMetadata()</strong>
   * <strong>Phar::hasMetadata()</strong>
   * <strong>Phar::getMetadata()</strong>


id: PhpToken
type: class
doc:
<comment>Description:</comment>
  このクラスは、<strong>token_get_all()</strong> 関数の代替です。 <strong>token_get_all()</strong> 関数は、トークンを示す一文字、 また
  はトークンのIDの配列、トークンのテキスト、行番号からなる配列を返します。 <strong>PhpToken::tokenize()</strong> は、
  全てのトークンを PhpToken オブジェクトに正規化します。 これによって、トークンの操作を行うコードの
  メモリ使用量が少なくなり、 コードが読みやすくなります。


id: PhpToken::__construct
type: function
doc:
<comment>Description:</comment>
  新しい PhpToken オブジェクトを返す
  
  新しい PhpToken オブジェクトを返します。

<comment>Param:</comment>
  <info>int</info>     <strong>$id</strong>    T_* 定数( を参照) のうちのひとつ。 または、 一文字のトークンを表す ASCII コードポイ
                 ント。
  <info>string</info>  <strong>$text</strong>  トークンの内容を示すテキスト
  <info>int</info>     <strong>$line</strong>  トークンが始まる行番号(1から始まります)
  <info>int</info>     <strong>$pos</strong>   トークン化された文字列内での(バイト単位の)開始位置(0から始まります)

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>


id: PhpToken::__toString
type: function
doc:
<comment>Description:</comment>
  トークンの文字列表現を返す
  
  トークンの文字列表現を返します。

<comment>Return:</comment>
  <info>string</info>  トークンの文字列表現を返します。

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


id: PhpToken::getTokenName
type: function
doc:
<comment>Description:</comment>
  トークンの名前を返す
  
  トークンの名前を返します。

<comment>Return:</comment>
  <info>string|null</info>  一文字のトークンを示す ASCII 文字。 または、既知のトークンの名前を示す T_* 定数( を参
               照)。 不明なトークンの場合は <info>null</info> を返します。

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>
   * <strong>token_name()</strong>


id: PhpToken::is
type: function
doc:
<comment>Description:</comment>
  指定された種類のトークンかを調べる
  
  トークンが指定された <strong>$kind</strong> であるかを判定します。

<comment>Param:</comment>
  <info>int|string|array</info>  <strong>$kind</strong>  トークンのID、またはテキスト表現に一致するスカラー値、または配列

<comment>Return:</comment>
  <info>bool</info>  トークンが指定された種類かを boolean で返します。

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


id: PhpToken::isIgnorable
type: function
doc:
<comment>Description:</comment>
  トークンがPHPパーサから無視されるかを調べる
  
  トークンがPHPパーサから無視されるかを判定します。

<comment>Return:</comment>
  <info>bool</info>  A boolean value whether the token would be ignored by the PHP parser (such as whitespace or
        comments).

<comment>See Also:</comment>
   * <strong>PhpToken::tokenize()</strong>


id: PhpToken::tokenize
type: function
doc:
<comment>Description:</comment>
  ソースコードを PhpToken オブジェクトで表現されたトークンに分割する
  
  与えられた <strong>$code</strong> を表現する PhpToken オブジェクトの配列を返します。

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>   パースする PHP のコード。
  <info>int</info>     <strong>$flags</strong>  有効なフラグ: <info>TOKEN_PARSE</info> - 特定のコンテクストで予約語を認識します。 
                  
                  <info>TOKEN_PARSE</info> - 特定のコンテクストで予約語を認識します。

<comment>Return:</comment>
  <info>array</info>  PhpToken、またはそのサブクラスで表現される、PHPトークンの配列を返します。 このメソッドの戻
         り値は、PhpToken をシームレスに拡張できるように、 <info>static[]</info> 型になっています。

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


id: Pool
type: class
doc:
<comment>Description:</comment>
  A Pool is a container for, and controller of, an adjustable number of Workers.
  
  Pooling provides a higher level abstraction of the Worker functionality, including the management
  of references in the way required by pthreads.


id: Pool::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new Pool of Workers
  
  Construct a new pool of workers. Pools lazily create their threads, which means new threads will
  only be spawned when they are required to execute tasks.

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>   The maximum number of workers for this pool to create
  <info>string</info>  <strong>$class</strong>  The class for new Workers. If no class is given, then it defaults to the <class>Worker</class>
                  class.
  <info>array</info>   <strong>$ctor</strong>   An array of arguments to be passed to new workers' constructors


id: Pool::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the pool to collect references determined to be garbage by the optionally given collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks in the pool to be collected.


id: Pool::resize
type: function
doc:
<comment>Description:</comment>
  Resize the Pool
  
  Resize the Pool

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The maximum number of Workers this Pool can create

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Pool::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown all workers
  
  Shuts down all of the workers in the pool. This will block until all submitted tasks have been
  executed.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Pool::submit
type: function
doc:
<comment>Description:</comment>
  Submits an object for execution
  
  Submit the task to the next Worker in the Pool

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$task</strong>  The task for execution

<comment>Return:</comment>
  <info>int</info>  the identifier of the Worker executing the object


id: Pool::submitTo
type: function
doc:
<comment>Description:</comment>
  Submits a task to a specific worker for execution
  
  Submit a task to the specified worker in the pool. The workers are indexed from 0, and will only
  exist if the pool has needed to create them (since threads are lazily spawned).

<comment>Param:</comment>
  <info>int</info>       <strong>$worker</strong>  The worker to stack the task onto, indexed from <return>0</return>.
  <info>Threaded</info>  <strong>$task</strong>    The task for execution.

<comment>Return:</comment>
  <info>int</info>  The identifier of the worker that accepted the task.


id: QuickHashIntHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing integer numbers, where the values are also integer
  numbers. Hashes are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashIntHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntHash::add or
  QuickHashIntHash::loadFromFile) will result in those elements to be dropped from the set. This
  will take up extra time, so only used when it is required.


id: QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC
type: constant
doc:
<comment>Description:</comment>
  Disables the use of PHP's internal memory manager for internal set structures. With this option
  enabled, internal allocations will not count towards the memory_limit settings.


id: QuickHashIntHash::HASHER_JENKINS1
type: constant
doc:
<comment>Description:</comment>
  This is the default hashing function to turn the integer hashes into bucket list indexes.


id: QuickHashIntHash::HASHER_NO_HASH
type: constant
doc:
<comment>Description:</comment>
  Selects to not use a hashing function, but merely use a modulo to find the bucket list index. This
  is not faster than normal hashing, and gives more collisions.


id: QuickHashIntHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntHash object
  
  This constructor creates a new <class>QuickHashIntHash</class>. The size is the amount of bucket lists to create.
  The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntHash::CHECK_FOR_DUPES</info>, which
                 makes sure no duplicate entries are added to the hash;
                 <info>QuickHashIntHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory manager as
                 well as one of <info>QuickHashIntHash::HASHER_NO_HASH</info>, <info>QuickHashIntHash::HASHER_JENKINS1</info>
                 or <info>QuickHashIntHash::HASHER_JENKINS2</info>. These last three configure which hashing
                 algorithm to use. All options can be combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntHash</class> object.


id: QuickHashIntHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntHash::CHECK_FOR_DUPES</info> has been passed when the hash was
  created.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to add.
  <info>int</info>  <strong>$value</strong>  The optional value of the entry to add. If no value is specified, <return>1</return> will be used.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntHash::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the hash
  
  This method deletes an entry from the hash, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the hash itself is
  freed.
  
  Elements can not be deleted when the hash is used in an iterator. The method will not throw an
  exception, but simply return <info>false</info> like would happen with any other deletion failure.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashIntHash::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the hash
  
  This method checks whether an entry with the provided key exists in the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the hash.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashIntHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>int</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashIntHash::getSize
type: function
doc:
<comment>Description:</comment>
  Returns the number of elements in the hash
  
  Returns the number of elements in the hash.

<comment>Return:</comment>
  <info>int</info>  The number of elements in the hash.


id: QuickHashIntHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x11\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  followed by 32 bit signed integers packed together in the Endianness that the system that the code
  runs on uses. For each hash element there are two 32 bit signed integers stored. The first of each
  element is the key, and the second is the value belonging to the key. An example could be:
  
  QuickHash IntHash file format
  
  QuickHash IntHash file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntHash</info>  Returns a new <class>QuickHashIntHash</class>.


id: QuickHashIntHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses. For each element there are two 32 bit signed integers stored. The first of each element is
  the key, and the second is the value belonging to the key.

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntHash</info>  Returns a new <class>QuickHashIntHash</class>.


id: QuickHashIntHash::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory hash to disk
  
  This method stores an existing hash to a file on disk, in the same format that
  QuickHashIntHash::loadFromFile can read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: QuickHashIntHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashIntHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the hash. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  <info>QuickHashIntHash::CHECK_FOR_DUPES</info> during hash creation to prevent duplicate keys from being part
  of the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to add or update.
  <info>int</info>  <strong>$value</strong>  The new value to set the entry with.

<comment>Return:</comment>
  <info>bool</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
        error.


id: QuickHashIntHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  <info>QuickHashIntHash::CHECK_FOR_DUPES</info> during hash creation to prevent duplicate keys from being part
  of the hash.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>    The key of the entry to update.
  <info>int</info>  <strong>$value</strong>  The new value to update the entry with.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: QuickHashIntSet
type: class
doc:
<comment>Description:</comment>
  This class wraps around a set containing integer numbers.
  
  Sets can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well. The
  order of which elements are returned in is not guaranteed.


id: QuickHashIntSet::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntSet::add or
  QuickHashIntSet::loadFromFile) will result in those elements to be dropped from the set. This will
  take up extra time, so only used when it is required.


id: QuickHashIntSet::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntSet object
  
  This constructor creates a new <class>QuickHashIntSet</class>. The size is the amount of bucket lists to create.
  The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>4</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntSet::CHECK_FOR_DUPES</info>, which makes
                 sure no duplicate entries are added to the set;
                 <info>QuickHashIntSet::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory manager as
                 well as one of <info>QuickHashIntSet::HASHER_NO_HASH</info>, <info>QuickHashIntSet::HASHER_JENKINS1</info> or
                 <info>QuickHashIntSet::HASHER_JENKINS2</info>. These last three configure which hashing
                 algorithm to use. All options can be combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntSet</class> object.


id: QuickHashIntSet::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the set
  
  This method adds a new entry to the set, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntSet::CHECK_FOR_DUPES</info> has been passed when the set was
  created.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to add.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntSet::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the set
  
  This method deletes an entry from the set, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the set itself is
  freed.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashIntSet::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the set
  
  This method checks whether an entry with the provided key exists in the set.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the set.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashIntSet::getSize
type: function
doc:
<comment>Description:</comment>
  Returns the number of elements in the set
  
  Returns the number of elements in the set.

<comment>Return:</comment>
  <info>int</info>  The number of elements in the set.


id: QuickHashIntSet::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a set from a file
  
  This factory method creates a new set from a definition file on disk. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the set from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the set, rounded up to the nearest power of two with a maximum limit
                     of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntSet</info>  Returns a new <class>QuickHashIntSet</class>.


id: QuickHashIntSet::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a set from a string
  
  This factory method creates a new set from a definition in a string. The file format consists of
  32 bit signed integers packed together in the Endianness that the system that the code runs on
  uses.

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the set.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the set, rounded up to the nearest power of two automatically
                     limited from <return>64</return> to <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntSet</info>  Returns a new <class>QuickHashIntSet</class>.


id: QuickHashIntSet::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory set to disk
  
  This method stores an existing set to a file on disk, in the same format that
  QuickHashIntSet::loadFromFile can read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: QuickHashIntSet::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the set
  
  This method returns a serialized version of the set in the same format that
  QuickHashIntSet::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the set. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntStringHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing integer numbers, where the values are strings. Hashes
  are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashIntStringHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashIntStringHash::add or
  QuickHashIntStringHash::loadFromFile) will result in those elements to be dropped from the set.
  This will take up extra time, so only used when it is required.


id: QuickHashIntStringHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashIntStringHash object
  
  This constructor creates a new <class>QuickHashIntStringHash</class>. The size is the amount of bucket lists to
  create. The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashIntStringHash::CHECK_FOR_DUPES</info>,
                 which makes sure no duplicate entries are added to the hash;
                 <info>QuickHashIntStringHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory
                 manager as well as one of <info>QuickHashIntStringHash::HASHER_NO_HASH</info>,
                 <info>QuickHashIntStringHash::HASHER_JENKINS1</info> or <info>QuickHashIntStringHash::HASHER_JENKINS2</info>.
                 These last three configure which hashing algorithm to use. All options can be
                 combined using bitmasks.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashIntStringHash</class> object.


id: QuickHashIntStringHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashIntStringHash::CHECK_FOR_DUPES</info> has been passed when the hash
  was created.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to add.
  <info>string</info>  <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashIntStringHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashIntStringHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x12\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  an unsigned 32 bit integer containing the number of element data to follow in characters. This
  element data contains all the strings. After the header and the strings, the elements follow in
  pairs of two unsigned 32 bit integers where the first one is the key, and the second one the index
  in the element data string. An example could be:
  
  QuickHash IntString file format
  
  QuickHash IntString file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of <return>4194304</return>.

<comment>Return:</comment>
  <info>QuickHashIntStringHash</info>  Returns a new <class>QuickHashIntStringHash</class>.


id: QuickHashIntStringHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The format is the same as
  the one used in "loadFromFile".

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from 4 to 4194304.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of 4194304.

<comment>Return:</comment>
  <info>QuickHashIntStringHash</info>  Returns a new QuickHashIntStringHash.


id: QuickHashIntStringHash::saveToFile
type: function
doc:
<comment>Description:</comment>
  This method stores an in-memory hash to disk
  
  This method stores an existing hash to a file on disk, in the same format that loadFromFile() can
  read.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to store the hash in.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: QuickHashIntStringHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashIntStringHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a string containing a serialized format of the hash. Each element is
          stored as a four byte value in the Endianness that the current system uses.


id: QuickHashIntStringHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to add or update.
  <info>string</info>  <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>int</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
       error.


id: QuickHashIntStringHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  QuickHashIntStringHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    The key of the entry to update.
  <info>string</info>  <strong>$value</strong>  The new value for the entry. If a non-string is passed, it will be converted to a
                  string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: QuickHashStringIntHash
type: class
doc:
<comment>Description:</comment>
  This class wraps around a hash containing strings, where the values are integer numbers. Hashes
  are also available as implementation of the ArrayAccess interface.
  
  Hashes can also be iterated over with <return>foreach</return> as the Iterator interface is implemented as well.
  The order of which elements are returned in is not guaranteed.


id: QuickHashStringIntHash::CHECK_FOR_DUPES
type: constant
doc:
<comment>Description:</comment>
  If enabled, adding duplicate elements to a set (through either QuickHashStringIntHash::add or
  QuickHashStringIntHash::loadFromFile) will result in those elements to be dropped from the set.
  This will take up extra time, so only used when it is required.


id: QuickHashStringIntHash::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new QuickHashStringIntHash object
  
  This constructor creates a new <class>QuickHashStringIntHash</class>. The size is the amount of bucket lists to
  create. The more lists there are, the less collisions you will have. Options are also supported.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>     The amount of bucket lists to configure. The number you pass in will be
                 automatically rounded up to the next power of two. It is also automatically limited
                 from <return>64</return> to <return>4194304</return>.
  <info>int</info>  <strong>$options</strong>  The options that you can pass in are: <info>QuickHashStringIntHash::CHECK_FOR_DUPES</info>,
                 which makes sure no duplicate entries are added to the hash and
                 <info>QuickHashStringIntHash::DO_NOT_USE_ZEND_ALLOC</info> to not use PHP's internal memory
                 manager.

<comment>Return:</comment>
  <info>unknown</info>  Returns a new <class>QuickHashStringIntHash</class> object.


id: QuickHashStringIntHash::add
type: function
doc:
<comment>Description:</comment>
  This method adds a new entry to the hash
  
  This method adds a new entry to the hash, and returns whether the entry was added. Entries are by
  default always added unless <info>QuickHashStringIntHash::CHECK_FOR_DUPES</info> has been passed when the hash
  was created.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to add.
  <info>int</info>     <strong>$value</strong>  The value of the entry to add.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was added, and <info>false</info> if the entry was not added.


id: QuickHashStringIntHash::delete
type: function
doc:
<comment>Description:</comment>
  This method deletes an entry from the hash
  
  This method deletes an entry from the hash, and returns whether the entry was deleted or not.
  Associated memory structures will not be freed immediately, but rather when the hash itself is
  freed.
  
  Elements can not be deleted when the hash is used in an iterator. The method will not throw an
  exception, but simply return <info>false</info> like would happen with any other deletion failure.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to delete.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was deleted, and <info>false</info> if the entry was not deleted.


id: QuickHashStringIntHash::exists
type: function
doc:
<comment>Description:</comment>
  This method checks whether a key is part of the hash
  
  This method checks whether an entry with the provided key exists in the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to check for whether it exists in the hash.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> when the entry was found, or <info>false</info> when the entry is not found.


id: QuickHashStringIntHash::get
type: function
doc:
<comment>Description:</comment>
  This method retrieves a value from the hash by its key
  
  This method retrieves a value from the hash by its key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  The key of the entry to retrieve.

<comment>Return:</comment>
  <info>mixed</info>  The value if the key exists, or <info>null</info> if the key wasn't part of the hash.


id: QuickHashStringIntHash::loadFromFile
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a file
  
  This factory method creates a new hash from a definition file on disk. The file format consists of
  a signature <return>'QH\0x21\0'</return>, the number of elements as a 32 bit signed integer in system Endianness,
  an unsigned 32 bit integer containing the number of element data to follow in characters. This
  element data contains all the strings. The follows another signed 32 bit integer containing the
  number of bucket lists.  After the header and the strings, the elements follow. They are ordered
  by bucket list so that the keys don't have to be hashed in order to restore the hash. For each
  bucket list, the following information is stored (all as 32 bit integers): the bucket list index,
  the number of elements in that list, and then in pairs of two unsigned 32 bit integers the
  elements, where the first one is the index into the string list containing the keys, and the
  second one the value.  An example could be:
  
  QuickHash StringIntHash file format
  
  QuickHash IntHash file format

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The filename of the file to read the hash from.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from <return>4</return> to <return>4194304</return>.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is read from the file format (unlike the <class>QuickHashIntHash</class> and
                     <class>QuickHashIntStringHash</class> classes, where it is automatically calculated from the
                     number of entries in the hash.)

<comment>Return:</comment>
  <info>QuickHashStringIntHash</info>  Returns a new <class>QuickHashStringIntHash</class>.


id: QuickHashStringIntHash::loadFromString
type: function
doc:
<comment>Description:</comment>
  This factory method creates a hash from a string
  
  This factory method creates a new hash from a definition in a string. The format is the same as
  the one used in "loadFromFile".

<comment>Param:</comment>
  <info>string</info>  <strong>$contents</strong>  The string containing a serialized format of the hash.
  <info>int</info>     <strong>$size</strong>      The amount of bucket lists to configure. The number you pass in will be
                     automatically rounded up to the next power of two. It is also automatically
                     limited from 4 to 4194304.
  <info>int</info>     <strong>$options</strong>   The same options that the class' constructor takes; except that the size option
                     is ignored. It is automatically calculated to be the same as the number of
                     entries in the hash, rounded up to the nearest power of two with a maximum
                     limit of 4194304.

<comment>Return:</comment>
  <info>QuickHashStringIntHash</info>  Returns a new QuickHashStringIntHash.


id: QuickHashStringIntHash::saveToString
type: function
doc:
<comment>Description:</comment>
  This method returns a serialized version of the hash
  
  This method returns a serialized version of the hash in the same format that
  QuickHashStringIntHash::loadFromString can read.

<comment>Return:</comment>
  <info>string</info>  This method returns a serialized format of an existing hash, in the same format that
          QuickHashStringIntHash::loadFromString can read.


id: QuickHashStringIntHash::set
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value, or
    adds a new one if the entry doesn't exist
  
  This method tries to update an entry with a new value. In case the entry did not yet exist, it
  will instead add a new entry. It returns whether the entry was added or update. If there are
  duplicate keys, only the first found element will get an updated value. Use
  QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to add or update.
  <info>int</info>     <strong>$value</strong>  The value of the entry to add. If a non-string is passed, it will be converted to
                  a string automatically if possible.

<comment>Return:</comment>
  <info>int</info>  2 if the entry was found and updated, 1 if the entry was newly added or 0 if there was an
       error.


id: QuickHashStringIntHash::update
type: function
doc:
<comment>Description:</comment>
  This method updates an entry in the hash with a new value
  
  This method updates an entry with a new value, and returns whether the entry was update. If there
  are duplicate keys, only the first found element will get an updated value. Use
  QuickHashStringIntHash::CHECK_FOR_DUPES during hash creation to prevent duplicate keys from being
  part of the hash.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key of the entry to update.
  <info>int</info>     <strong>$value</strong>  The new value for the entry. If a non-string is passed, it will be converted to a
                  string automatically if possible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> when the entry was found and updated, and <info>false</info> if the entry was not part of the hash
        already.


id: RADIUS_ACCESS_ACCEPT
type: constant
doc:
<comment>Description:</comment>
  An Access-Accept response to an Access-Request indicating that the RADIUS server authenticated the
  user successfully.


id: RADIUS_ACCESS_CHALLENGE
type: constant
doc:
<comment>Description:</comment>
  An Access-Challenge response to an Access-Request indicating that the RADIUS server requires
  further information in another Access-Request before authenticating the user.


id: RADIUS_ACCESS_REJECT
type: constant
doc:
<comment>Description:</comment>
  An Access-Reject response to an Access-Request indicating that the RADIUS server could not
  authenticate the user.


id: RADIUS_ACCESS_REQUEST
type: constant
doc:
<comment>Description:</comment>
  An Access-Request, used to authenticate a user against a RADIUS server. Access request packets
  must include a <info>RADIUS_NAS_IP_ADDRESS</info> or a <info>RADIUS_NAS_IDENTIFIER</info> attribute, must also include a
  <info>RADIUS_USER_PASSWORD</info>, <info>RADIUS_CHAP_PASSWORD</info> or a <info>RADIUS_STATE</info> attribute, and should include a
  <info>RADIUS_USER_NAME</info> attribute.


id: RADIUS_ACCOUNTING_REQUEST
type: constant
doc:
<comment>Description:</comment>
  An Accounting-Request, used to convey accounting information for a service to the RADIUS server.


id: RADIUS_ACCT_AUTHENTIC
type: constant
doc:
<comment>Description:</comment>
  Accounting authentic, one of: <info>RADIUS_AUTH_RADIUS</info><info>RADIUS_AUTH_LOCAL</info><info>RADIUS_AUTH_REMOTE</info>


id: RADIUS_ACCT_STATUS_TYPE
type: constant
doc:
<comment>Description:</comment>
  Accounting status type, one of: <info>RADIUS_START</info><info>RADIUS_STOP</info><info>RADIUS_ACCOUNTING_ON</info><info>RADIUS_ACCOUNTING_OFF</info>


id: RADIUS_ACCT_TERMINATE_CAUSE
type: constant
doc:
<comment>Description:</comment>
  Accounting terminate cause, one of:
  <info>RADIUS_TERM_USER_REQUEST</info><info>RADIUS_TERM_LOST_CARRIER</info><info>RADIUS_TERM_LOST_SERVICE</info><info>RADIUS_TERM_IDLE_TIMEOUT</info><info>RADIUS_TERM_SESSION_TIMEOUT</info><info>RADIUS_TERM_ADMIN_RESET</info><info>RADIUS_TERM_ADMIN_REBOOT</info><info>RADIUS_TERM_PORT_ERROR</info><info>RADIUS_TERM_NAS_ERROR</info><info>RADIUS_TERM_NAS_REQUEST</info><info>RADIUS_TERM_NAS_REBOOT</info><info>RADIUS_TERM_PORT_UNNEEDED</info><info>RADIUS_TERM_PORT_PREEMPTED</info><info>RADIUS_TERM_PORT_SUSPENDED</info><info>RADIUS_TERM_SERVICE_UNAVAILABLE</info><info>RADIUS_TERM_CALLBACK</info><info>RADIUS_TERM_USER_ERROR</info><info>RADIUS_TERM_HOST_REQUEST</info>


id: RADIUS_CALLBACK_ID
type: constant
doc:
<comment>Description:</comment>
  The Callback-Id attribute. The attribute value is a <info>string</info> containing an implementation-specific
  name of the place to be called.


id: RADIUS_CALLBACK_NUMBER
type: constant
doc:
<comment>Description:</comment>
  The Callback-Number attribute. The attribute value is a <info>string</info> containing the dialing string to
  use for callback.


id: RADIUS_CHAP_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  The Chap-Password attribute. The attribute value is expected to be a <info>string</info> with the first byte
  containing the CHAP identifier, and the subsequent 16 bytes containing the MD5 hash of the CHAP
  identifier, the plaintext password and the CHAP challenge value concatenated together. Note that
  the CHAP challenge value should also be sent separately in a <info>RADIUS_CHAP_CHALLENGE</info> attribute.
  
  Using CHAP passwords


id: RADIUS_CLASS
type: constant
doc:
<comment>Description:</comment>
  The Class attribute. The attribute value is an arbitrary <info>string</info> included in an Access-Accept
  message that should then be sent to the accounting server in Accounting-Request messages, and can
  be set using <strong>radius_put_attr()</strong>.


id: RADIUS_COA_ACK
type: constant
doc:
<comment>Description:</comment>
  A CoA-ACK, sent to the RADIUS server to indicate that the user authorisations have been updated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_COA_NAK
type: constant
doc:
<comment>Description:</comment>
  A CoA-NAK, sent to the RADIUS server to indicate that the user authorisations could not be
  updated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_COA_REQUEST
type: constant
doc:
<comment>Description:</comment>
  A CoA-Request, sent from the RADIUS server to indicate that the authorisations within the user
  session have changed. A response must be sent in the form of a CoA-ACK or a CoA-NAK.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_DISCONNECT_ACK
type: constant
doc:
<comment>Description:</comment>
  A Disconnect-ACK, sent to the RADIUS server to indicate that the user session has been terminated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_DISCONNECT_NAK
type: constant
doc:
<comment>Description:</comment>
  A Disconnect-NAK, sent to the RADIUS server to indicate that the user session could not be
  terminated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_DISCONNECT_REQUEST
type: constant
doc:
<comment>Description:</comment>
  A Disconnect-Request, sent from the RADIUS server to indicate that the user session must be
  terminated.
  
  This constant is available in PECL radius 1.3.0 and later.


id: RADIUS_FILTER_ID
type: constant
doc:
<comment>Description:</comment>
  The Filter-ID attribute. The attribute value is expected to be an implementation-specific,
  human-readable <info>string</info> of filters, which can be set using <strong>radius_put_attr()</strong>.


id: RADIUS_FRAMED_COMPRESSION
type: constant
doc:
<comment>Description:</comment>
  The Framed-Compression attribute. The attribute value is expected to be an <info>int</info> indicating the
  compression protocol to be used, and can be set using <strong>radius_put_int()</strong>. Possible values include
  these constants: <info>RADIUS_COMP_NONE</info>: No compression<info>RADIUS_COMP_VJ</info>: VJ TCP/IP header
  compression<info>RADIUS_COMP_IPXHDR</info>: IPX header compression<info>RADIUS_COMP_STAC_LZS</info>: Stac-LZS compression
  (added in PECL radius 1.3.0b2)


id: RADIUS_FRAMED_IPX_NETWORK
type: constant
doc:
<comment>Description:</comment>
  The Framed-IPX-Network attribute. The attribute value is an <info>int</info> containing the IPX network to be
  configured for the user, or <return>0xFFFFFFFE</return> to indicate that the RADIUS client should select the
  network, and can be accessed via <strong>radius_cvt_int()</strong>.


id: RADIUS_FRAMED_IP_ADDRESS
type: constant
doc:
<comment>Description:</comment>
  The Framed-IP-Address attribute. The attribute value is expected to be the address of the user's
  network encoded as an <info>int</info>, which can be set using <strong>radius_put_addr()</strong> and retrieved using
  <strong>radius_cvt_addr()</strong>.


id: RADIUS_FRAMED_IP_NETMASK
type: constant
doc:
<comment>Description:</comment>
  The Framed-IP-Netmask attribute. The attribute value is expected to be the netmask of the user's
  network encoded as an <info>int</info>, which can be set using <strong>radius_put_addr()</strong> and retrieved using
  <strong>radius_cvt_addr()</strong>.


id: RADIUS_FRAMED_MTU
type: constant
doc:
<comment>Description:</comment>
  The Framed-MTU attribute. The attribute value is expected to be an <info>int</info> indicating the MTU to be
  configured for the user, and can be set using <strong>radius_put_int()</strong>.


id: RADIUS_FRAMED_PROTOCOL
type: constant
doc:
<comment>Description:</comment>
  The Framed-Protocol attribute. The attribute value is expected to be an <info>int</info> indicating the framing
  to be used for framed access, and can be set using <strong>radius_put_int()</strong>. The possible attribute values
  include these constants: <info>RADIUS_PPP</info><info>RADIUS_SLIP</info><info>RADIUS_ARAP</info><info>RADIUS_GANDALF</info><info>RADIUS_XYLOGICS</info>


id: RADIUS_FRAMED_ROUTE
type: constant
doc:
<comment>Description:</comment>
  The Framed-Route attribute. The attribute value is a <info>string</info> containing an implementation-specific
  set of routes to be configured for the user.


id: RADIUS_FRAMED_ROUTING
type: constant
doc:
<comment>Description:</comment>
  The Framed-Routing attribute. The attribute value is expected to be an <info>int</info> indicating the routing
  method for the user, which can be set using <strong>radius_put_int()</strong>.
  
  Possible values include: <return>0</return>: No routing<return>1</return>: Send routing packets<return>2</return>: Listen for routing packets<return>3</return>: Send
  and listen


id: RADIUS_LOGIN_IP_HOST
type: constant
doc:
<comment>Description:</comment>
  The Login-IP-Host attribute. The attribute value is expected to the IP address to connect the user
  to, encoded as an <info>int</info>, which can be set using <strong>radius_put_addr()</strong>.


id: RADIUS_LOGIN_SERVICE
type: constant
doc:
<comment>Description:</comment>
  The Login-Service attribute. The attribute value is an <info>int</info> indicating the service to connect the
  user to on the login host. The value can be converted to a PHP integer via <strong>radius_cvt_int()</strong>.


id: RADIUS_LOGIN_TCP_PORT
type: constant
doc:
<comment>Description:</comment>
  The Login-TCP-Port attribute. The attribute value is an <info>int</info> indicating the port to connect the
  user to on the login host. The value can be converted to a PHP integer via <strong>radius_cvt_int()</strong>.


id: RADIUS_NAS_IP_ADDRESS
type: constant
doc:
<comment>Description:</comment>
  The NAS-IP-Address attribute. The attribute value is expected to the IP address of the RADIUS
  client encoded as an <info>int</info>, which can be set using <strong>radius_put_addr()</strong>.


id: RADIUS_NAS_PORT
type: constant
doc:
<comment>Description:</comment>
  The NAS-Port attribute. The attribute value is expected to be the physical port of the user on the
  RADIUS client encoded as an <info>int</info>, which can be set using <strong>radius_put_int()</strong>.


id: RADIUS_NAS_PORT_TYPE
type: constant
doc:
<comment>Description:</comment>
  NAS port type, one of:
  <info>RADIUS_ASYNC</info><info>RADIUS_SYNC</info><info>RADIUS_ISDN_SYNC</info><info>RADIUS_ISDN_ASYNC_V120</info><info>RADIUS_ISDN_ASYNC_V110</info><info>RADIUS_VIRTUAL</info><info>RADIUS_PIAFS</info><info>RADIUS_HDLC_CLEAR_CHANNEL</info><info>RADIUS_X_25</info><info>RADIUS_X_75</info><info>RADIUS_G_3_FAX</info><info>RADIUS_SDSL</info><info>RADIUS_ADSL_CAP</info><info>RADIUS_ADSL_DMT</info><info>RADIUS_IDSL</info><info>RADIUS_ETHERNET</info><info>RADIUS_XDSL</info><info>RADIUS_CABLE</info><info>RADIUS_WIRELESS_OTHER</info><info>RADIUS_WIRELESS_IEEE_802_11</info>


id: RADIUS_OPTION_SALT
type: constant
doc:
<comment>Description:</comment>
  When set, this option will result in the attribute value being salt-encrypted.


id: RADIUS_OPTION_TAGGED
type: constant
doc:
<comment>Description:</comment>
  When set, this option will result in the attribute value being tagged with the value of the tag
  parameter.


id: RADIUS_REPLY_MESSAGE
type: constant
doc:
<comment>Description:</comment>
  The Reply-Message attribute. The attribute value is a <info>string</info> containing text that may be displayed
  to the user in response to an access request.


id: RADIUS_SERVICE_TYPE
type: constant
doc:
<comment>Description:</comment>
  The Service-Type attribute. The attribute value indicates the service type the user is requesting,
  and is expected to be an <info>int</info>, which can be set using <strong>radius_put_int()</strong>.
  
  A number of constants are provided to represent the possible values of this attribute. They
  include:
  <info>RADIUS_LOGIN</info><info>RADIUS_FRAMED</info><info>RADIUS_CALLBACK_LOGIN</info><info>RADIUS_CALLBACK_FRAMED</info><info>RADIUS_OUTBOUND</info><info>RADIUS_ADMINISTRATIVE</info><info>RADIUS_NAS_PROMPT</info><info>RADIUS_AUTHENTICATE_ONLY</info><info>RADIUS_CALLBACK_NAS_PROMPT</info>


id: RADIUS_STATE
type: constant
doc:
<comment>Description:</comment>
  The State attribute. The attribute value is an implementation-defined <info>string</info> included in an
  Access-Challenge from a server that must be included in the subsequent Access-Request, and can be
  set using <strong>radius_put_attr()</strong>.


id: RADIUS_USER_NAME
type: constant
doc:
<comment>Description:</comment>
  The User-Name attribute. The attribute value is expected to be a <info>string</info> containing the name of the
  user being authenticated, and can be set using <strong>radius_put_attr()</strong>.


id: RADIUS_USER_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  The User-Password attribute. The attribute value is expected to be a <info>string</info> containing the user's
  password, and can be set using <strong>radius_put_attr()</strong>. This value will be obfuscated on transmission as
  described in section 5.2 of RFC 2865.


id: RADIUS_VENDOR_MICROSOFT
type: constant
doc:
<comment>Description:</comment>
  Microsoft specific vendor attributes (RFC 2548), one of:
  <info>RADIUS_MICROSOFT_MS_CHAP_RESPONSE</info><info>RADIUS_MICROSOFT_MS_CHAP_ERROR</info><info>RADIUS_MICROSOFT_MS_CHAP_PW_1</info><info>RADIUS_MICROSOFT_MS_CHAP_PW_2</info><info>RADIUS_MICROSOFT_MS_CHAP_LM_ENC_PW</info><info>RADIUS_MICROSOFT_MS_CHAP_NT_ENC_PW</info><info>RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_POLICY</info><info>RADIUS_MICROSOFT_MS_MPPE_ENCRYPTION_TYPES</info><info>RADIUS_MICROSOFT_MS_RAS_VENDOR</info><info>RADIUS_MICROSOFT_MS_CHAP_DOMAIN</info><info>RADIUS_MICROSOFT_MS_CHAP_CHALLENGE</info><info>RADIUS_MICROSOFT_MS_CHAP_MPPE_KEYS</info><info>RADIUS_MICROSOFT_MS_BAP_USAGE</info><info>RADIUS_MICROSOFT_MS_LINK_UTILIZATION_THRESHOLD</info><info>RADIUS_MICROSOFT_MS_LINK_DROP_TIME_LIMIT</info><info>RADIUS_MICROSOFT_MS_MPPE_SEND_KEY</info><info>RADIUS_MICROSOFT_MS_MPPE_RECV_KEY</info><info>RADIUS_MICROSOFT_MS_RAS_VERSION</info><info>RADIUS_MICROSOFT_MS_OLD_ARAP_PASSWORD</info><info>RADIUS_MICROSOFT_MS_NEW_ARAP_PASSWORD</info><info>RADIUS_MICROSOFT_MS_ARAP_PASSWORD_CHANGE_REASON</info><info>RADIUS_MICROSOFT_MS_FILTER</info><info>RADIUS_MICROSOFT_MS_ACCT_AUTH_TYPE</info><info>RADIUS_MICROSOFT_MS_ACCT_EAP_TYPE</info><info>RADIUS_MICROSOFT_MS_CHAP2_RESPONSE</info><info>RADIUS_MICROSOFT_MS_CHAP2_SUCCESS</info><info>RADIUS_MICROSOFT_MS_CHAP2_PW</info><info>RADIUS_MICROSOFT_MS_PRIMARY_DNS_SERVER</info><info>RADIUS_MICROSOFT_MS_SECONDARY_DNS_SERVER</info><info>RADIUS_MICROSOFT_MS_PRIMARY_NBNS_SERVER</info><info>RADIUS_MICROSOFT_MS_SECONDARY_NBNS_SERVER</info><info>RADIUS_MICROSOFT_MS_ARAP_CHALLENGE</info>


id: RADIUS_VENDOR_SPECIFIC
type: constant
doc:
<comment>Description:</comment>
  The Vendor-Specific attribute. In general, vendor attribute values should be set using
  <strong>radius_put_vendor_addr()</strong>, <strong>radius_put_vendor_attr()</strong>, <strong>radius_put_vendor_int()</strong> and
  <strong>radius_put_vendor_string()</strong>, rather than directly.
  
  This constant is mostly useful when interpreting vendor specific attributes in responses from a
  RADIUS server; when a vendor specific attribute is received, the <strong>radius_get_vendor_attr()</strong> function
  should be used to access the vendor ID, attribute type and attribute value.


id: READLINE_LIB
type: constant
doc:
<comment>Description:</comment>
  readline サポートに使われるライブラリ。 現状は、<return>readline</return> または <return>libedit</return> が指定できます。


id: RNP_ENCRYPT_NOWRAP
type: constant
doc:
<comment>Description:</comment>
  Allows encryption of signed message. Message is not wrapped into literal data packet.


id: RNP_KEYSTORE_KBX
type: constant
doc:
<comment>Description:</comment>
  Keystore format "KBX". For public keys only. A keybox is a file format used to store public keys
  along with meta information and indices.


id: RNP_KEY_EXPORT_SUBKEYS
type: constant
doc:
<comment>Description:</comment>
  If primary key is being exported, all subkeys will be exported too.


id: RNP_KEY_REMOVE_SUBKEYS
type: constant
doc:
<comment>Description:</comment>
  If primary key is being deleted, all of its subkeys will be removed too.


id: RNP_LOAD_SAVE_PERMISSIVE
type: constant
doc:
<comment>Description:</comment>
  Allows to ignore bad signature/key/subkey packets during key import.


id: RNP_LOAD_SAVE_PUBLIC_KEYS
type: constant
doc:
<comment>Description:</comment>
  Load or save public keys only. Can be OR-ed with <info>RNP_LOAD_SAVE_SECRET_KEYS</info> to load both public and
  private keys to the FFI context or save them from the context.


id: RNP_LOAD_SAVE_SECRET_KEYS
type: constant
doc:
<comment>Description:</comment>
  Load or save secret keys only. Can be OR-ed with <info>RNP_LOAD_SAVE_PUBLIC_KEYS</info> to load both public and
  private keys to the FFI context or save them from the context.


id: RPMMIRE_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Search pattern is a regular expression with \., .* and ^...$ added.


id: RPMTAG_ENHANCENAME
type: constant
doc:
<comment>Description:</comment>
  Weak dependencies, with database index, requires librpm &gt;= 4.13.


id: RPMTAG_FILETRIGGERNAME
type: constant
doc:
<comment>Description:</comment>
  File trigger name, with database index, requires librpm &gt;= 4.13.


id: RPMTAG_RECOMMENDNAME
type: constant
doc:
<comment>Description:</comment>
  Recommended weak dependencies, with database index, requires librpm &gt;= 4.13.


id: RPMTAG_SUGGESTNAME
type: constant
doc:
<comment>Description:</comment>
  Suggested weak dependencies, with database index, requires librpm &gt;= 4.13.


id: RPMTAG_TRANSFILETRIGGERNAME
type: constant
doc:
<comment>Description:</comment>
  Transaction file trigger name, with database index, requires librpm &gt;= 4.13.


id: RRDCreator::__construct
type: function
doc:
<comment>Description:</comment>
  Creates new RRDCreator instance
  
  Creates new <class>RRDCreator</class> instance.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>       Path for newly created RRD database file.
  <info>string</info>  <strong>$startTime</strong>  Time for the first value in RRD database. Parameter supports all formats which
                      are supported by rrd create call.
  <info>int</info>     <strong>$step</strong>       Base interval in seconds with which data will be fed into the RRD database.


id: RRDCreator::addArchive
type: function
doc:
<comment>Description:</comment>
  Adds RRA - archive of data values for each data source
  
  Adds RRA definition by description of archive. Archive consists  of a number of data values or
  statistics for each of the defined data-sources (DS). Data sources are defined by method
  RRDCreator::addDataSource. You need call this method for each requested archive.

<comment>Param:</comment>
  <info>string</info>  <strong>$description</strong>  Definition of archive - RRA. This has same format as RRA definition in rrd
                        create command. See man page of rrd create for more details.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: RRDCreator::addDataSource
type: function
doc:
<comment>Description:</comment>
  Adds data source definition for RRD database
  
  RRD can accept input from several data sources (DS), e.g incoming and outgoing traffic. This
  method adds data source by description. You need call this method for each data source.

<comment>Param:</comment>
  <info>string</info>  <strong>$description</strong>  Definition of data source - DS. This has same format as DS definition in rrd
                        create command. See man page of rrd create for more details.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: RRDCreator::save
type: function
doc:
<comment>Description:</comment>
  Saves the RRD database to a file
  
  Saves the RRD database into file, which name is defined by RRDCreator::__construct.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: RRDGraph::__construct
type: function
doc:
<comment>Description:</comment>
  Creates new RRDGraph instance
  
  Creates new <class>RRDGraph</class> instance. This instance is responsible for rendering the result of RRD
  database query into image.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Full path for the newly created image.


id: RRDGraph::save
type: function
doc:
<comment>Description:</comment>
  Saves the result of query into image
  
  Saves the result of RRD database query into image defined by RRDGraph::__construct.

<comment>Return:</comment>
  <info>array</info>  Returns array with information about generated image,失敗した場合に <info>false</info> を返します.


id: RRDGraph::saveVerbose
type: function
doc:
<comment>Description:</comment>
  Saves the RRD database query into image and returns the verbose
     information about generated graph
    
  
  Saves the RRD database query into image file defined by method RRDGraph::__construct and returns
  the verbose information about generated graph, if "-" is used as image filename, image data are
  also returned in result array.

<comment>Return:</comment>
  <info>array</info>  Returns array with detailed information about generated image,失敗した場合に <info>false</info> を返しま
         す.


id: RRDGraph::setOptions
type: function
doc:
<comment>Description:</comment>
  Sets the options for rrd graph export

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  List of options for the image generation from the RRD database file. It can be
                   list of strings or list of strings with keys for better readability. Read the rrd
                   graph man pages for list of available options.

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: RRDUpdater::__construct
type: function
doc:
<comment>Description:</comment>
  Creates new RRDUpdater instance
  
  Creates new RRDUpdater instance. This instance is responsible for updating the RRD database file.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Filesystem path for RRD database file, which will be updated.


id: RRDUpdater::update
type: function
doc:
<comment>Description:</comment>
  Update the RRD database file
  
  Updates the RRD file defined via RRDUpdater::__construct. The file is updated with a specific
  values.

<comment>Param:</comment>
  <info>array</info>   <strong>$values</strong>  Data for update. Key is data source name.
  <info>string</info>  <strong>$time</strong>    Time value for updating the RRD with a particular data. Default value is current
                   time.

<comment>Return:</comment>
  <info>bool</info>  成功した場合に <info>true</info> を、失敗した場合に <info>false</info> を返します。


id: RUNKIT7_ACC_PRIVATE
type: constant
doc:
<comment>Description:</comment>
  Flag for <strong>runkit7_method_add()</strong> and <strong>runkit7_method_redefine()</strong> to make the method private.


id: RUNKIT7_ACC_PROTECTED
type: constant
doc:
<comment>Description:</comment>
  Flag for <strong>runkit7_method_add()</strong> and <strong>runkit7_method_redefine()</strong> to make the method protected.


id: RUNKIT7_ACC_PUBLIC
type: constant
doc:
<comment>Description:</comment>
  Flag for <strong>runkit7_method_add()</strong> and <strong>runkit7_method_redefine()</strong> to make the method public.


id: RUNKIT7_ACC_RETURN_REFERENCE
type: constant
doc:
<comment>Description:</comment>
  Include this flag to make the function or method being created or redeclared return a reference.


id: RUNKIT7_ACC_STATIC
type: constant
doc:
<comment>Description:</comment>
  Flag for <strong>runkit7_method_add()</strong> and <strong>runkit7_method_redefine()</strong> to make the method static.


id: RUNKIT7_FEATURE_SANDBOX
type: constant
doc:
<comment>Description:</comment>
  Always 0, it's impractical to implement the sandbox feature in php 7.


id: RUNKIT7_IMPORT_CLASSES
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag representing a bitwise OR of the <info>RUNKIT7_IMPORT_CLASS_*</info> constants.


id: RUNKIT7_IMPORT_CLASS_CONSTS
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that class constants should be imported from the specified file.


id: RUNKIT7_IMPORT_CLASS_METHODS
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that class methods should be imported from the specified file.


id: RUNKIT7_IMPORT_CLASS_PROPS
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that class standard properties should be imported from the
  specified file.


id: RUNKIT7_IMPORT_CLASS_STATIC_PROPS
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that class static properties should be imported from the
  specified file. Available since Runkit 1.0.1.


id: RUNKIT7_IMPORT_FUNCTIONS
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that normal functions should be imported from the specified file.


id: RUNKIT7_IMPORT_OVERRIDE
type: constant
doc:
<comment>Description:</comment>
  <strong>runkit7_import()</strong> flag indicating that if any of the imported functions, methods, constants, or
  properties already exist, they should be replaced with the new definitions.  If this flag is not
  set, then any imported definitions which already exist will be discarded.


id: Random\CryptoSafeEngine
type: class
doc:
<comment>Description:</comment>
  <info>Random\Engine</info> が、暗号学的にセキュアなランダム値を返すことを示す、マーカーインターフェイスです。 


id: Random\Engine
type: class
doc:
<comment>Description:</comment>
  <class>Random\Engine</class> は、ランダムな値の低レベルなソースを提供します。 ここから返されたランダムな値は、 高
  レベルAPIで操作することで消費されます。 <class>Random\Engine</class> インターフェイスを使うと、 ランダムな値を生
  成するためのアルゴリズムを切り替えることができます。 何故切り替えるのかというと、 それぞれのアルゴ
  リズムは特定のユースケースに応じて、 異なるトレードオフの特性を持つからです。 とても高速に値を生成
  するものの、 生成するランダムな値の品質は低いアルゴリズムもあれば、 それよりは低速ですが、よりよい
  ランダムな値を生成するアルゴリズムもあります。 さらに、<class>Random\Engine\Secure</class> が提供する、 暗号学的
  にセキュアな、ランダムな値を生成するものまであります。
  
  PHP は 異なるユースケースに対応した、 複数の <class>Random\Engine</class> を提供します。 とても高速なパフォーマン
  スを追求したり、 再現可能なシーケンスをアプリケーション側で必須としない限り、 CSPRNG をバックエン
  ドにした <class>Random\Engine\Secure</class> を、 デフォルトとして選択することを推奨します。


id: Random\Engine::generate
type: function
doc:
<comment>Description:</comment>
  ランダムな値を生成する
  
  ランダムな値を生成し、アルゴリズムの内部的なステートをひとつ進めます。
  
  ランダムな値は、ランダムなバイト列を含んだバイナリ文字列として表現されます。 そう表現することで、
  アルゴリズムが生成したランダムなビットを、 曖昧さがない形で解釈できるようになります。 これはたとえ
  ば、アルゴリズムによって異なる出力サイズを調整する目的があります。
  
  整数の値をネイティブで操作するアルゴリズムは、 たとえば <strong>pack()</strong> 関数に <return>P</return> フォーマットコードを指定す
  るなどして、リトルエンディアンで整数値を返すべきです。 <class>Random\Randomizer</class> が提供する高レベルイン
  ターフェイスは、 数値表現が必要な場合、返されたランダムなバイト列を符号なしのリトルエンディアンと
  して解釈します。
  
  返された文字列の個々のビットは、 等確率に、かつ独立に選ばれた状態にあることを強く推奨します。 アプ
  リケーションによっては、正しく動作する要件が、 ビットレベルでランダムであることに依存する場合があ
  るからです。 たとえば 線形合同法(LCGs) は、整数の下位ビットについては品質が低いランダムな値を生成
  するため、 ビットレベルでランダムな状態を必須とするアプリケーションには適していません。

<comment>Return:</comment>
  <info>string</info>  ランダムなバイト列を含む、空でない文字列を返します。
          
          <class>Random\Randomizer</class> は内部的に、符号なしの64ビット整数を使って動作します。 返される文字列が
          64ビット(8バイト)以上のランダムな文字列である場合、 64ビットを超えるバイト列は無視されま
          す。 他のアプリケーションでは、 64ビット以上のデータを一度に処理できるものがあるかもしれま
          せん。


id: Random\Engine\Mt19937::__construct
type: function
doc:
<comment>Description:</comment>
  新しい Mt19937 エンジンを作成する
  
  Mt19937 (メルセンヌ・ツイスター) エンジンは、シードとして32ビットの整数だけを受け入れます。よっ
  て、219937-1 もの周期を持つにも関わらず、あり得るランダムなシーケンスの数はたかだか 232 (つまり
  4,294,967,296) しかありません。
  
  暗黙、または明示的にランダムなシードに依存する場合、 重複がそれ(4,294,967,296 個)よりも早く発生し
  ます。 誕生日のパラドックスによると、80,000 個以下のランダムな値を生成した場合でも、 シードの重複
  が 50% の確率で発生します。 重複したシードの 10% が、ざっと 30,000 個のランダムな値を生成したあと
  に発生します。
  
  このため、無視できる確率以上に重複したシーケンスが発生してはいけないアプリケーションでは、Mt19937
  は適していません。 再現可能なシードが必須の場合、 <class>Random\Engine\Xoshiro256StarStar</class> と
  <class>Random\Engine\PcgOneseq128XslRr64</class> が、ランダムな値が衝突しにくく、より大きなシードをサポートしてい
  ます。 再現可能なシードが必須でない場合、 <class>Random\Engine\Secure</class> が、暗号学的にセキュアなランダム性
  を提供します。
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>int|null</info>  <strong>$seed</strong>  符号なし32ビットの整数として解釈される <strong>$seed</strong> をシードとし、 線形合同法(LCG) を
                   使って生成された値でステートを埋めます。
                   
                   <strong>$seed</strong> が省略されるか、<info>null</info> の場合は、 ランダムな符号なし32ビットの整数を使いま
                   す。
  <info>int</info>       <strong>$mode</strong>  使用するアルゴリズムの実装を指定するために、 以下の定数のうちの一つを指定します:
                   <info>MT_RAND_MT19937</info>: 正しい メルセンヌ・ツイスター の実装です。 <info>MT_RAND_PHP</info>: 正しくな
                   い メルセンヌ・ツイスター の実装です。 PHP 7.1.0 より前のバージョンの <strong>mt_srand()</strong>
                   と互換性を保つために残されています。
                   
                   この機能は PHP 8.3.0 で
                   非推奨になります。この機能に頼らないことを強く推奨します。


id: Random\Engine\Mt19937::__debugInfo
type: function
doc:
<comment>Description:</comment>
  エンジンの内部的なステートを返す
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Random\Engine\Mt19937::__serialize
type: function
doc:
<comment>Description:</comment>
  Mt19937 オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Random\Engine\Mt19937::__unserialize
type: function
doc:
<comment>Description:</comment>
  指定した data を Mt19937 オブジェクトに復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Random\Engine\Mt19937::generate
type: function
doc:
<comment>Description:</comment>
  32ビットのランダムな値を生成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  符号なし32ビットの整数値を、リトルエンディアンで表現した文字列を返します。


id: Random\Engine\PcgOneseq128XslRr64
type: class
doc:
<comment>Description:</comment>
  128 ビットのステートと、XSL-RR 変換を用いて、64 ビットの出力を生成する Permuted congruential
  generator (PCG) を実装したクラスです。


id: Random\Engine\PcgOneseq128XslRr64::__construct
type: function
doc:
<comment>Description:</comment>
  128 ビットのステートと XSL RR 変換を使う、新しいPCGエンジンを作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string|int|null</info>  <strong>$seed</strong>  128ビット(16バイト) の符号なし整数が、 どのように与えられるかを <strong>$seed</strong> のタ
                          イプを使って指定します。 タイプ説明<info>null</info> ランダムな16バイトのステートを、
                          CSPRNG を使って生成し、埋めます。 <info>int</info><return>0</return> に設定することでステートを埋め、エ
                          ンジンの内部状態をひとつ進めます。 そして、<strong>$seed</strong> を64ビットの符号なし整数
                          と解釈して加算し、 エンジンの内部状態をさらにもうひとつ進めます。 <info>string</info>
                          16バイトの文字列を、リトルエンディアン、 かつ符号なし128ビットの整数と解釈
                          してステートを埋めます。


id: Random\Engine\PcgOneseq128XslRr64::__serialize
type: function
doc:
<comment>Description:</comment>
  PcgOneseq128XslRr64 オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Random\Engine\PcgOneseq128XslRr64::__unserialize
type: function
doc:
<comment>Description:</comment>
  指定した data を PcgOneseq128XslRr64 オブジェクトに復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Random\Engine\PcgOneseq128XslRr64::generate
type: function
doc:
<comment>Description:</comment>
  64ビットのランダムな値を生成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Return:</comment>
  <info>string</info>  符号なし64ビットの整数値を、リトルエンディアンで表現した文字列を返します。


id: Random\Engine\PcgOneseq128XslRr64::jump
type: function
doc:
<comment>Description:</comment>
  エンジンの内部状態を、効率的に複数ステップ進める
  
  <strong>Random\Engine\PcgOneseq128XslRr64::generate()</strong> が何回も呼ばれたかのように、 アルゴリズムのステート
  を <strong>$advance</strong> で指定された回数分進めます。

<comment>Param:</comment>
  <info>int</info>  <strong>$advance</strong>  ステートを進める回数。 <return>0</return> 以上でなければなりません。

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Random\Engine\Secure
type: class
doc:
<comment>Description:</comment>
  オペレーティングシステムの CSPRNG を使い、暗号学的にセキュアな、ランダムな値を生成します。
  
  この <class>Random\Engine</class> が生成するランダムな値は、 暗号化キーのような長期間使うシークレットを含む、すべ
  てのアプリケーションで適切です。
  
  とても高速なパフォーマンスを追求したり、 再現可能なシーケンスをアプリケーション側で必須としない限
  り、 <class>Random\Engine\Secure</class> エンジンを安全なデフォルトの選択として推奨します。


id: Random\Engine\Secure::generate
type: function
doc:
<comment>Description:</comment>
  暗号学的にセキュアな、ランダムなバイト列を生成する
  
  暗号学的にセキュアな、ランダムなバイト列を返します。
  
  この関数が使う不規則性のソースは、優先度順に以下のとおりです:
  
  Linux: getrandom(), /dev/urandom
  
  FreeBSD &gt;= 12 (PHP &gt;= 7.3): getrandom(), /dev/urandom
  
  Windows (PHP &gt;= 7.2): CNG-API
  
  Windows: CryptGenRandom
  
  macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 CCRandomGenerateBytes がコンパイル時に利用可能な場
  合): CCRandomGenerateBytes()
  
  macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), /dev/urandom
  
  NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  DragonflyBSD (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Solaris (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  上記にあてはまらないオペレーティングシステムやPHP のバージョンの場合: /dev/urandom
  
  どの不規則性のソースも利用できなかったり、 すべてのソースがランダムな値を生成できなかった場合、
  <class>Random\RandomException</class> がスローされます。

<comment>Return:</comment>
  <info>string</info>  暗号学的にセキュアな、ランダムなバイト列を文字列として返します。 長さは <info>PHP_INT_SIZE</info> で
          す。


id: Random\Engine\Xoshiro256StarStar::__construct
type: function
doc:
<comment>Description:</comment>
  新しい xoshiro256** エンジンを作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>string|int|null</info>  <strong>$seed</strong>  符号なし64ビット整数で構成される 256ビット(32バイト) の内部ステートが、 ど
                          のように与えられるかは <strong>$seed</strong> のタイプに依存します。 タイプ説明<info>null</info> ランダ
                          ムな32バイトのステートを、 CSPRNG を使って生成し、埋めます。 <info>int</info><strong>$seed</strong> を
                          64ビットの符号なし整数と解釈し、 その値を SplitMix64 アルゴリズムに与えて
                          生成した、 4つの連続した値でステートを埋めます。 <info>string</info> 32バイトの文字列
                          を、4つのリトルエンディアン、 かつ符号なし64ビットの整数と解釈してステート
                          を埋めます。


id: Random\Engine\Xoshiro256StarStar::__serialize
type: function
doc:
<comment>Description:</comment>
  Xoshiro256StarStar オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Random\Engine\Xoshiro256StarStar::__unserialize
type: function
doc:
<comment>Description:</comment>
  指定した data を Xoshiro256StarStar オブジェクトに復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Random\Engine\Xoshiro256StarStar::jump
type: function
doc:
<comment>Description:</comment>
  エンジンの内部状態を、効率的に 2^128 ステップ進める
  
  <strong>Random\Engine\Xoshiro256StarStar::generate()</strong> が 2128 回呼ばれたかのように、 アルゴリズムのステート
  を 2128 回分進めます。
  
  アルゴリズムの内部状態を進める目的は、 新しい <class>Random\Engine\Xoshiro256StarStar</class> エンジンを、既に存
  在する <class>Random\Engine\Xoshiro256StarStar</class> から生成するのを容易にするためです。 シードが与えられてい
  るエンジンは新しいエンジンの設計図として振る舞い、 clone することができ、 2128 の値を持つ 2128 個
  分の重ならないシーケンスを作るために、繰り返し内部状態を進めます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Random\Engine\Xoshiro256StarStar::jumpLong()</strong>


id: Random\Engine\Xoshiro256StarStar::jumpLong
type: function
doc:
<comment>Description:</comment>
  エンジンの内部状態を、効率的に 2^192 ステップ進める
  
  <strong>Random\Engine\Xoshiro256StarStar::generate()</strong> が 2192 回呼ばれたかのように、 アルゴリズムのステート
  を 2192 回分進めます。
  
  アルゴリズムの内部状態を大きく進める目的は、 新しい <class>Random\Engine\Xoshiro256StarStar</class> エンジンを、
  既に存在する <class>Random\Engine\Xoshiro256StarStar</class> から生成するのを容易にするためです。 シードが与えら
  れているエンジンは新しいエンジンの設計図として振る舞い、 clone することができ、 2192 の値を持つ
  264 個分の重ならないシーケンスを作るために、繰り返し内部状態を進めます。
  
  このメソッドは、 <strong>Random\Engine\Xoshiro256StarStar::jump()</strong> と組み合わせることができます。 そうする
  ことで、このメソッドが生成した 264 回数分のシーケンスを、 2128 の値をそれぞれ持つ 264 回分のシーケ
  ンスに分割できます。

<comment>Return:</comment>
  <info>void</info>  値を返しません。

<comment>See Also:</comment>
   * <strong>Random\Engine\Xoshiro256StarStar::jump()</strong>


id: Random\RandomError
type: class
doc:
<comment>Description:</comment>
  たとえば、生成される値がとても強く偏っているなどの理由で、 使っている <class>Random\Engine</class> が壊れているこ
  とを示します。


id: Random\Randomizer::__construct
type: function
doc:
<comment>Description:</comment>
  新しい Randomizer を作成する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>Random\Engine|null</info>  <strong>$engine</strong>  ランダムな値を生成するのに使う <class>Random\Engine</class>
                               
                               <strong>$engine</strong> が省略されるか、<info>null</info> の場合は、 新しい <class>Random\Engine\Secure</class>
                               オブジェクトを使います。


id: Random\Randomizer::__serialize
type: function
doc:
<comment>Description:</comment>
  Randomizer オブジェクトをシリアライズする
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

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


id: Random\Randomizer::__unserialize
type: function
doc:
<comment>Description:</comment>
  指定した data を Randomizer オブジェクトに復元する
  
  この関数は、
  現在のところ詳細な情報はありません。引数のリストのみが
  記述されています。

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  

<comment>Return:</comment>
  <info>void</info>  値を返しません。


id: Random\Randomizer::getBytes
type: function
doc:
<comment>Description:</comment>
  ランダムなバイト列を取得する
  
  等確率に選ばれるランダムなバイト列を含む、指定された長さ <strong>$length</strong> の文字列を生成します。
  
  返されるバイト列は完全にランダムに選ばれるため、 結果の文字列は印字できない文字や、 不正な UTF-8
  のシーケンスとなる可能性があります。 よって、転送したり表示したりする時にはエンコードが必要かもし
  れません。

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  返すべきランダムな文字列の長さをバイト単位で指定します。<return>1</return> 以上でなければなりません。

<comment>Return:</comment>
  <info>string</info>  指定された長さの、ランダムなバイト列を含んだ文字列を返します。

<comment>See Also:</comment>
   * <strong>random_bytes()</strong>
   * <strong>base64_encode()</strong>
   * Random\Randomizer::getBytesFromString


id: Random\Randomizer::getBytesFromString
type: function
doc:
<comment>Description:</comment>
  文字列からランダムにバイト列を取得する
  
  入力となる <strong>$string</strong> から等確率に選択した、ランダムなバイト列を含む文字列を、 指定された <strong>$length</strong> だ
  け返します。
  
  特定のバイトが選ばれる確率は、 入力となる <strong>$string</strong> に占める割合に比例します。 それぞれのバイトの頻
  度が同じ場合、 それぞれのバイトが選ばれる確率は等しくなります。

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  戻り値のために、バイト列が選択される文字列
  <info>int</info>     <strong>$length</strong>  バイト単位で返されるランダムな文字列の長さ。 <return>1</return> 以上でなければいけません。

<comment>Return:</comment>
  <info>string</info>  入力された <strong>$string</strong> から取得したランダムなバイト列を、 指定された長さだけ含む文字列を返しま
          す。

<comment>See Also:</comment>
   * Random\Randomizer::getBytes


id: Random\Randomizer::getFloat
type: function
doc:
<comment>Description:</comment>
  等確率に選んだ float の値を取得する
  
  指定した区間に一様に分散した浮動小数点数の中から、等確率に選んだ値を返します。
  
  精度が限られているため、 全ての実数が正確に浮動小数点数として表現できるとは限りません。
   数値が正確に表現できない場合、値は表現できるもっとも近い値に丸められます。
   さらに浮動小数点数の値は、数直線全体に均等に分布しているわけではありません。
   浮動小数点数の値は 2進数の指数を使うので、隣り合うふたつの値の距離は、 それぞれの2のべき乗ごとに
  2倍になります。
   つまり: <return>1.0</return> と <return>2.0</return> の間で表現できる 浮動小数点数 の数は、<return>2.0</return> と <return>4.0</return> の間で表現できる数、<return>4.0</return> と
  <return>8.0</return> の間で表現できる数、<return>8.0</return> と <return>16.0</return> の間で表現できる数と同じ... といった具合です。
  
  こうした理由から、例えば2つの整数を割るなどして、 要求された区間内の任意の数をランダムサンプリング
  すると、 分布が偏る可能性があります。
   必要な丸めを行うと、 浮動小数点数の値によっては別の値より多くの頻度で返されることがあります。 浮
  動小数点数の値の密度が変わる2のべき乗周辺の値については、特にそれが当てはまります。
  
  Random\Randomizer::getFloat は、 指定した区間内で正確に表現でき、 かつ一様に分散した浮動小数点数の
  可能な限り大きな集合から、 等確率に値を返すアルゴリズムを実装します。
   選択可能な浮動小数点数の間の距離 (ステップサイズ) は、 密度が最も小さい浮動小数点数の間の距離、つ
  まり、 絶対値がより大きな区間境界の浮動小数点数の距離に一致します。
   これは、区間が2のべき乗を1つ以上横切る場合、 与えられた区間内で表現可能な浮動小数点数の値がすべて
  返されるとは限らないということです。
   ステップは、絶対値の大きい区間境界から始まります。 これは、ステップを正確に表現可能な浮動小数点数
  と一致させるためです。
  
  閉区間の境界は、常に選択可能な浮動小数点数の集合に含まれます。
   よって、区間のサイズがステップサイズの正確な倍数でなく、 かつ絶対値が小さな方の境界が閉じている場
  合、 その境界とそれにもっとも近い選択可能な浮動小数点数との間の距離は、 ステップサイズよりも小さく
  なります。
  
  このメソッドが返す float の値を後処理すると、 値の一様な分布を壊す可能性があります。なぜなら、 数
  学演算に含まれる中間的な浮動小数点数の値は暗黙のうちに丸められているからです。
   指定された区間は、できるだけ望ましい区間と一致させるべきですし、 丸め処理はこのメソッドが選択した
  値をユーザーに表示させる直前に明示的に実行すべきです。
  
  アルゴリズムがどのように動作するかの例を示すために、 3ビットの仮数を使用する浮動小数点表現を考えて
  みましょう。
   この表現は、連続する2のべき乗の間で、8つの異なる浮動小数点数を表現することができます。
   つまり、<return>1.0</return> と <return>2.0</return> の間では <return>0.125</return> のすべてのステップサイズを正確に表現でき、 <return>2.0</return> と <return>4.0</return> の間では
  <return>0.25</return> のすべてのステップサイズを正確に表現できるということです。
   実際には、PHP の float は 52 ビットの仮数を使用しており、 それぞれの 2 のべき乗の間で 252 個の異
  なる値を表現することができます。
   つまり、以下の数が、<return>1.0</return> と <return>4.0</return> の範囲で正確に表現できるということです。
   <return>1.0</return><return>1.125</return><return>1.25</return><return>1.375</return><return>1.5</return><return>1.625</return><return>1.75</return><return>1.875</return><return>2.0</return><return>2.25</return><return>2.5</return><return>2.75</return><return>3.0</return><return>3.25</return><return>3.5</return><return>3.75</return><return>4.0</return>
  
  さてここで、$randomizer-&gt;getFloat(1.625, 2.5, IntervalBoundary::ClosedOpen) がコールされた場合
  を考えてみましょう。 つまり、<return>1.625</return> から始まり、<return>2.5</return> までのランダムな値 (ただし <return>2.5</return> そのものは含みま
  せん) を要求するということです。
   このメソッドのアルゴリズムは、 まず絶対値の大きい境界(<return>2.5</return>)でのステップサイズを決定します。 今回の
  境界の場合、ステップサイズは <return>0.25</return> です。
  
  ここで、要求された区間のサイズは <return>0.875</return> であり、 <return>0.25</return> の正確な倍数ではないことに注意してください。
   もしアルゴリズムが下界 <return>1.625</return>からステップを開始すると、 正確に表現できない <return>2.125</return> が現れた時点で、
  暗黙の丸めが発生します。
   そのため、アルゴリズムは上界 <return>2.5</return> からステップを開始するのです。
   選択可能な値は、以下のとおりです:
   <return>2.25</return><return>2.0</return><return>1.75</return><return>1.625</return>
   <return>2.5</return> は選択可能な値に含まれません。 なぜなら、要求された区間の上界が開いているからです。
   <return>1.625</return> は選択可能な値に含まれます。 この値は最も近い値 <return>1.75</return> との距離が <return>0.125</return> であり、以前決定した
  ステップサイズ <return>0.25</return>より小さいのですが、 それにも関わらず、含まれます。
   その理由は、要求された区間は下側の境界(<return>1.625</return>)で閉じており、 閉じた境界は常に含まれるからです。
  
  最後に、アルゴリズムは4つの選択可能な値から等確率で値をランダムに選び、それを返します。
  
  上の例では、2のべき乗で区切られたそれぞれの区間に、 表現可能な浮動小数点数が8個あります。
   ランダムな浮動小数点数を生成するのに、 なぜ2つの整数を割る方法がうまくいかないのかを示すために、
  <return>0.0</return> から <return>1.0</return> を含まない右開きの区間に、16個の一様に分散した浮動小数点数があるとしましょう。
   そのうち半分は、<return>0.5</return> から <return>1.0</return> までの間で8つの値として正確に表現できますが、 残りの半分は <return>0.0</return> から
  <return>1.0</return> までの間でステップサイズが <return>0.0625</return> の値です。 これらの値は、<return>0</return> から <return>15</return> の間のランダムな整数を <return>16</return>
  で割ることによって、以下のうちのひとつを簡単に生成することができます:
   <return>0.0</return><return>0.0625</return><return>0.125</return><return>0.1875</return><return>0.25</return><return>0.3125</return><return>0.375</return><return>0.4375</return><return>0.5</return><return>0.5625</return><return>0.625</return><return>0.6875</return><return>0.75</return><return>0.8125</return><return>0.875</return><return>0.9375</return>
  
  このランダムな浮動小数点の値は、 <return>1.625</return> から <return>2.75</return> まで (<return>2.75</return> を含まない) の右開きの区間に、 区間の
  大きさ(<return>0.875</return>) を掛け合わせ、 最小の <return>1.625</return> を足すことで拡大変換できます。 この、いわゆるアフィン変
  換の結果は、以下のような値になります:
   <return>1.625</return> は、<return>1.625</return> に丸められます<return>1.679</return> は、<return>1.625</return> に丸められます<return>1.734</return> は、<return>1.75</return> に丸められます<return>1.789</return>
  は、<return>1.75</return> に丸められます<return>1.843</return> は、<return>1.875</return> に丸められます<return>1.898</return> は、<return>1.875</return> に丸められます<return>1.953</return> は、<return>2.0</return>
  に丸められます<return>2.007</return> は、<return>2.0</return> に丸められます<return>2.062</return> は、<return>2.0</return> に丸められます<return>2.117</return> は、<return>2.0</return> に丸められます
  <return>2.171</return> は、<return>2.25</return> に丸められます<return>2.226</return> は、<return>2.25</return> に丸められます<return>2.281</return> は、<return>2.25</return> に丸められます<return>2.335</return> は、
  <return>2.25</return> に丸められます<return>2.390</return> は、<return>2.5</return> に丸められます<return>2.445</return> は、<return>2.5</return> に丸められます
   上界の値 <return>2.5</return> が、 開区間であるため除外されるべきなのに、返されてしまう点に注意してください。
   また、<return>2.0</return> と <return>2.25</return> が、 他の値に比べて2倍の確率で返されることにも注意しましょう。

<comment>Param:</comment>
  <info>float</info>                    <strong>$min</strong>       区間の下限
  <info>float</info>                    <strong>$max</strong>       区間の上限
  <info>Random\IntervalBoundary</info>  <strong>$boundary</strong>  区間の境界を戻り値に含めるかどうかを指定します。

<comment>Return:</comment>
  <info>float</info>  <strong>$min</strong>, <strong>$max</strong>, <strong>$boundary</strong> で指定した区間に一様に分散した float の中から、等確率に選んだ値を返し
         ます。 <strong>$min</strong> と <strong>$max</strong> が戻り値に含まれるかどうかは、 <strong>$boundary</strong> の値次第です。

<comment>See Also:</comment>
   * Random\Randomizer::nextFloat
   * Random\Randomizer::getInt


