1. class
  2. Google
  3. \
  4. AppEngine
  5. \
  6. Api
  7. \
  8. UrlFetch
  9. \
  10. UrlFetchStream

UrlFetchStream

class UrlFetchStream implements IteratorAggregate, ArrayAccess (View source)

Constants

DOMAIN_SEPARATOR

NEWLINE_SEPARATOR

HTTP_METHODS

Properties

$context
$headers

Methods

iterable
getIterator()

No description

bool
offsetExists($offset)

No description

offsetGet($offset)

No description

void
offsetSet($offset, $value)

No description

void
offsetUnset($offset)

No description

bool
stream_open(string $url, string $mode, int $optionsStream, null $openedPath)

Opens URL Stream.

void
stream_close()

Closes URL Stream.

bool
stream_eof()

Return if end of file.

void
stream_stat()

Returns URL Stats, Unused.

string
stream_read(int $count)

Read from stream.

bool
stream_seek(int $offset, int $whence = SEEK_SET)

Seeks to specific location in a stream.

int
stream_tell()

Retrieve the current position of a stream.

Details

at line 56
iterable getIterator()

Return Value

iterable

at line 61
bool offsetExists($offset)

Parameters

$offset

Return Value

bool

at line 65
offsetGet($offset)

Parameters

$offset

at line 69
void offsetSet($offset, $value)

Parameters

$offset
$value

Return Value

void

at line 73
void offsetUnset($offset)

Parameters

$offset

Return Value

void

at line 270
bool stream_open(string $url, string $mode, int $optionsStream, null $openedPath)

Opens URL Stream.

Parameters

string $url Specifies the URL that was passed to the original function.
string $mode UNUSED in the context of URLs.
int $optionsStream UNUSED in the context of URLs.
null $openedPath UNUSED in the context of URLs.

Return Value

bool Returns true on success or false on failure.

Exceptions

Exception if URLFetch request is nto successful.

at line 319
void stream_close()

Closes URL Stream.

Return Value

void

at line 337
bool stream_eof()

Return if end of file.

Return Value

bool Return true if the read/write position is at the end of the stream and if no more data is available to be read, or false otherwise.

at line 348
void stream_stat()

Returns URL Stats, Unused.

Must be implemented for stream wrapper.

Return Value

void

at line 361
string stream_read(int $count)

Read from stream.

Parameters

int $count How many bytes of data from the current position should be returned.

Return Value

string Return number of bytes. If there are less than count bytes available, return as many as are available. If no more data is available, return either false or an empty string.

at line 378
bool stream_seek(int $offset, int $whence = SEEK_SET)

Seeks to specific location in a stream.

Parameters

int $offset The stream offset to seek to.
int $whence SEEK_SET: - Set position equal to offset bytes. SEEK_CUR: - Set position to current location plus offset. SEEK_END: - Set position to end-of-file plus offset.

Return Value

bool Return true if the position was updated, false otherwise.

at line 392
int stream_tell()

Retrieve the current position of a stream.

Return Value

int current position of the stream as int.