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

  • ActionFormModel
  • ArrayUtil
  • ArrayValidator
  • AssociatedMediaBehavior
  • AuxLib
  • Changelog
  • DetailView
  • EncryptUtilTmp
  • EventsWidgetFieldFormatter
  • FailedLogins
  • FieldFormatter
  • FieldFormatterBase
  • FieldInputRenderer
  • FileFieldBehavior
  • FiltersForm
  • FilterUtil
  • FineDiff
  • FineDiffCopyOp
  • FineDiffDeleteOp
  • FineDiffInsertOp
  • FineDiffOp
  • FineDiffOps
  • FineDiffReplaceOp
  • GlobalCSSFormModel
  • GlobalImportFormModel
  • GoogleAuthenticator
  • JSONFieldsBehavior
  • JSONResponse
  • MediaFieldFormatter
  • MediaSelector
  • MobileActiveRecordFieldFormatter
  • MobileActivityFeed
  • MobileChartDashboard
  • MobileFieldFormatter
  • MobileFieldInputRenderer
  • ModuleModelNameValidator
  • MultiChildNode
  • MultiTypeAutocomplete
  • PasswordUtil
  • ProductFeature
  • ProfileWidgetLayout
  • QueryParamGenerator
  • RecordLimitBehavior
  • RecordView
  • RecordViewWidgetLayout
  • RelationshipsGridModel
  • RelationshipsJoin
  • RepairUserDataCommand
  • RequestUtil
  • RequiredIfNotSetValidator
  • ResponseUtil
  • RunMigrationScriptCommand
  • ServiceWebFormDesigner
  • Settings
  • StringUtil
  • TestEmailAction
  • TestEmailActionForm
  • ThemeGenerator
  • TimerUtil
  • TopicsFieldFormatter
  • TopicsWidgetLayout
  • TransactionalViewFieldFormatter
  • UrlUtil
  • ValidLinkValidator
  • WebFormDesigner
  • WebLeadFormDesigner
  • X2ActiveRecordBehavior
  • X2ActiveRecordFieldFormatter
  • X2ButtonColumn
  • X2ConditionList
  • X2ConsoleCommand
  • X2ControllerBehavior
  • X2DataColumn
  • X2DuplicateBehavior
  • X2Flashes
  • X2GridViewFieldFormatter
  • X2IPAddress
  • X2LeadsDataColumn
  • X2MergeableBehavior
  • X2MessageSource
  • X2MobileControllerBehavior
  • X2MobileProfileControllerBehavior
  • X2MobileQuotesControllerBehavior
  • X2MobileSiteControllerBehavior
  • X2MobileTopicsControllerBehavior
  • X2ModelConversionBehavior
  • X2ModelConversionWidget
  • X2ModelForeignKeyValidator
  • X2ModelUniqueIndexValidator
  • X2NonWebUser
  • X2StaticDropdown
  • X2StaticField
  • X2StaticFieldsBehavior
  • X2UrlManager
  • X2Validator
  • X2WidgetBehavior

Interfaces

  • AdminOwnedCredentials

Exceptions

  • CampaignMailingException
  • CodeExchangeException
  • GetCredentialsException
  • NoRefreshTokenException
  • NoUserIdException
  • StringUtilException

Functions

  • checkCurrency
  • checkDNS
  • checkServerVar
  • checkTimezone
  • decodeQuotes
  • echoIcons
  • encodeQuotes
  • exceptionForError
  • getField
  • getLanguageName
  • getModuleTitle
  • handleReqError
  • handleReqException
  • installer_t
  • installer_tr
  • isAllowedDir
  • mediaMigrationRrmdir
  • migrateMediaDir
  • printGraph
  • printR
  • renderFields
  • reqShutdown
  • RIP
  • translateOptions
  • tryGetRemote
  • Overview
  • Package
  • Class
  • Tree

Class RecordView

Abstract Class for rendering the Form view and Detail View Some things are awkward from being retroactivly applied. STRUCTURE: With a given form layout:

RenderMain (getMainOptions) RenderSections (getSectionOptions) RenderSectionTitle RenderRows (getRowOptions) RenderColumns (getColumnOptions) RenderItems (getItemOptions) RenderLabel RenderAttribute

The get<part>Options() function return an array of html options for that section. This makes it easier to override classes you want to add on specific elements

CComponent
Extended by CBaseController
Extended by CWidget
Extended by X2Widget
Extended by RecordView

Direct known subclasses

