<?php
/** DomFramework
    @package domframework
    @author Dominique Fournier <dominique@fournier38.fr> */

/** Convert a format to another one
  */
class convert
{
  /** Convert Date received in one format to another.
    * If the provided string is not corresponding to the format, generate an
    * exception or return the original string
    * Format used http://php.net/manual/en/datetime.createfromformat.php
    * Do not accept the locale ! The language of the dates is always in english
    * @param string $inputDate The date to modify
    * @param string $inputFormat The input format of the date
    * @param string $outputFormat The output format of the date
    * @param boolean|null $exception If set, generate an exception if the
    * provided date is invalid
    * @return string
    */
  public static function convertDate ($inputDate, $inputFormat, $outputFormat,
                                      $exception = true)
  {
    if (! is_string ($inputDate))
      throw new \Exception ("The date to convert is not a string", 500);
    if (! is_string ($inputFormat))
      throw new \Exception ("The convert input format is not a string", 500);
    if (! is_string ($outputFormat))
      throw new \Exception ("The convert output format is not a string", 500);
    $date = \DateTime::CreateFromFormat ($inputFormat, $inputDate);
    if ($date === false)
    {
      if ($exception === true)
        throw new \Exception (
          "Invalid date provided or not matching the format", 500);
      return $inputDate;
    }
    $errors = $date->getLastErrors();
    if ($errors["warning_count"] > 0 || $errors["error_count"] > 0)
    {
      if ($exception === true)
        throw new \Exception (
          "Invalid date provided or not matching the format", 500);
      return $inputDate;
    }
    return $date->format ($outputFormat);
  }

  /** Convert the first char to capital and the rest of the sentence in
    * lowercase (like ucfirst, but UTF8 compliant)
    * @param string $str The string to convert
    */
  public static function ucfirst ($str)
  {
    if (! function_exists ("mb_strtoupper"))
      throw new \Exception ("PHP don't have the MB Support. Please add it !",
        500);
    $a = mb_strtoupper (mb_substr ($str, 0, 1, 'UTF-8'), 'UTF-8');
    return $a . mb_substr ($str, 1, null, 'UTF-8');
  }

  /** Convert the first char of each word of a sentence to capital. The word
    * delimiter can be provided.
    * The sentence is in UTF-8.
    * The sentence is converted to lowercase before doing the action (in
    * contrary of the original PHP function)
    * @param string $str The string to convert
    * @param string $delimiters The delimiters (by default " \t\r\n\f\v")
    * @return string
    */
  public static function ucwords ($str, $delimiters = " \t\r\n\f\v")
  {
    if (! function_exists ("mb_strtolower"))
      throw new \Exception ("PHP don't have the MB Support. Please add it !",
        500);
    $str = mb_strtolower ($str, "utf-8");
    $res = "";
    foreach  (preg_split ("#([".preg_quote ($delimiters)."]+)#", $str, -1,
              PREG_SPLIT_DELIM_CAPTURE) as $tok)
    {
      $res .= \convert::ucfirst ($tok);
    }
    return $res;
  }

  /** Convert the provided integer to human readable format
    * Example : 1440000000 => 1.44Mo
    * @param integer $bytes The number of bytes to convert
    * @param integer $decimals The number of decimal
    */
  public static function humanSize ($bytes, $decimals = 2)
  {
    $size = array (dgettext ("domframework", 'B'),
                   dgettext ("domframework", 'kB'),
                   dgettext ("domframework", 'MB'),
                   dgettext ("domframework", 'GB'),
                   dgettext ("domframework", 'TB'),
                   dgettext ("domframework", 'PB'),
                   dgettext ("domframework", 'EB'),
                   dgettext ("domframework", 'ZB'),
                   dgettext ("domframework", 'YB'));
    $factor = floor ((strlen ($bytes) - 1) / 3);
    if ($factor == 0)
      $val = sprintf ("%d", intval ($bytes)). @$size[$factor];
    else
      $val = sprintf ("%.{$decimals}f", $bytes / pow (1024, $factor)) .
             @$size[$factor];
    return $val;
  }
}