OpenPSA API Documentation
Back to top  

org.openpsa.calendar site interface class.

package org.openpsa.calendar

 Methods

_handler_day (String $handler_id, array $args, array $data)

Day view

Parameters

$handler_id

StringName of the request handler

$args

arrayVariable arguments

$data

array&$data Public request data, passed by reference

_handler_event (String $handler_id, array $args, array $data)

Handle the single event view

Parameters

$handler_id

StringName of the request handler

$args

arrayVariable arguments

$data

array&$data Public request data, passed by reference

_handler_month (String $handler_id, array $args, array $data)

Month view

Parameters

$handler_id

StringName of the request handler

$args

arrayVariable arguments

$data

array&$data Public request data, passed by reference

_handler_week (String $handler_id, array $args, array $data)

Week view

Parameters

$handler_id

StringName of the request handler

$args

arrayVariable arguments

$data

array&$data Public request data, passed by reference

_on_initialize ()

Initialization of the handler class

_show_day (String $handler_id, array $data)

Show day view

Parameters

$handler_id

StringName of the request handler

$data

array&$data Public request data, passed by reference

_show_event (String $handler_id, array $data)

Show a single event

Parameters

$handler_id

StringName of the request handler

$data

array&$data Public request data, passed by reference

_show_month (String $handler_id, array $data)

Show the month view

Parameters

$handler_id

StringName of the request handler

$data

array&$data Public request data, passed by reference

_show_week (string $handler_id, array $data)

Show the week view

Parameters

$handler_id

stringName of the request handler

$data

array&$data Public request data, passed by reference

_generate_date ($args)

Parameters

$args

_get_datestring (int $from)

Helper that formats a timestamp into a string

Parameters

$from

intThe timestamp, if any

Returns

stringThe formatted time

_populate_calendar_contacts (int $from, int $to)

Populate the calendar with selected contacts

Parameters

$from

intStart time

$to

intEnd time

_populate_calendar_from_filter ($user, $from, $to)

Parameters

$user

$from

$to

_populate_calendar_resource (\midcom_db_person $resource, int $from, int $to)

Populate the calendar with resources

Parameters

$resource

\midcom_db_person

$from

intStart time

$to

intEnd time

_populate_toolbar (string $path)

Populate the toolbar

Parameters

$path

stringPath to calendar

 Properties

 

\org_openpsa_widgets_calendar $_calendar

The calendar widget we're working on
 

\midcom_helper_datamanager2_datamanager $_datamanager

Datamanager2 instance
 

\midcom_db_event $_root_event

The calendar root event
 

int $_selected_time

The time to show
 

mixed $_shown_persons