\NetCommonsMailAssignTag

NetCommonsメール 埋め込みタグ Utility

自動セットする埋め込みタグ

埋め込みタグ 参照元
X-FROM_EMAIL 送信者メールアドレス SiteSettingUtil::read('Mail.from');
X-FROM_NAME 送信者名 SiteSettingUtil::read('Mail.from_name');
X-SITE_NAME サイト名 SiteSettingUtil::read('App.site_name');
X-SITE_URL サイトURL Router::url('/', true);
X-PLUGIN_NAME プラグイン名 Current::read('Plugin.name');
X-BLOCK_NAME ブロック名 Current::read('BlocksLanguage.name');
X-TO_DATE 今日日付 'Y/m/d H:i:s'
X-BODY_HEADER 本文ヘッダー SiteSettingUtil::read('Mail.body_header');
X-SIGNATURE 署名 SiteSettingUtil::read('Mail.signature');
X-USER ユーザ名(ハンドル) NetCommonsExtentionTag::getXUser()
X-ROOM ルーム名 NetCommonsExtentionTag::getXRoom()
X-URL コンテンツURL NetCommonsExtentionTag::getXUrl()
X-TAGS タグ(タグプラグイン) NetCommonsExtentionTag::getXTags()
X-WORKFLOW_COMMENT 承認コメント NetCommonsExtentionTag::getXWorkflowComment()
X-PLUGIN_MAIL_SUBJECT プラグイン側で設定した件名(承認メール用) NetCommonsMailAssignTag::setMailFixedPhraseSiteSetting()
X-PLUGIN_MAIL_BODY プラグイン側で設定した本文(承認メール用) NetCommonsMailAssignTag::setMailFixedPhraseSiteSetting()

Summary

Methods
Properties
Constants
initPlugin()
initTags()
setMailFixedPhrase()
setMailFixedPhrasePlugin()
setMailFixedPhraseSiteSetting()
setFixedPhraseSubject()
setFixedPhraseBody()
assignTag()
assignTags()
assignTagDatas()
assignTagReplace()
addHeaderAndSignature()
getFixedPhraseType()
__call()
$fixedPhraseSubject
$fixedPhraseBody
$assignTags
$embedTagsWysiwyg
$siteSetting
$SiteSetting
$RoomsLanguage
$Workflow
$User
MAX_LINE_LENGTH
SITE_SETTING_FIXED_PHRASE_APPROVAL
SITE_SETTING_FIXED_PHRASE_DISAPPROVAL
SITE_SETTING_FIXED_PHRASE_APPROVAL_COMPLETION
SITE_SETTING_FIXED_PHRASE_CONTACT_AFTER_APPROVAL
No protected methods found
No protected properties found
N/A
__decodeAndStripTags()
__textBrAndWrap()
No private properties found
N/A

Constants

MAX_LINE_LENGTH

MAX_LINE_LENGTH

SITE_SETTING_FIXED_PHRASE_APPROVAL

SITE_SETTING_FIXED_PHRASE_APPROVAL

SiteSettingの定型文の種類

SITE_SETTING_FIXED_PHRASE_DISAPPROVAL

SITE_SETTING_FIXED_PHRASE_DISAPPROVAL

SiteSettingの定型文の種類

SITE_SETTING_FIXED_PHRASE_APPROVAL_COMPLETION

SITE_SETTING_FIXED_PHRASE_APPROVAL_COMPLETION

SiteSettingの定型文の種類

SITE_SETTING_FIXED_PHRASE_CONTACT_AFTER_APPROVAL

SITE_SETTING_FIXED_PHRASE_CONTACT_AFTER_APPROVAL

SiteSettingの定型文の種類

Properties

$fixedPhraseSubject

$fixedPhraseSubject : string

Type

string — 件名(定型文)

$fixedPhraseBody

$fixedPhraseBody : string

Type

string — 本文(定型文)

$assignTags

$assignTags : array

Type

array — 埋め込みタグ

$embedTagsWysiwyg

$embedTagsWysiwyg : array

