baserCMS クラスリファレンス

MailFieldsController extends BcAdminApiController
in package

メールフィールドコントローラー

Table of Contents

Properties

$Authentication  : AuthenticationComponent
$Authentication  : AuthenticationComponent
$BcMessage  : BcMessageComponent
$Paginator  : PaginatorComponent
$Security  : SecurityComponent
$_View  : View
View

Methods

__construct()  : mixed
BcAppController constructor.
_blackHoleCallback()  : void
Securityコンポーネントのブラックホールからのコールバック
add()  : void
[API] メールフィールド API 新規追加
batch()  : mixed
メールフィールドのバッチ処理
beforeFilter()  : Response|void
Before Filter
beforeRender()  : Response|void|null
Before render
copy()  : void
[API] メールフィールド API コピー
delete()  : void
[API] メールフィールド API 削除
dispatchLayerEvent()  : bool|Event
イベントを発火
edit()  : void
[API] メールフィールド API 編集
getAccessToken()  : array<string|int, mixed>
トークンを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
hasService()  : bool
Has Service
index()  : mixed
[API] メールフィールド API 一覧取得
initialize()  : void
Initialize
isAdminApiEnabled()  : bool
認証が必要なAPIを利用可能かどうか判定
isAvailableUser()  : bool
ログインユーザーが有効か判定する
list()  : void
[API] メールフィールド API リスト取得
notFound()  : void
NOT FOUNDページを出力する
redirectIfIsRequireMaintenance()  : Response|void|null
メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
setTitle()  : void
Set Title
setupFrontView()  : void
フロント用のViewクラスをセットアップする
update_sort()  : bool|void
並び替えを更新する [AJAX]
view()  : void
[API] メールフィールド API 単一データ取得
_autoConvertEncodingByArray()  : array<string|int, mixed>
配列の文字コードを変換する
loadViewConditions()  : void
画面の情報をセッションから読み込む
saveViewConditions()  : void
画面の情報をセッションに保存する
setViewConditions()  : void
画面の情報をセットする
__cleanupQueryParams()  : void
クエリーパラメーターの調整 環境によって?キーにamp;が付加されてしまうため
__convertEncodingHttpInput()  : void
http経由で送信されたデータを変換する とりあえず、UTF-8で固定
checkPermission()  : bool
アクセスルールの権限を確認する

Properties

$Authentication

public AuthenticationComponent $Authentication

Methods

__construct()

BcAppController constructor.

public __construct([ServerRequest|null $request = null ][, Response|null $response = null ][, string|null $name = null ][, EventManagerInterface|null $eventManager = null ][, ComponentRegistry|null $components = null ]) : mixed
Parameters
$request : ServerRequest|null = null
$response : Response|null = null
$name : string|null = null
$eventManager : EventManagerInterface|null = null
$components : ComponentRegistry|null = null
Tags
checked
noTodo
unitTest

_blackHoleCallback()

Securityコンポーネントのブラックホールからのコールバック

public _blackHoleCallback(string $err, mixed $exception) : void

フォーム改ざん対策・CSRF対策・SSL制限・HTTPメソッド制限などへの違反が原因で Securityコンポーネントに"ブラックホールされた"場合の動作を指定する

Parameters
$err : string

エラーの種類

$exception : mixed
Tags
throws
BadRequestException
uses
_blackHoleCallback
checked
noTodo
unitTest

batch()

メールフィールドのバッチ処理

public batch(MailFieldsService $service) : mixed

指定したメールフィールドに対して削除、公開、非公開の処理を一括で行う

エラー

受け取ったPOSTデータのキー名'batch'が'delete','publish','unpublish'以外の値であれば500エラーを発生させる

Parameters
$service : MailFieldsService
Tags
checked
noTodo
unitTest

beforeFilter()

Before Filter

public beforeFilter(EventInterface $event) : Response|void
Parameters
$event : EventInterface
Tags
checked
noTodo
unitTest
Return values
Response|void

beforeRender()

Before render

public beforeRender(EventInterface $event) : Response|void|null
Parameters
$event : EventInterface
Tags
checked
noTodo
unitTest
Return values
Response|void|null

dispatchLayerEvent()

イベントを発火

public dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
$name : string
$data : array<string|int, mixed> = []
$options : mixed = []
Tags
checked
unitTest
noTodo
Return values
bool|Event

getAccessToken()

トークンを取得する

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

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

hasService()

Has Service

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

