Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • AccountsGridViewProfileWidget
  • ActionMenu
  • ActionsGridViewProfileWidget
  • ActionsQuickCreateRelationshipBehavior
  • ActiveDateRangeInput
  • ApplicationConfigBehavior
  • Attachments
  • ChatBox
  • CommonControllerBehavior
  • ContactMapInlineTags
  • ContactsGridViewProfileWidget
  • CronForm
  • CSaveRelationsBehavior
  • DateRangeInputsWidget
  • DocsGridViewProfileWidget
  • DocViewer
  • DocViewerProfileWidget
  • EButtonColumnWithClearFilters
  • EmailDeliveryBehavior
  • EmailProgressControl
  • EncryptedFieldsBehavior
  • EventsChartProfileWidget
  • FileUploader
  • FontPickerInput
  • Formatter
  • FormView
  • GridViewWidget
  • History
  • IframeWidget
  • ImportExportBehavior
  • InlineActionForm
  • InlineEmailAction
  • InlineEmailForm
  • InlineEmailModelBehavior
  • InlineQuotes
  • JSONEmbeddedModelFieldsBehavior
  • JSONFieldsDefaultValuesBehavior
  • LeadRoutingBehavior
  • LeftWidget
  • LoginThemeHelper
  • LoginThemeHelperBase
  • MarketingGridViewProfileWidget
  • MediaBox
  • MessageBox
  • MobileFormatter
  • MobileFormLayoutRenderer
  • MobileLayoutRenderer
  • MobileLoginThemeHelper
  • MobileViewLayoutRenderer
  • ModelFileUploader
  • NewWebLeadsGridViewProfileWidget
  • NormalizedJSONFieldsBehavior
  • NoteBox
  • OnlineUsers
  • OpportunitiesGridViewProfileWidget
  • Panel
  • ProfileDashboardManager
  • ProfileGridViewWidget
  • ProfileLayoutEditor
  • ProfilesGridViewProfileWidget
  • Publisher
  • PublisherActionTab
  • PublisherCalendarEventTab
  • PublisherCallTab
  • PublisherCommentTab
  • PublisherEventTab
  • PublisherSmallCalendarEventTab
  • PublisherTab
  • PublisherTimeTab
  • QuickContact
  • QuickCreateRelationshipBehavior
  • QuotesGridViewProfileWidget
  • RecordAliasesWidget
  • RecordViewLayoutManager
  • RecordViewWidgetManager
  • RememberPagination
  • Reminders
  • ResponseBehavior
  • ResponsiveHtml
  • SearchIndexBehavior
  • ServicesGridViewProfileWidget
  • SmallCalendar
  • SmartActiveDataProvider
  • SmartDataProviderBehavior
  • SmartSort
  • SocialForm
  • SortableWidgetManager
  • SortableWidgets
  • TagBehavior
  • TagCloud
  • TemplatesGridViewProfileWidget
  • TimeZone
  • TopContacts
  • TopSites
  • TransformedFieldStorageBehavior
  • TranslationLogger
  • TwitterFeed
  • TwoColumnSortableWidgetManager
  • UpdaterBehavior
  • UpdatesForm
  • UserIdentity
  • UsersChartProfileWidget
  • WorkflowBehavior
  • X2ActiveGridView
  • X2ActiveGridViewForSortableWidgets
  • X2AssetManager
  • X2AuthManager
  • X2ChangeLogBehavior
  • X2ClientScript
  • X2Color
  • X2DateUtil
  • X2FixtureManager
  • X2FlowFormatter
  • X2GridView
  • X2GridViewBase
  • X2GridViewForSortableWidgets
  • X2GridViewSortableWidgetsBehavior
  • X2LeadsGridViewProfileWidget
  • X2LinkableBehavior
  • X2ListView
  • X2PillBox
  • X2ProgressBar
  • X2SmartSearchModelBehavior
  • X2TimestampBehavior
  • X2TranslationBehavior
  • X2UrlRule
  • X2WebModule
  • X2Widget
  • X2WidgetList
  • Overview
  • Package
  • Class
  • Tree

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
Extended by CBehavior implements IBehavior
Extended by CModelBehavior
Extended by CActiveRecordBehavior
Extended by 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
X2CRM Documentation API documentation generated by ApiGen 2.8.0