YANA 4 PHP FrameworkDocs For Class InputStream

### Class InputStream

#### Description

«abstract» InputStream

- access: public
- abstract:

Located in /includes/class_inputstream.php

    SerializeableObject
       |
       --InputStream

#### Direct descendents

Class | Description
--- | ---
DirStream | Manipulate a directory
Executeable | handle php files
SecureInputStream | SecureInputStream

#### Method Summary

InputStream InputStream (string $filename)
boolean exists ()
string get ()
string getFilename ()
boolean isEmpty ()
boolean read ()
void resetStats ()
string toString ()

#### Methods

##### Constructor InputStream

InputStream InputStream (string $filename)

constructor

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

##### exists

boolean exists ()

exists

- access: public

Redefined in descendants as:

- DirStream::exists() : check if directory exists and is readable
- ConfigFile::exists() : test if a certain value exists
- SmlFile::exists() : exists

##### get

string get ()

get

- access: public

Redefined in descendants as:

- DirStream::get() : return list of files within the directory
- SecureInputStream::get() : get
- ConfigFile::get() : get
- SmlFile::get() : get
- DatFile::get() : retrieve a line of data from the file
- VDrive::get() : get a mountpoint

##### getFilename

string getFilename ()

getFilename

- access: public

##### isEmpty

boolean isEmpty ()

«abstract» isEmpty

implement this method in sub class

- abstract:
- access: public

Redefined in descendants as:

- DirStream::isEmpty() : check wether the directory has no contents
- SecureInputStream::isEmpty() : isEmpty

##### read

boolean read ()

«abstract» read

implement this method in sub class

- abstract:
- access: public

Redefined in descendants as:

- DirStream::read() : read contents and put results in cache (filter settings will be applied)
- Executeable::read() : require / include a php file
- SecureInputStream::read() : read
- VDrive::read() : read the virtual drive

##### resetStats

void resetStats ()

resetStats

Reset file stats, e.g. after creating a file that did not exist. While this method is never used in THIS class, it will propably be essential for its sub classes.

- access: protected

##### toString

string toString ()

«abstract» toString

implement this method in sub class

- abstract:
- access: public

Redefinition of:

SerializeableObject::toString()
  «abstract» get a string representation of this object

Redefined in descendants as:

- DirStream::toString() : toString
- SecureInputStream::toString() : toString
- ConfigFile::toString() : get a string representation
- DatFile::toString() : return file content as string (if available)
- VDrive::toString() : get string represenation of a virtual drive

#### Inherited Methods

Inherited From SerializeableObject

> SerializeableObject::serialize()
> SerializeableObject::toString()

Documentation generated on Sat, 16 Sep 2006 17:06:00 +0200 by phpDocumentor 1.3.0RC4

yana author: Thomas Meyerwww.all-community.de/pub