a-blog cms PHP API Reference

EntryHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait, PaginationTrait

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

Methods

__construct() : mixed: コンストラクタ
buildBlog() : array<string|int, mixed>: ブログ情報を組み立て
buildCategory() : array<string|int, mixed>: カテゴリ情報を組み立て
buildEntry() : array<string|int, mixed>: エントリ情報の組み立て
buildEntryLink() : null|string: リンクを組み立て
buildEntryTitle() : string: エントリータイトルを組み立て
buildFulltext() : null|string: フルテキストの組み立て
buildGeo() : null|array<string|int, mixed>: 位置情報を組み立て
buildMainImage() : null|array<string|int, mixed>: メイン画像を組み立て
buildMainImageFromEntryData() : null|array<string|int, mixed>: メイン画像をIDから組み立て
buildMainImageVars() : array<string|int, mixed>: メイン画像の変数を組み立て
buildNextLink() : null|array<string|int, mixed>: 次のリンクを組み立て
buildPagerTrait() : array<string|int, mixed>: ページャーの組み立て
buildPagination() : null|array<string|int, mixed>: ページネーションを組み立て
buildPaginationTrait() : array<string|int, mixed>: ページネーションの組み立て
buildPrevLink() : null|array<string|int, mixed>: 一個前のリンクを組み立て
buildRelatedEntries() : array<string|int, mixed>: 関連エントリを組み立て
buildSerialNavi() : null|array<string|int, mixed>: 前後リンクを組み立て
buildSimplePager() : array<string|int, mixed>|null: シンプルページャーを組み立て
buildSubCategory() : array<string|int, mixed>: サブカテゴリーを組み立て
buildTag() : array<string|int, mixed>: タグを組み立て
buildUnitList() : array<string|int, mixed>|null: ユニットリストの組み立て
buildUser() : array<string|int, mixed>: ユーザー情報を組み立て
canAccessEntry() : bool: エントリーへのアクセス権限を確認する
eagerLoad() : array<string|int, mixed>: Eager loads for the given entries.
getRelationalEntryIds() : array<string|int, mixed>: 関連エントリーの取得
getRootVars() : array<string|int, mixed>: ルート変数の取得
notFoundStatus() : void: NotFound時のテンプレート組み立て
setProperty() : void: プロパティの設定
buildFieldTrait() : array<string|int, mixed>|null: フィールドを連想配列として組み立て
eagerLoadEntryTrait() : array<int, array<string, mixed>>: エントリーのEagerLoading
eagerLoadFieldTrait() : Field>)
eagerLoadFullTextTrait() : array<int<1, max>, UnitCollection>: フルテキストのEagerLoading
eagerLoadMainImageFieldTrait() : array<int, array<string|int, mixed>>: 指定したエントリーカスタムフィールドのメインイメージをEagerLoadする
eagerLoadMainImageTrait() : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array}): メインイメージのEagerLoading
eagerLoadRelatedEntryTrait() : array<string|int, mixed>: 関連記事のEagerLoading
eagerLoadSubCategoriesTrait() : array<string|int, array<int, array<string, mixed>>>: サブカテゴリーのEagerLoading
eagerLoadTagTrait() : array<string|int, mixed>: タグのEagerLoading
resolveTemplateUrlsTrait() : array<string|int, mixed>: toStructured の出力に対し、path フィールドの URL 解決と html フィールドの絶対化（テンプレート出力固有）を適用する。
resolveTemplateUrlsInGroupRowTrait() : array<string|int, mixed>: グループ内の 1 行に含まれるマルチ項目（連想配列構造）に対して URL 解決を適用。
resolveTemplateUrlsInMultiEntryTrait() : array<string|int, mixed>: マルチ項目フィールドエントリ（'value'/'array' を持つ）に対して URL 解決を適用。

$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

__construct()

コンストラクタ


    public
                    __construct(array<string|int, mixed> $params) : mixed

Parameters

$params : array<string|int, mixed>

buildBlog()

ブログ情報を組み立て


    public
                    buildBlog(int $bid, array<string|int, mixed> $row) : array<string|int, mixed>

Parameters

$bid : int
$row : array<string|int, mixed>

Return values

array<string|int, mixed>

buildCategory()

カテゴリ情報を組み立て


    public
                    buildCategory(int $cid, int $bid) : array<string|int, mixed>

Parameters

$cid : int
$bid : int

Return values

