tangra logo
   
[ class tree: tangra_lib ] [ index: tangra_lib ] [ all elements ]
 

Class: Form_Field_Checkbox

Source Location: /form/fields/checkbox/form_field_checkbox.class.php

Class Form_Field_Checkbox

Class Overview
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail

Represents HTML checkbox

Located in /form/fields/checkbox/form_field_checkbox.class.php [line 24] 

Tangra_Class
   |
   --Form_Field
      |
      --Form_Field_Checkbox

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Properties | Method Summary | Methods Detail
Inherited Properties Inherited Methods Inherited Constants

Inherited From Form_Field

Form_Field::$current_errors
Form_Field::$default_value
Form_Field::$html_value
Form_Field::$name
Form_Field::$potential_errors
Form_Field::$required
Form_Field::$type
Form_Field::$value

Inherited From Form_Field

Form_Field::__construct()
Constructor
Form_Field::accept_submit()
Accepts submit data
Form_Field::add_potential_error()
Adds potential error for the field
Form_Field::basic_check()
Performs basic check for validity
Form_Field::capture_submit()
Captures submit
Form_Field::clear_errors()
Clear current errors
Form_Field::get_default_value()
Returns default value
Form_Field::get_errors()
Return field's current errors
Form_Field::get_html_value()
Returns html_value
Form_Field::get_name()
Returns field name
Form_Field::get_potential_error()
Nonsense function. Candidate for removal
Form_Field::get_properties_array()
Returns array with field properties
Form_Field::get_required()
Returns if the field is required
Form_Field::get_type()
Returns type of the field (class name)
Form_Field::get_value()
Returns field's value
Form_Field::is_field_in_error()
Checks if field is in error
Form_Field::set_default_value()
Sets default value
Form_Field::set_error()
Sets field current error
Form_Field::set_html_value()
Sets html_value
Form_Field::set_name()
Sets field's name
Form_Field::set_required()
Sets will the field be required
Form_Field::set_to_default()
Set field's value to default value
Form_Field::set_value()
Sets field's value
Form_Field::translate_value_html2app()
Transfers data from html_value to value

Inherited From Tangra_Class

Tangra_Class::get_class_name()
Alias of get_class(). Exist because of historical reasons.
Tangra_Class::__set()
Overides PHP built-in method and just throws exception if called. Purpose - to "forbid" autosetting of nonexisting class properties.

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Properties | Method Summary | Methods Detail
Form_Field_Checkbox   __construct()   Constructor
void   accept_submit()   Accepts submit
void   capture_submit()   Captures submit
array   get_properties_array()   Returns array with field properties
void   set_value()   Sets fields value
void   translate_value_html2app()   Transfers data from html_value to value

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Methods
Class Overview | Inherited Properties and Methods | Properties | Method Summary | Methods Detail
Constructor __construct  [line 32]

  Form_Field_Checkbox __construct( string $name, [boolean $required = false], [boolean $value = false]  )

Constructor

Parameters:
string   $name:  Name of the field
boolean   $required:  Is field required?
boolean   $value:  Default value

Redefinition of:
Form_Field::__construct()
Constructor

[ Top ]
accept_submit  [line 71]

  void accept_submit( )

Accepts submit


API Tags:
Internal:  
Access:  public

Redefinition of:
Form_Field::accept_submit()
Accepts submit data

[ Top ]
capture_submit  [line 58]

  void capture_submit( form_name $form_name, &$submit_array, array $submit_array  )

Captures submit

Parameters:
form_name   $form_name: 
array   $submit_array: 
   &$submit_array: 

API Tags:
Internal:  
Access:  public

Redefinition of:
Form_Field::capture_submit()
Captures submit

[ Top ]
get_properties_array  [line 82]

  array get_properties_array( )

Returns array with field properties


API Tags:
Internal:  
Access:  public

Redefinition of:
Form_Field::get_properties_array()
Returns array with field properties

[ Top ]
set_value  [line 42]

  void set_value( boolean $value  )

Sets fields value

Parameters:
boolean   $value: 

API Tags:
Access:  public

Redefinition of:
Form_Field::set_value()
Sets field's value

[ Top ]
translate_value_html2app  [line 94]

  void translate_value_html2app( )

Transfers data from html_value to value


API Tags:
Internal:  
Access:  protected

Redefinition of:
Form_Field::translate_value_html2app()
Transfers data from html_value to value

[ Top ]