[SOL | start of life for variable]
assert('!isset($|i); // Cannot redeclare var $i');
[EOL | end of life for variable]
unset($|i);
[assert_string | check argument via assertion]
assert('is_string($|); // Wrong argument type argument 1. String expected');
[assert_bool | check argument via assertion]
assert('is_bool($|); // Wrong argument type argument 1. Boolean expected');
[assert_array | check argument via assertion]
assert('is_array($|); // Wrong argument type argument 1. Array expected');
[assert_int | check argument via assertion]
assert('is_int($|); // Wrong argument type argument 1. Integer expected');
[assert_float | check argument via assertion]
assert('is_float($|); // Wrong argument type argument 1. Float expected');
[chkstring | check argument and trigger error]
if (!is_string($|)) {
trigger_error(sprintf(YANA_ERROR_WRONG_ARGUMENT, 1, 'String', gettype($)), E_USER_WARNING);
return false;
}
[chkbool | check bool argument ]
if (!is_bool($|)) {
trigger_error(sprintf(YANA_ERROR_WRONG_ARGUMENT, 1, 'Boolean', gettype($)), E_USER_WARNING);
return false;
}
[chkarray | check array argument ]
if (!is_array($|)) {
trigger_error(sprintf(YANA_ERROR_WRONG_ARGUMENT, 1, 'Array', gettype($)), E_USER_WARNING);
return false;
}
[chkint | check int argument ]
if (!is_int($|)) {
trigger_error(sprintf(YANA_ERROR_WRONG_ARGUMENT, 1, 'Integer', gettype($)), E_USER_WARNING);
return false;
}
[chkfloat | check float argument ]
if (!is_float($|)) {
trigger_error(sprintf(YANA_ERROR_WRONG_ARGUMENT, 1, 'Float', gettype($)), E_USER_WARNING);
return false;
}
[switchstmt | switch ]
switch ($|)
{
/**
* foo
*/
case 1:
break;
/**
* default
*/
default:
break;
} /* end switch */
[php_doc | php tags with PhpDoc block]
*
* @ignore
*/
?>
[class_doc | insert class with PhpDoc block]
/**
* «stereotype» short description
*
* long description
*
* @access public
* @package package
* @subpackage subpackage
*/
class |ClassName
{
/**@#+
* @access private
*/
/* add private class vars here */
/**@#-*/
/**
* create new instance
*
* @param type $argument description
*/
function ClassName ($argumentList)
{
/* do something */
}
}
[const_doc | define constant with PhpDoc block]
if (!defined('|CONST')) {
/**
* @name CONST
* @ignore
*/
define('CONST', 1);
}
[var_doc | define variable with PhpDoc block]
if (!isset(|$var)) {
/**
* @name var
* @var type
*/
$var = null;
} else {
trigger_error("Can't redeclare variable \$var.", E_USER_NOTICE);
}
[method_doc | class method with PhpDoc block]
/**
* «stereotype» short description
*
* long description
*
* input:
*
*
* purpose:
*
*
* expected results:
*
*
* @access public
* @param type $argumentName description
* @return bool
*/
function |methodName($in_args)
{
/* always check input first - at least for correct data type */
if (!is_array($in_args)) {
trigger_error("Wrong data type for argument 1. Array expected, found '".gettype($in_args)."' instead.",E_USER_WARNING);
return false;
} else {
$args = $in_args;
assert('is_array($args);');
/* do something */
return true;
}
}
[foreachassert | for-each loop with assert]
assert('!isset($key); // Cannot redeclare var $key');
assert('!isset($element); // Cannot redeclare var $element');
foreach ($| as $key => $element)
{
} /* end foreach */
unset($key, $element); /* clean up garbage */
[foreachloop | for-each loop]
assert('!isset($element); // Cannot redeclare var $element');
foreach ($| as $element)
{
} /* end foreach */
unset($element); /* clean up garbage */
[forloop | for loop]
assert('!isset($i); // Cannot redeclare var $i');
for ($i = 0; $i < count($|); $i++)
{
} /* end for */
unset($i); /* clean up garbage */
[forassert | for loop with assert]
assert('!isset($i); // Cannot redeclare var $i');
for ($i = 0; $i < count($|array); $i++)
{
if (!isset($array[$i])) {
trigger_error("Array index out of bounds. There is no element '${i}' in \$array.", E_USER_NOTICE);
continue;
} else {
/* do something */
}
assert('is_int($i); // Unexpected result. $i is supposed to be an integer');
assert('isset($array[$i]); // Array index out of bounds.');
} /* end for */
unset($i); /* clean up garbage */
[whilelist | while loop with list]
reset($|);
assert('!isset($key); // Cannot redeclare var $key');
assert('!isset($value); // Cannot redeclare var $value');
while (list($key, $value) = each($))
{
} /* end foreach */
unset($key, $value); /* clean up garbage */
reset($);
[doloop | do ... while loop]
do
{
} while (|); /* end do */
[whileloop | while loop]
while (|)
{
} /* end while */
[forcurrent | for loop with current]
reset($|);
assert('!isset($i); // Overwriting variable $i');
for ($i = 0; $i < count($); $i++)
{
/* do something */
next($);
} /* end foreach */
unset($i); /* clean up garbage */
reset($);
[PHPDoc | list of all phpDoc Tags]
/**
* The short description
*
* As many lines of extendend description as you want {@link element}
* links to an element
* {@link http://www.example.com Example hyperlink inline link} links to
* a website. The inline
* source tag displays function source code in the description:
* {@source }
*
* In addition, in version 1.2+ one can link to extended documentation like this
* documentation using {@tutorial phpDocumentor/phpDocumentor.howto.pkg}
* In a method/class var, {@inheritdoc may be used to copy documentation from}
* the parent method
* {@internal
* This paragraph explains very detailed information that will only
* be of use to advanced developers, and can contain
* {@link http://www.example.com Other inline links!} as well as text}}}
*
* Here are the tags:
*
* @abstract
* @access public or private
* @author author name
* @copyright name date
* @deprecated description
* @deprec alias for deprecated
* @example /path/to/example
* @exception Javadoc-compatible, use as needed
* @global type $globalvarname
or
* @global type description of global variable usage in a function
* @ignore
* @internal private information for advanced developers only
* @param type [$varname] description
* @return type description
* @link URL
* @name procpagealias
or
* @name $globalvaralias
* @magic phpdoc.de compatibility
* @package package name
* @see name of another element that can be documented,
* produces a link to it in the documentation
* @since a version or a date
* @static
* @staticvar type description of static variable usage in a function
* @subpackage sub package name, groupings inside of a project
* @throws Javadoc-compatible, use as needed
* @todo phpdoc.de compatibility
* @var type a data type for a class variable
* @version version
*/
|
[PHPDoc_method | insert PHP-Doc comment for a method]
/**
* «stereotype» short description
*
* long description
*
* @abstract
* @static
*
* @access public
* @name class::method()
* @param string $name description
* @return bool
*
* @ignore
*/
|
[BlockFile_serialize | serialize this object to a string]
string BlockFile->serialize()|
[BlockFile_toString | get a string representation of this object]
string BlockFile->toString()|
[BlockFile_cloneObject | clone this object]
Object BlockFile->cloneObject()|
[BlockFile_getClass | get the class name of the instance]
string BlockFile->getClass()|
[BlockFile_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[BlockFile_read | <> read contents of resource]
bool BlockFile->read()|
[BlockFile_get | return stream contents]
string BlockFile->get()|
[BlockFile_getPath | get path to the resource]
string BlockFile->getPath()|
[BlockFile_exists | return true, if the input stream resource exists]
bool BlockFile->exists()|
[BlockFile_getLastModified | get time when file was last modified]
int BlockFile->getLastModified()|
[BlockFile_read | read file contents]
bool BlockFile->read()|
[BlockFile_failSafeRead | read file contents]
bool BlockFile->failSafeRead()|
[BlockFile_get | get file contents]
string BlockFile->get()|
[BlockFile_getFileContent | return file contents as string]
string BlockFile->getFileContent()|
[BlockFile_toString | alias of get()]
string BlockFile->toString()|
[BlockFile_isEmpty | returns bool(true) if the source is empty or not loaded]
bool BlockFile->isEmpty()|
[BlockFile_getCrc32 | return crc32 checksum for this file]
int BlockFile->getCrc32(|[string filename])
[BlockFile_getMd5 | return md5 hash for this file]
string BlockFile->getMd5(|[string filename])
[BlockFile_insert | insert new content]
void BlockFile->insert(|scalar text)
[BlockFile_write | write file to system]
bool BlockFile->write()|
[BlockFile_getFilesize | get size of this file]
int BlockFile->getFilesize()|
[BlockFile_delete | delete this file]
bool BlockFile->delete()|
[BlockFile_failSafeWrite | failSafe writing of data]
bool BlockFile->failSafeWrite()|
[BlockFile_create | create the current file if it does not exist]
bool BlockFile->create()|
[BlockFile_isWriteable | return bool(true) if file is writeable]
bool BlockFile->isWriteable()|
[BlockFile_length | get the number of contents inside the file]
int BlockFile->length()|
[BlockFile_remove | remove an entry from the file]
bool BlockFile->remove(|[string key])
[Counter_serialize | serialize this object to a string]
string Counter->serialize()|
[Counter_toString | get a string representation of this object]
string Counter->toString()|
[Counter_cloneObject | clone this object]
Object Counter->cloneObject()|
[Counter_getClass | get the class name of the instance]
string Counter->getClass()|
[Counter_Counter | create a new instance]
new Counter(|[string filename], [int use_ip])
[Counter_get | get counter]
array Counter->get(|[string id])
[Counter_getInfo | get counter info]
mixed Counter->getInfo(|[string id])
[Counter_getCount | get counter value]
mixed Counter->getCount(|[string id])
[Counter_count | Decrement counter]
int Counter->count(|string id, [string info], [int ammount])
[DatFile_serialize | serialize this object to a string]
string DatFile->serialize()|
[DatFile_toString | get a string representation of this object]
string DatFile->toString()|
[DatFile_cloneObject | clone this object]
Object DatFile->cloneObject()|
[DatFile_getClass | get the class name of the instance]
string DatFile->getClass()|
[DatFile_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[DatFile_read | <> read contents of resource]
bool DatFile->read()|
[DatFile_get | return stream contents]
string DatFile->get()|
[DatFile_getPath | get path to the resource]
string DatFile->getPath()|
[DatFile_exists | return true, if the input stream resource exists]
bool DatFile->exists()|
[DatFile_getLastModified | get time when file was last modified]
int DatFile->getLastModified()|
[DatFile_read | read file contents]
bool DatFile->read()|
[DatFile_failSafeRead | read file contents]
bool DatFile->failSafeRead()|
[DatFile_get | get file contents]
string DatFile->get()|
[DatFile_getFileContent | return file contents as string]
string DatFile->getFileContent()|
[DatFile_toString | alias of get()]
string DatFile->toString()|
[DatFile_isEmpty | returns bool(true) if the source is empty or not loaded]
bool DatFile->isEmpty()|
[DatFile_getCrc32 | return crc32 checksum for this file]
int DatFile->getCrc32(|[string filename])
[DatFile_getMd5 | return md5 hash for this file]
string DatFile->getMd5(|[string filename])
[DatFile_insert | insert new content]
void DatFile->insert(|scalar text)
[DatFile_write | write file to system]
bool DatFile->write()|
[DatFile_getFilesize | get size of this file]
int DatFile->getFilesize()|
[DatFile_delete | delete this file]
bool DatFile->delete()|
[DatFile_failSafeWrite | failSafe writing of data]
bool DatFile->failSafeWrite()|
[DatFile_create | create the current file if it does not exist]
bool DatFile->create()|
[DatFile_isWriteable | return bool(true) if file is writeable]
bool DatFile->isWriteable()|
[DatFile_length | get the number of contents inside the file]
int DatFile->length()|
[DatFile_remove | remove an entry from the file]
bool DatFile->remove(|[string key])
[DatFile_get | retrieve a line of data from the file]
array DatFile->get(|int lineNr)
[DatFile_insert | insert (append) an entry to the file]
bool DatFile->insert(|array newEntry, [bool append])
[DatFile_update | update an entry of the file]
bool DatFile->update(|int lineNr, array newEntry)
[DatFile_remove | remove an entry from the file]
bool DatFile->remove(|array lineNr)
[DatFile_toString | return file content as string (if available)]
string DatFile->toString()|
[DatFile_length | return the number of rows in the file]
int DatFile->length()|
[DbBlob_serialize | serialize this object to a string]
string DbBlob->serialize()|
[DbBlob_toString | get a string representation of this object]
string DbBlob->toString()|
[DbBlob_cloneObject | clone this object]
Object DbBlob->cloneObject()|
[DbBlob_getClass | get the class name of the instance]
string DbBlob->getClass()|
[DbBlob_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[DbBlob_read | <> read contents of resource]
bool DbBlob->read()|
[DbBlob_get | return stream contents]
string DbBlob->get()|
[DbBlob_getPath | get path to the resource]
string DbBlob->getPath()|
[DbBlob_exists | return true, if the input stream resource exists]
bool DbBlob->exists()|
[DbBlob_getLastModified | get time when file was last modified]
int DbBlob->getLastModified()|
[DbBlob_read | read file contents]
bool DbBlob->read()|
[DbBlob_failSafeRead | read file contents]
bool DbBlob->failSafeRead()|
[DbBlob_get | get file contents]
string DbBlob->get()|
[DbBlob_getFileContent | return file contents as string]
string DbBlob->getFileContent()|
[DbBlob_toString | alias of get()]
string DbBlob->toString()|
[DbBlob_isEmpty | returns bool(true) if the source is empty or not loaded]
bool DbBlob->isEmpty()|
[DbBlob_getCrc32 | return crc32 checksum for this file]
int DbBlob->getCrc32(|[string filename])
[DbBlob_getMd5 | return md5 hash for this file]
string DbBlob->getMd5(|[string filename])
[DbBlob_read | read file contents]
bool DbBlob->read()|
[DbBlob_getMimeType | get mime-type of this file]
string DbBlob->getMimeType()|
[DbBlob_getFilesize | get size of this file]
int DbBlob->getFilesize()|
[DbBlob_getFileId | read the current file id from the session vars]
string DbBlob::getFileId(|[int i], [bool fullsize])
[DbCreator_serialize | serialize this object to a string]
string DbCreator->serialize()|
[DbCreator_toString | get a string representation of this object]
string DbCreator->toString()|
[DbCreator_cloneObject | clone this object]
Object DbCreator->cloneObject()|
[DbCreator_getClass | get the class name of the instance]
string DbCreator->getClass()|
[DbCreator_DbCreator | create a new instance]
new DbCreator(|string/DbStructure &structure)
[DbCreator_createMySQL | create SQL for MySQL]
array DbCreator->createMySQL()|
[DbCreator_createPostgreSQL | create SQL for PostgreSQL]
array DbCreator->createPostgreSQL()|
[DbCreator_createMSSQL | create SQL for MS SQL Server]
array DbCreator->createMSSQL()|
[DbCreator_createMSAccess | create SQL for MS Access]
array DbCreator->createMSAccess()|
[DbCreator_createDB2 | create SQL for IBM DB2]
array DbCreator->createDB2()|
[DbCreator_createOracleDB | create SQL for Oracle]
array DbCreator->createOracleDB()|
[DbCreator_getStructure | get the currently set structure file]
DbStructure DbCreator->getStructure()|
[DbCreator_setStructure | set a new structure file]
bool DbCreator->setStructure(|string/DbStructure &structure)
[DbDatatype_serialize | serialize this object to a string]
string DbDatatype->serialize()|
[DbDatatype_toString | get a string representation of this object]
string DbDatatype->toString()|
[DbDatatype_cloneObject | clone this object]
Object DbDatatype->cloneObject()|
[DbDatatype_getClass | get the class name of the instance]
string DbDatatype->getClass()|
[DbDesigner4_serialize | serialize this object to a string]
string DbDesigner4->serialize()|
[DbDesigner4_toString | get a string representation of this object]
string DbDesigner4->toString()|
[DbDesigner4_cloneObject | clone this object]
Object DbDesigner4->cloneObject()|
[DbDesigner4_getClass | get the class name of the instance]
string DbDesigner4->getClass()|
[DbDesigner4_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[DbDesigner4_read | <> read contents of resource]
bool DbDesigner4->read()|
[DbDesigner4_get | return stream contents]
string DbDesigner4->get()|
[DbDesigner4_getPath | get path to the resource]
string DbDesigner4->getPath()|
[DbDesigner4_exists | return true, if the input stream resource exists]
bool DbDesigner4->exists()|
[DbDesigner4_getLastModified | get time when file was last modified]
int DbDesigner4->getLastModified()|
[DbDesigner4_read | read file contents]
bool DbDesigner4->read()|
[DbDesigner4_failSafeRead | read file contents]
bool DbDesigner4->failSafeRead()|
[DbDesigner4_get | get file contents]
string DbDesigner4->get()|
[DbDesigner4_getFileContent | return file contents as string]
string DbDesigner4->getFileContent()|
[DbDesigner4_toString | alias of get()]
string DbDesigner4->toString()|
[DbDesigner4_isEmpty | returns bool(true) if the source is empty or not loaded]
bool DbDesigner4->isEmpty()|
[DbDesigner4_getCrc32 | return crc32 checksum for this file]
int DbDesigner4->getCrc32(|[string filename])
[DbDesigner4_getMd5 | return md5 hash for this file]
string DbDesigner4->getMd5(|[string filename])
[DbDesigner4_insert | insert new content]
void DbDesigner4->insert(|scalar text)
[DbDesigner4_write | write file to system]
bool DbDesigner4->write()|
[DbDesigner4_getFilesize | get size of this file]
int DbDesigner4->getFilesize()|
[DbDesigner4_delete | delete this file]
bool DbDesigner4->delete()|
[DbDesigner4_failSafeWrite | failSafe writing of data]
bool DbDesigner4->failSafeWrite()|
[DbDesigner4_create | create the current file if it does not exist]
bool DbDesigner4->create()|
[DbDesigner4_isWriteable | return bool(true) if file is writeable]
bool DbDesigner4->isWriteable()|
[DbDesigner4_length | get the number of contents inside the file]
int DbDesigner4->length()|
[DbDesigner4_remove | remove an entry from the file]
bool DbDesigner4->remove(|[string key])
[DbDesigner4_getTableInfo | Return table info for current data]
array DbDesigner4->getTableInfo(|[string table])
[DbDesigner4_getStructure | Return database structure for current data]
DbStructure DbDesigner4->getStructure(|[string filename])
[DbExtractor_DbCreator | create a new instance]
new DbCreator(|string/DbStructure &structure)
[DbExtractor_createMySQL | create SQL for MySQL]
array DbExtractor->createMySQL()|
[DbExtractor_createPostgreSQL | create SQL for PostgreSQL]
array DbExtractor->createPostgreSQL()|
[DbExtractor_createMSSQL | create SQL for MS SQL Server]
array DbExtractor->createMSSQL()|
[DbExtractor_createMSAccess | create SQL for MS Access]
array DbExtractor->createMSAccess()|
[DbExtractor_createDB2 | create SQL for IBM DB2]
array DbExtractor->createDB2()|
[DbExtractor_createOracleDB | create SQL for Oracle]
array DbExtractor->createOracleDB()|
[DbExtractor_getStructure | get the currently set structure file]
DbStructure DbExtractor->getStructure()|
[DbExtractor_setStructure | set a new structure file]
bool DbExtractor->setStructure(|string/DbStructure &structure)
[DbExtractor_DbExtractor | create a new instance]
new DbExtractor(|DbStream/FileDb db)
[DbExtractor_createMySQL | create SQL for MySQL]
array DbExtractor->createMySQL(|[bool extractStructure], [bool extractData])
[DbExtractor_createPostgreSQL | create SQL for PostgreSQL]
array DbExtractor->createPostgreSQL(|[bool extractStructure], [bool extractData])
[DbExtractor_createMSSQL | create SQL for MS SQL Server]
array DbExtractor->createMSSQL(|[bool extractStructure], [bool extractData])
[DbExtractor_createMSAccess | create SQL for MS Access]
array DbExtractor->createMSAccess(|[bool extractStructure], [bool extractData])
[DbExtractor_createDB2 | create SQL for IBM DB2]
array DbExtractor->createDB2(|[bool extractStructure], [bool extractData])
[DbExtractor_createOracleDB | create SQL for Oracle]
array DbExtractor->createOracleDB(|[bool extractStructure], [bool extractData])
[DbExtractor_createXML | create XML]
string DbExtractor::createXML(|[bool useForeignKeys], [string/array structure], [string/array table], [array rows])
[DbExtractor_importMDB2 | import MDB2 schema to Yana structure files]
DbStructure DbExtractor::importMDB2(|string mdb2Schema)
[DbExtractor_importDbDesigner4 | import DBDesigner 4 configuration file to Yana structure files]
DbStructure DbExtractor::importDbDesigner4(|string dbDesignerConfig)
[DbInfoColumn_serialize | serialize this object to a string]
string DbInfoColumn->serialize()|
[DbInfoColumn_toString | get a string representation of this object]
string DbInfoColumn->toString()|
[DbInfoColumn_cloneObject | clone this object]
Object DbInfoColumn->cloneObject()|
[DbInfoColumn_getClass | get the class name of the instance]
string DbInfoColumn->getClass()|
[DbInfoTable_serialize | serialize this object to a string]
string DbInfoTable->serialize()|
[DbInfoTable_toString | get a string representation of this object]
string DbInfoTable->toString()|
[DbInfoTable_cloneObject | clone this object]
Object DbInfoTable->cloneObject()|
[DbInfoTable_getClass | get the class name of the instance]
string DbInfoTable->getClass()|
[DbMDB2_serialize | serialize this object to a string]
string DbMDB2->serialize()|
[DbMDB2_toString | get a string representation of this object]
string DbMDB2->toString()|
[DbMDB2_cloneObject | clone this object]
Object DbMDB2->cloneObject()|
[DbMDB2_getClass | get the class name of the instance]
string DbMDB2->getClass()|
[DbMDB2_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[DbMDB2_read | <> read contents of resource]
bool DbMDB2->read()|
[DbMDB2_get | return stream contents]
string DbMDB2->get()|
[DbMDB2_getPath | get path to the resource]
string DbMDB2->getPath()|
[DbMDB2_exists | return true, if the input stream resource exists]
bool DbMDB2->exists()|
[DbMDB2_getLastModified | get time when file was last modified]
int DbMDB2->getLastModified()|
[DbMDB2_read | read file contents]
bool DbMDB2->read()|
[DbMDB2_failSafeRead | read file contents]
bool DbMDB2->failSafeRead()|
[DbMDB2_get | get file contents]
string DbMDB2->get()|
[DbMDB2_getFileContent | return file contents as string]
string DbMDB2->getFileContent()|
[DbMDB2_toString | alias of get()]
string DbMDB2->toString()|
[DbMDB2_isEmpty | returns bool(true) if the source is empty or not loaded]
bool DbMDB2->isEmpty()|
[DbMDB2_getCrc32 | return crc32 checksum for this file]
int DbMDB2->getCrc32(|[string filename])
[DbMDB2_getMd5 | return md5 hash for this file]
string DbMDB2->getMd5(|[string filename])
[DbMDB2_insert | insert new content]
void DbMDB2->insert(|scalar text)
[DbMDB2_write | write file to system]
bool DbMDB2->write()|
[DbMDB2_getFilesize | get size of this file]
int DbMDB2->getFilesize()|
[DbMDB2_delete | delete this file]
bool DbMDB2->delete()|
[DbMDB2_failSafeWrite | failSafe writing of data]
bool DbMDB2->failSafeWrite()|
[DbMDB2_create | create the current file if it does not exist]
bool DbMDB2->create()|
[DbMDB2_isWriteable | return bool(true) if file is writeable]
bool DbMDB2->isWriteable()|
[DbMDB2_length | get the number of contents inside the file]
int DbMDB2->length()|
[DbMDB2_remove | remove an entry from the file]
bool DbMDB2->remove(|[string key])
[DbQuery_serialize | serialize this object to a string]
string DbQuery->serialize()|
[DbQuery_toString | get a string representation of this object]
string DbQuery->toString()|
[DbQuery_cloneObject | clone this object]
Object DbQuery->cloneObject()|
[DbQuery_getClass | get the class name of the instance]
string DbQuery->getClass()|
[DbQuery_DbQuery | create a new instance]
new DbQuery(|object database)
[DbQuery_resetQuery | reset query]
void DbQuery->resetQuery()|
[DbQuery_setType | select the kind of statement]
bool DbQuery->setType(|int type)
[DbQuery_getType | get the currently selected type of statement]
int DbQuery->getType()|
[DbQuery_useInheritance | deactivate automatic handling of inheritance]
bool DbQuery->useInheritance(|[bool state])
[DbQuery_getParentByColumn | get parent table by column name]
void DbQuery->getParentByColumn(|string column)
[DbQuery_getParent | get the parent of a table]
void DbQuery->getParent(|[string table])
[DbQuery_setTable | set source table]
bool DbQuery->setTable(|string table)
[DbQuery_getTable | get the currently selected table]
bool DbQuery->getTable()|
[DbQuery_setColumn | set source column]
bool DbQuery->setColumn(|[string column], [string arrayAddress])
[DbQuery_setColumns | set source columns]
bool DbQuery->setColumns(|[array columns])
[DbQuery_getColumn | get the currently selected column]
string DbQuery->getColumn(|[int i])
[DbQuery_getColumns | get the list of all selected columns]
array DbQuery->getColumns()|
[DbQuery_getArrayAddress | get the currently selected array address]
bool DbQuery->getArrayAddress()|
[DbQuery_setRow | set source row]
bool DbQuery->setRow(|scalar row)
[DbQuery_getRow | get the currently selected row]
string DbQuery->getRow()|
[DbQuery_setKey | resolve key address to determine table, column and row]
bool DbQuery->setKey(|string key)
[DbQuery_setOrderBy | set column to sort the resultset by]
bool DbQuery->setOrderBy(|string/array orderBy, [bool desc])
[DbQuery_getOrderBy | get the list of columns the resultset is ordered by]
array DbQuery->getOrderBy()|
[DbQuery_isDescending | check if resultset is sorted in descending order]
bool DbQuery->isDescending()|
[DbQuery_setWhere | set where clause (filter)]
bool DbQuery->setWhere(|[string/array where])
[DbQuery_getWhere | get the currently set where clause]
array DbQuery->getWhere()|
[DbQuery_setJoin | join the resultsets for two tables]
bool DbQuery->setJoin(|[string table], [string key1], [string key2])
[DbQuery_getJoin | get a list of the tables, the query has joined together]
array DbQuery->getJoin(|[string table])
[DbQuery_setValues | set value(s) for current query]
bool DbQuery->setValues(|mixed &values)
[DbQuery_getValues | get the list of values]
mixed DbQuery->getValues()|
[DbQuery_getLimit | get the currently selected limit]
int DbQuery->getLimit()|
[DbQuery_setLimit | set a limit for this query]
bool DbQuery->setLimit(|int limit)
[DbQuery_getOffset | get the currently selected offset]
int DbQuery->getOffset()|
[DbQuery_setOffset | set an offset for this query]
bool DbQuery->setOffset(|int offset)
[DbQuery_toString | build a SQL-query]
string DbQuery->toString()|
[DbQueryParser_DbQuery | create a new instance]
new DbQuery(|object database)
[DbQueryParser_resetQuery | reset query]
void DbQueryParser->resetQuery()|
[DbQueryParser_setType | select the kind of statement]
bool DbQueryParser->setType(|int type)
[DbQueryParser_getType | get the currently selected type of statement]
int DbQueryParser->getType()|
[DbQueryParser_useInheritance | deactivate automatic handling of inheritance]
bool DbQueryParser->useInheritance(|[bool state])
[DbQueryParser_getParentByColumn | get parent table by column name]
void DbQueryParser->getParentByColumn(|string column)
[DbQueryParser_getParent | get the parent of a table]
void DbQueryParser->getParent(|[string table])
[DbQueryParser_setTable | set source table]
bool DbQueryParser->setTable(|string table)
[DbQueryParser_getTable | get the currently selected table]
bool DbQueryParser->getTable()|
[DbQueryParser_setColumn | set source column]
bool DbQueryParser->setColumn(|[string column], [string arrayAddress])
[DbQueryParser_setColumns | set source columns]
bool DbQueryParser->setColumns(|[array columns])
[DbQueryParser_getColumn | get the currently selected column]
string DbQueryParser->getColumn(|[int i])
[DbQueryParser_getColumns | get the list of all selected columns]
array DbQueryParser->getColumns()|
[DbQueryParser_getArrayAddress | get the currently selected array address]
bool DbQueryParser->getArrayAddress()|
[DbQueryParser_setRow | set source row]
bool DbQueryParser->setRow(|scalar row)
[DbQueryParser_getRow | get the currently selected row]
string DbQueryParser->getRow()|
[DbQueryParser_setKey | resolve key address to determine table, column and row]
bool DbQueryParser->setKey(|string key)
[DbQueryParser_setOrderBy | set column to sort the resultset by]
bool DbQueryParser->setOrderBy(|string/array orderBy, [bool desc])
[DbQueryParser_getOrderBy | get the list of columns the resultset is ordered by]
array DbQueryParser->getOrderBy()|
[DbQueryParser_isDescending | check if resultset is sorted in descending order]
bool DbQueryParser->isDescending()|
[DbQueryParser_setWhere | set where clause (filter)]
bool DbQueryParser->setWhere(|[string/array where])
[DbQueryParser_getWhere | get the currently set where clause]
array DbQueryParser->getWhere()|
[DbQueryParser_setJoin | join the resultsets for two tables]
bool DbQueryParser->setJoin(|[string table], [string key1], [string key2])
[DbQueryParser_getJoin | get a list of the tables, the query has joined together]
array DbQueryParser->getJoin(|[string table])
[DbQueryParser_setValues | set value(s) for current query]
bool DbQueryParser->setValues(|mixed &values)
[DbQueryParser_getValues | get the list of values]
mixed DbQueryParser->getValues()|
[DbQueryParser_getLimit | get the currently selected limit]
int DbQueryParser->getLimit()|
[DbQueryParser_setLimit | set a limit for this query]
bool DbQueryParser->setLimit(|int limit)
[DbQueryParser_getOffset | get the currently selected offset]
int DbQueryParser->getOffset()|
[DbQueryParser_setOffset | set an offset for this query]
bool DbQueryParser->setOffset(|int offset)
[DbQueryParser_toString | build a SQL-query]
string DbQueryParser->toString()|
[DbQueryParser_DbQueryParser | create a new instance]
new DbQueryParser(|object database)
[DbQueryParser_parseSQL | parse SQL query into query object]
bool DbQueryParser->parseSQL(|string sqlStmt)
[DbServer_serialize | serialize this object to a string]
string DbServer->serialize()|
[DbServer_toString | get a string representation of this object]
string DbServer->toString()|
[DbServer_cloneObject | clone this object]
Object DbServer->cloneObject()|
[DbServer_getClass | get the class name of the instance]
string DbServer->getClass()|
[DbServer_DbServer | create a new instance]
new DbServer(|[array dsn])
[DbServer_get | get a PEAR-DB connection object]
mixed DbServer->get()|
[DbServer_getConnection | alias of DbServer::get()]
array DbServer->getConnection()|
[DbServer_getDsn | get the DSN]
array DbServer->getDsn()|
[DbStream_serialize | serialize this object to a string]
string DbStream->serialize()|
[DbStream_toString | get a string representation of this object]
string DbStream->toString()|
[DbStream_cloneObject | clone this object]
Object DbStream->cloneObject()|
[DbStream_getClass | get the class name of the instance]
string DbStream->getClass()|
[DbStream_DbStream | create a new instance]
new DbStream(|[string/DbStructure file], [dbServer server])
[DbStream_getDsn | get the DSN]
array DbStream->getDsn()|
[DbStream_commit | Alias of DbStream::write()]
bool DbStream->commit()|
[DbStream_write | Commit current transaction]
bool DbStream->write()|
[DbStream_get | get values from the database]
mixed DbStream->get(|array/string/DbQuery key, [array/string where], [array orderBy], [int offset], [int limit], [bool desc])
[DbStream_update | update a row or cell]
bool DbStream->update(|string/DbQuery key, [mixed value])
[DbStream_insertOrUpdate | update or insert row]
bool DbStream->insertOrUpdate(|string/DbQuery key, [mixed value])
[DbStream_insert | insert row]
bool DbStream->insert(|string/DbQuery key, [mixed value])
[DbStream_remove | remove one row]
bool DbStream->remove(|string/DbQuery key, [string/array where])
[DbStream_join | join the resultsets for two tables]
bool DbStream->join(|string table1, [string table2], [string key1], [string key2])
[DbStream_query | optional API bypass]
mixed DbStream->query(|string/DbQuery sqlStmt, [int offset], [int limit])
[DbStream_getTable | get the most recently queried table]
string DbStream->getTable()|
[DbStream_length | get the number of entries inside a table]
int DbStream->length(|[string/DbQuery table], [string/array search])
[DbStream_isEmpty | check wether a certain table has no entries]
bool DbStream->isEmpty(|[string table])
[DbStream_exists | Check wether a certain key exists]
bool DbStream->exists(|[string/DbQuery key])
[DbStream_isWriteable | check wether the current database is readonly]
bool DbStream->isWriteable()|
[DbStream_importSQL | import SQL from a file]
bool DbStream->importSQL(|string/array sqlFile)
[DbStream_toString | get CSV string from a table]
string DbStream->toString(|[string table])
[DbStream_exportStructure | export database structure to a file]
bool DbStream->exportStructure(|string filename)
[DbStream_getErrorMessage | get last reported error message]
string DbStream->getErrorMessage()|
[DbStream_getTableInfo | get table information]
array DbStream->getTableInfo(|string table)
[DbStream_reset | Reset the object to default values]
void DbStream->reset()|
[DbStream_rollback | Alias of DbStream::reset()]
void DbStream->rollback()|
[DbStream_equals | compare with another object]
string DbStream->equals(|object anotherObject)
[DbStructure_serialize | serialize this object to a string]
string DbStructure->serialize()|
[DbStructure_toString | get a string representation of this object]
string DbStructure->toString()|
[DbStructure_cloneObject | clone this object]
Object DbStructure->cloneObject()|
[DbStructure_getClass | get the class name of the instance]
string DbStructure->getClass()|
[DbStructure_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[DbStructure_read | <> read contents of resource]
bool DbStructure->read()|
[DbStructure_get | return stream contents]
string DbStructure->get()|
[DbStructure_getPath | get path to the resource]
string DbStructure->getPath()|
[DbStructure_exists | return true, if the input stream resource exists]
bool DbStructure->exists()|
[DbStructure_getLastModified | get time when file was last modified]
int DbStructure->getLastModified()|
[DbStructure_read | read file contents]
bool DbStructure->read()|
[DbStructure_failSafeRead | read file contents]
bool DbStructure->failSafeRead()|
[DbStructure_get | get file contents]
string DbStructure->get()|
[DbStructure_getFileContent | return file contents as string]
string DbStructure->getFileContent()|
[DbStructure_toString | alias of get()]
string DbStructure->toString()|
[DbStructure_isEmpty | returns bool(true) if the source is empty or not loaded]
bool DbStructure->isEmpty()|
[DbStructure_getCrc32 | return crc32 checksum for this file]
int DbStructure->getCrc32(|[string filename])
[DbStructure_getMd5 | return md5 hash for this file]
string DbStructure->getMd5(|[string filename])
[DbStructure_insert | insert new content]
void DbStructure->insert(|scalar text)
[DbStructure_write | write file to system]
bool DbStructure->write()|
[DbStructure_getFilesize | get size of this file]
int DbStructure->getFilesize()|
[DbStructure_delete | delete this file]
bool DbStructure->delete()|
[DbStructure_failSafeWrite | failSafe writing of data]
bool DbStructure->failSafeWrite()|
[DbStructure_create | create the current file if it does not exist]
bool DbStructure->create()|
[DbStructure_isWriteable | return bool(true) if file is writeable]
bool DbStructure->isWriteable()|
[DbStructure_length | get the number of contents inside the file]
int DbStructure->length()|
[DbStructure_remove | remove an entry from the file]
bool DbStructure->remove(|[string key])
[DbStructure_SML | constructor]
new SML(|string filename, [int case_sensitive])
[DbStructure_get | get a value from the file]
mixed DbStructure->get(|[string key])
[DbStructure_insert | insert an array into the file]
bool DbStructure->insert(|array array)
[DbStructure_getVar | Alias of SML->get(string $key)]
mixed DbStructure->getVar(|[string key])
[DbStructure_getVarByReference | Alias of SML->getByReference(string $key)]
mixed DbStructure->getVarByReference(|[string key])
[DbStructure_setVar | Alias of SML->insert(string $key, mixed $value)]
bool DbStructure->setVar(|string key, mixed value)
[DbStructure_setVarByReference | Set var by reference]
bool DbStructure->setVarByReference(|string key, mixed &value)
[DbStructure_set | set the content of the file]
bool DbStructure->set(|array array)
[DbStructure_reset | reset the file]
void DbStructure->reset()|
[DbStructure_toString | get a string representation]
string DbStructure->toString()|
[DbStructure_read | initialize file contents]
mixed DbStructure->read()|
[DbStructure_length | get the number of elements]
int DbStructure->length(|[string key])
[DbStructure_remove | remove an entry from the file]
bool DbStructure->remove(|[string key])
[DbStructure_exists | test if a certain value exists]
bool DbStructure->exists(|[string key])
[DbStructure_getFile | Read a file in SML syntax and return its contents]
array DbStructure::getFile(|array/string input, [int case_sensitive])
[DbStructure_encode | Create a SML string from a scalar variable, an object, or an array of data.]
void DbStructure::encode(|scalar/array/object data, [string name], [int case_sensitive], [int indent])
[DbStructure_decode | Read variables from an encoded string]
array DbStructure::decode(|string input, [int case_sensitive])
[DbStructure_getFileContent | return file contents as string]
string DbStructure->getFileContent()|
[DbStructure_DbStructure | constructor]
new DbStructure(|string filename)
[DbStructure_read | read and initialize the file]
array DbStructure->read()|
[DbStructure_getStructure | get the compiled structure of the database]
mixed DbStructure->getStructure()|
[DbStructure_getSource | get the file source]
mixed DbStructure->getSource()|
[DbStructure_isTable | check whether a table exists in the current structure]
bool DbStructure->isTable(|string table)
[DbStructure_addTable | add a new table]
bool DbStructure->addTable(|string table)
[DbStructure_renameTable | rename a table]
bool DbStructure->renameTable(|string oldTable, string newTable)
[DbStructure_dropTable | drop a table]
bool DbStructure->dropTable(|string table)
[DbStructure_isColumn | check whether a column exists in the current structure]
bool DbStructure->isColumn(|string table, string column)
[DbStructure_addColumn | add a new column]
bool DbStructure->addColumn(|string table, string column)
[DbStructure_renameColumn | rename a column]
bool DbStructure->renameColumn(|string table, string oldColumn, string newColumn)
[DbStructure_dropColumn | drop a column]
bool DbStructure->dropColumn(|string table, string column)
[DbStructure_setInit | set sql statements for initialization of a table]
bool DbStructure->setInit(|string table, [array statements])
[DbStructure_getInit | get sql statements for initialization of a table]
bool DbStructure->getInit(|[string table])
[DbStructure_isNullable | check whether a column allows NULL values]
bool DbStructure->isNullable(|string table, string column)
[DbStructure_setNullable | choose wether a column should be nullable]
bool DbStructure->setNullable(|string table, string column, bool isNullable)
[DbStructure_setAuto | auto-filled values]
bool DbStructure->setAuto(|string table, string column, [bool isAuto])
[DbStructure_isAuto | check whether a column uses the "autofill" feature]
bool DbStructure->isAuto(|string table, string column)
[DbStructure_isAutonumber | autoincrement]
bool DbStructure->isAutonumber(|string table, string column)
[DbStructure_hasIndex | check whether a column is indexed in the current structure]
bool DbStructure->hasIndex(|string table, string column)
[DbStructure_setIndex | remove an index on a column]
bool DbStructure->setIndex(|string table, string column, bool hasIndex)
[DbStructure_getProfile | check whether the table has a column containing a profile id]
string DbStructure->getProfile(|string table)
[DbStructure_setProfile | remove a profile reference on a column]
bool DbStructure->setProfile(|string table, [string column])
[DbStructure_isForeignKey | check whether a foreign key exists in the current structure]
bool DbStructure->isForeignKey(|string table, string column)
[DbStructure_setForeignKey | add a foreign key constraint]
bool DbStructure->setForeignKey(|[string table], string column, [string ftable])
[DbStructure_isPrimaryKey | check whether a primary key exists in the current structure]
bool DbStructure->isPrimaryKey(|string table, string column)
[DbStructure_isUnique | check whether a column has a unique constraint]
bool DbStructure->isUnique(|string table, string column)
[DbStructure_setUnique | remove a unique constraint on a column]
bool DbStructure->setUnique(|string table, string column, bool isUnique)
[DbStructure_isUnsigned | check whether a column is an unsigned number]
bool DbStructure->isUnsigned(|string table, string column)
[DbStructure_setUnsigned | set a column to an unsigned number]
bool DbStructure->setUnsigned(|string table, string column, bool isUnsigned)
[DbStructure_isZerofill | check whether a column is a number with the zerofill flag set]
bool DbStructure->isZerofill(|string table, string column)
[DbStructure_setZerofill | set a numeric column to zerofill]
bool DbStructure->setZerofill(|string table, string column, bool isZerofill)
[DbStructure_isNumber | check if column has a numeric data type]
bool DbStructure->isNumber(|string table, string column)
[DbStructure_getForeignKeys | return a list of foreign keys defined on a table]
array DbStructure->getForeignKeys(|string table)
[DbStructure_getPrimaryKey | get the primary key of a table]
string DbStructure->getPrimaryKey(|string table)
[DbStructure_setPrimaryKey | set the primary key of a table]
bool DbStructure->setPrimaryKey(|string table, string column)
[DbStructure_getDescription | get the user description of a column]
string DbStructure->getDescription(|[string table], [string column])
[DbStructure_setDescription | set the description property of a column]
bool DbStructure->setDescription(|string table, string column, string description)
[DbStructure_getLength | get the maximum length of a column as specified in the structure]
int DbStructure->getLength(|string table, string column)
[DbStructure_getPrecision | get the maximum length of the decimal fraction of a float]
int DbStructure->getPrecision(|string table, string column)
[DbStructure_setLength | set the maximum length property of a column]
bool DbStructure->setLength(|string table, string column, int length, [int precision])
[DbStructure_getType | get the data type of a field as specified in the structure]
string DbStructure->getType(|string table, string column)
[DbStructure_setType | set the type of a field as specified in the structure]
bool DbStructure->setType(|string table, string column, midex value)
[DbStructure_getImageSettings | get the properties of a field of type 'image']
array DbStructure->getImageSettings(|string table, string column)
[DbStructure_setImageSettings | set the properties of a field of type 'image']
array DbStructure->setImageSettings(|string table, string column, array settings)
[DbStructure_getColumnsByType | get a list of all columns that match a certain type]
array DbStructure->getColumnsByType(|string table, string type)
[DbStructure_getFiles | get a list of all columns that contain blobs]
array DbStructure->getFiles(|string table)
[DbStructure_getDefault | get the default value of a field as specified in the structure]
mixed DbStructure->getDefault(|string table, string column)
[DbStructure_setDefault | set the default value of a field as specified in the structure]
bool DbStructure->setDefault(|string table, string column, mixed value)
[DbStructure_getColumns | get the names of all columns in a table]
array DbStructure->getColumns(|string table)
[DbStructure_getTableByForeignKey | get the name of the table, a foreign key points to]
string DbStructure->getTableByForeignKey(|string table, string foreignKey)
[DbStructure_isStrict | check whether the structure defines the "USE_STRICT" setting as bool(true)]
bool DbStructure->isStrict()|
[DbStructure_setStrict | select whether the structure should use the "strict" directive]
void DbStructure->setStrict(|bool isStrict)
[DbStructure_getTables | get a list of all tables in the current database]
array DbStructure->getTables()|
[DbStructure_getIndexes | get a list of all indexed columns in a table]
array DbStructure->getIndexes(|string table)
[DbStructure_getUniqueConstraints | get a list of all unique columns of a table]
array DbStructure->getUniqueConstraints(|string table)
[DbStructure_getConstraint | get all constraints for an address]
array DbStructure->getConstraint(|string operation, string table, [array columns])
[DbStructure_setConstraint | set constraint]
bool DbStructure->setConstraint(|string constraint, string operation, [string table], [string column])
[DbStructure_getTrigger | get all triggers for an address]
array DbStructure->getTrigger(|int prefix, string operation, string table, [array columns])
[DbStructure_setTrigger | set trigger]
bool DbStructure->setTrigger(|string trigger, int prefix, string operation, [string table], [string column])
[DbStructure_isReadonly | check whether the "READONLY" flag is set to bool(true)]
bool DbStructure->isReadonly(|[string table], [string column])
[DbStructure_setReadonly | set the "readonly" property]
bool DbStructure->setReadonly(|bool isReadonly, [string table], [string column])
[DbStructure_isVisible | check whether the column should be visible]
bool DbStructure->isVisible(|string table, string column, [string action])
[DbStructure_setVisible | select whether the column should be visible]
bool DbStructure->setVisible(|bool/int isVisible, string table, string column, [string action])
[DbStructure_isNumericArray | check whether the column has a list-style type]
bool DbStructure->isNumericArray(|string table, string column)
[DbStructure_setNumericArray | set's the type of the column to be a numeric array]
bool DbStructure->setNumericArray(|string table, string column, [bool isNumeric])
[DbStructure_isEditable | check whether the column should be editable]
bool DbStructure->isEditable(|string table, string column, [string action])
[DbStructure_setEditable | select whether the column should be editable]
bool DbStructure->setEditable(|bool/int isEditable, string table, string column, [string action])
[DbStructure_getAction | get the action property of a field as specified in the structure]
mixed DbStructure->getAction(|string table, string column, [string namespace])
[DbStructure_getActions | get all columns of a table, where the action property is set]
array DbStructure->getActions(|string table)
[DbStructure_setAction | set the action property of a field]
mixed DbStructure->setAction(|string table, string column, [string action], [string namespace], [string linkText], [string tooltip])
[DbStructure_checkRow | validate a row against this file]
bool DbStructure->checkRow(|string table, mixed &row, [bool isInsert])
[DbStructure_untaintInput | untaint user input data with the help of the schema]
mixed DbStructure->untaintInput(|string table, string column, mixed value, [int escape])
[DbStructure_addFile | include structure file]
bool DbStructure->addFile(|string filename)
[DbStructure_getListOfFiles | return list of known structure files]
array DbStructure::getListOfFiles(|[bool fullFilename])
[DbStructure_getChangelog | get list of changes for your documentation purposes]
array DbStructure->getChangelog()|
[DbStructure_dropChangelog | flush the changelog]
bool DbStructure->dropChangelog()|
[DbTrigger_serialize | serialize this object to a string]
string DbTrigger->serialize()|
[DbTrigger_toString | get a string representation of this object]
string DbTrigger->toString()|
[DbTrigger_cloneObject | clone this object]
Object DbTrigger->cloneObject()|
[DbTrigger_getClass | get the class name of the instance]
string DbTrigger->getClass()|
[DbUpdater_DbCreator | create a new instance]
new DbCreator(|string/DbStructure &structure)
[DbUpdater_createMySQL | create SQL for MySQL]
array DbUpdater->createMySQL()|
[DbUpdater_createPostgreSQL | create SQL for PostgreSQL]
array DbUpdater->createPostgreSQL()|
[DbUpdater_createMSSQL | create SQL for MS SQL Server]
array DbUpdater->createMSSQL()|
[DbUpdater_createMSAccess | create SQL for MS Access]
array DbUpdater->createMSAccess()|
[DbUpdater_createDB2 | create SQL for IBM DB2]
array DbUpdater->createDB2()|
[DbUpdater_createOracleDB | create SQL for Oracle]
array DbUpdater->createOracleDB()|
[DbUpdater_getStructure | get the currently set structure file]
DbStructure DbUpdater->getStructure()|
[DbUpdater_setStructure | set a new structure file]
bool DbUpdater->setStructure(|string/DbStructure &structure)
[Dir_serialize | serialize this object to a string]
string Dir->serialize()|
[Dir_toString | get a string representation of this object]
string Dir->toString()|
[Dir_cloneObject | clone this object]
Object Dir->cloneObject()|
[Dir_getClass | get the class name of the instance]
string Dir->getClass()|
[Dir_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[Dir_read | <> read contents of resource]
bool Dir->read()|
[Dir_get | return stream contents]
string Dir->get()|
[Dir_getPath | get path to the resource]
string Dir->getPath()|
[Dir_exists | return true, if the input stream resource exists]
bool Dir->exists()|
[Dir_getLastModified | get time when file was last modified]
int Dir->getLastModified()|
[Dir_Dir | constructor]
new Dir(|string path)
[Dir_read | read contents and put results in cache (filter settings will be applied)]
bool Dir->read()|
[Dir_get | return list of files within the directory]
array Dir->get()|
[Dir_create | create this directory]
bool Dir->create(|[int mode])
[Dir_delete | remove this directory]
bool Dir->delete(|[bool isRecursive])
[Dir_toString | return a string representation of this directory]
string Dir->toString()|
[Dir_isEmpty | check wether the directory has no contents]
bool Dir->isEmpty()|
[Dir_length | get the number of files inside the directory]
int Dir->length()|
[Dir_dirlist | list contents of a directory]
new dirlist(|string filter)
[Dir_getSize | get size of directory]
int Dir->getSize(|[string directory], [bool copySubDirs], [bool useCache])
[Dir_exists | check if directory exists and is readable]
bool Dir->exists()|
[Dir_copy | copy the directory to some destination]
bool Dir->copy(|string destDir, [bool overwrite], [int mode], [bool copySubDirs], [string fileFilter], [string dirFilter], [bool useRegExp])
[ErrorUtility_setErrorReporting | Set error reporting level]
void ErrorUtility::setErrorReporting(|integer/string errorLevel)
[Executeable_serialize | serialize this object to a string]
string Executeable->serialize()|
[Executeable_toString | get a string representation of this object]
string Executeable->toString()|
[Executeable_cloneObject | clone this object]
Object Executeable->cloneObject()|
[Executeable_getClass | get the class name of the instance]
string Executeable->getClass()|
[Executeable_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[Executeable_read | <> read contents of resource]
bool Executeable->read()|
[Executeable_get | return stream contents]
string Executeable->get()|
[Executeable_getPath | get path to the resource]
string Executeable->getPath()|
[Executeable_exists | return true, if the input stream resource exists]
bool Executeable->exists()|
[Executeable_getLastModified | get time when file was last modified]
int Executeable->getLastModified()|
[Executeable_read | include a php file]
bool Executeable->read()|
[File_serialize | serialize this object to a string]
string File->serialize()|
[File_toString | get a string representation of this object]
string File->toString()|
[File_cloneObject | clone this object]
Object File->cloneObject()|
[File_getClass | get the class name of the instance]
string File->getClass()|
[File_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[File_read | <> read contents of resource]
bool File->read()|
[File_get | return stream contents]
string File->get()|
[File_getPath | get path to the resource]
string File->getPath()|
[File_exists | return true, if the input stream resource exists]
bool File->exists()|
[File_getLastModified | get time when file was last modified]
int File->getLastModified()|
[File_read | read file contents]
bool File->read()|
[File_failSafeRead | read file contents]
bool File->failSafeRead()|
[File_get | get file contents]
string File->get()|
[File_getFileContent | return file contents as string]
string File->getFileContent()|
[File_toString | alias of get()]
string File->toString()|
[File_isEmpty | returns bool(true) if the source is empty or not loaded]
bool File->isEmpty()|
[File_getCrc32 | return crc32 checksum for this file]
int File->getCrc32(|[string filename])
[File_getMd5 | return md5 hash for this file]
string File->getMd5(|[string filename])
[File_insert | insert new content]
void File->insert(|scalar text)
[File_write | write file to system]
bool File->write()|
[File_getFilesize | get size of this file]
int File->getFilesize()|
[File_delete | delete this file]
bool File->delete()|
[File_failSafeWrite | failSafe writing of data]
bool File->failSafeWrite()|
[File_create | create the current file if it does not exist]
bool File->create()|
[File_isWriteable | return bool(true) if file is writeable]
bool File->isWriteable()|
[File_length | get the number of contents inside the file]
int File->length()|
[File_remove | remove an entry from the file]
bool File->remove(|[string key])
[FileDb_DbStream | create a new instance]
new DbStream(|[string/DbStructure file], [dbServer server])
[FileDb_getDsn | get the DSN]
array FileDb->getDsn()|
[FileDb_commit | Alias of DbStream::write()]
bool FileDb->commit()|
[FileDb_write | Commit current transaction]
bool FileDb->write()|
[FileDb_get | get values from the database]
mixed FileDb->get(|array/string/DbQuery key, [array/string where], [array orderBy], [int offset], [int limit], [bool desc])
[FileDb_update | update a row or cell]
bool FileDb->update(|string/DbQuery key, [mixed value])
[FileDb_insertOrUpdate | update or insert row]
bool FileDb->insertOrUpdate(|string/DbQuery key, [mixed value])
[FileDb_insert | insert row]
bool FileDb->insert(|string/DbQuery key, [mixed value])
[FileDb_remove | remove one row]
bool FileDb->remove(|string/DbQuery key, [string/array where])
[FileDb_join | join the resultsets for two tables]
bool FileDb->join(|string table1, [string table2], [string key1], [string key2])
[FileDb_query | optional API bypass]
mixed FileDb->query(|string/DbQuery sqlStmt, [int offset], [int limit])
[FileDb_getTable | get the most recently queried table]
string FileDb->getTable()|
[FileDb_length | get the number of entries inside a table]
int FileDb->length(|[string/DbQuery table], [string/array search])
[FileDb_isEmpty | check wether a certain table has no entries]
bool FileDb->isEmpty(|[string table])
[FileDb_exists | Check wether a certain key exists]
bool FileDb->exists(|[string/DbQuery key])
[FileDb_isWriteable | check wether the current database is readonly]
bool FileDb->isWriteable()|
[FileDb_importSQL | import SQL from a file]
bool FileDb->importSQL(|string/array sqlFile)
[FileDb_toString | get CSV string from a table]
string FileDb->toString(|[string table])
[FileDb_exportStructure | export database structure to a file]
bool FileDb->exportStructure(|string filename)
[FileDb_getErrorMessage | get last reported error message]
string FileDb->getErrorMessage()|
[FileDb_getTableInfo | get table information]
array FileDb->getTableInfo(|string table)
[FileDb_reset | Reset the object to default values]
void FileDb->reset()|
[FileDb_rollback | Alias of DbStream::reset()]
void FileDb->rollback()|
[FileDb_equals | compare with another object]
string FileDb->equals(|object anotherObject)
[FileDb_FileDb | constructor]
new FileDb(|[string filename])
[FileDb_getTableInfo | get table information]
array FileDb->getTableInfo(|string table)
[FileDbConnection_serialize | serialize this object to a string]
string FileDbConnection->serialize()|
[FileDbConnection_toString | get a string representation of this object]
string FileDbConnection->toString()|
[FileDbConnection_cloneObject | clone this object]
Object FileDbConnection->cloneObject()|
[FileDbConnection_getClass | get the class name of the instance]
string FileDbConnection->getClass()|
[FileDbIndex_serialize | serialize this object to a string]
string FileDbIndex->serialize()|
[FileDbIndex_toString | get a string representation of this object]
string FileDbIndex->toString()|
[FileDbIndex_cloneObject | clone this object]
Object FileDbIndex->cloneObject()|
[FileDbIndex_getClass | get the class name of the instance]
string FileDbIndex->getClass()|
[FileDbResult_serialize | serialize this object to a string]
string FileDbResult->serialize()|
[FileDbResult_toString | get a string representation of this object]
string FileDbResult->toString()|
[FileDbResult_cloneObject | clone this object]
Object FileDbResult->cloneObject()|
[FileDbResult_getClass | get the class name of the instance]
string FileDbResult->getClass()|
[FileReadonly_serialize | serialize this object to a string]
string FileReadonly->serialize()|
[FileReadonly_toString | get a string representation of this object]
string FileReadonly->toString()|
[FileReadonly_cloneObject | clone this object]
Object FileReadonly->cloneObject()|
[FileReadonly_getClass | get the class name of the instance]
string FileReadonly->getClass()|
[FileReadonly_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[FileReadonly_read | <> read contents of resource]
bool FileReadonly->read()|
[FileReadonly_get | return stream contents]
string FileReadonly->get()|
[FileReadonly_getPath | get path to the resource]
string FileReadonly->getPath()|
[FileReadonly_exists | return true, if the input stream resource exists]
bool FileReadonly->exists()|
[FileReadonly_getLastModified | get time when file was last modified]
int FileReadonly->getLastModified()|
[FileReadonly_read | read file contents]
bool FileReadonly->read()|
[FileReadonly_failSafeRead | read file contents]
bool FileReadonly->failSafeRead()|
[FileReadonly_get | get file contents]
string FileReadonly->get()|
[FileReadonly_getFileContent | return file contents as string]
string FileReadonly->getFileContent()|
[FileReadonly_toString | alias of get()]
string FileReadonly->toString()|
[FileReadonly_isEmpty | returns bool(true) if the source is empty or not loaded]
bool FileReadonly->isEmpty()|
[FileReadonly_getCrc32 | return crc32 checksum for this file]
int FileReadonly->getCrc32(|[string filename])
[FileReadonly_getMd5 | return md5 hash for this file]
string FileReadonly->getMd5(|[string filename])
[FileSystemResource_serialize | serialize this object to a string]
string FileSystemResource->serialize()|
[FileSystemResource_toString | get a string representation of this object]
string FileSystemResource->toString()|
[FileSystemResource_cloneObject | clone this object]
Object FileSystemResource->cloneObject()|
[FileSystemResource_getClass | get the class name of the instance]
string FileSystemResource->getClass()|
[FileSystemResource_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[FileSystemResource_read | <> read contents of resource]
bool FileSystemResource->read()|
[FileSystemResource_get | return stream contents]
string FileSystemResource->get()|
[FileSystemResource_getPath | get path to the resource]
string FileSystemResource->getPath()|
[FileSystemResource_exists | return true, if the input stream resource exists]
bool FileSystemResource->exists()|
[FileSystemResource_getLastModified | get time when file was last modified]
int FileSystemResource->getLastModified()|
[FloodFile_insert | insert new content]
void FloodFile->insert(|scalar text)
[FloodFile_write | write file to system]
bool FloodFile->write()|
[FloodFile_getFilesize | get size of this file]
int FloodFile->getFilesize()|
[FloodFile_delete | delete this file]
bool FloodFile->delete()|
[FloodFile_failSafeWrite | failSafe writing of data]
bool FloodFile->failSafeWrite()|
[FloodFile_create | create the current file if it does not exist]
bool FloodFile->create()|
[FloodFile_isWriteable | return bool(true) if file is writeable]
bool FloodFile->isWriteable()|
[FloodFile_length | get the number of contents inside the file]
int FloodFile->length()|
[FloodFile_remove | remove an entry from the file]
bool FloodFile->remove(|[string key])
[FormCreator_serialize | serialize this object to a string]
string FormCreator->serialize()|
[FormCreator_toString | get a string representation of this object]
string FormCreator->toString()|
[FormCreator_cloneObject | clone this object]
Object FormCreator->cloneObject()|
[FormCreator_getClass | get the class name of the instance]
string FormCreator->getClass()|
[FormCreator_FormCreator | create a new instance]
new FormCreator()|
[FormCreator_setTemplate | select a template for output]
bool FormCreator->setTemplate(|int/string template, [int layout])
[FormCreator_getTemplate | get the currently selected template file]
bool FormCreator->getTemplate()|
[FormCreator_setFile | set source file]
bool FormCreator->setFile(|string file)
[FormCreator_getFile | get the currently selected file]
bool FormCreator->getFile()|
[FormCreator_enableAdvancedSearch | off]
bool FormCreator->enableAdvancedSearch(|[bool advancedSearch])
[FormCreator_getAdvancedSearch | off)]
bool FormCreator->getAdvancedSearch()|
[FormCreator_allowNewEntry | trigger wether the user should be allowed to create new entries]
bool FormCreator->allowNewEntry(|[bool allowNewEntry])
[FormCreator_setTable | set source table]
bool FormCreator->setTable(|string table)
[FormCreator_setColumns | select columns to view in form]
bool FormCreator->setColumns(|[array columns])
[FormCreator_getColumns | get selected columns]
array FormCreator->getColumns()|
[FormCreator_getTable | get the currently selected table]
bool FormCreator->getTable()|
[FormCreator_setAction | set action for an event]
bool FormCreator->setAction(|string name, string value)
[FormCreator_getAction | get action for an event]
bool FormCreator->getAction(|string name)
[FormCreator_setDownloadAction | set download action]
bool FormCreator->setDownloadAction(|string action)
[FormCreator_getDownloadAction | get download action]
bool FormCreator->getDownloadAction()|
[FormCreator_setEditAction | set edit action]
bool FormCreator->setEditAction(|string action)
[FormCreator_getEditAction | get edit action]
bool FormCreator->getEditAction()|
[FormCreator_setNewAction | set new action]
bool FormCreator->setNewAction(|string action)
[FormCreator_getNewAction | get new action]
bool FormCreator->getNewAction()|
[FormCreator_setDeleteAction | set delete action]
bool FormCreator->setDeleteAction(|string action)
[FormCreator_getDeleteAction | get delete action]
bool FormCreator->getDeleteAction()|
[FormCreator_setSearchAction | set search action]
bool FormCreator->setSearchAction(|string action)
[FormCreator_getSearchAction | get search action]
bool FormCreator->getSearchAction()|
[FormCreator_getNamespace | get namespace]
string FormCreator->getNamespace()|
[FormCreator_enableTitles | off]
bool FormCreator->enableTitles(|[bool titles])
[FormCreator_getTitles | off)]
bool FormCreator->getTitles()|
[FormCreator_enableArrayKeys | off]
bool FormCreator->enableArrayKeys(|[bool arrayKeys])
[FormCreator_getArrayKeys | off)]
bool FormCreator->getArrayKeys()|
[FormCreator_setSort | set column to sort the resultset by]
bool FormCreator->setSort(|[string orderBy], [bool desc])
[FormCreator_getSort | get the name of the column the resultset is ordered by]
bool FormCreator->getSort()|
[FormCreator_isDescending | check if resultset is sorted in descending order]
bool FormCreator->isDescending()|
[FormCreator_setPage | set current page]
bool FormCreator->setPage(|[int page])
[FormCreator_setEntriesPerPage | set number of entries per page]
bool FormCreator->setEntriesPerPage(|[int entries])
[FormCreator_getPage | get the currently selected page]
bool FormCreator->getPage()|
[FormCreator_getEntriesPerPage | get number of entries to show per page]
bool FormCreator->getEntriesPerPage()|
[FormCreator_setWhere | set where clause (filter)]
bool FormCreator->setWhere(|[string/array where], [bool replace])
[FormCreator_getWhere | get the currently set where clause]
bool FormCreator->getWhere()|
[FormCreator_hasFilter | check if a filter is set on a column]
bool FormCreator->hasFilter(|string column)
[FormCreator_getRows | get result rows]
array FormCreator->getRows()|
[FormCreator_getFormdata | get data from posted form]
array FormCreator::getFormdata(|int form, string/DbStructure source, string table, [array data], [array columns])
[FormCreator_createForm | create a form from the current instance and return it]
string FormCreator->createForm()|
[FormMailer_serialize | serialize this object to a string]
string FormMailer->serialize()|
[FormMailer_toString | get a string representation of this object]
string FormMailer->toString()|
[FormMailer_cloneObject | clone this object]
Object FormMailer->cloneObject()|
[FormMailer_getClass | get the class name of the instance]
string FormMailer->getClass()|
[FormMailer_FormMailer | constructor]
new FormMailer()|
[FormMailer_send | send an e-mail]
bool FormMailer->send(|string recipient)
[FormMailer_mail | create an automatically formated e.mail from an array of form data]
bool FormMailer::mail(|string recipient, string subject, array &formdata)
[Hashtable_get | retrieve a value]
mixed Hashtable::get(|array &hash, string key)
[Hashtable_setByReference | set an element by Reference]
bool Hashtable::setByReference(|array &hash, string key, mixed &value)
[Hashtable_set | set an element to a value]
bool Hashtable::set(|array &hash, string key, mixed value)
[Hashtable_setType | set the data type of an element]
bool Hashtable::setType(|array &hash, string key, string type)
[Hashtable_exists | check if an element exists]
bool Hashtable::exists(|array &hash, string key)
[Hashtable_remove | remove an element]
bool Hashtable::remove(|array &hash, string key)
[Hashtable_changeCase | Lowercase or uppercase all keys of an associative array]
array Hashtable::changeCase(|array input, [int/bool case])
[Hashtable_merge | recursively merge two arrays to one]
array Hashtable::merge(|array A, array B)
[Image_serialize | serialize this object to a string]
string Image->serialize()|
[Image_toString | get a string representation of this object]
string Image->toString()|
[Image_cloneObject | clone this object]
Object Image->cloneObject()|
[Image_getClass | get the class name of the instance]
string Image->getClass()|
[Image_Image | create a new instance of this class]
new Image(|[string filename], [string imageType])
[Image_getPath | get filename]
string Image->getPath()|
[Image_exists | return true, if the image exists]
bool Image->exists()|
[Image_isBroken | return true, if the image is broken]
bool Image->isBroken()|
[Image_isTruecolor | check if image is truecolor]
bool Image->isTruecolor()|
[Image_cloneObject | clone this object]
Object Image->cloneObject()|
[Image_equals | compare with another object]
bool Image->equals(|object anotherObject)
[Image_getResource | get the image resource]
resource Image->getResource()|
[Image_clearCanvas | This function produces a new image]
void Image->clearCanvas()|
[Image_getWidth | get image width]
int Image->getWidth()|
[Image_getHeight | get image height]
int Image->getHeight()|
[Image_drawPoint | draw a point (aka paint a pixel)]
bool Image->drawPoint(|int x, int y, [int color])
[Image_drawLine | draw a line]
bool Image->drawLine(|int x1, int y1, int x2, int y2, [int color])
[Image_drawString | draw a text string]
bool Image->drawString(|string text, [int x], [int y], [int color], [int font], [bool asVerticalString])
[Image_drawFormattedString | draw a formatted text string with a true-type font]
bool Image->drawFormattedString(|string text, [int x], [int y], [int color], [string fontfile], [int fontsize], [int angle])
[Image_drawEllipse | draw an ellipse]
bool Image->drawEllipse(|int x, int y, int width, [int height], [int color], [int fillColor], [int start], [int end])
[Image_drawRectangle | draw a rectangle]
bool Image->drawRectangle(|int x, int y, int width, [int height], [int color], [int fillColor])
[Image_drawPolygon | draw a polygon]
bool Image->drawPolygon(|array points, [int x], [int y], [int color], [int fillColor])
[Image_fill | fill with a color]
array Image->fill(|int fillColor, [int x], [int y], [int borderColor])
[Image_enableAlpha | disable alpha blending]
bool Image->enableAlpha(|[bool isEnabled], [bool saveAlpha])
[Image_enableAntialias | disable antialiasing]
bool Image->enableAntialias(|[bool isEnabled])
[Image_getFontWidth | get font width]
int Image::getFontWidth(|int font)
[Image_getFontHeight | get font width]
int Image::getFontHeight(|int font)
[Image_getColorValues | get color values (red,green,blue,alpha)]
array Image->getColorValues(|int color)
[Image_getColorAt | get color at pixel ($x,$y)]
int Image->getColorAt(|int x, int y)
[Image_getSize | get image info]
array Image::getSize(|string filename)
[Image_getColor | get a color for the current index]
int Image->getColor(|int r, int g, int b, [float opacity])
[Image_getLineWidth | get current line width]
int Image->getLineWidth()|
[Image_setLineWidth | set line width]
bool Image->setLineWidth(|int width)
[Image_setLineStyle | set line style]
bool Image->setLineStyle()|
[Image_replaceIndexColor | replace one palette color by another]
bool Image->replaceIndexColor(|int replacedColor, array/int newColor)
[Image_replaceColor | replace a color]
bool Image->replaceColor(|int replacedColor, int newColor)
[Image_setBrush | set current brush]
bool Image->setBrush(|string/Image/Brush/resource brush)
[Image_setBackgroundColor | set current background color]
bool Image->setBackgroundColor(|[int backgroundColor], [bool replaceOldColor])
[Image_getBackgroundColor | get current background color]
int Image->getBackgroundColor()|
[Image_isInterlaced | Check if image is interlaced]
bool Image->isInterlaced()|
[Image_enableInterlace | off]
bool Image->enableInterlace(|[bool isInterlaced])
[Image_hasAlpha | Check if image has alpha channel]
bool Image->hasAlpha()|
[Image_setGamma | set gamma correction]
bool Image->setGamma(|float gamma)
[Image_rotate | Rotate the image]
bool Image->rotate(|float angle)
[Image_resizeCanvas | Resize the canvas]
bool Image->resizeCanvas(|[int width], [int height], [int paddingLeft], [int paddingTop], [array canvasColor])
[Image_resizeImage | Resize the image]
bool Image->resizeImage(|[int width], [int height])
[Image_resize | Resize the image]
bool Image->resize(|[int width], [int height])
[Image_getTransparency | get current transparency color]
int Image->getTransparency()|
[Image_setTransparency | set transparency to a color]
bool Image->setTransparency(|[int/array transparency])
[Image_getPaletteSize | get number of colors in palette]
int Image->getPaletteSize()|
[Image_reduceColorDepth | reduce color depth to value]
bool Image->reduceColorDepth(|int ammount, [bool dither])
[Image_copyRegion | copy one portion of an image to another]
bool Image->copyRegion(|Image/string/resource sourceImage, [int sourceX], [int sourceY], [int width], [int height], [int destX], [int destY], [float opacity])
[Image_toGrayscale | convert a colored image to grayscale]
void Image->toGrayscale()|
[Image_toGreyscale | alias of Image::toGrayscale()]
void Image->toGreyscale()|
[Image_monochromatic | create a monochromatic image]
bool Image->monochromatic(|int r, int g, int b)
[Image_brightness | darken the image]
bool Image->brightness(|float ammount)
[Image_contrast | remove contrast from the image]
bool Image->contrast(|float ammount)
[Image_negate | procude negative image]
bool Image->negate()|
[Image_applyFilter | apply a filter]
bool Image->applyFilter(|int filter, int arg1, int arg2, int arg3)
[Image_colorize | colorize the image]
bool Image->colorize(|int r, int g, int b)
[Image_multiply | multiply the palette values with a color]
bool Image->multiply(|int r, int g, int b)
[Image_blur | blur the image]
bool Image->blur(|float ammount)
[Image_sharpen | sharpen the image]
bool Image->sharpen(|float ammount)
[Image_flipX | flip the image horizontally]
bool Image->flipX()|
[Image_flipY | flip the image vertically]
bool Image->flipY()|
[Image_copyPalette | copy palette]
bool Image->copyPalette(|Image/string/resource sourceImage)
[Image_outputToScreen | output image to browser]
bool Image->outputToScreen(|[string imageType])
[Image_outputToFile | output image to a file]
string Image->outputToFile(|string filename, [string imageType])
[Image_uploadFile | upload an image file]
string Image::uploadFile(|string fromId, string toFilename, [string imageType], [int maxSize], [int width], [int height], [bool keepAspectRatio], [array backgroundColor])
[Image_compareImage | compare this image to another]
float Image->compareImage(|Image/string otherImage)
[Image_toString | get a string representation of this object]
string Image->toString()|
[Brush_serialize | serialize this object to a string]
string Brush->serialize()|
[Brush_toString | get a string representation of this object]
string Brush->toString()|
[Brush_cloneObject | clone this object]
Object Brush->cloneObject()|
[Brush_getClass | get the class name of the instance]
string Brush->getClass()|
[Brush_Brush | create a new instance of this class]
new Brush(|[string brushname])
[Brush_getName | get name of this brush]
string Brush->getName()|
[Brush_setSourceDirectory | set the directory that contains the brushes]
bool Brush->setSourceDirectory(|string directory)
[Brush_getSize | get brush size]
int Brush->getSize()|
[Brush_setSize | Resize the brush]
bool Brush->setSize(|int size)
[Brush_setColor | set the color of this brush]
string Brush->setColor(|int r, int g, int b)
[Brush_getColor | get the color of this brush]
array Brush->getColor()|
[Brush_toString | get a string representation of this object]
string Brush->toString()|
[Brush_cloneObject | clone this object]
Object Brush->cloneObject()|
[Brush_equals | compare with another object]
bool Brush->equals(|object anotherObject)
[Language_serialize | serialize this object to a string]
string Language->serialize()|
[Language_toString | get a string representation of this object]
string Language->toString()|
[Language_cloneObject | clone this object]
Object Language->cloneObject()|
[Language_getClass | get the class name of the instance]
string Language->getClass()|
[Language_getSelectedLanguage | get name of selected language]
string Language->getSelectedLanguage()|
[Language_read | read language strings from a file]
bool Language->read(|string filename)
[Mailer_serialize | serialize this object to a string]
string Mailer->serialize()|
[Mailer_toString | get a string representation of this object]
string Mailer->toString()|
[Mailer_cloneObject | clone this object]
Object Mailer->cloneObject()|
[Mailer_getClass | get the class name of the instance]
string Mailer->getClass()|
[Mailer_SmartTemplate | create an instance]
new SmartTemplate(|[string filename])
[Mailer_get | fetch a template or template var]
mixed Mailer->get(|[string key], [bool overwrite])
[Mailer_write | output the template to screen]
void Mailer->write()|
[Mailer_getSmarty | bypass template class]
Smarty Mailer->getSmarty()|
[Mailer_insert | assign a variable by value]
bool Mailer->insert(|string varName, mixed var)
[Mailer_insertByReference | assign a variable by reference]
bool Mailer->insertByReference(|string varName, mixed &var)
[Mailer_insertFile | insert a file]
bool Mailer->insertFile(|string varName, string filename)
[Mailer_setPath | set filename of current template]
bool Mailer->setPath(|string filename)
[Mailer_getPath | get path and name of current template]
string Mailer->getPath()|
[Mailer_setFunction | Register function]
bool Mailer->setFunction(|int as, string name, mixed code)
[Mailer_unsetFunction | Unregister function]
bool Mailer->unsetFunction(|int as, string name)
[Mailer_send | send an e.mail]
bool Mailer->send(|string recipient)
[Mailer_mail | send an e.mail]
bool Mailer::mail(|string recipient, string subject, string text, [array header])
[Microsummary_get | get a microsummary]
bool Microsummary->get(|string id)
[Microsummary_set | set a microsummary]
bool Microsummary->set(|string id, string text)
[Object_serialize | serialize this object to a string]
string Object->serialize()|
[Object_toString | get a string representation of this object]
string Object->toString()|
[Object_cloneObject | clone this object]
Object Object->cloneObject()|
[Object_getClass | get the class name of the instance]
string Object->getClass()|
[Plugin_Plugin | constructor]
new Plugin(|string name)
[Plugin__default | <> default event handler]
bool Plugin->_default(|string event, array ARGS)
[PluginManager_serialize | serialize this object to a string]
string PluginManager->serialize()|
[PluginManager_toString | get a string representation of this object]
string PluginManager->toString()|
[PluginManager_cloneObject | clone this object]
Object PluginManager->cloneObject()|
[PluginManager_getClass | get the class name of the instance]
string PluginManager->getClass()|
[PluginManager_handle | broadcast an event to all plugins]
bool PluginManager->handle(|string event, array args, [string criteria])
[PluginManager_get | get a file from a virtual drive]
string PluginManager->get(|string pluginName, string key)
[PluginManager_isInstalled | check if a specific plugin is installed]
bool PluginManager->isInstalled(|string pluginName)
[PluginManager_getPluginDir | get the name of the directory where plugins are installed]
string PluginManager->getPluginDir()|
[Registry_read | read file contents]
bool Registry->read()|
[Registry_failSafeRead | read file contents]
bool Registry->failSafeRead()|
[Registry_get | get file contents]
string Registry->get()|
[Registry_getFileContent | return file contents as string]
string Registry->getFileContent()|
[Registry_toString | alias of get()]
string Registry->toString()|
[Registry_isEmpty | returns bool(true) if the source is empty or not loaded]
bool Registry->isEmpty()|
[Registry_getCrc32 | return crc32 checksum for this file]
int Registry->getCrc32(|[string filename])
[Registry_getMd5 | return md5 hash for this file]
string Registry->getMd5(|[string filename])
[Registry_VDrive | constructor]
new VDrive(|string path, [array options], [string baseDir], [int mode])
[Registry_addDrive | add another drive to repository]
bool Registry->addDrive(|string filename, string baseDir)
[Registry_mount | mount an unmounted virtual drive]
bool Registry->mount(|string key)
[Registry_read | read the virtual drive]
bool Registry->read()|
[Registry_toString | get string represenation of a virtual drive]
string Registry->toString()|
[Registry_get | get a mountpoint]
bool Registry->get(|string key)
[Registry_getVar | retrieves var from registry]
mixed Registry->getVar(|[string key])
[Registry_getVarByReference | retrieves var from registry and returns it by reference]
mixed Registry->getVarByReference(|[string key])
[Registry_setVarByReference | sets var on registry by Reference]
bool Registry->setVarByReference(|string key, mixed &value, [bool overwrite])
[Registry_setVar | sets var on registry]
bool Registry->setVar(|string key, mixed value, [bool overwrite])
[Registry_merge | merges the value at adresse $key with the provided array data]
bool Registry->merge(|string key, array array, [bool overwrite])
[Registry_unsetVar | removes var from registry]
bool Registry->unsetVar(|string key)
[Report_Report | constructor]
new Report(|string message, [mixed data])
[Report_getLog | create log]
string Report->getLog(|[string prefix])
[Report_getMessage | returns the message string of this event]
string Report->getMessage()|
[Alert_Report | constructor]
new Report(|string message, [mixed data])
[Alert_getLog | create log]
string Alert->getLog(|[string prefix])
[Alert_getMessage | returns the message string of this event]
string Alert->getMessage()|
[Alert_message | constructor]
new message(|array/string message, [mixed data])
[Error_Report | constructor]
new Report(|string message, [mixed data])
[Error_getLog | create log]
string Error->getLog(|[string prefix])
[Error_getMessage | returns the message string of this event]
string Error->getMessage()|
[Error_message | constructor]
new message(|array/string message, [mixed data])
[Log_Report | constructor]
new Report(|string message, [mixed data])
[Log_getLog | create log]
string Log->getLog(|[string prefix])
[Log_getMessage | returns the message string of this event]
string Log->getMessage()|
[Message_Report | constructor]
new Report(|string message, [mixed data])
[Message_getLog | create log]
string Message->getLog(|[string prefix])
[Message_getMessage | returns the message string of this event]
string Message->getMessage()|
[Message_message | constructor]
new message(|array/string message, [mixed data])
[Warning_message | constructor]
new message(|array/string message, [mixed data])
[RSS_serialize | serialize this object to a string]
string RSS->serialize()|
[RSS_toString | get a string representation of this object]
string RSS->toString()|
[RSS_cloneObject | clone this object]
Object RSS->cloneObject()|
[RSS_getClass | get the class name of the instance]
string RSS->getClass()|
[RSS_RSS | constructor]
new RSS()|
[RSS_toString | get string value]
bool RSS->toString()|
[RSS_addItem | add RSS feed item to this channel]
bool RSS->addItem(|RSSitem item)
[RSSitem_serialize | serialize this object to a string]
string RSSitem->serialize()|
[RSSitem_toString | get a string representation of this object]
string RSSitem->toString()|
[RSSitem_cloneObject | clone this object]
Object RSSitem->cloneObject()|
[RSSitem_getClass | get the class name of the instance]
string RSSitem->getClass()|
[RSSitem_RSSitem | constructor]
new RSSitem()|
[SessionManager_serialize | serialize this object to a string]
string SessionManager->serialize()|
[SessionManager_toString | get a string representation of this object]
string SessionManager->toString()|
[SessionManager_cloneObject | clone this object]
Object SessionManager->cloneObject()|
[SessionManager_getClass | get the class name of the instance]
string SessionManager->getClass()|
[Singleton_serialize | serialize this object to a string]
string Singleton->serialize()|
[Singleton_toString | get a string representation of this object]
string Singleton->toString()|
[Singleton_cloneObject | clone this object]
Object Singleton->cloneObject()|
[Singleton_getClass | get the class name of the instance]
string Singleton->getClass()|
[SmartTemplate_serialize | serialize this object to a string]
string SmartTemplate->serialize()|
[SmartTemplate_toString | get a string representation of this object]
string SmartTemplate->toString()|
[SmartTemplate_cloneObject | clone this object]
Object SmartTemplate->cloneObject()|
[SmartTemplate_getClass | get the class name of the instance]
string SmartTemplate->getClass()|
[SmartTemplate_SmartTemplate | create an instance]
new SmartTemplate(|[string filename])
[SmartTemplate_get | fetch a template or template var]
mixed SmartTemplate->get(|[string key], [bool overwrite])
[SmartTemplate_write | output the template to screen]
void SmartTemplate->write()|
[SmartTemplate_getSmarty | bypass template class]
Smarty SmartTemplate->getSmarty()|
[SmartTemplate_insert | assign a variable by value]
bool SmartTemplate->insert(|string varName, mixed var)
[SmartTemplate_insertByReference | assign a variable by reference]
bool SmartTemplate->insertByReference(|string varName, mixed &var)
[SmartTemplate_insertFile | insert a file]
bool SmartTemplate->insertFile(|string varName, string filename)
[SmartTemplate_setPath | set filename of current template]
bool SmartTemplate->setPath(|string filename)
[SmartTemplate_getPath | get path and name of current template]
string SmartTemplate->getPath()|
[SmartTemplate_setFunction | Register function]
bool SmartTemplate->setFunction(|int as, string name, mixed code)
[SmartTemplate_unsetFunction | Unregister function]
bool SmartTemplate->unsetFunction(|int as, string name)
[SmartView_SmartTemplate | create an instance]
new SmartTemplate(|[string filename])
[SmartView_get | fetch a template or template var]
mixed SmartView->get(|[string key], [bool overwrite])
[SmartView_write | output the template to screen]
void SmartView->write()|
[SmartView_getSmarty | bypass template class]
Smarty SmartView->getSmarty()|
[SmartView_insert | assign a variable by value]
bool SmartView->insert(|string varName, mixed var)
[SmartView_insertByReference | assign a variable by reference]
bool SmartView->insertByReference(|string varName, mixed &var)
[SmartView_insertFile | insert a file]
bool SmartView->insertFile(|string varName, string filename)
[SmartView_setPath | set filename of current template]
bool SmartView->setPath(|string filename)
[SmartView_getPath | get path and name of current template]
string SmartView->getPath()|
[SmartView_setFunction | Register function]
bool SmartView->setFunction(|int as, string name, mixed code)
[SmartView_unsetFunction | Unregister function]
bool SmartView->unsetFunction(|int as, string name)
[SmartView_setTemplates | select template by template id]
bool SmartView->setTemplates(|[string frameTemplate], [string embeddedTemplate])
[SmartView_getTemplate | get id of selected template]
string SmartView->getTemplate(|[int i])
[SmartView_showMessage | output a message to browser and terminate the program]
void SmartView->showMessage(|string type, string errcode, [string event], [string template])
[SML_insert | insert new content]
void SML->insert(|scalar text)
[SML_write | write file to system]
bool SML->write()|
[SML_getFilesize | get size of this file]
int SML->getFilesize()|
[SML_delete | delete this file]
bool SML->delete()|
[SML_failSafeWrite | failSafe writing of data]
bool SML->failSafeWrite()|
[SML_create | create the current file if it does not exist]
bool SML->create()|
[SML_isWriteable | return bool(true) if file is writeable]
bool SML->isWriteable()|
[SML_length | get the number of contents inside the file]
int SML->length()|
[SML_remove | remove an entry from the file]
bool SML->remove(|[string key])
[SML_SML | constructor]
new SML(|string filename, [int case_sensitive])
[SML_get | get a value from the file]
mixed SML->get(|[string key])
[SML_insert | insert an array into the file]
bool SML->insert(|array array)
[SML_getVar | Alias of SML->get(string $key)]
mixed SML->getVar(|[string key])
[SML_getVarByReference | Alias of SML->getByReference(string $key)]
mixed SML->getVarByReference(|[string key])
[SML_setVar | Alias of SML->insert(string $key, mixed $value)]
bool SML->setVar(|string key, mixed value)
[SML_setVarByReference | Set var by reference]
bool SML->setVarByReference(|string key, mixed &value)
[SML_set | set the content of the file]
bool SML->set(|array array)
[SML_reset | reset the file]
void SML->reset()|
[SML_toString | get a string representation]
string SML->toString()|
[SML_read | initialize file contents]
mixed SML->read()|
[SML_length | get the number of elements]
int SML->length(|[string key])
[SML_remove | remove an entry from the file]
bool SML->remove(|[string key])
[SML_exists | test if a certain value exists]
bool SML->exists(|[string key])
[SML_getFile | Read a file in SML syntax and return its contents]
array SML::getFile(|array/string input, [int case_sensitive])
[SML_encode | Create a SML string from a scalar variable, an object, or an array of data.]
void SML::encode(|scalar/array/object data, [string name], [int case_sensitive], [int indent])
[SML_decode | Read variables from an encoded string]
array SML::decode(|string input, [int case_sensitive])
[SML_getFileContent | return file contents as string]
string SML->getFileContent()|
[String_serialize | serialize this object to a string]
string String->serialize()|
[String_toString | get a string representation of this object]
string String->toString()|
[String_cloneObject | clone this object]
Object String->cloneObject()|
[String_getClass | get the class name of the instance]
string String->getClass()|
[String_String | create new instance]
new String(|string value)
[String_get | get string value]
string String->get()|
[String_set | set string value]
string String->set(|string value)
[String_toString | Alias of: String::get()]
void String->toString()|
[String_toInt | return value as int]
int String->toInt()|
[String_toFloat | return value as float]
float String->toFloat()|
[String_toBool | return value as boolean]
bool String->toBool()|
[String_addSlashes | OO-Alias of: addslashes(), addcslashes()]
string String->addSlashes(|[string charlist])
[String_removeSlashes | OO-Alias of: stripslashes(), stripcslashes()]
string String->removeSlashes(|string charlist)
[String_charAt | OO-Alias of: $string[$index]]
void String->charAt(|int index)
[String_trim | OO-Alias of: trim(), chop()]
string String->trim()|
[String_encrypt | hashing function, encryption, transformation (not revertable)]
string String->encrypt(|[string encryption], [string salt])
[String_encode | encoding, or converting a string (revertable)]
string String->encode(|string encoding, [string style], [string charset])
[String_decode | decode a string (revertable)]
string String->decode(|string encoding, [int style], [string charset])
[String_toLowerCase | return a lower-cased version of the string]
string String->toLowerCase()|
[String_toUpperCase | return a upper-cased version of the string]
string String->toUpperCase()|
[String_substring | extract a substring]
string String->substring(|int start, [int length])
[String_equals | test two strings for equality]
bool String->equals(|mixed something)
[String_compareTo | compare two strings]
int String->compareTo(|string anotherString)
[String_compareToIgnoreCase | compare two strings (ignore case)]
int String->compareToIgnoreCase(|string anotherString)
[String_match | match string against regular expression]
array String->match(|string regularExpression)
[String_matchAll | match string against regular expression (return all results)]
array String->matchAll(|string regularExpression)
[String_replace | replace a needle with a substitute]
int String->replace(|string needle, [string substitute])
[String_replaceRegExp | replace a substring by using a regular expression]
int String->replaceRegExp(|string regularExpression, [string substitute], [int limit])
[String_length | get the length of the string]
int String->length()|
[String_split | convert string to an array]
array String->split(|string separator, [int limit])
[String_splitRegExp | convert string to an array by using regular expression to find a speratator]
array String->splitRegExp(|string separator, [int limit])
[String_indexOf | get position of first occurence of a needle inside the string]
int String->indexOf(|string needle, [int offset])
[String_wrap | wrap a long text]
string String->wrap(|[int width], [string break], [bool cut])
[String_shuffle | shuffle the string's characters]
string String->shuffle()|
[String_reverse | reverse the string value]
string String->reverse()|
[String_cloneObject | clone the string]
String String->cloneObject()|
[String_copy | alias of cloneObject()]
String String->copy()|
[String_htmlEntities | convert to html entities]
string String::htmlEntities(|string input)
[String_htmlSpecialChars | convert html special characters]
string String::htmlSpecialChars(|string string, [int quoteStyle], [string charset], [bool doubleEncode])
[VDrive_read | read file contents]
bool VDrive->read()|
[VDrive_failSafeRead | read file contents]
bool VDrive->failSafeRead()|
[VDrive_get | get file contents]
string VDrive->get()|
[VDrive_getFileContent | return file contents as string]
string VDrive->getFileContent()|
[VDrive_toString | alias of get()]
string VDrive->toString()|
[VDrive_isEmpty | returns bool(true) if the source is empty or not loaded]
bool VDrive->isEmpty()|
[VDrive_getCrc32 | return crc32 checksum for this file]
int VDrive->getCrc32(|[string filename])
[VDrive_getMd5 | return md5 hash for this file]
string VDrive->getMd5(|[string filename])
[VDrive_VDrive | constructor]
new VDrive(|string path, [array options], [string baseDir], [int mode])
[VDrive_addDrive | add another drive to repository]
bool VDrive->addDrive(|string filename, string baseDir)
[VDrive_mount | mount an unmounted virtual drive]
bool VDrive->mount(|string key)
[VDrive_read | read the virtual drive]
bool VDrive->read()|
[VDrive_toString | get string represenation of a virtual drive]
string VDrive->toString()|
[VDrive_get | get a mountpoint]
bool VDrive->get(|string key)
[VDrive_dir_serialize | serialize this object to a string]
string VDrive_dir->serialize()|
[VDrive_dir_toString | get a string representation of this object]
string VDrive_dir->toString()|
[VDrive_dir_cloneObject | clone this object]
Object VDrive_dir->cloneObject()|
[VDrive_dir_getClass | get the class name of the instance]
string VDrive_dir->getClass()|
[VDrive_file_serialize | serialize this object to a string]
string VDrive_file->serialize()|
[VDrive_file_toString | get a string representation of this object]
string VDrive_file->toString()|
[VDrive_file_cloneObject | clone this object]
Object VDrive_file->cloneObject()|
[VDrive_file_getClass | get the class name of the instance]
string VDrive_file->getClass()|
[VDrive_mountpoint_serialize | serialize this object to a string]
string VDrive_mountpoint->serialize()|
[VDrive_mountpoint_toString | get a string representation of this object]
string VDrive_mountpoint->toString()|
[VDrive_mountpoint_cloneObject | clone this object]
Object VDrive_mountpoint->cloneObject()|
[VDrive_mountpoint_getClass | get the class name of the instance]
string VDrive_mountpoint->getClass()|
[Yana_Yana | <> Constructor]
new Yana(|string filename, array ARGS)
[Yana_handle | handle an event]
bool $GLOBALS["YANA"]->handle(|[string event], [array ARGS])
[Yana_getRequestVar | get a value from the request vars]
mixed $GLOBALS["YANA"]->getRequestVar(|[string key], [int method])
[Yana_getId | returns the current profile id]
string $GLOBALS["YANA"]->getId()|
[Yana_getVar | get value from registry]
mixed $GLOBALS["YANA"]->getVar(|string key)
[Yana_setVarByReference | sets var on registry by Reference]
bool $GLOBALS["YANA"]->setVarByReference(|string key, mixed &value)
[Yana_setVar | sets var on registry]
bool $GLOBALS["YANA"]->setVar(|string key, mixed value)
[Yana_setType | sets the type of a var on registry (memory shared by all plugins)]
bool $GLOBALS["YANA"]->setType(|string key, string type)
[Yana_unsetVar | remove var from registry]
bool $GLOBALS["YANA"]->unsetVar(|string key)
[Yana_merge | merges value in registry]
bool $GLOBALS["YANA"]->merge(|string key, array array)
[Yana_report | adds an entry to the log-queue]
void $GLOBALS["YANA"]->report(|Report log)
[Yana_exitTo | exit the current script]
void $GLOBALS["YANA"]->exitTo(|[string event])
[Yana_writeView | provides GUI from current data]
void $GLOBALS["YANA"]->writeView()|
[Yana_getMode | get mode of current action]
int $GLOBALS["YANA"]->getMode()|
[Yana_getDefault | get default configuration value]
mixed $GLOBALS["YANA"]->getDefault(|string key)
[Yana_clearCache | clear system cache]
void Yana::clearCache()|
[Yana_connect | <> connect()]
mixed $GLOBALS["YANA"]->connect(|string source)
[GuiCreator_FormCreator | create a new instance]
new FormCreator()|
[GuiCreator_setTemplate | select a template for output]
bool GuiCreator->setTemplate(|int/string template, [int layout])
[GuiCreator_getTemplate | get the currently selected template file]
bool GuiCreator->getTemplate()|
[GuiCreator_setFile | set source file]
bool GuiCreator->setFile(|string file)
[GuiCreator_getFile | get the currently selected file]
bool GuiCreator->getFile()|
[GuiCreator_enableAdvancedSearch | off]
bool GuiCreator->enableAdvancedSearch(|[bool advancedSearch])
[GuiCreator_getAdvancedSearch | off)]
bool GuiCreator->getAdvancedSearch()|
[GuiCreator_allowNewEntry | trigger wether the user should be allowed to create new entries]
bool GuiCreator->allowNewEntry(|[bool allowNewEntry])
[GuiCreator_setTable | set source table]
bool GuiCreator->setTable(|string table)
[GuiCreator_setColumns | select columns to view in form]
bool GuiCreator->setColumns(|[array columns])
[GuiCreator_getColumns | get selected columns]
array GuiCreator->getColumns()|
[GuiCreator_getTable | get the currently selected table]
bool GuiCreator->getTable()|
[GuiCreator_setAction | set action for an event]
bool GuiCreator->setAction(|string name, string value)
[GuiCreator_getAction | get action for an event]
bool GuiCreator->getAction(|string name)
[GuiCreator_setDownloadAction | set download action]
bool GuiCreator->setDownloadAction(|string action)
[GuiCreator_getDownloadAction | get download action]
bool GuiCreator->getDownloadAction()|
[GuiCreator_setEditAction | set edit action]
bool GuiCreator->setEditAction(|string action)
[GuiCreator_getEditAction | get edit action]
bool GuiCreator->getEditAction()|
[GuiCreator_setNewAction | set new action]
bool GuiCreator->setNewAction(|string action)
[GuiCreator_getNewAction | get new action]
bool GuiCreator->getNewAction()|
[GuiCreator_setDeleteAction | set delete action]
bool GuiCreator->setDeleteAction(|string action)
[GuiCreator_getDeleteAction | get delete action]
bool GuiCreator->getDeleteAction()|
[GuiCreator_setSearchAction | set search action]
bool GuiCreator->setSearchAction(|string action)
[GuiCreator_getSearchAction | get search action]
bool GuiCreator->getSearchAction()|
[GuiCreator_getNamespace | get namespace]
string GuiCreator->getNamespace()|
[GuiCreator_enableTitles | off]
bool GuiCreator->enableTitles(|[bool titles])
[GuiCreator_getTitles | off)]
bool GuiCreator->getTitles()|
[GuiCreator_enableArrayKeys | off]
bool GuiCreator->enableArrayKeys(|[bool arrayKeys])
[GuiCreator_getArrayKeys | off)]
bool GuiCreator->getArrayKeys()|
[GuiCreator_setSort | set column to sort the resultset by]
bool GuiCreator->setSort(|[string orderBy], [bool desc])
[GuiCreator_getSort | get the name of the column the resultset is ordered by]
bool GuiCreator->getSort()|
[GuiCreator_isDescending | check if resultset is sorted in descending order]
bool GuiCreator->isDescending()|
[GuiCreator_setPage | set current page]
bool GuiCreator->setPage(|[int page])
[GuiCreator_setEntriesPerPage | set number of entries per page]
bool GuiCreator->setEntriesPerPage(|[int entries])
[GuiCreator_getPage | get the currently selected page]
bool GuiCreator->getPage()|
[GuiCreator_getEntriesPerPage | get number of entries to show per page]
bool GuiCreator->getEntriesPerPage()|
[GuiCreator_setWhere | set where clause (filter)]
bool GuiCreator->setWhere(|[string/array where], [bool replace])
[GuiCreator_getWhere | get the currently set where clause]
bool GuiCreator->getWhere()|
[GuiCreator_hasFilter | check if a filter is set on a column]
bool GuiCreator->hasFilter(|string column)
[GuiCreator_getRows | get result rows]
array GuiCreator->getRows()|
[GuiCreator_getFormdata | get data from posted form]
array GuiCreator::getFormdata(|int form, string/DbStructure source, string table, [array data], [array columns])
[GuiCreator_createForm | create a form from the current instance and return it]
string GuiCreator->createForm()|
[InputStream_FileSystemResource | constructor]
new FileSystemResource(|string filename)
[InputStream_read | <> read contents of resource]
bool InputStream->read()|
[InputStream_get | return stream contents]
string InputStream->get()|
[InputStream_getPath | get path to the resource]
string InputStream->getPath()|
[InputStream_exists | return true, if the input stream resource exists]
bool InputStream->exists()|
[InputStream_getLastModified | get time when file was last modified]
int InputStream->getLastModified()|
[SecureInputStream_read | read file contents]
bool SecureInputStream->read()|
[SecureInputStream_failSafeRead | read file contents]
bool SecureInputStream->failSafeRead()|
[SecureInputStream_get | get file contents]
string SecureInputStream->get()|
[SecureInputStream_getFileContent | return file contents as string]
string SecureInputStream->getFileContent()|
[SecureInputStream_toString | alias of get()]
string SecureInputStream->toString()|
[SecureInputStream_isEmpty | returns bool(true) if the source is empty or not loaded]
bool SecureInputStream->isEmpty()|
[SecureInputStream_getCrc32 | return crc32 checksum for this file]
int SecureInputStream->getCrc32(|[string filename])
[SecureInputStream_getMd5 | return md5 hash for this file]
string SecureInputStream->getMd5(|[string filename])
[SecureFileStream_insert | insert new content]
void SecureFileStream->insert(|scalar text)
[SecureFileStream_write | write file to system]
bool SecureFileStream->write()|
[SecureFileStream_getFilesize | get size of this file]
int SecureFileStream->getFilesize()|
[SecureFileStream_delete | delete this file]
bool SecureFileStream->delete()|
[SecureFileStream_failSafeWrite | failSafe writing of data]
bool SecureFileStream->failSafeWrite()|
[SecureFileStream_create | create the current file if it does not exist]
bool SecureFileStream->create()|
[SecureFileStream_isWriteable | return bool(true) if file is writeable]
bool SecureFileStream->isWriteable()|
[SecureFileStream_length | get the number of contents inside the file]
int SecureFileStream->length()|
[SecureFileStream_remove | remove an entry from the file]
bool SecureFileStream->remove(|[string key])
[DirStream_Dir | constructor]
new Dir(|string path)
[DirStream_read | read contents and put results in cache (filter settings will be applied)]
bool DirStream->read()|
[DirStream_get | return list of files within the directory]
array DirStream->get()|
[DirStream_create | create this directory]
bool DirStream->create(|[int mode])
[DirStream_delete | remove this directory]
bool DirStream->delete(|[bool isRecursive])
[DirStream_toString | return a string representation of this directory]
string DirStream->toString()|
[DirStream_isEmpty | check wether the directory has no contents]
bool DirStream->isEmpty()|
[DirStream_length | get the number of files inside the directory]
int DirStream->length()|
[DirStream_dirlist | list contents of a directory]
new dirlist(|string filter)
[DirStream_getSize | get size of directory]
int DirStream->getSize(|[string directory], [bool copySubDirs], [bool useCache])
[DirStream_exists | check if directory exists and is readable]
bool DirStream->exists()|
[DirStream_copy | copy the directory to some destination]
bool DirStream->copy(|string destDir, [bool overwrite], [int mode], [bool copySubDirs], [string fileFilter], [string dirFilter], [bool useRegExp])
[StructureFile_DbStructure | constructor]
new DbStructure(|string filename)
[StructureFile_read | read and initialize the file]
array StructureFile->read()|
[StructureFile_getStructure | get the compiled structure of the database]
mixed StructureFile->getStructure()|
[StructureFile_getSource | get the file source]
mixed StructureFile->getSource()|
[StructureFile_isTable | check whether a table exists in the current structure]
bool StructureFile->isTable(|string table)
[StructureFile_addTable | add a new table]
bool StructureFile->addTable(|string table)
[StructureFile_renameTable | rename a table]
bool StructureFile->renameTable(|string oldTable, string newTable)
[StructureFile_dropTable | drop a table]
bool StructureFile->dropTable(|string table)
[StructureFile_isColumn | check whether a column exists in the current structure]
bool StructureFile->isColumn(|string table, string column)
[StructureFile_addColumn | add a new column]
bool StructureFile->addColumn(|string table, string column)
[StructureFile_renameColumn | rename a column]
bool StructureFile->renameColumn(|string table, string oldColumn, string newColumn)
[StructureFile_dropColumn | drop a column]
bool StructureFile->dropColumn(|string table, string column)
[StructureFile_setInit | set sql statements for initialization of a table]
bool StructureFile->setInit(|string table, [array statements])
[StructureFile_getInit | get sql statements for initialization of a table]
bool StructureFile->getInit(|[string table])
[StructureFile_isNullable | check whether a column allows NULL values]
bool StructureFile->isNullable(|string table, string column)
[StructureFile_setNullable | choose wether a column should be nullable]
bool StructureFile->setNullable(|string table, string column, bool isNullable)
[StructureFile_setAuto | auto-filled values]
bool StructureFile->setAuto(|string table, string column, [bool isAuto])
[StructureFile_isAuto | check whether a column uses the "autofill" feature]
bool StructureFile->isAuto(|string table, string column)
[StructureFile_isAutonumber | autoincrement]
bool StructureFile->isAutonumber(|string table, string column)
[StructureFile_hasIndex | check whether a column is indexed in the current structure]
bool StructureFile->hasIndex(|string table, string column)
[StructureFile_setIndex | remove an index on a column]
bool StructureFile->setIndex(|string table, string column, bool hasIndex)
[StructureFile_getProfile | check whether the table has a column containing a profile id]
string StructureFile->getProfile(|string table)
[StructureFile_setProfile | remove a profile reference on a column]
bool StructureFile->setProfile(|string table, [string column])
[StructureFile_isForeignKey | check whether a foreign key exists in the current structure]
bool StructureFile->isForeignKey(|string table, string column)
[StructureFile_setForeignKey | add a foreign key constraint]
bool StructureFile->setForeignKey(|[string table], string column, [string ftable])
[StructureFile_isPrimaryKey | check whether a primary key exists in the current structure]
bool StructureFile->isPrimaryKey(|string table, string column)
[StructureFile_isUnique | check whether a column has a unique constraint]
bool StructureFile->isUnique(|string table, string column)
[StructureFile_setUnique | remove a unique constraint on a column]
bool StructureFile->setUnique(|string table, string column, bool isUnique)
[StructureFile_isUnsigned | check whether a column is an unsigned number]
bool StructureFile->isUnsigned(|string table, string column)
[StructureFile_setUnsigned | set a column to an unsigned number]
bool StructureFile->setUnsigned(|string table, string column, bool isUnsigned)
[StructureFile_isZerofill | check whether a column is a number with the zerofill flag set]
bool StructureFile->isZerofill(|string table, string column)
[StructureFile_setZerofill | set a numeric column to zerofill]
bool StructureFile->setZerofill(|string table, string column, bool isZerofill)
[StructureFile_isNumber | check if column has a numeric data type]
bool StructureFile->isNumber(|string table, string column)
[StructureFile_getForeignKeys | return a list of foreign keys defined on a table]
array StructureFile->getForeignKeys(|string table)
[StructureFile_getPrimaryKey | get the primary key of a table]
string StructureFile->getPrimaryKey(|string table)
[StructureFile_setPrimaryKey | set the primary key of a table]
bool StructureFile->setPrimaryKey(|string table, string column)
[StructureFile_getDescription | get the user description of a column]
string StructureFile->getDescription(|[string table], [string column])
[StructureFile_setDescription | set the description property of a column]
bool StructureFile->setDescription(|string table, string column, string description)
[StructureFile_getLength | get the maximum length of a column as specified in the structure]
int StructureFile->getLength(|string table, string column)
[StructureFile_getPrecision | get the maximum length of the decimal fraction of a float]
int StructureFile->getPrecision(|string table, string column)
[StructureFile_setLength | set the maximum length property of a column]
bool StructureFile->setLength(|string table, string column, int length, [int precision])
[StructureFile_getType | get the data type of a field as specified in the structure]
string StructureFile->getType(|string table, string column)
[StructureFile_setType | set the type of a field as specified in the structure]
bool StructureFile->setType(|string table, string column, midex value)
[StructureFile_getImageSettings | get the properties of a field of type 'image']
array StructureFile->getImageSettings(|string table, string column)
[StructureFile_setImageSettings | set the properties of a field of type 'image']
array StructureFile->setImageSettings(|string table, string column, array settings)
[StructureFile_getColumnsByType | get a list of all columns that match a certain type]
array StructureFile->getColumnsByType(|string table, string type)
[StructureFile_getFiles | get a list of all columns that contain blobs]
array StructureFile->getFiles(|string table)
[StructureFile_getDefault | get the default value of a field as specified in the structure]
mixed StructureFile->getDefault(|string table, string column)
[StructureFile_setDefault | set the default value of a field as specified in the structure]
bool StructureFile->setDefault(|string table, string column, mixed value)
[StructureFile_getColumns | get the names of all columns in a table]
array StructureFile->getColumns(|string table)
[StructureFile_getTableByForeignKey | get the name of the table, a foreign key points to]
string StructureFile->getTableByForeignKey(|string table, string foreignKey)
[StructureFile_isStrict | check whether the structure defines the "USE_STRICT" setting as bool(true)]
bool StructureFile->isStrict()|
[StructureFile_setStrict | select whether the structure should use the "strict" directive]
void StructureFile->setStrict(|bool isStrict)
[StructureFile_getTables | get a list of all tables in the current database]
array StructureFile->getTables()|
[StructureFile_getIndexes | get a list of all indexed columns in a table]
array StructureFile->getIndexes(|string table)
[StructureFile_getUniqueConstraints | get a list of all unique columns of a table]
array StructureFile->getUniqueConstraints(|string table)
[StructureFile_getConstraint | get all constraints for an address]
array StructureFile->getConstraint(|string operation, string table, [array columns])
[StructureFile_setConstraint | set constraint]
bool StructureFile->setConstraint(|string constraint, string operation, [string table], [string column])
[StructureFile_getTrigger | get all triggers for an address]
array StructureFile->getTrigger(|int prefix, string operation, string table, [array columns])
[StructureFile_setTrigger | set trigger]
bool StructureFile->setTrigger(|string trigger, int prefix, string operation, [string table], [string column])
[StructureFile_isReadonly | check whether the "READONLY" flag is set to bool(true)]
bool StructureFile->isReadonly(|[string table], [string column])
[StructureFile_setReadonly | set the "readonly" property]
bool StructureFile->setReadonly(|bool isReadonly, [string table], [string column])
[StructureFile_isVisible | check whether the column should be visible]
bool StructureFile->isVisible(|string table, string column, [string action])
[StructureFile_setVisible | select whether the column should be visible]
bool StructureFile->setVisible(|bool/int isVisible, string table, string column, [string action])
[StructureFile_isNumericArray | check whether the column has a list-style type]
bool StructureFile->isNumericArray(|string table, string column)
[StructureFile_setNumericArray | set's the type of the column to be a numeric array]
bool StructureFile->setNumericArray(|string table, string column, [bool isNumeric])
[StructureFile_isEditable | check whether the column should be editable]
bool StructureFile->isEditable(|string table, string column, [string action])
[StructureFile_setEditable | select whether the column should be editable]
bool StructureFile->setEditable(|bool/int isEditable, string table, string column, [string action])
[StructureFile_getAction | get the action property of a field as specified in the structure]
mixed StructureFile->getAction(|string table, string column, [string namespace])
[StructureFile_getActions | get all columns of a table, where the action property is set]
array StructureFile->getActions(|string table)
[StructureFile_setAction | set the action property of a field]
mixed StructureFile->setAction(|string table, string column, [string action], [string namespace], [string linkText], [string tooltip])
[StructureFile_checkRow | validate a row against this file]
bool StructureFile->checkRow(|string table, mixed &row, [bool isInsert])
[StructureFile_untaintInput | untaint user input data with the help of the schema]
mixed StructureFile->untaintInput(|string table, string column, mixed value, [int escape])
[StructureFile_addFile | include structure file]
bool StructureFile->addFile(|string filename)
[StructureFile_getListOfFiles | return list of known structure files]
array StructureFile::getListOfFiles(|[bool fullFilename])
[StructureFile_getChangelog | get list of changes for your documentation purposes]
array StructureFile->getChangelog()|
[StructureFile_dropChangelog | flush the changelog]
bool StructureFile->dropChangelog()|
[is_infinite | is_infinite() for PHP < 4.2.0]
bool is_infinite(|float float)
[is_nan | is_nan() for PHP < 4.2.0]
bool is_nan(|float float)
[is_finite | is_finite() for PHP < 4.2.0]
bool is_finite(|float float)
[md5_file | md5_file() for PHP < 4.2]
string md5_file(|string filename, [bool rawOutput])
[array_change_key_case | array_change_key_case() for PHP < 4.2]
array array_change_key_case(|array array, [int mode])
[floatval | floatval() for PHP < 4.2.0]
float floatval(|mixed var)
[file_get_contents | file_get_contents() for PHP < 4.3.0]
string file_get_contents(|string filename, [bool useIncludePath])
[file_put_contents | file_put_contents() for PHP < 5.0]
int file_put_contents(|string filename, mixed data, [int flags], [resource context])
[stripos | stripos() for PHP < 5.0]
int stripos(|string haystack, string needle, [int offset])
[strripos | strripos() for PHP < 5.0]
int strripos(|string haystack, string needle, [int offset])
[substr_compare | substr_compare() for PHP < 5.0]
int substr_compare(|string mainString, string string, int offset, [int length], [bool caseInsensitivity])
[str_ireplace | str_ireplace() for PHP < 5.0]
mixed str_ireplace(|mixed search, mixed replace, mixed subject)
[strpbrk | strpbrk() for PHP < 5.0]
string strpbrk(|string haystack, string charList)
[scandir | scandir() for PHP < 5]
array scandir(|string directory, [int sorting_order], [resource context])
[array_combine | array_combine() for PHP < 5]
array array_combine(|array keys, array values)
[json_encode | json_encode() for PHP < 5.0]
string json_encode(|mixed var, [bool obj])
[json_decode | json_decode() for PHP < 5.0]
mixed json_decode(|string json, [bool assoc], [mixed n], [mixed state], [mixed waitfor])
[fprintf | fprintf() for PHP < 5.0]
int fprintf(|resource stream, string format, mixed args)
[vfprintf | vfprintf() for PHP < 5.0]
int vfprintf(|resource stream, string format, [array args])
[str_split | str_split() for PHP < 5.0]
array str_split(|string string, [int split_length])
[array_product | array_product() for PHP < 5.1]
number array_product(|array array)
[property_exists | array_product() for PHP < 5.1.0RC1]
bool property_exists(|mixed class, string property)
[http_build_query | http_build_query() for PHP < 5.0]
string http_build_query(|array formdata, [string numeric_prefix], [string arg_separator])
[htmlspecialchars_decode | htmlspecialchars_decode() for PHP < 5.1]
string htmlspecialchars_decode(|string string, [int quote_style])
[sys_get_temp_dir | This function is new to PHP 5.]
string sys_get_temp_dir(|mixed var)
[dirlist | list contents of a directory]
array dirlist(|string dir, [string filter], [int switch])
[qSearchArray | search for a value in a sorted list]
int qSearchArray(|array &array, scalar needle)
[untaintInput | Untaint user input taken from a web form]
mixed untaintInput(|mixed value, [string type], [int length], [int escape], [bool doubleEncode], [int precision])
[cloneArray | recursive deep-copy on arrays]
array cloneArray(|array array)
[checkArgumentList | check the list of arguments for correct data types]
bool checkArgumentList(|array arguments, array types, [string name])
[XMLencode | Create a XML string from a scalar variable, an object, or an array of data.]
void XMLencode(|scalar/array/object data, [string name], [int caseSensitive], [int indent], [string inputEncoding], [string outputEncoding])