Mistralys / application-utils

src/XMLHelper.php

Indentation +172 added lines, -172 removed lines

@@ -28,9 +28,9 @@ 
 {
     const ERROR_CANNOT_APPEND_FRAGMENT = 491001; 
 
-   /**
-    * @var boolean
-    */
+    /**
+     * @var boolean
+     */
     private static $simulation = false;
 
     /**
@@ -38,11 +38,11 @@ 
      */
     private $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');
@@ -51,72 +51,72 @@ 
         return new XMLHelper($dom);
     }
     
-   /**
-    * Creates a converter instance from an XML file.
-    * @param string $xmlFile
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter instance from an XML file.
+     * @param string $xmlFile
+     * @return XMLHelper_Converter
+     */
     public static function convertFile(string $xmlFile) : XMLHelper_Converter
     {
         return XMLHelper_Converter::fromFile($xmlFile);
     }
     
-   /**
-    * Creates a converter from an XML string.
-    * @param string $xmlString
-    * @return XMLHelper_Converter
-    */
+    /**
+     * Creates a converter from an XML string.
+     * @param string $xmlString
+     * @return XMLHelper_Converter
+     */
     public static function convertString(string $xmlString) : XMLHelper_Converter
     {
         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;
     }
 
-   /**
-    * Adds an attribute to an existing tag with
-    * the specified value.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param mixed $value
-    * @return DOMNode
-    */
+    /**
+     * Adds an attribute to an existing tag with
+     * the specified value.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param mixed $value
+     * @return DOMNode
+     */
     public function addAttribute(DOMNode $parent, string $name, $value)
     {
         $node = $this->dom->createAttribute($name);
@@ -126,12 +126,12 @@ 
         return $parent->appendChild($node);
     }
 
-   /**
-    * Adds several attributes to the target node.
-    * 
-    * @param DOMNode $parent
-    * @param array<string,mixed> $attributes
-    */
+    /**
+     * Adds several attributes to the target node.
+     * 
+     * @param DOMNode $parent
+     * @param array<string,mixed> $attributes
+     */
     public function addAttributes(DOMNode $parent, array $attributes) : void
     {
         foreach ($attributes as $name => $value) {
@@ -139,14 +139,14 @@ 
         }
     }
 
