baserCMS クラスリファレンス

CustomEntriesTable extends AppTable
in package

Application

Uses BcEventDispatcherTrait, BcContainerTrait

CustomEntriesTable

$CustomTables : CustomTablesTable
$links : null|ResultSet: 関連フィールド一覧
$publishBeginField : string: 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
$publishEndField : string: 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
$publishStatusField : string: 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
$tableId : null|int: Custom Table Id
$tmpEvents : array<string|int, mixed>: 一時イベントイベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
$_View : View: View
addPrefix() : string: テーブル名にプレフィックスを追加する
alphaNumeric() : bool: 英数チェック
autoConvert() : ArrayObject: エンティティの配列データの自動変換処理
beforeMarshal() : mixed: Before Marshal
belongsToMany() : BelongsToMany: Belongs To Many
between() : mixed: 範囲を指定しての長さチェック
cakeError() : mixed: Used to report user friendly errors.
changeSort() : bool: 並び順を変更する
convertEncodingByArray() : array<string|int, mixed>: 配列の文字コードを変換する
createSearchDetail() : string: カスタムコンテンツの検索インデックスの詳細を生成する
createSearchIndex() : array<string|int, mixed>|false: 検索インデックスを生成する
decodeRow() : EntityInterface: エンティティのJSON化したフィールドをデコードして返す
deconstruct() : mixed: Deconstructs a complex data type (array or object) into a single field value.
dispatchLayerEvent() : bool|Event: イベントを発火
findAll() : Query: Find all
getConditionAllowPublish() : array<string|int, mixed>: 公開状態となっているデータを取得するための conditions 値を取得
getControlSource() : array<string|int, mixed>: コントロールソースを取得する
getMax() : int: 指定フィールドのMAX値を取得する
getService() : array<string|int, mixed>|mixed|object: Get Service
getTable() : string: テーブルを取得
getTableName() : string: カスタムエントリーのテーブル名を取得する
getUrlPattern() : array<string|int, mixed>: コンテンツのURLにマッチする候補を取得する
hasService() : bool: Has Service
initialize() : void: Initialize
isJson() : bool: JSON データかどうかを判定する
offEvent() : mixed: イベントを一時的にオフにする
onEvent() : mixed: 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
reduceAssociations() : void: 指定したモデル以外のアソシエーションを除外する
replaceText() : string: 機種依存文字の変換処理
setLinks() : mixed: メールフィールドを取得してセットする。
setTable() : AppTable: テーブルをセット
setUp() : bool: カスタムエントリーテーブルのセットアップを行う
setupValidate() : mixed: バリデーションを設定する
setUseTable() : mixed: テーブル名を設定する
setValidateDatetime() : Validator: 日付チェックをセットする
setValidateEmail() : Validator: Eメールチェックをセットする
setValidateEmailConfirm() : Validator: Eメール比較バリデーションをセットアップする
setValidateFileExt() : Validator: ファイル拡張子バリデーションをセットアップする
setValidateHankaku() : Validator: 半角チェックをセットする
setValidateMaxFileSize() : Validator: ファイルアップロード上限バリデーションをセットアップする
setValidateNumber() : Validator: 数値チェックをセットする
setValidateRegex() : Validator: 正規表現のバリデーションをセットアップする
setValidateZenkakuHiragana() : Validator: 全角ひらがなチェックをセットする
setValidateZenkakuKatakana() : Validator: 全角カタカナチェックをセットする
sortdown() : bool: 一つ位置を下げる
sortup() : bool: 一つ位置を上げる
validationDefault() : Validator: デフォルトのバリデーションを設定する

$CustomTables


    public
        CustomTablesTable
    $CustomTables

$links

$publishBeginField

公開開始日のフィールド AppTable::getConditionAllowPublish() で利用


    public
        string
    $publishBeginField
     = 'publish_begin'

$publishEndField

公開終了日のフィールド AppTable::getConditionAllowPublish() で利用


    public
        string
    $publishEndField
     = 'publish_end'

$publishStatusField

公開状態のフィールド AppTable::getConditionAllowPublish() で利用


    public
        string
    $publishStatusField
     = 'status'

$tableId

Custom Table Id


    public
        null|int
    $tableId
     = null

$tmpEvents

一時イベントイベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する


    public
        array<string|int, mixed>
    $tmpEvents
     = []

$_View

View


    protected
        View
    $_View

addPrefix()

テーブル名にプレフィックスを追加する


    public
                    addPrefix( $table) : string

