YANA 4 PHP FrameworkDocs For Class SmlFile

### Class SmlFile

#### Description

Simple Markup Language Files

This class offers exactly the same semantics as its super class, except for the fact that keys are not case-sensitive in the sense, that all keys are automatically converted to upper-case.

- see: configfile
- access: public

Located in /includes/class_smlfile.php

    SerializeableObject
       |
       --InputStream
          |
          --SecureInputStream
             |
             --SecureFileStream
                |
                --ConfigFile
                   |
                   --SmlFile

#### Direct descendents

Class | Description
--- | ---
StructureFile | StructureFile

#### Method Summary

boolean exists ([string $key = "*"])
mixed get ([string $key = "*"])
mixed init ()
boolean insert (array $REF)
int length ([string $key = "*"])
boolean remove ([string $key = "*"])
boolean set (array $REF)

#### Methods

##### exists

boolean exists ([string $key = "*"])

exists

See the description of the super class for details on this function.

- see: configfile::exists()
- access: public

Name | Type | Description
--- | --- | ---
$key | string | (optional)

Redefinition of:

ConfigFile::exists()
  test if a certain value exists

##### get

mixed get ([string $key = "*"])

get

See the description of the super class for details on this function.

- see: configfile::get()
- access: public

Name | Type | Description
--- | --- | ---
$key | string | (optional)

Redefinition of:

ConfigFile::get()
  get

##### init

mixed init ()

init

See the description of the super class for details on this function.

- see: configfile::init()
- access: public

Redefinition of:

ConfigFile::init()
  initialize file contents

Redefined in descendants as:

- StructureFile::init() : init

##### insert

boolean insert (array $REF)

insert

See the description of the super class for details on this function.

- see: configfile::insert()
- access: public

Name | Type | Description
--- | --- | ---
$REF | array |

Redefinition of:

ConfigFile::insert()
  insert an array into the file

##### length

int length ([string $key = "*"])

length

See the description of the super class for details on this function.

- see: configfile::length()
- access: public

Name | Type | Description
--- | --- | ---
$key | string | (optional)

Redefinition of:

ConfigFile::length()
  get the number of elements

##### remove

boolean remove ([string $key = "*"])

remove

See the description of the super class for details on this function.

- see: configfile::remove()
- access: public

Name | Type | Description
--- | --- | ---
$key | string | (optional)

Redefinition of:

ConfigFile::remove()
  remove an entry from the file

##### set

boolean set (array $REF)

set

See the description of the super class for details on this function.

- see: configfile::set()
- access: public

Name | Type | Description
--- | --- | ---
$REF | array |

Redefinition of:

ConfigFile::set()
  set the content of the file

#### Inherited Methods

Inherited From ConfigFile

> ConfigFile::exists()
> ConfigFile::get()
> ConfigFile::init()
> ConfigFile::insert()
> ConfigFile::length()
> ConfigFile::remove()
> ConfigFile::reset()
> ConfigFile::set()
> ConfigFile::toString()

Inherited From SecureFileStream

> SecureFileStream::create()
> SecureFileStream::delete()
> SecureFileStream::failSafeWrite()
> SecureFileStream::insert()
> SecureFileStream::is_writeable()
> SecureFileStream::length()
> SecureFileStream::remove()
> SecureFileStream::write()

Inherited From SecureInputStream

> SecureInputStream::checksum()
> SecureInputStream::failSafeRead()
> SecureInputStream::get()
> SecureInputStream::isEmpty()
> SecureInputStream::read()
> SecureInputStream::reset()
> SecureInputStream::toString()

Inherited From InputStream

> InputStream::InputStream()
> InputStream::exists()
> InputStream::get()
> InputStream::getFilename()
> InputStream::isEmpty()
> InputStream::read()
> InputStream::resetStats()
> InputStream::toString()

Inherited From SerializeableObject

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

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

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