PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of StreamString.php

Joomla! Content Management System

Copyright:	(C) 2008 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	285 lines (6 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

StreamString:: (9 methods):
  stream_open()
  stream_stat()
  url_stat()
  stream_read()
  stream_write()
  stream_tell()
  stream_eof()
  stream_seek()
  stream_flush()

Class: StreamString - X-Ref

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

stream_open($path, $mode, $options, &$openedPath) X-Ref

Method to open a file or URL.

param: string   $path        The stream path.
param: string   $mode        Not used.
param: integer  $options     Not used.
param: string   $openedPath  Not used.
return: boolean

stream_stat() X-Ref

Method to retrieve information from a file resource

return: array

url_stat($path, $flags = 0) X-Ref

Method to retrieve information about a file.

param: string $path File path or URL to stat
param: integer $flags Additional flags set by the streams API
return: array

stream_read($count) X-Ref

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.

param: integer $count Bytes of data from the current position should be returned.
return: string

stream_write($data) X-Ref

Stream write, always returning false.

param: string $data The data to write.
return: boolean

stream_tell() X-Ref

Method to get the current position

return: integer The position

stream_eof() X-Ref

End of field check

return: boolean True if at end of field.

stream_seek($offset, $whence) X-Ref

Stream offset

param: integer  $offset  The starting offset.
param: integer  $whence  SEEK_SET, SEEK_CUR, SEEK_END
return: boolean  True on success.

stream_flush() X-Ref

Stream flush, always returns true.

return: boolean

PHP Cross Reference of Joomla 4.2.2 documentation

/libraries/src/Filesystem/Streams/ -> StreamString.php (summary)

Defines 1 class