Source for file tag.php

Documentation is available at tag.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Libraries
  4.  * @subpackage  Form
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('JPATH_BASE') or die;
  11.  
  12. JFormHelper::loadFieldClass('list');
  13.  
  14. /**
  15.  * Form Field class for the Joomla Framework.
  16.  *
  17.  * @package     Joomla.Libraries
  18.  * @subpackage  Form
  19.  * @since       3.1
  20.  */
  21. class JFormFieldTag extends JFormFieldList
  22. {
  23.     /**
  24.      * A flexible tag list that respects access controls
  25.      *
  26.      * @var    string 
  27.      * @since  3.1
  28.      */
  29.     public $type = 'Tag';
  30.  
  31.     /**
  32.      * Flag to work with nested tag field
  33.      *
  34.      * @var    boolean 
  35.      * @since  3.1
  36.      */
  37.     public $isNested = null;
  38.  
  39.     /**
  40.      * com_tags parameters
  41.      *
  42.      * @var    JRegistry 
  43.      * @since  3.1
  44.      */
  45.     protected $comParams = null;
  46.  
  47.     /**
  48.      * Constructor
  49.      *
  50.      * @since  3.1
  51.      */
  52.     public function __construct()
  53.     {
  54.         parent::__construct();
  55.  
  56.         // Load com_tags config
  57.         $this->comParams = JComponentHelper::getParams('com_tags');
  58.     }
  59.  
  60.     /**
  61.      * Method to get the field input for a tag field.
  62.      *
  63.      * @return  string  The field input.
  64.      *
  65.      * @since   3.1
  66.      */
  67.     protected function getInput()
  68.     {
  69.         // AJAX mode requires ajax-chosen
  70.         if (!$this->isNested())
  71.         {
  72.             // Get the field id
  73.             $id    = isset($this->element['id']) ? $this->element['id'] : null;
  74.             $cssId = '#' . $this->getId($id, $this->element['name']);
  75.  
  76.             // Load the ajax-chosen customised field
  77.             JHtml::_('tag.ajaxfield', $cssId, $this->allowCustom());
  78.         }
  79.  
  80.         if (!is_array($this->value) && !empty($this->value))
  81.         {
  82.             if ($this->value instanceof JHelperTags)
  83.             {
  84.                 if (empty($this->value->tags))
  85.                 {
  86.                     $this->value = array();
  87.                 }
  88.                 else
  89.                 {
  90.                     $this->value = $this->value->tags;
  91.                 }
  92.             }
  93.  
  94.             // String in format 2,5,4
  95.             if (is_string($this->value))
  96.             {
  97.                 $this->value = explode(',', $this->value);
  98.             }
  99.         }
  100.  
  101.         $input = parent::getInput();
  102.  
  103.         return $input;
  104.     }
  105.  
  106.     /**
  107.      * Method to get a list of tags
  108.      *
  109.      * @return  array  The field option objects.
  110.      *
  111.      * @since   3.1
  112.      */
  113.     protected function getOptions()
  114.     {
  115.         $published = $this->element['published']? $this->element['published'] : array(0,1);
  116.  
  117.         $db        = JFactory::getDbo();
  118.         $query    = $db->getQuery(true)
  119.             ->select('a.id AS value, a.path, a.title AS text, a.level, a.published')
  120.             ->from('#__tags AS a')
  121.             ->join('LEFT', $db->quoteName('#__tags') . ' AS b ON a.lft > b.lft AND a.rgt < b.rgt');
  122.  
  123.         // Ajax tag only loads assigned values
  124.         if (!$this->isNested() && !empty($this->value))
  125.         {
  126.             // Only item assigned values
  127.             $values = (array) $this->value;
  128.             JArrayHelper::toInteger($values);
  129.             $query->where('a.id IN (' . implode(',', $values) . ')');
  130.         }
  131.  
  132.         // Block the possibility to set a tag as it own parent
  133.         $id   = (int) $this->form->getValue('id', 0);
  134.         $name = (int) $this->form->getValue('name', '');
  135.  
  136.         if ($name == 'com_tags.tag')
  137.         {
  138.             $query->where('a.id != ' . $db->quote($id));
  139.         }
  140.  
  141.         // Filter language
  142.         if (!empty($this->element['language']))
  143.         {
  144.             $query->where('a.language = ' . $db->quote($this->element['language']));
  145.         }
  146.  
  147.         $query->where($db->quoteName('a.alias') . ' <> ' . $db->quote('root'));
  148.  
  149.         // Filter on the published state
  150.         if (is_numeric($published))
  151.         {
  152.             $query->where('a.published = ' . (int) $published);
  153.         }
  154.         elseif (is_array($published))
  155.         {
  156.             JArrayHelper::toInteger($published);
  157.             $query->where('a.published IN (' . implode(',', $published) . ')');
  158.         }
  159.  
  160.         $query->group('a.id, a.title, a.level, a.lft, a.rgt, a.parent_id, a.published, a.path')
  161.             ->order('a.lft ASC');
  162.  
  163.         // Get the options.
  164.         $db->setQuery($query);
  165.  
  166.         try
  167.         {
  168.             $options = $db->loadObjectList();
  169.         }
  170.         catch (RuntimeException $e)
  171.         {
  172.             return false;
  173.         }
  174.  
  175.         // Merge any additional options in the XML definition.
  176.         $options = array_merge(parent::getOptions(), $options);
  177.  
  178.         // Prepare nested data
  179.         if ($this->isNested())
  180.         {
  181.             $this->prepareOptionsNested($options);
  182.         }
  183.         else
  184.         {
  185.             $options = JHelperTags::convertPathsToNames($options);
  186.         }
  187.  
  188.         return $options;
  189.     }
  190.  
  191.     /**
  192.      * Add "-" before nested tags, depending on level
  193.      *
  194.      * @param   array  &$options  Array of tags
  195.      *
  196.      * @return  array  The field option objects.
  197.      *
  198.      * @since   3.1
  199.      */
  200.     protected function prepareOptionsNested(&$options)
  201.     {
  202.         if ($options)
  203.         {
  204.             foreach ($options as &$option)
  205.             {
  206.                 $repeat = (isset($option->level) && $option->level - 1 >= 0) ? $option->level - 1 : 0;
  207.                 $option->text = str_repeat('- ', $repeat) . $option->text;
  208.             }
  209.         }
  210.  
  211.         return $options;
  212.     }
  213.  
  214.     /**
  215.      * Determine if the field has to be tagnested
  216.      *
  217.      * @return  boolean 
  218.      *
  219.      * @since   3.1
  220.      */
  221.     public function isNested()
  222.     {
  223.         if (is_null($this->isNested))
  224.         {
  225.             // If mode="nested" || ( mode not set & config = nested )
  226.             if ((isset($this->element['mode']) && $this->element['mode'] == 'nested')
  227.                 || (!isset($this->element['mode']) && $this->comParams->get('tag_field_ajax_mode', 1) == 0))
  228.             {
  229.                 $this->isNested = true;
  230.             }
  231.         }
  232.  
  233.         return $this->isNested;
  234.     }
  235.  
  236.     /**
  237.      * Determines if the field allows or denies custom values
  238.      *
  239.      * @return  boolean 
  240.      */
  241.     public function allowCustom()
  242.     {
  243.         if (isset($this->element['custom']) && $this->element['custom'] == 'deny')
  244.         {
  245.             return false;
  246.         }
  247.  
  248.         return true;
  249.     }
  250. }

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