Type

array — 埋め込みタグのウィジウィグ対象

$siteSetting

$siteSetting : array

Type

array — SiteSetting model data

$SiteSetting

$SiteSetting : \SiteSetting

Type

\SiteSetting

$RoomsLanguage

$RoomsLanguage : \RoomsLanguage

Type

\RoomsLanguage

$Workflow

$Workflow : \Workflow

Type

\Workflow

$User

$User : \User

Type

\User

Methods

initPlugin()

initPlugin(integer  $languageId, string  $pluginName = null) : void

初期設定 プラグイン用

Parameters

integer $languageId

言語ID

string $pluginName

プラグイン名

initTags()

initTags(integer  $languageId, string  $pluginName = null) : void

初期設定 タグ

Parameters

integer $languageId

言語ID

string $pluginName

プラグイン名

setMailFixedPhrase()

setMailFixedPhrase(integer  $languageId, string  $fixedPhraseType = null, array  $mailSettingPlugin = null) : void

サイト設定 セット

Parameters

integer $languageId

言語ID

string $fixedPhraseType

定型文の種類

array $mailSettingPlugin

プラグイン側のメール設定データ

setMailFixedPhrasePlugin()

setMailFixedPhrasePlugin(array  $mailSettingPlugin) : void

プラグインの定型文 セット

Parameters

array $mailSettingPlugin

メール設定データ

setMailFixedPhraseSiteSetting()

setMailFixedPhraseSiteSetting(integer  $languageId, string  $fixedPhraseType, array  $mailSettingPlugin = null) : void

サイト設定の定型文 セット

Parameters

integer $languageId

言語ID

string $fixedPhraseType

定型文の種類

array $mailSettingPlugin

プラグイン側のメール設定データ

setFixedPhraseSubject()

setFixedPhraseSubject(string  $fixedPhraseSubject) : void

件名(定型文)をセットする

Parameters

string $fixedPhraseSubject

件名

setFixedPhraseBody()

setFixedPhraseBody(string  $fixedPhraseBody) : void

本文(定型文)をセットする

Parameters

string $fixedPhraseBody

本文

assignTag()

assignTag(string  $tag, string  $value) : array

埋め込みタグの追加

Parameters

string $tag

タグ

string $value

変換する値

Returns

array —

タグ

assignTags()

assignTags(array  $tags) : void

埋め込みタグを配列で追加

Parameters

array $tags

タグ配列

assignTagDatas()

assignTagDatas(array  $tags, array  $data) : void

埋め込みタグをデータから参照して追加

Parameters

array $tags

タグ配列

array $data

タグ配列

assignTagReplace()

assignTagReplace() : array

埋め込みタグ変換:定型文の埋め込みタグを変換して、メール生文にする

Returns

array —

タグ

addHeaderAndSignature()

addHeaderAndSignature(string  $body) : string

メール本文の共通ヘッダー文、署名追加

Parameters

string $body

本文

Returns

string —

本文

getFixedPhraseType()

getFixedPhraseType(string  $status, string  $comment = null, boolean  $isPublishableEdit = null) : string

SiteSettingの定型文の種類 ゲット

Parameters

string $status

承認ステータス

string $comment

承認コメント

boolean $isPublishableEdit

公開許可あり(承認者、承認OFF時の一般)の編集か

Throws

\InternalErrorException

Returns

string

__call()

__call(string  $method, array  $params) : mixed

オリジナルタグのセット用マジックメソッド

Parameters

string $method

メソッド

array $params

パラメータ

Returns

mixed

__decodeAndStripTags()

__decodeAndStripTags(string  $str) : string

htmlspecialchar 等をデコード と strap_tags

・{X-BODY}のウィジウィグのテキストは、不等号等が htmlspecialchar になっているため、変換する

Parameters

string $str

文字列

Returns

string —

変換した文字列

__textBrAndWrap()

__textBrAndWrap(string  $text) : string

改行処理 と テキストのブロックを決められた幅で折り返す

Parameters

string $text

文字列

Returns

string —

文字列