initialize()

Initialize

public initialize() : void
Tags
checked
unitTest
note

(value="BcEmailを実装したあとに確認")

isAdminApiEnabled()

認証が必要なAPIを利用可能かどうか判定

public isAdminApiEnabled() : bool
Tags
noTodo
checked
unitTest
Return values
bool

isAvailableUser()

ログインユーザーが有効か判定する

public isAvailableUser() : bool

サービスクラス、または、テーブルクラスにおいて、isAvailable / get メソッドが 存在するかを確認し、あれば実行し、その結果を返す。 ない場合は、 true を返却する

Return values
bool

notFound()

NOT FOUNDページを出力する

public notFound() : void
Tags
throws
NotFoundException
checked
noTodo
unitTest

redirectIfIsRequireMaintenance()

メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする

public redirectIfIsRequireMaintenance() : Response|void|null
Tags
checked
noTodo
unitTest
Return values
Response|void|null

setTitle()

Set Title

public setTitle(string $title) : void
Parameters
$title : string
Tags
checked
noTodo
unitTest

setupFrontView()

フロント用のViewクラスをセットアップする

public setupFrontView() : void
Tags
checked
noTodo
unitTest

_autoConvertEncodingByArray()

配列の文字コードを変換する

protected _autoConvertEncodingByArray(array<string|int, mixed> $data[, string $outenc = 'UTF-8' ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

変換前データ

$outenc : string = 'UTF-8'

変換後の文字コード

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

変換後データ

loadViewConditions()

画面の情報をセッションから読み込む

protected loadViewConditions([array<string|int, mixed> $targetModel = [] ][, array<string|int, mixed>|string $options = [] ]) : void

初期値が設定されている場合は初期値を設定した上で、セッションで上書きし、 ServerRequestに設定する。

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

オプション

  • default: 読み出す初期値(初期値:[])
  • group: 保存するグループ名(初期値:'')
  • post: POSTデータを保存するかどうか(初期値:true)
  • get: GETデータを保存するかどうか(初期値:false)
Tags
see

setViewConditions, saveViewConditions

checked
noTodo
unitTest

saveViewConditions()

画面の情報をセッションに保存する

protected saveViewConditions([array<string|int, mixed> $targetModel = [] ][, array<string|int, mixed> $options = [] ]) : void

次のセッション名に保存。

  • POSTデータ: BcApp.viewConditions.{$contentsName}.data.{$model}
  • クエリパラメーター: BcApp.viewConditions.{$contentsName}.query

$contentsNameは次の形式となる。 {$controllerName}{$actionName}.{$group}

ただし、ページネーションにおいて、1ページ目はクエリパラメーターpage を付けない仕様となっているため page は保存しない。

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

オプション

  • group: 保存するグループ名(初期値:'')
  • post: POSTデータを保存するかどうか(初期値:true)
  • get: GETデータを保存するかどうか(初期値:false)
Tags
see
setViewConditions
checked
noTodo
unitTest

setViewConditions()

画面の情報をセットする

protected setViewConditions([array<string|int, mixed> $targetModel = [] ][, array<string|int, mixed> $options = [] ]) : void

POSTデータとクエリパラメーターをセッションに保存した上で、 指定されたデフォルト値も含めて ServerRequest に設定する。

$this->setViewConditions(['Content'], [
    'group' => 'index',
    'default' => [
         'query' => ['limit' => 10],
         'data' => ['title' => 'default']
     ],
    'get' => true
]);
Parameters
$targetModel : array<string|int, mixed> = []

ターゲットとなるモデル

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

オプション

  • default: 読み出す初期値(初期値:[])
  • group: 保存するグループ名(初期値:'')
  • post: POSTデータを保存するかどうか(初期値:true)
  • get: GETデータを保存するかどうか(初期値:false)
Tags
checked
noTodo
unitTest

__cleanupQueryParams()

クエリーパラメーターの調整 環境によって?キーにamp;が付加されてしまうため

private __cleanupQueryParams() : void
Tags
checked
noTodo
unitTest

__convertEncodingHttpInput()

http経由で送信されたデータを変換する とりあえず、UTF-8で固定

private __convertEncodingHttpInput() : void
Tags
checked
noTodo
unitTest

checkPermission()

アクセスルールの権限を確認する

private checkPermission() : bool

現在アクセスしているURLについて権限があるかどうかを確認する。

Return values
bool

        
On this page

Search results