Package: Controls

Class: Zebra_Form_Textarea

source file: /includes/Textarea.php

Class Overview

XSS_Clean
|
--Zebra_Form_Control
|
--Zebra_Form_Textarea

Class for textarea controls

Author(s):

Copyright:

  • (c) 2006 - 2016 Stefan Gabos

Methods

Inherited properties

Class: Zebra_Form_Control

Zebra_Form_Control::$attributes
Zebra_Form_Control::$private_attributes
Zebra_Form_Control::$rules

Inherited methods

Class: Zebra_Form_Control

Zebra_Form_Control::change_case()
Call this method to instruct the script to force all letters typed by the user, to either uppercase or lowercase, in real-time.
Zebra_Form_Control::disable_spam_filter()
Disables the SPAM filter for the control.
Zebra_Form_Control::disable_xss_filters()
Disables XSS filtering of the control's submitted value.
Zebra_Form_Control::get_attributes()
Returns the values of requested attributes.
Zebra_Form_Control::lock()
Locks the control's value. A locked control will preserve its default value after the form is submitted even if the user altered it.
Zebra_Form_Control::reset()
Resets the control's submitted value (empties text fields, unchecks radio buttons/checkboxes, etc).
Zebra_Form_Control::set_attributes()
Sets one or more of the control's attributes.
Zebra_Form_Control::set_rule()
Sets a single or an array of validation rules for the control.
Zebra_Form_Control::_render_attributes()
Converts the array with control's attributes to valid HTML markup interpreted by the toHTML() method

Class: XSS_Clean

XSS_Clean::sanitize()
Sanitizes submitted data so that Cross Site Scripting Hacks can be prevented.

Class methods

constructor __construct()

void __construct ( string $id , [ string $default = ''] , [ array $attributes = ''] )

Adds an <textarea> control to the form.

Do not instantiate this class directly! Use the add() method instead!

  1. // create a new form
  2. $form = new Zebra_Form('my_form');
  3.  
  4. // add a textarea control to the form
  5. $obj = $form->add('textarea', 'my_textarea');
  6.  
  7. // don't forget to always call this method before rendering the form
  8. if ($form->validate()) {
  9.     // put code here
  10. }
  11.  
  12. // output the form using an automatically generated template
  13. $form->render();
Parameters:
string $id

Unique name to identify the control in the form.

The control's name attribute will be the same as the id attribute!

This is the name to be used when referring to the control's value in the POST/GET superglobals, after the form is submitted.

This is also the name of the variable to be used in custom template files, in order to display the control.

  1. // in a template file, in order to print the generated HTML
  2. // for a control named "my_textarea", one would use:
  3. echo $my_textarea;
string $default (Optional) Default value of the textarea.
array $attributes

(Optional) An array of attributes valid for textarea controls (rows, cols, style, etc)

Must be specified as an associative array, in the form of attribute => value.

  1. // setting the "rows" attribute
  2. $obj = $form->add(
  3.     'textarea',
  4.     'my_textarea',
  5.     '',
  6.     array(
  7.         'rows' => 10
  8.     )
  9. );

See set_attributes() on how to set attributes, other than through the constructor.

The following attributes are automatically set when the control is created and should not be altered manually:

id, name, class
Top

method toHTML()

string toHTML ( )

Generates the control's HTML code.

This method is automatically called by the render() method!

Tags:
return: The control's HTML code
Top