Inheritance diagram for GroupedList:

Collaboration diagram for GroupedList:

Public Member Functions
	GroupedList ($items, $id="grouped_list", $format, $cssClass="article_list", $groupClass="subheading")

	group ($title, $key, $expanded=false, $fixed=false)
	Adds a group to the view. More...

	groupBy ($groups, $format=null, $field="")
	Add groups based on the supplied list of DataItems. More...

	getID ()

	addFacetTaggingHandler ($handler)
	Adds a row tagging handler. More...

	format ($group, $template)
	Outputs the text for the groupedBy title bar using the given group dataitem object. More...

	writeScript ()

	drawList ()

	drawListToString ()
	Helpful utility function - generates the list HTML in an output buffer and returns the string representation. More...

Public Attributes
	$items

	$id

	$format

	$mode
	The display mode for the table: fixed, tree, or accordian. More...

	$groups
	The group definitions. More...

	$cssClass = null

	$styles = null

	$groupStyles = ""
	Styles for the group headings. More...

	$groupClass = "subheading"
	Class for the ul that links the li list. More...

	$groupedListClass
	The css class for the entire grouped list div. More...

	$group_id

	$tagRowCallbacks
	Array of callbacks for adding extra attributes to each row. More...

Detailed Description

Definition at line 83 of file grouped_list.inc.

Member Function Documentation

◆ addFacetTaggingHandler()

GroupedList::addFacetTaggingHandler ( $handler )

Adds a row tagging handler.

This function will receive the data item for each row and can add custom attributes to the row tag.

Implements FacetFilterable.

Definition at line 151 of file grouped_list.inc.

      {
           $this->tagRowCallbacks[] = $handler;
      }

◆ drawList()

GroupedList::drawList ( )

Definition at line 191 of file grouped_list.inc.

      {
           $attrs = "";
           if ($this->cssClass) $attrs .= " class='{$this->cssClass}'";
           if ($this->styles) $attrs .= " style='{$this->styles}'";
  
           echo "<div id='{$this->id}' class='{$this->groupedListClass}'>\n";
           
           if(count($this->groups) == 0)
           {
                foreach(array_keys($this->items) as $group)
                {
                     $this->group($group, $group);
                }
           }
  
           if(count($this->groups) == 0) return;
                
           foreach($this->groups as $group)
           {
                if (array_key_exists($group->key, $this->items))
                {
                     echo "<div id='content_{$group->key}'>\n";
  
                     $group->draw();
                          
                     $itemsInGroup = $this->items[$group->key];
  
                     echo "<ul id=\"subheading[{$group->key}]\" class=\"{$this->groupClass}\" $attrs>\n";
      
                     foreach($itemsInGroup as $item)
                     {
                          $css = "";
                          
                          if ($this->onStartRow)
                          {
                               $css = call_user_func($this->onStartRow, $item);
                               if ($css === false) continue; // Skip this record if false returned
                          }
                          
                          if ($css) $css = " class='$css'";
                          
                          $dataAttrs = array();
                          foreach($this->tagRowCallbacks as $cb)
                          {
                               $dataAttrs = call_user_func($cb, $item, $dataAttrs);
                          }
                          
                          $rowAttrs = "";
                          foreach($dataAttrs as $name => $value)
                          {
                               $rowAttrs .= " ".$name."='".$value."'";
                          }
                          
                          echo "<li {$css}{$rowAttrs}>";
           
                          if (is_callable($this->format))
                          {
                               echo call_user_func($this->format, $item);
                          }
                          else echo $item->format($this->format);
                          echo "</li>\n";
                     }
                     
                     echo "</ul>\n";
                     echo "</div>\n";
                }
           } // end for each groups as group
  
           echo "</div>\n";
      }

◆ drawListToString()

GroupedList::drawListToString ( )

Helpful utility function - generates the list HTML in an output buffer and returns the string representation.

This is useful for resolving issues in rendering order that can occur when working with facets.

Returns: string the HTML output for the list

Definition at line 269 of file grouped_list.inc.

      {
           ob_start();
           $this->drawList();
           $out = ob_get_contents();
           ob_end_clean();
           return $out;
      }

◆ format()

GroupedList::format	(	$group,
		$template
	)

Outputs the text for the groupedBy title bar using the given group dataitem object.

This function should not be invoked directly, but is invoked as part of the GroupedDataListView's rendering operations.

Parameters

$group the dataitem object for the title bar being rendered

Returns: title for the titel bar.

Definition at line 164 of file grouped_list.inc.

      {
           if(!is_callable($template))
                return $group->format($template);
           else
                return call_user_func($template, $group);
      }

