a-blog cms PHP API Reference

CalendarHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait

Properties

$bids : array<string|int, int>
$cids : array<string|int, int>
$eids : array<string|int, int>
$uids : array<string|int, int>
$beginW : int: 前後月を考慮した最初の曜日（数値）
$bid : int
$blogAxis : string
$categoryAxis : string
$cid : int|null
$config : mixed
$countQuery : SQL_Select
$d : string: 日（DD形式）
$eid : int|null
$end : string|null
$endDate : string: カレンダーの終了日例）前後月のエントリー表示を有効にしている場合、2022/06 のURLコンテキストでアクセスしたとき 2022-07-03 23:59:59
$entries : array<int, array<string, mixed>>: エントリー一覧
$entryEndDate : string: エントリーの終了日
$entryStartDate : string: エントリーの開始日
$Field : Field_Search|null
$firstDay : int: day:loop ブロックの中で最も若い日
$firstW : int: day:loop ブロックの中で最も若い日の曜日（数値）
$keyword : string|null
$loopCount : int: day:loop ブロックのループ回数
$m : string: 月（MM形式）
$order : string
$page : int
$separateWeek : int: week:loopブロックの区切りの曜日（数値）
$sortFields : array<string|int, mixed>
$start : string|null
$startDate : string: カレンダーの開始日例）前後月のエントリー表示を有効にしている場合、2022/06 のURLコンテキストでアクセスしたとき 2022-05-30 00:00:00
$tags : array<string|int, string>
$uid : int|null
$y : string: 年（YYYY形式）
$ymd : string: 日付コンテキスト（YYYY-MM-DD形式）

Methods

__construct() : mixed: コンストラクタ
buildEntryCalendarQuery() : SQL_Select: sqlの組み立て
getDate() : array{year: string, month: string, day: string, prevDate: string, nextDate: string, date: string, prevMonth: string, nextMonth: string, firstWeekDay?: int}: dateブロックの変数の取得
getDays() : array<int, array<int, array{week: mixed, w: int, day: int, date: string, padding: false, url: string|false, today?: mixed, entries: list|null}>}>>: カレンダーの日付データを週単位でグループ化して取得
getNextMonthPaddingDays() : array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>: 次月のパディング日を取得
getPrevMonthPaddingDays() : array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>: 前月のパディング日を取得
getWeekLabel() : array<int, array{w: int, label: string}>: 曜日ラベルの取得
setCalendarVars() : void: カレンダーの計算に必要な変数の代入
setDateContextVars() : void: 日付のURLコンテキストに関わるの代入
setProperty() : void: プロパティの設定
autoConvertTypeTrait() : array<string|int, mixed>: 自動で型変換
buildBasicFieldGroupTrait() : array<string|int, mixed>: 基本カスタムフィールドグループを組み立て
buildBasicFieldTrait() : array<string|int, mixed>: 基本カスタムフィールドを組み立て
buildFieldTrait() : array<string|int, mixed>|null: フィールドを連想配列として組み立て
buildMultiFieldGroupTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドグループを組み立て
buildMultiFieldTrait() : array<string|int, mixed>: 複数項目をもつカスタムフィールドを組み立て
computeDate() : 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
extractGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを抜き出す
extractNonGroupFieldKeysTrait() : array<string|int, mixed>: グループフィールドのキーを除いてキーを取得
formatDate() : string: 日付をフォーマットして文字列として返す
formatFieldKeysTrait() : array<string|int, mixed>: フィールドキー配列を整形
getEntriesByDate() : array<int, array{title: string, eid: int, cid: int, bid: int, status: mixed, datetime: mixed, url?: mixed, fields: array|null}>: 指定した日付のエントリーを取得

$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
     = []

$beginW

前後月を考慮した最初の曜日（数値）


        protected
            int
    $beginW
     = 0

$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

$d

日（DD形式）


        protected
            string
    $d
     = ''

$eid


        protected
            int|null
    $eid
     = null

$end


        protected
            string|null
    $end
     = null

$endDate

カレンダーの終了日例）前後月のエントリー表示を有効にしている場合、2022/06 のURLコンテキストでアクセスしたとき 2022-07-03 23:59:59


        protected
            string
    $endDate
     = ''

$entries

エントリー一覧


        protected
            array<int, array<string, mixed>>
    $entries
     = []

$entryEndDate

エントリーの終了日


        protected
            string
    $entryEndDate
     = ''

$entryStartDate

エントリーの開始日


        protected
            string
    $entryStartDate
     = ''

$Field


        protected
            Field_Search|null
    $Field
     = null

$firstDay

day:loop ブロックの中で最も若い日


        protected
            int
    $firstDay
     = 0

$firstW

day:loop ブロックの中で最も若い日の曜日（数値）


        protected
            int
    $firstW
     = 0

$keyword


        protected
            string|null
    $keyword
     = null

$loopCount

day:loop ブロックのループ回数


        protected
            int
    $loopCount
     = 0

$m

月（MM形式）


        protected
            string
    $m
     = ''

$order


        protected
            string
    $order
     = 'desc'

$page


        protected
            int
    $page
     = 1

$separateWeek

week:loopブロックの区切りの曜日（数値）


        protected
            int
    $separateWeek
     = 0

$sortFields


        protected
            array<string|int, mixed>
    $sortFields
     = []

$start


        protected
            string|null
    $start
     = null

$startDate

