1. class
  2. Eccube
  3. Framework
  4. Util
  5. Utils

Utils

class Utils

各種ユーティリティクラス.

主に static 参照するユーティリティ系の関数群

:XXX: 内部でインスタンスを生成している関数は, Helper クラスへ移動するべき...

Methods

static 
sfInitInstall()

No description

static string
getInstallerPath()

インストーラーの URL を返す

static string
getRealURL(string $url)

相対パスで記述された URL から絶対パスの URL を取得する.

static 
sfErrorHeader($mess, $print = false)

No description

static 
sfDispError($type)

No description

static 
sfDispSiteError($type, $objSiteSess = '', $return_top = false, $err_msg = '')

No description

sfDispException($debugMsg = null) deprecated

前方互換用

static bool
sfIsSuccess(Session $objSess, bool $disp_error = true)

認証の可否判定

static string
sfPassLen(string $passlen)

文字列をアスタリスクへ変換する.

static bool
sfIsHTTPS()

HTTPSかどうかを判定

sfIsValidTransition(obj $objSess)

正規の遷移がされているかを判定 前画面でuniqidを埋め込んでおく必要がある

static 
sfGetTimestamp($year, $month, $day, $last = false)

No description

static 
sfGetTimestampistime($year, $month, $day, $hour, $minutes, $last = false)

No description

static bool
sfIsInt($value)

INT型の数値チェック ・FIXME: マイナス値の扱いが不明確 ・XXX: INT_LENには収まるが、INT型の範囲を超えるケースに対応できないのでは?

static boolean
sfIsZeroFilling(string $value)

桁が0で埋められているかを判定する

static 
sfGetCSVData($data, $prefix = '')

No description

static 
sfUpDirName()

No description

sfMergeCBValue($keyname, $max) deprecated

No description

sfMergeCheckBoxes($array, $max) deprecated

No description

sfMergeParamCheckBoxes($array) deprecated

No description

sfSearchCheckBoxes($array) deprecated

No description

sfSplitCheckBoxes($val) deprecated

No description

sfMergeCBSearchValue($keyname, $max) deprecated

No description

sfSplitCBValue($val, $keyname = '') deprecated

No description

static 
sfArrKeyValue($arrList, $keyname, $valname, $len_max = '', $keysize = '')

No description

sfArrKeyValues($arrList, $keyname, $valname, $len_max = '', $keysize = '', $connect = '')

キーと値をセットした配列を取得(値が複数の場合) 使用されていない

static 
sfGetCommaList($array, $space = true, $arrPop = array())

No description

static 
sfGetCSVList($array)

No description

sfCheckSetTerm($start_year, $start_month, $start_day, $end_year, $end_month, $end_day)

