baserCMS クラスリファレンス

MailFrontService
in package
implements MailFrontServiceInterface Uses BcContainerTrait, MailerAwareTrait

MailFrontService

Table of Contents

Interfaces

MailFrontServiceInterface
MailFrontServiceInterface

Properties

$MailContentsService  : MailContentsService
$MailContentsService  : MailContentsServiceInterface|MailContentsService
MailContentsService

Methods

__construct()  : mixed
Constructor
confirm()  : EntityInterface
送信データの確認を行う
createMailData()  : array<string|int, mixed>
メール送信用のデータを生成する
getAdminMail()  : string
管理者メールを取得する
getAttachments()  : array<string|int, mixed>
添付ファイルのパスを取得する
getConfirmTemplate()  : string
メールフォーム確認画面のテンプレート名を取得する
getEditLink()  : array<string|int, mixed>
編集リンクを取得する
getIndexTemplate()  : string
メールフォームのテンプレート名を取得する
getMailFields()  : ResultSetInterface
メールコンテンツに関連するメールフィールドを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
getThanksTemplate()  : string
メールフォームの完了画面用のテンプレート名を取得する
getUnpublishTemplate()  : string
メールフォームの非公開状態用のテンプレート名を取得する
getUserMail()  : string
ユーザーメールを取得する
getViewVarsForConfirm()  : array<string|int, mixed>
確認画面用の View 変数を取得する
getViewVarsForIndex()  : array<string|int, mixed>
メールフォーム用の View 変数を取得する
hasService()  : bool
Has Service
isAccepting()  : bool
フォームが公開中かどうかチェックする
sendMail()  : mixed
メールを送信する
setupPreviewForIndex()  : void
プレビュー用のセットアップをする
_checkDirectoryRraversal()  : bool
ファイルフィールドのデータがアップロードされたファイルパスであることを検証する

Properties

Methods

__construct()

Constructor

public __construct() : mixed

サービスクラスを初期化する

Tags
checked
noTodo
unitTest

confirm()

送信データの確認を行う

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

createMailData()

メール送信用のデータを生成する

public createMailData(EntityInterface $mailConfig, EntityInterface $mailContent, Query $mailFields, EntityInterface $mailMessage, array<string|int, mixed> $options) : array<string|int, mixed>
Parameters
$mailConfig : EntityInterface
$mailContent : EntityInterface
$mailFields : Query
$mailMessage : EntityInterface
$options : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

getAdminMail()

管理者メールを取得する

public getAdminMail(EntityInterface $mailContent) : string
Parameters
$mailContent : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getAttachments()

添付ファイルのパスを取得する

public getAttachments(Query $mailFields, EntityInterface $mailMessage) : array<string|int, mixed>
Parameters
$mailFields : Query
$mailMessage : EntityInterface
Tags
unitTest
checked
noTodo
Return values
array<string|int, mixed>

getConfirmTemplate()

メールフォーム確認画面のテンプレート名を取得する

public getConfirmTemplate(EntityInterface $mailContent) : string
Parameters
$mailContent : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getEditLink()

編集リンクを取得する

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

getIndexTemplate()

メールフォームのテンプレート名を取得する

public getIndexTemplate(EntityInterface $mailContent) : string
Parameters
$mailContent : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getMailFields()

メールコンテンツに関連するメールフィールドを取得する

public getMailFields(int $mailContentId) : ResultSetInterface
Parameters
$mailContentId : int
Tags
checked
noTodo
Return values
ResultSetInterface

getService()

Get Service

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

getThanksTemplate()

メールフォームの完了画面用のテンプレート名を取得する

public getThanksTemplate(EntityInterface $mailContent) : string
Parameters
$mailContent : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getUnpublishTemplate()

メールフォームの非公開状態用のテンプレート名を取得する

public getUnpublishTemplate(EntityInterface $mailContent) : string
Parameters
$mailContent : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getUserMail()

ユーザーメールを取得する

public getUserMail(EntityInterface $mailFields, EntityInterface $mailMessage) : string
Parameters
$mailFields : EntityInterface
$mailMessage : EntityInterface
Tags
checked
noTodo
unitTest
Return values
string

getViewVarsForConfirm()

確認画面用の View 変数を取得する

public getViewVarsForConfirm(EntityInterface $mailContent, EntityInterface $mailMessage) : array<string|int, mixed>
Parameters
$mailContent : EntityInterface
$mailMessage : EntityInterface
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>

getViewVarsForIndex()

メールフォーム用の View 変数を取得する

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

hasService()

Has Service

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

isAccepting()

フォームが公開中かどうかチェックする

public isAccepting(EntityInterface|MailContent $mailContent) : bool
Parameters
$mailContent : EntityInterface|MailContent
Tags
checked
noTodo
unitTest
Return values
bool

sendMail()

メールを送信する

public sendMail(EntityInterface $mailContent, EntityInterface $mailMessage, array<string|int, mixed> $sendEmailOptions) : mixed
Parameters
$mailContent : EntityInterface
$mailMessage : EntityInterface
$sendEmailOptions : array<string|int, mixed>
Tags
throws
Throwable
checked
noTodo
unitTest

setupPreviewForIndex()

プレビュー用のセットアップをする

public setupPreviewForIndex(Controller $controller) : void
Parameters
$controller : Controller
Tags
checked
noTodo
unitTest

_checkDirectoryRraversal()

ファイルフィールドのデータがアップロードされたファイルパスであることを検証する

private _checkDirectoryRraversal(int $mailContentId, array<string|int, mixed> $postData) : bool
Parameters
$mailContentId : int
$postData : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results