PHP Класс chobie\Jira\Issues\Walker

Наследование: implements Iterator
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$api chobie\Jira\Api API.
$callback callable Callback.
$current integer Current record index.
$executed boolean Was JQL executed.
$fields string | array | null List of fields to query.
$issues array Result.
$jql string JQL.
$max integer Issue count on current page.
$offset integer Offset.
$perPage integer Issues per page.
$startAt integer Index of issue in issue list (across all issue pages).
$total integer Total issue count.

Открытые методы

Метод Описание
__construct ( Api $api, integer | null $per_page = null ) Creates walker instance.
count ( ) : integer Count elements of an object.
current ( ) : mixed Return the current element.
key ( ) : mixed Return the key of the current element.
next ( ) : void Move forward to next element.
push ( string $jql, string | array | null $fields = null ) : void Pushes JQL.
rewind ( ) : void Rewind the Iterator to the first element.
setDelegate ( callable $callable ) : void Sets callable.
valid ( ) : boolean Checks if current position is valid.

Защищенные методы

Метод Описание
getQuery ( ) : string Returns JQL.
setResult ( Result $result ) : void Sets result.

Описание методов

__construct() публичный Метод

Creates walker instance.
public __construct ( Api $api, integer | null $per_page = null )
$api chobie\Jira\Api API.
$per_page integer | null Per page.

count() публичный Метод

Count elements of an object.
См. ссылку: http://php.net/manual/en/countable.count.php
public count ( ) : integer
Результат integer The custom count as an integer.

current() публичный Метод

Return the current element.
См. ссылку: http://php.net/manual/en/iterator.current.php
public current ( ) : mixed
Результат mixed Can return any type.

getQuery() защищенный Метод

Returns JQL.
protected getQuery ( ) : string
Результат string

key() публичный Метод

Return the key of the current element.
См. ссылку: http://php.net/manual/en/iterator.key.php
public key ( ) : mixed
Результат mixed scalar on success, or null on failure.

next() публичный Метод

Move forward to next element.
См. ссылку: http://php.net/manual/en/iterator.next.php
public next ( ) : void
Результат void Any returned value is ignored.

push() публичный Метод

Pushes JQL.
public push ( string $jql, string | array | null $fields = null ) : void
$jql string JQL.
$fields string | array | null Fields.
Результат void

rewind() публичный Метод

Rewind the Iterator to the first element.
См. ссылку: http://php.net/manual/en/iterator.rewind.php
public rewind ( ) : void
Результат void Any returned value is ignored.

setDelegate() публичный Метод

Sets callable.
public setDelegate ( callable $callable ) : void
$callable callable Callable.
Результат void

setResult() защищенный Метод

Sets result.
protected setResult ( Result $result ) : void
$result chobie\Jira\Api\Result Result.
Результат void

valid() публичный Метод

Checks if current position is valid.
См. ссылку: http://php.net/manual/en/iterator.valid.php
public valid ( ) : boolean
Результат boolean The return value will be casted to boolean and then evaluated. Returns true on success or false on failure.

Описание свойств

$api защищенное свойство

API.
protected Api,chobie\Jira $api
Результат chobie\Jira\Api

$callback защищенное свойство

Callback.
protected callable $callback
Результат callable

$current защищенное свойство

Current record index.
protected int $current
Результат integer

$executed защищенное свойство

Was JQL executed.
protected bool $executed
Результат boolean

$fields защищенное свойство

List of fields to query.
protected string|array|null $fields
Результат string | array | null

$issues защищенное свойство

Result.
protected array $issues
Результат array

$jql защищенное свойство

JQL.
protected string $jql
Результат string

$max защищенное свойство

Issue count on current page.
protected int $max
Результат integer

$offset защищенное свойство

Offset.
protected int $offset
Результат integer

$perPage защищенное свойство

Issues per page.
protected int $perPage
Результат integer

$startAt защищенное свойство

Index of issue in issue list (across all issue pages).
protected int $startAt
Результат integer

$total защищенное свойство

Total issue count.
protected int $total
Результат integer