Table.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred\Controller\Widget;

use \Rsi\Fred\Controller;
use \Rsi\Fred\Controller\Provider;

class Table extends Char{

  const PROVIDER = 'provider'; //!< Data provider.
  const KEY = 'key'; //!< System key (hidden from user).
  const SEQUENCE = 'sequence'; //!< Sequence key (higher = newer).
  const CODE = 'code'; //!< User code (what the user sees; default same as key).
  const DESCR = 'descr'; //!< Full description.
  const PARENT_KEY = 'parentKey'; //!< Parent key column.
  const COLUMNS = 'columns'; //!< Grid columns (key = column name, value = column config; code and description if empty).
  const LINK = 'link'; //!< Link (URL) for a record ("[columnName]" is replaced by the value of that column, for that record).
  const BATCH_SIZE = 'batchSize'; //!< Number of records to return per call.
  const DOWNLOAD_FORMATS = 'downloadFormats'; //!< Available download formats (key = description, value = function (use '*' to
    // refer to this widget); default all downloadXxx functions; set to false for none).
  const DOWNLOAD_NAME = 'downloadName'; //!< Filename (without extension) used for download.

  //column options
  const ORDER = 'order'; //!< True if ordering the result by this column is allowed (default true if omitted).
  const SEARCH = 'search'; //!< Allowed search methods for this column (see \\Rsi\\Fred\\Controller\\Provider::SEARCH_*
    // constants).
  const TOTAL = 'total'; //!< Show total for this column (see \\Rsi\\Fred\\Controller\\Provider::TOTAL_* constants; one or
    // multiple in an array).
  const GROUP = 'group'; //!< Show grouped data for this column (array with keys 'group' = column to group by - defaults to
    // first column; 'column' = column to group the value for - defaults to current column; 'total' = see
    // \\Rsi\\Fred\\Controller\\Provider::TOTAL_* constants; 'limit' = number of results: positive = top-x, negative = bottom-x,
    // 0 = all, sorted by 'group' column).
  const FORMAT = 'format'; //!< Formatting method.
  const FORMAT_PARAMS = 'formatParams'; //!< Extra parameters for the formatting method.
  const VISIBLE = 'visible'; //!< Default visibility (see VISIBLE_* and DOWNLOAD_* constants).

  const VISIBLE_DEFAULT = 1; //!< Show by deault (may be unselected by the user).
  const VISIBLE_OPTIONAL = 2; //!< Dont't show by default, but make it selectable for the user.
  const VISIBLE_NEVER = 4; //!< Do not show (also not optional).
  const DOWNLOAD_DEFAULT = 16; //!< Download by default (may be unselected by the user).
  const DOWNLOAD_VISIBLE = 32; //!< Download when visible.
  const DOWNLOAD_OPTIONAL = 64; //!< Do not download by default, but make it selectable for the user.

  public $provider = null;
  public $batchSize = 100;
  public $link = null;
  public $sequence = null;
  public $sequenceMessage = '{[count<0]!}{[count>0]{[count|number()]}}'; //!< Message for new records (available tags: count,
    //id, and caption; empty result = no message / no refresh; '!' = auto-refresh). Note: count = -1 means: latest record gone.
  public $pdfWriter = null;
  public $downloadName = 'data';
  public $downloadCookieKey = 'fred-controller-table-downloading';
  public $downloadBusyMessage = null;
  public $downloadTimeout = null;

  protected $_key = null;
  protected $_code = null;
  protected $_descr = null;
  protected $_parentKey = null;
  protected $_search = null;
  protected $_columns = null;
  protected $_downloadFormats = null;

  protected function init(){
    parent::init();
    $this->publish(['key','descr','parentKey','search']);
  }

  public function columnCaption($column){
    return array_key_exists(self::CAPTION,$config = $this->columns[$column] ?: [])
      ? $this->trans->str($config[self::CAPTION])
      : $this->trans->id($column);
  }

  public function sessionKey($key){
    return array_merge(['widget','table',$this->id ?: $this->provider->id],is_array($key) ? $key : [$key]);
  }

