framework/main/interfaces/request/class_Requestable.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Request;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for requests
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13 <<<<<<< HEAD:framework/main/interfaces/request/class_Requestable.php
  14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  15 =======
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
  17 >>>>>>> Some updates::inc/main/interfaces/request/class_Requestable.php
  18  * @license             GNU GPL 3.0 or any newer version
  19  * @link                http://www.shipsimu.org
  20  *
  21  * This program is free software: you can redistribute it and/or modify
  22  * it under the terms of the GNU General Public License as published by
  23  * the Free Software Foundation, either version 3 of the License, or
  24  * (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  33  */
  34 interface Requestable extends FrameworkInterface {
  35         /**
  36          * Checks whether a request element is set
  37          *
  38          * @param       $element        Name of the request element we want to check
  39          * @return      $isSet          Whether the request element is set
  40          */
  41         function isRequestElementSet ($element);
  42
  43         /**
  44          * Getter for request element or 'null' if element was not found
  45          *
  46          * @param       $element        Name of the request element we want to check
  47          * @return      $value          Value of the found request element or 'null' if the
  48          *                                              element was not found
  49          */
  50         function getRequestElement ($element);
  51
  52         /**
  53          * Setter for request elements
  54          *
  55          * @param       $element        Request element to se
  56          * @param       $value          Value to set
  57          * @return      void
  58          */
  59         function setRequestElement ($element, $value);
  60
  61         /**
  62          * Setter for request data array
  63          *
  64          * @param       $requestData    Request element to se
  65          * @return      void
  66          */
  67         function setRequestData (array $requestData);
  68
  69         /**
  70          * Wrapper method for array_key() function for the request data array
  71          *
  72          * @return      $array  An array containing all array keys to return
  73          */
  74         function getParameterNames ();
  75
  76         /**
  77          * Sets whether the request was valid (default: true)
  78          *
  79          * @param       $isValid        Whether the request is valid
  80          * @return      void
  81          */
  82         function requestIsValid ($isValid = true);
  83
  84         /**
  85          * Returns whether this request is valid
  86          *
  87          * @return      $requestIsValid         Whether this request is valid
  88          */
  89         function isRequestValid ();
  90
  91 }