MassAction Class Reference

Inheritance diagram for MassAction:

Public Member Functions
	__construct (AuthorizationInterface $authorization, ContextInterface $context, array $components=[], array $data=[])
	prepare ()
	getComponentName ()
	isActionAllowed ($actionType)
Public Member Functions inherited from AbstractComponent
	__construct (ContextInterface $context, array $components=[], array $data=[])
	getContext ()
	getName ()
	prepare ()
	toHtml ()
	render ()
	addComponent ($name, UiComponentInterface $component)
	getComponent ($name)
	getChildComponents ()
	renderChildComponent ($name)
	getTemplate ()
	getConfiguration ()
	getJsConfig (UiComponentInterface $component)
	setData ($key, $value=null)
	getData ($key='', $index=null)
	prepareDataSource (array $dataSource)
	getDataSourceData ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)

Data Fields
const	NAME = 'massaction'

Additional Inherited Members
Protected Member Functions inherited from AbstractComponent
	prepareChildComponent (UiComponentInterface $component)
	initObservers (array & $data=[])
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)
Protected Attributes inherited from AbstractComponent
	$context
	$components
	$componentData = []
	$dataSources = []
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 15 of file MassAction.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AuthorizationInterface	$authorization,
		ContextInterface	$context,
		array	$components = [],
		array	$data = []
	)

Constructor

Parameters

AuthorizationInterface	$authorization
ContextInterface	$context
	UiComponentInterface[]	$components
array	$data

Definition at line 32 of file MassAction.php.

      {
        $this->authorization = $authorization;
        parent::__construct($context, $components, $data);
    }

Member Function Documentation

getComponentName()

getComponentName

(

)

{Get component name

Returns

string

}

Implements UiComponentInterface.

Definition at line 69 of file MassAction.php.

                                       : string
    {
        return static::NAME;
    }

isActionAllowed()

isActionAllowed

(

$actionType

)

Check if the given type of action is allowed

Parameters

string

$actionType

Returns

bool

Definition at line 80 of file MassAction.php.

                                                 : bool
    {
        $isAllowed = true;
        switch ($actionType) {
            case 'delete':
                $isAllowed = $this->authorization->isAllowed('Magento_Catalog::products');
                break;
            case 'status':
                $isAllowed = $this->authorization->isAllowed('Magento_Catalog::products');
                break;
            case 'attributes':
                $isAllowed = $this->authorization->isAllowed('Magento_Catalog::update_attributes');
                break;
            default:
                break;
        }
        return $isAllowed;
    }

prepare()

prepare

(

)

{Prepare component configuration

Returns

void

}

Implements UiComponentInterface.

Definition at line 45 of file MassAction.php.

                              : void
    {
        $config = $this->getConfiguration();

        foreach ($this->getChildComponents() as $actionComponent) {
            $actionType = $actionComponent->getConfiguration()['type'];
            if ($this->isActionAllowed($actionType)) {
                $config['actions'][] = $actionComponent->getConfiguration();
            }
        }
        $origConfig = $this->getConfiguration();
        if ($origConfig !== $config) {
            $config = array_replace_recursive($config, $origConfig);
        }

        $this->setData('config', $config);
        $this->components = [];

        parent::prepare();
    }

Field Documentation

NAME

const NAME = 'massaction'

Definition at line 17 of file MassAction.php.

---

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

• vendor/magento/module-catalog/Ui/Component/Product/MassAction.php