a-blog cms PHP API Reference

Schedule extends Base
in package

Application

uses EagerLoadingTrait

Properties

$bid : int
$bids : array<string|int, int>
$cid : int|null
$cids : array<string|int, int>
$eid : int|null
$eids : array<string|int, int>
$end : string
$field : string
$Field : Field_Search
$keyword : string
$limit : int|null
$order : string
$page : int<1, max>
$start : string
$tag : string
$tags : array<string|int, string>
$uid : int|null
$uids : array<string|int, int>
$axis : mixed: 階層の設定
$cacheLifetime : int
$calendarHelper : CalendarHelper
$customFieldsEnabled : bool
$Get : Field
$identifier : string|null
$mbid : int|null
$mid : int|null
$moduleContext : Field
$Post : Field_Validation
$scopes : array{uid?: "local"|"global", cid?: "local"|"global", eid?: "local"|"global", keyword?: "local"|"global", tag?: "local"|"global", field?: "local"|"global", date?: "local"|"global", start?: "local"|"global", end?: "local"|"global", page?: "local"|"global", order?: "local"|"global"}: スコープの設定

Methods

__construct() : void: Constructor
fire() : array<string|int, mixed>: モジュールを実行
get() : array<string|int, mixed>|never
addEntryDataToCalendar() : array<string|int, mixed>: カレンダーにスケジュール情報を追加
autoConvertTypeTrait() : array<string|int, mixed>: 自動で型変換
blogAxis() : string
buildAxis() : void: モジュールの階層設定を組み立て
buildBasicFieldGroupTrait() : array<string|int, mixed>: 基本カスタムフィールドグループを組み立て
buildBasicFieldTrait() : array<string|int, mixed>: 基本カスタムフィールドを組み立て
buildFieldTrait() : array<string|int, mixed>|null: フィールドを連想配列として組み立て
buildModuleContext() : void: モジュールコンテキストを組み立て
buildModuleField() : null|array<string|int, mixed>: モジュールフィールドを組み立て
buildMultiFieldGroupTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドグループを組み立て
buildMultiFieldTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドを組み立て
buildScheduleData() : array<string|int, mixed>: スケジュール情報を組み立てる
buildScheduleQuery() : SQL_Select: スケジュール情報のSQLクエリを組み立てる
categoryAxis() : string
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
exec() : array<string|int, mixed>: モジュールを実行結果を返却（キャッシュ考慮）
extractGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを抜き出す
extractNonGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを除いてキーを取得
formatFieldKeysTrait() : array<string|int, mixed>: フィールドキー配列を整形
getBaseParams() : array<string|int, mixed>: モジュールの基本パラメータを取得
getLabelMap() : array<string|int, mixed>: ラベルマップを取得
getScope() : string: 指定したコンテキストのスコープを取得モジュール設定とURLのコンテキストを考慮します
loadModuleConfig() : Field: モジュールIDのコンフィグをロード
setIntegerValue() : void: 整数型の値を設定

$bid


        public
            int
    $bid
     = null

$bids


        public
            array<string|int, int>
    $bids
     = []

$cid


        public
            int|null
    $cid
     = null

$cids


        public
            array<string|int, int>
    $cids
     = []

$eid


        public
            int|null
    $eid
     = null

$eids


        public
            array<string|int, int>
    $eids
     = []

$end


        public
            string
    $end

$field


        public
            string
    $field

$Field


        public
            Field_Search
    $Field

$keyword


        public
            string
    $keyword

$limit


        public
            int|null
    $limit
     = null

$order


        public
            string
    $order

$page


        public
            int<1, max>
    $page
     = 1

$start


        public
            string
    $start

$tag


        public
            string
    $tag

$tags


        public
            array<string|int, string>
    $tags
     = []

$uid


        public
            int|null
    $uid
     = null

$uids


        public
            array<string|int, int>
    $uids
     = []

$axis

