CachedPaginatedEntityListingControllerTrait.php in Apigee Edge 8
Namespace
Drupal\apigee_edge\Entity\ControllerFile
src/Entity/Controller/CachedPaginatedEntityListingControllerTrait.phpView source
<?php
/**
* Copyright 2018 Google Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* version 2 as published by the Free Software Foundation.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*/
namespace Drupal\apigee_edge\Entity\Controller;
use Apigee\Edge\Structure\PagerInterface;
/**
* For those controllers that supports paginated entity listing.
*
* @see \Apigee\Edge\Controller\PaginatedEntityListingControllerInterface
*/
trait CachedPaginatedEntityListingControllerTrait {
use EntityCacheAwareControllerTrait;
/**
* The decorated entity controller from the SDK.
*
* We did not added a return type because this way all entity controller's
* decorated() method becomes compatible with this declaration.
*
* @return \Apigee\Edge\Controller\PaginatedEntityListingControllerInterface
* An entity controller that extends these interfaces.
*/
protected abstract function decorated();
/**
* {@inheritdoc}
*/
public function getEntities(PagerInterface $pager = NULL, string $key_provider = 'id') : array {
if ($this
->entityCache()
->isAllEntitiesInCache()) {
if ($pager === NULL) {
return $this
->entityCache()
->getEntities();
}
else {
return $this
->extractSubsetOfAssociativeArray($this
->entityCache()
->getEntities(), $pager
->getLimit(), $pager
->getStartKey());
}
}
$entities = $this
->decorated()
->getEntities($pager, $key_provider);
$this
->entityCache()
->saveEntities($entities);
if ($pager === NULL) {
$this
->entityCache()
->allEntitiesInCache(TRUE);
}
return $entities;
}
/**
* {@inheritdoc}
*/
protected abstract function extractSubsetOfAssociativeArray(array $assoc_array, int $limit, ?string $start_key = NULL) : array;
}
Traits
Name | Description |
---|---|
CachedPaginatedEntityListingControllerTrait | For those controllers that supports paginated entity listing. |