Calendar_Year::build

Calendar_Year::build() – Builds the Months of the Year.

Synopsis

require_once 'Year.php';

boolean Calendar_Year::build ( array$sDates = array() , int$firstDay = null )

Description

Note: by defining the constant CALENDAR_MONTH_STATE you can control what class of Calendar_Month is built e.g.;

1  require_once 'Calendar/Calendar_Year.php';
    2
define
('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKDAYS); // Use Calendar_Month_Weekdays
    3  // define ('CALENDAR_MONTH_STATE',CALENDAR_USE_MONTH_WEEKS); // Use Calendar_Month_Weeks
    4

It defaults to building Calendar_Month objects.

Parameter

array $sDates

(optional) array of Calendar_Month objects representing selected months

integer $firstDay

(optional) first day of week (e.g. 0 for Sunday, 2 for Tuesday etc.)

Throws

throws no exceptions thrown

Note

This function can not be called statically.

Constructs Calendar_Year (Previous) Calendar_Month API (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

There are no user contributed notes for this page.