PHP Class org\bovigo\vfs\vfsStreamWrapperRecordingProxy

Since: 0.10.0
Inheritance: extends vfsStreamWrapper
Afficher le fichier Open project: mikey179/vfsstream

Protected Properties

Свойство Type Description
$calledMethods array list of called methods for a stream
$path string currently opened path

Méthodes publiques

Méthode Description
dir_closedir ( ) : boolean closes directory
dir_opendir ( string $path, integer $options ) : boolean opens a directory
dir_readdir ( ) : string reads directory contents
dir_rewinddir ( ) : boolean reset directory iteration
getMethodCalls ( string $path ) : array returns recorded method calls for given path
mkdir ( string $path, integer $mode, integer $options ) : boolean creates a new directory
rename ( string $path_from, string $path_to ) : boolean rename from one path to another
rmdir ( string $path, integer $options ) : boolean removes a directory
setup ( string $rootDirName = 'root', integer $permissions = null ) : vfsStreamDirectory helper method for setting up vfsStream with the proxy
stream_cast ( integer $cast_as ) : boolean retrieve the underlaying resource
stream_close ( ) closes the stream
stream_eof ( ) : boolean checks whether stream is at end of file
stream_flush ( ) : boolean flushes unstored data into storage
stream_lock ( integer $operation ) : boolean set lock status for stream
stream_open ( string $path, string $mode, string $options, string $opened_path ) : boolean open the stream
stream_read ( integer $count ) : string read the stream up to $count bytes
stream_seek ( integer $offset, integer $whence ) : boolean seeks to the given offset
stream_stat ( ) : array returns status of stream
stream_tell ( ) : integer returns the current position of the stream
stream_write ( string $data ) : integer writes data into the stream
unlink ( string $path ) : boolean remove the data under the given path
url_stat ( string $path, integer $flags ) : array returns status of url

Méthodes protégées

Méthode Description
recordMethodCall ( string $method, string $path ) records method call for given path

Method Details

dir_closedir() public méthode

closes directory
public dir_closedir ( ) : boolean
Résultat boolean

dir_opendir() public méthode

opens a directory
public dir_opendir ( string $path, integer $options ) : boolean
$path string
$options integer
Résultat boolean

dir_readdir() public méthode

reads directory contents
public dir_readdir ( ) : string
Résultat string

dir_rewinddir() public méthode

reset directory iteration
public dir_rewinddir ( ) : boolean
Résultat boolean

getMethodCalls() public static méthode

returns recorded method calls for given path
public static getMethodCalls ( string $path ) : array
$path string
Résultat array

mkdir() public méthode

creates a new directory
public mkdir ( string $path, integer $mode, integer $options ) : boolean
$path string
$mode integer
$options integer
Résultat boolean

recordMethodCall() protected static méthode

records method call for given path
protected static recordMethodCall ( string $method, string $path )
$method string
$path string

rename() public méthode

rename from one path to another
public rename ( string $path_from, string $path_to ) : boolean
$path_from string
$path_to string
Résultat boolean

rmdir() public méthode

removes a directory
public rmdir ( string $path, integer $options ) : boolean
$path string
$options integer
Résultat boolean

setup() public static méthode

helper method for setting up vfsStream with the proxy
public static setup ( string $rootDirName = 'root', integer $permissions = null ) : vfsStreamDirectory
$rootDirName string optional name of root directory
$permissions integer optional file permissions of root directory
Résultat vfsStreamDirectory

stream_cast() public méthode

retrieve the underlaying resource
public stream_cast ( integer $cast_as ) : boolean
$cast_as integer
Résultat boolean

stream_close() public méthode

closes the stream
public stream_close ( )

stream_eof() public méthode

checks whether stream is at end of file
public stream_eof ( ) : boolean
Résultat boolean

stream_flush() public méthode

flushes unstored data into storage
public stream_flush ( ) : boolean
Résultat boolean

stream_lock() public méthode

set lock status for stream
public stream_lock ( integer $operation ) : boolean
$operation integer
Résultat boolean

stream_open() public méthode

open the stream
public stream_open ( string $path, string $mode, string $options, string $opened_path ) : boolean
$path string the path to open
$mode string mode for opening
$options string options for opening
$opened_path string full path that was actually opened
Résultat boolean

stream_read() public méthode

read the stream up to $count bytes
public stream_read ( integer $count ) : string
$count integer amount of bytes to read
Résultat string

stream_seek() public méthode

seeks to the given offset
public stream_seek ( integer $offset, integer $whence ) : boolean
$offset integer
$whence integer
Résultat boolean

stream_stat() public méthode

returns status of stream
public stream_stat ( ) : array
Résultat array

stream_tell() public méthode

returns the current position of the stream
public stream_tell ( ) : integer
Résultat integer

stream_write() public méthode

writes data into the stream
public stream_write ( string $data ) : integer
$data string
Résultat integer amount of bytes written

url_stat() public méthode

returns status of url
public url_stat ( string $path, integer $flags ) : array
$path string path of url to return status for
$flags integer flags set by the stream API
Résultat array

Property Details

$calledMethods protected_oe static_oe property

list of called methods for a stream
protected static array $calledMethods
Résultat array

$path protected_oe property

currently opened path
protected string $path
Résultat string