Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe ChangeSet

Fonctions membres publiques

 __construct ($db, $folder=null)
 
 check ()
 
 fix ()
 
 getStatus ()
 
 getSchema ()
 

Fonctions membres publiques statiques

static getInstance ($db, $folder=null)
 

Attributs protégés

 $changeItems = array()
 
 $db = null
 
 $folder = null
 

Attributs protégés statiques

static $instance
 

Fonctions membres privées

 getUpdateFiles ()
 
 getUpdateQueries (array $sqlfiles)
 

Description détaillée

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.

Depuis
2.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $db,
  $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>.

Paramètres
\JDatabaseDriver$dbThe current database object
string$folderThe full path to the folder containing the update queries
Depuis
2.5

Références $db, $folder, et ChangeItem\getInstance().

Documentation des fonctions membres

◆ check()

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.

Renvoie
array Array of errors if any.
Depuis
2.5

Références $item.

◆ fix()

fix ( )

Runs the update query to apply the change to the database

Renvoie
void
Depuis
2.5

Références $item.

◆ getInstance()

static getInstance (   $db,
  $folder = null 
)
static

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

Paramètres
\JDatabaseDriver$dbThe current database object
string$folderThe full path to the folder containing the update queries
Renvoie
ChangeSet
Depuis
2.5

Références $db, et $folder.

◆ getSchema()

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.

Renvoie
string the schema version for the database
Depuis
2.5

◆ getStatus()

getStatus ( )

Returns an array of results for this set

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

Références $item.

◆ getUpdateFiles()

getUpdateFiles ( )
private

Get list of SQL update files for this database

Renvoie
array list of sql update full-path names
Depuis
2.5

Références JPATH_ADMINISTRATOR.

◆ getUpdateQueries()

getUpdateQueries ( array  $sqlfiles)
private

Get array of SQL queries

Paramètres
array$sqlfilesArray of .sql update filenames.
Renvoie
array Array of objects where: file=filename, update_query = text of SQL update query
Depuis
2.5

Références $buffer, $file, $query, et JDatabaseDriver\splitSql().

Documentation des champs

◆ $changeItems

$changeItems = array()
protected

◆ $db

$db = null
protected

◆ $folder

$folder = null
protected

◆ $instance

$instance
staticprotected

La documentation de cette classe a été générée à partir du fichier suivant :