MigrationsService

Type
Class
Namespace
Craft
Inherits
Craft\MigrationsService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class MigrationsService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.
$defaultActionstring

$defaultAction

Signature

public string $defaultAction = 'up'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getBaseMigration()Returns the base migration name.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getMigrationHistory()
getMigrationPath()
getNewMigrations()Gets migrations that have no been applied yet AND have a later timestamp than the current Craft release.
getTemplate()
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
hasRun()Returns whether a given migration has been run.
init()Initializes the application component.
instantiateMigration()
isInitialized()Checks if this application component has been initialized yet, or not.
migrateUp()
raiseEvent()Raises an event.
runToTop()

getBaseMigration()

Returns the base migration name.

View source

Returns

string

Signature

public string getBaseMigration ( )

getMigrationHistory()

View source

Arguments

Returns

mixed

Signature

public mixed getMigrationHistory ( $plugin = null, $limit = null )

getMigrationPath()

View source

Arguments

Returns

string

Throws

Signature

public string getMigrationPath ( $plugin = null )

getNewMigrations()

Gets migrations that have no been applied yet AND have a later timestamp than the current Craft release.

View source

Arguments

  • $plugin

Returns

array

Signature

public array getNewMigrations ( $plugin = null )

getTemplate()

Signature

public string getTemplate ( )

hasRun()

Returns whether a given migration has been run.

View source

Arguments

Returns

boolean

Signature

public boolean hasRun ( $version, $plugin = null )

init()

Initializes the application component.

View source

Returns

boolean, null

Throws

Signature

public boolean, null init ( )

instantiateMigration()

View source

Arguments

  • $class
  • $plugin (null)

Returns

mixed

Throws

Signature

public mixed instantiateMigration ( $class, $plugin = null )

migrateUp()

View source

Arguments

  • $class
  • $plugin (null)

Returns

boolean, null

Signature

public boolean, null migrateUp ( $class, $plugin = null )

runToTop()

View source

Arguments

Returns

mixed

Signature

public mixed runToTop ( $plugin = null )