CachedPaginatedControllerHelperTrait.php in Apigee Edge 8
Namespace
Drupal\apigee_edge\Entity\ControllerFile
src/Entity/Controller/CachedPaginatedControllerHelperTrait.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;
/**
* Shared defs. for cached paginated entity & entity od listing controllers.
*/
trait CachedPaginatedControllerHelperTrait {
/**
* 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\PaginatedEntityIdListingControllerInterface|\Apigee\Edge\Controller\PaginatedEntityListingControllerInterface
* An entity controller that extends these interfaces.
*/
protected abstract function decorated();
/**
* {@inheritdoc}
*/
public function createPager(int $limit = 0, ?string $start_key = NULL) : PagerInterface {
return $this
->decorated()
->createPager($limit, $start_key);
}
/**
* Utility function that returns a subset of an associative array.
*
* @param array $assoc_array
* Input array.
* @param int $limit
* Limit.
* @param string|null $start_key
* The start key, if it is null than it is first key of the array.
*
* @return array
* Subset of the array.
*/
protected final function extractSubsetOfAssociativeArray(array $assoc_array, int $limit, ?string $start_key = NULL) : array {
$array_keys = array_keys($assoc_array);
if ($start_key === NULL) {
$start_key = reset($array_keys);
}
$pos = array_search($start_key, $array_keys);
return array_slice($assoc_array, $pos, $limit);
}
}
Traits
Name | Description |
---|---|
CachedPaginatedControllerHelperTrait | Shared defs. for cached paginated entity & entity od listing controllers. |