Hoa central
Public Member Functions | Public Attributes | List of all members
Hoa\Stream\IStream\Pointable Interface Reference
Inheritance diagram for Hoa\Stream\IStream\Pointable:

Public Member Functions

 rewind ()
 
 seek ($offset, $whence=self::SEEK_SET)
 
 tell ()
 

Public Attributes

const SEEK_SET = SEEK_SET
 
const SEEK_CURRENT = SEEK_CUR
 
const SEEK_END = SEEK_END
 

Detailed Description

Interface .

Interface for pointable input/output.

Definition at line 47 of file Pointable.php.

Member Function Documentation

Hoa\Stream\IStream\Pointable::rewind ( )

Rewind the position of a stream pointer.

Returns
bool

Implemented in Hoa\File\File, and Hoa\Stringbuffer\Stringbuffer.

Hoa\Stream\IStream\Pointable::seek (   $offset,
  $whence = self::SEEK_SET 
)

Seek on a stream pointer.

Parameters
int$offsetOffset (negative value should be supported).
int$whenceWhence, use the self::SEEK_* constants.
Returns
int

Implemented in Hoa\File\File, and Hoa\Stringbuffer\Stringbuffer.

Hoa\Stream\IStream\Pointable::tell ( )

Get the current position of the stream pointer.

Returns
int

Implemented in Hoa\File\File, and Hoa\Stringbuffer\Stringbuffer.

Member Data Documentation

const Hoa\Stream\IStream\Pointable::SEEK_CURRENT = SEEK_CUR

Set position to current location plus $offset.

int

Definition at line 61 of file Pointable.php.

const Hoa\Stream\IStream\Pointable::SEEK_END = SEEK_END

Set position to end-of-file plus $offset.

int

Definition at line 68 of file Pointable.php.

const Hoa\Stream\IStream\Pointable::SEEK_SET = SEEK_SET

Set position equal to $offset bytes.

int

Definition at line 54 of file Pointable.php.


The documentation for this interface was generated from the following file: