Follow

Code Templates - Features Comparison

The tables below shows the features available in each of the Standard code templates and the Enhanced code template.  In addition following the tables are details of the features in the Joomla! 3.x Test Data Generator code template, click here to go directly to that.

To provide an overview of the features provided by Component Architect, and which code templates these appear in, we have giving details below of the control settings which can be used in Component Architect to specify what is to be generated in a particular component/extension or object/table. The general principal in Component Architect is that any feature in a code template must always be selectable for inclusion in a component/extension or object table - hence the best way of showing the scope of features is to give the settings which may be selected. Naturally, these settings will change as new Joomla! or Component Architect developed features are introduced - for example we recently added the 'Include Microdata' option for Joomla! 3.3.

The one major extra feature in the Joomla! 3.x Enhanced code template, not shown below, is that it is backward compatible to Joomla! 2.5 (later than version 2.5.6) and all versions of Joomla! 3.x. This does not mean that new functionality added by Joomla! to 3.1 (e.g. tags) or 3.2 (version control) will work in the older releases of Joomla!. But they will not cause the component to fail. Any future development of the Enhanced code template or any derivative of it will maintain this backward compatability.

The Joomla! 3.x Test Data Generator code template is also backwards compatible to Joomla! 2.5.

Joomla! Parts

The Joomla! Parts settings are a set of controls which allow the developer to specify which parts of Joomla! (admin, site, plugins and modules) are to be generated for a component/extension. The value at the component/extension level will override that at the object/table level.

Note: If not set for the component/extension that part will not be generated irrespective of what is set for the object/table.

Feature 2.5 Standard 3.3 Standard 3.4 Standard 3.x Enhanced
Generate Admin        

You can select whether to generate an administrator area for your component or objects/tables in it. This may have only limited value at the moment as the component/extension structure requires an administrator area for it to function properly.

Generate Admin - Dashboard        

An administrator dashboard can be generated for a component to provide short cuts and also overviews of licence statements and updates.

Generate Admin - Help        

Administrator help files can be generated for a component. These provide help for both admin list and edit views plus menu parameters when creating a menu item.

Generate Site        

You can select whether to generate a site front end for your component or any object/table in it.

Generate Site - Views        

You can select whether to generate any site front end views for your component or any of its objects/tables. In the Enhanced code templates the default record view has been extended to provide for four different layouts of sections, they are plain, tabs, slider or switcher. These are selectable via a global, menu item or record level parameter.

Generate Site - Article Layout        

In Component Architect code templates, the default front end layout for an object/table is not an Article layout, it is more like a non-edit record layout. But an article layout is available in the code templates and can be selected to be generated for your objects/tables.

The article layout is based on the core Joomla! content article layouts.

Generate Site - Blog Layout        

In Component Architect code templates, the default front end layout for multiple records is not a Blog view, but a list view similar to the Admin list layout. But a blog layout is available in the code templates and can be selected to be generated for your objects/tables.

The blog layout is based on the core Joomla! content blog layouts.

Generate Site - Tree Layout        

A new layout which has been added to the Enhanced code templates is a Tree Layout.

The tree layout shows objects and their sub objects in a collapsible tree structure.

Generate Categories        

This will add categories functionality in the generated component/extension.

For Standard code templates, if Generate Categories is selected, then it will only ever be the components default object/table that will be linked to categories i.e. only one table can have categories. The Enhanced code templates may have multiple object/tables that have categories.

Generate Categories -Site Categories View        

You can select whether you wish to include a Categories view in your component. This is based on the categories view in the core Joomla! content component.

For this to be selected the Generate Categories, Generate Site and Generate Site Views options must also be selected.

Generate Categories - Site Category View        

You can select whether you wish to include a Category view in your component. This is based on the category view in the core Joomla! content component. In the Enhanced code templates this includes the capability to see multiple lists of objects/tables with records for that category.

For this to be selected the Generate Categories, Generate Site and Generate Site Views options must also be selected.

Generate Plugins        

A number of plugins are available in the code template packages. If you do not require them at all in your component or only for certain object/tables then you can use this setting to select an overall setting for the inclusion of plugins. If this is set you may still control whether to include individual plugins.

Generate Plugins - Finder        

This will generate a Finder (Smart Search) plugin for searching and an indexing plugin to index the records.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Item Navigation        

Any default or article view of a record may include Item Navigation buttons if this Item Navigation plugin is generated. Whether to display the Item Navigation buttons is also controlled by global, menu or record level configuration parameters.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Vote        

