Mistralys / application-utils

src/XMLHelper.php

Indentation +65 added lines, -65 removed lines

@@ -34,11 +34,11 @@ 
     private static bool $simulation = false;
     private DOMDocument $dom;
 
-   /**
-    * Creates a new XMLHelper instance.
-    * 
-    * @return XMLHelper
-    */
+    /**
+     * Creates a new XMLHelper instance.
+     * 
+     * @return XMLHelper
+     */
     public static function create() : XMLHelper
     {
         $dom = new DOMDocument('1.0', 'UTF-8');
@@ -68,38 +68,38 @@ 
         return XMLHelper_Converter::fromString($xmlString);
     }
 
-   /**
-    * Creates a converter from a SimpleXMLElement instance.
-    * @param SimpleXMLElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a SimpleXMLElement instance.
+     * @param SimpleXMLElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertElement(SimpleXMLElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromElement($element);
     }
    
-   /**
-    * Creates a converter from a DOMElement instance.
-    * @param DOMElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from a DOMElement instance.
+     * @param DOMElement $element
+     * @return XMLHelper_Converter
+     */
     public static function convertDOMElement(DOMElement $element) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromDOMElement($element);
     }
 
-   /**
-    * Creates a new helper using an existing DOMDocument object.
-    * @param DOMDocument $dom
-    */
+    /**
+     * Creates a new helper using an existing DOMDocument object.
+     * @param DOMDocument $dom
+     */
     public function __construct(DOMDocument $dom)
     {
         $this->dom = $dom;
     }
 
-   /**
-    * @return DOMDocument
-    */
+    /**
+     * @return DOMDocument
+     */
     public function getDOM() : DOMDocument
     {
         return $this->dom;
@@ -299,12 +299,12 @@ 
         return $root;
     }
 
-   /**
-    * Escaped the string for use in XML.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Escaped the string for use in XML.
+     * 
+     * @param string $string
+     * @return string
+     */
     public function escape(string $string) : string
     {
         return preg_replace('#<p>(.*)</p>#isUm', '$1', $string);
@@ -331,18 +331,18 @@ 
         );
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers to trigger a download of the XML
-    * to a local file.
-    * 
-    * NOTE: Ensure calling exit after this is done, and to
-    * not send additional content, which would corrupt the 
-    * download.
-    *
-    * @param string $xml
-    * @param string $filename
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers to trigger a download of the XML
+     * to a local file.
+     * 
+     * NOTE: Ensure calling exit after this is done, and to
+     * not send additional content, which would corrupt the 
+     * download.
+     *
+     * @param string $xml
+     * @param string $filename
+     */
     public static function downloadXML(string $xml, string $filename = 'download.xml') : void
     {
         if(!self::$simulation && !headers_sent())
@@ -353,12 +353,12 @@ 
         echo $xml;
     }
 
-   /**
-    * Sends the specified XML string to the browser with
-    * the correct headers and terminates the request.
-    *
-    * @param string $xml
-    */
+    /**
+     * Sends the specified XML string to the browser with
+     * the correct headers and terminates the request.
+     *
+     * @param string $xml
+     */
     public static function displayXML(string $xml) : void
     {
         if(!self::$simulation && !headers_sent())
@@ -477,30 +477,30 @@ 
         return $this->dom->saveXML();
     }
     
-   /**
-    * Creates a new SimpleXML helper instance: this
-    * object is useful to work with loading XML strings
-    * and files with easy access to any errors that 
-    * may occurr, since the simplexml functions can be
-    * somewhat cryptic.
-    * 
-    * @return XMLHelper_SimpleXML
-    */
+    /**
+     * Creates a new SimpleXML helper instance: this
+     * object is useful to work with loading XML strings
+     * and files with easy access to any errors that 
+     * may occurr, since the simplexml functions can be
+     * somewhat cryptic.
+     * 
+     * @return XMLHelper_SimpleXML
+     */
     public static function createSimplexml() : XMLHelper_SimpleXML
     {
         return new XMLHelper_SimpleXML();
     }
     
