Mistralys / application-utils

src/URLInfo/ConnectionTester.php

Indentation +19 added lines, -19 removed lines

@@ -22,9 +22,9 @@ 
 {
     use Traits_Optionable;
     
-   /**
-    * @var URLInfo
-    */
+    /**
+     * @var URLInfo
+     */
     private $url;
     
     public function __construct(URLInfo $url)
@@ -41,13 +41,13 @@ 
         );
     }
     
-   /**
-    * Whether to verify the host's SSL certificate, in
-    * case of an https connection.
-    * 
-    * @param bool $verifySSL
-    * @return URLInfo_ConnectionTester
-    */
+    /**
+     * Whether to verify the host's SSL certificate, in
+     * case of an https connection.
+     * 
+     * @param bool $verifySSL
+     * @return URLInfo_ConnectionTester
+     */
     public function setVerifySSL(bool $verifySSL=true) : URLInfo_ConnectionTester
     {
         $this->setOption('verify-ssl', $verifySSL);
@@ -81,12 +81,12 @@ 
         return $this->getIntOption('timeout');
     }
     
-   /**
-    * Initializes the CURL instance.
-    * 
-    * @throws BaseException
-    * @return resource
-    */
+    /**
+     * Initializes the CURL instance.
+     * 
+     * @throws BaseException
+     * @return resource
+     */
     private function initCURL()
     {
         $ch = curl_init();
@@ -103,9 +103,9 @@ 
         return $ch;
     }
     
-   /**
-    * @param resource $ch
-    */
+    /**
+     * @param resource $ch
+     */
     private function configureOptions($ch) : void
     {
         if($this->isVerboseModeEnabled())

src/ConvertHelper/URLFinder.php

Indentation +37 added lines, -37 removed lines

@@ -110,38 +110,38 @@ 
         return $this;
     }
     
-   /**
-    * Whether to enable sorting the URLs alphabetically (disabled by default).
-    * 
-    * @param bool $enabled
-    * @return $this
-    */
+    /**
+     * Whether to enable sorting the URLs alphabetically (disabled by default).
+     * 
+     * @param bool $enabled
+     * @return $this
+     */
     public function enableSorting(bool $enabled=true) : ConvertHelper_URLFinder
     {
         $this->setOption('sorting', $enabled);
         return $this;
     }
     
-   /**
-    * Whether to include email addresses in the search. 
-    * This is only relevant when using the getURLs()
-    * method.
-    * 
-    * @param bool $include
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Whether to include email addresses in the search. 
+     * This is only relevant when using the getURLs()
+     * method.
+     * 
+     * @param bool $include
+     * @return ConvertHelper_URLFinder
+     */
     public function includeEmails(bool $include=true) : ConvertHelper_URLFinder
     {
         $this->setOption('include-emails', $include);
         return $this;
     }
     
-   /**
-    * Whether to omit the mailto: that is automatically added to all email addresses.
-    * 
-    * @param bool $omit
-    * @return ConvertHelper_URLFinder
-    */
+    /**
+     * Whether to omit the mailto: that is automatically added to all email addresses.
+     * 
+     * @param bool $omit
+     * @return ConvertHelper_URLFinder
+     */
     public function omitMailto(bool $omit=true) : ConvertHelper_URLFinder
     {
         $this->setOption('omit-mailto', $omit);
@@ -267,11 +267,11 @@ 
         );
     }
 
-   /**
-    * Fetches all URLs that can be found in the subject string.
-    * 
-    * @return string[]
-    */
+    /**
+     * Fetches all URLs that can be found in the subject string.
+     * 
+     * @return string[]
+     */
     public function getURLs() : array
     {
         $this->parse();
@@ -474,13 +474,13 @@ 
         return array_pop($parts);
     }
 
