3 namespace Org\Mxchange\City\Command;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Request\Requestable;
7 use Org\Mxchange\CoreFramework\Response\Responseable;
10 * A command for user login
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2015, 2016 City Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
18 * This program is free software: you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation, either version 3 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 class CityHtmlCityUserLoginCommand extends BaseCommand implements Commandable {
33 * Protected constructor
37 protected function __construct () {
38 // Call parent constructor
39 parent::__construct(__CLASS__);
43 * Creates an instance of this command and sets the resolver instance
45 * @param $resolverInstance An instance of a command resolver
46 * @return $commandInstance The created command instance
48 public static final function createCityHtmlCityUserLoginCommand (CommandResolver $resolverInstance) {
50 $commandInstance = new CityHtmlCityUserLoginCommand();
52 // Set the resolver instance
53 $commandInstance->setResolverInstance($resolverInstance);
55 // Return the prepared instance
56 return $commandInstance;
60 * Executes the command with given request and response objects
62 * @param $requestInstance An instance of a class with an Requestable interface
63 * @param $responseInstance An instance of a class with an Responseable interface
66 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
67 // First get a UserLogin instance
68 $loginInstance = ObjectFactory::createObjectByConfiguredName('user_login_class');
70 // First set request and response instance
71 $loginInstance->setRequestInstance($requestInstance);
73 // Encrypt the password
74 $loginInstance->encryptPassword('pass');
77 $loginInstance->doLogin($requestInstance, $responseInstance);
79 // Was the login fine? Then redirect here
80 if ($loginInstance->ifLoginWasSuccessfull()) {
81 // Try to redirect here
84 $responseInstance->redirectToConfiguredUrl('app_login');
88 } catch (FrameworkException $e) {
89 // Something went wrong here!
90 $responseInstance->addFatalMessage($e->getMessage());
93 // Attach error message to the response
94 $responseInstance->addFatalMessage('failed_user_login');
99 * Adds extra filters to the given controller instance
101 * @param $controllerInstance A controller instance
102 * @param $requestInstance An instance of a class with an Requestable interface
104 * @todo Add more filters
106 public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
107 // Which login type do we have?
108 switch ($this->getConfigInstance()->getConfigEntry('login_type')) {
109 case 'username': // Login via username
110 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_verifier_filter'));
113 case 'email': // Login via email
114 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_verifier_filter'));
117 default: // Wether username or email is set
118 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_email_verifier_filter'));
122 // Password verifier filter
123 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_verifier_filter'));
125 // Add filter for CAPTCHA
126 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_user_verifier_filter'));