Docs For Class input

Description

Used to store/retrieve data from the session.

version: $Revision: 1.4 $

input_base
   |
   --input_session

Variable Summary

bool $base64

Method Summary

input_session input_session (string $name, [string $regex = NULL], [string $value = NULL], [bool $base64 = false])

void refresh ()

void remove ()

void reset ()

bool set (string $value, [bool $set_in_session = TRUE])

bool verifyData (string &$value)

Variables

bool $base64 (line 33)

Should/Is value base64 encoded in the session

access: private

Inherited Variables

Inherited from input_base

input_base::$default
input_base::$name
input_base::$regex
input_base::$required
input_base::$value
input_base::$wasSet
input_base::$wasValid

Methods

Constructor input_session (line 43)

Constructs a new input_session object

input_session input_session (string $name, [string $regex = NULL], [string $value = NULL], [bool $base64 = false])

string $name: The name of the textarea.
string $regex: The validation regular expression.
string $value: The initial contents value.
bool $base64: Should the value be base64 encoded in the session.

refresh (line 68)

Refresh values from the session

void refresh ()

remove (line 132)

Clear value from session.

void remove ()

reset (line 98)

Remove value from session, reset the instance value to the default.

void reset ()

Redefinition of:

input_base::reset(): Reset to value specified as default.

set (line 112)

Set the value for this object, also set value in session if set_in_session is true.

return: TRUE on success.

bool set (string $value, [bool $set_in_session = TRUE])

string $value: The value to set.
bool $set_in_session: Should value also be set in session

Redefinition of:

input_base::set(): Sets the value of the object to the specified value if that value is valid according to regex given to constructor.

verifyData (line 145)

Verify value against regex.

Will recursively verify array elements.

return: TRUE if value is valid.
access: private

bool verifyData (string &$value)

string $value: The value to verify.

Inherited Methods

Inherited From input_base

input_base::input_base()
input_base::reset()
input_base::set()