checksetterm 年月日に別れた2つの期間の妥当性をチェックし、整合性と期間を返す 　引数 (開始年,開始月,開始日,終了年,終了月,終了日) 　戻値 array(１，２，３） １．開始年月日 (YYYY/MM/DD 000000) ２．終了年月日 (YYYY/MM/DD 235959) ３．エラー (0 = OK, 1 = NG)

sfSetErrorStyle()

No description

sfSearchKey($array, $word, $default)

No description

sfGetErrorColor($val)

No description

sfGetEnabled($val)

No description

sfGetChecked($param, $value)

No description

sfTrim($str)

No description

static double
sfTax(integer $price, integer $tax, integer $tax_rule)

税金額を返す

static double
sfCalcIncTax(integer $price, integer $tax, integer $tax_rule)

税金付与した金額を返す

sfRound($value, $pow)

桁数を指定して四捨五入

static double
sfPrePoint(int $price, float $point_rate, int $rule = POINT_RULE)

ポイント付与 $product_id が使われていない。

static 
sfGetClassCatCount()

No description

static int
sfGetProductClassId(int $product_id, int $classcategory_id1, int $classcategory_id2)

商品IDとカテゴリIDから商品規格IDを取得する

static 
sfTrimURL($url)

No description

sfDispDBDate($dbdate, $time = true)

No description

static array
sfSwapArray(array $array, bool $isColumnName = true)

配列をキー名ごとの配列に変更する

static array
getHash2Array(array $hash, array $requires = array())

連想配列から新たな配列を生成して返す.

sfMultiply($num1, $num2)

No description

static integer
getAddPoint(integer $totalpoint, integer $use_point, integer $point_rate)

加算ポイントの計算

static 
sfGetUniqRandomId($head = '')

No description

static string
sfRmDupSlash(string $istr)

二回以上繰り返されているスラッシュ[/]を一つに変換する。

static string
sfEncodeFile(string $filepath, string $enc_type, string $out_dir)

テキストファイルの文字エンコーディングを変換する.

sfCutString($str, $len, $byte = true, $commadisp = true)

No description

static 
sfTermMonth($year, $month, $close_day)

No description

static 
sfMakeHiddenArray($arrSrc, $arrDst = array(), $parent_key = '')

No description

static 
sfDBDatetoTime($db_date)

No description

sfMbConvertEncoding($str, $encode = CHAR_CODE)

PHPのmbconvertencoding関数をSmartyでも使えるようにする

sfArrCombine($arrKeys, $arrValues)

No description

static 
sfGetUnderChildrenArray($arrData, $pid_name, $id_name, $parent)

No description

static 
sfQuoteSmart($in) deprecated

SQLシングルクォート対応

static 
sfMakeDir($path)

No description

static 
sfCopyDir($src, $des, $mess = '', $override = false)

No description

static void
sfFlush(boolean|string $output = false, int $sleep)

ブラウザに強制的に送出する

sfGetFileVersion($path)

No description

array
mbConvertKanaWithArray(array $array, array $arrConvList)

$array の要素を $arrConvList で指定した方式で mbconvertkana を適用する.

static array
arrayDefineIndexes(array $array, string[] $defineIndexes)

配列の添字が未定義の場合は空文字を代入して定義する.

static array
sfArrayIntersectKeys(array $arrSrc, array $arrKey)

$arrSrc のうち、キーが $arrKey に含まれるものを返す

printXMLDeclaration() deprecated

前方互換用

string
getTableTag(array $array)

配列をテーブルタグで出力する。

static string
getSaveImagePath($filename)

指定の画像のパスを返す

string
sfNoImageMainList(string $filename = '')

一覧-メイン画像のファイル指定がない場合、専用の画像ファイルに書き換える。

static string
sfNoImageMain(string $filename = '')

詳細-メイン画像のファイル指定がない場合、専用の画像ファイルに書き換える。

static void
sfPrintR(mixed $obj)

デバッグ用

static string
sfGetRandomString(integer $length = 1)

ランダムな文字列を取得する

sfGetUrl() deprecated

前方互換用

sfBacktraceToString($arrBacktrace) deprecated

前方互換用

sfIsAdminFunction() deprecated

前方互換用

sfIsFrontFunction() deprecated

前方互換用

sfIsInstallFunction() deprecated

前方互換用

static 
sfGetAddress(string $zipcode)

No description

sfMicrotimeFloat() deprecated

前方互換用

static boolean
isBlank(mixed $val, boolean $greedy = true)

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

static boolean
sfIsInternalDomain(string $url)

指定されたURLのドメインが一致するかを返す

static string
sfGetHashString(string $str, string $salt)

パスワードのハッシュ化

static boolean
sfIsMatchHashPassword(string $pass, string $hashpass, string $salt)

パスワード文字列のハッシュ一致判定

static integer
sfGetSearchPageMax(string $search_page_max)

検索結果の1ページあたりの最大表示件数を取得する

static string
jsonEncode(mixed $value)

値を JSON 形式にして返す.

static mixed
jsonDecode(string $json)

JSON 文字列をデコードする.

static boolean
isAbsoluteRealPath(string $path)

パスが絶対パスかどうかをチェックする.

static boolean
recursiveMkdir($path, $mode = 0777)

ディレクトリを再帰的に作成する.

static 
isAppInnerUrl($url)

No description

static boolean
extendTimeOut(integer $seconds = null)

PHP のタイムアウトを延長する

static void
clearCompliedTemplate()

コンパイルファイルを削除します.

static void
copyDirectory(string $source_path, string $dest_path)

指定されたパスの配下を再帰的にコピーします.

static string
repeatStrWithSeparator(string $input, string $multiplier, string $separator = ',')

文字列を区切り文字を挟み反復する

static string
encodeRFC3986(string $str)

RFC3986に準拠したURIエンコード MEMO: PHP5.3.0未満では、~のエンコードをしてしまうための処理

static string
trim(string $str, string $charlist = null)

マルチバイト対応の trim

static string
ltrim(string $str, string $charlist = null)

マルチバイト対応の ltrim

static string
rtrim(string $str, string $charlist = null)

マルチバイト対応の rtrim

static string
getTrimPregPattern(string $charlist = null)

文字列のトリム処理で使用する PCRE のパターン

static string
getUnitDataSize(int $data)

データ量の単位を付与する

static array
buildTree(string $primary_key, string $glue_key, integer $max_depth, array $correction = array(), integer $root_id)

カテゴリーツリー状の配列を作成.

static void
addChild(array $target, string $primary_key, integer $level, integer $max_depth, array $children = array())

ツリーの親子をつなげるルーチン.

static array
makeArrayIDToKey(string $ID_name, array $correction = array())

配列のキーをIDにした配列を作成.

static array
getTreeTrail(integer $start_id, string $primary_key, string $glue_key, array $correction = array(), boolean $cid_is_key = FALSE, integer $root_id, boolean $id_only = TRUE)

階層情報が含まれている配列から親ID配列を取得する.

static bool
checkFileExistsWithInBasePath(string $file, string $base_path)

ベースとなるパスと相対パスを比較してファイルが存在する事をチェックする

static string
getFormattedDateWithMicroSecond()

マイクロ秒付きの時間文字列を取得する.

Details

at line 38
static sfInitInstall()

at line 59
static string getInstallerPath()

インストーラーの URL を返す

Return Value

string インストーラーの URL

at line 92
static string getRealURL(string $url)

相対パスで記述された URL から絶対パスの URL を取得する.

この関数は, http(s):// から始まる URL を解析し, 相対パスで記述されていた 場合, 絶対パスに変換して返す

例) http://www.example.jp/aaa/../index.php ↓ http://www.example.jp/index.php

