Block Class Reference

Inheritance diagram for Block:

Public Member Functions
	__construct (\Magento\Framework\View\Element\BlockFactory $blockFactory, \Magento\Framework\Data\Argument\InterpreterInterface $argumentInterpreter, \Magento\Framework\Event\ManagerInterface $eventManager, \Psr\Log\LoggerInterface $logger, \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig, \Magento\Framework\App\ScopeResolverInterface $scopeResolver, \Magento\Framework\View\Element\ExceptionHandlerBlockFactory $exceptionHandlerBlockFactory, State $appState, $defaultClass=Template::class)
	getType ()
	createBlock ($block, $name, array $arguments=[])
Public Member Functions inherited from GeneratorInterface
	process (Reader\Context $readerContext, Generator\Context $generatorContext)

Data Fields
const	TYPE = 'block'

Protected Member Functions
	handleRenderException (\Exception $cause)
	generateBlock (Layout\ScheduledStructure $scheduledStructure, Layout\Data\Structure $structure, $elementName)
	getBlockInstance ($block, array $arguments=[])
	generateAction ($block, $methodName, $actionArguments)
	evaluateArguments (array $arguments)

Protected Attributes
	$blockFactory
	$argumentInterpreter
	$eventManager
	$logger
	$scopeConfig
	$scopeResolver
	$appState
	$exceptionHandlerBlockFactory

Detailed Description

Class Block @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 17 of file Block.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Element\BlockFactory	$blockFactory,
		\Magento\Framework\Data\Argument\InterpreterInterface	$argumentInterpreter,
		\Magento\Framework\Event\ManagerInterface	$eventManager,
		\Psr\Log\LoggerInterface	$logger,
		\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig,
		\Magento\Framework\App\ScopeResolverInterface	$scopeResolver,
		\Magento\Framework\View\Element\ExceptionHandlerBlockFactory	$exceptionHandlerBlockFactory,
		State	$appState,
			$defaultClass = Template::class
	)

Parameters

\Magento\Framework\View\Element\BlockFactory	$blockFactory
\Magento\Framework\Data\Argument\InterpreterInterface	$argumentInterpreter
\Magento\Framework\Event\ManagerInterface	$eventManager
\Psr\Log\LoggerInterface	$logger
\Magento\Framework\App\Config\ScopeConfigInterface	$scopeConfig
\Magento\Framework\App\ScopeResolverInterface	$scopeResolver
\Magento\Framework\View\Element\ExceptionHandlerBlockFactory	$exceptionHandlerBlockFactory
State	$appState
string	$defaultClass

Definition at line 82 of file Block.php.

      {
        $this->blockFactory = $blockFactory;
        $this->argumentInterpreter = $argumentInterpreter;
        $this->eventManager = $eventManager;
        $this->logger = $logger;
        $this->scopeConfig = $scopeConfig;
        $this->scopeResolver = $scopeResolver;
        $this->exceptionHandlerBlockFactory = $exceptionHandlerBlockFactory;
        $this->appState = $appState;
        $this->defaultClass = $defaultClass;
    }

Member Function Documentation

createBlock()

createBlock	(		$block,
			$name,
		array	$arguments = []
	)

Create block instance

Parameters

string | \Magento\Framework\View\Element\AbstractBlock	$block
string	$name
array	$arguments

Returns

\Magento\Framework\View\Element\AbstractBlock

Definition at line 247 of file Block.php.

    {
        $block = $this->getBlockInstance($block, $arguments);
        $block->setType(get_class($block));
        $block->setNameInLayout($name);
        $block->addData(isset($arguments['data']) ? $arguments['data'] : []);
        return $block;
    }

evaluateArguments()

evaluateArguments ( array  $arguments )

protected

Compute and return argument values

Parameters

array

$arguments

Returns

array

Definition at line 309 of file Block.php.

    {
        $result = [];
        foreach ($arguments as $argumentName => $argumentData) {
            if (!isset($argumentData[Dom::TYPE_ATTRIBUTE])) {
                $result[$argumentName] = $argumentData;
                continue;
            }
            $result[$argumentName] = $this->argumentInterpreter->evaluate($argumentData);
        }
        return $result;
    }

generateAction()

generateAction (   $block,   $methodName,   $actionArguments  )

protected

