• Home
• Jarves
• Configuration
• Field

PHP Class Jarves\Configuration\Field

Show file Open project: jarves/jarves Class Usage Examples

Protected Properties

Property	Type	Description
$againstField	string | null	Works only with needValue. A field id from another field.
$arrayKey
$attribute	boolean	Whether this field is a attribute.
$attributes
$autoIncrement	boolean
$children	Field[]
$customGet	string
$customSave	string
$default	mixed | null	The default/initial value.
$description	string	Shows a grayed description text. Use markdown to format stuff.
$disabled	boolean	If this fields is disabled or not.
$field	string	The key of the field this is representing. Primarily for types 'predefined'.
$fieldWidth	string | integer	Width of the panel where the input is placed.
$help	string	Shows a little help icon and points to the given help id.
$id	string
$inputWidth	string | integer	Width of the actual input element (input, select, textarea, etc)
$label	string	The label.
$layout	string	Not in use.
$maxLength	integer
$needValue	string | null	Per default, this is checked against the parent (when this field is in a children section of another field), however, you can change that by using againstField.
$noWrapper	boolean	If this fields contains a default wrapper div with title, description etc or only the input itself.
$object	string
$objectLabel	string
$objectRefRelationName	string	The virtualField name of the field in the foreign object pointing to us back.
$objectRelation	string	\Jarves\ORM\ORMAbstract:: MANY_TO_ONE = 'nTo1', ONE_TO_MANY = '1ToN', ONE_TO_ONE = '1To1', MANY_TO_MANY = 'nToM';
$objectRelationCrossObjectKey	string	The object name of the cross-table of a nToM relation.
$objectRelationOnDelete	string	onDelete cascade|setnull|restrict|none
$objectRelationOnUpdate	string	onUpdate cascade|setnull|restrict|none
$objectRelationTable	string	The table name of the middle-table of a nToM relation.
$objectRelationWithConstraint	boolean	If the storage backend should also create a constraint so its not possible to pass a invalid reference id.
$options	Options
$primaryKey	boolean
$required	boolean	Defines if this field needs a valid value.
$requiredRegex	string
$returnDefault	boolean	If this field returns the value even though it's the default value (in a form).
$saveOnlyFilled	boolean
$startEmpty	boolean	If this field starts with a empty value (on initialisation). (Good fit for password fields)
$tableItem	boolean	If this field injects a tr+2xtd instead of div.
$target	string	Only used when this field is a object attribute (extends another foreign object)
$type	string
$virtual	boolean	Virtual fields are not exported to the configuration xml.
$width	integer | string	Width of a column.

Public Methods

Method	Description
__sleep ( )
bootRunTime ( Object $object, Configs $configs )	Do whatever is needed to setup the runtime environment correctly.
canPropertyBeExported ( $k )
fromArray ( array $values, string $key = null )
getAgainstField ( ) : string
getAttribute ( ) : boolean
getAutoIncrement ( ) : boolean
getChildren ( ) : Field[]
getChildrenArray ( ) : array
getColumnName ( ) : string	Returns the column name for database access.
getCustomGet ( ) : string
getCustomSave ( ) : string
getDefault ( ) : mixed
getDescription ( ) : string
getDisabled ( ) : boolean
getField ( ) : string
getFieldType ( ) : Jarves\Admin\FieldTypes\TypeInterface
getFieldWidth ( ) : integer | string
getForm ( ) : Form
getHelp ( ) : string
getId ( ) : string
getInputWidth ( ) : integer | string
getLabel ( ) : string
getLayout ( ) : string
getMaxLength ( ) : integer
getNeedValue ( ) : mixed
getNoWrapper ( ) : boolean
getObject ( ) : string
getObjectDefinition ( ) : Object
getObjectLabel ( ) : string
getObjectRefRelationName ( ) : string
getObjectRelation ( ) : string
getObjectRelationCrossObjectKey ( ) : string
getObjectRelationOnDelete ( ) : string
getObjectRelationOnUpdate ( ) : string
getObjectRelationTable ( ) : string
getObjectRelationWithConstraint ( ) : boolean	If the storage backend should also create a constraint so its not possible to pass a invalid reference id.
getOption ( string $key ) : mixed
getOptions ( ) : Options
getParentField ( ) : Field
getPhpDataType ( ) : string	Returns the internal data type.
getPrimaryKey ( ) : boolean
getRequired ( ) : boolean
getRequiredRegex ( ) : string
getReturnDefault ( ) : boolean
getSaveOnlyFilled ( ) : boolean
getStartEmpty ( ) : boolean
getTableItem ( ) : mixed
getTarget ( ) : string
getType ( ) : string
getValue ( ) : mixed
getVirtual ( ) : boolean
getWidth ( ) : integer | string
hasFieldType ( ) : boolean
isAttribute ( ) : boolean
isAutoIncrement ( ) : boolean
isHidden ( ) : boolean	Hidden means here if the needValue is correct with the value of parent or getAgainstField.
isObjectRelationWithConstraint ( ) : boolean	If the storage backend should also create a constraint so its not possible to pass a invalid reference id.
isPrimaryKey ( ) : boolean
isRequired ( ) : boolean
isVirtual ( ) : boolean
mapValues ( array &$data )
setAgainstField ( string $againstField )
setAttribute ( boolean $attribute )
setAutoIncrement ( boolean $autoIncrement )
setChildren ( array $children = null )
setCustomGet ( string $customGet )
setCustomSave ( string $customSave )
setDefault ( mixed $default )
setDescription ( string $description )
setDisabled ( boolean $disabled )
setField ( string $field )
setFieldType ( Jarves\Admin\FieldTypes\TypeInterface $fieldType )
setFieldWidth ( integer | string $fieldWidth )
setForm ( Form $form )
setHelp ( string $help )
setId ( string $id )
setInputWidth ( integer | string $inputWidth )
setLabel ( string $label )
setLayout ( string $layout )
setMaxLength ( integer $maxLength )
setNeedValue ( mixed $needValue )
setNoWrapper ( boolean $noWrapper )
setObject ( string $object )
setObjectDefinition ( Object $objectDefinition )
setObjectLabel ( string $objectLabel )
setObjectRefRelationName ( string $objectRefRelationName )
setObjectRelation ( string $objectRelation )
setObjectRelationCrossObjectKey ( string $objectRelationPhpName )
setObjectRelationOnDelete ( string $objectRelationOnDelete )
setObjectRelationOnUpdate ( string $objectRelationOnUpdate )
setObjectRelationTable ( string $objectRelationTable )
setObjectRelationWithConstraint ( boolean $objectRelationWithConstraint )
setOption ( $key, $value )
setOptions ( Options $options )
setParentField ( Field $parentField )
setPrimaryKey ( boolean $primaryKey )
setRequired ( boolean $required )
setRequiredRegex ( string $requiredRegex )
setReturnDefault ( boolean $returnDefault )
setSaveOnlyFilled ( boolean $saveOnlyFilled )
setStartEmpty ( boolean $startEmpty )
setTableItem ( mixed $tableItem )
setTarget ( string $target )
setType ( string $type )
setValue ( mixed $value )
setVirtual ( boolean $virtual )
setWidth ( integer | string $width )
toArray ( boolean $printDefaults = false ) : array
validate ( ) : boolean

Method Details

Property Details