Calendar
class Calendar extends UIComponent
Constants
SYSTEM_TEMPLATE_UI_FOLDER |
|
GP_PARAM |
|
Properties
Link | $xf_link | from UIComponent | |
string | $link_id | from UIComponent | |
array | $GPvars | from UIComponent | |
Controller | $mod | from UIComponent | |
protected array | $local_template_marker | from UIComponent | |
protected bool | $_overwrite_param_array | from UIComponent | |
protected bool|array|ModelCollection | $marker_content | from UIComponent | |
string | $mod_object_manager | from UIComponent | |
protected bool | $_orig_marker_content | from UIComponent | |
protected array | $_allowed_params_filter | from UIComponent | |
string | $unique_dom_id | from UIComponent | |
protected string | $uid | from UIComponent | |
string read-only | $_content | When used in template this property will contain the XML/HTML within the XUI Nodes |
from UIComponent |
protected | $month | ||
protected | $year | ||
protected array | $options | Internal options |
|
protected array | $day_info |
Methods
UIComponent constructor.
Magic setter. Enables call of setter functions via
Has the date of this component been set via the GPVars? Returns the current selection as timestamp
Get selected month from paging
Generates a unique dom id, dependent on the provided UID, as well as the current context.
Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder
No description
No description
Set the default month/year to show
Show day table selection
No description
Enables the user to select months/years via dropdown
Set Variable / Option for an array
Set info for a specific date
Set default link params, all params will be parsed by strftime.
sets marker_content to passed data -> restore original content with reset_marker_content()
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
Set the days to be selected (display style) Only ONE selection possible. Use marks instead for visuals
Details
at line 46
__construct()
UIComponent constructor.
at line 57
__set(string $key, mixed $value)
Magic setter. Enables call of setter functions via
in
UIComponent at line 324
string
__toString()
No description
at line 147
enable_month_select()
deprecated
deprecated
Enables the user to select months/years via dropdown
at line 139
enable_paging()
deprecated
deprecated
Enables the user to page through months/years
in
UIComponent at line 185
mixed
get($var)
Get Variable / Option
at line 77
int
getSelectedDateTimestamp()
Has the date of this component been set via the GPVars? Returns the current selection as timestamp
at line 225
string
get_current_month()
Get selected month from paging
in
UIComponent at line 202
string
get_unique_dom_id()
Generates a unique dom id, dependent on the provided UID, as well as the current context.
in
UIComponent at line 289
Template|null
get_view(string|bool $section = false)
Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder
in
UIComponent at line 72
init()
put your comment there.
..
in
UIComponent at line 221
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 234
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 260
mixed|string
parse_xtag($xml_source)
No description
in
UIComponent at line 335
process()
Declared in Classes
at line 234
render()
No description
in
UIComponent at line 268
mixed
render_xtag_element()
No description
in
UIComponent at line 173
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 106
void
set(mixed $var, mixed $value = false)
Set Variable / Option
at line 85
setDefaultTimestamp(int $dateTS)
Set the default month/year to show
at line 158
Calendar
setShowDaySelectTable(bool $enable = true)
Show day table selection
at line 180
Calendar
setShowMonthPagination(bool $enable = true)
No description
at line 170
Calendar
setShowMonthSelect(bool $enable = true)
Enables the user to select months/years via dropdown
at line 190
Calendar
setXUITarget(UIAjaxComponent $ajaxComponent)
No description
in
UIComponent at line 122
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 130
set_day_info(string $date, mixed $link_params = false, bool|string $marked = false)
Set info for a specific date
at line 108
void
set_default_link(array $link_params)
Set default link params, all params will be parsed by strftime.
Default is NO link on days, only display Example: array('cmd'=>'%d.%m.%Y') will return links with the current date in CMD
in
UIComponent at line 165
void
set_marker_content(mixed $marker_content = false)
sets marker_content to passed data -> restore original content with reset_marker_content()
in
UIComponent at line 90
set_mod(mixed $mod)
Set link to owning module
at line 96
set_month(int $month, int $year = false)
deprecated
deprecated
Set the default month/year to show
at line 200
set_options(array $options)
deprecated
deprecated
Set Options
in
UIComponent at line 135
void
set_render_params(mixed $input_params = array())
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
at line 119
set_selection(int|string $start, int|string $end = null)
Set the days to be selected (display style) Only ONE selection possible. Use marks instead for visuals