Console.php

Go to the documentation of this file.

<?php

namespace Rsi;

/**
 *  Console helpers.
 */
class Console{

  /**
   * Read an input line.
   * @return string  User input (excluding the last return).
   */
  public static function readLine(){
    $line = fgets(STDIN);
    return rtrim($line,"\r\n");
  }
  /**
   * Ask a question.
   * @param string $message  Message to show.
   * @param array|string $options  Array with allowed options (key = input, value = explanation) or regex for the answer.
   * @param string $default  Default answer (when user presses enter).
   * @return string  Answer.
   */
  public static function prompt($message,$options = null,$default = null){
    do{
      print($message . (is_array($options) ? ' [' . Record::implode($options,',','=') . ']' : '') . ($default ? " ($default)" : '') . ': ');
      if(($result = self::readLine()) === '') $result = $default;
    }
    while($options && !(is_array($options) ? array_key_exists($result,$options) : preg_match($options,$result)));
    return $result;
  }
  /**
   * Large header text.
   * @param string $header  Header.
   * @param int $width  Maximum width of header.
   * @param int $font  Maximum font size (1..5).
   * @param int $pad  Padding type (STR_PAD_* constants).
   * @return string  Large header (multi line string) or simply $header if too wide.
   */
  public static function header($header,$width = 80,$font = null,$pad = null){
    $length = strlen($header);
    $image = imagecreate($width * 2,$width);
    $background = imagecolorallocate($image,0,0,0);
    $color = imagecolorallocate($image,0,0,255);
    $check = imagecolorallocate($image,0,255,0);
    for($font = $font ?: 5; $font; $font--){
      $size= imagefontwidth($font);
      imagefilledrectangle($image,0,0,$width * 2,$height = imagefontheight($font),$background);
      $x = $max = 0;
      for($i = 0; $i < $length; $i++) if(trim($c = $header[$i])){
        if($i && trim($header[$i - 1])){
          do{
            imagestring($image,$font,--$x,0,$c,$check);
            $touch = false;
            for($cx = max(0,$x - $size); $cx < min($width * 2,$x + $size); $cx++) for($cy = 0; $cy < $height; $cy++)
              if($touch = (!$cx || (imagecolorat($image,$cx - 1,$cy) == $color)) && (
                (($cy > 0) && (($cx && (imagecolorat($image,$cx - 1,$cy - 1) == $check)) || (imagecolorat($image,$cx,$cy - 1) == $check))) ||
                (imagecolorat($image,$cx,$cy) == $check) ||
                (($cy < $height - 1) && (($cx && (imagecolorat($image,$cx - 1,$cy + 1) == $check)) || (imagecolorat($image,$cx,$cy + 1) == $check)))
              )) break 2; //cx + cy loop
            imagestring($image,$font,$x,0,$c,$background);
          }
          while(!$touch);
          $x++;
        }
        imagestring($image,$font,$x,0,$c,$color);
        if(($x += $size) > $width * 2) break;
      }
      else $x += round($size / 2); //space
      $lines = [];
      for($y = 0; $y < $height; $y++){
        $line = '';
        for($x = 0; $x < $width * 2; $x++) $line .= imagecolorat($image,$x,$y) ? '#' : ' ';
        if($line = rtrim($line)) $max = max($max,strlen($lines[] = $line));
      }
      if($max <= $width) break;
    }
    imagedestroy($image);
    if($max > $width){
      $lines = [$header];
      $max = $length;
    }
    switch($pad){
      case STR_PAD_RIGHT: $lines = Record::prefix($lines,str_repeat(' ',$width - $max)); break;
      case STR_PAD_BOTH: $lines = Record::prefix($lines,str_repeat(' ',round(($width - $max) / 2))); break;
    }
    return implode("\n",$lines);
  }
  /**
   * Text block.
   * @param string $str  Text.
   * @param int $width  Width of block.
   * @param int $pad  Padding type (STR_PAD_* constants).
   * @return string  Block with text.
   */
  public static function block($str,$width = 80,$pad = null){
    $text = $border = str_repeat('*',$width);
    foreach(Str::wrap($str,$width -= 8) as $line) $text .= "\n**  " . Str::pad($line,$width,' ',$pad ?: STR_PAD_RIGHT) . "  **";
    return $text . "\n" . $border;
  }
  /**
   * Text style gauge.
   * @param float $perc  Percentage done (0..100).
   * @param int $width  Total width of gauche.
   * @return string
   */
  public static function gauge($perc = 0,$width = 80){
    $done = round($perc * $width / 100);
    $text = str_repeat('#',$done) . str_repeat('-',$width - $done);
    $start = round(($width - ($length = strlen($perc = ' ' . round($perc) . '% '))) / 2);
    return substr($text,0,$start) . $perc . substr($text,$start + $length);
  }

