baserCMS クラスリファレンス

MailContentsTable extends MailAppTable
in package

Application

Uses BcEventDispatcherTrait, BcContainerTrait

メールコンテンツモデル

$actsAs : array<string|int, mixed>: behaviors
$hasMany : array<string|int, mixed>: hasMany
$MailFields : MailFieldsTable
$publishBeginField : string: 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
$publishEndField : string: 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
$publishStatusField : string: 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
$tmpEvents : array<string|int, mixed>: 一時イベントイベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
$_View : View: View
addPrefix() : string: テーブル名にプレフィックスを追加する
afterSave() : void: afterSave
alphaNumeric() : bool: 英数チェック
belongsToMany() : BelongsToMany: Belongs To Many
between() : mixed: 範囲を指定しての長さチェック
cakeError() : mixed: Used to report user friendly errors.
changeSort() : bool: 並び順を変更する
checkSslUrl() : bool: SSL用のURLが設定されているかチェックする
convertEncodingByArray() : array<string|int, mixed>: 配列の文字コードを変換する
copy() : mixed: メールコンテンツデータをコピーする
createSearchIndex() : array<string|int, mixed>|false: 検索用データを生成する
deconstruct() : mixed: Deconstructs a complex data type (array or object) into a single field value.
dispatchLayerEvent() : bool|Event: イベントを発火
findAccepting() : array<string|int, mixed>|null: 公開されたコンテンツを取得する
getConditionAllowAccepting() : array<string|int, mixed>: 公開済の conditions を取得
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: テーブルを取得
getUrlPattern() : array<string|int, mixed>: コンテンツのURLにマッチする候補を取得する
hasService() : bool: Has Service
initialize() : void: Initialize
offEvent() : mixed: イベントを一時的にオフにする
onEvent() : mixed: 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
reduceAssociations() : void: 指定したモデル以外のアソシエーションを除外する
replaceText() : string: 機種依存文字の変換処理
setTable() : AppTable: テーブルをセット
sortdown() : bool: 一つ位置を下げる
sortup() : bool: 一つ位置を上げる
validationDefault() : Validator: Validation Default

$actsAs

behaviors


    public
        array<string|int, mixed>
    $actsAs
     = ['BcSearchIndexManager', 'BcCache', 'BcContents']

$hasMany

hasMany


    public
        array<string|int, mixed>
    $hasMany
     = ['MailField' => ['className' => 'BcMail.MailField', 'order' => 'sort', 'foreignKey' => 'mail_content_id', 'dependent' => true, 'exclusive' => false, 'finderQuery' => '']]

$MailFields


    public
        MailFieldsTable
    $MailFields

$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

addPrefix()

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


    public
                    addPrefix( $table) : string

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

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

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

Parameters

$table :

Return values

string —

afterSave()

afterSave


    public
                    afterSave(mixed $created[, mixed $options = [] ]) : void

Parameters

$created : mixed
$options : mixed = []

Return values

void —

alphaNumeric()

英数チェック


    public
            static        alphaNumeric(array<string|int, mixed> $check) : bool

Parameters

$check : array<string|int, mixed>: チェック対象文字列

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

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 —

checkSslUrl()

SSL用のURLが設定されているかチェックする


    public
                    checkSslUrl(mixed $value) : bool

Parameters

$value : mixed

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> —

変換後のデータ

copy()

メールコンテンツデータをコピーする


    public
                    copy(int $id, int $newParentId, string $newTitle, int $newAuthorId[, int $newSiteId = null ]) : mixed

Parameters

$id : int: ページID
$newParentId : int: 新しい親コンテンツID
$newTitle : string: 新しいタイトル
$newAuthorId : int: 新しいユーザーID
$newSiteId : int = null: 新しいサイトID

Return values

mixed —

mailContent|false

createSearchIndex()

検索用データを生成する


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

Parameters

$data : array<string|int, mixed>

Return values

array<string|int, mixed>|false —

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 —

findAccepting()

公開されたコンテンツを取得する


    public
                    findAccepting([string $type = 'first' ][, array<string|int, mixed> $query = [] ]) : array<string|int, mixed>|null

Parameters

$type : string = 'first'
$query : array<string|int, mixed> = []

Return values

array<string|int, mixed>|null —

getConditionAllowAccepting()

公開済の conditions を取得


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

Return values

array<string|int, mixed> —

公開条件（conditions 形式）

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 —

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 —

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 —

変換後文字列

setTable()

テーブルをセット


    public
                    setTable(string $table) : AppTable

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

Parameters

$table : string

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 —

validationDefault()

Validation Default


    public
                    validationDefault(Validator $validator) : Validator

Parameters

$validator : Validator

Return values

Validator —

MailContentsTable extends MailAppTable in package Application Uses BcEventDispatcherTrait, BcContainerTrait

Table of Contents

Properties

$actsAs

$hasMany

$MailFields

$publishBeginField

$publishEndField

$publishStatusField

$tmpEvents

$_View

Methods

addPrefix()

Parameters

Tags

Return values

afterSave()

Parameters

Return values

alphaNumeric()

Parameters

Return values

belongsToMany()

Parameters

Tags

Return values

between()

Parameters

Return values

cakeError()

Parameters

Return values

changeSort()

Parameters

Return values

checkSslUrl()

Parameters

Return values

convertEncodingByArray()

Parameters

Tags

Return values

copy()

Parameters

Return values

createSearchIndex()

Parameters

Return values

deconstruct()

Parameters

Return values

dispatchLayerEvent()

Parameters

Tags

Return values

findAccepting()

Parameters

Return values

getConditionAllowAccepting()

Return values

getConditionAllowPublish()

Tags

Return values

getControlSource()

Parameters

Return values

getMax()

Parameters

Tags

Return values

getService()

Parameters

Tags

Return values

getTable()

Tags

Return values

getUrlPattern()

Parameters

Tags

MailContentsTable extends MailAppTable
in package

Application

Uses BcEventDispatcherTrait, BcContainerTrait