application/city/classes/commands/html/class_CityHtmlCityMapCommand.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Command;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Command\BaseCommand;
   7 use Org\Mxchange\CoreFramework\Command\Commandable;
   8 use Org\Mxchange\CoreFramework\Controller\Controller;
   9 use Org\Mxchange\CoreFramework\Factory\ObjectFactory;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  12 use Org\Mxchange\CoreFramework\Response\Responseable;
  13
  14 /**
  15  * A command for the city map
  16  *
  17  * @author              Roland Haeder <webmaster@shipsimu.org>
  18  * @version             0.0.0
  19  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  20  * @license             GNU GPL 3.0 or any newer version
  21  * @link                http://www.shipsimu.org
  22  *
  23  * This program is free software: you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation, either version 3 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  35  */
  36 class CityHtmlCityMapCommand extends BaseCommand implements Commandable {
  37         /**
  38          * Protected constructor
  39          *
  40          * @return      void
  41          */
  42         protected function __construct () {
  43                 // Call parent constructor
  44                 parent::__construct(__CLASS__);
  45         }
  46
  47         /**
  48          * Creates an instance of this command and sets the resolver instance
  49          *
  50          * @param       $resolverInstance       An instance of a command resolver
  51          * @return      $commandInstance        The created command instance
  52          */
  53         public static final function createCityHtmlCityMapCommand (CommandResolver $resolverInstance) {
  54                 // Get a new instance
  55                 $commandInstance = new CityHtmlCityMapCommand();
  56
  57                 // Set the resolver instance
  58                 $commandInstance->setResolverInstance($resolverInstance);
  59
  60                 // Return the prepared instance
  61                 return $commandInstance;
  62         }
  63
  64         /**
  65          * Executes the command with given request and response objects
  66          *
  67          * @param       $requestInstance        An instance of a class with an Requestable interface
  68          * @param       $responseInstance       An instance of a class with an Responseable interface
  69          * @return      void
  70          */
  71         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  72                 // First get a UserRegistration instance
  73                 $managerInstance = ManagerFactory::createManagerByType('city');
  74
  75                 // Make sure the instance is valid
  76                 assert($managerInstance instanceof ManageableCity);
  77
  78                 // First set request and response instance
  79                 $managerInstance->setRequestInstance($requestInstance);
  80                 $managerInstance->setResponseInstance($responseInstance);
  81
  82                 // Is there already a city the user has founded?
  83                 if ($managerInstance->isCityAlreadyFounded()) {
  84                         // Found 2nd,3rd,... city
  85                         $managerInstance->foundNewCity();
  86                 } else {
  87                         // Found first city
  88                         $managerInstance->foundFirstCity();
  89                 }
  90
  91                 // Redirect or login after registration
  92                 $managerInstance->doPostAction();
  93         }
  94
  95         /**
  96          * Adds extra filters to the given controller instance
  97          *
  98          * @param       $controllerInstance             A controller instance
  99          * @param       $requestInstance                An instance of a class with an Requestable interface
 100          * @return      void
 101          * @todo        Add some more pre/post filters to the controller
 102          */
 103         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
 104                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
 105                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
 106
 107                 // Validate user status ('confirmed' no guest)
 108                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
 109
 110                 // Check if city name is already used
 111                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('city_name_verifier_filter'));
 112
 113                 // Validate ...
 114                 //$controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_validator_filter'));
 115         }
 116 }