Warning: You are browsing the documentation for PrestaShop 1.7, which is outdated.

You might want to read an updated version of this page for the current version, PrestaShop 8. Read the updated version of this page

Learn how to upgrade to the latest version.

CmsPage domain

CmsPage Commands

AddCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\AddCmsPageCommand Adds new cms page

Command details
Constructor parameters
  • $int $cmsPageCategoryId
  • $array $localizedTitle
  • $array $localizedMetaTitle
  • $array $localizedMetaDescription
  • $array $LocalizedMetaKeyword
  • $array $localizedFriendlyUrl
  • $array $localizedContent
  • $bool $indexedForSearch
  • $bool $displayed
  • $array $shopAssociation
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\AddCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\AddCmsPageHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\CmsPage\ValueObject\CmsPageId

BulkDeleteCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\BulkDeleteCmsPageCommand Deletes multiple cms pages according to given array.

Command details
Constructor parameters
  • $array $cmsPageIds
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\BulkDeleteCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\BulkDeleteCmsPageHandlerInterface
Return type void

BulkDisableCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\BulkDisableCmsPageCommand Disables multiple cms pages.

Command details
Constructor parameters
  • $array $cmsPageIds
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\BulkDisableCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\BulkDisableCmsPageHandlerInterface
Return type void

BulkEnableCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\BulkEnableCmsPageCommand Enables multiple cms pages.

Command details
Constructor parameters
  • $array $cmsPageIds
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\BulkEnableCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\BulkEnableCmsPageHandlerInterface
Return type void

DeleteCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\DeleteCmsPageCommand Deletes given cms page.

Command details
Constructor parameters
  • $int $cmsPageId
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\DeleteCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\DeleteCmsPageHandlerInterface
Return type void

EditCmsPageCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\EditCmsPageCommand Edits cms page

Command details
Constructor parameters
  • $int $cmsPageId
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\EditCmsPageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\EditCmsPageHandlerInterface
Return type void

ToggleCmsPageStatusCommand

PrestaShop\PrestaShop\Core\Domain\CmsPage\Command\ToggleCmsPageStatusCommand Changes the status of cms page.

Command details
Constructor parameters
  • $int $cmsPageId
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\CommandHandler\ToggleCmsPageStatusHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\CommandHandler\ToggleCmsPageStatusHandlerInterface
Return type void

CmsPage Queries

GetCmsCategoryIdForRedirection

PrestaShop\PrestaShop\Core\Domain\CmsPage\Query\GetCmsCategoryIdForRedirection This class is used for getting the id which is used later on to redirect to the right page after certain controller actions.

Query details
Constructor parameters
  • $int $cmsPageId
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\QueryHandler\GetCmsCategoryIdForRedirectionHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\QueryHandler\GetCmsCategoryIdHandlerForRedirectionInterface
Return type PrestaShop\PrestaShop\Core\Domain\CmsPageCategory\ValueObject\CmsPageCategoryId

GetCmsPageForEditing

PrestaShop\PrestaShop\Core\Domain\CmsPage\Query\GetCmsPageForEditing Gets object which transfers cms page data for editing

Query details
Constructor parameters
  • $int $cmsPageId
Handler class PrestaShop\PrestaShop\Adapter\CMS\Page\QueryHandler\GetCmsPageForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\CmsPage\QueryHandler\GetCmsPageForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\CmsPage\QueryResult\EditableCmsPage