grouped_list.inc

Go to the documentation of this file.

<?php
/**************************************************************
 
 Copyright (c) 2007-2010 Sonjara, Inc
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
 files (the "Software"), to deal in the Software without
 restriction, including without limitation the rights to use,
 copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the
 Software is furnished to do so, subject to the following
 conditions:
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.
 
 Except as contained in this notice, the name(s) of the above 
 copyright holders shall not be used in advertising or otherwise 
 to promote the sale, use or other dealings in this Software 
 without prior written authorization.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
*****************************************************************/
 
require_once realpath(dirname(__FILE__))."/grouped_data_view.inc";
 
/*
 * Similar to PagedList class but provides a one-level 
 * expandable/collapsable style list, given an array of items 
 * that are grouped by a field.
 * 
 * For example, projects grouped by type. Outputs the project
 * type as a heading followed by all projects that are categorized
 * as that type. The project type heading can be expanded/collapsed.
 * 
 * Can be used for Blogs and other formatted list displays.
 */
 
class GroupedListGroup extends DataGroup
{
     function GroupListGroup($parent, $title, $key, $expanded = false, $fixed = false)
     {
          parent::DataGroup($parent, $title, $key, $expanded, $fixed);
     }
 
     function draw()
     {
          $attrs = "";
          if ($this->cssClass) $attrs .= " class='{$this->cssClass}'";
          if ($this->groupStyles) $attrs .= " style='{$this->groupStyles}'";
          
          $cssClass = ($this->fixed || $this->parent->mode == 'fixed') ? "fixed" : ($this->expanded) ? "expanded" : "collapsed";
 
          echo "<h2 id=\"{$this->parent->group_id}[{$this->key}]\" $attrs>\n";
          // Output the section title
          echo "{$this->title}\n";
          echo "</h2>\n";
     }
}
 
 
class GroupedList implements FacetFilterable
{
     var $items;
     var $id;
     var $format;
     var $mode;               
     var $groups;        
     var $cssClass = null;
     var $styles = null;
     var $groupStyles = ""; 
     var $groupClass = "subheading"; 
     var $groupedListClass; 
     var $group_id;
     var $tagRowCallbacks;  
     
     function GroupedList($items, $id = "grouped_list", $format, $cssClass = "article_list", $groupClass = "subheading")
     {
          $this->items = $items;
          $this->id = $id;
          $this->format = $format;
          $this->cssClass = $cssClass;
          $this->groupClass = $groupClass;
          $this->cssStyle = null;
          $this->mode = "accordian";
          $this->tagRowCallbacks = array();
     }
     
     function group($title, $key, $expanded = false, $fixed = false)
     {
          $this->groups[] = new GroupedListGroup($this, $title, $key, $expanded);
          return $this;
     }
     
     function groupBy($groups, $format = null, $field = "")
     {
          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);
          } 
     }
 
     function getID()
     {
          return $this->id;
     }
     
     function addFacetTaggingHandler($handler)
     {
          $this->tagRowCallbacks[] = $handler;
     }
     
     function format($group, $template)
     {
          if(!is_callable($template))
               return $group->format($template);
          else
               return call_user_func($template, $group);
     }
     
     
     function writeScript()
     {
          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;
     }
     
     function drawList()
     {
          $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";
     }
     
     function drawListToString()
     {
          ob_start();
          $this->drawList();
          $out = ob_get_contents();
          ob_end_clean();
          return $out;
     }
     
}