baserCMS クラスリファレンス

MailMessagesTable extends MailAppTable
in package

Application

メッセージモデル

Properties

$mailContent : array<string|int, mixed>: メールコンテンツ情報
$mailFields : ResultSet: メールフォーム情報
$publishBeginField : string: 公開開始日のフィールド AppTable::getConditionAllowPublish() で利用
$publishEndField : string: 公開終了日のフィールド AppTable::getConditionAllowPublish() で利用
$publishStatusField : string: 公開状態のフィールド AppTable::getConditionAllowPublish() で利用
$tmpEvents : array<string|int, mixed>: 一時イベントイベントを一時にオフにする場合に対象のコールバック処理を一時的に格納する
$_View : View: View

Methods

addPrefix() : string: テーブル名にプレフィックスを追加する
afterMarshal() : void: After Marshal
belongsToMany() : BelongsToMany: Belongs To Many
changeSort() : bool: 並び順を変更する
convertDatasToMail() : array<string|int, mixed>: メール用に変換する
convertMessageToCsv() : array<string|int, mixed>: 受信メッセージの内容を表示状態に変換する
convertToDb() : EntityInterface: データベース用のデータに変換する
createFullTableName() : string: フルテーブル名を生成する
createTableName() : string: テーブル名を生成する int型でなかったら強制終了
dispatchLayerEvent() : bool|Event: イベントを発火
find() : SelectQuery: find
getConditionAllowPublish() : array<string|int, mixed>: 公開状態となっているデータを取得するための conditions 値を取得
getMax() : int: 指定フィールドのMAX値を取得する
getTable() : string: テーブルを取得
getUrlPattern() : array<string|int, mixed>: コンテンツのURLにマッチする候補を取得する
initialize() : void: Initialize method
offEvent() : mixed: イベントを一時的にオフにする
onEvent() : mixed: 一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
reconstructionAll() : bool: メール受信テーブルを全て再構築
replaceText() : string: 機種依存文字の変換処理
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
     = []

$_View

View


    protected
        View
    $_View

addPrefix()

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


    public
                    addPrefix(mixed $table) : string

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

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

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

Parameters

$table : mixed

Return values

string

afterMarshal()

After Marshal


    public
                    afterMarshal(Event $event) : void

Parameters

$event : Event

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

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

convertMessageToCsv()

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


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

Parameters

$messages : array<string|int, mixed>

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(mixed $mailContentId) : string

Parameters

$mailContentId : mixed

Return values

string

createTableName()

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


    public
                    createTableName(int $mailContentId) : string

Parameters

$mailContentId : int

Return values

string —

The table name

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

find()

find


    public
                    find([string $type = 'all' ], mixed ...$args) : SelectQuery

Parameters

$type : string = 'all'
$args : mixed

Return values

SelectQuery

getConditionAllowPublish()

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


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

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

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

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.

offEvent()

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


    public
                    offEvent(string $eventKey) : mixed

Parameters

$eventKey : string

onEvent()

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


    public
                    onEvent(string $eventKey) : mixed

Parameters

$eventKey : string

reconstructionAll()

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


    public
                    reconstructionAll() : bool

Return values

bool

replaceText()

機種依存文字の変換処理


    public
                    replaceText(string $str) : string

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

Parameters

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

Return values

string —

変換後文字列

setMailFields()

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


    public
                    setMailFields(int $mailContentId) : mixed

Parameters

$mailContentId : int

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

setUseTable()

テーブル名を設定する


    public
                    setUseTable(mixed $mailContentId) : mixed

Parameters

$mailContentId : 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

_validGroupErrorCheck()

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


    protected
                    _validGroupErrorCheck(EntityInterface $entity) : void

Parameters

$entity : EntityInterface

setupValidate()

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


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

Parameters

$postData : array<string|int, mixed>

MailMessagesTable extends MailAppTable in package Application

Table of Contents

Properties

Methods

Properties

$mailContent

$mailFields

$publishBeginField

$publishEndField

$publishStatusField

$tmpEvents

$_View

Methods

addPrefix()

Parameters

Tags

Return values

afterMarshal()

Parameters

Tags

belongsToMany()

Parameters

Tags

Return values

changeSort()

Parameters

Tags

Return values

convertDatasToMail()

Parameters

Tags

Return values

convertMessageToCsv()

Parameters

Tags

Return values

convertToDb()

Parameters

Tags

Return values

createFullTableName()

Parameters

Tags

Return values

createTableName()

Parameters

Tags

Return values

dispatchLayerEvent()

Parameters

Tags

Return values

find()

Parameters

Return values

getConditionAllowPublish()

Tags

Return values

getMax()

Parameters

Tags

Return values

getTable()

Tags

Return values

getUrlPattern()

Parameters

Tags

Return values

initialize()

Parameters

Tags

offEvent()

Parameters

Tags

onEvent()

Parameters

Tags

reconstructionAll()

Return values

MailMessagesTable extends MailAppTable
in package

Application