NusaATK - User contributions [en]

ATK 101

2006-02-08T14:40:08Z

82.176.175.208: /* Misc Tips */

== General Documentation ==

[[InstallationGuide]]

[[atkMetaNode]]

[[System Requirements]]

== Modules ==

An ATK Application consists of one or more modules.

A [[CompleteModuleFile]]

== Nodes ==

A module consists of one or more nodes. ATK knows 3 node types: [[atkNode]], [[atkTreeNode]] and [[atkMetaNode]]

An [[ExampleNode]] file.

[[NodeFlags]]

== Attributes ==

A node is build with attributes.

[[AttributesExplained]]

[[AttributeFlags]]

[[AttributeLevelSecurity]]

== Sessions ==

Application state is remembered in sessions.

[[SessionVariables]]

== Advanced techniques ==

[[Polymorphism]]

== Misc Tips ==

[[OrderingAttributesWithinANode]]<br />
[[SmartDebug]]<br />
[[Handy features]]

ATK 101

2006-02-08T14:39:56Z

82.176.175.208: /* Misc Tips */

ATK Flags

2006-02-06T16:27:43Z

82.176.175.208:

Flags can change the behaviour of your node or attribute. Checkout the following sections for more information about these flags:

* [[AttributeFlags]]
* [[NodeFlags]]

ATK

2006-02-06T16:25:30Z

82.176.175.208: /* Attributes */

== [[ATK 101]] ==
Add tutorials here, lessons, explaination. Everything people might want to know when they start working with ATK.

ATK Flags

2006-02-03T16:35:51Z

82.176.175.208:

Flags can change the behaviour of your node or attribute. Checkout the following sections for more information about these flags:

* [[Attribute Flags]]
* [[Node Flags]]

AtkBoolAttribute

2006-02-03T16:34:25Z

82.176.175.208:

=== Description ===
The atkBoolAttribute is used for 'yes or no' fields. Depending on your database it uses a boolean field or a textfield of 1 character length.

=== Params ===
The constructor of the atkBoolAttribute has the following params:
atkBoolAttribute($name, $flags=0)

* name String
Name of the attribute (the same as the fieldname used in the database)
* flags (optional) int
Flags for the attribute. For more information about flags, please checkout the [[flags]] section.

=== Examples ===
(in a [[node]] constructor):

$this->add(new atkBoolAttribute("receive_mailinglist"));
Adds a field 'receive_mailinglist' to the node. In the admin this will be displayed as a yes/no selection with the possibility to not select any value.

$this->add(new atkBoolAttribute("receive_mailinglist",AF_OBLIGATORY));
The same, but the field is obligatory.

AtkAttribute

2006-02-03T16:34:07Z

82.176.175.208:

=== Description ===
The atkAttribute is the most basic attribute that exists. It can be used to represent a basic textfield (varchar/string) in the database.

=== Params ===
The constructor of the atkAttribute has the following params:
atkAttribute($name, $flags = 0, $size = 0)

* name String
Name of the attribute (unique within a node, and for most attributes, corresponds to a field in the database.
* flags (optional) int
Flags for the attribute. For more information about flags, please checkout the [[flags]] section.
* size (optional) mixed
The max. number of characters that can be entered. If not specified, or set to 0, the max. size is automatically
retrieved from the table metadata.

By default, the size of the edit box is the same as the maximum
number of chars that can be entered (as long as it fits on
screen). You can however pass an array of 2 or 3 numbers instead
of a single number. In this case, the array is interpreted as
follows:
- $size[0] - The maximum size that can be entered
- $size[1] - The size of the input box in add/edit forms
- $size[2] - The size of the search box

If $size[2] is not specified, $size[1] will be used instead.
If $size[1] is not specified, or the passed value is not an
array, all 3 sizes will default to the first value.

Note: The sizes that are actually used depend both on the
specified size and the size of the field in the database.
Usually, these are the same. In the case they differ, the
smallest of the 2 will be used.

=== Examples ===
(in a [[node]] constructor):

$this->add(new atkAttribute("firstname"));
Adds a field 'firstname' to the node

$this->add(new atkAttribute("firstname",AF_OBLIGATORY|AF_HIDE_LIST));
Does the same, but mades the field required to fill in and hides it's value in the list

$this->add(new atkAttribute("firstname",AF_OBLIGATORY|AF_HIDE_LIST,10));
Makes the maximum input for the field 10 characters, even when the database field is larger

AtkBoolAttribute

2006-02-03T16:33:32Z

82.176.175.208:

=== Description ===
The atkBoolAttribute is used for 'yes or no' fields. Depending on your database it uses a boolean field or a textfield of 1 character length.

=== Params ===
The constructor of the atkBoolAttribute has the following params:
atkBoolAttribute($name, $flags=0)

* name String
Name of the attribute (the same as the fieldname used in the database)
* flags (optional) int
Flags for the attribute.

=== Examples ===
(in a [[node]] constructor):

$this->add(new atkBoolAttribute("receive_mailinglist"));
Adds a field 'receive_mailinglist' to the node. In the admin this will be displayed as a yes/no selection with the possibility to not select any value.

$this->add(new atkBoolAttribute("receive_mailinglist",AF_OBLIGATORY));
The same, but the field is obligatory.

For more information about flags, please checkout the [[flags]] section.