Mistralys / application-utils

src/Request.php

Indentation +108 added lines, -108 removed lines

@@ -56,12 +56,12 @@ 
         $this->init();
     }
     
-   /**
-    * Can be extended in a subclass, to avoid
-    * redefining the constructor.
-    *
-    * @return void
-    */
+    /**
+     * Can be extended in a subclass, to avoid
+     * redefining the constructor.
+     *
+     * @return void
+     */
     protected function init() : void
     {
         
@@ -126,30 +126,30 @@ 
         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 a 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 a 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()) : array
     {
         return $this->createRefreshParams()
@@ -158,13 +158,13 @@ 
             ->getParams();
     }
     
-   /**
-    * Creates an instance of the helper that can be used to
-    * retrieve the request's parameters collection, with the
-    * possibility to exclude 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
+     * possibility to exclude and override some by rules.
+     * 
+     * @return Request_RefreshParams
+     */
     public function createRefreshParams() : Request_RefreshParams
     {
         return new Request_RefreshParams();
@@ -200,10 +200,10 @@ 
         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;
@@ -233,13 +233,13 @@ 
         return $this->knownParams[$name];
     }
     
-   /**
-    * Retrieves a previously registered parameter instance.
-    * 
-    * @param string $name
-    * @return RequestParam
-    *@throws Request_Exception
-    */
+    /**
+     * Retrieves a previously registered parameter instance.
+     * 
+     * @param string $name
+     * @return RequestParam
+     *@throws Request_Exception
+     */
     public function getRegisteredParam(string $name) : RequestParam
     {
         if(isset($this->knownParams[$name])) {
@@ -256,48 +256,48 @@ 
         );
     }
     
-   /**
-    * 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 string[]
-    * @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 string[]
+     * @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;
@@ -341,14 +341,14 @@ 
         return $this->getParam($name) !== null;
     }
     
-   /**
-    * 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])) {
@@ -362,12 +362,12 @@ 
         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) {
@@ -563,11 +563,11 @@ 
         exit;
     }
     
-   /**
-    * Sends HTML to the browser with the correct headers.
-    * 
-    * @param string $html
-    */
+    /**
+     * Sends HTML to the browser with the correct headers.
+     * 
+     * @param string $html
+     */
     public static function sendHTML(string $html) : void
     {
         header('Cache-Control: no-cache, must-revalidate');
@@ -588,16 +588,16 @@ 
         exit;
     }
     
-   /**
-    * 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 string[] $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 string[] $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);
@@ -606,10 +606,10 @@ 
         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'];

src/FileHelper/FileFinder.php

Indentation +130 added lines, -130 removed lines

@@ -44,20 +44,20 @@ 
 
     protected FolderInfo $path;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $found = array();
     
-   /**
-    * The path must exist when the class is instantiated: its
-    * real path will be determined to work with.
-    * 
-    * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
-    *
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * The path must exist when the class is instantiated: its
+     * real path will be determined to work with.
+     * 
+     * @param string|PathInfoInterface|SplFileInfo $path The absolute path to the target folder.
+     *
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public function __construct($path)
     {
         $this->path = AbstractPathInfo::resolveType($path)->requireExists()->requireIsFolder();
@@ -75,11 +75,11 @@ 
         );
     }
     
-   /**
-    * Enables extension stripping, to return file names without extension.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * Enables extension stripping, to return file names without extension.
+     * 
+     * @return FileFinder
+     */
     public function stripExtensions() : FileFinder
     {
         return $this->setOption('strip-extensions', true);
@@ -96,46 +96,46 @@ 
         return $this->setOption('recursive', $enabled);
     }
     
-   /**
-    * Retrieves all extensions that were added to
-    * the list of included extensions.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all extensions that were added to
+     * the list of included extensions.
+     * 
+     * @return string[]
+     */
     public function getIncludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_INCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Includes a single extension in the file search: only
-    * files with this extension will be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtensions()
-    */
+    /**
+     * Includes a single extension in the file search: only
+     * files with this extension will be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtensions()
+     */
     public function includeExtension(string $extension) : FileFinder
     {
         return $this->includeExtensions(array($extension));
     }
     
-   /**
-    * Includes several extensions in the file search: only
-    * files with these extensions wil be used in the results.
-    * 
-    * NOTE: Included extensions take precedence before excluded
-    * extensions. If any excluded extensions are specified, they
-    * will be ignored.
-    * 
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::includeExtension()
-    */
+    /**
+     * Includes several extensions in the file search: only
+     * files with these extensions wil be used in the results.
+     * 
+     * NOTE: Included extensions take precedence before excluded
+     * extensions. If any excluded extensions are specified, they
+     * will be ignored.
+     * 
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::includeExtension()
+     */
     public function includeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getIncludeExtensions();
