Source for file messages.php

Documentation is available at messages.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_postinstall
  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.  * Model class to manage postinstall messages
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_postinstall
  17.  * @since       3.2
  18.  */
  19. class PostinstallModelMessages extends FOFModel
  20. {
  21.     /**
  22.      * Builds the SELECT query
  23.      *
  24.      * @param   boolean  $overrideLimits  Are we requested to override the set limits?
  25.      *
  26.      * @return  JDatabaseQuery 
  27.      *
  28.      * @since   3.2
  29.      */
  30.     public function buildQuery($overrideLimits = false)
  31.     {
  32.         $query = parent::buildQuery($overrideLimits);
  33.  
  34.         $db = $this->getDbo();
  35.  
  36.         // Add a forced extension filtering to the list
  37.         $eid = $this->input->getInt('eid', 700);
  38.         $query->where($db->qn('extension_id') . ' = ' . $db->q($eid));
  39.  
  40.         // Force filter only enabled messages
  41.         $published = $this->input->getInt('published', 1);
  42.         $query->where($db->qn('enabled') . ' = ' . $db->q($published));
  43.  
  44.         return $query;
  45.     }
  46.  
  47.     /**
  48.      * Returns the name of an extension, as registered in the #__extensions table
  49.      *
  50.      * @param   integer  $eid  The extension ID
  51.      *
  52.      * @return  string  The extension name
  53.      *
  54.      * @since   3.2
  55.      */
  56.     public function getExtensionName($eid)
  57.     {
  58.         // Load the extension's information from the database
  59.         $db = $this->getDbo();
  60.  
  61.         $query = $db->getQuery(true)
  62.             ->select(array('name', 'element', 'client_id'))
  63.             ->from($db->qn('#__extensions'))
  64.             ->where($db->qn('extension_id') . ' = ' . $db->q((int) $eid));
  65.  
  66.         $db->setQuery($query, 0, 1);
  67.  
  68.         $extension = $db->loadObject();
  69.  
  70.         if (!is_object($extension))
  71.         {
  72.             return '';
  73.         }
  74.  
  75.         // Load language files
  76.         $basePath = JPATH_ADMINISTRATOR;
  77.  
  78.         if ($extension->client_id == 0)
  79.         {
  80.             $basePath = JPATH_SITE;
  81.         }
  82.  
  83.         $lang = JFactory::getLanguage();
  84.         $lang->load($extension->element, $basePath);
  85.  
  86.         // Return the localised name
  87.         return JText::_($extension->name);
  88.     }
  89.  
  90.     /**
  91.      * Resets all messages for an extension
  92.      *
  93.      * @param   integer  $eid  The extension ID whose messages we'll reset
  94.      *
  95.      * @return  mixed  False if we fail, a db cursor otherwise
  96.      *
  97.      * @since   3.2
  98.      */
  99.     public function resetMessages($eid)
  100.     {
  101.         $db = $this->getDbo();
  102.  
  103.         $query = $db->getQuery(true)
  104.             ->update($db->qn('#__postinstall_messages'))
  105.             ->set($db->qn('enabled') . ' = ' . $db->q(1))
  106.             ->where($db->qn('extension_id') . ' = ' . $db->q($eid));
  107.         $db->setQuery($query);
  108.  
  109.         return $db->execute();
  110.     }
  111.  
  112.     /**
  113.      * List post-processing. This is used to run the programmatic display
  114.      * conditions against each list item and decide if we have to show it or
  115.      * not.
  116.      *
  117.      * Do note that this a core method of the RAD Layer which operates directly
  118.      * on the list it's being fed. A little touch of modern magic.
  119.      *
  120.      * @param   array  $resultArray  A list of items to process
  121.      *
  122.      * @return  void 
  123.      *
  124.      * @since   3.2
  125.      */
  126.     protected function onProcessList(&$resultArray)
  127.     {
  128.         $unset_keys = array();
  129.         $language_extensions = array();
  130.  
  131.         foreach ($resultArray as $key => $item)
  132.         {
  133.             // Filter out messages based on dynamically loaded programmatic conditions
  134.             if (!empty($item->condition_file) && !empty($item->condition_method))
  135.             {
  136.                 jimport('joomla.filesystem.file');
  137.  
  138.                 $file = FOFTemplateUtils::parsePath($item->condition_file, true);
  139.  
  140.                 if (JFile::exists($file))
  141.                 {
  142.                     require_once $file;
  143.  
  144.                     $result = call_user_func($item->condition_method);
  145.  
  146.                     if ($result === false)
  147.                     {
  148.                         $unset_keys[] = $key;
  149.                     }
  150.                 }
  151.             }
  152.  
  153.             // Load the necessary language files
  154.             if (!empty($item->language_extension))
  155.             {
  156.                 $hash = $item->language_client_id . '-' . $item->language_extension;
  157.  
  158.                 if (!in_array($hash, $language_extensions))
  159.                 {
  160.                     $language_extensions[] = $hash;
  161.                     JFactory::getLanguage()->load($item->language_extension, $item->language_client_id == 0 ? JPATH_SITE : JPATH_ADMINISTRATOR);
  162.                 }
  163.             }
  164.         }
  165.  
  166.         if (!empty($unset_keys))
  167.         {
  168.             foreach ($unset_keys as $key)
  169.             {
  170.                 unset($resultArray[$key]);
  171.             }
  172.         }
  173.     }
  174. }

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