Parameters

string $url http(s):// から始まる URL

Return Value

string $url を絶対パスに変換した URL

at line 117
static sfErrorHeader($mess, $print = false)

Parameters

$mess
$print

at line 129
static sfDispError($type)

Parameters

$type

at line 139
static sfDispSiteError($type, $objSiteSess = '', $return_top = false, $err_msg = '')

Parameters

$type
$objSiteSess
$return_top
$err_msg

at line 157
sfDispException($debugMsg = null) deprecated

deprecated 2.12.0 trigger_error($debugMsg, E_USER_ERROR) を使用すること

前方互換用

Parameters

$debugMsg

at line 170
static bool sfIsSuccess(Session $objSess, bool $disp_error = true)

認証の可否判定

Parameters

Session $objSess
bool $disp_error

Return Value

bool

at line 208
static string sfPassLen(string $passlen)

文字列をアスタリスクへ変換する.

Parameters

string $passlen 変換する文字列

Return Value

string アスタリスクへ変換した文字列

at line 224
static bool sfIsHTTPS()

HTTPSかどうかを判定

Return Value

bool

at line 244
sfIsValidTransition(obj $objSess)

正規の遷移がされているかを判定 前画面でuniqidを埋め込んでおく必要がある

使用されていない.

Parameters

obj $objSess Session, SiteSession @return bool

at line 256
static sfGetTimestamp($year, $month, $day, $last = false)

Parameters

$year
$month
$day
$last

at line 280
static sfGetTimestampistime($year, $month, $day, $hour, $minutes, $last = false)

Parameters

$year
$month
$day
$hour
$minutes
$last

at line 304
static bool sfIsInt($value)

INT型の数値チェック ・FIXME: マイナス値の扱いが不明確 ・XXX: INT_LENには収まるが、INT型の範囲を超えるケースに対応できないのでは?

@param mixed $value

Parameters

$value

Return Value

bool

at line 319
static boolean sfIsZeroFilling(string $value)

桁が0で埋められているかを判定する

Parameters

string $value 検査対象

Return Value

boolean 0で埋められている

at line 331
static sfGetCSVData($data, $prefix = '')

Parameters

$data
$prefix

at line 350
static sfUpDirName()

at line 363
sfMergeCBValue($keyname, $max) deprecated

deprecated

Parameters

$keyname
$max

at line 382
sfMergeCheckBoxes($array, $max) deprecated

deprecated

Parameters

$array
$max

at line 406
sfMergeParamCheckBoxes($array) deprecated

deprecated

Parameters

$array

at line 428
sfSearchCheckBoxes($array) deprecated

deprecated

Parameters

$array

at line 446
sfSplitCheckBoxes($val) deprecated

deprecated

Parameters

$val

at line 463
sfMergeCBSearchValue($keyname, $max) deprecated