  public function clientConfig(){
    $session = $this->_controller->session;
    $columns = [];
    foreach($this->columns as $column => $config){
      if($caption = $this->columnCaption($column)) $config[self::CAPTION] = $caption;
      $columns[$column] = $config;
    }
    $config = array_merge(parent::clientConfig(),$this->get([self::CODE,self::DESCR,self::PARENT_KEY,self::LINK,self::SEARCH]),[self::COLUMNS => $columns]);
    if($search = $session->get($this->sessionKey('search'))) $config[self::SEARCH] = $search;
    if($order = $session->get($this->sessionKey('order')) ?: $this->provider->order) $config['defaultOrder'] = $order;
    if($this->downloadFormats) $config[self::DOWNLOAD_FORMATS] = array_keys($this->downloadFormats);
    $config['downloadCookieKey'] = $this->downloadCookieKey;
    if($this->downloadBusyMessage) $config['downloadBusyMessage'] = $this->trans->str($this->downloadBusyMessage);
    if($this->downloadTimeout) $config = $this->downloadTimeout;
    return $config;
  }

  public function convert($value){
    return $this->provider->trans($this->key,$this->code,$value,$this->params);
  }

  public function clientConvert($value){
    return $this->convert($value);
  }

  public function format($value){
    return $this->provider->trans($this->code,$this->key,$value,$this->params);
  }

  public function clientFormat($value){
    return $this->format($value);
  }

  protected function checkRange($value,$index = null){
    return $this->provider->exists($this->key,$value,$this->params);
  }

  protected function download($records,$format,$ext = null,$content_type = null){
    $spreadsheet = new \PhpOffice\PhpSpreadsheet\Spreadsheet();
    $sheet = $spreadsheet->setActiveSheetIndex(0)->setTitle($this->downloadName);
    if(!($columns = $this->request->record('columns')))
      $this->fred->externalError('Invalid columns',['columns' => $columns]);
    $columnChars = [];
    foreach(array_values($columns) as $index => $column){
      if(!array_key_exists($column,$this->columns)) $this->fred->externalError('Unknown column',['column' => $column]);
      $char = \PhpOffice\PhpSpreadsheet\Cell\Coordinate::stringFromColumnIndex($index);
      $sheet->setCellValue($cell = $char . 1,$this->columnCaption($column));
      $sheet->getStyle($cell)->getFont()->setBold(true);
      foreach($records as $index => $record) $sheet->setCellValue($char . ($index + 2),$record[$column] ?? null);
      $sheet->getColumnDimension($char)->setAutoSize(true);
    }
    \Rsi\Http::downloadHeaders($this->downloadName . '.' . ($ext ?: strtolower($format)),$content_type);
    \PhpOffice\PhpSpreadsheet\IOFactory::createWriter($spreadsheet,$format)->save('php://output');
  }

  protected function downloadExcel($records){
    $this->download($records,'Xls');
  }

  protected function downloadXLSX($records){
    $this->download($records,'Xlsx');
  }

  protected function downloadCSV($records){
    $this->download($records,'Csv');
  }

  protected function downloadPDF($records){
    $this->download($records,$this->pdfWriter,'pdf');
  }

  protected function downloadXML($records){
    $root = new \SimpleXmlElement('<records />');
    foreach($records as $record){
      $node = $root->addChild('record');
      foreach($record as $key => $value) $node->addChild($key,htmlspecialchars($value));
    }
    \Rsi\Http::downloadHeaders($this->downloadName . '.xml');
    print($root->asXML());
  }

  protected function downloadJSON($records){
    \Rsi\Http::downloadHeaders($this->downloadName . '.json');
    print(json_encode($records));
  }

  public function searchParams(&$search,&$order){
    $search = $order = [];
    if(is_array($param = $this->request->complex('search'))) foreach($param as $column => $values)
      if(
        array_key_exists($column,$this->columns) && is_array($values) &&
        ($types = \Rsi\Record::get($this->columns[$column],self::SEARCH,[Provider::SEARCH_LIKE]))
      ){
        foreach($values as $type => $value) if(!in_array($type,$types))
          $this->fred->externalError('Invalid search type',['class' => get_called_class()] + compact('column','type'));
        $search[$column] = $values;
      }
    if(is_array($param = $this->request->complex('order'))) foreach($param as $column => $type)
      if(array_key_exists($column,$this->columns) && \Rsi\Record::get($this->columns[$column],self::ORDER,true))
        $order[$column] = (int)$type;
  }

