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

Class: Form_Field_File

Source Location: /form/fields/file/form_field_file.class.php

Class Form_Field_File

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

Represents HTML field type=file

Please note that this field will be represented by 2 form fields:

  • type="file" - for the file itself
  • type="hidden" - for the hidden field that holds Maximum file size

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

Tangra_Class
   |
   --Form_Field
      |
      --Form_Field_File

Properties

Methods
[ Top ]
Inherited Properties, Constants, and Methods
Class Overview | Inherited Properties, Constants, and Methods | Property Summary | Properties Detail | 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 ]
Property Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
integer   $max_file_size   Maximal file size

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Form_Field_File   __construct()   Constructor
boolean   basic_check()   Performs basic check for validity
void   capture_submit()   Captures submit
integer   get_max_file_size()   Returns masximum allowed file size
array   get_properties_array()   Returns array with field properties

[ Top ]
Properties
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
integer   $max_file_size [line 37]

Maximal file size

API Tags:
Internal:  
Access:  private


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

  Form_Field_File __construct( string $name, [boolean $required = false], integer $max_file_size  )

Constructor

Parameters:
string   $name:  Name of the field
boolean   $required:  Is field required. Default is false
integer   $max_file_size:  Maximal allowed file size. Please note that php.ini settings "upload_max_filesize" and "file_uploads" are also in effect.

Redefinition of:
Form_Field::__construct()
Constructor

[ Top ]
basic_check  [line 90]

  boolean basic_check( )

Performs basic check for validity


API Tags:
Internal:  
Access:  public

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

[ Top ]
capture_submit  [line 74]

  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

Redefinition of:
Form_Field::capture_submit()
Captures submit

[ Top ]
get_max_file_size  [line 62]

  integer get_max_file_size( )

Returns masximum allowed file size


API Tags:
Access:  public


[ Top ]
get_properties_array  [line 120]

  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 ]