階層の設定


        protected
            mixed
    $axis
     = [
    // phpcs:ignore
    'bid' => 'self',
    'cid' => 'self',
]

$cacheLifetime


        protected
            int
    $cacheLifetime
     = 0

$calendarHelper


        protected
            CalendarHelper
    $calendarHelper

$customFieldsEnabled


        protected
            bool
    $customFieldsEnabled
     = false

$Get


        protected
            Field
    $Get

$identifier


        protected
            string|null
    $identifier
     = null

$mbid


        protected
            int|null
    $mbid
     = null

$mid


        protected
            int|null
    $mid
     = null

$moduleContext


        protected
            Field
    $moduleContext

$Post


        protected
            Field_Validation
    $Post

$scopes

スコープの設定


        protected
            array{uid?: "local"|"global", cid?: "local"|"global", eid?: "local"|"global", keyword?: "local"|"global", tag?: "local"|"global", field?: "local"|"global", date?: "local"|"global", start?: "local"|"global", end?: "local"|"global", page?: "local"|"global", order?: "local"|"global"}
    $scopes
     = [
    // phpcs:ignore
    'date' => 'global',
    'start' => 'global',
    'end' => 'global',
]

__construct()

Constructor


    public
                    __construct(array{bid?: int, bids?: int[], cid?: int, cids?: int[], eid?: int, eids?: int[], uid?: int, uids?: int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string} $context, array<string|int, mixed> $scopes, array<string|int, mixed> $axis, Field_Validation $Post[, int $cacheLifetime = 0 ][, bool $customFieldsEnabled = false ][, null|int $mid = null ][, int|null $mbid = null ][, null|string $identifier = null ]) : void

Parameters

$context : array{bid?: int, bids?: int[], cid?: int, cids?: int[], eid?: int, eids?: int[], uid?: int, uids?: int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string}
$scopes : array<string|int, mixed>
$axis : array<string|int, mixed>
$Post : Field_Validation
$cacheLifetime : int = 0
$customFieldsEnabled : bool = false
$mid : null|int = null
$mbid : int|null = null
$identifier : null|string = null

fire()

モジュールを実行


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

Return values

array<string|int, mixed>

get()


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

Return values

array<string|int, mixed>|never

addEntryDataToCalendar()

カレンダーにスケジュール情報を追加


    protected
                    addEntryDataToCalendar(array<string|int, mixed> $weeks, array<string|int, mixed> $data) : array<string|int, mixed>

Parameters

$weeks : array<string|int, mixed>
$data : array<string|int, mixed>

Return values

array<string|int, mixed>

autoConvertTypeTrait()

自動で型変換


    protected
                    autoConvertTypeTrait(array<string|int, mixed> $values) : array<string|int, mixed>

Parameters

$values : array<string|int, mixed>

Return values

array<string|int, mixed>

blogAxis()


    protected
                    blogAxis() : string

Return values

string

buildAxis()

モジュールの階層設定を組み立て


    protected
                    buildAxis(array<string|int, mixed> $axis) : void

Parameters

$axis : array<string|int, mixed>

buildBasicFieldGroupTrait()

基本カスタムフィールドグループを組み立て


    protected
                    buildBasicFieldGroupTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

buildBasicFieldTrait()

基本カスタムフィールドを組み立て


    protected
                    buildBasicFieldTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, 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

Return values

array<string|int, mixed>|null

buildModuleContext()

モジュールコンテキストを組み立て


    protected
                    buildModuleContext(array{bid?: int|int[], cid?: int|int[], eid?: int|int[], uid?: int|int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string} $context, array<string|int, mixed> $scopes) : void

Parameters

$context : array{bid?: int|int[], cid?: int|int[], eid?: int|int[], uid?: int|int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string}
$scopes : array<string|int, mixed>

buildModuleField()

モジュールフィールドを組み立て


    protected
                    buildModuleField() : null|array<string|int, mixed>

Return values

null|array<string|int, mixed>

