Class PifaField

contains meta data of a PIFA field

cGenericDb

Item

PifaField

Package: Plugin\FormAssistant
Copyright: four for business AG
Author: marcus.gnass
Located at plugins/form_assistant/classes/class.pifa.field.php

Methods summary
`public`	# `__construct( mixed $id = false )` Parameters `$id` `mixed` $id ID of item to be loaded or false Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `Item::__construct()`
`public mixed`	# `getField( string $field )` Rule has to be stripslashed to allow regular expressions with backslashes. Rule has to be stripslashed to allow regular expressions with backslashes. Parameters `$field` `string` $sField Specifies the field to retrieve Returns `mixed` Value of the field See `Item::getField()` Overrides `Item::getField()`
`public`	# `getLastError( )` Getter for protected prop. Getter for protected prop.
`public mixed`	# `getValue( )` Returns this fields stored value. Returns this fields stored value. Returns `mixed` the $_value
`public`	# `setValue( mixed $value )` Parameters `$value` `mixed` $_value
`public array`	# `getFile( )` keys: name, tmp_name keys: name, tmp_name Returns `array` the $_file
`public`	# `setFile( array $_file )` Parameters `$_file` `array` $_file
`public`	# `validate( )` Throws `PifaValidationException` if an error occured
`public string`	# `toHtml( array $errors = NULL )` Returns HTML for this form that should be displayed in frontend. Returns HTML for this form that should be displayed in frontend. Parameters `$errors` `array` $errors to be displayed for form field Returns `string`
`public cHTMLLabel`	# `_getElemLabel( )` TODO should be private, right? Returns `cHTMLLabel`
`public cHTMLTextbox`	# `_getElemField( )` Creates the HTML for a form field. Creates the HTML for a form field. The displayed value of a form field can be set via a GET param whose name has to be the fields column name which is set if the form is displayed for the first time and user hasn't entered another value. TODO should be private, right? Returns `cHTMLTextbox` cHTMLTextarea cHTMLPasswordbox cHTMLSpan cHTMLSelectElement NULL cHTMLButton Throws `NotImplementedException` if field type is not implemented
`public Ambigous`	# `_getElemHelp( )` TODO should be private, right? TODO should be private, right? Returns `Ambigous` <NULL, cHTMLParagraph>
`public Ambigous`	# `_getElemScript( )` TODO should be private, right? TODO should be private, right? Returns `Ambigous` <NULL, cHTMLScript>
`public static`	# `getFieldTypeIcon( integer $fieldType )` TODO add different icons for different form field types TODO add different icons for different form field types Parameters `$fieldType` `integer` $fieldType
`public static array`	# `getFieldTypeIds( )` Returns an array containing all field type ids. Returns an array containing all field type ids. Returns `array`
`public static array`	# `getFieldTypeNames( )` Returns an array containing all field type ids mapped to their names. Returns an array containing all field type ids mapped to their names. Returns `array`
`public static string`	# `getFieldTypeName( integer $fieldTypeId )` Return the field type name for the given field type id. Return the field type name for the given field type id. Parameters `$fieldTypeId` `integer` $fieldType Returns `string`
`public string`	# `getMyFieldTypeName( )` Return this fields type name. Return this fields type name. Returns `string`
`public`	# `getDbDataType( )` Returns a string describing this fields database data type as used in MySQL CREATE and ALTER TABLE statements. Returns a string describing this fields database data type as used in MySQL CREATE and ALTER TABLE statements. Throws `PifaException` if field is not loaded `PifaException` if field type is not implemented
`public`	# `delete( )` Deletes this form with all its fields and stored data. The forms data table is also dropped. Deletes this form with all its fields and stored data. The forms data table is also dropped.
`public`	# `showField( string $columnName )` Determines for which form field types which data should be editable in backend. Determines for which form field types which data should be editable in backend. Parameters `$columnName` `string` $columnName for data to edit
`public array`	# `getOptions( )` Returns `array`

Methods inherited from Item
`Item(), _inFilter(), _loadByWhereClause(), _onLoad(), _outFilter(), _setMetaObject(), deleteProperty(), deletePropertyById(), get(), getMetaObject(), getProperty(), isLoaded(), loadBy(), loadByMany(), loadByPrimaryKey(), loadByRecordSet(), set(), setField(), setFilters(), setProperty(), store(), toArray(), toObject()`

Methods inherited from cItemBaseAbstract
`_getPropertiesCollectionInstance(), _getSecondDBInstance(), escape()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants summary
`integer`	`VARCHAR_SIZE`	`255`	# size to use for VARCHAR fields Remember: the maximum row size for the used table type, not counting BLOBs, is 65535. TODO PIFA should be able to calculate the size for one record by the size of its fields and handle it accordingly. size to use for VARCHAR fields Remember: the maximum row size for the used table type, not counting BLOBs, is 65535. TODO PIFA should be able to calculate the size for one record by the size of its fields and handle it accordingly.
`integer`	`INPUTTEXT`	`1`	#
`integer`	`TEXTAREA`	`2`	#
`integer`	`INPUTPASSWORD`	`3`	#
`integer`	`INPUTRADIO`	`4`	#
`integer`	`INPUTCHECKBOX`	`5`	#
`integer`	`SELECT`	`6`	#
`integer`	`SELECTMULTI`	`7`	#
`integer`	`DATEPICKER`	`8`	#
`integer`	`INPUTFILE`	`9`	#
`integer`	`PROCESSBAR`	`10`	#
`integer`	`SLIDER`	`11`	#
`integer`	`BUTTONSUBMIT`	`13`	#
`integer`	`BUTTONRESET`	`14`	#
`integer`	`BUTTONBACK`	`15`	#
`integer`	`MATRIX`	`16`	#
`integer`	`PARA`	`17`	# A text to be displayed between form fields. It's no form field on its own but should be handled like one. A text to be displayed between form fields. It's no form field on its own but should be handled like one.
`integer`	`INPUTHIDDEN`	`18`	#
`integer`	`FIELDSET_BEGIN`	`19`	#
`integer`	`FIELDSET_END`	`20`	#

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties summary
`private mixed`	`$_value`	`NULL`	#
`private array`	`$_file`	`NULL`	#

Properties inherited from Item
`$_arrInFilters, $_arrOutFilters, $_lastSQL, $_metaObject, $modifiedValues, $oldPrimaryKey, $values`

Properties inherited from cItemBaseAbstract
`$_className, $_oCache, $_settings, $db, $lasterror, $primaryKey, $properties, $secondDb, $table, $virgin`

Packages

Classes

Exceptions

Class PifaField

Parameters

Throws

Overrides

Parameters

Returns

See

Overrides

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Returns

Returns

Throws

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Throws

Parameters

Returns