Class mr_html_heading

Description

MR HTML Heading

Simple renderable object for headings. Can include help text and icon as well.

  • author: Mark Nielsen

Located in /html/heading.php (line 36)


	
			
Variable Summary
string $classes
string $component
string|moodle_url $icon
string $iconalt
string $id
int $level
string $text
Method Summary
mr_html_heading __construct (string $component)
void set (string $identifier, [string $helpidentifier = ''], [string $a = NULL])
Variables
string $classes = 'main' (line 56)

Heading classes

  • access: public
string $component (line 84)

Get string component

  • access: public
string|moodle_url $icon = '' (line 70)

Header icon

  • access: public
string $iconalt = '' (line 77)

Header icon alt text

  • access: public
string $id = NULL (line 63)

Heading ID

  • access: public
int $level = 2 (line 49)

Size of heading

  • access: public
string $text = '' (line 42)

Heading display text

  • access: public
Methods
Constructor __construct (line 91)

Constructor

  • access: public
mr_html_heading __construct (string $component)
  • string $component: Get string component
set (line 103)

Set heading

  • access: public
void set (string $identifier, [string $helpidentifier = ''], [string $a = NULL])
  • string $identifier: String key to pass to get_string()
  • string $helpidentifier: Help button identifier. If you define "{$identifier}_help" then this will automatically be set for you.
  • string $a: Additional variables to pass to get_string()

Documentation generated on Thu, 28 Jun 2012 16:33:48 -0700 by phpDocumentor 1.4.3