Mistralys / application-utils

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);

src/IniHelper/Section.php

Indentation +47 added lines, -47 removed lines

@@ -26,9 +26,9 @@ 
     protected IniHelper $ini;
     protected string $name;
     
-   /**
-    * @var INILine[]
-    */
+    /**
+     * @var INILine[]
+     */
     protected array $lines = array();
     
     public function __construct(IniHelper $ini, string $name)
@@ -37,33 +37,33 @@ 
         $this->name = $name;
     }
     
-   /**
-    * The section's name.
-    * @return string
-    */
+    /**
+     * The section's name.
+     * @return string
+     */
     public function getName() : string
     {
         return $this->name;
     }
     
-   /**
-    * Whether this is the default section: this 
-    * is used internally to store all variables that
-    * are not in any specific section.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether this is the default section: this 
+     * is used internally to store all variables that
+     * are not in any specific section.
+     * 
+     * @return bool
+     */
     public function isDefault() : bool
     {
         return $this->name === IniHelper::SECTION_DEFAULT;
     }
     
-   /**
-    * Adds a line instance to the section.
-    * 
-    * @param INILine $line
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a line instance to the section.
+     * 
+     * @param INILine $line
+     * @return IniHelper_Section
+     */
     public function addLine(INILine $line) : IniHelper_Section
     {
         $this->lines[] = $line;
@@ -71,12 +71,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts the values contained in the section into 
-    * an associative array.
-    * 
-    * @return array<string,array<int,string>>
-    */
+    /**
+     * Converts the values contained in the section into 
+     * an associative array.
+     * 
+     * @return array<string,array<int,string>>
+     */
     public function toArray() : array
     {
         $result = array();
@@ -136,12 +136,12 @@ 
         return implode($this->ini->getEOLChar(), $lines);
     }
 
-   /**
-    * Deletes a line from the section.
-    * 
-    * @param INILine $toDelete
-    * @return IniHelper_Section
-    */
+    /**
+     * Deletes a line from the section.
+     * 
+     * @param INILine $toDelete
+     * @return IniHelper_Section
+     */
     public function deleteLine(INILine $toDelete) : IniHelper_Section
     {
         $keep = array();
@@ -226,15 +226,15 @@ 
         return $this;
     }
     
-   /**
-    * Adds a variable value to the section. Unlike setValue(), this
-    * will not overwrite any existing value. If the name is an existing
-    * variable name, it will be converted to duplicate keys.
-    * 
-    * @param string $name
-    * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a variable value to the section. Unlike setValue(), this
+     * will not overwrite any existing value. If the name is an existing
+     * variable name, it will be converted to duplicate keys.
+     * 
+     * @param string $name
+     * @param mixed $value If this is an array, it will be treated as duplicate keys, and all values that are not present yet will be added.
+     * @return IniHelper_Section
+     */
     public function addValue(string $name, $value) : IniHelper_Section
     {
         // array value? Treat it as duplicate keys.
@@ -297,12 +297,12 @@ 
     }
     
     
-   /**
-    * Retrieves all lines for the specified variable name.
-    *  
-    * @param string $name
-    * @return INILine[]
-    */
+    /**
+     * Retrieves all lines for the specified variable name.
+     *  
+     * @param string $name
+     * @return INILine[]
+     */
     public function getLinesByVariable(string $name) : array
     {
         $result = array();

src/Request/Param/Validator.php

Indentation +3 added lines, -3 removed lines

@@ -27,9 +27,9 @@
     protected RequestParam $param;
     protected bool $isSubvalue = false;
 
-   /**
-    * @var mixed|NULL
-    */
+    /**
+     * @var mixed|NULL
+     */
     protected $value;
     
     public function __construct(RequestParam $param, bool $subval)

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
-    */
+    /**
+     * Retrieves the array as parsed by PHP's parse_url,
+     * filtered and adjusted as necessary.
+     * 
+     * @return array
+     */
     public function getInfo() : array
     {
         return $this->info;
@@ -119,11 +119,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);
@@ -194,23 +194,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 $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();
@@ -234,13 +234,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)
@@ -261,32 +261,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;