MailMessagesService
in package
implements
MailMessagesServiceInterface
Uses
BcContainerTrait
MailMessagesService
Interfaces, Classes, Traits and Enums
- MailMessagesServiceInterface
- MailMessagesServiceInterface
Table of Contents
- $BcDatabaseService : BcDatabaseService
- $MailMessages : MailMessagesTable
- __construct() : mixed
- Constructor
- addMessageField() : bool
- メッセージフィールドを追加する
- autoConvert() : array<string|int, mixed>
- 自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
- batch() : bool
- 一括処理
- construction() : bool
- メッセージ保存用テーブルのフィールドを最適化する 初回の場合、id/created/modifiedを追加する 2回目以降の場合は、最後のカラムに追加する
- create() : EntityInterface
- 新規データ作成
- createTable() : bool
- メッセージテーブルを作成する
- createTableName() : string
- テーブル名を生成する int型でなかったら強制終了
- delete() : bool
- メールメッセージを削除する
- deleteMessageField() : array<string|int, mixed>|bool
- メッセージファイルのフィールドを削除する
- dropTable() : bool
- メッセージテーブルを削除する
- get() : EntityInterface
- メールメッセージを取得する
- getIndex() : Query
- メールメッセージの一覧を取得する
- getNew() : EntityInterface
- 初期値の設定をする
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- hasService() : bool
- Has Service
- renameMessageField() : array<string|int, mixed>|bool
- メッセージファイルのフィールドを編集する
- setup() : mixed
- メールメッセージの初期セットアップを実行する
- update() : EntityInterface|null
- メールメッセージを編集する
Properties
$BcDatabaseService
public
BcDatabaseService
$BcDatabaseService
$MailMessages
public
MailMessagesTable
$MailMessages
Methods
__construct()
Constructor
public
__construct() : mixed
Tags
Return values
mixed —addMessageField()
メッセージフィールドを追加する
public
addMessageField(int $mailContentId, string $fieldName) : bool
Parameters
- $mailContentId : int
- $fieldName : string
Tags
Return values
bool —autoConvert()
自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
public
autoConvert(int $mailContentId, array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $mailContentId : int
- $data : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —$data
batch()
一括処理
public
batch(string $method, array<string|int, mixed> $ids) : bool
Parameters
- $method : string
- $ids : array<string|int, mixed>
Tags
Return values
bool —construction()
メッセージ保存用テーブルのフィールドを最適化する 初回の場合、id/created/modifiedを追加する 2回目以降の場合は、最後のカラムに追加する
public
construction(int $mailContentId) : bool
Parameters
- $mailContentId : int
Tags
Return values
bool —create()
新規データ作成
public
create(EntityInterface|MailContent $mailContent, array<string|int, mixed>|MailMessage $postData) : EntityInterface
Parameters
- $mailContent : EntityInterface|MailContent
- $postData : array<string|int, mixed>|MailMessage
Return values
EntityInterface —createTable()
メッセージテーブルを作成する
public
createTable(int $mailContentId) : bool
Parameters
- $mailContentId : int
Tags
Return values
bool —createTableName()
テーブル名を生成する int型でなかったら強制終了
public
createTableName(int $mailContentId) : string
Parameters
- $mailContentId : int
Tags
Return values
string —delete()
メールメッセージを削除する
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
bool —deleteMessageField()
メッセージファイルのフィールドを削除する
public
deleteMessageField(int $mailContentId, string $field) : array<string|int, mixed>|bool
Parameters
- $mailContentId : int
- $field : string
Tags
Return values
array<string|int, mixed>|bool —dropTable()
メッセージテーブルを削除する
public
dropTable(int $mailContentId) : bool
Parameters
- $mailContentId : int
Tags
Return values
bool —get()
メールメッセージを取得する
public
get(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterface —getIndex()
メールメッセージの一覧を取得する
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
Query —getNew()
初期値の設定をする
public
getNew(int $mailContentId, array<string|int, mixed> $params) : EntityInterface
Parameters
- $mailContentId : int
- $params : array<string|int, mixed>
Tags
Return values
EntityInterface —getService()
Get Service
public
getService( $service) : array<string|int, mixed>|mixed|object
Parameters
Tags
Return values
array<string|int, mixed>|mixed|object —hasService()
Has Service
public
hasService( $service) : bool
Parameters
Tags
Return values
bool —renameMessageField()
メッセージファイルのフィールドを編集する
public
renameMessageField(int $mailContentId, string $oldFieldName, string $newfieldName) : array<string|int, mixed>|bool
Parameters
- $mailContentId : int
- $oldFieldName : string
- $newfieldName : string
Tags
Return values
array<string|int, mixed>|bool —setup()
メールメッセージの初期セットアップを実行する
public
setup(int $mailContentId[, mixed $postData = [] ]) : mixed
利用する前に必ず実行しなければならない
Parameters
- $mailContentId : int
- $postData : mixed = []
Tags
Return values
mixed —update()
メールメッセージを編集する
public
update(EntityInterface $entity, array<string|int, mixed> $postData) : EntityInterface|null
Parameters
- $entity : EntityInterface
- $postData : array<string|int, mixed>