いくつかのクラスでいくつかのCONSTが定義されており、それらのリストを取得したいです。例えば:
_class Profile {
const LABEL_FIRST_NAME = "First Name";
const LABEL_LAST_NAME = "Last Name";
const LABEL_COMPANY_NAME = "Company";
}
_
Profile
クラスで定義されたCONSTのリストを取得する方法はありますか?私が知る限り、最も近いオプション(get_defined_constants()
)はトリックを行いません。
実際に必要なのは、定数名のリストです。次のようなものです。
_array('LABEL_FIRST_NAME',
'LABEL_LAST_NAME',
'LABEL_COMPANY_NAME')
_
または:
_array('Profile::LABEL_FIRST_NAME',
'Profile::LABEL_LAST_NAME',
'Profile::LABEL_COMPANY_NAME')
_
あるいは:
_array('Profile::LABEL_FIRST_NAME'=>'First Name',
'Profile::LABEL_LAST_NAME'=>'Last Name',
'Profile::LABEL_COMPANY_NAME'=>'Company')
_
これには Reflection を使用できます。これを頻繁に行う場合は、結果のキャッシュを確認することをお勧めします。
<?php
class Profile {
const LABEL_FIRST_NAME = "First Name";
const LABEL_LAST_NAME = "Last Name";
const LABEL_COMPANY_NAME = "Company";
}
$refl = new ReflectionClass('Profile');
print_r($refl->getConstants());
出力:
Array
(
'LABEL_FIRST_NAME' => 'First Name',
'LABEL_LAST_NAME' => 'Last Name',
'LABEL_COMPANY_NAME' => 'Company'
)
$reflector = new ReflectionClass('Status');
var_dump($reflector->getConstants());
token_get_all() を使用します。すなわち:
<?php
header('Content-Type: text/plain');
$file = file_get_contents('Profile.php');
$tokens = token_get_all($file);
$const = false;
$name = '';
$constants = array();
foreach ($tokens as $token) {
if (is_array($token)) {
if ($token[0] != T_WHITESPACE) {
if ($token[0] == T_CONST && $token[1] == 'const') {
$const = true;
$name = '';
} else if ($token[0] == T_STRING && $const) {
$const = false;
$name = $token[1];
} else if ($token[0] == T_CONSTANT_ENCAPSED_STRING && $name) {
$constants[$name] = $token[1];
$name = '';
}
}
} else if ($token != '=') {
$const = false;
$name = '';
}
}
foreach ($constants as $constant => $value) {
echo "$constant = $value\n";
}
?>
出力:
LABEL_FIRST_NAME = "First Name"
LABEL_LAST_NAME = "Last Name"
LABEL_COMPANY_NAME = "Company"
PHP5では、Reflectionを使用できます。 (手動参照)
$class = new ReflectionClass('Profile');
$consts = $class->getConstants();
ReflectionClass(PHP 5)を使用できる場合は、PHP docsコメントを参照):
function GetClassConstants($sClassName) {
$oClass = new ReflectionClass($sClassName);
return $oClass->getConstants();
}
ReflectionClassと getConstants()
を使用すると、まさに必要なものが得られます。
<?php
class Cl {
const AAA = 1;
const BBB = 2;
}
$r = new ReflectionClass('Cl');
print_r($r->getConstants());
出力:
Array
(
[AAA] => 1
[BBB] => 2
)
ええ、あなたは reflection を使います。の出力を見てください
<?
Reflection::export(new ReflectionClass('YourClass'));
?>
それはあなたがあなたが見ているもののアイデアを与えるはずです。
静的関数でTraitsを使用してクラスの機能を拡張するのに最適な場所のようです。また、トレイトを使用すると、同じコードを何度も書き換えることなく、他のクラスにこの機能を実装できます(DRYのまま)。
Profileクラスでカスタムの 'ConstantExport'特性を使用します。この機能が必要なすべてのクラスに対して実行してください。
/**
* ConstantExport Trait implements getConstants() method which allows
* to return class constant as an assosiative array
*/
Trait ConstantExport
{
/**
* @return [const_name => 'value', ...]
*/
static function getConstants(){
$refl = new \ReflectionClass(__CLASS__);
return $refl->getConstants();
}
}
Class Profile
{
const LABEL_FIRST_NAME = "First Name";
const LABEL_LAST_NAME = "Last Name";
const LABEL_COMPANY_NAME = "Company";
use ConstantExport;
}
使用例
// So simple and so clean
$constList = Profile::getConstants();
print_r($constList); // TEST
出力:
Array
(
[LABEL_FIRST_NAME] => First Name
[LABEL_LAST_NAME] => Last Name
[LABEL_COMPANY_NAME] => Company
)
クラス内に独自の定数を返すメソッドを用意すると便利です。
次の方法で行うことができます。
class Profile {
const LABEL_FIRST_NAME = "First Name";
const LABEL_LAST_NAME = "Last Name";
const LABEL_COMPANY_NAME = "Company";
public static function getAllConsts() {
return (new ReflectionClass(get_class()))->getConstants();
}
}
// test
print_r(Profile::getAllConsts());
そもそもそれらを配列としてクラス変数に入れてみませんか?ループスルーが簡単になります。
private $_data = array("production"=>0 ...);
最終的に名前空間で:
namespaces enums;
class enumCountries
{
const CountryAustria = 1 ;
const CountrySweden = 24;
const CountryUnitedKingdom = 25;
}
namespace Helpers;
class Helpers
{
static function getCountries()
{
$c = new \ReflectionClass('\enums\enumCountries');
return $c->getConstants();
}
}
print_r(\Helpers\Helpers::getCountries());
Class Qwerty
{
const __COOKIE_LANG_NAME__ = "zxc";
const __UPDATE_COOKIE__ = 30000;
// [1]
public function getConstants_(){
return ['__COOKIE_LANG_NAME__' => self::__COOKIE_LANG_NAME__,
'__UPDATE_COOKIE__' => self::__UPDATE_COOKIE__];
}
// [2]
static function getConstantsStatic_(){
return ['__COOKIE_LANG_NAME__' => self::__COOKIE_LANG_NAME__,
'__UPDATE_COOKIE__' => self::__UPDATE_COOKIE__];
}
}
// [1]
$objC = new Qwerty();
var_dump($objC->getConstants_());
// [2]
var_dump(Qwerty::getConstantsStatic_());