core_calendar\local\event\value_objects\action Class Reference

Class representing an action a user should take. More...

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

Public Member Functions
	__construct ( $name, moodle_url $url, $itemcount, $actionable)
	Constructor. More...
	get_item_count ()
	Get the number of items that need actioning. More...
	get_name ()
	Get the name of the action. More...
	get_url ()
	Get the URL of the action. More...
	is_actionable ()
	Get the actions actionability. More...

Protected Attributes
bool	$actionable
	$actionable Whether or not the event is currently actionable.
int	$itemcount
	$itemcount How many items there are to action.
string	$name
	$name The action's name.
moodle_url	$url
	$url The action's URL.

Detailed Description

Class representing an action a user should take.

Copyright

2017 Ryan Wyllie ryan@.nosp@m.mood.nosp@m.le.co.nosp@m.m

License

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

Constructor & Destructor Documentation

__construct()

core_calendar\local\event\value_objects\action::__construct	(		$name,
		moodle_url	$url,
			$itemcount,
			$actionable
	)

Constructor.

Parameters

string	$name	The action's name.
moodle_url	$url	The action's URL.
int	$itemcount	How many items there are to action.
bool	$actionable	Whether or not the event is currently actionable.

Member Function Documentation

get_item_count()

core_calendar\local\event\value_objects\action::get_item_count

(

)

Get the number of items that need actioning.

Return values

int

Implements core_calendar\local\event\entities\action_interface.

get_name()

core_calendar\local\event\value_objects\action::get_name

(

)

Get the name of the action.

Return values

string

Implements core_calendar\local\event\entities\action_interface.

get_url()

core_calendar\local\event\value_objects\action::get_url

(

)

Get the URL of the action.

Return values

moodle_url

Implements core_calendar\local\event\entities\action_interface.

is_actionable()

core_calendar\local\event\value_objects\action::is_actionable

(

)

Get the actions actionability.

Return values

bool

Implements core_calendar\local\event\entities\action_interface.

---

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

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