CalendarHelper
extends BaseHelper
in package
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
Methods
- __construct() : mixed
- コンストラクタ
- buildCalendar() : array<string|int, mixed>
- カレンダーを組み立て
- buildDateArray() : array<string|int, mixed>
- 日付の配列を組み立て
- buildMonth() : array<string|int, mixed>
- 月のカレンダーを組み立て
- buildRange() : array<string|int, mixed>
- 日付の配列を組み立て
- getDate() : array<string|int, mixed>
- dateブロックの変数の取得
- getEndDate() : string
- カレンダーの終了日を取得
- getStartDate() : string
- カレンダーの開始日を取得
- getWeekLabel() : array<string|int, mixed>
- 曜日ラベルの取得
- getYearDate() : array<string|int, mixed>
- dateブロックの変数の取得
- 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
Methods
__construct()
コンストラクタ
public
__construct(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
buildCalendar()
カレンダーを組み立て
public
buildCalendar([array{mode?: "month"|"range", weekLabels?: string[], baseDate?: string, startWeekDay?: int, showPadding?: bool, pastDays?: int, futureDays?: int} $options = [] ]) : array<string|int, mixed>
Parameters
- $options : array{mode?: "month"|"range", weekLabels?: string[], baseDate?: string, startWeekDay?: int, showPadding?: bool, pastDays?: int, futureDays?: int} = []
Return values
array<string|int, mixed>buildDateArray()
日付の配列を組み立て
public
buildDateArray(DateTime $date, bool $isPadding, array<string|int, mixed> $weekLabels) : array<string|int, mixed>
Parameters
- $date : DateTime
- $isPadding : bool
- $weekLabels : array<string|int, mixed>
Return values
array<string|int, mixed>buildMonth()
月のカレンダーを組み立て
public
buildMonth(DateTime $baseDate, array<string|int, mixed> $weekLabels, int $startWeekDay, bool $showPadding) : array<string|int, mixed>
Parameters
- $baseDate : DateTime
- $weekLabels : array<string|int, mixed>
- $startWeekDay : int
-
0 = Sunday
- $showPadding : bool
Return values
array<string|int, mixed>buildRange()
日付の配列を組み立て
public
buildRange(DateTime $baseDate, array<string|int, mixed> $weekLabels, int $pastDays, int $futureDays) : array<string|int, mixed>
Parameters
- $baseDate : DateTime
- $weekLabels : array<string|int, mixed>
- $pastDays : int
- $futureDays : int
Return values
array<string|int, mixed>getDate()
dateブロックの変数の取得
public
getDate(string $mode, Datetime $date[, int|null $past = null ][, int|null $future = null ]) : array<string|int, mixed>
Parameters
- $mode : string
-
'month' or 'range'
- $date : Datetime
- $past : int|null = null
- $future : int|null = null
Return values
array<string|int, mixed>getEndDate()
カレンダーの終了日を取得
public
getEndDate(string $mode, string $baseDate, int $startWeekDay, int $futureDays) : string
Parameters
- $mode : string
-
'month' or 'range'
- $baseDate : string
-
'YYYY-MM-DD'
- $startWeekDay : int
-
// 0 = Sunday
- $futureDays : int
Return values
stringgetStartDate()
カレンダーの開始日を取得
public
getStartDate(string $mode, string $baseDate, int $startWeekDay, int $pastDays) : string
Parameters
- $mode : string
-
'month' or 'range'
- $baseDate : string
-
'YYYY-MM-DD'
- $startWeekDay : int
-
// 0 = Sunday
- $pastDays : int
Return values
stringgetWeekLabel()
曜日ラベルの取得
public
getWeekLabel(array<string|int, string> $weekLabels, int $beginWeek) : array<string|int, mixed>
Parameters
- $weekLabels : array<string|int, string>
- $beginWeek : int
-
0 = Sunday
Return values
array<string|int, mixed>getYearDate()
dateブロックの変数の取得
public
getYearDate(Datetime $date) : array<string|int, mixed>
Parameters
- $date : Datetime
Return values
array<string|int, mixed>setProperty()
プロパティの設定
public
setProperty(string $name, mixed $value) : void
Parameters
- $name : string
- $value : mixed