Util

クラス: Peach_Util_Values

定義: /Peach/Util/Values.php

値の各種変換を行うユーティリティクラスです.

メソッド

メソッド 詳細

static arrayValue

line 118

static array arrayValue(mixed $value, [bool $wrap = false])

指定された値を配列に変換します.

引数が配列の場合は引数をそのまま返します. 配列以外の値の場合は, 第二引数によって結果が変わります.

  • $wrap = TRUE の場合, 引数を長さ 1 の配列として返す.
  • $wrap = FALSE の場合, 空の配列を返す.

デフォルトでは $wrap = FALSE となります.

Tags

  • return : 変換後の配列
  • access : public

Parameters

mixed $value 変換元の値.
bool $wrap 配列以外の値の場合に, 長さ 1 の配列に変換する場合は TRUE

static boolValue

line 152

static bool boolValue(mixed $value, [bool $defaultValue = null])

指定された値を bool 型に変換します.

この関数は "Yes", "No", "True", "False", "OK", "NG" などの文字列を bool に変換する用途を想定したものです.

引数が bool 型の場合は引数をそのまま返します.

引数が文字列型の場合, 先頭の 1 バイトが T, Y, O のいずれかの場合は TRUE, 先頭の 1 バイトが F, N のいずれかの場合は FALSE, それ以外は文字列を bool にキャストした結果を返します. (大文字・小文字は区別しません)

引数が数値型の場合, bool にキャストした結果を返します. すなわち 0 以外の値は TRUE, 0 の場合は FALSE を返します.

以上の条件にあてはまらない値の場合, $defaultValue が NULL または未指定の場合は第 1 引数を bool にキャストした結果を返します. $defaultValue が指定されている場合はその bool 値を返します.

Tags

  • return : 変換後の bool 値
  • access : public

Parameters

mixed $value 変換対象の値
bool $defaultValue デフォルトの返り値

static getType

line 214

static void getType(mixed $var)

指定された値の型を返します.

内部関数の gettype() とほぼ同じ動作をしますが, 引数にオブジェクトを指定した場合に文字列 "object" ではなくその値のクラス名を返すところが異なります.

Tags

  • access : public

Parameters

mixed $var 検査対象の値

static intValue

line 56

static int intValue(mixed $value, [int $min = null], [int $max = null])

指定された値を整数に変換します.

この関数は変換処理に intval() を利用します.

最小値が指定されている場合, 変換後の値が最小値より小さければ最小値を返します.

最小値と最大値の両方が指定されている場合, 変換後の値が最大値より大きければ最大値を返します.

最小値が最大値より大きい場合, 最大値の指定は無視されます. 最大値のみ指定したい場合は, 最小値を NULL にしてください.

引数にオブジェクトが指定された場合は 1 として扱います.

Tags

  • return : 引数を整数に変換した値
  • access : public

Parameters

mixed $value 変換元の値
int $min 最小値 (省略可). 変換後の値がこの値よりも小さい場合は, この値を返す.
int $max 最大値 (省略可). 変換後の値がこの値よりも大きい場合は, この値を返す.

static stringValue

line 90

static string stringValue(mixed $value)

指定された値を文字列型に変換します.

__toString() が定義されているオブジェクトの場合は __toString() の結果, それ以外のオブジェクトはクラス名を返します. リソース型の場合は get_resource_type() にリソース ID を付け足した結果を返します. それ以外は string 型にキャストした結果を返します.

Tags

  • return : 変換後の文字列
  • access : public

Parameters

mixed $value 変換対象の値