Hint.php

Go to the documentation of this file.

<?php

namespace Rsi\Fred;

class Hint extends Component{

  public $transId = 'hint-*'; //!< An asterisk will be replaced with the widget ID or type.
  public $closeCaption = null; //!< Caption for the close button (will be translated).
  public $ignore = []; //!< ID's of hints to ignore (do not show - anymore).
  public $ignoreAll = false; //!< Set to true to ignore all hints.
  public $counts = [];

  protected $_hints = [];

  public function clientConfig(){
    return array_merge(parent::clientConfig(),[
      'hints' => $this->_hints,
      'counts' => $this->counts,
      'closeCaption' => $this->component('trans')->str($this->closeCaption)
    ]);
  }
  /**
   * Add a hint.
   * @param string $id  Unique ID for the hint.
   * @param string $selector  Selector for the hint (e.g. CSS selector for HTML view).
   * @param int $from  Show this hint from this presentation onwards (1 = do not show hint first time).
   * @param int $limit  Show this hint only for this amount of times (empty = no limit).
   * @param array $config  Extra config for the hint.
   */
  public function add($id,$selector,$from = 0,$limit = null,$config = null){
    if(!$this->ignoreAll && !in_array($id,$this->ignore))
      $this->_hints[$id] = array_merge(array_filter(compact('selector','from','limit')),$config ?: []);
  }
  /**
   * Translate a hint.
   * @param string $id  Hint ID.
   * @param int $count  Presentation counter (0 on first presentation).
   * @return string  Translated hint.
   */
  public function trans($id,$count = null){
    return $this->component('trans')->id(str_replace('*',$id,$this->transId),($this->_hints[$id] ?? []) + ['count' => $count]);
  }

}