baserCMS クラスリファレンス

UtilitiesController extends BcAdminApiController
in package

Class UtilitiesController

Table of Contents

Properties

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

Methods

__construct()  : void|ResponseInterface
AppController constructor.
_blackHoleCallback()  : void
Securityコンポーネントのブラックホールからのコールバック
ajaxError()  : void
Ajax用のエラーを出力する
beforeFilter()  : Response|void|null
Before Filter
beforeRender()  : Response|void|null
Before render 日本語を Unicode エスケープしないようにする
clear_cache()  : mixed
[API] サーバーキャッシュを削除する
delete_log()  : mixed
[API] ユーティリティ：ログファイルを削除
dispatchLayerEvent()  : bool|Event
イベントを発火
download_backup()  : mixed
[API] ユーティリティ：バックアップダウンロード
download_log()  : mixed
[API] ユーティリティ：ログファイルダウンロード
getAccessToken()  : array<string|int, mixed>
トークンを取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
hasService()  : bool
Has Service
initialize()  : void
Initialize
isAdminApiEnabled()  : bool
認証が必要なAPIを利用可能かどうか判定
isAvailableUser()  : bool
ログインユーザーが有効か判定する
notFound()  : void
NOT FOUNDページを出力する
redirectIfIsRequireMaintenance()  : Response|void|null
メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
reset_contents_tree()  : mixed
[API] ユーティリティ：ツリー構造リセット
restore_db()  : mixed
[API] ユーティリティ：バックアップよりレストア
save_search_opened()  : void
検索ボックスの表示状態を保存する
setTitle()  : void
Set Title
setupFrontView()  : void
フロント用のViewクラスをセットアップする
verity_contents_tree()  : 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

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
checked
noTodo
unitTest
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
Tags
throws
Exception
checked
noTodo
unitTest
Return values
Response|void|null

beforeRender()

Before render 日本語を Unicode エスケープしないようにする

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

clear_cache()

[API] サーバーキャッシュを削除する

public clear_cache() : mixed
Tags
checked
unitTest
noTodo

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(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

isAdminApiEnabled()

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

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

isAvailableUser()

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

public isAvailableUser() : bool

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

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

save_search_opened()

検索ボックスの表示状態を保存する

public save_search_opened(string $key[, mixed $open = '' ]) : void
Parameters
$key : string

キー

$open : mixed = ''

1 Or ''

Tags
checked
noTodo
unitTest

setTitle()

Set Title

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

setupFrontView()

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

public setupFrontView() : void
Tags
checked
noTodo
unitTest

viewClasses()

View classes

public viewClasses() : array<string|int, string>
Tags
checked
noTodo
unitTest
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
see

setViewConditions, saveViewConditions

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

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

checkPermission()

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

private checkPermission() : bool

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

Tags
noTodo
checked
unitTest
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results