baserCMS クラスリファレンス

BurgerEditorController extends BcAdminAppController
in package

BurgerEditorController

Table of Contents

Properties

$Authentication  : AuthenticationComponent
$BcMessage  : BcMessageComponent
$imgSizeWidthDefault  : mixed
$imgSizeWidthMax  : mixed
$imgSizeWidthSmall  : mixed
$isUse  : mixed
$_View  : View
View
$BurgerEditorService  : BurgerEditorService
BurgerEditorService
$fileDataMaxSize  : mixed
$fileListPerPage  : mixed
$imageDataMaxsize  : mixed
$imageListPerPage  : mixed
$imgExts  : mixed

Methods

__construct()  : void|ResponseInterface
Constructor
_blackHoleCallback()  : void
Securityコンポーネントのブラックホールからのコールバック
ajaxError()  : void
Ajax用のエラーを出力する
beforeFilter()  : Response|void|null
before filter
beforeRender()  : Response|void|null
Before Render
dispatchLayerEvent()  : bool|Event
イベントを発火
file_delete()  : Response
アップロードファイル削除
file_list()  : Response
アップロードファイル一覧取得
file_upload()  : Response
ファイルアップロード
get_filename()  : Response
base64encodeされたファイル名をdecodeして変換
getService()  : array<string|int, mixed>|mixed|object
Get Service
hasService()  : bool
Has Service
img_delete()  : Response
アップロードファイル削除
img_list()  : Response
アップロード画像一覧取得
img_upload()  : Response
画像ファイルアップロード
initialize()  : void
Initialize
notFound()  : void
NOT FOUNDページを出力する
redirectIfIsNotSameSite()  : Response|void|null
siteUrlや、cmsUrlと現在のURLが違う場合には、そちらのURLにリダイレクトを行う setting.php にて、cmsUrlとして、cmsUrlを定義した場合にはそちらを優先する
redirectIfIsRequireMaintenance()  : Response|void|null
メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
requirePermission()  : bool
パーミッションが必要かどうかを確認する
setTitle()  : void
Set Title
setupFrontView()  : void
フロント用のViewクラスをセットアップする
_checkReferer()  : bool
リファラチェックを行う
getFormatedImageList()  : array<string|int, mixed>
JSON変換用画像ファイルリストを取得する
getFormatedOtherList()  : array<string|int, mixed>
JSON変換用ファイルリストを取得する
loadViewConditions()  : void
画面の情報をセッションから読み込む
restrictNonPublicAccess()  : void
未認証ユーザーによる非公開データへのアクセスを制限する
saveDblog()  : EntityInterface
データベースログを記録する
saveViewConditions()  : void
画面の情報をセッションに保存する
setAdminTheme()  : void
管理画面用テーマをセットする
setHelp()  : void
Set Help
setSearch()  : void
Set Search
setViewConditions()  : void
画面の情報をセットする

Properties

Methods

__construct()

Constructor

public __construct([mixed $request = null ][, mixed $response = null ]) : void|ResponseInterface
Parameters
$request : mixed = null
$response : mixed = null
Return values
void|ResponseInterface

_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

ajaxError()

Ajax用のエラーを出力する

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

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

Parameters
$errorNo : int = 500

エラーのステータスコード

$message : mixed = ''

エラーメッセージ

Tags
checked
noTodo
unitTest

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
Tags
checked
unitTest
noTodo
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

file_delete()

アップロードファイル削除

public file_delete() : Response
Return values
Response

file_list()

アップロードファイル一覧取得

public file_list() : Response
Return values
Response

file_upload()

ファイルアップロード

public file_upload() : Response
Return values
Response

get_filename()

base64encodeされたファイル名をdecodeして変換

public get_filename(mixed $encodedFileName) : Response
Parameters
$encodedFileName : mixed
Return values
Response

getService()

Get Service

public getService(mixed $service) : array<string|int, mixed>|mixed|object
Parameters
$service : mixed
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed>|mixed|object

hasService()

Has Service

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

img_delete()

アップロードファイル削除

public img_delete() : Response
Return values
Response

img_list()

アップロード画像一覧取得

public img_list() : Response
Return values
Response

img_upload()

画像ファイルアップロード

public img_upload() : Response
Return values
Response

initialize()

Initialize

public initialize() : void
Tags
checked
unitTest
note

(value="インストーラーを実装してから対応する")

notFound()

NOT FOUNDページを出力する

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

redirectIfIsNotSameSite()

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

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

redirectIfIsRequireMaintenance()

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

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

requirePermission()

パーミッションが必要かどうかを確認する

public requirePermission(ServerRequest $request) : bool

デフォルトは true であるが、設定ファイルで明示的に false に 設定されている場合は false となる。

Parameters
$request : ServerRequest
Return values
bool

setTitle()

Set Title

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

setupFrontView()

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

public setupFrontView() : void
Tags
checked
noTodo
unitTest

_checkReferer()

リファラチェックを行う

protected _checkReferer() : bool
Tags
checked
noTodo
unitTest
Return values
bool

getFormatedImageList()

JSON変換用画像ファイルリストを取得する

protected getFormatedImageList([mixed $searchWord = null ][, mixed $targetPage = null ][, mixed $selectedFilePath = null ][, mixed $pageNum = 10 ]) : array<string|int, mixed>
Parameters
$searchWord : mixed = null
$targetPage : mixed = null
$selectedFilePath : mixed = null
$pageNum : mixed = 10
Return values
array<string|int, mixed>

getFormatedOtherList()

JSON変換用ファイルリストを取得する

protected getFormatedOtherList([mixed $searchWord = null ][, mixed $targetPage = null ][, mixed $selectedFilePath = null ][, mixed $pageNum = 10 ]) : array<string|int, mixed>
Parameters
$searchWord : mixed = null
$targetPage : mixed = null
$selectedFilePath : mixed = null
$pageNum : mixed = 10
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

restrictNonPublicAccess()

未認証ユーザーによる非公開データへのアクセスを制限する

protected restrictNonPublicAccess() : void

未認証ユーザーが preview / status を利用して非公開データを閲覧することを防ぐ。 デフォルト（フロント・管理画面）では、未認証時にこれらのパラメータを除去し、 公開データのみに強制する。認証済み（正規のプレビュー機能を含む）はそのまま許可する。 API では BcApiController でオーバーライドし、preview を拒否（Forbidden）する。

Tags
noTodo
checked
unitTest

saveDblog()

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

protected saveDblog(string $message) : EntityInterface
Parameters
$message : string
Tags
checked
unitTest
noTodo
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）
Tags
see
setViewConditions
checked
noTodo
unitTest

setAdminTheme()

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

protected setAdminTheme() : void

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

Tags
checked
noTodo
unitTest

setHelp()

Set Help

protected setHelp(string $template) : void
Parameters
$template : string
Tags
checked
noTodo
unitTest

setSearch()

Set Search

protected setSearch(string $template) : void
Parameters
$template : string
Tags
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
On this page

Search results