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

Class: Form_Field_Select_Multiple

Source Location: /form/fields/select_multiple/form_field_select_multiple.class.php

Class Form_Field_Select_Multiple

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

Represents select field with multiple choice

Located in /form/fields/select_multiple/form_field_select_multiple.class.php [line 33] 

Tangra_Class
   |
   --Form_Field
      |
      --Form_Field_Select
         |
         --Form_Field_Select_Multiple

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_Select

Form_Field_Select::$empty_value
Form_Field_Select::$options

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_Select

Form_Field_Select::__construct()
Constructor
Form_Field_Select::add_option()
Adds new option
Form_Field_Select::basic_check()
Performs basic check for validity
Form_Field_Select::get_empty_value()
Returns empty value
Form_Field_Select::get_options()
Returns all options as array
Form_Field_Select::get_properties_array()
Returns array with field properties
Form_Field_Select::is_unique_value()
Checks if there is option with same value
Form_Field_Select::set_empty_value()
Sets empty value
Form_Field_Select::set_options()
Sets all options at once using array
Form_Field_Select::set_option_selected()
marks option as selected
Form_Field_Select::set_value()
Sets current value
Form_Field_Select::translate_value_html2app()
Transfers data from html_value to value
Form_Field_Select::_set_value()
Sets current 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_Select_Multiple   __construct()   Enter description here...
boolean   basic_check()   Performs basic check for validity
void   capture_submit()   Captures submit
void   deselect_all_options()   Deselects all options
void   deselect_option()   Marks options as not selected
integer   find_option_by_html_value()   Returns option value for option with html_value = $html_value
void   select_option()   Marks option as selected
void   set_value()   Sets which options are selected
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 41]

  Form_Field_Select_Multiple __construct( string $name, [integer $value = NULL], [boolean $required = false]  )

Enter description here...

Parameters:
string   $name:  Name of the field
integer   $value:  Array containing option values to be selected
boolean   $required:  Is field required. Default is false

Redefinition of:
Form_Field_Select::__construct()
Constructor

[ Top ]
basic_check  [line 140]

  boolean basic_check( )

Performs basic check for validity


API Tags:
Internal:  
Access:  public

Redefinition of:
Form_Field_Select::basic_check()
Performs basic check for validity

[ Top ]
capture_submit  [line 125]

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

Captures submit

Parameters:
unknown_type   $form_name: 
unknown_type   $submit_array: 
   &$submit_array: 

API Tags:
Internal:  
Access:  public

Redefinition of:
Form_Field::capture_submit()
Captures submit

[ Top ]
deselect_all_options  [line 181]

  void deselect_all_options( )

Deselects all options


API Tags:
Internal:  
Access:  private


[ Top ]
deselect_option  [line 101]

  void deselect_option( unknown_type $value  )

Marks options as not selected

Parameters:
unknown_type   $value:  Value of the option

API Tags:
Access:  public

Information Tags:
Throws:  TE_Select_Multiple_Option_Not_Exists

[ Top ]
find_option_by_html_value  [line 194]

  integer find_option_by_html_value( integer $html_value  )

Returns option value for option with html_value = $html_value

Parameters:
integer   $html_value: 

API Tags:
Access:  private


[ Top ]
select_option  [line 78]

  void select_option( integer $value  )

Marks option as selected

Parameters:
integer   $value:  Value of the option

API Tags:
Access:  public

Information Tags:
Throws:  TE_Select_Multiple_Option_Not_Exists

[ Top ]
set_value  [line 52]

  void set_value( array $value  )

Sets which options are selected

Parameters:
array   $value:  Array that contains values of options to be selected

API Tags:
Access:  public

Information Tags:
Throws:  TE_Select_Multiple_Value_Not_An_Array
Redefinition of:
Form_Field_Select::set_value()
Sets current value

[ Top ]
translate_value_html2app  [line 158]

  void translate_value_html2app( )

Transfers data from html_value to value


API Tags:
Internal:  
Access:  public

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

[ Top ]