PeServer

Text
in package

Application

AbstractYes

文字列操作。

Constants

EMPTY = '': 空文字列。
TRIM_CHARACTERS = " \n\r\t\v\x00　": トリム対象文字一覧。
TRIM_PHP_CHARACTERS = " \t\n\r\x00\v": PHP の使ってる対象文字一覧
TRIM_TARGET_BOTH = 0
TRIM_TARGET_END = 1
TRIM_TARGET_START = -1

Methods

contains() : bool: 文字列を含んでいるか判定。
dump() : string: データ出力。
endsWith() : bool: 終端文字列一致判定。
format() : string: `sprintf` ラッパー。
formatNumber() : string: 数字を千の位毎にグループ化してフォーマット
fromCodePoint() : string: Unicode のコードポイントに対応する文字を返す。
getByteCount() : int: 文字列バイト数を取得。
getLastPosition() : int: 文字列位置を取得。
getLength() : int: 文字列長を取得。
getPosition() : int: 文字列位置を取得。
isNullOrEmpty() : bool: 文字列が `null` か空か
isNullOrWhiteSpace() : bool: 文字列がnullかホワイトスペースのみで構築されているか
join() : string: 文字列結合。
repeat() : string: 文字列を反復。
replace() : string: 文字列置き換え
replaceMap() : string: プレースホルダー文字列置き換え処理
requireNotNullOrEmpty() : string: 文字列が `null` か空の場合に代替文字列を返す。
requireNotNullOrWhiteSpace() : string: 文字列がnullかホワイトスペースのみで構築されている場合に代替文字列を返す。
split() : array<string|int, string>: 文字列分割。
splitLines() : array<string|int, string>: 文字列を改行で分割。
startsWith() : bool: 先頭文字列一致判定。
substring() : string: 文字列部分切り出し。
toCharacters() : array<string|int, string>: 文字列を文字の配列に変換。
toLower() : string: 大文字を小文字に変換。
toString() : string: 何かしらを文字列変換
toUpper() : string: 小文字を大文字に変換。
trim() : string: トリム処理。
trimEnd() : string: 終端トリム。
trimStart() : string: 先頭トリム。
createTrimPattern() : string: トリム用パターンの生成。
fromCodePointCore() : string

EMPTY

空文字列。


    public
        mixed
    EMPTY
    = ''

TRIM_CHARACTERS

トリム対象文字一覧。


    public
        mixed
    TRIM_CHARACTERS
    = " \n\r\t\v\x00　"

TRIM_PHP_CHARACTERS

PHP の使ってる対象文字一覧


    public
        mixed
    TRIM_PHP_CHARACTERS
    = " \t\n\r\x00\v"

TRIM_TARGET_BOTH


    private
        mixed
    TRIM_TARGET_BOTH
    = 0

TRIM_TARGET_END


    private
        mixed
    TRIM_TARGET_END
    = 1

TRIM_TARGET_START


    private
        mixed
    TRIM_TARGET_START
    = -1

contains()

文字列を含んでいるか判定。


    public
            static        contains(string $haystack, string $needle, bool $ignoreCase) : bool

Parameters

$haystack : string: 対象文字列。
$needle : string: 検索文字列。
$ignoreCase : bool: 大文字小文字を無視するか。

Return values

bool

dump()

データ出力。


    public
            static        dump(mixed $value) : string

var_export/print_r で迷ったり $return = true 忘れのためのラッパー。色々あったけど var_dump に落ち着いた感。

Parameters

$value : mixed

Return values

string

endsWith()

終端文字列一致判定。


    public
            static        endsWith(string $haystack, string $needle, bool $ignoreCase) : bool

Parameters

$haystack : string: 対象文字列。
$needle : string: 検索文字列。
$ignoreCase : bool: 大文字小文字を無視するか。

Return values

bool

format()

`sprintf` ラッパー。


    public
            static        format(string $format, mixed ...$values) : string

単純な文字列置き換えであれば Text::replaceMap を使用する。

Parameters

$format : string
$values : mixed

Return values

string

formatNumber()

数字を千の位毎にグループ化してフォーマット


    public
            static        formatNumber(int|float $number[, int $decimals = 0 ][, string|null $decimalSeparator = '.' ][, string|null $thousandsSeparator = ',' ]) : string

