yana

Description
  Class trees
  Index of elements
  Todo List
core
  Classes
    FormCreator
    Index
    Language
    Object
    Plugin
    PluginManager
    Singleton
    SmartTemplate
    SmartView
    Utility
    Yana
database
  Classes
    DbBlob
    DbCreator
    DbDesigner4
    DbExtractor
    DbQuery
    DbQueryParser
    DbServer
    DbStream
    DbStructure
    FileDb
error_reporting
  Classes
    Alert
    Error
    ErrorUtility
    Log
    Message
    Report
    Warning
file_system
  Classes
    DatFile
    Dir
    Executeable
    File
    FileReadonly
    FileSystemResource
    SML
javascript
  Classes
    AjaxRequest
  Functions
    preview
    yanaAddEventListener
    yanaAddIcon
    yanaCheckEmbTags
    yanaCloseAll
    yanaGetCookie
    yanaGetElementsByClassName
    yanaMaxLength
    yanaMenu
    yanaMenuCookie
    yanaSetCookie
mail
  Classes
    FormMailer
    Mailer
plugins
  Classes
    plugin_blog
    plugin_check
    plugin_db_admin
    plugin_db_tools
    plugin_default_library
    plugin_diagnostics
    plugin_guestbook
    plugin_guestbook_admin
    plugin_ipblock
    plugin_ipblock_admin
    plugin_rss
    plugin_rss_admin
    plugin_sdk
    plugin_search
    plugin_search_admin
    plugin_user
    plugin_user_admin
utilities
  Classes
    Brush
    Counter
    Hashtable
    Image
    Microsummary
    RSS
    RSSitem
    String
  Functions
    checkArgumentList
    cloneArray
    dirlist
    qSearchArray
    untaintInput
    XMLencode
vdrive
  Classes
    Registry
    VDrive
zip
  Classes
    PclZip

phpDocumentor v 1.4.0

YANA Framework for PHPDocs for page library.php

### /library.php

#### Description

YANA PHP-Framework
Constant definitions and basic configuration-file

- license: http://www.gnu.org/licenses/gpl.txt

#### Constants

ENT_FULL = 10
Constant ENT_FULL
This adds a new constant ENT_FULL to the php predefined constants ENT_COMPAT=2, ENT_QUOTES=3, ENT_NOQUOTES=0
Use of this constant with the method String::encode(), will force ALL characters of the string to be encoded as html entities.
See this example:

1. $string->encode('entities', ENT_FULL)

- see: String::encode()

FORM_ADV_SEARCH = 7
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_DETAILS = 3
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_EDIT = 4
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_NEW = 5
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_SEARCH = 6
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_SEPERATED = 2
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

FORM_VIEW = 1
form generator identifier
These constants are used (amongst others) by the function FormCreator::getFormdata() to identify which form a set of input vars is comming from. See the API-documentation of this function for details and examples.

- see: FormCreator

IS_ARRAY = 32
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_BOOL = 16
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_FLOAT = 8
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_INT = 2
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_MIXED = 2048
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_NULL = 1024
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_NUMERIC = 128
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_OBJECT = 256
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_RESOURCE = 512
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_SCALAR = 64
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

IS_STRING = 4
type identifier
These constants are used by the function checkArgumentList() to identify the type of an argument. These can be combined using the bitwise OR operator, like IS_INT|IS_NULL (read as "is integer or null").

- see: checkArgumentList()

STRING_UNSUPPORTED_ENCRYPTION = 1
Constant UNSUPPORTED_ENCRYPTION
This is returned by String::encrypt() when an invalid encryption method is encountered.

- see: String

YANA_CACHE_ACTIVE = error_reporting()===0
activate/deactivate Yana Framework's system cache
This constant enables/disables the framework's internal system cache, that accelerates the startup process of the framework in productive environments.
You may want to turn this feature off for debugging.
Set to bool(true) to enable, or bool(false) to disable the feature. By default this setting is activated and deactivated automatically together with the debugging mode.
YANA_CDROM = false
select type of media (online / offline)
This should be bool(false) when installed on a webserver. If you want to run yana from a DVD or CD-ROM, this should be set to bool(true).
In more detail: This setting defines where to store user settings and files. When false they will be kept in the yana installation directory. When true they will be moved to a temporary directory on a local HDD.
YANA_CDROM_DIR = sys_get_temp_dir()."yana/"
temporary directory when running on CD-ROM or DVD
Here you may specify a path, where files should be stored, when running the YANA framework on a media, where you can't store files.
Example:

