PHP Класс Uploadcare\FileIterator

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

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

Свойство Тип Описание
$api Api Api object
$container array Array of cached file elements
$count integer Total count of files
$fullyLoaded boolean Indicates if all files were loaded from server
$limit integer Desired count of elements
$options array Options for requests
$position integer Current iterator position
$requestLimit integer Limit for requests
$reverse boolean Determines direction of file browsing and which URL param is used: 'from' or 'to'

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

Метод Описание
__construct ( Api $api, array $options = [] ) Constructor
count ( )
current ( )
key ( )
next ( )
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
rewind ( )
valid ( )

Приватные методы

Метод Описание
exists ( integer $offset = null ) : boolean Check if element exists. Uses current position if no offset provided
isFullyLoaded ( ) : boolean Check if all elements are loaded into iterator
loadChunk ( ) Load elements chunk from server

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

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

Constructor
public __construct ( Api $api, array $options = [] )
$api Api Uploadcare class instance
$options array Request parameters and filters

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

public count ( )

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

public current ( )

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

public key ( )

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

public next ( )

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

public offsetExists ( $offset )

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

public offsetGet ( $offset )

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

public offsetSet ( $offset, $value )

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

public offsetUnset ( $offset )

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

public rewind ( )

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

public valid ( )

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

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

Api object
protected Api,uploadcare $api
Результат Api

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

Array of cached file elements
protected array $container
Результат array

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

Total count of files
protected int $count
Результат integer

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

Indicates if all files were loaded from server
protected bool $fullyLoaded
Результат boolean

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

Desired count of elements
protected int $limit
Результат integer

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

Options for requests
protected array $options
Результат array

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

Current iterator position
protected int $position
Результат integer

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

Limit for requests
protected int $requestLimit
Результат integer

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

Determines direction of file browsing and which URL param is used: 'from' or 'to'
protected bool $reverse
Результат boolean