deprecated

Parameters

$keyname
$max

at line 482
sfSplitCBValue($val, $keyname = '') deprecated

deprecated

Parameters

$val
$keyname

at line 505
static sfArrKeyValue($arrList, $keyname, $valname, $len_max = '', $keysize = '')

Parameters

$arrList
$keyname
$valname
$len_max
$keysize

at line 535
sfArrKeyValues($arrList, $keyname, $valname, $len_max = '', $keysize = '', $connect = '')

キーと値をセットした配列を取得(値が複数の場合) 使用されていない

Parameters

$arrList
$keyname
$valname
$len_max
$keysize
$connect

at line 563
static sfGetCommaList($array, $space = true, $arrPop = array())

Parameters

$array
$space
$arrPop

at line 590
static sfGetCSVList($array)

Parameters

$array

at line 617
sfCheckSetTerm($start_year, $start_month, $start_day, $end_year, $end_month, $end_day)

checksetterm 年月日に別れた2つの期間の妥当性をチェックし、整合性と期間を返す 　引数 (開始年,開始月,開始日,終了年,終了月,終了日) 　戻値 array(１，２，３） １．開始年月日 (YYYY/MM/DD 000000) ２．終了年月日 (YYYY/MM/DD 235959) ３．エラー (0 = OK, 1 = NG)

使用されていない

Parameters

$start_year
$start_month
$start_day
$end_year
$end_month
$end_day

at line 641
sfSetErrorStyle()

at line 647
sfSearchKey($array, $word, $default)

Parameters

$array
$word
$default

at line 658
sfGetErrorColor($val)

Parameters

$val

at line 667
sfGetEnabled($val)

Parameters

$val

at line 676
sfGetChecked($param, $value)

Parameters

$param
$value

at line 685
sfTrim($str)

Parameters

$str

at line 704
static double sfTax(integer $price, integer $tax, integer $tax_rule)

税金額を返す

・店舗基本情報に基づいた計算は \Eccube\Helper\Application::alias('eccube.helper.db')->tax() を使用する

Parameters

integer $price 計算対象の金額
integer $tax 税率(%単位) XXX integer のみか不明
integer $tax_rule 端数処理

Return Value

double 税金額

at line 724
static double sfCalcIncTax(integer $price, integer $tax, integer $tax_rule)

税金付与した金額を返す

・店舗基本情報に基づいた計算は \Eccube\Helper\Application::alias('eccube.helper.db')->tax() を使用する

Parameters

integer $price 計算対象の金額
integer $tax 税率(%単位) XXX integer のみか不明
integer $tax_rule 端数処理

Return Value

double 税金付与した金額

at line 734
sfRound($value, $pow)

桁数を指定して四捨五入

使用されていない

Parameters

$value
$pow

at line 756
static double sfPrePoint(int $price, float $point_rate, int $rule = POINT_RULE)

ポイント付与 $product_id が使われていない。

Parameters

int $price
float $point_rate
int $rule

Return Value

double

at line 766
static sfGetClassCatCount()

at line 789
static int sfGetProductClassId(int $product_id, int $classcategory_id1, int $classcategory_id2)

商品IDとカテゴリIDから商品規格IDを取得する

Parameters

int $product_id
int $classcategory_id1 デフォルト値0
int $classcategory_id2 デフォルト値0

Return Value

int

at line 806
static sfTrimURL($url)

Parameters

$url

at line 814
sfDispDBDate($dbdate, $time = true)

Parameters

$dbdate
$time

at line 838
static array sfSwapArray(array $array, bool $isColumnName = true)

配列をキー名ごとの配列に変更する

Parameters

array $array
bool $isColumnName

Return Value

array

at line 865
static array getHash2Array(array $hash, array $requires = array())

連想配列から新たな配列を生成して返す.

$requires が指定された場合, $requires に含まれるキーの値のみを返す.

Parameters

array $hash 連想配列
array $requires 必須キーの配列

Return Value

array 連想配列の値のみの配列

at line 885
sfMultiply($num1, $num2)

Parameters

$num1
$num2

at line 900
static integer getAddPoint(integer $totalpoint, integer $use_point, integer $point_rate)

加算ポイントの計算

・店舗基本情報に基づいた計算は \Eccube\Helper\Application::alias('eccube.helper.db')->getAddPoint() を使用する

Parameters

integer $totalpoint
integer $use_point
integer $point_rate

Return Value

integer 加算ポイント

at line 913
static sfGetUniqRandomId($head = '')

Parameters

$head

at line 929
static string sfRmDupSlash(string $istr)

二回以上繰り返されているスラッシュ[/]を一つに変換する。

Parameters

string $istr

Return Value

string

at line 964
static string sfEncodeFile(string $filepath, string $enc_type, string $out_dir)

テキストファイルの文字エンコーディングを変換する.

$filepath に存在するテキストファイルの文字エンコーディングを変換する. 変換前の文字エンコーディングは, mbdetectorder で設定した順序で自動検出する. 変換後は, 変換前のファイル名に「enc」というプレフィクスを付与し, $outdir で指定したディレクトリへ出力する

TODO $filepath のファイルがバイナリだった場合の扱い TODO fwrite などでのエラーハンドリング

Parameters

string $filepath 変換するテキストファイルのパス
string $enc_type 変換後のファイルエンコーディングの種類を表す文字列
string $out_dir 変換後のファイルを出力するディレクトリを表す文字列

Return Value

string 変換後のテキストファイルのパス

at line 992
sfCutString($str, $len, $byte = true, $commadisp = true)

Parameters

$str
$len
$byte
$commadisp

at line 1042
static sfTermMonth($year, $month, $close_day)

Parameters

$year
$month
$close_day

at line 1085
static sfMakeHiddenArray($arrSrc, $arrDst = array(), $parent_key = '')

Parameters

$arrSrc
$arrDst
$parent_key

at line 1106
static sfDBDatetoTime($db_date)

Parameters

$db_date

at line 1119
sfMbConvertEncoding($str, $encode = CHAR_CODE)

PHPのmbconvertencoding関数をSmartyでも使えるようにする

XXX この関数を使っている箇所は、ほぼ設計誤りと思われる。変数にフェッチするか、出力時のエンコーディングで対応すべきと見受ける。

Parameters

$str
$encode

at line 1125
sfArrCombine($arrKeys, $arrValues)

Parameters

$arrKeys
$arrValues

at line 1147
static sfGetUnderChildrenArray($arrData, $pid_name, $id_name, $parent)

Parameters

$arrData
$pid_name
$id_name
$parent

at line 1166
static sfQuoteSmart($in) deprecated

deprecated Query::quote() を使用すること

SQLシングルクォート対応

Parameters

$in

at line 1180
static sfMakeDir($path)

Parameters

$path

at line 1214
static sfCopyDir($src, $des, $mess = '', $override = false)

Parameters

$src
$des
$mess
$override

at line 1275
static void sfFlush(boolean|string $output = false, int $sleep)

ブラウザに強制的に送出する

Parameters

boolean|string $output 半角スペース256文字+改行を出力するか。または、送信する文字列を指定。
int $sleep

Return Value

void

at line 1302
sfGetFileVersion($path)

Parameters

$path

at line 1331
array mbConvertKanaWithArray(array $array, array $arrConvList)

$array の要素を $arrConvList で指定した方式で mbconvertkana を適用する.

使用されていない

Parameters

array $array 変換する文字列の配列
array $arrConvList mbconvertkana の適用ルール

Return Value

array 変換後の配列

See also

mb_convert_kana

at line 1349
static array arrayDefineIndexes(array $array, string[] $defineIndexes)

配列の添字が未定義の場合は空文字を代入して定義する.

Parameters

array $array 添字をチェックする配列
string[] $defineIndexes チェックする添字

Return Value

array 添字を定義した配列

at line 1367
static array sfArrayIntersectKeys(array $arrSrc, array $arrKey)

$arrSrc のうち、キーが $arrKey に含まれるものを返す

$arrSrc に含まない要素は返されない。

Parameters

array $arrSrc
array $arrKey

Return Value

array

at line 1382
printXMLDeclaration() deprecated

deprecated 2.12.0 GcUtils::printXMLDeclaration を使用すること

前方互換用

at line 1396
string getTableTag(array $array)

配列をテーブルタグで出力する。

使用されていない

Parameters

array $array

Return Value

string

at line 1424
static string getSaveImagePath($filename)

指定の画像のパスを返す

Parameters

$filename

Return Value

string $file 画像のパス、画像が存在しない場合、NOIMAGEREALFILEを返す

at line 1442
string sfNoImageMainList(string $filename = '')

一覧-メイン画像のファイル指定がない場合、専用の画像ファイルに書き換える。

Parameters

string $filename &$filename ファイル名

Return Value

string

at line 1457
static string sfNoImageMain(string $filename = '')

詳細-メイン画像のファイル指定がない場合、専用の画像ファイルに書き換える。

Parameters

string $filename &$filename ファイル名

Return Value

string

at line 1472
static void sfPrintR(mixed $obj)

デバッグ用

Parameters

mixed $obj

Return Value

void

at line 1488
static string sfGetRandomString(integer $length = 1)

ランダムな文字列を取得する

Parameters

integer $length 文字数

Return Value

string ランダムな文字列

at line 1498
sfGetUrl() deprecated

deprecated 2.12.0 GcUtils::getUrl を使用すること

前方互換用

at line 1510
sfBacktraceToString($arrBacktrace) deprecated

deprecated 2.12.0 GcUtils::toStringBacktrace を使用すること

前方互換用

Parameters

$arrBacktrace

at line 1522
sfIsAdminFunction() deprecated

deprecated 2.12.0 GcUtils::isAdminFunction を使用すること

前方互換用

at line 1534
sfIsFrontFunction() deprecated

deprecated 2.12.0 GcUtils::isFrontFunction を使用すること

前方互換用

at line 1546
sfIsInstallFunction() deprecated

deprecated 2.12.0 GcUtils::isInstallFunction を使用すること

前方互換用

at line 1558
static sfGetAddress(string $zipcode)

Parameters

string $zipcode

at line 1605
sfMicrotimeFloat() deprecated

deprecated 2.12.0 microtime(true) を使用する。

前方互換用

at line 1633
static boolean isBlank(mixed $val, boolean $greedy = true)

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

引数 $val が空白かどうかをチェックする. 空白の場合は 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)), 垂直タブ