Run action defined in layout update

Parameters

\Magento\Framework\View\Element\AbstractBlock	$block
string	$methodName
array	$actionArguments

Returns

void

Definition at line 294 of file Block.php.

    {
        $profilerKey = 'BLOCK_ACTION:' . $block->getNameInLayout() . '>' . $methodName;
        \Magento\Framework\Profiler::start($profilerKey);
        $args = $this->evaluateArguments($actionArguments);
        call_user_func_array([$block, $methodName], $args);
        \Magento\Framework\Profiler::stop($profilerKey);
    }

generateBlock()

generateBlock ( Layout\ScheduledStructure  $scheduledStructure, Layout\Data\Structure  $structure,   $elementName  )

protected

Create block and set related data

Parameters

\Magento\Framework\View\Layout\ScheduledStructure	$scheduledStructure
\Magento\Framework\View\Layout\Data\Structure	$structure
string	$elementName

Returns

\Magento\Framework\View\Element\AbstractBlock

Definition at line 208 of file Block.php.

      {
        list(, $data) = $scheduledStructure->getElement($elementName);
        $attributes = $data['attributes'];

        if (!empty($attributes['group'])) {
            $structure->addToParentGroup($elementName, $attributes['group']);
        }
        if (!empty($attributes['display'])) {
            $structure->setAttribute($elementName, 'display', $attributes['display']);
        }

        // create block
        $className = isset($attributes['class']) && !empty($attributes['class']) ?
            $attributes['class'] : $this->defaultClass;
        $block = $this->createBlock($className, $elementName, [
            'data' => $this->evaluateArguments($data['arguments'])
        ]);
        if (!empty($attributes['template'])) {
            $block->setTemplate($attributes['template']);
        }
        if (!empty($attributes['ttl'])) {
            $ttl = (int)$attributes['ttl'];
            $block->setTtl($ttl);
        }
        return $block;
    }

getBlockInstance()

getBlockInstance (   $block, array  $arguments = []  )

protected

Create block object instance based on block type

Parameters

string | \Magento\Framework\View\Element\AbstractBlock	$block
array	$arguments

Exceptions

Definition at line 264 of file Block.php.

    {
        $e = null;
        if ($block && is_string($block)) {
            try {
                $block = $this->blockFactory->createBlock($block, $arguments);
            } catch (\ReflectionException $e) {
                $this->logger->critical($e->getMessage());
            }
        }
        if (!$block instanceof \Magento\Framework\View\Element\AbstractBlock) {
            throw new \Magento\Framework\Exception\LocalizedException(
                new \Magento\Framework\Phrase(
                    'Invalid block type: %1',
                    [is_object($block) ? get_class($block) : (string) $block]
                ),
                $e
            );
        }
        return $block;
    }

getType()

getType

(

)

{Return type of generator

Returns

string

}

Returns

string

Implements GeneratorInterface.

Definition at line 109 of file Block.php.

    {
        return self::TYPE;
    }

handleRenderException()

handleRenderException ( \Exception  $cause )

protected

Handle exceptions during rendering process

Parameters

\Exception

$cause

Exceptions

Definition at line 191 of file Block.php.

    {
        if ($this->appState->getMode() === State::MODE_DEVELOPER) {
            throw $cause;
        }
        $message = ($cause instanceof LocalizedException) ? $cause->getLogMessage() : $cause->getMessage();
        $this->logger->critical($message);
    }

Field Documentation

$appState

$appState

protected

Definition at line 57 of file Block.php.

$argumentInterpreter

$argumentInterpreter

protected

Definition at line 32 of file Block.php.

$blockFactory

$blockFactory

protected

Definition at line 27 of file Block.php.

$eventManager

$eventManager

protected

Definition at line 37 of file Block.php.

$exceptionHandlerBlockFactory

$exceptionHandlerBlockFactory

protected

Definition at line 62 of file Block.php.

$logger

$logger

protected

Definition at line 42 of file Block.php.

$scopeConfig

$scopeConfig

protected

Definition at line 47 of file Block.php.

$scopeResolver

$scopeResolver

protected

Definition at line 52 of file Block.php.

TYPE

const TYPE = 'block'

Type of generator

Definition at line 22 of file Block.php.

---

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

• vendor/magento/framework/View/Layout/Generator/Block.php