GrimaFormField Class Reference

Wrapper for each field in a form, keeping track of its properties. More...

Public Member Functions
	booly ($str, $default='undefined')
	return boolean meaning of common terms ("true","on","1","yes") More...
	__construct ($field)
	create a new GrimaFormField More...

Public Attributes
	$value
	$name
	$shortname
	$label
	$placeholder
	$required
	$persistent
	$autofocus
	$visible
	$rows
	$dataset
	$error_condition = ""
	$error_message = ""

Protected Attributes
	$autocomplete
	$highlight

Detailed Description

Wrapper for each field in a form, keeping track of its properties.

Definition at line 2073 of file grima-lib.php.

Constructor & Destructor Documentation

__construct()

GrimaFormField::__construct

(

$field

)

create a new GrimaFormField

Parameters

DomNode

$field

with attributes for all properties

Definition at line 2128 of file grima-lib.php.

    {

        $this->name = $field->getAttribute('name');

        $this->shortname = $field->getAttribute('shortname');

        $this->label = $field->getAttribute('label');

        $this->placeholder = $field->getAttribute('placeholder');

        $this->rows = $field->getAttribute('rows');

        $this->type = $field->getAttribute('type');

        if (!$this->type) {

            $this->type = 'input';

        }

        $this->required = $this->booly($field->getAttribute('required'), true);

        $this->persistent = $this->booly($field->getAttribute('persistent'), false);

        $this->autofocus = $this->booly($field->getAttribute('autofocus'), false);

        $this->autocomplete = $this->booly($field->getAttribute('autocomplete'), false);

        $this->visible = $this->booly($field->getAttribute('visible'), true);

        $this->dataset = $field->getAttribute('dataset');

        $this->options = array();

        if ($this->dataset) {

            if ($this->dataset == "institutions") {

                $institutions = GrimaDB::getInstitutions();

                $currentUser = GrimaUser::GetCurrentUser();

                foreach ($institutions as $institution) {

                    $i = htmlspecialchars($institution);

                    $s = ($institution === $currentUser['institution']) ? ' selected="selected"' : '';

                    $this->options[] = "<option value=\"$i\"$s>$i</option>";

                }

            }

        } else {

            foreach ($field->getElementsByTagName("option") as $option) {

                $this->options[] = $option->ownerDocument->saveXML($option);

            }

        }

    }

References booly(), GrimaUser\GetCurrentUser(), and GrimaDB\getInstitutions().

Member Function Documentation

booly()

GrimaFormField::booly	(		$str,
			$default = 'undefined'
	)

return boolean meaning of common terms ("true","on","1","yes")

Parameters

string	$str	term to interpret
	$default	if it is not found

Returns

boolean true or false

Definition at line 2101 of file grima-lib.php.

    {

        switch(strtolower($str)) {

        case 'true':

        case 't':

        case 'on':

        case 'yes':

        case '1':

            return true;

        case 'false':

        case 'f':

        case 'off':

        case 'no':

        case '0':

            return false;

        default:

            return $default;

        }

    }

Referenced by __construct().

Member Data Documentation

$autocomplete

GrimaFormField::$autocomplete

protected

Definition at line 2088 of file grima-lib.php.

$autofocus

GrimaFormField::$autofocus

Definition at line 2084 of file grima-lib.php.

$dataset

GrimaFormField::$dataset

Definition at line 2087 of file grima-lib.php.

$error_condition

GrimaFormField::$error_condition = ""

Definition at line 2090 of file grima-lib.php.

$error_message

GrimaFormField::$error_message = ""

Definition at line 2091 of file grima-lib.php.

$highlight

GrimaFormField::$highlight

protected

Definition at line 2089 of file grima-lib.php.

$label

GrimaFormField::$label

Definition at line 2080 of file grima-lib.php.

$name

GrimaFormField::$name

Definition at line 2078 of file grima-lib.php.

$persistent

GrimaFormField::$persistent

Definition at line 2083 of file grima-lib.php.

$placeholder

GrimaFormField::$placeholder

Definition at line 2081 of file grima-lib.php.

$required

GrimaFormField::$required

Definition at line 2082 of file grima-lib.php.

$rows

GrimaFormField::$rows

Definition at line 2086 of file grima-lib.php.

$shortname

GrimaFormField::$shortname

Definition at line 2079 of file grima-lib.php.

$value

GrimaFormField::$value

Definition at line 2076 of file grima-lib.php.

$visible

GrimaFormField::$visible

Definition at line 2085 of file grima-lib.php.

---

The documentation for this class was generated from the following file:

• grimas/grima-lib.php