baserCMS クラスリファレンス

MailFieldsTable extends MailAppTable
in package

メールフィールドモデル

Table of Contents

Properties

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

Methods

addPrefix()  : string
テーブル名にプレフィックスを追加する
belongsToMany()  : BelongsToMany
Belongs To Many
changeSort()  : bool
並び順を変更する
copy()  : EntityInterface|false
フィールドデータをコピーする
dispatchLayerEvent()  : bool|Event
イベントを発火
duplicateMailField()  : bool
同じ名称のフィールド名がないかチェックする 同じメールコンテンツが条件
formatSource()  : string
選択リストのソースを整形する 空白と \r を除外し、改行で結合する | の対応は後方互換として残しておく
getConditionAllowPublish()  : array<string|int, mixed>
公開状態となっているデータを取得するための conditions 値を取得
getControlSource()  : array<string|int, mixed>
コントロールソースを取得する
getMax()  : int
指定フィールドのMAX値を取得する
getTable()  : string
テーブルを取得
getUrlPattern()  : array<string|int, mixed>
コンテンツのURLにマッチする候補を取得する
halfTextMailField()  : bool
メールフィールドの値として正しい文字列か検証する 半角小文字英数-_ メールフィールドは、DBテーブルのフィールドとして利用されるため、 大文字を利用した場合にクォートを入れないとエラーとなってしまう
initialize()  : void
Initialize method
offEvent()  : mixed
イベントを一時的にオフにする
onEvent()  : mixed
一時的にオフにしたイベントをオンにする BcModelEventDispatcherは対象外とする
replaceText()  : string
機種依存文字の変換処理
setTable()  : AppTable
テーブルをセット
sortdown()  : bool
一つ位置を下げる
sortup()  : bool
一つ位置を上げる
sourceMailField()  : bool
選択リストの入力チェック
validationDefault()  : Validator
MailField constructor.

Properties

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

Methods

addPrefix()

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

public addPrefix(mixed $table) : string

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

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

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

Parameters
$table : mixed
Tags
checked
noTodo
unitTest
Return values
string

belongsToMany()

Belongs To Many

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

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

Parameters
$associated : string
$options : array<string|int, mixed> = []
Tags
checked
noTodo
unitTest
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)
Tags
checked
noTodo
unitTest
Return values
bool

copy()

フィールドデータをコピーする

public copy(int $id[, MailField $data = null ][, array<string|int, mixed> $options = [] ]) : EntityInterface|false
Parameters
$id : int
$data : MailField = null
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
EntityInterface|false

dispatchLayerEvent()

イベントを発火

public dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
$name : string
$data : array<string|int, mixed> = []
$options : mixed = []
Tags
checked
unitTest
noTodo
Return values
bool|Event

duplicateMailField()

同じ名称のフィールド名がないかチェックする 同じメールコンテンツが条件

public duplicateMailField(string $value, array<string|int, mixed> $context) : bool
Parameters
$value : string
$context : array<string|int, mixed>
Tags
checked
noTodo
Return values
bool

formatSource()

選択リストのソースを整形する 空白と \r を除外し、改行で結合する | の対応は後方互換として残しておく

public formatSource(string $source) : string
Parameters
$source : string

選択リストソース

Tags
checked
noTodo
unitTest
Return values
string —

整形後選択リストソース

getConditionAllowPublish()

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

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

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

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

Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

getControlSource()

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

public getControlSource([string $field = null ]) : array<string|int, mixed>
Parameters
$field : string = null
Tags
checked
noTodo
Return values
array<string|int, mixed> —

source

getMax()

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

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

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

Parameters
$field : string
$conditions : array<string|int, mixed> = []
Tags
checked
unitTest
noTodo
Return values
int

getTable()

テーブルを取得

public getTable() : string

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

Tags
checked
noTodo
unitTest
Return values
string

getUrlPattern()

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

public getUrlPattern(string $url) : array<string|int, mixed>
Parameters
$url : string
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

halfTextMailField()

メールフィールドの値として正しい文字列か検証する 半角小文字英数-_ メールフィールドは、DBテーブルのフィールドとして利用されるため、 大文字を利用した場合にクォートを入れないとエラーとなってしまう

public halfTextMailField(string $value) : bool
Parameters
$value : string
Tags
checked
noTodo
unitTest
Return values
bool

initialize()

Initialize method

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

The configuration for the Table.

Tags
noTodo
checked
unitTest

offEvent()

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

public offEvent(string $eventKey) : mixed
Parameters
$eventKey : string
Tags
checked
noTodo

onEvent()

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

public onEvent(string $eventKey) : mixed
Parameters
$eventKey : string
Tags
checked
noTodo
unitTest

replaceText()

機種依存文字の変換処理

public replaceText(string $str) : string

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

Parameters
$str : string

変換対象文字列

Tags
checked
noTodo
unitTest
Return values
string —

変換後文字列

setTable()

テーブルをセット

public setTable(string $table) : AppTable

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

Parameters
$table : string
Tags
checked
noTodo
Return values
AppTable

sortdown()

一つ位置を下げる

public sortdown(string $id, array<string|int, mixed> $conditions) : bool
Parameters
$id : string
$conditions : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
bool

sortup()

一つ位置を上げる

public sortup(string $id, array<string|int, mixed> $conditions) : bool
Parameters
$id : string
$conditions : array<string|int, mixed>
Tags
checked
noTodo
Return values
bool

sourceMailField()

選択リストの入力チェック

public sourceMailField(string $value, array<string|int, mixed> $context) : bool
Parameters
$value : string
$context : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
bool

validationDefault()

MailField constructor.

public validationDefault(Validator $validator) : Validator
Parameters
$validator : Validator
Tags
checked
noTodo
unitTest
Return values
Validator 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results