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
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • BaseDocsMassAction
  • CApplication
  • CApplicationComponent
  • CBehavior
  • CComponent
  • CEnumerable
  • CErrorEvent
  • CErrorHandler
  • CEvent
  • CExceptionEvent
  • CModel
  • CModelBehavior
  • CModelEvent
  • CModule
  • CommonFieldsBehavior
  • CSecurityManager
  • CStatePersister
  • Expression
  • MassAction
  • MassAddToList
  • MassCompleteAction
  • MassMoveFileSysObjToFolder
  • MassRemoveFromList
  • MassRenameFileSysObj
  • MassUncompleteAction
  • MobileRecentItems
  • ModulePanelItem
  • NewListFromSelection
  • PanelItem
  • QuickCRUDBehavior
  • RecentItemPanelItem
  • ServiceRoutingBehavior
  • SettingsPanelItem
  • X2AddressBehavior
  • X2AuthCache
  • X2BaseListViewBehavior

Interfaces

  • IAction
  • IApplicationComponent
  • IAuthManager
  • IBehavior
  • IFilter
  • IStatePersister
  • IUserIdentity
  • IViewRenderer
  • IWebServiceProvider
  • IWebUser

Exceptions

  • CException
  • CHttpException
  • TwitterFeedWidgetException
  • Overview
  • Package
  • Class
  • Tree

Class CBehavior

CBehavior is a convenient base class for behavior classes.

CComponent
Extended by CBehavior implements IBehavior

Direct known subclasses

ApplicationConfigBehavior, CConsoleCommandBehavior, LeadRoutingBehavior, QuickCRUDBehavior, ResponseBehavior, ServiceRoutingBehavior, SmartDataProviderBehavior, X2AddressBehavior, X2BaseListViewBehavior, X2ControllerBehavior, X2GridViewSortableWidgetsBehavior, X2Settings, CModelBehavior, X2SmartSearchModelBehavior, X2StaticFieldsBehavior, X2TranslationBehavior, X2WidgetBehavior, CommonControllerBehavior, CommonFieldsBehavior, CommonSiteControllerBehavior, ControllerPermissionsBehavior, EmailDeliveryBehavior, ImportExportBehavior, InlineEmailModelBehavior

Indirect known subclasses

ActionsQuickCreateRelationshipBehavior, AssociatedMediaBehavior, FileSystemObjectBehavior, GridViewDbSettingsBehavior, GridViewSessionSettingsBehavior, JSONEmbeddedModelFieldsBehavior, JSONFieldsBehavior, JSONFieldsDefaultValuesBehavior, ModelPermissionsBehavior, NormalizedJSONFieldsBehavior, QuickCreateRelationshipBehavior, RecordLimitBehavior, CActiveRecordBehavior, RelationshipsBehavior, SearchIndexBehavior, TagBehavior, TransformedFieldStorageBehavior, UpdaterBehavior, WorkflowBehavior, X2ActiveRecordBehavior, X2ChangeLogBehavior, X2ControllerPermissionsBehavior, X2DuplicateBehavior, CampaignMailingBehavior, X2FlowTriggerBehavior, X2LinkableBehavior, X2MergeableBehavior, X2MobileControllerBehavior, X2MobileProfileControllerBehavior, X2MobileQuotesControllerBehavior, X2MobileSiteControllerBehavior, X2MobileTopicsControllerBehavior, X2ModelConversionBehavior, X2PermissionsBehavior, ContactsNameBehavior, X2TimestampBehavior, CSaveRelationsBehavior, CTimestampBehavior, EncryptedFieldsBehavior, ERememberFiltersBehavior, FileFieldBehavior
Package: system\base
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Located at x2engine/framework/base/CBehavior.php
Methods summary
public array
# events( )

Declares events and the corresponding event handler methods. The events are defined by the owner component, while the handler methods by the behavior class. The handlers will be attached to the corresponding events when the behavior is attached to the owner component; and they will be detached from the events when the behavior is detached from the component. Make sure you've declared handler method as public.

Declares events and the corresponding event handler methods. The events are defined by the owner component, while the handler methods by the behavior class. The handlers will be attached to the corresponding events when the behavior is attached to the owner component; and they will be detached from the events when the behavior is detached from the component. Make sure you've declared handler method as public.

Returns

array
events (array keys) and the corresponding event handler methods (array values).
public
# attach( CComponent $owner )

Attaches the behavior object to the component. The default implementation will set the owner property and attach event handlers as declared in CBehavior::events(). This method will also set enabled to true. Make sure you've declared handler as public and call the parent implementation if you override this method.

Attaches the behavior object to the component. The default implementation will set the owner property and attach event handlers as declared in CBehavior::events(). This method will also set enabled to true. Make sure you've declared handler as public and call the parent implementation if you override this method.

Parameters

$owner
CComponent
$owner the component that this behavior is to be attached to.

Implementation of

IBehavior::attach()
public
# detach( CComponent $owner )

Detaches the behavior object from the component. The default implementation will unset the owner property and detach event handlers declared in CBehavior::events(). This method will also set enabled to false. Make sure you call the parent implementation if you override this method.

Detaches the behavior object from the component. The default implementation will unset the owner property and detach event handlers declared in CBehavior::events(). This method will also set enabled to false. Make sure you call the parent implementation if you override this method.

Parameters

$owner
CComponent
$owner the component that this behavior is to be detached from.

Implementation of

IBehavior::detach()
public CComponent
# getOwner( )

Returns

CComponent
the owner component that this behavior is attached to.
public boolean
# getEnabled( )

Returns

boolean
whether this behavior is enabled

Implementation of

IBehavior::getEnabled()
public
# setEnabled( boolean $value )

Parameters

$value
boolean
$value whether this behavior is enabled

Implementation of

IBehavior::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()
Magic properties summary
public CComponent $owner
#

The owner component that this behavior is attached to.

The owner component that this behavior is attached to.

public boolean $enabled
#

Whether this behavior is enabled.

Whether this behavior is enabled.

API documentation generated by ApiGen 2.8.0