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

No package

Classes summary
ActionFormModel Form model for publisher action form. Simplifies publisher form submission since it allows all types to be treated the same. Also allows for additional validation rules not applied to main action form.
ArrayUtil Standalone class with miscellaneous array functions
ArrayValidator Miscellaneous additions to CValidator including option to have errors reported in the form of exceptions. Certain bad inputs will not occur during normal form submission and indicate either a programming error a malicious request. In either of these cases it makes sense to throw an exception instead of adding errors to the model.
AssociatedMediaBehavior Manages file upload for filename fields. If file fails to be saved, save/update will be cancelled.
AuxLib Standalone class with miscellaneous utility functions
Changelog This is the model class for table "x2_changelog".
DetailView Child Class of Record View to display a form with inline editing.
EncryptUtilTmp Copy of Encrypt util with an irrelevant method removed
EventsWidgetFieldFormatter Handles rendering of X2Model fields
FailedLogins Model for x2_failed_logins table
FieldFormatter Handles rendering of X2Model fields
FieldFormatterBase Handles rendering of X2ActiveRecord fields
FieldInputRenderer Allows behavior of X2Model::renderModelInput to be overridden. TODO: make this class non-abstract and move X2Model::renderModelInput into here, splitting rendering code into methods grouped by field type.
FileFieldBehavior Manages file upload for filename fields. If file fails to be saved, save/update will be cancelled.
FiltersForm Filterform to use filters in combination with CArrayDataProvider and CGridView
FilterUtil
FineDiff FineDiff class
FineDiffCopyOp Persisted opcodes (string) are a sequence of atomic opcode. A single opcode can be one of the following: c | c{n} | d | d{n} | i:{c} | i{length}:{s} 'c' = copy one character from source 'c{n}' = copy n characters from source 'd' = skip one character from source 'd{n}' = skip n characters from source 'i:{c} = insert character 'c' 'i{n}:{s}' = insert string s, which is of length n
FineDiffDeleteOp Persisted opcodes (string) are a sequence of atomic opcode. A single opcode can be one of the following: c | c{n} | d | d{n} | i:{c} | i{length}:{s} 'c' = copy one character from source 'c{n}' = copy n characters from source 'd' = skip one character from source 'd{n}' = skip n characters from source 'i:{c} = insert character 'c' 'i{n}:{s}' = insert string s, which is of length n
FineDiffInsertOp Persisted opcodes (string) are a sequence of atomic opcode. A single opcode can be one of the following: c | c{n} | d | d{n} | i:{c} | i{length}:{s} 'c' = copy one character from source 'c{n}' = copy n characters from source 'd' = skip one character from source 'd{n}' = skip n characters from source 'i:{c} = insert character 'c' 'i{n}:{s}' = insert string s, which is of length n
FineDiffOp Persisted opcodes (string) are a sequence of atomic opcode. A single opcode can be one of the following: c | c{n} | d | d{n} | i:{c} | i{length}:{s} 'c' = copy one character from source 'c{n}' = copy n characters from source 'd' = skip one character from source 'd{n}' = skip n characters from source 'i:{c} = insert character 'c' 'i{n}:{s}' = insert string s, which is of length n
FineDiffOps FineDiff ops
FineDiffReplaceOp Persisted opcodes (string) are a sequence of atomic opcode. A single opcode can be one of the following: c | c{n} | d | d{n} | i:{c} | i{length}:{s} 'c' = copy one character from source 'c{n}' = copy n characters from source 'd' = skip one character from source 'd{n}' = skip n characters from source 'i:{c} = insert character 'c' 'i{n}:{s}' = insert string s, which is of length n
GlobalCSSFormModel Used to validate/manage global css
GlobalImportFormModel Used to validate global import form
GoogleAuthenticator Wrapper class for interaction with Google's API and authentication methods. This is designed to handle all user authentication and returning of Google API Client classes in an easy to use manner. Much of the code is from Google's stock PHP API examples, but it has been modified to be usable with our software and as such some of the comments/classes are Google developers' not mine.
JSONFieldsBehavior Enables automatic decoding/encoding of field values
JSONResponse Class designed to provide uniform structure for JSON-encoded responses
MediaFieldFormatter Handles rendering of X2Model fields
MediaSelector Media Selector Widget. Pops up when the Media button is clicked on the CKEditor. The button will lazily load this widget via site/mediaSelector and append it to the dom with all JS.
MobileActiveRecordFieldFormatter Handles rendering of X2ActiveRecord fields
MobileActivityFeed
MobileChartDashboard
MobileFieldFormatter Handles rendering of X2Model fields
MobileFieldInputRenderer Allows behavior of X2Model::renderModelInput to be overridden. TODO: make this class non-abstract and move X2Model::renderModelInput into here, splitting rendering code into methods grouped by field type.
ModuleModelNameValidator Used to ensure that types are main models of visible and editable modules
MultiChildNode Abstract base for nodes with multiple children (splitter and conditional)
MultiTypeAutocomplete Renders a record type selector which refreshes an autocomplete input when changed
PasswordUtil
ProductFeature Description of ProductFeature
ProfileWidgetLayout Manages profile widget settings
QueryParamGenerator Utility class for simplifying generation SQL parameters
RecordLimitBehavior Deletes oldest records if count surpasses limit
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:
RecordViewWidgetLayout Manages record view widget settings
RelationshipsGridModel Handles relationship grid attribute rendering and filtering
RelationshipsJoin Generic active record class for relationships join tables
RepairUserDataCommand Repair action/contact data corrupted by user deletion prior to version 4.1
RequestUtil Class to simplify web requests by abstracting creation of curl handles and stream contexts
RequiredIfNotSetValidator Miscellaneous additions to CValidator including option to have errors reported in the form of exceptions. Certain bad inputs will not occur during normal form submission and indicate either a programming error a malicious request. In either of these cases it makes sense to throw an exception instead of adding errors to the model.
ResponseUtil Standalone environmentally-agnostic content/message feedback utility.
RunMigrationScriptCommand
ServiceWebFormDesigner Parent Widget class to handle the 3 different Webforms
Settings Model class for Generic settings with structure defined in embedded model class
StringUtil
TestEmailAction Simulates campaign email delivery
TestEmailActionForm Adds test campaign-specific fields to InlineEmail
ThemeGenerator Class to generate a CSS files from profile settings, works as a templating system. Templates files are .php files that return a string of css. The array $colors will be sent to the files with generated keys based on $settingsList.
TimerUtil
TopicsFieldFormatter Handles rendering of X2Model fields
TopicsWidgetLayout Manages record view widget settings
TransactionalViewFieldFormatter Handles rendering of X2Model fields
UrlUtil
ValidLinkValidator
WebFormDesigner Parent Widget class to handle the 3 different Webforms
WebLeadFormDesigner Parent Widget class to handle the 3 different Webforms
X2ActiveRecordBehavior Adds ability to specify validation rules for pseudo-properties
X2ActiveRecordFieldFormatter Handles rendering of X2ActiveRecord fields
X2ButtonColumn Display column for attributes of X2Model subclasses.
X2ConditionList Generic condition list form which enables user specification of conditions on model properties. User specified conditions can be retrieved through the front-end X2ConditionList API (see X2ConditionList.js).
X2ConsoleCommand
X2ControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2DataColumn Display column for attributes of X2Model subclasses.
X2DuplicateBehavior Behavior to provide requisite methods for checking for potential duplicate records. Currently only implemented in Contacts and Accounts.
X2Flashes Used to collect error, notice, and success messages which can then be echoed back to the client. This can be used in conjunction with the UI library X2Flashes.js.
X2GridViewFieldFormatter Handles rendering of X2Model fields
X2IPAddress X2IPAddress helper component for useful IP address methods
X2LeadsDataColumn Display column for attributes of X2Model subclasses.
X2MergeableBehavior Behavior to define the set of methods necessary to merge two or more records into a single record. Should always be implemented on records which have X2DuplicateBehavior but is more general in its application.
X2MessageSource This is a modified version of the default Yii class. The only change that has been made is the inclusion of "common.php" as a shared source of translation messages. Ctrl + F for "X2CHANGE" to find the exact location of this customization.
X2MobileControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2MobileProfileControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2MobileQuotesControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2MobileSiteControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2MobileTopicsControllerBehavior Allows behavior to add actions and beforeAction handler to owner controller (see X2Controller::getBehaviorActions())
X2ModelConversionBehavior Manages conversion between subclasses of X2Model
X2ModelConversionWidget Widget for record conversion links which leverage X2ModelConversionBehavior. Designed to have multiple instances on the same page (which is useful if links for multiple conversion targets are needed).
X2ModelForeignKeyValidator Miscellaneous additions to CValidator including option to have errors reported in the form of exceptions. Certain bad inputs will not occur during normal form submission and indicate either a programming error a malicious request. In either of these cases it makes sense to throw an exception instead of adding errors to the model.
X2ModelUniqueIndexValidator Miscellaneous additions to CValidator including option to have errors reported in the form of exceptions. Certain bad inputs will not occur during normal form submission and indicate either a programming error a malicious request. In either of these cases it makes sense to throw an exception instead of adding errors to the model.
X2NonWebUser User for console applications.
X2StaticDropdown Behaves as stand in for Dropdowns class. $options can be set to a callable to enable lazy loading.
X2StaticField Behaves as stand in for Fields class
X2StaticFieldsBehavior Allows fields to be defined in an array, instead of in the x2_fields table. Enables use of features that have a Fields dependency, without having to subclass X2Model or introduce unnecessary database interaction.
X2UrlManager
X2Validator Miscellaneous additions to CValidator including option to have errors reported in the form of exceptions. Certain bad inputs will not occur during normal form submission and indicate either a programming error a malicious request. In either of these cases it makes sense to throw an exception instead of adding errors to the model.
X2WidgetBehavior Adds namespace mechanism, packages, and JS class instantiation to children of CWidget
Interfaces summary
AdminOwnedCredentials
Exceptions summary
CampaignMailingException Campaign mailing instant halt exception class that retains data regarding the current operation.
CodeExchangeException Exception thrown when a code exchange has failed.
GetCredentialsException Exception thrown when an error occurred while retrieving credentials.
NoRefreshTokenException Exception thrown when no refresh token has been found.
NoUserIdException Exception thrown when no user ID could be retrieved.
StringUtilException
Functions summary
checkCurrency
checkDNS Attempt to query a host name's DNS record.
checkServerVar Test the consistency of the $_SERVER global.
checkTimezone
decodeQuotes
echoIcons
encodeQuotes
exceptionForError Throws an exception when encountering an error for easier handling.
getField
getLanguageName
getModuleTitle
handleReqError Error handler.
handleReqException Exception handler.
installer_t
installer_tr
isAllowedDir Tells if the directory is within the open_basedir restriction
mediaMigrationRrmdir
migrateMediaDir
printGraph
printR
renderFields
reqShutdown Shutdown function (for fatal errors, i.e. call to undefined function)
RIP Wrapper for die()
translateOptions
tryGetRemote Attempt to access a remote URL
X2CRM Documentation API documentation generated by ApiGen 2.8.0