AdminLists - Revision history

Dirk: Typo

2009-05-25T11:51:53Z

Typo

Dirk: Fixed formatting and added category

2009-05-06T08:30:09Z

Fixed formatting and added category

LWC: /* Aditional Form Fields */ ' is really "

2008-12-08T13:29:30Z

‎Aditional Form Fields: ' is really "

LWC: /* Aditional Form Fields */ = is really =>

2008-12-08T13:22:04Z

‎Aditional Form Fields: = is really =>

Tokyoahead: /* The Data */

2007-08-23T06:26:34Z

‎The Data

Tokyoahead: /* Aditional Form Fields */

2007-08-23T06:06:05Z

‎Aditional Form Fields

Tokyoahead: /* Aditional Form Fields */

2007-08-23T05:52:52Z

‎Aditional Form Fields

Tokyoahead at 10:24, 1 March 2007

2007-03-01T10:24:25Z

Tokyoahead at 10:12, 1 March 2007

2007-03-01T10:12:43Z

Tokyoahead at 10:08, 1 March 2007

2007-03-01T10:08:25Z

@@ Line 81: / Line 81: @@
 The next array is called $form_arr and is optional:
-=== Aditional Form Fields ===
+=== Additional Form Fields ===
 <pre>

@@ Line 1: / Line 1: @@
 == Introduction ==
 Geeklog 1.4 has an engine to create tables/lists from data. This engine can be used to make sure that all tabular information looks similar all over the site. It is also helpful to reduce the amount of code that has to be written for a table, including template files.
@@ Line 7: / Line 8: @@
 == Simple Lists ==
 === The header ===
 The first element of a list is the header, the line where you can read what the information below represents. To define those use an array, each of the elements of the array define one column:
@@ Line 26: / Line 29: @@
 );
 </pre>
 You can see that you need to create a multi-dimensional array with several fields, most of which are optional. Required are the first two.
 <table border="1">
 <tr><th>Field/Array Name</th><th>Content</th><th>Data Type</th><th>Required</th></tr>
@@ Line 34: / Line 39: @@
 <tr><td>field_class</td><td>The CSS class that should be assigned to the data fields below</td><td>string</td><td>No</td></tr>
 </table>
 === Text fields & Settings ===
 Then, you need a text-array, defining some other details of the table:
@@ Line 43: / Line 50: @@
 );
 </pre>
 <table border="1">
 <tr><th>Field/Array Name</th><th>Content</th><th>Data Type</th><th>Required</th></tr>
@@ Line 49: / Line 57: @@
 <tr><td>help_url</td><td>The url that shows help for the block</td><td>string</td><td>No</td></tr>
 <tr><td>form_url</td><td>The form used in case the menu is there</td><td>string</td><td>if has_menu=true</td></tr>
-<tr><td>icon</th><td>An Icon to be displayed</td><td>string</th><td>No</td></tr>
+<tr><td>icon</td><td>An Icon to be displayed</td><td>string</td><td>No</td></tr>
 <tr><td>instructions</td><td>Some text to explain how the table works. This only shows if has_menu = true</td><td>string</td><td>no</td></tr>
 <tr><td>no_data</td><td>The string that is shown in case the table is empty. If this is not given, $LANG_ADMIN['no_results'] is shown</td><td>string</td><td>No</td></tr>
@@ Line 55: / Line 63: @@
 === The Menu ===
 In case the $text_arr stats has_menu = true, you need to give the following array for the menu details:
 <pre>
@@ Line 71: / Line 80: @@
 This pretty straight-forward Array gives a text to display and a url to link for each desired menu item.
 The next array is called $form_arr and is optional:
 === Aditional Form Fields ===
 <pre>
 $form_arr = array(
@@ Line 78: / Line 89: @@
 );
 </pre>
 This optional array allows you to display additional information above and below the table, specifically for form elements such as extra buttons, dropdowns, explanatory texts etc, since the tables have a form around them. Please take a look at the templates under /layout/professional/admin/lists/list.thtml to understand what you can do with them. Those forms are used for example in moderation.php.
 === The Data ===
 The actual data is given through an array that holds one element for each cell.
 <pre>
 $data_arr = array();
@@ Line 89: / Line 103: @@
 );
 </pre>
