Mistralys / application-utils

src/Highlighter.php

Indentation +64 added lines, -64 removed lines

@@ -43,60 +43,60 @@ 
  */
 class Highlighter
 {
-   /**
-    * Creates a new GeSHi instance from a source code string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from a source code string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromString(string $sourceCode, string $format) : GeSHi
     {
         return new GeSHi($sourceCode, $format);
     }
     
-   /**
-    * Creates a new GeSHi instance from the contents of a file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return GeSHi
-    */
+    /**
+     * Creates a new GeSHi instance from the contents of a file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return GeSHi
+     */
     public static function fromFile(string $path, string $format) : GeSHi
     {
         return self::fromString(FileHelper::readContents($path), $format);
     }
     
-   /**
-    * Parses and highlights the target string.
-    * 
-    * @param string $sourceCode
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the target string.
+     * 
+     * @param string $sourceCode
+     * @param string $format
+     * @return string
+     */
     public static function parseString(string $sourceCode, string $format) : string
     {
         return self::fromString($sourceCode, $format)->parse_code();
     }
     
-   /**
-    * Parses and highlights the contents of the target file.
-    * 
-    * @param string $path
-    * @param string $format
-    * @return string
-    */
+    /**
+     * Parses and highlights the contents of the target file.
+     * 
+     * @param string $path
+     * @param string $format
+     * @return string
+     */
     public static function parseFile(string $path, string $format) : string
     {
         return self::fromFile($path, $format)->parse_code();
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified SQL string.
-    *
-    * @param string $sql
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified SQL string.
+     *
+     * @param string $sql
+     * @return string
+     */
     public static function sql(string $sql) : string
     {
         return self::parseString($sql, 'sql');
@@ -122,13 +122,13 @@ 
         return self::parseString($subject, 'javascript');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified XML code.
-    *
-    * @param string $xml The XML to highlight.
-    * @param bool $formatSource Whether to format the source with indentation to make it readable.
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified XML code.
+     *
+     * @param string $xml The XML to highlight.
+     * @param bool $formatSource Whether to format the source with indentation to make it readable.
+     * @return string
+     */
     public static function xml(string $xml, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -145,13 +145,13 @@ 
         return self::parseString($xml, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to the specified HTML code.
-    * 
-    * @param string $html
-    * @param bool $formatSource
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to the specified HTML code.
+     * 
+     * @param string $html
+     * @param bool $formatSource
+     * @return string
+     */
     public static function html(string $html, bool $formatSource=false) : string
     {
         if($formatSource)
@@ -168,27 +168,27 @@ 
         return self::parseString($html, 'xml');
     }
     
-   /**
-    * Adds HTML syntax highlighting to a bit of PHP code.
-    * 
-    * @param string $phpCode
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to a bit of PHP code.
+     * 
+     * @param string $phpCode
+     * @return string
+     */
     public static function php(string $phpCode) : string
     {
         return self::parseString($phpCode, 'php');
     }
     
-   /**
-    * Adds HTML syntax highlighting to an URL.
-    *
-    * NOTE: Includes the necessary CSS styles. When
-    * highlighting several URLs in the same page,
-    * prefer using the `parseURL` function instead.
-    *
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to an URL.
+     *
+     * NOTE: Includes the necessary CSS styles. When
+     * highlighting several URLs in the same page,
+     * prefer using the `parseURL` function instead.
+     *
+     * @param string $url
+     * @return string
+     */
     public static function url(string $url) : string
     {
         $info = parseURL($url);

src/XMLHelper/Converter.php

Indentation +21 added lines, -21 removed lines

@@ -51,9 +51,9 @@ 
     
     protected SimpleXMLElement $xml;
     
-   /**
-    * @var string|NULL
-    */
+    /**
+     * @var string|NULL
+     */
     protected ?string $json;
     
     protected function __construct(SimpleXMLElement $element)
@@ -98,34 +98,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
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @return string
+     * @throws XMLHelper_Exception
+     */
     public function toJSON() : string
     {
         if (isset($this->json))

src/JSHelper.php

Indentation +48 added lines, -48 removed lines

@@ -38,27 +38,27 @@ 
     public const JS_REGEX_JSON = 'json';
 
     /**
-    * @var array<string,string>
-    */
+     * @var array<string,string>
+     */
     protected static array $variableCache = array();
     protected static int $elementCounter = 0;
     protected static string $idPrefix = 'E';
     
-   /**
-    * Builds a javascript statement. The first parameter is the
-    * javascript function to call, any additional parameters are
-    * used as arguments for the javascript function call. Variable
-    * types are automagically converted to the javascript equivalents.
-    *
-    * Examples:
-    *
-    * // add an alert(); statement:
-    * JSHelper::buildStatement('alert');
-    *
-    * // add an alert('Alert text'); statement
-    * JSHelper::buildStatement('alert', 'Alert text');
-    *
-    */
+    /**
+     * Builds a javascript statement. The first parameter is the
+     * javascript function to call, any additional parameters are
+     * used as arguments for the javascript function call. Variable
+     * types are automagically converted to the javascript equivalents.
+     *
+     * Examples:
+     *
+     * // add an alert(); statement:
+     * JSHelper::buildStatement('alert');
+     *
+     * // add an alert('Alert text'); statement
+     * JSHelper::buildStatement('alert', 'Alert text');
+     *
+     */
     public static function buildStatement() : string
     {
         $args = func_get_args();
@@ -66,13 +66,13 @@ 
         return call_user_func_array(array(self::class, 'buildStatementQuoteStyle'), $args);
     }
     
-   /**
-    * Like {@link JSHelper::buildStatement()}, but using single quotes
-    * to make it possible to use the statement in an HTML tag attribute.
-    * 
-    * @return string
-    * @see JSHelper::buildStatement()
-    */
+    /**
+     * Like {@link JSHelper::buildStatement()}, but using single quotes
+     * to make it possible to use the statement in an HTML tag attribute.
+     * 
+     * @return string
+     * @see JSHelper::buildStatement()
+     */
     public static function buildStatementAttribute() : string
     {
         $args = func_get_args();
@@ -225,13 +225,13 @@ 
         return self::phpVariable2JS($variable, self::QUOTE_STYLE_SINGLE);
     }
 
-   /**
-    * Generates a dynamic element ID to be used with dynamically generated
-    * HTML code to tie in with clientside javascript when compact but unique
-    * IDs are needed in a  request.
-    *
-    * @return string
-    */
+    /**
+     * Generates a dynamic element ID to be used with dynamically generated
+     * HTML code to tie in with clientside javascript when compact but unique
+     * IDs are needed in a  request.
+     *
+     * @return string
+     */
     public static function nextElementID() : string
     {
         self::$elementCounter++;
@@ -239,33 +239,33 @@ 
         return self::$idPrefix . self::$elementCounter;
     }
     
-   /**
-    * Retrieves the ID prefix currently used.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the ID prefix currently used.
+     * 
+     * @return string
+     */
     public static function getIDPrefix() : string
     {
         return self::$idPrefix;
     }
     
-   /**
-    * Retrieves the value of the internal elements counter.
-    * 
-    * @return integer
-    */
+    /**
+     * Retrieves the value of the internal elements counter.
+     * 
+     * @return integer
+     */
     public static function getElementCounter() : int
     {
         return self::$elementCounter;
     }
     
-   /**
-    * Sets the prefix that is added in front of all IDs
-    * retrieved using the {@link nextElementID()} method.
-    * 
-    * @param string $prefix
-    * @see JSHelper::nextElementID()
-    */
+    /**
+     * Sets the prefix that is added in front of all IDs
+     * retrieved using the {@link nextElementID()} method.
+     * 
+     * @param string $prefix
+     * @see JSHelper::nextElementID()
+     */
     public static function setIDPrefix(string $prefix) : void
     {
         self::$idPrefix = $prefix;

src/ZIPHelper.php

Indentation +29 added lines, -29 removed lines

@@ -40,14 +40,14 @@ 
         'WriteThreshold' => 100
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
     
-   /**
-    * @var ZipArchive|NULL
-    */
+    /**
+     * @var ZipArchive|NULL
+     */
     protected $zip;
 
     protected bool $open = false;
@@ -57,35 +57,35 @@ 
         $this->file = $targetFile;
     }
     
-   /**
-    * Sets an option, among the available options:
-    * 
-    * <ul>
-    * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return ZIPHelper
-    */
+    /**
+     * Sets an option, among the available options:
+     * 
+     * <ul>
+     * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return ZIPHelper
+     */
     public function setOption(string $name, $value) : ZIPHelper
     {
         $this->options[$name] = $value;
         return $this;
     }
     
-   /**
-    * Adds a file to the zip. By default, the file is stored
-    * with the same name in the root of the zip. Use the optional
-    * parameter to change the location in the zip.
-    * 
-    * @param string $filePath
-    * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
-    * @throws ZIPHelper_Exception
-    * @return bool
-    * 
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Adds a file to the zip. By default, the file is stored
+     * with the same name in the root of the zip. Use the optional
+     * parameter to change the location in the zip.
+     * 
+     * @param string $filePath
+     * @param string|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
+     * @throws ZIPHelper_Exception
+     * @return bool
+     * 
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
+     */
     public function addFile(string $filePath, ?string $zipPath=null) : bool
     {
         $this->open();

src/URLInfo/URIParser.php

Indentation +60 added lines, -60 removed lines

@@ -42,18 +42,18 @@ 
     protected bool $isValid = false;
     protected bool $encodeUTF = false;
 
-   /**
-    * @var array{code:int,message:string}|NULL
-    */
+    /**
+     * @var array{code:int,message:string}|NULL
+     */
     protected ?array $error = null;
     
-   /**
-    * Stores a list of all unicode characters in the URL
-    * that have been filtered out before parsing it with
-    * parse_url.
-    * 
-    * @var array<string,string>
-    */
+    /**
+     * Stores a list of all unicode characters in the URL
+     * that have been filtered out before parsing it with
+     * parse_url.
+     * 
+     * @var array<string,string>
+     */
     protected array $unicodeChars = array();
 
     /**
@@ -78,10 +78,10 @@ 
     );
 
     /**
-    * 
-    * @param string $url The target URL.
-    * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
-    */
+     * 
+     * @param string $url The target URL.
+     * @param bool $encodeUTF Whether to URL encode any plain text unicode characters.
+     */
     public function __construct(string $url, bool $encodeUTF)
     {
         $this->url = $url;
@@ -92,12 +92,12 @@ 
         $this->validate();
     }
 
-   /**
-    * Retrieves the array as parsed by PHP's parse_url,
-    * filtered and adjusted as necessary.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array<string,mixed>
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -153,11 +153,11 @@ 
         $this->url = implode(':', $parts);
     }
 
-   /**
-    * Finds any non-url encoded unicode characters in 
-    * the URL, and encodes them before the URL is 
-    * passed to parse_url.
-    */
+    /**
+     * Finds any non-url encoded unicode characters in 
+     * the URL, and encodes them before the URL is 
+     * passed to parse_url.
+     */
     protected function filterUnicodeChars() : void
     {
         $chars = ConvertHelper::string2array($this->url);
@@ -228,23 +228,23 @@ 
         $this->isValid = true;
     }
 
-   /**
-    * Goes through all information in the parse_url result
-    * array, and attempts to fix any user errors in formatting
-    * that can be recovered from, mostly regarding stray spaces.
-    */
+    /**
+     * Goes through all information in the parse_url result
+     * array, and attempts to fix any user errors in formatting
+     * that can be recovered from, mostly regarding stray spaces.
+     */
     protected function filterParsed() : void
     {
         $this->info = (new ParsedInfoFilter($this->url, $this->info))->filter();
     }
     
-   /**
-    * Recursively goes through the array, and converts all previously
-    * URL encoded characters with their unicode character counterparts.
-    * 
-    * @param array<string,mixed> $subject
-    * @return array<string,mixed>
-    */
+    /**
+     * Recursively goes through the array, and converts all previously
+     * URL encoded characters with their unicode character counterparts.
+     * 
+     * @param array<string,mixed> $subject
+     * @return array<string,mixed>
+     */
     protected function restoreUnicodeChars(array $subject) : array
     {
         $result = array();
@@ -268,13 +268,13 @@ 
         return $result;
     }
     
-   /**
-    * Replaces all URL encoded unicode characters
-    * in the string with the unicode character.
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Replaces all URL encoded unicode characters
+     * in the string with the unicode character.
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function restoreUnicodeChar(string $string) : string
     {
         if(strpos($string, '%') !== false)
@@ -295,32 +295,32 @@ 
         );
     }
    
-   /**
-    * Checks whether the URL that was parsed is valid.
-    * @return bool
-    */
+    /**
+     * Checks whether the URL that was parsed is valid.
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->isValid;
     }
 
-   /**
-    * If the validation failed, retrieves the validation
-    * error message.
-    * 
-    * @return string
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error message.
+     * 
+     * @return string
+     */
     public function getErrorMessage() : string
     {
         return $this->error['message'] ?? '';
     }
     
-   /**
-    * If the validation failed, retrieves the validation
-    * error code.
-    * 
-    * @return int
-    */
+    /**
+     * If the validation failed, retrieves the validation
+     * error code.
+     * 
+     * @return int
+     */
     public function getErrorCode() : int
     {
         return $this->error['code'] ?? -1;