Fork me on GitHub

Configuration Field
<field>

Source » Jarves\Configuration\Field.

<!--

  Attribute id:

    @var string

  Attribute type:

    @var string

  Attribute target:

    Only used when this field is a object attribute (extends another foreign object)

    @internal
    @var string

  Attribute required:

    Defines if this field needs a valid value.

    @var bool

  Attribute primaryKey:

    @var bool

  Attribute autoIncrement:

    @var bool-->
<field id="" type="" target="" required="false" primaryKey="false" autoIncrement="false">
  <!--
  The label.

  @var string-->
  <label></label>
  <!--
  Shows a grayed description text. Use markdown to format stuff.

  @var string-->
  <description></description>
  <!--
  @var integer-->
  <maxLength></maxLength>
  <!--
  @var string-->
  <object></object>
  <!--
  One of

  \Jarves\ORM\ORMAbstract::
        MANY_TO_ONE = 'nTo1',
        ONE_TO_MANY = '1ToN',
        ONE_TO_ONE = '1To1',
        MANY_TO_MANY = 'nToM';

  @var string-->
  <objectRelation></objectRelation>
  <!--
  @var string-->
  <objectLabel></objectLabel>
  <!--
  The table name of the middle-table of a nToM relation.

  @var string-->
  <objectRelationTable></objectRelationTable>
  <!--
  The object name of the cross-table of a nToM relation.

  @var string-->
  <objectRelationCrossObjectKey></objectRelationCrossObjectKey>
  <!--
  The virtualField name of the field in the foreign object pointing to us back.

  @var string-->
  <objectRefRelationName></objectRefRelationName>
  <!--
  onDelete cascade|setnull|restrict|none

  @var string-->
  <objectRelationOnDelete>cascade</objectRelationOnDelete>
  <!--
  onUpdate cascade|setnull|restrict|none

  @var string-->
  <objectRelationOnUpdate>cascade</objectRelationOnUpdate>
  <!--
  If the storage backend should also create a constraint so its not possible to pass a invalid reference id.

  @var bool-->
  <objectRelationWithConstraint>true</objectRelationWithConstraint>
  <!--
  The key of the field this is representing. Primarily for types 'predefined'.

  @internal
  @var string-->
  <field></field>
  <!--
  Not in use.

  @var string-->
  <layout></layout>
  <!--
  Whether this field is a attribute.

  @var boolean-->
  <attribute>false</attribute>
  <!--
  When defined, this field is hidden as long as the parent does not have the given value in `needValue`.
  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`.

  @var string|null-->
  <needValue></needValue>
  <!--
  Works only with `needValue`. A field id from another field.

  @var string|null-->
  <againstField></againstField>
  <!--
  The default/initial value.

  @var mixed|null-->
  <default></default>
  <!--
  If this field starts with a empty value (on initialisation). (Good fit for password fields)

  @var bool-->
  <startEmpty>false</startEmpty>
  <!--
  If this field returns the value even though it's the `default` value (in a form).

  @var bool-->
  <returnDefault>false</returnDefault>
  <!--
  If this field injects a `tr`+2x`td` instead of `div`.

  @var bool-->
  <tableItem></tableItem>
  <!--
  If this fields is disabled or not.

  @var bool-->
  <disabled>false</disabled>
  <!--
  If this fields contains a default wrapper div with title, description etc or only the input itself.

  @var bool-->
  <noWrapper>false</noWrapper>
  <!--
  Shows a little help icon and points to the given help id.

  @var string-->
  <help></help>
  <!--
  Width of a column.

  @var integer|string-->
  <width></width>
  <!--
  Width of the actual input element (input, select, textarea, etc)

  @var string|integer-->
  <inputWidth></inputWidth>
  <!--
  Width of the panel where the input is placed.

  @var string|integer-->
  <fieldWidth></fieldWidth>
  <!--
  @var Field[]-->
  <children></children>
  <!--
  @var Options-->
  <options></options>
  <!--
  @var string-->
  <customSave></customSave>
  <!--
  @var string-->
  <customGet></customGet>
  <!--
  @var bool-->
  <saveOnlyFilled>false</saveOnlyFilled>
  <!--
  If this is a virtual field or not. Virtual fields a technical implementation
  fields to keep for example arelation between object fields in sync or if a fieldType needs
  multiple fields to be able to store their data.

  Virtual fields are not exported to the configuration xml.

  @var boolean-->
  <virtual>false</virtual>
</field>

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