Files
espocrm/application/Espo/Core/Record/Collection.php
Taras Machyshyn 124cce55bd 2021 license
2021-01-25 16:37:54 +02:00

86 lines
2.5 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
* Website: https://www.espocrm.com
*
* EspoCRM is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* EspoCRM is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with EspoCRM. If not, see http://www.gnu.org/licenses/.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
namespace Espo\Core\Record;
use Espo\ORM\{
Collection as OrmCollection,
};
use StdClass;
/**
* Contains an an ORM collection and total number of records.
*/
class Collection
{
protected $collection;
protected $total;
public function __construct(OrmCollection $collection, ?int $total = null)
{
$this->collection = $collection;
$this->total = $total;
}
/**
* Get a total number of records in DB (that matches applied search parameters).
*/
public function getTotal() : ?int
{
return $this->total;
}
/**
* Get an ORM collection.
*/
public function getCollection() : OrmCollection
{
return $this->collection;
}
/**
* Get an array of StdClass objects.
*/
public function getValueMapList() : array
{
if (!$this->collection->getEntityType()) {
$list = [];
foreach ($this->collection as $e) {
$item = $e->getValueMap();
$item->_scope = $e->getEntityType();
$list[] = $item;
}
return $list;
}
return $this->collection->getValueMapList();
}
}