Newsletterdeveloper's documentation

dbo_def Class Reference
[DBO Core API]

DBO entity type definition. More...

List of all members.

Public Member Functions

 __construct ($name, $table, $options)
 Constructor.
 get_attr ($name)
 Get attribute definition.
 get_bag ($name)
 Get bag definition.

Public Attributes

 $name
 [string] Name of the entity, dbo class name.
 $table
 [string] Nmae of the table this entity is stored in.
 $attrs
 [array(dbo_attr_def)] Entity attributes list.
 $bags
 [array(dbo_bag_def)] Entity bags list.
 $title
 [string] Title of this entity on the form.
 $help
 [string] Help text.
 $tip
 [string] Tip text.


Detailed Description

DBO entity type definition.

This class contains information about specific entites DBO represent. You may access these using dbo_registry::get('name') or $obj->def.


Constructor & Destructor Documentation

dbo_def::__construct ( name,
table,
options 
)

Constructor.

Used internally.

References $name, and $table.


Member Function Documentation

dbo_def::get_attr ( name  ) 

Get attribute definition.

Parameters:
name [string] Attribute name.
Returns:
[dbo_attr_def] Attribute definition.

References $name.

dbo_def::get_bag ( name  ) 

Get bag definition.

Parameters:
name [string]
Returns:
[dbo_bag_def] Bag definition.

References $name.


Member Data Documentation

dbo_def::$attrs

[array(dbo_attr_def)] Entity attributes list.

dbo_def::$bags

[array(dbo_bag_def)] Entity bags list.

dbo_def::$help

[string] Help text.

dbo_def::$name

[string] Name of the entity, dbo class name.

Referenced by __construct(), get_attr(), and get_bag().

dbo_def::$table

[string] Nmae of the table this entity is stored in.

Referenced by __construct().

dbo_def::$tip

[string] Tip text.

dbo_def::$title

[string] Title of this entity on the form.


The documentation for this class was generated from the following file:
Documentation for Newsletter, Tue Nov 11 07:50:02 2008.