PageRepository Class Reference

Inheritance diagram for PageRepository:

Public Member Functions
	__construct (ResourcePage $resource, PageFactory $pageFactory, Data\PageInterfaceFactory $dataPageFactory, PageCollectionFactory $pageCollectionFactory, Data\PageSearchResultsInterfaceFactory $searchResultsFactory, DataObjectHelper $dataObjectHelper, DataObjectProcessor $dataObjectProcessor, StoreManagerInterface $storeManager, CollectionProcessorInterface $collectionProcessor=null)
	save (\Magento\Cms\Api\Data\PageInterface $page)
	getById ($pageId)
	delete (\Magento\Cms\Api\Data\PageInterface $page)
	deleteById ($pageId)
Public Member Functions inherited from PageRepositoryInterface
	getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)

Protected Attributes
	$resource
	$pageFactory
	$pageCollectionFactory
	$searchResultsFactory
	$dataObjectHelper
	$dataObjectProcessor
	$dataPageFactory

Detailed Description

Class PageRepository @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 25 of file PageRepository.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ResourcePage	$resource,
		PageFactory	$pageFactory,
		Data\PageInterfaceFactory	$dataPageFactory,
		PageCollectionFactory	$pageCollectionFactory,
		Data\PageSearchResultsInterfaceFactory	$searchResultsFactory,
		DataObjectHelper	$dataObjectHelper,
		DataObjectProcessor	$dataObjectProcessor,
		StoreManagerInterface	$storeManager,
		CollectionProcessorInterface	$collectionProcessor = null
	)

Parameters

ResourcePage	$resource
PageFactory	$pageFactory
Data\PageInterfaceFactory	$dataPageFactory
PageCollectionFactory	$pageCollectionFactory
Data\PageSearchResultsInterfaceFactory	$searchResultsFactory
DataObjectHelper	$dataObjectHelper
DataObjectProcessor	$dataObjectProcessor
StoreManagerInterface	$storeManager
CollectionProcessorInterface	$collectionProcessor

Definition at line 83 of file PageRepository.php.

      {
        $this->resource = $resource;
        $this->pageFactory = $pageFactory;
        $this->pageCollectionFactory = $pageCollectionFactory;
        $this->searchResultsFactory = $searchResultsFactory;
        $this->dataObjectHelper = $dataObjectHelper;
        $this->dataPageFactory = $dataPageFactory;
        $this->dataObjectProcessor = $dataObjectProcessor;
        $this->storeManager = $storeManager;
        $this->collectionProcessor = $collectionProcessor ?: $this->getCollectionProcessor();
    }

Member Function Documentation

delete()

delete

(

\Magento\Cms\Api\Data\PageInterface

$page

)

Delete Page

Parameters

\Magento\Cms\Api\Data\PageInterface

$page

Returns

bool

Exceptions

CouldNotDeleteException

Implements PageRepositoryInterface.

Definition at line 176 of file PageRepository.php.

    {
        try {
            $this->resource->delete($page);
        } catch (\Exception $exception) {
            throw new CouldNotDeleteException(__(
                'Could not delete the page: %1',
                $exception->getMessage()
            ));
        }
        return true;
    }

deleteById()

deleteById

(

$pageId

)

Delete Page by given Page Identity

Parameters

string

$pageId

Returns

bool

Exceptions

CouldNotDeleteException
NoSuchEntityException

Implements PageRepositoryInterface.

Definition at line 197 of file PageRepository.php.

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

getById()

getById

(

$pageId

)

Load Page data by given Page Identity

Parameters

string

$pageId

Returns

Page

Exceptions

Implements PageRepositoryInterface.

Definition at line 136 of file PageRepository.php.

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

save()

save

(

\Magento\Cms\Api\Data\PageInterface

$page

)

Save Page data

Parameters

\Magento\Cms\Api\Data\PageInterface

$page

Returns

Page

Exceptions

CouldNotSaveException

Implements PageRepositoryInterface.

Definition at line 112 of file PageRepository.php.

    {
        if ($page->getStoreId() === null) {
            $storeId = $this->storeManager->getStore()->getId();
            $page->setStoreId($storeId);
        }
        try {
            $this->resource->save($page);
        } catch (\Exception $exception) {
            throw new CouldNotSaveException(
                __('Could not save the page: %1', $exception->getMessage()),
                $exception
            );
        }
        return $page;
    }

Field Documentation

$dataObjectHelper

$dataObjectHelper

protected

Definition at line 50 of file PageRepository.php.

$dataObjectProcessor

$dataObjectProcessor

protected

Definition at line 55 of file PageRepository.php.

$dataPageFactory

$dataPageFactory

protected

Definition at line 60 of file PageRepository.php.

$pageCollectionFactory

$pageCollectionFactory

protected

Definition at line 40 of file PageRepository.php.

$pageFactory

$pageFactory

protected

Definition at line 35 of file PageRepository.php.

$resource

$resource

protected

Definition at line 30 of file PageRepository.php.

$searchResultsFactory

$searchResultsFactory

protected

Definition at line 45 of file PageRepository.php.

---

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

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