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

Class: Link

Source Location: /Link.php

Class Link

Class Overview

A Link is an Item that belongs to Relation and links Items from several Units together

Located in /Link.php [line 13]

Instance
   |
   --Item
      |
      --Link

Properties

Methods

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

Inherited From Instance

Instance::$data
Instance::$entity

Inherited From Item

Item::__construct()
Instance constructor. Creates object from SQL result row, loads by ID or just leaves blank to be filled later.
Item::display()
Single object display using XTemplate object.
Item::display_auto()
Row-based automatic unit render TPL designer specifies parameters implicitly with row block.
Item::get_referenced_item()
Gets a referenced object as result row to be passed to exact class constructor
Item::get_referencing_items()
Gets all items which reference to this item with a specific entity parameter.
Item::get_related_items()
Gets items from another Unit which reference to this Item with a many-to-many Relation
Item::import()
Imports data from user input, validates it and stores in the object
Item::load()
Loads object from database

Inherited From Instance

Instance::__construct()
Creates object from SQL result row or array of parameter values or blank to be filled later.
Instance::delete()
Removes object instance from the database
Instance::exists()
Checks whether instance exists in database
Instance::get_key()
Instance::save()
Saves unit object in database. Performs UPDATE if object ID is set or INSERT otherwise.
Instance::__get()
Returns property value
Instance::__isset()
Checks for property
Instance::__set()
Sets property value
Instance::__unset()
Unsets property value

[ Top ]
Property Summary
string   $name  

[ Top ]
Method Summary
Link   __construct()   Instance constructor. Creates object from SQL result row, loads by ID or just leaves blank to be filled later.
void   display()   Row-based automatic unit render TPL designer specifies parameters implicitly with row block.
bool   exists()   Checks whether instance exists in database
mixed   get_key()  

[ Top ]
Properties
string   $name = '' [line 17]
API Tags:
Access:  public


[ Top ]
Methods
Constructor __construct  [line 24]

  Link __construct( Unit $unit, [array $source = NULL]  )

Instance constructor. Creates object from SQL result row, loads by ID or just leaves blank to be filled later.

Parameters:
Unit   $unit:  Reference to parent unit
array   $source:  Query result row or array with params

API Tags:
Access:  public


Redefinition of:
Item::__construct()
Instance constructor. Creates object from SQL result row, loads by ID or just leaves blank to be filled later.

[ Top ]
display  [line 50]

  void display( XTemplate $tpl, string $block, [string $row_block = 'PARAM'], [string $title_tag = 'PARAM_TITLE'], [string $value_tag = 'PARAM_VALUE']  )

Row-based automatic unit render TPL designer specifies parameters implicitly with row block.

TPL example: <!-- BEGIN: MY_UNIT --> <!-- BEGIN: MY_PARAM --> <stong>{PARAM_TITLE}:</strong> {PARAM_VALUE} <!-- END: MY_PARAM --> <!-- END: MY_UNIT -->

Parameters:
XTemplate   $tpl:  Layout template object
string   $block:  Full block name to render the object in, e.g. 'MAIN.MY_UNIT'
string   $row_block:  Row block name for parameter row, e.g. 'MY_PARAM'
string   $title_tag:  Tag name for parameter title
string   $value_tag:  Tag name for parameter value

API Tags:
Access:  public


Redefinition of:
Item::display()
Single object display using XTemplate object.

[ Top ]
exists  [line 70]

  bool exists( )

Checks whether instance exists in database


API Tags:
Access:  public


Redefinition of:
Instance::exists()
Checks whether instance exists in database

[ Top ]
get_key  [line 81]

  mixed get_key( )


API Tags:
Return:  Primary key value for SQL WHERE
Access:  protected


Redefinition of:
Instance::get_key()

[ Top ]

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