Class X2LinkableBehavior

CModelBehavior class for route lookups on classes.

X2LinkableBehavior is a CModelBehavior which allows consistent lookup of Yii routes, HTML links and autcomplete sources.

CComponent

CBehavior implements IBehavior

CModelBehavior

CActiveRecordBehavior

X2LinkableBehavior

Package: application\components
Located at x2engine/protected/components/X2LinkableBehavior.php

Methods summary
`public`	# `attach( string $owner )` Attaches the behavior object to the model. Attaches the behavior object to the model. Parameters `$owner` `string` $owner The component to which the behavior will be applied Overrides `CBehavior::attach()`
`public string\|null`	# `getModule( )` Gets the module property. Gets the module property. Returns `string\|null`
`public string`	# `getUrl( )` Generates a url to the view of the object. Generates a url to the view of the object. Returns `string` a url to the model
`public static`	# `getMobileLinkableRecordTypes( )`
`public static`	# `isMobileLinkableRecordType( mixed $type )`
`public string`	# `getUrlLink( mixed $htmlOptions = array () )` Generates a link to the view of the object. Generates a link to the view of the object. Returns `string` a link to the model
`public string`	# `getLink( mixed $htmlOptions = array () )` Generates a link to the view of the object. Generates a link to the view of the object. Returns `string` a link to the model
`public string`	# `createLink( )` Returns `string` a link to the model view, or just the name if no ID is set
`public string`	# `getAutoCompleteSource( )` Accessor method for $autoCompleteSource Accessor method for $autoCompleteSource Returns `string` $autoCompleteSource
`public static`	# `getItems( string $term, mixed $valueAttr = 'name', mixed $nameAttr = 'id', mixed $modelClass = null )` Get autocomplete options Get autocomplete options Parameters `$term` `string` $term `$valueAttr` `$nameAttr` `$modelClass`
`public array`	# `getItems2( string $prefix = '', integer $page = 0, integer $limit = 20, string\|array $valueAttr = 'name', string $nameAttr = 'name' )` Improved version of getItems which enables use of empty search string, pagination, and configurable option values/names. Improved version of getItems which enables use of empty search string, pagination, and configurable option values/names. Parameters `$prefix` `string` $prefix name prefix of items to retrieve `$page` `integer` $page page number of results to retrieve (ignored if limit is -1) `$limit` `integer` $limit max number of results to retrieve (-1 to disable limit) `$valueAttr` `string\|array` $valueAttr attribute(s) used to popuplate the option values. If an array is passed, value will composed of values of each of the attributes specified, joined by commas `$nameAttr` `string` $nameAttr attribute used to popuplate the option names Returns `array` name, value pairs
`public`	# `setModule( string $value )` Sets the module property Sets the module property Parameters `$value` `string` $value

Methods inherited from CActiveRecordBehavior
`afterDelete(), afterFind(), afterSave(), beforeCount(), beforeDelete(), beforeFind(), beforeSave(), events()`

Methods inherited from CModelBehavior
`afterConstruct(), afterValidate(), beforeValidate()`

Methods inherited from CBehavior
`detach(), getEnabled(), getOwner(), setEnabled()`

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()`

Properties summary
`public mixed`	`$baseRoute`	#
`public mixed`	`$viewRoute`	#
`public mixed`	`$autoCompleteSource`	#
`public mixed`	`$icon`	#

Magic properties summary
`public string`	`$module`	# The module this record "belongs" to The module this record "belongs" to
`public string`	`$baseRoute`	# The default module/controller path for this record's module The default module/controller path for this record's module
`public string`	`$viewRoute`	# The default action to view this record The default action to view this record
`public string`	`$autoCompleteSource`	# The action to user for autocomplete data The action to user for autocomplete data

Magic properties inherited from CActiveRecordBehavior
`$owner`

Magic properties inherited from CBehavior
`$enabled`

Packages

Classes

Class X2LinkableBehavior

Parameters

Overrides

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Parameters

Returns

Parameters