CRM_Upgrade_Incremental_php_FourFour

class CRM_Upgrade_Incremental_php_FourFour extends CRM_Upgrade_Incremental_Base

Upgrade logic for 4.4

Constants

BATCH_SIZE

MAX_WORD_REPLACEMENT_SIZE

Methods

bool
verifyPreDBstate($errors)

Verify DB state.

from CRM_Upgrade_Incremental_Base
setPreUpgradeMessage($preUpgradeMessage, string $rev, null $currentVer = NULL)

Compute any messages which should be displayed beforeupgrade.

setPostUpgradeMessage(string $postUpgradeMessage, string $rev)

Compute any messages which should be displayed after upgrade.

static bool
runSql( $ctx, string $rev)

(Queue Task Callback)

from CRM_Upgrade_Incremental_Base
addTask(string $title, string $funcName)

Syntactic sugar for adding a task.

from CRM_Upgrade_Incremental_Base
static bool
removePaymentProcessorType( $ctx, string $name)

Remove a payment processor if not in use

from CRM_Upgrade_Incremental_Base
static bool
checkFKExists(string $table_name, string $constraint_name)

No description

from CRM_Upgrade_Incremental_Base
static bool
addColumn(CRM_Queue_TaskContext $ctx, string $table, string $column, string $properties)

Add a column to a table if it doesn't already exist

from CRM_Upgrade_Incremental_Base
static bool
dropColumn(CRM_Queue_TaskContext $ctx, string $table, string $column)

Drop a column from a table if it exist.

from CRM_Upgrade_Incremental_Base
static bool
addIndex(CRM_Queue_TaskContext $ctx, string $table, string|array $column)

Add a index to a table column.

from CRM_Upgrade_Incremental_Base
static bool
dropIndex(CRM_Queue_TaskContext $ctx, string $table, string $indexName)

Drop a index from a table if it exist.

from CRM_Upgrade_Incremental_Base
bool
upgrade_4_4_alpha1(string $rev)

Upgrade 4.4.alpha1.

upgrade_4_4_beta1($rev)

No description

upgrade_4_4_1($rev)

No description

bool
upgrade_4_4_4($rev)

No description

upgrade_4_4_6($rev)

No description

upgrade_4_4_7(string $rev, string $originalVer, string $latestVer)

Upgrade script for 4.4.7.

static bool
upgradeImageUrls( $ctx, $startId, $endId)

Upgrade image URLs.

static bool
changeSavedSearch( $ctx)

Change saved search.

static bool
cleanupBackendImageUrls( $ctx, int $startId, int $endId)

For WordPress/Joomla(?) sites which upgraded to 4.4.6, find back-end image_URLs (e.g. "http://example.com/wp-admin/admin.php?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg") and convert them to front-end URLs (e.g. "http://example.com/?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg").

static CRM_Core_DAO
findContactImageUrls(int $startId, int $endId)

No description

static 
setContactImageUrl(int $cid, string $newImageUrl)

No description

static bool
activityContacts( $ctx)

Update activity contacts CRM-12274

static bool
wordReplacements( $ctx)

Migrate word-replacements from $config to civicrm_word_replacement

static bool
wordReplacements_patch( $ctx, $rev)

Fix misconfigured constraints created in 4.4.0. To distinguish the good and bad configurations, we change the constraint name from "UI_find" (the original name in 4.4.0) to "UI_domain_find" (the new name in 4.4.1).

static array
getConfigArraysAsAPIParams(bool $rebuildEach)

Get all the word-replacements stored in config-arrays and convert them to params for the WordReplacement.create API.

static 
rebuildWordReplacementTable()

Get all the word-replacements stored in config-arrays and write them out as records in civicrm_word_replacement.

updateReportInstanceTable()

CRM-13998 missing alter statements for civicrm_report_instance

static bool
isValidWordReplacement(array $params)

No description

Details

in CRM_Upgrade_Incremental_Base at line 41
bool verifyPreDBstate($errors)

Verify DB state.

Parameters

$errors

Return Value

bool

at line 45
setPreUpgradeMessage($preUpgradeMessage, string $rev, null $currentVer = NULL)

Compute any messages which should be displayed beforeupgrade.

Note: This function is called iteratively for each upcoming revision to the database.

Parameters

$preUpgradeMessage
string $rev a version number, e.g. '4.8.alpha1', '4.8.beta3', '4.8.0'.
null $currentVer

at line 70
setPostUpgradeMessage(string $postUpgradeMessage, string $rev)

Compute any messages which should be displayed after upgrade.

Parameters

string $postUpgradeMessage alterable.
string $rev an intermediate version; note that setPostUpgradeMessage is called repeatedly with different $revs.

in CRM_Upgrade_Incremental_Base at line 78
static bool runSql( $ctx, string $rev)

(Queue Task Callback)

Parameters

$ctx
string $rev

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 96
protected addTask(string $title, string $funcName)

Syntactic sugar for adding a task.

Task is (a) in this class and (b) has a high priority.

After passing the $funcName, you can also pass parameters that will go to the function. Note that all params must be serializable.

Parameters

string $title
string $funcName

