Joomla\CMS\Schema\ChangeSet

Since: 2.5

class ChangeSet

Contains a set of JSchemaChange objects for a particular instance of Joomla.

Each of these objects contains a DDL query that should have been run against the database when this database was created or updated. This enables the Installation Manager to check that the current database schema is up to date.

Properties

protected ChangeItem[] Since: 2.5	$changeItems	Array of ChangeItem objects
protected DatabaseDriver Since: 2.5	$db	DatabaseDriver object
protected string Since: 2.5	$folder	Folder where SQL update files will be found
static protected ChangeSet Since: 3.5.1	$instance	The singleton instance of this object

Methods

__construct(DatabaseDriver $db, string $folder = null)

Constructor: builds array of $changeItems by processing the .sql files in a folder.

static ChangeSet

getInstance(DatabaseDriver $db, string $folder = null)

Returns a reference to the ChangeSet object, only creating it if it doesn't already exist.

array

check()

Checks the database and returns an array of any errors found.

void

fix()

Runs the update query to apply the change to the database

array

getStatus()

Returns an array of results for this set

string

getSchema()

Gets the current database schema, based on the highest version number.

Details

`__construct(DatabaseDriver $db, string $folder = null)`

Since: 2.5

Constructor: builds array of $changeItems by processing the .sql files in a folder.

The folder for the Joomla core updates is administrator/components/com_admin/sql/updates/<database>.

Parameters

DatabaseDriver	$db	The current database object
string	$folder	The full path to the folder containing the update queries

`static ChangeSet getInstance(DatabaseDriver $db, string $folder = null)`

Since: 2.5

Returns a reference to the ChangeSet object, only creating it if it doesn't already exist.

Parameters

DatabaseDriver	$db	The current database object
string	$folder	The full path to the folder containing the update queries

Return Value

ChangeSet

`array check()`

Since: 2.5

Checks the database and returns an array of any errors found.

Note these are not database errors but rather situations where the current schema is not up to date.

Return Value

array

Array of errors if any.

`void fix()`

Since: 2.5

Runs the update query to apply the change to the database

Return Value

void

`array getStatus()`

Since: 2.5

Returns an array of results for this set

Return Value

array

associative array of changeitems grouped by unchecked, ok, error, and skipped

`string getSchema()`

Since: 2.5

Gets the current database schema, based on the highest version number.

Note that the .sql files are named based on the version and date, so the file name of the last file should match the database schema version in the #__schemas table.

Return Value

string

the schema version for the database