Class Strings

文字列処理に関するユーティリティクラスです

Namespace: Peach\Util
Located at Peach/Util/Strings.php

Methods summary
`public static array`	# `explode( string $separator, string $value )` 内部関数の explode() のカスタム版です. 基本的にはオリジナルの explode() と同じですが, 以下の点が異なります. 内部関数の explode() のカスタム版です. 基本的にはオリジナルの explode() と同じですが, 以下の点が異なります. $separator が空文字列の場合に空の配列を返す (オリジナルは FALSE を返す) $value が文字列以外の場合, Values::stringValue の結果を使用する引数をどのように指定しても, 返り値が必ず配列型になることが特徴です. Parameters `$separator` セパレータ `$value` 対象文字列 Returns array セパレータが見つからないときは長さ 1 の配列, 対象が空文字列の場合は空の配列, それ以外は explode() と同じ.
`public static array`	# `getLines( string $str )` 指定された文字列を行単位で分割します. 引数の文字列を CR, LF, CRLF で分割し, 結果の配列を返します. 結果の配列の各要素に改行コードは含まれません. 指定された文字列を行単位で分割します. 引数の文字列を CR, LF, CRLF で分割し, 結果の配列を返します. 結果の配列の各要素に改行コードは含まれません. Parameters `$str` 分割対象の文字列 Returns array 行単位で分割された文字列の配列
`public static boolean`	# `isWhitespace( string $str )` 指定された文字列が空白文字の集合からなる文字列かどうかを返します. 指定された文字列が空白文字の集合からなる文字列かどうかを返します. Parameters `$str` 検査対象の文字列 Returns boolean 引数が NULL, 空文字列, "\r", "\n", "\t", 半角スペースから成る文字列の場合に TRUE, それ以外は FALSE
`public static string`	# `basedir( string $basedir )` 指定された文字列を基底ディレクトリに変換します. 引数が空文字列か, '/' で終わる文字列の場合は引数をそのまま返します. それ以外の場合は, 引数の末尾に '/' を連結した文字列を返します. 指定された文字列を基底ディレクトリに変換します. 引数が空文字列か, '/' で終わる文字列の場合は引数をそのまま返します. それ以外の場合は, 引数の末尾に '/' を連結した文字列を返します. Parameters `$basedir` 変換対象の文字列 Returns string 基底ディレクトリ名
`public static integer`	# `getRawIndex( string $text, string $chr )` 指定された文字列の中で、"\" によるエスケープ処理のされていない文字列があらわれる最初のインデックスを返します. 偶数個の "\" が続いた後に対象の文字列が出現した場合に、そのインデックスを返り値とします. 奇数個の "\" の後の文字については, その直前の "\" によってエスケープされているとみなしてスルーします. 以下に例を示します. 指定された文字列の中で、"\" によるエスケープ処理のされていない文字列があらわれる最初のインデックスを返します. 偶数個の "\" が続いた後に対象の文字列が出現した場合に、そのインデックスを返り値とします. 奇数個の "\" の後の文字については, その直前の "\" によってエスケープされているとみなしてスルーします. 以下に例を示します. getRawIndex("AB=CD=EF", "=") => 2 getRawIndex("AB\\=CD=EF", "=") => 6 getRawIndex("AB\\\\=CD=EF", "=") => 4 インデックスが存在しない場合は FALSE を返します. Parameters `$text` 検索文字列 `$chr` 検索対象の文字 Returns integer インデックス. ただし存在しない場合は FALSE
`public static boolean`	# `startsWith( string $text, string $prefix )` ある文字列が指定された文字列で始まっているかどうかを判別します. $prefix が空文字列の場合は TRUE を返します. 引数が文字列以外の場合は Values::stringValue が適用されます. ある文字列が指定された文字列で始まっているかどうかを判別します. $prefix が空文字列の場合は TRUE を返します. 引数が文字列以外の場合は Values::stringValue が適用されます. Parameters `$text` 検査対象の文字列 `$prefix` 開始する文字列 Returns boolean 引数 $text の先頭が $prefix である場合に TRUE
`public static boolean`	# `endsWith( string $text, string $suffix )` ある文字列が指定された文字列で終了しているかどうかを判別します. $suffix が空文字列の場合は TRUE を返します. 引数が文字列以外の場合は Values::stringValue が適用されます. ある文字列が指定された文字列で終了しているかどうかを判別します. $suffix が空文字列の場合は TRUE を返します. 引数が文字列以外の場合は Values::stringValue が適用されます. Parameters `$text` 検査対象の文字列 `$suffix` 終了する文字列 Returns boolean 引数 $text の末尾が $suffix に等しい場合に TRUE
`public static boolean`	# `endsWithRawChar( string $text, string $chr )` ある文字列が指定された文字で終了して, かつエスケープ処理されていないかを判別します. 以下に例を示します. ある文字列が指定された文字で終了して, かつエスケープ処理されていないかを判別します. 以下に例を示します. ("[ABC]", "]") => TRUE ("[ABC\]", "]") => FALSE ("\" がその後ろの "]" をエスケープしているとみなされる) ("[ABC\\]", "]") => TRUE ("\\" が一つの文字として扱われるため, 直後の "]" に影響しない) Parameters `$text` 検査対象の文字列 `$chr` 検査対象の文字 Returns boolean 引数 $text の末尾が, '\' でエスケープされていない $chr で終了している場合のみ TRUE
`public static string`	# `template( string $template, array $args = array() )` 文字列内に含まれる {0}, {1}, {2} などのテンプレート変数を, $args 内の各要素で置き換えます. 例えば template('My name is {0}. I am {1} years old', array('Taro', 18)); の結果は次のようになります. "My name is Taro. I am 18 years old" 文字列内に含まれる {0}, {1}, {2} などのテンプレート変数を, $args 内の各要素で置き換えます. 例えば template('My name is {0}. I am {1} years old', array('Taro', 18)); の結果は次のようになります. "My name is Taro. I am 18 years old" $template が NULL の場合は NULL を返します. Parameters `$template` テンプレート `$args` 置き換える内容の配列 Returns string テンプレートの適用結果