Public Member Functions | Static Public Member Functions | Public Attributes

FormControlStatic Class Reference

Inheritance diagram for FormControlStatic:
Collaboration diagram for FormControlStatic:

List of all members.

Public Member Functions

 set_static ($static)
 get (Theme $theme)

Static Public Member Functions

static create ($name, $storage= 'null:null', array $properties=array(), array $settings=array())

Public Attributes

 $static = ''

Detailed Description

A text control based on FormControl for output via a FormUI.

Definition at line 8 of file formcontrolstatic.php.


Member Function Documentation

static FormControlStatic::create ( name,
storage = 'null:null',
array $  properties = array(),
array $  settings = array() 
) [static]

Create a new instance of FormControlStatic and return it, use the fluent interface

Parameters:
string $name The name of the control
FormStorage|string|null $storage A storage location for the data collected by the control
array $properties An array of properties that apply to the output HTML
array $settings An array of settings that apply to this control object
Returns:
FormControlStatic An instance of the referenced FormControl with the supplied parameters

Reimplemented from FormControl.

Definition at line 22 of file formcontrolstatic.php.

Referenced by AdminUsersHandler::__construct(), Menus::action_admin_theme_get_menus(), Charcoal::action_theme_ui(), Menus::filter_menu_type_data(), AdminCommentsHandler::form_comment(), and UserHandler::login_form().

FormControlStatic::get ( Theme theme  ) 

Produce HTML output for this static text control.

Parameters:
Theme $theme The theme used to render this control
Returns:
string HTML that will render this control in the form

Reimplemented from FormControl.

Definition at line 44 of file formcontrolstatic.php.

FormControlStatic::set_static ( static  ) 

Set the static content of this control

Parameters:
string $static The static content of this control
Returns:
FormControlStatic $this

Definition at line 32 of file formcontrolstatic.php.


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