Varien_Filter_Template Class Reference

Inheritance diagram for Varien_Filter_Template:

List of all members.

Public Member Functions
	setVariables (array $variables)
	setIncludeProcessor (array $callback)
	getIncludeProcessor ()
	filter ($value)
	varDirective ($construction)
	includeDirective ($construction)
	dependDirective ($construction)
	ifDirective ($construction)
Public Attributes
const	CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si'
const	CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s*(.*?)}}(.*?){{\\/depend\s*}}/si'
const	CONSTRUCTION_IF_PATTERN = '/{{if\s*(.*?)}}(.*?)({{else}}(.*?))?{{\\/if\s*}}/si'
Protected Member Functions
	_getIncludeParameters ($value)
	_getVariable ($value, $default='{no_value_defined}')
Protected Attributes
	$_templateVars = array()
	$_includeProcessor = null

---

Detailed Description

Definition at line 35 of file Template.php.

---

Member Function Documentation

_getIncludeParameters

(

$

value

)

[protected]

Return associative array of include construction.

Parameters:

string

$value raw parameters

Returns:

array

Definition at line 209 of file Template.php.

    {
        $tokenizer = new Varien_Filter_Template_Tokenizer_Parameter();
        $tokenizer->setString($value);
        $params = $tokenizer->tokenize();
        foreach ($params as $key => $value) {
            if (substr($value, 0, 1) === '$') {
                $params[$key] = $this->_getVariable(substr($value, 1), null);
            }
        }
        return $params;
    }

_getVariable

(

$

value

)

[protected]

Return variable value for var construction

Parameters:

	string	$value raw parameters
	string	$default default value

Returns:

string

Definition at line 229 of file Template.php.

                                                      {no_value_defined}')
    {
        Varien_Profiler::start("email_template_proccessing_variables");
        $tokenizer = new Varien_Filter_Template_Tokenizer_Variable();
        $tokenizer->setString($value);
        $stackVars = $tokenizer->tokenize();
        $result = $default;
        $last = 0;
        for($i = 0; $i < count($stackVars); $i ++) {
            if ($i == 0 && isset($this->_templateVars[$stackVars[$i]['name']])) {
                // Getting of template value
                $stackVars[$i]['variable'] =& $this->_templateVars[$stackVars[$i]['name']];
            } else if (isset($stackVars[$i-1]['variable'])
                       && $stackVars[$i-1]['variable'] instanceof Varien_Object) {
                // If object calling methods or getting properties
                if($stackVars[$i]['type'] == 'property') {
                    $caller = "get" . uc_words($stackVars[$i]['name'], '');
                    if(is_callable(array($stackVars[$i-1]['variable'], $caller))) {
                        // If specified getter for this property
                        $stackVars[$i]['variable'] = $stackVars[$i-1]['variable']->$caller();
                    } else {
                        $stackVars[$i]['variable'] = $stackVars[$i-1]['variable']
                                                        ->getData($stackVars[$i]['name']);
                    }
                } else if ($stackVars[$i]['type'] == 'method') {
                    // Calling of object method
                    if (is_callable(array($stackVars[$i-1]['variable'], $stackVars[$i]['name'])) || substr($stackVars[$i]['name'],0,3) == 'get') {
                        $stackVars[$i]['variable'] = call_user_func_array(array($stackVars[$i-1]['variable'],
                                                                                $stackVars[$i]['name']),
                                                                          $stackVars[$i]['args']);
                    }
                }
                $last = $i;
            }
        }

        if(isset($stackVars[$last]['variable'])) {
            // If value for construction exists set it
            $result = $stackVars[$last]['variable'];
        }
        Varien_Profiler::stop("email_template_proccessing_variables");
        return $result;
    }

dependDirective

(

$

construction

)

Definition at line 173 of file Template.php.

    {
        if (count($this->_templateVars)==0) {
            // If template preprocessing
            return $construction[0];
        }

        if($this->_getVariable($construction[1], '')=='') {
            return '';
        } else {
            return $construction[2];
        }
    }

filter

(

$

value

)

Filter the string as template.

Parameters:

string

$value

Returns:

string