引数 $val が配列の場合は, 空の配列の場合 true を返す.

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

Parameters

mixed $val チェック対象の変数
boolean $greedy '貧欲'にチェックを行う場合 true

Return Value

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

at line 1678
static boolean sfIsInternalDomain(string $url)

指定されたURLのドメインが一致するかを返す

戻り値：一致(true) 不一致(false)

Parameters

string $url

Return Value

boolean

at line 1701
static string sfGetHashString(string $str, string $salt)

パスワードのハッシュ化

Parameters

string $str 暗号化したい文言
string $salt salt

Return Value

string ハッシュ暗号化された文字列

at line 1723
static boolean sfIsMatchHashPassword(string $pass, string $hashpass, string $salt)

パスワード文字列のハッシュ一致判定

Parameters

string $pass 確認したいパスワード文字列
string $hashpass 確認したいパスワードハッシュ文字列
string $salt salt

Return Value

boolean 一致判定

at line 1756
static integer sfGetSearchPageMax(string $search_page_max)

検索結果の1ページあたりの最大表示件数を取得する

フォームの入力値から最大表示件数を取得する 取得できなかった場合は, 定数 SEARCH_PMAX の値を返す

Parameters

string $search_page_max 表示件数の選択値

Return Value

integer 1ページあたりの最大表示件数