Parameters

$number : int|float: フォーマットする数値
$decimals : int = 0: 小数点以下の桁数。 0 を指定すると、戻り値の $decimalSeparator は省略されます
$decimalSeparator : string|null = '.': 小数点を表す区切り文字
$thousandsSeparator : string|null = ',': 千の位毎の区切り文字

Return values

string —

置き換え後文字列

fromCodePoint()

Unicode のコードポイントに対応する文字を返す。


    public
            static        fromCodePoint(int|array<string|int, int> $value) : string

mb_chr ラッパー。

Parameters

$value : int|array<string|int, int>

Return values

string

getByteCount()

文字列バイト数を取得。


    public
            static        getByteCount(string $value) : int

strlen ラッパー。

Parameters

$value : string: 対象文字列。

Return values

int —

バイト数。

getLastPosition()

文字列位置を取得。


    public
            static        getLastPosition(string $haystack, string $needle[, int $offset = 0 ]) : int

Parameters

$haystack : string: 対象文字列。
$needle : string: 検索文字列。
$offset : int = 0: 終端文字数目。

Return values

int —

見つかった文字位置。見つかんない場合は -1

getLength()

文字列長を取得。


    public
            static        getLength(string $value) : int

mb_strlen ラッパー。

Parameters

$value : string: 対象文字列。

Return values

int —

文字数。

getPosition()

文字列位置を取得。


    public
            static        getPosition(string $haystack, string $needle[, int $offset = 0 ]) : int

Parameters

$haystack : string: 対象文字列。
$needle : string: 検索文字列。
$offset : int = 0: 開始文字数目。

Return values

int —

見つかった文字位置。見つかんない場合は -1

isNullOrEmpty()

文字列が `null` か空か


    public
            static        isNullOrEmpty(string|null $s) : bool

Parameters

$s : string|null: 対象文字列。

Return values

bool —

真: nullか空。

isNullOrWhiteSpace()

文字列がnullかホワイトスペースのみで構築されているか


    public
            static        isNullOrWhiteSpace(string|null $s) : bool

TRIM_CHARACTERS がホワイトスペースとして扱われる。

Parameters

$s : string|null: 対象文字列。

Return values

bool —

真: nullかホワイトスペースのみ。

join()

文字列結合。


    public
            static        join(string $separator, array<string|int, string> $values) : string

implode ラッパー。

Parameters

$separator : string
$values : array<string|int, string>

Return values

string

repeat()

文字列を反復。


    public
            static        repeat(string $value, int $count) : string

str_repeat ラッパー。

Parameters

$value : string
$count : int

Return values

string

replace()

文字列置き換え


    public
            static        replace(string $source, string|array<string|int, string> $oldValue, string|array<string|int, string> $newValue) : string

str_replace ラッパー。

Parameters

$source : string: 入力文字列。
$oldValue : string|array<string|int, string>: 元文字列(か、元文字列配列)
$newValue : string|array<string|int, string>: 置き換え文字列(か、元文字列配列)。

Return values

string —

置き換え後文字列。

replaceMap()

プレースホルダー文字列置き換え処理


    public
            static        replaceMap(string $source, array<string, string> $map[, non-empty-string $head = '{' ][, non-empty-string $tail = '}' ]) : string

Parameters

$source : string: 元文字列
$map : array<string, string>: 置き換え対象辞書
$head : non-empty-string = '{': プレースホルダー先頭
$tail : non-empty-string = '}': プレースホルダー終端

Return values

string —

置き換え後文字列

requireNotNullOrEmpty()

文字列が `null` か空の場合に代替文字列を返す。


    public
            static        requireNotNullOrEmpty(string|null $s, string $fallback) : string

Parameters

$s : string|null
$fallback : string

Return values

string

requireNotNullOrWhiteSpace()

文字列がnullかホワイトスペースのみで構築されている場合に代替文字列を返す。


    public
            static        requireNotNullOrWhiteSpace(string|null $s, string $fallback) : string

Parameters

$s : string|null
$fallback : string

Return values

string

split()

文字列分割。


    public
            static        split(string $value, non-empty-string $separator[, int $limit = PHP_INT_MAX ]) : array<string|int, string>

explode ラッパー。

Parameters

