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.
Method Summary
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.
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.
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.
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.
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.
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 Sat, 03 Jan 2009 22:22:30 +0100 by phpDocumentor 1.4.0
www.yanaframework.net