CustomContentAdminHelper
extends CustomContentAppHelper
in package
CustomContentAdminHelper
Table of Contents
- $BcAdminForm : BcAdminFormHelper
- $BcBaser : BcBaserHelper
- $helpers : array<string|int, string>
- Helper
- __construct() : mixed
- Constructor
- afterHead() : string
- 後見出しを表示する
- attention() : string
- 注意書きを表示する
- beforeHead() : string
- 前見出しを表示する
- control() : string
- フィールドのコントロールを取得する
- description() : string
- 説明文を表示する
- displayPluginMeta() : mixed
- プラグインのメタフィールドを表示する
- error() : string
- エラー表示を取得
- getEntryColumnsNum() : int
- エントリー一覧のカラム数を取得する
- getEntryIndexTitle() : string
- カスタムエントリー一覧のタイトルを取得する
- getEntryUrl() : mixed|string
- カスタムエントリーのURLを取得する
- getFieldName() : string
- ループを考慮したフィールド名を取得する
- getFields() : Query
- カスタムフィールドの一覧を取得する
- getGroupErrors() : mixed
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- hasService() : bool
- Has Service
- isAllowPublishEntry() : bool
- カスタムエントリーが公開状態かどうか判定
- isDisplayEntryList() : bool
- 管理画面のエントリー一覧に表示するかどうか判定する
- isDisplayEntrySearch() : bool
- エントリー一覧の検索に表示するかどうか判定する
- isEnabledMoveDownEntry() : bool
- カスタムエントリーを下に移動できるか判定
- isEnabledMoveUpEntry() : bool
- カスタムエントリーを上に移動できるか判定
- isEnableField() : bool
- フィールドが有校かどうか判定する
- label() : string
- フィールドのラベルを取得する
- loadPluginHelper() : void
- プラグインのヘルパーを読み込む
- preview() : string
- フィールドのコントロールを取得する
- required() : string
- フィールドの必須マークを取得する
- searchControl() : string
- 検索コントロールを取得
Properties
$BcAdminForm
public
BcAdminFormHelper
$BcAdminForm
$BcBaser
public
BcBaserHelper
$BcBaser
$helpers
Helper
public
array<string|int, string>
$helpers
= ['BaserCore.BcBaser', 'BaserCore.BcAdminForm']
Methods
__construct()
Constructor
public
__construct(View $view[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
- $view : View
- $config : array<string|int, mixed> = []
Return values
mixed —afterHead()
後見出しを表示する
public
afterHead(CustomLink $link) : string
Parameters
- $link : CustomLink
Return values
string —attention()
注意書きを表示する
public
attention(CustomLink $link) : string
Parameters
- $link : CustomLink
Return values
string —beforeHead()
前見出しを表示する
public
beforeHead(CustomLink $link) : string
Parameters
- $link : CustomLink
Return values
string —control()
フィールドのコントロールを取得する
public
control(CustomLink $customLink[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $customLink : CustomLink
- $options : array<string|int, mixed> = []
Return values
string —description()
説明文を表示する
public
description(CustomLink $link) : string
ヘルプ用のツールチップで表示する
Parameters
- $link : CustomLink
Return values
string —displayPluginMeta()
プラグインのメタフィールドを表示する
public
displayPluginMeta() : mixed
Return values
mixed —error()
エラー表示を取得
public
error(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $link : CustomLink
- $options : array<string|int, mixed> = []
Return values
string —getEntryColumnsNum()
エントリー一覧のカラム数を取得する
public
getEntryColumnsNum(array<string|int, mixed> $customLinks) : int
Parameters
- $customLinks : array<string|int, mixed>
Return values
int —getEntryIndexTitle()
カスタムエントリー一覧のタイトルを取得する
public
getEntryIndexTitle(CustomTable $table, CustomEntry $entry) : string
ツリー構造テーブルの場合、見出しフィールドが title に設定されている場合に、リンクを設定する
Parameters
- $table : CustomTable
- $entry : CustomEntry
Return values
string —getEntryUrl()
カスタムエントリーのURLを取得する
public
getEntryUrl(CustomEntry $entry[, mixed $full = true ]) : mixed|string
Parameters
- $entry : CustomEntry
- $full : mixed = true
Return values
mixed|string —getFieldName()
ループを考慮したフィールド名を取得する
public
getFieldName(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $link : CustomLink
- $options : array<string|int, mixed> = []
Return values
string —getFields()
カスタムフィールドの一覧を取得する
public
getFields() : Query
Return values
Query —getGroupErrors()
public
getGroupErrors(CustomLink $link) : mixed
Parameters
- $link : CustomLink
Return values
mixed —getService()
Get Service
public
getService( $service) : array<string|int, mixed>|mixed|object
Parameters
Tags
Return values
array<string|int, mixed>|mixed|object —hasService()
Has Service
public
hasService( $service) : bool
Parameters
Tags
Return values
bool —isAllowPublishEntry()
カスタムエントリーが公開状態かどうか判定
public
isAllowPublishEntry(CustomEntry $entry) : bool
Parameters
- $entry : CustomEntry
Return values
bool —isDisplayEntryList()
管理画面のエントリー一覧に表示するかどうか判定する
public
isDisplayEntryList(CustomLink $customLink) : bool
Parameters
- $customLink : CustomLink
Return values
bool —isDisplayEntrySearch()
エントリー一覧の検索に表示するかどうか判定する
public
isDisplayEntrySearch(CustomLink $customLink[, string $type = 'front' ]) : bool
Parameters
- $customLink : CustomLink
- $type : string = 'front'
Return values
bool —isEnabledMoveDownEntry()
カスタムエントリーを下に移動できるか判定
public
isEnabledMoveDownEntry(ArrayObject $entries, CustomEntry $currentEntry) : bool
Parameters
- $entries : ArrayObject
- $currentEntry : CustomEntry
Return values
bool —isEnabledMoveUpEntry()
カスタムエントリーを上に移動できるか判定
public
isEnabledMoveUpEntry(ArrayObject $entries, CustomEntry $currentEntry) : bool
Parameters
- $entries : ArrayObject
- $currentEntry : CustomEntry
Return values
bool —isEnableField()
フィールドが有校かどうか判定する
public
isEnableField(CustomLink $customLink) : bool
グループフィールドで子がいない場合は無効とする
Parameters
- $customLink : CustomLink
Return values
bool —label()
フィールドのラベルを取得する
public
label(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $link : CustomLink
- $options : array<string|int, mixed> = []
Return values
string —loadPluginHelper()
プラグインのヘルパーを読み込む
public
loadPluginHelper() : void
Return values
void —preview()
フィールドのコントロールを取得する
public
preview(string $fieldName, string $type, CustomField $field) : string
Parameters
- $fieldName : string
- $type : string
- $field : CustomField
Return values
string —required()
フィールドの必須マークを取得する
public
required(CustomLink $link) : string
Parameters
- $link : CustomLink
Return values
string —searchControl()
検索コントロールを取得
public
searchControl(CustomLink $customLink[, array<string|int, mixed> $options = [] ]) : string
Parameters
- $customLink : CustomLink
- $options : array<string|int, mixed> = []