1. class
  2. Joomla
  3. CMS
  4. Schema
  5. ChangeItem
  6. MysqlChangeItem

MysqlChangeItem

class MysqlChangeItem extends ChangeItem

Checks the database schema against one MySQL DDL query to see if it has been run.

Properties

string $file Update file: full path file name where query was found from ChangeItem
string $updateQuery Update query: query used to change the db schema (one line from the file) from ChangeItem
string $checkQuery Check query: query used to check the db schema from ChangeItem
string $checkQueryExpected Check query result: expected result of check query if database is up to date from ChangeItem
JDatabaseDriver $db \JDatabaseDriver object from ChangeItem
string $queryType Query type: To be used in building a language key for a message to tell user what was checked / changed Possible values: ADDTABLE, ADDCOLUMN, CHANGECOLUMNTYPE, ADD_INDEX from ChangeItem
array $msgElements Array with values for use in a \JText::sprintf statment indicating what was checked from ChangeItem
integer $checkStatus Checked status from ChangeItem
int $rerunStatus Rerun status from ChangeItem

Methods

__construct( JDatabaseDriver $db, string $file, string $query)

Constructor: builds check query and message from $updateQuery

from ChangeItem
static  ChangeItem
getInstance( JDatabaseDriver $db, string $file, string $query)

Returns a reference to the ChangeItem object.

from ChangeItem
boolean
check()

Runs the check query and checks that 1 row is returned If yes, return true, otherwise return false

from ChangeItem
void
fix()

Runs the update query to apply the change to the database

from ChangeItem

Details

__construct( JDatabaseDriver $db, string $file, string $query)

Constructor: builds check query and message from $updateQuery

Parameters

JDatabaseDriver $db Database connector object
string $file Full path name of the sql file
string $query Text of the sql query (one line of the file)

static ChangeItem getInstance( JDatabaseDriver $db, string $file, string $query)

Returns a reference to the ChangeItem object.

Parameters

JDatabaseDriver $db Database connector object
string $file Full path name of the sql file
string $query Text of the sql query (one line of the file)

Return Value

ChangeItem instance based on the database driver

Exceptions

RuntimeException if class for database driver not found

boolean check()

Runs the check query and checks that 1 row is returned If yes, return true, otherwise return false

Return Value

boolean true on success, false otherwise

void fix()

Runs the update query to apply the change to the database

Return Value

void