FrxTemplate.inc in Forena Reports 7.3
Same filename and directory in other branches
FrxTemplate Base Class for all tmeplates. By default simply renders a document with all the possible tokens in it. @author davidmetzler
File
templates/FrxTemplate.incView source
<?php
/**
* @file FrxTemplate
* Base Class for all tmeplates. By default simply renders a document with all the possible tokens in it.
* @author davidmetzler
*
*/
class FrxTemplate {
public $dom;
public $document_root;
public $simplexml;
public $body;
public $doc_prefix = '<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE root [ <!ENTITY nbsp " "> ]>';
public $xmlns = 'urn:FrxReports';
public $columns;
public function __construct($xml_string = '') {
$this->dom = new DOMDocument('1.0', 'UTF-8');
$dom = $this->dom;
// Load a new one or build the empty XML Document
$xml_string = $this->doc_prefix . '<html xmlns:frx="urn:FrxReports"><head/><body/></html>';
libxml_use_internal_errors();
try {
$dom
->loadXML($xml_string);
} catch (Exception $e) {
forena_error('Invalid or malformed template document', '<pre>' . $e
->getMessage() . $e
->getTraceAsString() . '</pre>');
}
$this->body = $dom
->getElementsByTagName('body')
->item(0);
}
public function columns($xml, $path = '/*/*') {
//create an array of columns
if (!is_object($xml)) {
return array();
}
$rows = $xml
->xpath($path);
$column_array = array();
$this->columns = array();
foreach ($rows as $columns) {
foreach ($columns as $name => $value) {
$column_array[$name] = $name;
$this->columns[] = $name;
}
if (is_object($xml) && method_exists($xml, 'attributes')) {
foreach ($xml
->attributes() as $name => $value) {
$column_array['@' . $name] = '@' . $name;
}
}
}
return $column_array;
}
/**
* Returns the section
* Enter description here ...
*/
public function config_form($config, $xml = '') {
$form_ctl = array();
$form_ctl['heading'] = array(
'#type' => 'textfield',
'#title' => t('Heading'),
'#default_value' => @$config['heading'],
);
$form_ctl['description'] = array(
'#type' => 'textarea',
'#title' => t('Description'),
'#rows' => 2,
'#default_value' => @$config['description'],
);
$form_ctl['include'] = array(
'#type' => 'textfield',
'#title' => 'Include Report (graph/image)',
'#autocomplete_path' => 'forena/reports/autocomplete',
'#default_value' => @$config['include'],
);
return $form_ctl;
}
function addNode($cur_node, $indent = 0, $tag = 'div', $value = '', $attributes = array(), $frx_attributes = array()) {
$dom = $this->dom;
if (!$cur_node) {
return;
}
if ($indent !== FALSE) {
$tnode = $dom
->createTextNode("\n" . str_repeat(' ', $indent));
$cur_node
->appendChild($tnode);
}
$pnode = $dom
->createElement($tag, $value);
if ($attributes) {
foreach ($attributes as $key => $value) {
if ($value) {
$attr = $dom
->createAttribute($key);
$attr->value = $value;
$pnode
->appendChild($attr);
}
}
}
if ($frx_attributes) {
foreach ($frx_attributes as $key => $value) {
if ($value) {
// If the value is an array create multiple attributes
// that are of the form key_1, key_2 .... etc.
if (is_array($value)) {
$i = 0;
foreach ($value as $v) {
$i++;
$k = $key . '_' . trim((string) $i);
$attr = $dom
->createAttributeNS($this->xmlns, $k);
$attr->value = htmlentities($v);
$pnode
->appendChild($attr);
}
}
else {
$attr = $dom
->createAttributeNS($this->xmlns, $key);
$attr->value = htmlentities($value);
$pnode
->appendChild($attr);
}
}
}
}
$cur_node
->appendChild($pnode);
return $pnode;
}
function addText($cur_node, $text) {
$dom = $this->dom;
$tnode = $dom
->createTextNode($text);
$cur_node
->appendChild($tnode);
return $tnode;
}
/**
*
* Extract a configuration var removing it from the array
* @param string $key attribute key for the data being extracted.
* @param array $config
*/
public function extract($key, &$config) {
$value = '';
if (isset($config[$key])) {
$value = $config[$key];
unset($config[$key]);
}
return $value;
}
/**
*
* Generate generic div tag.
* @param unknown_type $config
* @param unknown_type $text
*/
public function blockDiv(&$config, $text = '') {
$body = $this->body;
$heading = $this
->extract('heading', $config);
$descr = $this
->extract('description', $config);
$include = $this
->extract('include', $config);
$block = $this
->extract('block', $config);
$foreach = $this
->extract('foreach', $config);
$id = $this
->extract('id', $config);
if (!$id) {
$id = $this
->idFromBlock($block);
}
$class = $this
->extract('class', $config);
$frx_attributes = array(
'block' => $block,
'foreach' => $foreach,
);
$attributes = array(
'id' => $id,
'class' => $class,
);
$node = $this
->addNode($body, 2, 'div', $text, $attributes, $frx_attributes);
if ($heading) {
$this
->addNode($node, 4, 'h2', $heading);
}
if ($descr) {
$this
->addNode($node, 4, 'p', $descr);
}
if ($include) {
$src = 'reports/' . str_replace('/', '.', $include);
$this
->addNode($node, 4, 'div', NULL, NULL, array(
'renderer' => 'FrxInclude',
'src' => $src,
));
}
return $node;
}
/**
*
* Enter description here ...
* @param string $data_block
* @param SimpleXMLElement $xml
* @param array $config
*/
public function generate($xml, $config) {
if (!@$config['foreach']) {
$config['foreach'] = '*';
}
$columns = $this
->columns($xml);
$text = '';
if ($columns) {
foreach ($columns as $col) {
$text .= ' {' . $col . '}';
}
}
$this
->blockDiv($config, $text);
}
public function template() {
$body = $this->body;
$output = '';
foreach ($body->childNodes as $node) {
$output .= $this->dom
->saveXML($node);
}
return $output;
}
public function asXML() {
return $this->dom
->saveXML();
}
public function idFromBlock($block) {
$parts = explode('/', $block);
$id = str_replace('.', '_', array_pop($parts));
return $id;
}
}Classes
Name |
Description |
|---|---|
| FrxTemplate | @file FrxTemplate Base Class for all tmeplates. By default simply renders a document with all the possible tokens in it. @author davidmetzler |