Any default or article view of a record may include a Voting section if this Vote plugin is generated. Whether to display the Voting section is also controlled by global, menu or record level configuration parameters.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Page Break        

Any default or article view of a record may include Page Break functionality if this Page Break plugin is generated.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Email Cloaking        

Where email addresses are used in description fields this plugin allows the automatic setting of these email address to be mailto links.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Load Module        

This plugin provides the functionality to let modules (selected by position, type or name) to appear within the description fields of items. This uses the loadposition and loadmodule tags as in the core Joomla content component.

For this to be selected the Generate Plugins option must also be selected.

Generate Plugins - Events        

This is generalised piece of code which creates skeleton functions for each of the valid object/table events (e.g. BeforeSave, AfterSave etc). This can be useful in quickly adding custom event code.

For this to be selected the Generate Plugins option must also be selected. The Events plugin is only available in the Enhanced code templates.

Generate Modules        

Currently only two modules can be generated - one at component level and one at object/table level. For the moment there is no sub-selection of these two modules but as more modules are added then this may change.

Joomla! Fields/Features

The Joomla! Fields/Features settings are a set of controls which allow the developer to specify the more detailed features and functionality to include in their components/extensions.

The settings will include not just the field in a table (there may be none) and form but also the standard code for how it is used within the core Joomla! components.

These settings differ from the Joomla! Parts settings in that the values set at the component/extension level can be over ruled by a setting for an object/table.

Feature 2.5 Standard 3.3 Standard 3.4 Standard 3.x Enhanced
Include Access        

You can select whether to include Joomla!'s legacy access control and associated code for objects/tables in the generated component/extension.

Include Alias        

You can select whether to include Joomla!'s 'alias' field and associated code for objects/tables in the generated component/extension.

This can only be set if 'Include Name' is also set.

Include Asset ACL        

You can select whether to include Joomla!'s ACL and associated code for objects/tables in the generated component/extension.

Include Asset ACL - Record Level        

You can select whether to include Joomla!'s ACL and associated code for record level access control for objects/tables in the generated component/extension.

This can only be set if 'Include Asset ACL' is also set.

Include Batch        

You can select whether to include Joomla!'s Batch functionality for objects/tables in the generated component/extension.

Include Cascade        

You can select whether to include a set of applicable cascade functions (i.e. some combination of publish, un-publish, archive, trash, delete and copy cascade functions) for objects/tables in the generated component/extension.

This includes functionality in the administrator area to view child records of an object in separate tabs within a record view and to also create new or edit those child records via a pop-up.

Cascade functionality is only provided in the Enhanced code templates.

Include Check In/Out        

You can select whether to include Joomla!'s 'checked_out' fields and associated check in/check out code for objects/tables in the generated component/extension.

Include Copy        

You can select whether to include a copy function for Components/Extensions. This will affect the copy functionality for Batch copy, Save and Copy, Cascade Copy and a Copy button.

This will only be used in code templates for Joomla! 2.5 and later.

Include Created        

You can select whether to include Joomla!'s 'created' and 'created by' fields and associated code for objects/tables in the generated component/extension.

Include Description        

You can select whether to include a 'description' field and associated code for objects/tables in the generated component/extension.

Include Hits        

You can select whether to include a standard Joomla! 'hits' field and associated code for objects/tables in the generated component/extension.

Include Image        

You can select whether to include a standard set of Joomla! image fields and associated code for objects/tables in the generated component/extension.

Include Image Thumbnail        

You can select whether to include a thumbnail field for Joomla! image fields and associated code for objects/tables in the generated component/extension. This can only be set if 'Include Image' is also set.

The generation of Image Thumbnails is only available in the Enhanced code templates.

Include Intro        

You can select whether to include an 'intro' field and associated code for objects/tables in the generated component/extension. This can only be set if 'Include Description' is also set.

In the Enhanced code templates this will work slightly differently from the intro field on articles/content and in the Standard code templates. In the Enhanced code templates the 'intro' will be able to be edited separately from the description. But if left empty will be auto-generated using the description and a read-more tag.

Include Language        

You can select whether to include a language fields and associated code for objects/tables in the generated component/extension.

Include Meta Data        

You can select whether to include a set of meta data fields and associated code for objects/tables in the generated component/extension.

Include Microdata        

You can select whether to include micro data mark-up of front end display output for objects/tables in the generated component/extension.

Include Modified        

You can select whether to include standard Joomla! 'modified' and modified by' fields and associated code for objects/tables in the generated component/extension.

Include Name        

You can select whether to include a name field and associated code for objects/tables in the generated component/extension.

