BlockPool Class Reference

Public Member Functions
	__construct (BlockFactory $blockFactory)
	add ($name, $class, array $arguments=[])
	get ($name=null)

Protected Attributes
	$blockFactory
	$blocks = []

Detailed Description

Class BlockPool

Definition at line 14 of file BlockPool.php.

Constructor & Destructor Documentation

__construct()

__construct

(

BlockFactory

$blockFactory

)

Constructor

Parameters

BlockFactory

$blockFactory

Definition at line 34 of file BlockPool.php.

    {
        $this->blockFactory = $blockFactory;
    }

Member Function Documentation

add()

add	(		$name,
			$class,
		array	$arguments = []
	)

Add a block

Parameters

string	$name
string	$class
array	$arguments	[optional]

Returns

BlockPool

Exceptions

Definition at line 48 of file BlockPool.php.

    {
        if (!class_exists($class)) {
            throw new \InvalidArgumentException(
                (string)new \Magento\Framework\Phrase('Invalid Block class name: %1', [$class])
            );
        }

        $block = $this->blockFactory->createBlock($class, $arguments);

        $this->blocks[$name] = $block;

        return $this;
    }

get()

get

(

$name = null

)

Get blocks

Parameters

string

$name

Returns

BlockInterface|null

Definition at line 69 of file BlockPool.php.

    {
        if (!isset($name)) {
            return $this->blocks;
        }

        return $this->blocks[$name] ?? null;
    }

Field Documentation

$blockFactory

$blockFactory

protected

Definition at line 20 of file BlockPool.php.

$blocks

$blocks = []

protected

Definition at line 27 of file BlockPool.php.

---

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

• vendor/magento/framework/View/BlockPool.php