PHP Class Redaxscript\Html\Form

Since: 2.6.0
Author: Henry Ruhs
Inheritance: extends HtmlAbstract
Datei anzeigen Open project: redaxmedia/redaxscript Class Usage Examples

Protected Properties

Property Type Description
$_attributeArray array attributes of the form
$_captcha object captcha of the form
$_language object instance of the language class
$_languageArray array languages of the form
$_optionArray array options of the form
$_registry object instance of the registry class

Public Methods

Method Description
__call ( string $method = null, array $argumentArray = [] ) : Form call method as needed
__construct ( Registry $registry, Language $language ) constructor of the class
__toString ( ) : string stringify the form
captcha ( string $type = null ) : Form append the captcha
init ( array $attributeArray = [], array $optionArray = [] ) : Form init the class
label ( string $html = null, array $attributeArray = [] ) : Form append the label
legend ( string $html = null, array $attributeArray = [] ) : Form append the legend
render ( ) : string render the form
select ( array $optionArray = [], array $attributeArray = [] ) : Form append the select
selectRange ( array $rangeArray = [], array $attributeArray = [] ) : Form append the select range
textarea ( array $attributeArray = [] ) : Form append the textarea
token ( ) : Form append the token

Protected Methods

Method Description
_createButton ( string $type = null, string $text = null, array $attributeArray = [] ) : Form create the button
_createInput ( string $type = 'text', array $attributeArray = [] ) : Form create the input
_createLink ( string $type = null, string $text = null, array $attributeArray = [] ) : Form create the link
_createOption ( array $optionArray = [], mixed $selected = null ) : string create the option

Method Details

__call() public method

call method as needed
Since: 2.6.0
public __call ( string $method = null, array $argumentArray = [] ) : Form
$method string name of the method
$argumentArray array arguments of the method
return Form

__construct() public method

constructor of the class
Since: 2.6.0
public __construct ( Registry $registry, Language $language )
$registry Redaxscript\Registry instance of the registry class
$language Redaxscript\Language instance of the language class

__toString() public method

stringify the form
Since: 2.6.0
public __toString ( ) : string
return string

_createButton() protected method

create the button
Since: 2.6.0
protected _createButton ( string $type = null, string $text = null, array $attributeArray = [] ) : Form
$type string type of the button
$text string text of the button
$attributeArray array attributes of the button
return Form

_createInput() protected method

create the input
Since: 2.6.0
protected _createInput ( string $type = 'text', array $attributeArray = [] ) : Form
$type string type of the input
$attributeArray array attributes of the input
return Form

_createOption() protected method

create the option
Since: 3.0.0
protected _createOption ( array $optionArray = [], mixed $selected = null ) : string
$optionArray array options of the select
$selected mixed option to be selected
return string

captcha() public method

append the captcha
Since: 2.6.0
public captcha ( string $type = null ) : Form
$type string type of the captcha
return Form

init() public method

init the class
Since: 2.6.0
public init ( array $attributeArray = [], array $optionArray = [] ) : Form
$attributeArray array attributes of the form
$optionArray array options of the form
return Form

label() public method

append the label
Since: 3.0.0
public label ( string $html = null, array $attributeArray = [] ) : Form
$html string html of the label
$attributeArray array attributes of the label
return Form

legend() public method

append the legend
Since: 3.0.0
public legend ( string $html = null, array $attributeArray = [] ) : Form
$html string html of the legend
$attributeArray array attributes of the legend
return Form

render() public method

render the form
Since: 2.6.0
public render ( ) : string
return string

select() public method

append the select
Since: 2.6.0
public select ( array $optionArray = [], array $attributeArray = [] ) : Form
$optionArray array options of the select
$attributeArray array attributes of the select
return Form

selectRange() public method

append the select range
Since: 3.0.0
public selectRange ( array $rangeArray = [], array $attributeArray = [] ) : Form
$rangeArray array range of the select
$attributeArray array attributes of the select
return Form

textarea() public method

append the textarea
Since: 2.6.0
public textarea ( array $attributeArray = [] ) : Form
$attributeArray array attributes of the textarea
return Form

token() public method

append the token
Since: 2.6.0
public token ( ) : Form
return Form

Property Details

$_attributeArray protected_oe property

attributes of the form
protected array $_attributeArray
return array

$_captcha protected_oe property

captcha of the form
protected object $_captcha
return object

$_language protected_oe property

instance of the language class
protected object $_language
return object

$_languageArray protected_oe property

languages of the form
protected array $_languageArray
return array

$_optionArray protected_oe property

options of the form
protected array $_optionArray
return array

$_registry protected_oe property

instance of the registry class
protected object $_registry
return object