EntryBodyHelper
extends BaseHelper
in package
uses
PaginationTrait
Table of Contents
Properties
- $bids : array<string|int, int>
- $cids : array<string|int, int>
- $eids : array<string|int, int>
- $uids : array<string|int, int>
- $bid : int
- $blogAxis : string
- $categoryAxis : string
- $cid : int|null
- $config : mixed
- $countQuery : SQL_Select
- $eid : int|null
- $end : string|null
- $Field : Field_Search|null
- $keyword : string|null
- $order : string
- $page : int
- $sortFields : array<string|int, mixed>
- $start : string|null
- $tags : array<string|int, string>
- $uid : int|null
- $isMembersOnlyEntry : bool
- 会員限定記事
Methods
- __construct() : mixed
- コンストラクタ
- buildColumn() : void
- ユニットの描画
- buildMicroPagination() : null|array<string|int, mixed>
- マイクロページネーションを組み立て
- buildPagerTrait() : array<string|int, mixed>
- ページャーの組み立て
- buildPaginationTrait() : array<string|int, mixed>
- ページネーションの組み立て
- canEditEntry() : bool
- エントリーの編集権限があるかを判定
- containsMembersOnlyUnitOnMicroPage() : bool
- 指定したマイクロページで会員限定ユニットが含まれているかどうか
- countMicroPageAmount() : int
- マイクロページの総ページ数をカウント
- filterUnitsByMicroPage() : UnitCollection
- 指定したマイクロページに表示するユニットで絞り込んで取得
- getAllUnitCollection() : UnitCollection
- ユニットを取得
- getBreakUnitOnMicroPage() : NewPage|null
- 指定したマイクロページを分割する改ページユニットを取得
- getDisplayUnitCollection() : UnitCollection
- 一覧で表示するユニットを取得
- getFixTitle() : string
- 修正したエントリータイトルを取得
- getIsMembersOnly() : bool
- 会員限定記事かどうかを取得
- getPublicUnitCollection() : UnitCollection
- 公開ユニットのみ取得
- setIsMembersOnlyEntry() : void
- 会員限定記事かどうかを設定
- setProperty() : void
- プロパティの設定
Properties
$bids
public
array<string|int, int>
$bids
= []
$cids
public
array<string|int, int>
$cids
= []
$eids
public
array<string|int, int>
$eids
= []
$uids
public
array<string|int, int>
$uids
= []
$bid
protected
int
$bid
= null
$blogAxis
protected
string
$blogAxis
= 'self'
$categoryAxis
protected
string
$categoryAxis
= 'self'
$cid
protected
int|null
$cid
= null
$config
protected
mixed
$config
$countQuery
protected
SQL_Select
$countQuery
$eid
protected
int|null
$eid
= null
$end
protected
string|null
$end
= null
$Field
protected
Field_Search|null
$Field
= null
$keyword
protected
string|null
$keyword
= null
$order
protected
string
$order
= 'desc'
$page
protected
int
$page
= 1
$sortFields
protected
array<string|int, mixed>
$sortFields
= []
$start
protected
string|null
$start
= null
$tags
protected
array<string|int, string>
$tags
= []
$uid
protected
int|null
$uid
= null
$isMembersOnlyEntry
会員限定記事
private
bool
$isMembersOnlyEntry
= false
Methods
__construct()
コンストラクタ
public
__construct(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
buildColumn()
ユニットの描画
public
buildColumn(UnitCollection $collection, Template $tpl, int $eid) : void
Parameters
- $collection : UnitCollection
- $tpl : Template
- $eid : int
buildMicroPagination()
マイクロページネーションを組み立て
public
buildMicroPagination(UnitCollection $allUnitCollection) : null|array<string|int, mixed>
Parameters
- $allUnitCollection : UnitCollection
Return values
null|array<string|int, mixed>buildPagerTrait()
ページャーの組み立て
public
buildPagerTrait(int $page[, bool $nextPage = true ]) : array<string|int, mixed>
Parameters
- $page : int
- $nextPage : bool = true
Return values
array<string|int, mixed>buildPaginationTrait()
ページネーションの組み立て
public
buildPaginationTrait(int $page, int $total, int $limit, int $maxPages[, array<string|int, mixed> $context = [] ]) : array<string|int, mixed>
Parameters
- $page : int
- $total : int
- $limit : int
- $maxPages : int
- $context : array<string|int, mixed> = []
Return values
array<string|int, mixed>canEditEntry()
エントリーの編集権限があるかを判定
public
canEditEntry(int $bid, int $uid, int $eid) : bool
Parameters
- $bid : int
- $uid : int
- $eid : int
Return values
boolcontainsMembersOnlyUnitOnMicroPage()
指定したマイクロページで会員限定ユニットが含まれているかどうか
public
containsMembersOnlyUnitOnMicroPage(UnitCollection $collection, int $summaryRange, int $micropage) : bool
Parameters
- $collection : UnitCollection
-
エントリーが持つ全てのユニットを含む配列
- $summaryRange : int
- $micropage : int
Return values
boolcountMicroPageAmount()
マイクロページの総ページ数をカウント
public
countMicroPageAmount(UnitCollection $collection) : int
Parameters
- $collection : UnitCollection
Return values
intfilterUnitsByMicroPage()
指定したマイクロページに表示するユニットで絞り込んで取得
public
filterUnitsByMicroPage(UnitCollection $collection, int<1, max> $micropage) : UnitCollection
Parameters
- $collection : UnitCollection
- $micropage : int<1, max>
-
マイクロページ番号
Return values
UnitCollectiongetAllUnitCollection()
ユニットを取得
public
getAllUnitCollection(int $eid[, int|null $rvid = null ]) : UnitCollection
Parameters
- $eid : int
- $rvid : int|null = null
Tags
Return values
UnitCollectiongetBreakUnitOnMicroPage()
指定したマイクロページを分割する改ページユニットを取得
public
getBreakUnitOnMicroPage(UnitCollection $collection, int<1, max> $micropage) : NewPage|null
Parameters
- $collection : UnitCollection
- $micropage : int<1, max>
-
マイクロページ番号
Return values
NewPage|nullgetDisplayUnitCollection()
一覧で表示するユニットを取得
public
getDisplayUnitCollection(array<string|int, mixed> $entry, UnitCollection $collection) : UnitCollection
Parameters
- $entry : array<string|int, mixed>
- $collection : UnitCollection
Return values
UnitCollectiongetFixTitle()
修正したエントリータイトルを取得
public
getFixTitle(string $title) : string
Parameters
- $title : string
Return values
stringgetIsMembersOnly()
会員限定記事かどうかを取得
public
getIsMembersOnly() : bool
Return values
boolgetPublicUnitCollection()
公開ユニットのみ取得
public
getPublicUnitCollection(UnitCollection $collection, int|null $summaryRange) : UnitCollection
Parameters
- $collection : UnitCollection
- $summaryRange : int|null
Return values
UnitCollectionsetIsMembersOnlyEntry()
会員限定記事かどうかを設定
public
setIsMembersOnlyEntry(bool $isMembersOnly) : void
Parameters
- $isMembersOnly : bool
setProperty()
プロパティの設定
public
setProperty(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed