baserCMS クラスリファレンス

SearchIndexesController extends BcAdminApiController
in package

Application

SearchIndicesController

Properties

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

Methods

__construct() : void|ResponseInterface: AppController constructor.
_blackHoleCallback() : void: Securityコンポーネントのブラックホールからのコールバック
ajaxError() : void: Ajax用のエラーを出力する
batch() : mixed: バッチ処理
beforeFilter() : Response|void: Before filter
beforeRender() : Response|void|null: Before render 日本語を Unicode エスケープしないようにする
change_priority() : mixed: [AJAX] 優先順位を変更する
delete() : mixed: [API] 検索インデックス削除
dispatchLayerEvent() : bool|Event: イベントを発火
getAccessToken() : array<string|int, mixed>: トークンを取得する
getService() : array<string|int, mixed>|mixed|object: Get Service
hasService() : bool: Has Service
index() : mixed: [API] 検索インデックス一覧取得
initialize() : void: Initialize
isAdminApiEnabled() : bool: 認証が必要なAPIを利用可能かどうか判定
isAvailableUser() : bool: ログインユーザーが有効か判定する
notFound() : void: NOT FOUNDページを出力する
reconstruct() : mixed
redirectIfIsRequireMaintenance() : Response|void|null: メンテナンス画面へのリダイレクトが必要な場合にリダイレクトする
setTitle() : void: Set Title
setupFrontView() : void: フロント用のViewクラスをセットアップする
viewClasses() : array<string|int, string>: View classes
loadViewConditions() : void: 画面の情報をセッションから読み込む
saveDblog() : EntityInterface: データベースログを記録する
saveViewConditions() : void: 画面の情報をセッションに保存する
setViewConditions() : void: 画面の情報をセットする
__cleanupQueryParams() : void: クエリーパラメーターの調整環境によって？キーにamp;が付加されてしまうため
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

ajaxError()

Ajax用のエラーを出力する


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

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

Parameters

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

batch()

バッチ処理


    public
                    batch(SearchIndexesServiceInterface $service) : mixed

Parameters

$service : SearchIndexesServiceInterface

beforeFilter()

Before filter


    public
                    beforeFilter(EventInterface $event) : Response|void

Parameters

$event : EventInterface

Return values

Response|void

beforeRender()

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


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

Parameters

$event : EventInterface

Return values

Response|void|null

change_priority()

[AJAX] 優先順位を変更する


    public
                    change_priority(SearchIndexesServiceInterface $service, mixed $id) : mixed

Parameters

$service : SearchIndexesServiceInterface
$id : mixed

delete()

[API] 検索インデックス削除


    public
                    delete(SearchIndexesServiceInterface $searchIndexesService, mixed $id) : mixed

Parameters

$searchIndexesService : SearchIndexesServiceInterface
$id : mixed

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

getAccessToken()

トークンを取得する


    public
                    getAccessToken(ResultInterface $result) : array<string|int, mixed>

Parameters

$result : ResultInterface

Return values

array<string|int, mixed>

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

index()

[API] 検索インデックス一覧取得


    public
                    index(SearchIndexesServiceInterface $searchIndexesService) : mixed

認証なしでアクセスできるが、公開状態のもののみ取得可能。

URL

/baser/api/bc-search-index/search_indexes/index.json

クエリパラメーター（カッコ内は省略形）

keyword(q): 検索キーワード
site_id(s): サイトID
content_id(c): コンテンツID
content_filter_id(cf): コンテンツフィルダーID
type: コンテンツタイプ
model(m): モデル名（エンティティ名）
priority: 優先度
folder_id(f): フォルダーID

レスポンス

searchIndexes: 検索インデックスの一覧

Parameters

$searchIndexesService : SearchIndexesServiceInterface

initialize()

Initialize


    public
                    initialize() : void

isAdminApiEnabled()

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


    public
                    isAdminApiEnabled() : bool

Return values

bool

isAvailableUser()

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


    public
                    isAvailableUser() : bool

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

Return values

bool

notFound()

NOT FOUNDページを出力する


    public
                    notFound() : void

reconstruct()


    public
                    reconstruct(SearchIndexesServiceInterface $searchIndexesService) : mixed

Parameters

$searchIndexesService : SearchIndexesServiceInterface

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

viewClasses()

View classes


    public
                    viewClasses() : array<string|int, string>

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）

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）

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

checkPermission()

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


    private
                    checkPermission() : bool

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

Return values

bool

SearchIndexesController extends BcAdminApiController in package Application

Table of Contents

Properties

Methods

Properties

$Authentication

$Authentication

$BcMessage

$_View

Methods

__construct()

Parameters

Tags

Return values

_blackHoleCallback()

Parameters

Tags

ajaxError()

Parameters

Tags

batch()

Parameters

Tags

beforeFilter()

Parameters

Tags

Return values

beforeRender()

Parameters

Tags

Return values

change_priority()

Parameters

Tags

delete()

Parameters

Tags

dispatchLayerEvent()

Parameters

Tags

Return values

getAccessToken()

Parameters

Tags

Return values

getService()

Parameters

Tags

Return values

hasService()

Parameters

Tags

Return values

index()

URL

クエリパラメーター（カッコ内は省略形）

レスポンス

Parameters

Tags

initialize()

Tags

isAdminApiEnabled()

Tags

Return values

isAvailableUser()

Tags

Return values

notFound()

Tags

reconstruct()

Parameters

redirectIfIsRequireMaintenance()

Tags

Return values

setTitle()

Parameters

Tags

setupFrontView()

Tags

viewClasses()

SearchIndexesController extends BcAdminApiController
in package

Application