Flow PHP

Http

Classes

ContentTypeDetector
HttpEncoder
Decodes an HTTP exchange into raw row values. The response/request body is decoded once, content-type aware, into a navigable nested map (JSON via json_decode, XML via {@see XMLConverter}); the extractor's Hydrator types the Row from it and pagination reads the same map.
HttpExchange
PsrHttpClientDynamicExtractor
PsrHttpClientPaginatedExtractor
PsrHttpClientStaticExtractor

Namespaces

DynamicExtractor
Pagination

Enums

ResponseType

Functions

from_static_http_requests()

from_static_http_requests(ClientInterface $client, iterable<string|int, RequestInterface> $requests[, Schema|null $schema = null ]) : PsrHttpClientStaticExtractor
Parameters
$client : ClientInterface
$requests : iterable<string|int, RequestInterface>
$schema : Schema|null = null
Return values
PsrHttpClientStaticExtractor

http_pagination_page_number()

http_pagination_page_number(RequestOption $inject[, int $start_page = 1 ][, int|null $page_size = null ][, RequestOption|null $size_option = null ][, bool $inject_on_first_request = true ][, string|null $records_path = null ][, bool $stop_on_client_error = true ][, StopWhen|null $stop_when = null ]) : Paginator
Parameters
$inject : RequestOption
$start_page : int = 1
$page_size : int|null = null
$size_option : RequestOption|null = null
$inject_on_first_request : bool = true
$records_path : string|null = null
$stop_on_client_error : bool = true
$stop_when : StopWhen|null = null
Return values
Paginator

http_pagination_offset()

http_pagination_offset(RequestOption $offset_option, RequestOption $limit_option, int $limit[, int $start_offset = 0 ][, string|null $total_path = null ][, bool $inject_on_first_request = true ][, bool $stop_on_client_error = true ][, StopWhen|null $stop_when = null ]) : Paginator
Parameters
$offset_option : RequestOption
$limit_option : RequestOption
$limit : int
$start_offset : int = 0
$total_path : string|null = null
$inject_on_first_request : bool = true
$stop_on_client_error : bool = true
$stop_when : StopWhen|null = null
Return values
Paginator

http_pagination_next_url()

http_pagination_next_url(string $path[, bool $stop_on_client_error = true ][, StopWhen|null $stop_when = null ]) : Paginator
Parameters
$path : string
$stop_on_client_error : bool = true
$stop_when : StopWhen|null = null
Return values
Paginator

http_pagination_link_header()

http_pagination_link_header([string $rel = 'next' ][, bool $stop_on_client_error = true ][, StopWhen|null $stop_when = null ]) : Paginator
Parameters
$rel : string = 'next'
$stop_on_client_error : bool = true
$stop_when : StopWhen|null = null
Return values
Paginator

http_pagination_last_record_cursor()

http_pagination_last_record_cursor(string $record_path, RequestOption $inject[, bool $stop_on_client_error = true ][, StopWhen|null $stop_when = null ]) : Paginator
Parameters
$record_path : string
$inject : RequestOption
$stop_on_client_error : bool = true
$stop_when : StopWhen|null = null
Return values
Paginator

http_request_option_body()

http_request_option_body(string $path, StreamFactoryInterface $stream_factory) : RequestOption
Parameters
$path : string
$stream_factory : StreamFactoryInterface
Return values
RequestOption

http_stop_when_path_missing()

http_stop_when_path_missing(string $path) : StopWhen
Parameters
$path : string
Return values
StopWhen

http_stop_when_empty_path()

http_stop_when_empty_path(string $path) : StopWhen
Parameters
$path : string
Return values
StopWhen

http_stop_when_flag_false()

http_stop_when_flag_false(string $path) : StopWhen
Parameters
$path : string
Return values
StopWhen

http_stop_when_flag_true()

http_stop_when_flag_true(string $path) : StopWhen
Parameters
$path : string
Return values
StopWhen

http_stop_when_total_reached()

http_stop_when_total_reached(string $total_path) : StopWhen
Parameters
$total_path : string
Return values
StopWhen

http_stop_when_max_results()

http_stop_when_max_results(int $count) : StopWhen
Parameters
$count : int
Return values
StopWhen
On this page

Search results