Fields ImageField New/Edit Help

Each attribute of a table or a property of an object is defined as a Field within a Fieldset and an Object/Table. The field will be one of a set of pre-defined Field Types. Currently all of the Joomla field types are supported and further field types will be added as required.

Fields may also be contained in other fields i.e. Registry/JSON type fields. To do this first define the field into which other fields are stored with a field type of 'Registry'. Then as you define the other fields you can specify a link to the registry field.

Some predefined fields are automatically generated based on the feature and functionality settings in an object/table.

You can use the following links to jump to a section of this help page:

Screenshot

Field - Screenshot

Toolbar Buttons

Field - Toolbar

Save

Save the Field record and continue editing it.

Save & Close

Save the Field record and return to the Fields list page.

Save & New

Save the Field record and then clear the edit form for a new record.

Save as Copy

Save the Field record as a new copy of the record displayed.

Close

Close the edit form without saving and return to the list.

Help

Link to display the Help system.
Top

Headline Details

Field - Headline Details

Name

Enter a name for the field. This is the visible name of the field. This will also be the label used for the field in views.

Only alphanumeric, space and \ / & + - _ ( ) are allowed - this prevents problems in generated code.

Text
Top

Basic Details

Field - Basic Details

Description

Enter a description for the field.
Editor

Code Name

The variable name used in code for a field. This field is auto_generated from the field name and can be changed. No spaces or punctuation marks (except underscore _) are allowed, the value must be unique within a component object and start with a letter.

text

Component/Extension

Select the Component/Extension that this field is part of.

modal_components

Object/Table

Select the Object/Table that this field is part of.

modal_componentobjects

Fieldset

Select the fieldset that this field is part of.

modal_fieldsets

Pre-defined

Flag set to indicate whether this field is pre-defined or not. As pre-defined fields are auto-created this field is read-only. Some templates are marked-up to handle the Include Joomla! Features flags without reference to a defined Field, others may use the pre-defined Fields to implement the Joomla! Feature.

list

Field Type

Select the field type for this field.

For information on the pre-defined Field Types see the Installed Field Types help page

modal_fieldtypes

Required

Select whether this field is mandatory field and something must be entered for it before the record can be saved.

checkbox

Filter

Set this if the field is to be included as a Filter field on the Admin and Site list views for the Component Objects. If the filter is also set as an Order field this will determine how ordering will work.

checkbox

Order

Set this if the field is to be included as an Order field on the Admin and Site list views for the Component Objects. The field must also be set as a Filter in order for ordering to work.

checkbox

Search

Select whether this field will be searchable or not.

checkbox

Read Only

Select whether this field is to be displayed as 'read only' or not.

checkbox

Disabled

Select whether this field is to be displayed as 'disabled' or not.

checkbox

Hidden

Select whether this field is to be displayed on a form or will be hidden.

checkbox

Ordering

The ordering of field.
Ordering List

ID

The ID of the displayed field.
Text - read only
Top

Field Specific Attributes

A set of fields that are attributes that are set for a specific Field.

Field - Field Specific Attributes

Validate

Select whether this field needs to be validated

checkbox

Validation Type

Select the validation type for this Field. If 'custom' selected then enter the value in the allowed input field.

list

Allowed Input

This specifies the reqex code to be used for a field which has a validation type of 'custom'. It may be left blank even if the 'custom' validation type is selected but if no validation rule is written for the field all input will be accepted.

text

Custom Error Message

This specifies a custom error message which will be output if the field validation fails. It may be left blank even if the 'custom' validation type is selected and a standard Joomla! message of 'Invalid field: Field Name' will be displayed if validation fails.

text

Registry Field

Select the registry field that this field will be contained within. For fields that are in a registry field (i.e. JSON field) then the field which is the container for the entry must be specified.

modal_fields

PHP Variable Type

Select the variable type used in PHP code for this field.

list

Default

Specify a default value for the field.

For 'string' type fields this should be a value enclosed in single quotes or if blank is default just two single quotes. Numeric fields should just have a number without quotes e.g for foreign key fields a simple 0 with no quotes.

text
Top

Field Type Specific Attributes

A set of fields on a Field record that are specific to a Field Type.

Field - Field Type Specific Attributes

Class

Specify the class to be used for this field. Field types when selected will populate a standard class for the Field Type. This may be changed or added to. NB separate classes with a space.

text

Size

Specify the size attribute for the field. This works differently on fields of different field types e.g. for text fields it determines the width of the input box but for lists it determines the number of entries to be shown before scrolling is required.

text

Max Length

Specify the maximum length for input into this field. This should match the MYSQL Size value or at least be less than that otherwise data will be truncated on saving.

text

Width

Specify the width (as '%' or 'px') to be used for displaying an editor box.