DetailView, FormView
Abstract
Located at x2engine/protected/components/RecordView.php
Methods summary
abstract 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
abstract public array
# getLayoutData( )

Gets the layout of the form.

Gets the layout of the form.

Returns

array
Array of the form layout
public
# setFormSettings( array $formSettings )
public
# init( )

Inititialization

Inititialization

Overrides

X2Widget::init()
public
# run( )

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

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

Overrides

CWidget::run()
public
# getPackages( )
public
# getJSClassParams( )
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
public array
# getSectionOptions( mixed $section, mixed $collapsed )

HtmlOptions for the .formSection tags

HtmlOptions for the .formSection tags

Returns

array
HTML Attributes
public array
# getRowOptions( mixed $row )

HtmlOptions for the .formSectionRow tags

HtmlOptions for the .formSectionRow tags

Returns

array
HTML Attributes
public array
# getColumnOptions( mixed $col, mixed $count )

HtmlOptions for the .formSectionColumn tags

HtmlOptions for the .formSectionColumn tags

Returns

array
HTML Attributes
public array
# getItemOptions( mixed $item, Fields $field )

HtmlOptions for the .formItem tags

HtmlOptions for the .formItem tags

Returns

array
HTML Attributes
public string
# renderMain( )

Renders the upper level tag and all sections

Renders the upper level tag and all sections

Returns

string
HTML
protected
# renderSections( )
public string
# renderSection( mixed $section, mixed $collapsed )

Renders the tag for all sections and renders the interior rows

Renders the tag for all sections and renders the interior rows

Returns

string
HTML
public
# renderSectionHeader( array $section )

Renders a section header

Renders a section header

Parameters

$section
array
$section Section Options
public
# renderRow( mixed $row )

Renders a .formSectionRow and interior columns

Renders a .formSectionRow and interior columns

public
# renderColumn( array $col, integer $count )

Renders .formSectionColumn and interior Items Note that this is a table

Renders .formSectionColumn and interior Items Note that this is a table

Parameters

$col
array
$col Layout options for columns
$count
integer
$count count of columns in this row
public
# renderItem( mixed $item )
public
# renderNoneLabel( mixed $item, Fields $field )

Renders the None Label type. Omits the label and increases colspan to to 2

Renders the None Label type. Omits the label and increases colspan to to 2

public
# renderInlineLabel( mixed $item, Fields $field )

See

RecordView::renderNoneLabel()
public [type]
# renderTopLabel( [type] $item, Fields $field )

Renders the top label type. Renders the label in it's own row, increases colspan to 2

Renders the top label type. Renders the label in it's own row, increases colspan to 2

Parameters

$item
[type]
$item [description]
$field
[type]
$field [description]

Returns

[type]
[description]
public
# renderLeftLabel( mixed $item, Fields $field )

Renders the most common label, LeftLabel

Renders the most common label, LeftLabel

public
# renderLabel( mixed $field )

Renders the label of a field

Renders the label of a field

public array
# getFieldPermissions( )

Gets the field Permissions into an aray

Gets the field Permissions into an aray

Returns

array
array of field permissions
public array
# getFields( )

Retrieves all Fields for this model

Retrieves all Fields for this model

Returns

array
array of Fields objects
public
# canEdit( Fields $field )

Returns if the form or a specific field can be edited. If Field is empty, it returns permissions of whole form

Returns if the form or a specific field can be edited. If Field is empty, it returns permissions of whole form

public
# canView( mixed $field )
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' => 'x2-layout-island' )
#

$htmlOptions

$htmlOptions

public string $JSClass 'RecordView'
#

JS Class

JS Class

public string $modelName
#

Model Name of the record being displayed

Model Name of the record being displayed

public [type] $model
#

Model obejct of the record being displayed

Model obejct of the record being displayed

public string $scenario 'Default'
#

Scenario of the form. options: Default, Inline

Scenario of the form. options: Default, Inline

public array $suppressFields array()
#

Fields to hide from the form

Fields to hide from the form

public array $specialFields array()
#

Special fields to render within the view

Special fields to render within the view

public array $layoutData
#

The parsed JSON created from the form layout editor

The parsed JSON created from the form layout editor

protected array $_formSettings
#

The form settings that contains the saved collapsed sections

The form settings that contains the saved collapsed sections

protected array $_fieldPermissions
#

Array of field permissions

Array of field permissions

protected array $_fields
#

Array of fields objects to extract settings from

Array of fields objects to extract settings from

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