vendor/pimcore/pimcore/models/DataObject/Listing.php line 152

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Model\DataObject;
  18. use Pimcore\Model;
  19. use Pimcore\Model\Paginator\PaginateListingInterface;
  21. /**
  22.  * @method Model\DataObject[] load()
  23.  * @method Model\DataObject|false current()
  24.  * @method int getTotalCount()
  25.  * @method int getCount()
  26.  * @method int[] loadIdList()
  27.  * @method \Pimcore\Model\DataObject\Listing\Dao getDao()
  28.  * @method onCreateQueryBuilder(?callable $callback)
  29.  */
  30. class Listing extends Model\Listing\AbstractListing implements PaginateListingInterface
  31. {
  32.     /**
  33.      * @var bool
  34.      */
  35.     protected $unpublished = false;
  37.     /**
  38.      * @var array
  39.      */
  40.     protected $objectTypes = [Model\DataObject::OBJECT_TYPE_OBJECT, Model\DataObject::OBJECT_TYPE_FOLDER];
  42.     /**
  43.      * @return array
  44.      */
  45.     public function getObjects()
  46.     {
  47.         return $this->getData();
  48.     }
  50.     /**
  51.      * @param array $objects
  52.      *
  53.      * @return static
  54.      */
  55.     public function setObjects($objects)
  56.     {
  57.         return $this->setData($objects);
  58.     }
  60.     /**
  61.      * @return bool
  62.      */
  63.     public function getUnpublished()
  64.     {
  65.         return $this->unpublished;
  66.     }
  68.     /**
  69.      * @param bool $unpublished
  70.      *
  71.      * @return $this
  72.      */
  73.     public function setUnpublished($unpublished)
  74.     {
  75.         $this->setData(null);
  77.         $this->unpublished = (bool) $unpublished;
  79.         return $this;
  80.     }
  82.     /**
  83.      * @param array $objectTypes
  84.      *
  85.      * @return $this
  86.      */
  87.     public function setObjectTypes($objectTypes)
  88.     {
  89.         $this->setData(null);
  91.         $this->objectTypes = $objectTypes;
  93.         return $this;
  94.     }
  96.     /**
  97.      * @return array
  98.      */
  99.     public function getObjectTypes()
  100.     {
  101.         return $this->objectTypes;
  102.     }
  104.     /**
  105.      * @param string $key
  106.      * @param mixed $value
  107.      * @param string $concatenator
  108.      *
  109.      * @return $this
  110.      */
  111.     public function addConditionParam($key, $value = null, $concatenator = 'AND')
  112.     {
  113.         return parent::addConditionParam($key, $value, $concatenator); // TODO: Change the autogenerated stub
  114.     }
  116.     /**
  117.      * @return $this
  118.      */
  119.     public function resetConditionParams()
  120.     {
  121.         return parent::resetConditionParams(); // TODO: Change the autogenerated stub
  122.     }
  124.     /**
  125.      * @param string $condition
  126.      * @param array|scalar $conditionVariables
  127.      *
  128.      * @return $this
  129.      */
  130.     public function setCondition($condition, $conditionVariables = null)
  131.     {
  132.         return parent::setCondition($condition, $conditionVariables);
  133.     }
  135.     /**
  136.      *
  137.      * Methods for AdapterInterface
  138.      */
  140.     /**
  141.      * @return int
  142.      */
  143.     #[\ReturnTypeWillChange]
  144.     public function count()// : int
  145.     {
  146.         return $this->getDao()->getTotalCount();
  147.     }
  149.     /**
  150.      * {@inheritdoc}
  151.      */
  152.     public function getItems($offset, $itemCountPerPage)
  153.     {
  154.         $this->setOffset($offset);
  155.         $this->setLimit($itemCountPerPage);
  157.         return $this->load();
  158.     }
  160.     /**
  161.      * @internal
  162.      *
  163.      * @return bool
  164.      */
  165.     public function addDistinct()
  166.     {
  167.         return false;
  168.     }
  170.     /**
  171.      * @internal
  172.      *
  173.      * @param string $field database column to use for WHERE condition
  174.      * @param string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"
  175.      * @param string|int|float|array $data comparison data, can be scalar or array (if operator is e.g. "IN (?)")
  176.      *
  177.      * @return static
  178.      */
  179.     public function addFilterByField($field, $operator, $data)
  180.     {
  181.         if (strpos($operator, '?') === false) {
  182.             $operator .= ' ?';
  183.         }
  185.         return $this->addConditionParam('`'.$field.'` '.$operator, $data);
  186.     }
  187. }