Mistralys / application-utils

src/RequestHelper/Boundaries.php

Indentation +52 added lines, -52 removed lines

@@ -22,19 +22,19 @@ 
 {
     public const ERROR_NO_BOUNDARIES_SPECIFIED = 44401;
     
-   /**
-    * @var RequestHelper
-    */
+    /**
+     * @var RequestHelper
+     */
     protected $helper;
 
-   /**
-    * @var RequestHelper_Boundaries_Boundary[]
-    */
+    /**
+     * @var RequestHelper_Boundaries_Boundary[]
+     */
     protected $boundaries = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
     
     public function __construct(RequestHelper $helper)
@@ -42,31 +42,31 @@ 
         $this->helper = $helper;
     }
     
-   /**
-    * Retrieves the string that is used to separate mime boundaries in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the string that is used to separate mime boundaries in the body.
+     * 
+     * @return string
+     */
     public function getMimeBoundary() : string
     {
         return $this->helper->getMimeBoundary();
     }
     
-   /**
-    * Retrieves the end of line character(s) used in the body.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the end of line character(s) used in the body.
+     * 
+     * @return string
+     */
     public function getEOL() : string
     {
         return $this->helper->getEOL();
     }
     
-   /**
-    * Retrieves the total content length of all boundary contents.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the total content length of all boundary contents.
+     * 
+     * @return int
+     */
     public function getContentLength() : int
     {
         // this must use strlen, and not mb_strlen: the content length
@@ -75,15 +75,15 @@ 
         return strlen($this->render());
     }
     
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper_Boundaries
     {
         if(empty($contentType))
@@ -107,13 +107,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds arbitrary content.
-    *
-    * @param string $varName
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     *
+     * @param string $varName
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper_Boundaries
     {
         $content = ConvertHelper::string2utf8($content);
@@ -127,13 +127,13 @@ 
         return $this->addBoundary($boundary);
     }
     
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper_Boundaries
     {
         $boundary = $this->createBoundary($value)
@@ -149,11 +149,11 @@ 
         return $this;
     }
     
-   /**
-    * Renders the response body with all mime boundaries.
-    * 
-    * @return string
-    */
+    /**
+     * Renders the response body with all mime boundaries.
+     * 
+     * @return string
+     */
     public function render() : string
     {
         if(empty($this->boundaries)) 

src/SVNHelper/Command/Status.php

Indentation +8 added lines, -8 removed lines

@@ -24,10 +24,10 @@ 
     
     public const STATUS_FILETYPE_CHANGE = 'filetype-change';
     
-   /**
-    * @var array
-    * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html
-    */
+    /**
+     * @var array
+     * @see http://svnbook.red-bean.com/en/1.7/svn.ref.svn.c.status.html
+     */
     protected static $knownStati = array(
         'a' => self::STATUS_ADD,
         'd' => self::STATUS_DELETE,
@@ -40,9 +40,9 @@ 
         '~' => self::STATUS_FILETYPE_CHANGE,
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $status;
     
     protected function _execute()
@@ -65,7 +65,7 @@ 
             
             $svnStatusCode = strtolower(substr($lines[0], 0, 1));
             if(isset(self::$knownStati[$svnStatusCode])) {
-               $this->status = self::$knownStati[$svnStatusCode];
+                $this->status = self::$knownStati[$svnStatusCode];
             }
         }
         

src/ZIPHelper.php

Indentation +48 added lines, -48 removed lines

@@ -38,14 +38,14 @@ 
         'WriteThreshold' => 100
     );
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $file;
     
-   /**
-    * @var ZipArchive|NULL
-    */
+    /**
+     * @var ZipArchive|NULL
+     */
     protected $zip;
     
     public function __construct(string $targetFile)
@@ -53,35 +53,35 @@ 
         $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(string $name, $value) : ZIPHelper
     {
         $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|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
-    * @throws ZIPHelper_Exception
-    * @return bool
-    * 
-    * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
-    */
+    /**
+     * 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|null $zipPath If no path is specified, file will be added with the same name in the ZIP's root.
+     * @throws ZIPHelper_Exception
+     * @return bool
+     * 
+     * @see FileHelper::ERROR_SOURCE_FILE_DOES_NOT_EXIST
+     */
     public function addFile(string $filePath, ?string $zipPath=null) : bool
     {
         $this->open();
@@ -289,14 +289,14 @@ 
         return $this;
     }
 
-   /**
-    * 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|NULL $outputFolder If no folder is specified, uses the target file's folder.
-    * @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|NULL $outputFolder If no folder is specified, uses the target file's folder.
+     * @return boolean
+     */
     public function extractAll(?string $outputFolder=null) : bool
     {
         if(empty($outputFolder)) {
@@ -308,9 +308,9 @@ 
         return $this->zip->extractTo($outputFolder);
     }
 
-   /**
-    * @return ZipArchive
-    */
+    /**
+     * @return ZipArchive
+     */
     public function getArchive() : ZipArchive
     {
         $this->open();
@@ -318,14 +318,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, string $zipPath) : bool
     {
         return $this->addString(

src/RequestHelper.php

Indentation +151 added lines, -151 removed lines

@@ -32,62 +32,62 @@ 
     public const ERROR_CURL_INIT_FAILED = 17903;
     public const ERROR_CANNOT_OPEN_LOGFILE = 17904;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $eol = "\r\n";
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $mimeBoundary;
 
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $destination;
 
-   /**
-    * @var array<string,string>
-    */
+    /**
+     * @var array<string,string>
+     */
     protected $headers = array();
     
-   /**
-    * Whether to verify SSL certificates.
-    * @var bool
-    */
+    /**
+     * Whether to verify SSL certificates.
+     * @var bool
+     */
     protected $verifySSL = true;
     
-   /**
-    * @var RequestHelper_Boundaries
-    */
+    /**
+     * @var RequestHelper_Boundaries
+     */
     protected $boundaries;
     
-   /**
-    * @var RequestHelper_Response|NULL
-    */
+    /**
+     * @var RequestHelper_Response|NULL
+     */
     protected $response;
 
-   /**
-    * Timeout duration, in seconds.
-    * @var integer
-    */
+    /**
+     * Timeout duration, in seconds.
+     * @var integer
+     */
     protected $timeout = 30;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $logfile = '';
 
-   /**
-    * @var resource|NULL
-    */
+    /**
+     * @var resource|NULL
+     */
     protected $logfilePointer = null;
     
-   /**
-    * Creates a new request helper to send POST data to the specified destination URL.
-    * @param string $destinationURL
-    */
+    /**
+     * Creates a new request helper to send POST data to the specified destination URL.
+     * @param string $destinationURL
+     */
     public function __construct(string $destinationURL)
     {
         $this->destination = $destinationURL;
@@ -110,13 +110,13 @@ 
         return $this->eol;
     }
     
-   /**
-    * Sets the timeout for the request, in seconds. If the request
-    * takes longer, it will be cancelled and an exception triggered.
-    * 
-    * @param int $seconds
-    * @return RequestHelper
-    */
+    /**
+     * Sets the timeout for the request, in seconds. If the request
+     * takes longer, it will be cancelled and an exception triggered.
+     * 
+     * @param int $seconds
+     * @return RequestHelper
+     */
     public function setTimeout(int $seconds) : RequestHelper
     {
         $this->timeout = $seconds;
@@ -129,13 +129,13 @@ 
         return $this->timeout;
     }
     
-   /**
-    * Enables verbose logging of the CURL request, which
-    * is then redirected to the target file.
-    * 
-    * @param string $targetFile
-    * @return RequestHelper
-    */
+    /**
+     * Enables verbose logging of the CURL request, which
+     * is then redirected to the target file.
+     * 
+     * @param string $targetFile
+     * @return RequestHelper
+     */
     public function enableLogging(string $targetFile) : RequestHelper
     {
         $this->logfile = $targetFile;
@@ -143,15 +143,15 @@ 
         return $this;
     }
 
-   /**
-    * Adds a file to be sent with the request.
-    *
-    * @param string $varName The variable name to send the file in
-    * @param string $fileName The name of the file as it should be received at the destination
-    * @param string $content The raw content of the file
-    * @param string $contentType The content type, use the constants to specify this
-    * @param string $encoding The encoding of the file, use the constants to specify this
-    */
+    /**
+     * Adds a file to be sent with the request.
+     *
+     * @param string $varName The variable name to send the file in
+     * @param string $fileName The name of the file as it should be received at the destination
+     * @param string $content The raw content of the file
+     * @param string $contentType The content type, use the constants to specify this
+     * @param string $encoding The encoding of the file, use the constants to specify this
+     */
     public function addFile(string $varName, string $fileName, string $content, string $contentType = '', string $encoding = '') : RequestHelper
     {
         $this->boundaries->addFile($varName, $fileName, $content, $contentType, $encoding);
@@ -159,13 +159,13 @@ 
         return $this;
     }
     
-   /**
-    * Adds arbitrary content.
-    * 
-    * @param string $varName The variable name to send the content in.
-    * @param string $content
-    * @param string $contentType
-    */
+    /**
+     * Adds arbitrary content.
+     * 
+     * @param string $varName The variable name to send the content in.
+     * @param string $content
+     * @param string $contentType
+     */
     public function addContent(string $varName, string $content, string $contentType) : RequestHelper
     {
         $this->boundaries->addContent($varName, $content, $contentType);
@@ -173,13 +173,13 @@ 
         return $this;
     }
 
-   /**
-    * Adds a variable to be sent with the request. If it
-    * already exists, its value is overwritten.
-    *
-    * @param string $name
-    * @param string $value
-    */
+    /**
+     * Adds a variable to be sent with the request. If it
+     * already exists, its value is overwritten.
+     *
+     * @param string $name
+     * @param string $value
+     */
     public function addVariable(string $name, string $value) : RequestHelper
     {
         $this->boundaries->addVariable($name, $value);
@@ -187,13 +187,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets an HTTP header to include in the request.
-    * 
-    * @param string $name
-    * @param string $value
-    * @return RequestHelper
-    */
+    /**
+     * Sets an HTTP header to include in the request.
+     * 
+     * @param string $name
+     * @param string $value
+     * @return RequestHelper
+     */
     public function setHeader(string $name, string $value) : RequestHelper
     {
         $this->headers[$name] = $value;
@@ -201,36 +201,36 @@ 
         return $this;
     }
     
-   /**
-    * Disables SSL certificate checking.
-    * 
-    * @return RequestHelper
-    */
+    /**
+     * Disables SSL certificate checking.
+     * 
+     * @return RequestHelper
+     */
     public function disableSSLChecks() : RequestHelper
     {
         $this->verifySSL = false;
         return $this;
     }
    
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $contentLength = 0;
 
-   /**
-    * Sends the POST request to the destination, and returns
-    * the response text.
-    *
-    * The response object is stored internally, so after calling
-    * this method it may be retrieved at any moment using the
-    * {@link getResponse()} method.
-    *
-    * @return string
-    * @see RequestHelper::getResponse()
-    * @throws RequestHelper_Exception
-    * 
-    * @see RequestHelper::ERROR_REQUEST_FAILED
-    */
+    /**
+     * Sends the POST request to the destination, and returns
+     * the response text.
+     *
+     * The response object is stored internally, so after calling
+     * this method it may be retrieved at any moment using the
+     * {@link getResponse()} method.
+     *
+     * @return string
+     * @see RequestHelper::getResponse()
+     * @throws RequestHelper_Exception
+     * 
+     * @see RequestHelper::ERROR_REQUEST_FAILED
+     */
     public function send() : string
     {
         $info = parseURL($this->destination);
@@ -270,26 +270,26 @@ 
         return $this->response->getResponseBody();
     }
     
-   /**
-    * Retrieves the request's body content. This is an alias
-    * for {@see RequestHelper::getMimeBody()}.
-    * 
-    * @return string
-    * @see RequestHelper::getMimeBody()
-    */
+    /**
+     * Retrieves the request's body content. This is an alias
+     * for {@see RequestHelper::getMimeBody()}.
+     * 
+     * @return string
+     * @see RequestHelper::getMimeBody()
+     */
     public function getBody() : string
     {
         return $this->getMimeBody();
     }
     
-   /**
-    * Creates a new CURL resource configured according to the
-    * request's settings.
-    * 
-    * @param URLInfo $url
-    * @throws RequestHelper_Exception
-    * @return resource
-    */
+    /**
+     * Creates a new CURL resource configured according to the
+     * request's settings.
+     * 
+     * @param URLInfo $url
+     * @throws RequestHelper_Exception
+     * @return resource
+     */
     protected function createCURL(URLInfo $url)
     {
         $ch = curl_init();
@@ -337,10 +337,10 @@ 
         return $ch;
     }
     
-   /**
-    * @param resource $ch
-    * @return bool Whether logging is enabled.
-    */
+    /**
+     * @param resource $ch
+     * @return bool Whether logging is enabled.
+     */
     protected function configureLogging($ch) : bool
     {
         if(empty($this->logfile))
@@ -367,13 +367,13 @@ 
         return true;
     }
 
-   /**
-    * Compiles the associative headers array into
-    * the format understood by CURL, namely an indexed
-    * array with one header string per entry.
-    * 
-    * @return array
-    */
+    /**
+     * Compiles the associative headers array into
+     * the format understood by CURL, namely an indexed
+     * array with one header string per entry.
+     * 
+     * @return array
+     */
     protected function renderHeaders() : array
     {
         $result = array();
@@ -387,12 +387,12 @@ 
         return $result;
     }
     
-   /**
-    * Retrieves the raw response header, in the form of an indexed
-    * array containing all response header lines.
-    * 
-    * @return array
-    */
+    /**
+     * Retrieves the raw response header, in the form of an indexed
+     * array containing all response header lines.
+     * 
+     * @return array
+     */
     public function getResponseHeader() : array
     {
         $response = $this->getResponse();
@@ -404,33 +404,33 @@ 
         return array();
     }
 
-   /**
-    * After calling the {@link send()} method, this may be used to
-    * retrieve the response text from the POST request.
-    *
-    * @return RequestHelper_Response|NULL
-    */
+    /**
+     * After calling the {@link send()} method, this may be used to
+     * retrieve the response text from the POST request.
+     *
+     * @return RequestHelper_Response|NULL
+     */
     public function getResponse() : ?RequestHelper_Response
     {
         return $this->response;
     }
     
-   /**
-    * Retrieves all headers set until now.
-    * 
-    * @return array<string,string>
-    */
+    /**
+     * Retrieves all headers set until now.
+     * 
+     * @return array<string,string>
+     */
     public function getHeaders() : array
     {
         return $this->headers;
     }
     
-   /**
-    * Retrieves the value of a header by its name.
-    * 
-    * @param string $name
-    * @return string The header value, or an empty string if not set.
-    */
+    /**
+     * Retrieves the value of a header by its name.
+     * 
+     * @param string $name
+     * @return string The header value, or an empty string if not set.
+     */
     public function getHeader(string $name) : string
     {
         if(isset($this->headers[$name]))

src/XMLHelper.php

Indentation +172 added lines, -172 removed lines

@@ -28,9 +28,9 @@ 
 {
     public 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/OperationResult.php

Indentation +73 added lines, -73 removed lines

@@ -34,46 +34,46 @@ 
     public const TYPE_ERROR = 'error';
     public const TYPE_SUCCESS = 'success';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message = '';
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
   
-   /**
-    * @var object
-    */
+    /**
+     * @var object
+     */
     protected $subject;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     private static $counter = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     private $id;
     
-   /**
-    * The subject being validated.
-    * 
-    * @param object $subject
-    */
+    /**
+     * The subject being validated.
+     * 
+     * @param object $subject
+     */
     public function __construct(object $subject)
     {
         $this->subject = $subject;
@@ -83,21 +83,21 @@ 
         $this->id = self::$counter;
     }
     
-   /**
-    * Retrieves the ID of the result, which is unique within a request.
-    * 
-    * @return int
-    */
+    /**
+     * Retrieves the ID of the result, which is unique within a request.
+     * 
+     * @return int
+     */
     public function getID() : int
     {
         return $this->id;
     }
     
-   /**
-    * Whether the validation was successful.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether the validation was successful.
+     * 
+     * @return bool
+     */
     public function isValid() : bool
     {
         return $this->valid;
@@ -128,33 +128,33 @@ 
         return $this->type === $type;
     }
     
-   /**
-    * Retrieves the subject that was validated.
-    * 
-    * @return object
-    */
+    /**
+     * Retrieves the subject that was validated.
+     * 
+     * @return object
+     */
     public function getSubject() : object
     {
         return $this->subject;
     }
     
-   /**
-    * Makes the result a success, with the specified message.
-    * 
-    * @param string $message Should not contain a date, just the system specific info.
-    * @return $this
-    */
+    /**
+     * Makes the result a success, with the specified message.
+     * 
+     * @param string $message Should not contain a date, just the system specific info.
+     * @return $this
+     */
     public function makeSuccess(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_SUCCESS, $message, $code, true);
     }
     
-   /**
-    * Sets the result as an error.
-    * 
-    * @param string $message Should be as detailed as possible.
-    * @return $this
-    */
+    /**
+     * Sets the result as an error.
+     * 
+     * @param string $message Should be as detailed as possible.
+     * @return $this
+     */
     public function makeError(string $message, int $code=0) : OperationResult
     {
         return $this->setMessage(self::TYPE_ERROR, $message, $code, false);
@@ -202,21 +202,21 @@ 
         return $this->type;
     }
     
-   /**
-    * Retrieves the error message, if an error occurred.
-    * 
-    * @return string The error message, or an empty string if no error occurred.
-    */
+    /**
+     * Retrieves the error message, if an error occurred.
+     * 
+     * @return string The error message, or an empty string if no error occurred.
+     */
     public function getErrorMessage() : string
     {
         return $this->getMessage(self::TYPE_ERROR);
     }
     
-   /**
-    * Retrieves the success message, if one has been provided.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the success message, if one has been provided.
+     * 
+     * @return string
+     */
     public function getSuccessMessage() : string
     {
         return $this->getMessage(self::TYPE_SUCCESS);
@@ -232,21 +232,21 @@ 
         return $this->getMessage(self::TYPE_WARNING);
     }
     
-   /**
-    * Whether a specific error/success code has been specified.
-    * 
-    * @return bool
-    */
+    /**
+     * Whether a specific error/success code has been specified.
+     * 
+     * @return bool
+     */
     public function hasCode() : bool
     {
         return $this->code > 0;
     }
     
-   /**
-    * Retrieves the error/success code, if any. 
-    * 
-    * @return int The error code, or 0 if none.
-    */
+    /**
+     * Retrieves the error/success code, if any. 
+     * 
+     * @return int The error code, or 0 if none.
+     */
     public function getCode() : int
     {
         return $this->code;

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>>|NULL
-    */
+    /**
+     * @var array<int,array<string,string|int>>|NULL
+     */
     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/DateInterval.php

Indentation +37 added lines, -37 removed lines

@@ -41,14 +41,14 @@ 
     public const TOKEN_MONTHS = 'm';
     public const TOKEN_YEARS = 'y';
     
-   /**
-    * @var DateInterval
-    */
+    /**
+     * @var DateInterval
+     */
     protected $interval;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $seconds;
 
     /**
@@ -92,22 +92,22 @@ 
         return new ConvertHelper_DateInterval($seconds);
     }
     
-   /**
-    * Creates the interval from an existing regular interval instance.
-    * 
-    * @param DateInterval $interval
-    * @return ConvertHelper_DateInterval
-    */
+    /**
+     * Creates the interval from an existing regular interval instance.
+     * 
+     * @param DateInterval $interval
+     * @return ConvertHelper_DateInterval
+     */
     public static function fromInterval(DateInterval $interval)
     {
         return self::fromSeconds(ConvertHelper::interval2seconds($interval));
     }
     
-   /**
-    * Retrieves the PHP native date interval.
-    * 
-    * @return DateInterval
-    */
+    /**
+     * Retrieves the PHP native date interval.
+     * 
+     * @return DateInterval
+     */
     public function getInterval() : DateInterval
     {
         return $this->interval;
@@ -143,31 +143,31 @@ 
         return $this->getToken(self::TOKEN_YEARS);
     }
     
-   /**
-    * Retrieves a specific time token, e.g. "h" (for hours).
-    * Using the constants to specifiy the tokens is recommended.
-    * 
-    * @param string $token
-    * @return int
-    * 
-    * @see ConvertHelper_DateInterval::TOKEN_SECONDS
-    * @see ConvertHelper_DateInterval::TOKEN_MINUTES
-    * @see ConvertHelper_DateInterval::TOKEN_HOURS
-    * @see ConvertHelper_DateInterval::TOKEN_DAYS
-    * @see ConvertHelper_DateInterval::TOKEN_MONTHS
-    * @see ConvertHelper_DateInterval::TOKEN_YEARS
-    */
+    /**
+     * Retrieves a specific time token, e.g. "h" (for hours).
+     * Using the constants to specifiy the tokens is recommended.
+     * 
+     * @param string $token
+     * @return int
+     * 
+     * @see ConvertHelper_DateInterval::TOKEN_SECONDS
+     * @see ConvertHelper_DateInterval::TOKEN_MINUTES
+     * @see ConvertHelper_DateInterval::TOKEN_HOURS
+     * @see ConvertHelper_DateInterval::TOKEN_DAYS
+     * @see ConvertHelper_DateInterval::TOKEN_MONTHS
+     * @see ConvertHelper_DateInterval::TOKEN_YEARS
+     */
     public function getToken(string $token) : int
     {
         return (int)$this->interval->$token;
     }
     
-   /**
-    * The total amount of seconds in the interval (including
-    * everything, from seconds to days, months, years...).
-    * 
-    * @return int
-    */
+    /**
+     * The total amount of seconds in the interval (including
+     * everything, from seconds to days, months, years...).
+     * 
+     * @return int
+     */
     public function getTotalSeconds() : int
     {
         return $this->seconds;

src/ConvertHelper/ThrowableInfo.php

Indentation +96 added lines, -96 removed lines

@@ -20,48 +20,48 @@ 
     public const CONTEXT_WEB = 'web';
 
     /**
-    * @var Throwable
-    */
+     * @var Throwable
+     */
     protected $exception;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo_Call[]
+     */
     protected $calls = array();
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $code = 0;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $message;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $callsCount = 0;
     
-   /**
-    * @var ConvertHelper_ThrowableInfo|NULL
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo|NULL
+     */
     protected $previous = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $referer = '';
     
-   /**
-    * @var Microtime
-    */
+    /**
+     * @var Microtime
+     */
     protected $date;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $context = self::CONTEXT_WEB;
 
     /**
@@ -127,16 +127,16 @@ 
         return isset($this->previous);
     }
     
-   /**
-    * Retrieves the information on the previous exception.
-    * 
-    * NOTE: Throws an exception if there is no previous 
-    * exception. Use hasPrevious() first to avoid this.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return ConvertHelper_ThrowableInfo
-    * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
-    */
+    /**
+     * Retrieves the information on the previous exception.
+     * 
+     * NOTE: Throws an exception if there is no previous 
+     * exception. Use hasPrevious() first to avoid this.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return ConvertHelper_ThrowableInfo
+     * @see ConvertHelper_ThrowableInfo::ERROR_NO_PREVIOUS_EXCEPTION
+     */
     public function getPrevious() : ConvertHelper_ThrowableInfo
     {
         if(isset($this->previous)) {
@@ -155,68 +155,68 @@ 
         return !empty($this->code);
     }
     
-   /**
-    * Improved text-only exception trace.
-    */
+    /**
+     * Improved text-only exception trace.
+     */
     public function toString() : string
     {
         return (new ConvertHelper_ThrowableInfo_StringConverter($this))
             ->toString();
     }
     
-   /**
-    * Retrieves the URL of the page in which the exception
-    * was thrown, if applicable: in CLI context, this will
-    * return an empty string.
-    * 
-    * @return string
-    */
+    /**
+     * Retrieves the URL of the page in which the exception
+     * was thrown, if applicable: in CLI context, this will
+     * return an empty string.
+     * 
+     * @return string
+     */
     public function getReferer() : string
     {
         return $this->referer;
     }
     
-   /**
-    * Whether the exception occurred in a command line context.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred in a command line context.
+     * @return bool
+     */
     public function isCommandLine() : bool
     {
         return $this->getContext() === self::CONTEXT_COMMAND_LINE;
     }
     
-   /**
-    * Whether the exception occurred during an http request.
-    * @return bool
-    */
+    /**
+     * Whether the exception occurred during an http request.
+     * @return bool
+     */
     public function isWebRequest() : bool
     {
         return $this->getContext() === self::CONTEXT_WEB;
     }
     
-   /**
-    * Retrieves the context identifier, i.e. if the exception
-    * occurred in a command line context or regular web request.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo::isCommandLine()
-    * @see ConvertHelper_ThrowableInfo::isWebRequest()
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
-    * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
-    */
+    /**
+     * Retrieves the context identifier, i.e. if the exception
+     * occurred in a command line context or regular web request.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo::isCommandLine()
+     * @see ConvertHelper_ThrowableInfo::isWebRequest()
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_COMMAND_LINE
+     * @see ConvertHelper_ThrowableInfo::CONTEXT_WEB
+     */
     public function getContext() : string
     {
         return $this->context;
     }
     
-   /**
-    * Retrieves the date of the exception, and approximate time:
-    * since exceptions do not store time, this is captured the 
-    * moment the ThrowableInfo is created.
-    * 
-    * @return Microtime
-    */
+    /**
+     * Retrieves the date of the exception, and approximate time:
+     * since exceptions do not store time, this is captured the 
+     * moment the ThrowableInfo is created.
+     * 
+     * @return Microtime
+     */
     public function getDate() : Microtime
     {
         return $this->date;
@@ -237,24 +237,24 @@ 
         return ConvertHelper_ThrowableInfo_Serializer::serialize($this);
     }
 
-   /**
-    * Sets the maximum folder depth to show in the 
-    * file paths, to avoid them being too long.
-    * 
-    * @param int $depth
-    * @return ConvertHelper_ThrowableInfo
-    */
+    /**
+     * Sets the maximum folder depth to show in the 
+     * file paths, to avoid them being too long.
+     * 
+     * @param int $depth
+     * @return ConvertHelper_ThrowableInfo
+     */
     public function setFolderDepth(int $depth) : ConvertHelper_ThrowableInfo
     {
         return $this->setOption('folder-depth', $depth);
     }
     
-   /**
-    * Retrieves the current folder depth option value.
-    * 
-    * @return int
-    * @see ConvertHelper_ThrowableInfo::setFolderDepth()
-    */
+    /**
+     * Retrieves the current folder depth option value.
+     * 
+     * @return int
+     * @see ConvertHelper_ThrowableInfo::setFolderDepth()
+     */
     public function getFolderDepth() : int
     {
         $depth = $this->getOption('folder-depth');
@@ -265,13 +265,13 @@ 
         return 2;
     }
     
-   /**
-    * Retrieves all function calls that led to the error,
-    * ordered from latest to earliest (the first one in
-    * the stack is actually the last call).
-    *
-    * @return ConvertHelper_ThrowableInfo_Call[]
-    */
+    /**
+     * Retrieves all function calls that led to the error,
+     * ordered from latest to earliest (the first one in
+     * the stack is actually the last call).
+     *
+     * @return ConvertHelper_ThrowableInfo_Call[]
+     */
     public function getCalls()
     {
         return $this->calls;
@@ -287,10 +287,10 @@ 
         return $this->calls[0];
     }
     
-   /**
-    * Returns the amount of function and method calls in the stack trace.
-    * @return int
-    */
+    /**
+     * Returns the amount of function and method calls in the stack trace.
+     * @return int
+     */
     public function countCalls() : int
     {
         return $this->callsCount;