Source for file messages.php

Documentation is available at messages.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_messages
  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.  * Messages Component Messages Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_messages
  17.  * @since       1.6
  18.  */
  19. class MessagesModelMessages extends JModelList
  20. {
  21.     /**
  22.      * Constructor.
  23.      *
  24.      * @param   array  An optional associative array of configuration settings.
  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.                 'message_id', 'a.id',
  34.                 'subject', 'a.subject',
  35.                 'state', 'a.state',
  36.                 'user_id_from', 'a.user_id_from',
  37.                 'user_id_to', 'a.user_id_to',
  38.                 'date_time', 'a.date_time',
  39.                 'priority', 'a.priority',
  40.             );
  41.         }
  42.  
  43.         parent::__construct($config);
  44.     }
  45.  
  46.     /**
  47.      * Method to auto-populate the model state.
  48.      *
  49.      * Note. Calling getState in this method will result in recursion.
  50.      *
  51.      * @since   1.6
  52.      */
  53.     protected function populateState($ordering = null, $direction = null)
  54.     {
  55.         // Load the filter state.
  56.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  57.         $this->setState('filter.search', $search);
  58.  
  59.         $state = $this->getUserStateFromRequest($this->context . '.filter.state', 'filter_state', '', 'string');
  60.         $this->setState('filter.state', $state);
  61.  
  62.         // List state information.
  63.         parent::populateState('a.date_time', 'desc');
  64.     }
  65.  
  66.     /**
  67.      * Method to get a store id based on model configuration state.
  68.      *
  69.      * This is necessary because the model is used by the component and
  70.      * different modules that might need different sets of data or different
  71.      * ordering requirements.
  72.      *
  73.      * @param   string    A prefix for the store id.
  74.      *
  75.      * @return  string    A store id.
  76.      */
  77.     protected function getStoreId($id = '')
  78.     {
  79.         // Compile the store id.
  80.         $id .= ':' . $this->getState('filter.search');
  81.         $id .= ':' . $this->getState('filter.state');
  82.  
  83.         return parent::getStoreId($id);
  84.     }
  85.  
  86.     /**
  87.      * Build an SQL query to load the list data.
  88.      *
  89.      * @return  JDatabaseQuery 
  90.      */
  91.     protected function getListQuery()
  92.     {
  93.         // Create a new query object.
  94.         $db = $this->getDbo();
  95.         $query = $db->getQuery(true);
  96.         $user = JFactory::getUser();
  97.  
  98.         // Select the required fields from the table.
  99.         $query->select(
  100.             $this->getState(
  101.                 'list.select',
  102.                 'a.*, ' .
  103.                     'u.name AS user_from'
  104.             )
  105.         );
  106.         $query->from('#__messages AS a');
  107.  
  108.         // Join over the users for message owner.
  109.         $query->join('INNER', '#__users AS u ON u.id = a.user_id_from')
  110.             ->where('a.user_id_to = ' . (int) $user->get('id'));
  111.  
  112.         // Filter by published state.
  113.         $state = $this->getState('filter.state');
  114.         if (is_numeric($state))
  115.         {
  116.             $query->where('a.state = ' . (int) $state);
  117.         }
  118.         elseif ($state === '')
  119.         {
  120.             $query->where('(a.state IN (0, 1))');
  121.         }
  122.  
  123.         // Filter by search in subject or message.
  124.         $search = $this->getState('filter.search');
  125.  
  126.         if (!empty($search))
  127.         {
  128.             $search = $db->quote('%' . $db->escape($search, true) . '%', false);
  129.             $query->where('a.subject LIKE ' . $search . ' OR a.message LIKE ' . $search);
  130.         }
  131.  
  132.         // Add the list ordering clause.
  133.         $query->order($db->escape($this->getState('list.ordering', 'a.date_time')) . ' ' . $db->escape($this->getState('list.direction', 'DESC')));
  134.  
  135.         //echo nl2br(str_replace('#__','jos_',$query));
  136.         return $query;
  137.     }
  138. }

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