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 Object

### Class Object

#### Description

Object
This is a base class for all entities used in the framework. It provides same basic functionality that is common for all subclasses.

- abstract:
- access: public

##### Method Summary

- Object cloneObject ()
- bool equals (object $anotherObject)
- string getClass ()
- string serialize ()
- string toString ()

#### Direct descendents

Class | Description
--- | ---
Counter | counter wrapper
DbCreator | «decorator» database Creator
DbQuery | Database query builder
DbServer | Connection to a database server
DbStream | database API
FileSystemResource | «abstract» filesystem resource
FormCreator | Form-generator
FormMailer | create and send mails from form data
Image | Image wrapper class
Brush | Brush wrapper class
RSS | «entity» RSS feed
RSSitem | «entity» RSS item
Singleton | «abstract» Singleton
SmartTemplate | «decorator» SmartTemplate
String | «datatype» String

#### Methods

##### clone this object

Object cloneObject ()

###### Description:

Creates a copy of this object. You are encouraged to reimplement this for each subclass.

- since: 2.8.5
- access: public

Redefined in descendants as:

- Image::cloneObject() : clone this object
- Brush::cloneObject() : clone this object
- String::cloneObject() : clone the string

##### compare with another object

bool equals (
object $anotherObject
)

###### List of parameters:

Name | Type | Description
--- | --- | ---
$anotherObject | object |

###### Description:

Returns bool(true) if this object and $anotherObject are the same and bool(false) otherwise.
You are encouraged to overwrite this function in subclasses to reflect your implementation.

- since: 2.8.5
- access: public

Redefined in descendants as:

- Counter::equals() : compare with another object
- DbStream::equals() : compare with another object
- FileSystemResource::equals() : compare with another object
- FormMailer::equals() : compare with another object
- Image::equals() : compare with another object
- Brush::equals() : compare with another object
- SmartTemplate::equals() : compare with another object
- String::equals() : test two strings for equality

##### get the class name of the instance

string getClass ()

###### Description:

This function returns the name of the class of this object as a string.

- since: 2.8.5
- access: public

##### serialize this object to a string

string serialize ()

###### Description:

This calls the PHP function serialize on the object and returns the result. Use unserialize() to revert the string back into an object.

- access: public

##### get a string representation of this object

string toString ()

###### Description:

This function is intended to be called when the object is used in a string context.
You are encouraged to implement this for each derived subclass, to reflect your implementation and purpose of your class.

- access: public

Redefined in descendants as:

- DbQuery::toString() : build a SQL-query
- DbStream::toString() : get CSV string from a table
- Dir::toString() : return a string representation of this directory
- FileReadonly::toString() : alias of get()
- DatFile::toString() : return file content as string (if available)
- SML::toString() : get a string representation
- VDrive::toString() : get string represenation of a virtual drive
- Image::toString() : get a string representation of this object
- Brush::toString() : get a string representation of this object
- RSS::toString() : get string value
- String::toString() : Alias of: String::get()

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

yana author: Thomas Meyerwww.yanaframework.net