IntlChar::getPropertyEnum

プロパティの名前に対応する定数値を取得する

説明

public static int IntlChar::getPropertyEnum(string $alias)

指定されたプロパティの名前に対応する、プロパティの定数値を返します。これは、Unicode のデータベースファイル PropertyAliases.txt に存在するものです。短縮名や長い名前、その他の名前も認識します。

さらに、この関数はプロパティ IntlChar::PROPERTY_GENERAL_CATEGORY_MASK を仮想の名前 "gcm" / "General_Category_Mask" に対応させています。これらの名前は、PropertyAliases.txt には存在しません。

この関数は、 IntlChar::getPropertyName を補完するものです。

パラメータ

alias: マッチさせるプロパティの名前。 PropertyAliases.txt で説明されている "loose matching" を使って比較されます。

戻り値

IntlChar::PROPERTY_ で始まる定数値を返します。指定した名前が、どのプロパティにもマッチしない場合は IntlChar::PROPERTY_INVALID_CODE を返します。

例

例1 さまざまなプロパティの例

<?php
var_dump(IntlChar::getPropertyEnum('Bidi_Class') === IntlChar::PROPERTY_BIDI_CLASS);
var_dump(IntlChar::getPropertyEnum('script') === IntlChar::PROPERTY_SCRIPT);
var_dump(IntlChar::getPropertyEnum('IDEOGRAPHIC') === IntlChar::PROPERTY_IDEOGRAPHIC);
var_dump(IntlChar::getPropertyEnum('Some made-up string') === IntlChar::PROPERTY_INVALID_CODE);
?>

上の例の出力は以下となります。

bool(true)
bool(true)
bool(true)
bool(true)

参考

IntlChar::getPropertyName