Samy\DataVersion\MySql Class Reference

Inheritance diagram for Samy\DataVersion\MySql:

Public Member Functions
	__construct (string $Host, string $Username, string $Password, string $Database, int $Port=3306)
	__destruct ()
	versions ()
	version ()
Public Member Functions inherited from Samy\DataVersion\AbstractDataVersion
	isConnected ()
	getErrorQuery ()
	getErrorMessage ()
	includeDirectory (string $Directory)
	migrate ()
	rollback (int $VersionId)
	seed (array $Seeds)
	isConnected ()
	getErrorQuery ()
	getErrorMessage ()
	includeDirectory (string $Directory)
	versions ()
	version ()
	migrate ()
	rollback (int $VersionId)
	seed (array $Seeds)

Protected Member Functions
	escape (string $UnescapedString)
	execute (string $Command)
	statement (array $Commands)
	query (string $Command)
	initSchema ()
	getExistsVersion ()
	getRollbackVersion (int $Id)
	addVersion (string $Name, string $Description="")
	removeVersion (string $Name)
	resetVersion ()
Protected Member Functions inherited from Samy\DataVersion\AbstractDataVersion
	escape (string $UnescapedString)
	execute (string $Command)
	statement (array $Commands)
	query (string $Command)
	initSchema ()
	getExistsVersion ()
	getRollbackVersion (int $Id)
	addVersion (string $Name, string $Description="")
	removeVersion (string $Name)
	resetVersion ()
	getAllClasses (string $ClassName)
	getAvailableMigration ()
	getAvailableSeed ()
	withError (string $Message, string $Query="")
	withoutError ()

Additional Inherited Members
Protected Attributes inherited from Samy\DataVersion\AbstractDataVersion
	$driver = null
	$is_connected = false
	$error_message = ""
	$error_query = ""
	$platform = ""
	$credential = array()

Detailed Description

Simple MySQL implementation.

Constructor & Destructor Documentation

__construct()

Samy\DataVersion\MySql::__construct	(	string	$Host,
		string	$Username,
		string	$Password,
		string	$Database,
		int	$Port = 3306
	)

MySql construction.

Parameters

[in]	string	$Host	MySQL Host
[in]	string	$Username	MySQL Username
[in]	string	$Password	MySQL Password
[in]	string	$Database	MySQL Database
[in]	int	$Port	MySQL Port

Returns

void

__destruct()

Samy\DataVersion\MySql::__destruct

(

)

MySql destruction.

Returns

void

Member Function Documentation

addVersion()

Samy\DataVersion\MySql::addVersion ( string  $Name, string  $Description = ""  )

protected

Return an instance with added version.

Parameters

[in]	string	$Name	The version name
[in]	string	$Description	The version description

Returns

static

Reimplemented from Samy\DataVersion\AbstractDataVersion.

escape()

Samy\DataVersion\MySql::escape ( string  $UnescapedString )

protected

Escapes special characters in a string for use in an SQL statement.

Parameters

[in]

string

$UnescapedString

The string that is to be escaped

Returns

string

Reimplemented from Samy\DataVersion\AbstractDataVersion.

execute()

Samy\DataVersion\MySql::execute ( string  $Command )

protected

Return an instance with executed query command.

Parameters

[in]

string

$Command

The query command

Returns

bool

Reimplemented from Samy\DataVersion\AbstractDataVersion.

getExistsVersion()

Samy\DataVersion\MySql::getExistsVersion ( )

protected

Retrieve exists version name.

Returns

array<string>

Reimplemented from Samy\DataVersion\AbstractDataVersion.

getRollbackVersion()

Samy\DataVersion\MySql::getRollbackVersion ( int  $Id )

protected

Retrieve rollback version name.

Parameters

[in]

int

$Id

The version id

Returns

array<string>

Reimplemented from Samy\DataVersion\AbstractDataVersion.

initSchema()

Samy\DataVersion\MySql::initSchema ( )

protected

Return an instance with initialized schema.

Returns

static

Reimplemented from Samy\DataVersion\AbstractDataVersion.

query()

Samy\DataVersion\MySql::query ( string  $Command )

protected

Retrieve records from query command.

Parameters

[in]

string

$Command

The query command

Returns

array<array<string, mixed>>

Reimplemented from Samy\DataVersion\AbstractDataVersion.

removeVersion()

Samy\DataVersion\MySql::removeVersion ( string  $Name )

protected

Return an instance with removed version.

Parameters

[in]

string

$Name

The version name

Returns

static

Reimplemented from Samy\DataVersion\AbstractDataVersion.

resetVersion()

Samy\DataVersion\MySql::resetVersion ( )

protected

Return an instance with reset version.

Returns

static

Reimplemented from Samy\DataVersion\AbstractDataVersion.

statement()

Samy\DataVersion\MySql::statement ( array  $Commands )

protected

Return an instance with executed query commands.

Parameters

[in]

array

$Commands

The query commands

Returns

bool

Reimplemented from Samy\DataVersion\AbstractDataVersion.

version()

Samy\DataVersion\MySql::version

(

)

Retrieve the current versions of migration.

Returns

array<string, mixed>

Implements Samy\DataVersion\DataVersionInterface.

versions()

Samy\DataVersion\MySql::versions

(

)

Retrieve all versions of migration.

Returns

array<array<string, mixed>>

Implements Samy\DataVersion\DataVersionInterface.

---

The documentation for this class was generated from the following file:

• dataversion/MySql.php