Source for file strings.php

Documentation is available at strings.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_languages
  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.  * Languages Strings Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_languages
  17.  * @since       2.5
  18.  */
  19. class LanguagesModelStrings extends JModelLegacy
  20. {
  21.     /**
  22.      * Method for refreshing the cache in the database with the known language strings
  23.      *
  24.      * @return  boolean  True on success, Exception object otherwise
  25.      *
  26.      * @since        2.5
  27.      */
  28.     public function refresh()
  29.     {
  30.         require_once JPATH_COMPONENT.'/helpers/languages.php';
  31.  
  32.         $app = JFactory::getApplication();
  33.  
  34.         $app->setUserState('com_languages.overrides.cachedtime', null);
  35.  
  36.         // Empty the database cache first
  37.         try
  38.         {
  39.             $this->_db->setQuery('TRUNCATE TABLE '.$this->_db->quoteName('#__overrider'));
  40.             $this->_db->execute();
  41.         }
  42.         catch (RuntimeException $e)
  43.         {
  44.             return $e;
  45.         }
  46.  
  47.         // Create the insert query
  48.         $query = $this->_db->getQuery(true)
  49.                     ->insert($this->_db->quoteName('#__overrider'))
  50.                     ->columns('constant, string, file');
  51.  
  52.         // Initialize some variables
  53.         $client        = $app->getUserState('com_languages.overrides.filter.client', 'site') ? 'administrator' : 'site';
  54.         $language    = $app->getUserState('com_languages.overrides.filter.language', 'en-GB');
  55.  
  56.         $base = constant('JPATH_'.strtoupper($client));
  57.         $path = $base . '/language/' . $language;
  58.  
  59.         $files = array();
  60.  
  61.         // Parse common language directory
  62.         jimport('joomla.filesystem.folder');
  63.         if (is_dir($path))
  64.         {
  65.             $files = JFolder::files($path, $language.'.*ini$', false, true);
  66.         }
  67.  
  68.         // Parse language directories of components
  69.         $files = array_merge($files, JFolder::files($base.'/components', $language.'.*ini$', 3, true));
  70.  
  71.         // Parse language directories of modules
  72.         $files = array_merge($files, JFolder::files($base.'/modules', $language.'.*ini$', 3, true));
  73.  
  74.         // Parse language directories of templates
  75.         $files = array_merge($files, JFolder::files($base.'/templates', $language.'.*ini$', 3, true));
  76.  
  77.         // Parse language directories of plugins
  78.         $files = array_merge($files, JFolder::files(JPATH_PLUGINS, $language.'.*ini$', 3, true));
  79.  
  80.         // Parse all found ini files and add the strings to the database cache
  81.         foreach ($files as $file)
  82.         {
  83.             $strings = LanguagesHelper::parseFile($file);
  84.             if ($strings && count($strings))
  85.             {
  86.                 $query->clear('values');
  87.                 foreach ($strings as $key => $string)
  88.                 {
  89.                     $query->values($this->_db->quote($key).','.$this->_db->quote($string).','.$this->_db->quote(JPath::clean($file)));
  90.                 }
  91.  
  92.                 try
  93.                 {
  94.                     $this->_db->setQuery($query);
  95.                     $this->_db->execute();
  96.                 }
  97.                 catch (RuntimeException $e)
  98.                 {
  99.                     return $e;
  100.                 }
  101.             }
  102.         }
  103.  
  104.         // Update the cached time
  105.         $app->setUserState('com_languages.overrides.cachedtime.'.$client.'.'.$language, time());
  106.  
  107.         return true;
  108.     }
  109.  
  110.     /**
  111.      * Method for searching language strings
  112.      *
  113.      * @return  array  Array of resuls on success, Exception object otherwise
  114.      *
  115.      * @since        2.5
  116.      */
  117.     public function search()
  118.     {
  119.         $results = array();
  120.         $input   = JFactory::getApplication()->input;
  121.  
  122.         $limitstart = $input->getInt('more');
  123.  
  124.         try
  125.         {
  126.             $searchstring = $this->_db->quote('%' . $input->getString('searchstring') . '%');
  127.  
  128.             // Create the search query
  129.             $query = $this->_db->getQuery(true)
  130.                 ->select('constant, string, file')
  131.                 ->from($this->_db->quoteName('#__overrider'));
  132.             if ($input->get('searchtype') == 'constant')
  133.             {
  134.                 $query->where('constant LIKE '.$searchstring);
  135.             }
  136.             else
  137.             {
  138.                 $query->where('string LIKE '.$searchstring);
  139.             }
  140.  
  141.             // Consider the limitstart according to the 'more' parameter and load the results
  142.             $this->_db->setQuery($query, $limitstart, 10);
  143.             $results['results'] = $this->_db->loadObjectList();
  144.  
  145.             // Check whether there are more results than already loaded
  146.             $query->clear('select')
  147.                         ->select('COUNT(id)');
  148.             $this->_db->setQuery($query);
  149.  
  150.             if ($this->_db->loadResult() > $limitstart + 10)
  151.             {
  152.                 // If this is set a 'More Results' link will be displayed in the view
  153.                 $results['more'] = $limitstart + 10;
  154.             }
  155.         }
  156.         catch (RuntimeException $e)
  157.         {
  158.             return $e;
  159.         }
  160.  
  161.         return $results;
  162.     }
  163. }

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