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 X2ClientScript

Custom extension of CClientScript used by the app.

NLSClientScript
Extended by X2ClientScript
Package: application\components
Located at x2engine/protected/components/X2ClientScript.php
Methods summary
public
# getDefaultPackages( )
public
# getIEDefaultPackages( )
public
# getCacheBuster( )
public string
# renderOnRequest( boolean $includeScriptFiles = false )

Inserts the scripts at the beginning of the body section.

Inserts the scripts at the beginning of the body section.

Parameters

$includeScriptFiles
boolean
$includeScriptFiles whether to include external files, or just dynamic scripts

Returns

string
the output to be inserted with scripts.
public
# echoScripts( mixed $captureScripts = false )

Echoes out registered scripts and the necessary JavaScript to load all prerequisite script files.

Echoes out registered scripts and the necessary JavaScript to load all prerequisite script files.

Useful for loading UI elements via AJAX that require registering scripts.

public
# registerPackages( Array $packages, boolean $useDefaultPackages = false )

Registers a set of packages

Registers a set of packages

Parameters

$packages
Array
$packages
$useDefaultPackages
boolean
$useDefaultPackages
public
# registerCoreScript( mixed $name )

Modified Function from CClientScript to add custom packages

Modified Function from CClientScript to add custom packages

See

CClientScript::registerCoreScript
public
# getCurrencyConfigScript( )
public string
# getCacheBusterSuffix( mixed $url = null )

Returns a cache busting url suffix to be appended to JS/CSS files before registration Checks for presence of query string to determine the appropriate separator between the url and the cache buster string.

Returns a cache busting url suffix to be appended to JS/CSS files before registration Checks for presence of query string to determine the appropriate separator between the url and the cache buster string.

Returns

string
suffix
public
# registerResponsiveCssFile( mixed $url, mixed $media = '' )

Allows css containing media queries to be added conditionally

Allows css containing media queries to be added conditionally

public
# registerResponsiveCss( mixed $id, mixed $css, mixed $media = '' )

Allows css containing media queries to be added conditionally

Allows css containing media queries to be added conditionally

public
# makeUrlAbsolute( mixed $url )
public
# registerScriptFile( mixed $url, mixed $position = null, array $htmlOptions = array() )

Overrides parent method to add cache buster parameter and substitute the asset domain if requested

Overrides parent method to add cache buster parameter and substitute the asset domain if requested

public
# renderCoreScripts( )

Overrides parent method to add cache busting suffix to package files

Overrides parent method to add cache busting suffix to package files

public string
# renderX2TouchAssets( )

Used by X2Touch to return JS resources during ajax requests

Used by X2Touch to return JS resources during ajax requests

Returns

string
rendered JS in all positions This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/
public
# renderHead( string & $output )

Inserts the scripts in the head section.

Inserts the scripts in the head section.

Parameters

$output
string
$output the output to be inserted with scripts. This method is Copyright (c) 2008-2014 by Yii Software LLC http://www.yiiframework.com/license/
public
# registerScript( mixed $id, mixed $script, mixed $position = null, array $htmlOptions = array() )
protected
# renderScriptBatch( array $scripts )
public
# registerCssFile( mixed $url, mixed $media = '' )

Overrides parent method to add cache buster parameter and substitute the asset domain if requested

Overrides parent method to add cache buster parameter and substitute the asset domain if requested

public
# registerCssFiles( string $id, array $filenames, boolean $prependThemeUrl = true, mixed $media = '' )

Registers a set of css files using cache busting. For ie < 10, files are imported using css import statements within style tags. This is done to get around the 31 stylesheet limit in ie 6-9.

Registers a set of css files using cache busting. For ie < 10, files are imported using css import statements within style tags. This is done to get around the 31 stylesheet limit in ie 6-9.

Parameters

$id
string
id CSS script unique id
$filenames
array
$filenames array of filename strings
$prependThemeUrl
boolean
if true, theme url + '/css/' will be prepended to each filename
$media
public
# registerX2Flashes( )

Instantiates the Flashes utility class

Instantiates the Flashes utility class

public
# registerMain( )

Performs all the necessary JavaScript/CSS initializations for most parts of the app.

Performs all the necessary JavaScript/CSS initializations for most parts of the app.

public
# getAdmin( )
public
# setAdmin( Admin $value )
public
# getBaseUrl( )
public
# setBaseUrl( mixed $value )
public
# getFullscreen( )
public
# setFullscreen( mixed $value )
public
# getIsGuest( )
public
# setIsGuest( mixed $value )
public
# getProfile( )
public
# setProfile( Profile $value )
public
# getScriptUrl( )
public
# setScriptUrl( mixed $value )
public
# getThemeUrl( )
public
# setThemeUrl( mixed $value )
Properties summary
public boolean $useAbsolutePaths false
#
Magic properties summary
public boolean $fullscreen
#

Whether to render in full screen mode

Whether to render in full screen mode

X2CRM Documentation API documentation generated by ApiGen 2.8.0