class TokenReplacerBase in Forena Reports 8

Base class for token replacements. @package Drupal\forena\Token

Hierarchy

• class \Drupal\forena\Token\TokenReplacerBase implements TokenReplacerInterface uses FrxAPI

File

src/Token/TokenReplacerBase.php, line 18

FrXSytnaxEngine defines how regular expression procesing/token substitution takes place. It includes support for passing in a formatter oobject that will escape strings properly before substituting them.

Namespace

Drupal\forena\Token

class TokenReplacerBase implements TokenReplacerInterface {
  use FrxAPI;
  private $tpattern;
  protected $trim_chars;
  protected $formatter;

  // Object used to format the data

  /**
   * @param $regexp
   *   Regular expression used to find the tokens.
   * @param string $trim
   *   Characters used to remove from the regular expression.
   * @param null $formatter
   *   Object contaning the formatter method.
   */
  public function __construct($regexp, $trim, $formatter = NULL) {
    $this->tpattern = $regexp;
    $this->trim_chars = $trim;
    if (is_object($formatter)) {
      $this->formatter = $formatter;
    }
  }

  /**
   * @param $formatter
   * Building
   */
  public function setFormatter($formatter) {
    $this->formatter = $formatter;
  }

  /**
   * Get the value from the data.
   * This is used by token_replace method to extract the data based on the path provided.
   * @param $data
   * @param $key
   * @return string|array
   */
  protected function get_value($key, $raw = FALSE) {
    $context = '';
    $raw_key = $key;
    $dataSvc = $this
      ->dataService();
    if ($key && strpos($key, '.')) {
      @(list($context, $key) = explode('.', $key, 2));
      $o = $this
        ->getDataContext($context);
    }
    else {
      $o = $this
        ->currentDataContext();
    }
    $value = $dataSvc
      ->getValue($key, $context);
    if ($this->formatter) {
      $value = $this->formatter
        ->format($value, $raw_key, $raw);
    }
    return $value;
  }

  /**
   *Replace the text in a report.
   * @param string $text
   *   text that needs replacing
   * @param bool $raw
   *   Whether to perform field replacement
   * @return string
   *   Replaced text
   */
  public function replace($text, $raw = FALSE) {
    if (is_array($text)) {
      foreach ($text as $key => $value) {
        $text[$key] = $this
          ->replace($value, $raw);
      }
      return $text;
    }

    //Otherswise assume text
    $match = array();
    $o_text = $text;

    // Put the data on the stack.
    if (preg_match_all($this->tpattern, $o_text, $match)) {

      // If we are replacing a single value then return exactly
      // the single value in its native type;
      $single_value = $match && count($match[0]) == 1 && $match[0][0] == $text && $raw;

      //list($params) = $match[1];
      $i = 0;
      foreach ($match[0] as $match_num => $token) {
        $path = trim($token, $this->trim_chars);
        $value = $this
          ->get_value($path, $raw);
        if ($single_value) {
          return $value;
        }
        else {
          $pos = strpos($text, $token);
          if ($pos !== FALSE) {
            $text = substr_replace($text, $value, $pos, strlen($token));
          }
        }
      }
    }
    return $text;
  }

  /**
   * List all of the tokens used in a piece of text, ignoring duplicates.
   *
   * @param string $text
   * @return array tokens contained in the text according to the regular expression.
   */
  public function tokens($text) {
    $match = array();
    $tokens = array();
    if (preg_match_all($this->tpattern, $text, $match)) {
      $i = 0;
      foreach ($match[0] as $match_num => $token) {
        $path = trim($token, $this->trim_chars);
        if (array_search($path, $tokens) === FALSE) {
          $tokens[] = $path;
        }
      }
    }
    return $tokens;
  }

  /**
   * Convert an object into an array
   *
   *    *
   * Iterates the object and builds an array of strings from it.
   * If the object appears to be an xml object and has an attributes
   * method, do the same for it.
   *
   * @param mixed $data
   * @return array
   *   array representation of object.
   */
  public function object_to_array($data) {
    if (is_object($data)) {
      $ar = array();
      foreach ($data as $key => $value) {
        $ar[$key] = (string) $value;
      }
      if (method_exists($data, 'attributes')) {
        foreach ($data
          ->attributes() as $key => $value) {
          $ar[$key] = (string) $value;
        }
      }
      return $ar;
    }
    else {
      return $data;
    }
  }

  /**
   * Test for TRUE/FALSE for conditions that are able to be represented using bind parameters
   * Note that & are used to separate the different conditions and these are to be OR'd together.
   * @param  $condition String
   * @return bool
   *   Boolean cast of expression.
   */
  public function test($condition) {
    $eval = TRUE;
    $tests = explode('&', $condition);
    if ($tests) {
      foreach ($tests as $test) {
        $t = trim($test);
        $res = $this
          ->replace($t, TRUE);
        if (is_string($res)) {
          $res = trim($res, ' !') ? TRUE : FALSE;
          if (strpos($t, '!') === 0) {
            $res = !$res;
          }
        }
        else {
          $res = $res ? TRUE : FALSE;
        }
        $eval = $eval && $res;
      }
    }
    return $eval;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FrxAPI::app	public	function	Returns containing application service
FrxAPI::currentDataContext	public	function	Get the current data context.
FrxAPI::currentDataContextArray	public	function
FrxAPI::dataManager	public	function	Returns the data manager service
FrxAPI::dataService	public	function	Return Data Service
FrxAPI::documentManager	public	function	Returns the fornea document manager
FrxAPI::error	public	function	Report an error
FrxAPI::getDataContext	public	function	Get the context of a specific id.
FrxAPI::getDocument	public	function	Get the current document
FrxAPI::getReportFileContents	public	function	Load the contents of a file in the report file system.
FrxAPI::innerXML		function	Enter description here...	1
FrxAPI::popData	public	function	Pop data off of the stack.
FrxAPI::pushData	public	function	Push data onto the Stack
FrxAPI::report	public	function	Run a report with a particular format.	1
FrxAPI::reportFileSystem	public	function	Get the current report file system.
FrxAPI::setDataContext	public	function	Set Data context by id.
FrxAPI::setDocument	public	function	Change to a specific document type.
FrxAPI::skins	public	function	Get list of skins.
TokenReplacerBase::$formatter	protected	property
TokenReplacerBase::$tpattern	private	property
TokenReplacerBase::$trim_chars	protected	property
TokenReplacerBase::get_value	protected	function	Get the value from the data. This is used by token_replace method to extract the data based on the path provided.	1
TokenReplacerBase::object_to_array	public	function	Convert an object into an array
TokenReplacerBase::replace	public	function	Replace the text in a report. Overrides TokenReplacerInterface::replace
TokenReplacerBase::setFormatter	public	function
TokenReplacerBase::test	public	function	Test for TRUE/FALSE for conditions that are able to be represented using bind parameters Note that & are used to separate the different conditions and these are to be OR'd together. Overrides TokenReplacerInterface::test
TokenReplacerBase::tokens	public	function	List all of the tokens used in a piece of text, ignoring duplicates. Overrides TokenReplacerInterface::tokens
TokenReplacerBase::__construct	public	function		2