phpDocumentor CCL
[ class tree: CCL ] [ index: CCL ] [ all elements ]

Class: Relation

Source Location: /Relation.php

Class Relation

Class Overview

Link is a relation that links Units with each other

Located in /Relation.php [line 13]

Container
   |
   --Entity
      |
      --Unit
         |
         --Relation

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Unit

Unit::$back_references
Unit::$item_class
Unit::$item_title
Unit::$order
Unit::$relations
Unit::$title
Unit::$zone

Inherited From Entity

Entity::$col_prefix
Entity::$name
Entity::$primary_key
Entity::$table_name
Entity::$table_prefix

Inherited From Container

Container::$data

Inherited From Unit

Unit::__construct()
Initializes controller Unit
Unit::add()
Basic add scenario
Unit::display_form()
Renders add/edit form display. A form will be empty if object has no data and if some data was imported, it will be already in the inputs.
Unit::display_form_auto()
Row-based automatic form render TPL designer specifies parameters implicitly with row block.
Unit::display_item()
Basic item display scenario
Unit::display_list()
Renders a simple list of objects to be displayed on screen.
Unit::display_list_edit()
Renders an editable list of objects to edit many instances of the entity at once
Unit::edit()
Basic edit scenario
Unit::list_items()
Basic item listing scenario
Unit::main()
Basic main unit scenario
Unit::remove()
Basic remove scenario

Inherited From Entity

Entity::__construct()
Entity constructor
Entity::add()
Adds a new entry to the entity parameter list. After the parameter has been added, you will be able to access it by name in associative array style.
Entity::define()
Defines entity structure all at once
Entity::get_primary_key()
Fetches Param used as primary key for the entity

Inherited From Container

Container::__construct()
Constructs container and puts data inside
Container::current()
Returns current container element
Container::key()
Fetches current key from the container
Container::key_exists()
Checks if key exists in container
Container::next()
Fetches next element from the container
Container::offsetExists()
Checks if any item is assigned to a key
Container::offsetGet()
Returns contained item by key or NULL on error
Container::offsetSet()
Sets a contained item value in array style
Container::offsetUnset()
Removes contained item by key
Container::rewind()
Sets iterator pointer to the beginning of the container
Container::serialize()
Serializes the container
Container::unserialize()
Unserializes container data
Container::valid()
Checks if iterator pointer points to a valid element (non-false)

[ Top ]
Method Summary
Relation   __construct()   Initializes Relation entity
void   main()   Unit main overloaded

[ Top ]
Methods
Constructor __construct  [line 22]

  Relation __construct( string $name, [string $item_class = 'Link'], [string $prefix = ''], [string $col_prefix = ''], [array $params = NULL]  )

Initializes Relation entity

Parameters:
string   $name:  Unit name
string   $item_class:  Name of the Item class representing objects for this Unit
string   $prefix:  Table prefix
string   $col_prefix:  Column prefix
array   $params:  Array of Param objects

API Tags:
Access:  public


Redefinition of:
Unit::__construct()
Initializes controller Unit

[ Top ]
main  [line 53]

  void main( )

Unit main overloaded


API Tags:
Access:  public


Redefinition of:
Unit::main()
Basic main unit scenario

[ Top ]

Documentation generated on Thu, 09 Jul 2009 14:11:36 +0400 by phpDocumentor 1.4.1