Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_OutputByteStream

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/OutputByteStream.php

Interface Overview


An abstract means of reading data.


Author(s):

  • Chris Corbyn

Methods


Child classes:

Swift_FileStream
An OutputByteStream which specifically reads from a file.

Class Details

[line 19]
An abstract means of reading data.

Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.




Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method read [line 34]

string|bool read( int $length)

Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.

If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned.




Tags:

throws:  Swift_IoException
access:  public


Parameters:

int   $length  

[ Top ]

method setReadPointer [line 45]

bool setReadPointer( int $byteOffset)

Move the internal read pointer to $byteOffset in the stream.



Tags:

throws:  Swift_IoException
access:  public


Parameters:

int   $byteOffset  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:53:10 +0000 by phpDocumentor 1.4.3