at line 1779
static string jsonEncode(mixed $value)

値を JSON 形式にして返す.

この関数は, jsonencode() 又は ServicesJSON::encode() のラッパーです. jsonencode() 関数が使用可能な場合は jsonencode() 関数を使用する. 使用できない場合は, Services_JSON::encode() 関数を使用する.

Parameters

mixed $value JSON 形式にエンコードする値

Return Value

string JSON 形式にした文字列

See also

json_encode()
Services_JSON::encode()

at line 1804
static mixed jsonDecode(string $json)

JSON 文字列をデコードする.

この関数は, jsondecode() 又は ServicesJSON::decode() のラッパーです. jsondecode() 関数が使用可能な場合は jsondecode() 関数を使用する. 使用できない場合は, Services_JSON::decode() 関数を使用する.

Parameters

string $json JSON 形式にエンコードされた文字列

Return Value

mixed デコードされた PHP の型

See also

json_decode()
Services_JSON::decode()

at line 1829
static boolean isAbsoluteRealPath(string $path)

パスが絶対パスかどうかをチェックする.

引数のパスが絶対パスの場合は true を返す. この関数は, パスの存在チェックを行なわないため注意すること.

use FileUtil::isAbsolute http://pear.php.net/package/FileUtil/

Parameters

string $path チェック対象のパス

Return Value

boolean 絶対パスの場合 true

