baserCMS クラスリファレンス

PagesController extends BcAdminAppController
in package

Application

PagesController

Properties

$Authentication : AuthenticationComponent
$Authentication : AuthenticationComponent
$BcMessage : BcMessageComponent
$_View : View: View

Methods

__construct() : void|ResponseInterface: AppController constructor.
_blackHoleCallback() : void: Securityコンポーネントのブラックホールからのコールバック
add() : void|ResponseInterface: 固定ページ新規追加
ajaxError() : void: Ajax用のエラーを出力する
beforeFilter() : Response|void|null: Before Filter
beforeRender() : Response|void|null: Before Render
dispatchLayerEvent() : bool|Event: イベントを発火
edit() : mixed: [ADMIN] 固定ページ情報編集
getService() : array<string|int, mixed>|mixed|object: Get Service
hasService() : bool: Has Service
initialize() : void: initialize
notFound() : void: NOT FOUNDページを出力する
redirectIfIsNotSameSite() : Response|void|null: siteUrlや、cmsUrlと現在のURLが違う場合には、そちらのURLにリダイレクトを行う setting.php にて、cmsUrlとして、cmsUrlを定義した場合にはそちらを優先する
redirectIfIsRequireMaintenance() : Response|void|null: メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
setTitle() : void: Set Title
setupFrontView() : void: フロント用のViewクラスをセットアップする
_checkReferer() : bool: リファラチェックを行う
loadViewConditions() : void: 画面の情報をセッションから読み込む
saveDblog() : EntityInterface: データベースログを記録する
saveViewConditions() : void: 画面の情報をセッションに保存する
setAdminTheme() : void: 管理画面用テーマをセットする
setHelp() : void: Set Help
setSearch() : void: Set Search
setViewConditions() : void: 画面の情報をセットする
__cleanupQueryParams() : void: クエリーパラメーターの調整環境によって？キーにamp;が付加されてしまうため
__updateFirstAccess() : void: 初回アクセスメッセージ用のフラグを更新する
checkPermission() : bool: アクセスルールの権限を確認する

$Authentication


    public
        AuthenticationComponent
    $Authentication

$Authentication


    public
        AuthenticationComponent
    $Authentication

$BcMessage


    public
        BcMessageComponent
    $BcMessage

$_View

View


    protected
        View
    $_View

__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

Return values

void|ResponseInterface

_blackHoleCallback()

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


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

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

Parameters

$err : string: エラーの種類
$exception : mixed

add()

固定ページ新規追加


    public
                    add(PagesAdminServiceInterface $service, ContentsServiceInterface $contentsService, int $parentContentId[, string $name = '' ]) : void|ResponseInterface

Parameters

$service : PagesAdminServiceInterface
$contentsService : ContentsServiceInterface
$parentContentId : int: 親コンテンツID
$name : string = ''

Return values

void|ResponseInterface

ajaxError()

Ajax用のエラーを出力する


    public
                    ajaxError([int $errorNo = 500 ][, mixed $message = '' ]) : void

since 5.0.5 このメソッドは非推奨です。

Parameters

$errorNo : int = 500: エラーのステータスコード
$message : mixed = '': エラーメッセージ

beforeFilter()

Before Filter


    public
                    beforeFilter(EventInterface $event) : Response|void|null

Parameters

$event : EventInterface

Return values

Response|void|null

beforeRender()

Before Render


    public
                    beforeRender(EventInterface $event) : Response|void|null

Parameters

$event : EventInterface

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 = []

Return values

bool|Event

edit()

[ADMIN] 固定ページ情報編集


    public
                    edit(PagesServiceInterface $service, ContentsServiceInterface $contentsService, int $id) : mixed

Parameters

$service : PagesServiceInterface
$contentsService : ContentsServiceInterface
$id : int: ページID

getService()

Get Service


    public
                    getService(mixed $service) : array<string|int, mixed>|mixed|object

Parameters

$service : mixed

Return values

array<string|int, mixed>|mixed|object

hasService()

Has Service


    public
                    hasService(mixed $service) : bool

Parameters

$service : mixed

Return values

bool

initialize()

initialize


    public
                    initialize() : void

notFound()

NOT FOUNDページを出力する


    public
                    notFound() : void

redirectIfIsNotSameSite()

siteUrlや、cmsUrlと現在のURLが違う場合には、そちらのURLにリダイレクトを行う setting.php にて、cmsUrlとして、cmsUrlを定義した場合にはそちらを優先する


    public
                    redirectIfIsNotSameSite() : Response|void|null

Return values

Response|void|null

redirectIfIsRequireMaintenance()

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


    public
                    redirectIfIsRequireMaintenance() : Response|void|null

Return values

Response|void|null

setTitle()

Set Title


    public
                    setTitle(string $title) : void

Parameters

$title : string

setupFrontView()

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


    public
                    setupFrontView() : void

_checkReferer()

リファラチェックを行う


    protected
                    _checkReferer() : bool

Return values

bool

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）

saveDblog()

データベースログを記録する


    protected
                    saveDblog(string $message) : EntityInterface

Parameters

$message : string

Return values

EntityInterface

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）

setAdminTheme()

管理画面用テーマをセットする


    protected
                    setAdminTheme() : void

優先順位 BcSiteConfig::get('admin_theme') > Configure::read('BcApp.adminTheme')

setHelp()

Set Help


    protected
                    setHelp(string $template) : void

Parameters

$template : string

setSearch()

Set Search


    protected
                    setSearch(string $template) : void

Parameters

$template : string

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）

__cleanupQueryParams()

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


    private
                    __cleanupQueryParams() : void

__updateFirstAccess()

初回アクセスメッセージ用のフラグを更新する


    private
                    __updateFirstAccess() : void

checkPermission()

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


    private
                    checkPermission() : bool

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

Return values

bool

PagesController extends BcAdminAppController in package Application

Table of Contents

Properties

Methods

Properties

$Authentication

$Authentication

$BcMessage

$_View

Methods

__construct()

Parameters

Tags

Return values

_blackHoleCallback()

Parameters

Tags

add()

Parameters

Tags

Return values

ajaxError()

Parameters

Tags

beforeFilter()

Parameters

Tags

Return values

beforeRender()

Parameters

Tags

Return values

dispatchLayerEvent()

Parameters

Tags

Return values

edit()

Parameters

Tags

getService()

Parameters

Tags

Return values

hasService()

Parameters

Tags

Return values

initialize()

Tags

notFound()

Tags

redirectIfIsNotSameSite()

Tags

Return values

redirectIfIsRequireMaintenance()

Tags

Return values

setTitle()

Parameters

Tags

setupFrontView()

Tags

_checkReferer()

Tags

Return values

loadViewConditions()

Parameters

Tags

saveDblog()

Parameters

Tags

Return values

saveViewConditions()

Parameters

Tags

setAdminTheme()

Tags

setHelp()

Parameters

Tags

PagesController extends BcAdminAppController
in package

Application