AppUtils\ConvertHelper_TimeConverter

Complexity

Total Complexity

11

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	toString()	0	23	4
A	initUnits()	0	37	2
A	resolveTokens()	0	31	4

<?php
/**
 * File containing the {@see AppUtils\ConvertHelper_TimeConverter} class.
 *
 * @package Application Utils
 * @subpackage ConvertHelper
 * @see AppUtils\ConvertHelper_TimeConverter
 */

declare(strict_types=1);

namespace AppUtils;

/**
 * Converts seconds to a human readable duration string,
 * like "5 minutes and 20 seconds".
 *
 * @package Application Utils
 * @subpackage ConvertHelper
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 *
 * @see ConvertHelper::time2string()
 */
class ConvertHelper_TimeConverter
{
   /**
    * @var float
    */
    private $seconds;

   /**
    * @var array<int,array<string,string|int>>
    */
    private static $units;
    
   /**
    * @param float $seconds
    */
    public function __construct($seconds)
    {
        $this->seconds = $seconds;   
        
        $this->initUnits();
    }
    
   /**
    * Creates the list of units once per request as needed.
    */
    private function initUnits() : void
    {
        if(isset(self::$units))
        {
            return;
        }
        
        self::$units = array(
            array(
                'value' => 31 * 7 * 24 * 3600,
                'singular' => t('month'),
                'plural' => t('months')
            ),
            array(
                'value' => 7 * 24 * 3600,
                'singular' => t('week'),
                'plural' => t('weeks')
            ),
            array(
                'value' => 24 * 3600,
                'singular' => t('day'),
                'plural' => t('days')
            ),
            array(
                'value' => 3600,
                'singular' => t('hour'),
                'plural' => t('hours')
            ),
            array(
                'value' => 60,
                'singular' => t('minute'),
                'plural' => t('minutes')
            ),
            array(
                'value' => 1,
                'singular' => t('second'),
                'plural' => t('seconds')
            )
        );
    }
    
    public function toString() : string
    {
        // specifically handle zero
        if($this->seconds <= 0) 
        {
            return '0 ' . t('seconds');
        }
        
        if($this->seconds < 1) 
        {
            return t('less than a second');
        }
        
        $tokens = $this->resolveTokens();

        $last = array_pop($tokens);
        
        if(empty($tokens)) 
        {
            return $last;
        }
        
        return implode(', ', $tokens) . ' ' . t('and') . ' ' . $last;
    }
    
   /**
    * Resolves the list of converted units.
    * 
    * @return string[]
    */
    private function resolveTokens() : array
    {
        $seconds = $this->seconds;
        $tokens = array();
        
        foreach(self::$units as $def)
        {
            $unitValue = intval($seconds / $def['value']);
            
            if($unitValue <= 0)
            {
                continue;
            }
            
            $item = strval($unitValue) . ' ';
            
            if(abs($unitValue) > 1)
            {
                $item .= $def['plural'];
            }
            else
            {
                $item .= $def['singular'];
            }
            
            $tokens[] = $item;
            
            $seconds -= $unitValue * $def['value'];
        }
        
        return $tokens;
    }
}