-   /**
-    * Retrieves all email addresses from the subject string.
-    * 
-    * @return string[]
-    * 
-    * @see omitMailto()
-    */
+    /**
+     * Retrieves all email addresses from the subject string.
+     * 
+     * @return string[]
+     * 
+     * @see omitMailto()
+     */
     public function getEmails() : array
     {
         $this->parse();
@@ -506,11 +506,11 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves all URLs as URLInfo instances.
-    * 
-    * @return URLInfo[]
-    */
+    /**
+     * Retrieves all URLs as URLInfo instances.
+     * 
+     * @return URLInfo[]
+     */
     public function getInfos() : array
     {
         $this->parse();

src/URLInfo/Parser.php

Indentation +73 added lines, -73 removed lines

@@ -23,24 +23,24 @@ 
  */
 class URLInfo_Parser
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $url;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $isValid = false;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $info;
     
-   /**
-    * @var array|NULL
-    */
+    /**
+     * @var array|NULL
+     */
     protected $error;
     
     /**
@@ -57,25 +57,25 @@ 
         'git'
     );
     
-   /**
-    * Stores a list of all unicode characters in the URL
-    * that have been filtered out before parsing it with
-    * parse_url.
-    * 
-    * @var string[]string
-    */
+    /**
+     * Stores a list of all unicode characters in the URL
+     * that have been filtered out before parsing it with
+     * parse_url.
+     * 
+     * @var string[]string
+     */
     protected $unicodeChars = array();
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $encodeUTF = false;
     
-   /**
-    * 
-    * @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;
@@ -88,12 +88,12 @@ 
         }
     }
 
-   /**
-    * Retrieves the array as parsed by PHP's parse_url,
-    * filtered and adjusted as necessary.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -115,11 +115,11 @@ 
         }
     }
 
-   /**
-    * 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);
@@ -238,11 +238,11 @@ 
         return false;
     }
 
-   /**
-    * 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['params'] = array();
@@ -284,13 +284,13 @@ 
         }
     }
     
-   /**
-    * Recursively goes through the array, and converts all previously
-    * URL encoded characters with their unicode character counterparts.
-    * 
-    * @param array $subject
-    * @return array
-    */
+    /**
+     * Recursively goes through the array, and converts all previously
+     * URL encoded characters with their unicode character counterparts.
+     * 
+     * @param array $subject
+     * @return array
+     */
     protected function restoreUnicodeChars(array $subject) : array
     {
         $result = array();
@@ -314,13 +314,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(strstr($string, '%'))
@@ -404,21 +404,21 @@ 
         );
     }
    
-   /**
-    * 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
     {
         if(isset($this->error)) {
@@ -428,12 +428,12 @@ 
         return '';
     }
     
-   /**
-    * 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
     {
         if(isset($this->error)) {

src/StringBuilder/Interface.php

Indentation +2 added lines, -2 removed lines

@@ -25,10 +25,10 @@
      * 
      * @return string
      */
-     function render() : string;
+        function render() : string;
      
     /**
      * Renders the string and echos it.
      */
-     function display() : void;
+        function display() : void;
 }

src/ConvertHelper/TabsNormalizer.php

Indentation +45 added lines, -45 removed lines

@@ -20,43 +20,43 @@ 
  */
 class ConvertHelper_TabsNormalizer
 {
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $max = 0;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $min = PHP_INT_MAX;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $tabs2spaces = false;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $lines = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $tabSize = 4;
     
-   /**
-    * Whether to enable or disable the conversion
-    * of tabs to spaces.
-    * 
-    * @param bool $enable
-    * @return ConvertHelper_TabsNormalizer
-    */
+    /**
+     * Whether to enable or disable the conversion
+     * of tabs to spaces.
+     * 
+     * @param bool $enable
+     * @return ConvertHelper_TabsNormalizer
+     */
     public function convertTabsToSpaces(bool $enable=true) : ConvertHelper_TabsNormalizer
     {
         $this->tabs2spaces = $enable;
@@ -64,13 +64,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the size of a tab, in spaces. Used to convert tabs
-    * from spaces and the other way around. Defaults to 4.
-    * 
-    * @param int $amountSpaces
-    * @return ConvertHelper_TabsNormalizer
-    */
+    /**
+     * Sets the size of a tab, in spaces. Used to convert tabs
+     * from spaces and the other way around. Defaults to 4.
+     * 
+     * @param int $amountSpaces
+     * @return ConvertHelper_TabsNormalizer
+     */
     public function setTabSize(int $amountSpaces) : ConvertHelper_TabsNormalizer
     {
         $this->tabSize = $amountSpaces;
@@ -78,15 +78,15 @@ 
         return $this;
     }
     
-   /**
-    * Normalizes tabs in the specified string by indenting everything
-    * back to the minimum tab distance. With the second parameter,
-    * tabs can optionally be converted to spaces as well (recommended
-    * for HTML output).
-    *
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Normalizes tabs in the specified string by indenting everything
+     * back to the minimum tab distance. With the second parameter,
+     * tabs can optionally be converted to spaces as well (recommended
+     * for HTML output).
+     *
+     * @param string $string
+     * @return string
+     */
     public function normalize(string $string) : string
     {
         $this->splitLines($string);
@@ -143,10 +143,10 @@ 
         return implode($this->eol, $converted);
     }
     
-   /**
-    * Finds out the minimum and maximum amount of 
-    * tabs in the string.
-    */
+    /**
+     * Finds out the minimum and maximum amount of 
+     * tabs in the string.
+     */
     protected function countOccurrences() : void
     {
         foreach($this->lines as $line) 

src/ConvertHelper/HiddenConverter.php

Indentation +18 added lines, -18 removed lines

@@ -71,9 +71,9 @@ 
         )
     );
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $selected = array();
     
     public function convert(string $string) : string
@@ -83,16 +83,16 @@ 
         return str_replace(array_keys($chars), array_values($chars), $string);
     }
     