array<string|int, mixed>

buildEntry()

エントリ情報の組み立て


    public
                    buildEntry(array<string|int, mixed> $row, array{includeBlog: ?bool, includeUser: ?bool, includeCategory: ?bool, fulltextWidth: ?int, fulltextMarker: ?string, newItemPeriod: ?int} $config[, array<string|int, mixed> $extraVars = [] ][, array<string|int, mixed> $eagerLoadingData = [] ]) : array<string|int, mixed>

Parameters

$row : array<string|int, mixed>
$config : array{includeBlog: ?bool, includeUser: ?bool, includeCategory: ?bool, fulltextWidth: ?int, fulltextMarker: ?string, newItemPeriod: ?int}
$extraVars : array<string|int, mixed> = []
$eagerLoadingData : array<string|int, mixed> = []

Return values

array<string|int, mixed>

buildEntryLink()

リンクを組み立て


    public
                    buildEntryLink(string $link, int $eid, int $bid, int|null $cid) : null|string

Parameters

$link : string
$eid : int
$bid : int
$cid : int|null

Return values

null|string

buildEntryTitle()

エントリータイトルを組み立て


    public
                    buildEntryTitle(array<string|int, mixed> $row) : string

Parameters

$row : array<string|int, mixed>

Return values

string

buildFulltext()

フルテキストの組み立て


    public
                    buildFulltext(int $eid, int $width, string $marker, array<string|int, mixed> $eagerLoadedFulltext) : null|string

Parameters

$eid : int
$width : int
$marker : string
$eagerLoadedFulltext : array<string|int, mixed>

Return values

null|string

buildGeo()

位置情報を組み立て


    public
                    buildGeo(array<string|int, mixed> $row) : null|array<string|int, mixed>

Parameters

$row : array<string|int, mixed>

Return values

null|array<string|int, mixed>

buildMainImage()

メイン画像を組み立て


    public
                    buildMainImage(string|null $pimageId, int $eid, array<string|int, mixed> $eagerLoadingData) : null|array<string|int, mixed>

Parameters

$pimageId : string|null
$eid : int
$eagerLoadingData : array<string|int, mixed>

Return values

null|array<string|int, mixed>

buildMainImageFromEntryData()

メイン画像をIDから組み立て


    public
                    buildMainImageFromEntryData(array<string|int, mixed> $entry) : null|array<string|int, mixed>

Parameters

$entry : array<string|int, mixed>

Return values

null|array<string|int, mixed>

buildMainImageVars()

