SCC Core Developer's Document
Back to top  

NoticeTargetListener

Extends \SCC\Api\Model\Listener\Extend\CommonListener

[共通ユーザ通知 イベントリスナー]

共通ユーザ通知のイベントと処理を結びつける

package

Default

Methods

コンストラクター

__construct(object $logger = '')
inherited

Arguments

$logger

object

ロガー

アプリケーションCDを返す

getAppCd() : string
abstract

Response

string

アプリケーションCD

メール本文の取得

getBody(mixed $param) : \SCC\Api\Model\Listener\Extend\メール本文
abstract

Arguments

$param

mixed

メール本部作成用のパラメータ

Response

\SCC\Api\Model\Listener\Extend\メール本文

メール本文の埋め込みURL部分の取得

getEmbeddedURL(mixed $param, string $terminal = '') : string
abstract

Arguments

$param

mixed

メール本文の埋め込みURL部分作成用のパラメータ

$terminal

string

端末（pc:PC, sp:スマートフォン）

Response

string

メール本文の埋め込みURL部分

対象テーブルの対象組織の階層差を指定するフィールド名を返す

getLevelFieldName() : string
abstract

Response

string

対象テーブルの対象組織の階層差を指定するフィールド名

メール件名の取得

getMailSubject(mixed $param) : string
abstract

Arguments

$param

mixed

本文作成用のパラメータ

Response

string

メール件名

メインテーブルの（複合）キーのコードのフィールド名を返す

getMainCdFieldName() : string
abstract

Response

string

メインテーブルの（複合）キーのコードのフィールド名

メール本文のURLパラメータの取得

getQueryParams( $params,  $terminal = '') : string
abstract

Arguments

$params

$terminal

Response

string

メール本文の埋め込みURLクエリパラメータ

対象テーブルのモデルのインスタンスを返す

getTargetModel() : \SCC\Api\Model\Extend\CommonCoreModel
abstract

Response

\SCC\Api\Model\Extend\CommonCoreModel

対象テーブルのモデルのインスタンス

通知対象ユーザリストを取得する

getTargetUser(\Phalcon\Events\Event $event, \SCC\Api\Model\Extend\CommonCoreModel $model) : array<mixed,string>

Arguments

$event

\Phalcon\Events\Event

イベントオブジェクト

$model

\SCC\Api\Model\Extend\CommonCoreModel

通知のトリガーとなったモデル

Response

array<mixed,string>

通知先対象ユーザリスト

メール本文の埋め込みURLのタイトルの取得

getURLTitle(mixed $param) : string
abstract

不要の場合はブランクを返す

Arguments

$param

mixed

メール本文の埋め込みURLのタイトル作成用のパラメータ

Response

string

メール本文の埋め込みURLのタイトル

通知対象ユーザリストから通知データを作成する

makeNotice(\Phalcon\Events\Event $event, \SCC\Api\Model\Extend\CommonCoreModel $model, array $param, string $function = '')

Arguments

$event

\Phalcon\Events\Event

イベントオブジェクト

$model

\SCC\Api\Model\Extend\CommonCoreModel

通知のトリガーとなったモデル

$param

array

パラメータ("userList":送付先ユーザリスト)

$function

string

通知対象の機能

Constants

通知対象機能 掲示板コメント

NOTICE_FUNCTION_MSGMOARD_COMMENT

通知対象機能 スケジュール登録

NOTICE_FUNCTION_SCHEDULE_REGIST

Properties

ロガー

logger :
inherited

Type(s)