1. // Try to determine the system's temporary directory automatically, ...
2. define('YANA_CDROM_DIR', sys_get_temp_dir() . "yana/");
3. // or set it to a fixed directory.
4. define('YANA_CDROM_DIR', "c:/temp/yana/");
5. // for Server2Go on CD-ROM you may also use the following ...
6. define('YANA_CDROM_DIR', $_ENV['S2G_TEMP_FOLDER'] . "yana/");

YANA_COUNTER_IGNORE_IP = 1
counter settings
These constants are used by the class Counter to identify wether the visitor's remote address (IP) should be remembered or not, to avoid counting twice when the page reloads in the visitor's browser.

- see: Counter

YANA_COUNTER_USE_IP = 0
counter settings
These constants are used by the class Counter to identify wether the visitor's remote address (IP) should be remembered or not, to avoid counting twice when the page reloads in the visitor's browser.

- see: Counter

YANA_DB_COMPAT_INSERT = false
activate/deactivate database compatibility mode on insert() operation
Makes the database operation "insert()" behave like in version 2.9.4 and earlier. Set this constant to bool(true) to enable the compatibility mode, or set it to bool(false) to disable it.
YANA_EMBTAG_ALLOW_PHP = true
activate/deactivate php emb-tag
This enables/disables the emb-tag "php", which transfers php code in guestbook or forum posts to a higlighted text representation in HTML. Note that this does NOT execute the code.
Under certain circumstances, e.g. where you do not need this feature, you may want to disable it. To do so, set this constant to bool(false). Otherwise it should be set to bool(true).
YANA_ERROR_LOG = 'log'
send errors to a log file
error reporting
Write all reported messages to 'cache/error.log'. Use this for testing.

- see: ErrorUtility::setErrorReporting()

YANA_ERROR_OFF = 'off'
turn error reporting off
error reporting
Use this in any production environment to prevent information leak to possible attackers.

- see: ErrorUtility::setErrorReporting()

YANA_ERROR_ON = 'on'
turn error reporting on
error reporting
Use this to debug your scripts.

- see: ErrorUtility::setErrorReporting()

YANA_ESCAPE_ALL = PHP_INT_MAX-2
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_CODED = 8
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_LINEBREAK = 16
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_NONE = 0
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_SLASHED = 2
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_TOKEN = 4
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_ESCAPE_USERTEXT = 32
escape method
These constants are used by the functions StructureFile::untaintInput() and untaintInput() to identify the method that should be used to escape characters of an input string.
See the API-documentation of these functions for details and examples.

- see: untaintInput()
- see: StructureFile::untaintInput()

YANA_GET = 2
request vars
These constants are used to identify the method via which arguments have been sent to the script.

- see: Yana::getRequestVar()

YANA_GET_ALL = 0
directory scanning
These constants are used by the functions dirlist() and Dirstream::dirlist(). See the documentation of these for details.

- see: Dirstream::dirlist()
- see: dirlist()

YANA_GET_DIRS = 2
directory scanning
These constants are used by the functions dirlist() and Dirstream::dirlist(). See the documentation of these for details.

- see: Dirstream::dirlist()
- see: dirlist()

YANA_GET_FILES = 1
directory scanning
These constants are used by the functions dirlist() and Dirstream::dirlist(). See the documentation of these for details.

- see: Dirstream::dirlist()
- see: dirlist()

YANA_IS_STABLE = false
this is true, if the current version is stable
YANA_POST = 1
request vars
These constants are used to identify the method via which arguments have been sent to the script.

- see: Yana::getRequestVar()

YANA_REQUEST = 0
request vars
These constants are used to identify the method via which arguments have been sent to the script.

- see: Yana::getRequestVar()

YANA_VERSION = '{VERSION}'
currently installed version of the Yana Framework
Note: you can compare two version strings using the PHP-function version_compare(). See the PHP manual for details.

Documentation generated on Sun, 04 Jan 2009 03:49:14 +0100 by phpDocumentor 1.4.0

yana author: Thomas Meyerwww.yanaframework.net