framework/main/classes/filter/verifier/class_PasswordGuestVerifierFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Filter\Verifier\User;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Filter\BaseFilter;
   7 use Org\Mxchange\CoreFramework\Filter\Filterable;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * A concrete filter for validating the guest password. This filter may intercept
  13  * the filter chain if no password is given or the password is invalid
  14  *
  15  * @author              Roland Haeder <webmaster@shipsimu.org>
  16  * @version             0.0.0
  17 <<<<<<< HEAD:framework/main/classes/filter/verifier/class_PasswordGuestVerifierFilter.php
  18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  19 =======
  20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  21 >>>>>>> Some updates::inc/main/classes/filter/verifier/class_PasswordGuestVerifierFilter.php
  22  * @license             GNU GPL 3.0 or any newer version
  23  * @link                http://www.shipsimu.org
  24  *
  25  * This program is free software: you can redistribute it and/or modify
  26  * it under the terms of the GNU General Public License as published by
  27  * the Free Software Foundation, either version 3 of the License, or
  28  * (at your option) any later version.
  29  *
  30  * This program is distributed in the hope that it will be useful,
  31  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  32  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  33  * GNU General Public License for more details.
  34  *
  35  * You should have received a copy of the GNU General Public License
  36  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  37  */
  38 class PasswordGuestVerifierFilter extends BaseFilter implements Filterable {
  39         /**
  40          * Protected constructor
  41          *
  42          * @return      void
  43          */
  44         protected function __construct () {
  45                 // Call parent constructor
  46                 parent::__construct(__CLASS__);
  47         }
  48
  49         /**
  50          * Creates an instance of this filter class
  51          *
  52          * @return      $filterInstance         An instance of this filter class
  53          */
  54         public static final function createPasswordGuestVerifierFilter () {
  55                 // Get a new instance
  56                 $filterInstance = new PasswordGuestVerifierFilter();
  57
  58                 // Return the instance
  59                 return $filterInstance;
  60         }
  61
  62         /**
  63          * Executes the filter with given request and response objects
  64          *
  65          * @param       $requestInstance        An instance of a class with an Requestable interface
  66          * @param       $responseInstance       An instance of a class with an Responseable interface
  67          * @return      void
  68          * @throws      FilterChainException    If this filter fails to operate
  69          */
  70         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  71                 // Get password
  72                 $password = $requestInstance->getRequestElement('passwd');
  73
  74                 // Is the password still not set?
  75                 if (is_null($password)) {
  76                         // Not found in form so stop the filtering process
  77                         $requestInstance->requestIsValid(false);
  78
  79                         // Add a message to the response
  80                         $responseInstance->addFatalMessage('password_unset');
  81
  82                         // Abort here
  83                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  84                 } elseif (empty($password)) {
  85                         // Password is empty
  86                         $requestInstance->requestIsValid(false);
  87
  88                         // Add a message to the response
  89                         $responseInstance->addFatalMessage('password_empty');
  90
  91                         // Abort here
  92                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  93                 }
  94         }
  95
  96 }