yana

Description
  Class trees
  Index of elements
  Todo List
core
  Classes
    FormCreator
    Index
    Language
    Object
    Plugin
    PluginManager
    Singleton
    SmartTemplate
    SmartView
    Utility
    Yana
database
  Classes
    DbBlob
    DbCreator
    DbDesigner4
    DbExtractor
    DbQuery
    DbQueryParser
    DbServer
    DbStream
    DbStructure
    FileDb
error_reporting
  Classes
    Alert
    Error
    ErrorUtility
    Log
    Message
    Report
    Warning
file_system
  Classes
    DatFile
    Dir
    Executeable
    File
    FileReadonly
    FileSystemResource
    SML
javascript
  Classes
    AjaxRequest
  Functions
    preview
    yanaAddEventListener
    yanaAddIcon
    yanaCheckEmbTags
    yanaCloseAll
    yanaGetCookie
    yanaGetElementsByClassName
    yanaMaxLength
    yanaMenu
    yanaMenuCookie
    yanaSetCookie
mail
  Classes
    FormMailer
    Mailer
plugins
  Classes
    plugin_blog
    plugin_check
    plugin_db_admin
    plugin_db_tools
    plugin_default_library
    plugin_diagnostics
    plugin_guestbook
    plugin_guestbook_admin
    plugin_ipblock
    plugin_ipblock_admin
    plugin_rss
    plugin_rss_admin
    plugin_sdk
    plugin_search
    plugin_search_admin
    plugin_user
    plugin_user_admin
utilities
  Classes
    Brush
    Counter
    Hashtable
    Image
    Microsummary
    RSS
    RSSitem
    String
  Functions
    checkArgumentList
    cloneArray
    dirlist
    qSearchArray
    untaintInput
    XMLencode
vdrive
  Classes
    Registry
    VDrive
zip
  Classes
    PclZip

phpDocumentor v 1.4.0

YANA Framework for PHPDocs For Class FileSystemResource

### Class FileSystemResource

#### Description

«abstract» filesystem resource
This is an abstract super-class for all filesystem wrappers.
For examples: resources may be files of any type, or directories.
All subclasses should implement the abstract functions read() and isEmpty(). You are also encouraged to re-implement the function toString().

- abstract:
- access: public

    Object
       |
       --FileSystemResource

##### Method Summary

- FileSystemResource FileSystemResource (string $filename)
- bool equals (object $anotherObject)
- bool exists ()
- string get ()
- int getLastModified ()
- string getPath ()
- bool read ()

#### Direct descendents

Class | Description
--- | ---
Dir | Manipulate a directory
Executeable | handle php files
FileReadonly | checked reading of file sources

#### Methods

##### constructor

FileSystemResource FileSystemResource (
string $filename
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$filename | string |

###### Description:

Create a new instance of this class.

##### compare with another object

bool equals (
object $anotherObject
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$anotherObject | object |

###### Description:

Returns bool(true) if this object and $anotherObject are equal and bool(false) otherwise.
Two instances are considered equal if and only if they are both objects of the same class and they both refer to the same filesystem resource.

- access: public

Redefinition of: Object::equals()

##### return true, if the input stream resource exists

bool exists ()

###### Description:

- access: public

Redefined in descendants as:

- Dir::exists() : check if directory exists and is readable
- SML::exists() : test if a certain value exists

##### return stream contents

string get ()

###### Description:

- access: public

Redefined in descendants as:

- Dir::get() : return list of files within the directory
- FileReadonly::get() : get file contents
- DatFile::get() : retrieve a line of data from the file
- SML::get() : get a value from the file
- VDrive::get() : get a mountpoint

##### get time when file was last modified

int getLastModified ()

###### Description:

Returns the file MTIME value (from cached value). The result is an UNIX timestamp (UTC), or bool(false) if an error occurs.

- since: 2.8.5
- access: public

##### get path to the resource

string getPath ()

###### Description:

Returns a string with the path and name of the currently open resource (directory or file).

- access: public
- name: FileSystemResource::getPath()

##### «abstract» read contents of resource

bool read ()

###### Description:

Since this is an abstract method, it is to implemented in the sub-classes.

- abstract:
- access: public

Redefined in descendants as:

- Dir::read() : read contents and put results in cache (filter settings will be applied)
- Executeable::read() : require / include a php file
- FileReadonly::read() : read file contents
- DbBlob::read() : read file contents
- SML::read() : initialize file contents
- DbStructure::read() : read and initialize the file
- VDrive::read() : read the virtual drive

##### inherited from base classes

Inherited From Object

- Object::cloneObject()
- Object::equals()
- Object::getClass()
- Object::serialize()
- Object::toString()

Documentation generated on Sun, 04 Jan 2009 03:49:00 +0100 by phpDocumentor 1.4.0

yana author: Thomas Meyerwww.yanaframework.net