action_menu_link Class Reference

An action menu action. More...

Inheritance diagram for action_menu_link:

Public Member Functions
	__construct (moodle_url $url, ?pix_icon $icon, $text, $primary=true, array $attributes=array())
	Constructs the object.
	add_action (component_action $action)
	Add action to the link.
	add_class ($class)
	Adds a CSS class to this action link object.
	export_for_template (renderer_base $output)
	Export for template.
	get_icon_html ()
	Return the rendered HTML for the icon.
	has_class ($class)
	Returns true if the specified class has been added to this link.

Public Attributes
action_menu	$actionmenu = null
	The action menu this link has been added to.
array	$actions
	List of actions attached to link.
array	$attributes
	HTML attributes.
pix_icon	$icon
	Optional pix icon to render with the link.
bool	$primary = true
	True if this is a primary action.
string	$text
	Link text HTML fragment.
moodle_url	$url
	Href url.

Static Protected Attributes
static int	$instance = 1
	The number of instances of this action menu link (and its subclasses).

Detailed Description

An action menu action.

Copyright

2013 Sam Hemelryk

License

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

Constructor & Destructor Documentation

__construct()

action_menu_link::__construct	(	moodle_url	$url,
		?pix_icon	$icon,
			$text,
			$primary = true,
		array	$attributes = array() )

Constructs the object.

Parameters

moodle_url	$url	The URL for the action.
pix_icon | null	$icon	The icon to represent the action.
string	$text	The text to represent the action.
bool	$primary	Whether this is a primary action or not.
array	$attributes	Any attribtues associated with the action.

Member Function Documentation

add_action()

action_link::add_action ( component_action $action )

inherited

Add action to the link.

Parameters

component_action

$action

add_class()

action_link::add_class ( $class )

inherited

Adds a CSS class to this action link object.

Parameters

string

$class

export_for_template()

action_menu_link::export_for_template

(

renderer_base

$output

)

Export for template.

Parameters

renderer_base

$output

The renderer.

Return values

stdClass

Reimplemented from action_link.

get_icon_html()

action_link::get_icon_html ( )

inherited

Return the rendered HTML for the icon.

Useful for rendering action links in a template.

Return values

string

has_class()

action_link::has_class ( $class )

inherited

Returns true if the specified class has been added to this link.

Parameters

string

$class

Return values

bool

Member Data Documentation

$primary

bool action_menu_link::$primary = true

True if this is a primary action.

False if not.

---

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

• lib/outputcomponents.php