  protected function actionRecords(){
    $this->searchParams($search,$order);
    $session = $this->_controller->session;
    $session->set($this->sessionKey('search'),$search);
    $session->set($this->sessionKey('order'),$order);
    if($this->parentKey) $search[$this->parentKey] = [Provider::SEARCH_EXACT => $this->convert($this->request->parent)];
    $offset = max(0,(int)$this->request->offset);
    $limit = min(max(0,(int)$this->request->limit) ?: $this->batchSize,$this->batchSize);
    $records = $this->provider->search($search,$order,$params = $this->params,$offset,$limit);
    if($this->parentKey) foreach($records as $index => $record) $records[$index][$this->parentKey] =
      ($value = $record[$this->key] ?? null) && $this->provider->exists($this->parentKey,$value,$params);
    $this->request->result = [
      'records' => $records,
      'eof' => count($records) < $limit
    ];
  }

  protected function actionTotals(){
    $this->searchParams($search,$order);
    $this->request->result = $totals = [];
    foreach($this->columns as $column => $config)
      if($total = \Rsi\Record::get($config,self::TOTAL)) $totals[$column] = $total;
    if($this->sequence) $totals[$this->sequence] =
      array_unique(array_merge(\Rsi\Record::explode($totals[$this->sequence] ?? null),[Controller::TOTAL_MAX]));
    if($totals){
      $this->request->result['totals'] = $totals = $this->provider->totals($search,$totals,$this->params);
      if($this->sequence) $this->request->result['latest'] = $totals[$this->sequence][Controller::TOTAL_MAX];
    }
  }

  protected function actionGroup(){
    if($config = \Rsi\Record::get($this->columns,[$column = $this->request->column,self::GROUP])){
      $this->searchParams($search,$order);
      $this->request->result = $this->provider->group(
        $search,
        $config['group'] ?? \Rsi\Record::key($this->columns),
        $config['column'] ?? $column,
        $config['total'],
        $config['limit'] ?? null
      );
    }
  }

  protected function actionDownload(){
    if($method = \Rsi\Record::get($this->downloadFormats,$this->request->format)){
      $this->request->cookie($this->downloadCookieKey,null,-1,['httponly' => false]);
      $this->searchParams($search,$order);
      call_user_func($method,$this->provider->search($search,$order,$this->params));
      $this->fred->halt();
    }
  }

  protected function actionNew(){
    if($this->sequence){
      $this->searchParams($search,$order);
      if(!array_key_exists($this->sequence,$search)) $search[$this->sequence] = [];
      if($latest = $this->request->latest) $search[$this->sequence][Provider::SEARCH_FROM] = $latest;
      $count = \Rsi\Record::get(
        $this->provider->totals($search,[$this->sequence => Controller::TOTAL_COUNT],$this->params),
        [$this->sequence,Controller::TOTAL_COUNT]
      );
      if($latest) $count--;
      if($this->request->result['count'] = $count) $this->request->result['message'] = $this->trans->str(
        $this->sequenceMessage,
        ['count' => $count,'id' => $this->id,'caption' => $this->caption()]
      );
    }
  }

  protected function getCode(){
    return $this->config(self::CODE) ?: $this->_key;
  }

  protected function getColumns(){
    if(!$this->_columns){
      $this->_columns = $this->config(self::COLUMNS);
      if(!$this->_columns){
        $this->_columns = [$this->code => null];
        if($this->descr) $this->_columns[$this->descr] = null;
      }
    }
    return $this->_columns;
  }

  protected function getDownloadFormats(){
    if($this->_downloadFormats === null){
      $this->_downloadFormats = $this->config(self::DOWNLOAD_FORMATS);
      if($this->_downloadFormats === null){
        $this->_downloadFormats = [];
        foreach(get_class_methods($this) as $method) if((strlen($method) > 8) && (substr($method,0,8) == 'download'))
          $this->_downloadFormats[substr($method,8)] = [$this,$method];
      }
      elseif($this->_downloadFormats) foreach($this->_downloadFormats as &$function)
        if(is_array($function) && ($function[0] == '*')) $function[0] = $this;
      unset($function);
    }
    return $this->_downloadFormats;
  }

}