baserCMS クラスリファレンス

CustomContentAdminHelper extends CustomContentAppHelper
in package

CustomContentAdminHelper

Table of Contents

Properties

$BcAdminForm  : BcAdminFormHelper
$BcBaser  : BcBaserHelper
$helpers  : array<string|int, string>
Helper

Methods

__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

$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> = []
Tags
checked
noTodo

control()

フィールドのコントロールを取得する

public control(CustomLink $customLink[, array<string|int, mixed> $options = [] ]) : string
Parameters
$customLink : CustomLink
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
string

description()

説明文を表示する

public description(CustomLink $link) : string

ヘルプ用のツールチップで表示する

Parameters
$link : CustomLink
Tags
checked
noTodo
Return values
string

displayPluginMeta()

プラグインのメタフィールドを表示する

public displayPluginMeta() : mixed
Tags
checked
noTodo

error()

エラー表示を取得

public error(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
$link : CustomLink
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
string

getEntryColumnsNum()

エントリー一覧のカラム数を取得する

public getEntryColumnsNum(array<string|int, mixed> $customLinks) : int
Parameters
$customLinks : array<string|int, mixed>
Tags
checked
noTodo
Return values
int

getEntryIndexTitle()

カスタムエントリー一覧のタイトルを取得する

public getEntryIndexTitle(CustomTable $table, CustomEntry $entry) : string

ツリー構造テーブルの場合、見出しフィールドが title に設定されている場合に、リンクを設定する

Parameters
$table : CustomTable
$entry : CustomEntry
Tags
checked
noTodo
Return values
string

getEntryUrl()

カスタムエントリーのURLを取得する

public getEntryUrl(CustomEntry $entry[, mixed $full = true ]) : mixed|string
Parameters
$entry : CustomEntry
$full : mixed = true
Tags
checked
noTodo
Return values
mixed|string

getFieldName()

ループを考慮したフィールド名を取得する

public getFieldName(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
$link : CustomLink
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
string

getFields()

カスタムフィールドの一覧を取得する

public getFields() : Query
Tags
checked
noTodo
Return values
Query

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

isDisplayEntryList()

管理画面のエントリー一覧に表示するかどうか判定する

public isDisplayEntryList(CustomLink $customLink) : bool
Parameters
$customLink : CustomLink
Tags
checked
noTodo
Return values
bool

isDisplayEntrySearch()

エントリー一覧の検索に表示するかどうか判定する

public isDisplayEntrySearch(CustomLink $customLink[, string $type = 'front' ]) : bool
Parameters
$customLink : CustomLink
$type : string = 'front'
Tags
checked
noTodo
Return values
bool

isEnabledMoveDownEntry()

カスタムエントリーを下に移動できるか判定

public isEnabledMoveDownEntry(ArrayObject $entries, CustomEntry $currentEntry) : bool
Parameters
$entries : ArrayObject
$currentEntry : CustomEntry
Tags
checked
noTodo
Return values
bool

isEnabledMoveUpEntry()

カスタムエントリーを上に移動できるか判定

public isEnabledMoveUpEntry(ArrayObject $entries, CustomEntry $currentEntry) : bool
Parameters
$entries : ArrayObject
$currentEntry : CustomEntry
Tags
checked
noTodo
Return values
bool

isEnableField()

フィールドが有校かどうか判定する

public isEnableField(CustomLink $customLink) : bool

グループフィールドで子がいない場合は無効とする

Parameters
$customLink : CustomLink
Tags
checked
noTodo
Return values
bool

label()

フィールドのラベルを取得する

public label(CustomLink $link[, array<string|int, mixed> $options = [] ]) : string
Parameters
$link : CustomLink
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
string

loadPluginHelper()

プラグインのヘルパーを読み込む

public loadPluginHelper() : void
Tags
checked
noTodo

preview()

フィールドのコントロールを取得する

public preview(string $fieldName, string $type, CustomField $field) : string
Parameters
$fieldName : string
$type : string
$field : CustomField
Tags
checked
noTodo
Return values
string

searchControl()

検索コントロールを取得

public searchControl(CustomLink $customLink[, array<string|int, mixed> $options = [] ]) : string
Parameters
$customLink : CustomLink
$options : array<string|int, mixed> = []
Tags
checked
noTodo
Return values
string

        
On this page

Search results