Mistralys / application-utils

src/ConvertHelper/QueryParser.php

Spacing +5 added lines, -5 removed lines

@@ -37,7 +37,7 @@ 
         // extract parameter names from the query string
         $result = array();
         preg_match_all('/&?([^&]+)=.*/sixU', $queryString, $result, PREG_PATTERN_ORDER);
-        if(isset($result[1])) {
+        if (isset($result[1])) {
             $paramNames = $result[1];
         }
         
@@ -60,11 +60,11 @@ 
         // possible naming conflicts like having both parameters "foo.bar"
         // and "foo_bar" in the query string: since "foo.bar" would be converted
         // to "foo_bar", one of the two would be replaced.
-        if($fixRequired)
+        if ($fixRequired)
         {
             $counter = 1;
             $placeholders = array();
-            foreach($paramNames as $paramName)
+            foreach ($paramNames as $paramName)
             {
                 // create a unique placeholder name
                 $placeholder = '__PLACEHOLDER'.$counter.'__';
@@ -94,13 +94,13 @@ 
         parse_str($queryString, $parsed);
         
         // do any of the parameter names need to be fixed?
-        if(!$fixRequired) {
+        if (!$fixRequired) {
             return $parsed;
         }
         
         $keep = array();
         
-        foreach($parsed as $name => $value)
+        foreach ($parsed as $name => $value)
         {
             $keep[$table[$name]] = $value;
         }

src/ConvertHelper/WordWrapper.php

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
         return $this->getBoolOption('cut');
     }
     
-    public function setCuttingEnabled(bool $enabled=true) : ConvertHelper_WordWrapper
+    public function setCuttingEnabled(bool $enabled = true) : ConvertHelper_WordWrapper
     {
         $this->setOption('cut', $enabled);
         return $this;

Braces +1 added lines, -2 removed lines

@@ -92,8 +92,7 @@
                 if (mb_strlen($actual.$word) <= $width)
                 {
                     $actual .= $word.' ';
-                }
-                else
+                } else
                 {
                     if ($actual != '') {
                         $line .= rtrim($actual).$break;

src/ConvertHelper/DateInterval.php

Indentation +43 added lines, -43 removed lines

@@ -37,14 +37,14 @@ 
     const TOKEN_MONTHS = 'm';
     const TOKEN_YEARS = 'y';
     
-   /**
-    * @var \DateInterval
-    */
+    /**
+     * @var \DateInterval
+     */
     protected $interval;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $seconds;
     
     protected function __construct(int $seconds)
@@ -69,33 +69,33 @@ 
         $this->interval = $interval;
     }
     
-   /**
-    * Creates the interval from a specific amount of seconds.
-    * 
-    * @param int $seconds
-    * @return \AppUtils\ConvertHelper_DateInterval
-    */
+    /**
+     * Creates the interval from a specific amount of seconds.
+     * 
+     * @param int $seconds
+     * @return \AppUtils\ConvertHelper_DateInterval
+     */
     public static function fromSeconds(int $seconds)
     {
         return new ConvertHelper_DateInterval($seconds);
     }
     
-   /**
-    * Creates the interval from an existing regular interval instance.
-    * 
-    * @param \DateInterval $interval
-    * @return \AppUtils\ConvertHelper_DateInterval
-    */
+    /**
+     * Creates the interval from an existing regular interval instance.
+     * 
+     * @param \DateInterval $interval
+     * @return \AppUtils\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;
@@ -131,31 +131,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;

Spacing +1 added lines, -1 removed lines

@@ -57,7 +57,7 @@
         
         $interval = $d2->diff($d1);
         
-        if($interval === false) 
+        if ($interval === false) 
         {
             throw new ConvertHelper_Exception(
                 'Cannot create interval',

src/ConvertHelper/DurationConverter.php

Indentation +47 added lines, -47 removed lines

@@ -26,39 +26,39 @@ 
     const ERROR_NO_DATE_FROM_SET = 43401;
     
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     protected $dateFrom;
     
-   /**
-    * @var int
-    */
+    /**
+     * @var int
+     */
     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
-    */
+    /**
+     * @var array
+     */
     protected static $texts;
     
     public function __construct()
@@ -78,17 +78,17 @@ 
         unset(self::$texts);
     }
     
-   /**
-    * 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);
@@ -96,13 +96,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);
@@ -110,14 +110,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();

Spacing +8 added lines, -8 removed lines

@@ -63,7 +63,7 @@ 
     
     public function __construct()
     {
-        if(class_exists('\AppLocalize\Localization')) {
+        if (class_exists('\AppLocalize\Localization')) {
             \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged'));
         }
     }
@@ -125,11 +125,11 @@ 
         
         $epoch = 'past';
         $key = 'singular';
-        if($this->dateDiff > 1) {
+        if ($this->dateDiff > 1) {
             $key = 'plural';
         }
         
-        if($this->future) {
+        if ($this->future) {
             $epoch = 'future'; 
         }
         
@@ -142,7 +142,7 @@ 
     
     protected function initTexts()
     {
-        if(isset(self::$texts)) {
+        if (isset(self::$texts)) {
             return;
         }
         
@@ -228,7 +228,7 @@ 
         $day = (int)date("j", $this->dateTo);
         $year = (int)date("Y", $this->dateFrom);
         
-        while(mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo)
+        while (mktime($hour, $min, $sec, $month + ($months_difference), $day, $year) < $this->dateTo)
         {
             $months_difference++;
         }
@@ -248,7 +248,7 @@ 
     
     protected function resolveCalculations() : void
     {
-        if(!isset($this->dateFrom))
+        if (!isset($this->dateFrom))
         {
             throw new ConvertHelper_Exception(
                 'No date from has been specified.',
@@ -258,7 +258,7 @@ 
         }
         
         // no date to set? Assume we want to use today.
-        if(!isset($this->dateTo))
+        if (!isset($this->dateTo))
         {
             $this->dateTo = time();
         }
@@ -337,7 +337,7 @@ 
         
         $difference = $this->dateTo - $this->dateFrom;
         
-        if($difference < 0)
+        if ($difference < 0)
         {
             $difference = $difference * -1;
             $this->future = true;

src/ConvertHelper/IntervalConverter.php

Indentation +38 added lines, -39 removed lines

@@ -17,21 +17,20 @@ 
  * @package Application Utils
  * @subpackage ConvertHelper
  * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
-
  * @see ConvertHelper::interval2string()
  */
 class ConvertHelper_IntervalConverter
 {
     const ERROR_MISSING_TRANSLATION = 43501;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected static $texts;
     
-   /**
-    * @var array
-    */
+    /**
+     * @var array
+     */
     protected $tokens = array('y', 'm', 'd', 'h', 'i', 's');
     
     public function __construct()
@@ -41,25 +40,25 @@ 
         }
     }
     
-   /**
-    * Called whenever the application locale has changed,
-    * to reset the internal translation cache.
-    */
+    /**
+     * Called whenever the application locale has changed,
+     * to reset the internal translation cache.
+     */
     public function handle_localeChanged()
     {
         unset(self::$texts);
     }
     
-   /**
-    * Converts the specified interval to a human readable
-    * string, e.g. "2 hours and 4 minutes".
-    * 
-    * @param \DateInterval $interval
-    * @return string
-    * @throws ConvertHelper_Exception
-    * 
-    * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
-    */
+    /**
+     * Converts the specified interval to a human readable
+     * string, e.g. "2 hours and 4 minutes".
+     * 
+     * @param \DateInterval $interval
+     * @return string
+     * @throws ConvertHelper_Exception
+     * 
+     * @see ConvertHelper_IntervalConverter::ERROR_MISSING_TRANSLATION
+     */
     public function toString(\DateInterval $interval) : string
     {
         $this->initTexts();
@@ -88,14 +87,14 @@ 
         return t('%1$s and %2$s', implode(', ', $parts), $last);
     }
     
-   /**
-    * Translates the selected time token, e.g. "y" (for year).
-    * 
-    * @param string $token
-    * @param ConvertHelper_DateInterval $interval
-    * @throws ConvertHelper_Exception
-    * @return string
-    */
+    /**
+     * Translates the selected time token, e.g. "y" (for year).
+     * 
+     * @param string $token
+     * @param ConvertHelper_DateInterval $interval
+     * @throws ConvertHelper_Exception
+     * @return string
+     */
     protected function translateToken(string $token, ConvertHelper_DateInterval $interval) : string
     {
         $value = $interval->getToken($token);
@@ -123,13 +122,13 @@ 
         );
     }
     
-   /**
-    * Resolves all time tokens that need to be translated in
-    * the subject interval, depending on its length.
-    * 
-    * @param ConvertHelper_DateInterval $interval
-    * @return array
-    */
+    /**
+     * Resolves all time tokens that need to be translated in
+     * the subject interval, depending on its length.
+     * 
+     * @param ConvertHelper_DateInterval $interval
+     * @return array
+     */
     protected function resolveTokens(ConvertHelper_DateInterval $interval) : array
     {
         $offset = 0;
@@ -147,9 +146,9 @@ 
         return array();
     }
     
-   /**
-    * Initializes the translateable strings.
-    */
+    /**
+     * Initializes the translateable strings.
+     */
     protected function initTexts() : void
     {
         if(isset(self::$texts)) {

Spacing +9 added lines, -9 removed lines

@@ -36,7 +36,7 @@ 
     
     public function __construct()
     {
-        if(class_exists('\AppLocalize\Localization')) {
+        if (class_exists('\AppLocalize\Localization')) {
             \AppLocalize\Localization::onLocaleChanged(array($this, 'handle_localeChanged'));
         }
     }
@@ -69,17 +69,17 @@ 
         $keep = $this->resolveTokens($interval);
 
         $parts = array();
-        foreach($keep as $token)
+        foreach ($keep as $token)
         {
             $value = $interval->getToken($token);
-            if($value === 0) {
+            if ($value === 0) {
                 continue;
             }
             
             $parts[] = $this->translateToken($token, $interval);
         }
         
-        if(count($parts) == 1) {
+        if (count($parts) == 1) {
             return $parts[0];
         }
         
@@ -101,10 +101,10 @@ 
         $value = $interval->getToken($token);
         
         $suffix = 'p';
-        if($value == 1) { $suffix = 's'; }
+        if ($value == 1) { $suffix = 's'; }
         $token .= $suffix;
         
-        if(!isset(self::$texts[$token]))
+        if (!isset(self::$texts[$token]))
         {
             throw new ConvertHelper_Exception(
                 'Missing interval translation',
@@ -134,9 +134,9 @@ 
     {
         $offset = 0;
         
-        foreach($this->tokens as $token) 
+        foreach ($this->tokens as $token) 
         {
-            if($interval->getToken($token) > 0) 
+            if ($interval->getToken($token) > 0) 
             {
                 return array_slice($this->tokens, $offset);
             }
@@ -152,7 +152,7 @@ 
     */
     protected function initTexts() : void
     {
-        if(isset(self::$texts)) {
+        if (isset(self::$texts)) {
             return;
         }
         

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();
@@ -244,13 +244,13 @@ 
         readfile($this->file);
     }
     
-   /**
-    * 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->download($fileName);
@@ -258,14 +258,14 @@ 
         FileHelper::deleteFile($fileName);
     }
 
-   /**
-    * 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)) {
@@ -278,9 +278,9 @@ 
     }
 
     
-   /**
-    * @return \ZipArchive
-    */
+    /**
+     * @return \ZipArchive
+     */
     public function getArchive()
     {
         $this->open();
@@ -288,14 +288,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(

Spacing +16 added lines, -16 removed lines

@@ -30,7 +30,7 @@ 
     
     const ERROR_OPENING_ZIP_FILE = 338003;
     
-    const ERROR_CANNOT_SAVE_FILE_TO_DISK =338004;
+    const ERROR_CANNOT_SAVE_FILE_TO_DISK = 338004;
     
     protected $options = array(
         'WriteThreshold' => 100
@@ -75,7 +75,7 @@ 
     * @throws ZIPHelper_Exception
     * @return bool
     */
-    public function addFile($filePath, $zipPath=null)
+    public function addFile($filePath, $zipPath = null)
     {
         $this->open();
         
@@ -120,16 +120,16 @@ 
     
     protected function open()
     {
-        if($this->open) {
+        if ($this->open) {
             return;
         }
         
-        if(!isset($this->zip)) {
+        if (!isset($this->zip)) {
             $this->zip = new \ZipArchive();
         }
         
         $flag = null;
-        if(!file_exists($this->file)) {
+        if (!file_exists($this->file)) {
             $flag = \ZipArchive::CREATE;
         }
         
@@ -169,7 +169,7 @@ 
     {
         $this->fileTracker++;
 
-        if($this->options['WriteThreshold'] < 1) {
+        if ($this->options['WriteThreshold'] < 1) {
             return;
         }
         
@@ -182,7 +182,7 @@ 
     
     protected function close()
     {
-        if(!$this->open) {
+        if (!$this->open) {
             return;
         }
         
@@ -190,8 +190,8 @@ 
             throw new ZIPHelper_Exception(
                 'Could not save ZIP file to disk',
                 sprintf(
-                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, ' .
-                    'including adding files that do not exist on disk, trying to create an empty zip, ' .
+                    'Tried saving the ZIP file [%1$s], but the write failed. This can have several causes, '.
+                    'including adding files that do not exist on disk, trying to create an empty zip, '.
                     'or trying to save to a directory that does not exist.',
                     $this->file
                 ),
@@ -228,17 +228,17 @@ 
      * @see ZIPHelper::downloadAndDelete()
      * @throws ZIPHelper_Exception
      */
-    public function download($fileName=null)
+    public function download($fileName = null)
     {
         $this->save();
         
-        if(empty($fileName)) {
+        if (empty($fileName)) {
             $fileName = basename($this->file);
         }
         
         header('Content-type: application/zip');
-        header('Content-Disposition: attachment; filename=' . $fileName);
-        header('Content-length: ' . filesize($this->file));
+        header('Content-Disposition: attachment; filename='.$fileName);
+        header('Content-length: '.filesize($this->file));
         header('Pragma: no-cache');
         header('Expires: 0');
         readfile($this->file);
@@ -251,7 +251,7 @@ 
     * @param string|NULL $fileName Override the ZIP's file name for the download
     * @see ZIPHelper::download()
     */
-    public function downloadAndDelete($fileName=null)
+    public function downloadAndDelete($fileName = null)
     {
         $this->download($fileName);
         
@@ -266,9 +266,9 @@ 
     * @param string $outputFolder
     * @return boolean
     */
-    public function extractAll($outputFolder=null)
+    public function extractAll($outputFolder = null)
     {
-        if(empty($outputFolder)) {
+        if (empty($outputFolder)) {
             $outputFolder = dirname($this->file);
         }