'>
これらの大半は、対応する ASN.1 の型を使います。's', 'x', 'd' および 'b' はどれも OCTET STRING
を異なる方法で表したものであり、'u' も Gauge32 値を扱うためのものです。
'>
MIB ファイルが "snmp_read_mib" や libsnmp の設定で MIB ツリーに読み込まれている場合は、
type に '=' を使うことができます。
これはすべてのオブジェクト ID を表し、型は自動的に MIB から読み込みます。
'>
"SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}"
のような BITS 型の値変数を設定する方法は二通りあることに注意しましょう。
型として "b" を使い、ビット番号の一覧を指定する。この方法はおすすめしません。
同じ OID に対して GET クエリを実行しても 0xF8 などを返すからです。
Using type "x" and a hex number but without(!) the usual "0x" prefix.
型として "x" を使い、通常のプレフィックス "0x" をつけずに(!) 16 進数を指定する。
詳細は、サンプルを参照ください。
'>
&reftitle.errors;
このメソッドは、デフォルトでは一切例外をスローしません。ライブラリでエラーが発生したときに
SNMPException をスローさせるには SNMP クラスパラメータ
exceptions_enabled に値を設定しなければなりません。
詳細は
SNMP::$exceptions_enabled の説明を参照ください。
'>
callback 関数が、リクエスト終了時にコールされます。
この関数のプロトタイプは、
に一致しなければなりません。
dataは、リクエストに渡すカスタムデータです。resultにはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが返すそのままの値となります。reqはオプションで指定するリクエストリソースです。
eio_get_last_error のような関数で使えます。
'>
リクエストの優先順位。EIO_PRI_DEFAULT、EIO_PRI_MIN、EIO_PRI_MAX あるいは &null; を指定します。
&null; を渡した場合、pri は内部的に
EIO_PRI_DEFAULT となります。
'>
相対パスを避けましょう
'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_MA_TYPE_* series of constants should be used.'>
TRADER_REAL_MIN to TRADER_REAL_MAX.'>
TRADER_REAL_MIN to TRADER_REAL_MAX.'>
PECL mongodb 1.15.0
Return types for methods are declared as tentative on PHP 8.0 and newer,
triggering deprecation notices in code that implements this interface
without declaring the appropriate return types. The #[ReturnTypeWillChange]
attribute can be added to silence the deprecation notice.
'>
collationarrayobject
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
'>
letarrayobject
Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var).
This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version.
'>
keyVaultClientMongoDB\Driver\ManagerThe Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used.
'>
keyVaultNamespacestringA fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption.
'>
kmsProvidersarray
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified.
If an empty document is specified for "aws",
"azure", or "gcp", the driver
will attempt to configure the provider using
Automatic Credentials.
The format for "aws" is as follows:
,
secretAccessKey: ,
sessionToken:
}
]]>
The format for "azure" is as follows:
,
clientId: ,
clientSecret: ,
identityPlatformEndpoint: // Defaults to "login.microsoftonline.com"
}
]]>
The format for "gcp" is as follows:
,
privateKey: |,
endpoint: // Defaults to "oauth2.googleapis.com"
}
]]>
The format for "kmip" is as follows:
}
]]>
The format for "local" is as follows:
|
}
]]>
'>
<literal>"aws"</literal> provider optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The Amazon Resource Name (ARN) to the AWS customer master key (CMK).endpointstringOptional. An alternate host identifier to send KMS requests to. May include port number.
<literal>"azure"</literal> provider optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with optional port (e.g. "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional. A specific version of the named key. Defaults to using the key's primary version.
<literal>"gcp"</literal> provider optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional. A specific version of the named key. Defaults to using the key's primary version.endpointstringOptional. Host with optional port. Defaults to "cloudkms.googleapis.com".
<literal>"kmip"</literal> provider optionsOptionTypeDescriptionkeyIdstringOptional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object.endpointstringOptional. Host with optional port.
'>
tlsOptionsarray
A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options:
: {
tlsCaFile: ,
tlsCertificateKeyFile: ,
tlsCertificateKeyFilePassword: ,
tlsDisableOCSPEndpointCheck:
}
]]>
'>
maxCommitTimeMSinteger
The maximum amount of time in milliseconds to allow a single
commitTransaction command to run.
If specified, maxCommitTimeMS must be a signed
32-bit integer greater than or equal to zero.
'>
readConcernMongoDB\Driver\ReadConcern
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.
'>
readPreferenceMongoDB\Driver\ReadPreference
A read preference to use for selecting a server for the operation.
'>
sessionMongoDB\Driver\Session
A session to associate with the operation.
'>
If you are using a "session" which has a transaction
in progress, you cannot specify a "readConcern" or
"writeConcern" option. This will result in an
MongoDB\Driver\Exception\InvalidArgumentException
being thrown. Instead, you should set these two options when you create
the transaction with
MongoDB\Driver\Session::startTransaction.
'>
writeConcernMongoDB\Driver\WriteConcern
A write concern to apply to the operation.
'>
namespace (string)
A fully qualified namespace (e.g. "databaseName.collectionName").
'>
db (string)
The name of the database on which to execute the command.
'>
bulk (MongoDB\Driver\BulkWrite)
The write(s) to execute.
'>
command (MongoDB\Driver\Command)
The command to execute.
'>
options
Encryption optionsOptionTypeDescriptionalgorithmstring
The encryption algorithm to be used. This option is required.
Specify one of the following
ClientEncryption constants:
MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTICMongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOMMongoDB\Driver\ClientEncryption::ALGORITHM_INDEXEDMongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXEDMongoDB\Driver\ClientEncryption::ALGORITHM_RANGEcontentionFactorint
The contention factor for evaluating queries with indexed, encrypted
payloads.
This option only applies and may only be specified when
algorithm is
MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
or
MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
keyAltNamestring
Identifies a key vault collection document by
keyAltName. This option is mutually exclusive
with keyId and exactly one is required.
keyIdMongoDB\BSON\Binary
Identifies a data key by _id. The value is a UUID
(binary subtype 4). This option is mutually exclusive with
keyAltName and exactly one is required.
queryTypestring
The query type for evaluating queries with indexed, encrypted
payloads. Specify one of the following
ClientEncryption constants:
MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITYMongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE_PREVIEWThis option only applies and may only be specified when
algorithm is
MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED
or MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE.
rangeOptsarray
Index options for a queryable encryption field supporting "range"
queries. The options below must match the values set in the
encryptedFields of the target collection. For
double and decimal128 BSON field types, min,
max, and precision must all be
set, or all be unset.
Range index optionsOptionTypeDescriptionminmixed
Required if precision is set. The minimum
BSON value of the range.
maxmixed
Required if precision is set. The maximum
BSON value of the range.
sparsityintOptional. Positive 64-bit integer.precisionint
Optional. Positive 32-bit integer specifying precision to use
for explicit encryption. May only be set for double or
decimal128 BSON field types.
trimFactorintOptional. Positive 32-bit integer.
'>
query (MongoDB\Driver\Query)
The query to execute.
'>
typeMap (array)
Type map configuration.
'>
filter (arrayobject)
The query predicate.
An empty predicate will match all documents in the collection.
When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).
'>
Returns MongoDB\Driver\Cursor on success.'>
Returns MongoDB\Driver\WriteResult on success.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used with an associated transaction in combination with a "readConcern" or "writeConcern" option.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used in combination with an unacknowledged write concern.'>
Throws MongoDB\Driver\Exception\BulkWriteException on any write failure (e.g. write error, failure to apply a write concern)'>
Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.'>
Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.'>
Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).'>
Throws MongoDB\Driver\Exception\UnexpectedValueException if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected libbson error.'>
Queryable Encryption is in public preview and available for evaluation
purposes. It is not yet recommended for production deployments as breaking
changes may be introduced. See the Queryable Encryption Preview blog post for more information.
'>
MongoDB\BSON\Decimal128 is only compatible with
MongoDB 3.4+. Attempting to use the BSON type with an earlier version of
MongoDB will result in an error.
'>
The output is consistent with the MongoDB\BSON\toJSON
function, which uses the driver-specific legacy extended JSON format. This
does not necessarily match the
relaxed
or canonical
extended JSON representations used by
MongoDB\BSON\toRelaxedExtendedJSON and
MongoDB\BSON\toCanonicalExtendedJSON, respectively.
'>
On Unix platforms, the extension is sensitive to scripts that use the
fork() system call without also calling exec(). Users are advised not to
re-use MongoDB\Driver\Manager instances in a forked
child process.
'>
Because PHP's integer type is signed, some values returned by this
method may appear as negative integers on 32-bit platforms. The
"%u" formatter of sprintf may be
used to obtain a string representation of the unsigned decimal value.
'>
The "readPreference" option does not control the server
to which the driver issues the operation; it will always be executed on
this server object. Instead, it may be used when issuing the operation to a
secondary (from a replica set connection, not standalone) or mongos node to
ensure that the driver sets the wire protocol accordingly or adds the read
preference to the operation, respectively.
'>
It is the caller's responsibility to ensure that the server is capable
of executing the write operation. For example, executing a write operation
on a secondary (excluding its "local" database) will fail.
'>
BSON documents can technically contain duplicate keys because documents are
stored as a list of key-value pairs; however, applications should refrain
from generating documents with duplicate keys as server and driver behavior
may be undefined. Since PHP objects and arrays cannot have duplicate keys,
data could also be lost when decoding a BSON document with duplicate keys.
'>
A request must be created via radius_create_request before this function can be called.'>
typeThe attribute type.'>
radius_handleThe RADIUS resource.'>
optionsA bitmask of the attribute options. The available options include RADIUS_OPTION_TAGGED and RADIUS_OPTION_SALT.'>
tagThe attribute tag. This parameter is ignored unless the RADIUS_OPTION_TAGGED option is set.'>
vendorThe vendor ID.'>
PECL mongodb 1.15.0
Return types for methods are declared as tentative on PHP 8.0 and newer,
triggering deprecation notices in code that implements this interface
without declaring the appropriate return types. The #[ReturnTypeWillChange]
attribute can be added to silence the deprecation notice.
'>
collationarrayobject
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. When specifying collation, the "locale" field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.
If the collation is unspecified but the collection has a default collation, the operation uses the collation specified for the collection. If no collation is specified for the collection or for the operation, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
This option is available in MongoDB 3.4+ and will result in an exception at execution time if specified for an older server version.
'>
letarrayobject
Map of parameter names and values. Values must be constant or closed expressions that do not reference document fields. Parameters can then be accessed as variables in an aggregate expression context (e.g. $$var).
This option is available in MongoDB 5.0+ and will result in an exception at execution time if specified for an older server version.
'>
keyVaultClientMongoDB\Driver\ManagerThe Manager used to route data key queries to a separate MongoDB cluster. By default, the current Manager and cluster is used.
'>
keyVaultNamespacestringA fully qualified namespace (e.g. "databaseName.collectionName") denoting the collection that contains all data keys used for encryption and decryption. This option is required.
'>
kmsProvidersarray
A document containing the configuration for one or more KMS providers, which are used to encrypt data keys. Supported providers include "aws", "azure", "gcp", "kmip", and "local" and at least one must be specified.
The format for "aws" is as follows:
,
secretAccessKey: ,
sessionToken:
}
]]>
The format for "azure" is as follows:
,
clientId: ,
clientSecret: ,
identityPlatformEndpoint: // Defaults to "login.microsoftonline.com"
}
]]>
The format for "gcp" is as follows:
,
privateKey: |,
endpoint: // Defaults to "oauth2.googleapis.com"
}
]]>
The format for "kmip" is as follows:
}
]]>
The format for "local" is as follows:
|
}
]]>
'>
<literal>"aws"</literal> provider optionsOptionTypeDescriptionregionstringRequired.keystringRequired. The Amazon Resource Name (ARN) to the AWS customer master key (CMK).endpointstringOptional. An alternate host identifier to send KMS requests to. May include port number.
<literal>"azure"</literal> provider optionsOptionTypeDescriptionkeyVaultEndpointstringRequired. Host with optional port (e.g. "example.vault.azure.net").keyNamestringRequired.keyVersionstringOptional. A specific version of the named key. Defaults to using the key's primary version.
<literal>"gcp"</literal> provider optionsOptionTypeDescriptionprojectIdstringRequired.locationstringRequired.keyRingstringRequired.keyNamestringRequired.keyVersionstringOptional. A specific version of the named key. Defaults to using the key's primary version.endpointstringOptional. Host with optional port. Defaults to "cloudkms.googleapis.com".
<literal>"kmip"</literal> provider optionsOptionTypeDescriptionkeyIdstringOptional. Unique identifier to a 96-byte KMIP secret data managed object. If unspecified, the driver creates a random 96-byte KMIP secret data managed object.endpointstringOptional. Host with optional port.
'>
tlsOptionsarray
A document containing the TLS configuration for one or more KMS providers. Supported providers include "aws", "azure", "gcp", and "kmip". All providers support the following options:
: {
tlsCaFile: ,
tlsCertificateKeyFile: ,
tlsCertificateKeyFilePassword: ,
tlsDisableOCSPEndpointCheck:
}
]]>
'>
maxCommitTimeMSinteger
The maximum amount of time in milliseconds to allow a single
commitTransaction command to run.
If specified, maxCommitTimeMS must be a signed
32-bit integer greater than or equal to zero.
'>
readConcernMongoDB\Driver\ReadConcern
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.
'>
readPreferenceMongoDB\Driver\ReadPreference
A read preference to use for selecting a server for the operation.
'>
sessionMongoDB\Driver\Session
A session to associate with the operation.
'>
If you are using a "session" which has a transaction
in progress, you cannot specify a "readConcern" or
"writeConcern" option. This will result in an
MongoDB\Driver\Exception\InvalidArgumentException
being thrown. Instead, you should set these two options when you create
the transaction with
MongoDB\Driver\Session::startTransaction.
'>
writeConcernMongoDB\Driver\WriteConcern
A write concern to apply to the operation.
'>
namespace (string)
A fully qualified namespace (e.g. "databaseName.collectionName").
'>
db (string)
The name of the database on which to execute the command.
'>
bulk (MongoDB\Driver\BulkWrite)
The write(s) to execute.
'>
command (MongoDB\Driver\Command)
The command to execute.
'>
query (MongoDB\Driver\Query)
The query to execute.
'>
typeMap (array)
Type map configuration.
'>
filter (arrayobject)
The query predicate.
An empty predicate will match all documents in the collection.
When evaluating query criteria, MongoDB compares types and values according to its own comparison rules for BSON types, which differs from PHP's comparison and type juggling rules. When matching a special BSON type the query criteria should use the respective BSON class (e.g. use MongoDB\BSON\ObjectId to match an ObjectId).
'>
Returns MongoDB\Driver\Cursor on success.'>
Returns MongoDB\Driver\WriteResult on success.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used with an associated transaction in combination with a "readConcern" or "writeConcern" option.'>
Throws MongoDB\Driver\Exception\InvalidArgumentException if the "session" option is used in combination with an unacknowledged write concern.'>
Throws MongoDB\Driver\Exception\BulkWriteException on any write failure (e.g. write error, failure to apply a write concern)'>
Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.'>
Throws MongoDB\Driver\Exception\AuthenticationException if authentication is needed and fails.'>
Throws MongoDB\Driver\Exception\ConnectionException if connection to the server fails (for reasons other than authentication).'>
Throws MongoDB\Driver\Exception\UnexpectedValueException if the input did not contain exactly one BSON document. Possible reasons include, but are not limited to, invalid BSON, extra data (after reading one BSON document), or an unexpected libbson error.'>
MongoDB\BSON\Decimal128 is only compatible with
MongoDB 3.4+. Attempting to use the BSON type with an earlier version of
MongoDB will result in an error.
'>
The output is consistent with the MongoDB\BSON\toJSON
function, which uses the driver-specific legacy extended JSON format. This
does not necessarily match the
relaxed
or canonical
extended JSON representations used by
MongoDB\BSON\toRelaxedExtendedJSON and
MongoDB\BSON\toCanonicalExtendedJSON, respectively.
'>
On Unix platforms, the MongoDB driver is sensitive to scripts that use the
fork() system call without also calling exec(). Users are advised not to
re-use MongoDB\Driver\Manager instances in a forked
child process.
'>
Because PHP's integer type is signed, some values returned by this
method may appear as negative integers on 32-bit platforms. The
"%u" formatter of sprintf may be
used to obtain a string representation of the unsigned decimal value.
'>
The "readPreference" option does not control the server
to which the driver issues the operation; it will always be executed on
this server object. Instead, it may be used when issuing the operation to a
secondary (from a replica set connection, not standalone) or mongos node to
ensure that the driver sets the wire protocol accordingly or adds the read
preference to the operation, respectively.
'>
It is the caller's responsibility to ensure that the server is capable
of executing the write operation. For example, executing a write operation
on a secondary (excluding its "local" database) will fail.
'>
BSON documents can technically contain duplicate keys because documents are
stored as a list of key-value pairs; however, applications should refrain
from generating documents with duplicate keys as server and driver behavior
may be undefined. Since PHP objects and arrays cannot have duplicate keys,
data could also be lost when decoding a BSON document with duplicate keys.
'>
リクエストを radius_create_request で作ってからでないと、この関数は呼べません。'>
type属性の型。'>
radius_handleRADIUS リソース。'>
options属性のオプションのビットマスク。使えるオプションには、RADIUS_OPTION_TAGGED や RADIUS_OPTION_SALT があります。'>
tag属性のタグ。RADIUS_OPTION_TAGGED が設定されていない限り、このパラメータは無視されます。'>
vendorベンダー ID。'>
file_descriptor
ファイル記述子。ファイルリソースか、あるいは int で指定します。
int を指定した場合は、システムコールにそのまま渡せるファイル記述子だとみなします。
'>
各リソースには、それぞれソフトリミットとハードリミットがあります。
ソフトリミットとは、そのリソースに対してカーネルが課す制限値のことです。
ハードリミットとは、ソフトリミットの上限値のことです。
特権を持たないプロセスは、ソフトリミットの値を 0 からハードリミット値の間で設定することが可能です。
また、ハードリミットの値を下げることもできます。
'>
characters パラメータにより、
削除する文字を指定することも可能です。
削除したい全ての文字をリストにしてください。
'>
" ": ASCII の SP 文字
0x20 、通常のスペース。
"\t": ASCII の HT 文字
0x09 、タブ。
"\n": ASCII の LF 文字
0x0A 、改行（ラインフィード）。
"\r": ASCII の CR 文字
0x0D 、キャリッジリターン。
"\0": ASCII の NUL 文字
0x00 、NULバイト。
"\v": ASCII VT 文字
0x0B 、垂直タブ。
'>
" " (Unicode U+0020)、通常のスペース。
"\t" (Unicode U+0009)、タブ。
"\n" (Unicode U+000A)、改行（ラインフィード）。
"\r" (Unicode U+000D)、キャリッジリターン。
"\0" (Unicode U+0000)、NULバイト。
"\v" (Unicode U+000B)、垂直タブ。
"\f" (Unicode U+000C)、フォームフィード。
"\u00A0" (Unicode U+00A0)、ノーブレークスペース。もしくは、非分割スペース。
"\u1680" (Unicode U+1680)、オガム文字（古代アイルランド語）用のスペース。
"\u2000" (Unicode U+2000)、エンクアッド。アルファベット1文字分の幅を持つスペース。
"\u2001" (Unicode U+2001)、エムクアッド。エンクアッドの2倍の幅を持つスペース。
"\u2002" (Unicode U+2002)、エンスペース。エンクアッドと同じ幅のスペース。
"\u2003" (Unicode U+2003)、エムスペース。エムクアッドと同じ幅のスペース。
"\u2004" (Unicode U+2004)、エムスペースの3分の1の幅を持つスペース。
"\u2005" (Unicode U+2005)、エムスペースの4分の1の幅を持つスペース。
"\u2006" (Unicode U+2006)、エムスペースの6分の1の幅を持つスペース。
"\u2007" (Unicode U+2007)、数字や図の間隔を整えるために使われるスペース。
"\u2008" (Unicode U+2008)、句読点のためにデザインされたスペース。
"\u2009" (Unicode U+2009)、シンスペース。非常に狭いスペース。
"\u200A" (Unicode U+200A)、ヘアスペース。シンスペースよりもさらに細いスペース。
"\u2028" (Unicode U+2028)、ラインセパレーター。行の区切りとして使用。
"\u2029" (Unicode U+2029)、パラグラフセパレーター。段落の区切りとして使用。
"\u202F" (Unicode U+202F)、ナローノーブレークスペース。通常の非分割スペースよりも狭く、ラテン文字や句読点の間で使用。
"\u205F" (Unicode U+205F)、数式などで使われるスペース。
"\u3000" (Unicode U+3000)、全角文字用のスペース。
"\u0085" (Unicode U+0085)、次行（NEL）。
"\u180E" (Unicode U+180E)、モンゴル語のテキスト内で母音を区切るために使用されるスペース。
'>
必要に応じて、削除する文字を characters パラメータで指定することもできます。
削除が必要なすべての文字を単純にリストとして記述してください。
.. を使用することで、連続する文字の範囲を指定することも可能です。
'>
オプションの引数。文字を変換するときに使うエンコーディングを定義します。
省略した場合の encoding のデフォルト値は、
default_charset の値を使います。
技術的にはこの引数を省略可能ですが、
default_charset
の指定が入力とは違う文字セットになっている可能性もあるので、
適切な値を指定しておくことを強く推奨します。
'>
format
0個以上のディレクティブで構成されるフォーマット文字列:
変換結果に直接コピーされる通常文字列 (% は除きます)
と、変換仕様。
これらのいずれも、自分が持つパラメータを取得します。
変換の仕様は、以下のプロトタイプに従います:
%[argnum$][flags][width][.precision]specifier.
Argnum
何番目の引数を変換の対象にするかを指定するために、
数値の後にドル記号 $ を続けます。
Width
(最小で)何文字がこの変換結果に含まれるかを数値で指定するか、
* を指定します。
* を指定した場合、
指定子によってフォーマットされる値の前に、
幅を追加の数値として指定します。
Precision
ピリオド . の後に数値を続けるか、
* を続けますが、
その意味は指定子に依存します:
e, E,
f と F
指定子の場合:
小数点の後に表示する桁数 (デフォルトでは、この値は6です)
g, G,
h, H 指定子の場合:
表示する最大の有効桁数
s 指定子の場合:
文字列を切り捨てる時点、つまり、文字列の最大の長さを設定します。
明示的に精度を指定せず、ピリオドを指定した場合、精度は0として扱われます。
* を使った場合、
精度は指定子によってフォーマットされる値の前に、
追加の数値として指定します。
指定子の一覧指定子&Description;%
文字通り、パーセント文字です。
引数は不要です。
b
引数は整数として扱われ、2進数値として表現されます。
c
引数は整数として扱われ、ASCII文字として表現されます。
d
引数は整数として扱われ、(符号付き)10進数値として表現されます。
e
引数は科学的記法で表現された値(e.g. 1.2e+2)として扱われます。
Ee 指定子に似ていますが、
大文字を使います(e.g. 1.2E+2)
f
引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮します)。
F
引数は小数として扱われ、浮動小数点数値として表現されます(ロケールを考慮しません)。
g
汎用フォーマット
P を精度を表す、ゼロでない値とします。
精度が省略された場合、Pの値は6です。
精度に0を指定した場合、Pの値は1になります。
この場合、 E 指定子の変換結果は、
X乗になります。
P > X ≥ −4 の場合、E
指定子の変換結果となり、精度は、P − (X + 1) になります。
そうでない場合、e 指定子の変換結果となり、
精度は、P - 1 になります。
Gg 指定子に似ていますが、
E と f を使います。
hg 指定子に似ていますが、
F を使います。
PHP 8.0.0 以降で利用可能です。
Hg 指定子に似ていますが、
E と F を使います。
PHP 8.0.0 以降で利用可能です。
o
引数は整数として扱われ、8進数値として表現されます。
s
引数は文字列として扱われ、文字列として表現されます。
u
引数は整数として扱われ、符号なし10進数値として表現されます。
x
引数は整数として扱われ、16進数値(小文字)として表現されます。
X
引数は整数として扱われ、16進数値(大文字)として表現されます。
c 指定子はパディングと幅を無視します
文字列と width
指定子を、1文字の表現に1バイト以上必要な文字セットと一緒に使おうとすると、
期待しない結果になるかもしれません。
値は、指定子の型に合うように強制されます:
型のハンドリング型指定子stringsintd,
u,
c,
o,
x,
X,
bfloate,
E,
f,
F,
g,
G,
h,
H