Source for file model.php

Documentation is available at model.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('JFormFieldSql'))
  12. {
  13.     require_once JPATH_LIBRARIES . '/joomla/form/fields/sql.php';
  14. }
  15.  
  16. /**
  17.  * Form Field class for FOF
  18.  * Generic list from a model's results
  19.  *
  20.  * @package  FrameworkOnFramework
  21.  * @since    2.0
  22.  */
  23. class FOFFormHeaderModel extends FOFFormHeaderFieldselectable
  24. {
  25.     /**
  26.      * Method to get the field options.
  27.      *
  28.      * @return  array  The field option objects.
  29.      */
  30.     protected function getOptions()
  31.     {
  32.         $options = array();
  33.  
  34.         // Initialize some field attributes.
  35.         $key = $this->element['key_field'] ? (string) $this->element['key_field'] : 'value';
  36.         $value = $this->element['value_field'] ? (string) $this->element['value_field'] : (string) $this->element['name'];
  37.         $translate = $this->element['translate'] ? (string) $this->element['translate'] : false;
  38.         $applyAccess = $this->element['apply_access'] ? (string) $this->element['apply_access'] : 'false';
  39.         $modelName = (string) $this->element['model'];
  40.         $nonePlaceholder = (string) $this->element['none'];
  41.  
  42.         if (!empty($nonePlaceholder))
  43.         {
  44.             $options[] = JHtml::_('select.option', JText::_($nonePlaceholder), null);
  45.         }
  46.  
  47.         // Process field atrtibutes
  48.         $applyAccess = strtolower($applyAccess);
  49.         $applyAccess = in_array($applyAccess, array('yes', 'on', 'true', '1'));
  50.  
  51.         // Explode model name into model name and prefix
  52.         $parts = FOFInflector::explode($modelName);
  53.         $mName = ucfirst(array_pop($parts));
  54.         $mPrefix = FOFInflector::implode($parts);
  55.  
  56.         // Get the model object
  57.         $config = array('savestate' => 0);
  58.         $model = FOFModel::getTmpInstance($mName, $mPrefix, $config);
  59.  
  60.         if ($applyAccess)
  61.         {
  62.             $model->applyAccessFiltering();
  63.         }
  64.  
  65.         // Process state variables
  66.         foreach ($this->element->children() as $stateoption)
  67.         {
  68.             // Only add <option /> elements.
  69.             if ($stateoption->getName() != 'state')
  70.             {
  71.                 continue;
  72.             }
  73.  
  74.             $stateKey = (string) $stateoption['key'];
  75.             $stateValue = (string) $stateoption;
  76.  
  77.             $model->setState($stateKey, $stateValue);
  78.         }
  79.  
  80.         // Set the query and get the result list.
  81.         $items = $model->getItemList(true);
  82.  
  83.         // Build the field options.
  84.         if (!empty($items))
  85.         {
  86.             foreach ($items as $item)
  87.             {
  88.                 if ($translate == true)
  89.                 {
  90.                     $options[] = JHtml::_('select.option', $item->$key, JText::_($item->$value));
  91.                 }
  92.                 else
  93.                 {
  94.                     $options[] = JHtml::_('select.option', $item->$key, $item->$value);
  95.                 }
  96.             }
  97.         }
  98.  
  99.         // Merge any additional options in the XML definition.
  100.         $options = array_merge(parent::getOptions(), $options);
  101.  
  102.         return $options;
  103.     }
  104. }

Documentation generated on Tue, 19 Nov 2013 15:08:38 +0100 by phpDocumentor 1.4.3