メイン画像の変数を組み立て


    public
                    buildMainImageVars(array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>

Return values

array<string|int, mixed>

buildNextLink()

次のリンクを組み立て


    public
                    buildNextLink(string $sortFieldName, string $sortOrder, SQL_Select $baseSql, string $field, string $value) : null|array<string|int, mixed>

Parameters

$sortFieldName : string
$sortOrder : string
$baseSql : SQL_Select
$field : string
$value : string

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>

buildPagination()

ページネーションを組み立て


    public
                    buildPagination(SQL_Select $amount) : null|array<string|int, mixed>

Parameters

$amount : SQL_Select

Return values

null|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>

buildPrevLink()

一個前のリンクを組み立て


    public
                    buildPrevLink(string $sortFieldName, string $sortOrder, SQL_Select $baseSql, string $field, string $value) : null|array<string|int, mixed>

Parameters

$sortFieldName : string
$sortOrder : string
$baseSql : SQL_Select
$field : string
$value : string

Return values

null|array<string|int, mixed>

buildRelatedEntries()

Parameters

$relatedEntries : array<string|int, mixed>

Return values

array<string|int, mixed>

buildSerialNavi()

前後リンクを組み立て


    public
                    buildSerialNavi(int $eid, string $order[, bool $ignoreCategory = false ][, Field_Search|Field $field = null ]) : null|array<string|int, mixed>

Parameters

$eid : int
$order : string
$ignoreCategory : bool = false
$field : Field_Search|Field = null

Return values

null|array<string|int, mixed>

buildSimplePager()

シンプルページャーを組み立て


    public
                    buildSimplePager(int $page, bool $nextPage) : array<string|int, mixed>|null

Parameters

$page : int
$nextPage : bool

Return values

array<string|int, mixed>|null

buildSubCategory()

サブカテゴリーを組み立て


    public
                    buildSubCategory(array<string|int, mixed> $subCategories) : array<string|int, mixed>

Parameters

$subCategories : array<string|int, mixed>

Return values

array<string|int, mixed>

buildTag()

タグを組み立て


    public
                    buildTag(array<string|int, mixed> $tags) : array<string|int, mixed>

Parameters

$tags : array<string|int, mixed>

Return values

array<string|int, mixed>

buildUnitList()

ユニットリストの組み立て


    public
                    buildUnitList(array<string|int, mixed> $unit, array<string|int, mixed> $config, array<string|int, mixed> $eagerLoadingData, array<string|int, mixed> $mediaEagerLoading, Repository $unitRepository, string $tplString) : array<string|int, mixed>|null

Parameters

$unit : array<string|int, mixed>
$config : array<string|int, mixed>
$eagerLoadingData : array<string|int, mixed>
$mediaEagerLoading : array<string|int, mixed>
$unitRepository : Repository
$tplString : string

Return values

array<string|int, mixed>|null

buildUser()

ユーザー情報を組み立て


    public
                    buildUser(int $uid) : array<string|int, mixed>

Parameters

$uid : int

Return values

array<string|int, mixed>

canAccessEntry()

エントリーへのアクセス権限を確認する


    public
                    canAccessEntry(int $eid) : bool

Parameters

$eid : int

Return values

bool

eagerLoad()

Eager loads for the given entries.


    public
                    eagerLoad(array<string|int, mixed> $entries, array{includeMainImage?: bool, mainImageTarget?: "unit"|"field", mainImageFieldName?: string, includeFulltext?: bool, includeTags?: bool, includeEntryFields?: bool, includeUserFields?: bool, includeBlogFields?: bool, includeCategoryFields?: bool, includeSubCategories?: bool, includeRelatedEntries?: bool} $config[, int|null $rvid = null ]) : array<string|int, mixed>

Parameters

$entries : array<string|int, mixed>
$config : array{includeMainImage?: bool, mainImageTarget?: "unit"|"field", mainImageFieldName?: string, includeFulltext?: bool, includeTags?: bool, includeEntryFields?: bool, includeUserFields?: bool, includeBlogFields?: bool, includeCategoryFields?: bool, includeSubCategories?: bool, includeRelatedEntries?: bool}
$rvid : int|null = null

Return values

array<string|int, mixed>

getRelationalEntryIds()

Parameters

$eid : int
$type : null|string

Return values

array<string|int, mixed>

getRootVars()

ルート変数の取得


    public
                    getRootVars() : array<string|int, mixed>

Return values

array<string|int, mixed>

notFoundStatus()

NotFound時のテンプレート組み立て


    public
                    notFoundStatus() : void

setProperty()

プロパティの設定


    public
                    setProperty(string $name, mixed $value) : void

Parameters

$name : string
$value : mixed

buildFieldTrait()

フィールドを連想配列として組み立て


    protected
                    buildFieldTrait(Field|Field_Validation $field[, string|null $scp = null ]) : array<string|int, mixed>|null

Parameters

$field : Field|Field_Validation
$scp : string|null = null: 子フィールドとして再帰したときの名前（takeover キーの prefix に使う）

Return values

array<string|int, mixed>|null —

フィールドが空の場合は null

eagerLoadEntryTrait()

エントリーのEagerLoading


    protected
                    eagerLoadEntryTrait(array<string|int, int> $ids) : array<int, array<string, mixed>>

Parameters

$ids : array<string|int, int>

Return values

array<int, array<string, mixed>>

eagerLoadFieldTrait()


    protected
                    eagerLoadFieldTrait(array<string|int, int>|array<string|int, string> $ids, "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id" $type[, int|null $rvid = null ]) : Field>)

Parameters

$ids : array<string|int, int>|array<string|int, string>
$type : "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id"
$rvid : int|null = null

Return values

Field>)

eagerLoadFullTextTrait()

フルテキストのEagerLoading


    protected
                    eagerLoadFullTextTrait(array<string|int, int> $entryIds) : array<int<1, max>, UnitCollection>

Parameters

$entryIds : array<string|int, int>

Return values

array<int<1, max>, UnitCollection>

eagerLoadMainImageFieldTrait()

指定したエントリーカスタムフィールドのメインイメージをEagerLoadする


    protected
                    eagerLoadMainImageFieldTrait(array<string|int, mixed> $entryIds, string $fieldName[, int|null $rvid = null ]) : array<int, array<string|int, mixed>>

