tangra_lib

Packages:

tangra_lib

Interfaces:

interfaces
I_DB_Config
I_DB_Recordset
I_DB_Storable
I_Dynamic_Viewable
I_Exception_Listener
I_Runnable_By_Site
I_Static_Viewable
I_Tple
I_Tple_Advanced

Classes:

core
Config_Loader
Config_Loader_File
Context
Event
Exception_Handler
Modules_Register
Tangra_Class
Tangra_Form_Submit_Method
Tangra_Parameter_Method
Tangra_Simple_Tple
Vars_Manager

db
DB_Config
DB_Config_Loader_File
DB_Connection
DB_Recordset
Paginate_DB_Data

form
Form
Form_Ctrl
Form_Field
Form_Field_Checkbox
Form_Field_Checkbox_View
Form_Field_Date
Form_Field_Date_Triad
Form_Field_Date_Triad_View
Form_Field_Date_View
Form_Field_Email
Form_Field_Email_View
Form_Field_File
Form_Field_File_View
Form_Field_Hidden
Form_Field_Hidden_View
Form_Field_Integer
Form_Field_Integer_Limited
Form_Field_Integer_Limited_View
Form_Field_Integer_Positive
Form_Field_Integer_Positive_View
Form_Field_Integer_View
Form_Field_Money
Form_Field_Money_Positive
Form_Field_Money_Positive_View
Form_Field_Money_View
Form_Field_Number
Form_Field_Number_Fixed
Form_Field_Number_Fixed_View
Form_Field_Number_NLS
Form_Field_Number_NLS_View
Form_Field_Number_View
Form_Field_Password
Form_Field_Password_View
Form_Field_Radio_Group
Form_Field_Radio_Group_Semidynamic_View
Form_Field_Radio_Group_View
Form_Field_Select
Form_Field_Select_Multiple
Form_Field_Select_Multiple_View
Form_Field_Select_Semidynamic_View
Form_Field_Select_View
Form_Field_Text
Form_Field_Textarea
Form_Field_Textarea_View
Form_Field_Text_View
Form_Field_View
Form_Guard
Form_View
GForm_Ctrl
GForm_Ctrl_With_Object
GForm_Ctrl_With_Object_EP
Guardable_Form
Guardable_Form_View
Static_HTML_Form_Generator

grids
Grid
Grid_Ctrl
Paginated_Grid
SP_Grid_WLC
Static_Grid
Static_Paginated_Grid

web_site
Just_Headers_View
Redirect_Composer
Redirect_Composer_Local
Session_Vars_Manager
Threads_Manager
Thread_Vars_Manager
Tple_Exports
Web_Context
Web_Event
Web_Event_Composite
Web_Event_Dispatcher
Web_Event_Simple
Web_Event_Simple_Int
Web_Page
Web_Page_View
Web_Site
Web_Site_Config
Web_Site_Config_Loader
Web_Site_Config_Loader_File

filesystem_toolbox
Tangra_File

modules_manager
Tangra_Module_Info
Tangra_Module_Info_Loader
Tangra_Module_Info_Loader_File
Tangra_Module_Info_Parser
Tangra_Module_Installer
Tangra_Module_Installer_Run

Files:

tangra2.inc.php

core
config_loader.class.php
config_loader_file.class.php
context.class.php
debug.inc.php
event.class.php
exception_handler.class.php
misc_functions.inc.php
modules_register.class.php
rc_d.inc.php
tangra_class.class.php
tangra_form_submit_method.class.php
tangra_parameter_method.class.php
tangra_simple_tple.class.php
vars_manager.class.php

db
db_config.class.php
db_config_loader_file.class.php
db_connection.class.php
db_recordset.class.php
paginate_db_data.class.php

filesystem_toolbox
filesystem_functions.inc.php
tangra_file.class.php

grids
grid.class.php
grid_ctrl.class.php
paginated_grid.class.php
sp_grid_wlc.class.php
static_grid.class.php
static_paginated_grid.class.php

interfaces
i_db_config.class.php
i_db_recordset.class.php
i_db_storable.class.php
i_dynamic_viewable.class.php
i_exception_listener.class.php
i_runnable_by_site.class.php
i_static_viewable.class.php
i_tple.class.php
i_tple_advanced.class.php

misc
inet_functions.inc.php

modules_manager
tangra_module_info.class.php
tangra_module_info_loader.class.php
tangra_module_info_loader_file.class.php
tangra_module_info_parser.class.php
tangra_module_installer.class.php
tangra_module_installer_run.class.php

nls
date.inc.php
number_functions.inc.php
string_functions.inc.php
string_functions_mb.inc.php
string_functions_sb.inc.php

web_site
just_headers_view.class.php
redirect_composer.class.php
redirect_composer_local.class.php
session_vars_manager.class.php
threads_manager.class.php
thread_vars_manager.class.php
tple_exports.class.php
web_context.class.php
web_event.class.php
web_events_dispatcher.class.php
web_event_composite.class.php
web_event_simple.class.php
web_event_simple_int.class.php
web_page.class.php
web_page_view.class.php
web_site.class.php
web_site_config.class.php
web_site_config_loader.class.php
web_site_config_loader_file.class.php

