EC-CUBE4 APIドキュメント

StringUtil

Table of Contents

random() The MIT License (MIT) string
quickRandom() The MIT License (MIT) string
convertLineFeed() 改行コードの変換 string
characterEncoding() 文字コードの判定 string
ellipsis() 指定した文字列以上ある場合、「...」を付加する lengthに7を指定すると、「1234567890」は「1234567...」と「...」を付与して出力される string
timeAgo() 現在からの経過時間を書式化する. string
isBlank() 変数が空白かどうかをチェックする. bool
isNotBlank() bool
trimAll() 両端にある全角スペース、半角スペースを取り除く string
replaceOrAddEnv() envファイルのコンテンツを更新または追加する. string

Methods

random()

The MIT License (MIT)

public static random( [ $length : int = 16 ] ) : string

Copyright (c) <Taylor Otwell>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

Generate a more truly "random" alpha-numeric string.

Parameters
$length : int = 16
Tags
throws
RuntimeException
Return values
string

quickRandom()

The MIT License (MIT)

public static quickRandom( [ $length : int = 16 ] ) : string

Copyright (c) <Taylor Otwell>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

Generate a "random" alpha-numeric string.

Should not be considered sufficient for cryptography, etc.

Parameters
$length : int = 16
Return values
string

convertLineFeed()

改行コードの変換

public static convertLineFeed( $value : [, $lf : string = "\n" ] ) : string
Parameters
$value :
$lf : string = "\n"
Return values
string

characterEncoding()

文字コードの判定

public static characterEncoding( $value : string [, $encoding : mixed = ['UTF-8', 'SJIS', 'EUC-JP', 'ASCII', 'JIS', 'sjis-win'] ] ) : string
Parameters
$value : string
$encoding : mixed = ['UTF-8', 'SJIS', 'EUC-JP', 'ASCII', 'JIS', 'sjis-win']
Return values
string

ellipsis()

指定した文字列以上ある場合、「...」を付加する lengthに7を指定すると、「1234567890」は「1234567...」と「...」を付与して出力される

public static ellipsis( $value : string [, $length : int = 100 ] [, $end : string = '...' ] ) : string
Parameters
$value : string
$length : int = 100
$end : string = '...'
Return values
string

timeAgo()

現在からの経過時間を書式化する.

public static timeAgo( $date : ) : string
Parameters
$date :
Return values
string

isBlank()

変数が空白かどうかをチェックする.

public static isBlank( $value : string [, $greedy : bool = false ] ) : bool

引数 $value が空白かどうかをチェックする. 空白の場合は true. 以下の文字は空白と判断する.

  • ' ' (ASCII 32 (0x20)), 通常の空白
  • "\t" (ASCII 9 (0x09)), タブ
  • "\n" (ASCII 10 (0x0A)), リターン
  • "\r" (ASCII 13 (0x0D)), 改行
  • "\0" (ASCII 0 (0x00)), NULバイト
  • "\x0B" (ASCII 11 (0x0B)), 垂直タブ

引数 $value がオブジェクト型、配列の場合は非推奨とし、 E_USER_DEPRECATED をスローする. EC-CUBE2系からの互換性、ビギナー層を配慮し、以下のような実装とする. 引数 $value が配列の場合は, 空の配列の場合 true を返す. 引数 $value が ArrayCollection::isEmpty() == true の場合 true を返す. 引数 $value が上記以外のオブジェクト型の場合は false を返す.

引数 $greedy が true の場合は, 全角スペース, ネストした空の配列も 空白と判断する.

Parameters
$value : string

チェック対象の変数. 文字型以外も使用できるが、非推奨.

$greedy : bool = false

'貧欲'にチェックを行う場合 true, デフォルト false

Return values
bool —

$value が空白と判断された場合 true

isNotBlank()

public static isNotBlank( $value : [, $greedy : mixed = false ] ) : bool
Parameters
$value :
$greedy : mixed = false
Return values
bool

trimAll()

両端にある全角スペース、半角スペースを取り除く

public static trimAll( $value : ) : string
Parameters
$value :
Return values
string

replaceOrAddEnv()

envファイルのコンテンツを更新または追加する.

public static replaceOrAddEnv( $env : string , $replacement : array ) : string
Parameters
$env : string
$replacement : array
Return values
string

Search results