Mistralys / application-utils

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

src/ConvertHelper/EOL.php

Indentation +26 added lines, -26 removed lines

@@ -29,19 +29,19 @@ 
     public const TYPE_LF = 'LF';
     public 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/ConvertHelper/ThrowableInfo/Call.php

Indentation +56 added lines, -56 removed lines

@@ -10,45 +10,45 @@ 
     public const TYPE_METHOD_CALL = 'method';
     public const TYPE_SCRIPT_START = 'start';
     
-   /**
-    * @var ConvertHelper_ThrowableInfo
-    */
+    /**
+     * @var ConvertHelper_ThrowableInfo
+     */
     protected $info;
     
-   /**
-    * @var VariableInfo[]
-    */
+    /**
+     * @var VariableInfo[]
+     */
     protected $args = array();
     
-   /**
-    * The source file, if any
-    * @var string
-    */
+    /**
+     * The source file, if any
+     * @var string
+     */
     protected $file = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $class = '';
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $line = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $position = 1;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $function = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $type = self::TYPE_SCRIPT_START;
 
     /**
@@ -79,10 +79,10 @@ 
         }
     }
     
-   /**
-    * 1-based position of the call in the calls list.
-    * @return int
-    */
+    /**
+     * 1-based position of the call in the calls list.
+     * @return int
+     */
     public function getPosition() : int
     {
         return $this->position;
@@ -93,18 +93,18 @@ 
         return $this->line;
     }
     
-   /**
-    * Whether the call had any arguments.
-    * @return bool
-    */
+    /**
+     * Whether the call had any arguments.
+     * @return bool
+     */
     public function hasArguments() : bool
     {
         return !empty($this->args);
     }
     
-   /**
-    * @return VariableInfo[]
-    */
+    /**
+     * @return VariableInfo[]
+     */
     public function getArguments()
     {
         return $this->args;
@@ -244,31 +244,31 @@ 
         return implode(', ', $tokens); 
     }
     
-   /**
-    * Retrieves the type of call: typically a function
-    * call, or a method call of an object. Note that the
-    * first call in a script does not have either.
-    * 
-    * @return string
-    * 
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
-    * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
-    * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
-    * @see ConvertHelper_ThrowableInfo_Call::hasClass()
-    */
+    /**
+     * Retrieves the type of call: typically a function
+     * call, or a method call of an object. Note that the
+     * first call in a script does not have either.
+     * 
+     * @return string
+     * 
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_FUNCTION_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_METHOD_CALL
+     * @see ConvertHelper_ThrowableInfo_Call::TYPE_SCRIPT_START
+     * @see ConvertHelper_ThrowableInfo_Call::hasFunction()
+     * @see ConvertHelper_ThrowableInfo_Call::hasClass()
+     */
     public function getType() : string
     {
         return $this->type;
     }
      
