core_calendar\local\event\value_objects\event_description Class Reference

Class representing a description value object. More...

Inheritance diagram for core_calendar\local\event\value_objects\event_description:

Public Member Functions
	__construct ($value, $format)
	Constructor. More...
	get_format ()
	Get the description's format. More...
	get_value ()
	Get the description's text. More...

Protected Attributes
int	$format
	$format The description's format.
string	$value
	$value The description's text.

Detailed Description

Class representing a description value object.

Copyright

2017 Cameron Ball camer.nosp@m.on@c.nosp@m.amero.nosp@m.n172.nosp@m.9.xyz

License

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

Constructor & Destructor Documentation

__construct()

core_calendar\local\event\value_objects\event_description::__construct	(		$value,
			$format
	)

Constructor.

Parameters

string	$value	The description's value.
int	$format	The description's format.

Member Function Documentation

get_format()

core_calendar\local\event\value_objects\event_description::get_format

(

)

Get the description's format.

Return values

int	The description's format.

Implements core_calendar\local\event\value_objects\description_interface.

get_value()

core_calendar\local\event\value_objects\event_description::get_value

(

)

Get the description's text.

Return values

string

The description's text.

Implements core_calendar\local\event\value_objects\description_interface.

---

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

• calendar/classes/local/event/value_objects/event_description.php