baserCMS クラスリファレンス

CustomContentHelper extends CustomContentAppHelper
in package

Application

Uses BcContainerTrait

CustomContentHelper

Properties

$BcBaser : BcBaserHelper
$BcTime : BcTimeHelper
$helpers : array<string|int, string>: ヘルパ
$cacheLinks : array<string|int, mixed>: カスタムリンクのキャッシュ

Methods

__construct() : mixed: Constructor
clearCacheLinks() : mixed: 関連リンクのエンティティキャッシュを削除する
description() : mixed: カスタムコンテンツの説明文を出力する
descriptionExists() : bool: カスタムコンテンツに説明文が存在するか判定する
entryTitle() : mixed: カスタムエントリーのタイトルを週ty録する
getDescription() : string: カスタムコンテンツの説明文を取得する
getEntryTitle() : string: カスタムエントリーのタイトルを取得する
getEntryUrl() : mixed|string: カスタムエントリーのURLを取得する
getField() : false: Get Field
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: Is Loop
loadPluginHelper() : void: プラグインのヘルパーを読み込む
published() : mixed: カスタムエントリーの公開日を出力する
searchControl() : string: 検索コントロールを取得
title() : void: カスタムコンテンツのタイトルを出力する

$BcBaser


    public
        BcBaserHelper
    $BcBaser

$BcTime


    public
        BcTimeHelper
    $BcTime

$helpers

ヘルパ


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

$cacheLinks

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


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

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

__construct()

Constructor


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

Parameters

$view : View
$config : array<string|int, mixed> = []

clearCacheLinks()

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


    public
                    clearCacheLinks() : mixed

description()

カスタムコンテンツの説明文を出力する


    public
                    description(CustomContent $content) : mixed

Parameters

$content : CustomContent

descriptionExists()

カスタムコンテンツに説明文が存在するか判定する


    public
                    descriptionExists(CustomContent $content) : bool

Parameters

$content : CustomContent

Return values

bool

entryTitle()

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


    public
                    entryTitle(CustomEntry $entry[, array<string|int, mixed> $options = [] ]) : mixed

Parameters

$entry : CustomEntry

$options : array<string|int, mixed> = []

link: 詳細ページへのリンクタグとして出力するかどうか（初期値：true）

getDescription()

カスタムコンテンツの説明文を取得する


    public
                    getDescription(CustomContent $content) : string

Parameters

$content : CustomContent

Return values

string

getEntryTitle()

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


    public
                    getEntryTitle(CustomEntry $entry) : string

Parameters

$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

getField()

Get Field


    public
                    getField(int $tableId, string $fieldName) : false

Parameters

$tableId : int
$fieldName : string

Return values

false

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

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>

getLink()

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


    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

getLinks()

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


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

Parameters

$tableId : int
$isThreaded : bool = true

getPublished()

カスタムエントリーの公開日を取得する


    public
                    getPublished(CustomEntry $entry) : string

Parameters

$entry : CustomEntry

Return values

string

getService()

Get Service


    public
                    getService( $service) : array<string|int, mixed>|mixed|object

Parameters

$service :

Return values

array<string|int, mixed>|mixed|object

getTitle()

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


    public
                    getTitle() : string

Return values

string

hasService()

Has Service


    public
                    hasService( $service) : bool

Parameters

$service :

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

isLoop()

Is Loop


    public
                    isLoop(CustomEntry $customEntry, string $fieldName) : bool

Parameters

$customEntry : CustomEntry
$fieldName : string

Return values

bool

loadPluginHelper()

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


    public
                    loadPluginHelper() : void

published()

カスタムエントリーの公開日を出力する


    public
                    published(CustomEntry $entry) : mixed

Parameters

$entry : CustomEntry

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

CustomContentHelper extends CustomContentAppHelper in package Application Uses BcContainerTrait

Table of Contents

Properties

Methods

Properties

$BcBaser

$BcTime

$helpers

$cacheLinks

Methods

__construct()

Parameters

Tags

clearCacheLinks()

Tags

description()

Parameters

Tags

descriptionExists()

Parameters

Tags

Return values

entryTitle()

Parameters

Tags

getDescription()

Parameters

Tags

Return values

getEntryTitle()

Parameters

Tags

Return values

getEntryUrl()

Parameters

Tags

Return values

getField()

Parameters

Tags

Return values

getFieldTitle()

Parameters

Tags

Return values

getFieldValue()

Parameters

Tags

Return values

getLink()

Parameters

Tags

Return values

getLinkChildren()

Parameters

Tags

Return values

getLinks()

Parameters

Tags

getPublished()

Parameters

Tags

Return values

getService()

Parameters

Tags

Return values

getTitle()

Tags

Return values

hasService()

Parameters

Tags

Return values

isDisplayEntrySearch()

Parameters

Tags

Return values

isDisplayField()

CustomContentHelper extends CustomContentAppHelper
in package

Application

Uses BcContainerTrait