Mistralys / application-utils

src/RequestHelper/Boundaries/Boundary.php

Indentation +47 added lines, -47 removed lines

@@ -19,34 +19,34 @@ 
  */
 class RequestHelper_Boundaries_Boundary
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $content;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $dispositionParams = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentType = '';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $contentEncoding = '';
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $transferEncoding = '';
     
     public function __construct(RequestHelper_Boundaries $boundaries, string $content)
@@ -60,46 +60,46 @@ 
         return strlen($this->content);
     }
     
-   /**
-    * Sets the name of the request parameter.
-    * 
-    * @param string $name
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the name of the request parameter.
+     * 
+     * @param string $name
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setName(string $name) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('name', $name);
     }
     
-   /**
-    * Sets the filename to use for the content, if applicable.
-    *  
-    * @param string $fileName
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the filename to use for the content, if applicable.
+     *  
+     * @param string $fileName
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('filename', $fileName);
     }
     
-   /**
-    * Sets the content type to use for the content.
-    * 
-    * @param string $contentType
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the content type to use for the content.
+     * 
+     * @param string $contentType
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary
     {
         $this->contentType = $contentType;
         return $this;
     }
     
-   /**
-    * Sets the encoding to specify for the content.
-    * 
-    * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the encoding to specify for the content.
+     * 
+     * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary
     {
         $this->contentEncoding = $encoding;
@@ -119,11 +119,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the mime boundary text.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the mime boundary text.
+     * 
+     * @return string
+     */
     public function render()
     {
         $eol = $this->boundaries->getEOL();

src/URLInfo/Highlighter.php

Indentation +10 added lines, -10 removed lines

@@ -20,9 +20,9 @@ 
  */
 class URLInfo_Highlighter
 {
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     protected $info;
     
     public function __construct(URLInfo $info)
@@ -158,13 +158,13 @@ 
         );
     }
     
