Documentation

Result
in package
implements Iterator

Api Result

Tags
author

Patrick Rainer rainer@datacycle.at

Table of Contents

Interfaces

Iterator

Properties

$context  : array<string|int, mixed>|null
$initPageNumber  : int
$items  : array<string|int, mixed>|null
$links  : stdClass|null
$logger  : LoggerInterface
$meta  : stdClass|null
$modelFactory  : ModelFactoryInterface
$request  : Request
$requestParams  : array<string|int, mixed>
$responseCode  : int
$responseErrors  : stdClass|null
$responseObject  : stdClass|null
$responsePhrase  : string

Methods

__construct()  : mixed
creates a new Result.
current()  : Result
getContext()  : array<string|int, mixed>|null
getErrors()  : stdClass|null
getItems()  : array<string|int, mixed>|null
getLinks()  : stdClass|null
getMeta()  : stdClass|null
getRawResponseObject()  : stdClass|null
getRequestParams()  : array<string|int, mixed>|null
getResponseCode()  : int
getResponsePhrase()  : string
hasNext()  : bool
key()  : int
next()  : void
rewind()  : void
valid()  : bool
parseItems()  : array<string|int, mixed>
sendRequest()  : mixed

Properties

$context

private array<string|int, mixed>|null $context = null

context

$initPageNumber

private int $initPageNumber

response code

$items

private array<string|int, mixed>|null $items = null

items

$links

private stdClass|null $links = null

links

$logger

private LoggerInterface $logger

logger

$meta

private stdClass|null $meta = null

meta

$requestParams

private array<string|int, mixed> $requestParams

requestParams

$responseCode

private int $responseCode

response code

$responseErrors

private stdClass|null $responseErrors = null

responseErrors

$responseObject

private stdClass|null $responseObject = null

responseObject

$responsePhrase

private string $responsePhrase

response phrase

Methods

__construct()

creates a new Result.

public __construct(array<string|int, mixed> $requestParams[, ModelFactoryInterface|null $modelFactory = null ][, LoggerInterface|null $logger = null ]) : mixed
Parameters
$requestParams : array<string|int, mixed>
$modelFactory : ModelFactoryInterface|null = null
$logger : LoggerInterface|null = null
Tags
throws
GuzzleException

getContext()

public getContext() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getErrors()

public getErrors() : stdClass|null
Return values
stdClass|null

getItems()

public getItems() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getLinks()

public getLinks() : stdClass|null
Return values
stdClass|null

getMeta()

public getMeta() : stdClass|null
Return values
stdClass|null

getRawResponseObject()

public getRawResponseObject() : stdClass|null
Return values
stdClass|null

getRequestParams()

public getRequestParams() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

getResponseCode()

public getResponseCode() : int
Return values
int

getResponsePhrase()

public getResponsePhrase() : string
Return values
string

hasNext()

public hasNext() : bool
Return values
bool

key()

public key() : int
Return values
int

rewind()

public rewind() : void

valid()

public valid() : bool
Tags
throws
GuzzleException
Return values
bool

parseItems()

private parseItems(array<string|int, mixed> $items) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>
Return values
array<string|int, mixed>

sendRequest()

private sendRequest(array<string|int, mixed> $requestParams) : mixed
Parameters
$requestParams : array<string|int, mixed>
Tags
throws
GuzzleException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results