@@ -146,37 +146,37 @@ 
         return $this;
     }
 
-   /**
-    * Retrieves a list of all extensions currently set as 
-    * excluded from the search.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all extensions currently set as 
+     * excluded from the search.
+     * 
+     * @return string[]
+     */
     public function getExcludeExtensions() : array
     {
         return $this->getArrayOption(self::OPTION_EXCLUDE_EXTENSIONS);
     }
     
-   /**
-    * Excludes a single extension from the search.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtensions()
-    */
+    /**
+     * Excludes a single extension from the search.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtensions()
+     */
     public function excludeExtension(string $extension) : FileFinder
     {
         return $this->excludeExtensions(array($extension));
     }
 
-   /**
-    * Add several extensions to the list of extensions to
-    * exclude from the file search.
-    *  
-    * @param string[] $extensions Extension names, without dot (`php` for example).
-    * @return FileFinder
-    * @see FileFinder::excludeExtension()
-    */
+    /**
+     * Add several extensions to the list of extensions to
+     * exclude from the file search.
+     *  
+     * @param string[] $extensions Extension names, without dot (`php` for example).
+     * @return FileFinder
+     * @see FileFinder::excludeExtension()
+     */
     public function excludeExtensions(array $extensions) : FileFinder
     {
         $items = $this->getExcludeExtensions();
@@ -187,52 +187,52 @@ 
         return $this;
     }
     
-   /**
-    * In this mode, the entire path to the file will be stripped,
-    * leaving only the file name in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the entire path to the file will be stripped,
+     * leaving only the file name in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeStrip() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_STRIP);
     }
     
-   /**
-    * In this mode, only the path relative to the source folder
-    * will be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, only the path relative to the source folder
+     * will be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeRelative() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_RELATIVE);
     }
     
-   /**
-    * In this mode, the full, absolute paths to the files will
-    * be included in the files list.
-    * 
-    * @return FileFinder
-    */
+    /**
+     * In this mode, the full, absolute paths to the files will
+     * be included in the files list.
+     * 
+     * @return FileFinder
+     */
     public function setPathmodeAbsolute() : FileFinder
     {
         return $this->setPathmode(self::PATH_MODE_ABSOLUTE);
     }
     
-   /**
-    * This sets a character or string to replace the slashes
-    * in the paths with. 
-    * 
-    * This is used for example in the `getPHPClassNames()` 
-    * method, to return files from subfolders as class names
-    * using the "_" character:
-    * 
-    * Subfolder/To/File.php => Subfolder_To_File.php
-    * 
-    * @param string $character
-    * @return FileFinder
-    */
+    /**
+     * This sets a character or string to replace the slashes
+     * in the paths with. 
+     * 
+     * This is used for example in the `getPHPClassNames()` 
+     * method, to return files from subfolders as class names
+     * using the "_" character:
+     * 
+     * Subfolder/To/File.php => Subfolder_To_File.php
+     * 
+     * @param string $character
+     * @return FileFinder
+     */
     public function setSlashReplacement(string $character) : FileFinder
     {
         return $this->setOption('slash-replacement', $character);
@@ -255,12 +255,12 @@ 
         return $this->setOption(self::OPTION_PATHMODE, $mode);
     }
     
-   /**
-    * Retrieves a list of all matching file names/paths,
-    * depending on the selected options.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all matching file names/paths,
+     * depending on the selected options.
+     * 
+     * @return string[]
+     */
     public function getAll() : array
     {
         $this->find((string)$this->path, true);
@@ -268,24 +268,24 @@ 
         return $this->found;
     }
     
-   /**
-    * Retrieves only PHP files. Can be combined with other
-    * options like enabling recursion into sub-folders.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves only PHP files. Can be combined with other
+     * options like enabling recursion into sub-folders.
+     * 
+     * @return string[]
+     */
     public function getPHPFiles() : array
     {
         $this->includeExtensions(array('php'));
         return $this->getAll();
     }
     
-   /**
-    * Generates PHP class names from file paths: it replaces
-    * slashes with underscores, and removes file extensions.
-    * 
-    * @return string[] An array of PHP file names without extension.
-    */
+    /**
+     * Generates PHP class names from file paths: it replaces
+     * slashes with underscores, and removes file extensions.
+     * 
+     * @return string[] An array of PHP file names without extension.
+     */
     public function getPHPClassNames() : array
     {
         $this->includeExtensions(array('php'));
@@ -356,13 +356,13 @@ 
         return $path;
     }
     
