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 Class plugin_check

### Class plugin_check

#### Description

collection of unit- and performance-tests

- access: public

    Plugin
       |
       --plugin_check

##### Method Summary

- bool check_performance (array $ARGS)
- bool check_sql (array $ARGS)
- bool check_unit (array $ARGS)

#### Methods

##### Run performance tests

bool check_performance (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

This procedure does a test-run on several units. Each is run X times. The overall time for each test and the number of test-runs are displayed as a numbered list.
If a test-run fails, the performance test is skipped and a failure message will be produced instead.
Use the argument 'target' to limit the performance run to a certain test scenario.
parameters taken:

- int target (optional) number of performance test to take (default = all)

- access: public

##### SQL command line interface

bool check_sql (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

This is a console application to run tests on the FileDB database driver and SQL-/Query-parser. It takes a SQL command as input and displays the transformed internal query as it would be understood by the query-parser, together with the results of the query.
Note: as this is meant for testing purposes only, you cannot modify values via this console application. Queries of type INSERT, UPDATE, and DELETE are parsed and ignored. Also you cannot access the user-database via this interface.
parameters taken:

- string db name of the database to run the query on
- string sql sql code

- access: public

##### Procedure to run unit test

bool check_unit (
array $ARGS
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$ARGS | array | array of params passed to the function

###### Description:

This runs a number of unit tests and presents the results as a numbered list. If a test fails, the invalid unit, failed test and test results will be stated in the protocol.
Use the argument 'target' to limit this to a certain test scenario.
parameters taken:

- int target (optional) number of test to take (default = all)

- access: public

##### inherited from base classes

Inherited From Plugin

- Plugin::Plugin()
- Plugin::getName()
- Plugin::_default()

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

yana author: Thomas Meyerwww.yanaframework.net