vendor/pimcore/pimcore/models/Document/Editable/Date.php line 25

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Enterprise License (PEL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  * @category   Pimcore
  12.  * @package    Document
  13.  *
  14.  * @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15.  * @license    http://www.pimcore.org/license     GPLv3 and PEL
  16.  */
  18. namespace Pimcore\Model\Document\Editable;
  20. use Pimcore\Model;
  22. /**
  23.  * @method \Pimcore\Model\Document\Editable\Dao getDao()
  24.  */
  25. class Date extends Model\Document\Editable
  26. {
  27.     /**
  28.      * Contains the date
  29.      *
  30.      * @var \Carbon\Carbon|null
  31.      */
  32.     public $date;
  34.     /**
  35.      * @see EditableInterface::getType
  36.      *
  37.      * @return string
  38.      */
  39.     public function getType()
  40.     {
  41.         return 'date';
  42.     }
  44.     /**
  45.      * @see EditableInterface::getData
  46.      *
  47.      * @return mixed
  48.      */
  49.     public function getData()
  50.     {
  51.         return $this->date;
  52.     }
  54.     /**
  55.      * Converts the data so it's suitable for the editmode
  56.      *
  57.      * @return int|null
  58.      */
  59.     public function getDataEditmode()
  60.     {
  61.         if ($this->date) {
  62.             return $this->date->getTimestamp();
  63.         }
  65.         return null;
  66.     }
  68.     /**
  69.      * @see EditableInterface::frontend
  70.      */
  71.     public function frontend()
  72.     {
  73.         $format = null;
  75.         if (isset($this->config['outputFormat']) && $this->config['outputFormat']) {
  76.             $format = $this->config['outputFormat'];
  77.         } elseif (isset($this->config['format']) && $this->config['format']) {
  78.             $format = $this->config['format'];
  79.         } else {
  80.             $format = \DateTime::ISO8601;
  81.         }
  83.         if ($this->date instanceof \DateTimeInterface) {
  84.             return $this->date->formatLocalized($format);
  85.         }
  86.     }
  88.     /**
  89.      * @see Tag::getDataForResource
  90.      *
  91.      * @return int|null
  92.      */
  93.     public function getDataForResource()
  94.     {
  95.         if ($this->date) {
  96.             return $this->date->getTimestamp();
  97.         }
  99.         return null;
  100.     }
  102.     /**
  103.      * @see EditableInterface::setDataFromResource
  104.      *
  105.      * @param mixed $data
  106.      *
  107.      * @return $this
  108.      */
  109.     public function setDataFromResource($data)
  110.     {
  111.         if ($data) {
  112.             $this->setDateFromTimestamp($data);
  113.         }
  115.         return $this;
  116.     }
  118.     /**
  119.      * @see EditableInterface::setDataFromEditmode
  120.      *
  121.      * @param mixed $data
  122.      *
  123.      * @return $this
  124.      */
  125.     public function setDataFromEditmode($data)
  126.     {
  127.         if (strlen($data) > 5) {
  128.             $timestamp = strtotime($data);
  129.             $this->setDateFromTimestamp($timestamp);
  130.         }
  132.         return $this;
  133.     }
  135.     /**
  136.      * @return bool
  137.      */
  138.     public function isEmpty()
  139.     {
  140.         if ($this->date) {
  141.             return false;
  142.         }
  144.         return true;
  145.     }
  147.     /**
  148.      * Receives a Webservice\Data\Document\Element from webservice import and fill the current tag's data
  149.      *
  150.      * @deprecated
  151.      *
  152.      * @param Model\Webservice\Data\Document\Element $wsElement
  153.      * @param Model\Document\PageSnippet $document
  154.      * @param array $params
  155.      * @param Model\Webservice\IdMapperInterface|null $idMapper
  156.      *
  157.      * @throws \Exception
  158.      */
  159.     public function getFromWebserviceImport($wsElement, $document = null, $params = [], $idMapper = null)
  160.     {
  161.         if (!$wsElement or empty($wsElement->value)) {
  162.             $this->date = null;
  163.         } elseif (is_numeric($wsElement->value)) {
  164.             $this->setDateFromTimestamp($wsElement->value);
  165.         } else {
  166.             throw new \Exception('cannot get document tag date from WS - invalid value [  '.$wsElement->value.' ]');
  167.         }
  168.     }
  170.     /**
  171.      * Returns the current tag's data for web service export
  172.      *
  173.      * @deprecated
  174.      *
  175.      * @param Model\Document\PageSnippet|null $document
  176.      * @param array $params
  177.      * @abstract
  178.      *
  179.      * @return int|null
  180.      */
  181.     public function getForWebserviceExport($document = null, $params = [])
  182.     {
  183.         if ($this->date) {
  184.             return $this->date->getTimestamp();
  185.         } else {
  186.             return null;
  187.         }
  188.     }
  190.     /**
  191.      * @param int $timestamp
  192.      */
  193.     protected function setDateFromTimestamp($timestamp)
  194.     {
  195.         $this->date = new \Carbon\Carbon();
  196.         $this->date->setTimestamp($timestamp);
  197.     }
  198. }
  200. class_alias(Date::class, 'Pimcore\Model\Document\Tag\Date');