core_calendar\local\event\entities\action_interface Interface Reference

Interface for a action class. More...

Inheritance diagram for core_calendar\local\event\entities\action_interface:

Public Member Functions
	get_item_count ()
	Get the number of items that need actioning.
	get_name ()
	Get the name of the action.
	get_url ()
	Get the URL of the action.
	is_actionable ()
	Get the actions actionability.

Detailed Description

Interface for a action class.

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

Member Function Documentation

get_item_count()

core_calendar\local\event\entities\action_interface::get_item_count

(

)

Get the number of items that need actioning.

Return values

int

Implemented in core_calendar\local\event\value_objects\action.

get_name()

core_calendar\local\event\entities\action_interface::get_name

(

)

Get the name of the action.

Return values

string

Implemented in core_calendar\local\event\value_objects\action.

get_url()

core_calendar\local\event\entities\action_interface::get_url

(

)

Get the URL of the action.

Return values

moodle_url

Implemented in core_calendar\local\event\value_objects\action.

is_actionable()

core_calendar\local\event\entities\action_interface::is_actionable

(

)

Get the actions actionability.

Return values

bool

Implemented in core_calendar\local\event\value_objects\action.

---

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

• calendar/classes/local/event/entities/action_interface.php