Gumbo PHP Library API Documentation

Template List Class (Special class for saving lists of data)

This is a Special Template Element designed to hold lists of data. The output is formatted specifically by the child class.

For example, using a string replacement Engine, looping through an array of data requires clever programming. However, the List class will hold the array of data and perform the loop internally, formatting the desired output. If the program requires placing list items 'li' inside an [un]ordered list 'ul' or 'ol', simply populate the List_Item class with the data and assign a Template Variable. When the Template File is parsed, the List object will replace the keyword with a formatted string.

 $tpl = new Gumbo_Template_Engine_[Name] ();
 ...
 $tpl_list = new Gumbo_Template_List_Item;
 $tpl_list->add ("some data");
 ...
 $tpl->assign ("My_List", $tpl_list);

 // inside template_file.txt
 ...
 {My_List}

To extend, create new List classes that work with specific types of elements. In HTML, this could be definition lists, table rows, [un]ordered list items, etc.