PageInterface.php 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Cms\Api\Data;
  7. /**
  8. * CMS page interface.
  9. * @api
  10. * @since 100.0.2
  11. */
  12. interface PageInterface
  13. {
  14. /**#@+
  15. * Constants for keys of data array. Identical to the name of the getter in snake case
  16. */
  17. const PAGE_ID = 'page_id';
  18. const IDENTIFIER = 'identifier';
  19. const TITLE = 'title';
  20. const PAGE_LAYOUT = 'page_layout';
  21. const META_TITLE = 'meta_title';
  22. const META_KEYWORDS = 'meta_keywords';
  23. const META_DESCRIPTION = 'meta_description';
  24. const CONTENT_HEADING = 'content_heading';
  25. const CONTENT = 'content';
  26. const CREATION_TIME = 'creation_time';
  27. const UPDATE_TIME = 'update_time';
  28. const SORT_ORDER = 'sort_order';
  29. const LAYOUT_UPDATE_XML = 'layout_update_xml';
  30. const CUSTOM_THEME = 'custom_theme';
  31. const CUSTOM_ROOT_TEMPLATE = 'custom_root_template';
  32. const CUSTOM_LAYOUT_UPDATE_XML = 'custom_layout_update_xml';
  33. const CUSTOM_THEME_FROM = 'custom_theme_from';
  34. const CUSTOM_THEME_TO = 'custom_theme_to';
  35. const IS_ACTIVE = 'is_active';
  36. /**#@-*/
  37. /**
  38. * Get ID
  39. *
  40. * @return int|null
  41. */
  42. public function getId();
  43. /**
  44. * Get identifier
  45. *
  46. * @return string
  47. */
  48. public function getIdentifier();
  49. /**
  50. * Get title
  51. *
  52. * @return string|null
  53. */
  54. public function getTitle();
  55. /**
  56. * Get page layout
  57. *
  58. * @return string|null
  59. */
  60. public function getPageLayout();
  61. /**
  62. * Get meta title
  63. *
  64. * @return string|null
  65. * @since 101.0.0
  66. */
  67. public function getMetaTitle();
  68. /**
  69. * Get meta keywords
  70. *
  71. * @return string|null
  72. */
  73. public function getMetaKeywords();
  74. /**
  75. * Get meta description
  76. *
  77. * @return string|null
  78. */
  79. public function getMetaDescription();
  80. /**
  81. * Get content heading
  82. *
  83. * @return string|null
  84. */
  85. public function getContentHeading();
  86. /**
  87. * Get content
  88. *
  89. * @return string|null
  90. */
  91. public function getContent();
  92. /**
  93. * Get creation time
  94. *
  95. * @return string|null
  96. */
  97. public function getCreationTime();
  98. /**
  99. * Get update time
  100. *
  101. * @return string|null
  102. */
  103. public function getUpdateTime();
  104. /**
  105. * Get sort order
  106. *
  107. * @return string|null
  108. */
  109. public function getSortOrder();
  110. /**
  111. * Get layout update xml
  112. *
  113. * @return string|null
  114. */
  115. public function getLayoutUpdateXml();
  116. /**
  117. * Get custom theme
  118. *
  119. * @return string|null
  120. */
  121. public function getCustomTheme();
  122. /**
  123. * Get custom root template
  124. *
  125. * @return string|null
  126. */
  127. public function getCustomRootTemplate();
  128. /**
  129. * Get custom layout update xml
  130. *
  131. * @return string|null
  132. */
  133. public function getCustomLayoutUpdateXml();
  134. /**
  135. * Get custom theme from
  136. *
  137. * @return string|null
  138. */
  139. public function getCustomThemeFrom();
  140. /**
  141. * Get custom theme to
  142. *
  143. * @return string|null
  144. */
  145. public function getCustomThemeTo();
  146. /**
  147. * Is active
  148. *
  149. * @return bool|null
  150. */
  151. public function isActive();
  152. /**
  153. * Set ID
  154. *
  155. * @param int $id
  156. * @return \Magento\Cms\Api\Data\PageInterface
  157. */
  158. public function setId($id);
  159. /**
  160. * Set identifier
  161. *
  162. * @param string $identifier
  163. * @return \Magento\Cms\Api\Data\PageInterface
  164. */
  165. public function setIdentifier($identifier);
  166. /**
  167. * Set title
  168. *
  169. * @param string $title
  170. * @return \Magento\Cms\Api\Data\PageInterface
  171. */
  172. public function setTitle($title);
  173. /**
  174. * Set page layout
  175. *
  176. * @param string $pageLayout
  177. * @return \Magento\Cms\Api\Data\PageInterface
  178. */
  179. public function setPageLayout($pageLayout);
  180. /**
  181. * Set meta title
  182. *
  183. * @param string $metaTitle
  184. * @return \Magento\Cms\Api\Data\PageInterface
  185. * @since 101.0.0
  186. */
  187. public function setMetaTitle($metaTitle);
  188. /**
  189. * Set meta keywords
  190. *
  191. * @param string $metaKeywords
  192. * @return \Magento\Cms\Api\Data\PageInterface
  193. */
  194. public function setMetaKeywords($metaKeywords);
  195. /**
  196. * Set meta description
  197. *
  198. * @param string $metaDescription
  199. * @return \Magento\Cms\Api\Data\PageInterface
  200. */
  201. public function setMetaDescription($metaDescription);
  202. /**
  203. * Set content heading
  204. *
  205. * @param string $contentHeading
  206. * @return \Magento\Cms\Api\Data\PageInterface
  207. */
  208. public function setContentHeading($contentHeading);
  209. /**
  210. * Set content
  211. *
  212. * @param string $content
  213. * @return \Magento\Cms\Api\Data\PageInterface
  214. */
  215. public function setContent($content);
  216. /**
  217. * Set creation time
  218. *
  219. * @param string $creationTime
  220. * @return \Magento\Cms\Api\Data\PageInterface
  221. */
  222. public function setCreationTime($creationTime);
  223. /**
  224. * Set update time
  225. *
  226. * @param string $updateTime
  227. * @return \Magento\Cms\Api\Data\PageInterface
  228. */
  229. public function setUpdateTime($updateTime);
  230. /**
  231. * Set sort order
  232. *
  233. * @param string $sortOrder
  234. * @return \Magento\Cms\Api\Data\PageInterface
  235. */
  236. public function setSortOrder($sortOrder);
  237. /**
  238. * Set layout update xml
  239. *
  240. * @param string $layoutUpdateXml
  241. * @return \Magento\Cms\Api\Data\PageInterface
  242. */
  243. public function setLayoutUpdateXml($layoutUpdateXml);
  244. /**
  245. * Set custom theme
  246. *
  247. * @param string $customTheme
  248. * @return \Magento\Cms\Api\Data\PageInterface
  249. */
  250. public function setCustomTheme($customTheme);
  251. /**
  252. * Set custom root template
  253. *
  254. * @param string $customRootTemplate
  255. * @return \Magento\Cms\Api\Data\PageInterface
  256. */
  257. public function setCustomRootTemplate($customRootTemplate);
  258. /**
  259. * Set custom layout update xml
  260. *
  261. * @param string $customLayoutUpdateXml
  262. * @return \Magento\Cms\Api\Data\PageInterface
  263. */
  264. public function setCustomLayoutUpdateXml($customLayoutUpdateXml);
  265. /**
  266. * Set custom theme from
  267. *
  268. * @param string $customThemeFrom
  269. * @return \Magento\Cms\Api\Data\PageInterface
  270. */
  271. public function setCustomThemeFrom($customThemeFrom);
  272. /**
  273. * Set custom theme to
  274. *
  275. * @param string $customThemeTo
  276. * @return \Magento\Cms\Api\Data\PageInterface
  277. */
  278. public function setCustomThemeTo($customThemeTo);
  279. /**
  280. * Set is active
  281. *
  282. * @param int|bool $isActive
  283. * @return \Magento\Cms\Api\Data\PageInterface
  284. */
  285. public function setIsActive($isActive);
  286. }