libraries/advisor.lib.php

   1 <?php
   2 /* vim: set expandtab sw=4 ts=4 sts=4: */
   3 /**
   4  * Contains Advisor functions
   5  *
   6  * @package PhpMyAdmin
   7  */
   8
   9 /**
  10  * Formats interval like 10 per hour
  11  *
  12  * @param integer $num       number to format
  13  * @param integer $precision required precision
  14  *
  15  * @return string formatted string
  16  */
  17 function ADVISOR_bytime($num, $precision)
  18 {
  19     if ($num >= 1) { // per second
  20         $per = __('per second');
  21     } elseif ($num * 60 >= 1) { // per minute
  22         $num = $num * 60;
  23         $per = __('per minute');
  24     } elseif ($num * 60 * 60 >= 1 ) { // per hour
  25         $num = $num * 60 * 60;
  26         $per = __('per hour');
  27     } else {
  28         $num = $num * 60 * 60 * 24;
  29         $per = __('per day');
  30     }
  31
  32     $num = round($num, $precision);
  33
  34     if ($num == 0) {
  35         $num = '<' . pow(10, -$precision);
  36     }
  37
  38     return "$num $per";
  39 }
  40
  41 /**
  42  * Wrapper for PMA\libraries\Util::timespanFormat
  43  *
  44  * This function is used when evaluating advisory_rules.txt
  45  *
  46  * @param int $seconds the timespan
  47  *
  48  * @return string  the formatted value
  49  */
  50 function ADVISOR_timespanFormat($seconds)
  51 {
  52     return PMA\libraries\Util::timespanFormat($seconds);
  53 }
  54
  55 /**
  56  * Wrapper around PMA\libraries\Util::formatByteDown
  57  *
  58  * This function is used when evaluating advisory_rules.txt
  59  *
  60  * @param double $value the value to format
  61  * @param int    $limes the sensitiveness
  62  * @param int    $comma the number of decimals to retain
  63  *
  64  * @return string the formatted value with unit
  65  */
  66 function ADVISOR_formatByteDown($value, $limes = 6, $comma = 0)
  67 {
  68     return implode(' ', PMA\libraries\Util::formatByteDown($value, $limes, $comma));
  69 }