Fork me on GitHub

Configuration Object
<object>

Source » Jarves\Configuration\Object.

<!--

  Attribute id:

    The id of the object.

    @var string

  Attribute crossRef:

    @var bool-->
<object id="" crossRef="false">
  <!--
  A label of the object.

  @var string-->
  <label></label>
  <!--
  @var string-->
  <desc></desc>
  <!--
  @var string-->
  <table></table>
  <!--
  The storage/persisting service that handles the actual data storage/retrievement (to a file e.g) of the object
  interface. This class is used by $controller (Jarves\Admin\ObjectCrud class)

  Schema (default):
    Jarves\Objects -> crudService (ObjectCrud) -> storageService (propel)

  Note: the service needs to have `shared: false`.

  @var string-->
  <storageService>jarves.storage.propel</storageService>
  <!--
  Service to use as crud interface which is used in jarves and external bundles to
  modify actual objects. Per default Jarves\Admin\ObjectCrud (jarves.crud.object_crud) is used.

  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.

  @var string-->
  <crudService>jarves.crud.object_crud</crudService>
  <!--
  Service which builds the external API (Symfony routes for the REST API). Per default one of
  Jarves\Controller\*ObjectCrudController. If you overwrite this, make sure to extend from one of those classes
  there.

  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)

  @var string-->
  <apiControllerService></apiControllerService>
  <!--
  Path to a yml definition for api controller. This is basically a yaml file containing key values
  that overwrite properties of $apiControllerService (which is most likely Jarves\Admin\ObjectCrud)

  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

  @var string-->
  <apiControllerDefinition></apiControllerDefinition>
  <!--
  Which field (the value of it) shall be used as default label for the object.

  @var string-->
  <labelField></labelField>
  <!--
  @var string-->
  <labelTemplate></labelTemplate>
  <!--
  Comma separated list of fields which are selected per default.

  @var string-->
  <defaultSelection></defaultSelection>
  <!--
  Comma separated list of fields which are blacklisted and therefore not selectable
  through the object API.

  @var string-->
  <blacklistSelection></blacklistSelection>
  <!--
  Whether we handle multi languages or not.

  @var bool-->
  <multiLanguage>false</multiLanguage>
  <!--
  Whether we handle workspaces or not.

  @var bool-->
  <workspace>false</workspace>
  <!--
  @var bool-->
  <domainDepended>false</domainDepended>
  <!--
  Which field shall be used as default label for a default text input `field` instance in the user interface for
  example.
  (jarves.Field instance)

  @var string-->
  <singleItemLabelField></singleItemLabelField>
  <!--
  Extra fields to select for single item.

  @var string|array-->
  <singleItemSelection></singleItemSelection>
  <!--
  @var string-->
  <fieldTemplate></fieldTemplate>
  <!--
  If the object is nested.

  @var bool-->
  <nested>false</nested>
  <!--
  @var bool-->
  <nestedRootAsObject>false</nestedRootAsObject>
  <!--
  @var string-->
  <nestedRootObject></nestedRootObject>
  <!--
  @var string-->
  <nestedRootObjectField></nestedRootObjectField>
  <!--
  @var string-->
  <nestedRootObjectLabelField></nestedRootObjectLabelField>
  <!--
  @var string-->
  <nestedRootObjectExtraFields></nestedRootObjectExtraFields>
  <!--
  Which field shall be used as default label for the nested set object.

  @var string-->
  <treeLabel></treeLabel>
  <!--
  @var string-->
  <treeTemplate></treeTemplate>
  <!--
  Which fields are selected per default in the nested rest.

  @var string-->
  <treeFields></treeFields>
  <!--
  @var string-->
  <treeIcon></treeIcon>
  <!--
  @var TreeIconMapping-->
  <treeIconMapping></treeIconMapping>
  <!--
  Javascript class/function for the tree user interface.

  @var string-->
  <treeInterfaceClass></treeInterfaceClass>
  <!--
  @var string default|custom-->
  <treeInterface>default</treeInterface>
  <!--
  @var string-->
  <treeDefaultIcon></treeDefaultIcon>
  <!--
  @var bool-->
  <treeFixedIcon>false</treeFixedIcon>
  <!--
  @var string-->
  <treeRootObjectIconPath></treeRootObjectIconPath>
  <!--
  @var bool-->
  <treeRootObjectFixedIcon>false</treeRootObjectFixedIcon>
  <!--
  Which field shall be used as label for the nested root.

  @var string-->
  <treeRootFieldLabel></treeRootFieldLabel>
  <!--
  @var string-->
  <treeRootFieldTemplate></treeRootFieldTemplate>
  <!--
  Comma separated list of field which shall be selected per default in the rest api.

  @var string-->
  <treeRootFieldFields></treeRootFieldFields>
  <!--
  The javascript class/function to be used as the user interface for object browsing/listing.

  @var-->
  <browserInterfaceClass></browserInterfaceClass>
  <!--
  @var string default|custom-->
  <browserInterface>default</browserInterface>
  <!--
  @var Field[]-->
  <browserOptions></browserOptions>
  <!--
  @var array-->
  <limitDataSets></limitDataSets>
  <!--
  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.

  @var string|null-->
  <listEntryPoint></listEntryPoint>
  <!--
  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.

  @var string|null-->
  <editEntryPoint></editEntryPoint>
  <!--
  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.

  @var string|null-->
  <addEntryPoint></addEntryPoint>
  <!--
  @var Field[]-->
  <fields></fields>
  <!--
  @var Field[]-->
  <browserColumns></browserColumns>
  <!--
  The callable string pointing to a method/function that generates the actual public url for a object pk.

  example:

   `\MyBundle\ControllerXy::getPublicUrl`

  The function should have this signature:

    `function($objectKey, array $pk, array $pluginProperties )

  @var string-->
  <publicUrlGenerator></publicUrlGenerator>
  <!--
  Whether Jarves should not build crud views and menu links in the administration for this object automatically.

  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.

  @var bool-->
  <autoCrud>true</autoCrud>
  <!--
  Whether Jarves should not include this object in the object REST API (jarves/object/<objectKey>).
  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.

  @var bool-->
  <excludeFromREST>false</excludeFromREST>
  <!--
  Whether this object can be searched in the administration search.

  @var bool-->
  <searchable>true</searchable>
</object>

Found a typo? The website is based on Markdown, please feel free to send us a pull request! :) github.com/jarves/jarves.io/tree/master/app/jarves/website/jarves.io