PHP Class Neos\Flow\ResourceManagement\Streams\ResourceStreamWrapper

Inheritance: implements Neos\Flow\ResourceManagement\Streams\StreamWrapperInterface
显示文件 Open project: neos/flow-development-collection Class Usage Examples

Public Properties

Property Type Description
$context resource

Protected Properties

Property Type Description
$handle resource
$packageManager Neos\Flow\Package\PackageManagerInterface
$resourceManager Neos\Flow\ResourceManagement\ResourceManager
$uri Neos\Flow\Http\Uri

Public Methods

Method Description
cast ( integer $castType ) : resource Retrieve the underlying resource.
close ( ) : void Close an resource.
closeDirectory ( ) : boolean Close directory handle.
flush ( ) : boolean Flushes the output.
getScheme ( ) : string Returns the scheme ("protocol") this wrapper handles.
isAtEof ( ) : boolean Tests for end-of-file on a file pointer.
lock ( integer $operation ) : boolean Advisory file locking.
makeDirectory ( string $path, integer $mode, integer $options ) : void Create a directory.
open ( string $path, string $mode, integer $options, &$openedPathAndFilename ) : boolean Opens file or URL.
openDirectory ( string $path, integer $options ) : boolean Open directory handle.
pathStat ( string $path, integer $flags ) : array Retrieve information about a file.
read ( integer $count ) : string Read from stream.
readDirectory ( ) : string Read entry from directory handle.
removeDirectory ( string $path, integer $options ) : void Removes a directory.
rename ( string $source, string $target ) : boolean Renames a file or directory.
resourceStat ( ) : array Retrieve information about a file resource.
rewindDirectory ( ) : boolean Rewind directory handle.
seek ( integer $offset, integer $whence = SEEK_SET ) : boolean Seeks to specific location in a stream.
setOption ( integer $option, integer $argument1, integer $argument2 ) : boolean Change stream options.
tell ( ) : integer Retrieve the current position of a stream.
unlink ( string $path ) : boolean Delete a file.
unlock ( ) : boolean Advisory file locking.
write ( string $data ) : integer Write to stream.

Protected Methods

Method Description
evaluateResourcePath ( string $requestedPath, boolean $checkForExistence = true ) : mixed Evaluates the absolute path and filename of the resource file specified by the given path.

Method Details

cast() public method

This method is called in response to stream_select().
public cast ( integer $castType ) : resource
$castType integer Can be STREAM_CAST_FOR_SELECT when stream_select() is calling stream_cast() or STREAM_CAST_AS_STREAM when stream_cast() is called for other uses.
return resource Should return the underlying stream resource used by the wrapper, or FALSE.

close() public method

This method is called in response to fclose(). All resources that were locked, or allocated, by the wrapper should be released.
public close ( ) : void
return void

closeDirectory() public method

This method is called in response to closedir(). Any resources which were locked, or allocated, during opening and use of the directory stream should be released.
public closeDirectory ( ) : boolean
return boolean Always TRUE

evaluateResourcePath() protected method

Evaluates the absolute path and filename of the resource file specified by the given path.
protected evaluateResourcePath ( string $requestedPath, boolean $checkForExistence = true ) : mixed
$requestedPath string
$checkForExistence boolean Whether a (non-hash) path should be checked for existence before being returned
return mixed The full path and filename or FALSE if the file doesn't exist

flush() public method

This method is called in response to fflush(). If you have cached data in your stream but not yet stored it into the underlying storage, you should do so now. Note: If not implemented, FALSE is assumed as the return value.
public flush ( ) : boolean
return boolean Should return TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.

getScheme() public static method

Returns the scheme ("protocol") this wrapper handles.
public static getScheme ( ) : string
return string

isAtEof() public method

This method is called in response to feof().
public isAtEof ( ) : boolean
return boolean Should return TRUE if the read/write position is at the end of the stream and if no more data is available to be read, or FALSE otherwise.

lock() public method

This method is called in response to flock(), when file_put_contents() (when flags contains LOCK_EX), stream_set_blocking(). $operation is one of the following: LOCK_SH to acquire a shared lock (reader). LOCK_EX to acquire an exclusive lock (writer). LOCK_NB if you don't want flock() to block while locking.
public lock ( integer $operation ) : boolean
$operation integer One of the LOCK_* constants
return boolean TRUE on success or FALSE on failure.

makeDirectory() public method

This method is called in response to mkdir().
public makeDirectory ( string $path, integer $mode, integer $options ) : void
$path string Directory which should be created.
$mode integer The value passed to mkdir().
$options integer A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.
return void

open() public method

This method is called immediately after the wrapper is initialized (f.e. by fopen() and file_get_contents()). $options can hold one of the following values OR'd together: STREAM_USE_PATH If path is relative, search for the resource using the include_path. STREAM_REPORT_ERRORS If this flag is set, you are responsible for raising errors using trigger_error() during opening of the stream. If this flag is not set, you should not raise any errors.
public open ( string $path, string $mode, integer $options, &$openedPathAndFilename ) : boolean
$path string Specifies the URL that was passed to the original function.
$mode string The mode used to open the file, as detailed for fopen().
$options integer Holds additional flags set by the streams API.
return boolean TRUE on success or FALSE on failure.

openDirectory() public method

This method is called in response to opendir().
public openDirectory ( string $path, integer $options ) : boolean
$path string Specifies the URL that was passed to opendir().
$options integer Whether or not to enforce safe_mode (0x04).
return boolean TRUE on success or FALSE on failure.

