Source for file stringcontroller.php

Documentation is available at stringcontroller.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Platform
  4.  * @subpackage  FileSystem
  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.  * String Controller
  14.  *
  15.  * @package     Joomla.Platform
  16.  * @subpackage  FileSystem
  17.  * @since       11.1
  18.  */
  19. class JStringController
  20. {
  21.     /**
  22.      * Defines a variable as an array
  23.      *
  24.      * @return  array 
  25.      *
  26.      * @since   11.1
  27.      */
  28.     public function _getArray()
  29.     {
  30.         static $strings = array();
  31.  
  32.         return $strings;
  33.     }
  34.  
  35.     /**
  36.      * Create a reference
  37.      *
  38.      * @param   string  $reference  The key
  39.      * @param   string  &$string    The value
  40.      *
  41.      * @return  void 
  42.      *
  43.      * @since   11.1
  44.      */
  45.     public function createRef($reference, &$string)
  46.     {
  47.         $ref = &self::_getArray();
  48.         $ref[$reference] = & $string;
  49.     }
  50.  
  51.     /**
  52.      * Get reference
  53.      *
  54.      * @param   string  $reference  The key for the reference.
  55.      *
  56.      * @return  mixed  False if not set, reference if it it exists
  57.      *
  58.      * @since   11.1
  59.      */
  60.     public function getRef($reference)
  61.     {
  62.         $ref = &self::_getArray();
  63.  
  64.         if (isset($ref[$reference]))
  65.         {
  66.             return $ref[$reference];
  67.         }
  68.         else
  69.         {
  70.             return false;
  71.         }
  72.     }
  73. }

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