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

Class: Form_Field_Integer_Positive

Source Location: /form/fields/integer_positive/form_field_integer_positive.class.php

Class Form_Field_Integer_Positive

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

Represents text field that accepts positive integer value

Located in /form/fields/integer_positive/form_field_integer_positive.class.php [line 27] 

Tangra_Class
   |
   --Form_Field
      |
      --Form_Field_Text
         |
         --Form_Field_Number
            |
            --Form_Field_Integer
               |
               --Form_Field_Integer_Positive

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_Text

Form_Field_Text::$maxlength

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_Integer

Form_Field_Integer::__construct()
Constructor
Form_Field_Integer::basic_check()
Performs basic check for validity

Inherited From Form_Field_Number

Form_Field_Number::__construct()
Constructor
Form_Field_Number::basic_check()
Performs basic check for validity

Inherited From Form_Field_Text

Form_Field_Text::__construct()
Constructor
Form_Field_Text::basic_check()
Performs basic check for validity
Form_Field_Text::get_maxlength()
Returns maximum characters accepted by the field
Form_Field_Text::get_properties_array()
Returns array with field properties
Form_Field_Text::set_maxlength()
Sets amximum characters accepted by the field

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
boolean   $accept_zero   Will accept zero

[ Top ]
Method Summary
Class Overview | Inherited Properties and Methods | Property Summary | Properties Detail | Method Summary | Methods Detail
Form_Field_Integer_Positive   __construct()   Constructor
boolean   basic_check()   Performs basic check for validity
unknown   get_accept_zero()   Returns true if accepts zero as valid value
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
boolean   $accept_zero [line 34]

Will accept zero

API Tags:
Internal:  
Access:  private


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

  Form_Field_Integer_Positive __construct( string $name, [boolean $accept_zero = false], [boolean $required = false], [integer $maxlength = 100], [integer $value = NULL]  )

Constructor

Parameters:
string   $name:  Name of the field
boolean   $accept_zero:  Will object zero as valid value?
boolean   $required:  Is field required. Default is false
integer   $maxlength:  Maximum length of the text. Default is 100
integer   $value:  Default value.

Redefinition of:
Form_Field_Integer::__construct()
Constructor

[ Top ]
basic_check  [line 69]

  boolean basic_check( )

Performs basic check for validity


API Tags:
Internal:  
Access:  public

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

[ Top ]
get_accept_zero  [line 58]

  unknown get_accept_zero( )

Returns true if accepts zero as valid value


API Tags:
Access:  public


[ Top ]
get_properties_array  [line 98]

  array get_properties_array( )

Returns array with field properties


API Tags:
Internal:  
Access:  public

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

[ Top ]