EC-CUBE
Public メソッド
クラス SC_Utils
SC_Utilsに対する継承グラフ
Inheritance graph
[凡例]

Public メソッド

 sfInitInstall ()
 searchInstallerPath ($path)
 getRealURL ($url)
 sfErrorHeader ($mess, $print=false)
 sfDispError ($type)
 sfDispSiteError ($type, $objSiteSess="", $return_top=false, $err_msg="")
 sfDispException ($debugMsg=null)
 sfIsSuccess ($objSess, $disp_error=true)
 sfPassLen ($passlen)
 sfIsHTTPS ()
 sfIsValidTransition ($objSess)
 sfGetTimestamp ($year, $month, $day, $last=false)
 sfIsInt ($value)
 sfIsZeroFilling ($value)
 sfGetCSVData ($data, $prefix="")
 sfUpDirName ()
 sfMergeCBValue ($keyname, $max)
 sfMergeCheckBoxes ($array, $max)
 sfMergeParamCheckBoxes ($array)
 sfSearchCheckBoxes ($array)
 sfSplitCheckBoxes ($val)
 sfMergeCBSearchValue ($keyname, $max)
 sfSplitCBValue ($val, $keyname="")
 sfArrKeyValue ($arrList, $keyname, $valname, $len_max="", $keysize="")
 sfArrKeyValues ($arrList, $keyname, $valname, $len_max="", $keysize="", $connect="")
 sfGetCommaList ($array, $space=true, $arrPop=array())
 sfGetCSVList ($array)
 sfCheckSetTerm ($start_year, $start_month, $start_day, $end_year, $end_month, $end_day)
 sfSetErrorStyle ()
 sfSearchKey ($array, $word, $default)
 sfGetErrorColor ($val)
 sfGetEnabled ($val)
 sfGetChecked ($param, $value)
 sfTrim ($str)
 sfTax ($price, $tax, $tax_rule)
 sfCalcIncTax ($price, $tax, $tax_rule)
 sfRound ($value, $pow=0)
 sfPrePoint ($price, $point_rate, $rule=POINT_RULE, $product_id="")
 sfGetClassCatCount ()
 sfGetProductClassId ($product_id, $classcategory_id1, $classcategory_id2)
 sfTrimURL ($url)
 sfDispDBDate ($dbdate, $time=true)
 sfSwapArray ($array, $isColumnName=true)
 getHash2Array ($hash, $requires=array())
 sfMultiply ($num1, $num2)
 sfGetAddPoint ($totalpoint, $use_point, $point_rate)
 sfGetUniqRandomId ($head="")
 sfPutBR ($str, $size)
 sfRmDupSlash ($istr)
 sfEncodeFile ($filepath, $enc_type, $out_dir)
 sfCutString ($str, $len, $byte=true, $commadisp=true)
 sfTermMonth ($year, $month, $close_day)
 sfMakeHiddenArray ($arrSrc, $arrDst=array(), $parent_key="")
 sfDBDatetoTime ($db_date)
 sfMbConvertEncoding ($str, $encode= 'CHAR_CODE')
 sfArrCombine ($arrKeys, $arrValues)
 sfGetBrothersArray ($arrData, $pid_name, $id_name, $arrPID)
 sfGetUnderChildrenArray ($arrData, $pid_name, $id_name, $parent)
 sfQuoteSmart ($in)
 sfMakeDir ($path)
 sfCopyDir ($src, $des, $mess="", $override=false)
 sfDelFile ($dir)
 sfWriteFile ($str, $path, $type, $permission="")
 sfFlush ($output=false, $sleep=0)
 sfGetFileVersion ($path)
 mbConvertKanaWithArray ($array, $arrConvList)
 arrayDefineIndexes ($array, $defineIndexes)
 sfArrayIntersectKeys ($arrSrc, $arrKey)
 printXMLDeclaration ()
 sfGetFileList ($dir)
 sfGetDirSize ($dir)
 sfDeleteDir ($dir)
 sfGetFileTree ($dir, $tree_status)
 sfGetFileTreeSub ($dir, $default_rank, &$cnt, &$arrTree, $tree_status)
 sfDirChildExists ($dir)
 lfIsFileOpen ($dir, $tree_status)
 sfDownloadFile ($file)
 sfCreateFile ($file, $mode="")
 sfReadFile ($filename)
 getCSVData ($array, $arrayIndex)
 getTableTag ($array)
 sfNoImageMainList ($filename= '')
 sfNoImageMain ($filename= '')
 sfPrintR ($obj)
 sfGetRandomString ($length=1)
 sfGetUrl ()
 sfBacktraceToString ($arrBacktrace)
 sfIsAdminFunction ()
 sfIsFrontFunction ()
 sfIsInstallFunction ()
 sfGetAddress ($zipcode)
 sfGetPluginFullPathByRequireFilePath ($file)
 sfGetPluginPathByPluginFullPath ($pluginFullPath)
 sfMakePluginInfoArray ($file)
 sfGetPluginInfoArray ($path)
 sfGetPluginsXml ()
 sfPutPluginsXml ($pluginsXml)
 sfLoadPluginInfo ($filenamePluginInfo)
 sfMicrotimeFloat ()
 isBlank ($val, $greedy=true)
 sfIsInternalDomain ($url)
 sfGetHashString ($str, $salt)
 sfIsMatchHashPassword ($pass, $hashpass, $salt)
 sfGetSearchPageMax ($search_page_max)
 jsonEncode ($value)
 jsonDecode ($json)
 isAbsoluteRealPath ($realpath)
 recursiveMkdir ($pathname, $mode=0777)

