baserCMS クラスリファレンス

MailMessagesService
in package
implements MailMessagesServiceInterface uses BcContainerTrait

MailMessagesService

Table of Contents

Interfaces

MailMessagesServiceInterface
MailMessagesServiceInterface

Properties

$BcDatabaseService  : BcDatabaseService
$BcDatabaseService  : BcDatabaseServiceInterface|BcDatabaseService
BcDatabaseService
$MailMessages  : MailMessagesTable
$MailMessages  : MailMessagesTable|Table
BcDatabaseService

Methods

__construct()  : mixed
Constructor
addMessageField()  : bool
メッセージフィールドを追加する
autoConvert()  : array<string|int, mixed>
自動変換 確認画面で利用される事も踏まえてバリデートを通す為の 可能な変換処理を行う。
batch()  : bool
一括処理
construction()  : bool
メッセージ保存用テーブルのフィールドを最適化する 初回の場合、id/created/modifiedを追加する 2回目以降の場合は、最後のカラムに追加する
convertToForm()  : EntityInterface
エンティティをフォーム用のデータに変換する
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
reconstructionAll()  : bool
全てのメール受信テーブルの再構築を行う
renameMessageField()  : array<string|int, mixed>|bool
メッセージファイルのフィールドを編集する
setup()  : mixed
メールメッセージの初期セットアップを実行する
update()  : EntityInterface|null
メールメッセージを編集する

Properties

Methods

addMessageField()

メッセージフィールドを追加する

public addMessageField(int $mailContentId, string $fieldName) : bool
Parameters
$mailContentId : int
$fieldName : string
Tags
checked
noTodo
unitTest
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
checked
noTodo
unitTest
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
checked
noTodo
unitTest
Return values
bool

construction()

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

public construction(int $mailContentId) : bool
Parameters
$mailContentId : int
Tags
checked
noTodo
unitTest
Return values
bool

convertToForm()

エンティティをフォーム用のデータに変換する

public convertToForm(EntityInterface $mailMessage) : EntityInterface
Parameters
$mailMessage : EntityInterface
Tags
checked
noTodo
Return values
EntityInterface

create()

新規データ作成

public create(EntityInterface|MailContent $mailContent, array<string|int, mixed>|MailMessage $postData) : EntityInterface
Parameters
$mailContent : EntityInterface|MailContent
$postData : array<string|int, mixed>|MailMessage
Tags
unitTest
checked
noTodo
Return values
EntityInterface

createTable()

メッセージテーブルを作成する

public createTable(int $mailContentId) : bool
Parameters
$mailContentId : int
Tags
checked
noTodo
unitTest
Return values
bool

createTableName()

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

public createTableName(int $mailContentId) : string
Parameters
$mailContentId : int
Tags
checked
noTodo
unitTest
Return values
string

delete()

メールメッセージを削除する

public delete(int $id) : bool
Parameters
$id : int
Tags
checked
noTodo
unitTest
Return values
bool

deleteMessageField()

メッセージファイルのフィールドを削除する

public deleteMessageField(int $mailContentId, string $field) : array<string|int, mixed>|bool
Parameters
$mailContentId : int
$field : string
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|bool

dropTable()

メッセージテーブルを削除する

public dropTable(int $mailContentId) : bool
Parameters
$mailContentId : int
Tags
checked
noTodo
unitTest
Return values
bool

get()

メールメッセージを取得する

public get(int $id) : EntityInterface
Parameters
$id : int
Tags
checked
noTodo
unitTest
Return values
EntityInterface

getIndex()

メールメッセージの一覧を取得する

public getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
$queryParams : array<string|int, mixed> = []
Tags
checked
noTodo
unitTest
Return values
Query

getNew()

初期値の設定をする

public getNew(int $mailContentId, array<string|int, mixed> $params) : EntityInterface
Parameters
$mailContentId : int
$params : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
EntityInterface

getService()

Get Service

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

hasService()

Has Service

public hasService(mixed $service) : bool
Parameters
$service : mixed
Tags
checked
noTodo
unitTest
Return values
bool

reconstructionAll()

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

public reconstructionAll() : bool
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
checked
noTodo
unitTest
Return values
array<string|int, mixed>|bool

setup()

メールメッセージの初期セットアップを実行する

public setup(int $mailContentId[, mixed $postData = [] ]) : mixed

利用する前に必ず実行しなければならない

Parameters
$mailContentId : int
$postData : mixed = []
Tags
checked
noTodo
unitTest

update()

メールメッセージを編集する

public update(EntityInterface $entity, array<string|int, mixed> $postData) : EntityInterface|null
Parameters
$entity : EntityInterface
$postData : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
EntityInterface|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results