pathStat() public method

This method is called in response to all stat() related functions. $flags can hold one or more of the following values OR'd together: STREAM_URL_STAT_LINK For resources with the ability to link to other resource (such as an HTTP Location: forward, or a filesystem symlink). This flag specified that only information about the link itself should be returned, not the resource pointed to by the link. This flag is set in response to calls to lstat(), is_link(), or filetype(). STREAM_URL_STAT_QUIET If this flag is set, your wrapper should not raise any errors. If this flag is not set, you are responsible for reporting errors using the trigger_error() function during stating of the path. Note: The stat() call is silenced through the shut-up operator because this method would issue a warning if the file does not exist - but file_exists() will call pathStat() in order to check exactly that. So without the "@" operator it wouldn't be possible to run file_exists() on a resource without issuing a warning and the resulting exception.
public pathStat ( string $path, integer $flags ) : array
$path string The file path or URL to stat. Note that in the case of a URL, it must be a :// delimited URL. Other URL forms are not supported.
$flags integer Holds additional flags set by the streams API.
return array Should return as many elements as stat() does. Unknown or unavailable values should be set to a rational value (usually 0).

read() public method

This method is called in response to fread() and fgets(). Note: Remember to update the read/write position of the stream (by the number of bytes that were successfully read).
public read ( integer $count ) : string
$count integer How many bytes of data from the current position should be returned.
return string If there are less than count bytes available, return as many as are available. If no more data is available, return either FALSE or an empty string.

readDirectory() public method

This method is called in response to readdir().
public readDirectory ( ) : string
return string Should return string representing the next filename, or FALSE if there is no next file.

removeDirectory() public method

This method is called in response to rmdir(). Note: If the wrapper does not support creating directories it must throw a \BadMethodCallException.
public removeDirectory ( string $path, integer $options ) : void
$path string The directory URL which should be removed.
$options integer A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.
return void

rename() public method

This method is called in response to rename(). Should attempt to rename path_from to path_to.
public rename ( string $source, string $target ) : boolean
$source string The URL to the current file.
$target string The URL which the path_from should be renamed to.
return boolean TRUE on success or FALSE on failure.

resourceStat() public method

This method is called in response to fstat().
public resourceStat ( ) : array
return array See http://php.net/stat

rewindDirectory() public method

This method is called in response to rewinddir(). Should reset the output generated by dir_readdir(). I.e.: The next call to dir_readdir() should return the first entry in the location returned by dir_opendir().
public rewindDirectory ( ) : boolean
return boolean always TRUE

seek() public method

This method is called in response to fseek(). The read/write position of the stream should be updated according to the offset and whence . $whence can one of: SEEK_SET - Set position equal to offset bytes. SEEK_CUR - Set position to current location plus offset. SEEK_END - Set position to end-of-file plus offset.
public seek ( integer $offset, integer $whence = SEEK_SET ) : boolean
$offset integer The stream offset to seek to.
$whence integer
return boolean TRUE on success or FALSE on failure.

setOption() public method

This method is called to set options on the stream. $option can be one of: STREAM_OPTION_BLOCKING (The method was called in response to stream_set_blocking()) STREAM_OPTION_READ_TIMEOUT (The method was called in response to stream_set_timeout()) STREAM_OPTION_WRITE_BUFFER (The method was called in response to stream_set_write_buffer()) If $option is ... then $arg1 is set to: STREAM_OPTION_BLOCKING: requested blocking mode (1 meaning block 0 not blocking). STREAM_OPTION_READ_TIMEOUT: the timeout in seconds. STREAM_OPTION_WRITE_BUFFER: buffer mode (STREAM_BUFFER_NONE or STREAM_BUFFER_FULL). If $option is ... then $arg2 is set to: STREAM_OPTION_BLOCKING: This option is not set. STREAM_OPTION_READ_TIMEOUT: the timeout in microseconds. STREAM_OPTION_WRITE_BUFFER: the requested buffer size.
public setOption ( integer $option, integer $argument1, integer $argument2 ) : boolean
$option integer
$argument1 integer
$argument2 integer
return boolean TRUE on success or FALSE on failure. If option is not implemented, FALSE should be returned.

tell() public method

This method is called in response to ftell().
public tell ( ) : integer
return integer Should return the current position of the stream.

unlock() public method

This method is called when closing the stream (LOCK_UN).
public unlock ( ) : boolean
return boolean TRUE on success or FALSE on failure.

write() public method

This method is called in response to fwrite(). If there is not enough room in the underlying stream, store as much as possible. Note: Remember to update the current position of the stream by number of bytes that were successfully written.
public write ( string $data ) : integer
$data string Should be stored into the underlying stream.
return integer Should return the number of bytes that were successfully stored, or 0 if none could be stored.

Property Details

$context public_oe property

public resource $context
return resource

$handle protected_oe property

protected resource $handle
return resource

$packageManager protected_oe property

protected PackageManagerInterface,Neos\Flow\Package $packageManager
return Neos\Flow\Package\PackageManagerInterface

$resourceManager protected_oe property

protected ResourceManager,Neos\Flow\ResourceManagement $resourceManager
return Neos\Flow\ResourceManagement\ResourceManager

$uri protected_oe property

protected Uri,Neos\Flow\Http $uri
return Neos\Flow\Http\Uri