Class: Form_Field

Source Location: /form/fields/form_field.class.php

Class Form_Field

Class Overview

Represents abstract concept of HTML form field

Located in /form/fields/form_field.class.php [line 30]

Tangra_Class
   |
   --Form_Field

Author(s):

API Tags:

Abstract:

Properties

Methods

[ Top ]

Descendants

Child Class	Description
Form_Field_File	Represents HTML field type=file
Form_Field_Select	Represents select field
Form_Field_Text	Represents text field
Form_Field_Checkbox	Represents HTML checkbox
Form_Field_Hidden	Represents HTML field type="hiddne"
Form_Field_Date_Triad	Represents 3 HTML text fields.
Form_Field_Radio_Group	Represents group of radio buttons

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

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 ]

Property Summary

array	$current_errors	Array with current errors
mixed	$default_value	Default value
string	$html_value	HTML value of the field
string	$name	Name of the field
array	$potential_errors	Array with potential errors
boolean	$required	Is field required?
string	$type	Type of the field. Contains class name of the field object
mixed	$value	Value of the field

[ Top ]

Method Summary

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

[ Top ]

Properties

array $current_errors = array() [line 86]

Array with current errors

API Tags:

Internal:
Access:	private

[ Top ]

mixed $default_value [line 65]

Default value

API Tags:

Internal:
Access:	private

[ Top ]

string $html_value [line 58]

HTML value of the field

API Tags:

Internal:
Access:	private

[ Top ]

string $name [line 37]

Name of the field

API Tags:

Internal:
Access:	private

[ Top ]

array $potential_errors = array() [line 79]

Array with potential errors

API Tags:

Internal:
Access:	private

[ Top ]

boolean $required [line 44]

Is field required?

API Tags:

Internal:
Access:	private

[ Top ]

string $type [line 72]

Type of the field. Contains class name of the field object

API Tags:

Internal:
Access:	private

[ Top ]

mixed $value [line 51]

Value of the field

API Tags:

Internal:
Access:	private

[ Top ]

Methods

Constructor __construct [line 96]

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

Constructor

Parameters:

string	$name:	Name of the field
mixed	$value:	Default value.
boolean	$required:	Is field required. Default is false

Redefined in descendants as:

Form_Field_File::__construct() : Constructor
Form_Field_Select::__construct() : Constructor
Form_Field_Select_Multiple::__construct() : Enter description here...
Form_Field_Text::__construct() : Constructor
Form_Field_Money::__construct() : Enter description here...
Form_Field_Money_Positive::__construct() : Constructor
Form_Field_Email::__construct() : Constructor
Form_Field_Number::__construct() : Constructor
Form_Field_Integer::__construct() : Constructor
Form_Field_Integer_Positive::__construct() : Constructor
Form_Field_Integer_Limited::__construct() : Constructor
Form_Field_Number_Fixed::__construct() : Enter description here...
Form_Field_Password::__construct() : Constructor
Form_Field_Number_NLS::__construct() : Constructor
Form_Field_Date::__construct() : Constructor
Form_Field_Checkbox::__construct() : Constructor
Form_Field_Hidden::__construct() : Constructor
Form_Field_Date_Triad::__construct() : Constructor
Form_Field_Radio_Group::__construct() : Constructor

[ Top ]

accept_submit [line 250]

void accept_submit(
)

Accepts submit data

API Tags:

Internal:
Access:	public

Redefined in descendants as:

Form_Field_Checkbox::accept_submit() : Accepts submit

[ Top ]

add_potential_error [line 262]

void add_potential_error(
string
$error_name 
)

Adds potential error for the field

Parameters:

string

$error_name:

Name of the error

API Tags:

Access:

public

[ Top ]

basic_check [line 216]

boolean basic_check(
)

Performs basic check for validity

API Tags:

Internal:
Access:	public

Redefined in descendants as:

Form_Field_File::basic_check() : Performs basic check for validity
Form_Field_Select::basic_check() : Performs basic check for validity
Form_Field_Select_Multiple::basic_check() : Performs basic check for validity
Form_Field_Text::basic_check() : Performs basic check for validity
Form_Field_Money::basic_check() : Performs basic check for validity
Form_Field_Money_Positive::basic_check() : Performs basic check for validity
Form_Field_Email::basic_check() : Performs basic check for validity
Form_Field_Number::basic_check() : Performs basic check for validity
Form_Field_Integer::basic_check() : Performs basic check for validity
Form_Field_Integer_Positive::basic_check() : Performs basic check for validity
Form_Field_Integer_Limited::basic_check() : Performs basic check for validity
Form_Field_Number_Fixed::basic_check() : Performs basic check for validity
Form_Field_Password::basic_check() : Performs basic check for validity
Form_Field_Number_NLS::basic_check() : Performs basic check for validity
Form_Field_Date::basic_check() : Performs basic check for validity
Form_Field_Date_Triad::basic_check() : Performs basic check for validity
Form_Field_Radio_Group::basic_check() : Performs basic check for validity

