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.  * @package     Joomla.Administrator
  14.  * @subpackage  com_messages
  15.  * @since       1.6
  16.  */
  17. class MessagesHelper
  18. {
  19.     /**
  20.      * Configure the Linkbar.
  21.      *
  22.      * @param   string    The name of the active view.
  23.      *
  24.      * @return  void 
  25.      * @since   1.6
  26.      */
  27.     public static function addSubmenu($vName)
  28.     {
  29.         JHtmlSidebar::addEntry(
  30.             JText::_('COM_MESSAGES_ADD'),
  31.             'index.php?option=com_messages&view=message&layout=edit',
  32.             $vName == 'message'
  33.         );
  34.  
  35.         JHtmlSidebar::addEntry(
  36.             JText::_('COM_MESSAGES_READ'),
  37.             'index.php?option=com_messages',
  38.             $vName == 'messages'
  39.         );
  40.     }
  41.  
  42.     /**
  43.      * Gets a list of the actions that can be performed.
  44.      *
  45.      * @return  JObject 
  46.      */
  47.     public static function getActions()
  48.     {
  49.         $user    = JFactory::getUser();
  50.         $result    = new JObject;
  51.  
  52.         $actions = JAccess::getActions('com_messages');
  53.  
  54.         foreach ($actions as $action)
  55.         {
  56.             $result->set($action->name,    $user->authorise($action->name, 'com_messages'));
  57.         }
  58.  
  59.         return $result;
  60.     }
  61.  
  62.     /**
  63.      * Get a list of filter options for the state of a module.
  64.      *
  65.      * @return  array  An array of JHtmlOption elements.
  66.      */
  67.     public static function getStateOptions()
  68.     {
  69.         // Build the filter options.
  70.         $options    = array();
  71.         $options[]    = JHtml::_('select.option',    '1',    JText::_('COM_MESSAGES_OPTION_READ'));
  72.         $options[]    = JHtml::_('select.option',    '0',    JText::_('COM_MESSAGES_OPTION_UNREAD'));
  73.         $options[]    = JHtml::_('select.option',    '-2',    JText::_('JTRASHED'));
  74.         return $options;
  75.     }
  76. }

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