-   /**
-    * Serializes the call to an array, with all
-    * necessary information. Can be used to restore
-    * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
-    * 
-    * @return array<string,mixed>
-    */
+    /**
+     * Serializes the call to an array, with all
+     * necessary information. Can be used to restore
+     * the call later using {@link ConvertHelper_ThrowableInfo_Call::fromSerialized()}.
+     * 
+     * @return array<string,mixed>
+     */
     public function serialize() : array
     {
         $result = array(

src/ConvertHelper/DurationConverter.php

Indentation +47 added lines, -47 removed lines

@@ -34,39 +34,39 @@ 
     public const SECONDS_PER_MONTH_APPROX = 2505600; // imprecise - for 29 days, only for approximations. 
     public const SECONDS_PER_YEAR = 31536000;
     
-   /**
-    * @var int|NULL
-    */
+    /**
+     * @var int|NULL
+     */
     protected $dateFrom;
     
-   /**
-    * @var int|NULL
-    */
+    /**
+     * @var int|NULL
+     */
     protected $dateTo;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $future = false;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $interval = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $difference = 0;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateDiff = 0;
     
-   /**
-    * @var array<string,array<string,string>>|NULL
-    */
+    /**
+     * @var array<string,array<string,string>>|NULL
+     */
     protected static $texts = null;
     
     public function __construct()
@@ -86,17 +86,17 @@ 
         self::$texts = null;
     }
     
-   /**
-    * Sets the origin date to calculate from.
-    * 
-    * NOTE: if this is further in the future than
-    * the to: date, it will be considered as a 
-    * calculation for something to come, i.e. 
-    * "In two days".
-    *  
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the origin date to calculate from.
+     * 
+     * NOTE: if this is further in the future than
+     * the to: date, it will be considered as a 
+     * calculation for something to come, i.e. 
+     * "In two days".
+     *  
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateFrom(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateFrom = ConvertHelper::date2timestamp($date);
@@ -104,13 +104,13 @@ 
         return $this;
     }
     
-   /**
-    * Sets the date to calculate to. Defaults to 
-    * the current time if not set.
-    * 
-    * @param DateTime $date
-    * @return ConvertHelper_DurationConverter
-    */
+    /**
+     * Sets the date to calculate to. Defaults to 
+     * the current time if not set.
+     * 
+     * @param DateTime $date
+     * @return ConvertHelper_DurationConverter
+     */
     public function setDateTo(DateTime $date) : ConvertHelper_DurationConverter
     {
         $this->dateTo = ConvertHelper::date2timestamp($date);
@@ -118,14 +118,14 @@ 
         return $this;
     }
     
-   /**
-    * Converts the specified dates to a human-readable string.
-    * 
-    * @throws ConvertHelper_Exception
-    * @return string
-    * 
-    * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
-    */
+    /**
+     * Converts the specified dates to a human-readable string.
+     * 
+     * @throws ConvertHelper_Exception
+     * @return string
+     * 
+     * @see ConvertHelper_DurationConverter::ERROR_NO_DATE_FROM_SET
+     */
     public function convert() : string
     {
         $this->initTexts();

src/ConvertHelper/SizeNotation.php

Indentation +89 added lines, -89 removed lines

@@ -31,9 +31,9 @@ 
     
     public const VALIDATION_ERROR_NEGATIVE_VALUE = 43803;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $sizeString;
 
     /**
@@ -41,44 +41,44 @@ 
      */
     protected $sizeDefinition;
     
-   /**
-    * @var integer
-    */
+    /**
+     * @var integer
+     */
     protected $bytes = 0;
     
-   /**
-    * @var bool
-    */
+    /**
+     * @var bool
+     */
     protected $valid = true;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $units = null;
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $number = '';
     
-   /**
-    * @var string
-    */
+    /**
+     * @var string
+     */
     protected $errorMessage = '';
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $errorCode = 0;
     
-   /**
-    * Create a new instance for the specified size string.
-    * 
-    * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case-insensitive, so "50 MB" = "50 mb".
-    *
-    * @throws ConvertHelper_Exception
-    * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
-    */
+    /**
+     * Create a new instance for the specified size string.
+     * 
+     * @param string $sizeString A size notation in the format "50 MB", or a number of bytes without units. Spaces are ignored, so "50MB" = "50 MB" = "  50   MB   ". Floating point values are accepted, both with dot and comma notation ("50.5" = "50,5"). To use Base 2 values, ose appropriate units, e.g. "50 MiB", "1.5 GiB". The units are case-insensitive, so "50 MB" = "50 mb".
+     *
+     * @throws ConvertHelper_Exception
+     * @see ConvertHelper_StorageSizeEnum::ERROR_UNKNOWN_UNIT_NAME
+     */
     public function __construct(string $sizeString)
     {
         $this->sizeString = $this->cleanString($sizeString);
@@ -86,31 +86,31 @@ 
         $this->convert();
     }
     
-   /**
-    * Gets the amount of bytes contained in the size notation.
-    * @return int
-    */
+    /**
+     * Gets the amount of bytes contained in the size notation.
+     * @return int
+     */
     public function toBytes() : int
     {
         return $this->bytes;
     }
     
-   /**
-    * Converts the size notation to a human-readable string, e.g. "50 MB".
-    * 
-    * @param int $precision
-    * @return string
-    * @see ConvertHelper::bytes2readable()
-    */
+    /**
+     * Converts the size notation to a human-readable string, e.g. "50 MB".
+     * 
+     * @param int $precision
+     * @return string
+     * @see ConvertHelper::bytes2readable()
+     */
     public function toString(int $precision=1) : string
     {
         return ConvertHelper::bytes2readable($this->bytes, $precision, $this->getBase());
     }
     
-   /**
-    * Retrieves the detected number's base.
-    * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
-    */
+    /**
+     * Retrieves the detected number's base.
+     * @return int The base number (1000 for Base 10, or 1024 for Base 2), or 0 if it is not valid.
+     */
     public function getBase() : int
     {
         if($this->isValid()) {
@@ -120,13 +120,13 @@ 
         return 0;
     }
     
-   /**
-    * Retrieves the detected storage size instance, if 
-    * the size string is valid.
-    * 
-    * @return ConvertHelper_StorageSizeEnum_Size|NULL
-    * @see ConvertHelper_StorageSizeEnum_Size
-    */
+    /**
+     * Retrieves the detected storage size instance, if 
+     * the size string is valid.
+     * 
+     * @return ConvertHelper_StorageSizeEnum_Size|NULL
+     * @see ConvertHelper_StorageSizeEnum_Size
+     */
     public function getSizeDefinition() : ?ConvertHelper_StorageSizeEnum_Size
     {
         if($this->isValid()) {
@@ -136,27 +136,27 @@ 
         return null;
     }
     
-   /**
-    * Checks whether the size notation was valid and could be parsed
-    * into a meaningful byte value. If this returns `false`, it is 
-    * possible to use the `getErrorXXX` methods to retrieve information
-    * on what went wrong. 
-    * 
-    * @return bool
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Checks whether the size notation was valid and could be parsed
+     * into a meaningful byte value. If this returns `false`, it is 
+     * possible to use the `getErrorXXX` methods to retrieve information
+     * on what went wrong. 
+     * 
+     * @return bool
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function isValid() : bool
     {
         return $this->valid;
     }
     
-   /**
-    * Retrieves the error message if the size notation validation failed.
-    * 
-    * @return string
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * Retrieves the error message if the size notation validation failed.
+     * 
+     * @return string
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     public function getErrorMessage() : string
     {
         return $this->errorMessage;
@@ -201,12 +201,12 @@ 
         );
     }
     
-   /**
-    * Detects the units and the number in the size notation string.
-    * Populates the `units` and `number` properties.
-    * 
-    * @return bool Whether the string could be parsed successfully.
-    */
+    /**
+     * Detects the units and the number in the size notation string.
+     * Populates the `units` and `number` properties.
+     * 
+     * @return bool Whether the string could be parsed successfully.
+     */
     protected function detectParts() : bool
     {
         $units = ConvertHelper_StorageSizeEnum::getSizeNames();
@@ -242,16 +242,16 @@ 
         return true;
     }
     
-   /**
-    * If the validation fails, this is used to store the reason for retrieval later.
-    *  
-    * @param string $message
-    * @param int $code
-    * 
-    * @see ConvertHelper_SizeNotation::isValid()
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    * @see ConvertHelper_SizeNotation::getErrorCode()
-    */
+    /**
+     * If the validation fails, this is used to store the reason for retrieval later.
+     *  
+     * @param string $message
+     * @param int $code
+     * 
+     * @see ConvertHelper_SizeNotation::isValid()
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     * @see ConvertHelper_SizeNotation::getErrorCode()
+     */
     protected function setError(string $message, int $code) : void
     {
         $this->valid = false;
@@ -259,12 +259,12 @@ 
         $this->errorCode = $code;
     }
     
-   /**
-    * Retrieves the error code, if the size notation validation failed.
-    * 
-    * @return int
-    * @see ConvertHelper_SizeNotation::getErrorMessage()
-    */
+    /**
+     * Retrieves the error code, if the size notation validation failed.
+     * 
+     * @return int
+     * @see ConvertHelper_SizeNotation::getErrorMessage()
+     */
     public function getErrorCode() : int
     {
         return $this->errorCode;