BcContentsHelper
extends Helper
in package
Uses
BcEventDispatcherTrait, BcContainerTrait
コンテンツヘルパ
Table of Contents
- $_Contents : ContentsTable
- $helpers : array<string|int, mixed>
- Helper
- $PermissionsService : PermissionsService
- $_View : View
- View
- _getIconUrl() : string
- アイコンのURLを取得する
- dispatchLayerEvent() : bool|Event
- イベントを発火
- getContentByEntityId() : array<string|int, mixed>|string|bool
- エンティティIDからコンテンツの情報を取得
- getContentByUrl() : array<string|int, mixed>|string|bool
- urlからコンテンツの情報を取得
- getContentFolderList() : array<string|int, mixed>|bool
- フォルダリストを取得する
- getCurrentContent() : false|Site
- フロントページにおいて現在のコンテンツを取得する
- getCurrentRelatedSiteUrl() : mixed|string
- 現在のURLを元に指定したサブサイトのURLを取得する
- getCurrentSite() : false|Site
- フロントページにおいて現在のサイトを取得する
- getFolderLinkedUrl() : string
- 対象コンテンツが属するフォルダまでのフルパスを取得する フォルダ名称部分にはフォルダ編集画面へのリンクを付与する コンテンツ編集画面で利用
- getJsonItems() : string
- コンテンツ設定を Json 形式で取得する
- getNextLink() : mixed
- フォルダ内の次のコンテンツへのリンクを取得する
- getParent() : EntityInterface|array<string|int, mixed>|false
- 親コンテンツを取得する
- getPrevLink() : string|false
- フォルダ内の前のコンテンツへのリンクを取得する
- getPublishedSites() : ResultSetInterface
- 公開状態のサイトを全て取得する
- getPureUrl() : mixed
- プレフィックスなしのURLを取得する
- getRelatedSiteContents() : array<string|int, mixed>
- 関連サイトのコンテンツを取得
- getRelatedSiteLinks() : array<string|int, mixed>
- 関連サイトのリンク情報を取得する
- getService() : array<string|int, mixed>|mixed|object
- Get Service
- getSiteRoot() : Content
- サイトIDからサイトルートとなるコンテンツを取得する
- getSiteRootId() : string|bool
- サイトIDからサイトルートとなるコンテンツIDを取得する
- getTree() : mixed
- コンテンツリストをツリー構造で取得する
- getUrl() : string
- コンテンツ管理上のURLを元に正式なURLを取得する
- getUrlById() : mixed
- コンテンツIDよりフルURLを取得する
- hasService() : bool
- Has Service
- initialize() : void
- initialize
- isActionAvailable() : bool
- アクションが利用可能かどうか確認する
- isAllowPublish() : mixed
- データが公開状態にあるか確認する
- isEditable() : bool
- コンテンツが編集可能かどうか確認
- isFolder() : bool
- フォルダかどうか確認する
- isParentId() : bool
- IDがコンテンツ自身の親のIDかを判定する
- isSiteRelated() : bool
- サイト連携データかどうか確認する
- nextLink() : mixed
- フォルダ内の次のコンテンツへのリンクを出力する
- prevLink() : void
- フォルダ内の前のコンテンツへのリンクを出力する
- setup() : mixed
- セットアップ
- _getExistsTitles() : array<string|int, mixed>
- シングルコンテンツで既に登録済のタイトルを取得する
- getPageNeighbors() : array<string|int, mixed>
- 指定した固定ページデータの次、または、前のデータを取得する
- _getContent() : array<string|int, mixed>|EntityInterface|false|mixed
- 条件を指定してコンテンツを取得する フィールドを指定した場合はフィールドの値を取得する
Properties
$_Contents
public
ContentsTable
$_Contents
$helpers
Helper
public
array<string|int, mixed>
$helpers
= ['BcBaser']
$PermissionsService
public
PermissionsService
$PermissionsService
$_View
View
protected
View
$_View
Methods
_getIconUrl()
アイコンのURLを取得する
public
_getIconUrl(mixed $plugin, $type, $file[, null $suffix = null ]) : string
Parameters
Return values
string —dispatchLayerEvent()
イベントを発火
public
dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
- $name : string
- $data : array<string|int, mixed> = []
- $options : mixed = []
Tags
Return values
bool|Event —getContentByEntityId()
エンティティIDからコンテンツの情報を取得
public
getContentByEntityId(int $id, string $contentType[, string $field = null ]) : array<string|int, mixed>|string|bool
Parameters
- $id : int
-
エンティティID
- $contentType : string
-
コンテンツタイプ ('Page','MailContent','BlogContent','ContentFolder')
- $field : string = null
-
取得したい値 'name','url','title'など 初期値：Null 省略した場合配列を取得
Return values
array<string|int, mixed>|string|bool —getContentByUrl()
urlからコンテンツの情報を取得
public
getContentByUrl(string $url, string $contentType[, string $field = null ]) : array<string|int, mixed>|string|bool
Parameters
- $url : string
- $contentType : string
-
コンテンツタイプ ('Page','MailContent','BlogContent','ContentFolder')
- $field : string = null
-
取得したい値 'name','url','title'など 初期値：Null 省略した場合配列を取得
Tags
Return values
array<string|int, mixed>|string|bool —getContentFolderList()
フォルダリストを取得する
public
getContentFolderList([int $siteId = null ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|bool
Parameters
- $siteId : int = null
- $options : array<string|int, mixed> = []
Return values
array<string|int, mixed>|bool —getCurrentContent()
フロントページにおいて現在のコンテンツを取得する
public
getCurrentContent() : false|Site
Tags
Return values
false|Site —getCurrentRelatedSiteUrl()
現在のURLを元に指定したサブサイトのURLを取得する
public
getCurrentRelatedSiteUrl(string $siteName) : mixed|string
Parameters
- $siteName : string
Return values
mixed|string —getCurrentSite()
フロントページにおいて現在のサイトを取得する
public
getCurrentSite() : false|Site
Tags
Return values
false|Site —getFolderLinkedUrl()
対象コンテンツが属するフォルダまでのフルパスを取得する フォルダ名称部分にはフォルダ編集画面へのリンクを付与する コンテンツ編集画面で利用
public
getFolderLinkedUrl(Content $content) : string
Parameters
- $content : Content
-
コンテンツデータ
Tags
Return values
string —getJsonItems()
コンテンツ設定を Json 形式で取得する
public
getJsonItems() : string
Return values
string —getNextLink()
フォルダ内の次のコンテンツへのリンクを取得する
public
getNextLink([string $title = '' ][, array<string|int, mixed> $options = [] ]) : mixed
MEMO: BcRequest.(agent).aliasは廃止
Parameters
- $title : string = ''
- $options : array<string|int, mixed> = []
-
オプション（初期値 : array()）
-
class: CSSのクラス名（初期値 : 'next-link'） -
arrow: 表示文字列（初期値 : ' ≫'） -
overFolder: フォルダ外も含めるかどうか（初期値 : false） ※ overFolder が true の場合は、BcPageHelper::contentsNaviAvailable() が false だとしても強制的に出力する -
escape: エスケープするかどうか
-
Tags
Return values
mixed —コンテンツナビが無効かつオプションoverFolderがtrueでない場合はfalseを返す
getParent()
親コンテンツを取得する
public
getParent([null $id = null ][, bool $direct = true ]) : EntityInterface|array<string|int, mixed>|false
- 引数なしで現在のコンテンツの親情報を取得
- $id を指定して取得する事ができる
- $direct を false に設定する事で、最上位までの親情報を取得
Parameters
- $id : null = null
- $direct : bool = true
-
直接の親かどうか
Return values
EntityInterface|array<string|int, mixed>|false —getPrevLink()
フォルダ内の前のコンテンツへのリンクを取得する
public
getPrevLink([string $title = '' ][, array<string|int, mixed> $options = [] ]) : string|false
Parameters
- $title : string = ''
- $options : array<string|int, mixed> = []
-
オプション（初期値 : array()）
-
class: CSSのクラス名（初期値 : 'prev-link'） -
arrow: 表示文字列（初期値 : ' ≫'） -
overFolder: フォルダ外も含めるかどうか（初期値 : false） -
escape: エスケープするかどうか
-
Tags
Return values
string|false —getPublishedSites()
公開状態のサイトを全て取得する
public
getPublishedSites() : ResultSetInterface
Return values
ResultSetInterface —getPureUrl()
プレフィックスなしのURLを取得する
public
getPureUrl(string $url, int $siteId) : mixed
Parameters
- $url : string
- $siteId : int
Return values
mixed —getRelatedSiteContents()
関連サイトのコンテンツを取得
public
getRelatedSiteContents([int $id = null ][, mixed $options = [] ]) : array<string|int, mixed>
Parameters
- $id : int = null
-
コンテンツID
- $options : mixed = []
Return values
array<string|int, mixed> —| false
getRelatedSiteLinks()
関連サイトのリンク情報を取得する
public
getRelatedSiteLinks([int $id = null ][, mixed $options = [] ]) : array<string|int, mixed>
Parameters
- $id : int = null
- $options : mixed = []
Return values
array<string|int, mixed> —getService()
Get Service
public
getService( $service) : array<string|int, mixed>|mixed|object
Parameters
Tags
Return values
array<string|int, mixed>|mixed|object —getSiteRoot()
サイトIDからサイトルートとなるコンテンツを取得する
public
getSiteRoot(int $siteId) : Content
Parameters
- $siteId : int
Return values
Content —getSiteRootId()
サイトIDからサイトルートとなるコンテンツIDを取得する
public
getSiteRootId(int $siteId) : string|bool
Parameters
- $siteId : int
Tags
Return values
string|bool —getTree()
コンテンツリストをツリー構造で取得する
public
getTree([int $id = 1 ][, int $level = null ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $id : int = 1
-
カテゴリID
- $level : int = null
-
関連データの階層
- $options : array<string|int, mixed> = []
Return values
mixed —getUrl()
コンテンツ管理上のURLを元に正式なURLを取得する
public
getUrl(string $url[, bool $full = false ][, bool $useSubDomain = false ][, bool $base = false ]) : string
ドメインからのフルパスでない場合、デフォルトでは、 サブフォルダ設置時等の baseUrl（サブフォルダまでのパス）は含まない
Parameters
- $url : string
-
コンテンツ管理上のURL
- $full : bool = false
-
http からのフルのURLかどうか
- $useSubDomain : bool = false
-
サブドメインを利用しているかどうか
- $base : bool = false
-
$full が false の場合、ベースとなるURLを含めるかどうか
Return values
string —URL
getUrlById()
コンテンツIDよりフルURLを取得する
public
getUrlById(int $id[, mixed $full = false ]) : mixed
Parameters
- $id : int
-
コンテンツID
- $full : mixed = false
Return values
mixed —hasService()
Has Service
public
hasService( $service) : bool
Parameters
Tags
Return values
bool —initialize()
initialize
public
initialize(array<string|int, mixed> $config) : void
Parameters
- $config : array<string|int, mixed>
Tags
Return values
void —isActionAvailable()
アクションが利用可能かどうか確認する
public
isActionAvailable(string $type, string $action, int $entityId) : bool
Parameters
- $type : string
-
コンテンツタイプ
- $action : string
-
アクション
- $entityId : int
-
コンテンツを特定するID
Tags
Return values
bool —isAllowPublish()
データが公開状態にあるか確認する
public
isAllowPublish(array<string|int, mixed> $data[, bool $self = false ]) : mixed
Parameters
- $data : array<string|int, mixed>
-
コンテンツデータ
- $self : bool = false
-
コンテンツ自身の公開状態かどうか
Return values
mixed —isEditable()
コンテンツが編集可能かどうか確認
public
isEditable(Content $content) : bool
Parameters
- $content : Content
-
コンテンツ、サイト情報を格納した配列
Tags
Return values
bool —isFolder()
フォルダかどうか確認する
public
isFolder() : bool
Return values
bool —isParentId()
IDがコンテンツ自身の親のIDかを判定する
public
isParentId(int $id, int $parentId) : bool
Parameters
- $id : int
-
コンテンツ自身のID
- $parentId : int
-
親として判定するID
Return values
bool —isSiteRelated()
サイト連携データかどうか確認する
public
isSiteRelated(array<string|int, mixed> $data) : bool
Parameters
- $data : array<string|int, mixed>
-
コンテンツデータ
Tags
Return values
bool —nextLink()
フォルダ内の次のコンテンツへのリンクを出力する
public
nextLink([string $title = '' ][, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $title : string = ''
- $options : array<string|int, mixed> = []
-
オプション（初期値 : array()）
-
class: CSSのクラス名（初期値 : 'next-link'） -
arrow: 表示文字列（初期値 : ' ≫'） -
overFolder: フォルダ外も含めるかどうか（初期値 : false） ※ overFolder が true の場合は、BcPageHelper::contentsNaviAvailable() が false だとしても強制的に出力する
-
Tags
Return values
mixed —prevLink()
フォルダ内の前のコンテンツへのリンクを出力する
public
prevLink([string $title = '' ][, array<string|int, mixed> $options = [] ]) : void
Parameters
- $title : string = ''
- $options : array<string|int, mixed> = []
-
オプション（初期値 : array()）
-
class: CSSのクラス名（初期値 : 'prev-link'） -
arrow: 表示文字列（初期値 : ' ≫'） -
overFolder: フォルダ外も含めるかどうか（初期値 : false） ※ overFolder が true の場合は、BcPageHelper::contentsNaviAvailable() が false だとしても強制的に出力する
-
Tags
Return values
void —コンテンツナビが無効かつオプションoverFolderがtrueでない場合はfalseを返す
setup()
セットアップ
public
setup() : mixed
Return values
mixed —_getExistsTitles()
シングルコンテンツで既に登録済のタイトルを取得する
protected
_getExistsTitles() : array<string|int, mixed>
Return values
array<string|int, mixed> —getPageNeighbors()
指定した固定ページデータの次、または、前のデータを取得する
protected
getPageNeighbors(Content $content[, bool $overFolder = false ]) : array<string|int, mixed>
Parameters
- $content : Content
- $overFolder : bool = false
-
フォルダ外も含めるかどうか
Tags
Return values
array<string|int, mixed> —次、または、前の固定ページデータ
_getContent()
条件を指定してコンテンツを取得する フィールドを指定した場合はフィールドの値を取得する
private
_getContent(array<string|int, mixed> $conditions[, string|null $field = null ]) : array<string|int, mixed>|EntityInterface|false|mixed
Parameters
- $conditions : array<string|int, mixed>
- $field : string|null = null