AtkBoolAttribute: Difference between revisions

Latest revision as of 17:23, 19 December 2007

Attribute: atkBoolAttribute

API docs | Flags

The atkBoolAttribute is used for 'yes or no' fields. Depending on your database it uses a boolean field, tinyint 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) Integer

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.

@@ Line 1: / Line 1: @@
-=== Description ===
+{{attribute}}
-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 '''atkBoolAttribute''' is used for 'yes or no' fields. Depending on your database it uses a boolean field, tinyint or a textfield of 1 character length.
+== Params ==
 The constructor of the atkBoolAttribute has the following params:
-atkBoolAttribute($name, $flags=0)
+ atkBoolAttribute($name, $flags=0)
-* name String
+* '''name''' ''String''
- Name of the attribute (the same as the fieldname used in the database)
+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 ===
+* '''flags''' (optional) ''Integer''
+Flags for the attribute. For more information about flags, please checkout the [[flags]] section.
+== Examples ==
 (in a [[node]] constructor):
@@ Line 19: / Line 21: @@
   $this->add(new atkBoolAttribute("receive_mailinglist",AF_OBLIGATORY));
 The same, but the field is obligatory.
+[[Category:Attributes]]