Docs For Class input

Description

Base input element class - for forms, cookies, and session vars

version: $Revision: 1.3 $

Located in /input.lib.php (line 59)

Direct descendents

Class	Description
input_cookie	Input cookie class.
input_form_element	Base input element class for form elements
input_querystring	Input querystring class.
input_session	Used to store/retrieve data from the session.

Variable Summary

mixed $default

string $name

string $regex

bool $required

string $value

bool $wasSet

bool $wasValid

Method Summary

input_base input_base (string $name, [string $regex = NULL], [string $value = NULL], [bool $required = FALSE], [constant $method = INFUSE_FORM])

void reset ()

bool set (string $value)

Variables

mixed $default (line 108)

Default value (provided by caller).

string $name (line 66)

The name of the element.

string $regex (line 80)

The regular expression used to validate the objects contents.

bool $required (line 101)

Whether or not element is required

string $value (line 73)

The value of the element.

bool $wasSet = FALSE (line 87)

Whether the value was set by form submission

bool $wasValid = FALSE (line 94)

Whether the value set by form submission was correct

Methods

Constructor input_base (line 126)

Constructs a new base object.

uses: INFUSE_COOKIE - Possible value for $method.
uses: INFUSE_SERVER - Possible value for $method.
uses: INFUSE_POST - Possible value for $method.
uses: INFUSE_GET - Possible value for $method.
uses: INFUSE_SESSION - Possible value for $method.
uses: INFUSE_FORM - Possible value for $method.
uses: INFUSE_INORDER - Possible value for $method.

input_base input_base (string $name, [string $regex = NULL], [string $value = NULL], [bool $required = FALSE], [constant $method = INFUSE_FORM])

string $name: The name of the form element.
string $regex: A regular expression used to validate supplied data, or null.
string $value: The default value - used if not otherwise specified (in form, session, or cookie data).
bool $required: True if item is required.
constant $method: One of the constants specifying location of input values.

reset (line 156)

Reset to value specified as default.

Clear wasSet and wasValid.

void reset ()

Redefined in descendants as:

input_cookie::reset() : Reset to default value
input_checkbox::reset() : Reset checkbox value to default
input_session::reset() : Remove value from session, reset the instance value to the default.

set (line 171)

Sets the value of the object to the specified value if that value is valid according to regex given to constructor.

return: TRUE on success.

bool set (string $value)

string $value: The value to set.

Redefined in descendants as:

input_cookie::set() : Sets the value of the cookie object.
input_checkbox::set() : Sets the value of the checkbox.
input_dropdown::set() : Sets the value of the dropdown list.
input_radio::set() : Sets the value of the radio group.
input_textarea::set() : Sets the value of the textarea.
input_session::set() : Set the value for this object, also set value in session if set_in_session is true.