vendor/pimcore/pimcore/models/Document/Listing.php line 32

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\Document;
  18. use Pimcore\Model;
  19. use Pimcore\Model\Document;
  20. use Pimcore\Model\Paginator\PaginateListingInterface;
  22. /**
  23.  * @method Document[] load()
  24.  * @method Document current()
  25.  * @method int getTotalCount()
  26.  * @method int getCount()
  27.  * @method int[] loadIdList()
  28.  * @method \Pimcore\Model\Document\Listing\Dao getDao()
  29.  * @method onCreateQueryBuilder(?callable $callback)
  30.  * @method array loadIdPathList()
  31.  */
  32. class Listing extends Model\Listing\AbstractListing implements PaginateListingInterface
  33. {
  34.     /**
  35.      * Return all documents as Type Document. eg. for trees an so on there isn't the whole data required
  36.      *
  37.      * @internal
  38.      *
  39.      * @var bool
  40.      */
  41.     protected $objectTypeDocument = false;
  43.     /**
  44.      * @internal
  45.      *
  46.      * @var bool
  47.      */
  48.     protected $unpublished = false;
  50.     /**
  51.      * @return Document[]
  52.      */
  53.     public function getDocuments()
  54.     {
  55.         return $this->getData();
  56.     }
  58.     /**
  59.      * @param array $documents
  60.      *
  61.      * @return Listing
  62.      */
  63.     public function setDocuments($documents)
  64.     {
  65.         return $this->setData($documents);
  66.     }
  68.     /**
  69.      * Checks if the document is unpublished.
  70.      *
  71.      * @return bool
  72.      */
  73.     public function getUnpublished()
  74.     {
  75.         return $this->unpublished;
  76.     }
  78.     /**
  79.      * Set the unpublished flag for the document.
  80.      *
  81.      * @param bool $unpublished
  82.      *
  83.      * @return $this
  84.      */
  85.     public function setUnpublished($unpublished)
  86.     {
  87.         $this->unpublished = (bool) $unpublished;
  89.         return $this;
  90.     }
  92.     /**
  93.      * {@inheritdoc}
  94.      */
  95.     public function getCondition()
  96.     {
  97.         $condition = parent::getCondition();
  99.         if ($condition) {
  100.             if (Document::doHideUnpublished() && !$this->getUnpublished()) {
  101.                 $condition = ' (' . $condition . ') AND published = 1';
  102.             }
  103.         } elseif (Document::doHideUnpublished() && !$this->getUnpublished()) {
  104.             $condition = 'published = 1';
  105.         }
  107.         return $condition;
  108.     }
  110.     /**
  111.      *
  112.      * Methods for AdapterInterface
  113.      */
  115.     /**
  116.      * {@inheritdoc}
  117.      */
  118.     public function count()
  119.     {
  120.         return $this->getTotalCount();
  121.     }
  123.     /**
  124.      * {@inheritdoc}
  125.      */
  126.     public function getItems($offset, $itemCountPerPage)
  127.     {
  128.         $this->setOffset($offset);
  129.         $this->setLimit($itemCountPerPage);
  131.         return $this->load();
  132.     }
  133. }