関数

arrayDefineIndexes ( array,
defineIndexes 
)

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

引数:
array$array添字をチェックする配列
array$defineIndexesチェックする添字
戻り値:
array 添字を定義した配列
getCSVData ( array,
arrayIndex 
)

CSV出力用データ取得

戻り値:
string
getHash2Array ( hash,
requires = array() 
)

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

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

引数:
array連想配列
array必須キーの配列
戻り値:
array 連想配列の値のみの配列
getRealURL ( url)

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

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

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

引数:
string$urlhttp(s):// から始まる URL
戻り値:
string $url を絶対パスに変換した URL
getTableTag ( array)

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

戻り値:
string
isAbsoluteRealPath ( realpath)

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

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

引数:
stringチェック対象のパス
戻り値:
boolean 絶対パスの場合 true
isBlank ( val,
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 の場合は, 全角スペース, ネストした空の配列も 空白と判断する.

引数:
mixed$valチェック対象の変数
boolean$greedy"貧欲"にチェックを行う場合 true
戻り値:
boolean $val が空白と判断された場合 true
jsonDecode ( json)

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

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

引数:
string$jsonJSON 形式にエンコードされた文字列
戻り値:
mixed デコードされた PHP の型
参照:
json_decode()
Services_JSON::decode()
jsonEncode ( value)

値を JSON 形式にして返す.

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

引数:
mixed$valueJSON 形式にエンコードする値
戻り値:
string JSON 形式にした文字列
参照:
json_encode()
Services_JSON::encode()
mbConvertKanaWithArray ( array,
arrConvList 
)

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

引数:
array$array変換する文字列の配列
array$arrConvListmb_convert_kana の適用ルール
戻り値:
array 変換後の配列
参照:
mb_convert_kana

XML宣言を出力する.

XML宣言があると問題が発生する UA は出力しない.

戻り値:
string XML宣言の文字列
recursiveMkdir ( pathname,
mode = 0777 
)

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

mkdir 関数の $recursive パラメーターを PHP4 でサポートする.

引数:
string$pathnameディレクトリのパス
integer$mode作成するディレクトリのパーミッション
戻り値:
boolean 作成に成功した場合 true; 失敗した場合 false
参照:
http://jp.php.net/mkdir
searchInstallerPath ( path)

インストーラのパスを検索し, URL を返す.

$path と同階層に install/index.php があるか検索する. 存在しない場合は上位階層を再帰的に検索する. インストーラのパスが見つかった場合は, その URL を返す. DocumentRoot まで検索しても見つからない場合は /install/index.php を返す.

引数:
string$path検索対象のパス
戻り値:
string インストーラの URL
sfArrayIntersectKeys ( arrSrc,
arrKey 
)

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

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

引数:
array$arrSrc
array$arrKey
戻り値:
array
sfBacktraceToString ( arrBacktrace)

バックトレースをテキスト形式で出力する

戻り値:
string テキストで表現したバックトレース
sfCalcIncTax ( price,
tax,
tax_rule 
)

税金付与した金額を返す

・店舗基本情報に基づいた計算は SC_Helper_DB::sfTax() を使用する

引数:
integer$price計算対象の金額
integer$tax税率(単位) XXX integer のみか不明
integer$tax_rule端数処理
戻り値:
integer 税金付与した金額
sfDispException ( debugMsg = null)

例外エラーページの表示

引数:
string$debugMsgデバッグ用のメッセージ
戻り値:
void
sfEncodeFile ( filepath,
enc_type,
out_dir 
)

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

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

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

public

引数:
string$filepath変換するテキストファイルのパス
string$enc_type変換後のファイルエンコーディングの種類を表す文字列
string$out_dir変換後のファイルを出力するディレクトリを表す文字列
戻り値:
string 変換後のテキストファイルのパス
sfFlush ( output = false,
sleep = 0 
)

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

引数:
boolean | string$output半角スペース256文字+改行を出力するか。または、送信する文字列を指定。
戻り値:
void
sfGetAddPoint ( totalpoint,
use_point,
point_rate 
)

加算ポイントの計算

・店舗基本情報に基づいた計算は SC_Helper_DB::sfGetAddPoint() を使用する

引数:
integer$totalpoint
integer$use_point
integer$point_rate
戻り値:
integer 加算ポイント
sfGetHashString ( str,
salt 
)

パスワードのハッシュ化

引数:
string$str暗号化したい文言
string$saltsalt
戻り値:
string ハッシュ暗号化された文字列

プラグインが配置されているディレクトリ(フルパス)を取得する

引数:
string$fileプラグイン情報ファイル(info.php)のパス
戻り値:
SimpleXMLElement プラグイン XML
sfGetPluginInfoArray ( path)

プラグイン情報配列を取得する

TODO include_once を利用することで例外対応をサボタージュしているのを改善する。

引数:
string$pathプラグインのディレクトリ名
戻り値:
array プラグイン情報配列
sfGetPluginPathByPluginFullPath ( pluginFullPath)

プラグインのパスを取得する

引数:
string$pluginFullPathプラグインが配置されているディレクトリ(フルパス)
戻り値:
SimpleXMLElement プラグイン XML

プラグイン XML を読み込む

TODO 空だったときを考慮

戻り値:
SimpleXMLElement プラグイン XML
sfGetRandomString ( length = 1)

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

引数:
integer$length文字数
戻り値:
string ランダムな文字列
sfGetSearchPageMax ( search_page_max)

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

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

引数:
string$search_page_max表示件数の選択値
戻り値:
integer 1ページあたりの最大表示件数
sfGetUrl ( )

現在の URL を取得する

戻り値:
string 現在のURL

管理機能かを判定

戻り値:
bool 管理機能か

フロント機能かを判定

戻り値:
bool フロント機能か
sfIsHTTPS ( )

HTTPSかどうかを判定

戻り値:
bool

インストール機能かを判定

戻り値:
bool インストール機能か
sfIsInt ( value)

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

引数:
mixed$value
戻り値:
bool
sfIsInternalDomain ( url)

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

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

引数:
string$url
戻り値:
boolean
sfIsMatchHashPassword ( pass,
hashpass,
salt 
)

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

引数:
string$pass確認したいパスワード文字列
string$hashpass確認したいパスワードハッシュ文字列
string$saltsalt
戻り値:
boolean 一致判定
sfIsValidTransition ( objSess)

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

引数:
objSC_Session, SC_SiteSession
戻り値:
bool
sfMakePluginInfoArray ( file)

プラグイン情報配列の基本形を作成する

引数:
string$fileプラグイン情報ファイル(info.php)のパス
戻り値:
array プラグイン情報配列
sfMergeCBSearchValue ( keyname,
max 
)
sfMergeCBValue ( keyname,
max 
)
sfMergeCheckBoxes ( array,
max 
)
sfMergeParamCheckBoxes ( array)

現在の Unix タイムスタンプを float (秒単位) でマイクロ秒まで返す

PHP4の上位互換用途。 FIXME PHP4でテストする。(現状全くテストしていない。)

引数:
SimpleXMLElement$pluginsXmlプラグイン XML
戻り値:
integer ファイルに書き込まれたバイト数を返します。
sfNoImageMain ( filename = '')

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

引数:
string&$filenameファイル名
戻り値:
string
sfNoImageMainList ( filename = '')

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

引数:
string&$filenameファイル名
戻り値:
string
sfPassLen ( passlen)

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

引数:
string$passlen変換する文字列
戻り値:
string アスタリスクへ変換した文字列
sfPutPluginsXml ( pluginsXml)

プラグイン XML を書き込む

引数:
SimpleXMLElement$pluginsXmlプラグイン XML
戻り値:
integer ファイルに書き込まれたバイト数を返します。
sfQuoteSmart ( in)

SQLシングルクォート対応

非推奨:
SC_Query::quote() を使用すること
sfSearchCheckBoxes ( array)
sfSplitCBValue ( val,
keyname = "" 
)
sfSplitCheckBoxes ( val)
sfTax ( price,
tax,
tax_rule 
)

税金額を返す

・店舗基本情報に基づいた計算は SC_Helper_DB::sfTax() を使用する

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

このクラスの説明は次のファイルから生成されました:
 全て データ構造 ネームスペース 関数 変数