-   /**
-    * Checks whether the specified extension is allowed 
-    * with the current settings.
-    * 
-    * @param string $extension
-    * @return bool
-    */
+    /**
+     * Checks whether the specified extension is allowed 
+     * with the current settings.
+     * 
+     * @param string $extension
+     * @return bool
+     */
     protected function filterExclusion(string $extension) : bool
     {
         $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS);
@@ -382,12 +382,12 @@ 
         return true;
     }
     
-   /**
-    * Adjusts the path according to the selected path mode.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Adjusts the path according to the selected path mode.
+     * 
+     * @param string $path
+     * @return string
+     */
     protected function filterPath(string $path) : string
     {
         switch($this->getStringOption(self::OPTION_PATHMODE))

src/BaseException.php

Indentation +33 added lines, -33 removed lines

@@ -25,12 +25,12 @@ 
 {
     protected ?string $details = null;
     
-   /**
-    * @param string $message
-    * @param string|NULL $details
-    * @param int|NULL $code
-    * @param Throwable|NULL $previous
-    */
+    /**
+     * @param string $message
+     * @param string|NULL $details
+     * @param int|NULL $code
+     * @param Throwable|NULL $previous
+     */
     public function __construct(string $message, ?string $details=null, ?int $code=null, ?Throwable $previous=null)
     {
         if(defined('APP_UTILS_TESTSUITE') && APP_UTILS_TESTSUITE === 'true')
@@ -40,7 +40,7 @@ 
 
         if($code === null)
         {
-             $code = 0;
+                $code = 0;
         }
 
         parent::__construct($message, (int)$code, $previous);
@@ -48,18 +48,18 @@ 
         $this->details = $details;
     }
     
-   /**
-    * Retrieves the detailed error description, if any.
-    * @return string
-    */
+    /**
+     * Retrieves the detailed error description, if any.
+     * @return string
+     */
     public function getDetails() : string
     {
         return $this->details ?? '';
     }
     
-   /**
-    * Displays pertinent information on the exception.
-    */
+    /**
+     * Displays pertinent information on the exception.
+     */
     public function display() : void
     {
         if(!headers_sent()) {
@@ -69,20 +69,20 @@ 
         echo $this->getInfo();
     }
     
-   /**
-    * Retrieves information on the exception that can be
-    * easily accessed.
-    * 
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Retrieves information on the exception that can be
+     * easily accessed.
+     * 
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function getInfo() : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($this);
     }
     
-   /**
-    * Dumps a current PHP function trace, as a text only string.
-    */
+    /**
+     * Dumps a current PHP function trace, as a text only string.
+     */
     public static function dumpTraceAsString() : void
     {
         try
@@ -95,9 +95,9 @@ 
         }
     }
 
-   /**
-    * Dumps a current PHP function trace, with HTML styling.
-    */
+    /**
+     * Dumps a current PHP function trace, with HTML styling.
+     */
     public static function dumpTraceAsHTML() : void
     {
         try
@@ -112,13 +112,13 @@ 
         }
     }
     
-   /**
-    * Creates an exception info instance from a throwable instance.
-    * 
-    * @param Throwable $e
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper::throwable2info()
-    */
+    /**
+     * Creates an exception info instance from a throwable instance.
+     * 
+     * @param Throwable $e
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper::throwable2info()
+     */
     public static function createInfo(Throwable $e) : ConvertHelper_ThrowableInfo
     {
         return ConvertHelper::throwable2info($e);

src/FileHelper/PHPClassInfo.php

Indentation +39 added lines, -39 removed lines

@@ -48,11 +48,11 @@ 
         self::TYPE_TRAIT
     );
 
-   /**
-    * @param PHPFile $path The path to the PHP file to parse.
-    * @throws FileHelper_Exception
-    * @see FileHelper::findPHPClasses()
-    */
+    /**
+     * @param PHPFile $path The path to the PHP file to parse.
+     * @throws FileHelper_Exception
+     * @see FileHelper::findPHPClasses()
+     */
     public function __construct(PHPFile $path)
     {
         $this->file = $path
@@ -62,58 +62,58 @@ 
         $this->parseFile();
     }
     
-   /**
-    * The name of the namespace of the classes in the file, if any.
-    * @return string
-    */
+    /**
+     * The name of the namespace of the classes in the file, if any.
+     * @return string
+     */
     public function getNamespace() : string
     {
         return $this->namespace;
     }
     
-   /**
-    * Whether the file contains a namespace.
-    * @return bool
-    */
+    /**
+     * Whether the file contains a namespace.
+     * @return bool
+     */
     public function hasNamespace() : bool
     {
         return !empty($this->namespace);
     }
     
-   /**
-    * The absolute path to the file.
-    * @return string
-    */
+    /**
+     * The absolute path to the file.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->file->getPath();
     }
    
-   /**
-    * Whether any classes were found in the file.
-    * @return bool
-    */
+    /**
+     * Whether any classes were found in the file.
+     * @return bool
+     */
     public function hasClasses() : bool
     {
         return !empty($this->classes);
     }
     
-   /**
-    * The names of the classes that were found in the file (with namespace if any).
-    * @return string[]
-    */
+    /**
+     * The names of the classes that were found in the file (with namespace if any).
+     * @return string[]
+     */
     public function getClassNames() : array
     {
         return array_keys($this->classes);
     }
     
-   /**
-    * Retrieves all classes that were detected in the file,
-    * which can be used to retrieve more information about
-    * them.
-    * 
-    * @return FileHelper_PHPClassInfo_Class[]
-    */
+    /**
+     * Retrieves all classes that were detected in the file,
+     * which can be used to retrieve more information about
+     * them.
+     * 
+     * @return FileHelper_PHPClassInfo_Class[]
+     */
     public function getClasses() : array
     {
         return array_values($this->classes);
@@ -185,13 +185,13 @@ 
         $this->classes[$class->getNameNS()] = $class;
     }
 
-   /**
-    * Strips all whitespace from the string, replacing it with 
-    * regular spaces (newlines, tabs, etc.).
-    * 
-    * @param string $string
-    * @return string
-    */
+    /**
+     * Strips all whitespace from the string, replacing it with 
+     * regular spaces (newlines, tabs, etc.).
+     * 
+     * @param string $string
+     * @return string
+     */
     protected function stripWhitespace(string $string) : string 
     {
         return preg_replace('/\s/', ' ', $string);

src/Request/AcceptHeaders.php

Indentation +32 added lines, -32 removed lines

@@ -33,22 +33,22 @@ 
         $this->parse();
     }
     
-   /**
-    * 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 string[]
-    */
+    /**
+     * 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 string[]
+     */
     public function getMimeStrings() : array
     {
         $result = array();
@@ -61,9 +61,9 @@ 
         return $result;
     }
     
-   /**
-    * Checks that an "Accept" header string exists, and tries to parse it.
-    */
+    /**
+     * Checks that an "Accept" header string exists, and tries to parse it.
+     */
     protected function parse() : void
     {
         // we may be in a CLI environment where the headers
@@ -75,12 +75,12 @@ 
         $this->headers = $this->parseHeader($_SERVER['HTTP_ACCEPT']);
     }
     
-   /**
-    * Splits the "Accept" header string and parses the mime types.
-    *  
-    * @param string $acceptHeader
-    * @return AcceptHeader[]
-    */
+    /**
+     * Splits the "Accept" header string and parses the mime types.
+     *  
+     * @param string $acceptHeader
+     * @return AcceptHeader[]
+     */
     protected function parseHeader(string $acceptHeader) : array
     {
         $tokens = preg_split('/\s*,\s*/', $acceptHeader);
@@ -97,13 +97,13 @@ 
         return $accept;
     }
     
-   /**
-    * Parses a single mime type entry.
-    * 
-    * @param int $i The position in the "Accept" string
-    * @param string $mime The mime type
-    * @return AcceptHeader
-    */
+    /**
+     * Parses a single mime type entry.
+     * 
+     * @param int $i The position in the "Accept" string
+     * @param string $mime The mime type
+     * @return AcceptHeader
+     */
     protected function parseEntry(int $i, string $mime) : AcceptHeader
     {
         $quality = 0;

src/URLInfo/URINormalizer.php

Indentation +11 added lines, -11 removed lines

@@ -28,23 +28,23 @@
         $this->info = $info;
     }
     
-   /**
-    * Enables the authentication information in the URL,
-    * if a username and password are present.
-    * 
-    * @param bool $enable Whether to turn it on or off.
-    * @return URINormalizer
-    */
+    /**
+     * Enables the authentication information in the URL,
+     * if a username and password are present.
+     * 
+     * @param bool $enable Whether to turn it on or off.
+     * @return URINormalizer
+     */
     public function enableAuth(bool $enable=true) : URINormalizer
     {
         $this->auth = $enable;
         return $this;
     }
     
-   /**
-    * Retrieves the normalized URL.
-    * @return string
-    */
+    /**
+     * Retrieves the normalized URL.
+     * @return string
+     */
     public function normalize() : string
     {
         $method = 'normalize_'.$this->info->getType();

src/URLInfo/URIHighlighter.php

Indentation +7 added lines, -7 removed lines

@@ -155,13 +155,13 @@
         );
     }
     
