EC-CUBE
Public メソッド | 変数
クラス Calendar_Decorator
Calendar_Decoratorに対する継承グラフ
Inheritance graph
[凡例]

Public メソッド

 Calendar_Decorator (&$calendar)
 setTimestamp ($ts)
 getTimestamp ()
 setSelected ($state=true)
 isSelected ()
 adjust ()
 toArray ($stamp=null)
 returnValue ($returnType, $format, $stamp, $default)
 setFirst ($state=true)
 setLast ($state=true)
 isFirst ()
 isLast ()
 setEmpty ($state=true)
 isEmpty ()
 build ($sDates=array())
 fetch ()
 fetchAll ()
 size ()
 isValid ()
getValidator ()
getEngine ()
 prevYear ($format= 'int')
 thisYear ($format= 'int')
 nextYear ($format= 'int')
 prevMonth ($format= 'int')
 thisMonth ($format= 'int')
 nextMonth ($format= 'int')
 prevWeek ($format= 'n_in_month')
 thisWeek ($format= 'n_in_month')
 nextWeek ($format= 'n_in_month')
 prevDay ($format= 'int')
 thisDay ($format= 'int')
 nextDay ($format= 'int')
 prevHour ($format= 'int')
 thisHour ($format= 'int')
 nextHour ($format= 'int')
 prevMinute ($format= 'int')
 thisMinute ($format= 'int')
 nextMinute ($format= 'int')
 prevSecond ($format= 'int')
 thisSecond ($format= 'int')
 nextSecond ($format= 'int')

変数

 $calendar

関数

adjust ( )

Adjusts the date (helper method)

戻り値:
void public
build ( sDates = array())

Build the children

引数:
arraycontaining Calendar objects to select (optional)
戻り値:
boolean public

MonthPayload_Decoratorで再定義されています。

Calendar_Decorator ( &$  calendar)

Constructs the Calendar_Decorator

引数:
objectsubclass to Calendar to decorate
fetch ( )

Iterator method for fetching child Calendar subclass objects (e.g. a minute from an hour object). On reaching the end of the collection, returns false and resets the collection for further iteratations.

戻り値:
mixed either an object subclass of Calendar or false public

MonthPayload_Decoratorで再定義されています。

fetchAll ( )

Fetches all child from the current collection of children

戻り値:
array public
& getEngine ( )

Returns a reference to the current Calendar_Engine being used. Useful for Calendar_Table_Helper and Calendar_Validator

戻り値:
object implementing Calendar_Engine_Inteface private

Returns a timestamp from the current date / time values. Format of timestamp depends on Calendar_Engine implementation being used

戻り値:
int timestamp public
& getValidator ( )

Returns an instance of Calendar_Validator

戻り値:
Calendar_Validator public
isEmpty ( )
戻り値:
boolean public
isFirst ( )

Returns true if Day object is first in a Week Only relevant when Day is created by Calendar_Month_Weekdays::build()

戻り値:
boolean public
isLast ( )

Returns true if Day object is last in a Week Only relevant when Day is created by Calendar_Month_Weekdays::build()

戻り値:
boolean public

True if the calendar subclass object is selected (e.g. today)

戻り値:
boolean public
isValid ( )

Determine whether this date is valid, with the bounds determined by the Calendar_Engine. The call is passed on to Calendar_Validator::isValid

戻り値:
boolean public
nextDay ( format = 'int')

Returns the value for the next day

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 12 or timestamp public
nextHour ( format = 'int')

Returns the value for the next hour

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 14 or timestamp public
nextMinute ( format = 'int')

Returns the value for the next minute

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 25 or timestamp public
nextMonth ( format = 'int')

Returns the value for next month

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 6 or timestamp public
nextSecond ( format = 'int')

Returns the value for the next second

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 45 or timestamp public
nextWeek ( format = 'n_in_month')

Returns the value for next week

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 6 or timestamp public
nextYear ( format = 'int')

Returns the value for next year

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 2004 or timestamp public
prevDay ( format = 'int')

Returns the value for the previous day

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 10 or timestamp public
prevHour ( format = 'int')

Returns the value for the previous hour

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 13 or timestamp public
prevMinute ( format = 'int')

Returns the value for the previous minute

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 23 or timestamp public
prevMonth ( format = 'int')

Returns the value for the previous month

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 4 or Unix timestamp public
prevSecond ( format = 'int')

Returns the value for the previous second

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 43 or timestamp public
prevWeek ( format = 'n_in_month')

Returns the value for the previous week

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 4 or Unix timestamp public
prevYear ( format = 'int')

Returns the value for the previous year

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 2002 or timestamp public
returnValue ( returnType,
format,
stamp,
default 
)

Returns the value as an associative array (helper method)

引数:
stringtype of date object that return value represents
string$format['int' | 'array' | 'timestamp' | 'object']
mixedtimestamp (depending on Calendar engine being used)
intinteger default value (i.e. give me the answer quick)
戻り値:
mixed private
setEmpty ( state = true)

Defines Day object as empty Only used by Calendar_Month_Weekdays::build()

引数:
booleanstate
戻り値:
void private
setFirst ( state = true)

Defines Day object as first in a week Only used by Calendar_Month_Weekdays::build()

引数:
booleanstate
戻り値:
void private
setLast ( state = true)

Defines Day object as last in a week Used only following Calendar_Month_Weekdays::build()

引数:
booleanstate
戻り値:
void private
setSelected ( state = true)

Defines calendar object as selected (e.g. for today)

引数:
booleanstate whether Calendar subclass
戻り値:
void public
setTimestamp ( ts)

Defines the calendar by a Unix timestamp, replacing values passed to the constructor

引数:
intUnix timestamp
戻り値:
void public
size ( )

Get the number Calendar subclass objects stored in the internal collection.

戻り値:
int public
thisDay ( format = 'int')

Returns the value for this day

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 11 or timestamp public
thisHour ( format = 'int')

Returns the value for this hour

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 14 or timestamp public
thisMinute ( format = 'int')

Returns the value for this minute

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 24 or timestamp public
thisMonth ( format = 'int')

Returns the value for this month

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 5 or timestamp public
thisSecond ( format = 'int')

Returns the value for this second

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 44 or timestamp public
thisWeek ( format = 'n_in_month')

Returns the value for this week

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 5 or timestamp public
thisYear ( format = 'int')

Returns the value for this year

引数:
stringreturn value format ['int' | 'timestamp' | 'object' | 'array']
戻り値:
int e.g. 2003 or timestamp public
toArray ( stamp = null)

Returns the date as an associative array (helper method)

引数:
mixedtimestamp (leave empty for current timestamp)
戻り値:
array public

このクラスの説明は次のファイルから生成されました:
 全て データ構造 ネームスペース 関数 変数