WidgetAreasController
extends BcAdminApiController
in package
Class WidgetAreasController
ウィジェットエリアコントローラー
Table of Contents
Properties
- $Authentication : AuthenticationComponent
- $Authentication : AuthenticationComponent
- $BcMessage : BcMessageComponent
- $_View : View
- View
Methods
- __construct() : void|ResponseInterface
- AppController constructor.
- _blackHoleCallback() : void
- Securityコンポーネントのブラックホールからのコールバック
- add() : mixed
- 新規追加
- ajaxError() : void
- Ajax用のエラーを出力する
- batch() : mixed
- メールフィールドのバッチ処理
- beforeFilter() : Response|void|null
- Before Filter
- beforeRender() : Response|void|null
- Before render 日本語を Unicode エスケープしないようにする
- delete() : mixed
- 削除
- delete_widget() : void
- [AJAX] ウィジェットを削除
- dispatchLayerEvent() : bool|Event
- イベントを発火
- edit() : mixed
- ウィジェットエリア管理 API 編集
- getAccessToken() : array<string|int, mixed>
- トークンを取得する
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- hasService() : bool
- Has Service
- index() : mixed
- 一覧取得
- initialize() : void
- Initialize
- isAdminApiEnabled() : bool
- 認証が必要なAPIを利用可能かどうか判定
- isAvailableUser() : bool
- ログインユーザーが有効か判定する
- list() : mixed
- リストデータ取得
- notFound() : void
- NOT FOUNDページを出力する
- redirectIfIsRequireMaintenance() : Response|void|null
- メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
- setTitle() : void
- Set Title
- setupFrontView() : void
- フロント用のViewクラスをセットアップする
- update_sort() : void
- 並び順を更新する
- update_title() : void
- [AJAX] タイトル更新
- update_widget() : void
- [AJAX] ウィジェット更新
- view() : mixed
- [API] 単一データ取得
- viewClasses() : array<string|int, string>
- View classes
- loadViewConditions() : void
- 画面の情報をセッションから読み込む
- saveDblog() : EntityInterface
- データベースログを記録する
- saveViewConditions() : void
- 画面の情報をセッションに保存する
- setViewConditions() : void
- 画面の情報をセットする
- __cleanupQueryParams() : void
- クエリーパラメーターの調整 環境によって?キーにamp;が付加されてしまうため
- checkPermission() : bool
- アクセスルールの権限を確認する
Properties
$Authentication
public
AuthenticationComponent
$Authentication
$Authentication
public
AuthenticationComponent
$Authentication
$BcMessage
public
BcMessageComponent
$BcMessage
$_View
View
protected
View
$_View
Methods
__construct()
AppController constructor.
public
__construct([ServerRequest|null $request = null ][, Response|null $response = null ][, string|null $name = null ][, EventManagerInterface|null $eventManager = null ][, ComponentRegistry|null $components = null ]) : void|ResponseInterface
Parameters
- $request : ServerRequest|null = null
- $response : Response|null = null
- $name : string|null = null
- $eventManager : EventManagerInterface|null = null
- $components : ComponentRegistry|null = null
Tags
Return values
void|ResponseInterface_blackHoleCallback()
Securityコンポーネントのブラックホールからのコールバック
public
_blackHoleCallback(string $err, mixed $exception) : void
フォーム改ざん対策・CSRF対策・SSL制限・HTTPメソッド制限などへの違反が原因で Securityコンポーネントに"ブラックホールされた"場合の動作を指定する
Parameters
- $err : string
-
エラーの種類
- $exception : mixed
Tags
add()
新規追加
public
add(WidgetAreasServiceInterface $service) : mixed
Parameters
- $service : WidgetAreasServiceInterface
Tags
ajaxError()
Ajax用のエラーを出力する
public
ajaxError([int $errorNo = 500 ][, mixed $message = '' ]) : void
since 5.0.5 このメソッドは非推奨です。
Parameters
- $errorNo : int = 500
-
エラーのステータスコード
- $message : mixed = ''
-
エラーメッセージ
Tags
batch()
メールフィールドのバッチ処理
public
batch(WidgetAreasServiceInterface $service) : mixed
指定したメールフィールドに対して削除、公開、非公開の処理を一括で行う
エラー
受け取ったPOSTデータのキー名'batch'が'delete'以外の値であれば500エラーを発生させる
Parameters
- $service : WidgetAreasServiceInterface
Tags
beforeFilter()
Before Filter
public
beforeFilter(EventInterface $event) : Response|void|null
Parameters
- $event : EventInterface
Tags
Return values
Response|void|nullbeforeRender()
Before render 日本語を Unicode エスケープしないようにする
public
beforeRender(EventInterface $event) : Response|void|null
Parameters
- $event : EventInterface
Tags
Return values
Response|void|nulldelete()
削除
public
delete(WidgetAreasServiceInterface $service, mixed $id) : mixed
Parameters
- $service : WidgetAreasServiceInterface
- $id : mixed
Tags
delete_widget()
[AJAX] ウィジェットを削除
public
delete_widget(WidgetAreasServiceInterface $service, int $widgetAreaId, int $id) : void
Parameters
- $service : WidgetAreasServiceInterface
- $widgetAreaId : int
- $id : int
Tags
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
Return values
bool|Eventedit()
ウィジェットエリア管理 API 編集
public
edit(WidgetAreasService $service, mixed $id) : mixed
Parameters
- $service : WidgetAreasService
- $id : mixed
Tags
getAccessToken()
トークンを取得する
public
getAccessToken(ResultInterface $result) : array<string|int, mixed>
Parameters
- $result : ResultInterface
Tags
Return values
array<string|int, mixed>getService()
Get Service
public
getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
- $service : mixed
Tags
Return values
array<string|int, mixed>|mixed|objecthasService()
Has Service
public
hasService(mixed $service) : bool
Parameters
- $service : mixed
Tags
Return values
boolindex()
一覧取得
public
index(WidgetAreasServiceInterface $service) : mixed
Parameters
- $service : WidgetAreasServiceInterface
Tags
initialize()
Initialize
public
initialize() : void
Tags
isAdminApiEnabled()
認証が必要なAPIを利用可能かどうか判定
public
isAdminApiEnabled() : bool
Tags
Return values
boolisAvailableUser()
ログインユーザーが有効か判定する
public
isAvailableUser() : bool
サービスクラス、または、テーブルクラスにおいて、isAvailable / get メソッドが 存在するかを確認し、あれば実行し、その結果を返す。 ない場合は、 true を返却する
Tags
Return values
boollist()
リストデータ取得
public
list(WidgetAreasServiceInterface $service) : mixed
Parameters
- $service : WidgetAreasServiceInterface
Tags
notFound()
NOT FOUNDページを出力する
public
notFound() : void
Tags
redirectIfIsRequireMaintenance()
メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
public
redirectIfIsRequireMaintenance() : Response|void|null
Tags
Return values
Response|void|nullsetTitle()
Set Title
public
setTitle(string $title) : void
Parameters
- $title : string
Tags
setupFrontView()
フロント用のViewクラスをセットアップする
public
setupFrontView() : void
Tags
update_sort()
並び順を更新する
public
update_sort(WidgetAreasServiceInterface $service, int $widgetAreaId) : void
Parameters
- $service : WidgetAreasServiceInterface
- $widgetAreaId : int
Tags
update_title()
[AJAX] タイトル更新
public
update_title(WidgetAreasServiceInterface $service, int $widgetAreaId) : void
Parameters
- $service : WidgetAreasServiceInterface
- $widgetAreaId : int
Tags
update_widget()
[AJAX] ウィジェット更新
public
update_widget(WidgetAreasServiceInterface $service, int $widgetAreaId) : void
Parameters
- $service : WidgetAreasServiceInterface
- $widgetAreaId : int
Tags
view()
[API] 単一データ取得
public
view(WidgetAreasServiceInterface $service, mixed $id) : mixed
Parameters
- $service : WidgetAreasServiceInterface
- $id : mixed
Tags
viewClasses()
View classes
public
viewClasses() : array<string|int, string>
Tags
Return values
array<string|int, string>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
saveDblog()
データベースログを記録する
protected
saveDblog(string $message) : EntityInterface
Parameters
- $message : string
Tags
Return values
EntityInterfacesaveViewConditions()
画面の情報をセッションに保存する
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
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
__cleanupQueryParams()
クエリーパラメーターの調整 環境によって?キーにamp;が付加されてしまうため
private
__cleanupQueryParams() : void
Tags
checkPermission()
アクセスルールの権限を確認する
private
checkPermission() : bool
現在アクセスしているURLについて権限があるかどうかを確認する。