baserCMS クラスリファレンス

MailHelper extends Helper
in package
uses BcContainerTrait

メールヘルパー

Table of Contents

Properties

$currentMailContent  : MailContent
現在のメールコンテンツ
$helpers  : array<string|int, mixed>
ヘルパー

Methods

__construct()  : void
コンストラクタ
beforeRender()  : mixed
beforeRender
description()  : void
メールの説明文を出力する
descriptionExists()  : bool
メールの説明文が設定されているかどうかを判定する
getDescription()  : string
メールフォームの説明文を取得する
getForm()  : mixed
メールフォームを取得する
getFormTemplates()  : array<string|int, mixed>
フォームテンプレートを取得
getMailTemplates()  : array<string|int, mixed>
メールテンプレートを取得
getPublishedMailContents()  : mixed
公開状態のメールコンテンツを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
getToken()  : string
ブラウザの戻るボタン対応コードを作成
hasService()  : bool
Has Service
isMail()  : bool
現在のページがメールプラグインかどうかを判定する
link()  : void
メールフォームへのリンクを生成する
setMailContent()  : void
メールコンテンツデータをセットする
token()  : void
ブラウザの戻るボタン対応コードを出力

Properties

$helpers

ヘルパー

public array<string|int, mixed> $helpers = ['BcBaser', 'BcContents']

Methods

__construct()

コンストラクタ

public __construct(View $view[, array<string|int, mixed> $config = [] ]) : void
Parameters
$view : View
$config : array<string|int, mixed> = []
Tags
checked
noTodo

beforeRender()

beforeRender

public beforeRender(Event $event, string $viewFile) : mixed
Parameters
$event : Event
$viewFile : string
Tags
checked

description()

メールの説明文を出力する

public description() : void
Tags
checked
noTodo

descriptionExists()

メールの説明文が設定されているかどうかを判定する

public descriptionExists() : bool
Tags
checked
noTodo
Return values
bool

設定されている場合 true を返す

getDescription()

メールフォームの説明文を取得する

public getDescription() : string
Tags
checked
noTodo
Return values
string

メールフォームの説明文

getForm()

メールフォームを取得する

public getForm([mixed $id = null ]) : mixed
Parameters
$id : mixed = null

getFormTemplates()

フォームテンプレートを取得

public getFormTemplates([mixed $siteId = 1 ]) : array<string|int, mixed>

コンボボックスのソースとして利用

Parameters
$siteId : mixed = 1
Tags
todo

他のヘルパーに移動する

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

フォームテンプレート一覧データ

getMailTemplates()

メールテンプレートを取得

public getMailTemplates([mixed $siteId = 1 ]) : array<string|int, mixed>

コンボボックスのソースとして利用

Parameters
$siteId : mixed = 1
Tags
todo

他のヘルパに移動する

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

メールテンプレート一覧データ

getPublishedMailContents()

公開状態のメールコンテンツを取得する

public getPublishedMailContents(int $siteId) : mixed
Parameters
$siteId : int
Tags
checked
noTodo

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

getToken()

ブラウザの戻るボタン対応コードを作成

public getToken() : string
Tags
checked
noTodo
Return values
string

hasService()

Has Service

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

isMail()

現在のページがメールプラグインかどうかを判定する

public isMail() : bool
Tags
checked
noTodo
Return values
bool

メールフォームへのリンクを生成する

public link(string $title, string $contentsName[, array<string|int, mixed> $datas = [] ][, array<string|int, mixed> $options = [] ]) : void
Parameters
$title : string

リンクのタイトル

$contentsName : string

メールフォームのコンテンツ名

$datas : array<string|int, mixed> = []

メールフォームに引き継ぐデータ(初期値 : array())

$options : array<string|int, mixed> = []

a タグの属性(初期値 : array()) ※ オプションについては、HtmlHelper::link() を参照

Tags
checked
noTodo

setMailContent()

メールコンテンツデータをセットする

public setMailContent([int $mailContentId = null ]) : void
Parameters
$mailContentId : int = null

メールコンテンツID

token()

ブラウザの戻るボタン対応コードを出力

public token() : void
Tags
checked
noTodo

        
On this page

Search results