at line 1848
static boolean recursiveMkdir($path, $mode = 0777)

ディレクトリを再帰的に作成する.

Parameters

$path
$mode

Return Value

boolean 作成に成功した場合 true; 失敗した場合 false

See also

http://jp.php.net/mkdir

at line 1854
static isAppInnerUrl($url)

Parameters

$url

at line 1869
static boolean extendTimeOut(integer $seconds = null)

PHP のタイムアウトを延長する

ループの中で呼び出すことを意図している。 暴走スレッドが残留する確率を軽減するため、settimelimit(0) とはしていない。

Parameters

integer $seconds 最大実行時間を延長する秒数。

Return Value

boolean 成功=true, 失敗=false

at line 1891
static void clearCompliedTemplate()

コンパイルファイルを削除します.

Return Value

void

at line 1906
static void copyDirectory(string $source_path, string $dest_path)

指定されたパスの配下を再帰的にコピーします.

Parameters

string $source_path コピー元ディレクトリのパス
string $dest_path コピー先ディレクトリのパス

Return Value

void

at line 1932
static string repeatStrWithSeparator(string $input, string $multiplier, string $separator = ',')

文字列を区切り文字を挟み反復する

Parameters

string $input 繰り返す文字列。
string $multiplier input を繰り返す回数。
string $separator 区切り文字

Return Value

string

at line 1944
static string encodeRFC3986(string $str)

RFC3986に準拠したURIエンコード MEMO: PHP5.3.0未満では、~のエンコードをしてしまうための処理

Parameters

string $str 文字列

Return Value

string RFC3986エンコード文字列

at line 1956
static string trim(string $str, string $charlist = null)

マルチバイト対応の trim

Parameters

string $str 入力文字列
string $charlist 削除する文字を指定

Return Value

string 変更後の文字列

at line 1970
static string ltrim(string $str, string $charlist = null)

マルチバイト対応の ltrim

Parameters

string $str 入力文字列
string $charlist 削除する文字を指定

Return Value

string 変更後の文字列

at line 1984
static string rtrim(string $str, string $charlist = null)

マルチバイト対応の rtrim

Parameters

string $str 入力文字列
string $charlist 削除する文字を指定

Return Value

string 変更後の文字列

at line 1997
static string getTrimPregPattern(string $charlist = null)

文字列のトリム処理で使用する PCRE のパターン

Parameters

string $charlist 削除する文字を指定

Return Value

string パターン

at line 2012
static string getUnitDataSize(int $data)

データ量の単位を付与する

Parameters

int $data

Return Value

string

at line 2035
static array buildTree(string $primary_key, string $glue_key, integer $max_depth, array $correction = array(), integer $root_id)

カテゴリーツリー状の配列を作成.

Parameters

string $primary_key
string $glue_key
integer $max_depth
array $correction
integer $root_id

Return Value

array ツリーの配列

at line 2059
static void addChild(array $target, string $primary_key, integer $level, integer $max_depth, array $children = array())

ツリーの親子をつなげるルーチン.

Parameters

array $target 親
string $primary_key 主キーの識別子
integer $level 親の階層
integer $max_depth 階層の深さの最大値
array $children 子の配列（キーが親ID）

Return Value

void

at line 2078
static array makeArrayIDToKey(string $ID_name, array $correction = array())

配列のキーをIDにした配列を作成.

Parameters

string $ID_name IDが格納されているキー名
array $correction 元の配列

Return Value

array

at line 2102
static array getTreeTrail(integer $start_id, string $primary_key, string $glue_key, array $correction = array(), boolean $cid_is_key = FALSE, integer $root_id, boolean $id_only = TRUE)

階層情報が含まれている配列から親ID配列を取得する.

Parameters

integer $start_id 取得起点
string $primary_key 主キー名
string $glue_key 親IDキー名
array $correction 階層構造が含まれている配列
boolean $cid_is_key キーがIDの配列の場合はtrue
integer $root_id ルートID
boolean $id_only IDだけの配列を返す場合はtrue

Return Value

array 親ID配列

at line 2134
static bool checkFileExistsWithInBasePath(string $file, string $base_path)

ベースとなるパスと相対パスを比較してファイルが存在する事をチェックする

Parameters

string $file
string $base_path

Return Value

bool true = exists / false does not exist

at line 2147
static string getFormattedDateWithMicroSecond()

マイクロ秒付きの時間文字列を取得する.

Return Value

string