Definition at line 102 of file Template.php.

    {
        // "depend" and "if" operands should be first
        foreach (array(
            self::CONSTRUCTION_DEPEND_PATTERN => 'dependDirective',
            self::CONSTRUCTION_IF_PATTERN     => 'ifDirective',
            ) as $pattern => $directive) {
            if (preg_match_all($pattern, $value, $constructions, PREG_SET_ORDER)) {
                foreach($constructions as $index => $construction) {
                    $replacedValue = '';
                    $callback = array($this, $directive);
                    if(!is_callable($callback)) {
                        continue;
                    }
                    try {
                        $replacedValue = call_user_func($callback, $construction);
                    } catch (Exception $e) {
                        throw $e;
                    }
                    $value = str_replace($construction[0], $replacedValue, $value);
                }
            }
        }

        if(preg_match_all(self::CONSTRUCTION_PATTERN, $value, $constructions, PREG_SET_ORDER)) {
            foreach($constructions as $index=>$construction) {
                $replacedValue = '';
                $callback = array($this, $construction[1].'Directive');
                if(!is_callable($callback)) {
                    continue;
                }
                try {
                    $replacedValue = call_user_func($callback, $construction);
                } catch (Exception $e) {
                    throw $e;
                }
                $value = str_replace($construction[0], $replacedValue, $value);
            }
        }
        return $value;
    }

getIncludeProcessor

(

)

Sets the proccessor of includes.

Returns:

array|null

Definition at line 91 of file Template.php.

    {
        return is_callable($this->_includeProcessor) ? $this->_includeProcessor : null;
    }

ifDirective

(

$

construction

)

Definition at line 187 of file Template.php.

    {
        if (count($this->_templateVars) == 0) {
            return $construction[0];
        }

        if($this->_getVariable($construction[1], '') == '') {
            if (isset($construction[3]) && isset($construction[4])) {
                return $construction[4];
            }
            return '';
        } else {
            return $construction[2];
        }
    }

includeDirective

(

$

construction

)

Definition at line 156 of file Template.php.

    {
        // Processing of {include template=... [...]} statement
        $includeParameters = $this->_getIncludeParameters($construction[2]);
        if(!isset($includeParameters['template']) or !$this->getIncludeProcessor()) {
            // Not specified template or not seted include processor
            $replacedValue = '{' . __('Error in include processing') . '}';
        } else {
            // Including of template
            $templateCode = $includeParameters['template'];
            unset($includeParameters['template']);
            $includeParameters = array_merge_recursive($includeParameters, $this->_templateVars);
            $replacedValue = call_user_func($this->getIncludeProcessor(), $templateCode, $includeParameters);
        }
        return $replacedValue;
    }

setIncludeProcessor

(

array $

callback

)

Sets the proccessor of includes.

Parameters:

array

$callback it must return string

Definition at line 80 of file Template.php.

    {
        $this->_includeProcessor = $callback;
        return $this;
    }

setVariables

(

array $

variables

)

Sets template variables that's can be called througth {var ...} statement

Parameters:

array

$variables

Definition at line 67 of file Template.php.

    {
        foreach($variables as $name=>$value) {
            $this->_templateVars[$name] = $value;
        }
        return $this;
    }

varDirective

(

$

construction

)

Definition at line 145 of file Template.php.

    {
        if (count($this->_templateVars)==0) {
            // If template preprocessing
            return $construction[0];
        }

        $replacedValue = $this->_getVariable($construction[2], '');
        return $replacedValue;
    }

---

Member Data Documentation

$_includeProcessor = null [protected]

Definition at line 60 of file Template.php.

$_templateVars = array() [protected]

Definition at line 53 of file Template.php.

const CONSTRUCTION_DEPEND_PATTERN = '/{{depend\s*(.*?)}}(.*?){{\\/depend\s*}}/si'

Cunstruction logic regular expression

Definition at line 45 of file Template.php.

const CONSTRUCTION_IF_PATTERN = '/{{if\s*(.*?)}}(.*?)({{else}}(.*?))?{{\\/if\s*}}/si'

Definition at line 46 of file Template.php.

const CONSTRUCTION_PATTERN = '/{{([a-z]{0,10})(.*?)}}/si'

Cunstruction regular expression

Definition at line 40 of file Template.php.

---

The documentation for this class was generated from the following file:

• lib/Varien/Filter/Template.php