Source for file contacts.php

Documentation is available at contacts.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_contact
  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('_JEXEC') or die;
  11.  
  12. /**
  13.  * Methods supporting a list of contact records.
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_contact
  17.  */
  18. class ContactModelContacts extends JModelList
  19. {
  20.     /**
  21.      * Constructor.
  22.      *
  23.      * @param   array  $config  An optional associative array of configuration settings.
  24.      *
  25.      * @see     JController
  26.      * @since   1.6
  27.      */
  28.     public function __construct($config = array())
  29.     {
  30.         if (empty($config['filter_fields']))
  31.         {
  32.             $config['filter_fields'] = array(
  33.                 'id', 'a.id',
  34.                 'name', 'a.name',
  35.                 'alias', 'a.alias',
  36.                 'checked_out', 'a.checked_out',
  37.                 'checked_out_time', 'a.checked_out_time',
  38.                 'catid', 'a.catid', 'category_title',
  39.                 'user_id', 'a.user_id',
  40.                 'published', 'a.published',
  41.                 'access', 'a.access', 'access_level',
  42.                 'created', 'a.created',
  43.                 'created_by', 'a.created_by',
  44.                 'ordering', 'a.ordering',
  45.                 'featured', 'a.featured',
  46.                 'language', 'a.language',
  47.                 'publish_up', 'a.publish_up',
  48.                 'publish_down', 'a.publish_down',
  49.                 'ul.name', 'linked_user',
  50.             );
  51.  
  52.             $app = JFactory::getApplication();
  53.             $assoc = JLanguageAssociations::isEnabled();
  54.             if ($assoc)
  55.             {
  56.                 $config['filter_fields'][] = 'association';
  57.             }
  58.         }
  59.  
  60.         parent::__construct($config);
  61.     }
  62.  
  63.     /**
  64.      * Method to auto-populate the model state.
  65.      *
  66.      * Note. Calling getState in this method will result in recursion.
  67.      *
  68.      * @param   string  $ordering   An optional ordering field.
  69.      * @param   string  $direction  An optional direction (asc|desc).
  70.      *
  71.      * @return  void 
  72.      *
  73.      * @since   1.6
  74.      */
  75.     protected function populateState($ordering = null, $direction = null)
  76.     {
  77.         $app = JFactory::getApplication();
  78.  
  79.         // Adjust the context to support modal layouts.
  80.         if ($layout = $app->input->get('layout'))
  81.         {
  82.             $this->context .= '.' . $layout;
  83.         }
  84.  
  85.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  86.         $this->setState('filter.search', $search);
  87.  
  88.         $access = $this->getUserStateFromRequest($this->context . '.filter.access', 'filter_access', 0, 'int');
  89.         $this->setState('filter.access', $access);
  90.  
  91.         $published = $this->getUserStateFromRequest($this->context . '.filter.published', 'filter_published', '');
  92.         $this->setState('filter.published', $published);
  93.  
  94.         $categoryId = $this->getUserStateFromRequest($this->context . '.filter.category_id', 'filter_category_id');
  95.         $this->setState('filter.category_id', $categoryId);
  96.  
  97.         $language = $this->getUserStateFromRequest($this->context . '.filter.language', 'filter_language', '');
  98.         $this->setState('filter.language', $language);
  99.  
  100.         // force a language
  101.         $forcedLanguage = $app->input->get('forcedLanguage');
  102.         if (!empty($forcedLanguage))
  103.         {
  104.             $this->setState('filter.language', $forcedLanguage);
  105.             $this->setState('filter.forcedLanguage', $forcedLanguage);
  106.         }
  107.  
  108.         $tag = $this->getUserStateFromRequest($this->context . '.filter.tag', 'filter_tag', '');
  109.         $this->setState('filter.tag', $tag);
  110.  
  111.         // List state information.
  112.         parent::populateState('a.name', 'asc');
  113.     }
  114.  
  115.     /**
  116.      * Method to get a store id based on model configuration state.
  117.      *
  118.      * This is necessary because the model is used by the component and
  119.      * different modules that might need different sets of data or different
  120.      * ordering requirements.
  121.      *
  122.      * @param   string  $id    A prefix for the store id.
  123.      *
  124.      * @return  string  A store id.
  125.      * @since   1.6
  126.      */
  127.     protected function getStoreId($id = '')
  128.     {
  129.         // Compile the store id.
  130.         $id .= ':' . $this->getState('filter.search');
  131.         $id .= ':' . $this->getState('filter.access');
  132.         $id .= ':' . $this->getState('filter.published');
  133.         $id .= ':' . $this->getState('filter.category_id');
  134.         $id .= ':' . $this->getState('filter.language');
  135.  
  136.         return parent::getStoreId($id);
  137.     }
  138.  
  139.     /**
  140.      * Build an SQL query to load the list data.
  141.      *
  142.      * @return  JDatabaseQuery 
  143.      * @since   1.6
  144.      */
  145.     protected function getListQuery()
  146.     {
  147.         // Create a new query object.
  148.         $db = $this->getDbo();
  149.         $query = $db->getQuery(true);
  150.         $user = JFactory::getUser();
  151.         $app = JFactory::getApplication();
  152.  
  153.         // Select the required fields from the table.
  154.         $query->select(
  155.             $this->getState(
  156.                 'list.select',
  157.                 'a.id, a.name, a.alias, a.checked_out, a.checked_out_time, a.catid, a.user_id' .
  158.                     ', a.published, a.access, a.created, a.created_by, a.ordering, a.featured, a.language' .
  159.                     ', a.publish_up, a.publish_down'
  160.             )
  161.         );
  162.         $query->from('#__contact_details AS a');
  163.  
  164.         // Join over the users for the linked user.
  165.         $query->select('ul.name AS linked_user')
  166.             ->join('LEFT', '#__users AS ul ON ul.id=a.user_id');
  167.  
  168.         // Join over the language
  169.         $query->select('l.title AS language_title')
  170.             ->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
  171.  
  172.         // Join over the users for the checked out user.
  173.         $query->select('uc.name AS editor')
  174.             ->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
  175.  
  176.         // Join over the asset groups.
  177.         $query->select('ag.title AS access_level')
  178.             ->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
  179.  
  180.         // Join over the categories.
  181.         $query->select('c.title AS category_title')
  182.             ->join('LEFT', '#__categories AS c ON c.id = a.catid');
  183.  
  184.         // Join over the associations.
  185.         $assoc = JLanguageAssociations::isEnabled();
  186.         if ($assoc)
  187.         {
  188.             $query->select('COUNT(asso2.id)>1 as association')
  189.                 ->join('LEFT', '#__associations AS asso ON asso.id = a.id AND asso.context=' . $db->quote('com_contact.item'))
  190.                 ->join('LEFT', '#__associations AS asso2 ON asso2.key = asso.key')
  191.                 ->group('a.id');
  192.         }
  193.  
  194.         // Filter by access level.
  195.         if ($access = $this->getState('filter.access'))
  196.         {
  197.             $query->where('a.access = ' . (int) $access);
  198.         }
  199.  
  200.         // Implement View Level Access
  201.         if (!$user->authorise('core.admin'))
  202.         {
  203.             $groups = implode(',', $user->getAuthorisedViewLevels());
  204.             $query->where('a.access IN (' . $groups . ')');
  205.         }
  206.  
  207.         // Filter by published state
  208.         $published = $this->getState('filter.published');
  209.         if (is_numeric($published))
  210.         {
  211.             $query->where('a.published = ' . (int) $published);
  212.         }
  213.         elseif ($published === '')
  214.         {
  215.             $query->where('(a.published = 0 OR a.published = 1)');
  216.         }
  217.  
  218.         // Filter by a single or group of categories.
  219.         $categoryId = $this->getState('filter.category_id');
  220.         if (is_numeric($categoryId))
  221.         {
  222.             $query->where('a.catid = ' . (int) $categoryId);
  223.         }
  224.         elseif (is_array($categoryId))
  225.         {
  226.             JArrayHelper::toInteger($categoryId);
  227.             $categoryId = implode(',', $categoryId);
  228.             $query->where('a.catid IN (' . $categoryId . ')');
  229.         }
  230.  
  231.         // Filter by search in name.
  232.         $search = $this->getState('filter.search');
  233.         if (!empty($search))
  234.         {
  235.             if (stripos($search, 'id:') === 0)
  236.             {
  237.                 $query->where('a.id = ' . (int) substr($search, 3));
  238.             }
  239.             elseif (stripos($search, 'author:') === 0)
  240.             {
  241.                 $search = $db->quote('%' . $db->escape(substr($search, 7), true) . '%');
  242.                 $query->where('(uc.name LIKE ' . $search . ' OR uc.username LIKE ' . $search . ')');
  243.             }
  244.             else
  245.             {
  246.                 $search = $db->quote('%' . $db->escape($search, true) . '%');
  247.                 $query->where('(a.name LIKE ' . $search . ' OR a.alias LIKE ' . $search . ')');
  248.             }
  249.         }
  250.  
  251.         // Filter on the language.
  252.         if ($language = $this->getState('filter.language'))
  253.         {
  254.             $query->where('a.language = ' . $db->quote($language));
  255.         }
  256.  
  257.         // Filter by a single tag.
  258.         $tagId = $this->getState('filter.tag');
  259.         if (is_numeric($tagId))
  260.         {
  261.             $query->where($db->quoteName('tagmap.tag_id') . ' = ' . (int) $tagId)
  262.                 ->join(
  263.                     'LEFT', $db->quoteName('#__contentitem_tag_map', 'tagmap')
  264.                     . ' ON ' . $db->quoteName('tagmap.content_item_id') . ' = ' . $db->quoteName('a.id')
  265.                     . ' AND ' . $db->quoteName('tagmap.type_alias') . ' = ' . $db->quote('com_contact.contact')
  266.                 );
  267.         }
  268.  
  269.         // Add the list ordering clause.
  270.         $orderCol = $this->state->get('list.ordering', 'a.name');
  271.         $orderDirn = $this->state->get('list.direction', 'asc');
  272.         if ($orderCol == 'a.ordering' || $orderCol == 'category_title')
  273.         {
  274.             $orderCol = 'c.title ' . $orderDirn . ', a.ordering';
  275.         }
  276.         $query->order($db->escape($orderCol . ' ' . $orderDirn));
  277.  
  278.         //echo nl2br(str_replace('#__','jos_',$query));
  279.         return $query;
  280.     }
  281. }

Documentation generated on Tue, 19 Nov 2013 14:56:45 +0100 by phpDocumentor 1.4.3