-   /**
-    * Adds a tag without content.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag without content.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTag(DOMNode $parent, string $name, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -168,17 +168,17 @@ 
         $parent->appendChild($this->dom->createTextNode(str_repeat("\t", $amount)));
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addTextTag(DOMNode $parent, string $name, string $text, int $indent = 0) : DOMNode
     {
         if ($indent > 0) {
@@ -192,19 +192,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with textual content, like:
-    *
-    * <tagname>text</tagname>
-    *
-    * and removes <p> tags
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with textual content, like:
+     *
+     * <tagname>text</tagname>
+     *
+     * and removes <p> tags
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addEscapedTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -220,19 +220,19 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with HTML content, like:
-    *
-    * <tagname><i>text</i></tagname>
-    *
-    * Tags will not be escaped.
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $text
-    * @param integer $indent
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with HTML content, like:
+     *
+     * <tagname><i>text</i></tagname>
+     *
+     * Tags will not be escaped.
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $text
+     * @param integer $indent
+     * @return DOMNode
+     */
     public function addFragmentTag(DOMNode $parent, string $name, string $text, int $indent = 0)
     {
         if ($indent > 0) {
@@ -260,16 +260,16 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Adds a tag with CDATA content, like:
-    *
-    * <tagname><![CDATA[value]]></tagname>
-    *
-    * @param DOMNode $parent
-    * @param string $name
-    * @param string $content
-    * @return DOMNode
-    */
+    /**
+     * Adds a tag with CDATA content, like:
+     *
+     * <tagname><![CDATA[value]]></tagname>
+     *
+     * @param DOMNode $parent
+     * @param string $name
+     * @param string $content
+     * @return DOMNode
+     */
     public function addCDATATag(DOMNode $parent, string $name, string $content) : DOMNode
     {
         $tag = $this->dom->createElement($name);
@@ -279,12 +279,12 @@ 
         return $parent->appendChild($tag);
     }
 
-   /**
-    * Creates the root element of the document.
-    * @param string $name
-    * @param array<string,mixed> $attributes
-    * @return DOMNode
-    */
+    /**
+     * Creates the root element of the document.
+     * @param string $name
+     * @param array<string,mixed> $attributes
+     * @return DOMNode
+     */
     public function createRoot(string $name, array $attributes=array())
     {
         $root = $this->dom->appendChild($this->dom->createElement($name));
@@ -292,12 +292,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
     {
         $string = preg_replace('#<p>(.*)</p>#isUm', '$1', $string);
@@ -317,18 +317,18 @@ 
         return $string;
     }
 
-   /**
-    * 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(!headers_sent() && !self::$simulation) 
@@ -339,12 +339,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(!headers_sent() && !self::$simulation) 
@@ -411,23 +411,23 @@ 
         return $xml->saveXML();
     }
 
-   /**
-    * Creates XML markup to describe an application error
-    * when using XML services. Creates XML with the
-    * following structure:
-    *
-    * <error>
-    *     <id>99</id>
-    *     <message>Full error message text</message>
-    *     <title>Short error label</title>
-    * </error>
-    *
-    * @param string|number $code
-    * @param string $message
-    * @param string $title
-    * @param array<string,string> $customInfo
-    * @return string
-    */
+    /**
+     * Creates XML markup to describe an application error
+     * when using XML services. Creates XML with the
+     * following structure:
+     *
+     * <error>
+     *     <id>99</id>
+     *     <message>Full error message text</message>
+     *     <title>Short error label</title>
+     * </error>
+     *
+     * @param string|number $code
+     * @param string $message
+     * @param string $title
+     * @param array<string,string> $customInfo
+     * @return string
+     */
     public static function buildErrorXML($code, string $message, string $title, array $customInfo=array())
     {
         $xml = new DOMDocument('1.0', 'UTF-8');
@@ -460,31 +460,31 @@ 
         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
-    * @throws XMLHelper_Exception
-    * @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
+     * @throws XMLHelper_Exception
+     * @return string
+     */
     public static function string2xml(string $string) : string
     {
         return XMLHelper_HTMLLoader::loadFragment($string)->fragmentToXML();

src/Highlighter.php

Indentation +70 added lines, -70 removed lines

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

src/ConvertHelper/TimeConverter.php

Indentation +17 added lines, -17 removed lines

@@ -23,19 +23,19 @@ 
  */
 class ConvertHelper_TimeConverter
 {
-   /**
-    * @var float
-    */
+    /**
+     * @var float
+     */
     private $seconds;
 
-   /**
-    * @var array<int,array<string,string|int>>
-    */
+    /**
+     * @var array<int,array<string,string|int>>
+     */
     private static $units;
     
-   /**
-    * @param float $seconds
-    */
+    /**
+     * @param float $seconds
+     */
     public function __construct($seconds)
     {
         $this->seconds = $seconds;   
@@ -43,9 +43,9 @@ 
         $this->initUnits();
     }
     
-   /**
-    * Creates the list of units once per request as needed.
-    */
+    /**
+     * Creates the list of units once per request as needed.
+     */
     private function initUnits() : void
     {
         if(isset(self::$units))
@@ -112,11 +112,11 @@ 
         return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
     }
     
-   /**
-    * Resolves the list of converted units.
-    * 
-    * @return string[]
-    */
+    /**
+     * Resolves the list of converted units.
+     * 
+     * @return string[]
+     */
     private function resolveTokens() : array
     {
         $seconds = $this->seconds;

src/ConvertHelper/EOL.php

Indentation +26 added lines, -26 removed lines

@@ -29,19 +29,19 @@ 
     const TYPE_LF = 'LF';
     const TYPE_CR = 'CR';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $char;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $description;
 
     /**
@@ -56,33 +56,33 @@ 
         $this->description = $description;
     }
     
-   /**
-    * The actual EOL character.
-    * @return string
-    */
+    /**
+     * The actual EOL character.
+     * @return string
+     */
     public function getCharacter() : string
     {
         return $this->char;
     }
     
-   /**
-    * A more detailed, human readable description of the character.
-    * @return string
-    */
+    /**
+     * A more detailed, human readable description of the character.
+     * @return string
+     */
     public function getDescription() : string
     {
         return $this->description;
     }
     
-   /**
-    * The EOL character type, e.g. "CR+LF", "CR"...
-    * @return string
-    * 
-    * @see ConvertHelper_EOL::TYPE_CR
-    * @see ConvertHelper_EOL::TYPE_CRLF
-    * @see ConvertHelper_EOL::TYPE_LF
-    * @see ConvertHelper_EOL::TYPE_LFCR
-    */
+    /**
+     * The EOL character type, e.g. "CR+LF", "CR"...
+     * @return string
+     * 
+     * @see ConvertHelper_EOL::TYPE_CR
+     * @see ConvertHelper_EOL::TYPE_CRLF
+     * @see ConvertHelper_EOL::TYPE_LF
+     * @see ConvertHelper_EOL::TYPE_LFCR
+     */
     public function getType() : string
     {
         return $this->type;

src/URLInfo/ConnectionTester.php

Indentation +19 added lines, -19 removed lines

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

src/StringBuilder.php

Indentation +147 added lines, -147 removed lines

@@ -33,24 +33,24 @@ 
  */
 class StringBuilder implements StringBuilder_Interface
 {
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $separator = ' ';
 
-   /**
-    * @var string[]
-    */
+    /**
+     * @var string[]
+     */
     protected $strings = array();
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mode = 'html';
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $noSpace = '§!§';
     
     public function __construct()
@@ -58,12 +58,12 @@ 
         
     }
     
-   /**
-    * Adds a subject as a string. Is ignored if empty.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a subject as a string. Is ignored if empty.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function add($string) : StringBuilder
     {
         $string = strval($string);
@@ -76,57 +76,57 @@ 
         return $this;
     }
     
-   /**
-    * Adds a string without appending an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a string without appending an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function nospace($string) : StringBuilder
     {
         return $this->add($this->noSpace.strval($string));
     }
     
-   /**
-    * Adds raw HTML code. Does not add an automatic space.
-    * 
-    * @param string|number|StringBuilder_Interface $html
-    * @return $this
-    */
+    /**
+     * Adds raw HTML code. Does not add an automatic space.
+     * 
+     * @param string|number|StringBuilder_Interface $html
+     * @return $this
+     */
     public function html($html) : StringBuilder
     {
         return $this->nospace($html);
     }
     
-   /**
-    * Adds an unordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an unordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ul(array $items) : StringBuilder
     {
         return $this->list('ul', $items);
     }
     
-   /**
-    * Adds an ordered list with the specified items.
-    * 
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Adds an ordered list with the specified items.
+     * 
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     public function ol(array $items) : StringBuilder
     {
         return $this->list('ol', $items);
     }
     
-   /**
-    * Creates a list tag with the items list.
-    * 
-    * @param string $type The list type, `ol` or `ul`.
-    * @param array<int,string|number|StringBuilder_Interface> $items
-    * @return $this
-    */
+    /**
+     * Creates a list tag with the items list.
+     * 
+     * @param string $type The list type, `ol` or `ul`.
+     * @param array<int,string|number|StringBuilder_Interface> $items
+     * @return $this
+     */
     protected function list(string $type, array $items) : StringBuilder
     {
         return $this->html(sprintf(
@@ -136,13 +136,13 @@ 
         ));
     }
     
-   /**
-    * Add a translated string.
-    * 
-    * @param string $format The native string to translate.
-    * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
-    * @return $this
-    */
+    /**
+     * Add a translated string.
+     * 
+     * @param string $format The native string to translate.
+     * @param array<int,mixed> $arguments The variables to inject into the translated string, if any.
+     * @return $this
+     */
     public function t(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -158,47 +158,47 @@ 
         ));
     }
     
-   /**
-    * Adds a "5 months ago" age since the specified date.
-    * 
-    * @param DateTime $since
-    * @return $this
-    */
+    /**
+     * Adds a "5 months ago" age since the specified date.
+     * 
+     * @param DateTime $since
+     * @return $this
+     */
     public function age(DateTime $since) : StringBuilder
     {
         return $this->add(ConvertHelper::duration2string($since));
     }
     
-   /**
-    * Adds HTML quotes around the string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds HTML quotes around the string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function quote($string)
     {
         return $this->sf('&quot;%s&quot;', strval($string));
     }
     
-   /**
-    * Adds a text that is meant as a reference to an UI element,
-    * like a menu item, button, etc.
-    * 
-    * @param string|number|StringBuilder_Interface $string 
-    * @return $this
-    */
+    /**
+     * Adds a text that is meant as a reference to an UI element,
+     * like a menu item, button, etc.
+     * 
+     * @param string|number|StringBuilder_Interface $string 
+     * @return $this
+     */
     public function reference($string) : StringBuilder
     {
         return $this->sf('"%s"', $string);
     }
 
-   /**
-    * Add a string using the `sprintf` method.
-    * 
-    * @param string $format The format string
-    * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
-    * @return $this
-    */
+    /**
+     * Add a string using the `sprintf` method.
+     * 
+     * @param string $format The format string
+     * @param string|number|StringBuilder_Interface ...$arguments The variables to inject
+     * @return $this
+     */
     public function sf(string $format, ...$arguments) : StringBuilder
     {
         array_unshift($arguments, $format);
@@ -206,12 +206,12 @@ 
         return $this->add(call_user_func_array('sprintf', $arguments));
     }
     
-   /**
-    * Adds a bold string.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Adds a bold string.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function bold($string) : StringBuilder
     {
         return $this->sf(
@@ -220,12 +220,12 @@ 
         );
     }
     
-   /**
-    * Adds a HTML `br` tag.
-    * 
-    * @return $this
-    * @see StringBuilder::eol()
-    */
+    /**
+     * Adds a HTML `br` tag.
+     * 
+     * @return $this
+     * @see StringBuilder::eol()
+     */
     public function nl() : StringBuilder
     {
         return $this->html('<br>');
@@ -242,52 +242,52 @@ 
         return $this->nospace(PHP_EOL);
     }
     
-   /**
-    * Adds the current time, in the format <code>H:i:s</code>.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the current time, in the format <code>H:i:s</code>.
+     * 
+     * @return $this
+     */
     public function time() : StringBuilder
     {
         return $this->add(date('H:i:s'));
     }
     
-   /**
-    * Adds the "Note:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Note:" text.
+     * 
+     * @return $this
+     */
     public function note() : StringBuilder
     {
         return $this->t('Note:');
     }
     
-   /**
-    * Like `note()`, but as bold text.
-    * 
-    * @return $this
-    */
+    /**
+     * Like `note()`, but as bold text.
+     * 
+     * @return $this
+     */
     public function noteBold() : StringBuilder
     {
         return $this->bold(sb()->note());
     }
     
-   /**
-    * Adds the "Hint:" text.
-    * 
-    * @return $this
-    */
+    /**
+     * Adds the "Hint:" text.
+     * 
+     * @return $this
+     */
     public function hint() : StringBuilder
     {
         return $this->t('Hint:');
     }
     
-   /**
-    * Adds two linebreaks.
-    *
-    * @param StringBuilder_Interface|string|NULL $content
-    * @return $this
-    */
+    /**
+     * Adds two linebreaks.
+     *
+     * @param StringBuilder_Interface|string|NULL $content
+     * @return $this
+     */
     public function para($content=null) : StringBuilder
     {
         if($content !== null) {
@@ -297,14 +297,14 @@ 
         return $this->nl()->nl();
     }
     
-   /**
-    * Adds an anchor HTML tag.
-    * 
-    * @param string $label
-    * @param string $url
-    * @param bool $newTab
-    * @return $this
-    */
+    /**
+     * Adds an anchor HTML tag.
+     * 
+     * @param string $label
+     * @param string $url
+     * @param bool $newTab
+     * @return $this
+     */
     public function link(string $label, string $url, bool $newTab=false) : StringBuilder
     {
         $target = '';
@@ -320,12 +320,12 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `code` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `code` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function code($string) : StringBuilder
     {
         return $this->sf(
@@ -334,24 +334,24 @@ 
         );
     }
     
-   /**
-    * Wraps the string in a `pre` tag.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @return $this
-    */
+    /**
+     * Wraps the string in a `pre` tag.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @return $this
+     */
     public function pre($string) : StringBuilder
     {
         return $this->sf('<pre>%s</pre>', strval($string));
     }
     
-   /**
-    * Wraps the text in a `span` tag with the specified classes.
-    * 
-    * @param string|number|StringBuilder_Interface $string
-    * @param string|string[] $classes
-    * @return $this
-    */
+    /**
+     * Wraps the text in a `span` tag with the specified classes.
+     * 
+     * @param string|number|StringBuilder_Interface $string
+     * @param string|string[] $classes
+     * @return $this
+     */
     protected function spanned($string, $classes) : StringBuilder
     {
         if(!is_array($classes)) 

src/FileHelper/FileFinder.php

Indentation +137 added lines, -137 removed lines

@@ -33,24 +33,24 @@ 
     
     const PATH_MODE_STRIP = 'strip';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $path;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $found;
     
-   /**
-    * The path must exist when the class is instantiated: its
-    * real path will be determined to work with.
-    * 
-    * @param string $path The absolute path to the target folder.
-    * @throws FileHelper_Exception
-    * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
-    */
+    /**
+     * The path must exist when the class is instantiated: its
+     * real path will be determined to work with.
+     * 
+     * @param string $path The absolute path to the target folder.
+     * @throws FileHelper_Exception
+     * @see FileHelper_FileFinder::ERROR_PATH_DOES_NOT_EXIST
+     */
     public function __construct(string $path)
     {
         $real = realpath($path);
@@ -82,66 +82,66 @@ 
         );
     }
     
-   /**
-    * Enables extension stripping, to return file names without extension.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Enables extension stripping, to return file names without extension.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function stripExtensions() : FileHelper_FileFinder
     {
         return $this->setOption('strip-extensions', true);
     }
     
-   /**
-    * Enables recursing into subfolders.
-    * 
-    * @return FileHelper_FileFinder
-    */
+    /**
+     * Enables recursing into subfolders.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function makeRecursive() : FileHelper_FileFinder
     {
         return $this->setOption('recursive', true);
     }
     
-   /**
-    * Retrieves all extensions that were added to
-    * the include list.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves all extensions that were added to
+     * the include list.
+     * 
+     * @return string[]
+     */
     public function getIncludeExtensions() : array
     {
         return $this->getArrayOption('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 FileHelper_FileFinder
-    * @see FileHelper_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 FileHelper_FileFinder
+     * @see FileHelper_FileFinder::includeExtensions()
+     */
     public function includeExtension(string $extension) : FileHelper_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 array $extensions Extension names, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_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 array $extensions Extension names, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::includeExtension()
+     */
     public function includeExtensions(array $extensions) : FileHelper_FileFinder
     {
         $items = $this->getIncludeExtensions();
@@ -152,37 +152,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('exclude-extensions');
     }
     
-   /**
-    * Excludes a single extension from the search.
-    * 
-    * @param string $extension Extension name, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::excludeExtensions()
-    */
+    /**
+     * Excludes a single extension from the search.
+     * 
+     * @param string $extension Extension name, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::excludeExtensions()
+     */
     public function excludeExtension(string $extension) : FileHelper_FileFinder
     {
         return $this->excludeExtensions(array($extension));
     }
 
-   /**
-    * Add several extensions to the list of extensions to
-    * exclude from the file search.
-    *  
-    * @param array $extensions Extension names, without dot (`php` for example).
-    * @return FileHelper_FileFinder
-    * @see FileHelper_FileFinder::excludeExtension()
-    */
+    /**
+     * Add several extensions to the list of extensions to
+     * exclude from the file search.
+     *  
+     * @param array $extensions Extension names, without dot (`php` for example).
+     * @return FileHelper_FileFinder
+     * @see FileHelper_FileFinder::excludeExtension()
+     */
     public function excludeExtensions(array $extensions) : FileHelper_FileFinder
     {
         $items = $this->getExcludeExtensions();
@@ -193,52 +193,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 FileHelper_FileFinder
-    */
+    /**
+     * In this mode, the entire path to the file will be stripped,
+     * leaving only the file name in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeStrip() : FileHelper_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 FileHelper_FileFinder
-    */
+    /**
+     * In this mode, only the path relative to the source folder
+     * will be included in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeRelative() : FileHelper_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 FileHelper_FileFinder
-    */
+    /**
+     * In this mode, the full, absolute paths to the files will
+     * be included in the files list.
+     * 
+     * @return FileHelper_FileFinder
+     */
     public function setPathmodeAbsolute() : FileHelper_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 FileHelper_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 FileHelper_FileFinder
+     */
     public function setSlashReplacement(string $character) : FileHelper_FileFinder
     {
         return $this->setOption('slash-replacement', $character);
@@ -249,12 +249,12 @@ 
         return $this->setOption('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($this->path, true);
@@ -262,24 +262,24 @@ 
         return $this->found;
     }
     
-   /**
-    * Retrieves only PHP files. Can be combined with other
-    * options like enabling recursion into subfolders.
-    * 
-    * @return string[]
-    */
+    /**
+     * Retrieves only PHP files. Can be combined with other
+     * options like enabling recursion into subfolders.
+     * 
+     * @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'));
@@ -350,13 +350,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('include-extensions');
@@ -378,12 +378,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('pathmode'))

src/FileHelper.php

Indentation +341 added lines, -341 removed lines

@@ -60,31 +60,31 @@ 
     protected static $utfBoms;
 
     /**
-    * Opens a serialized file and returns the unserialized data.
-    * 
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @deprecated Use parseSerializedFile() instead.
-    * @see FileHelper::parseSerializedFile()
-    */
+     * Opens a serialized file and returns the unserialized data.
+     * 
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @deprecated Use parseSerializedFile() instead.
+     * @see FileHelper::parseSerializedFile()
+     */
     public static function openUnserialized(string $file) : array
     {
         return self::parseSerializedFile($file);
     }
 
-   /**
-    * Opens a serialized file and returns the unserialized data.
-    *
-    * @param string $file
-    * @throws FileHelper_Exception
-    * @return array
-    * @see FileHelper::parseSerializedFile()
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
-    * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
-    */
+    /**
+     * Opens a serialized file and returns the unserialized data.
+     *
+     * @param string $file
+     * @throws FileHelper_Exception
+     * @return array
+     * @see FileHelper::parseSerializedFile()
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_SERIALIZED_FILE_CANNOT_BE_READ
+     * @see FileHelper::ERROR_SERIALIZED_FILE_UNSERIALZE_FAILED
+     */
     public static function parseSerializedFile(string $file) : array
     {
         self::requireFileExists($file);
@@ -160,13 +160,13 @@ 
         return rmdir($rootFolder);
     }
     
-   /**
-    * Create a folder, if it does not exist yet.
-    *  
-    * @param string $path
-    * @throws FileHelper_Exception
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    */
+    /**
+     * Create a folder, if it does not exist yet.
+     *  
+     * @param string $path
+     * @throws FileHelper_Exception
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     */
     public static function createFolder(string $path) : void
     {
         if(is_dir($path) || mkdir($path, 0777, true)) {
@@ -213,22 +213,22 @@ 
         }
     }
     
-   /**
-    * Copies a file to the target location. Includes checks
-    * for most error sources, like the source file not being
-    * readable. Automatically creates the target folder if it
-    * does not exist yet.
-    * 
-    * @param string $sourcePath
-    * @param string $targetPath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
-    * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
-    * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_CANNOT_COPY_FILE
-    */
+    /**
+     * Copies a file to the target location. Includes checks
+     * for most error sources, like the source file not being
+     * readable. Automatically creates the target folder if it
+     * does not exist yet.
+     * 
+     * @param string $sourcePath
+     * @param string $targetPath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_CREATE_FOLDER
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_FOUND
+     * @see FileHelper::ERROR_SOURCE_FILE_NOT_READABLE
+     * @see FileHelper::ERROR_TARGET_COPY_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_CANNOT_COPY_FILE
+     */
     public static function copyFile(string $sourcePath, string $targetPath) : void
     {
         self::requireFileExists($sourcePath, self::ERROR_SOURCE_FILE_NOT_FOUND);
@@ -268,15 +268,15 @@ 
         );
     }
     
-   /**
-    * Deletes the target file. Ignored if it cannot be found,
-    * and throws an exception if it fails.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_CANNOT_DELETE_FILE
-    */
+    /**
+     * Deletes the target file. Ignored if it cannot be found,
+     * and throws an exception if it fails.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_CANNOT_DELETE_FILE
+     */
     public static function deleteFile(string $filePath) : void
     {
         if(!file_exists($filePath)) {
@@ -298,15 +298,15 @@ 
     }
 
     /**
-    * Creates a new CSV parser instance and returns it.
-    * 
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return Csv
+     * Creates a new CSV parser instance and returns it.
+     * 
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return Csv
      * @see CSVHelper::createParser()
-    */
+     */
     public static function createCSVParser(string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : Csv
     {
         if($delimiter==='') { $delimiter = ';'; }
@@ -319,21 +319,21 @@ 
         return $parser;
     }
 
-   /**
-    * Parses all lines in the specified string and returns an
-    * indexed array with all csv values in each line.
-    *
-    * @param string $csv
-    * @param string $delimiter
-    * @param string $enclosure
-    * @param string $escape
-    * @param bool $heading
-    * @return array
-    * @throws FileHelper_Exception
-    * 
-    * @see parseCSVFile()
-    * @see FileHelper::ERROR_PARSING_CSV
-    */
+    /**
+     * Parses all lines in the specified string and returns an
+     * indexed array with all csv values in each line.
+     *
+     * @param string $csv
+     * @param string $delimiter
+     * @param string $enclosure
+     * @param string $escape
+     * @param bool $heading
+     * @return array
+     * @throws FileHelper_Exception
+     * 
+     * @see parseCSVFile()
+     * @see FileHelper::ERROR_PARSING_CSV
+     */
     public static function parseCSVString(string $csv, string $delimiter = ';', string $enclosure = '"', string $escape = '\\', bool $heading=false) : array
     {
         $parser = self::createCSVParser($delimiter, $enclosure, '\\', $heading);
@@ -521,27 +521,27 @@ 
         );
     }
     
-   /**
-    * Verifies whether the target file is a PHP file. The path
-    * to the file can be a path to a file as a string, or a 
-    * DirectoryIterator object instance.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @return boolean
-    */
+    /**
+     * Verifies whether the target file is a PHP file. The path
+     * to the file can be a path to a file as a string, or a 
+     * DirectoryIterator object instance.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @return boolean
+     */
     public static function isPHPFile($pathOrDirIterator) : bool
     {
-    	return self::getExtension($pathOrDirIterator) === 'php';
+        return self::getExtension($pathOrDirIterator) === 'php';
     }
     
-   /**
-    * Retrieves the extension of the specified file. Can be a path
-    * to a file as a string, or a DirectoryIterator object instance.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @param bool $lowercase
-    * @return string
-    */
+    /**
+     * Retrieves the extension of the specified file. Can be a path
+     * to a file as a string, or a DirectoryIterator object instance.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @param bool $lowercase
+     * @return string
+     */
     public static function getExtension($pathOrDirIterator, bool $lowercase = true) : string
     {
         if($pathOrDirIterator instanceof DirectoryIterator) {
@@ -552,38 +552,38 @@ 
          
         $ext = pathinfo($filename, PATHINFO_EXTENSION);
         if($lowercase) {
-        	$ext = mb_strtolower($ext);
+            $ext = mb_strtolower($ext);
         }
         
         return $ext;
     }
     
-   /**
-    * Retrieves the file name from a path, with or without extension.
-    * The path to the file can be a string, or a DirectoryIterator object
-    * instance.
-    * 
-    * In case of folders, behaves like the pathinfo function: returns
-    * the name of the folder.
-    * 
-    * @param string|DirectoryIterator $pathOrDirIterator
-    * @param bool $extension
-    * @return string
-    */
+    /**
+     * Retrieves the file name from a path, with or without extension.
+     * The path to the file can be a string, or a DirectoryIterator object
+     * instance.
+     * 
+     * In case of folders, behaves like the pathinfo function: returns
+     * the name of the folder.
+     * 
+     * @param string|DirectoryIterator $pathOrDirIterator
+     * @param bool $extension
+     * @return string
+     */
     public static function getFilename($pathOrDirIterator, $extension = true) : string
     {
         $path = strval($pathOrDirIterator);
-    	if($pathOrDirIterator instanceof DirectoryIterator) {
-    		$path = $pathOrDirIterator->getFilename();
-    	}
+        if($pathOrDirIterator instanceof DirectoryIterator) {
+            $path = $pathOrDirIterator->getFilename();
+        }
     	
-    	$path = self::normalizePath($path);
+        $path = self::normalizePath($path);
     	
-    	if(!$extension) {
-    	    return pathinfo($path, PATHINFO_FILENAME);
-    	}
+        if(!$extension) {
+            return pathinfo($path, PATHINFO_FILENAME);
+        }
     	
-    	return pathinfo($path, PATHINFO_BASENAME); 
+        return pathinfo($path, PATHINFO_BASENAME); 
     }
 
     /**
@@ -624,16 +624,16 @@ 
         return $json;
     }
     
-   /**
-    * Corrects common formatting mistakes when users enter
-    * file names, like too many spaces, dots and the like.
-    * 
-    * NOTE: if the file name contains a path, the path is
-    * stripped, leaving only the file name.
-    * 
-    * @param string $name
-    * @return string
-    */
+    /**
+     * Corrects common formatting mistakes when users enter
+     * file names, like too many spaces, dots and the like.
+     * 
+     * NOTE: if the file name contains a path, the path is
+     * stripped, leaving only the file name.
+     * 
+     * @param string $name
+     * @return string
+     */
     public static function fixFileName(string $name) : string
     {
         $name = trim($name);
@@ -715,20 +715,20 @@ 
         return self::findFiles($targetFolder, array('php'), $options);
     }
     
-   /**
-    * Finds files according to the specified options.
-    * 
-    * NOTE: This method only exists for backwards compatibility.
-    * Use the `createFileFinder()` method instead, which offers
-    * an object oriented interface that is much easier to use.
-    *  
-    * @param string $targetFolder
-    * @param string[] $extensions
-    * @param array<string,mixed> $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    * @see FileHelper::createFileFinder()
-    */
+    /**
+     * Finds files according to the specified options.
+     * 
+     * NOTE: This method only exists for backwards compatibility.
+     * Use the `createFileFinder()` method instead, which offers
+     * an object oriented interface that is much easier to use.
+     *  
+     * @param string $targetFolder
+     * @param string[] $extensions
+     * @param array<string,mixed> $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     * @see FileHelper::createFileFinder()
+     */
     public static function findFiles(string $targetFolder, array $extensions=array(), array $options=array()) : array
     {
         $finder = self::createFileFinder($targetFolder);
@@ -758,14 +758,14 @@ 
         return $finder->getAll();
     }
 
-   /**
-    * Removes the extension from the specified path or file name,
-    * if any, and returns the name without the extension.
-    * 
-    * @param string $filename
-    * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
-    * @return string
-    */
+    /**
+     * Removes the extension from the specified path or file name,
+     * if any, and returns the name without the extension.
+     * 
+     * @param string $filename
+     * @param bool $keepPath Whether to keep the path component, if any. Default PHP pathinfo behavior is not to.
+     * @return string
+     */
     public static function removeExtension(string $filename, bool $keepPath=false) : string
     {
         // normalize paths to allow windows style slashes even on nix servers
@@ -833,13 +833,13 @@ 
         return null;
     }
 
-   /**
-    * Retrieves a list of all UTF byte order mark character
-    * sequences, as an associative array with UTF encoding => bom sequence
-    * pairs.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves a list of all UTF byte order mark character
+     * sequences, as an associative array with UTF encoding => bom sequence
+     * pairs.
+     * 
+     * @return array<string,string>
+     */
     public static function getUTFBOMs() : array
     {
         if(!isset(self::$utfBoms)) {
@@ -855,15 +855,15 @@ 
         return self::$utfBoms;
     }
     
-   /**
-    * Checks whether the specified encoding is a valid
-    * unicode encoding, for example "UTF16-LE" or "UTF8".
-    * Also accounts for alternate way to write the, like
-    * "UTF-8", and omitting little/big endian suffixes.
-    * 
-    * @param string $encoding
-    * @return boolean
-    */
+    /**
+     * Checks whether the specified encoding is a valid
+     * unicode encoding, for example "UTF16-LE" or "UTF8".
+     * Also accounts for alternate way to write the, like
+     * "UTF-8", and omitting little/big endian suffixes.
+     * 
+     * @param string $encoding
+     * @return boolean
+     */
     public static function isValidUnicodeEncoding(string $encoding) : bool
     {
         $encodings = self::getKnownUnicodeEncodings();
@@ -882,40 +882,40 @@ 
         return in_array($encoding, $keep);
     }
     
-   /**
-    * Retrieves a list of all known unicode file encodings.
-    * @return string[]
-    */
+    /**
+     * Retrieves a list of all known unicode file encodings.
+     * @return string[]
+     */
     public static function getKnownUnicodeEncodings() : array
     {
         return array_keys(self::getUTFBOMs());
     }
     
-   /**
-    * Normalizes the slash style in a file or folder path,
-    * by replacing any antislashes with forward slashes.
-    * 
-    * @param string $path
-    * @return string
-    */
+    /**
+     * Normalizes the slash style in a file or folder path,
+     * by replacing any antislashes with forward slashes.
+     * 
+     * @param string $path
+     * @return string
+     */
     public static function normalizePath(string $path) : string
     {
         return str_replace(array('\\', '//'), array('/', '/'), $path);
     }
     
-   /**
-    * Saves the specified data to a file, JSON encoded.
-    * 
-    * @param mixed $data
-    * @param string $file
-    * @param bool $pretty
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_JSON_ENCODE_ERROR
-    * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
-    * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
-    */
+    /**
+     * Saves the specified data to a file, JSON encoded.
+     * 
+     * @param mixed $data
+     * @param string $file
+     * @param bool $pretty
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_JSON_ENCODE_ERROR
+     * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE
+     * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED
+     */
     public static function saveAsJSON($data, string $file, bool $pretty=false) : void
     {
         $options = null;
@@ -939,18 +939,18 @@ 
         self::saveFile($file, $json);
     }
    
-   /**
-    * Saves the specified content to the target file, creating
-    * the file and the folder as necessary.
-    * 
-    * @param string $filePath
-    * @param string $content
-    * @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 specified content to the target file, creating
+     * the file and the folder as necessary.
+     * 
+     * @param string $filePath
+     * @param string $content
+     * @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 static function saveFile(string $filePath, string $content='') : void
     {
         $filePath = self::normalizePath($filePath);
@@ -1134,14 +1134,14 @@ 
         return $output;
     }
     
-   /**
-    * Retrieves the last modified date for the specified file or folder.
-    * 
-    * Note: If the target does not exist, returns null. 
-    * 
-    * @param string $path
-    * @return DateTime|NULL
-    */
+    /**
+     * Retrieves the last modified date for the specified file or folder.
+     * 
+     * Note: If the target does not exist, returns null. 
+     * 
+     * @param string $path
+     * @return DateTime|NULL
+     */
     public static function getModifiedDate(string $path) : ?DateTime
     {
         $time = filemtime($path);
@@ -1154,25 +1154,25 @@ 
         return $date;
     }
     
-   /**
-    * Retrieves the names of all subfolders in the specified path.
-    * 
-    * Available options:
-    * 
-    * - recursive: true/false
-    *   Whether to search for subfolders recursively. 
-    *   
-    * - absolute-paths: true/false
-    *   Whether to return a list of absolute paths.
-    * 
-    * @param string|DirectoryIterator $targetFolder
-    * @param array $options
-    * @throws FileHelper_Exception
-    * @return string[]
-    *
-    * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
-    * @todo Move this to a separate class.
-    */
+    /**
+     * Retrieves the names of all subfolders in the specified path.
+     * 
+     * Available options:
+     * 
+     * - recursive: true/false
+     *   Whether to search for subfolders recursively. 
+     *   
+     * - absolute-paths: true/false
+     *   Whether to return a list of absolute paths.
+     * 
+     * @param string|DirectoryIterator $targetFolder
+     * @param array $options
+     * @throws FileHelper_Exception
+     * @return string[]
+     *
+     * @see FileHelper::ERROR_FIND_SUBFOLDERS_FOLDER_DOES_NOT_EXIST
+     * @todo Move this to a separate class.
+     */
     public static function getSubfolders($targetFolder, $options = array())
     {
         if($targetFolder instanceof DirectoryIterator) {
@@ -1237,16 +1237,16 @@ 
         return $result;
     }
 
-   /**
-    * Retrieves the maximum allowed upload file size, in bytes.
-    * Takes into account the PHP ini settings <code>post_max_size</code>
-    * and <code>upload_max_filesize</code>. Since these cannot
-    * be modified at runtime, they are the hard limits for uploads.
-    * 
-    * NOTE: Based on binary values, where 1KB = 1024 Bytes.
-    * 
-    * @return int Will return <code>-1</code> if no limit.
-    */
+    /**
+     * Retrieves the maximum allowed upload file size, in bytes.
+     * Takes into account the PHP ini settings <code>post_max_size</code>
+     * and <code>upload_max_filesize</code>. Since these cannot
+     * be modified at runtime, they are the hard limits for uploads.
+     * 
+     * NOTE: Based on binary values, where 1KB = 1024 Bytes.
+     * 
+     * @return int Will return <code>-1</code> if no limit.
+     */
     public static function getMaxUploadFilesize() : int
     {
         static $max_size = -1;
@@ -1284,16 +1284,16 @@ 
         return round($size);
     }
    
-   /**
-    * Makes a path relative using a folder depth: will reduce the
-    * length of the path so that only the amount of folders defined
-    * in the <code>$depth</code> attribute are shown below the actual
-    * folder or file in the path.
-    *  
-    * @param string  $path The absolute or relative path
-    * @param int $depth The folder depth to reduce the path to
-    * @return string
-    */
+    /**
+     * Makes a path relative using a folder depth: will reduce the
+     * length of the path so that only the amount of folders defined
+     * in the <code>$depth</code> attribute are shown below the actual
+     * folder or file in the path.
+     *  
+     * @param string  $path The absolute or relative path
+     * @param int $depth The folder depth to reduce the path to
+     * @return string
+     */
     public static function relativizePathByDepth(string $path, int $depth=2) : string
     {
         $path = self::normalizePath($path);
@@ -1331,23 +1331,23 @@ 
         return trim(implode('/', $tokens), '/');
     }
     
-   /**
-    * Makes the specified path relative to another path,
-    * by removing one from the other if found. Also 
-    * normalizes the path to use forward slashes. 
-    * 
-    * Example:
-    * 
-    * <pre>
-    * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
-    * </pre>
-    * 
-    * Result: <code>to/file.txt</code>
-    * 
-    * @param string $path
-    * @param string $relativeTo
-    * @return string
-    */
+    /**
+     * Makes the specified path relative to another path,
+     * by removing one from the other if found. Also 
+     * normalizes the path to use forward slashes. 
+     * 
+     * Example:
+     * 
+     * <pre>
+     * relativizePath('c:\some\folder\to\file.txt', 'c:\some\folder');
+     * </pre>
+     * 
+     * Result: <code>to/file.txt</code>
+     * 
+     * @param string $path
+     * @param string $relativeTo
+     * @return string
+     */
     public static function relativizePath(string $path, string $relativeTo) : string
     {
         $path = self::normalizePath($path);
@@ -1359,17 +1359,17 @@ 
         return $relative;
     }
     
-   /**
-    * Checks that the target file exists, and throws an exception
-    * if it does not. 
-    * 
-    * @param string $path
-    * @param int|NULL $errorCode Optional custom error code
-    * @throws FileHelper_Exception
-    * @return string The real path to the file
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Checks that the target file exists, and throws an exception
+     * if it does not. 
+     * 
+     * @param string $path
+     * @param int|NULL $errorCode Optional custom error code
+     * @throws FileHelper_Exception
+     * @return string The real path to the file
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function requireFileExists(string $path, ?int $errorCode=null) : string
     {
         $result = realpath($path);
@@ -1413,18 +1413,18 @@ 
         );
     }
     
-   /**
-    * Reads a specific line number from the target file and returns its
-    * contents, if the file has such a line. Does so with little memory
-    * usage, as the file is not read entirely into memory.
-    * 
-    * @param string $path
-    * @param int $lineNumber Note: 1-based; the first line is number 1.
-    * @return string|NULL Will return null if the requested line does not exist.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads a specific line number from the target file and returns its
+     * contents, if the file has such a line. Does so with little memory
+     * usage, as the file is not read entirely into memory.
+     * 
+     * @param string $path
+     * @param int $lineNumber Note: 1-based; the first line is number 1.
+     * @return string|NULL Will return null if the requested line does not exist.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function getLineFromFile(string $path, int $lineNumber) : ?string
     {
         self::requireFileExists($path);
@@ -1440,19 +1440,19 @@ 
         $file->seek($targetLine);
         
         if($file->key() !== $targetLine) {
-             return null;
+                return null;
         }
         
         return $file->current(); 
     }
     
-   /**
-    * Retrieves the total amount of lines in the file, without 
-    * reading the whole file into memory.
-    * 
-    * @param string $path
-    * @return int
-    */
+    /**
+     * Retrieves the total amount of lines in the file, without 
+     * reading the whole file into memory.
+     * 
+     * @param string $path
+     * @return int
+     */
     public static function countFileLines(string $path) : int
     {
         self::requireFileExists($path);
@@ -1482,26 +1482,26 @@ 
         return $number+1;
     }
     
-   /**
-    * Parses the target file to detect any PHP classes contained
-    * within, and retrieve information on them. Does not use the 
-    * PHP reflection API.
-    * 
-    * @param string $filePath
-    * @return FileHelper_PHPClassInfo
-    */
+    /**
+     * Parses the target file to detect any PHP classes contained
+     * within, and retrieve information on them. Does not use the 
+     * PHP reflection API.
+     * 
+     * @param string $filePath
+     * @return FileHelper_PHPClassInfo
+     */
     public static function findPHPClasses(string $filePath) : FileHelper_PHPClassInfo
     {
         return new FileHelper_PHPClassInfo($filePath);
     }
     
-   /**
-    * Detects the end of line style used in the target file, if any.
-    * Can be used with large files, because it only reads part of it.
-    * 
-    * @param string $filePath The path to the file.
-    * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
-    */
+    /**
+     * Detects the end of line style used in the target file, if any.
+     * Can be used with large files, because it only reads part of it.
+     * 
+     * @param string $filePath The path to the file.
+     * @return NULL|ConvertHelper_EOL The end of line character information, or NULL if none is found.
+     */
     public static function detectEOLCharacter(string $filePath) : ?ConvertHelper_EOL
     {
         // 20 lines is enough to get a good picture of the newline style in the file.
@@ -1514,18 +1514,18 @@ 
         return ConvertHelper::detectEOLCharacter($string);
     }
     
-   /**
-    * Reads the specified amount of lines from the target file.
-    * Unicode BOM compatible: any byte order marker is stripped
-    * from the resulting lines.
-    * 
-    * @param string $filePath
-    * @param int $amount Set to 0 to read all lines.
-    * @return array
-    * 
-    * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * Reads the specified amount of lines from the target file.
+     * Unicode BOM compatible: any byte order marker is stripped
+     * from the resulting lines.
+     * 
+     * @param string $filePath
+     * @param int $amount Set to 0 to read all lines.
+     * @return array
+     * 
+     * @see FileHelper::ERROR_CANNOT_OPEN_FILE_TO_READ_LINES
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     */
     public static function readLines(string $filePath, int $amount=0) : array
     {
         self::requireFileExists($filePath);
@@ -1578,16 +1578,16 @@ 
         return $result;
     }
     
-   /**
-    * Reads all content from a file.
-    * 
-    * @param string $filePath
-    * @throws FileHelper_Exception
-    * @return string
-    * 
-    * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
-    */
+    /**
+     * Reads all content from a file.
+     * 
+     * @param string $filePath
+     * @throws FileHelper_Exception
+     * @return string
+     * 
+     * @see FileHelper::ERROR_FILE_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_CANNOT_READ_FILE_CONTENTS
+     */
     public static function readContents(string $filePath) : string
     {
         self::requireFileExists($filePath);
@@ -1608,18 +1608,18 @@ 
         );
     }
 
-   /**
-    * Ensures that the target path exists on disk, and is a folder.
-    * 
-    * @param string $path
-    * @return string The real path, with normalized slashes.
-    * @throws FileHelper_Exception
-    * 
-    * @see FileHelper::normalizePath()
-    * 
-    * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
-    * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
-    */
+    /**
+     * Ensures that the target path exists on disk, and is a folder.
+     * 
+     * @param string $path
+     * @return string The real path, with normalized slashes.
+     * @throws FileHelper_Exception
+     * 
+     * @see FileHelper::normalizePath()
+     * 
+     * @see FileHelper::ERROR_FOLDER_DOES_NOT_EXIST
+     * @see FileHelper::ERROR_PATH_IS_NOT_A_FOLDER
+     */
     public static function requireFolderExists(string $path) : string
     {
         $actual = realpath($path);

src/VariableInfo.php

Indentation +31 added lines, -31 removed lines

@@ -37,19 +37,19 @@ 
 
     const ERROR_INVALID_SERIALIZED_DATA = 56301;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $string;
     
-   /**
-    * @var mixed
-    */
+    /**
+     * @var mixed
+     */
     protected $value;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
 
     /**
@@ -106,15 +106,15 @@ 
         return new VariableInfo(null, $serialized);
     }
     
-   /**
-    * Parses a previously serialized data set to restore the 
-    * variable information from it.
-    * 
-    * @param array $serialized
-    * @throws BaseException
-    * 
-    * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
-    */
+    /**
+     * Parses a previously serialized data set to restore the 
+     * variable information from it.
+     * 
+     * @param array $serialized
+     * @throws BaseException
+     * 
+     * @see VariableInfo::ERROR_INVALID_SERIALIZED_DATA
+     */
     protected function parseSerialized(array $serialized) : void
     {
         if(!isset($serialized['string']) || !isset($serialized['type']) || !isset($serialized['options']))
@@ -156,12 +156,12 @@ 
         return $this->value;
     }
     
-   /**
-    * The variable type - this is the same string that
-    * is returned by the PHP function `gettype`.
-    * 
-    * @return string
-    */
+    /**
+     * The variable type - this is the same string that
+     * is returned by the PHP function `gettype`.
+     * 
+     * @return string
+     */
     public function getType() : string
     {
         return $this->type;
@@ -175,13 +175,13 @@ 
         );
     }
     
-   /**
-    * Whether to prepend the variable type before the value, 
-    * like the var_dump function. Example: <code>string "Some text"</code>.
-    * 
-    * @param bool $enable
-    * @return VariableInfo
-    */
+    /**
+     * Whether to prepend the variable type before the value, 
+     * like the var_dump function. Example: <code>string "Some text"</code>.
+     * 
+     * @param bool $enable
+     * @return VariableInfo
+     */
     public function enableType(bool $enable=true) : VariableInfo
     {
         return $this->setOption('prepend-type', $enable);