Class JSchemaChangeset

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.

Package: Joomla\Libraries\Schema
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 2.5
Located at cms/schema/changeset.php

Methods summary

`public`	# `__construct( JDatabaseDriver $db, string $folder = null )` 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>`. 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 `$db` `JDatabaseDriver` - $db The current database object `$folder` `string` - $folder The full path to the folder containing the update queries Since 2.5
`public static JSchemaChangeset`	# `getInstance( JDatabaseDriver $db, string $folder = null )` Returns a reference to the JSchemaChangeset object, only creating it if it doesn't already exist. Returns a reference to the JSchemaChangeset object, only creating it if it doesn't already exist. Parameters `$db` `JDatabaseDriver` - $db The current database object `$folder` `string` - $folder The full path to the folder containing the update queries Returns `JSchemaChangeset` Since 2.5
`public array`	# `check( )` 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. 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. Returns `array` - Array of errors if any. Since 2.5
`public`	# `fix( )` Runs the update query to apply the change to the database Runs the update query to apply the change to the database Since 2.5
`public array`	# `getStatus( )` Returns an array of results for this set Returns an array of results for this set Returns `array` - associative array of changeitems grouped by unchecked, ok, error, and skipped Since 2.5
`public string`	# `getSchema( )` 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. 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. Returns `string` - the schema version for the database Since 2.5

Magic methods summary

Properties summary

`protected JSchemaChangeitem[]`	`$changeItems`	# Array of JSchemaChangeitem objects Array of JSchemaChangeitem objects Since 2.5
`protected JDatabaseDriver`	`$db`	# JDatabaseDriver object JDatabaseDriver object Since 2.5
`protected string`	`$folder`	# Folder where SQL update files will be found Folder where SQL update files will be found Since 2.5
`protected static JSchemaChangeset`	`$instance`	# The singleton instance of this object The singleton instance of this object Since 3.5.1

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JSchemaChangeset

Methods summary

Parameters

Since

Parameters

Returns

Since

Returns

Since

Since

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since

Since

Since

Since