-   /**
-    * Fetches all parameters in the URL, regardless of 
-    * whether parameter exclusion is enabled, so they
-    * can be highlighted is need be.
-    * 
-    * @return array
-    */
+    /**
+     * Fetches all parameters in the URL, regardless of 
+     * whether parameter exclusion is enabled, so they
+     * can be highlighted is need be.
+     * 
+     * @return array
+     */
     protected function resolveParams() : array
     {
         $previous = $this->info->isParamExclusionEnabled();

src/ConvertHelper/ControlCharacters.php

Indentation +43 added lines, -43 removed lines

@@ -22,9 +22,9 @@ 
 {
     const ERROR_MALFORMATTED_STRING = 53801;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $controlChars =  array(
         '0000-0008', // control chars
         '000E-000F', // control chars
@@ -32,19 +32,19 @@ 
         '2000-200F', // non-breaking space and co
     );
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected static $controlCharsRegex;
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected static $hexAlphabet = array('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'A', 'B', 'C', 'D', 'E', 'F');
     
-   /**
-    * @var string[]|NULL
-    */
+    /**
+     * @var string[]|NULL
+     */
     protected static $charsAsHex;
     
     public function __construct()
@@ -67,13 +67,13 @@ 
         }
     }
     
-   /**
-    * Retrieves the HEX character codes for all control
-    * characters that the {@link stripControlCharacters()}
-    * method will remove.
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves the HEX character codes for all control
+     * characters that the {@link stripControlCharacters()}
+     * method will remove.
+     *
+     * @return string[]
+     */
     public function getCharsAsHex() : array
     {
         if (isset(self::$charsAsHex))
@@ -120,13 +120,13 @@ 
         return $stack;
     }
     
-   /**
-    * Retrieves an array of all control characters that
-    * the {@link stripControlCharacters()} method will
-    * remove, as the actual UTF-8 characters.
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves an array of all control characters that
+     * the {@link stripControlCharacters()} method will
+     * remove, as the actual UTF-8 characters.
+     *
+     * @return string[]
+     */
     public function getCharsAsUTF8() : array
     {
         $chars = $this->getCharsAsHex();
@@ -139,12 +139,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all control characters as JSON encoded
-    * characters, e.g. "\u200b".
-    *
-    * @return string[]
-    */
+    /**
+     * Retrieves all control characters as JSON encoded
+     * characters, e.g. "\u200b".
+     *
+     * @return string[]
+     */
     public function getCharsAsJSON() : array
     {
         $chars = $this->getCharsAsHex();
@@ -157,17 +157,17 @@ 
         return $result;
     }
     
-   /**
-    * Removes all control characters from the specified string
-    * that can cause problems in some cases, like creating
-    * valid XML documents. This includes invisible non-breaking
-    * spaces.
-    *
-    * @param string $string
-    * @return string
-    * @see https://stackoverflow.com/a/8171868/2298192
-    * @see https://unicode-table.com/en
-    */
+    /**
+     * Removes all control characters from the specified string
+     * that can cause problems in some cases, like creating
+     * valid XML documents. This includes invisible non-breaking
+     * spaces.
+     *
+     * @param string $string
+     * @return string
+     * @see https://stackoverflow.com/a/8171868/2298192
+     * @see https://unicode-table.com/en
+     */
     public function stripControlCharacters(string $string) : string
     {
         if(empty($string)) 

src/RequestHelper/Boundaries.php

Indentation +52 added lines, -52 removed lines

@@ -22,19 +22,19 @@ 
 {
     const ERROR_NO_BOUNDARIES_SPECIFIED = 44401;
     
-   /**
-    * @var RequestHelper
-    */
+    /**
+     * @var RequestHelper
+     */
     protected $helper;
 
-   /**
-    * @var RequestHelper_Boundaries_Boundary[]
-    */
+    /**
+     * @var RequestHelper_Boundaries_Boundary[]
+     */
     protected $boundaries = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
     
     public function __construct(RequestHelper $helper)
@@ -42,31 +42,31 @@ 
         $this->helper = $helper;
     }
     
-   /**
-    * Retrieves the string that is used to separate mime boundaries in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string that is used to separate mime boundaries in the body.
+     * 
+     * @return string
+     */
     public function getMimeBoundary() : string
     {
         return $this->helper->getMimeBoundary();
     }
     
-   /**
-    * Retrieves the end of line character(s) used in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the end of line character(s) used in the body.
+     * 
+     * @return string
+     */
     public function getEOL() : string
     {
         return $this->helper->getEOL();
     }
     
-   /**
-    * Retrieves the total content length of all boundary contents.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the total content length of all boundary contents.
+     * 
+     * @return int
+     */
     public function getContentLength() : int
     {
         // this must use strlen, and not mb_strlen: the content length
@@ -75,15 +75,15 @@ 
         return strlen($this->render());
     }
     
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries
     {
         if(empty($contentType))
@@ -107,13 +107,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds arbitrary content.
-    *
-    * @param string $varName
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     *
+     * @param string $varName
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries
     {
         $content = ConvertHelper::string2utf8($content);
@@ -127,13 +127,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper_Boundaries
     {
         $boundary = $this->createBoundary($value)
@@ -149,11 +149,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the response body with all mime boundaries.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the response body with all mime boundaries.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         if(empty($this->boundaries)) 

src/XMLHelper/SimpleXML.php

Indentation +22 added lines, -22 removed lines

@@ -23,37 +23,37 @@
 {
     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);

src/XMLHelper/DOMErrors/Error.php

Indentation +3 added lines, -3 removed lines

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

src/XMLHelper/HTMLLoader.php

Indentation +66 added lines, -66 removed lines

@@ -36,19 +36,19 @@ 
 {
     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 @@ 
         '</body>'.
     '</html>';
     
-   /**
-    * @var \DOMDocument
-    */
+    /**
+     * @var \DOMDocument
+     */
     private $dom;
 
     private function __construct(string $html)
@@ -70,13 +70,13 @@ 
         $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 @@ 
         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 @@ 
         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();

src/XMLHelper/DOMErrors.php

Indentation +50 added lines, -50 removed lines

@@ -23,14 +23,14 @@ 
 {
     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 @@ 
         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 @@ 
     }
     
     
-   /**
-    * 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 @@ 
         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 @@ 
         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 @@ 
         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 @@ 
         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 @@ 
         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);

docs/libxml/generate-errorcodes.php

Indentation +3 added lines, -3 removed lines

@@ -14,9 +14,9 @@
  * @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);