Back to Joomla project (class list)

Class StreamString - list of methods

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\CMS\Filesystem\Streams
Copyright: (C) 2008 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Filesystem/Streams/StreamString.php
Project: Joomla

Method Summary

public bool
(mixed $path, mixed $mode, mixed $options, mixed &$openedPath)

Method to open a file or URL.
Parameters
  • string $path The stream path.
  • string $mode Not used.
  • int $options Not used.
  • string $openedPath Not used.
Returns
  • bool
Since
  • 1.7.0
Show source code of this method: stream_open Source Code

public array
()

Method to retrieve information from a file resource
Returns
  • array
Since
  • 1.7.0
-
  • https://www.php.net/manual/en/streamwrapper.stream-stat.php
Show source code of this method: stream_stat Source Code

public array
(mixed $path, mixed $flags = 0)

Method to retrieve information about a file.
Parameters
  • string $path File path or URL to stat
  • int $flags Additional flags set by the streams API
Returns
  • array
Since
  • 1.7.0
-
  • https://www.php.net/manual/en/streamwrapper.url-stat.php
Show source code of this method: url_stat Source Code

public string
(mixed $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.
Parameters
  • int $count Bytes of data from the current position should be returned.
Returns
  • string
Since
  • 1.7.0
-
  • https://www.php.net/manual/en/streamwrapper.stream-read.php
Show source code of this method: stream_read Source Code

public bool
(mixed $data)

Stream write, always returning false.
Parameters
  • string $data The data to write.
Returns
  • bool
Since
  • 1.7.0
-
  • Updating the string is not supported.
Show source code of this method: stream_write Source Code

public int
()

Method to get the current position
Returns
  • int The position
Since
  • 1.7.0
Show source code of this method: stream_tell Source Code

public bool
()

End of field check
Returns
  • bool True if at end of field.
Since
  • 1.7.0
Show source code of this method: stream_eof Source Code

public bool
(mixed $offset, mixed $whence)

Stream offset
Parameters
  • int $offset The starting offset.
  • int $whence SEEK_SET, SEEK_CUR, SEEK_END
Returns
  • bool True on success.
Since
  • 1.7.0
Show source code of this method: stream_seek Source Code

public bool
()

Stream flush, always returns true.
Returns
  • bool
Since
  • 1.7.0
-
  • Data storage is not supported
Show source code of this method: stream_flush Source Code

Properties Summary

protected string
$currentString
The current string
Since
  • 3.0.0
protected string
$path
The path
Since
  • 3.0.0
protected string
$mode
The mode
Since
  • 3.0.0
protected string
$options
Enter description here .
Since
  • 3.0.0
protected string
$openedPath
Enter description here .
Since
  • 3.0.0
protected int
$pos
Current position
Since
  • 3.0.0
protected string
$len
Length of the string
Since
  • 3.0.0
protected array
$stat
Statistics for a file
Since
  • 3.0.0
-
  • array

Tags Summary

Since
1.7.0