Pimcore\Model\Document::getList PHP Method

getList() public static method

Returns the documents list instance.
public static getList ( array $config = [] ) : Listing
$config array
return Pimcore\Model\Document\Listing
    public static function getList($config = [])
    {
        if (is_array($config)) {
            $listClass = "Pimcore\\Model\\Document\\Listing";
            $list = \Pimcore::getDiContainer()->make($listClass);
            $list->setValues($config);
            $list->load();
            return $list;
        }
        throw new \Exception("Unable to initiate list class - class not found or invalid configuration");
    }

Usage Example

Example #1
0
 /**
  * @param null $condition
  * @param null $order
  * @param null $orderKey
  * @param null $offset
  * @param null $limit
  * @param null $groupBy
  * @throws \Exception
  */
 public function getDocumentList($condition = null, $order = null, $orderKey = null, $offset = null, $limit = null, $groupBy = null)
 {
     try {
         $list = Document::getList(array("condition" => $condition, "order" => $order, "orderKey" => $orderKey, "offset" => $offset, "limit" => $limit, "groupBy" => $groupBy));
         $list->setUnpublished(1);
         $items = array();
         /** @var  $doc Document */
         foreach ($list as $doc) {
             $item = new Webservice\Data\Document\Listing\Item();
             $item->id = $doc->getId();
             $item->type = $doc->getType();
             if (method_exists($doc, "getPublished")) {
                 $item->published = $doc->getPublished();
             }
             $items[] = $item;
         }
         return $items;
     } catch (\Exception $e) {
         \Logger::error($e);
         throw $e;
     }
 }
All Usage Examples Of Pimcore\Model\Document::getList