core_calendar

Topics
	calendar
	external
	test

Namespaces
namespace	calendartype_test_example
namespace	core_calendar
	Action factory.
namespace	core_calendar\external
namespace	core_calendar\external\export
	This is the external method for exporting a calendar token.
namespace	core_calendar\local
	Contains class containing the internal calendar API.
namespace	core_calendar\local\event
	Core container for calendar events.
namespace	core_calendar\local\event\data_access
	Event vault class.
namespace	core_calendar\local\event\entities
	Calendar action event class.
namespace	core_calendar\local\event\exceptions
	Invalid callback exception.
namespace	core_calendar\local\event\factories
	Action factory interface.
namespace	core_calendar\local\event\forms
	The mform for creating a calendar event.
namespace	core_calendar\local\event\mappers
	Event create form and update form mapper.
namespace	core_calendar\local\event\proxies
	Course module cm_info proxy.
namespace	core_calendar\local\event\strategies
	Raw event retrieval strategy.
namespace	core_calendar\local\event\value_objects
	Class representing an action a user should take.
namespace	core_calendar\output
	Class to display collection select for the refresh interval.
namespace	core_calendar\privacy
	Privacy class for requesting user data.

Classes
class	action_event_test_factory
	A test factory that will create action events. More...
class	calendartype_test_example\structure
	Handles calendar functions for the test calendar. More...
class	core_calendar\action_factory
	Action factory class. More...
class	core_calendar\external\calendar_day_exporter
	Class for displaying the day view. More...
class	core_calendar\external\calendar_event_exporter
	Class for displaying a calendar event. More...
class	core_calendar\external\calendar_upcoming_exporter
	Class for displaying the day view. More...
class	core_calendar\external\date_exporter
	Class for normalising the date data. More...
class	core_calendar\external\day_exporter
	Class for displaying the day view. More...
class	core_calendar\external\day_name_exporter
	Class for displaying the day view. More...
class	core_calendar\external\event_action_exporter
	Class for displaying a calendar event's action. More...
class	core_calendar\external\event_exporter
	Class for displaying a calendar event. More...
class	core_calendar\external\event_exporter_base
	Class for displaying a calendar event. More...
class	core_calendar\external\event_icon_exporter
	Class for displaying a calendar event's icon. More...
class	core_calendar\external\event_subscription_exporter
	Class for displaying a calendar event's subscription. More...
class	core_calendar\external\events_exporter
	Class for displaying a list of calendar events. More...
class	core_calendar\external\events_grouped_by_course_exporter
	Class for displaying a list of calendar events grouped by course id. More...
class	core_calendar\external\events_related_objects_cache
	Class to providing the related objects when exporting a list of calendar events. More...
class	core_calendar\external\events_same_course_exporter
	Class for displaying a list of calendar events for a single course. More...
class	core_calendar\external\export\token
	This is the external method for exporting a calendar token. More...
class	core_calendar\external\footer_options_exporter
	Class for exporting calendar footer view options data. More...
class	core_calendar\external\month_exporter
	Class for displaying the month view. More...
class	core_calendar\external\week_day_exporter
	Class for displaying the day on month view. More...
class	core_calendar\external\week_exporter
	Class for displaying the week view. More...
class	core_calendar\local\api
	Class containing the local calendar API. More...
class	core_calendar\local\event\container
	Core container. More...
class	core_calendar\local\event\data_access\event_vault
	Event vault class. More...
interface	core_calendar\local\event\data_access\event_vault_interface
	Interface for an event vault class. More...
class	core_calendar\local\event\entities\action_event
	Class representing an actionable event. More...
interface	core_calendar\local\event\entities\action_event_interface
	Interface for an action event class. More...
interface	core_calendar\local\event\entities\action_interface
	Interface for a action class. More...
class	core_calendar\local\event\entities\event
	Class representing a calendar event. More...
interface	core_calendar\local\event\entities\event_collection_interface
	Interface for an event collection class. More...
interface	core_calendar\local\event\entities\event_interface
	Interface for an event class. More...
class	core_calendar\local\event\entities\repeat_event_collection
	Class representing a collection of repeat events. More...
class	core_calendar\local\event\exceptions\invalid_callback_exception
	Invalid callback exception. More...
class	core_calendar\local\event\exceptions\invalid_parameter_exception
	General invalid parameter exception. More...
class	core_calendar\local\event\exceptions\limit_invalid_parameter_exception
	Invalid limit parameter exception. More...
class	core_calendar\local\event\exceptions\member_does_not_exist_exception
	Member does not exist exception. More...
