• Home
• org
• bovigo
• vfs
• vfsStreamWrapper

PHP Class org\bovigo\vfs\vfsStreamWrapper

ファイルを表示 Open project: mikey179/vfsstream Class Usage Examples

Protected Properties

Property	Type	Description
$content		shortcut to file container
$dir		shortcut to directory container
$dirIterator		shortcut to directory container iterator
$mode		file mode: read only, write only, all
$registered		switch whether class has already been registered as stream wrapper or not
$root		root content

Public Methods

Method	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
getRoot ( ) : org\bovigo\vfs\vfsStreamContainer	returns the root content
mkdir ( string $path, integer $mode, integer $options ) : boolean	creates a new directory
register ( )	method to register the stream wrapper
rename ( string $path_from, string $path_to ) : boolean	rename from one path to another
rmdir ( string $path, integer $options ) : boolean	removes a directory
setQuota ( Quota $quota )	sets quota for disk space
setRoot ( org\bovigo\vfs\vfsStreamContainer $root ) : org\bovigo\vfs\vfsStreamContainer	sets the root content
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_metadata ( string $path, integer $option, mixed $var ) : boolean	sets metadata like owner, user or permissions
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_set_option ( integer $option, integer $arg1, integer $arg2 ) : boolean	sets options on the stream
stream_stat ( ) : array	returns status of stream
stream_tell ( ) : integer	returns the current position of the stream
stream_truncate ( integer $size ) : boolean	truncates a file to a given length
stream_write ( string $data ) : integer	writes data into the stream
unlink ( string $path ) : boolean	remove the data under the given path
unregister ( )	Unregisters a previously registered URL wrapper for the vfs scheme.
url_stat ( string $path, integer $flags ) : array	returns status of url

Protected Methods

Method	Description
calculateMode ( string $mode, boolean $extended ) : integer	calculates the file mode
doUnlink ( string $path ) : boolean	removes a path
getContent ( string $path ) : org\bovigo\vfs\vfsStreamContent	returns content for given path
getContentOfType ( string $path, integer $type ) : org\bovigo\vfs\vfsStreamContent	returns content for given path but only when it is of given type
resolvePath ( string $path ) : string	helper method to resolve a path from /foo/bar/. to /foo/bar
splitPath ( string $path ) : string[]	splits path into its dirname and the basename

Private Methods

Method	Description
createFile ( string $path, string $mode = null, string $options = null ) : boolean	creates a file at given path
doPermChange ( string $path, vfsStreamAbstractContent $content, Closure $change ) : boolean	executes given permission change when necessary rights allow such a change
isInRoot ( string $path ) : boolean	helper method to detect whether given path is in root path

Method Details

Property Details