-   /**
-    * Converts a string to valid XML: can be a text only string
-    * or an HTML string. Returns valid XML code.
-    * 
-    * NOTE: The string may contain custom tags, which are 
-    * preserved.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Converts a string to valid XML: can be a text only string
+     * or an HTML string. Returns valid XML code.
+     * 
+     * NOTE: The string may contain custom tags, which are 
+     * preserved.
+     * 
+     * @param string $string
+     * @return string
+     */
     public static function string2xml(string $string) : string
     {
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();

src/RequestHelper/Boundaries/Boundary.php

Indentation +32 added lines, -32 removed lines

@@ -25,9 +25,9 @@ 
     protected RequestHelper_Boundaries $boundaries;
     protected string $transferEncoding = '';
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected array $dispositionParams = array();
 
     public function __construct(RequestHelper_Boundaries $boundaries, string $content)
@@ -41,46 +41,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;
@@ -100,11 +100,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the mime boundary text.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the mime boundary text.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         $eol = $this->boundaries->getEOL();

src/RequestHelper/Response.php

Indentation +47 added lines, -47 removed lines

@@ -31,21 +31,21 @@ 
     protected array $info;
     
 
-   /**
-    * @param RequestHelper $helper
-    * @param array<string,mixed> $info The CURL info array from curl_getinfo().
-    */
+    /**
+     * @param RequestHelper $helper
+     * @param array<string,mixed> $info The CURL info array from curl_getinfo().
+     */
     public function __construct(RequestHelper $helper, array $info)
     {
         $this->request = $helper;
         $this->info = $info;
     }
     
-   /**
-    * Retrieves the request instance that initiated the request.
-    *  
-    * @return RequestHelper
-    */
+    /**
+     * Retrieves the request instance that initiated the request.
+     *  
+     * @return RequestHelper
+     */
     public function getRequest() : RequestHelper
     {
         return $this->request;
@@ -66,79 +66,79 @@ 
         return $this;
     }
     
-   /**
-    * Whether an error occurred in the request.
-    * @return bool
-    */
+    /**
+     * Whether an error occurred in the request.
+     * @return bool
+     */
     public function isError() : bool
     {
         return $this->isError;
     }
     
-   /**
-    * Whether the request timed out.
-    * @return bool
-    */
+    /**
+     * Whether the request timed out.
+     * @return bool
+     */
     public function isTimeout() : bool
     {
         return $this->errorCode === RequestHelper_CURL::OPERATION_TIMEDOUT;
     }
     
-   /**
-    * Retrieves the native error message, if an error occurred.
-    * @return string
-    */
+    /**
+     * Retrieves the native error message, if an error occurred.
+     * @return string
+     */
     public function getErrorMessage() : string
     {
         return $this->errorMessage;
     }
     
-   /**
-    * Retrieves the native CURL error code, if an error occurred.
-    * @return int
-    * @see RequestHelper_CURL For a list of error codes.
-    */
+    /**
+     * Retrieves the native CURL error code, if an error occurred.
+     * @return int
+     * @see RequestHelper_CURL For a list of error codes.
+     */
     public function getErrorCode() : int
     {
         return $this->errorCode;
     }
     
-   /**
-    * Retrieves the full body of the request.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the full body of the request.
+     * 
+     * @return string
+     */
     public function getRequestBody() : string
     {
         return $this->request->getBody();
     }
     
-   /**
-    * Retrieves the body of the response, if any.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the body of the response, if any.
+     * 
+     * @return string
+     */
     public function getResponseBody() : string
     {
         return $this->body;
     }
     
-   /**
-    * The response HTTP code.
-    * 
-    * @return int The code, or 0 if none was sent (on error).
-    */
+    /**
+     * The response HTTP code.
+     * 
+     * @return int The code, or 0 if none was sent (on error).
+     */
     public function getCode() : int
     {
         return (int)$this->getInfoKey('http_code');
     }
     
-   /**
-    * Retrieves the actual headers that were sent in the request:
-    * one header by entry in the indexed array.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves the actual headers that were sent in the request:
+     * one header by entry in the indexed array.
+     * 
+     * @return string[]
+     */
     public function getHeaders() : array
     {
         return ConvertHelper::explodeTrim("\n", $this->getInfoKey('request_header'));

src/VariableInfo.php

Indentation +31 added lines, -31 removed lines

@@ -37,19 +37,19 @@ 
 
     public const ERROR_INVALID_SERIALIZED_DATA = 56301;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $string;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
 
     /**
@@ -106,15 +106,15 @@ 
         return new VariableInfo(null, $serialized);
     }
     
-   /**
-    * Parses a previously serialized data set to restore the 
-    * variable information from it.
-    * 
-    * @param array<mixed> $serialized
-    * @throws BaseException
-    * 
-    * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
-    */
+    /**
+     * Parses a previously serialized data set to restore the 
+     * variable information from it.
+     * 
+     * @param array<mixed> $serialized
+     * @throws BaseException
+     * 
+     * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
+     */
     protected function parseSerialized(array $serialized) : void
     {
         if(!isset($serialized['string'], $serialized['type'], $serialized['options']))
@@ -163,12 +163,12 @@ 
         return $this->value;
     }
     
-   /**
-    * The variable type - this is the same string that
-    * is returned by the PHP function `gettype`.
-    * 
-    * @return string
-    */
+    /**
+     * The variable type - this is the same string that
+     * is returned by the PHP function `gettype`.
+     * 
+     * @return string
+     */
     public function getType() : string
     {
         return $this->type;
@@ -185,13 +185,13 @@ 
         );
     }
     
-   /**
-    * Whether to prepend the variable type before the value, 
-    * like the var_dump function. Example: <code>string "Some text"</code>.
-    * 
-    * @param bool $enable
-    * @return VariableInfo
-    */
+    /**
+     * Whether to prepend the variable type before the value, 
+     * like the var_dump function. Example: <code>string "Some text"</code>.
+     * 
+     * @param bool $enable
+     * @return VariableInfo
+     */
     public function enableType(bool $enable=true) : VariableInfo
     {
         return $this->setOption('prepend-type', $enable);

src/XMLHelper/Converter/Decorator.php

Indentation +24 added lines, -24 removed lines

@@ -28,18 +28,18 @@ 
     
     public const DEF_DEPTH = 512;
     
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     private array $options = array(
         '@attributes' => true,
         '@text' => true,
         'depth' => self::DEF_DEPTH
     );
 
-   /**
-    * @var array<mixed>|string
-    */
+    /**
+     * @var array<mixed>|string
+     */
     protected $result = array();
     
     public function __construct(SimpleXMLElement $element)
@@ -47,36 +47,36 @@ 
         $this->subject = $element;
     }
     
-   /**
-    * Whether to use the `@attributes` key to store element attributes.
-    * 
-    * @param bool $bool
-    * @return XMLHelper_Converter_Decorator
-    */
+    /**
+     * Whether to use the `@attributes` key to store element attributes.
+     * 
+     * @param bool $bool
+     * @return XMLHelper_Converter_Decorator
+     */
     public function useAttributes(bool $bool) : XMLHelper_Converter_Decorator 
     {
         $this->options['@attributes'] = $bool;
         return $this;
     }
     
-   /**
-    * Whether to use the `@text` key to store the node text.
-    * 
-    * @param bool $bool
-    * @return XMLHelper_Converter_Decorator
-    */
+    /**
+     * Whether to use the `@text` key to store the node text.
+     * 
+     * @param bool $bool
+     * @return XMLHelper_Converter_Decorator
+     */
     public function useText(bool $bool) : XMLHelper_Converter_Decorator 
     {
         $this->options['@text'] = $bool;
         return $this;
     }
     
-   /**
-    * Set the maximum depth to parse in the document.
-    * 
-    * @param int $depth
-    * @return XMLHelper_Converter_Decorator
-    */
+    /**
+     * Set the maximum depth to parse in the document.
+     * 
+     * @param int $depth
+     * @return XMLHelper_Converter_Decorator
+     */
     public function setDepth(int $depth) : XMLHelper_Converter_Decorator 
     {
         $this->options['depth'] = (int)max(0, $depth);

src/XMLHelper/Converter.php

Indentation +27 added lines, -27 removed lines

@@ -49,9 +49,9 @@ 
     
     protected SimpleXMLElement $xml;
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected ?string $json;
     
     protected function __construct(SimpleXMLElement $element)
@@ -96,34 +96,34 @@ 
         }
     }
     
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    * 
-    * @param SimpleXMLElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     * 
+     * @param SimpleXMLElement $element
+     * @return XMLHelper_Converter
+     */
     public static function fromElement(SimpleXMLElement $element) : XMLHelper_Converter
     {
         return new XMLHelper_Converter($element);
     }
 
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    *
-    * @param DOMElement $element
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     *
+     * @param DOMElement $element
+     * @return XMLHelper_Converter
+     */
     public static function fromDOMElement(DOMElement $element) : XMLHelper_Converter
     {
         return new XMLHelper_Converter(simplexml_import_dom($element));
     }
     
