Alpha Framework alpha--controller
[ class tree: alpha--controller ] [ index: alpha--controller ] [ all elements ]
alpha--controller
Packages:
alpha--controller
alpha--controller--front
alpha--exceptions
alpha--model
alpha--model--types
alpha--service
alpha--tasks
alpha--tests
alpha--util
alpha--util--cache
alpha--util--convertors
alpha--util--feeds
alpha--util--filters
alpha--util--graphs
alpha--util--helpers
alpha--util--metrics
alpha--view
alpha--view--widgets

Source for file Logout.php

Documentation is available at Logout.php

  1. <?php
  2.  
  3. // include the config file
  4. if(!isset($config)) {
  5.     require_once '../util/AlphaConfig.inc';
  6.     $config = AlphaConfig::getInstance();
  7. }
  8.  
  9. require_once $config->get('sysRoot').'alpha/util/Logger.inc';
  10. require_once $config->get('sysRoot').'alpha/model/PersonObject.inc';
  11. require_once $config->get('sysRoot').'alpha/controller/AlphaController.inc';
  12. require_once $config->get('sysRoot').'alpha/controller/AlphaControllerInterface.inc';
  13.  
  14. /**
  15.  *
  16.  * Logout controller that removes the current user object from the session
  17.  * 
  18.  * @package alpha::controller
  19.  * @since 1.0
  20.  * @author John Collins <dev@alphaframework.org>
  21.  * @version $Id: Logout.php 1453 2011-12-04 15:12:54Z johnc $
  22.  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
  23.  * @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
  24.  *  All rights reserved.
  25.  * 
  26.  *  <pre>
  27.  *  Redistribution and use in source and binary forms, with or
  28.  *  without modification, are permitted provided that the
  29.  *  following conditions are met:
  30.  * 
  31.  *  * Redistributions of source code must retain the above
  32.  *    copyright notice, this list of conditions and the
  33.  *    following disclaimer.
  34.  *  * Redistributions in binary form must reproduce the above
  35.  *    copyright notice, this list of conditions and the
  36.  *    following disclaimer in the documentation and/or other
  37.  *    materials provided with the distribution.
  38.  *  * Neither the name of the Alpha Framework nor the names
  39.  *    of its contributors may be used to endorse or promote
  40.  *    products derived from this software without specific
  41.  *    prior written permission.
  42.  *   
  43.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  44.  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  45.  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  46.  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  47.  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  48.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  49.  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  50.  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  51.  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  52.  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  53.  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  54.  *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  55.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  56.  *  </pre>
  57.  *  
  58.  */
  59. class Logout extends AlphaController implements AlphaControllerInterface {
  60.     /**
  61.      * Trace logger
  62.      * 
  63.      * @var Logger 
  64.      * @since 1.0
  65.      */
  66.     private static $logger = null;
  67.     
  68.     /**
  69.      * constructor to set up the object
  70.      * 
  71.      * @since 1.0
  72.      */
  73.     public function __construct() {
  74.         self::$logger = new Logger('Logout');
  75.         self::$logger->debug('>>__construct()');
  76.         
  77.         // ensure that the super class constructor is called, indicating the rights group
  78.         parent::__construct('Public');
  79.         
  80.         if(isset($_SESSION['currentUser']))
  81.             $this->setBO($_SESSION['currentUser']);
  82.         else
  83.             self::$logger->warn('Logout controller called when no user is logged in');
  84.         
  85.         // set up the title and meta details
  86.         $this->setTitle('Logged out successfully.');
  87.         $this->setDescription('Logout page.');
  88.         $this->setKeywords('Logout,logon');
  89.         
  90.         self::$logger->debug('<<__construct');
  91.     }
  92.     
  93.     /**
  94.      * Handle POST requests (adds $currentUser PersonObject to the session)
  95.      * 
  96.      * @param array $params 
  97.      * @since 1.0
  98.      */
  99.     public function doPOST($params) {
  100.         self::$logger->debug('>>doPOST($params=['.var_export($params, true).'])');
  101.         
  102.         self::$logger->debug('<<doPOST');
  103.     }
  104.     
  105.     /**
  106.      * Handle GET requests
  107.      * 
  108.      * @param array $params 
  109.      * @since 1.0
  110.      * @throws AlphaException
  111.      */
  112.     public function doGET($params) {
  113.         self::$logger->debug('>>doGET($params=['.var_export($params, true).'])');
  114.         
  115.         global $config;
  116.         
  117.         if($this->BO instanceof PersonObject)
  118.             self::$logger->info('Logging out ['.$this->BO->get('email').'] at ['.date("Y-m-d H:i:s").']');
  119.         
  120.         $_SESSION = array();
  121.         
  122.         session_destroy();
  123.         
  124.         echo AlphaView::displayPageHead($this);
  125.         
  126.         echo AlphaView::displayUpdateMessage('You have successfully logged out of the system.');
  127.         
  128.         echo '<div align="center"><a href="'.$config->get('sysURL').'">Home Page</a></div>';
  129.         
  130.         echo AlphaView::displayPageFoot($this);
  131.         
  132.         self::$logger->debug('<<doGET');        
  133.     }
  134. }
  135.  
  136. // now build the new controller if this file is called directly
  137. if ('Logout.php' == basename($_SERVER['PHP_SELF'])) {
  138.     $controller = new Logout();
  139.     
  140.     if(!empty($_POST)) {            
  141.         $controller->doPOST($_POST);
  142.     }else{
  143.         $controller->doGET($_GET);
  144.     }
  145. }
  146.  
  147. ?>
Documentation generated on Tue, 13 Dec 2011 20:27:14 +0000 by phpDocumentor 1.4.3