Mistralys / application-utils

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

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/XMLHelper.php

Indentation +65 added lines, -65 removed lines

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

src/RequestHelper/Boundaries/Boundary.php

Indentation +32 added lines, -32 removed lines

@@ -25,9 +25,9 @@ 
     protected RequestHelper_Boundaries $boundaries;
     protected string $transferEncoding = '';
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected array $dispositionParams = array();
 
     public function __construct(RequestHelper_Boundaries $boundaries, string $content)
@@ -41,46 +41,46 @@ 
         return strlen($this->content);
     }
     
-   /**
-    * Sets the name of the request parameter.
-    * 
-    * @param string $name
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the name of the request parameter.
+     * 
+     * @param string $name
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setName(string $name) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('name', $name);
     }
     
-   /**
-    * Sets the filename to use for the content, if applicable.
-    *  
-    * @param string $fileName
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the filename to use for the content, if applicable.
+     *  
+     * @param string $fileName
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setFileName(string $fileName) : RequestHelper_Boundaries_Boundary
     {
         return $this->setDispositionParam('filename', $fileName);
     }
     
-   /**
-    * Sets the content type to use for the content.
-    * 
-    * @param string $contentType
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the content type to use for the content.
+     * 
+     * @param string $contentType
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentType(string $contentType) : RequestHelper_Boundaries_Boundary
     {
         $this->contentType = $contentType;
         return $this;
     }
     
-   /**
-    * Sets the encoding to specify for the content.
-    * 
-    * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
-    * @return RequestHelper_Boundaries_Boundary
-    */
+    /**
+     * Sets the encoding to specify for the content.
+     * 
+     * @param string $encoding An encoding string, e.g. "UTF-8", "ASCII"
+     * @return RequestHelper_Boundaries_Boundary
+     */
     public function setContentEncoding(string $encoding) : RequestHelper_Boundaries_Boundary
     {
         $this->contentEncoding = $encoding;
@@ -100,11 +100,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the mime boundary text.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the mime boundary text.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         $eol = $this->boundaries->getEOL();

src/RequestHelper/Response.php

Indentation +47 added lines, -47 removed lines

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