Source for file jContext.class.php

Documentation is available at jContext.class.php

1. <?php
2. /**
3. * @package    jelix
4. * @subpackage core
5. * @author    Laurent Jouanneau
6. * @copyright  2001-2005 CopixTeam, 2005-2006 Laurent Jouanneau
7. *  This class was get originally from the Copix project (CopixContext, Copix 2.3dev20050901, http://www.copix.org)
8. *  Few lines of code are still copyrighted 2001-2005 CopixTeam (LGPL licence).
9. *  Initial authors of this Copix class are Gerald Croes and Laurent Jouanneau,
10. *  and this class was adapted/improved for Jelix by Laurent Jouanneau
11. *
12. * @link      http://www.jelix.org
13. * @licence  http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public Licence, see LICENCE file
14. */
15.  
16. /**
17.  * Module context manager
18.  * Its goal is to manage a stack of module context
19.  * @package  jelix
20.  * @subpackage core
21.  */
22. class jContext {
23.  
24.     static protected $context = array();
25.  
26.     /**
27.     * set the context to the given module
28.     * @param string $module  the module name
29.     */
30.     static function push ($module){
31.         array_push (self::$context, $module);
32.     }
33.  
34.     /**
35.     * cancel the current context and set the context to the previous module
36.     * @return string the obsolet module name
37.     */
38.     static function pop (){
39.         return array_pop (self::$context);
40.     }
41.  
42.     /**
43.     * get the module name of the current context
44.     * @return string name of the current module
45.     */
46.     static function get (){
47.         return end(self::$context);
48.     }
49.  
50.     /**
51.     * clear the context
52.     */
53.     static function clear (){
54.         self::$context = array ();
55.     }
56. }

Documentation generated on Mon, 26 Oct 2015 21:52:11 +0100 by phpDocumentor 1.4.3