-   /**
-    * Selects a character set to replace. Can be called
-    * several times to add additional sets to the collection.
-    * 
-    * @param string $type See the <code>CHAR_XXX</code> constants.
-    * @return ConvertHelper_HiddenConverter
-    * 
-    * @see ConvertHelper_HiddenConverter::CHARS_CONTROL
-    * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE
-    */
+    /**
+     * Selects a character set to replace. Can be called
+     * several times to add additional sets to the collection.
+     * 
+     * @param string $type See the <code>CHAR_XXX</code> constants.
+     * @return ConvertHelper_HiddenConverter
+     * 
+     * @see ConvertHelper_HiddenConverter::CHARS_CONTROL
+     * @see ConvertHelper_HiddenConverter::CHARS_WHITESPACE
+     */
     public function selectCharacters(string $type) : ConvertHelper_HiddenConverter
     {
         if(!in_array($type, $this->selected)) {
@@ -102,11 +102,11 @@ 
         return $this;
     }
     
-   /**
-    * Resolves the list of characters to make visible.
-    * 
-    * @return string[]
-    */
+    /**
+     * Resolves the list of characters to make visible.
+     * 
+     * @return string[]
+     */
     protected function resolveSelection() : array
     {
         $selected = $this->selected;

src/ConvertHelper/QueryParser.php

Indentation +10 added lines, -10 removed lines

@@ -27,16 +27,16 @@
         
     }
     
-   /**
-    * We parse the query string ourselves, because the PHP implementation
-    * of parse_str has limitations that do not apply to query strings. This
-    * is due to the fact that parse_str has to create PHP-compatible variable
-    * names from the parameters. URL parameters simply allow way more things
-    * than PHP variable names.
-    * 
-    * @param string $queryString
-    * @return array<string,string>
-    */
+    /**
+     * We parse the query string ourselves, because the PHP implementation
+     * of parse_str has limitations that do not apply to query strings. This
+     * is due to the fact that parse_str has to create PHP-compatible variable
+     * names from the parameters. URL parameters simply allow way more things
+     * than PHP variable names.
+     * 
+     * @param string $queryString
+     * @return array<string,string>
+     */
     public function parse(string $queryString) : array
     {
         // allow HTML entities notation

src/RequestHelper/Exception.php

Indentation +8 added lines, -8 removed lines

@@ -22,9 +22,9 @@ 
  */
 class RequestHelper_Exception extends BaseException
 {
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response = null;
 
     /**
@@ -37,11 +37,11 @@ 
         return $this;
     }
     
-   /**
-    * Retrieves the related response instance, if available.
-    * 
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * Retrieves the related response instance, if available.
+     * 
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;

src/Highlighter.php

Indentation +70 added lines, -70 removed lines

@@ -41,71 +41,71 @@ 
  */
 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');
     }
     
-   /**
-    * Adds HTML syntax highlighting to a JSON string, or a data array/object.
-    *
-    * @param array<int|string,mixed>|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
-    * @return string
-    */
+    /**
+     * Adds HTML syntax highlighting to a JSON string, or a data array/object.
+     *
+     * @param array<int|string,mixed>|object|string $subject A JSON string, or data array/object to convert to JSON to highlight.
+     * @return string
+     */
     public static function json($subject) : string
     {
         if(!is_string($subject))
@@ -118,13 +118,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)
@@ -141,13 +141,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)
@@ -164,27 +164,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);