-This would create one line in the table. You can extend the array as you whish, but each field must match the fields given as 'field' the $header_arr().
 === Manipulating data during display ===
@@ Line 96: / Line 111: @@
 For this, you can name a function and include the name in the call of the list. You could of course process the data beforehand. This function allows you however to skip the iteration of each field in the array. You simply define the rules and the list-creator does all for you. The function will be called for each single field in the array.
-<pre>
+<pre>$fieldfunction = "plugin_getListField_mypluginname";</pre>
 $fieldfunction = "plugin_getListField_mypluginname";
 Then, you write a plugin function and name it as before, the function variables MUST be the same as below:
 <pre>
 /**
@@ Line 150: / Line 165: @@
 === Calling the function ===
 You can call the function as follows:
-<pre>
+<pre>echo ADMIN_simpleList($fieldfunction, $header_arr, $text_arr, $data_arr, $menu_arr, $options, $form_arr);</pre>
 echo ADMIN_simpleList($fieldfunction, $header_arr, $text_arr, $data_arr, $menu_arr, $options, $form_arr);
 The returned HTML will include the full list with all the options that you selected before.
 ... To be continued

@@ Line 74: / Line 74: @@
 <pre>
 $form_arr = array(
-     'top' => '<input type='hidden' name='text' value='text'>',
+     'top' => '<input type="hidden" name="text" value="text">',
-     'bottom' => '<input type='hidden' name='text' value='text'>'
+     'bottom' => '<input type="hidden" name="text" value="text">'
 );
 </pre>

@@ Line 74: / Line 74: @@
 <pre>
 $form_arr = array(
-     'top' = '<input type='hidden' name='text' value='text'>',
+     'top' => '<input type='hidden' name='text' value='text'>',
-     'bottom' = '<input type='hidden' name='text' value='text'>'
+     'bottom' => '<input type='hidden' name='text' value='text'>'
 );
 </pre>

@@ Line 90: / Line 90: @@
 </pre>
 This would create one line in the table. You can extend the array as you whish, but each field must match the fields given as 'field' the $header_arr().
 ... To be continued

@@ Line 78: / Line 78: @@
 );
 </pre>
-This optional array allows you to display additional information above and below the table, specifically for form elements such as extra buttons etc. The tables have a form around them. Please take a look at the templates under /layout/professional/admin/lists/ to understand what you can do with them. Those forms are used for example in moderation.php
+This optional array allows you to display additional information above and below the table, specifically for form elements such as extra buttons etc. The tables have a form around them. Please take a look at the templates under /layout/professional/admin/lists/ to understand what you can do with them. Those forms are used for example in moderation.php.
 === The Data ===

← Older revision		Revision as of 10:24, 1 March 2007
Line 90:		Line 90:
	</pre>		</pre>
	This would create one line in the table. You can extend the array as you whish, but each field must match the fields given as 'field' the $header_arr().		This would create one line in the table. You can extend the array as you whish, but each field must match the fields given as 'field' the $header_arr().
		+
		+
		+	... To be continued

@@ Line 2: / Line 2: @@
 Geeklog 1.4 has an engine to create tables/lists from data. This engine can be used to make sure that all tabular information looks similar all over the site. It is also helpful to reduce the amount of code that has to be written for a table, including template files.
-To use this function, you have to choose between two main differences: Simple & Complex lists. The main difference is that the simple lists need an array of data and the complex lists need an SQL string of data. So if you do not have your data in a database table, you will need to use a simple list. Also, the simple lists only can be displayed several times on a page (such as used on the moderation and statistics screens). This guide will tell you first how to create a simple list, and then describe the aditional features of complex lists.
+To use this function, you have to choose between two main differences: Simple & Complex lists. The main difference is that the simple lists need an array of data and the complex lists need an SQL string of data. So if you do not have your data in a database table, you will need to use a simple list. Also, the simple lists only can be displayed several times on a page (such as used on the moderation and statistics screens).
 Generally it is recommended to take any of the existing lists and changing the details. This makes sure that you use the required set of data for a complete table.
@@ Line 77: / Line 77: @@
 </pre>
 This array allows you to display additional information above and below the table, specifically for form elements such as extra buttons etc. The tables have a form around them. Please take a look at the templates under /layout/professional/admin/lists/ to understand what you can do with them. Those forms are used for example in moderation.php