Samy\DataVersion\AbstractDataVersion Class Reference

Inheritance diagram for Samy\DataVersion\AbstractDataVersion:

Public Member Functions
	isConnected ()
	getErrorQuery ()
	getErrorMessage ()
	includeDirectory (string $Directory)
	migrate ()
	rollback (int $VersionId)
	seed (array $Seeds)
Public Member Functions inherited from Samy\DataVersion\DataVersionInterface
	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 ()
	getAllClasses (string $ClassName)
	getAvailableMigration ()
	getAvailableSeed ()
	withError (string $Message, string $Query="")
	withoutError ()

Protected Attributes
	$driver = null
	$is_connected = false
	$error_message = ""
	$error_query = ""
	$platform = ""
	$credential = array()

Detailed Description

This is a simple DataVersion implementation that other DataVersion can inherit from.

Member Function Documentation

addVersion()

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

abstractprotected

Return an instance with added version.

Parameters

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

Returns

static

Reimplemented in Samy\DataVersion\MySql.

escape()

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

abstractprotected

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 in Samy\DataVersion\MySql.

execute()

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

abstractprotected

Return an instance with executed query command.

Parameters

[in]

string

$Command

The query command

Returns

bool

Reimplemented in Samy\DataVersion\MySql.

getAllClasses()

Samy\DataVersion\AbstractDataVersion::getAllClasses ( string  $ClassName )

protected

Return an instance with included directory.

Parameters

[in]

string

$ClassName

The class name

Returns

array<string>

getAvailableMigration()

Samy\DataVersion\AbstractDataVersion::getAvailableMigration ( )

protected

Retrieve available migration.

Returns

array<string, string>

getAvailableSeed()

Samy\DataVersion\AbstractDataVersion::getAvailableSeed ( )

protected

Retrieve available seed.

Returns

array<string, string>

getErrorMessage()

Samy\DataVersion\AbstractDataVersion::getErrorMessage

(

)

Retrieve error message.

Returns

string

Implements Samy\DataVersion\DataVersionInterface.

getErrorQuery()

Samy\DataVersion\AbstractDataVersion::getErrorQuery

(

)

Retrieve error query.

Returns

string

Implements Samy\DataVersion\DataVersionInterface.

getExistsVersion()

Samy\DataVersion\AbstractDataVersion::getExistsVersion ( )

abstractprotected

Retrieve exists version name.

Returns

array<string>

Reimplemented in Samy\DataVersion\MySql.

getRollbackVersion()

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

abstractprotected

Retrieve rollback version name.

Parameters

[in]

int

$Id

The version id

Returns

array<string>

Reimplemented in Samy\DataVersion\MySql.

includeDirectory()

Samy\DataVersion\AbstractDataVersion::includeDirectory

(

string

$Directory

)

Return an instance with included directory.

Parameters

[in]

string

$Directory

The directory

Returns

static

Implements Samy\DataVersion\DataVersionInterface.

initSchema()

Samy\DataVersion\AbstractDataVersion::initSchema ( )

abstractprotected

Return an instance with initialized schema.

Returns

static

Reimplemented in Samy\DataVersion\MySql.

isConnected()

Samy\DataVersion\AbstractDataVersion::isConnected

(

)

Check if driver is connected to database.

Returns

bool

Implements Samy\DataVersion\DataVersionInterface.

migrate()

Samy\DataVersion\AbstractDataVersion::migrate

(

)

Return the new migration version.

Returns

array<array<string,mixed>>

Implements Samy\DataVersion\DataVersionInterface.

query()

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

abstractprotected

Retrieve records from query command.

Parameters

[in]

string

$Command

The query command

Returns

array<array<string, mixed>>

Reimplemented in Samy\DataVersion\MySql.

removeVersion()

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

abstractprotected

Return an instance with removed version.

Parameters

[in]

string

$Name

The version name

Returns

static

Reimplemented in Samy\DataVersion\MySql.

resetVersion()

Samy\DataVersion\AbstractDataVersion::resetVersion ( )

abstractprotected

Return an instance with reset version.

Returns

static

Reimplemented in Samy\DataVersion\MySql.

rollback()

Samy\DataVersion\AbstractDataVersion::rollback

(

int

$VersionId

)

Return the rollback versions.

Parameters

[in]

int

$VersionId

The version id

Returns

array<array<string,mixed>>

Implements Samy\DataVersion\DataVersionInterface.

seed()

Samy\DataVersion\AbstractDataVersion::seed

(

array

$Seeds

)

Return an instance with executed the specified seed name.

Parameters

[in]

array

$Seeds

Seed names

Returns

array<array<string,mixed>>

Implements Samy\DataVersion\DataVersionInterface.

statement()

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

abstractprotected

Return an instance with executed query commands.

Parameters

[in]

array

$Commands

The query commands

Returns

bool

Reimplemented in Samy\DataVersion\MySql.

withError()

Samy\DataVersion\AbstractDataVersion::withError ( string  $Message, string  $Query = ""  )

protected

Return an instance with provided error.

Parameters

[in]	string	$Message	The error message
[in]	string	$Query	The error query

Returns

static

withoutError()

Samy\DataVersion\AbstractDataVersion::withoutError ( )

protected

Return an instance without error.

Returns

static

Member Data Documentation

$credential

Samy\DataVersion\AbstractDataVersion::$credential = array()

protected

describe credential

$driver

Samy\DataVersion\AbstractDataVersion::$driver = null

protected

describe driver

$error_message

Samy\DataVersion\AbstractDataVersion::$error_message = ""

protected

describe error message

$error_query

Samy\DataVersion\AbstractDataVersion::$error_query = ""

protected

describe error query

$is_connected

Samy\DataVersion\AbstractDataVersion::$is_connected = false

protected

describe driver is connected

$platform

Samy\DataVersion\AbstractDataVersion::$platform = ""

protected

describe platform

---

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

• dataversion/AbstractDataVersion.php