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--tests
alpha--util
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 ListBusinessObjects.php

Documentation is available at ListBusinessObjects.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/controller/AlphaController.inc';
  10. require_once $config->get('sysRoot').'alpha/view/AlphaView.inc';
  11. require_once $config->get('sysRoot').'alpha/controller/AlphaControllerInterface.inc';
  12.  
  13. /**
  14.  * 
  15.  * Controller used to list all of the business objects for the system
  16.  * 
  17.  * @package alpha::controller
  18.  * @since 1.0
  19.  * @author John Collins <dev@alphaframework.org>
  20.  * @version $Id: ListBusinessObjects.php 1341 2011-03-17 15:02:02Z johnc $
  21.  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
  22.  * @copyright Copyright (c) 2011, John Collins (founder of Alpha Framework).
  23.  *  All rights reserved.
  24.  * 
  25.  *  <pre>
  26.  *  Redistribution and use in source and binary forms, with or
  27.  *  without modification, are permitted provided that the
  28.  *  following conditions are met:
  29.  * 
  30.  *  * Redistributions of source code must retain the above
  31.  *    copyright notice, this list of conditions and the
  32.  *    following disclaimer.
  33.  *  * Redistributions in binary form must reproduce the above
  34.  *    copyright notice, this list of conditions and the
  35.  *    following disclaimer in the documentation and/or other
  36.  *    materials provided with the distribution.
  37.  *  * Neither the name of the Alpha Framework nor the names
  38.  *    of its contributors may be used to endorse or promote
  39.  *    products derived from this software without specific
  40.  *    prior written permission.
  41.  *   
  42.  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  43.  *  CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  44.  *  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  45.  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  46.  *  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  47.  *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  48.  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  49.  *  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  50.  *  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  51.  *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  52.  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  53.  *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  54.  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  55.  *  </pre>
  56.  *  
  57.  */
  58. class ListBusinessObjects extends AlphaController implements AlphaControllerInterface {
  59.     /**
  60.      * Trace logger
  61.      * 
  62.      * @var Logger 
  63.      * @since 1.0
  64.      */
  65.     private static $logger = null;
  66.     
  67.     /**
  68.      * the constructor
  69.      * 
  70.      * @since 1.0
  71.      */
  72.     public function __construct() {
  73.         self::$logger = new Logger('ListBusinessObjects');
  74.         self::$logger->debug('>>__construct()');
  75.         
  76.         global $config;
  77.         
  78.         // ensure that the super class constructor is called, indicating the rights group
  79.         parent::__construct('Admin');
  80.         
  81.         // set up the title and meta details
  82.         $this->setTitle('Listing all business objects in the system');
  83.         $this->setDescription('Page to list all business objects.');
  84.         $this->setKeywords('list,all,business,objects');
  85.         
  86.         self::$logger->debug('<<__construct');
  87.     }
  88.     
  89.     /**
  90.      * Handle GET requests
  91.      * 
  92.      * @param array $params 
  93.      * @since 1.0
  94.      */
  95.     public function doGET($params) {
  96.         self::$logger->debug('>>doGET($params=['.var_export($params, true).'])');
  97.         
  98.         echo AlphaView::displayPageHead($this);
  99.         
  100.         $this->displayBodyContent();
  101.         
  102.         echo AlphaView::displayPageFoot($this);
  103.         
  104.         self::$logger->debug('<<doGET');
  105.     }
  106.     
  107.     /**
  108.      * Handle POST requests
  109.      * 
  110.      * @param array $params 
  111.      * @since 1.0
  112.      */
  113.     public function doPOST($params) {
  114.         self::$logger->debug('>>doPOST($params=['.var_export($params, true).'])');
  115.         
  116.         global $config;
  117.         
  118.         echo AlphaView::displayPageHead($this);
  119.         
  120.         try {
  121.             // check the hidden security fields before accepting the form POST data
  122.             if(!$this->checkSecurityFields())
  123.                 throw new SecurityException('This page cannot accept post data from remote servers!');
  124.         
  125.             if(isset($params['createTableBut'])) {
  126.                 try {                    
  127.                     $classname = $params['createTableClass'];
  128.                     AlphaDAO::loadClassDef($classname);
  129.                         
  130.                     $BO = new $classname();    
  131.                     $BO->makeTable();
  132.                 
  133.                     echo AlphaView::displayUpdateMessage('The table for the class '.$classname.' has been successfully created.');
  134.                 }catch(AlphaException $e) {
  135.                     self::$logger->error($e->getMessage());
  136.                     echo AlphaView::displayErrorMessage('Error creating the table for the class '.$classname.', check the log!');
  137.                 }
  138.             }
  139.             
  140.             if(isset($params['recreateTableClass']) && $params['admin_'.$params['recreateTableClass'].'_button_pressed'] == 'recreateTableBut') {
  141.                 try {                    
  142.                     $classname = $params['recreateTableClass'];
  143.                     AlphaDAO::loadClassDef($classname);                    
  144.                     $BO = new $classname();    
  145.                     $BO->rebuildTable();
  146.                     
  147.                     echo AlphaView::displayUpdateMessage('The table for the class '.$classname.' has been successfully recreated.');
  148.                 }catch(AlphaException $e) {
  149.                     self::$logger->error($e->getTraceAsString());
  150.                     echo AlphaView::displayErrorMessage('Error recreating the table for the class '.$classname.', check the log!');
  151.                 }
  152.             }
  153.             
  154.             if(isset($params['updateTableClass']) && $params['admin_'.$params['updateTableClass'].'_button_pressed'] == 'updateTableBut') {
  155.                 try {
  156.                     $classname = $params['updateTableClass'];
  157.                     AlphaDAO::loadClassDef($classname);
  158.                         
  159.                     $BO = new $classname();
  160.                     $missingFields = $BO->findMissingFields();
  161.                     
  162.                     $count = count($missingFields);
  163.                     
  164.                     for($i = 0; $i < $count; $i++)
  165.                         $BO->addProperty($missingFields[$i]);
  166.                     
  167.                     echo AlphaView::displayUpdateMessage('The table for the class '.$classname.' has been successfully updated.');
  168.                 }catch(AlphaException $e) {
  169.                     self::$logger->error($e->getTraceAsString());
  170.                     echo AlphaView::displayErrorMessage('Error updating the table for the class '.$classname.', check the log!');
  171.                 }
  172.             }
  173.         }catch(SecurityException $e) {
  174.             echo AlphaView::displayErrorMessage($e->getMessage());
  175.             self::$logger->warn($e->getMessage());
  176.         }
  177.         
  178.         $this->displayBodyContent();
  179.                 
  180.         echo AlphaView::displayPageFoot($this);
  181.         
  182.         self::$logger->debug('<<doPOST');
  183.     }
  184.     
  185.     /**
  186.      * Private method to display the main body HTML for this page
  187.      * 
  188.      * @since 1.0
  189.      */
  190.     private function displayBodyContent() {
  191.         $classNames = AlphaDAO::getBOClassNames();
  192.         $loadedClasses = array();
  193.         
  194.         foreach($classNames as $classname) {
  195.             AlphaDAO::loadClassDef($classname);
  196.             array_push($loadedClasses, $classname);
  197.         }
  198.         
  199.         foreach($loadedClasses as $classname) {
  200.             try {
  201.                 $BO = new $classname();
  202.                 $BO_View = AlphaView::getInstance($BO);                
  203.                 $BO_View->adminView();                
  204.             }catch (AlphaException $e) {
  205.                 self::$logger->error("[$classname]:".$e->getMessage());
  206.                 // its possible that the exception occured due to the table schema being out of date
  207.                 if($BO->checkTableExists() && $BO->checkTableNeedsUpdate()) {                
  208.                     $missingFields = $BO->findMissingFields();
  209.                 
  210.                     $count = count($missingFields);
  211.                     
  212.                     for($i = 0; $i < $count; $i++)
  213.                         $BO->addProperty($missingFields[$i]);
  214.                         
  215.                     // now try again...
  216.                     $BO = new $classname();
  217.                     $BO_View = AlphaView::getInstance($BO);
  218.                     $BO_View->adminView();
  219.                 }
  220.             }catch (Exception $e) {
  221.                 self::$logger->error($e->getMessage());
  222.                 echo AlphaView::displayErrorMessage('Error accessing the class ['.$classname.'], check the log!');
  223.             }
  224.         }
  225.     }
  226. }
  227.  
  228. // now build the new controller
  229. if(basename($_SERVER['PHP_SELF']) == 'ListBusinessObjects.php') {
  230.     $controller = new ListBusinessObjects();
  231.     
  232.     if(!empty($_POST)) {            
  233.         $controller->doPOST($_REQUEST);
  234.     }else{
  235.         $controller->doGET($_GET);
  236.     }
  237. }
  238.  
  239. ?>
Documentation generated on Thu, 17 Mar 2011 16:44:29 +0000 by phpDocumentor 1.4.3