YANA 4 PHP Framework
Docs For Class Yana
«Singleton» Yana
This is a primary controller and application loader for the YANA-Framework.
Located in /includes/class_yana.php
SerializeableObject | --Singleton | --Yana
readonly
readonly
readonly
readonly
«Singleton» Constructor
Name | Type | Description |
---|---|---|
$filename | string | path to system.config |
$ARGS | array | associative array of request vars |
«factory» connect()
returns a ready-to-use database connection
Name | Type | Description |
---|---|---|
$source | string | name of the database schema that describes the names and structure of tables within the database |
returns the default value for a given var (if any) else returns null (not false!)
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
returns current type of session (0=using profile|1=using default data)
retrieves var from registry (memory shared by all plugins)
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
resolves event and calls plugin(s), with the given arguments
Name | Type | Description |
---|---|---|
$event | string | (optional) script action parameter |
$ARGS | array | (optional) array of passed arguments |
merges the value at adresse $key with the provided array data
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
$array | array | associative array to merge |
outputs an text message (while terminating the current script)
Name | Type | Description |
---|---|---|
$level | string | type of message ('OK'|'ALERT'|'ERROR') |
$errcode | string | code of corresponding message in message.config |
$event | string | upcoming event to route to |
adds an entry to the log-queue (will be printed to screen or written to log-file, depending on base-class)
Name | Type | Description |
---|---|---|
$log | yana_log | object containing the log entry |
sets the type of a var on registry (memory shared by all plugins)
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
$type | string | new type of variable |
sets var on registry (memory shared by all plugins)
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
$value | mixed | new value (may be scalar value or array) |
removes var from registry (memory shared by all plugins)
Name | Type | Description |
---|---|---|
$key | string | adress of data in memory (case insensitive) |
provides gui from current data
Inherited From Singleton
Singleton::checkSingletonConstraint()
Inherited From SerializeableObject
SerializeableObject::serialize()
SerializeableObject::toString()
Documentation generated on Sat, 16 Sep 2006 17:06:13 +0200 by phpDocumentor 1.3.0RC4