CustomLinksTable
extends AppTable
in package
CustomLinksTable
Table of Contents
Properties
- $CustomFields : CustomFieldsTable
- $publishBeginField : string
- 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
- $publishEndField : string
- 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
- $publishStatusField : string
- 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
- $tmpEvents : array<string|int, mixed>
- 一時イベント イベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
- $_View : View
- View
Methods
- addPrefix() : string
- テーブル名にプレフィックスを追加する
- beforeDelete() : mixed
- Before Delete
- beforeSave() : bool|void
- Before Save
- belongsToMany() : BelongsToMany
- Belongs To Many
- changeSort() : bool
- 並び順を変更する
- dispatchLayerEvent() : bool|Event
- イベントを発火
- getConditionAllowPublish() : array<string|int, mixed>
- 公開状態となっているデータを取得するための conditions 値を取得
- getCurentSort() : bool|int|null
- 同じ階層における並び順を取得
- getMax() : int
- 指定フィールドのMAX値を取得する
- getTable() : string
- テーブルを取得
- getUniqueName() : string
- 一意の name を取得する
- getUrlPattern() : array<string|int, mixed>
- コンテンツのURLにマッチする候補を取得する
- implementedEvents() : array<string|int, mixed>
- イベント定義
- initialize() : void
- Initialize
- moveOffset() : EntityInterface|bool
- オフセットを元に関連フィールドを移動する
- offEvent() : mixed
- イベントを一時的にオフにする
- onEvent() : mixed
- 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
- replaceText() : string
- 機種依存文字の変換処理
- setTable() : AppTable
- テーブルをセット
- setTreeScope() : void
- ツリービヘイビアのスコープを設定する
- sortdown() : bool
- 一つ位置を下げる
- sortup() : bool
- 一つ位置を上げる
- updateSort() : mixed
- 並び順を更新する
- validationDefault() : Validator
- Validation Default
Properties
$CustomFields
public
CustomFieldsTable
$CustomFields
$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(mixed $table) : string
$this->getConnection()->config() を利用するとユニットテストで問題が発生するため、BcUtil::getCurrentDbConfig()を利用する
$this->getConnection()->config()を利用すると、 そのテーブルに connection が設定されてしまう。
ユニットテストの dataProvider で、テーブルを初期化する場合、 タイミング的に、接続についてテスト用のエイリアスが設定されていないので、 テスト用の接続ではなく、 default がセットされてしまう。
Parameters
- $table : mixed
Tags
Return values
stringbeforeDelete()
Before Delete
public
beforeDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options) : mixed
Parameters
- $event : EventInterface
- $entity : EntityInterface
- $options : ArrayObject
Tags
beforeSave()
Before Save
public
beforeSave(EventInterface $event, EntityInterface $entity, ArrayObject $options) : bool|void
Parameters
- $event : EventInterface
- $entity : EntityInterface
- $options : ArrayObject
Tags
Return values
bool|voidbelongsToMany()
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
BelongsToManychangeSort()
並び順を変更する
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)
Tags
Return values
booldispatchLayerEvent()
イベントを発火
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|EventgetConditionAllowPublish()
公開状態となっているデータを取得するための conditions 値を取得
public
getConditionAllowPublish() : array<string|int, mixed>
公開状態(初期値:status)、公開開始日(初期値:publish_begin)、公開終了日(初期値:publish_end) の組み合わせてによって配列を生成する。
公開状態が true であったとしても、公開期間が設定されている場合はそちらを優先する。
Tags
Return values
array<string|int, mixed>getCurentSort()
同じ階層における並び順を取得
public
getCurentSort(int $id, int $tableId, int|null $parentId) : bool|int|null
Parameters
- $id : int
- $tableId : int
- $parentId : int|null
Tags
Return values
bool|int|nullgetMax()
指定フィールドのMAX値を取得する
public
getMax(string $field[, array<string|int, mixed> $conditions = [] ]) : int
現在数値フィールドのみ対応
Parameters
- $field : string
- $conditions : array<string|int, mixed> = []
Tags
Return values
intgetTable()
テーブルを取得
public
getTable() : string
プレフィックスを追加する
Tags
Return values
stringgetUniqueName()
一意の name を取得する
public
getUniqueName(string $name, int $tableId) : string
Parameters
- $name : string
- $tableId : int
Tags
Return values
stringgetUrlPattern()
コンテンツのURLにマッチする候補を取得する
public
getUrlPattern(string $url) : array<string|int, mixed>
Parameters
- $url : string
Tags
Return values
array<string|int, mixed>implementedEvents()
イベント定義
public
implementedEvents() : array<string|int, mixed>
scope の設定のため、TreeBehavior より優先度を高くする
Tags
Return values
array<string|int, mixed>initialize()
Initialize
public
initialize(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
Tags
moveOffset()
オフセットを元に関連フィールドを移動する
public
moveOffset(mixed $field, mixed $offset) : EntityInterface|bool
Parameters
- $field : mixed
- $offset : mixed
Tags
Return values
EntityInterface|booloffEvent()
イベントを一時的にオフにする
public
offEvent(string $eventKey) : mixed
Parameters
- $eventKey : string
Tags
onEvent()
一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
public
onEvent(string $eventKey) : mixed
Parameters
- $eventKey : string
Tags
replaceText()
機種依存文字の変換処理
public
replaceText(string $str) : string
内部文字コードがUTF-8である必要がある。 多次元配列には対応していない。
Parameters
- $str : string
-
変換対象文字列
Tags
Return values
string —変換後文字列
setTable()
テーブルをセット
public
setTable(string $table) : AppTable
プレフィックスを追加する
Parameters
- $table : string
Tags
Return values
AppTablesetTreeScope()
ツリービヘイビアのスコープを設定する
public
setTreeScope(int $tableId) : void
Parameters
- $tableId : int
Tags
sortdown()
一つ位置を下げる
public
sortdown(string $id, array<string|int, mixed> $conditions) : bool
Parameters
- $id : string
- $conditions : array<string|int, mixed>
Tags
Return values
boolsortup()
一つ位置を上げる
public
sortup(string $id, array<string|int, mixed> $conditions) : bool
Parameters
- $id : string
- $conditions : array<string|int, mixed>
Tags
Return values
boolupdateSort()
並び順を更新する
public
updateSort(array<string|int, mixed> $customLinks) : mixed
Parameters
- $customLinks : array<string|int, mixed>
Tags
validationDefault()
Validation Default
public
validationDefault(Validator $validator) : Validator
Parameters
- $validator : Validator