Source for file helper.php

Documentation is available at helper.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Legacy
  4.  * @subpackage  Library
  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('JPATH_PLATFORM') or die;
  11.  
  12. /**
  13.  * Library helper class
  14.  *
  15.  * @package     Joomla.Legacy
  16.  * @subpackage  Library
  17.  * @since       3.2
  18.  */
  19. class JLibraryHelper
  20. {
  21.     /**
  22.      * The component list cache
  23.      *
  24.      * @var    array 
  25.      * @since  3.2
  26.      */
  27.     protected static $libraries = array();
  28.  
  29.     /**
  30.      * Get the library information.
  31.      *
  32.      * @param   string   $element  Element of the library in the extensions table.
  33.      * @param   boolean  $strict   If set and the library does not exist, the enabled attribute will be set to false.
  34.      *
  35.      * @return  object   An object with the library's information.
  36.      *
  37.      * @since   3.2
  38.      */
  39.     public static function getLibrary($element, $strict = false)
  40.     {
  41.         // Is already cached ?
  42.         if (isset(static::$libraries[$element]))
  43.         {
  44.             return static::$libraries[$element];
  45.         }
  46.  
  47.         if (static::_load($element))
  48.         {
  49.             $result = static::$libraries[$element];
  50.         }
  51.         else
  52.         {
  53.             $result = new stdClass;
  54.             $result->enabled = $strict ? false : true;
  55.             $result->params = new JRegistry;
  56.         }
  57.  
  58.         return $result;
  59.     }
  60.  
  61.     /**
  62.      * Checks if a library is enabled
  63.      *
  64.      * @param   string  $element  Element of the library in the extensions table.
  65.      *
  66.      * @return  boolean 
  67.      *
  68.      * @since   3.2
  69.      */
  70.     public static function isEnabled($element)
  71.     {
  72.         $result = static::getLibrary($element, true);
  73.  
  74.         return $result->enabled;
  75.     }
  76.  
  77.     /**
  78.      * Gets the parameter object for the library
  79.      *
  80.      * @param   string   $element  Element of the library in the extensions table.
  81.      * @param   boolean  $strict   If set and the library does not exist, false will be returned
  82.      *
  83.      * @return  JRegistry  A JRegistry object.
  84.      *
  85.      * @see     JRegistry
  86.      * @since   3.2
  87.      */
  88.     public static function getParams($element, $strict = false)
  89.     {
  90.         $library = static::getLibrary($element, $strict);
  91.  
  92.         return $library->params;
  93.     }
  94.  
  95.     /**
  96.      * Save the parameters object for the library
  97.      *
  98.      * @param   string     $element  Element of the library in the extensions table.
  99.      * @param   JRegistry  $params   Params to save
  100.      *
  101.      * @return  JRegistry  A JRegistry object.
  102.      *
  103.      * @see     JRegistry
  104.      * @since   3.2
  105.      */
  106.     public static function saveParams($element, $params)
  107.     {
  108.         if (static::isEnabled($element))
  109.         {
  110.             // Save params in DB
  111.             $db = JFactory::getDbo();
  112.             $query = $db->getQuery(true)
  113.                 ->update($db->quoteName('#__extensions'))
  114.                 ->set($db->quoteName('params') . ' = ' . $db->quote($params->toString()))
  115.                 ->where($db->quoteName('type') . ' = ' . $db->quote('library'))
  116.                 ->where($db->quoteName('element') . ' = ' . $db->quote($element));
  117.             $db->setQuery($query);
  118.  
  119.             $result = $db->execute();
  120.  
  121.             // Update params in libraries cache
  122.             if ($result && isset(static::$libraries[$element]))
  123.             {
  124.                 static::$libraries[$element]->params = $params;
  125.             }
  126.  
  127.             return $result;
  128.         }
  129.  
  130.         return false;
  131.     }
  132.  
  133.     /**
  134.      * Load the installed libraryes into the libraries property.
  135.      *
  136.      * @param   string  $element  The element value for the extension
  137.      *
  138.      * @return  boolean  True on success
  139.      *
  140.      * @since   3.2
  141.      */
  142.     protected static function _load($element)
  143.     {
  144.         $db = JFactory::getDbo();
  145.         $query = $db->getQuery(true)
  146.             ->select('extension_id AS id, element AS "option", params, enabled')
  147.             ->from('#__extensions')
  148.             ->where($db->quoteName('type') . ' = ' . $db->quote('library'))
  149.             ->where($db->quoteName('element') . ' = ' . $db->quote($element));
  150.         $db->setQuery($query);
  151.  
  152.         $cache = JFactory::getCache('_system', 'callback');
  153.  
  154.         try
  155.         {
  156.             static::$libraries[$element] = $cache->get(array($db, 'loadObject'), null, $element, false);
  157.         }
  158.         catch (RuntimeException $e)
  159.         {
  160.             // Fatal error.
  161.             JLog::add(JText::sprintf('JLIB_APPLICATION_ERROR_LIBRARY_NOT_LOADING', $element, $e->getMessage()), JLog::WARNING, 'jerror');
  162.  
  163.             return false;
  164.         }
  165.  
  166.         if (empty(static::$libraries[$element]))
  167.         {
  168.             // Fatal error.
  169.             $error = JText::_('JLIB_APPLICATION_ERROR_LIBRARY_NOT_FOUND');
  170.             JLog::add(JText::sprintf('JLIB_APPLICATION_ERROR_LIBRARY_NOT_LOADING', $element, $error), JLog::WARNING, 'jerror');
  171.  
  172.             return false;
  173.         }
  174.  
  175.         // Convert the params to an object.
  176.         if (is_string(static::$libraries[$element]->params))
  177.         {
  178.             $temp = new JRegistry;
  179.             $temp->loadString(static::$libraries[$element]->params);
  180.             static::$libraries[$element]->params = $temp;
  181.         }
  182.  
  183.         return true;
  184.     }
  185. }

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