SiteConfigsTable
extends AppTable
in package
Uses
BcEventDispatcherTrait
Class SiteConfig
システム設定モデル
Table of Contents
- $publishBeginField : string
- 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
- $publishEndField : string
- 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
- $publishStatusField : string
- 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
- $tmpEvents : array<string|int, mixed>
- 一時イベント イベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
- $_View : View
- View
- addPrefix() : string
- テーブル名にプレフィックスを追加する
- alphaNumeric() : bool
- 英数チェック
- belongsToMany() : BelongsToMany
- Belongs To Many
- between() : mixed
- 範囲を指定しての長さチェック
- cakeError() : mixed
- Used to report user friendly errors.
- changeSort() : bool
- 並び順を変更する
- convertEncodingByArray() : array<string|int, mixed>
- 配列の文字コードを変換する
- deconstruct() : mixed
- Deconstructs a complex data type (array or object) into a single field value.
- dispatchLayerEvent() : bool|Event
- イベントを発火
- getConditionAllowPublish() : array<string|int, mixed>
- 公開状態となっているデータを取得するための conditions 値を取得
- getControlSource() : mixed
- コントロールソースを取得する
- getMax() : int
- 指定フィールドのMAX値を取得する
- getTable() : string
- テーブルを取得
- getUrlPattern() : array<string|int, mixed>
- コンテンツのURLにマッチする候補を取得する
- initialize() : void
- Initialize
- isChange() : bool
- 指定したフィールドの値がDBのデータと比較して変更状態か確認
- isChangedContentsSortLastModified() : bool
- コンテンツ一覧を表示してから、コンテンツの並び順が変更されていないかどうか 60秒をブラウザのロード時間を加味したバッファとする
- newEntity() : SiteConfig
- offEvent() : mixed
- イベントを一時的にオフにする
- onEvent() : mixed
- 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
- reduceAssociations() : void
- 指定したモデル以外のアソシエーションを除外する
- replaceText() : string
- 機種依存文字の変換処理
- resetContentsSortLastModified() : bool
- コンテンツ並び替え順変更時間をリセットする
- saveValue() : BcKeyValueBehavior
- setTable() : AppTable
- テーブルをセット
- sortdown() : bool
- 一つ位置を下げる
- sortup() : bool
- 一つ位置を上げる
- updateContentsSortLastModified() : bool
- コンテンツ並び順変更時間を更新する
- validationDefault() : Validator
- Validation Default
- validationKeyValue() : Validator
- Validation Key Value
Properties
$publishBeginField
公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
public
string
$publishBeginField
= 'publish_begin'
$publishEndField
公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
public
string
$publishEndField
= 'publish_end'
$publishStatusField
公開状態のフィールド AppTable::getConditionAllowPublish() で利用
public
string
$publishStatusField
= 'status'
$tmpEvents
一時イベント イベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
public
array<string|int, mixed>
$tmpEvents
= []
$_View
View
protected
View
$_View
Methods
addPrefix()
テーブル名にプレフィックスを追加する
public
addPrefix( $table) : string
$this->getConnection()->config() を利用するとユニットテストで問題が発生するため、BcUtil::getCurrentDbConfig()を利用する
$this->getConnection()->config()を利用すると、 そのテーブルに connection が設定されてしまう。
ユニットテストの dataProvider で、テーブルを初期化する場合、 タイミング的に、接続についてテスト用のエイリアスが設定されていないので、 テスト用の接続ではなく、 default がセットされてしまう。
Parameters
Tags
Return values
string —alphaNumeric()
英数チェック
public
static alphaNumeric(string $value) : bool
Parameters
- $value : string
-
チェック対象文字列
Return values
bool —belongsToMany()
Belongs To Many
public
belongsToMany(string $associated[, array<string|int, mixed> $options = [] ]) : BelongsToMany
joinTable にプレフィックスを追加
Parameters
- $associated : string
- $options : array<string|int, mixed> = []
Tags
Return values
BelongsToMany —between()
範囲を指定しての長さチェック
public
between(mixed $check, int $min, int $max) : mixed
Parameters
- $check : mixed
-
対象となる値
- $min : int
-
値の最短値
- $max : int
-
値の最長値
Return values
mixed —cakeError()
Used to report user friendly errors.
public
cakeError(string $method[, array<string|int, mixed> $messages = [] ]) : mixed
If there is a file app/error.php or app/app_error.php this file will be loaded error.php is the AppError class it should extend ErrorHandler class.
Parameters
- $method : string
-
Method to be called in the error class (AppError or ErrorHandler classes)
- $messages : array<string|int, mixed> = []
-
Message that is to be displayed by the error class
Return values
mixed —changeSort()
並び順を変更する
public
changeSort(string $id, int $offset[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $id : string
- $offset : int
- $options : array<string|int, mixed> = []
-
- conditions: データ取得条件
- sortFieldName: ソートフィールドのカラム名 (初期値: sort)
Return values
bool —convertEncodingByArray()
配列の文字コードを変換する
public
convertEncodingByArray(array<string|int, mixed> $data, string $outenc, string $inenc) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
変換前のデータ
- $outenc : string
-
変換後の文字コード
- $inenc : string
-
変換元の文字コード
Tags
Return values
array<string|int, mixed> —変換後のデータ
deconstruct()
Deconstructs a complex data type (array or object) into a single field value.
public
deconstruct(string $field, mixed $data) : mixed
Parameters
- $field : string
-
The name of the field to be deconstructed
- $data : mixed
-
An array or object to be deconstructed into a field
Return values
mixed —The resulting data that should be assigned to a field
dispatchLayerEvent()
イベントを発火
public
dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
- $name : string
- $data : array<string|int, mixed> = []
- $options : mixed = []
Tags
Return values
bool|Event —getConditionAllowPublish()
公開状態となっているデータを取得するための conditions 値を取得
public
getConditionAllowPublish() : array<string|int, mixed>
公開状態(初期値:status)、公開開始日(初期値:publish_begin)、公開終了日(初期値:publish_end) の組み合わせてによって配列を生成する。
公開状態が true であったとしても、公開期間が設定されている場合はそちらを優先する。
Tags
Return values
array<string|int, mixed> —getControlSource()
コントロールソースを取得する
public
getControlSource(string $field) : mixed
Parameters
- $field : string
Tags
Return values
mixed —array|false
getMax()
指定フィールドのMAX値を取得する
public
getMax(string $field[, array<string|int, mixed> $conditions = [] ]) : int
現在数値フィールドのみ対応
Parameters
- $field : string
- $conditions : array<string|int, mixed> = []
Tags
Return values
int —getTable()
テーブルを取得
public
getTable() : string
プレフィックスを追加する
Tags
Return values
string —getUrlPattern()
コンテンツのURLにマッチする候補を取得する
public
getUrlPattern(string $url) : array<string|int, mixed>
Parameters
- $url : string
Tags
Return values
array<string|int, mixed> —initialize()
Initialize
public
initialize(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
-
テーブル設定
Tags
Return values
void —isChange()
指定したフィールドの値がDBのデータと比較して変更状態か確認
public
isChange(string $field, string $value) : bool
Parameters
- $field : string
-
フィールド名
- $value : string
-
値
Tags
Return values
bool —isChangedContentsSortLastModified()
コンテンツ一覧を表示してから、コンテンツの並び順が変更されていないかどうか 60秒をブラウザのロード時間を加味したバッファとする
public
isChangedContentsSortLastModified( $listDisplayed) : bool
Parameters
Tags
Return values
bool —newEntity()
public
newEntity(mixed $data, array<string|int, mixed> $options = []) : SiteConfig
Parameters
- $data : mixed
- $options = [] : array<string|int, mixed>
Return values
SiteConfig —offEvent()
イベントを一時的にオフにする
public
offEvent(string $eventKey) : mixed
Parameters
- $eventKey : string
Return values
mixed —onEvent()
一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
public
onEvent(string $eventKey) : mixed
Parameters
- $eventKey : string
Tags
Return values
mixed —reduceAssociations()
指定したモデル以外のアソシエーションを除外する
public
reduceAssociations(mixed $arguments[, bool $reset = true ]) : void
Parameters
- $arguments : mixed
- $reset : bool = true
-
バインド時に1回の find でリセットするかどうか
Return values
void —replaceText()
機種依存文字の変換処理
public
replaceText(mixed $str) : string
内部文字コードがUTF-8である必要がある。 多次元配列には対応していない。
Parameters
- $str : mixed
Tags
Return values
string —変換後文字列
resetContentsSortLastModified()
コンテンツ並び替え順変更時間をリセットする
public
resetContentsSortLastModified() : bool
Tags
Return values
bool —saveValue()
public
saveValue(mixed $key, mixed $value) : BcKeyValueBehavior
Parameters
- $key : mixed
- $value : mixed
Return values
BcKeyValueBehavior —setTable()
テーブルをセット
public
setTable(string $table) : AppTable
プレフィックスを追加する
Parameters
- $table : string
Tags
Return values
AppTable —sortdown()
一つ位置を下げる
public
sortdown(string $id, array<string|int, mixed> $conditions) : bool
Parameters
- $id : string
- $conditions : array<string|int, mixed>
Return values
bool —sortup()
一つ位置を上げる
public
sortup(string $id, array<string|int, mixed> $conditions) : bool
Parameters
- $id : string
- $conditions : array<string|int, mixed>
Return values
bool —updateContentsSortLastModified()
コンテンツ並び順変更時間を更新する
public
updateContentsSortLastModified() : bool
Tags
Return values
bool —validationDefault()
Validation Default
public
validationDefault(Validator $validator) : Validator
Parameters
- $validator : Validator
Tags
Return values
Validator —validationKeyValue()
Validation Key Value
public
validationKeyValue(Validator $validator) : Validator
Parameters
- $validator : Validator