Summary
- File
- Package hierarchy Util
- Class hierarchy \MiniCalendar
This class enables you to retrieve easily a date entered by a user.
If the user isn't in the same timezone as the server, the hour will be automatically recomputed.
Class MiniCalendar
Methods
__construct()
__construct( $html_id, \Date $date = null) Builds a calendar which will be displayable.
Parameters
| $html_id | ||
| \Date | $date |
- Inherited from \MiniCalendar
Tags
| None found |
set_date()
set_date(\Date $date) Sets the date at which will be initialized the calendar.
Parameters
| \Date | $date | Date |
- Inherited from \MiniCalendar
Tags
| None found |
set_style()
set_style(string $style) Sets the CSS properties of the element.
You can use it if you want to customize the mini calendar, but the best solution is to redefine the template in your module. The template used is framework/mini_calendar.tpl.
Parameters
| string | $style | The CSS properties |
- Inherited from \MiniCalendar
Tags
| None found |
get_date()
get_date() : \DateReturns the date
Returns
\Date
—
the date
- Inherited from \MiniCalendar
Tags
| None found |
display()
display() : stringDisplays the mini calendar. You must call the display method in the same order as the calendars are displayed, because it requires a javascript code loading.
Returns
string
—
The code to write in the HTML page.
- Inherited from \MiniCalendar
Tags
| None found |
retrieve_date()
retrieve_date(string $calendar_name) : \DateRetrieves a date entered in a mini calendar.
Parameters
| string | $calendar_name | Name of the calendar (HTML identifier). |
Returns
\Date
—
The date of the calendar.
static
- Inherited from \MiniCalendar
Tags
| None found |
Properties
$num_instance
$num_instance : integer
integer
— The number of calendars created in that page (used to know if we have to load the javascript code)
Tags
| None found |
$style
$style : string
string
— The CSS properties of the calendar
Tags
| None found |
$html_id
$html_id : string
string
— The calendar id
Tags
| None found |
$date
$date : \Date
\Date
— The date it displays
Tags
| None found |
$num_instances
$num_instances :
Tags
| None found |
$js_inclusion_already_done
$js_inclusion_already_done :
Tags
| None found |