baserCMS クラスリファレンス

BcTimeHelper extends TimeHelper
in package
uses BcEventDispatcherTrait

Class BcTimeHelper

Table of Contents

Properties

$jpWeekList  : array<string|int, mixed>
日本語曜日リスト
$nengos  : array<string|int, mixed>
年号リスト
$warekiRegex  : string
和暦文字列の正規表現
$_View  : View
View

Methods

convertToSeirekiYear()  : int|false
和暦の年を西暦に変換する 和暦のフォーマット例:s-48
convertToWareki()  : string
和暦変換
convertToWarekiArray()  : array<string|int, mixed>|string
日付を配列に分解した形で和暦変換する
convertToWarekiYear()  : array<string|int, mixed>|false
西暦を和暦の年に変換する 西暦をまたがる場合があるので配列で返す
dispatchLayerEvent()  : bool|Event
イベントを発火
format()  : string
format 拡張
getJpWeek()  : string
日本の曜日名を1文字 + $suffixの形式で取得する - 引数により、指定しない場合は本日の曜日 - 文字列で、strtotime関数で解析可能な場合は解析された日付の曜日
jpWeek()  : mixed
曜日情報を出力する - 曜日情報が正しく取得できない場合は接尾辞も表示しない - ex) <?php $this->BcTime->jpWeek($post['posts_date'], '曜日'); ?>
minutes()  : mixed
文字列から時間(分)を取得
nengo()  : string
年号を取得
pastDays()  : bool
指定した日数が経過しているか確認する 経過していない場合はtrueを返す 日付が確認できなかった場合もtrueを返す
wareki()  : string|false
和暦を取得(アルファベット)
wyear()  : string|false
和暦の年を取得

Properties

$jpWeekList

日本語曜日リスト

public array<string|int, mixed> $jpWeekList = [0 => '日', 1 => '月', 2 => '火', 3 => '水', 4 => '木', 5 => '金', 6 => '土', 7 => '日']

$nengos

年号リスト

public array<string|int, mixed> $nengos = ["m" => "明治", "t" => "大正", "s" => "昭和", "h" => "平成", "r" => "令和"]

$warekiRegex

和暦文字列の正規表現

public string $warekiRegex = '!^(?<nengo>[mtshr])-(?<year>[0-9]{1,2})([/\-])(?<month>0?[0-9]|1[0-2])([/\-])(?<day>[0-2][0-9]|3[01])$!'

Methods

convertToSeirekiYear()

和暦の年を西暦に変換する 和暦のフォーマット例:s-48

public convertToSeirekiYear(string $year) : int|false
Parameters
$year : string
Tags
checked
noTodo
Return values
int|false

convertToWareki()

和暦変換

public convertToWareki(string $date) : string
Parameters
$date : string

日付

Tags
checked
noTodo
Return values
string

和暦データ

convertToWarekiArray()

日付を配列に分解した形で和暦変換する

public convertToWarekiArray(string|array<string|int, mixed> $date) : array<string|int, mixed>|string
Parameters
$date : string|array<string|int, mixed>

文字列形式の日付 (例: '2018/05/28')、または配列形式の和暦データ

Tags
checked
noTodo
Return values
array<string|int, mixed>|string

配列形式の和暦データ、または日付フォーマットが正しくない場合は空文字

convertToWarekiYear()

西暦を和暦の年に変換する 西暦をまたがる場合があるので配列で返す

public convertToWarekiYear(int $year) : array<string|int, mixed>|false
Parameters
$year : int
Tags
checked
noTodo
Return values
array<string|int, mixed>|false

dispatchLayerEvent()

イベントを発火

public dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
$name : string
$data : array<string|int, mixed> = []
$options : mixed = []
Tags
checked
unitTest
noTodo
Return values
bool|Event

format()

format 拡張

public format([string $date = null ][, array<string|int, mixed> $format = 'yyyy-MM-dd' ][, bool $invalid = false ][, int $timezone = null ]) : string
Parameters
$date : string = null

String Datetime string

$format : array<string|int, mixed> = 'yyyy-MM-dd'
$invalid : bool = false

flag to ignore results of fromString == false

$timezone : int = null

User's timezone string or DateTimeZone

Tags
checked
noTodo
Return values
string

Formatted date string

getJpWeek()

日本の曜日名を1文字 + $suffixの形式で取得する - 引数により、指定しない場合は本日の曜日 - 文字列で、strtotime関数で解析可能な場合は解析された日付の曜日

public getJpWeek([mixed $dateStr = null ][, string $suffix = '' ]) : string
Parameters
$dateStr : mixed = null
$suffix : string = ''

接尾語(曜日 など)

Tags
checked
noTodo
Return values
string

曜日 | 空白

jpWeek()

曜日情報を出力する - 曜日情報が正しく取得できない場合は接尾辞も表示しない - ex) <?php $this->BcTime->jpWeek($post['posts_date'], '曜日'); ?>

public jpWeek([string $dateStr = null ][, string $suffix = '' ]) : mixed
Parameters
$dateStr : string = null

getJpWeek参照

$suffix : string = ''

getJpWeek参照

Tags
checked
noTodo

minutes()

文字列から時間(分)を取得

public minutes(string $strDate) : mixed
Parameters
$strDate : string

日時

Tags
checked
noTodo
Return values
mixed

分/null

nengo()

年号を取得

public nengo(string $w) : string
Parameters
$w : string

年号のローマ字表記の頭文字 m (明治) / t(大正) / s(昭和) / h(平成) / r(令和)

Tags
checked
noTodo
Return values
string

年号をあらわすアルファベット

pastDays()

指定した日数が経過しているか確認する 経過していない場合はtrueを返す 日付が確認できなかった場合もtrueを返す

public pastDays(string $date, int $days[, mixed $now = null ]) : bool
Parameters
$date : string

日付

$days : int

経過日数

$now : mixed = null
Tags
checked
noTodo
Return values
bool

経過有無

wareki()

和暦を取得(アルファベット)

public wareki(string $date) : string|false
Parameters
$date : string

和暦を表す日付文字列(s-48/5/10)

Tags
checked
noTodo
Return values
string|false

和暦

wyear()

和暦の年を取得

public wyear(string $date) : string|false
Parameters
$date : string

和暦を表す日付文字列(s-48/5/10)

Tags
checked
noTodo
Return values
string|false

int / false


        
On this page

Search results