$this->getConnection()->config() を利用するとユニットテストで問題が発生するため、BcUtil::getCurrentDbConfig()を利用する

$this->getConnection()->config()を利用すると、そのテーブルに connection が設定されてしまう。

ユニットテストの dataProvider で、テーブルを初期化する場合、タイミング的に、接続についてテスト用のエイリアスが設定されていないので、テスト用の接続ではなく、 default がセットされてしまう。

Parameters

$table :

Return values

string —

alphaNumeric()

英数チェック


    public
            static        alphaNumeric(string $value) : bool

Parameters

$value : string: チェック対象文字列

Return values

bool —

autoConvert()

エンティティの配列データの自動変換処理


    public
                    autoConvert(ArrayObject $content) : ArrayObject

Parameters

$content : ArrayObject

Return values

ArrayObject —

beforeMarshal()

Before Marshal


    public
                    beforeMarshal(EventInterface $event, ArrayObject $content, ArrayObject $options) : mixed

Parameters

$event : EventInterface
$content : ArrayObject
$options : ArrayObject

Return values

mixed —

belongsToMany()

Belongs To Many


    public
                    belongsToMany(string $associated[, array<string|int, mixed> $options = [] ]) : BelongsToMany

joinTable にプレフィックスを追加

Parameters

$associated : string
$options : array<string|int, mixed> = []

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: 変換元の文字コード

Return values

array<string|int, mixed> —

変換後のデータ

createSearchDetail()

カスタムコンテンツの検索インデックスの詳細を生成する


    public
                    createSearchDetail(CustomEntry $entity) : string

Parameters

$entity : CustomEntry

Return values

string —

createSearchIndex()

検索インデックスを生成する


    public
                    createSearchIndex(CustomEntry $entry) : array<string|int, mixed>|false

Parameters

$entry : CustomEntry

Return values

array<string|int, mixed>|false —

decodeRow()

エンティティのJSON化したフィールドをデコードして返す


    public
                    decodeRow(EntityInterface $row) : EntityInterface

Parameters

$row : EntityInterface

Return values

EntityInterface —

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 = []

Return values

bool|Event —

findAll()

Find all


    public
                    findAll(Query $query[, array<string|int, mixed> $options = [] ]) : Query

JSON データをデコードする

Parameters

$query : Query
$options : array<string|int, mixed> = []

Return values

Query —

getConditionAllowPublish()

公開状態となっているデータを取得するための conditions 値を取得


    public
                    getConditionAllowPublish() : array<string|int, mixed>

公開状態（初期値：status）、公開開始日（初期値：publish_begin）、公開終了日（初期値：publish_end）の組み合わせてによって配列を生成する。

公開状態が true であったとしても、公開期間が設定されている場合はそちらを優先する。

Return values

array<string|int, mixed> —

getControlSource()

コントロールソースを取得する


    public
                    getControlSource( $field) : array<string|int, mixed>

継承先でオーバーライドする事

Parameters

$field :

Return values

array<string|int, mixed> —

getMax()

指定フィールドのMAX値を取得する


    public
                    getMax(string $field[, array<string|int, mixed> $conditions = [] ]) : int

現在数値フィールドのみ対応

Parameters

$field : string
$conditions : array<string|int, mixed> = []

Return values

int —

getService()

Get Service


    public
                    getService( $service) : array<string|int, mixed>|mixed|object

Parameters

$service :

Return values

array<string|int, mixed>|mixed|object —

getTable()

テーブルを取得


    public
                    getTable() : string

プレフィックスを追加する

Return values

string —

getTableName()

カスタムエントリーのテーブル名を取得する


    public
                    getTableName(int $tableId[, string $name = '' ]) : string

Parameters

$tableId : int
$name : string = ''

Return values

string —

getUrlPattern()

コンテンツのURLにマッチする候補を取得する


    public
                    getUrlPattern(string $url) : array<string|int, mixed>

Parameters

$url : string

Return values

array<string|int, mixed> —

hasService()

Has Service


    public
                    hasService( $service) : bool

Parameters

$service :

Return values

bool —

initialize()

Initialize


    public
                    initialize(array<string|int, mixed> $config) : void

Parameters

$config : array<string|int, mixed>

Return values

void —

isJson()

JSON データかどうかを判定する


    public
                    isJson(string $string) : bool

Parameters

$string : string

Return values

bool —

offEvent()

イベントを一時的にオフにする


    public
                    offEvent(string $eventKey) : mixed

Parameters

$eventKey : string

Return values

mixed —

onEvent()

一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする


    public
                    onEvent(string $eventKey) : mixed

Parameters

