Php Class Reference

Inheritance diagram for Php:

Public Member Functions
	__construct (\Magento\Framework\ObjectManagerInterface $helperFactory)
	render (BlockInterface $block, $fileName, array $dictionary=[])
	__call ($method, $args)
	__isset ($name)
	__get ($name)
	helper ($className)
Public Member Functions inherited from TemplateEngineInterface
	render (\Magento\Framework\View\Element\BlockInterface $block, $templateFile, array $dictionary=[])

Protected Attributes
	$_currentBlock
	$_helperFactory

Detailed Description

Template engine that enables PHP templates to be used for rendering

Definition at line 14 of file Php.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Framework\ObjectManagerInterface

$helperFactory

)

Constructor

Parameters

\Magento\Framework\ObjectManagerInterface

$helperFactory

Definition at line 35 of file Php.php.

    {
        $this->_helperFactory = $helperFactory;
    }

Member Function Documentation

__call()

__call	(		$method,
			$args
	)

Redirects methods calls to the current block

This is needed because the templates are included in the context of this engine rather than in the context of the block.

Parameters

string	$method
array	$args

Returns

mixed

Definition at line 80 of file Php.php.

    {
        return call_user_func_array([$this->_currentBlock, $method], $args);
    }

__get()

__get

(

$name

)

Allows read access to properties of the current block

This is needed because the templates are included in the context of this engine rather than in the context of the block.

Parameters

string

$name

Returns

mixed

Definition at line 108 of file Php.php.

    {
        return $this->_currentBlock->{$name};
    }

__isset()

__isset

(

$name

)

Redirects isset calls to the current block

This is needed because the templates are included in the context of this engine rather than in the context of the block.

Parameters

string

$name

Returns

bool

Definition at line 94 of file Php.php.

    {
        return isset($this->_currentBlock->{$name});
    }

helper()

helper

(

$className

)

Get helper singleton

Parameters

string

$className

Returns

\Magento\Framework\App\Helper\AbstractHelper

Exceptions

Definition at line 120 of file Php.php.

    {
        $helper = $this->_helperFactory->get($className);
        if (false === $helper instanceof \Magento\Framework\App\Helper\AbstractHelper) {
            throw new \LogicException($className . ' doesn\'t extends Magento\Framework\App\Helper\AbstractHelper');
        }

        return $helper;
    }

render()

render	(	BlockInterface	$block,
			$fileName,
		array	$dictionary = []
	)

Render output

Include the named PHTML template using the given block as the $this reference, though only public methods will be accessible.

Parameters

BlockInterface	$block
string	$fileName
array	$dictionary

Returns

string

Exceptions

Get output buffer.

Definition at line 52 of file Php.php.

    {
        ob_start();
        try {
            $tmpBlock = $this->_currentBlock;
            $this->_currentBlock = $block;
            extract($dictionary, EXTR_SKIP);
            include $fileName;
            $this->_currentBlock = $tmpBlock;
        } catch (\Exception $exception) {
            ob_end_clean();
            throw $exception;
        }
        $output = ob_get_clean();
        return $output;
    }

Field Documentation

$_currentBlock

$_currentBlock

protected

Definition at line 21 of file Php.php.

$_helperFactory

$_helperFactory

protected

Definition at line 28 of file Php.php.

---

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

• vendor/magento/framework/View/TemplateEngine/Php.php