Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Protected Attributes | List of all members
core_calendar\local\event\mappers\event_mapper Class Reference

Event mapper class. More...

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

Public Member Functions

 __construct (event_factory_interface $factory)
 Constructor. More...
 
 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 $legacyevent)
 Map a legacy event to an event. More...
 

Protected Attributes

event_factory_interface $factory
 $factory Event factory.
 

Detailed Description

Event mapper class.

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

Constructor & Destructor Documentation

◆ __construct()

core_calendar\local\event\mappers\event_mapper::__construct ( event_factory_interface  $factory)

Constructor.

Parameters
event_factory_interface$factoryEvent factory.

Member Function Documentation

◆ from_event_to_assoc_array()

core_calendar\local\event\mappers\event_mapper::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.

Implements core_calendar\local\event\mappers\event_mapper_interface.

◆ from_event_to_legacy_event()

core_calendar\local\event\mappers\event_mapper::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.

Implements core_calendar\local\event\mappers\event_mapper_interface.

◆ from_event_to_stdclass()

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

Map an event to a stdClass.

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

Implements core_calendar\local\event\mappers\event_mapper_interface.

◆ from_legacy_event_to_event()

core_calendar\local\event\mappers\event_mapper::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.

Implements core_calendar\local\event\mappers\event_mapper_interface.


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