dbo_bag_def Class Reference
[DBO Core API]

DBO entity bag type definition. More...

List of all members.

Public Member Functions
	__construct (dbo_def $dbo_def, $name, $remote_name, $item_name, $min_items, $max_items, $owned, $ordered, $type, $options)
	Constructor.
Public Attributes
	$dbo_def
	[dbo_def] Definition of DBO that owns this attribute.
	$name
	[string] Name of this end of the bag.
	$remote_name
	[string] Name of the other bag for two-way relations (unsupported).
	$item_name
	[string] Name of the bag item DBO class.
	$min_items
	[int] Min items that can be put into this bag.
	$max_items
	[int] Max items that can be put into this bag.
	$owned
	[boolean] If items are removed from the bag, they must be removed from database too.
	$ordered
	[boolean] Ordered bag, applies to 1:N and N:M relations.
	$type
	[string] Type of the realtion implemented by this bag (one of "1:N", "N:1", "N:M").
	$fkey_name
	[string] Foreign key name for "1:N" and "N:1" bag types.
	$nmtab_name
	[string] N:M helper table for "N:M" bag types.
	$nmtab_c1
	[string] N:M helper table column 1 name.
	$nmtab_c2
	[string] N:M helper table column 2 name.
	$title
	[string] Title for the bag on forms, overview pages, etc.
	$help
	[string] Help text.
	$tip
	[string] Tip text.
	$control
	[string] Default form control type for this bag.

---

Detailed Description

DBO entity bag type definition.

This class contains information about specific entity bag. You may access entity bag definitions using dbo_registry::get('name')->bags or $obj->bag_name->def.

---

Constructor & Destructor Documentation

dbo_bag_def::__construct	(	dbo_def $	dbo_def,
		$	name,
		$	remote_name,
		$	item_name,
		$	min_items,
		$	max_items,
		$	owned,
		$	ordered,
		$	type,
		$	options
	)

Constructor.

Used internally.

References $item_name, $max_items, $min_items, $name, $ordered, $owned, $remote_name, and $type.

---

Member Data Documentation

dbo_bag_def::$control

[string] Default form control type for this bag.

Supproted control styles are 'floatbox'.

dbo_bag_def::$dbo_def

[dbo_def] Definition of DBO that owns this attribute.

dbo_bag_def::$fkey_name

[string] Foreign key name for "1:N" and "N:1" bag types.

dbo_bag_def::$help

[string] Help text.

dbo_bag_def::$item_name

[string] Name of the bag item DBO class.

Referenced by __construct().

dbo_bag_def::$max_items

[int] Max items that can be put into this bag.

(0 == unlimited)

Referenced by __construct().

dbo_bag_def::$min_items

[int] Min items that can be put into this bag.

Referenced by __construct().

dbo_bag_def::$name

[string] Name of this end of the bag.

Referenced by __construct().

dbo_bag_def::$nmtab_c1

[string] N:M helper table column 1 name.

dbo_bag_def::$nmtab_c2

[string] N:M helper table column 2 name.

dbo_bag_def::$nmtab_name

[string] N:M helper table for "N:M" bag types.

dbo_bag_def::$ordered

[boolean] Ordered bag, applies to 1:N and N:M relations.

Referenced by __construct().

dbo_bag_def::$owned

[boolean] If items are removed from the bag, they must be removed from database too.

Referenced by __construct().

dbo_bag_def::$remote_name

[string] Name of the other bag for two-way relations (unsupported).

Referenced by __construct().

dbo_bag_def::$tip

[string] Tip text.

dbo_bag_def::$title

[string] Title for the bag on forms, overview pages, etc.

dbo_bag_def::$type

[string] Type of the realtion implemented by this bag (one of "1:N", "N:1", "N:M").

Referenced by __construct().

---

The documentation for this class was generated from the following file:

• dbo.php