in CRM_Upgrade_Incremental_Base at line 121
static bool removePaymentProcessorType( $ctx, string $name)

Remove a payment processor if not in use

Parameters

$ctx
string $name

Return Value

bool

Exceptions

CiviCRM_API3_Exception

in CRM_Upgrade_Incremental_Base at line 140
static bool checkFKExists(string $table_name, string $constraint_name)

Parameters

string $table_name
string $constraint_name

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 153
static bool addColumn(CRM_Queue_TaskContext $ctx, string $table, string $column, string $properties)

Add a column to a table if it doesn't already exist

Parameters

CRM_Queue_TaskContext $ctx
string $table
string $column
string $properties

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 175
static bool dropColumn(CRM_Queue_TaskContext $ctx, string $table, string $column)

Drop a column from a table if it exist.

Parameters

CRM_Queue_TaskContext $ctx
string $table
string $column

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 191
static bool addIndex(CRM_Queue_TaskContext $ctx, string $table, string|array $column)

Add a index to a table column.

Parameters

CRM_Queue_TaskContext $ctx
string $table
string|array $column

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 206
static bool dropIndex(CRM_Queue_TaskContext $ctx, string $table, string $indexName)

Drop a index from a table if it exist.

Parameters

CRM_Queue_TaskContext $ctx
string $table
string $indexName

Return Value

bool

at line 106
bool upgrade_4_4_alpha1(string $rev)

Upgrade 4.4.alpha1.

Parameters

string $rev

Return Value

bool

at line 119
upgrade_4_4_beta1($rev)

Parameters

$rev

at line 148
upgrade_4_4_1($rev)

Parameters

$rev

at line 259
bool upgrade_4_4_4($rev)

Parameters

$rev

Return Value

bool

at line 335
upgrade_4_4_6($rev)

Parameters

$rev

at line 360
upgrade_4_4_7(string $rev, string $originalVer, string $latestVer)

Upgrade script for 4.4.7.

Parameters

string $rev
string $originalVer
string $latestVer

at line 385
static bool upgradeImageUrls( $ctx, $startId, $endId)

Upgrade image URLs.

Parameters

$ctx
$startId
$endId

Return Value

bool

at line 425
static bool changeSavedSearch( $ctx)

Change saved search.

Parameters

$ctx

Return Value

bool

at line 484
static bool cleanupBackendImageUrls( $ctx, int $startId, int $endId)

For WordPress/Joomla(?) sites which upgraded to 4.4.6, find back-end image_URLs (e.g. "http://example.com/wp-admin/admin.php?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg") and convert them to front-end URLs (e.g. "http://example.com/?page=CiviCRM&q=civicrm/contact/imagefile&photo=123.jpg").

Parameters

$ctx
int $startId
int $endId

Return Value

bool

at line 505
static CRM_Core_DAO findContactImageUrls(int $startId, int $endId)

Parameters

int $startId
int $endId

Return Value

CRM_Core_DAO columns include "id" and "image_URL"

at line 526
static setContactImageUrl(int $cid, string $newImageUrl)

Parameters

int $cid
string $newImageUrl

at line 543
static bool activityContacts( $ctx)

Update activity contacts CRM-12274

Parameters

$ctx

Return Value

bool TRUE for success

at line 653
static bool wordReplacements( $ctx)

Migrate word-replacements from $config to civicrm_word_replacement

Parameters

$ctx

Return Value

bool TRUE for success

See also

http://issues.civicrm.org/jira/browse/CRM-13187

at line 686
static bool wordReplacements_patch( $ctx, $rev)

Fix misconfigured constraints created in 4.4.0. To distinguish the good and bad configurations, we change the constraint name from "UI_find" (the original name in 4.4.0) to "UI_domain_find" (the new name in 4.4.1).

Parameters

$ctx
$rev

Return Value

bool TRUE for success

See also

http://issues.civicrm.org/jira/browse/CRM-13655

at line 715
static array getConfigArraysAsAPIParams(bool $rebuildEach)

Get all the word-replacements stored in config-arrays and convert them to params for the WordReplacement.create API.

Note: This function is duplicated in CRM_Core_BAO_WordReplacement and CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade step behaves consistently even as the BAO evolves in future versions. However, if there's a bug in here prior to 4.4.0, we should apply the bugfix in both places.

Parameters

bool $rebuildEach Whether to perform rebuild after each individual API call.

Return Value

array Each item is $params for WordReplacement.create

See also

CRM_Core_BAO_WordReplacement::convertConfigArraysToAPIParams

at line 765
static rebuildWordReplacementTable()

Get all the word-replacements stored in config-arrays and write them out as records in civicrm_word_replacement.

Note: This function is duplicated in CRM_Core_BAO_WordReplacement and CRM_Upgrade_Incremental_php_FourFour to ensure that the incremental upgrade step behaves consistently even as the BAO evolves in future versions. However, if there's a bug in here prior to 4.4.0, we should apply the bugfix in both places.

at line 777
updateReportInstanceTable()

CRM-13998 missing alter statements for civicrm_report_instance

at line 811
static bool isValidWordReplacement(array $params)

Parameters

array $params

Return Value

bool TRUE if $params is valid