Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Public Member Functions | List of all members
core_calendar\local\event\mappers\event_mapper_interface Interface Reference

Interface for an event mapper class. More...

Inheritance diagram for core_calendar\local\event\mappers\event_mapper_interface:
core_calendar\local\event\mappers\event_mapper

Public Member Functions

 from_event_to_assoc_array (event_interface $event)
 Map an event to an associative array. More...
 
 from_event_to_legacy_event (event_interface $event)
 Map an event to a legacy event. More...
 
 from_event_to_stdclass (event_interface $event)
 Map an event to a stdClass. More...
 
 from_legacy_event_to_event (\calendar_event $event)
 Map a legacy event to an event. More...
 

Detailed Description

Interface for an event mapper class.

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

Member Function Documentation

◆ from_event_to_assoc_array()

core_calendar\local\event\mappers\event_mapper_interface::from_event_to_assoc_array ( event_interface  $event)

Map an event to an associative array.

Parameters
event_interface$eventThe legacy event.
Return values
arrayThe mapped legacy event array.

Implemented in core_calendar\local\event\mappers\event_mapper.

◆ from_event_to_legacy_event()

core_calendar\local\event\mappers\event_mapper_interface::from_event_to_legacy_event ( event_interface  $event)

Map an event to a legacy event.

Parameters
event_interface$eventThe legacy event.
Return values
calendar_eventThe mapped legacy event.

Implemented in core_calendar\local\event\mappers\event_mapper.

◆ from_event_to_stdclass()

core_calendar\local\event\mappers\event_mapper_interface::from_event_to_stdclass ( event_interface  $event)

Map an event to a stdClass.

Parameters
event_interface$eventThe legacy event.
Return values
stdClassThe mapped stdClass.

Implemented in core_calendar\local\event\mappers\event_mapper.

◆ from_legacy_event_to_event()

core_calendar\local\event\mappers\event_mapper_interface::from_legacy_event_to_event ( \calendar_event  $event)

Map a legacy event to an event.

Parameters
calendar_event$eventThe legacy event.
Return values
event_interfaceThe mapped event.

Implemented in core_calendar\local\event\mappers\event_mapper.


The documentation for this interface was generated from the following file: