Source for file groupedlist.php

Documentation is available at groupedlist.php

  1. <?php
  2. /**
  3.  * @package    FrameworkOnFramework
  4.  * @subpackage form
  5.  * @copyright  Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license    GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. // Protect from unauthorized access
  9. defined('_JEXEC') or die;
  10.  
  11. if (!class_exists('JFormFieldGroupedList'))
  12. {
  13.     require_once JPATH_LIBRARIES . '/joomla/form/fields/groupedlist.php';
  14. }
  15.  
  16. /**
  17.  * Form Field class for FOF
  18.  * Supports a generic list of options.
  19.  *
  20.  * @package  FrameworkOnFramework
  21.  * @since    2.0
  22.  */
  23. class FOFFormFieldGroupedlist extends JFormFieldGroupedList implements FOFFormField
  24. {
  25.     protected $static;
  26.  
  27.     protected $repeatable;
  28.     
  29.     /** @var   FOFTable  The item being rendered in a repeatable form field */
  30.     public $item;
  31.     
  32.     /** @var int A monotonically increasing number, denoting the row number in a repeatable view */
  33.     public $rowid;
  34.  
  35.     /**
  36.      * Method to get certain otherwise inaccessible properties from the form field object.
  37.      *
  38.      * @param   string  $name  The property name for which to the the value.
  39.      *
  40.      * @return  mixed  The property value or null.
  41.      *
  42.      * @since   2.0
  43.      */
  44.     public function __get($name)
  45.     {
  46.         switch ($name)
  47.         {
  48.             case 'static':
  49.                 if (empty($this->static))
  50.                 {
  51.                     $this->static = $this->getStatic();
  52.                 }
  53.  
  54.                 return $this->static;
  55.                 break;
  56.  
  57.             case 'repeatable':
  58.                 if (empty($this->repeatable))
  59.                 {
  60.                     $this->repeatable = $this->getRepeatable();
  61.                 }
  62.  
  63.                 return $this->static;
  64.                 break;
  65.  
  66.             default:
  67.                 return parent::__get($name);
  68.         }
  69.     }
  70.  
  71.     /**
  72.      * Get the rendering of this field type for static display, e.g. in a single
  73.      * item view (typically a "read" task).
  74.      *
  75.      * @since 2.0
  76.      *
  77.      * @return  string  The field HTML
  78.      */
  79.     public function getStatic()
  80.     {
  81.         $class = $this->element['class'] ? (string) $this->element['class'] : '';
  82.  
  83.         $selected = self::getOptionName($this->getOptions(), $this->value);
  84.  
  85.         if (is_null($selected))
  86.         {
  87.             $selected = array(
  88.                 'group'     => '',
  89.                 'item'     => ''
  90.             );
  91.         }
  92.  
  93.         return '<span id="' . $this->id . '-group" class="fof-groupedlist-group ' . $class . '>' .
  94.             htmlspecialchars($selected['group'], ENT_COMPAT, 'UTF-8') .
  95.             '</span>' .
  96.             '<span id="' . $this->id . '-item" class="fof-groupedlist-item ' . $class . '>' .
  97.             htmlspecialchars($selected['item'], ENT_COMPAT, 'UTF-8') .
  98.             '</span>';
  99.     }
  100.  
  101.     /**
  102.      * Get the rendering of this field type for a repeatable (grid) display,
  103.      * e.g. in a view listing many item (typically a "browse" task)
  104.      *
  105.      * @since 2.0
  106.      *
  107.      * @return  string  The field HTML
  108.      */
  109.     public function getRepeatable()
  110.     {
  111.         $class = $this->element['class'] ? (string) $this->element['class'] : '';
  112.  
  113.         $selected = self::getOptionName($this->getOptions(), $this->value);
  114.  
  115.         if (is_null($selected))
  116.         {
  117.             $selected = array(
  118.                 'group'     => '',
  119.                 'item'     => ''
  120.             );
  121.         }
  122.  
  123.         return '<span class="' . $this->id . '-group fof-groupedlist-group ' . $class . '">' .
  124.             htmlspecialchars($selected['group'], ENT_COMPAT, 'UTF-8') .
  125.             '</span>' .
  126.             '<span class="' . $this->id . '-item fof-groupedlist-item ' . $class . '">' .
  127.             htmlspecialchars($selected['item'], ENT_COMPAT, 'UTF-8') .
  128.             '</span>';
  129.     }
  130.  
  131.     /**
  132.      * Gets the active option's label given an array of JHtml options
  133.      *
  134.      * @param   array   $data      The JHtml options to parse
  135.      * @param   mixed   $selected  The currently selected value
  136.      * @param   string  $groupKey  Group name
  137.      * @param   string  $optKey    Key name
  138.      * @param   string  $optText   Value name
  139.      *
  140.      * @return  mixed   The label of the currently selected option
  141.      */
  142.     public static function getOptionName($data, $selected = null, $groupKey = 'items', $optKey = 'value', $optText = 'text')
  143.     {
  144.         $ret = null;
  145.  
  146.         foreach ($data as $dataKey => $group)
  147.         {
  148.             $label = $dataKey;
  149.             $noGroup = is_int($dataKey);
  150.  
  151.             if (is_array($group))
  152.             {
  153.                 $subList = $group[$groupKey];
  154.                 $label = $group[$optText];
  155.                 $noGroup = false;
  156.             }
  157.             elseif (is_object($group))
  158.             {
  159.                 // Sub-list is in a property of an object
  160.                 $subList = $group->$groupKey;
  161.                 $label = $group->$optText;
  162.                 $noGroup = false;
  163.             }
  164.             else
  165.             {
  166.                 throw new RuntimeException('Invalid group contents.', 1);
  167.             }
  168.  
  169.             if ($noGroup)
  170.             {
  171.                 $label = '';
  172.             }
  173.  
  174.             $match = FOFFormFieldList::getOptionName($data, $selected, $optKey, $optText);
  175.  
  176.             if (!is_null($match))
  177.             {
  178.                 $ret = array(
  179.                     'group'     => $label,
  180.                     'item'     => $match
  181.                 );
  182.                 break;
  183.             }
  184.         }
  185.  
  186.         return $ret;
  187.     }
  188. }

Documentation generated on Tue, 19 Nov 2013 15:04:07 +0100 by phpDocumentor 1.4.3