◆ getID()

GroupedList::getID ( )

Implements FacetFilterable.

Definition at line 142 of file grouped_list.inc.

      {
           return $this->id;
      }

◆ group()

GroupedList::group	(	$title,
		$key,
		$expanded = `false`,
		$fixed = `false`
	)

Adds a group to the view.

Parameters

unknown_type	$title	the title text for the group.
unknown_type	$key	the key value for the group.
unknown_type	$expanded	true for expanded by default, false for collapsed by default

Returns: GroupDataListView returns the current instance, allowing function call chaining for the group definitions.

Definition at line 117 of file grouped_list.inc.

      {
           $this->groups[] = new GroupedListGroup($this, $title, $key, $expanded);
           return $this;
      }

◆ groupBy()

GroupedList::groupBy	(	$groups,
		$format = `null`,
		$field = `""`
	)

Add groups based on the supplied list of DataItems.

Parameters

$groups	list of DataItems
$format	format template for the group titles
$field	the field to use for the key (defaults to the primary key of the group items if not specified)

Definition at line 129 of file grouped_list.inc.

      {
           if (count($groups) == 0) return;
           if (!$field) $field = $groups[0]->getPrimaryKey();
  
           $this->group_id = $field;
           
           foreach($groups as $group)
           {
                $this->group($this->format($group, $format), $group->$field);
           } 
      }

◆ GroupedList()

GroupedList::GroupedList	(	$items,
		$id = `"grouped_list"`,
		$format,
		$cssClass = `"article_list"`,
		$groupClass = `"subheading"`
	)

Definition at line 98 of file grouped_list.inc.

      {
           $this->items = $items;
           $this->id = $id;
           $this->format = $format;
           $this->cssClass = $cssClass;
           $this->groupClass = $groupClass;
           $this->cssStyle = null;
           $this->mode = "accordian";
           $this->tagRowCallbacks = array();
      }

◆ writeScript()

GroupedList::writeScript ( )

Definition at line 173 of file grouped_list.inc.

      {
           if(count($this->items) == 0) return;
                     
           $script = "<script type='text/javascript' src='/fakoli/js/grouping_list.js'></script>\n";
           
           $constructor .= "\n\t\tvar {$this->id} = new GroupingList('{$this->id}', {mode: '{$this->mode}'});";
           
           if ($constructor)
           {
                $script .=  "\t<script type='text/javascript'>\n\twindow.addEvent('domready', function()\n\t{";
                $script .= $constructor;
                $script .= "\n\t});\n\t</script>\n";
           }
  
           return $script;
      }

Member Data Documentation

◆ $cssClass

GroupedList::$cssClass = null

Definition at line 90 of file grouped_list.inc.

◆ $format

GroupedList::$format

Definition at line 87 of file grouped_list.inc.

◆ $group_id

GroupedList::$group_id

Definition at line 95 of file grouped_list.inc.

◆ $groupClass

GroupedList::$groupClass = "subheading"

Class for the ul that links the li list.

Definition at line 93 of file grouped_list.inc.

◆ $groupedListClass

GroupedList::$groupedListClass

The css class for the entire grouped list div.

Definition at line 94 of file grouped_list.inc.

◆ $groups

GroupedList::$groups

The group definitions.

Definition at line 89 of file grouped_list.inc.

◆ $groupStyles

GroupedList::$groupStyles = ""

Styles for the group headings.

Definition at line 92 of file grouped_list.inc.

◆ $id

GroupedList::$id

Definition at line 86 of file grouped_list.inc.

◆ $items

GroupedList::$items

Definition at line 85 of file grouped_list.inc.

◆ $mode

GroupedList::$mode

The display mode for the table: fixed, tree, or accordian.

Definition at line 88 of file grouped_list.inc.

◆ $styles

GroupedList::$styles = null

Definition at line 91 of file grouped_list.inc.

◆ $tagRowCallbacks

GroupedList::$tagRowCallbacks

Array of callbacks for adding extra attributes to each row.

Definition at line 96 of file grouped_list.inc.

The documentation for this class was generated from the following file:

C:/code/cms.sonjara.com/framework/grouped_list.inc

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ addFacetTaggingHandler()

◆ drawList()

◆ drawListToString()

◆ format()

◆ getID()

◆ group()

◆ groupBy()

◆ GroupedList()

◆ writeScript()

Member Data Documentation

◆ $cssClass

◆ $format

◆ $group_id

◆ $groupClass

◆ $groupedListClass

◆ $groups

◆ $groupStyles

◆ $id

◆ $items

◆ $mode

◆ $styles

◆ $tagRowCallbacks