ATK Reference: Difference between revisions

Latest revision as of 03:55, 21 December 2015

This part of the wiki aims to provide high level documentation on every part of ATK.
For further detailed information about the objects/methods and functions of ATK, please visit the ATK API documentation.

Reference categories

Modules

ATK is a modular framework and as such all functionality in ATK applications reside in modules.

Attributes

A node is built with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.

Actions

In order to use a node ATK uses 'actions', these include but are not limited to CRUD functions of a database (corresponding to the Add, View, Update and Delete actions in ATK).

User Interface

ATK posesses several methods of output handling and automated generating of a UI.

Testing

ATK uses and extends the SimpleTest Testing framework for Test driven development and also supports PHPUnit.

Database connections

Information about database connections in ATK.

Internationalization

ATK fully supports the creation of multi-lingual applications.

Nodes

A node is comparable to a table in a database, which groups certain data elements in one collection.
An ATK node provides all the functionality for one such collection.

Relations

To associate nodes with eachother ATK makes use of Relations, these are comparable to relations in ERDs (one-to-one, one-to-many, etc.).

Meta functionality

ATK supports on-the-fly generation of nodes and attributes by using the metadata of your database. A very powerfull tool for quick development of web applications on an existing database.

Utilities

ATK provides various objects and functions for performing common tasks like traversing a directory, parsing stringings, debugging, etc.

Security

ATK supports various methods of authentication (users) and authorisation (privileges).

Sessions

ATK has advanced session handling methods for remembering and application data.

Configuration

ATK Configuration Options V8

(OLD ATK has many configuration options. OLD)

@@ Line 1: / Line 1: @@
-<div align=right style="float: right; padding: 20px;">__TOC__</div>
+<div align=right style="float: right; padding: 20px; padding-top: 100px;">__TOC__</div>
+This part of the wiki aims to provide high level documentation on every part of ATK.<br />
+For further detailed information about the objects/methods and functions of ATK, please visit the [http://www.atk-framework.com/docs/atk/trunk/ ATK API documentation].
-== Introduction ==
+== Reference categories ==
-This part of the wiki is intended to supply a complete reference to every part of ATK.<br />
-It aims to provide high level documentation on every part of ATK.<br />
-For further detailed information about the objects/methods and functions of ATK, please visit the [http://achievo.org/docs/atk/latest/ ATK API documentation].
-== References categories ==
 {|
 |-
 | valign="top" |
-=== [[ATK Reference Modules|Modules]] ===
+=== [[ATK Module|Modules]] ===
+ATK is a modular framework and as such all functionality in ATK applications reside in modules.
+=== [[ATK Attributes|Attributes]] ===
+A node is built with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.
-ATK is a modular framework and as such all functionality in ATK applications reside in modules.<br />
+=== [[ATK Actions|Actions]] ===
-This category lists everything about modularity.
+In order to use a node ATK uses 'actions', these include but are not limited to [http://en.wikipedia.org/wiki/CRUD_(acronym) CRUD] functions of a database (corresponding to the Add, View, Update and Delete actions in ATK).
-<!--An [[example module.inc file]] [[Module Flags]] -->
-=== [[ATK Reference Attributes|Attributes]] ===
+=== [[ATK UI|User Interface]] ===
+ATK posesses several methods of output handling and automated generating of a UI.
-A node is build with attributes. Attributes are comparable to datatypes of fields in the database. They describe the content and house all functionality for dealing with that content.
+=== [[ATK Testing|Testing]] ===
-<--[[List of attributes]][[Attribute Flags]][[Attribute-level Security]]-->
+ATK uses and extends the [http://www.simpletest.org SimpleTest Testing framework] for [http://en.wikipedia.org/wiki/Test_driven_development Test driven development] and also supports [http://www.phpunit.de/ PHPUnit].
-=== [[ATK Reference Actions|Actions]] ===
+===[[ATK Database connections|Database connections]]===
+Information about database connections in ATK.
-=== [[ATK Reference GUI|Graphical User Interface]] ===
+=== [[ATK Internationalization|Internationalization]] ===
+ATK fully supports the creation of multi-lingual applications.
+| valign="top" |
+=== [[ATK Nodes|Nodes]] ===
+A node is comparable to a table in a database, which groups certain data elements in one collection.<br />
+An ATK node provides all the functionality for one such collection.
-=== [[ATK Reference Testing|Testing]] ===
+=== [[ATK Relations|Relations]] ===
+To associate nodes with eachother ATK makes use of Relations, these are comparable to relations in [http://en.wikipedia.org/wiki/ERD ERDs] (one-to-one, one-to-many, etc.).
-| valign="top" |
+=== [[ATK Meta|Meta functionality]] ===
-=== [[ATK Reference Nodes|Nodes]] ===
+ATK supports on-the-fly generation of nodes and attributes by using the metadata of your database. A very powerfull tool for quick development of web applications on an existing database.
+=== [[ATK Utilities|Utilities]] ===
+ATK provides various objects and functions for performing common tasks like traversing a directory, parsing stringings, debugging, etc.
-A node is comparable to a table in a database, which groups certain data elements in one collection.<br />
+=== [[ATK Security|Security]] ===
-An ATK node provides all the functionality for one data collection.
+ATK supports various methods of authentication (users) and authorisation (privileges).
-<!--A module consists of one or more nodes. ATK knows 3 node types: [[atkNode]], [[atkTreeNode]] and [[atkMetaNode]]
+===[[ATK Sessions|Sessions]]===
+ATK has advanced session handling methods for remembering and application data.
-An [[ExampleNode]] file.
+===[[ATK Configuration|Configuration]]===
-[[Node Flags]]
+[[ATK Configuration Options V8]]
-[[atkMetaNode]]
+(OLD ATK has many configuration options. OLD)
-[[Magic methods]]-->
-=== [[ATK Reference Relations|Relations]] ===
+|}
+== Miscellaneous References ==
+===[[ATK Constants|Constants and Flags]]===
-General explanation of [[relations]] in atk.
+Various FLAGS used by ATK, including [[Module Flags V8|Module Flags ATK V8+]], [[Node Flags V8|Node Flags ATK V8+]], [[Attribute Flags V8|Attribute Flags ATK V8+]] and [[Relation Flags V8|Relation Flags ATK V8+]]
-=== [[ATK Reference Meta|Meta functionality]] ===
+(OLD Various constants and [[flags]] used by ATK, including [[Attribute Flags]], [[Node Flags]], [[Relation Flags]] and [[Module Flags]] OLD)
-=== [[ATK Reference Utilities|Utilities]] ===
+=== [[ATK Extensions|Extensions in ATK]] ===
+Various 'extensions' in ATK, other Open Source software that is included in ATK.
-=== [[ATK Reference Security|Security]] ===
+=== [[Patches]] ===
+Do you have a contribution for the ATK framework? This page explains how to contribute them.
-|}
+=== [[Coding Guidelines]] ===
-== References ==
+If you develop for Achievo, ATK, please stick to these guidelines.
+=== [[ATK Debugging|Debugging]] ===
+When you have a problem, you might want to debug your application
-[[Available Open Source software in ATK]]<br />
+__NOEDITSECTION__
-[[Constants]]<br />
-[[ATK Reference Database connections|Database connections]]<br />
-[[ATK Reference Sessions|Sessions]]<br />
-<!--Application state is remembered in sessions.<br />
-[[SessionVariables]]<br />-->