class	core_calendar\local\event\exceptions\timesort_invalid_parameter_exception
	Invalid timesort parameter exception. More...
interface	core_calendar\local\event\factories\action_factory_interface
class	core_calendar\local\event\factories\event_abstract_factory
	Abstract factory for creating calendar events. More...
class	core_calendar\local\event\factories\event_factory
	Event factory class. More...
interface	core_calendar\local\event\factories\event_factory_interface
	Interface for an event factory class. More...
class	core_calendar\local\event\forms\create
	The mform class for creating a calendar event. More...
class	core_calendar\local\event\forms\update
	The mform class for updating a calendar event. More...
class	core_calendar\local\event\mappers\create_update_form_mapper
	Event create form and update form mapper class. More...
interface	core_calendar\local\event\mappers\create_update_form_mapper_interface
	Interface for a create_update_form_mapper class. More...
class	core_calendar\local\event\mappers\event_mapper
	Event mapper class. More...
interface	core_calendar\local\event\mappers\event_mapper_interface
	Interface for an event mapper class. More...
class	core_calendar\local\event\proxies\cm_info_proxy
	Course module stdClass proxy. More...
class	core_calendar\local\event\proxies\coursecat_proxy
	Course category proxy. More...
interface	core_calendar\local\event\proxies\proxy_interface
	Interface for a proxy class. More...
class	core_calendar\local\event\proxies\std_proxy
	stdClass proxy. More...
class	core_calendar\local\event\strategies\raw_event_retrieval_strategy
	Raw event retrieval strategy. More...
interface	core_calendar\local\event\strategies\raw_event_retrieval_strategy_interface
	Interface for an raw event retrival strategy class. More...
class	core_calendar\local\event\value_objects\action
	Class representing an action a user should take. More...
interface	core_calendar\local\event\value_objects\description_interface
	Interface for a description value object. More...
class	core_calendar\local\event\value_objects\event_description
	Class representing a description value object. More...
class	core_calendar\local\event\value_objects\event_times
	Class representing event times. More...
interface	core_calendar\local\event\value_objects\times_interface
	Interface for various times. More...
class	core_calendar\output\refreshintervalcollection
class	core_calendar\privacy\provider
	Privacy Subsystem for core_calendar implementing metadata, plugin, and user_preference providers. More...
class	core_calendar\rrule_manager
	Defines calendar class to manage recurrence rule (rrule) during ical imports. More...
class	core_calendar\type_base
	Defines functions used by calendar type plugins. More...
class	core_calendar\type_factory
	Class core_calendar\type_factory. More...
class	core_calendar_export_form
	The mform class for creating and editing a calendar. More...

Functions
	create_action_event (array $data)
	Helper function to create an action event.
	create_event ($properties)
	Create a calendar event with the given properties.
	create_group_override_event (string $modulename, int $instanceid, int $courseid, int $groupid)
	Helper function to create an group override calendar event.
	create_standard_events (int $quantity)
	Helper function to create a x number of events for each event type.
	create_user_override_event (string $modulename, int $instanceid, int $userid)
	Helper function to create an user override calendar event.

Variables
global	$CFG
global	core_calendar\external\export::$CFG
	if (!defined( 'MOODLE_INTERNAL'))
	The mform for exporting calendar events.

Detailed Description

Function Documentation

create_action_event()

create_action_event

(

array

$data

)

Helper function to create an action event.

Parameters

array

$data

The event data.

Return values

bool|calendar_event

create_event()

create_event

(

$properties

)

Create a calendar event with the given properties.

Parameters

array

$properties

The properties to set on the event

Return values

calendar_event

create_group_override_event()

create_group_override_event	(	string	$modulename,
		int	$instanceid,
		int	$courseid,
		int	$groupid )

Helper function to create an group override calendar event.

Parameters

string	$modulename	The modulename.
int	$instanceid	The instance id.
int	$courseid	The course id.
int	$groupid	The group id.

Return values

calendar_event|false

create_standard_events()

create_standard_events

(

int

$quantity

)

Helper function to create a x number of events for each event type.

Parameters

int

$quantity

The quantity of events to be created.

Return values

array

List of created events.

create_user_override_event()

create_user_override_event	(	string	$modulename,
		int	$instanceid,
		int	$userid )

Helper function to create an user override calendar event.

Parameters

string	$modulename	The modulename.
int	$instanceid	The instance id.
int	$userid	The user id.

Return values

calendar_event|false

Variable Documentation

if

if(!defined('MOODLE_INTERNAL'))

(

!

defined 'MOODLE_INTERNAL'

)

The mform for exporting calendar events.

Copyright

2014 Brian Barnes

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later