Class JStreamString

String Stream Wrapper

This class allows you to use a PHP string in the same way that you would normally use a regular stream wrapper

Package: Joomla\Platform\FileSystem
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/filesystem/streams/string.php

Methods summary

`public boolean`	# `stream_open( string $path, string $mode, integer $options, string & $opened_path )` Method to open a file or URL. Method to open a file or URL. Parameters `$path` `string` - $path The stream path. `$mode` `string` - $mode Not used. `$options` `integer` - $options Not used. `$opened_path` `string` - &$opened_path Not used. Returns `boolean` Since 11.1
`public array`	# `stream_stat( )` Method to retrieve information from a file resource Method to retrieve information from a file resource Returns `array` Since 11.1 Link https://secure.php.net/manual/en/streamwrapper.stream-stat.php
`public array`	# `url_stat( string $path, integer $flags = 0 )` Method to retrieve information about a file. Method to retrieve information about a file. Parameters `$path` `string` - $path File path or URL to stat `$flags` `integer` - $flags Additional flags set by the streams API Returns `array` Since 11.1 Link https://secure.php.net/manual/en/streamwrapper.url-stat.php
`public`	# `stream_read( integer $count )` Method to read a given number of bytes starting at the current position and moving to the end of the string defined by the current position plus the given number. Method to read a given number of bytes starting at the current position and moving to the end of the string defined by the current position plus the given number. Parameters `$count` `integer` - $count Bytes of data from the current position should be returned. Since 11.1 Link https://secure.php.net/manual/en/streamwrapper.stream-read.php
`public boolean`	# `stream_write( string $data )` Stream write, always returning false. Stream write, always returning false. Parameters `$data` `string` - $data The data to write. Returns `boolean` Since 11.1 Note Updating the string is not supported.
`public integer`	# `stream_tell( )` Method to get the current position Method to get the current position Returns `integer` - The position Since 11.1
`public boolean`	# `stream_eof( )` End of field check End of field check Returns `boolean` - True if at end of field. Since 11.1
`public boolean`	# `stream_seek( integer $offset, integer $whence )` Stream offset Stream offset Parameters `$offset` `integer` - $offset The starting offset. `$whence` `integer` - $whence SEEK_SET, SEEK_CUR, SEEK_END Returns `boolean` - True on success. Since 11.1
`public boolean`	# `stream_flush( )` Stream flush, always returns true. Stream flush, always returns true. Returns `boolean` Since 11.1 Note Data storage is not supported

Magic methods summary

Properties summary

`protected string`	`$currentString`	# The current string The current string Since 12.1
`protected string`	`$path`	# The path The path Since 12.1
`protected string`	`$mode`	# The mode The mode Since 12.1
`protected string`	`$options`	# Enter description here ... Enter description here ... Since 12.1
`protected string`	`$openedPath`	# Enter description here ... Enter description here ... Since 12.1
`protected integer`	`$pos`	# Current position Current position Since 12.1
`protected string`	`$len`	# Length of the string Length of the string Since 12.1
`protected array`	`$stat`	# Statistics for a file Statistics for a file Since 12.1 Link http://us.php.net/manual/en/function.stat.php

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JStreamString

Methods summary

Parameters

Returns

Since

Returns

Since

Link

Parameters

Returns

Since

Link

Parameters

Since

Link

Parameters

Returns

Since

Note

Returns

Since

Returns

Since

Parameters

Returns

Since

Returns

Since

Note

Magic methods summary

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Link