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

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 $this
  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. * @return $this
  106. */
  107. public function resetConditionParams()
  108. {
  109. return parent::resetConditionParams(); // TODO: Change the autogenerated stub
  110. }
  112. /**
  113. * @param string $condition
  114. * @param array|scalar $conditionVariables
  115. *
  116. * @return $this
  117. */
  118. public function setCondition($condition, $conditionVariables = null)
  119. {
  120. return parent::setCondition($condition, $conditionVariables);
  121. }
  123. /**
  124. *
  125. * Methods for AdapterInterface
  126. */
  128. /**
  129. * @return int
  130. */
  131. #[\ReturnTypeWillChange]
  132. public function count()// : int
  133. {
  134. return $this->getDao()->getTotalCount();
  135. }
  137. /**
  138. * {@inheritdoc}
  139. */
  140. public function getItems($offset, $itemCountPerPage)
  141. {
  142. $this->setOffset($offset);
  143. $this->setLimit($itemCountPerPage);
  145. return $this->load();
  146. }
  148. /**
  149. * @internal
  150. *
  151. * @return bool
  152. */
  153. public function addDistinct()
  154. {
  155. return false;
  156. }
  158. /**
  159. * @internal
  160. *
  161. * @param string $field database column to use for WHERE condition
  162. * @param string $operator SQL comparison operator, e.g. =, <, >= etc. You can use "?" as placeholder, e.g. "IN (?)"
  163. * @param string|int|float|array $data comparison data, can be scalar or array (if operator is e.g. "IN (?)")
  164. *
  165. * @return $this
  166. */
  167. public function addFilterByField($field, $operator, $data)
  168. {
  169. if (strpos($operator, '?') === false) {
  170. $operator .= ' ?';
  171. }
  173. return $this->addConditionParam('`'.$field.'` '.$operator, $data);
  174. }
  175. }