pure.util
[ class tree: pure.util ] [ index: pure.util ] [ all elements ]

Class: STR

Source Location: /package/pure/util/STR.inc

Class Overview

PURE_Class
   |
   --STR

文字列操作用のスタティックメソッド群を集約するクラスです。


Constants

Methods



Class Details

[line 21]
文字列操作用のスタティックメソッド群を集約するクラスです。



[ Top ]


Class Methods


static method adjustLines [line 77]

static string adjustLines( string $source)

文字列の行を整えます。

文字列の先頭・末尾に付加されている空白文字、改行は削除されます。 文字列が複数行からなる場合には、改行文字は "\n" に統一され、各行の先頭・末尾の空白文字が削除されます。




Tags:

return:  整えられた文字列
access:  public


Parameters:

string   $source   整えたい文字列

[ Top ]

static method adjust_newline [line 36]

static string adjust_newline( string $source)

改行コードを統一します。

Windows系OSのCR+LF、UNIX系OSのLF、MacOS 9以前のCRを検索し、全て"\n"に統一します。




Tags:

return:  整えられた文字列
access:  public


Parameters:

string   $source   整えたい文字列

[ Top ]

static method chop [line 392]

static void chop( string $haystack, string $needle)

文字列から特定の文字列を検索し、見つかった位置から後ろを切り捨てます。

chop関数は文字列$haystackから部分文字列$needleを検索し、最初に見つかった部分より後ろを削除して返します。 部分文字列$needleも削除されることに気をつけてください。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method end_with [line 563]

static bool end_with( string $haystack, string $suffix)

文字列の末尾が指定のサフィックス文字列であるか否かを判定して返します。



Tags:

return:  指定のサフィックス文字列で始まっているか否か
access:  public


Parameters:

string   $haystack   サフィックスを検索する文字列
string   $suffix   サフィックス文字列

[ Top ]

static method ichop [line 412]

static void ichop( string $haystack, string $needle)

文字列から特定の文字列を検索し、見つかった位置から後ろを切り捨てます。 大文字と小文字は同一視されます。

ichop関数は文字列$haystackから部分文字列$needleを検索し、最初に見つかった部分より後ろを削除して返します。 部分文字列$needleも削除されることに気をつけてください。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method iend_with [line 576]

static bool iend_with( string $haystack, string $suffix)

文字列の末尾が指定のサフィックス文字列であるか否かを判定して返します。 大文字と小文字は同一視されます。



Tags:

return:  指定のサフィックス文字列で始まっているか否か
access:  public


Parameters:

string   $haystack   サフィックスを検索する文字列
string   $suffix   サフィックス文字列

[ Top ]

static method insert_line_prefix [line 52]

static string insert_line_prefix( string $prefix, string $source, [bool $insert_first_line = true])

文字列を改行で区切られた行に分割し、各行頭に指定の文字列を追加して返します。



Tags:

return:  追加された後の文字列
access:  public


Parameters:

string   $prefix   追加したい文字列
string   $source   元になる文字列
bool   $insert_first_line   最初の行に付加するか否か

[ Top ]

static method istart_with [line 551]

static bool istart_with( string $haystack, string $prefix)

文字列の先頭が指定のプレフィックス文字列であるか否かを判定して返します。 大文字と小文字は同一視されます。



Tags:

return:  指定のプレフィックス文字列で始まっているか否か
access:  public


Parameters:

string   $haystack   プレフィックスを検索する文字列
string   $prefix   プレフィックス文字列

[ Top ]

static method itrunc [line 487]

static void itrunc( string $haystack, string $needle)

文字列の先頭が部分文字列の場合に切り捨てます。 大文字と小文字は同一視されます。

itrunc関数は文字列$haystackの先頭が部分文字列$needleに一致するか否かを確認し、一致していたらその部分を切り捨てた文字列を返します。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method ltrim_ja [line 181]

static string ltrim_ja( string $str)

日本語対応したltrim関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method ltrim_lines [line 256]

static string ltrim_lines( string $str)

文字列の前方の空白文字を削除して返します。

trim_lines関数は改行で区切られた複数行からなる文字列の場合には、各行の前方の空白文字を削除します。 また改行文字は"\n"に統一されます。




Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method ltrim_lines_ja [line 316]

static string ltrim_lines_ja( string $str)

日本語対応したltrim_lines関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method nvl [line 356]

static mixed nvl( mixed $value, [mixed $valueIsNull = " "])

$valueに与えた値がnull、ないし長さ0の文字列の場合に$valueIsNullを返します。 それ以外の場合には$valueに与えた値がそのまま返されます。



Tags:

return:  ないし $valueIsNull に与えた値
access:  public


Parameters:

mixed   $value   確認したい値
mixed   $valueIsNull   値がnull、ないし長さ0の文字列の場合に戻される値

