[[PageOutline(2-7, Table of Contents, floated)]]
== Ajax List ==

The Ajax List component of iPeer is responsible for creating lists from data. It is implemented as a Cake PHP component, and works with cake-like formated data.[[br]]
The advantages of Ajax Listinclude quick list control creation, with features default like filters, sorting, pagination, state retention, and search. The amount of initial set up is usually minimal. As Ajax List is a single component, any list-related bug in iPeer can be traced down to this component, and fixed. There are some mechanisms to extend the list's functionality, but moderate to highly custom features could require code modifications to Ajax List.

=== Requirements ===
 * For best results, PHP 5.2 is recommended.
  * PHP version bellow 5.2 should compile, and enable the PHP JSON plugin to achieve best performance.
  * A much slower version of JSON parce is included with iPeer, and will be used if the above is missing.
  * A session component is required to keep track of a list' state. Ajax List uses CakePHP's Session component.
  * If possible, the client's browser should leave the cookies enabled, so that Ajax List can keep track of what page number the client is on.

=== Files ===
Ajax List consists of 3 files.
 * {{{\app\controllers\components\ajax_list.php}}}
  * Holds the PHP side of Ajax List code.
  * Contains functions to initialize the list, creation of SQL queries, code to query the database for the data to be listed, converting data to JSON for Javascript client, and general list state management.
 * {{{\app\views\elements\list\ajaxList.tpl.php}}}
  * The elements that is inserted into the pages view where the list is to be created.
  * Passes the list data to the JS Ajax List component, making an initial ajax call unnecessary.
 * {{{\apps\webroot\js\ajaxList.js}}}
  * The JavaScript component Ajax List. Interprets the JSON, and renders the list as a table, along with the search control, and etc..

=== Manual ===


=== Example list ===
The following example demonstrates most of the features of Ajax List.