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

class wakarana_config

Wakaranaが組み込まれたアプリケーション本体のセットアップや設定変更の際に使用するクラス。

定数

wakarana_config::ORIGINAL_CONFIG

wakarana_config.iniの既定値一覧。

関数

wakarana_config::__construct($base_dir=NULL)

ベースフォルダに各種設定ファイル(wakarana_config.ini、wakarana_custom_fields.json、wakarana_email_domain_blacklist.conf)がなければ作成し、wakarana_configインスタンスを生成する。
ベースフォルダが存在しなかった場合や設定ファイルが破損していた場合は例外が発生する。

$base_dir : wakarana_config.iniのある(または作成する)フォルダの相対パスまたは絶対パス。省略時はwakarana_config.phpのあるフォルダを使用する。

◆ wakarana_config::save($update_config_cache=FALSE)

現在の設定値でwakarana_config.iniを上書きする。
◆クラス内呼び出し専用。

$update_config_cache : 設定キャッシュファイルの上書き保存を行うか否か

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

wakarana_config::set_config_value($key, $value, $save_now=TRUE)

wakarana_config.iniの設定値を変更する。
設定キャッシュファイルを使用する設定となっている場合、設定キャッシュファイルの更新も行う。
設定キャッシュファイルを使用する設定から使用しない設定に切り替えた場合は設定キャッシュファイルが削除される。

$key : wakarana_config.iniの項目名
$value : 設定する値
$save_now : FALSEならwakarana_config.iniへの上書きと設定キャッシュファイルの更新は保留する。

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

◆ wakarana_config::initialize_config($config_file_path)

指定されたファイルをwakarana_config.iniの既定値で上書きする。
◆クラス内呼び出し専用。

$config_file_path : 保存先設定ファイルのパス

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

wakarana_config::reset_config()

wakarana_config.iniの設定値を全て既定値に戻す。
ベースフォルダ内に設定キャッシュファイルが存在する場合、そのファイルは削除される。

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

wakarana_config::generate_dummy_password_hash()

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

返り値 : ダミーパスワードをハッシュ化した文字列を返す。

◆ wakarana_config::save_custom_fields($update_config_cache=FALSE)

現在の設定値でwakarana_custom_fields.jsonを上書きする。
◆クラス内呼び出し専用。

$update_config_cache : 設定キャッシュファイルの上書き保存を行うか否か

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

wakarana_config::create_custom_field($custom_field_name, $maximum_length=500, $records_per_user=1, $allow_nonunique_value=TRUE, $trigger_user_last_updated=TRUE, $save_now=TRUE)

文字列型カスタムフィールドを追加する。
既に存在するカスタムフィールド名を指定した場合はその設定を上書きする。
設定キャッシュファイルを使用する設定となっている場合、設定キャッシュファイルの更新も行う。

$custom_field_name : カスタムフィールド名。半角英数字及びアンダーバーが使用可能。
$maximum_length : 保存可能な最大文字数(500以下)
$records_per_user : ユーザーあたりの上限件数(100以下)
$allow_nonunique_value : 異なるユーザーが同一の値を持つことを認めるか否か
$trigger_user_last_updated : 値の変更時にユーザー情報の更新日時も更新するか否か
$save_now : FALSEならwakarana_custom_fields.jsonへの上書きと設定キャッシュファイルの更新は保留する

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

wakarana_config::create_custom_numerical_field($custom_field_name, $precision=0, $records_per_user=1, $allow_nonunique_value=TRUE, $trigger_user_last_updated=TRUE, $save_now=TRUE)

数値型カスタムフィールドを追加する。
既に存在するカスタムフィールド名を指定した場合はその設定を上書きする。
設定キャッシュファイルを使用する設定となっている場合、設定キャッシュファイルの更新も行う。

$custom_field_name : カスタムフィールド名。半角英数字及びアンダーバーが使用可能。
$precision : 値の小数点以下の桁数(整数値とする場合は0)
$records_per_user : ユーザーあたりの上限件数(100以下)
$allow_nonunique_value : 異なるユーザーが同一の値を持つことを認めるか否か
$trigger_user_last_updated : 値の変更時にユーザー情報の更新日時も更新するか否か
$save_now : FALSEならwakarana_custom_fields.jsonへの上書きと設定キャッシュファイルの更新は保留する

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

wakarana_config::delete_custom_field($custom_field_name, $save_now=TRUE)

カスタムフィールドを削除する。
この関数により既にデータベースに保存されている当該カスタムフィールドのデータが削除されるわけではない。
設定キャッシュファイルを使用する設定となっている場合、設定キャッシュファイルの更新も行う。

$custom_field_name : カスタムフィールド名
$save_now : FALSEならwakarana_custom_fields.jsonへの上書きと設定キャッシュファイルの更新は保留する。

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

wakarana_config::delete_config_cache()

ベースフォルダ内に存在する設定キャッシュファイル(wakarana_integrated_config_cache.php)を削除する。

返り値 : 成功した場合はTRUEを返す。削除対象のファイルが存在しない場合はNULLを返し、削除に失敗した場合はFALSEを返す。

◆ wakarana_config::save_email_domain_blacklist()

メールドメインブラックリストを上書き保存する。
◆クラス内呼び出し専用。

wakarana_config::add_email_domain_to_blacklist($damain_name, $save_now=TRUE)

ドメインをメールドメインブラックリストに追加する。

$domain_name : ブラックリストに追加するドメイン名
$save_now : FALSEならwakarana_email_domain_blacklist.confへの上書きは保留する。

返り値 : 成功した場合はTRUE、既にブラックリストに登録されているドメインだった場合はNULLを返し、メールドメインに使用できない文字列だった場合や失敗した場合はFALSEを返す。

wakarana_config::remove_email_domain_from_blacklist($damain_name)

ドメインをメールドメインブラックリストから除外する。

$domain_name : ブラックリストから除外するドメイン名

返り値 : 成功した場合はTRUE、もとからブラックリストに登録されていないドメインだった場合や失敗した場合はFALSEを返す。

wakarana_config::merge_email_domain_blacklists($damain_names)

複数のドメインをまとめてメールドメインブラックリストに追加する。
既にブラックリストに登録されているドメインや、ドメイン名として無効な文字列が含まれていた場合、それらは無視される。

$domain_names : ドメイン名が1行に1つずつ記載された文字列

返り値 : 成功した場合はブラックリストに追加されたドメインの数を返し、失敗した場合はFALSEを返す。

wakarana_config::clear_email_domain_blacklist($save_now=TRUE)

メールドメインブラックリストの内容を全て削除する。

$save_now : FALSEならwakarana_email_domain_blacklist.confへの上書きは保留する。

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

wakarana_config::replace_email_domain_blacklist($damain_names)

既存のメールドメインブラックリストを削除し、新しいブラックリストで置き換える。
新しいブラックリストの記載内容のうち、ドメイン名として無効な文字列は自動的に除外される。

$domain_names : ドメイン名が1行に1つずつ記載された文字列

返り値 : 成功した場合は新しいブラックリストに登録されたドメインの数を返し、失敗した場合はFALSEを返す。

wakarana_config::rebuild_user_permission_caches()

全ユーザーが保有する全ての権限のキャッシュを一度削除してから再生成する。

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

wakarana_config::rebuild_user_permitted_value_caches()

全ユーザーが保有する全ての権限値のキャッシュを一度削除してから再生成する。

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

wakarana_config::setup_db()

データベースにテーブルを作成する。
SQLiteを使用する設定の場合、データベースファイルの作成も行われる。
作成されたテーブルには初期情報(ベースロールと特権管理者ロールの基本情報)が格納される。

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