text

Height

Specify the height (as '%' or 'px') to be used for displaying an editor box.

text

Columns

Specify the number of columns (i.e. the width) to be used for displaying an editor box or text area.

text

Rows

Specify the number of rows (i.e. the height) to be used for displaying an editor box or text area.

text

Field Value Source

For lists, checkboxes and radio buttons specify the source of the values to be used as options. Custom values can be taken specified as being in the Option Values field or the Field Values table linked by the field id. Also sets of constant variables could be selected e.g countries or currencies. These are stored as Value Sets in the Field Values table. Can only be changed in the Pro version of Component Architect Generator

list

Option Values

Specify the keys and values to be used in options for this field. If the Field Value Source is set to 'Custom values' then the values entered in the rows here will be used to generate option values for this field and language variables for the labels.

Enter into the Value cell the value to be stored on the database and into the Text displayed cell the value to be visible to the end user. The Text displayed value will normally be used to generate a language variable and associated text. However, if it is set to some value which is all in capitals and begins with 'J' then no language variables will be generated as this will be treated as a standard Joomla! language variable such as JNONE, JYES, JNO etc. It is the developer's responsibility to ensure they use valid Joomla! Language Variables.

textarea

Multiple

Select whether this field (list, checkboxes, radios etc.) will allow the selection of multiple values.

checkbox

Format

Specify a display format for a field. Generally used only for the display of date/time fields. Must be set to a valid php format value.

text

First Number

Specify the first number to be used in a field of type 'integer'.

text

Last Number

Specify the last number to be used in a field of type 'integer'.

text

Step

Specify the step between numbers to be used in a field of type 'integer'.

text

Hide None Option

Select whether the 'hide none' option will be displayed on this field. This is for fields of type (folder list, file list and image list).

checkbox

Hide Use Default Option

Select whether the 'hide default' option will be displayed on this field. This is for fields of type (folder list, file list and image list).

checkbox

Buttons

Specify the buttons to be displayed with an editor box. Default is set to '*' i.e. all defined buttons

text

Hide Buttons

Specify the buttons to be hidden when displaying an editor box.

text

Foreign Object

Select the component object (i.e. table) that this field will link to.

modal_componentobjects

Field Filter

Select the field filter to be used for this field.

list

Max File Size

Specify the maximum file size (in KB) for a file that can be uploaded.

text

Exclude files

A regex value which is matched against file names and if a match is found the file is from a file list. With the correct regex this can be used to prevent file types or even specific files appearing. In the simplest case this can just be a file name e.g. 'index.html' or a single file type e.g. '.exe'.

text

Accept file types

Specify the types of fields to be accepted for a file dialog e.g. .php, .txt, .png etc. Each file type must be prefixed with a '.' and separated by a comma.

text

Start Directory

Specify the directory from which to start showing a file, folder or image list for this field.

text

Link URL

Specify the link web address/url to be used for this field when it is displayed.

url

SQL Query

Enter the SQL Query which will be used to retrieve the data to be used in the select list.

textarea

SQL Key Field

Specify the table field name from the SQL Query to be used for the 'key' part of the options in the select list.

text

SQL Value Field

Specify the table field name from the SQL Query to be used for the 'value' part of the options in the select list.

text

Translate

Specify whether to translate the provided SQL Query Value by using JText and the applicable ini translation file.

checkbox

Client

Specify whether the language setting is for the Site or Administrator client.

list

Strip Extension

Specify whether to remove the file extension from the displayed files.

checkbox

Media Preview

Specify how to display previews of media files.

list

Auto Complete

Specify whether a password field will be completed automatically on entry of a valid username.

list

On Click

Specify the javascript code or a url to be linked to when the 'on click' event for this field is triggered.

textarea

On Change

Specify the javascript code or a url to be linked to when the 'on change' event for this field is triggered.

textarea
Top

Field MySQL Settings

A fieldset for the mysql settings required for a Field. The default values are set for the Field Type.

Field - Field MySQL Settings

MySQL Data Type

Specify the mysql data type for this field. It can be set to blank when a field is a registry entry which is to be held in a registry/json field on the database.

list

MySQL Size

Specify the size of the field on the MYSQL table.

text

MySQL Default

Specify the default value to be used for the field on the MYSQL database. The value must be enclosed in single quotes.

text
Top

Publishing Options

Field - Publishing

Created By

Select the user that is to be shown as creating the field. If none selected on create then the current logged in user will be used.
Calendar

Created By Alias

Enter an alias for the user that is to be shown as creating the field.
Text

Created Date

Field created date. This can be changed if required.
Calendar

Modified Date

Field last modified date. This cannot be changed.
Text - protected

Modified By

The user that last modifed the Field record. This cannot be changed.
Text - protected
Top