Grouping attributes

ATK Howto: Grouping attributes Complexity: easy Author: Sandy Pleyte <sandy at achievo.org>

List of other Howto's

Requirements

ATK 6.2+

Summary

In a node it's possible to group attributes for an edit form on 2 ways. With a group and a section.

Sections will create a node level tabbed pane. For tabs as an attribute. See: Grouping attributes into tabs

Groups

addGroup() has been depreciated. "The addFieldSet() function was introduced to ATK on June 11, 2008. Prior to this the addGroup() function was used, but subsequently dropped from the core of ATK due to compatibility issues." See: Grouping attributes with addFieldSet

Groups are a list of attributes that will be placed on 1 line with or without a border (html fieldset). Every group that you create will always appear on top of the other attributes!

Syntax:

$this->addGroup("groupname",array("attrib1","attrib2"),<border>,"tab");

in your node file use the following line to group two attributes with a surrounding box on the main tab:

$this->addGroup("users",array("user_lastvisit","user_regdate"),TRUE,"main");

and this to group two attributes without a surrounding box on the details tab:

$this->addGroup("dates",array("user_level","user_posts"),FALSE,"details");

Note: Groups only work with the steelblue theme at the moment!

Sections

Groups a list with attributes on multiple lines which are collapsed by default. When you open a section it will retrieve the attributes with ajax. Sections always appear at the bottom.

Syntax:

$this->add(new atkAttribute('test'),'default.section');

In your node file use the following line to add an acttribute to the section 'address':

$this->add(new atkNumberAttribute('housenumber'), 'default.address');
$this->add(new atkAttribute('housenumber_suffix'), 'default.address');

The convention is: <tabname>.<sectionname>, in other words, the above places the attributes in the 'address' section of the default tab. Accepted notations:

• ".address" - Put attribute in the address section if there are no tabs, or on the default tab
• "billing" - Put attribute on the address tab
• "billing.address" - Put attribute in the address section of the billing tab