  protected static function tableRow($record,$columns){
    $text = null;
    $max_lines = 1;
    foreach($columns as $key => $column) $max_lines = max($max_lines,count($columns[$key]['lines'] = Str::wrap($record[$key] ?? null,$column['width'])));
    $last = Record::key($columns,-1);
    for($i = 0; $i < $max_lines; $i++){
      $text .= ['|','/',':','\\'][$border = $max_lines <= 1 ? 0 : ($i ? ($i == $max_lines - 1 ? 3 : 2) : 1)];
      foreach($columns as $key => $column)
        $text .= ' ' . \Rsi\Str::pad($column['lines'][$i] ?? null,$column['width'],' ',$column['pad'] ?? STR_PAD_RIGHT) . ' ' . ($key == $last ? ['|','\\',':','/'][$border] : '|');
      $text .= "\n";
    }
    return $text;
  }
  /**
   * Text style table.
   * @param array $data  Array of records.
   * @param array $columns  Key = same as records, value = array with (optional) 'header' (defaults to key), 'width' (defaults
   *   to null = auto), 'pad' = STR_PAD_RIGHT (default), STR_PAD_LEFT, or STR_PAD_BOTH. Empty = take keys of first record.
   * @param int $width  Maximum width of complete table (including borders).
   * @return string
   */
  public static function table($data,$columns = null,$width = 80){
    $text = null;
    if($count = count($data = array_values($data))){
      if(!$columns) $columns = array_fill_keys(array_keys($data[0]),[]);
      $headers = $footers = $max_length = [];
      foreach($columns as $key => $column) $max_length[$key] = max(mb_strlen($headers[$key] = $column['header'] ?? $key),mb_strlen($footers[$key] = $column['footer'] ?? null));
      $average_length = $max_length;
      foreach($data as $record) foreach($columns as $key => $column){
        $length = mb_strlen($record[$key] ?? null);
        if($column['width'] ?? null) $length = min($length,$column['width']);
        $average_length[$key] += $length;
        $max_length[$key] = max($max_length[$key],$length);
      }
      $total_width = 1; //left border
      foreach($columns as $key => $column){
        $average_length[$key] /= $count;
        $total_width += ($columns[$key]['width'] = $max_length[$key]) + 3; //spaces + right border
      }
      if($total_width > $width){
        $factor = ($width - 1 - count($columns) * 3) / array_sum($average_length);
        $total_width = 1;
        foreach($columns as $key => $column) $total_width += ($columns[$key]['width'] = min($max_length[$key],max(1,floor($factor * $average_length[$key])))) + 3;
        while($total_width < $width){
          $min_key = $min_width = null;
          foreach($columns as $key => $column) if((!$min_key || ($column['width'] < $min_width)) && ($column['width'] < $max_length[$key])){
            $min_key = $key;
            $min_width = $column['width'];
          }
          $columns[$min_key]['width']++;
          $total_width++;
        }
      }
      $border = '+';
      foreach($columns as $key => $column) $border .= str_repeat('-',$column['width'] + 2) . '+';
      $text = $border . "\n" . self::tableRow($headers,$columns) . $border . "\n";
      foreach($data as $record) $text .= self::tableRow($record,$columns);
      $text .= $border;
      if(array_filter($footers)) $text .= "\n" . self::tableRow($footers,$columns) . $border;
    }
    return $text;
  }

}