-   /**
-    * Converts the XML to JSON.
-    * 
-    * @return string
-    * @throws XMLHelper_Exception|JsonException
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @return string
+     * @throws XMLHelper_Exception|JsonException
+     */
     public function toJSON() : string
     {
         if (isset($this->json))
@@ -156,12 +156,12 @@ 
         }
     }
 
-   /**
-    * Converts the XML to an associative array.
-    * @return array<mixed>
-    * @throws XMLHelper_Exception
-    * @throws JsonException
-    */
+    /**
+     * Converts the XML to an associative array.
+     * @return array<mixed>
+     * @throws XMLHelper_Exception
+     * @throws JsonException
+     */
     public function toArray() : array 
     {
         $json = $this->toJSON();

src/XMLHelper/DOMErrors.php

Indentation +42 added lines, -42 removed lines

@@ -25,14 +25,14 @@ 
 {
     public const SERIALIZE_SEPARATOR = '__SERIALIZE_SEP__';
     
-   /**
-    * @var XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * @var XMLHelper_DOMErrors_Error[]
+     */
     private array $errors = array();
     
-   /**
-    * @param LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
-    */
+    /**
+     * @param LibXMLError[]|XMLHelper_DOMErrors_Error[] $libxmlErrors
+     */
     public function __construct(array $libxmlErrors)
     {
         foreach($libxmlErrors as $error)
@@ -61,11 +61,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() : array
     {
         return $this->getByLevel(LIBXML_ERR_WARNING);
@@ -121,12 +121,12 @@ 
     }
     
     
-   /**
-    * Retrieves all errors by the specified libxml error level.
-    * 
-    * @param int $level
-    * @return XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error level.
+     * 
+     * @param int $level
+     * @return XMLHelper_DOMErrors_Error[]
+     */
     public function getByLevel(int $level) : array
     {
         $result = array();
@@ -142,12 +142,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all errors by the specified libxml error code.
-    * 
-    * @param int $code
-    * @return XMLHelper_DOMErrors_Error[]
-    */
+    /**
+     * Retrieves all errors by the specified libxml error code.
+     * 
+     * @param int $code
+     * @return XMLHelper_DOMErrors_Error[]
+     */
     public function getByCode(int $code) : array
     {
         $result = array();
@@ -163,12 +163,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)
@@ -182,12 +182,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)
@@ -216,13 +216,13 @@ 
         return $result;
     }
     
-   /**
-    * Serializes the error collection, so it can be stored and
-    * restored as needed, using the `fromSerialized()` method.
-    * 
-    * @return string
-    * @see XMLHelper_DOMErrors::fromSerialized()
-    */
+    /**
+     * Serializes the error 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();

src/XMLHelper/DOMErrors/Error.php

Indentation +3 added lines, -3 removed lines

@@ -27,9 +27,9 @@
     public const ERROR_CANNOT_UNSERIALIZE_ERROR_DATA = 57201;
     public const ERROR_ERROR_DATA_KEY_MISSING = 57202;
     
-   /**
-    * @var LibXMLError
-    */
+    /**
+     * @var LibXMLError
+     */
     private LibXMLError $error;
 
     /**

src/XMLHelper/SimpleXML.php

Indentation +19 added lines, -19 removed lines

@@ -28,32 +28,32 @@
     
     private ?SimpleXMLElement $element = null;
     
-   /**
-    * @var XMLHelper_SimpleXML_Error[]
-    */
+    /**
+     * @var XMLHelper_SimpleXML_Error[]
+     */
     private array $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);