Source for file filter.php

Documentation is available at filter.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_finder
  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
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. JLoader::register('FinderHelperLanguage', JPATH_ADMINISTRATOR . '/components/com_finder/helpers/language.php');
  13.  
  14. /**
  15.  * Filter HTML Behaviors for Finder.
  16.  *
  17.  * @package     Joomla.Site
  18.  * @subpackage  com_finder
  19.  * @since       2.5
  20.  */
  21. abstract class JHtmlFilter
  22. {
  23.     /**
  24.      * Method to generate filters using the slider widget and decorated
  25.      * with the FinderFilter JavaScript behaviors.
  26.      *
  27.      * @param   array  $options  An array of configuration options. [optional]
  28.      *
  29.      * @return  mixed  A rendered HTML widget on success, null otherwise.
  30.      *
  31.      * @since   2.5
  32.      */
  33.     public static function slider($options = array())
  34.     {
  35.         $db = JFactory::getDbo();
  36.         $query = $db->getQuery(true);
  37.         $user = JFactory::getUser();
  38.         $groups = implode(',', $user->getAuthorisedViewLevels());
  39.         $html = '';
  40.         $filter = null;
  41.  
  42.         // Get the configuration options.
  43.         $filterId = array_key_exists('filter_id', $options) ? $options['filter_id'] : null;
  44.         $activeNodes = array_key_exists('selected_nodes', $options) ? $options['selected_nodes'] : array();
  45.         $classSuffix = array_key_exists('class_suffix', $options) ? $options['class_suffix'] : '';
  46.         $loadMedia = array_key_exists('load_media', $options) ? $options['load_media'] : true;
  47.  
  48.         // Load the predefined filter if specified.
  49.         if (!empty($filterId))
  50.         {
  51.             $query->select('f.data, f.params')
  52.                 ->from($db->quoteName('#__finder_filters') . ' AS f')
  53.                 ->where('f.filter_id = ' . (int) $filterId);
  54.  
  55.             // Load the filter data.
  56.             $db->setQuery($query);
  57.  
  58.             try
  59.             {
  60.                 $filter = $db->loadObject();
  61.             }
  62.             catch (RuntimeException $e)
  63.             {
  64.                 return null;
  65.             }
  66.  
  67.             // Initialize the filter parameters.
  68.             if ($filter)
  69.             {
  70.                 $registry = new JRegistry;
  71.                 $registry->loadString($filter->params);
  72.                 $filter->params = $registry;
  73.             }
  74.         }
  75.  
  76.         // Build the query to get the branch data and the number of child nodes.
  77.         $query->clear()
  78.             ->select('t.*, count(c.id) AS children')
  79.             ->from($db->quoteName('#__finder_taxonomy') . ' AS t')
  80.             ->join('INNER', $db->quoteName('#__finder_taxonomy') . ' AS c ON c.parent_id = t.id')
  81.             ->where('t.parent_id = 1')
  82.             ->where('t.state = 1')
  83.             ->where('t.access IN (' . $groups . ')')
  84.             ->where('c.state = 1')
  85.             ->where('c.access IN (' . $groups . ')')
  86.             ->group('t.id, t.parent_id, t.state, t.access, t.ordering, t.title, c.parent_id')
  87.             ->order('t.ordering, t.title');
  88.  
  89.         // Limit the branch children to a predefined filter.
  90.         if ($filter)
  91.         {
  92.             $query->where('c.id IN(' . $filter->data . ')');
  93.         }
  94.  
  95.         // Load the branches.
  96.         $db->setQuery($query);
  97.  
  98.         try
  99.         {
  100.             $branches = $db->loadObjectList('id');
  101.         }
  102.         catch (RuntimeException $e)
  103.         {
  104.             return null;
  105.         }
  106.  
  107.         // Check that we have at least one branch.
  108.         if (count($branches) === 0)
  109.         {
  110.             return null;
  111.         }
  112.  
  113.         // Load the CSS/JS resources.
  114.         if ($loadMedia)
  115.         {
  116.             JHtml::_('stylesheet', 'com_finder/sliderfilter.css', false, true, false);
  117.             JHtml::_('script', 'com_finder/sliderfilter.js', false, true);
  118.         }
  119.  
  120.         // Load plug-in language files.
  121.         FinderHelperLanguage::loadPluginLanguage();
  122.  
  123.         // Start the widget.
  124.         $html .= '<div id="finder-filter-container">';
  125.         $html .= '<dl id="branch-selectors">';
  126.         $html .= '<dt>';
  127.         $html .= '<label for="tax-select-all" class="checkbox">';
  128.         $html .= '<input type="checkbox" id="tax-select-all" />';
  129.         $html .= JText::_('COM_FINDER_FILTER_SELECT_ALL_LABEL');
  130.         $html .= '</label>';
  131.         $html .= '</dt>';
  132.         $html .= '<div class="control-group">';
  133.  
  134.         // Iterate through the branches to build the branch selector.
  135.         foreach ($branches as $bk => $bv)
  136.         {
  137.             // If the multi-lang plug-in is enabled then drop the language branch.
  138.             if ($bv->title == 'Language' && JLanguageMultilang::isEnabled())
  139.             {
  140.                 continue;
  141.             }
  142.  
  143.             $html .= '<label for="tax-' . $bk . '" class="checkbox">';
  144.             $html .= '<input type="checkbox" class="toggler" id="tax-' . $bk . '"/>';
  145.             $html .= JText::sprintf('COM_FINDER_FILTER_BRANCH_LABEL', JText::_(FinderHelperLanguage::branchSingular($bv->title)));
  146.             $html .= '</label>';
  147.         }
  148.  
  149.         $html .= '</div>';
  150.         $html .= '</dl>';
  151.         $html .= '<div id="finder-filter-container">';
  152.  
  153.         // Iterate through the branches and build the branch groups.
  154.         foreach ($branches as $bk => $bv)
  155.         {
  156.             // If the multi-lang plug-in is enabled then drop the language branch.
  157.             if ($bv->title == 'Language' && JLanguageMultilang::isEnabled())
  158.             {
  159.                 continue;
  160.             }
  161.  
  162.             // Build the query to get the child nodes for this branch.
  163.             $query->clear()
  164.                 ->select('t.*')
  165.                 ->from($db->quoteName('#__finder_taxonomy') . ' AS t')
  166.                 ->where('t.parent_id = ' . (int) $bk)
  167.                 ->where('t.state = 1')
  168.                 ->where('t.access IN (' . $groups . ')')
  169.                 ->order('t.ordering, t.title');
  170.  
  171.             // Load the branches.
  172.             $db->setQuery($query);
  173.  
  174.             try
  175.             {
  176.                 $nodes = $db->loadObjectList('id');
  177.             }
  178.             catch (RuntimeException $e)
  179.             {
  180.                 return null;
  181.             }
  182.  
  183.             // Translate node titles if possible.
  184.             $lang = JFactory::getLanguage();
  185.             foreach ($nodes as $nk => $nv)
  186.             {
  187.                 $key = FinderHelperLanguage::branchPlural($nv->title);
  188.                 if ($lang->hasKey($key))
  189.                 {
  190.                     $nodes[$nk]->title = JText::_($key);
  191.                 }
  192.             }
  193.  
  194.             // Start the group.
  195.             $html .= '<dl class="checklist" rel="tax-' . $bk . '">';
  196.             $html .= '<dt>';
  197.             $html .= '<label for="tax-' . JFilterOutput::stringUrlSafe($bv->title) . '" class="checkbox">';
  198.             $html .= '<input type="checkbox" class="branch-selector filter-branch' . $classSuffix . '" id="tax-'
  199.                 . JFilterOutput::stringUrlSafe($bv->title) . '" />';
  200.             $html .= JText::sprintf('COM_FINDER_FILTER_BRANCH_LABEL', JText::_(FinderHelperLanguage::branchSingular($bv->title)));
  201.             $html .= '</label>';
  202.             $html .= '</dt>';
  203.             $html .= '<div class="control-group">';
  204.  
  205.             // Populate the group with nodes.
  206.             foreach ($nodes as $nk => $nv)
  207.             {
  208.                 // Determine if the node should be checked.
  209.                 $checked = in_array($nk, $activeNodes) ? ' checked="checked"' : '';
  210.  
  211.                 // Build a node.
  212.                 $html .= '<label for="tax-' . $nk . '" class="checkbox">';
  213.                 $html .= '<input class="selector filter-node' . $classSuffix . '" type="checkbox" value="' . $nk . '" name="t[]" id="tax-'
  214.                     . $nk . '"' . $checked . ' />';
  215.                 $html .= $nv->title;
  216.                 $html .= '</label>';
  217.             }
  218.  
  219.             // Close the group.
  220.             $html .= '</div>';
  221.             $html .= '</dl>';
  222.         }
  223.  
  224.         // Close the widget.
  225.         $html .= '<div class="clr"></div>';
  226.         $html .= '</div>';
  227.         $html .= '</div>';
  228.  
  229.         return $html;
  230.     }
  231.  
  232.     /**
  233.      * Method to generate filters using select box drop down controls.
  234.      *
  235.      * @param   FinderIndexerQuery  $idxQuery  A FinderIndexerQuery object.
  236.      * @param   array               $options   An array of options.
  237.      *
  238.      * @return  mixed  A rendered HTML widget on success, null otherwise.
  239.      *
  240.      * @since   2.5
  241.      */
  242.     public static function select($idxQuery, $options)
  243.     {
  244.         $user     = JFactory::getUser();
  245.         $groups = implode(',', $user->getAuthorisedViewLevels());
  246.         $filter = null;
  247.  
  248.         // Get the configuration options.
  249.         $classSuffix = $options->get('class_suffix', null);
  250.         $loadMedia = $options->get('load_media', true);
  251.         $showDates = $options->get('show_date_filters', false);
  252.  
  253.         // Try to load the results from cache.
  254.         $cache = JFactory::getCache('com_finder', '');
  255.         $cacheId = 'filter_select_' . serialize(array($idxQuery->filter, $options, $groups, JFactory::getLanguage()->getTag()));
  256.  
  257.         // Check the cached results.
  258.         if (!($branches = $cache->get($cacheId)))
  259.         {
  260.             $db = JFactory::getDbo();
  261.             $query = $db->getQuery(true);
  262.  
  263.             // Load the predefined filter if specified.
  264.             if (!empty($idxQuery->filter))
  265.             {
  266.                 $query->select('f.data, ' . $db->quoteName('f.params'))
  267.                     ->from($db->quoteName('#__finder_filters') . ' AS f')
  268.                     ->where('f.filter_id = ' . (int) $idxQuery->filter);
  269.  
  270.                 // Load the filter data.
  271.                 $db->setQuery($query);
  272.  
  273.                 try
  274.                 {
  275.                     $filter = $db->loadObject();
  276.                 }
  277.                 catch (RuntimeException $e)
  278.                 {
  279.                     return null;
  280.                 }
  281.  
  282.                 // Initialize the filter parameters.
  283.                 if ($filter)
  284.                 {
  285.                     $registry = new JRegistry;
  286.                     $registry->loadString($filter->params);
  287.                     $filter->params = $registry;
  288.                 }
  289.             }
  290.  
  291.             // Build the query to get the branch data and the number of child nodes.
  292.             $query->clear()
  293.                 ->select('t.*, count(c.id) AS children')
  294.                 ->from($db->quoteName('#__finder_taxonomy') . ' AS t')
  295.                 ->join('INNER', $db->quoteName('#__finder_taxonomy') . ' AS c ON c.parent_id = t.id')
  296.                 ->where('t.parent_id = 1')
  297.                 ->where('t.state = 1')
  298.                 ->where('t.access IN (' . $groups . ')')
  299.                 ->where('c.state = 1')
  300.                 ->where('c.access IN (' . $groups . ')')
  301.                 ->group($db->quoteName('t.id'))
  302.                 ->order('t.ordering, t.title');
  303.  
  304.             // Limit the branch children to a predefined filter.
  305.             if (!empty($filter->data))
  306.             {
  307.                 $query->where('c.id IN(' . $filter->data . ')');
  308.             }
  309.  
  310.             // Load the branches.
  311.             $db->setQuery($query);
  312.  
  313.             try
  314.             {
  315.                 $branches = $db->loadObjectList('id');
  316.             }
  317.             catch (RuntimeException $e)
  318.             {
  319.                 return null;
  320.             }
  321.  
  322.             // Check that we have at least one branch.
  323.             if (count($branches) === 0)
  324.             {
  325.                 return null;
  326.             }
  327.  
  328.             // Iterate through the branches and build the branch groups.
  329.             foreach ($branches as $bk => $bv)
  330.             {
  331.                 // If the multi-lang plug-in is enabled then drop the language branch.
  332.                 if ($bv->title == 'Language' && JLanguageMultilang::isEnabled())
  333.                 {
  334.                     continue;
  335.                 }
  336.  
  337.                 // Build the query to get the child nodes for this branch.
  338.                 $query->clear()
  339.                     ->select('t.*')
  340.                     ->from($db->quoteName('#__finder_taxonomy') . ' AS t')
  341.                     ->where('t.parent_id = ' . (int) $bk)
  342.                     ->where('t.state = 1')
  343.                     ->where('t.access IN (' . $groups . ')')
  344.                     ->order('t.ordering, t.title');
  345.  
  346.                 // Limit the nodes to a predefined filter.
  347.                 if (!empty($filter->data))
  348.                 {
  349.                     $query->where('t.id IN(' . $filter->data . ')');
  350.                 }
  351.  
  352.                 // Load the branches.
  353.                 $db->setQuery($query);
  354.  
  355.                 try
  356.                 {
  357.                     $branches[$bk]->nodes = $db->loadObjectList('id');
  358.                 }
  359.                 catch (RuntimeException $e)
  360.                 {
  361.                     return null;
  362.                 }
  363.  
  364.                 // Translate branch nodes if possible.
  365.                 $language = JFactory::getLanguage();
  366.                 foreach ($branches[$bk]->nodes as $node_id => $node)
  367.                 {
  368.                     $key = FinderHelperLanguage::branchPlural($node->title);
  369.                     if ($language->hasKey($key))
  370.                     {
  371.                         $branches[$bk]->nodes[$node_id]->title = JText::_($key);
  372.                     }
  373.                 }
  374.  
  375.                 // Add the Search All option to the branch.
  376.                 array_unshift($branches[$bk]->nodes, array('id' => null, 'title' => JText::_('COM_FINDER_FILTER_SELECT_ALL_LABEL')));
  377.             }
  378.  
  379.             // Store the data in cache.
  380.             $cache->store($branches, $cacheId);
  381.         }
  382.  
  383.         $html = '';
  384.  
  385.         // Add the dates if enabled.
  386.         if ($showDates)
  387.         {
  388.             $html .= JHtml::_('filter.dates', $idxQuery, $options);
  389.         }
  390.  
  391.         $html .= '<div id="finder-filter-select-list" class="form-horizontal">';
  392.  
  393.         // Iterate through all branches and build code.
  394.         foreach ($branches as $bk => $bv)
  395.         {
  396.             // If the multi-lang plug-in is enabled then drop the language branch.
  397.             if ($bv->title == 'Language' && JLanguageMultilang::isEnabled())
  398.             {
  399.                 continue;
  400.             }
  401.  
  402.             $active = null;
  403.  
  404.             // Check if the branch is in the filter.
  405.             if (array_key_exists($bv->title, $idxQuery->filters))
  406.             {
  407.                 // Get the request filters.
  408.                 $temp = JFactory::getApplication()->input->request->get('t', array(), 'array');
  409.  
  410.                 // Search for active nodes in the branch and get the active node.
  411.                 $active = array_intersect($temp, $idxQuery->filters[$bv->title]);
  412.                 $active = count($active) === 1 ? array_shift($active) : null;
  413.             }
  414.  
  415.             $html .= '<div class="filter-branch' . $classSuffix . ' control-group">';
  416.             $html .= '<label for="tax-' . JFilterOutput::stringUrlSafe($bv->title) . '" class="control-label">';
  417.             $html .= JText::sprintf('COM_FINDER_FILTER_BRANCH_LABEL', JText::_(FinderHelperLanguage::branchSingular($bv->title)));
  418.             $html .= '</label>';
  419.             $html .= '<div class="controls">';
  420.             $html .= JHtml::_(
  421.                 'select.genericlist', $branches[$bk]->nodes, 't[]', 'class="inputbox"', 'id', 'title', $active,
  422.                 'tax-' . JFilterOutput::stringUrlSafe($bv->title)
  423.             );
  424.             $html .= '</div>';
  425.             $html .= '</div>';
  426.         }
  427.  
  428.         // Close the widget.
  429.         $html .= '</div>';
  430.  
  431.         // Load the CSS/JS resources.
  432.         if ($loadMedia)
  433.         {
  434.             JHtml::stylesheet('com_finder/sliderfilter.css', false, true, false);
  435.         }
  436.  
  437.         return $html;
  438.     }
  439.  
  440.     /**
  441.      * Method to generate fields for filtering dates
  442.      *
  443.      * @param   FinderIndexerQuery  $idxQuery  A FinderIndexerQuery object.
  444.      * @param   array               $options   An array of options.
  445.      *
  446.      * @return  mixed  A rendered HTML widget on success, null otherwise.
  447.      *
  448.      * @since   2.5
  449.      */
  450.     public static function dates($idxQuery, $options)
  451.     {
  452.         $html = '';
  453.  
  454.         // Get the configuration options.
  455.         $classSuffix = $options->get('class_suffix', null);
  456.         $loadMedia = $options->get('load_media', true);
  457.         $showDates = $options->get('show_date_filters', false);
  458.  
  459.         if (!empty($showDates))
  460.         {
  461.             // Build the date operators options.
  462.             $operators = array();
  463.             $operators[] = JHtml::_('select.option', 'before', JText::_('COM_FINDER_FILTER_DATE_BEFORE'));
  464.             $operators[] = JHtml::_('select.option', 'exact', JText::_('COM_FINDER_FILTER_DATE_EXACTLY'));
  465.             $operators[] = JHtml::_('select.option', 'after', JText::_('COM_FINDER_FILTER_DATE_AFTER'));
  466.  
  467.             // Load the CSS/JS resources.
  468.             if ($loadMedia)
  469.             {
  470.                 JHtml::stylesheet('com_finder/dates.css', false, true, false);
  471.             }
  472.  
  473.             // Open the widget.
  474.             $html .= '<ul id="finder-filter-select-dates">';
  475.  
  476.             // Start date filter.
  477.             $html .= '<li class="filter-date' . $classSuffix . '">';
  478.             $html .= '<label for="filter_date1">';
  479.             $html .= JText::_('COM_FINDER_FILTER_DATE1');
  480.             $html .= '</label>';
  481.             $html .= '<br />';
  482.             $html .= JHtml::_(
  483.                 'select.genericlist', $operators, 'w1', 'class="inputbox filter-date-operator"', 'value', 'text', $idxQuery->when1, 'finder-filter-w1'
  484.             );
  485.             $html .= JHtml::calendar($idxQuery->date1, 'd1', 'filter_date1', '%Y-%m-%d', 'title="' . JText::_('COM_FINDER_FILTER_DATE1_DESC') . '"');
  486.             $html .= '</li>';
  487.  
  488.             // End date filter.
  489.             $html .= '<li class="filter-date' . $classSuffix . '">';
  490.             $html .= '<label for="filter_date2">';
  491.             $html .= JText::_('COM_FINDER_FILTER_DATE2');
  492.             $html .= '</label>';
  493.             $html .= '<br />';
  494.             $html .= JHtml::_(
  495.                 'select.genericlist', $operators, 'w2', 'class="inputbox filter-date-operator"', 'value', 'text', $idxQuery->when2, 'finder-filter-w2'
  496.             );
  497.             $html .= JHtml::calendar($idxQuery->date2, 'd2', 'filter_date2', '%Y-%m-%d', 'title="' . JText::_('COM_FINDER_FILTER_DATE2_DESC') . '"');
  498.             $html .= '</li>';
  499.  
  500.             // Close the widget.
  501.             $html .= '</ul>';
  502.         }
  503.  
  504.         return $html;
  505.     }
  506. }

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