FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Wrapper Class Reference

Stream wrapper. More...

Inheritance diagram for Wrapper:
Thing

Public Member Functions

 dir_closedir ()
 
 dir_opendir ($path, $options)
 
 dir_readdir ()
 
 dir_rewinddir ()
 
 mkdir ($path, $mode, $options)
 
 rename ($path_from, $path_to)
 
 rmdir ($path, $options)
 
 stream_close ()
 
 stream_eof ()
 
 stream_flush ()
 
 stream_metadata ($path, $option, $value)
 
 stream_open ($path, $mode, $options, &$opened_path)
 
 stream_read ($count)
 
 stream_seek ($offset, $whence)
 
 stream_set_option ($option, $arg1, $arg2)
 
 stream_stat ()
 
 stream_tell ()
 
 stream_truncate ($new_size)
 
 stream_write ($data)
 
 unlink ($path)
 
 url_stat ($path, $flags)
 
- Public Member Functions inherited from Thing
 propertyExists ($property)
 Check if a property exists (public or published). More...
 
 constants ($prefix=null)
 Return all constants. More...
 
 get ($key)
 Get one or more properties. More...
 
 set ($key, $value=null)
 Set one or more properties. More...
 
 __get ($key)
 
 __set ($key, $value)
 

Data Fields

 $context = null
 
- Data Fields inherited from Thing
const HIDDEN = 0
 Property is hidden. More...
 
const READABLE = 1
 Property is readable. More...
 
const WRITEABLE = 2
 Property is writeable. More...
 
const READWRITE = 3
 Property is readable and writeable. More...
 

Protected Member Functions

 splitPath ($path)
 Split the path in protocol, handlers, filename and optional parameters (all stored in properties). More...
 
 getData ()
 
- Protected Member Functions inherited from Thing
 publish ($property, $visibility=self::READABLE)
 Publish a property (or hide it again). More...
 
 configure ($config)
 Configure the object. More...
 
 _get ($key)
 Default getter if no specific setter is defined, and the property is also not published (readable). More...
 
 _set ($key, $value)
 Default setter if no specific setter is defined, and the property is also not published (writeable). More...
 

Protected Attributes

 $_fred = null
 
 $_handlers = []
 
 $_filename = null
 
 $_params = []
 
 $_dir = null
 
 $_readOnly = false
 
 $_modified = false
 
 $_position = 0
 
 $_data = null
 
- Protected Attributes inherited from Thing
 $_published = []
 Published properties (key = name of property, value = visibility). More...
 

Detailed Description

Stream wrapper.

See also
http://www.php.net/manual/en/class.streamwrapper.php

Definition at line 9 of file Wrapper.php.

Member Function Documentation

◆ dir_closedir()

dir_closedir ( )

Definition at line 42 of file Wrapper.php.

◆ dir_opendir()

dir_opendir (   $path,
  $options 
)

Definition at line 47 of file Wrapper.php.

◆ dir_readdir()

dir_readdir ( )

Definition at line 53 of file Wrapper.php.

◆ dir_rewinddir()

dir_rewinddir ( )

Definition at line 59 of file Wrapper.php.

◆ getData()

getData ( )
protected

Definition at line 222 of file Wrapper.php.

◆ mkdir()

mkdir (   $path,
  $mode,
  $options 
)

Definition at line 64 of file Wrapper.php.

◆ rename()

rename (   $path_from,
  $path_to 
)

Definition at line 68 of file Wrapper.php.

◆ rmdir()

rmdir (   $path,
  $options 
)

Definition at line 77 of file Wrapper.php.

◆ splitPath()

splitPath (   $path)
protected

Split the path in protocol, handlers, filename and optional parameters (all stored in properties).

Parameters
string$pathPath of the form fred://handler1/handler2/file.ext?key1=value1&key2=value2 (where 'fred' is the name of the global var with the framework handle).
Returns
bool True when successful.

Definition at line 29 of file Wrapper.php.

◆ stream_close()

stream_close ( )

Definition at line 83 of file Wrapper.php.

◆ stream_eof()

stream_eof ( )

Definition at line 86 of file Wrapper.php.

◆ stream_flush()

stream_flush ( )

Definition at line 90 of file Wrapper.php.

◆ stream_metadata()

stream_metadata (   $path,
  $option,
  $value 
)

Definition at line 96 of file Wrapper.php.

◆ stream_open()

stream_open (   $path,
  $mode,
  $options,
$opened_path 
)

Definition at line 107 of file Wrapper.php.

◆ stream_read()

stream_read (   $count)

Definition at line 133 of file Wrapper.php.

◆ stream_seek()

stream_seek (   $offset,
  $whence 
)

Definition at line 139 of file Wrapper.php.

◆ stream_set_option()

stream_set_option (   $option,
  $arg1,
  $arg2 
)

Definition at line 159 of file Wrapper.php.

◆ stream_stat()

stream_stat ( )

Definition at line 163 of file Wrapper.php.

◆ stream_tell()

stream_tell ( )

Definition at line 181 of file Wrapper.php.

◆ stream_truncate()

stream_truncate (   $new_size)

Definition at line 185 of file Wrapper.php.

◆ stream_write()

stream_write (   $data)

Definition at line 189 of file Wrapper.php.

◆ unlink()

unlink (   $path)

Definition at line 198 of file Wrapper.php.

◆ url_stat()

url_stat (   $path,
  $flags 
)

Definition at line 202 of file Wrapper.php.

Field Documentation

◆ $_data

$_data = null
protected

Definition at line 21 of file Wrapper.php.

◆ $_dir

$_dir = null
protected

Definition at line 17 of file Wrapper.php.

◆ $_filename

$_filename = null
protected

Definition at line 15 of file Wrapper.php.

◆ $_fred

$_fred = null
protected

Definition at line 13 of file Wrapper.php.

◆ $_handlers

$_handlers = []
protected

Definition at line 14 of file Wrapper.php.

◆ $_modified

$_modified = false
protected

Definition at line 19 of file Wrapper.php.

◆ $_params

$_params = []
protected

Definition at line 16 of file Wrapper.php.

◆ $_position

$_position = 0
protected

Definition at line 20 of file Wrapper.php.

◆ $_readOnly

$_readOnly = false
protected

Definition at line 18 of file Wrapper.php.

◆ $context

$context = null

Definition at line 11 of file Wrapper.php.


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