Package: Controls

Class: Zebra_Form_Note

source file: /includes/Note.php

Class Overview

XSS_Clean
|
--Zebra_Form_Control
|
--Zebra_Form_Note

Class for notes attached to controls

Author(s):

Copyright:

  • (c) 2006 - 2013 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::get_submitted_value()
Returns the control's value after the form is submitted.
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 $attach_to , string $caption , [ array $attributes = ''] )

Adds a "note" to the form, attached to a control.

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 text control to the form
  5. $obj = $form->add('text', 'my_text');
  6.  
  7. // attach a note to the textbox control
  8. $form->add('note', 'note_my_text', 'my_text', 'Enter some text in the field above');
  9.  
  10. // don't forget to always call this method before rendering the form
  11. if ($form->validate()) {
  12.     // put code here
  13. }
  14.  
  15. // output the form using an automatically generated template
  16. $form->render();
Parameters:
string $id

Unique name to identify the control in the form.

This is the name of the variable to be used in the template file, containing the generated HTML for the control.

  1. // in a template file, in order to print the generated HTML
  2. // for a control named "my_note", one would use:
  3. echo $my_note;
string $attach_to

The id attribute of the control to attach the note to.

Notice that this must be the "id" attribute of the control you are attaching the label to, and not the "name" attribute!

This is important as while most of the controls have their id attribute set to the same value as their name attribute, for checkboxes, selects and radio buttons this is different.

Exception to the rule:

Just like in the case of labels, if you want a master note, a note that is attached to a group of checkboxes/radio buttons rather than individual controls, this attribute must instead refer to the name of the controls (which, for groups of checkboxes/radio buttons, is one and the same).
string $caption Content of the note (can be both plain text and/or HTML)
array $attributes

(Optional) An array of attributes valid for div elements (style, etc)

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

  1. // setting the "style" attribute
  2. $obj = $form->add(
  3.     'note',
  4.     'note_my_text',
  5.     'my_text',
  6.     array(
  7.         'style' => 'width:250px'
  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:
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