class Calendar extends UIComponent

Documentation

Constants

SYSTEM_TEMPLATE_UI_FOLDER

GP_PARAM

Properties

$xf_link from  UIComponent
$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

__construct()

UIComponent constructor.

__set(string $key, mixed $value)

Magic setter. Enables call of setter functions via

string
__toString()

No description

enable_month_select() deprecated

Enables the user to select months/years via dropdown

enable_paging() deprecated

Enables the user to page through months/years

mixed
get($var)

Get Variable / Option

int
getSelectedDateTimestamp()

Has the date of this component been set via the GPVars? Returns the current selection as timestamp

string
get_current_month()

Get selected month from paging

string
get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

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

init()

put your comment there.

string
parse_template(string $template_content, array|bool $marker_array = false)

No description

string|null
parse_template_cb_wrapper(mixed $matches)

No description

mixed|string
parse_xtag($xml_source)

No description

process()

Declared in Classes

render()

No description

mixed
render_xtag_element()

No description

void
reset_marker_content()

restores original content of marker_content

void
set(mixed $var, mixed $value = false)

Set Variable / Option

setDefaultTimestamp(int $dateTS)

Set the default month/year to show

setShowDaySelectTable(bool $enable = true)

Show day table selection

setShowMonthPagination(bool $enable = true)

No description

setShowMonthSelect(bool $enable = true)

Enables the user to select months/years via dropdown

setXUITarget(UIAjaxComponent $ajaxComponent)

No description

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

set_day_info(string $date, mixed $link_params = false, bool|string $marked = false)

Set info for a specific date

void
set_default_link(array $link_params)

Set default link params, all params will be parsed by strftime.

void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

set_mod(mixed $mod)

Set link to owning module

set_month(int $month, int $year = false) deprecated

Set the default month/year to show

set_options(array $options) deprecated

Set Options

void
set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

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

Details

at line 46
__construct()

UIComponent constructor.

at line 57
__set(string $key, mixed $value)

Magic setter. Enables call of setter functions via

Parameters

string $key
mixed $value

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 147
enable_month_select() deprecated

deprecated Use setShowMonthSelect()

Enables the user to select months/years via dropdown

at line 139
enable_paging() deprecated

deprecated Use setShowMonthPagination()

Enables the user to page through months/years

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 77
int getSelectedDateTimestamp()

Has the date of this component been set via the GPVars? Returns the current selection as timestamp

Return Value

int

Timestamp

at line 225
string get_current_month()

Get selected month from paging

Return Value

string

Y-m

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.

Return Value

string

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

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

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

Parameters

string $template_content

HTML Template

array|bool $marker_array

Markers and Values

Return Value

string

Parsed HTML Content

in UIComponent at line 234
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

in UIComponent at line 260
mixed|string parse_xtag($xml_source)

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in UIComponent at line 335
process()

Declared in Classes

at line 234
render()

No description

Exceptions

Exception

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

in UIComponent at line 106
void set(mixed $var, mixed $value = false)

Set Variable / Option

Parameters

mixed $var

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)

mixed $value

Value of Variable

Return Value

void

at line 85
setDefaultTimestamp(int $dateTS)

Set the default month/year to show

Parameters

int $dateTS

Timestamp

at line 158
Calendar setShowDaySelectTable(bool $enable = true)

Show day table selection

Parameters

bool $enable

Return Value

Calendar

at line 180
Calendar setShowMonthPagination(bool $enable = true)

No description

Parameters

bool $enable

Return Value

Calendar

at line 170
Calendar setShowMonthSelect(bool $enable = true)

Enables the user to select months/years via dropdown

Parameters

bool $enable

Return Value

Calendar

at line 190
Calendar setXUITarget(UIAjaxComponent $ajaxComponent)

No description

Parameters

UIAjaxComponent $ajaxComponent

Return Value

Calendar

in UIComponent at line 122
void set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

Parameters

mixed $member_array

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)

mixed $vars

Value of Variable

Return Value

void

at line 130
set_day_info(string $date, mixed $link_params = false, bool|string $marked = false)

Set info for a specific date

Parameters

string $date

(2012-02-01 or 37182763980)

mixed $link_params

array('view'=>,'page'=>,'cmd'=>) [except label]

bool|string $marked

Mark this element? true, false or alt (for alternative)

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

Parameters

array $link_params

array('view'=>,'page'=>,'cmd'=>) [except label]

Return Value

void

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()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

at line 96
set_month(int $month, int $year = false) deprecated

deprecated Use setDefaultTimestamp()

Set the default month/year to show

Parameters

int $month

(1-12)

int $year

at line 200
set_options(array $options) deprecated

deprecated - only for backwards compatiblity

Set Options

Parameters

array $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)

Parameters

mixed $input_params

Return Value

void

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

Parameters

int|string $start

(Timestamp or Mysql-Datetime Format)

int|string $end

(Timestamp or Mysql-Datetime Format)