[ Top ]

capture_submit [line 237]

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

Captures submit

Parameters:

string	$form_name:
array	$submit_array:
	&$submit_array:

API Tags:

Internal:
Access:	public

Redefined in descendants as:

Form_Field_File::capture_submit() : Captures submit
Form_Field_Select_Multiple::capture_submit() : Captures submit
Form_Field_Checkbox::capture_submit() : Captures submit
Form_Field_Date_Triad::capture_submit() : Captures submit

[ Top ]

clear_errors [line 343]

void clear_errors(
)

Clear current errors

API Tags:

Access:

public

[ Top ]

get_default_value [line 196]

mixed get_default_value(
)

Returns default value

API Tags:

Access:

public

[ Top ]

get_errors [line 334]

unknown get_errors(
)

Return field's current errors

API Tags:

Access:

public

[ Top ]

get_html_value [line 372]

mixed get_html_value(
)

Returns html_value

API Tags:

Access:

public

[ Top ]

get_name [line 127]

string get_name(
)

Returns field name

API Tags:

Access:

public

[ Top ]

get_potential_error [line 306]

string get_potential_error(
string
$error_name 
)

Nonsense function. Candidate for removal

Parameters:

string

$error_name:

API Tags:

Internal:
Access:	public

[ Top ]

get_properties_array [line 281]

array get_properties_array(
)

Returns array with field properties

API Tags:

Internal:
Access:	public

Redefined in descendants as:

Form_Field_File::get_properties_array() : Returns array with field properties
Form_Field_Select::get_properties_array() : Returns array with field properties
Form_Field_Text::get_properties_array() : Returns array with field properties
Form_Field_Integer_Positive::get_properties_array() : Returns array with field properties
Form_Field_Integer_Limited::get_properties_array() : Returns array with field properties
Form_Field_Date::get_properties_array() : Returns array with field properties
Form_Field_Checkbox::get_properties_array() : Returns array with field properties
Form_Field_Hidden::get_properties_array() : Returns array with field properties
Form_Field_Radio_Group::get_properties_array() : Returns array with field properties

[ Top ]

get_required [line 167]

unknown get_required(
)

Returns if the field is required

API Tags:

Access:

public

[ Top ]

get_type [line 176]

string get_type(
)

Returns type of the field (class name)

API Tags:

Access:

public

[ Top ]

get_value [line 147]

mixed get_value(
)

Returns field's value

API Tags:

Access:

public

[ Top ]

is_field_in_error [line 383]

boolean is_field_in_error(
)

Checks if field is in error

API Tags:

Internal:
Access:	protected

[ Top ]

set_default_value [line 186]

void set_default_value(
mixed
$default_value 
)

Sets default value

Parameters:

mixed

$default_value:

API Tags:

Access:

public

[ Top ]

set_error [line 324]

void set_error(
string
$potential_error_name 
)

Sets field current error

Parameters:

string

$potential_error_name:

Name of the error

API Tags:

Access:

public

[ Top ]

set_html_value [line 362]

void set_html_value(
mixed
$html_value 
)

Sets html_value

Parameters:

mixed

$html_value:

API Tags:

Access:

protected

[ Top ]

set_name [line 112]

void set_name(
string
$name 
)

Sets field's name

Parameters:

string

$name:

API Tags:

Access:

protected

[ Top ]

set_required [line 157]

void set_required(
boolean
$required 
)

Sets will the field be required

Parameters:

boolean

$required:

API Tags:

Access:

public

[ Top ]

set_to_default [line 205]

void set_to_default(
)

Set field's value to default value

API Tags:

Access:

public

[ Top ]

set_value [line 137]

void set_value(
mixed
$value 
)

Sets field's value

Parameters:

mixed

$value:

API Tags:

Access:

public

Redefined in descendants as:

Form_Field_Select::set_value() : Sets current value
Form_Field_Select_Multiple::set_value() : Sets which options are selected
Form_Field_Email::set_value() : Sets field value. Must be valid email address or empty (NULL/'')
Form_Field_Checkbox::set_value() : Sets fields value
Form_Field_Date_Triad::set_value() : Sets field value
Form_Field_Radio_Group::set_value() : Sets value

[ Top ]

translate_value_html2app [line 352]

void translate_value_html2app(
)

Transfers data from html_value to value

API Tags:

Internal:
Access:	protected

Redefined in descendants as:

Form_Field_Select::translate_value_html2app() : Transfers data from html_value to value
Form_Field_Select_Multiple::translate_value_html2app() : Transfers data from html_value to value
Form_Field_Money::translate_value_html2app() : Transfers data from html_value to value
Form_Field_Number_NLS::translate_value_html2app() : Transfers data from html_value to value
Form_Field_Checkbox::translate_value_html2app() : Transfers data from html_value to value
Form_Field_Radio_Group::translate_value_html2app() : Transfers data from html_value to value

[ Top ]