Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
action_link Class Reference
Inheritance diagram for action_link:
renderable action_menu_filler action_menu_link action_menu_link_primary action_menu_link_secondary

Public Member Functions

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

Public Attributes

array $actions
 List of actions attached to link.
 
array $attributes
 HTML attributes.
 
pix_icon $icon
 Optional pix icon to render with the link.
 
string $text
 Link text HTML fragment.
 
moodle_url $url
 Href url.
 

Constructor & Destructor Documentation

◆ __construct()

action_link::__construct ( moodle_url  $url,
  $text,
component_action  $action = null,
array  $attributes = null,
pix_icon  $icon = null 
)

Constructor.

Parameters
moodle_url$url
string$textHTML fragment
component_action$action
array$attributesassociative array of html link attributes + disabled
pix_icon$iconoptional pix_icon to render with the link text

Member Function Documentation

◆ add_action()

action_link::add_action ( component_action  $action)

Add action to the link.

Parameters
component_action$action

◆ add_class()

action_link::add_class (   $class)

Adds a CSS class to this action link object.

Parameters
string$class

◆ export_for_template()

action_link::export_for_template ( renderer_base  $output)

Export for template.

Parameters
renderer_base$outputThe renderer.
Return values
stdClass

Reimplemented in action_menu_link.

◆ get_icon_html()

action_link::get_icon_html ( )

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)

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

Parameters
string$class
Return values
bool

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