$eventKey : string

Return values

mixed —

reduceAssociations()

指定したモデル以外のアソシエーションを除外する


    public
                    reduceAssociations(mixed $arguments[, bool $reset = true ]) : void

Parameters

$arguments : mixed
$reset : bool = true: バインド時に１回の find でリセットするかどうか

Return values

void —

replaceText()

機種依存文字の変換処理


    public
                    replaceText(mixed $str) : string

内部文字コードがUTF-8である必要がある。多次元配列には対応していない。

Parameters

$str : mixed

Return values

string —

変換後文字列

setLinks()

メールフィールドを取得してセットする。


    public
                    setLinks(int $tableId) : mixed

Parameters

$tableId : int

Return values

mixed —

setTable()

テーブルをセット


    public
                    setTable(string $table) : AppTable

プレフィックスを追加する

Parameters

$table : string

Return values

AppTable —

setUp()

カスタムエントリーテーブルのセットアップを行う


    public
                    setUp(int $tableId[, array<string|int, mixed> $postData = [] ]) : bool

Parameters

$tableId : int
$postData : array<string|int, mixed> = []

Return values

bool —

setupValidate()

バリデーションを設定する


    public
                    setupValidate([array<string|int, mixed> $postData = [] ]) : mixed

Parameters

$postData : array<string|int, mixed> = []

Return values

mixed —

setUseTable()

テーブル名を設定する


    public
                    setUseTable(int $tableId) : mixed

Parameters

$tableId : int

Return values

mixed —

setValidateDatetime()

日付チェックをセットする


    public
                    setValidateDatetime(Validator $validator, CustomLink $link, array<string|int, mixed> $postData) : Validator

Parameters

$validator : Validator
$link : CustomLink
$postData : array<string|int, mixed>

Return values

Validator —

setValidateEmail()

Eメールチェックをセットする


    public
                    setValidateEmail(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateEmailConfirm()

Eメール比較バリデーションをセットアップする


    public
                    setValidateEmailConfirm(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateFileExt()

ファイル拡張子バリデーションをセットアップする


    public
                    setValidateFileExt(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateHankaku()

半角チェックをセットする


    public
                    setValidateHankaku(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateMaxFileSize()

ファイルアップロード上限バリデーションをセットアップする


    public
                    setValidateMaxFileSize(Validator $validator, CustomLink $link, array<string|int, mixed> $postData) : Validator

Parameters

$validator : Validator
$link : CustomLink
$postData : array<string|int, mixed>

Return values

Validator —

setValidateNumber()

数値チェックをセットする


    public
                    setValidateNumber(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateRegex()

正規表現のバリデーションをセットアップする


    public
                    setValidateRegex(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateZenkakuHiragana()

全角ひらがなチェックをセットする


    public
                    setValidateZenkakuHiragana(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

setValidateZenkakuKatakana()

全角カタカナチェックをセットする


    public
                    setValidateZenkakuKatakana(Validator $validator, CustomLink $link) : Validator

Parameters

$validator : Validator
$link : CustomLink

Return values

Validator —

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 —

validationDefault()

デフォルトのバリデーションを設定する


    public
                    validationDefault(Validator $validator) : Validator

Parameters

$validator : Validator

Return values

Validator —

CustomEntriesTable extends AppTable in package Application Uses BcEventDispatcherTrait, BcContainerTrait

Table of Contents

Properties

$CustomTables

$links

$publishBeginField

$publishEndField

$publishStatusField

$tableId

$tmpEvents

$_View

Methods

addPrefix()

Parameters

Tags

Return values

alphaNumeric()

Parameters

Return values

autoConvert()

Parameters

Return values

beforeMarshal()

Parameters

Return values

belongsToMany()

Parameters

Tags

Return values

between()

Parameters

Return values

cakeError()

Parameters

Return values

changeSort()

Parameters

Return values

convertEncodingByArray()

Parameters

Tags

Return values

createSearchDetail()

Parameters

Return values

createSearchIndex()

Parameters

Return values

decodeRow()

Parameters

Return values

deconstruct()

Parameters

Return values

dispatchLayerEvent()

Parameters

Tags

Return values

findAll()

Parameters

Return values

getConditionAllowPublish()

Tags

Return values

getControlSource()

Parameters

Return values

getMax()

Parameters

Tags

Return values

getService()

Parameters

Tags

Return values

getTable()

Tags

Return values

getTableName()

Parameters

CustomEntriesTable extends AppTable
in package

Application

Uses BcEventDispatcherTrait, BcContainerTrait