Migration Class Reference

Inheritance diagram for Migration:

Collaboration diagram for Migration:

Public Member Functions
	Migration ($verbose=FALSE)
	description ()
	up ()
	down ()
	migrate ($direction)
	write ($text="")
	announce ($format)

Data Fields
	$verbose

Member Function Documentation

announce

(

$format

)

Print the given formatted string (if verbose output is enabled). Output always includes the migration's class name.

Parameters

string

$format,...

printf-style format string and parameters

Here is the call graph for this function:

Here is the caller graph for this function:

description

(

)

Abstract method describing this migration step. This method should be implemented in a migration subclass.

Returns

string migration description

down

(

)

Abstract method reverting this migration step. This method should be implemented in a migration subclass.

protected

migrate

(

$direction

)

Perform or revert this migration, depending on the indicated direction.

protected

Parameters

string

$direction

migration direction (either 'up' or 'down')

Here is the call graph for this function:

Migration

(

$verbose = FALSE

)

Initalize a Migration object (optionally using verbose output).

Parameters

boolean

$verbose

verbose output (default FALSE)

Here is the caller graph for this function:

up

(

)

Abstract method performing this migration step. This method should be implemented in a migration subclass.

protected

write

(

$text = ""

)

Print the given string (if verbose output is enabled).

private

Parameters

string

$text

text to print

Here is the caller graph for this function:

Field Documentation

$verbose

---

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

• lib/migrations/migration.php