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 UpdaterBehavior

Behavior class with application updater/upgrader utilities.

Note to all future developers: it is important to bear in mind that if you need to make changes to the updates system or the updater in general, they must be backwards-compatible with all earlier versions of the software (or as far back as possible).

CComponent
Extended by CBehavior implements IBehavior
Extended by ResponseBehavior
Extended by UpdaterBehavior
Package: application\components
Author: Demitri Morgan <demitri@x2engine.com>
Located at x2engine/protected/components/UpdaterBehavior.php
Methods summary
public static
# classAliasPath( array $alias )

Converts an array formatted like a behavior or controller actions array entry and returns the path (relative to X2WebApplication.basePath to the class file. Yii::getPathOfAlias() is unsafe to use, because in cases where this function is to be used, the files may not exist yet.

Converts an array formatted like a behavior or controller actions array entry and returns the path (relative to X2WebApplication.basePath to the class file. Yii::getPathOfAlias() is unsafe to use, because in cases where this function is to be used, the files may not exist yet.

Parameters

$alias
array
$classes An array containing a "class" => [Yii path alias] entry
public
# applyFiles( array $dir = null )

In the case of a failed update or other event, restore files from a backup location.

In the case of a failed update or other event, restore files from a backup location.

Parameters

$dir
array
$fileList Array of paths relative to webroot to restore from backup.
public boolean
# backCompatHooks( mixed $latestUpdaterVersion )

Backwards compatibility hacks - I mean, hooks - to run after self-updating.

Backwards compatibility hacks - I mean, hooks - to run after self-updating.

Sometimes, downloading a copy of itself isn't enough. The updater must do additional work after it self-updates in order to resolve unforeseen post-refresh issues.

This works by creating a file in the runtime folder that counts as evidence that it has been run already and thus does not need to be run again (to avoid endless redirect loops in the web updater, for instance).

This was added because the decision was made to add ResponseUtil as a dependency, yet because the file already exists as of many versions before, it wouldn't be automatically fetched, because the earlier version of the updater wouldn't have known that it needed to be updated first.

Returns

boolean
True or false; true indicates that action has been taken, whereas false indicates no action needs to be taken nor has been taken.
public
# attach( type $owner )

Parameters

$owner
type
$owner

Overrides

ResponseBehavior::attach()
public
# checkFiles( )

Checks for the existence of an unpacked update package folder, and if present, whether all files are present and complete.

Checks for the existence of an unpacked update package folder, and if present, whether all files are present and complete.

public
# checkIf( mixed $name, mixed $throw = true )

Generic dependency and prerequisite checking function.

Generic dependency and prerequisite checking function.

A wrapper for all functions with names beginning with "checkIf"; runs a test if it hasn't been run already and returns the result (or throws an exception). Stores the result of a check so that it isn't necessary to run the check again.

All "checkIf" functions must have the rest of their names named after a condition, i.e. "AllClear" to "checkIfAllClear", and have a corresponding private property named accordingly (i.e. for "checkIfFoo" the property must be named "_foo"). The correspoding property must have a default value of false (boolean).

public boolean
# checkIfCanSpawnChildren( type $throw = true )

Checks whether it is possible to run system commands using PHP's proc_open() function.

Checks whether it is possible to run system commands using PHP's proc_open() function.

Parameters

$throw
type
$throw

Returns

boolean
public boolean
# checkIfChecksumsAvail( type $throw = true )

Checks if the package content digests file is present and not empty.

Checks if the package content digests file is present and not empty.

Said file (specifically, its content) is necessary for checking whether files were downloaded and extracted properly.

Parameters

$throw
type
$throw

Returns

boolean

Throws

CException
public
# checkIfDatabaseBackupExists( type $throw = true )

Checks to see if a file exists and isn't very old..

Checks to see if a file exists and isn't very old..

Parameters

$throw
type
$bakFile

Throws

Exception
public boolean|string
# checkIfManifestAvail( type $throw = true )

Checks if the manifest file is present and intact.

Checks if the manifest file is present and intact.

Parameters

$throw
type
$throw If false, returns; if true, throws or returns based on the success of the check

Returns

boolean|string
If not throwing: it will be the string representing the relative path to the manifest if it exists, and false if it doesn't.

Throws

CException
public
# checkIfPackageApplies( mixed $throw = true )

Ensures that the package actually applies to the current version and edition.

Ensures that the package actually applies to the current version and edition.

Throws

CException
public boolean
# checkIfPackageExists( boolean $throw = true )

Check to see if there is an update package present in the filesystem.

Check to see if there is an update package present in the filesystem.

Parameters

$throw
boolean
$throw Whether or not to throw an exception instead of returning false

Returns

boolean
True if the update package directory and contents digest file are present; false otherwise

Throws

CException
public
# checkUpdates( mixed $returnOnly = false )

Securely obtain the latest version.

Securely obtain the latest version.

public
# cleanUp( )

Deletes the update package folder

Deletes the update package folder

public
# copyFile( string $path, string $dir = null, string $ds = DIRECTORY_SEPARATOR )

Copies files out of a folder and into the live installation.

Copies files out of a folder and into the live installation.

Wrapper for FileUtil::ccopy() for updates that can operate recursively without requiring a list of files.

Parameters

$path
string
$path Path relative to the web root to be copied (this is the target, unless dir is null, in which case it's the source)
$dir
string
$file The path to copy (assumed relative to the webroot)
$ds
string
$dir The name of the backup directory; "." means top-level directory
public
# downloadPackage( type $version = null, type $uniqueId = null, type $edition = null )

Obtains update/upgrade data package from the server.

Obtains update/upgrade data package from the server.

Parameters

$version
type
$version
$uniqueId
type
$uniqueId
$edition
type
$edition
public boolean
# downloadSourceFile( string $file, string $route = null, integer $maxAttempts = 5 )

Retrieves a file from the update server. It will be stored in a temporary directory, "tmp", in the web root. To copy it into the live install, use restoreBackup on target "tmp".

Retrieves a file from the update server. It will be stored in a temporary directory, "tmp", in the web root. To copy it into the live install, use restoreBackup on target "tmp".

Parameters

$file
string
$route Route relative to the web root of the web root path in the X2Engine source code
$route
string
$file Path relative to the X2Engine web root of the file to be downloaded
$maxAttempts
integer
$maxAttempts Maximum times to attempt to download the file before giving up and throwing an exception.

Returns

boolean

Throws

Exception
public
# enactChanges( array $autoRestore = false )

Finalizes an update/upgrade by applying file, database and configuration changes.

Finalizes an update/upgrade by applying file, database and configuration changes.

This method replaces the SQL method as well as finishing copying files over. Both of these happen at once to prevent issues from files depending on SQL changes or vice versa.

Parameters

$autoRestore
array
$params parameters for update or upgrade
public
# handleSqlFailure( string $sql, boolean $sqlRun, mixed $sqlErr, mixed $backup, mixed $throw = true )

Handle database backups in the event of failure

Handle database backups in the event of failure

Parameters

$sql
string
$error SQL Error
$sqlRun
boolean
$backup Whether to restore from backup
$sqlErr
$backup
$throw
public
# finalizeUpdate( mixed $scenario, mixed $unique_id, mixed $version, mixed $edition )

Notify the server that the update has finished

Notify the server that the update has finished

public type
# formatDefinitionList( type $list, type $web )

Generates a "definition list"

Generates a "definition list"

Parameters

$list
type
$list Array with keys the terms and values their definition entries
$web
type
$web Whether to generate markup (if true) or console output (if false)

Returns

type
public string
# getBackCompatFile( )

Returns the path to the backwards-compatibility flag file.

Returns the path to the backwards-compatibility flag file.

Returns

string
public array
# getChecksums( )

Parse output formatted according to that of md5sum into an array of hashes indexed by filename. If no output is specified, the update package's content digest will be used as input.

Parse output formatted according to that of md5sum into an array of hashes indexed by filename. If no output is specified, the update package's content digest will be used as input.

Obtains checksums.

Returns

array
public
# getChecksumsContent( )
public array
# getCompatibilityStatus( )

Checks the current X2Engine installation for compatibility issues with the current package as defined in the manifest and requirements check script.

Checks the current X2Engine installation for compatibility issues with the current package as defined in the manifest and requirements check script.

Returns

array
public array
# getConfigVars( )

Gets configuration variables from the configuration file(s).

Gets configuration variables from the configuration file(s).

Returns

array
public string
# getDbBackupCommand( )

Magic getter for dbBackupCommand

Magic getter for dbBackupCommand

Returns

string

Throws

Exception
public string
# getDbBackupPath( )

Magic getter for dbBackupPath

Magic getter for dbBackupPath

Returns

string
public string
# getDbCommand( )

Magic getter for dbCommand

Magic getter for dbCommand

Returns

string

Throws

Exception
public array
# getDbParams( )

Magic getter for database parameters from the application's DSN and CDbConnection

Magic getter for database parameters from the application's DSN and CDbConnection

Returns

array
public string
# getEdition( )

Backwards-compatible function for obtaining the edition of the installation. Attempts to not fail and return a valid value even if the application singleton doesn't store the information.

Backwards-compatible function for obtaining the edition of the installation. Attempts to not fail and return a valid value even if the application singleton doesn't store the information.

It uses try/catch blocks because Yii's way of checking if properties exist as of 1.1.x does not include properties "inherited" from behaviors.

Returns

string
public array
# getFiles( )

Obtains the list of files and their statuses (essentially a wrapper function for UpdaterBehavior::checkFiles())

Obtains the list of files and their statuses (essentially a wrapper function for UpdaterBehavior::checkFiles())

Returns

array
public array
# getFilesByStatus( )

Return an array of arrays of files each indexed by the status (present, corrupt or missing) of those sets of files.

Return an array of arrays of files each indexed by the status (present, corrupt or missing) of those sets of files.

Returns

array
public array
# getFilesStatus( )

Obtains filesStatus

Obtains filesStatus

Returns

array
public string
# getLatestUpdaterVersion( )

Gets the latest version of the updater utility

Gets the latest version of the updater utility

Returns

string
public
# getLockFile( )

Magic getter for lockFile

Magic getter for lockFile

public
# getManifest( )

Obtains manifest

Obtains manifest

public boolean
# getNoHalt( )

Magic getter for noHalt

Magic getter for noHalt

Returns

boolean
public type
# getRequirements( )

Magic getter for requirements

Magic getter for requirements

Returns

type

Throws

CException
public
# getScenario( )
public
# getSettings( )

Getter for settings

Getter for settings

public string
# getSourceDir( )

Obtains sourceDir

Obtains sourceDir

Returns

string
public string
# getSourceFileRoute( type $edition = null, type $uniqueId = null )

Auto-construct a relative base URL on the updates server from which to retrieve source files.

Auto-construct a relative base URL on the updates server from which to retrieve source files.

Parameters

$edition
type
$edition
$uniqueId
type
$uniqueId

Returns

string
public string
# getThisPath( )

Magic getter for UpdaterBehavior::getThisPath()

Magic getter for UpdaterBehavior::getThisPath()

Returns

string
public type
# getUniqueId( )

Backwards-compatible function for obtaining the unique id. Very similar to getEdition in regard to its backwards compatibility.

Backwards-compatible function for obtaining the unique id. Very similar to getEdition in regard to its backwards compatibility.

Returns

type
public array
# getUpdateData( string $version = null, string $uniqueId = null, string $edition = null )

Retrieves update data from the server. For previewing an update before downloading it; this essentially retrieves the manifest without retrieving the full package.

Retrieves update data from the server. For previewing an update before downloading it; this essentially retrieves the manifest without retrieving the full package.

Parameters

$version
string
$version Version updating/upgrading from
$uniqueId
string
$uniqueId The identifier/product key for this installation of X2Engine
$edition
string
$edition The edition updating/upgrading from

Returns

array
public string
# getUpdateDataRoute( string $version = null, string $uniqueId = null, string $edition = null )

Gets a relative URL on the update server from which to obtain update data

Gets a relative URL on the update server from which to obtain update data

Parameters

$version
string
$version
$uniqueId
string
$edition
$edition
string
$uniqueId

Returns

string
public
# getUpdateDir( )
public
# getUpdatePackage( )
public
# getUpdateServer( )

Base URL of the web server from which to fetch data and files

Base URL of the web server from which to fetch data and files

public
# getVersion( )
public string
# getWebRoot( )

Web root magic getter.

Web root magic getter.

Resolves the absolute path to the webroot of the application without using the 'webroot' alias, which only works in web requests. Note, the realpath() function will strip off the trailing directory separator

Returns

string
public array
# getWebUpdaterActions( boolean $getter = true )

Returns the actions associated with the web-based updater.

Returns the actions associated with the web-based updater.

Parameters

$getter
boolean
$getter If being called as a getter, this method will attempt to download actions if they don't exist on the server yet. Otherwise, if this parameter is explicitly set to False, the return value will include the abstract base action class (in which case it should not be used in the return value of CController::actions() ) for purposes of checking dependencies.

Returns

array
An array of actions appropriate for inclusion in the return value of CController::actions().
public boolean
# makeDatabaseBackup( )

Back up the application database.

Back up the application database.

Attempts to perform a database backup using mysqldump or any other tool that might exist.

Returns

boolean
public boolean
# regenerateConfig( type $newversion = Null, type $newupdaterVersion = Null, type $newbuildDate = null, string $newAppName = null )

Rebuilds the configuration file and performs the final few little update tasks.

Rebuilds the configuration file and performs the final few little update tasks.

Parameters

$newversion
type
$newversion If set, change the version to this value in the resulting config file
$newupdaterVersion
type
$newupdaterVersion If set, change the updater version to this value in the resulting config file
$newbuildDate
type
$newbuildDate If set, change the build date to this value in the resulting config file
$newAppName
string
$newAppName If set, will be used to replace the app name in the config file.

Returns

boolean

Throws

Exception
public
# removeDatabaseBackup( )

Deletes the database backup file.

Deletes the database backup file.

public
# removeFiles( array $deletionList )

Deletes a list of files.

Deletes a list of files.

Parameters

$deletionList
array
$deletionList
public
# renderCompatibilityMessages( string $h = "h3", string $htmlOptions = array() )

Generates user-friendly messages for letting users know about update compatibility issues.

Generates user-friendly messages for letting users know about update compatibility issues.

Parameters

$h
string
$h Tag in which to wrap "section" titles
$htmlOptions
string
$htmlOptions Options for the titles of each section
public
# requireDependencies( )

Checks whether all dependencies of the updater exist on the server, and downloads any that don't.

Checks whether all dependencies of the updater exist on the server, and downloads any that don't.

public
# resetAssets( )

Removes everything in the assets folder.

Removes everything in the assets folder.

public boolean
# restoreDatabaseBackup( )

Uses a database dump to reinstate the database backup.

Uses a database dump to reinstate the database backup.

Returns

boolean

Throws

Exception
public
# runMigrationScripts( type $scripts, type $ran, mixed $backup )

Runs a list of migration scripts.

Runs a list of migration scripts.

Parameters

$scripts
type
$scripts
$ran
type
$ran List of database changes and other scripts that have already been run
$backup
public
# setChecksums( string $value )

Set the checksum contents to a specific value. Resets _checksumsContent; it no longer is applicable.

Set the checksum contents to a specific value. Resets _checksumsContent; it no longer is applicable.

Parameters

$value
string
$value
public
# setChecksumsContent( mixed $value )
public
# setConfigPermissions( type $value )

Magic setter that changes the file permissions of sensitive files in protected/config

Magic setter that changes the file permissions of sensitive files in protected/config

Parameters

$value
type
$value
public
# setEdition( mixed $value )
public
# setManifest( array $value )

Sets the update data to a specific value

Sets the update data to a specific value

Parameters

$value
array
$value
public
# setNoHalt( type $value )

Magic setter for noHalt. Kept here so that console applications can use it to stop more gracefully.

Magic setter for noHalt. Kept here so that console applications can use it to stop more gracefully.

Parameters

$value
type
$value
public
# setScenario( mixed $value )
public
# setUniqueId( mixed $value )

Sets the unique ID for the installation.

Sets the unique ID for the installation.

public
# setVersion( mixed $value )
public
# sqlError( type $sqlFail, type $sqlRun = array(), mixed $errorMessage = null, mixed $throw = true )

Exits, returning SQL error messages

Exits, returning SQL error messages

Parameters

$sqlFail
type
$sqlRun
$sqlRun
type
$errorMessage
$errorMessage
$throw
public
# testDatabasePermissions( )
public
# unpack( )

Unzips the package.

Unzips the package.

Throws

Exception
public array
# updateUpdater( type $updaterCheck )

In which the updater downloads a new version of itself.

In which the updater downloads a new version of itself.

Parameters

$updaterCheck
type
$updaterCheck New version of the update utility

Returns

array
Methods inherited from ResponseBehavior
__construct(), getIsConsole(), getLogCategory(), getResponse(), mergeResponse(), output(), respond(), ruProperty(), setErrorCode(), setExitNonFatal(), setIsConsole(), setLogCategory(), setLongErrorTrace(), setShutdown()
Methods inherited from CBehavior
detach(), events(), getEnabled(), getOwner(), setEnabled()
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()
Constants summary
string BAKFILE 'update_backup.sql'
#

SQL backup dump file

SQL backup dump file

string LOCKFILE 'app_update.lock'
#

Defines a file that (for extra security) prevents race conditions in the unlikely event that multiple requests to the web updater to enact file/database changes are made.

Defines a file that (for extra security) prevents race conditions in the unlikely event that multiple requests to the web updater to enact file/database changes are made.

string PKGFILE 'update.zip'
#
string TMP_DIR 'tmp'
#
string ERRFILE 'update_db_restore.err'
#
string LOGFILE 'update_db_restore.log'
#
string BCOFILE 'backcompat.run'
#
string UPDATE_DIR 'update'
#
string SECURITY_IMG 'cG93ZXJlZF9ieV94MmVuZ2luZS5wbmc='
#
integer ERR_ISLOCKED 1
#
integer ERR_CHECKSUM 2
#
integer ERR_MANIFEST 3
#
integer ERR_NOUPDATE 4
#
integer ERR_FILELIST 5
#
integer ERR_NOTAPPLY 6
#
integer ERR_UPSERVER 7
#
integer ERR_DBNOBACK 8
#
integer ERR_DBOLDBAK 9
#
integer ERR_SCENARIO 10
#
integer ERR_NOPROCOP 11
#
integer ERR_DATABASE 12
#
integer FILE_PRESENT 0
#
integer FILE_CORRUPT 1
#
integer FILE_MISSING 2
#
Properties summary
public static string $configFilename 'X2Config.php'
#

Core configuration file name.

Core configuration file name.

public static array $_configVarNames array( 'appName', 'email', 'host', 'user', 'pass', 'dbname', 'version', 'buildDate', 'updaterVersion', 'language', )
#

Configuration file variables as [variable name] => [value quote wrap] as can be found in the file protected/config/X2Config.php

Configuration file variables as [variable name] => [value quote wrap] as can be found in the file protected/config/X2Config.php

public static string $_logCategory 'application.updater'
#

Explicit override of default ResponseBehavior::$_logCategory

Explicit override of default ResponseBehavior::$_logCategory

public array $updaterFiles array( "views/admin/updater.php", "components/UpdaterBehavior.php", "components/util/FileUtil.php", "components/util/EncryptUtil.php", "components/util/ResponseUtil.php", "components/ResponseBehavior.php", "components/views/requirements.php", "commands/UpdateCommand.php" )
#

List of files used by the behavior

List of files used by the behavior

Properties inherited from ResponseBehavior
$handleErrors, $handleExceptions
Magic properties summary
public string $backCompatFile
#

Path to the backwards compatibility flag file.

Path to the backwards compatibility flag file.

public array $checksums
#

When running an update, this is a list of all MD5 hashes of files to be applied, with filenames their keys and checksums their values.

When running an update, this is a list of all MD5 hashes of files to be applied, with filenames their keys and checksums their values.

public string $checksumsContent
#

The contents of the package contents digest file.

The contents of the package contents digest file.

public array $compatibilityStatus
#

An array specifying compatibility issues.

An array specifying compatibility issues.

public array $configVars
#

(read-only) variables imported from the configuration

(read-only) variables imported from the configuration

public string $dbBackupCommand
#

(read-only) command to be used for backing up the database

(read-only) command to be used for backing up the database

public string $dbBackupPath
#

(read-only) Full path to the database backup file.

(read-only) Full path to the database backup file.

public string $dbCommand
#

(read-only) command to be used for running SQL from files

(read-only) command to be used for running SQL from files

public array $dbParams
#

(read-only) Database information retrieved from CDbConnection

(read-only) Database information retrieved from CDbConnection

public string $edition
#

(read-only) The edition of the installation of X2Engine.

(read-only) The edition of the installation of X2Engine.

public array $files
#

(read-only) A list of files and their statuses (present, missing or corrupt).

(read-only) A list of files and their statuses (present, missing or corrupt).

public array $filesByStatus
#

(read-only) An array of files in each status category

(read-only) An array of files in each status category

public array $filesStatus
#

(read-only) A summary (showing counts) of all files' statuses.

(read-only) A summary (showing counts) of all files' statuses.

public string $latestUpdaterVersion
#

(read-only) The latest version of the updater utility according to the updates server

(read-only) The latest version of the updater utility according to the updates server

public string $lockFile
#

Path to the file to use for locking when applying changes

Path to the file to use for locking when applying changes

public array $manifest
#

When running an update, this is the change manifest as retrieved from the update package

When running an update, this is the change manifest as retrieved from the update package

public boolean $noHalt
#

Whether to terminate the PHP process if errors occur

Whether to terminate the PHP process if errors occur

public PDO $pdo
#

(read-only) The app's PDO instance

(read-only) The app's PDO instance

public array $requirements
#

(read-only) Requirements script output.

(read-only) Requirements script output.

public string $scenario
#

Usage scenario, i.e. update/upgrade

Usage scenario, i.e. update/upgrade

public string $sourceDir
#

(read-only) Absolute path to the base directory of source files to be applied in the update/upgrade

(read-only) Absolute path to the base directory of source files to be applied in the update/upgrade

public string $sourceFileRoute
#

(read-only) Route (relative URL on the updates server) from which to download source files in a pinch

(read-only) Route (relative URL on the updates server) from which to download source files in a pinch

public string $thisPath
#

(read-only) Absolute path to the current working directory

(read-only) Absolute path to the current working directory

public string $uniqueId
#

(read-only) Unique ID of the installation

(read-only) Unique ID of the installation

public string $updateDataRoute
#

(read-only) Relative URL (to the base URL of the update server) from which to get update manifests.

(read-only) Relative URL (to the base URL of the update server) from which to get update manifests.

public string $updateDir
#

(read-only) the directory of updates.

(read-only) the directory of updates.

public string $updatePackage
#

(read-only) destination path for the update package.

(read-only) destination path for the update package.

public string $updateServer
#

Base URL of the web server from which to fetch data and files

Base URL of the web server from which to fetch data and files

public string $version
#

Version of X2Engine

Version of X2Engine

public string $webRoot
#

(read-only) Absolute path to the web root, even if not in a web request

(read-only) Absolute path to the web root, even if not in a web request

public array $webUpdaterActions
#

(read-only) array of actions in the web-based updater utility.

(read-only) array of actions in the web-based updater utility.

Magic properties inherited from ResponseBehavior
$exitNonFatal, $isConsole, $logCategory, $longErrorTrace, $response, $shutdown
Magic properties inherited from CBehavior
$enabled, $owner
X2CRM Documentation API documentation generated by ApiGen 2.8.0