PHP Class Jarves\Configuration\Object

Inheritance: extends Model
Show file Open project: jarves/jarves Class Usage Examples

Protected Properties

Property Type Description
$_excludeFromExport
$addEntryPoint string | null The path of the entry point that acts as a add window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
$apiControllerDefinition string This is used in the bundle editor and makes it very easy to modify the behavior of all REST endpoint of an object endpoint (e.g. jarves/object/jarves/node/) Example: @JarvesBundle/Resources/config/crud/node.yml
$apiControllerService string This service builds basically only the REST APIs, all action methods around ObjectCrud. class jarves.crud.controller.object (Jarves\Controller\ObjectCrudController) >extends jarves.crud.object_crud (Jarves\Admin\ObjectCrud Schema (default): REST -> apiControllerService -> storageService (propel)
$attributes
$autoCrud boolean If you disable this and have custom entry points defined, you should adjust 'editEntrypoint', 'addEntrypoint', 'listEntryPoint' pointing to your custom entry point, so the system knows what entry point to open when someone wants to edit/add/list you object items.
$blacklistSelection string Comma separated list of fields which are blacklisted and therefore not selectable through the object API.
$browserColumns Field[]
$browserInterface default|custom
$browserInterfaceClass The javascript class/function to be used as the user interface for object browsing/listing.
$browserOptions Field[]
$bundle Bundle
$crossRef boolean
$crudService string This service handles a bit more than the pure storageService. For example: ACL, automatic filtering (per language) and event dispatcher. It needs to extend ObjectCrud. Schema (default): Jarves\Objects -> crudService (ObjectCrud) -> storageService (propel) The information stored in this object is also used by apiControllerService and extracts its propertyies to the crud framework in the administration interface.
$defaultSelection string Comma separated list of fields which are selected per default.
$desc string
$domainDepended boolean
$editEntryPoint string | null The path of the entry point that acts as a edit window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
$excludeFromREST boolean When false: you can only manage and see objects of this type using a custom rest api. Note: When disabled crud windows won't work. If you want to adjust the REST API behavior of this object, you should overwrite the 'apiControllerService' property instead.
$fieldTemplate string
$fields Field[]
$id string The id of the object.
$label string A label of the object.
$labelField string Which field (the value of it) shall be used as default label for the object.
$labelTemplate string
$limitDataSets array
$listEntryPoint string | null The path of the entry point that acts as a listing window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
$multiLanguage boolean Whether we handle multi languages or not.
$nested boolean If the object is nested.
$nestedRootAsObject boolean
$nestedRootObject string
$nestedRootObjectExtraFields string
$nestedRootObjectField string
$nestedRootObjectLabelField string
$publicUrlGenerator string example: \MyBundle\ControllerXy::getPublicUrl The function should have this signature: `function($objectKey, array $pk, array $pluginProperties )
$searchable boolean Whether this object can be searched in the administration search.
$singleItemLabelField string (jarves.Field instance)
$singleItemSelection string | array Extra fields to select for single item.
$storageService string Schema (default): Jarves\Objects -> crudService (ObjectCrud) -> storageService (propel) Note: the service needs to have shared: false.
$table string
$treeDefaultIcon string
$treeFields string Which fields are selected per default in the nested rest.
$treeFixedIcon boolean
$treeIcon string
$treeIconMapping TreeIconMapping
$treeInterface default|custom
$treeInterfaceClass string Javascript class/function for the tree user interface.
$treeLabel string Which field shall be used as default label for the nested set object.
$treeRootFieldFields string Comma separated list of field which shall be selected per default in the rest api.
$treeRootFieldLabel string Which field shall be used as label for the nested root.
$treeRootFieldTemplate string
$treeRootObjectFixedIcon boolean
$treeRootObjectIconPath string
$treeTemplate string
$workspace boolean Whether we handle workspaces or not.

Public Methods

Method Description
__sleep ( ) : array
addField ( Field $field )
addRelation ( Jarves\Admin\FieldTypes\RelationDefinitionInterface $relation )
bootRunTime ( Configs $configs ) Do whatever is needed to setup the runtime environment correctly.
getAddEntryPoint ( ) : null | string
getApiControllerDefinition ( ) : string
getApiControllerService ( ) : string
getAutoCrud ( ) : boolean
getBlacklistSelection ( ) : string
getBrowserColumns ( ) : Field[]
getBrowserColumnsArray ( ) : array
getBrowserInterface ( ) : string
getBrowserInterfaceClass ( )
getBrowserOptions ( ) : Field[]
getBundle ( ) : Bundle
getCrossRef ( ) : boolean
getCrudService ( ) : string
getDefaultSelection ( ) : string
getDesc ( ) : string
getDomainDepended ( ) : boolean
getEditEntryPoint ( ) : null | string
getExcludeFromREST ( ) : boolean
getField ( $fieldId ) : Field
getFieldTemplate ( ) : string
getFields ( ) : Field[]
getFieldsArray ( ) : array
getFinalApiController ( ) : string
getId ( ) : string Returns the object id. E.g. Node
getIndexes ( ) : array
getKey ( ) : string Returns the full object key. E.g. jarves/node
getLabel ( ) : string
getLabelField ( ) : string Which field (the value of it) shall be used as default label for the object.
getLabelTemplate ( ) : string
getLimitDataSets ( ) : Condition
getListEntryPoint ( ) : null | string
getMultiLanguage ( ) : boolean
getNested ( ) : boolean
getNestedRootAsObject ( ) : boolean
getNestedRootObject ( ) : string
getNestedRootObjectExtraFields ( ) : string
getNestedRootObjectField ( ) : string
getNestedRootObjectLabelField ( ) : string
getPrimaryKeyNames ( ) : string[]
getPrimaryKeys ( ) : Field[]
getPublicUrlGenerator ( ) : string
getRelation ( $name ) : Jarves\Admin\FieldTypes\RelationDefinitionInterface
getRelations ( ) : Jarves\Admin\FieldTypes\RelationDefinitionInterface[]
getSearchable ( ) : boolean
getSingleItemLabelField ( ) : string
getSingleItemSelection ( ) : array | string
getStorageService ( ) : string
getTable ( ) : string
getTreeDefaultIcon ( ) : string
getTreeFields ( ) : string
getTreeFixedIcon ( ) : boolean
getTreeIcon ( ) : string
getTreeIconMapping ( ) : TreeIconMapping
getTreeInterface ( ) : string
getTreeInterfaceClass ( ) : string
getTreeLabel ( ) : string
getTreeRootFieldFields ( ) : string
getTreeRootFieldLabel ( ) : string
getTreeRootFieldTemplate ( ) : string
getTreeRootObjectFixedIcon ( ) : boolean
getTreeRootObjectIconPath ( ) : string
getTreeTemplate ( ) : string
getWorkspace ( ) : boolean
hasField ( string $name ) : boolean
hasRelation ( $name ) : boolean
isCrossRef ( ) : boolean
isExcludeFromREST ( ) : boolean
isNested ( )
isSearchable ( ) : boolean
setAddEntryPoint ( null | string $addEntryPoint )
setApiControllerDefinition ( string $apiControllerDefinition )
setApiControllerService ( string $apiControllerService )
setAutoCrud ( boolean $autoCrud )
setBlacklistSelection ( string $blacklistSelection )
setBrowserColumns ( array $fields = null )
setBrowserInterface ( string $browserInterface )
setBrowserInterfaceClass ( $browserInterfaceClass )
setBrowserOptions ( array $browserOptions = null )
setBundle ( Bundle $bundle = null )
setCrossRef ( boolean $crossRef )
setCrudService ( string $crudService )
setDefaultSelection ( string $defaultSelection )
setDesc ( string $desc )
setDomainDepended ( boolean $domainDepended )
setEditEntryPoint ( null | string $editEntryPoint )
setExcludeFromREST ( boolean $excludeFromREST )
setFieldTemplate ( string $fieldTemplate )
setFields ( array $fields = [] )
setId ( string $id )
setIndexes ( array $indexes )
setLabel ( string $label )
setLabelField ( string $labelField )
setLabelTemplate ( string $labelTemplate )
setLimitDataSets ( Condition $limitDataSets )
setListEntryPoint ( null | string $listEntryPoint )
setMultiLanguage ( boolean $multiLanguage )
setNested ( boolean $nested )
setNestedRootAsObject ( boolean $nestedRootAsObject )
setNestedRootObject ( string $nestedRootObject )
setNestedRootObjectExtraFields ( string $nestedRootObjectExtraFields )
setNestedRootObjectField ( string $nestedRootObjectField )
setNestedRootObjectLabelField ( string $nestedRootObjectLabelField )
setPublicUrlGenerator ( string $publicUrlGenerator )
setRelations ( array $relations )
setSearchable ( boolean $searchable )
setSingleItemLabelField ( string $fieldLabel )
setSingleItemSelection ( array | string $fieldFields )
setStorageService ( string $storageService )
setTable ( string $table )
setTreeDefaultIcon ( string $treeDefaultIcon )
setTreeFields ( string $treeFields )
setTreeFixedIcon ( boolean $treeFixedIcon )
setTreeIcon ( string $treeIcon )
setTreeIconMapping ( TreeIconMapping $treeIconMapping = null )
setTreeInterface ( string $treeInterface )
setTreeInterfaceClass ( string $treeInterfaceClass )
setTreeLabel ( string $treeLabel )
setTreeRootFieldFields ( string $treeRootFieldFields )
setTreeRootFieldLabel ( string $treeRootFieldLabel )
setTreeRootFieldTemplate ( string $treeRootFieldTemplate )
setTreeRootObjectFixedIcon ( boolean $treeRootObjectFixedIcon )
setTreeRootObjectIconPath ( string $treeRootObjectIconPath )
setTreeTemplate ( string $treeTemplate )
setWorkspace ( boolean $workspace )
toArray ( $printDefaults = false )

Method Details

__sleep() public method

public __sleep ( ) : array
return array

addField() public method

public addField ( Field $field )
$field Field

addRelation() public method

public addRelation ( Jarves\Admin\FieldTypes\RelationDefinitionInterface $relation )
$relation Jarves\Admin\FieldTypes\RelationDefinitionInterface

bootRunTime() public method

e.g. create cross foreignKeys for 1-to-n relations.
public bootRunTime ( Configs $configs )
$configs Configs

getAddEntryPoint() public method

public getAddEntryPoint ( ) : null | string
return null | string

getApiControllerDefinition() public method

getApiControllerService() public method

public getApiControllerService ( ) : string
return string

getAutoCrud() public method

public getAutoCrud ( ) : boolean
return boolean

getBlacklistSelection() public method

public getBlacklistSelection ( ) : string
return string

getBrowserColumns() public method

public getBrowserColumns ( ) : Field[]
return Field[]

getBrowserColumnsArray() public method

public getBrowserColumnsArray ( ) : array
return array

getBrowserInterface() public method

public getBrowserInterface ( ) : string
return string

getBrowserInterfaceClass() public method

getBrowserOptions() public method

public getBrowserOptions ( ) : Field[]
return Field[]

getBundle() public method

public getBundle ( ) : Bundle
return Bundle

getCrossRef() public method

public getCrossRef ( ) : boolean
return boolean

getCrudService() public method

public getCrudService ( ) : string
return string

getDefaultSelection() public method

public getDefaultSelection ( ) : string
return string

getDesc() public method

public getDesc ( ) : string
return string

getDomainDepended() public method

public getDomainDepended ( ) : boolean
return boolean

getEditEntryPoint() public method

public getEditEntryPoint ( ) : null | string
return null | string

getExcludeFromREST() public method

public getExcludeFromREST ( ) : boolean
return boolean

getField() public method

public getField ( $fieldId ) : Field
$fieldId
return Field

getFieldTemplate() public method

public getFieldTemplate ( ) : string
return string

getFields() public method

public getFields ( ) : Field[]
return Field[] underscored fieldNames as index

getFieldsArray() public method

public getFieldsArray ( ) : array
return array camelCased fieldNames as index

getFinalApiController() public method

public getFinalApiController ( ) : string
return string

getId() public method

Returns the object id. E.g. Node
public getId ( ) : string
return string

getIndexes() public method

public getIndexes ( ) : array
return array

getKey() public method

Returns the full object key. E.g. jarves/node
public getKey ( ) : string
return string

getLabel() public method

public getLabel ( ) : string
return string

getLabelField() public method

Which field (the value of it) shall be used as default label for the object.
public getLabelField ( ) : string
return string

getLabelTemplate() public method

public getLabelTemplate ( ) : string
return string

getLimitDataSets() public method

public getLimitDataSets ( ) : Condition
return Condition

getListEntryPoint() public method

public getListEntryPoint ( ) : null | string
return null | string

getMultiLanguage() public method

public getMultiLanguage ( ) : boolean
return boolean

getNested() public method

public getNested ( ) : boolean
return boolean

getNestedRootAsObject() public method

public getNestedRootAsObject ( ) : boolean
return boolean

getNestedRootObject() public method

public getNestedRootObject ( ) : string
return string

getNestedRootObjectExtraFields() public method

getNestedRootObjectField() public method

public getNestedRootObjectField ( ) : string
return string

getNestedRootObjectLabelField() public method

getPrimaryKeyNames() public method

public getPrimaryKeyNames ( ) : string[]
return string[]

getPrimaryKeys() public method

public getPrimaryKeys ( ) : Field[]
return Field[]

getPublicUrlGenerator() public method

public getPublicUrlGenerator ( ) : string
return string

getRelation() public method

public getRelation ( $name ) : Jarves\Admin\FieldTypes\RelationDefinitionInterface
$name
return Jarves\Admin\FieldTypes\RelationDefinitionInterface

getRelations() public method

public getRelations ( ) : Jarves\Admin\FieldTypes\RelationDefinitionInterface[]
return Jarves\Admin\FieldTypes\RelationDefinitionInterface[]

getSearchable() public method

public getSearchable ( ) : boolean
return boolean

getSingleItemLabelField() public method

public getSingleItemLabelField ( ) : string
return string

getSingleItemSelection() public method

public getSingleItemSelection ( ) : array | string
return array | string

getStorageService() public method

public getStorageService ( ) : string
return string

getTable() public method

public getTable ( ) : string
return string

getTreeDefaultIcon() public method

public getTreeDefaultIcon ( ) : string
return string

getTreeFields() public method

public getTreeFields ( ) : string
return string

getTreeFixedIcon() public method

public getTreeFixedIcon ( ) : boolean
return boolean

getTreeIcon() public method

public getTreeIcon ( ) : string
return string

getTreeIconMapping() public method

public getTreeIconMapping ( ) : TreeIconMapping
return TreeIconMapping

getTreeInterface() public method

public getTreeInterface ( ) : string
return string

getTreeInterfaceClass() public method

public getTreeInterfaceClass ( ) : string
return string

getTreeLabel() public method

public getTreeLabel ( ) : string
return string

getTreeRootFieldFields() public method

public getTreeRootFieldFields ( ) : string
return string

getTreeRootFieldLabel() public method

public getTreeRootFieldLabel ( ) : string
return string

getTreeRootFieldTemplate() public method

public getTreeRootFieldTemplate ( ) : string
return string

getTreeRootObjectFixedIcon() public method

getTreeRootObjectIconPath() public method

getTreeTemplate() public method

public getTreeTemplate ( ) : string
return string

getWorkspace() public method

public getWorkspace ( ) : boolean
return boolean

hasField() public method

public hasField ( string $name ) : boolean
$name string
return boolean

hasRelation() public method

public hasRelation ( $name ) : boolean
$name
return boolean

isCrossRef() public method

public isCrossRef ( ) : boolean
return boolean

isExcludeFromREST() public method

public isExcludeFromREST ( ) : boolean
return boolean

isNested() public method

public isNested ( )

isSearchable() public method

public isSearchable ( ) : boolean
return boolean

setAddEntryPoint() public method

public setAddEntryPoint ( null | string $addEntryPoint )
$addEntryPoint null | string

setApiControllerDefinition() public method

public setApiControllerDefinition ( string $apiControllerDefinition )
$apiControllerDefinition string

setApiControllerService() public method

public setApiControllerService ( string $apiControllerService )
$apiControllerService string

setAutoCrud() public method

public setAutoCrud ( boolean $autoCrud )
$autoCrud boolean

setBlacklistSelection() public method

public setBlacklistSelection ( string $blacklistSelection )
$blacklistSelection string

setBrowserColumns() public method

public setBrowserColumns ( array $fields = null )
$fields array

setBrowserInterface() public method

public setBrowserInterface ( string $browserInterface )
$browserInterface string

setBrowserInterfaceClass() public method

public setBrowserInterfaceClass ( $browserInterfaceClass )
$browserInterfaceClass

setBrowserOptions() public method

public setBrowserOptions ( array $browserOptions = null )
$browserOptions array

setBundle() public method

public setBundle ( Bundle $bundle = null )
$bundle Bundle

setCrossRef() public method

public setCrossRef ( boolean $crossRef )
$crossRef boolean

setCrudService() public method

public setCrudService ( string $crudService )
$crudService string

setDefaultSelection() public method

public setDefaultSelection ( string $defaultSelection )
$defaultSelection string

setDesc() public method

public setDesc ( string $desc )
$desc string

setDomainDepended() public method

public setDomainDepended ( boolean $domainDepended )
$domainDepended boolean

setEditEntryPoint() public method

public setEditEntryPoint ( null | string $editEntryPoint )
$editEntryPoint null | string

setExcludeFromREST() public method

public setExcludeFromREST ( boolean $excludeFromREST )
$excludeFromREST boolean

setFieldTemplate() public method

public setFieldTemplate ( string $fieldTemplate )
$fieldTemplate string

setFields() public method

public setFields ( array $fields = [] )
$fields array

setId() public method

public setId ( string $id )
$id string

setIndexes() public method

public setIndexes ( array $indexes )
$indexes array

setLabel() public method

public setLabel ( string $label )
$label string

setLabelField() public method

public setLabelField ( string $labelField )
$labelField string

setLabelTemplate() public method

public setLabelTemplate ( string $labelTemplate )
$labelTemplate string

setLimitDataSets() public method

public setLimitDataSets ( Condition $limitDataSets )
$limitDataSets Condition

setListEntryPoint() public method

public setListEntryPoint ( null | string $listEntryPoint )
$listEntryPoint null | string

setMultiLanguage() public method

public setMultiLanguage ( boolean $multiLanguage )
$multiLanguage boolean

setNested() public method

public setNested ( boolean $nested )
$nested boolean

setNestedRootAsObject() public method

public setNestedRootAsObject ( boolean $nestedRootAsObject )
$nestedRootAsObject boolean

setNestedRootObject() public method

public setNestedRootObject ( string $nestedRootObject )
$nestedRootObject string

setNestedRootObjectExtraFields() public method

public setNestedRootObjectExtraFields ( string $nestedRootObjectExtraFields )
$nestedRootObjectExtraFields string

setNestedRootObjectField() public method

public setNestedRootObjectField ( string $nestedRootObjectField )
$nestedRootObjectField string

setNestedRootObjectLabelField() public method

public setNestedRootObjectLabelField ( string $nestedRootObjectLabelField )
$nestedRootObjectLabelField string

setPublicUrlGenerator() public method

public setPublicUrlGenerator ( string $publicUrlGenerator )
$publicUrlGenerator string

setRelations() public method

public setRelations ( array $relations )
$relations array

setSearchable() public method

public setSearchable ( boolean $searchable )
$searchable boolean

setSingleItemLabelField() public method

public setSingleItemLabelField ( string $fieldLabel )
$fieldLabel string

setSingleItemSelection() public method

public setSingleItemSelection ( array | string $fieldFields )
$fieldFields array | string

setStorageService() public method

public setStorageService ( string $storageService )
$storageService string

setTable() public method

public setTable ( string $table )
$table string

setTreeDefaultIcon() public method

public setTreeDefaultIcon ( string $treeDefaultIcon )
$treeDefaultIcon string

setTreeFields() public method

public setTreeFields ( string $treeFields )
$treeFields string

setTreeFixedIcon() public method

public setTreeFixedIcon ( boolean $treeFixedIcon )
$treeFixedIcon boolean

setTreeIcon() public method

public setTreeIcon ( string $treeIcon )
$treeIcon string

setTreeIconMapping() public method

public setTreeIconMapping ( TreeIconMapping $treeIconMapping = null )
$treeIconMapping TreeIconMapping

setTreeInterface() public method

public setTreeInterface ( string $treeInterface )
$treeInterface string

setTreeInterfaceClass() public method

public setTreeInterfaceClass ( string $treeInterfaceClass )
$treeInterfaceClass string

setTreeLabel() public method

public setTreeLabel ( string $treeLabel )
$treeLabel string

setTreeRootFieldFields() public method

public setTreeRootFieldFields ( string $treeRootFieldFields )
$treeRootFieldFields string

setTreeRootFieldLabel() public method

public setTreeRootFieldLabel ( string $treeRootFieldLabel )
$treeRootFieldLabel string

setTreeRootFieldTemplate() public method

public setTreeRootFieldTemplate ( string $treeRootFieldTemplate )
$treeRootFieldTemplate string

setTreeRootObjectFixedIcon() public method

public setTreeRootObjectFixedIcon ( boolean $treeRootObjectFixedIcon )
$treeRootObjectFixedIcon boolean

setTreeRootObjectIconPath() public method

public setTreeRootObjectIconPath ( string $treeRootObjectIconPath )
$treeRootObjectIconPath string

setTreeTemplate() public method

public setTreeTemplate ( string $treeTemplate )
$treeTemplate string

setWorkspace() public method

public setWorkspace ( boolean $workspace )
$workspace boolean

toArray() public method

public toArray ( $printDefaults = false )

Property Details

$_excludeFromExport protected property

protected $_excludeFromExport

$addEntryPoint protected property

The path of the entry point that acts as a add window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
protected string|null $addEntryPoint
return string | null

$apiControllerDefinition protected property

This is used in the bundle editor and makes it very easy to modify the behavior of all REST endpoint of an object endpoint (e.g. jarves/object/jarves/node/) Example: @JarvesBundle/Resources/config/crud/node.yml
protected string $apiControllerDefinition
return string

$apiControllerService protected property

This service builds basically only the REST APIs, all action methods around ObjectCrud. class jarves.crud.controller.object (Jarves\Controller\ObjectCrudController) >extends jarves.crud.object_crud (Jarves\Admin\ObjectCrud Schema (default): REST -> apiControllerService -> storageService (propel)
protected string $apiControllerService
return string

$attributes protected property

protected $attributes

$autoCrud protected property

If you disable this and have custom entry points defined, you should adjust 'editEntrypoint', 'addEntrypoint', 'listEntryPoint' pointing to your custom entry point, so the system knows what entry point to open when someone wants to edit/add/list you object items.
protected bool $autoCrud
return boolean

$blacklistSelection protected property

Comma separated list of fields which are blacklisted and therefore not selectable through the object API.
protected string $blacklistSelection
return string

$browserColumns protected property

protected Field[],Jarves\Configuration $browserColumns
return Field[]

$browserInterface protected property

default|custom
protected $browserInterface

$browserInterfaceClass protected property

The javascript class/function to be used as the user interface for object browsing/listing.
protected $browserInterfaceClass

$browserOptions protected property

protected Field[],Jarves\Configuration $browserOptions
return Field[]

$bundle protected property

protected Bundle,Jarves\Configuration $bundle
return Bundle

$crossRef protected property

protected bool $crossRef
return boolean

$crudService protected property

This service handles a bit more than the pure storageService. For example: ACL, automatic filtering (per language) and event dispatcher. It needs to extend ObjectCrud. Schema (default): Jarves\Objects -> crudService (ObjectCrud) -> storageService (propel) The information stored in this object is also used by apiControllerService and extracts its propertyies to the crud framework in the administration interface.
protected string $crudService
return string

$defaultSelection protected property

Comma separated list of fields which are selected per default.
protected string $defaultSelection
return string

$desc protected property

protected string $desc
return string

$domainDepended protected property

protected bool $domainDepended
return boolean

$editEntryPoint protected property

The path of the entry point that acts as a edit window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
protected string|null $editEntryPoint
return string | null

$excludeFromREST protected property

When false: you can only manage and see objects of this type using a custom rest api. Note: When disabled crud windows won't work. If you want to adjust the REST API behavior of this object, you should overwrite the 'apiControllerService' property instead.
protected bool $excludeFromREST
return boolean

$fieldTemplate protected property

protected string $fieldTemplate
return string

$fields protected property

protected Field[],Jarves\Configuration $fields
return Field[]

$id protected property

The id of the object.
protected string $id
return string

$label protected property

A label of the object.
protected string $label
return string

$labelField protected property

Which field (the value of it) shall be used as default label for the object.
protected string $labelField
return string

$labelTemplate protected property

protected string $labelTemplate
return string

$limitDataSets protected property

protected array $limitDataSets
return array

$listEntryPoint protected property

The path of the entry point that acts as a listing window. Important for select fields, that allows the user to jump directly to the crud list/edit/add.
protected string|null $listEntryPoint
return string | null

$multiLanguage protected property

Whether we handle multi languages or not.
protected bool $multiLanguage
return boolean

$nested protected property

If the object is nested.
protected bool $nested
return boolean

$nestedRootAsObject protected property

protected bool $nestedRootAsObject
return boolean

$nestedRootObject protected property

protected string $nestedRootObject
return string

$nestedRootObjectExtraFields protected property

protected string $nestedRootObjectExtraFields
return string

$nestedRootObjectField protected property

protected string $nestedRootObjectField
return string

$nestedRootObjectLabelField protected property

protected string $nestedRootObjectLabelField
return string

$publicUrlGenerator protected property

example: \MyBundle\ControllerXy::getPublicUrl The function should have this signature: `function($objectKey, array $pk, array $pluginProperties )
protected string $publicUrlGenerator
return string

$searchable protected property

Whether this object can be searched in the administration search.
protected bool $searchable
return boolean

$singleItemLabelField protected property

(jarves.Field instance)
protected string $singleItemLabelField
return string

$singleItemSelection protected property

Extra fields to select for single item.
protected string|array $singleItemSelection
return string | array

$storageService protected property

Schema (default): Jarves\Objects -> crudService (ObjectCrud) -> storageService (propel) Note: the service needs to have shared: false.
protected string $storageService
return string

$table protected property

protected string $table
return string

$treeDefaultIcon protected property

protected string $treeDefaultIcon
return string

$treeFields protected property

Which fields are selected per default in the nested rest.
protected string $treeFields
return string

$treeFixedIcon protected property

protected bool $treeFixedIcon
return boolean

$treeIcon protected property

protected string $treeIcon
return string

$treeIconMapping protected property

protected TreeIconMapping,Jarves\Configuration $treeIconMapping
return TreeIconMapping

$treeInterface protected property

default|custom
protected $treeInterface

$treeInterfaceClass protected property

Javascript class/function for the tree user interface.
protected string $treeInterfaceClass
return string

$treeLabel protected property

Which field shall be used as default label for the nested set object.
protected string $treeLabel
return string

$treeRootFieldFields protected property

Comma separated list of field which shall be selected per default in the rest api.
protected string $treeRootFieldFields
return string

$treeRootFieldLabel protected property

Which field shall be used as label for the nested root.
protected string $treeRootFieldLabel
return string

$treeRootFieldTemplate protected property

protected string $treeRootFieldTemplate
return string

$treeRootObjectFixedIcon protected property

protected bool $treeRootObjectFixedIcon
return boolean

$treeRootObjectIconPath protected property

protected string $treeRootObjectIconPath
return string

$treeTemplate protected property

protected string $treeTemplate
return string

$workspace protected property

Whether we handle workspaces or not.
protected bool $workspace
return boolean