application/ship-simu/main/actions/web/class_WebLoginCompanyAction.php

   1 <?php
   2 /**
   3  * An action for shipping company page
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class WebLoginCompanyAction extends BaseAction implements Commandable, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set description
  35                 $this->setObjectDescription("Shipping comany action");
  36
  37                 // Generate unique key
  38                 $this->generateUniqueId();
  39         }
  40
  41         /**
  42          * Creates an instance of this action
  43          *
  44          * @param       $resolverInstance       An instance of an action resolver
  45          * @return      $actionInstance         An instance of this action class
  46          */
  47         public final static function createWebLoginCompanyAction (ActionResolver $resolverInstance) {
  48                 // Get a new instance
  49                 $actionInstance = new WebLoginCompanyAction();
  50
  51                 // Set the resolver instance
  52                 $actionInstance->setResolverInstance($resolverInstance);
  53
  54                 // Return the instance
  55                 return $actionInstance;
  56         }
  57
  58         /**
  59          * Executes the command with given request and response objects
  60          *
  61          * @param       $requestInstance        An instance of a class with an Requestable interface
  62          * @param       $responseInstance       An instance of a class with an Responseable interface
  63          * @return      void
  64          * @todo        Maybe add fetching company list of current user here?
  65          */
  66         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  67                 // Unfinished method
  68         }
  69
  70         /**
  71          * Adds extra filters to the given controller instance
  72          *
  73          * @param       $controllerInstance             A controller instance
  74          * @param       $requestInstance                An instance of a class with an Requestable interface
  75          * @return      void
  76          */
  77         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
  78                 // Add user status filter here
  79                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_class'));
  80         }
  81 }
  82
  83 // [EOF]
  84 ?>