• Home
• Jarves
• Configuration
• Object

PHP Class Jarves\Configuration\Object

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

Property Details