SRFParserFunctions Class Reference

List of all members.

Static Public Member Functions
static	registerFunctions (&$parser)
static	runCalendarStartDate (&$parser, $calendar_type= 'month', $calendar_start_day=null, $calendar_days=7, $default_year=null, $default_month=null, $default_day=null)
static	runCalendarEndDate (&$parser, $calendar_type= 'month', $calendar_start_day=null, $calendar_days=7, $default_year=null, $default_month=null, $default_day=null)
static	getBoundaryDates ($calendar_type= 'month', $calendar_start_day=null, $calendar_days=7, $default_year=null, $default_month=null, $default_day=null)
	Obtain both a lower- and upper- bound date to be used for querying.

---

Detailed Description

Definition at line 18 of file SRF_ParserFunctions.php.

---

Member Function Documentation

static SRFParserFunctions::registerFunctions

(

&$

parser

)

[static]

Definition at line 20 of file SRF_ParserFunctions.php.

static SRFParserFunctions::runCalendarStartDate	(	&$	parser,
		$	calendar_type = 'month',
		$	calendar_start_day = null,
		$	calendar_days = 7,
		$	default_year = null,
		$	default_month = null,
		$	default_day = null
	)			[static]

Definition at line 26 of file SRF_ParserFunctions.php.

References getBoundaryDates().

static SRFParserFunctions::runCalendarEndDate	(	&$	parser,
		$	calendar_type = 'month',
		$	calendar_start_day = null,
		$	calendar_days = 7,
		$	default_year = null,
		$	default_month = null,
		$	default_day = null
	)			[static]

Definition at line 33 of file SRF_ParserFunctions.php.

References getBoundaryDates().

static SRFParserFunctions::getBoundaryDates	(	$	calendar_type = 'month',
		$	calendar_start_day = null,
		$	calendar_days = 7,
		$	default_year = null,
		$	default_month = null,
		$	default_day = null
	)			[static]

Obtain both a lower- and upper- bound date to be used for querying.

Parameters:

	$calendar_type	string Values: 'month' (the default) for monthly calendar such as SRF Calendar; others not yet defined.
	$calendar_start_day	int Optionally force the lower bound date to be a certain day of the week (0 for Sunday, 6 for Saturday). If using a $calendar_type of 'month' this parameter is ignored, as the start day of week for a monthly calendar is currently always set as Sunday. Ohterwise defaults to either the day supplied in the query string, or the current day.
	$calendar_days	int The number of days to display. Ignored if using a $calendar_type of 'month'; otherwise defaults to 7.
	$default_year	int (Optional) Default year if none is specified in the query string. If parameter is not supplied, will fall back to current year.
	$default_month	int (Optional) Default month if none is specified in the query string. If parameter is not supplied, will fall back to current month.
	$default_day	int (Optional) Default day of month if none is specified in the query string. If parameter is not supplied, will fall back to current day of month.

Returns:

array First element contains the lower bound date, second element contains the upper bound, third element contains a date indicating the year/month/day to be queried.

Definition at line 63 of file SRF_ParserFunctions.php.

Referenced by runCalendarEndDate(), and runCalendarStartDate().

---

The documentation for this class was generated from the following file:

• SemanticResultFormats/SRF_ParserFunctions.php