BlockRepository Class Reference

Inheritance diagram for BlockRepository:

Public Member Functions
	__construct (ResourceBlock $resource, BlockFactory $blockFactory, \Magento\Cms\Api\Data\BlockInterfaceFactory $dataBlockFactory, BlockCollectionFactory $blockCollectionFactory, Data\BlockSearchResultsInterfaceFactory $searchResultsFactory, DataObjectHelper $dataObjectHelper, DataObjectProcessor $dataObjectProcessor, StoreManagerInterface $storeManager, CollectionProcessorInterface $collectionProcessor=null)
	save (Data\BlockInterface $block)
	getById ($blockId)
	delete (Data\BlockInterface $block)
	deleteById ($blockId)
Public Member Functions inherited from BlockRepositoryInterface
	getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)

Protected Attributes
	$resource
	$blockFactory
	$blockCollectionFactory
	$searchResultsFactory
	$dataObjectHelper
	$dataObjectProcessor
	$dataBlockFactory

Detailed Description

Class BlockRepository @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file BlockRepository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourceBlock	$resource,
		BlockFactory	$blockFactory,
		\Magento\Cms\Api\Data\BlockInterfaceFactory	$dataBlockFactory,
		BlockCollectionFactory	$blockCollectionFactory,
		Data\BlockSearchResultsInterfaceFactory	$searchResultsFactory,
		DataObjectHelper	$dataObjectHelper,
		DataObjectProcessor	$dataObjectProcessor,
		StoreManagerInterface	$storeManager,
		CollectionProcessorInterface	$collectionProcessor = null
	)

Parameters

ResourceBlock	$resource
BlockFactory	$blockFactory
Data\BlockInterfaceFactory	$dataBlockFactory
BlockCollectionFactory	$blockCollectionFactory
Data\BlockSearchResultsInterfaceFactory	$searchResultsFactory
DataObjectHelper	$dataObjectHelper
DataObjectProcessor	$dataObjectProcessor
StoreManagerInterface	$storeManager
CollectionProcessorInterface	$collectionProcessor

Definition at line 83 of file BlockRepository.php.

      {
        $this->resource = $resource;
        $this->blockFactory = $blockFactory;
        $this->blockCollectionFactory = $blockCollectionFactory;
        $this->searchResultsFactory = $searchResultsFactory;
        $this->dataObjectHelper = $dataObjectHelper;
        $this->dataBlockFactory = $dataBlockFactory;
        $this->dataObjectProcessor = $dataObjectProcessor;
        $this->storeManager = $storeManager;
        $this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
    }

Member Function Documentation

delete()

delete

(

Data\BlockInterface

$block

)

Delete Block

Parameters

\Magento\Cms\Api\Data\BlockInterface

$block

Returns

bool

Exceptions

CouldNotDeleteException

Implements BlockRepositoryInterface.

Definition at line 173 of file BlockRepository.php.

    {
        try {
            $this->resource->delete($block);
        } catch (\Exception $exception) {
            throw new CouldNotDeleteException(__($exception->getMessage()));
        }
        return true;
    }

deleteById()

deleteById

(

$blockId

)

Delete Block by given Block Identity

Parameters

string

$blockId

Returns

bool

Exceptions

CouldNotDeleteException
NoSuchEntityException

Implements BlockRepositoryInterface.

Definition at line 191 of file BlockRepository.php.

    {
        return $this->delete($this->getById($blockId));
    }

getById()

getById

(

$blockId

)

Load Block data by given Block Identity

Parameters

string

$blockId

Returns

Block

Exceptions

Implements BlockRepositoryInterface.

Definition at line 133 of file BlockRepository.php.

    {
        $block = $this->blockFactory->create();
        $this->resource->load($block, $blockId);
        if (!$block->getId()) {
            throw new NoSuchEntityException(__('The CMS block with the "%1" ID doesn\'t exist.', $blockId));
        }
        return $block;
    }

save()

save

(

Data\BlockInterface

$block

)

Save Block data

Parameters

\Magento\Cms\Api\Data\BlockInterface

$block

Returns

Block

Exceptions

CouldNotSaveException

Implements BlockRepositoryInterface.

Definition at line 112 of file BlockRepository.php.

    {
        if (empty($block->getStoreId())) {
            $block->setStoreId($this->storeManager->getStore()->getId());
        }

        try {
            $this->resource->save($block);
        } catch (\Exception $exception) {
            throw new CouldNotSaveException(__($exception->getMessage()));
        }
        return $block;
    }

Field Documentation

$blockCollectionFactory

$blockCollectionFactory

protected

Definition at line 40 of file BlockRepository.php.

$blockFactory

$blockFactory

protected

Definition at line 35 of file BlockRepository.php.

$dataBlockFactory

$dataBlockFactory

protected

Definition at line 60 of file BlockRepository.php.

$dataObjectHelper

$dataObjectHelper

protected

Definition at line 50 of file BlockRepository.php.

$dataObjectProcessor

$dataObjectProcessor

protected

Definition at line 55 of file BlockRepository.php.

$resource

$resource

protected

Definition at line 30 of file BlockRepository.php.

$searchResultsFactory

$searchResultsFactory

protected

Definition at line 45 of file BlockRepository.php.

---

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

• vendor/magento/module-cms/Model/BlockRepository.php