Hoa central
Public Member Functions | List of all members
Hoa\Stream\Wrapper\IWrapper\File Interface Reference
Inheritance diagram for Hoa\Stream\Wrapper\IWrapper\File:

Public Member Functions

 dir_closedir ()
 
 dir_opendir ($path, $options)
 
 dir_readdir ()
 
 dir_rewinddir ()
 
 mkdir ($path, $mode, $options)
 
 rename ($from, $to)
 
 rmdir ($path, $options)
 
 unlink ($path)
 
 url_stat ($path, $flags)
 

Detailed Description

Interface .

Interface for “file stream wrapper” class.

Definition at line 47 of file File.php.

Member Function Documentation

Hoa\Stream\Wrapper\IWrapper\File::dir_closedir ( )

Close directory handle. This method is called in to closedir(). Any resources which were locked, or allocated, during opening and use of the directory stream should be released.

Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::dir_opendir (   $path,
  $options 
)

Open directory handle. This method is called in response to opendir().

Parameters
string$pathSpecifies the URL that was passed to opendir().
int$optionsWhether or not to enforce safe_mode (0x04).
Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::dir_readdir ( )

Read entry from directory handle. This method is called in response to readdir().

Returns
mixed
Hoa\Stream\Wrapper\IWrapper\File::dir_rewinddir ( )

Rewind directory handle. This method is called in response to rewinddir(). Should reset the output generated by self::dir_readdir, i.e. the next call to self::dir_readdir should return the first entry in the location returned by self::dir_opendir.

Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::mkdir (   $path,
  $mode,
  $options 
)

Create a directory. This method is called in response to mkdir().

Parameters
string$pathDirectory which should be created.
int$modeThe value passed to mkdir().
int$optionsA bitwise mask of values.
Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::rename (   $from,
  $to 
)

Rename a file or directory. This method is called in response to rename(). Should attempt to rename $from to $to.

Parameters
string$fromThe URL to current file.
string$toThe URL which $from should be renamed to.
Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::rmdir (   $path,
  $options 
)

Remove a directory. This method is called in response to rmdir().

Parameters
string$pathThe directory URL which should be removed.
int$optionsA bitwise mask of values.
Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::unlink (   $path)

Delete a file. This method is called in response to unlink().

Parameters
string$pathThe file URL which should be deleted.
Returns
bool
Hoa\Stream\Wrapper\IWrapper\File::url_stat (   $path,
  $flags 
)

Retrieve information about a file. This method is called in response to all stat() related functions.

Parameters
string$pathThe file URL which should be retrieve information about.
int$flagsHolds additional flags set by the streams API. It can hold one or more of the following values OR'd together. STREAM_URL_STAT_LINK: for resource 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, our wrapper should not raise any errors. If this flag is not set, we are responsible for reporting errors using the trigger_error() function during stating of the path.
Returns
array

The documentation for this interface was generated from the following file: