YANA 4 PHP Framework
Docs For Class ConfigFile
ConfigFile
Located in /includes/class_configfile.php
SerializeableObject | --InputStream | --SecureInputStream | --SecureFileStream | --ConfigFile
Class | Description |
---|---|
SmlFile | Simple Markup Language Files |
test if a certain value exists
Name | Type | Description |
---|---|---|
$key | string | (optional) |
get
Name | Type | Description |
---|---|---|
$key | string | (optional) |
initialize file contents
You should always call this before anything else.
insert an array into the file
This merges the current file content with the provided array. New values will replace old ones.
Name | Type | Description |
---|---|---|
$REF | array |
get the number of elements
This returns how many elements can be found inside the array at position $key. If $key points to a non-existing value, or an empty array, the function returns 0.
Name | Type | Description |
---|---|---|
$key | string | (optional) |
remove an entry from the file
Name | Type | Description |
---|---|---|
$key | string | (optional) |
reset the file
Changes to the file will not be safed unless you explicitely call $configFile->write(). So if you want or need to revert your changes just call $configFile->reset() and all will be fine.
set the content of the file
Replaces the file content with the provided array.
Name | Type | Description |
---|---|---|
$REF | array |
get a string representation
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:05:54 +0200 by phpDocumentor 1.3.0RC4