baserCMS クラスリファレンス

CustomContentHelper extends CustomContentAppHelper
in package
Uses BcContainerTrait

CustomContentHelper

Table of Contents

$BcBaser  : BcBaserHelper
$BcTime  : BcTimeHelper
$helpers  : array<string|int, string>
ヘルパ
$cacheLinks  : array<string|int, mixed>
カスタムリンクのキャッシュ
__construct()  : mixed
Constructor
clearCacheLinks()  : mixed
関連リンクのエンティティキャッシュを削除する
description()  : mixed
カスタムコンテンツの説明文を出力する
descriptionExists()  : bool
カスタムコンテンツに説明文が存在するか判定する
entryTitle()  : mixed
カスタムエントリーのタイトルを週ty録する
getDescription()  : string
カスタムコンテンツの説明文を取得する
getEntryTitle()  : string
カスタムエントリーのタイトルを取得する
getEntryUrl()  : mixed|string
カスタムエントリーのURLを取得する
getField()  : mixed
getFieldTitle()  : array<string|int, mixed>|bool|float|int|mixed|string|null
カスタムエントリーのフィールドのタイトルを取得する
getFieldValue()  : string|array<string|int, mixed>
カスタムエントリーのフィールドの値を取得する
getLink()  : false|mixed
関連リンクのエンティティを取得する
getLinkChildren()  : ResultSetInterface
カスタムリンクの子を取得する
getLinks()  : mixed
関連リンクのエンティティリストを取得する
getPublished()  : string
カスタムエントリーの公開日を取得する
getService()  : array<string|int, mixed>|mixed|object
Get Service
getTitle()  : string
カスタムコンテンツのタイトルを取得する
hasService()  : bool
Has Service
isDisplayEntrySearch()  : bool
エントリー一覧の検索に表示するかどうか判定する
isDisplayField()  : bool
カスタムエントリーのフィールドについて表示対象かどうか判定する
isEnableField()  : bool
フィールドが有校かどうか判定する
isLoop()  : bool
loadPluginHelper()  : void
プラグインのヘルパーを読み込む
published()  : mixed
カスタムエントリーの公開日を出力する
searchControl()  : string
検索コントロールを取得
title()  : void
カスタムコンテンツのタイトルを出力する

Properties

$helpers

ヘルパ

public array<string|int, string> $helpers = ['BaserCore.BcBaser', 'BaserCore.BcTime']

カスタムリンクのキャッシュ

private array<string|int, mixed> $cacheLinks = []

CustomContentHelper::getLinks() で取得、保存 CustomContentHelper::clearCacheLinks() で削除

Methods

__construct()

Constructor

public __construct(View $view[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$view : View
$config : array<string|int, mixed> = []
Return values
mixed

関連リンクのエンティティキャッシュを削除する

public clearCacheLinks() : mixed
Return values
mixed

entryTitle()

カスタムエントリーのタイトルを週ty録する

public entryTitle(CustomEntry $entry[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$entry : CustomEntry
$options : array<string|int, mixed> = []
  • link: 詳細ページへのリンクタグとして出力するかどうか(初期値:true)
Return values
mixed

getEntryUrl()

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

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

getField()

public getField(int $tableId, string $fieldName) : mixed
Parameters
$tableId : int
$fieldName : string
Return values
mixed

getFieldTitle()

カスタムエントリーのフィールドのタイトルを取得する

public getFieldTitle(CustomEntry|array<string|int, mixed> $entry, string $fieldName) : array<string|int, mixed>|bool|float|int|mixed|string|null
Parameters
$entry : CustomEntry|array<string|int, mixed>
$fieldName : string
Return values
array<string|int, mixed>|bool|float|int|mixed|string|null

getFieldValue()

カスタムエントリーのフィールドの値を取得する

public getFieldValue(CustomEntry|array<string|int, mixed> $entry, string $fieldName[, array<string|int, mixed> $options = [] ]) : string|array<string|int, mixed>
Parameters
$entry : CustomEntry|array<string|int, mixed>
$fieldName : string
$options : array<string|int, mixed> = []
Return values
string|array<string|int, mixed>

関連リンクのエンティティを取得する

public getLink(int $tableId, string $fieldName) : false|mixed
Parameters
$tableId : int
$fieldName : string
Return values
false|mixed

getLinkChildren()

カスタムリンクの子を取得する

public getLinkChildren(CustomEntry $customEntry, string $fieldName) : ResultSetInterface
Parameters
$customEntry : CustomEntry
$fieldName : string
Return values
ResultSetInterface

関連リンクのエンティティリストを取得する

public getLinks(int $tableId[, bool $isThreaded = true ]) : mixed
Parameters
$tableId : int
$isThreaded : bool = true
Return values
mixed

getService()

Get Service

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

getTitle()

カスタムコンテンツのタイトルを取得する

public getTitle() : string
Return values
string

hasService()

Has Service

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

isDisplayEntrySearch()

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

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

isDisplayField()

カスタムエントリーのフィールドについて表示対象かどうか判定する

public isDisplayField(CustomEntry $entry, string $fieldName) : bool
Parameters
$entry : CustomEntry
$fieldName : string
Return values
bool

isEnableField()

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

public isEnableField(CustomLink $customLink) : bool

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

Parameters
$customLink : CustomLink
Return values
bool

loadPluginHelper()

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

public loadPluginHelper() : void
Return values
void

searchControl()

検索コントロールを取得

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

title()

カスタムコンテンツのタイトルを出力する

public title() : void
Return values
void

Search results