Mistralys / application-utils

src/ConvertHelper/StringMatch.php

Indentation +8 added lines, -8 removed lines

@@ -33,19 +33,19 @@
         $this->match = $matchedString;
     }
     
-   /**
-    * The zero-based start position of the string in the haystack.
-    * @return int
-    */
+    /**
+     * The zero-based start position of the string in the haystack.
+     * @return int
+     */
     public function getPosition() : int
     {
         return $this->position;
     }
     
-   /**
-    * The exact string that was matched, respecting the case as found in needle.
-    * @return string
-    */
+    /**
+     * The exact string that was matched, respecting the case as found in needle.
+     * @return string
+     */
     public function getMatchedString() : string
     {
         return $this->match;

src/XMLHelper/SimpleXML/Error.php

Indentation +3 added lines, -3 removed lines

@@ -6,9 +6,9 @@
 {
     protected $xml;
     
-   /**
-    * @var  \LibXMLError
-    */
+    /**
+     * @var  \LibXMLError
+     */
     protected $nativeError;
     
     public function __construct(XMLHelper_SimpleXML $xml, \LibXMLError $nativeError)

src/XMLHelper/Converter.php

Indentation +41 added lines, -41 removed lines

@@ -41,14 +41,14 @@ 
 {
     const ERROR_FAILED_CONVERTING_TO_JSON = 37901;
     
-   /**
-    * @var \SimpleXMLElement
-    */
+    /**
+     * @var \SimpleXMLElement
+     */
     protected $xml;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $json;
     
     protected function __construct(\SimpleXMLElement $element)
@@ -56,24 +56,24 @@ 
         $this->xml = $element;
     }
     
-   /**
-    * Factory method: creates a converter from an XML file on disk.
-    * 
-    * @param string $path
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an XML file on disk.
+     * 
+     * @param string $path
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromFile(string $path)
     {
         $xmlString = file_get_contents($path);
         return self::fromString($xmlString);
     }
  
-   /**
-    * Factory method: creates a converter from an XML string.
-    * 
-    * @param string $xmlString
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an XML string.
+     * 
+     * @param string $xmlString
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromString(string $xmlString)
     {
         $element = new \SimpleXMLElement($xmlString);
@@ -81,36 +81,36 @@ 
         return self::fromElement($element);
     }
     
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    * 
-    * @param \SimpleXMLElement $element
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     * 
+     * @param \SimpleXMLElement $element
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromElement(\SimpleXMLElement $element)
     {
         $obj = new XMLHelper_Converter($element);
         return $obj;
     }
 
-   /**
-    * Factory method: creates a converter from an existing SimpleXMLElement instance.
-    *
-    * @param \DOMElement $element
-    * @return \AppUtils\XMLHelper_Converter
-    */
+    /**
+     * Factory method: creates a converter from an existing SimpleXMLElement instance.
+     *
+     * @param \DOMElement $element
+     * @return \AppUtils\XMLHelper_Converter
+     */
     public static function fromDOMElement(\DOMElement $element)
     {
         $obj = new XMLHelper_Converter(simplexml_import_dom($element));
         return $obj;
     }
     
-   /**
-    * Converts the XML to JSON.
-    * 
-    * @throws XMLHelper_Exception
-    * @return string
-    */
+    /**
+     * Converts the XML to JSON.
+     * 
+     * @throws XMLHelper_Exception
+     * @return string
+     */
     public function toJSON() : string
     {
         if(isset($this->json)) {
@@ -138,11 +138,11 @@ 
         );
     }
     
-   /**
-    * Converts the XML to an associative array.
-    * @return array
-    * @throws XMLHelper_Exception
-    */
+    /**
+     * Converts the XML to an associative array.
+     * @return array
+     * @throws XMLHelper_Exception
+     */
     public function toArray() : array 
     {
         $json = $this->toJSON();

src/XMLHelper/SimpleXML.php

Indentation +16 added lines, -16 removed lines

@@ -11,27 +11,27 @@
     
     protected $errors = array();
     
-   /**
-    * Creates a simplexml instance from an XML string.
-    *
-    * NOTE: returns false in case of a fatal error.
-    *
-    * @param string $string
-    * @return \SimpleXMLElement|bool
-    */
+    /**
+     * Creates a simplexml instance from an XML string.
+     *
+     * NOTE: returns false in case of a fatal error.
+     *
+     * @param string $string
+     * @return \SimpleXMLElement|bool
+     */
     public function loadString($string)
     {
         return $this->load('string', $string);
     }
     
-   /**
-    * Creates a simplexml instance from an XML file.
-    * 
-    * NOTE: returns false in case of a fatal error.
-    * 
-    * @param string $file
-    * @return \SimpleXMLElement|bool
-    */
+    /**
+     * Creates a simplexml instance from an XML file.
+     * 
+     * NOTE: returns false in case of a fatal error.
+     * 
+     * @param string $file
+     * @return \SimpleXMLElement|bool
+     */
     public function loadFile($file)
     {
         return $this->load('file', $file);

src/RegexHelper.php

Indentation +12 added lines, -12 removed lines

@@ -42,10 +42,10 @@ 
     
     const REGEX_MD5 = '/^[a-f0-9]{32}$/i';
 
-   /**
-    * @var string
-    * @see https://en.wikipedia.org/wiki/Email_address#Local-part
-    */
+    /**
+     * @var string
+     * @see https://en.wikipedia.org/wiki/Email_address#Local-part
+     */
     const REGEX_EMAIL = '/[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?/i';
     
     const REGEX_PHONE = '/\A[+0-9][0-9 +\-()]+\z/m';
@@ -97,13 +97,13 @@ 
      */
     const REGEX_IS_HTML = '%<{0,1}[a-z\/][\s\S]*>|<[a-z\/][\s\S]*>{0,1}%i';
     
-   /**
-    * Hexadecimal color codes. Allows the following formats:
-    * 
-    * FFFFFF
-    * FFF
-    * 
-    * @var string
-    */
+    /**
+     * Hexadecimal color codes. Allows the following formats:
+     * 
+     * FFFFFF
+     * FFF
+     * 
+     * @var string
+     */
     const REGEX_HEX_COLOR_CODE = '/\A(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})\z/iU';
 }

src/IniHelper/Line.php

Indentation +18 added lines, -18 removed lines

@@ -38,38 +38,38 @@
      */
     protected $text;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $trimmed;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $lineNumber;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varName = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $varValue = '';
     
     protected $valueUnquoted = '';
     
     protected $quoteStyle = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sectionName = '';
     
     public function __construct(string $text, int $lineNumber)

src/IniHelper/Section.php

Indentation +65 added lines, -65 removed lines

@@ -21,19 +21,19 @@ 
  */
 class IniHelper_Section
 {
-   /**
-    * @var IniHelper
-    */
+    /**
+     * @var IniHelper
+     */
     protected $ini;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $name;
     
-   /**
-    * @var IniHelper_Line[]
-    */
+    /**
+     * @var IniHelper_Line[]
+     */
     protected $lines = array();
     
     public function __construct(IniHelper $ini, string $name)
@@ -42,33 +42,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 IniHelper_Line $line
-    * @return IniHelper_Section
-    */
+    /**
+     * Adds a line instance to the section.
+     * 
+     * @param IniHelper_Line $line
+     * @return IniHelper_Section
+     */
     public function addLine(IniHelper_Line $line) : IniHelper_Section
     {
         $this->lines[] = $line;
@@ -76,12 +76,12 @@ 
         return $this;
     }
     
-   /**
-    * Converts the values contained in the section into 
-    * an associative array.
-    * 
-    * @return array
-    */
+    /**
+     * Converts the values contained in the section into 
+     * an associative array.
+     * 
+     * @return array
+     */
     public function toArray() : array
     {
         $result = array();
@@ -114,11 +114,11 @@ 
         return $result;
     }
     
-   /**
-    * Converts the section's lines into an INI string.
-    * 
-    * @return string
-    */
+    /**
+     * Converts the section's lines into an INI string.
+     * 
+     * @return string
+     */
     public function toString()
     {
         $lines = array();
@@ -140,12 +140,12 @@ 
         return implode($this->ini->getEOLChar(), $lines);
     }
 
-   /**
-    * Deletes a line from the section.
-    * 
-    * @param IniHelper_Line $toDelete
-    * @return IniHelper_Section
-    */
+    /**
+     * Deletes a line from the section.
+     * 
+     * @param IniHelper_Line $toDelete
+     * @return IniHelper_Section
+     */
     public function deleteLine(IniHelper_Line $toDelete) : IniHelper_Section
     {
         $keep = array();
@@ -162,13 +162,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the value of a variable, overwriting any existing value.
-    * 
-    * @param string $name
-    * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
-    * @return IniHelper_Section
-    */
+    /**
+     * Sets the value of a variable, overwriting any existing value.
+     * 
+     * @param string $name
+     * @param mixed $value If an array is specified, it is treated as duplicate keys and will add a line for each value.
+     * @return IniHelper_Section
+     */
     public function setValue(string $name, $value) : IniHelper_Section
     {
         $lines = $this->getLinesByVariable($name);
@@ -229,15 +229,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.
@@ -295,12 +295,12 @@ 
     }
     
     
-   /**
-    * Retrieves all lines for the specified variable name.
-    *  
-    * @param string $name
-    * @return \AppUtils\IniHelper_Line[]
-    */
+    /**
+     * Retrieves all lines for the specified variable name.
+     *  
+     * @param string $name
+     * @return \AppUtils\IniHelper_Line[]
+     */
     public function getLinesByVariable(string $name)
     {
         $result = array();

src/ZIPHelper.php

Indentation +50 added lines, -50 removed lines

@@ -38,9 +38,9 @@ 
     
     protected $file;
     
-   /**
-    * @var \ZipArchive
-    */
+    /**
+     * @var \ZipArchive
+     */
     protected $zip;
     
     public function __construct($targetFile)
@@ -48,33 +48,33 @@ 
         $this->file = $targetFile;
     }
     
-   /**
-    * Sets an option, among the available options:
-    * 
-    * <ul>
-    * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
-    * </ul>
-    * 
-    * @param string $name
-    * @param mixed $value
-    * @return ZIPHelper
-    */
+    /**
+     * Sets an option, among the available options:
+     * 
+     * <ul>
+     * <li>WriteThreshold: The amount of files to add before the zip is automatically written to disk and re-opened to release the file handles. Set to 0 to disable.</li>
+     * </ul>
+     * 
+     * @param string $name
+     * @param mixed $value
+     * @return ZIPHelper
+     */
     public function setOption($name, $value)
     {
         $this->options[$name] = $value;
         return $this;
     }
     
-   /**
-    * Adds a file to the zip. By default, the file is stored
-    * with the same name in the root of the zip. Use the optional
-    * parameter to change the location in the zip.
-    * 
-    * @param string $filePath
-    * @param string $zipPath
-    * @throws ZIPHelper_Exception
-    * @return bool
-    */
+    /**
+     * Adds a file to the zip. By default, the file is stored
+     * with the same name in the root of the zip. Use the optional
+     * parameter to change the location in the zip.
+     * 
+     * @param string $filePath
+     * @param string $zipPath
+     * @throws ZIPHelper_Exception
+     * @return bool
+     */
     public function addFile($filePath, $zipPath=null)
     {
         $this->open();
@@ -252,13 +252,13 @@ 
     
     protected $exit;
     
-   /**
-    * Like {@link ZIPHelper::download()}, but deletes the
-    * file after sending it to the browser.
-    * 
-    * @param string|NULL $fileName Override the ZIP's file name for the download
-    * @see ZIPHelper::download()
-    */
+    /**
+     * Like {@link ZIPHelper::download()}, but deletes the
+     * file after sending it to the browser.
+     * 
+     * @param string|NULL $fileName Override the ZIP's file name for the download
+     * @see ZIPHelper::download()
+     */
     public function downloadAndDelete($fileName=null)
     {
         $this->exit = false;
@@ -272,14 +272,14 @@ 
         exit;
     }
 
-   /**
-    * Extracts all files and folders from the zip to the 
-    * target folder. If no folder is specified, the files
-    * are extracted into the same folder as the zip itself.
-    * 
-    * @param string $outputFolder
-    * @return boolean
-    */
+    /**
+     * Extracts all files and folders from the zip to the 
+     * target folder. If no folder is specified, the files
+     * are extracted into the same folder as the zip itself.
+     * 
+     * @param string $outputFolder
+     * @return boolean
+     */
     public function extractAll($outputFolder=null)
     {
         if(empty($outputFolder)) {
@@ -292,9 +292,9 @@ 
     }
 
     
-   /**
-    * @return \ZipArchive
-    */
+    /**
+     * @return \ZipArchive
+     */
     public function getArchive()
     {
         $this->open();
@@ -302,14 +302,14 @@ 
         return $this->zip;
     }
     
-   /**
-    * JSON encodes the specified data and adds the json as
-    * a file in the ZIP archive.
-    * 
-    * @param mixed $data
-    * @param string $zipPath
-    * @return boolean
-    */
+    /**
+     * JSON encodes the specified data and adds the json as
+     * a file in the ZIP archive.
+     * 
+     * @param mixed $data
+     * @param string $zipPath
+     * @return boolean
+     */
     public function addJSON($data, $zipPath)
     {
         return $this->addString(

src/FileHelper/PHPClassInfo.php

Indentation +46 added lines, -46 removed lines

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