[ Top ]

static method rchop [line 431]

static void rchop( string $haystack, string $needle)

文字列から特定の文字列を検索し、見つかった位置から後ろを切り捨てます。

rchop関数は文字列$haystackから部分文字列$needleを検索し、最後に見つかった部分より後ろを削除して返します。 部分文字列$needleも削除されることに気をつけてください。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method removeCtrlChars [line 151]

static string removeCtrlChars( string $str)

文字列中からコントロールコード、および不正な文字を除外します。



Tags:

return:  コントロールコード、不正な文字を取り除かれた文字列
access:  public


Parameters:

string   $str   コントロールコード、不正な文字を取り除きたい文字列

[ Top ]

static method richop [line 451]

static void richop( string $haystack, string $needle)

文字列から特定の文字列を検索し、見つかった位置から後ろを切り捨てます。 大文字と小文字は同一視されます。

richop関数は文字列$haystackから部分文字列$needleを検索し、最後に見つかった部分より後ろを削除して返します。 部分文字列$needleも削除されることに気をつけてください。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method ritrunc [line 522]

static void ritrunc( string $haystack, string $needle)

文字列の末尾が部分文字列の場合に切り捨てます。 大文字と小文字は同一視されます。

ritrunc関数は文字列$haystackの末尾が部分文字列$needleに一致するか否かを確認し、一致していたらその部分を切り捨てた文字列を返します。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method rtrim_ja [line 206]

static string rtrim_ja( string $str)

日本語対応したrtrim関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method rtrim_lines [line 278]

static string rtrim_lines( string $str)

文字列の末尾の空白文字を削除して返します。

trim_lines関数は改行で区切られた複数行からなる文字列の場合には、各行の末尾の空白文字を削除します。 また改行文字は"\n"に統一されます。




Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method rtrim_lines_ja [line 335]

static string rtrim_lines_ja( string $str)

日本語対応したrtrim_lines関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method rtrunc [line 504]

static void rtrunc( string $haystack, string $needle)

文字列の末尾が部分文字列の場合に切り捨てます。

rtrunc関数は文字列$haystackの末尾が部分文字列$needleに一致するか否かを確認し、一致していたらその部分を切り捨てた文字列を返します。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]

static method splitKeyword [line 374]

static array splitKeyword( string $str)

文字列をキーワードで分割し、配列に返します。

文字列は1つないし複数の空白文字、制御文字によって分割されます。 キーワードがひとつも存在しない場合には空の配列を返します。




Tags:

return:  分割されたキーワードを格納した配列
access:  public


Parameters:

string   $str   分割したい文字列

[ Top ]

static method start_with [line 538]

static bool start_with( string $haystack, string $prefix)

文字列の先頭が指定のプレフィックス文字列であるか否かを判定して返します。



Tags:

return:  指定のプレフィックス文字列で始まっているか否か
access:  public


Parameters:

string   $haystack   プレフィックスを検索する文字列
string   $prefix   プレフィックス文字列

[ Top ]

static method toCharArray [line 95]

static array toCharArray( string $source)

与えられた文字列を文字単位で分割して配列に格納して返します。

解析不可能な文字が存在した場合は除外されてしまうことに注意してください。




Tags:

return:  文字単位で分割された配列
access:  public


Parameters:

string   $source   分割したい文字列

[ Top ]

static method trim_ja [line 170]

static string trim_ja( string $str)

日本語対応したtrim関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method trim_lines [line 234]

static string trim_lines( string $str)

文字列の前方、末尾の空白文字を削除して返します。

trim_lines関数は改行で区切られた複数行からなる文字列の場合には、各行の前方、末尾の空白文字を削除します。 また改行文字は"\n"に統一されます。




Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method trim_lines_ja [line 297]

static string trim_lines_ja( string $str)

日本語対応したtrim_lines関数です。



Tags:

return:  空白を削除された文字列
access:  public


Parameters:

string   $str   空白を削除したい文字列

[ Top ]

static method trunc [line 469]

static void trunc( string $haystack, string $needle)

文字列の先頭が部分文字列の場合に切り捨てます。

trunc関数は文字列$haystackの先頭が部分文字列$needleに一致するか否かを確認し、一致していたらその部分を切り捨てた文字列を返します。




Tags:

access:  public


Parameters:

string   $haystack   入力文字列
string   $needle   部分文字列

[ Top ]


Class Constants

CR =  "\x0D"

[line 24]


[ Top ]

CRLF =  "\x0D\x0A"

[line 26]


[ Top ]

LF =  "\x0A"

[line 25]


[ Top ]

MB_SPACE =  ' '

[line 23]


[ Top ]



Documentation generated on Sun, 06 Jan 2008 01:33:28 +0900 by phpDocumentor 1.3.2