>> YANA 4 PHP Framework >> Docs For Class SecureInputStream

Class SecureInputStream

Description

checked reading of file sources

This class adds functionality to compute the checksum of a resource and failsafe reading of resources.

  • access: public

Located in /includes/class_secureinputstream.php

Object
   |
   --InputStream
      |
      --SecureInputStream
Method Summary

Direct descendents

Class Description
SecureFileStream checked reading and writing of file sources
VDrive virtual Drive

Methods

return crc32 checksum for this file
int checksum (
[string $filename = ""]
)
List of parameters:
Name Type Description
$filename string
Description:

The filename parameter became available in version 2.8.5

  • access: public
read file contents
boolean failSafeRead ()
Description:

Automatically restarts reading if the file-resource is temporarily not available after waiting for 0.5 seconds.

The process is aborted if it fails 3 times.

  • access: public
get file contents
string get ()
Description:
  • access: public

Redefinition of: InputStream::get()


Redefined in descendants as:
returns bool(true) if the source is empty or not loaded
boolean isEmpty ()
Description:
  • access: public
return md5 checksum for this file
string md5Checksum (
[ $filename = ""]
)
List of parameters:
Name Type Description
$filename
Description:

Usefull to check whether or not a file has been changed since last access.

Note: results are cached for the file itself.

  • since: 2.8.5
  • access: public
read file contents
boolean read ()
Description:

Returns bool(true) on success and bool(false) on error.

  • access: public

Redefined in descendants as:
reload file contents
void reset ()
Description:

You accidently did something wrong with the file? Calling this will reload the file from disk while reseting its current state.

  • access: public

Redefined in descendants as:
alias of get()
string toString ()
Description:
  • access: public

Redefinition of: Object::toString()


Redefined in descendants as:
inherited from base classes

Inherited From InputStream

Inherited From Object

Documentation generated on Wed, 22 Nov 2006 20:19:15 +0100 by phpDocumentor 1.3.1

yana author: Thomas MeyerHomepage: www.all-community.de/pub