カレンダーの開始日例）前後月のエントリー表示を有効にしている場合、2022/06 のURLコンテキストでアクセスしたとき 2022-05-30 00:00:00


        protected
            string
    $startDate
     = ''

$tags


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

$uid


        protected
            int|null
    $uid
     = null

$y

年（YYYY形式）


        protected
            string
    $y
     = ''

$ymd

日付コンテキスト（YYYY-MM-DD形式）


        protected
            string
    $ymd
     = ''

__construct()

コンストラクタ


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

Parameters

$params : array<string|int, mixed>

buildEntryCalendarQuery()

sqlの組み立て


    public
                    buildEntryCalendarQuery(int $bid[, int|null $cid = null ][, int|null $uid = null ]) : SQL_Select

Parameters

$bid : int
$cid : int|null = null
$uid : int|null = null

Return values

SQL_Select

getDate()

dateブロックの変数の取得


    public
                    getDate() : array{year: string, month: string, day: string, prevDate: string, nextDate: string, date: string, prevMonth: string, nextMonth: string, firstWeekDay?: int}

Return values

array{year: string, month: string, day: string, prevDate: string, nextDate: string, date: string, prevMonth: string, nextMonth: string, firstWeekDay?: int}

getDays()

カレンダーの日付データを週単位でグループ化して取得


    public
                    getDays(array<int, array<string, mixed>> $entries) : array<int, array<int, array{week: mixed, w: int, day: int, date: string, padding: false, url: string|false, today?: mixed, entries: list|null}>}>>

Parameters

$entries : array<int, array<string, mixed>>: エントリー一覧

Return values

array<int, array<int, array{week: mixed, w: int, day: int, date: string, padding: false, url: string|false, today?: mixed, entries: list|null}>}>> —

週単位でグループ化された日付データの二次元配列

getNextMonthPaddingDays()

次月のパディング日を取得


    public
                    getNextMonthPaddingDays(array<int, array<string, mixed>> $entries) : array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>

Parameters

$entries : array<int, array<string, mixed>>: エントリー一覧

Return values

array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>

getPrevMonthPaddingDays()

前月のパディング日を取得


    public
                    getPrevMonthPaddingDays(array<int, array<string, mixed>> $entries) : array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>

Parameters

$entries : array<int, array<string, mixed>>: エントリー一覧

Return values

array<int, array{day: int, date: string, w: int, week: mixed, url: string|false, padding: true, entries: list|null}>}>

getWeekLabel()

曜日ラベルの取得


    public
                    getWeekLabel() : array<int, array{w: int, label: string}>

Return values

array<int, array{w: int, label: string}>

setCalendarVars()

カレンダーの計算に必要な変数の代入


    public
                    setCalendarVars() : void

setDateContextVars()

日付のURLコンテキストに関わるの代入


    public
                    setDateContextVars() : void

setProperty()

プロパティの設定


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

Parameters

$name : string
$value : 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>

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

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>

computeDate()

日付を計算


    protected
                    computeDate(int $year, int $month, int $day, int $addDays) : string

Parameters

$year : int
$month : int
$day : int
$addDays : int

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>

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>

formatDate()

日付をフォーマットして文字列として返す


    protected
                    formatDate(string $format, string $datetime) : string

Parameters

$format : string: date() 関数のフォーマット文字列
$datetime : string: 日付文字列（strtotime() で解析可能な形式）

Return values

string —

フォーマットされた日付文字列

formatFieldKeysTrait()

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


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

Parameters

$fieldKeys : array<string|int, mixed>

Return values

array<string|int, mixed>

getEntriesByDate()

指定した日付のエントリーを取得


    protected
                    getEntriesByDate(string $date, array<int, array<string, mixed>> $entries) : array<int, array{title: string, eid: int, cid: int, bid: int, status: mixed, datetime: mixed, url?: mixed, fields: array|null}>

Parameters

$date : string: 日付（YYYY-MM-DD形式）
$entries : array<int, array<string, mixed>>: エントリー一覧

Return values

array<int, array{title: string, eid: int, cid: int, bid: int, status: mixed, datetime: mixed, url?: mixed, fields: array|null}>

CalendarHelper extends BaseHelper in package Application uses FieldTrait, EagerLoadingTrait

Table of Contents

Properties

Methods

Properties

$bids

$cids

$eids

$uids

$beginW

$bid

$blogAxis

$categoryAxis

$cid

$config

$countQuery

$d

$eid

$end

$endDate

$entries

$entryEndDate

$entryStartDate

$Field

$firstDay

$firstW

$keyword

$loopCount

$m

$order

$page

$separateWeek

$sortFields

$start

$startDate

$tags

$uid

$y

$ymd

Methods

__construct()

Parameters

buildEntryCalendarQuery()

Parameters

Return values

getDate()

Return values

getDays()

Parameters

Return values

getNextMonthPaddingDays()

Parameters

Return values

getPrevMonthPaddingDays()

Parameters

Return values

getWeekLabel()

Return values

setCalendarVars()

setDateContextVars()

setProperty()

Parameters

autoConvertTypeTrait()

Parameters

Return values

buildBasicFieldGroupTrait()

Parameters

Return values

buildBasicFieldTrait()

Parameters

Return values

buildFieldTrait()

Parameters

Return values

buildMultiFieldGroupTrait()

Parameters

Return values

buildMultiFieldTrait()

Parameters

Return values

CalendarHelper extends BaseHelper
in package

Application

uses FieldTrait, EagerLoadingTrait