month_overview

Summary

Generates a structure that can be used to build a calendar.

Usage

input|month_overview( field, 
                      today_timestamp,
                      hash( 'current',       current_timestamp,
                            'day_class',     day_class
                            'current_class', current_class,
                            'link',          link,
                            'month_link',    month_link,
                            'year_link',     year_link, 
                            'day_link',      day_link,
                            'next',          hash( 'link', next_link ),
                            'previous',      hash( 'link', previous_link ) ) )

Parameters

Name	Type	Description	Required
field	string	The way the objects should be grouped.	Yes.
today_timestamp	integer	The UNIX timestamp for the day being searched.	Yes.
current_timestamp	integer	The UNIX timestamp of the current date/time.	No.
day_class	string	The CSS class that should be used for a normal day.	No.
current_class	string	The CSS class that should be used for the current day.	No.
link	string	Link to days containing objects ("content/view/full/node_id").	No.
month_link	string	Append "/month/MON" to links or not.	No.
year_link	string	Append "/year/YEAR" to links or not.	No.
day_link	string	Append "/day/DAY" to links or not.	No.
next_link	string	Link to the next month.	No.
previous_link	string	Link to the previous month.	No.

Returns

A complex structure (see below).

Description

This operator takes an array of content objects as input and analyzes and distributes them in a given month. It returns a complex structure (see below) that can be used by the "monthview.tpl" template, which will highlight days when at least one object has been published (see "design/standard/templates/navigator/monthview.tpl"). The following structure will be returned:

.
|-- year
|-- month
|-- weekdays[]
|   |-- day
|   |-- class
|
|-- weeks[][]
|   |--day
|   |--link
|   |--class
|   |--highlight
|
|-- next
|   |--month
|   |--link
|
|-- previous
    |--month
    |--link