CRM_Upgrade_Incremental_php_FourSix

class CRM_Upgrade_Incremental_php_FourSix extends CRM_Upgrade_Incremental_Base

Upgrade logic for 4.6

Constants

BATCH_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 before upgrade.

from CRM_Upgrade_Incremental_Base
setPostUpgradeMessage(string $postUpgradeMessage, string $rev)

Compute any messages which should be displayed after upgrade.

static bool
runSql(CRM_Queue_TaskContext $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(CRM_Queue_TaskContext $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, bool $localizable = FALSE, string|null $version = NULL)

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

from CRM_Upgrade_Incremental_Base
static 
updateMessageTemplates(CRM_Queue_TaskContext $ctx, string $version)

Do any relevant message template updates.

from CRM_Upgrade_Incremental_Base
static bool
updateContributeSettings($ctx)

Re-save any valid values from contribute settings into the normal setting format.

from CRM_Upgrade_Incremental_Base
bool
updateSmartGroups(CRM_Queue_TaskContext $ctx, array $actions)

Do any relevant smart group updates.

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
static bool
dropTableIfEmpty(CRM_Queue_TaskContext $ctx, string $table)

Drop a table.

from CRM_Upgrade_Incremental_Base
static bool
rebuildMultilingalSchema(CRM_Queue_TaskContext $ctx, string|null $version = NULL)

Rebuild Multilingual Schema.

from CRM_Upgrade_Incremental_Base
upgrade_4_6_alpha3(string $rev)

CRM-16846 - This function incorrectly omits running the 4.6.alpha3 sql file.

static bool
updateReferenceDate(CRM_Queue_TaskContext $ctx)

Add new column reference_date to civicrm_action_log in order to track.

upgrade_4_6_1(string $rev)

Upgrade function.

upgrade_4_6_6(string $rev)

Upgrade function.

static bool
fixCaseLog(CRM_Queue_TaskContext $ctx)

Remove special characters from case_type_id column in log_civicrm_case.

static bool
task_4_6_x_runOnlySql(CRM_Queue_TaskContext $ctx, string $rev)

Queue Task Callback for CRM-16846

Details

in CRM_Upgrade_Incremental_Base at line 41
bool verifyPreDBstate($errors)

Verify DB state.

Parameters

$errors

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 56
setPreUpgradeMessage($preUpgradeMessage, string $rev, null $currentVer = NULL)

Compute any messages which should be displayed before upgrade.

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 41
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(CRM_Queue_TaskContext $ctx, string $rev)

(Queue Task Callback)

Parameters

CRM_Queue_TaskContext $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(CRM_Queue_TaskContext $ctx, string $name)

Remove a payment processor if not in use

Parameters

CRM_Queue_TaskContext $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 156
static bool addColumn(CRM_Queue_TaskContext $ctx, string $table, string $column, string $properties, bool $localizable = FALSE, string|null $version = NULL)

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

Parameters

CRM_Queue_TaskContext $ctx
string $table
string $column
string $properties
bool $localizable is this a field that should be localized
string|null $version CiviCRM version to use if rebuilding multilingual schema

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 194
static updateMessageTemplates(CRM_Queue_TaskContext $ctx, string $version)

Do any relevant message template updates.

Parameters

CRM_Queue_TaskContext $ctx
string $version

in CRM_Upgrade_Incremental_Base at line 213
static bool updateContributeSettings($ctx)

Re-save any valid values from contribute settings into the normal setting format.

We render the array of contribution_invoice_settings and any that have metadata defined we add to the correct key. This is safe to run even if no settings are to be converted, per the test in testConvertUpgradeContributeSettings.

Parameters

$ctx

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 231
bool updateSmartGroups(CRM_Queue_TaskContext $ctx, array $actions)

Do any relevant smart group updates.

Parameters

CRM_Queue_TaskContext $ctx
array $actions

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 245
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 261
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 276
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

in CRM_Upgrade_Incremental_Base at line 289
static bool dropTableIfEmpty(CRM_Queue_TaskContext $ctx, string $table)

Drop a table.

.. but only if it's empty.

Parameters

CRM_Queue_TaskContext $ctx
string $table

Return Value

bool

in CRM_Upgrade_Incremental_Base at line 309
static bool rebuildMultilingalSchema(CRM_Queue_TaskContext $ctx, string|null $version = NULL)

Rebuild Multilingual Schema.

Parameters

CRM_Queue_TaskContext $ctx
string|null $version CiviCRM version to use if rebuilding multilingual schema

Return Value

bool

at line 59
upgrade_4_6_alpha3(string $rev)

CRM-16846 - This function incorrectly omits running the 4.6.alpha3 sql file.

Instead of correcting it here (which would not run again for sites already on 4.6), the file is re-run conditionally during 4.6.6

Parameters

string $rev

See also

upgrade_4_6_6

at line 73
static bool updateReferenceDate(CRM_Queue_TaskContext $ctx)

Add new column reference_date to civicrm_action_log in order to track.

CRM-15728, actual action_start_date for membership entity for only those schedule reminders which are not repeatable

Parameters

CRM_Queue_TaskContext $ctx

Return Value

bool

at line 131
upgrade_4_6_1(string $rev)

Upgrade function.

Parameters

string $rev

at line 141
upgrade_4_6_6(string $rev)

Upgrade function.

Parameters

string $rev

at line 162
static bool fixCaseLog(CRM_Queue_TaskContext $ctx)

Remove special characters from case_type_id column in log_civicrm_case.

CRM-16289 - If logging enabled and upgrading from 4.4 or earlier, log_civicrm_case.case_type_id will contain special characters. This will cause ALTER TABLE to fail when changing this column to an INT

Parameters

CRM_Queue_TaskContext $ctx

Return Value

bool

at line 190
static bool task_4_6_x_runOnlySql(CRM_Queue_TaskContext $ctx, string $rev)

Queue Task Callback for CRM-16846

Run a sql file without resetting locale to that version

Parameters

CRM_Queue_TaskContext $ctx
string $rev

Return Value

bool