$value : string: 対象文字列。
$separator : non-empty-string: 分割対象文字列。
$limit : int = PHP_INT_MAX: 分割数。

Return values

array<string|int, string> —

分割された文字列。

splitLines()

文字列を改行で分割。


    public
            static        splitLines(string $value) : array<string|int, string>

Parameters

$value : string

Return values

array<string|int, string>

startsWith()

先頭文字列一致判定。


    public
            static        startsWith(string $haystack, string $needle, bool $ignoreCase) : bool

Parameters

$haystack : string: 対象文字列。
$needle : string: 検索文字列。
$ignoreCase : bool: 大文字小文字を無視するか。

Return values

bool

substring()

文字列部分切り出し。


    public
            static        substring(string $value, int $offset[, int $length = -1 ]) : string

Parameters

$value : string: 対象文字列。
$offset : int: 開始文字数目。負数の場合は後ろから。
$length : int = -1: 抜き出す長さ。負数の場合は最後まで($offset)

Return values

string —

切り抜き後文字列。

toCharacters()

文字列を文字の配列に変換。


    public
            static        toCharacters(non-empty-string $value) : array<string|int, string>

Parameters

$value : non-empty-string

Return values

array<string|int, string>

toLower()

大文字を小文字に変換。


    public
            static        toLower(string $value) : string

Parameters

$value : string

Return values

string

toString()

何かしらを文字列変換


    public
            static        toString(mixed $raw[, string $newline = PHP_EOL ]) : string

Parameters

$raw : mixed
$newline : string = PHP_EOL: 配列の場合の改行(未指定時に PHP_EOL)

Return values

string

toUpper()

小文字を大文字に変換。


    public
            static        toUpper(string $value) : string

Parameters

$value : string

Return values

string

trim()

トリム処理。


    public
            static        trim(string $value[, string $characters = self::TRIM_CHARACTERS ]) : string

trim ラッパー。

Parameters

$value : string: 対象文字列。
$characters : string = self::TRIM_CHARACTERS: トリム対象文字。

Return values

string —

トリム後文字列。

trimEnd()

終端トリム。


    public
            static        trimEnd(string $value[, string $characters = self::TRIM_CHARACTERS ]) : string

rtrim ラッパー。

Parameters

$value : string: 対象文字列。
$characters : string = self::TRIM_CHARACTERS: トリム対象文字。

Return values

string —

トリム後文字列。

trimStart()

先頭トリム。


    public
            static        trimStart(string $value[, string $characters = self::TRIM_CHARACTERS ]) : string

ltrim ラッパー。

Parameters

$value : string: 対象文字列。
$characters : string = self::TRIM_CHARACTERS: トリム対象文字。

Return values

string —

トリム後文字列。

createTrimPattern()

トリム用パターンの生成。


    private
            static        createTrimPattern(Regex $regex, string $characters, int $trimTarget) : string

Parameters

$regex : Regex
$characters : string
$trimTarget : int

Return values

string

fromCodePointCore()


    private
            static        fromCodePointCore(int $value) : string

Parameters

$value : int

Return values

string

Text in package Application

Table of Contents

Constants

Methods

Constants

EMPTY

TRIM_CHARACTERS

TRIM_PHP_CHARACTERS

TRIM_TARGET_BOTH

TRIM_TARGET_END

TRIM_TARGET_START

Methods

contains()

Parameters

Return values

dump()

Parameters

Return values

endsWith()

Parameters

Return values

format()

Parameters

Tags

Return values

formatNumber()

Parameters

Tags

Return values

fromCodePoint()

Parameters

Tags

Return values

getByteCount()

Parameters

Tags

Return values

getLastPosition()

Parameters

Tags

Return values

getLength()

Parameters

Tags

Return values

getPosition()

Parameters

Tags

Return values

isNullOrEmpty()

Parameters

Tags

Return values

isNullOrWhiteSpace()

Parameters

Tags

Return values

join()

Parameters

Tags

Return values

repeat()

Parameters

Tags

Return values

replace()

Parameters

Tags

Return values

replaceMap()

Parameters

Tags

Return values

requireNotNullOrEmpty()

Parameters

Return values

requireNotNullOrWhiteSpace()

Parameters

Return values

split()

Text
in package

Application