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 FormView

Child Class for a form record view

CComponent
Extended by CBaseController
Extended by CWidget
Extended by X2Widget
Extended by RecordView
Extended by FormView
Package: application\components
Author: Alex Rowe <alex@x2engine.com>
See: RecordView
Located at x2engine/protected/components/FormView.php
Methods summary
public
# init( )

Inititialization

Inititialization

Overrides

RecordView::init()
public
# run( )

Executes the widget. This method is called by CBaseController::endWidget.

Executes the widget. This method is called by CBaseController::endWidget.

Overrides

RecordView::run()
public
# getJSClassParams( )

Overrides

RecordView::getJSClassParams()
public
# getPackages( )

Overrides

RecordView::getPackages()
public array
# getMainOptions( )

HtmlOptions for the main tag that wraps the form

HtmlOptions for the main tag that wraps the form

Returns

array
HTML Attributes

Overrides

RecordView::getMainOptions()
public string
# renderMain( )

Renders the upper level tag and all sections

Renders the upper level tag and all sections

Returns

string
HTML

Overrides

RecordView::renderMain()
public string
# renderAttribute( array $item, Fields $field )

Renders the Attribute of a form item. For a View, this is the value of the field. For a Form, this is the inpute of the field

Renders the Attribute of a form item. For a View, this is the value of the field. For a Form, this is the inpute of the field

Parameters

$item
array
$item array of item settings
$field
Field
$field field object being rendered

Returns

string
HTML to add to the form
public
# renderExtra( mixed $field )

Renders the quick create/ Field help icons

Renders the quick create/ Field help icons

public array
# getLayoutData( )

Gets the layout of the form.

Gets the layout of the form.

Returns

array
Array of the form layout
public
# renderLabel( mixed $field )

Renders the label of a field

Renders the label of a field

Overrides

RecordView::renderLabel()
Methods inherited from RecordView
canEdit(), canView(), getColumnOptions(), getFieldPermissions(), getFields(), getItemOptions(), getRowOptions(), getSectionOptions(), renderColumn(), renderInlineLabel(), renderItem(), renderLeftLabel(), renderNoneLabel(), renderRow(), renderSection(), renderSectionHeader(), renderSections(), renderTopLabel(), setFormSettings()
Methods inherited from X2Widget
__construct(), ajaxRender(), behaviors(), getModule(), renderFile(), setModule()
Methods inherited from CWidget
actions(), getController(), getId(), getOwner(), getViewFile(), getViewPath(), render(), 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
public array $htmlOptions array ( 'class' => '' )
#

$htmlOptions

$htmlOptions

public CActiveForm $form
#

CActiveForm Object optionally passed to the widget

CActiveForm Object optionally passed to the widget

public string $JSClass 'FormView'
#

Js Class name

Js Class name

public array $quickCreateModels array()
#

Models names that support quick create

Models names that support quick create

public array $idArray
#

An array of IDs of a current duplication. If set, the form input will become dropdowns of the different possible inputs

An array of IDs of a current duplication. If set, the form input will become dropdowns of the different possible inputs

public array $defaultsByRelatedModelType array()
#

[$defaultsByRelatedModelType description]

[$defaultsByRelatedModelType description]

public boolean $suppressQuickCreate false
#

If true, quick create buttons will not render Typicall true if this form is a quick create form

If true, quick create buttons will not render Typicall true if this form is a quick create form

Properties inherited from RecordView
$_fieldPermissions, $_fields, $_formSettings, $layoutData, $model, $modelName, $scenario, $specialFields, $suppressFields
Properties inherited from X2Widget
$_module
Properties inherited from CWidget
$actionPrefix, $skin
Magic properties inherited from X2Widget
$module
Magic properties inherited from CWidget
$controller, $id, $owner, $viewPath
X2CRM Documentation API documentation generated by ApiGen 2.8.0