Note: in Joomla! core components and most other components there is a mix of use of either 'title' or 'name' as being the short descriptor field for a record. It was decided to use for this but plan in later enhancements to Component Architect and code templates to allow a choice for this.

 

Include Nested        

You can select whether to include the fields for object/tables in the generated component/extension for it to be a nested table and the associated code to display and manage the nested records.

Include Ordering        

You can select whether to include an ordering field and associated code for objects/tables in the generated component/extension.

Enhanced code templates also provide for an ordering field in the site front end list view.

Include Params Global        

You can select whether to include global component level params and associated code for objects/tables in the generated component/extension.

Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.

Include Params Menu        

You can select whether to include global menu item level params and associated code for objects/tables in the generated component/extension.

Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.

Include Params Record        

You can select whether to include data record level params and associated code for object/tables in the generated component/extension.

Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.

Include Published Dates        

You can select whether to include standard Joomla! 'publish up' and 'published down' date fields and associated code for objects/tables in the generated component/extension.

Include Status        

You can select whether to include standard Joomla! 'state' field and associated code for objects/tables in the generated component/extension.

This is used to set the status of the record e.g. Unpublished, Published, Trashed or Archived. The end user sees this as 'status' or 'published' but internally this uses the database field called 'state'.

Include Status Archived        

This is used to allow the setting the status of the record to Archived for objects/tables in the generated component/extension. This can only be set if 'Include Status' is also set.

To have a full Joomla! Status functionality this, the Include Published and Include Trash must all be set.

Include Status Published        

This is used to allow the setting the status of the record to Published or Unpublished for objects/tables in the generated component/extension. This can only be set if 'Include Status' is also set.

To have a full Joomla! Status functionality this, the Include Archived and Include Trash must all be set.

Include Status Trash        

This is used to allow the setting the status of the record to Trash for objects/tables in the generated component/extension. This can only be set if 'Include Status' is also set.

To have a full Joomla! Status functionality this, the Include Published and Include Archived must all be set.

Include Tags        

You can select whether to include tags functionality for objects/tables in the generated component/extension. Note in Joomla! tags are not held in the Object/Table but in a separate joomla table which links content to tags.

Include Urls        

You can select whether to include a standard set of 3 url links and associated code for objects/tables in the generated component/extension.

Include Versions        

You can select whether to include versions functionality for objects/tables in the generated component/extension. Note in Joomla! version history are not held in the Object/Table but in a separate joomla table which links content to version history. A latest version field is defined in the Object/Table.

 

Joomla! 3.x Test Data Generator

The Test Data Generator code template is not designed to be used as a basis for a Joomla! component that you wish to distribute.  It is the first of a set of code templates which will provide tools to aid the testing and development of your distributable Joomla! extensions.  These code templates will only be available to those users with a Professional subscription.  The following functionality is included:

  •  Creation of Test Object records for each object/table in your component definition
  •  Modification of the Test Object generation parameters
  •  Support for none, set value, random or incremental values to be generated for each field
  •  Support for all Joomla! field types
  •  Support for Nested Tables
  •  Vary number of records to be generated for each Test Object
  •  Select to generate Menu Items for all front end menu xml files
  •  Select to remove existing records or not (if remove then previously generated Menu Items will also be removed)
  •  Select whether to log the actions taken for later viewing
  •  Auto generation of records for each Test Object and generation of multiple menu items
  •  View logs option
  •  Backwards compatibility to Joomla! 2.5

To set-up test data and menu items follow this process:

  •  Use the Joomla! 3.x Standard or Joomla! 3.x Enhanced and your component/extension definition to create a component install file.  
  •  Install the component in a Joomla! 3.x or 2.5 site.
  •  Then use the Joomla! 3.x Test Data Generator code template with the component/extension definition to create a test data component.
  •  Install this in the Joomla! 3.x or 2.5.

Once the test data component is installed on your site you can access the administrator area and go to the test data component.  You can use this to generator records for the tables in your component and, if requested, automatically create menu items for creates, lists, blogs, articles and items for the records in the tables.  The test data generator can be used repeatedly to generate as wide a range of records as you require.   You can vary the values that will be generated for each field just by changing the parameters of the appropriate test object in the Test Data Generator component.   The field parameters can be specified to provide random, fixed, incremental or default values for each field in each table of your component.

We use cookies to improve our website and your experience when using it. Cookies used for the essential operation of the site have already been set. To find out more about the cookies we use and how to delete them, see our Use of cookies.

I accept cookies from this site.

AboutCookies.org