var/classes/DataObject/News.php line 114

Open in your IDE?
  1. <?php
  3. /**
  4. * Inheritance: yes
  5. * Variants: yes
  8. Fields Summary:
  9. - localizedfields [localizedfields]
  10. -- title [input]
  11. -- shortText [textarea]
  12. - content [fieldcollections]
  13. - date [datetime]
  14. - gallery [imageGallery]
  15. - completenessPercentage [numeric]
  16. - specificAttributes [objectbricks]
  17. - listData [table]
  18. - specificStore [classificationstore]
  19. */
  21. namespace Pimcore\Model\DataObject;
  23. use Pimcore\Model\DataObject\Exception\InheritanceParentNotFoundException;
  24. use Pimcore\Model\DataObject\PreGetValueHookInterface;
  26. /**
  27. * @method static \Pimcore\Model\DataObject\News\Listing getList(array $config = [])
  28. * @method static \Pimcore\Model\DataObject\News\Listing|\Pimcore\Model\DataObject\News|null getByLocalizedfields($field, $value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)
  29. * @method static \Pimcore\Model\DataObject\News\Listing|\Pimcore\Model\DataObject\News|null getByTitle($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)
  30. * @method static \Pimcore\Model\DataObject\News\Listing|\Pimcore\Model\DataObject\News|null getByShortText($value, $locale = null, $limit = 0, $offset = 0, $objectTypes = null)
  31. * @method static \Pimcore\Model\DataObject\News\Listing|\Pimcore\Model\DataObject\News|null getByDate($value, $limit = 0, $offset = 0, $objectTypes = null)
  32. * @method static \Pimcore\Model\DataObject\News\Listing|\Pimcore\Model\DataObject\News|null getByCompletenessPercentage($value, $limit = 0, $offset = 0, $objectTypes = null)
  33. */
  35. class News extends Concrete
  36. {
  37. protected $o_classId = "NE";
  38. protected $o_className = "News";
  39. protected $localizedfields;
  40. protected $content;
  41. protected $date;
  42. protected $gallery;
  43. protected $completenessPercentage;
  44. protected $specificAttributes;
  45. protected $listData;
  46. protected $specificStore;
  49. /**
  50. * @param array $values
  51. * @return \Pimcore\Model\DataObject\News
  52. */
  53. public static function create($values = array()) {
  54.     $object = new static();
  55.     $object->setValues($values);
  56.     return $object;
  57. }
  59. /**
  60. * Get localizedfields - 
  61. * @return \Pimcore\Model\DataObject\Localizedfield|null
  62. */
  63. public function getLocalizedfields(): ?\Pimcore\Model\DataObject\Localizedfield
  64. {
  65.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  66.         $preValue = $this->preGetValue("localizedfields");
  67.         if ($preValue !== null) {
  68.             return $preValue;
  69.         }
  70.     }
  72.     $data = $this->getClass()->getFieldDefinition("localizedfields")->preGetData($this);
  74.     if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("localizedfields")->isEmpty($data)) {
  75.         try {
  76.             return $this->getValueFromParent("localizedfields");
  77.         } catch (InheritanceParentNotFoundException $e) {
  78.             // no data from parent available, continue ...
  79.         }
  80.     }
  82.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  83.         return $data->getPlain();
  84.     }
  86.     return $data;
  87. }
  89. /**
  90. * Get title - Title
  91. * @return string|null
  92. */
  93. public function getTitle($language = null): ?string
  94. {
  95.     $data = $this->getLocalizedfields()->getLocalizedValue("title", $language);
  96.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  97.         $preValue = $this->preGetValue("title");
  98.         if ($preValue !== null) {
  99.             return $preValue;
  100.         }
  101.     }
  103.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  104.         return $data->getPlain();
  105.     }
  107.     return $data;
  108. }
  110. /**
  111. * Get shortText - Short Text
  112. * @return string|null
  113. */
  114. public function getShortText($language = null): ?string
  115. {
  116.     $data = $this->getLocalizedfields()->getLocalizedValue("shortText", $language);
  117.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  118.         $preValue = $this->preGetValue("shortText");
  119.         if ($preValue !== null) {
  120.             return $preValue;
  121.         }
  122.     }
  124.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  125.         return $data->getPlain();
  126.     }
  128.     return $data;
  129. }
  131. /**
  132. * Set localizedfields - 
  133. * @param \Pimcore\Model\DataObject\Localizedfield|null $localizedfields
  134. * @return \Pimcore\Model\DataObject\News
  135. */
  136. public function setLocalizedfields(?\Pimcore\Model\DataObject\Localizedfield $localizedfields)
  137. {
  138.     $inheritValues = self::getGetInheritedValues();
  139.     self::setGetInheritedValues(false);
  140.     $hideUnpublished = \Pimcore\Model\DataObject\Concrete::getHideUnpublished();
  141.     \Pimcore\Model\DataObject\Concrete::setHideUnpublished(false);
  142.     $currentData = $this->getLocalizedfields();
  143.     \Pimcore\Model\DataObject\Concrete::setHideUnpublished($hideUnpublished);
  144.     self::setGetInheritedValues($inheritValues);
  145.     $this->markFieldDirty("localizedfields", true);
  146.     $this->localizedfields = $localizedfields;
  148.     return $this;
  149. }
  151. /**
  152. * Set title - Title
  153. * @param string|null $title
  154. * @return \Pimcore\Model\DataObject\News
  155. */
  156. public function setTitle (?string $title, $language = null)
  157. {
  158.     $isEqual = false;
  159.     $this->getLocalizedfields()->setLocalizedValue("title", $title, $language, !$isEqual);
  161.     return $this;
  162. }
  164. /**
  165. * Set shortText - Short Text
  166. * @param string|null $shortText
  167. * @return \Pimcore\Model\DataObject\News
  168. */
  169. public function setShortText (?string $shortText, $language = null)
  170. {
  171.     $isEqual = false;
  172.     $this->getLocalizedfields()->setLocalizedValue("shortText", $shortText, $language, !$isEqual);
  174.     return $this;
  175. }
  177. /**
  178. * @return \Pimcore\Model\DataObject\Fieldcollection|null
  179. */
  180. public function getContent()
  181. {
  182.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  183.         $preValue = $this->preGetValue("content");
  184.         if ($preValue !== null) {
  185.             return $preValue;
  186.         }
  187.     }
  189.     $data = $this->getClass()->getFieldDefinition("content")->preGetData($this);
  190.     return $data;
  191. }
  193. /**
  194. * Set content - Content
  195. * @param \Pimcore\Model\DataObject\Fieldcollection|null $content
  196. * @return \Pimcore\Model\DataObject\News
  197. */
  198. public function setContent(?\Pimcore\Model\DataObject\Fieldcollection $content)
  199. {
  200.     /** @var \Pimcore\Model\DataObject\ClassDefinition\Data\Fieldcollections $fd */
  201.     $fd = $this->getClass()->getFieldDefinition("content");
  202.     $this->content = $fd->preSetData($this, $content);
  203.     return $this;
  204. }
  206. /**
  207. * Get date - Date
  208. * @return \Carbon\Carbon|null
  209. */
  210. public function getDate(): ?\Carbon\Carbon
  211. {
  212.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  213.         $preValue = $this->preGetValue("date");
  214.         if ($preValue !== null) {
  215.             return $preValue;
  216.         }
  217.     }
  219.     $data = $this->date;
  221.     if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("date")->isEmpty($data)) {
  222.         try {
  223.             return $this->getValueFromParent("date");
  224.         } catch (InheritanceParentNotFoundException $e) {
  225.             // no data from parent available, continue ...
  226.         }
  227.     }
  229.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  230.         return $data->getPlain();
  231.     }
  233.     return $data;
  234. }
  236. /**
  237. * Set date - Date
  238. * @param \Carbon\Carbon|null $date
  239. * @return \Pimcore\Model\DataObject\News
  240. */
  241. public function setDate(?\Carbon\Carbon $date)
  242. {
  243.     $this->date = $date;
  245.     return $this;
  246. }
  248. /**
  249. * Get gallery - Gallery
  250. * @return \Pimcore\Model\DataObject\Data\ImageGallery|null
  251. */
  252. public function getGallery(): ?\Pimcore\Model\DataObject\Data\ImageGallery
  253. {
  254.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  255.         $preValue = $this->preGetValue("gallery");
  256.         if ($preValue !== null) {
  257.             return $preValue;
  258.         }
  259.     }
  261.     $data = $this->gallery;
  263.     if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("gallery")->isEmpty($data)) {
  264.         try {
  265.             return $this->getValueFromParent("gallery");
  266.         } catch (InheritanceParentNotFoundException $e) {
  267.             // no data from parent available, continue ...
  268.         }
  269.     }
  271.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  272.         return $data->getPlain();
  273.     }
  275.     return $data;
  276. }
  278. /**
  279. * Set gallery - Gallery
  280. * @param \Pimcore\Model\DataObject\Data\ImageGallery|null $gallery
  281. * @return \Pimcore\Model\DataObject\News
  282. */
  283. public function setGallery(?\Pimcore\Model\DataObject\Data\ImageGallery $gallery)
  284. {
  285.     $this->gallery = $gallery;
  287.     return $this;
  288. }
  290. /**
  291. * Get completenessPercentage - Completeness %
  292. * @return float|null
  293. */
  294. public function getCompletenessPercentage(): ?float
  295. {
  296.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  297.         $preValue = $this->preGetValue("completenessPercentage");
  298.         if ($preValue !== null) {
  299.             return $preValue;
  300.         }
  301.     }
  303.     $data = $this->completenessPercentage;
  305.     if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("completenessPercentage")->isEmpty($data)) {
  306.         try {
  307.             return $this->getValueFromParent("completenessPercentage");
  308.         } catch (InheritanceParentNotFoundException $e) {
  309.             // no data from parent available, continue ...
  310.         }
  311.     }
  313.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  314.         return $data->getPlain();
  315.     }
  317.     return $data;
  318. }
  320. /**
  321. * Set completenessPercentage - Completeness %
  322. * @param float|null $completenessPercentage
  323. * @return \Pimcore\Model\DataObject\News
  324. */
  325. public function setCompletenessPercentage(?float $completenessPercentage)
  326. {
  327.     /** @var \Pimcore\Model\DataObject\ClassDefinition\Data\Numeric $fd */
  328.     $fd = $this->getClass()->getFieldDefinition("completenessPercentage");
  329.     $this->completenessPercentage = $fd->preSetData($this, $completenessPercentage);
  330.     return $this;
  331. }
  333. /**
  334. * @return \Pimcore\Model\DataObject\News\SpecificAttributes
  335. */
  336. public function getSpecificAttributes(): ?\Pimcore\Model\DataObject\Objectbrick
  337. {
  338.     $data = $this->specificAttributes;
  339.     if (!$data) {
  340.         if (\Pimcore\Tool::classExists("\\Pimcore\\Model\\DataObject\\News\\SpecificAttributes")) {
  341.             $data = new \Pimcore\Model\DataObject\News\SpecificAttributes($this, "specificAttributes");
  342.             $this->specificAttributes = $data;
  343.         } else {
  344.             return null;
  345.         }
  346.     }
  347.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  348.         $preValue = $this->preGetValue("specificAttributes");
  349.         if ($preValue !== null) {
  350.             return $preValue;
  351.         }
  352.     }
  354.     return $data;
  355. }
  357. /**
  358. * Set specificAttributes - Specific Attributes
  359. * @param \Pimcore\Model\DataObject\Objectbrick|null $specificAttributes
  360. * @return \Pimcore\Model\DataObject\News
  361. */
  362. public function setSpecificAttributes(?\Pimcore\Model\DataObject\Objectbrick $specificAttributes)
  363. {
  364.     /** @var \Pimcore\Model\DataObject\ClassDefinition\Data\Objectbricks $fd */
  365.     $fd = $this->getClass()->getFieldDefinition("specificAttributes");
  366.     $this->specificAttributes = $fd->preSetData($this, $specificAttributes);
  367.     return $this;
  368. }
  370. /**
  371. * Get listData - List
  372. * @return array
  373. */
  374. public function getListData(): array
  375. {
  376.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  377.         $preValue = $this->preGetValue("listData");
  378.         if ($preValue !== null) {
  379.             return $preValue;
  380.         }
  381.     }
  383.     $data = $this->listData;
  385.     if(\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("listData")->isEmpty($data)) {
  386.         try {
  387.             return $this->getValueFromParent("listData");
  388.         } catch (InheritanceParentNotFoundException $e) {
  389.             // no data from parent available, continue ...
  390.         }
  391.     }
  393.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  394.         return $data->getPlain() ?? [];
  395.     }
  397.     return $data ?? [];
  398. }
  400. /**
  401. * Set listData - List
  402. * @param ?array $listData
  403. * @return \Pimcore\Model\DataObject\News
  404. */
  405. public function setListData(?array $listData)
  406. {
  407.     $this->listData = $listData;
  409.     return $this;
  410. }
  412. /**
  413. * Get specificStore - Store Data
  414. * @return \Pimcore\Model\DataObject\Classificationstore|null
  415. */
  416. public function getSpecificStore(): ?\Pimcore\Model\DataObject\Classificationstore
  417. {
  418.     if ($this instanceof PreGetValueHookInterface && !\Pimcore::inAdmin()) {
  419.         $preValue = $this->preGetValue("specificStore");
  420.         if ($preValue !== null) {
  421.             return $preValue;
  422.         }
  423.     }
  425.     $data = $this->getClass()->getFieldDefinition("specificStore")->preGetData($this);
  427.     if (\Pimcore\Model\DataObject::doGetInheritedValues() && $this->getClass()->getFieldDefinition("specificStore")->isEmpty($data)) {
  428.         try {
  429.             return $this->getValueFromParent("specificStore");
  430.         } catch (InheritanceParentNotFoundException $e) {
  431.             // no data from parent available, continue ...
  432.         }
  433.     }
  435.     if ($data instanceof \Pimcore\Model\DataObject\Data\EncryptedField) {
  436.         return $data->getPlain();
  437.     }
  439.     return $data;
  440. }
  442. /**
  443. * Set specificStore - Store Data
  444. * @param \Pimcore\Model\DataObject\Classificationstore|null $specificStore
  445. * @return \Pimcore\Model\DataObject\News
  446. */
  447. public function setSpecificStore(?\Pimcore\Model\DataObject\Classificationstore $specificStore)
  448. {
  449.     $this->specificStore = $specificStore;
  451.     return $this;
  452. }
  454. }