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

class wakarana_common

wakaranaクラスとwakarana_configクラスの親クラス。このクラスの関数は全てwakaranaクラスとwakarana_configクラスで使用できる。

wakarana_common::__construct($base_dir=NULL)

指定したフォルダにある設定ファイルをロードする。

$base_dir : wakarana_config.iniのあるフォルダのパス。省略時はcommon.phpのあるフォルダを使用する。

wakarana_common::__get($name)

クラス内呼び出し用変数にクラス外からアクセスされた場合の処理。
ベースディレクトリ、設定ファイル変数値、DB接続については読み出しを許可する。

$name : クラス内変数名

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

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

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

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

◆ wakarana_common::update_base_path($base_dir)

インスタンス変数として保持しているベースフォルダのパスを更新する。
◆クラス内呼び出し専用であり、wakarana_common::__constructにより自動的に実行される。

◆ wakarana_common::connect_db()

wakarana_config.iniの設定に基づき、データベースに接続する。
◆クラス内呼び出し専用であり、wakaranaクラスとwakarana_configクラスはこの関数を自動的に実行する。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。

wakarana_common::begin_transaction()

データベースでトランザクションを開始する。
既に別のトランザクションが実行中の場合、内部的には新規のトランザクションではなくセーブポイントを作成する。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。

wakarana_common::commit_transaction()

データベースで最後に開始したトランザクション(またはセーブポイント)を完了する。
まだ解決していないトランザクションが存在する場合、内部的にはセーブポイントを破棄するのみでコミット処理を行わない。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。

wakarana_common::rollback_transaction()

データベースで最後に開始したトランザクション(またはセーブポイント)での変更内容を取り消す。

返り値 : 成功した場合はTRUE、失敗した場合はFALSEを返す。

◆ wakarana_common::disconnect_db()

データベースとの接続を終了する。
◆クラス内呼び出し専用。

◆ 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::get_config_keys()

wakarana_config.iniの変数名一覧を取得する。

返り値 : wakarana_config.iniの変数名一覧を配列で返す。

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_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::load_email_domain_blacklist()

メールドメインブラックリストがインスタンス変数に読み込まれていなければ、ファイルから読み込む。
◆クラス内呼び出し専用。

wakarana_common::check_email_domain($domain_name)

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

$domain_name : ドメイン名

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

wakarana_common::get_email_domain_blacklist()

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

返り値 : メールドメインブラックリストのドメインを配列で返す。