Midari Create > webアプリケーション製品 > Wakarana > 関数マニュアル >

trait wakarana_common

wakaranaクラスとwakarana_configクラスに共通する関数群。このトレイトの関数は全てwakaranaクラスとwakarana_configクラスで使用できる。

関数

◆ wakarana_common::print_error($error_text)

エラーメッセージを出力する。
ただし、wakarana_config.iniにおいてdisplay_errors=trueが設定されていなければ出力しない。
wakaranaクラスのインスタンスとwakarana_configクラスのインスタンスではエラー時にこの関数を実行する。
◆クラス内呼び出し専用。

$error_text : エラーメッセージ

wakarana_common::get_last_error_text()

wakarana_common::print_errorにて直近に入力されたエラーメッセージを返す。

返り値 : エラーメッセージの文字列

☆ wakarana_common::check_id_string($id, $length=60)

文字列に、ユーザーIDやロール名などの識別名として使用できない文字が含まれないか否かを検査する。
☆staticメソッド。

$id : 検査する文字列
$length : 文字列の長さの上限。検査する文字列がこれより長い場合は使用できない文字列とみなす。

返り値 : 識別名として使用可能な文字列ならTRUEを、それ以外の場合はFALSEを返す。

☆ wakarana_common::check_password_strength($password, $min_length=10)

パスワードの強度を確認する。
☆staticメソッド。

$password : パスワード
$min_length : 強いパスワードとみなす最小の文字数

返り値 : パスワードが指定した文字数以上かつ大文字・小文字・数字の全てを含むならTRUE、そうでないならFALSEを返す。

☆ wakarana_common::generate_random_password($length=14)

パスワードとして使用可能な文字列をランダムに生成する。
☆staticメソッド。

$length : 生成するパスワードの文字数。3以上の数値を指定した場合、大文字・小文字・数字の全てを含むパスワードを生成する。

返り値 : 英数字と記号(-と.)からなるランダムな文字列を返す。

wakarana_common::generate_password_hash($password, $salt=NULL)

wakarana_config.iniの設定に従ってパスワードのハッシュ値を計算する。

$password : パスワード
$salt : ソルトとして使用する文字列。ハッシュアルゴリズムとしてArgon2を使用する設定では無視される。

返り値 : パスワードをハッシュ化した文字列を返す。失敗した場合はFALSEを返す。

wakarana_common::get_config_value($key)

wakarana_config.iniの設定値を取得する。

$key : wakarana_config.iniの変数名

返り値 : 指定した変数名が存在すればその設定値、なければNULLを返す。

wakarana_common::get_custom_field_names()

ユーザーデータに追加可能なカスタムフィールド名一覧を取得する。

返り値 : wakarana_custom_fields.jsonのキー一覧を配列で返す。

wakarana_common::get_custom_field_is_numeric($custom_field_name)

指定したカスタムフィールドが数値型か否かを取得する。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在する場合、数値型であればTRUE、文字列型ならFALSEを返す。カスタムフィールド名が存在しなければNULLを返す。

wakarana_common::get_custom_field_maximum_length($custom_field_name)

指定したカスタムフィールドに保存可能な最大文字数を取得する。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在し、文字列型ならばその最大文字数を返す。カスタムフィールド名が存在しないか数値型ならばNULLを返す。

wakarana_common::get_custom_field_precision($custom_field_name)

指定したカスタムフィールドに数値を保存した際に四捨五入されない小数点以下の桁数を取得する。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在し、数値型ならばその小数点以下の桁数(整数値のみを許容する場合は0)を返す。カスタムフィールド名が存在しないか文字列型ならばNULLを返す。

wakarana_common::get_custom_field_records_per_user($custom_field_name)

指定したカスタムフィールドのユーザーあたりの上限件数を取得する。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在すればその上限件数、存在しなければNULLを返す。

wakarana_common::get_custom_field_allow_nonunique_value($custom_field_name)

指定したカスタムフィールドで異なるユーザーが同一の値を持つことができるか否かを返す。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在する場合、一意でない値を持てるならTRUE、持てないならFALSEを返す。カスタムフィールド名が存在しなければNULLを返す。

wakarana_common::get_custom_field_trigger_user_last_updated($custom_field_name)

指定したカスタムフィールドの値が変更されたときにユーザー情報の最終更新日時が更新されるか否かを返す。

$custom_field_name : カスタムフィールド名

返り値 : カスタムフィールド名がwakarana_custom_fields.jsonに存在する場合、そのカスタムフィールドの値が変更されたときにユーザー情報の最終更新日時も更新されるならTRUE、そうでないならFALSEを返す。カスタムフィールド名が存在しなければNULLを返す。

wakarana_common::check_email_domain($domain_name)

指定したドメインがメールドメインブラックリストに含まれないことを確認する。

$domain_name : ドメイン名

返り値 : ドメインがメールドメインブラックリストに含まれない場合はTRUE、含まれればFALSEを返す。

wakarana_common::get_email_domain_blacklist()

メールドメインブラックリストを配列で取得する。

返り値 : メールドメインブラックリストのドメインを配列で返す。メールドメインブラックリストの読み込みに失敗した場合はFALSEを返す。