PHP Class MailMessage

显示文件 Open project: baserproject/basercms Class Usage Examples

Public Properties

Property Type Description
$actsAs array ビヘイビア
$mailContent array メールコンテンツ情報
$mailFields array メールフォーム情報
$useTable string テーブル

Public Methods

Method Description
addMessageField ( $mailContentId, string $field ) : array メッセージファイルにフィールドを追加する
afterValidate ( ) : void Called after data has been checked for errors
autoConvert ( array $data ) : array 自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
beforeSave ( $options = [] ) : boolean beforeSave
beforeValidate ( array $options = [] ) : array バリデート処理
construction ( integer $mailContentId ) : boolean メッセージ保存用テーブルのフィールドを最適化する 初回の場合、id/created/modifiedを追加する 2回目以降の場合は、最後のカラムに追加する
convertDatasToMail ( $dbData ) : array メール用に変換する
convertMessageToCsv ( integer $id, array $messages ) : array 受信メッセージの内容を表示状態に変換する
convertToDb ( $dbData ) : array データベース用のデータに変換する
createFullTableName ( $mailContentId ) : string フルテーブル名を生成する
createTable ( $mailContentId ) : boolean メッセージテーブルを作成する
createTableName ( $mailContentId ) : string テーブル名を生成する
delMessageField ( $mailContentId, string $field ) : array メッセージファイルのフィールドを削除する
dropTable ( $mailContentId ) : boolean メッセージテーブルを削除する
find ( String $type = 'first', mixed $query = [] ) : Array find
getDefaultValue ( $data ) : array 初期値の設定をする
reconstructionAll ( ) : boolean メール受信テーブルを全て再構築
renameMessageField ( $mailContentId, string $oldFieldName, string $newfieldName ) : array メッセージファイルのフィールドを編集する
replaceText ( string $str ) : string 機種依存文字の変換処理 内部文字コードがUTF-8である必要がある。 多次元配列には対応していない。
setUseTable ( $mailContentId ) テーブル名を設定する
setup ( type $mailContentId ) : boolean モデルのセットアップを行う
setupUpload ( $name ) アップロード設定を行う

Protected Methods

Method Description
_setValidate ( ) : void validate（入力チェック）を個別に設定する VALID_NOT_EMPTY 空不可 VALID_EMAIL メール形式チェック
_validEmailCofirm ( array $data ) : void Eメール確認チェック
_validExtends ( array $data ) : void 拡張バリデートチェック
_validGroupComplate ( array $data ) : void 不完全データチェック
_validGroupErrorCheck ( ) : void バリデートグループエラーチェック

Method Details

_setValidate() protected method

validate（入力チェック）を個別に設定する VALID_NOT_EMPTY 空不可 VALID_EMAIL メール形式チェック
protected _setValidate ( ) : void
return void TODO Cake1.2に対応させる

_validEmailCofirm() protected method

Eメール確認チェック
protected _validEmailCofirm ( array $data ) : void
$data array
return void

_validExtends() protected method

拡張バリデートチェック
protected _validExtends ( array $data ) : void
$data array
return void

_validGroupComplate() protected method

不完全データチェック
protected _validGroupComplate ( array $data ) : void
$data array
return void

_validGroupErrorCheck() protected method

バリデートグループエラーチェック
protected _validGroupErrorCheck ( ) : void
return void

addMessageField() public method

メッセージファイルにフィールドを追加する
public addMessageField ( $mailContentId, string $field ) : array
$field string
return array

afterValidate() public method

Called after data has been checked for errors
public afterValidate ( ) : void
return void

autoConvert() public method

自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
public autoConvert ( array $data ) : array
$data array
return array $data

beforeSave() public method

beforeSave
public beforeSave ( $options = [] ) : boolean
return boolean

beforeValidate() public method

バリデート処理
public beforeValidate ( array $options = [] ) : array
$options array
return array

construction() public method

メッセージ保存用テーブルのフィールドを最適化する 初回の場合、id/created/modifiedを追加する 2回目以降の場合は、最後のカラムに追加する
public construction ( integer $mailContentId ) : boolean
$mailContentId integer
return boolean

convertDatasToMail() public method

メール用に変換する
public convertDatasToMail ( $dbData ) : array
return array $dbDatas TODO ヘルパー化すべきかも

convertMessageToCsv() public method

受信メッセージの内容を表示状態に変換する
public convertMessageToCsv ( integer $id, array $messages ) : array
$id integer
$messages array
return array

convertToDb() public method

データベース用のデータに変換する
public convertToDb ( $dbData ) : array
return array $dbDatas

createFullTableName() public method

フルテーブル名を生成する
public createFullTableName ( $mailContentId ) : string
$mailContentId
return string

createTable() public method

メッセージテーブルを作成する
public createTable ( $mailContentId ) : boolean
return boolean

createTableName() public method

テーブル名を生成する
public createTableName ( $mailContentId ) : string
$mailContentId
return string

delMessageField() public method

メッセージファイルのフィールドを削除する
public delMessageField ( $mailContentId, string $field ) : array
$field string
return array

dropTable() public method

メッセージテーブルを削除する
public dropTable ( $mailContentId ) : boolean
return boolean

find() public method

find
public find ( String $type = 'first', mixed $query = [] ) : Array
$type String
$query mixed
return Array

getDefaultValue() public method

初期値の設定をする
public getDefaultValue ( $data ) : array
return array $data

reconstructionAll() public method

メール受信テーブルを全て再構築
public reconstructionAll ( ) : boolean
return boolean

renameMessageField() public method

メッセージファイルのフィールドを編集する
public renameMessageField ( $mailContentId, string $oldFieldName, string $newfieldName ) : array
$oldFieldName string
$newfieldName string
return array

replaceText() public method

機種依存文字の変換処理 内部文字コードがUTF-8である必要がある。 多次元配列には対応していない。
public replaceText ( string $str ) : string
$str string 変換対象文字列
return string $str 変換後文字列 TODO AppExModeに移行すべきかも

setUseTable() public method

テーブル名を設定する
public setUseTable ( $mailContentId )
$mailContentId

setup() public method

MailMessageモデルは利用前にこのメソッドを呼び出しておく必要あり
public setup ( type $mailContentId ) : boolean
$mailContentId type
return boolean

setupUpload() public method

アップロード設定を行う
public setupUpload ( $name )

Property Details

$actsAs public_oe property

ビヘイビア
public array $actsAs
return array

$mailContent public_oe property

メールコンテンツ情報
public array $mailContent
return array

$mailFields public_oe property

メールフォーム情報
public array $mailFields
return array

$useTable public_oe property

テーブル
public string $useTable
return string