Documentation

CRM_Extension_Upgrader_RevisionsTrait

The revisions trait automatically enqueues any functions named 'upgrade_NNNN()' (where NNNN is taken to be a revision number).

Table of Contents

Properties

$revisions  : array<string|int, mixed>
$revisionStorageIsDeprecated  : bool

Methods

enqueuePendingRevisions()  : mixed
Add any pending revisions to the queue.
getCurrentRevision()  : mixed
getExtensionKey()  : string
getRevisions()  : array<string|int, mixed>
Get a list of revisions.
hasPendingRevisions()  : bool
Determine if there are any pending revisions.
setCurrentRevision()  : mixed
appendTask()  : mixed
deleteDeprecatedRevision()  : mixed
getCurrentRevisionDeprecated()  : mixed

Properties

$revisions

private array<string|int, mixed> $revisions

sorted numerically

$revisionStorageIsDeprecated

private bool $revisionStorageIsDeprecated = \FALSE

Flag to clean up extension revision data in civicrm_setting

Methods

enqueuePendingRevisions()

Add any pending revisions to the queue.

public enqueuePendingRevisions() : mixed

getExtensionKey()

public abstract getExtensionKey() : string
Return values
string

getRevisions()

Get a list of revisions.

public getRevisions() : array<string|int, mixed>
Return values
array<string|int, mixed>

revisionNumbers sorted numerically

hasPendingRevisions()

Determine if there are any pending revisions.

public hasPendingRevisions() : bool
Return values
bool

setCurrentRevision()

public setCurrentRevision(mixed $revision) : mixed
Parameters
$revision : mixed

appendTask()

protected abstract appendTask(string $title, string $funcName, mixed ...$options) : mixed
Parameters
$title : string
$funcName : string
$options : mixed

deleteDeprecatedRevision()

private deleteDeprecatedRevision() : mixed

getCurrentRevisionDeprecated()

private getCurrentRevisionDeprecated() : mixed

        
On this page

Search results