Class JBuffer

Generic Buffer stream handler

This class provides a generic buffer stream. It can be used to store/retrieve/manipulate string buffers with the standard PHP filesystem I/O methods.

Package: Joomla\Platform\Utilities
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Located at joomla/utilities/buffer.php

Methods summary

`public boolean`	# `stream_open( string $path, string $mode, integer $options, string & $opened_path )` Function to open file or url Function to open file or url Parameters `$path` `string` - $path The URL that was passed `$mode` `string` - $mode Mode used to open the file @see fopen `$options` `integer` - $options Flags used by the API, may be STREAM_USE_PATH and STREAM_REPORT_ERRORS `$opened_path` `string` - &$opened_path Full path of the resource. Used with STREAN_USE_PATH option Returns `boolean` Since 11.1 See streamWrapper::stream_open
`public mixed`	# `stream_read( integer $count )` Read stream Read stream Parameters `$count` `integer` - $count How many bytes of data from the current position should be returned. Returns `mixed` - The data from the stream up to the specified number of bytes (all data if the total number of bytes in the stream is less than $count. Null if the stream is empty. Since 11.1 See streamWrapper::stream_read
`public integer`	# `stream_write( string $data )` Write stream Write stream Parameters `$data` `string` - $data The data to write to the stream. Returns `integer` Since 11.1 See streamWrapper::stream_write
`public integer`	# `stream_tell( )` Function to get the current position of the stream Function to get the current position of the stream Returns `integer` Since 11.1 See streamWrapper::stream_tell
`public boolean`	# `stream_eof( )` Function to test for end of file pointer Function to test for end of file pointer Returns `boolean` - True if the pointer is at the end of the stream Since 11.1 See streamWrapper::stream_eof
`public boolean`	# `stream_seek( integer $offset, integer $whence )` The read write position updates in response to $offset and $whence The read write position updates in response to $offset and $whence Parameters `$offset` `integer` - $offset The offset in bytes `$whence` `integer` - $whence Position the offset is added to Options are SEEK_SET, SEEK_CUR, and SEEK_END Returns `boolean` - True if updated Since 11.1 See streamWrapper::stream_seek
`protected boolean`	# `seek_set( integer $offset )` Set the position to the offset Set the position to the offset Parameters `$offset` `integer` - $offset The offset in bytes Returns `boolean`
`protected boolean`	# `seek_cur( integer $offset )` Adds the offset to current position Adds the offset to current position Parameters `$offset` `integer` - $offset The offset in bytes Returns `boolean`
`protected boolean`	# `seek_end( integer $offset )` Sets the position to the end of the current buffer + offset Sets the position to the end of the current buffer + offset Parameters `$offset` `integer` - $offset The offset in bytes Returns `boolean`

Magic methods summary

Properties summary

`public integer`	`$position`	# Stream position Stream position Since 11.1
`public string`	`$name`	# Buffer name Buffer name Since 11.1
`public array`	`$buffers`	# Buffer hash Buffer hash Since 12.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JBuffer

Methods summary

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Magic methods summary

Properties summary

Since

Since

Since