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

GcUtils

class GcUtils

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

このクラスはエラーハンドリング処理でも使用している。 よって、このファイルで構文エラーが発生すると、EC-CUBE はエラーを捕捉できない。

Methods

void
gfDebugLog(mixed $obj)

ログファイルに変数の詳細を出力

string
gfGetCallerInfo(int $forLogInfo = true)

呼び出し元関数名を返します

getDebugBacktrace($arrBacktrace = null)

デバッグ情報として必要な範囲のバックトレースを取得する

gfGetLogStr($mess, $log_level = 'Info') deprecated

前方互換用

gfAdminLog($mess, $log_level = 'Info') deprecated

前方互換用

gfFrontLog($mess, $log_level = 'Info') deprecated

前方互換用

static 
gfPrintLog(string $msg, string $path = '', bool $verbose = USE_VERBOSE_LOG)

ログの出力を行う

void
gfLogRotation(integer $max_log, integer $max_size, string $path)

ログローテーション機能

static 
gfMakePassword(integer $pwLength)

No description

gfMailHeaderAddr($str)

No description

string
toStringBacktrace(array $arrBacktrace)

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

string|integer
getErrorTypeName(integer $error_type)

エラー型から該当する定数名を取得する

string
getUrl()

現在の URL を取得する

bool
isAdminFunction()

管理機能かを判定

static bool
isFrontFunction()

フロント機能かを判定

static bool
isInstallFunction()

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

string
printXMLDeclaration()

XML宣言を出力する.

Details

at line 45
void gfDebugLog(mixed $obj)

ログファイルに変数の詳細を出力

Parameters

mixed $obj

Return Value

void

at line 60
string gfGetCallerInfo(int $forLogInfo = true)

呼び出し元関数名を返します

Parameters

int $forLogInfo ログ出力用に利用するかどうか(1:ログ出力用に利用する)

Return Value

string 呼び出し元クラス、関数名、行数の文字列表現

at line 83
getDebugBacktrace($arrBacktrace = null)

デバッグ情報として必要な範囲のバックトレースを取得する

エラーハンドリングに関わる情報を切り捨てる。

Parameters

$arrBacktrace

at line 130
gfGetLogStr($mess, $log_level = 'Info') deprecated

deprecated 2.12.0

前方互換用

Parameters

$mess
$log_level

at line 149
gfAdminLog($mess, $log_level = 'Info') deprecated

deprecated 2.12.0 static::gfPrintLog を使用すること

前方互換用

Parameters

$mess
$log_level

at line 166
gfFrontLog($mess, $log_level = 'Info') deprecated

deprecated 2.12.0 static::gfPrintLog を使用すること

前方互換用

Parameters

$mess
$log_level

at line 186
static gfPrintLog(string $msg, string $path = '', bool $verbose = USE_VERBOSE_LOG)

ログの出力を行う

エラー・警告は trigger_error() を経由して利用すること。(補足の出力は例外。)

Parameters

string $msg
string $path
bool $verbose 冗長な出力を行うか

at line 223
void gfLogRotation(integer $max_log, integer $max_size, string $path)

ログローテーション機能

XXX この類のローテーションは通常 0 開始だが、本実装は 1 開始である。 この中でログ出力は行なわないこと。(無限ループの懸念あり)

Parameters

integer $max_log 最大ファイル数
integer $max_size 最大サイズ
string $path ファイルパス

Return Value

void

at line 263
static gfMakePassword(integer $pwLength)

Parameters

integer $pwLength

at line 289
gfMailHeaderAddr($str)

Parameters

$str

at line 313
string toStringBacktrace(array $arrBacktrace)

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

現状スタックトレースの形で出力している。

Parameters

array $arrBacktrace バックトレース

Return Value

string テキストで表現したバックトレース

at line 337
string|integer getErrorTypeName(integer $error_type)

エラー型から該当する定数名を取得する

該当する定数がない場合、$error_type を返す。

Parameters

integer $error_type エラー型

Return Value

string|integer エラー定数名

at line 368
string getUrl()

現在の URL を取得する

Return Value

string 現在のURL

at line 389
bool isAdminFunction()

管理機能かを判定

Return Value

bool 管理機能か

at line 399
static bool isFrontFunction()

フロント機能かを判定

Return Value

bool フロント機能か

at line 409
static bool isInstallFunction()

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

Return Value

bool インストール機能か

at line 421
string printXMLDeclaration()

XML宣言を出力する.

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

Return Value

string XML宣言の文字列