buildMultiFieldGroupTrait()

複数項目をもつカスタムフィールドグループを組み立て


    protected
                    buildMultiFieldGroupTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

buildMultiFieldTrait()

複数項目をもつカスタムフィールドを組み立て


    protected
                    buildMultiFieldTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

buildScheduleData()

スケジュール情報を組み立てる


    protected
                    buildScheduleData(array<string|int, mixed> $data, array<string|int, mixed> $labelData) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>
$labelData : array<string|int, mixed>

Return values

array<string|int, mixed>

buildScheduleQuery()

スケジュール情報のSQLクエリを組み立てる


    protected
                    buildScheduleQuery(int $bid, string $key, string $baseDate, string $startDate, string $endDate) : SQL_Select

Parameters

$bid : int
$key : string
$baseDate : string
$startDate : string
$endDate : string

Return values

SQL_Select

categoryAxis()


    protected
                    categoryAxis() : string

Return values

string

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>

exec()

モジュールを実行結果を返却（キャッシュ考慮）


    protected
                    exec() : array<string|int, mixed>

Return values

array<string|int, mixed>

extractGroupFieldKeysTrait()

グループフィールドのキーを抜き出す


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

Parameters

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

Return values

array<string|int, mixed>

extractNonGroupFieldKeysTrait()

グループフィールドのキーを除いてキーを取得


    protected
                    extractNonGroupFieldKeysTrait(array<string|int, mixed> $fieldKeys, array<string|int, mixed> $groupKeys) : array<string|int, mixed>

Parameters

$fieldKeys : array<string|int, mixed>
$groupKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

formatFieldKeysTrait()

フィールドキー配列を整形


    protected
                    formatFieldKeysTrait(array<string|int, mixed> $fieldKeys) : array<string|int, mixed>

Parameters

$fieldKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

getBaseParams()

モジュールの基本パラメータを取得


    protected
                    getBaseParams([array<string|int, mixed> $override = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

getLabelMap()

ラベルマップを取得


    protected
                    getLabelMap(string $key) : array<string|int, mixed>

Parameters

$key : string

Return values

array<string|int, mixed>

getScope()

指定したコンテキストのスコープを取得モジュール設定とURLのコンテキストを考慮します


    protected
                    getScope(string $key, array<string|int, mixed> $scopes) : string

Parameters

$key : string
$scopes : array<string|int, mixed>

Return values

string

loadModuleConfig()

モジュールIDのコンフィグをロード


    protected
                    loadModuleConfig() : Field

Return values

Field

setIntegerValue()

整数型の値を設定


    protected
                    setIntegerValue(string $key) : void

Parameters

$key : string

Schedule extends Base in package Application uses EagerLoadingTrait

Table of Contents

Properties

Methods

Properties

$bid

$bids

$cid

$cids

$eid

$eids

$end

$field

$Field

$keyword

$limit

$order

$page

$start

$tag

$tags

$uid

$uids

$axis

$cacheLifetime

$calendarHelper

$customFieldsEnabled

$Get

$identifier

$mbid

$mid

$moduleContext

$Post

$scopes

Tags

Methods

__construct()

Parameters

fire()

Tags

Return values

get()

Tags

Return values

addEntryDataToCalendar()

Parameters

Return values

autoConvertTypeTrait()

Parameters

Return values

blogAxis()

Return values

buildAxis()

Parameters

buildBasicFieldGroupTrait()

Parameters

Return values

buildBasicFieldTrait()

Parameters

Return values

buildFieldTrait()

Parameters

Return values

buildModuleContext()

Parameters

buildModuleField()

Return values

buildMultiFieldGroupTrait()

Parameters

Return values

buildMultiFieldTrait()

Parameters

Return values

buildScheduleData()

Parameters

Return values

buildScheduleQuery()

Parameters

Return values

categoryAxis()

Schedule extends Base
in package

Application

uses EagerLoadingTrait