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 X2Widget

Base widget class for all of X2Engine's widgets

CComponent
Extended by CBaseController
Extended by CWidget
Extended by X2Widget

Direct known subclasses

ActionMenu, ActiveDateRangeInput, InlineActionForm, InlineEmailForm, InlineQuotes, MediaBox, MediaSelector, MenuList, MessageBox, MobileLayoutRenderer, MultiTypeAutocomplete, NoteBox, Attachments, OnlineUsers, Panel, Publisher, PublisherTab, QuickContact, RecordAliasesWidget, RecordView, RecordViewLayoutManager, Reminders, SmallCalendar, ChatBox, SocialForm, SortableWidget, SortableWidgetManager, TagCloud, TimeZone, TopSites, TwitterFeed, WebFormDesigner, X2ConditionList, X2ModelConversionWidget, ContactMapInlineTags, X2PillBox, X2ProgressBar, X2WidgetList, CronForm, DocViewer, EmailProgressControl, FileUploader, History

Indirect known subclasses

AccountsGridViewProfileWidget, ActionsGridViewProfileWidget, EmailsWidget, EventsChartProfileWidget, EventsWidget, FormView, GridViewWidget, IframeWidget, InlineRelationshipsWidget, InlineTagsWidget, LoggedTimeWidget, MarketingGridViewProfileWidget, ActionsWidget, MobileFormLayoutRenderer, MobileViewLayoutRenderer, ModelFileUploader, NewWebLeadsGridViewProfileWidget, OpportunitiesGridViewProfileWidget, ProfileGridViewWidget, ProfilesGridViewProfileWidget, PublisherActionTab, PublisherCalendarEventTab, PublisherCallTab, CallsWidget, PublisherCommentTab, PublisherEventTab, PublisherSmallCalendarEventTab, PublisherTimeTab, PublisherWidget, QuotesGridViewProfileWidget, QuotesWidget, RecordViewWidgetManager, ServicesGridViewProfileWidget, ServiceWebFormDesigner, ChartWidget, TemplatesGridViewProfileWidget, TransactionalViewWidget, TwitterFeedWidget, TwoColumnSortableWidgetManager, UsersChartProfileWidget, WebActivityWidget, WebLeadFormDesigner, WorkflowStageDetailsWidget, X2LeadsGridViewProfileWidget, CommentsWidget, ContactsGridViewProfileWidget, DetailView, DocsGridViewProfileWidget, DocViewerProfileWidget
Abstract
Package: application\components
Located at x2engine/protected/components/X2Widget.php
Methods summary
public
# __construct( CBaseController $owner = null )

Constructor.

Constructor.

Parameters

$owner
CBaseController
$owner owner/creator of this widget. It could be either a widget or a controller.

Overrides

CWidget::__construct()
public
# behaviors( )
public string
# renderFile( string $viewFile, array $data = null, boolean $return = false )

Renders a view file. Overrides CBaseController::renderFile to check if the requested view has a version in /custom, and uses that if it exists.

Renders a view file. Overrides CBaseController::renderFile to check if the requested view has a version in /custom, and uses that if it exists.

Parameters

$viewFile
string
$viewFile view file path
$data
array
$data data to be extracted and made available to the view
$return
boolean
$return whether the rendering result should be returned instead of being echoed

Returns

string
the rendering result. Null if the rendering result is not required.

Throws

CException
if the view file does not exist

Overrides

CBaseController::renderFile()
public static
# ajaxRender( function $function, mixed $return = false )

Runs an arbitrary function inside a partial view. All scripts registered get processed. Allows scripts associated with a widget to be returned in AJAX response.

Runs an arbitrary function inside a partial view. All scripts registered get processed. Allows scripts associated with a widget to be returned in AJAX response.

Parameters

$function
function
$function
$return
public type
# getModule( )

Getter for module.

Getter for module.

Can automatically recognize when a component is a member of a module's collection of components.

Returns

type
public
# setModule( mixed $moduleName )
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()
Methods inherited from CWidget
actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), run(), setId()
Methods inherited from CBaseController
beginCache(), beginClip(), beginContent(), beginWidget(), createWidget(), endCache(), endClip(), endContent(), endWidget(), 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()
Properties summary
protected mixed $_module
#
Properties inherited from CWidget
$actionPrefix, $skin
Magic properties summary
public X2WebModule $module
#
Magic properties inherited from CWidget
$controller, $id, $owner, $viewPath
X2CRM Documentation API documentation generated by ApiGen 2.8.0