Inspection of "Added a missing changelog entry." - Mistralys/application-utils - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6ba584...289f9d )

by Sebastian

created 2021-07-08 07:38 UTC

Status

Indentation +22 added lines, -22 removed lines patch added patch discarded remove patch

@@ -23,37 +23,37 @@
 block discarded – undo
 {
     const ERROR_NOT_LOADED_YET = 56501;
     
-   /**
-    * @var \SimpleXMLElement|NULL
-    */
+    /**
+     * @var \SimpleXMLElement|NULL
+     */
     private $element = null;
     
-   /**
-    * @var XMLHelper_SimpleXML_Error[]
-    */
+    /**
+     * @var XMLHelper_SimpleXML_Error[]
+     */
     private $errors = array();
     
-   /**
-    * Creates a simplexml instance from an XML string.
-    *
-    * NOTE: returns false in case of a fatal error.
-    *
-    * @param string $string
-    * @return \SimpleXMLElement|NULL
-    */
+    /**
+     * Creates a simplexml instance from an XML string.
+     *
+     * NOTE: returns false in case of a fatal error.
+     *
+     * @param string $string
+     * @return \SimpleXMLElement|NULL
+     */
     public function loadString(string $string) : ?\SimpleXMLElement
     {
         return $this->load('string', $string);
     }
     
-   /**
-    * Creates a simplexml instance from an XML file.
-    * 
-    * NOTE: returns false in case of a fatal error.
-    * 
-    * @param string $file
-    * @return \SimpleXMLElement|NULL
-    */
+    /**
+     * Creates a simplexml instance from an XML file.
+     * 
+     * NOTE: returns false in case of a fatal error.
+     * 
+     * @param string $file
+     * @return \SimpleXMLElement|NULL
+     */
     public function loadFile(string $file) : ?\SimpleXMLElement
     {
         return $this->load('file', $file);

Please login to merge, or discard this patch.

src/XMLHelper/DOMErrors/Error.php 1 patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -24,9 +24,9 @@
 block discarded – undo
     const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201;
     const ERROR_ERROR_DATA_KEY_MISSING = 57202;
     
-   /**
-    * @var \LibXMLError
-    */
+    /**
+     * @var \LibXMLError
+     */
     private $error;
     
     private static $requiredKeys = array(

Please login to merge, or discard this patch.

src/XMLHelper/HTMLLoader.php 1 patch

Indentation +66 added lines, -66 removed lines patch added patch discarded remove patch

@@ -36,19 +36,19 @@  discard block
 block discarded – undo
 {
     const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001;
     
-   /**
-    * @var \DOMElement
-    */
+    /**
+     * @var \DOMElement
+     */
     private $bodyNode;
     
-   /**
-    * @var XMLHelper_DOMErrors
-    */
+    /**
+     * @var XMLHelper_DOMErrors
+     */
     private $errors;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private static $htmlTemplate = 
     '<!DOCTYPE html>'.
     '<html>'.
@@ -60,9 +60,9 @@  discard block
 block discarded – undo
         '</body>'.
     '</html>';
     
-   /**
-    * @var \DOMDocument
-    */
+    /**
+     * @var \DOMDocument
+     */
     private $dom;
 
     private function __construct(string $html)
@@ -70,13 +70,13 @@  discard block
 block discarded – undo
         $this->load($html);
     }
     
-   /**
-    * Creates an HTML loader from an HTML fragment (without
-    * doctype, head and body elements).
-    * 
-    * @param string $fragment
-    * @return XMLHelper_HTMLLoader
-    */
+    /**
+     * Creates an HTML loader from an HTML fragment (without
+     * doctype, head and body elements).
+     * 
+     * @param string $fragment
+     * @return XMLHelper_HTMLLoader
+     */
     public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader
     {
         self::checkFragment($fragment);
@@ -87,24 +87,24 @@  discard block
 block discarded – undo
         return new XMLHelper_HTMLLoader($pseudoHTML);
     }
     
-   /**
-    * Creates an HTML loader from a full HTML document (including
-    * doctype, head and body elements).
-    * 
-    * @param string $html
-    * @return XMLHelper_HTMLLoader
-    */
+    /**
+     * Creates an HTML loader from a full HTML document (including
+     * doctype, head and body elements).
+     * 
+     * @param string $html
+     * @return XMLHelper_HTMLLoader
+     */
     public static function loadHTML(string $html) : XMLHelper_HTMLLoader
     {
         return  new XMLHelper_HTMLLoader($html);
     }
 
-   /**
-    * Verifies that the fragment does not already contain a body element or doctype.
-    * 
-    * @param string $fragment
-    * @throws XMLHelper_Exception
-    */
+    /**
+     * Verifies that the fragment does not already contain a body element or doctype.
+     * 
+     * @param string $fragment
+     * @throws XMLHelper_Exception
+     */
     private static function checkFragment(string $fragment) : void
     {
         if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype'))
@@ -142,65 +142,65 @@  discard block
 block discarded – undo
         return $this->bodyNode;
     }
     
-   /**
-    * Retrieves the document's `<body>` tag node.
-    * 
-    * @return \DOMDocument
-    */
+    /**
+     * Retrieves the document's `<body>` tag node.
+     * 
+     * @return \DOMDocument
+     */
     public function getDOM() : \DOMDocument
     {
         return $this->dom;
     }
     
-   /**
-    * Retrieves all nodes from the HTML fragment (= child nodes
-    * of the `<body>` element).
-    * 
-    * @return \DOMNodeList
-    */
+    /**
+     * Retrieves all nodes from the HTML fragment (= child nodes
+     * of the `<body>` element).
+     * 
+     * @return \DOMNodeList
+     */
     public function getFragmentNodes() : \DOMNodeList
     {
         return $this->bodyNode->childNodes;
     }
     
-   /**
-    * Retrieves the LibXML HTML parsing errors collection, which
-    * can be used to review any errors that occurred while loading
-    * the HTML document.
-    * 
-    * @return XMLHelper_DOMErrors
-    */
+    /**
+     * Retrieves the LibXML HTML parsing errors collection, which
+     * can be used to review any errors that occurred while loading
+     * the HTML document.
+     * 
+     * @return XMLHelper_DOMErrors
+     */
     public function getErrors() : XMLHelper_DOMErrors
     {
         return $this->errors;
     }
     
-   /**
-    * Returns a valid HTML string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns a valid HTML string.
+     * 
+     * @return string
+     */
     public function toHTML() : string
     {
         return $this->dom->saveHTML();
     }
     
-   /**
-    * Returns a valid XML string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns a valid XML string.
+     * 
+     * @return string
+     */
     public function toXML() : string
     {
         return $this->dom->saveXML();
     }
     
-   /**
-    * Converts the HTML fragment to valid XML (= all
-    * child nodes of the `<body>` element).
-    * 
-    * @return string
-    */
+    /**
+     * Converts the HTML fragment to valid XML (= all
+     * child nodes of the `<body>` element).
+     * 
+     * @return string
+     */
     public function fragmentToXML() : string
     {
         $nodes = $this->getFragmentNodes();

Please login to merge, or discard this patch.

src/XMLHelper/DOMErrors.php 1 patch

Indentation +50 added lines, -50 removed lines patch added patch discarded remove patch

@@ -23,14 +23,14 @@  discard block
 block discarded – undo
 {
     const SERIALIZE_SEPARATOR = '__SERSEP__';
     
-   /**
-    * @var XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * @var XMLHelper_DOMErrors_Error[]
+     */
     private $errors;
     
-   /**
-    * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
-    */
+    /**
+     * @param \LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
+     */
     public function __construct(array $libxmlErrors)
     {
         foreach($libxmlErrors as $error)
@@ -56,11 +56,11 @@  discard block
 block discarded – undo
         return $this->errors;
     }
     
-   /**
-    * Retrieves all warnings, if any.
-    * 
-    * @return XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all warnings, if any.
+     * 
+     * @return XMLHelper_DOMErrors_Error[]
+     */
     public function getWarnings()
     {
         return $this->getByLevel(LIBXML_ERR_WARNING);
@@ -107,12 +107,12 @@  discard block
 block discarded – undo
     }
     
     
-   /**
-    * Retrieves all errors by the specified libxml error level.
-    * 
-    * @param int $level
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error level.
+     * 
+     * @param int $level
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
+     */
     public function getByLevel(int $level)
     {
         $result = array();
@@ -128,12 +128,12 @@  discard block
 block discarded – undo
         return $result;
     }
     
-   /**
-    * Retrieves all errors by the specified libxml error code.
-    * 
-    * @param int $code
-    * @return \AppUtils\XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error code.
+     * 
+     * @param int $code
+     * @return \AppUtils\XMLHelper_DOMErrors_Error[]
+     */
     public function getByCode(int $code)
     {
         $result = array();
@@ -149,12 +149,12 @@  discard block
 block discarded – undo
         return $result;
     }
     
-   /**
-    * Checks whether there are errors matching the libxml error level.
-    * 
-    * @param int $level
-    * @return bool
-    */
+    /**
+     * Checks whether there are errors matching the libxml error level.
+     * 
+     * @param int $level
+     * @return bool
+     */
     public function hasErrorsByLevel(int $level) : bool
     {
         foreach($this->errors as $error)
@@ -168,12 +168,12 @@  discard block
 block discarded – undo
         return false;
     }
     
-   /**
-    * Checks whether there are any errors matching the libxml error code.
-    * 
-    * @param int $code
-    * @return bool
-    */
+    /**
+     * Checks whether there are any errors matching the libxml error code.
+     * 
+     * @param int $code
+     * @return bool
+     */
     public function hasErrorsByCode(int $code) : bool
     {
         foreach($this->errors as $error)
@@ -199,13 +199,13 @@  discard block
 block discarded – undo
         return $result;
     }
     
-   /**
-    * Serializes the errors collection, so it can be stored and
-    * restored as needed, using the `fromSerialized()` method.
-    * 
-    * @return string
-    * @see XMLHelper_DOMErrors::fromSerialized()
-    */
+    /**
+     * Serializes the errors collection, so it can be stored and
+     * restored as needed, using the `fromSerialized()` method.
+     * 
+     * @return string
+     * @see XMLHelper_DOMErrors::fromSerialized()
+     */
     public function serialize() : string
     {
         $data = array();
@@ -218,14 +218,14 @@  discard block
 block discarded – undo
         return implode(self::SERIALIZE_SEPARATOR, $data);
     }
     
-   /**
-    * Restores the errors collection from a previously serialized
-    * collection, using `serialize()`. 
-    * 
-    * @param string $serialized
-    * @return XMLHelper_DOMErrors
-    * @see XMLHelper_DOMErrors::serialize()
-    */
+    /**
+     * Restores the errors collection from a previously serialized
+     * collection, using `serialize()`. 
+     * 
+     * @param string $serialized
+     * @return XMLHelper_DOMErrors
+     * @see XMLHelper_DOMErrors::serialize()
+     */
     public static function fromSerialized(string $serialized) : XMLHelper_DOMErrors
     {
         $parts = explode(self::SERIALIZE_SEPARATOR, $serialized);

Please login to merge, or discard this patch.

docs/libxml/generate-errorcodes.php 1 patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -14,9 +14,9 @@
 block discarded – undo
  * @see http://www.xmlsoft.org/html/libxml-xmlerror.html
  */
 
-   /**
-    * @var string $list
-    */
+    /**
+     * @var string $list
+     */
     $list = file_get_contents('libxmlerrors.txt');
     $outputFile = 'LibXML.php';
     $lines = explode("\n", $list);

Please login to merge, or discard this patch.

src/OperationResult.php 1 patch

Indentation +73 added lines, -73 removed lines patch added patch discarded remove patch

@@ -32,46 +32,46 @@  discard block
 block discarded – undo
     const TYPE_ERROR = 'error';
     const TYPE_SUCCESS = 'success';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message = '';
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
   
-   /**
-    * @var object
-    */
+    /**
+     * @var object
+     */
     protected $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $id;
     
-   /**
-    * The subject being validated.
-    * 
-    * @param object $subject
-    */
+    /**
+     * The subject being validated.
+     * 
+     * @param object $subject
+     */
     public function __construct(object $subject)
     {
         $this->subject = $subject;
@@ -81,21 +81,21 @@  discard block
 block discarded – undo
         $this->id = self::$counter;
     }
     
-   /**
-    * Retrieves the ID of the result, which is unique within a request.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the ID of the result, which is unique within a request.
+     * 
+     * @return int
+     */
     public function getID() : int
     {
         return $this->id;
     }
     
-   /**
-    * Whether the validation was successful.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the validation was successful.
+     * 
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->valid;
@@ -126,33 +126,33 @@  discard block
 block discarded – undo
         return $this->type === $type;
     }
     
-   /**
-    * Retrieves the subject that was validated.
-    * 
-    * @return object
-    */
+    /**
+     * Retrieves the subject that was validated.
+     * 
+     * @return object
+     */
     public function getSubject() : object
     {
         return $this->subject;
     }
     
-   /**
-    * Makes the result a succes, with the specified message.
-    * 
-    * @param string $message Should not contain a date, just the system specific info.
-    * @return OperationResult
-    */
+    /**
+     * Makes the result a succes, with the specified message.
+     * 
+     * @param string $message Should not contain a date, just the system specific info.
+     * @return OperationResult
+     */
     public function makeSuccess(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true);
     }
     
-   /**
-    * Sets the result as an error.
-    * 
-    * @param string $message Should be as detailed as possible.
-    * @return OperationResult
-    */
+    /**
+     * Sets the result as an error.
+     * 
+     * @param string $message Should be as detailed as possible.
+     * @return OperationResult
+     */
     public function makeError(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_ERROR, $message, $code, false);
@@ -183,21 +183,21 @@  discard block
 block discarded – undo
         return $this->type;
     }
     
-   /**
-    * Retrieves the error message, if an error occurred.
-    * 
-    * @return string The error message, or an empty string if no error occurred.
-    */
+    /**
+     * Retrieves the error message, if an error occurred.
+     * 
+     * @return string The error message, or an empty string if no error occurred.
+     */
     public function getErrorMessage() : string
     {
         return $this->getMessage(self::TYPE_ERROR);
     }
     
-   /**
-    * Retrieves the success message, if one has been provided.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the success message, if one has been provided.
+     * 
+     * @return string
+     */
     public function getSuccessMessage() : string
     {
         return $this->getMessage(self::TYPE_SUCCESS);
@@ -213,21 +213,21 @@  discard block
 block discarded – undo
         return $this->getMessage(self::TYPE_WARNING);
     }
     
-   /**
-    * Whether a specific error/success code has been specified.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether a specific error/success code has been specified.
+     * 
+     * @return bool
+     */
     public function hasCode() : bool
     {
         return $this->code > 0;
     }
     
-   /**
-    * Retrieves the error/success code, if any. 
-    * 
-    * @return int The error code, or 0 if none.
-    */
+    /**
+     * Retrieves the error/success code, if any. 
+     * 
+     * @return int The error code, or 0 if none.
+     */
     public function getCode() : int
     {
         return $this->code;

Please login to merge, or discard this patch.

src/OperationResult/Collection.php 1 patch

Indentation +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -26,9 +26,9 @@  discard block
 block discarded – undo
  */
 class OperationResult_Collection extends OperationResult
 {
-   /**
-    * @var OperationResult[]
-    */
+    /**
+     * @var OperationResult[]
+     */
     protected $results = array();
     
     public function makeError(string $message, int $code=0) : OperationResult
@@ -106,9 +106,9 @@  discard block
 block discarded – undo
         return $this;
     }
     
-   /**
-    * @return OperationResult[]
-    */
+    /**
+     * @return OperationResult[]
+     */
     public function getResults() : array
     {
         return $this->results;

Please login to merge, or discard this patch.

src/Request.php 1 patch

Indentation +142 added lines, -142 removed lines patch added patch discarded remove patch

@@ -39,9 +39,9 @@  discard block
 block discarded – undo
      */
     protected static $instance;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $baseURL = '';
     
     public function __construct()
@@ -51,10 +51,10 @@  discard block
 block discarded – undo
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     */
     protected function init()
     {
         
@@ -126,30 +126,30 @@  discard block
 block discarded – undo
         return $this->buildURL($params, $dispatcher);
     }
     
-   /**
-    * Retrieves the name of the current dispatcher script / page.
-    * This is made to be extended and implemented in a subclass.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the name of the current dispatcher script / page.
+     * This is made to be extended and implemented in a subclass.
+     * 
+     * @return string
+     */
     public function getDispatcher() : string
     {
         return '';
     }
     
-   /**
-    * Filters and retrieves the current request variables 
-    * to be used to build an URL to refresh the current page.
-    * 
-    * For further customization options, use the 
-    * {@see Request::createRefreshParams()} method.
-    * 
-    * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
-    * @param string[] $exclude Names of parameters to exclude from the result.
-    * @return array<string,mixed>
-    * 
-    * @see Request::createRefreshParams()
-    */
+    /**
+     * Filters and retrieves the current request variables 
+     * to be used to build an URL to refresh the current page.
+     * 
+     * For further customization options, use the 
+     * {@see Request::createRefreshParams()} method.
+     * 
+     * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
+     * @param string[] $exclude Names of parameters to exclude from the result.
+     * @return array<string,mixed>
+     * 
+     * @see Request::createRefreshParams()
+     */
     public function getRefreshParams(array $params = array(), array $exclude = array())
     {
         return $this->createRefreshParams()
@@ -158,13 +158,13 @@  discard block
 block discarded – undo
         ->getParams();
     }
     
-   /**
-    * Creates an instance of the helper that can be used to
-    * retrieve the request's parameters collection, with the
-    * possiblity to exlude and override some by rules.
-    * 
-    * @return Request_RefreshParams
-    */
+    /**
+     * Creates an instance of the helper that can be used to
+     * retrieve the request's parameters collection, with the
+     * possiblity to exlude and override some by rules.
+     * 
+     * @return Request_RefreshParams
+     */
     public function createRefreshParams() : Request_RefreshParams
     {
         return new Request_RefreshParams();
@@ -197,10 +197,10 @@  discard block
 block discarded – undo
         return $url;
     }
     
-   /**
-    * Retrieves the base URL of the application.
-    * @return string
-    */
+    /**
+     * Retrieves the base URL of the application.
+     * @return string
+     */
     public function getBaseURL() : string
     {
         return $this->baseURL;
@@ -230,13 +230,13 @@  discard block
 block discarded – undo
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @throws Request_Exception
-    * @return Request_Param
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @throws Request_Exception
+     * @return Request_Param
+     */
     public function getRegisteredParam(string $name) : Request_Param
     {
         if(isset($this->knownParams[$name])) {
@@ -253,48 +253,48 @@  discard block
 block discarded – undo
         );
     }
     
-   /**
-    * Checks whether a parameter with the specified name 
-    * has been registered.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a parameter with the specified name 
+     * has been registered.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function hasRegisteredParam(string $name) : bool
     {
         return isset($this->knownParams[$name]);
     }
     
-   /**
-    * Retrieves an indexed array with accept mime types
-    * that the client sent, in the order of preference
-    * the client specified.
-    *
-    * Example:
-    *
-    * array(
-    *     'text/html',
-    *     'application/xhtml+xml',
-    *     'image/webp'
-    *     ...
-    * )
-    * 
-    * @return array
-    * @see Request::parseAcceptHeaders()
-    */
+    /**
+     * Retrieves an indexed array with accept mime types
+     * that the client sent, in the order of preference
+     * the client specified.
+     *
+     * Example:
+     *
+     * array(
+     *     'text/html',
+     *     'application/xhtml+xml',
+     *     'image/webp'
+     *     ...
+     * )
+     * 
+     * @return array
+     * @see Request::parseAcceptHeaders()
+     */
     public static function getAcceptHeaders() : array
     {
         return self::parseAcceptHeaders()->getMimeStrings();
     }
     
-   /**
-    * Returns an instance of the accept headers parser,
-    * to access information on the browser's accepted
-    * mime types.
-    *  
-    * @return Request_AcceptHeaders
-    * @see Request::getAcceptHeaders()
-    */
+    /**
+     * Returns an instance of the accept headers parser,
+     * to access information on the browser's accepted
+     * mime types.
+     *  
+     * @return Request_AcceptHeaders
+     * @see Request::getAcceptHeaders()
+     */
     public static function parseAcceptHeaders() : Request_AcceptHeaders
     {
         static $accept;
@@ -342,14 +342,14 @@  discard block
 block discarded – undo
         return false;
     }
     
-   /**
-    * Removes a single parameter from the request.
-    * If the parameter has been registered, also
-    * removes the registration info.
-    * 
-    * @param string $name
-    * @return Request
-    */
+    /**
+     * Removes a single parameter from the request.
+     * If the parameter has been registered, also
+     * removes the registration info.
+     * 
+     * @param string $name
+     * @return Request
+     */
     public function removeParam(string $name) : Request
     {
         if(isset($_REQUEST[$name])) {
@@ -363,12 +363,12 @@  discard block
 block discarded – undo
         return $this;
     }
     
-   /**
-    * Removes several parameters from the request.
-    * 
-    * @param string[] $names
-    * @return Request
-    */
+    /**
+     * Removes several parameters from the request.
+     * 
+     * @param string[] $names
+     * @return Request
+     */
     public function removeParams(array $names) : Request
     {
         foreach($names as $name) {
@@ -435,18 +435,18 @@  discard block
 block discarded – undo
         return $val;
     }
     
-   /**
-    * Treats the request parameter as a JSON string, and
-    * if it exists and contains valid JSON, returns the
-    * decoded JSON value as an array (default).
-    *
-    * @param string $name
-    * @param bool $assoc
-    * @return array|object
-    * 
-    * @see Request::getJSONAssoc()
-    * @see Request::getJSONObject()
-    */
+    /**
+     * Treats the request parameter as a JSON string, and
+     * if it exists and contains valid JSON, returns the
+     * decoded JSON value as an array (default).
+     *
+     * @param string $name
+     * @param bool $assoc
+     * @return array|object
+     * 
+     * @see Request::getJSONAssoc()
+     * @see Request::getJSONObject()
+     */
     public function getJSON(string $name, bool $assoc=true)
     {
         $value = $this->getParam($name);
@@ -471,13 +471,13 @@  discard block
 block discarded – undo
         return new \stdClass();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    * 
-    * @param string $name
-    * @return array
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     * 
+     * @param string $name
+     * @return array
+     */
     public function getJSONAssoc(string $name) : array
     {
         $result = $this->getJSON($name);
@@ -488,13 +488,13 @@  discard block
 block discarded – undo
         return array();
     }
     
-   /**
-    * Like {@link Request::getJSON()}, but omitting the second
-    * parameter. Use this for more readable code.
-    *
-    * @param string $name
-    * @return object
-    */
+    /**
+     * Like {@link Request::getJSON()}, but omitting the second
+     * parameter. Use this for more readable code.
+     *
+     * @param string $name
+     * @return object
+     */
     public function getJSONObject(string $name) : object
     {
         $result = $this->getJSON($name, false);
@@ -505,12 +505,12 @@  discard block
 block discarded – undo
         return new \stdClass();
     }
     
-   /**
-    * Sends a JSON response with the correct headers.
-    *
-    * @param array|string $data
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends a JSON response with the correct headers.
+     *
+     * @param array|string $data
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendJSON($data, bool $exit=true)
     {
         $payload = $data;
@@ -530,12 +530,12 @@  discard block
 block discarded – undo
         }
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    * @param bool $exit Whether to exit the script afterwards.
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     * @param bool $exit Whether to exit the script afterwards.
+     */
     public static function sendHTML(string $html, bool $exit=true)
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -550,16 +550,16 @@  discard block
 block discarded – undo
         }
     }
     
-   /**
-    * Creates a new instance of the URL comparer, which can check 
-    * whether the specified URLs match, regardless of the order in 
-    * which the query parameters are, if any.
-    * 
-    * @param string $sourceURL
-    * @param string $targetURL
-    * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
-    * @return Request_URLComparer
-    */
+    /**
+     * Creates a new instance of the URL comparer, which can check 
+     * whether the specified URLs match, regardless of the order in 
+     * which the query parameters are, if any.
+     * 
+     * @param string $sourceURL
+     * @param string $targetURL
+     * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
+     * @return Request_URLComparer
+     */
     public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
     {
         $comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
@@ -568,10 +568,10 @@  discard block
 block discarded – undo
         return $comparer;
     }
     
-   /**
-    * Retrieves the full URL that was used to access the current page.
-    * @return string
-    */
+    /**
+     * Retrieves the full URL that was used to access the current page.
+     * @return string
+     */
     public function getCurrentURL() : string
     {
         return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

Please login to merge, or discard this patch.

src/Request/RefreshParams/Exclude/Name.php 1 patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -19,9 +19,9 @@
 block discarded – undo
  */
 class Request_RefreshParams_Exclude_Name extends Request_RefreshParams_Exclude
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     private $name;
     
     public function __construct(string $paramName)

Please login to merge, or discard this patch.

		@@ -23,37 +23,37 @@
		block discarded – undo
23	23	{
24	24	const ERROR_NOT_LOADED_YET = 56501;
25	25
26		- /**
27		- * @var \SimpleXMLElement\|NULL
28		- */
	26	+ /**
	27	+ * @var \SimpleXMLElement\|NULL
	28	+ */
29	29	private $element = null;
30	30
31		- /**
32		- * @var XMLHelper_SimpleXML_Error[]
33		- */
	31	+ /**
	32	+ * @var XMLHelper_SimpleXML_Error[]
	33	+ */
34	34	private $errors = array();
35	35
36		- /**
37		- * Creates a simplexml instance from an XML string.
38		- *
39		- * NOTE: returns false in case of a fatal error.
40		- *
41		- * @param string $string
42		- * @return \SimpleXMLElement\|NULL
43		- */
	36	+ /**
	37	+ * Creates a simplexml instance from an XML string.
	38	+ *
	39	+ * NOTE: returns false in case of a fatal error.
	40	+ *
	41	+ * @param string $string
	42	+ * @return \SimpleXMLElement\|NULL
	43	+ */
44	44	public function loadString(string $string) : ?\SimpleXMLElement
45	45	{
46	46	return $this->load('string', $string);
47	47	}
48	48
49		- /**
50		- * Creates a simplexml instance from an XML file.
51		- *
52		- * NOTE: returns false in case of a fatal error.
53		- *
54		- * @param string $file
55		- * @return \SimpleXMLElement\|NULL
56		- */
	49	+ /**
	50	+ * Creates a simplexml instance from an XML file.
	51	+ *
	52	+ * NOTE: returns false in case of a fatal error.
	53	+ *
	54	+ * @param string $file
	55	+ * @return \SimpleXMLElement\|NULL
	56	+ */
57	57	public function loadFile(string $file) : ?\SimpleXMLElement
58	58	{
59	59	return $this->load('file', $file);

		@@ -24,9 +24,9 @@
		block discarded – undo
24	24	const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201;
25	25	const ERROR_ERROR_DATA_KEY_MISSING = 57202;
26	26
27		- /**
28		- * @var \LibXMLError
29		- */
	27	+ /**
	28	+ * @var \LibXMLError
	29	+ */
30	30	private $error;
31	31
32	32	private static $requiredKeys = array(

		@@ -36,19 +36,19 @@ discard block
		block discarded – undo
36	36	{
37	37	const ERROR_STRING_ALREADY_HAS_BODY_TAG = 57001;
38	38
39		- /**
40		- * @var \DOMElement
41		- */
	39	+ /**
	40	+ * @var \DOMElement
	41	+ */
42	42	private $bodyNode;
43	43
44		- /**
45		- * @var XMLHelper_DOMErrors
46		- */
	44	+ /**
	45	+ * @var XMLHelper_DOMErrors
	46	+ */
47	47	private $errors;
48	48
49		- /**
50		- * @var string
51		- */
	49	+ /**
	50	+ * @var string
	51	+ */
52	52	private static $htmlTemplate =
53	53	'<!DOCTYPE html>'.
54	54	'<html>'.
		@@ -60,9 +60,9 @@ discard block
		block discarded – undo
60	60	'</body>'.
61	61	'</html>';
62	62
63		- /**
64		- * @var \DOMDocument
65		- */
	63	+ /**
	64	+ * @var \DOMDocument
	65	+ */
66	66	private $dom;
67	67
68	68	private function __construct(string $html)
		@@ -70,13 +70,13 @@ discard block
		block discarded – undo
70	70	$this->load($html);
71	71	}
72	72
73		- /**
74		- * Creates an HTML loader from an HTML fragment (without
75		- * doctype, head and body elements).
76		- *
77		- * @param string $fragment
78		- * @return XMLHelper_HTMLLoader
79		- */
	73	+ /**
	74	+ * Creates an HTML loader from an HTML fragment (without
	75	+ * doctype, head and body elements).
	76	+ *
	77	+ * @param string $fragment
	78	+ * @return XMLHelper_HTMLLoader
	79	+ */
80	80	public static function loadFragment(string $fragment) : XMLHelper_HTMLLoader
81	81	{
82	82	self::checkFragment($fragment);
		@@ -87,24 +87,24 @@ discard block
		block discarded – undo
87	87	return new XMLHelper_HTMLLoader($pseudoHTML);
88	88	}
89	89
90		- /**
91		- * Creates an HTML loader from a full HTML document (including
92		- * doctype, head and body elements).
93		- *
94		- * @param string $html
95		- * @return XMLHelper_HTMLLoader
96		- */
	90	+ /**
	91	+ * Creates an HTML loader from a full HTML document (including
	92	+ * doctype, head and body elements).
	93	+ *
	94	+ * @param string $html
	95	+ * @return XMLHelper_HTMLLoader
	96	+ */
97	97	public static function loadHTML(string $html) : XMLHelper_HTMLLoader
98	98	{
99	99	return new XMLHelper_HTMLLoader($html);
100	100	}
101	101
102		- /**
103		- * Verifies that the fragment does not already contain a body element or doctype.
104		- *
105		- * @param string $fragment
106		- * @throws XMLHelper_Exception
107		- */
	102	+ /**
	103	+ * Verifies that the fragment does not already contain a body element or doctype.
	104	+ *
	105	+ * @param string $fragment
	106	+ * @throws XMLHelper_Exception
	107	+ */
108	108	private static function checkFragment(string $fragment) : void
109	109	{
110	110	if(!stristr($fragment, '<body') && !stristr($fragment, 'doctype'))
		@@ -142,65 +142,65 @@ discard block
		block discarded – undo
142	142	return $this->bodyNode;
143	143	}
144	144
145		- /**
146		- * Retrieves the document's `<body>` tag node.
147		- *
148		- * @return \DOMDocument
149		- */
	145	+ /**
	146	+ * Retrieves the document's `<body>` tag node.
	147	+ *
	148	+ * @return \DOMDocument
	149	+ */
150	150	public function getDOM() : \DOMDocument
151	151	{
152	152	return $this->dom;
153	153	}
154	154
155		- /**
156		- * Retrieves all nodes from the HTML fragment (= child nodes
157		- * of the `<body>` element).
158		- *
159		- * @return \DOMNodeList
160		- */
	155	+ /**
	156	+ * Retrieves all nodes from the HTML fragment (= child nodes
	157	+ * of the `<body>` element).
	158	+ *
	159	+ * @return \DOMNodeList
	160	+ */
161	161	public function getFragmentNodes() : \DOMNodeList
162	162	{
163	163	return $this->bodyNode->childNodes;
164	164	}
165	165
166		- /**
167		- * Retrieves the LibXML HTML parsing errors collection, which
168		- * can be used to review any errors that occurred while loading
169		- * the HTML document.
170		- *
171		- * @return XMLHelper_DOMErrors
172		- */
	166	+ /**
	167	+ * Retrieves the LibXML HTML parsing errors collection, which
	168	+ * can be used to review any errors that occurred while loading
	169	+ * the HTML document.
	170	+ *
	171	+ * @return XMLHelper_DOMErrors
	172	+ */
173	173	public function getErrors() : XMLHelper_DOMErrors
174	174	{
175	175	return $this->errors;
176	176	}
177	177
178		- /**
179		- * Returns a valid HTML string.
180		- *
181		- * @return string
182		- */
	178	+ /**
	179	+ * Returns a valid HTML string.
	180	+ *
	181	+ * @return string
	182	+ */
183	183	public function toHTML() : string
184	184	{
185	185	return $this->dom->saveHTML();
186	186	}
187	187
188		- /**
189		- * Returns a valid XML string.
190		- *
191		- * @return string
192		- */
	188	+ /**
	189	+ * Returns a valid XML string.
	190	+ *
	191	+ * @return string
	192	+ */
193	193	public function toXML() : string
194	194	{
195	195	return $this->dom->saveXML();
196	196	}
197	197
198		- /**
199		- * Converts the HTML fragment to valid XML (= all
200		- * child nodes of the `<body>` element).
201		- *
202		- * @return string
203		- */
	198	+ /**
	199	+ * Converts the HTML fragment to valid XML (= all
	200	+ * child nodes of the `<body>` element).
	201	+ *
	202	+ * @return string
	203	+ */
204	204	public function fragmentToXML() : string
205	205	{
206	206	$nodes = $this->getFragmentNodes();

		@@ -23,14 +23,14 @@ discard block
		block discarded – undo
23	23	{
24	24	const SERIALIZE_SEPARATOR = '__SERSEP__';
25	25
26		- /**
27		- * @var XMLHelper_DOMErrors_Error[]
28		- */
	26	+ /**
	27	+ * @var XMLHelper_DOMErrors_Error[]
	28	+ */
29	29	private $errors;
30	30
31		- /**
32		- * @param \LibXMLError[]\|XMLHelper_DOMErrors_Error[] $libxmlErrors
33		- */
	31	+ /**
	32	+ * @param \LibXMLError[]\|XMLHelper_DOMErrors_Error[] $libxmlErrors
	33	+ */
34	34	public function __construct(array $libxmlErrors)
35	35	{
36	36	foreach($libxmlErrors as $error)
		@@ -56,11 +56,11 @@ discard block
		block discarded – undo
56	56	return $this->errors;
57	57	}
58	58
59		- /**
60		- * Retrieves all warnings, if any.
61		- *
62		- * @return XMLHelper_DOMErrors_Error[]
63		- */
	59	+ /**
	60	+ * Retrieves all warnings, if any.
	61	+ *
	62	+ * @return XMLHelper_DOMErrors_Error[]
	63	+ */
64	64	public function getWarnings()
65	65	{
66	66	return $this->getByLevel(LIBXML_ERR_WARNING);
		@@ -107,12 +107,12 @@ discard block
		block discarded – undo
107	107	}
108	108
109	109
110		- /**
111		- * Retrieves all errors by the specified libxml error level.
112		- *
113		- * @param int $level
114		- * @return \AppUtils\XMLHelper_DOMErrors_Error[]
115		- */
	110	+ /**
	111	+ * Retrieves all errors by the specified libxml error level.
	112	+ *
	113	+ * @param int $level
	114	+ * @return \AppUtils\XMLHelper_DOMErrors_Error[]
	115	+ */
116	116	public function getByLevel(int $level)
117	117	{
118	118	$result = array();
		@@ -128,12 +128,12 @@ discard block
		block discarded – undo
128	128	return $result;
129	129	}
130	130
131		- /**
132		- * Retrieves all errors by the specified libxml error code.
133		- *
134		- * @param int $code
135		- * @return \AppUtils\XMLHelper_DOMErrors_Error[]
136		- */
	131	+ /**
	132	+ * Retrieves all errors by the specified libxml error code.
	133	+ *
	134	+ * @param int $code
	135	+ * @return \AppUtils\XMLHelper_DOMErrors_Error[]
	136	+ */
137	137	public function getByCode(int $code)
138	138	{
139	139	$result = array();
		@@ -149,12 +149,12 @@ discard block
		block discarded – undo
149	149	return $result;
150	150	}
151	151
152		- /**
153		- * Checks whether there are errors matching the libxml error level.
154		- *
155		- * @param int $level
156		- * @return bool
157		- */
	152	+ /**
	153	+ * Checks whether there are errors matching the libxml error level.
	154	+ *
	155	+ * @param int $level
	156	+ * @return bool
	157	+ */
158	158	public function hasErrorsByLevel(int $level) : bool
159	159	{
160	160	foreach($this->errors as $error)
		@@ -168,12 +168,12 @@ discard block
		block discarded – undo
168	168	return false;
169	169	}
170	170
171		- /**
172		- * Checks whether there are any errors matching the libxml error code.
173		- *
174		- * @param int $code
175		- * @return bool
176		- */
	171	+ /**
	172	+ * Checks whether there are any errors matching the libxml error code.
	173	+ *
	174	+ * @param int $code
	175	+ * @return bool
	176	+ */
177	177	public function hasErrorsByCode(int $code) : bool
178	178	{
179	179	foreach($this->errors as $error)
		@@ -199,13 +199,13 @@ discard block
		block discarded – undo
199	199	return $result;
200	200	}
201	201
202		- /**
203		- * Serializes the errors collection, so it can be stored and
204		- * restored as needed, using the `fromSerialized()` method.
205		- *
206		- * @return string
207		- * @see XMLHelper_DOMErrors::fromSerialized()
208		- */
	202	+ /**
	203	+ * Serializes the errors collection, so it can be stored and
	204	+ * restored as needed, using the `fromSerialized()` method.
	205	+ *
	206	+ * @return string
	207	+ * @see XMLHelper_DOMErrors::fromSerialized()
	208	+ */
209	209	public function serialize() : string
210	210	{
211	211	$data = array();
		@@ -218,14 +218,14 @@ discard block
		block discarded – undo
218	218	return implode(self::SERIALIZE_SEPARATOR, $data);
219	219	}
220	220
221		- /**
222		- * Restores the errors collection from a previously serialized
223		- * collection, using `serialize()`.
224		- *
225		- * @param string $serialized
226		- * @return XMLHelper_DOMErrors
227		- * @see XMLHelper_DOMErrors::serialize()
228		- */
	221	+ /**
	222	+ * Restores the errors collection from a previously serialized
	223	+ * collection, using `serialize()`.
	224	+ *
	225	+ * @param string $serialized
	226	+ * @return XMLHelper_DOMErrors
	227	+ * @see XMLHelper_DOMErrors::serialize()
	228	+ */
229	229	public static function fromSerialized(string $serialized) : XMLHelper_DOMErrors
230	230	{
231	231	$parts = explode(self::SERIALIZE_SEPARATOR, $serialized);

		@@ -14,9 +14,9 @@
		block discarded – undo
14	14	* @see http://www.xmlsoft.org/html/libxml-xmlerror.html
15	15	*/
16	16
17		- /**
18		- * @var string $list
19		- */
	17	+ /**
	18	+ * @var string $list
	19	+ */
20	20	$list = file_get_contents('libxmlerrors.txt');
21	21	$outputFile = 'LibXML.php';
22	22	$lines = explode("\n", $list);

		@@ -32,46 +32,46 @@ discard block
		block discarded – undo
32	32	const TYPE_ERROR = 'error';
33	33	const TYPE_SUCCESS = 'success';
34	34
35		- /**
36		- * @var string
37		- */
	35	+ /**
	36	+ * @var string
	37	+ */
38	38	protected $message = '';
39	39
40		- /**
41		- * @var bool
42		- */
	40	+ /**
	41	+ * @var bool
	42	+ */
43	43	protected $valid = true;
44	44
45		- /**
46		- * @var object
47		- */
	45	+ /**
	46	+ * @var object
	47	+ */
48	48	protected $subject;
49	49
50		- /**
51		- * @var integer
52		- */
	50	+ /**
	51	+ * @var integer
	52	+ */
53	53	protected $code = 0;
54	54
55		- /**
56		- * @var string
57		- */
	55	+ /**
	56	+ * @var string
	57	+ */
58	58	protected $type = '';
59	59
60		- /**
61		- * @var integer
62		- */
	60	+ /**
	61	+ * @var integer
	62	+ */
63	63	private static $counter = 0;
64	64
65		- /**
66		- * @var int
67		- */
	65	+ /**
	66	+ * @var int
	67	+ */
68	68	private $id;
69	69
70		- /**
71		- * The subject being validated.
72		- *
73		- * @param object $subject
74		- */
	70	+ /**
	71	+ * The subject being validated.
	72	+ *
	73	+ * @param object $subject
	74	+ */
75	75	public function __construct(object $subject)
76	76	{
77	77	$this->subject = $subject;
		@@ -81,21 +81,21 @@ discard block
		block discarded – undo
81	81	$this->id = self::$counter;
82	82	}
83	83
84		- /**
85		- * Retrieves the ID of the result, which is unique within a request.
86		- *
87		- * @return int
88		- */
	84	+ /**
	85	+ * Retrieves the ID of the result, which is unique within a request.
	86	+ *
	87	+ * @return int
	88	+ */
89	89	public function getID() : int
90	90	{
91	91	return $this->id;
92	92	}
93	93
94		- /**
95		- * Whether the validation was successful.
96		- *
97		- * @return bool
98		- */
	94	+ /**
	95	+ * Whether the validation was successful.
	96	+ *
	97	+ * @return bool
	98	+ */
99	99	public function isValid() : bool
100	100	{
101	101	return $this->valid;
		@@ -126,33 +126,33 @@ discard block
		block discarded – undo
126	126	return $this->type === $type;
127	127	}
128	128
129		- /**
130		- * Retrieves the subject that was validated.
131		- *
132		- * @return object
133		- */
	129	+ /**
	130	+ * Retrieves the subject that was validated.
	131	+ *
	132	+ * @return object
	133	+ */
134	134	public function getSubject() : object
135	135	{
136	136	return $this->subject;
137	137	}
138	138
139		- /**
140		- * Makes the result a succes, with the specified message.
141		- *
142		- * @param string $message Should not contain a date, just the system specific info.
143		- * @return OperationResult
144		- */
	139	+ /**
	140	+ * Makes the result a succes, with the specified message.
	141	+ *
	142	+ * @param string $message Should not contain a date, just the system specific info.
	143	+ * @return OperationResult
	144	+ */
145	145	public function makeSuccess(string $message, int $code=0) : OperationResult
146	146	{
147	147	return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true);
148	148	}
149	149
150		- /**
151		- * Sets the result as an error.
152		- *
153		- * @param string $message Should be as detailed as possible.
154		- * @return OperationResult
155		- */
	150	+ /**
	151	+ * Sets the result as an error.
	152	+ *
	153	+ * @param string $message Should be as detailed as possible.
	154	+ * @return OperationResult
	155	+ */
156	156	public function makeError(string $message, int $code=0) : OperationResult
157	157	{
158	158	return $this->setMessage(self::TYPE_ERROR, $message, $code, false);
		@@ -183,21 +183,21 @@ discard block
		block discarded – undo
183	183	return $this->type;
184	184	}
185	185
186		- /**
187		- * Retrieves the error message, if an error occurred.
188		- *
189		- * @return string The error message, or an empty string if no error occurred.
190		- */
	186	+ /**
	187	+ * Retrieves the error message, if an error occurred.
	188	+ *
	189	+ * @return string The error message, or an empty string if no error occurred.
	190	+ */
191	191	public function getErrorMessage() : string
192	192	{
193	193	return $this->getMessage(self::TYPE_ERROR);
194	194	}
195	195
196		- /**
197		- * Retrieves the success message, if one has been provided.
198		- *
199		- * @return string
200		- */
	196	+ /**
	197	+ * Retrieves the success message, if one has been provided.
	198	+ *
	199	+ * @return string
	200	+ */
201	201	public function getSuccessMessage() : string
202	202	{
203	203	return $this->getMessage(self::TYPE_SUCCESS);
		@@ -213,21 +213,21 @@ discard block
		block discarded – undo
213	213	return $this->getMessage(self::TYPE_WARNING);
214	214	}
215	215
216		- /**
217		- * Whether a specific error/success code has been specified.
218		- *
219		- * @return bool
220		- */
	216	+ /**
	217	+ * Whether a specific error/success code has been specified.
	218	+ *
	219	+ * @return bool
	220	+ */
221	221	public function hasCode() : bool
222	222	{
223	223	return $this->code > 0;
224	224	}
225	225
226		- /**
227		- * Retrieves the error/success code, if any.
228		- *
229		- * @return int The error code, or 0 if none.
230		- */
	226	+ /**
	227	+ * Retrieves the error/success code, if any.
	228	+ *
	229	+ * @return int The error code, or 0 if none.
	230	+ */
231	231	public function getCode() : int
232	232	{
233	233	return $this->code;

		@@ -26,9 +26,9 @@ discard block
		block discarded – undo
26	26	*/
27	27	class OperationResult_Collection extends OperationResult
28	28	{
29		- /**
30		- * @var OperationResult[]
31		- */
	29	+ /**
	30	+ * @var OperationResult[]
	31	+ */
32	32	protected $results = array();
33	33
34	34	public function makeError(string $message, int $code=0) : OperationResult
		@@ -106,9 +106,9 @@ discard block
		block discarded – undo
106	106	return $this;
107	107	}
108	108
109		- /**
110		- * @return OperationResult[]
111		- */
	109	+ /**
	110	+ * @return OperationResult[]
	111	+ */
112	112	public function getResults() : array
113	113	{
114	114	return $this->results;

		@@ -39,9 +39,9 @@ discard block
		block discarded – undo
39	39	*/
40	40	protected static $instance;
41	41
42		- /**
43		- * @var string
44		- */
	42	+ /**
	43	+ * @var string
	44	+ */
45	45	protected $baseURL = '';
46	46
47	47	public function __construct()
		@@ -51,10 +51,10 @@ discard block
		block discarded – undo
51	51	$this->init();
52	52	}
53	53
54		- /**
55		- * Can be extended in a subclass, to avoid
56		- * redefining the constructor.
57		- */
	54	+ /**
	55	+ * Can be extended in a subclass, to avoid
	56	+ * redefining the constructor.
	57	+ */
58	58	protected function init()
59	59	{
60	60
		@@ -126,30 +126,30 @@ discard block
		block discarded – undo
126	126	return $this->buildURL($params, $dispatcher);
127	127	}
128	128
129		- /**
130		- * Retrieves the name of the current dispatcher script / page.
131		- * This is made to be extended and implemented in a subclass.
132		- *
133		- * @return string
134		- */
	129	+ /**
	130	+ * Retrieves the name of the current dispatcher script / page.
	131	+ * This is made to be extended and implemented in a subclass.
	132	+ *
	133	+ * @return string
	134	+ */
135	135	public function getDispatcher() : string
136	136	{
137	137	return '';
138	138	}
139	139
140		- /**
141		- * Filters and retrieves the current request variables
142		- * to be used to build an URL to refresh the current page.
143		- *
144		- * For further customization options, use the
145		- * {@see Request::createRefreshParams()} method.
146		- *
147		- * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
148		- * @param string[] $exclude Names of parameters to exclude from the result.
149		- * @return array<string,mixed>
150		- *
151		- * @see Request::createRefreshParams()
152		- */
	140	+ /**
	141	+ * Filters and retrieves the current request variables
	142	+ * to be used to build an URL to refresh the current page.
	143	+ *
	144	+ * For further customization options, use the
	145	+ * {@see Request::createRefreshParams()} method.
	146	+ *
	147	+ * @param array<string,mixed> $params Key => value pairs of parameters to always include in the result.
	148	+ * @param string[] $exclude Names of parameters to exclude from the result.
	149	+ * @return array<string,mixed>
	150	+ *
	151	+ * @see Request::createRefreshParams()
	152	+ */
153	153	public function getRefreshParams(array $params = array(), array $exclude = array())
154	154	{
155	155	return $this->createRefreshParams()
		@@ -158,13 +158,13 @@ discard block
		block discarded – undo
158	158	->getParams();
159	159	}
160	160
161		- /**
162		- * Creates an instance of the helper that can be used to
163		- * retrieve the request's parameters collection, with the
164		- * possiblity to exlude and override some by rules.
165		- *
166		- * @return Request_RefreshParams
167		- */
	161	+ /**
	162	+ * Creates an instance of the helper that can be used to
	163	+ * retrieve the request's parameters collection, with the
	164	+ * possiblity to exlude and override some by rules.
	165	+ *
	166	+ * @return Request_RefreshParams
	167	+ */
168	168	public function createRefreshParams() : Request_RefreshParams
169	169	{
170	170	return new Request_RefreshParams();
		@@ -197,10 +197,10 @@ discard block
		block discarded – undo
197	197	return $url;
198	198	}
199	199
200		- /**
201		- * Retrieves the base URL of the application.
202		- * @return string
203		- */
	200	+ /**
	201	+ * Retrieves the base URL of the application.
	202	+ * @return string
	203	+ */
204	204	public function getBaseURL() : string
205	205	{
206	206	return $this->baseURL;
		@@ -230,13 +230,13 @@ discard block
		block discarded – undo
230	230	return $this->knownParams[$name];
231	231	}
232	232
233		- /**
234		- * Retrieves a previously registered parameter instance.
235		- *
236		- * @param string $name
237		- * @throws Request_Exception
238		- * @return Request_Param
239		- */
	233	+ /**
	234	+ * Retrieves a previously registered parameter instance.
	235	+ *
	236	+ * @param string $name
	237	+ * @throws Request_Exception
	238	+ * @return Request_Param
	239	+ */
240	240	public function getRegisteredParam(string $name) : Request_Param
241	241	{
242	242	if(isset($this->knownParams[$name])) {
		@@ -253,48 +253,48 @@ discard block
		block discarded – undo
253	253	);
254	254	}
255	255
256		- /**
257		- * Checks whether a parameter with the specified name
258		- * has been registered.
259		- *
260		- * @param string $name
261		- * @return bool
262		- */
	256	+ /**
	257	+ * Checks whether a parameter with the specified name
	258	+ * has been registered.
	259	+ *
	260	+ * @param string $name
	261	+ * @return bool
	262	+ */
263	263	public function hasRegisteredParam(string $name) : bool
264	264	{
265	265	return isset($this->knownParams[$name]);
266	266	}
267	267
268		- /**
269		- * Retrieves an indexed array with accept mime types
270		- * that the client sent, in the order of preference
271		- * the client specified.
272		- *
273		- * Example:
274		- *
275		- * array(
276		- * 'text/html',
277		- * 'application/xhtml+xml',
278		- * 'image/webp'
279		- * ...
280		- * )
281		- *
282		- * @return array
283		- * @see Request::parseAcceptHeaders()
284		- */
	268	+ /**
	269	+ * Retrieves an indexed array with accept mime types
	270	+ * that the client sent, in the order of preference
	271	+ * the client specified.
	272	+ *
	273	+ * Example:
	274	+ *
	275	+ * array(
	276	+ * 'text/html',
	277	+ * 'application/xhtml+xml',
	278	+ * 'image/webp'
	279	+ * ...
	280	+ * )
	281	+ *
	282	+ * @return array
	283	+ * @see Request::parseAcceptHeaders()
	284	+ */
285	285	public static function getAcceptHeaders() : array
286	286	{
287	287	return self::parseAcceptHeaders()->getMimeStrings();
288	288	}
289	289
290		- /**
291		- * Returns an instance of the accept headers parser,
292		- * to access information on the browser's accepted
293		- * mime types.
294		- *
295		- * @return Request_AcceptHeaders
296		- * @see Request::getAcceptHeaders()
297		- */
	290	+ /**
	291	+ * Returns an instance of the accept headers parser,
	292	+ * to access information on the browser's accepted
	293	+ * mime types.
	294	+ *
	295	+ * @return Request_AcceptHeaders
	296	+ * @see Request::getAcceptHeaders()
	297	+ */
298	298	public static function parseAcceptHeaders() : Request_AcceptHeaders
299	299	{
300	300	static $accept;
		@@ -342,14 +342,14 @@ discard block
		block discarded – undo
342	342	return false;
343	343	}
344	344
345		- /**
346		- * Removes a single parameter from the request.
347		- * If the parameter has been registered, also
348		- * removes the registration info.
349		- *
350		- * @param string $name
351		- * @return Request
352		- */
	345	+ /**
	346	+ * Removes a single parameter from the request.
	347	+ * If the parameter has been registered, also
	348	+ * removes the registration info.
	349	+ *
	350	+ * @param string $name
	351	+ * @return Request
	352	+ */
353	353	public function removeParam(string $name) : Request
354	354	{
355	355	if(isset($_REQUEST[$name])) {
		@@ -363,12 +363,12 @@ discard block
		block discarded – undo
363	363	return $this;
364	364	}
365	365
366		- /**
367		- * Removes several parameters from the request.
368		- *
369		- * @param string[] $names
370		- * @return Request
371		- */
	366	+ /**
	367	+ * Removes several parameters from the request.
	368	+ *
	369	+ * @param string[] $names
	370	+ * @return Request
	371	+ */
372	372	public function removeParams(array $names) : Request
373	373	{
374	374	foreach($names as $name) {
		@@ -435,18 +435,18 @@ discard block
		block discarded – undo
435	435	return $val;
436	436	}
437	437
438		- /**
439		- * Treats the request parameter as a JSON string, and
440		- * if it exists and contains valid JSON, returns the
441		- * decoded JSON value as an array (default).
442		- *
443		- * @param string $name
444		- * @param bool $assoc
445		- * @return array\|object
446		- *
447		- * @see Request::getJSONAssoc()
448		- * @see Request::getJSONObject()
449		- */
	438	+ /**
	439	+ * Treats the request parameter as a JSON string, and
	440	+ * if it exists and contains valid JSON, returns the
	441	+ * decoded JSON value as an array (default).
	442	+ *
	443	+ * @param string $name
	444	+ * @param bool $assoc
	445	+ * @return array\|object
	446	+ *
	447	+ * @see Request::getJSONAssoc()
	448	+ * @see Request::getJSONObject()
	449	+ */
450	450	public function getJSON(string $name, bool $assoc=true)
451	451	{
452	452	$value = $this->getParam($name);
		@@ -471,13 +471,13 @@ discard block
		block discarded – undo
471	471	return new \stdClass();
472	472	}
473	473
474		- /**
475		- * Like {@link Request::getJSON()}, but omitting the second
476		- * parameter. Use this for more readable code.
477		- *
478		- * @param string $name
479		- * @return array
480		- */
	474	+ /**
	475	+ * Like {@link Request::getJSON()}, but omitting the second
	476	+ * parameter. Use this for more readable code.
	477	+ *
	478	+ * @param string $name
	479	+ * @return array
	480	+ */
481	481	public function getJSONAssoc(string $name) : array
482	482	{
483	483	$result = $this->getJSON($name);
		@@ -488,13 +488,13 @@ discard block
		block discarded – undo
488	488	return array();
489	489	}
490	490
491		- /**
492		- * Like {@link Request::getJSON()}, but omitting the second
493		- * parameter. Use this for more readable code.
494		- *
495		- * @param string $name
496		- * @return object
497		- */
	491	+ /**
	492	+ * Like {@link Request::getJSON()}, but omitting the second
	493	+ * parameter. Use this for more readable code.
	494	+ *
	495	+ * @param string $name
	496	+ * @return object
	497	+ */
498	498	public function getJSONObject(string $name) : object
499	499	{
500	500	$result = $this->getJSON($name, false);
		@@ -505,12 +505,12 @@ discard block
		block discarded – undo
505	505	return new \stdClass();
506	506	}
507	507
508		- /**
509		- * Sends a JSON response with the correct headers.
510		- *
511		- * @param array\|string $data
512		- * @param bool $exit Whether to exit the script afterwards.
513		- */
	508	+ /**
	509	+ * Sends a JSON response with the correct headers.
	510	+ *
	511	+ * @param array\|string $data
	512	+ * @param bool $exit Whether to exit the script afterwards.
	513	+ */
514	514	public static function sendJSON($data, bool $exit=true)
515	515	{
516	516	$payload = $data;
		@@ -530,12 +530,12 @@ discard block
		block discarded – undo
530	530	}
531	531	}
532	532
533		- /**
534		- * Sends HTML to the browser with the correct headers.
535		- *
536		- * @param string $html
537		- * @param bool $exit Whether to exit the script afterwards.
538		- */
	533	+ /**
	534	+ * Sends HTML to the browser with the correct headers.
	535	+ *
	536	+ * @param string $html
	537	+ * @param bool $exit Whether to exit the script afterwards.
	538	+ */
539	539	public static function sendHTML(string $html, bool $exit=true)
540	540	{
541	541	header('Cache-Control: no-cache, must-revalidate');
		@@ -550,16 +550,16 @@ discard block
		block discarded – undo
550	550	}
551	551	}
552	552
553		- /**
554		- * Creates a new instance of the URL comparer, which can check
555		- * whether the specified URLs match, regardless of the order in
556		- * which the query parameters are, if any.
557		- *
558		- * @param string $sourceURL
559		- * @param string $targetURL
560		- * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
561		- * @return Request_URLComparer
562		- */
	553	+ /**
	554	+ * Creates a new instance of the URL comparer, which can check
	555	+ * whether the specified URLs match, regardless of the order in
	556	+ * which the query parameters are, if any.
	557	+ *
	558	+ * @param string $sourceURL
	559	+ * @param string $targetURL
	560	+ * @param array $limitParams Whether to limit the comparison to these specific parameter names (if present)
	561	+ * @return Request_URLComparer
	562	+ */
563	563	public function createURLComparer(string $sourceURL, string $targetURL, array $limitParams=array()) : Request_URLComparer
564	564	{
565	565	$comparer = new Request_URLComparer($this, $sourceURL, $targetURL);
		@@ -568,10 +568,10 @@ discard block
		block discarded – undo
568	568	return $comparer;
569	569	}
570	570
571		- /**
572		- * Retrieves the full URL that was used to access the current page.
573		- * @return string
574		- */
	571	+ /**
	572	+ * Retrieves the full URL that was used to access the current page.
	573	+ * @return string
	574	+ */
575	575	public function getCurrentURL() : string
576	576	{
577	577	return $_SERVER['HTTP_HOST'].$_SERVER['REQUEST_URI'];

		@@ -19,9 +19,9 @@
		block discarded – undo
19	19	*/
20	20	class Request_RefreshParams_Exclude_Name extends Request_RefreshParams_Exclude
21	21	{
22		- /**
23		- * @var string
24		- */
	22	+ /**
	23	+ * @var string
	24	+ */
25	25	private $name;
26	26
27	27	public function __construct(string $paramName)

Mistralys / application-utils

Push — master ( 6ba584...289f9d )

Status

Category

Indentation +22 added lines, -22 removed lines patch added patch discarded remove patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch

Indentation +66 added lines, -66 removed lines patch added patch discarded remove patch

Indentation +50 added lines, -50 removed lines patch added patch discarded remove patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch

Indentation +73 added lines, -73 removed lines patch added patch discarded remove patch

Indentation +6 added lines, -6 removed lines patch added patch discarded remove patch

Indentation +142 added lines, -142 removed lines patch added patch discarded remove patch

Indentation +3 added lines, -3 removed lines patch added patch discarded remove patch