Class Relation

CWidget is the base class for widgets.

A widget is a self-contained component that may generate presentation based on model data. It can be viewed as a micro-controller that embeds into the controller-managed views.

Compared with CController controller, a widget has neither actions nor filters.

Usage is described at CBaseController and CBaseController::widget.

CComponent

CBaseController

CWidget

Relation

Package: system\web\widgets
Author: Qiang Xue <qiang.xue@gmail.com>
Version: $Id$
Since: 1.0
Located at phundament/gii-template-collection/components/Relation.php

Methods summary

`public`	# `init( )` Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Initializes the widget. This method is called by CBaseController::createWidget and CBaseController::beginWidget after the widget's properties have been initialized. Overrides `CWidget::init`
`public`	# `getModelData( mixed $model, mixed $field )`
`public`	# `getRelatedData( )` This function fetches all needed data of the related Object and returns them in an array that is prepared for use in ListData. This function fetches all needed data of the related Object and returns them in an array that is prepared for use in ListData.
`public`	# `getAssignedObjects( )` Retrieves the Assigned Objects of the MANY_MANY related Table Retrieves the Assigned Objects of the MANY_MANY related Table
`public`	# `getNotAssignedObjects( )` Retrieves the not Assigned Objects of the MANY_MANY related Table This is used in the two-pane style view. Retrieves the not Assigned Objects of the MANY_MANY related Table This is used in the two-pane style view.
`public`	# `getObjectValues( mixed $objects )` Gets the Values of the given Object or Objects depending on the $this->fields the widget requests Gets the Values of the given Object or Objects depending on the $this->fields the widget requests
`public`	# `getListBoxName( mixed $ajax = false )`
`public`	# `renderBelongsToSelection( )`
`public`	# `renderManyManySelection( )`
`public`	# `renderManyManyRadioButtonListSelection( )`
`public`	# `renderManyManyDropDownListSelection( )`
`public`	# `isAssigned( mixed $id )`
`public static`	# `retrieveValues( mixed $data )`
`public`	# `renderCheckBoxListSelection( )`
`public`	# `renderOnePaneSelection( )`
`public`	# `handleAjaxRequest( mixed $post )`
`public`	# `renderTwoPaneSelection( )`
`public`	# `run( )` Executes the widget. This method is called by CBaseController::endWidget. Executes the widget. This method is called by CBaseController::endWidget. Overrides `CWidget::run`
`protected`	# `renderAddButton( )`

Methods inherited from CWidget

__construct(), actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), setId()

Methods inherited from CBaseController

beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), renderFile(), renderInternal(), widget()

Methods inherited from CComponent

__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()

Magic methods summary

Properties summary

`protected mixed`	`$_model`	#
`protected mixed`	`$_relatedModel`	#
`public mixed`	`$model`	#
`public mixed`	`$relation`	#
`public mixed`	`$field`	#
`public mixed`	`$relatedPk`	#
`public mixed`	`$fields`	#
`public integer`	`$allowEmpty`	#
`public boolean`	`$preselect`	#
`public boolean`	`$showAddButton`	#
`public string`	`$addButtonUrl`	#
`public string`	`$addButtonRefreshUrl`	#
`public boolean`	`$criteria`	#
`public string`	`$template`	#
`public array`	`$functions`	#
`public boolean`	`$functionsInHtmlOptionsTemplate`	#
`public string`	`$delimiter`	#
`public string`	`$style`	#
`public array`	`$htmlOptions`	#
`public integer`	`$parentObjects`	#
`public integer`	`$orderParentsBy`	#
`public integer`	`$groupParentsBy`	#
`public string`	`$manyManyTable`	#
`public string`	`$manyManyTableLeft`	#
`public string`	`$manyManyTableRight`	#
`public integer`	`$num`	#

Properties inherited from CWidget

$actionPrefix, $skin

Magic properties inherited from CWidget

$controller, $id, $owner, $viewPath

Packages

Classes