-   /**
-    * Fetches all parameters in the URL, regardless of 
-    * whether parameter exclusion is enabled, so they
-    * can be highlighted is need be.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Fetches all parameters in the URL, regardless of 
+     * whether parameter exclusion is enabled, so they
+     * can be highlighted is need be.
+     * 
+     * @return array<string,string>
+     */
     protected function resolveParams() : array
     {
         $previous = $this->info->isParamExclusionEnabled();

src/URLInfo.php

Indentation +184 added lines, -184 removed lines

@@ -44,42 +44,42 @@ 
     public const TYPE_URL = 'url';
     public const TYPE_NONE = 'none';
 
-   /**
-    * The original URL that was passed to the constructor.
-    * @var string
-    */
+    /**
+     * The original URL that was passed to the constructor.
+     * @var string
+     */
     protected string $rawURL;
 
-   /**
-    * @var array<string,mixed>
-    */
+    /**
+     * @var array<string,mixed>
+     */
     protected array $info;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $excludedParams = array();
     
-   /**
-    * @var bool
-    * @see URLInfo::setParamExclusion()
-    */
+    /**
+     * @var bool
+     * @see URLInfo::setParamExclusion()
+     */
     protected bool $paramExclusion = false;
     
-   /**
-    * @var array<string,string>|NULL
-    * @see URLInfo::getTypeLabel()
-    */
+    /**
+     * @var array<string,string>|NULL
+     * @see URLInfo::getTypeLabel()
+     */
     protected static ?array $typeLabels = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $highlightExcluded = false;
     
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected array $infoKeys = array(
         'scheme',
         'host',
@@ -91,24 +91,24 @@ 
         'fragment'
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected string $url;
     
-   /**
-    * @var URIParser
-    */
+    /**
+     * @var URIParser
+     */
     protected URIParser $parser;
     
-   /**
-    * @var URINormalizer|NULL
-    */
+    /**
+     * @var URINormalizer|NULL
+     */
     protected ?URINormalizer $normalizer = null;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected bool $encodeUTFChars = false;
     
     public function __construct(string $url)
@@ -125,14 +125,14 @@ 
         $this->info = $this->parser->getInfo();
     }
 
-   /**
-    * Whether to URL encode any non-encoded UTF8 characters in the URL.
-    * Default is to leave them as-is for better readability, since 
-    * browsers handle this well.
-    * 
-    * @param bool $enabled
-    * @return URLInfo
-    */
+    /**
+     * Whether to URL encode any non-encoded UTF8 characters in the URL.
+     * Default is to leave them as-is for better readability, since 
+     * browsers handle this well.
+     * 
+     * @param bool $enabled
+     * @return URLInfo
+     */
     public function setUTFEncoding(bool $enabled=true) : URLInfo
     {
         if($this->encodeUTFChars !== $enabled)
@@ -149,13 +149,13 @@ 
         return $this->encodeUTFChars;
     }
     
-   /**
-    * Filters a URL: removes control characters and the
-    * like to have a clean URL to work with.
-    * 
-    * @param string $url
-    * @return string
-    */
+    /**
+     * Filters a URL: removes control characters and the
+     * like to have a clean URL to work with.
+     * 
+     * @param string $url
+     * @return string
+     */
     public static function filterURL(string $url) : string
     {
         return URIFilter::filter($url);
@@ -185,12 +185,12 @@ 
         return $this->info['type'] === self::TYPE_PHONE;
     }
     
-   /**
-    * Whether the URL is a regular URL, not one of the 
-    * other types like a phone number or email address.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the URL is a regular URL, not one of the 
+     * other types like a phone number or email address.
+     * 
+     * @return bool
+     */
     public function isURL() : bool
     {
         $host = $this->getHost();
@@ -202,20 +202,20 @@ 
         return $this->parser->isValid();
     }
     
-   /**
-    * Retrieves the host name, or an empty string if none is present.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the host name, or an empty string if none is present.
+     * 
+     * @return string
+     */
     public function getHost() : string
     {
         return $this->getInfoKey('host');
     }
     
-   /**
-    * Retrieves the path, or an empty string if none is present.
-    * @return string
-    */
+    /**
+     * Retrieves the path, or an empty string if none is present.
+     * @return string
+     */
     public function getPath() : string
     {
         return $this->getInfoKey('path');
@@ -231,10 +231,10 @@ 
         return $this->getInfoKey('scheme');
     }
     
-   /**
-    * Retrieves the port specified in the URL, or -1 if none is present.
-    * @return int
-    */
+    /**
+     * Retrieves the port specified in the URL, or -1 if none is present.
+     * @return int
+     */
     public function getPort() : int
     {
         $port = $this->getInfoKey('port');
@@ -246,13 +246,13 @@ 
         return -1;
     }
     
-   /**
-    * Retrieves the raw query string, or an empty string if none is present.
-    * 
-    * @return string
-    * 
-    * @see URLInfo::getParams()
-    */
+    /**
+     * Retrieves the raw query string, or an empty string if none is present.
+     * 
+     * @return string
+     * 
+     * @see URLInfo::getParams()
+     */
     public function getQuery() : string
     {
         return $this->getInfoKey('query');
@@ -268,20 +268,20 @@ 
         return $this->getInfoKey('pass');
     }
     
-   /**
-    * Whether the URL contains a port number.
-    * @return bool
-    */
+    /**
+     * Whether the URL contains a port number.
+     * @return bool
+     */
     public function hasPort() : bool
     {
         return $this->getPort() !== -1;
     }
     
-   /**
-    * Alias for the hasParams() method.
-    * @return bool
-    * @see URLInfo::hasParams()
-    */
+    /**
+     * Alias for the hasParams() method.
+     * @return bool
+     * @see URLInfo::hasParams()
+     */
     public function hasQuery() : bool
     {
         return $this->hasParams();
@@ -326,23 +326,23 @@ 
         return '';
     }
 
-   /**
-    * Retrieves a normalized URL: this ensures that all parameters
-    * in the URL are always in the same order.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves a normalized URL: this ensures that all parameters
+     * in the URL are always in the same order.
+     * 
+     * @return string
+     */
     public function getNormalized() : string
     {
         return $this->normalize();
     }
     
-   /**
-    * Like getNormalized(), but if a username and password are present
-    * in the URL, returns the URL without them.
-    * 
-    * @return string
-    */
+    /**
+     * Like getNormalized(), but if a username and password are present
+     * in the URL, returns the URL without them.
+     * 
+     * @return string
+     */
     public function getNormalizedWithoutAuth() : string
     {
         return $this->normalize(false);
@@ -363,25 +363,25 @@ 
         return $this->normalizer->normalize();
     }
     
-   /**
-    * Creates a hash of the URL, which can be used for comparisons.
-    * Since any parameters in the URL's query are sorted alphabetically,
-    * the same links with a different parameter order will have the 
-    * same hash.
-    * 
-    * @return string
-    */
+    /**
+     * Creates a hash of the URL, which can be used for comparisons.
+     * Since any parameters in the URL's query are sorted alphabetically,
+     * the same links with a different parameter order will have the 
+     * same hash.
+     * 
+     * @return string
+     */
     public function getHash() : string
     {
         return ConvertHelper::string2shortHash($this->getNormalized());
     }
 
-   /**
-    * Highlights the URL using HTML tags with specific highlighting
-    * class names.
-    * 
-    * @return string Will return an empty string if the URL is not valid.
-    */
+    /**
+     * Highlights the URL using HTML tags with specific highlighting
+     * class names.
+     * 
+     * @return string Will return an empty string if the URL is not valid.
+     */
     public function getHighlighted() : string
     {
         if(!$this->isValid()) {
@@ -413,15 +413,15 @@ 
         return count($params);
     }
     
-   /**
-    * Retrieves all parameters specified in the url,
-    * if any, as an associative array. 
-    * 
-    * NOTE: Ignores parameters that have been added
-    * to the excluded parameters list.
-    *
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all parameters specified in the url,
+     * if any, as an associative array. 
+     * 
+     * NOTE: Ignores parameters that have been added
+     * to the excluded parameters list.
+     *
+     * @return array<string,string>
+     */
     public function getParams() : array
     {
         if(!$this->paramExclusion || empty($this->excludedParams)) {
@@ -439,37 +439,37 @@ 
         return $keep;
     }
     
-   /**
-    * Retrieves the names of all parameters present in the URL, if any.
-    * @return string[]
-    */
+    /**
+     * Retrieves the names of all parameters present in the URL, if any.
+     * @return string[]
+     */
     public function getParamNames() : array
     {
         $params = $this->getParams();
         return array_keys($params);
     }
     
-   /**
-    * Retrieves a specific parameter value from the URL.
-    * 
-    * @param string $name
-    * @return string The parameter value, or an empty string if it does not exist.
-    */
+    /**
+     * Retrieves a specific parameter value from the URL.
+     * 
+     * @param string $name
+     * @return string The parameter value, or an empty string if it does not exist.
+     */
     public function getParam(string $name) : string
     {
         return $this->info['params'][$name] ?? '';
     }
     
-   /**
-    * Excludes a URL parameter entirely if present:
-    * the parser will act as if the parameter was not
-    * even present in the source URL, effectively
-    * stripping it.
-    *
-    * @param string $name
-    * @param string $reason A human-readable explanation why this is excluded - used when highlighting links.
-    * @return URLInfo
-    */
+    /**
+     * Excludes a URL parameter entirely if present:
+     * the parser will act as if the parameter was not
+     * even present in the source URL, effectively
+     * stripping it.
+     *
+     * @param string $name
+     * @param string $reason A human-readable explanation why this is excluded - used when highlighting links.
+     * @return URLInfo
+     */
     public function excludeParam(string $name, string $reason='') : URLInfo
     {
         if(!isset($this->excludedParams[$name]))
@@ -522,14 +522,14 @@ 
         return self::$typeLabels[$this->getType()];
     }
 
-   /**
-    * Whether excluded parameters should be highlighted in
-    * a different color in the URL when using the
-    * {@link URLInfo::getHighlighted()} method.
-    *
-    * @param bool $highlight
-    * @return URLInfo
-    */
+    /**
+     * Whether excluded parameters should be highlighted in
+     * a different color in the URL when using the
+     * {@link URLInfo::getHighlighted()} method.
+     *
+     * @param bool $highlight
+     * @return URLInfo
+     */
     public function setHighlightExcluded(bool $highlight=true) : URLInfo
     {
         $this->highlightExcluded = $highlight;
@@ -585,24 +585,24 @@ 
         return $this;
     }
     
-   /**
-    * Whether the parameter exclusion mode is enabled:
-    * In this case, if any parameters have been added to the
-    * exclusion list, all relevant methods will exclude these.
-    *
-    * @return bool
-    */
+    /**
+     * Whether the parameter exclusion mode is enabled:
+     * In this case, if any parameters have been added to the
+     * exclusion list, all relevant methods will exclude these.
+     *
+     * @return bool
+     */
     public function isParamExclusionEnabled() : bool
     {
         return $this->paramExclusion;
     }
     
-   /**
-    * Checks whether the link contains any parameters that
-    * are on the list of excluded parameters.
-    *
-    * @return bool
-    */
+    /**
+     * Checks whether the link contains any parameters that
+     * are on the list of excluded parameters.
+     *
+     * @return bool
+     */
     public function containsExcludedParams() : bool
     {
         if(empty($this->excludedParams)) {
@@ -690,26 +690,26 @@ 
             ->canConnect();
     }
     
-   /**
-    * Creates the connection tester instance that is used
-    * to check if a URL can be connected to, and which is
-    * used in the {@see URLInfo::tryConnect()} method. It
-    * allows more settings to be used.
-    * 
-    * @return URIConnectionTester
-    */
+    /**
+     * Creates the connection tester instance that is used
+     * to check if a URL can be connected to, and which is
+     * used in the {@see URLInfo::tryConnect()} method. It
+     * allows more settings to be used.
+     * 
+     * @return URIConnectionTester
+     */
     public function createConnectionTester() : URIConnectionTester
     {
         return new URIConnectionTester($this);
     }
     
-   /**
-    * Adds/overwrites a URL parameter.
-    *  
-    * @param string $name
-    * @param string $val
-    * @return URLInfo
-    */
+    /**
+     * Adds/overwrites a URL parameter.
+     *  
+     * @param string $name
+     * @param string $val
+     * @return URLInfo
+     */
     public function setParam(string $name, string $val) : URLInfo
     {
         $this->info['params'][$name] = $val;
@@ -717,13 +717,13 @@ 
         return $this;
     }
     
-   /**
-    * Removes a URL parameter. Has no effect if the
-    * parameter is not present to begin with.
-    * 
-    * @param string $param
-    * @return URLInfo
-    */
+    /**
+     * Removes a URL parameter. Has no effect if the
+     * parameter is not present to begin with.
+     * 
+     * @param string $param
+     * @return URLInfo
+     */
     public function removeParam(string $param) : URLInfo
     {
         if(isset($this->info['params'][$param]))

src/IniHelper.php

Indentation +77 added lines, -77 removed lines

@@ -62,10 +62,10 @@ 
         }
     }
     
-   /**
-    * The end of line character used in the INI source string.
-    * @return string
-    */
+    /**
+     * The end of line character used in the INI source string.
+     * @return string
+     */
     public function getEOLChar() : string
     {
         return $this->eol;
@@ -99,35 +99,35 @@ 
         );
     }
     
-   /**
-    * Factory method: Creates a new ini helper instance from an ini string.
-    * 
-    * @param string $iniContent
-    * @return IniHelper
-    */
+    /**
+     * Factory method: Creates a new ini helper instance from an ini string.
+     * 
+     * @param string $iniContent
+     * @return IniHelper
+     */
     public static function createFromString(string $iniContent) : IniHelper
     {
         return new IniHelper($iniContent);
     }
     
-   /**
-    * Factory method: Creates a new empty ini helper.
-    *  
-    * @return IniHelper
-    */
+    /**
+     * Factory method: Creates a new empty ini helper.
+     *  
+     * @return IniHelper
+     */
     public static function createNew() : IniHelper
     {
         return self::createFromString('');
     }
     
-   /**
-    * Adds a new data section, and returns the section instance.
-    * If a section with the name already exists, returns that
-    * section instead of creating a new one.
-    *  
-    * @param string $name
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a new data section, and returns the section instance.
+     * If a section with the name already exists, returns that
+     * section instead of creating a new one.
+     *  
+     * @param string $name
+     * @return IniHelper_Section
+     */
     public function addSection(string $name) : IniHelper_Section
     {
         if(!isset($this->sections[$name])) {
@@ -137,22 +137,22 @@ 
         return $this->sections[$name];
     }
     
-   /**
-    * Retrieves a section by its name, if it exists.
-    * 
-    * @param string $name
-    * @return IniHelper_Section|NULL
-    */
+    /**
+     * Retrieves a section by its name, if it exists.
+     * 
+     * @param string $name
+     * @return IniHelper_Section|NULL
+     */
     public function getSection(string $name) : ?IniHelper_Section
     {
         return $this->sections[$name] ?? null;
     }
     
-   /**
-    * Gets the data from the INI file as an associative array.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Gets the data from the INI file as an associative array.
+     * 
+     * @return array<string,mixed>
+     */
     public function toArray() : array
     {
         $result = array();
@@ -172,17 +172,17 @@ 
         return $result;
     }
     
-   /**
-    * Saves the INI content to the target file.
-    * 
-    * @param string $filePath
-    * @return IniHelper
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the INI content to the target file.
+     * 
+     * @param string $filePath
+     * @return IniHelper
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public function saveToFile(string $filePath) : IniHelper
     {
         FileHelper::saveFile($filePath, $this->saveToString());
@@ -190,11 +190,11 @@ 
         return $this;
     }
     
-   /**
-    * Returns the INI content as string.
-    * 
-    * @return string
-    */
+    /**
+     * Returns the INI content as string.
+     * 
+     * @return string
+     */
     public function saveToString() : string
     {
         $parts = array();
@@ -207,15 +207,15 @@ 
         return implode($this->eol, $parts);
     }
     
-   /**
-    * Sets or adds the value of a setting in the INI content.
-    * If the setting does not exist, it is added. Otherwise,
-    * the existing value is overwritten.
-    * 
-    * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>.
-    * @param mixed $value
-    * @return IniHelper
-    */
+    /**
+     * Sets or adds the value of a setting in the INI content.
+     * If the setting does not exist, it is added. Otherwise,
+     * the existing value is overwritten.
+     * 
+     * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>.
+     * @param mixed $value
+     * @return IniHelper
+     */
     public function setValue(string $path, $value) : IniHelper
     {
         $info = $this->parsePath($path);
@@ -239,12 +239,12 @@ 
         return $this;
     }
     
-   /**
-    * Checks whether a section with the specified name exists.
-    * 
-    * @param string $name
-    * @return bool
-    */
+    /**
+     * Checks whether a section with the specified name exists.
+     * 
+     * @param string $name
+     * @return bool
+     */
     public function sectionExists(string $name) : bool
     {
         foreach($this->sections as $section) {
@@ -256,23 +256,23 @@ 
         return false;
     }
     
-   /**
-    * Retrieves the default section, which is used to add
-    * values in the root of the document.
-    * 
-    * @return IniHelper_Section
-    */
+    /**
+     * Retrieves the default section, which is used to add
+     * values in the root of the document.
+     * 
+     * @return IniHelper_Section
+     */
     public function getDefaultSection() : IniHelper_Section
     {
         return $this->addSection(self::SECTION_DEFAULT);
     }
     
-   /**
-    * Retrieves all variable lines for the specified path.
-    * 
-    * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>.
-    * @return INILine[]
-    */
+    /**
+     * Retrieves all variable lines for the specified path.
+     * 
+     * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>.
+     * @return INILine[]
+     */
     public function getLinesByVariable(string $path) : array
     {
         $info = $this->parsePath($path);