Parameters

$entryIds : array<string|int, mixed>
$fieldName : string
$rvid : int|null = null

Return values

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

eagerLoadMainImageTrait()

メインイメージのEagerLoading


    protected
                    eagerLoadMainImageTrait(mixed $entries[, mixed $target = 'unit' ][, mixed $fieldName = '' ][, int|null $rvid = null ]) : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})

Parameters

$entries : mixed
$target : mixed = 'unit': 'unit'|'field'
$fieldName : mixed = '': ?string
$rvid : int|null = null

Return values

, media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})

eagerLoadRelatedEntryTrait()

Parameters

$eidArray : array<string|int, int>

Return values

array<string|int, mixed>

eagerLoadSubCategoriesTrait()

サブカテゴリーのEagerLoading


    protected
                    eagerLoadSubCategoriesTrait(array<string|int, int> $eidArray[, null|int $rvid = null ]) : array<string|int, array<int, array<string, mixed>>>

Parameters

$eidArray : array<string|int, int>
$rvid : null|int = null

Return values

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

eagerLoadTagTrait()

タグのEagerLoading


    protected
                    eagerLoadTagTrait(array<string|int, int> $eidArray[, int|null $rvid = null ]) : array<string|int, mixed>

Parameters

$eidArray : array<string|int, int>
$rvid : int|null = null

Return values

array<string|int, mixed>

resolveTemplateUrlsTrait()

toStructured の出力に対し、path フィールドの URL 解決と html フィールドの絶対化（テンプレート出力固有）を適用する。


    protected
                    resolveTemplateUrlsTrait(array<string|int, mixed> $data, Field|Field_Validation $field) : array<string|int, mixed>

マルチ項目フィールド (['value' => {...}, 'array' => [...]]) の中の path / html
グループ内マルチ項目（連番キーの行配列の中の各 baseName）の path / html

単一値フィールドや、グループ内単一値フィールドには URL 解決を適用しない（旧挙動）。

Parameters

$data : array<string|int, mixed>
$field : Field|Field_Validation

Return values

array<string|int, mixed>

resolveTemplateUrlsInGroupRowTrait()

グループ内の 1 行に含まれるマルチ項目（連想配列構造）に対して URL 解決を適用。


    private
                    resolveTemplateUrlsInGroupRowTrait(array<string|int, mixed> $row, Field|Field_Validation $field) : array<string|int, mixed>

グループ内単一値は ['value' => x] の形なのでスキップ。グループ内マルチ項目は ['alt' => x, 'path' => y, ...] の形。

Parameters

$row : array<string|int, mixed>
$field : Field|Field_Validation

Return values

array<string|int, mixed>

resolveTemplateUrlsInMultiEntryTrait()

マルチ項目フィールドエントリ（'value'/'array' を持つ）に対して URL 解決を適用。


    private
                    resolveTemplateUrlsInMultiEntryTrait(array<string|int, mixed> $entry, string $baseName, Field|Field_Validation $field) : array<string|int, mixed>

Parameters

$entry : array<string|int, mixed>
$baseName : string
$field : Field|Field_Validation

Return values

array<string|int, mixed>

EntryHelper extends BaseHelper in package Application uses FieldTrait, EagerLoadingTrait, PaginationTrait

Table of Contents

Properties

Methods

Properties

$bids

$cids

$eids

$uids

$bid

$blogAxis

$categoryAxis

$cid

$config

$countQuery

$eid

$end

$Field

$keyword

$order

$page

$sortFields

$start

$tags

$uid

Methods

__construct()

Parameters

buildBlog()

Parameters

Return values

buildCategory()

Parameters

Return values

buildEntry()

Parameters

Return values

buildEntryLink()

Parameters

Return values

buildEntryTitle()

Parameters

Return values

buildFulltext()

Parameters

Return values

buildGeo()

Parameters

Return values

buildMainImage()

Parameters

Return values

buildMainImageFromEntryData()

Parameters

Return values

buildMainImageVars()

Parameters

Return values

buildNextLink()

Parameters

Return values

buildPagerTrait()

Parameters

Return values

buildPagination()

Parameters

Return values

buildPaginationTrait()

Parameters

Return values

buildPrevLink()

Parameters

Return values

buildRelatedEntries()

Parameters

Return values

buildSerialNavi()

Parameters

Return values

buildSimplePager()

EntryHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait, PaginationTrait