user_enrolment_action Class Reference

User enrolment action. More...

Inheritance diagram for user_enrolment_action:

Public Member Functions
	__construct (pix_icon $icon, $title, $url, array $attributes=null)
	Constructor.
	get_attributes ()
	Returns the attributes to use for this action.
	get_icon ()
	Returns the icon for this action.
	get_title ()
	Returns the title for this action.
	get_url ()
	Returns the URL for this action.

Protected Attributes
array	$attributes = array()
	An array of HTML attributes.
pix_icon	$icon
	The icon to display for the action.
string	$title
	The title for the action.
moodle_url	$url
	The URL to the action.

Detailed Description

User enrolment action.

This class is used to manage a renderable ue action such as editing an user enrolment or deleting a user enrolment.

Copyright

2011 Sam Hemelryk

License

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

Constructor & Destructor Documentation

__construct()

user_enrolment_action::__construct	(	pix_icon	$icon,
			$title,
			$url,
		array	$attributes = null
	)

Constructor.

Parameters

pix_icon	$icon
string	$title
moodle_url	$url
array	$attributes

Member Function Documentation

get_attributes()

user_enrolment_action::get_attributes

(

)

Returns the attributes to use for this action.

Return values

array

get_icon()

user_enrolment_action::get_icon

(

)

Returns the icon for this action.

Return values

pix_icon

get_title()

user_enrolment_action::get_title

(

)

Returns the title for this action.

Return values

string

get_url()

user_enrolment_action::get_url

(

)

Returns the URL for this action.

Return values

moodle_url

Member Data Documentation

$attributes

array user_enrolment_action::$attributes = array()

protected

An array of HTML attributes.

$icon

pix_icon user_enrolment_action::$icon

protected

The icon to display for the action.

$title

string user_enrolment_action::$title

protected

The title for the action.

$url

moodle_url user_enrolment_action::$url

protected

The URL to the action.

---

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

• mnet/service/enrol/locallib.php