Server : ApacheSystem : Linux host.digitalbabaji.in 4.18.0-513.11.1.el8_9.x86_64 #1 SMP Wed Jan 17 02:00:40 EST 2024 x86_64 User : addictionfreeind ( 1003) PHP Version : 7.2.34 Disable Function : exec,passthru,shell_exec,system Directory : /home/addictionfreeind/www/admin1/vendor/m4tthumphrey/php-gitlab-api/src/ |
Upload File : |
<?php
declare(strict_types=1);
/*
* This file is part of the Gitlab API library.
*
* (c) Matt Humphrey <matth@windsor-telecom.co.uk>
* (c) Graham Campbell <hello@gjcampbell.co.uk>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Gitlab;
use Generator;
use Gitlab\Api\AbstractApi;
/**
* This is the result pager interface.
*
* @author Ramon de la Fuente <ramon@future500.nl>
* @author Mitchel Verschoof <mitchel@future500.nl>
* @author Graham Campbell <hello@gjcampbell.co.uk>
*/
interface ResultPagerInterface
{
/**
* Fetch a single result from an api call.
*
* @param AbstractApi $api
* @param string $method
* @param array $parameters
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetch(AbstractApi $api, string $method, array $parameters = []): array;
/**
* Fetch all results from an api call.
*
* @param AbstractApi $api
* @param string $method
* @param array $parameters
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetchAll(AbstractApi $api, string $method, array $parameters = []): array;
/**
* Lazily fetch all results from an api call.
*
* @param AbstractApi $api
* @param string $method
* @param array $parameters
*
* @throws \Http\Client\Exception
*
* @return \Generator
*/
public function fetchAllLazy(AbstractApi $api, string $method, array $parameters = []): Generator;
/**
* Check to determine the availability of a next page.
*
* @return bool
*/
public function hasNext(): bool;
/**
* Fetch the next page.
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetchNext(): array;
/**
* Check to determine the availability of a previous page.
*
* @return bool
*/
public function hasPrevious(): bool;
/**
* Fetch the previous page.
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetchPrevious(): array;
/**
* Fetch the first page.
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetchFirst(): array;
/**
* Fetch the last page.
*
* @throws \Http\Client\Exception
*
* @return array
*/
public function fetchLast(): array;
}