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

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Command;
   4
   5 // Import application-specific stuff
   6 use Org\Mxchange\City\Factory\Manager\ManagerFactory;
   7 use Org\Mxchange\City\Manager\City\ManageableCity;
   8
   9 // Import framework stuff
  10 use Org\Mxchange\CoreFramework\Command\BaseCommand;
  11 use Org\Mxchange\CoreFramework\Command\Commandable;
  12 use Org\Mxchange\CoreFramework\Controller\Controller;
  13 use Org\Mxchange\CoreFramework\Factory\Object\ObjectFactory;
  14 use Org\Mxchange\CoreFramework\Request\Requestable;
  15 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  16 use Org\Mxchange\CoreFramework\Response\Responseable;
  17
  18 /**
  19  * A command for the city map
  20  *
  21  * @author              Roland Haeder <webmaster@shipsimu.org>
  22  * @version             0.0.0
  23  * @copyright   Copyright (c) 2015 - 2023 City Developer Team
  24  * @license             GNU GPL 3.0 or any newer version
  25  * @link                http://www.shipsimu.org
  26  *
  27  * This program is free software: you can redistribute it and/or modify
  28  * it under the terms of the GNU General Public License as published by
  29  * the Free Software Foundation, either version 3 of the License, or
  30  * (at your option) any later version.
  31  *
  32  * This program is distributed in the hope that it will be useful,
  33  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  34  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  35  * GNU General Public License for more details.
  36  *
  37  * You should have received a copy of the GNU General Public License
  38  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  39  */
  40 class CityHtmlCityMapCommand extends BaseCommand implements Commandable {
  41         /**
  42          * Protected constructor
  43          *
  44          * @return      void
  45          */
  46         protected function __construct () {
  47                 // Call parent constructor
  48                 parent::__construct(__CLASS__);
  49         }
  50
  51         /**
  52          * Creates an instance of this command and sets the resolver instance
  53          *
  54          * @param       $resolverInstance       An instance of a command resolver
  55          * @return      $commandInstance        The created command instance
  56          */
  57         public static final function createCityHtmlCityMapCommand (CommandResolver $resolverInstance) {
  58                 // Get a new instance
  59                 $commandInstance = new CityHtmlCityMapCommand();
  60
  61                 // Set the resolver instance
  62                 $commandInstance->setResolverInstance($resolverInstance);
  63
  64                 // Return the prepared instance
  65                 return $commandInstance;
  66         }
  67
  68         /**
  69          * Executes the command with given request and response objects
  70          *
  71          * @param       $requestInstance        An instance of a class with an Requestable interface
  72          * @param       $responseInstance       An instance of a class with an Responseable interface
  73          * @return      void
  74          */
  75         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  76                 // First get a UserRegistration instance
  77                 $managerInstance = ManagerFactory::createManagerByType('city');
  78
  79                 // Make sure the instance is valid
  80                 assert($managerInstance instanceof ManageableCity);
  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_class'));
 106
 107                 // Validate user status ('confirmed' no guest)
 108                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter_class'));
 109
 110                 // Check if city name is already used
 111                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('city_name_verifier_filter_class'));
 112
 113                 // Validate ...
 114                 //$controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_validator_filter_class'));
 115         }
 116 }