baserCMS クラスリファレンス

MailMessagesTable extends MailAppTable
in package

Application

メッセージモデル

$mailContent : array<string|int, mixed>: メールコンテンツ情報
$mailFields : ResultSet: メールフォーム情報
$publishBeginField : string: 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
$publishEndField : string: 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
$publishStatusField : string: 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
$tmpEvents : array<string|int, mixed>: 一時イベントイベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
addPrefix() : string: テーブル名にプレフィックスを追加する
afterMarshal() : mixed: After Marshal
alphaNumeric() : bool: 英数チェック
belongsToMany() : BelongsToMany: Belongs To Many
between() : mixed: 範囲を指定しての長さチェック
cakeError() : mixed: Used to report user friendly errors.
changeSort() : bool: 並び順を変更する
convertDatasToMail() : array<string|int, mixed>: メール用に変換する
convertEncodingByArray() : array<string|int, mixed>: 配列の文字コードを変換する
convertMessageToCsv() : array<string|int, mixed>: 受信メッセージの内容を表示状態に変換する
convertToDb() : EntityInterface: データベース用のデータに変換する
createFullTableName() : string: フルテーブル名を生成する
createTableName() : string: テーブル名を生成する int型でなかったら強制終了
deconstruct() : mixed: Deconstructs a complex data type (array or object) into a single field value.
find() : array<string|int, mixed>: find
getConditionAllowPublish() : array<string|int, mixed>: 公開状態となっているデータを取得するための conditions 値を取得
getControlSource() : array<string|int, mixed>: コントロールソースを取得する
getMax() : int: 指定フィールドのMAX値を取得する
getTable() : string: テーブルを取得
getUrlPattern() : array<string|int, mixed>: コンテンツのURLにマッチする候補を取得する
initialize() : void: Initialize method
offEvent() : mixed: イベントを一時的にオフにする
onEvent() : mixed: 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
reconstructionAll() : bool: メール受信テーブルを全て再構築
reduceAssociations() : void: 指定したモデル以外のアソシエーションを除外する
replaceText() : string: 機種依存文字の変換処理内部文字コードがUTF-8である必要がある。多次元配列には対応していない。
setMailFields() : mixed: メールフィールドを取得してセットする。
setTable() : AppTable: テーブルをセット
setup() : bool: モデルのセットアップを行う
setupUpload() : mixed: アップロード設定を行う
setUseTable() : mixed: テーブル名を設定する
sortdown() : bool: 一つ位置を下げる
sortup() : bool: 一つ位置を上げる
validationDefault() : Validator: デフォルトのバリデーションを設定する
_validGroupComplete() : void: 不完全データチェック
_validGroupErrorCheck() : void: バリデートグループエラーチェック
setupValidate() : void: バリデーションをを個別に設定する

$mailContent

メールコンテンツ情報


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

$mailFields

メールフォーム情報


    public
        ResultSet
    $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
     = []

addPrefix()

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


    public
                    addPrefix( $table) : string

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

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

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

Parameters

$table :

Return values

string —

afterMarshal()

After Marshal


    public
                    afterMarshal(Event $event) : mixed

Parameters

$event : Event

Return values

mixed —

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

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 —

convertDatasToMail()

メール用に変換する


    public
                    convertDatasToMail(mixed $data, mixed $options) : array<string|int, mixed>

Parameters

$data : mixed
$options : mixed

Return values

array<string|int, mixed> —

$dbDatas

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

変換後のデータ

convertMessageToCsv()

受信メッセージの内容を表示状態に変換する


    public
                    convertMessageToCsv( $messages) : array<string|int, mixed>

Parameters

$messages :

Return values

array<string|int, mixed> —

convertToDb()

データベース用のデータに変換する


    public
                    convertToDb(ResultSetInterface $mailFields, EntityInterface $mailMessage) : EntityInterface

Parameters

$mailFields : ResultSetInterface
$mailMessage : EntityInterface

Return values

EntityInterface —

createFullTableName()

フルテーブル名を生成する


    public
                    createFullTableName( $mailContentId) : string

Parameters

$mailContentId :

Return values

string —

createTableName()

テーブル名を生成する int型でなかったら強制終了


    public
                    createTableName( $mailContentId) : string

Parameters

$mailContentId :

Return values

string —

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

find()

find


    public
                    find([string $type = 'all' ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$type : string = 'all'
$options : array<string|int, mixed> = []

Return values

array<string|int, mixed> —

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 —

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

initialize()

Initialize method


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

Parameters

$config : array<string|int, mixed>: The configuration for the Table.

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 —

reconstructionAll()

メール受信テーブルを全て再構築


    public
                    reconstructionAll() : bool

Return values

bool —

reduceAssociations()

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


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

Parameters

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

Return values

void —

replaceText()

機種依存文字の変換処理内部文字コードがUTF-8である必要がある。多次元配列には対応していない。


    public
                    replaceText(string $str) : string

Parameters

$str : string: 変換対象文字列

Return values

string —

$str 変換後文字列

setMailFields()

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


    public
                    setMailFields(int $mailContentId) : mixed

Parameters

$mailContentId : int

Return values

mixed —

setTable()

テーブルをセット


    public
                    setTable(string $table) : AppTable

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

Parameters

$table : string

Return values

AppTable —

setup()

モデルのセットアップを行う


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

MailMessageモデルは利用前にこのメソッドを呼び出しておく必要あり

Parameters

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

Return values

bool —

setupUpload()

アップロード設定を行う


    public
                    setupUpload(int $mailContentId) : mixed

Parameters

$mailContentId : int

Return values

mixed —

setUseTable()

テーブル名を設定する


    public
                    setUseTable( $mailContentId) : mixed

Parameters

$mailContentId :

Return values

mixed —

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 —

_validGroupComplete()

不完全データチェック


    protected
                    _validGroupComplete(EntityInterface $entity) : void

Parameters

$entity : EntityInterface

Return values

void —

_validGroupErrorCheck()

バリデートグループエラーチェック


    protected
                    _validGroupErrorCheck(EntityInterface $entity) : void

Parameters

$entity : EntityInterface

Return values

void —

setupValidate()

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


    protected
                    setupValidate(array<string|int, mixed> $postData) : void

Parameters

$postData : array<string|int, mixed>

Return values

void —

MailMessagesTable extends MailAppTable in package Application

Table of Contents

Properties

$mailContent

$mailFields

$publishBeginField

$publishEndField

$publishStatusField

$tmpEvents

Methods

addPrefix()

Parameters

Tags

Return values

afterMarshal()

Parameters

Return values

alphaNumeric()

Parameters

Return values

belongsToMany()

Parameters

Tags

Return values

between()

Parameters

Return values

cakeError()

Parameters

Return values

changeSort()

Parameters

Return values

convertDatasToMail()

Parameters

Tags

Return values

convertEncodingByArray()

Parameters

Tags

Return values

convertMessageToCsv()

Parameters

Return values

convertToDb()

Parameters

Tags

Return values

createFullTableName()

Parameters

Return values

createTableName()

Parameters

Tags

Return values

deconstruct()

Parameters

Return values

find()

Parameters

Return values

getConditionAllowPublish()

Tags

Return values

getControlSource()

Parameters

Return values

getMax()

Parameters

Tags

Return values

getTable()

Tags

Return values

getUrlPattern()

Parameters

Tags

Return values

initialize()

Parameters

MailMessagesTable extends MailAppTable
in package

Application