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

Documentation generated on Thu, 22 Mar 2012 22:14:15 +0100 by phpDocumentor 1.4.3