Class PifaField

PIFA field item class. It's a kind of a model.

cGenericDb

Item

PifaField

Package: Plugin\FormAssistant
Copyright: four for business AG
Author: Marcus Gnaß <marcus.gnass@4fb.de>
Located at plugins/form_assistant/classes/class.pifa.field.php

Methods summary
`public`	# `__construct( string\|boolean $id = false )` Create an instance. Create an instance. Parameters `$id` `string\|boolean` $id ID of item to be loaded or false Throws `cDbException` `cException` Overrides `Item::__construct()`
`public mixed\|string`	# `getField( string $field, boolean $bSafe = true )` 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` $field `$bSafe` `boolean` $bSafe Returns `mixed\|string` 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` Throws `PifaException`
`private cHTMLLabel\|string`	# `_getElemLabel( )` Returns `cHTMLLabel\|string`
`private 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. Returns `cHTMLTextbox` cHTMLTextarea cHTMLPasswordbox cHTMLSpan cHTMLSelectElement NULL cHTMLButton Throws `PifaException` `PifaNotImplementedException` if field type is not implemented
`private cHTMLParagraph\|null`	# `_getElemHelp( )` Returns `cHTMLParagraph\|null`
`public cHTMLScript\|null`	# `_getElemScript( )` Returns `cHTMLScript\|null`
`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. The order of field types in this array influences the order of icons displayed in the backend for selection! 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` $fieldTypeId 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. Throws `PifaException` `cDbException`
`public boolean`	# `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 Returns `boolean` Throws `PifaException`
`public array`	# `getOptions( )` Returns `array`

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

Methods inherited from cItemBaseAbstract
`__get(), __set(), _getPropertiesCollectionInstance(), _getSecondDBInstance(), _setLoaded(), _setPrimaryKeyName(), escape(), getPrimaryKeyName(), isLoaded()`

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. 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`	# Input field for single-line text. Input field for single-line text.
`integer`	`TEXTAREA`	`2`	# Input field for multi-line text. Input field for multi-line text.
`integer`	`INPUTPASSWORD`	`3`	# Input field for single-line password. Input field for single-line password.
`integer`	`INPUTRADIO`	`4`	# Radiobox. Radiobox.
`integer`	`INPUTCHECKBOX`	`5`	# Checkbox Checkbox
`integer`	`SELECT`	`6`	# Selectbox allowing for selection of a single option. Selectbox allowing for selection of a single option.
`integer`	`SELECTMULTI`	`7`	# Selectbox allowing for selection of multiple options. Selectbox allowing for selection of multiple options.
`integer`	`DATEPICKER`	`8`	# Input field for date selection. Input field for date selection.
`integer`	`INPUTFILE`	`9`	# Input field for file selection. Input field for file selection.
`integer`	`PROCESSBAR`	`10`	# Processbar. Processbar.
`integer`	`SLIDER`	`11`	# Slider. Slider.
`integer`	`CAPTCHA`	`12`	# Captcha. Captcha.
`integer`	`BUTTONSUBMIT`	`13`	# Button of type submit. Button of type submit.
`integer`	`BUTTONRESET`	`14`	# Button of type reset. Button of type reset.
`integer`	`BUTTONBACK`	`15`	# General button. General button. Deprecated use PifaField::BUTTON instead
`integer`	`BUTTON`	`15`	# General button. General button.
`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`	# A hidden input field. A hidden input field.
`integer`	`FIELDSET_BEGIN`	`19`	# Begin of a fieldset. Begin of a fieldset.
`integer`	`FIELDSET_END`	`20`	# End of a fieldset. End of a fieldset.
`integer`	`BUTTONIMAGE`	`21`	# Button of type image (which is in fact a submit button). Button of type image (which is in fact a submit button).

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`	# The form fields value. The form fields value.
`private array`	`$_file`	`NULL`	# The file that was transmitted in case of INPUTFILE. The file that was transmitted in case of INPUTFILE.

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

Properties inherited from cItemBaseAbstract
`$_className, $_loaded, $_oCache, $_primaryKeyName, $_settings, $db, $lasterror, $properties, $secondDb, $table`

Packages

Classes

Exceptions

Class PifaField

Parameters

Throws

Overrides

Parameters

Returns

See

Overrides

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Throws

Returns

Returns

Throws

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Throws

Throws

Parameters

Returns

Throws

Returns

Todo

Deprecated