ActionPool Class Reference

Inheritance diagram for ActionPool:

Public Member Functions
	__construct (Context $context, ItemFactory $itemFactory)
	getToolbar ()
	add ($key, array $data, UiComponentInterface $component)
	remove ($key)
	update ($key, array $data)
	addHtmlBlock ($type, $name='', array $arguments=[])

Data Fields
const	ACTIONS_PAGE_TOOLBAR = 'page.actions.toolbar'

Protected Member Functions
	createContainer ($key, UiComponentInterface $view)

Protected Attributes
	$context
	$items
	$itemFactory
	$toolbarBlock

Detailed Description

Class ActionPool

Definition at line 17 of file ActionPool.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Context	$context,
		ItemFactory	$itemFactory
	)

Construct

Parameters

Context	$context
ItemFactory	$itemFactory

Definition at line 56 of file ActionPool.php.

    {
        $this->context = $context;
        $this->itemFactory = $itemFactory;
    }

Member Function Documentation

add()

add	(		$key,
		array	$data,
		UiComponentInterface	$component
	)

Add button

Parameters

string	$key
array	$data
UiComponentInterface	$component

Returns

void

Implements ActionPoolInterface.

Definition at line 82 of file ActionPool.php.

    {
        $data['id'] = isset($data['id']) ? $data['id'] : $key;

        $toolbar = $this->getToolbar();
        if ($toolbar !== false) {
            $this->items[$key] = $this->itemFactory->create();
            $this->items[$key]->setData($data);
            $container = $this->createContainer($key, $component);
            $toolbar->setChild($key, $container);
        }
    }

addHtmlBlock()

addHtmlBlock	(		$type,
			$name = '',
		array	$arguments = []
	)

Add html block

Parameters

string	$type
string	$name
array	$arguments

Returns

void

Implements ActionPoolInterface.

Definition at line 128 of file ActionPool.php.

    {
        $toolbar = $this->getToolbar();
        $container = $this->context->getPageLayout()->createBlock($type, $name, $arguments);
        if ($toolbar) {
            $toolbar->setChild($name, $container);
        }
    }

createContainer()

createContainer (   $key, UiComponentInterface  $view  )

protected

Create button container

Parameters

string	$key
UiComponentInterface	$view

Returns

Container

Definition at line 144 of file ActionPool.php.

    {
        $container = $this->context->getPageLayout()->createBlock(
            \Magento\Ui\Component\Control\Container::class,
            'container-' . $view->getName() . '-' . $key,
            [
                'data' => [
                    'button_item' => $this->items[$key],
                    'context' => $view,
                ]
            ]
        );

        return $container;
    }

getToolbar()

getToolbar

(

)

Get toolbar block

Returns

bool|BlockInterface

Implements ActionPoolInterface.

Definition at line 67 of file ActionPool.php.

    {
        return $this->context->getPageLayout()
            ? $this->context->getPageLayout()->getBlock(static::ACTIONS_PAGE_TOOLBAR)
            : false;
    }

remove()

remove

(

$key

)

Remove button

Parameters

string

$key

Returns

void

Implements ActionPoolInterface.

Definition at line 101 of file ActionPool.php.

    {
        unset($this->items[$key]);
    }

update()

update	(		$key,
		array	$data
	)

Update button

Parameters

string	$key
array	$data

Returns

void

Implements ActionPoolInterface.

Definition at line 113 of file ActionPool.php.

    {
        if (isset($this->items[$key])) {
            $this->items[$key]->setData($data);
        }
    }

Field Documentation

$context

$context

protected

Definition at line 29 of file ActionPool.php.

$itemFactory

$itemFactory

protected

Definition at line 43 of file ActionPool.php.

$items

$items

protected

Definition at line 36 of file ActionPool.php.

$toolbarBlock

$toolbarBlock

protected

Definition at line 48 of file ActionPool.php.

ACTIONS_PAGE_TOOLBAR

const ACTIONS_PAGE_TOOLBAR = 'page.actions.toolbar'

Actions toolbar block name

Definition at line 22 of file ActionPool.php.

---

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

• vendor/magento/module-ui/Component/Control/ActionPool.php