CRM_Upgrade_Incremental_php_FourFive

class CRM_Upgrade_Incremental_php_FourFive extends CRM_Upgrade_Incremental_Base

Upgrade logic for 4.5

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( $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_5_alpha1($rev)

No description

bool
upgrade_4_5_beta9($rev)

No description

static bool
task_4_5_0_fixLineItem( $ctx, int $startId, int $endId, $entityTable)

(Queue Task Callback)

static bool
addNameFieldOptions( $ctx)

Add defaults for the newly introduced name fields configuration in 'contact_edit_options' setting

static bool
migrateHonoreeInfo( $ctx)

Migrate honoree information to uf_join.module_data as honoree columns (text and title) will be dropped on DB upgrade

bool
upgrade_4_5_9(string $rev)

Upgrade function.

static bool
updateSavedSearch( $ctx)

Update saved search for multi-select custom fields on DB upgrade

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( $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 60
bool upgrade_4_5_alpha1($rev)

Parameters

$rev

Return Value

bool

at line 99
bool upgrade_4_5_beta9($rev)

Parameters

$rev

Return Value

bool

at line 138
static bool task_4_5_0_fixLineItem( $ctx, int $startId, int $endId, $entityTable)

(Queue Task Callback)

update the line items

Parameters

$ctx
int $startId the first/lowest entity ID to convert.
int $endId the last/highest entity ID to convert.
$entityTable

Return Value

bool

at line 207
static bool addNameFieldOptions( $ctx)

Add defaults for the newly introduced name fields configuration in 'contact_edit_options' setting

Parameters

$ctx

Return Value

bool TRUE for success

at line 231
static bool migrateHonoreeInfo( $ctx)

Migrate honoree information to uf_join.module_data as honoree columns (text and title) will be dropped on DB upgrade

Parameters

$ctx

Return Value

bool TRUE for success

at line 291
bool upgrade_4_5_9(string $rev)

Upgrade function.

Parameters

string $rev

Return Value

bool

at line 305
static bool updateSavedSearch( $ctx)

Update saved search for multi-select custom fields on DB upgrade

Parameters

$ctx

Return Value

bool TRUE for success