third_party/vfsstream/vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamWrapper.php

Classes
- \org\bovigo\vfs\vfsStreamWrapper

Table of Contents

This file is part of vfsStream.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Package: org\bovigo\vfs

\org\bovigo\vfs\vfsStreamWrapper
jump to top

Package: Default

Stream wrapper to mock file system requests.

Children: \org\bovigo\vfs\vfsStreamWrapperRecordingProxy; \org\bovigo\vfs\TestvfsStreamWrapper

Constants

open file for reading


       
       
        TRUNCATE
       
       = 'w'

truncate file

set file pointer to end, append new data

set file pointer to start, overwrite existing data


       
       
        WRITE_NEW
       
       = 'c'

set file pointer to start, overwrite existing data; or create file if does not exist

file mode: read only

file mode: write only

file mode: read and write

Methods


       
       
       
        dir_closedir
       
       
        ()
       
       : bool

closes directory

Returns

Type	Description
bool


       
       
       
        dir_opendir
       
       
        (string $path, int $options)
       
       : bool

opens a directory

Parameters

Name	Type	Description
$path	string
$options	int

Returns

Type	Description
bool


       
       
       
        dir_readdir
       
       
        ()
       
       : string

reads directory contents

Returns

Type	Description
string


       
       
       
        dir_rewinddir
       
       
        ()
       
       : bool

reset directory iteration

Returns

Type	Description
bool


       
       
       
        getRoot
       
       
        ()
       
       :
       
        \org\bovigo\vfs\vfsStreamContainer

static

returns the root content

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContainer


       
       
       
        mkdir
       
       
        (string $path, int $mode, int $options)
       
       : bool

creates a new directory

Parameters

Name	Type	Description
$path	string
$mode	int
$options	int

Returns

Type	Description
bool

static

method to register the stream wrapper

Please be aware that a call to this method will reset the root element to null. If the stream is already registered the method returns silently. If there is already another stream wrapper registered for the scheme used by vfsStream a vfsStreamException will be thrown.

Throws

Exception	Description
\org\bovigo\vfs\vfsStreamException


       
       
       
        rename
       
       
        (string $path_from, string $path_to)
       
       : bool

rename from one path to another

Parameters

Name	Type	Description
$path_from	string
$path_to	string

Returns

Type	Description
bool

Details

Author: Benoit Aubuchon


       
       
       
        rmdir
       
       
        (string $path, int $options)
       
       : bool

removes a directory

Parameters

Name	Type	Description
$path	string
$options	int

Returns

Type	Description
bool

Details

Todo: consider $options with STREAM_MKDIR_RECURSIVE


       
       
       
        setQuota
       
       
        (\org\bovigo\vfs\Quota $quota)
       
       : void

static

sets quota for disk space

Parameters

Name	Type	Description
$quota	\org\bovigo\vfs\Quota

Details

Since: 1.1.0


       
       
       
        setRoot
       
       
        (
        
         \org\bovigo\vfs\vfsStreamContainer
        
        $root)
       
       :
       
        \org\bovigo\vfs\vfsStreamContainer

static

sets the root content

Parameters

Name	Type	Description
$root	\org\bovigo\vfs\vfsStreamContainer

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContainer


       
       
       
        stream_cast
       
       
        (int $cast_as)
       
       : bool

retrieve the underlaying resource

Please note that this method always returns false as there is no underlaying resource to return.

Parameters

Name	Type	Description
$cast_as	int

Returns

Type	Description
bool

Details

See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/3
Since: 0.9.0


       
       
       
        stream_close
       
       
        ()
       
       : void

closes the stream

Details

See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/40

checks whether stream is at end of file

Returns

Type	Description
bool


       
       
       
        stream_flush
       
       
        ()
       
       : bool

flushes unstored data into storage

Returns

Type	Description
bool


       
       
       
        stream_lock
       
       
        (int $operation)
       
       : bool

set lock status for stream

Parameters

Name	Type	Description
$operation	int

Returns

Type	Description
bool

Details

See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/6
See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/31
See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/40
Since: 0.10.0


       
       
       
        stream_metadata
       
       
        (string $path, int $option, mixed $var)
       
       : bool

sets metadata like owner, user or permissions

Parameters

Name	Type	Description
$path	string
$option	int
$var	mixed

Returns

Type	Description
bool

Details

Since: 1.1.0


       
       
       
        stream_open
       
       
        (string $path, string $mode, string $options, string $opened_path)
       
       : bool

open the stream

Parameters

Name	Type	Description
$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

Returns

Type	Description
bool


       
       
       
        stream_read
       
       
        (int $count)
       
       : string

read the stream up to $count bytes

Parameters

Name	Type	Description
$count	int	amount of bytes to read

Returns

Type	Description
string


       
       
       
        stream_seek
       
       
        (int $offset, int $whence)
       
       : bool

seeks to the given offset

Parameters

Name	Type	Description
$offset	int
$whence	int

Returns

Type	Description
bool


       
       
       
        stream_set_option
       
       
        (int $option, int $arg1, int $arg2)
       
       : bool

sets options on the stream

Parameters

Name	Type	Description
$option	int	key of option to set
$arg1	int
$arg2	int

Returns

Type	Description
bool

Details

See: \org\bovigo\vfs\https://github.com/mikey179/vfsStream/issues/15
See: \org\bovigo\vfs\http://www.php.net/manual/streamwrapper.stream-set-option.php
Since: 0.10.0


       
       
       
        stream_stat
       
       
        ()
       
       : array

returns status of stream

Returns

Type	Description
array


       
       
       
        stream_tell
       
       
        ()
       
       : int

returns the current position of the stream

Returns

Type	Description
int


       
       
       
        stream_truncate
       
       
        (int $size)
       
       : bool

truncates a file to a given length

Parameters

Name	Type	Description
$size	int	length to truncate file to

Returns

Type	Description
bool

Details

Since: 1.1.0


       
       
       
        stream_write
       
       
        (string $data)
       
       : int

writes data into the stream

Parameters

Name	Type	Description
$data	string

Returns

Type	Description
int	amount of bytes written


       
       
       
        unlink
       
       
        (string $path)
       
       : bool

remove the data under the given path

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
bool


       
       
       
        url_stat
       
       
        (string $path, int $flags)
       
       : array

returns status of url

Parameters

Name	Type	Description
$path	string	path of url to return status for
$flags	int	flags set by the stream API

Returns

Type	Description
array

third_party/vfsstream/vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamWrapper.php

\org\bovigo\vfs\vfsStreamWrapper jump to top

Constants

Methods

\org\bovigo\vfs\vfsStreamWrapper
jump to top