Procedural File: function.inc
Source Location: /package/core/function.inc
Page Details:
Ag:PUREコアライブラリが標準で定義する関数を格納したモジュールです。
convert_encoding_filesystem_to_internal [line 45]
string convert_encoding_filesystem_to_internal(
string $source)
|
|
ファイルシステムの文字エンコーディングを内部文字エンコーディングの文字列に変換して返します。 ファイルシステムのエンコーディングはPURE_ENCODING_FILESYSTEM定数に従います。 内部エンコーディングはPURE_ENCODING_INTERNAL定数に従います。 更にPURE_ENCODING_FILESYSTEM定数、PURE_ENCODING_INTERNAL定数はpure.confの設定に従います。
Tags:
Parameters
| string |
$source |
エンコーディングを変換したい文字列 |
convert_encoding_internal_to_filesystem [line 26]
string convert_encoding_internal_to_filesystem(
string $source)
|
|
内部文字エンコーディングの文字列をファイルシステムの文字エンコーディングに変換して返します。 ファイルシステムのエンコーディングはPURE_ENCODING_FILESYSTEM定数に従います。 内部エンコーディングはPURE_ENCODING_INTERNAL定数に従います。 更にPURE_ENCODING_FILESYSTEM定数、PURE_ENCODING_INTERNAL定数はpure.confの設定に従います。
Tags:
Parameters
| string |
$source |
エンコーディングを変換したい文字列 |
erase_file [line 201]
bool erase_file(
string $path)
|
|
ファイルまたはディレクトリを削除します。 削除対象がディレクトリの場合、ディレクトリが保有するファイル、ディレクトリを再帰的に検索、削除してディレクトリ自体を削除しようと試みます。 関数は削除が成功したか否かを返します。 指定のファイルまたはディレクトリが見付からなかった場合にもfalseが返されることに注意してください。
Tags:
Parameters
| string |
$path |
削除するファイルまたはディレクトリ |
force_mkdir [line 245]
作成に成功したか否か force_mkdir(
string $dir)
|
|
新規のディレクトリを作成します。 必要に応じて親ディレクトリも作成されます。 force_mkdir関数は$dirで指定されたとおりに新規ディレクトリを作成します。 パスで指定されたディレクトリが存在しない場合、force_mkdir関数はそれらのディレクトリを作成します。 force_mkdir関数はすべてのディレクトリが作成された場合にtrueを返し、エラーが発生した場合はfalseを返します。
Parameters
getArgCount [line 61]
コマンドラインから渡されたパラメータの個数を取得します。 通常、PHP標準の$argc変数はパラメータの個数に自分自身のパスを加えた個数を返しますが、getArgCount関数は純粋に与えられたパラメータの個数のみを返します。
Tags:
getArgValue [line 75]
string getArgValue(
int $index)
|
|
コマンドラインから渡されたパラメータを取得します。 PHP標準の$args変数と異なり、インデックス0が先頭のパラメータであることに注意してください。 パラメータが見付からなかった場合、インデックスが不正の場合はfalseを返します。
Tags:
Parameters
isBool [line 98]
bool isBool(
mixed $value)
|
|
値が論理型か、論理型の値として類推可能な文字列かを判定して返します。 論理型の場合にはtrueを返します。 文字列型の場合、真を表す"true"、"yes"、"on"、"1"、偽を表す"false"、"no"、"off"、"0"の場合にtrueを返します。 それ以外の場合にはfalseを返します。 isBool関数がtrueを返す場合、その真偽値はtoBool関数で取得可能です。
Tags:
Parameters
loadConf [line 168]
array loadConf(
string $confFile)
|
|
環境設定ファイルを読み込み、そのキーと値のペアを配列で返します。 環境設定ファイルは "キー = 値" の形式の行が列挙されたテキストファイルです。 行頭が"#"の行は明示的にコメントとして無視されます。 文中に"="が存在しない行は無視されます。 "="の前が空白の行は無視されます。 キー名は全て小文字に自動的に変換されることに注意してください。 指定のファイルが見付からない場合には空の配列を返します。 従ってloadConf関数単体では環境設定ファイルが存在しないことを確認できません。
Tags:
Parameters
| string |
$confFile |
環境設定ファイル名 |
split_first_token [line 281]
array split_first_token(
string $separator, string $str)
|
|
文字列を指定の区切文字列で分割し、その最初の部分とその後方の文字列に分割して返します。 返却値は配列で返されます。 配列の第一要素は最初の部分、第二要素は最初の部分の後方文字列になります。 文字列中に区切文字列が見つからなかった場合には、文字列全体が最初の部分であると解釈されます。 区切文字列が空の文字列の場合には、文字列全体が最初の部分であると解釈されます。 第三要素は区切文字列が見つかったか否かを論理値で返します。 これは第一要素や第二要素が空の文字列であることから区切文字列の存在の有無を判定するよりも直接的で正確です。 なお、区切文字列に空の文字列を指定した場合には常にfalseを返すことに注意してください。 例えばこれは、カンマ区切文字列で実装されるキュー情報から先頭の値を取得するのに適します。
Tags:
Parameters
| string |
$separator |
区切文字列 |
| string |
$str |
解析する文字列 |
split_last_token [line 323]
array split_last_token(
string $separator, string $str)
|
|
文字列を指定の区切文字列で分割し、その最後の部分とその前方の文字列に分割して返します。 返却値は配列で返されます。 配列の第一要素は最後の部分の前方の文字列、第二要素は最後の部分になります。 文字列中に区切文字列が見つからなかった場合には、文字列全体が最後の部分であると解釈されます。 区切文字列が空の文字列の場合には、文字列全体が最後の部分であると解釈されます。 第三要素は区切文字列が見つかったか否かを論理値で返します。 これは第一要素や第二要素が空の文字列であることから区切文字列の存在の有無を判定するよりも直接的で正確です。 なお、区切文字列に空の文字列を指定した場合には常にfalseを返すことに注意してください。 例えばこれは、カンマ区切文字列で実装されるスタック情報から末尾の値を取得するのに適します。
Tags:
Parameters
| string |
$separator |
区切文字列 |
| string |
$str |
解析する文字列 |
toBool [line 130]
bool toBool(
mixed $value, [bool $def = false])
|
|
値が論理型か、論理型の値として類推可能な文字列の場合にその真偽値を返します。 toBool関数は値が論理型か、論理型の値として類推可能な文字列の場合（isBool関数がtrueを返す値の場合）にその真偽値を返します。 真偽値として判定できない場合には$def引数の値を返します。
Tags:
Parameters
| mixed |
$value |
真偽値を取得したい値 |
| bool |
$def |
真偽値が取得できなかった場合の標準値 |
| 