vendor/pimcore/pimcore/models/Document/Editable/Checkbox.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 Checkbox extends Model\Document\Editable
  26. {
  27.     /**
  28.      * Contains the checkbox value
  29.      *
  30.      * @var bool
  31.      */
  32.     public $value = false;
  34.     /**
  35.      * @see EditableInterface::getType
  36.      *
  37.      * @return string
  38.      */
  39.     public function getType()
  40.     {
  41.         return 'checkbox';
  42.     }
  44.     /**
  45.      * @see EditableInterface::getData
  46.      *
  47.      * @return mixed
  48.      */
  49.     public function getData()
  50.     {
  51.         return $this->value;
  52.     }
  54.     /**
  55.      * @see EditableInterface::frontend
  56.      *
  57.      * @return string
  58.      */
  59.     public function frontend()
  60.     {
  61.         return (string)$this->value;
  62.     }
  64.     /**
  65.      * @see EditableInterface::setDataFromResource
  66.      *
  67.      * @param mixed $data
  68.      *
  69.      * @return $this
  70.      */
  71.     public function setDataFromResource($data)
  72.     {
  73.         $this->value = (bool) $data;
  75.         return $this;
  76.     }
  78.     /**
  79.      * @see EditableInterface::setDataFromEditmode
  80.      *
  81.      * @param mixed $data
  82.      *
  83.      * @return $this
  84.      */
  85.     public function setDataFromEditmode($data)
  86.     {
  87.         $this->value = (bool) $data;
  89.         return $this;
  90.     }
  92.     /**
  93.      * @return bool
  94.      */
  95.     public function isEmpty()
  96.     {
  97.         return !$this->value;
  98.     }
  100.     /**
  101.      * @return bool
  102.      */
  103.     public function isChecked()
  104.     {
  105.         return $this->value;
  106.     }
  108.     /**
  109.      * @deprecated
  110.      *
  111.      * @param Model\Webservice\Data\Document\Element $wsElement
  112.      * @param Model\Document\PageSnippet $document
  113.      * @param array $params
  114.      * @param Model\Webservice\IdMapperInterface|null $idMapper
  115.      *
  116.      * @throws \Exception
  117.      *
  118.      */
  119.     public function getFromWebserviceImport($wsElement, $document = null, $params = [], $idMapper = null)
  120.     {
  121.         $data = $this->sanitizeWebserviceData($wsElement->value);
  122.         if ($data->bool === null || is_bool($data)) {
  123.             $this->value = (bool) $data->value;
  124.         } else {
  125.             throw new \Exception('cannot get values from web service import - invalid data');
  126.         }
  127.     }
  128. }
  130. class_alias(Checkbox::class, 'Pimcore\Model\Document\Tag\Checkbox');