MigrationsService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\MigrationsService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class MigrationsService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $defaultAction | string (opens new window) |
# $defaultAction
Signature
public string $defaultAction = 'up'
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| getBaseMigration() | Returns the base migration name. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | 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() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | 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() (opens new window) | Raises an event. |
| runToTop() |
# getBaseMigration()
Signature
public string getBaseMigration ( )
# getMigrationHistory()
View source (opens new window)
Arguments
$plugin(null (opens new window))$limit(null (opens new window))
Returns
mixed
Signature
public mixed getMigrationHistory ( $plugin = null, $limit = null )
# getMigrationPath()
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 (opens new window)
Arguments
$plugin
Returns
Signature
public array getNewMigrations ( $plugin = null )
# getTemplate()
Signature
public string getTemplate ( )
# hasRun()
Returns whether a given migration has been run.
View source (opens new window)
Arguments
$version(string (opens new window))$plugin(string (opens new window), null (opens new window))
Returns
Signature
public boolean hasRun ( $version, $plugin = null )
# init()
Initializes the application component.
View source (opens new window)
Returns
boolean (opens new window), null (opens new window)
Throws
Signature
public boolean, null init ( )
# instantiateMigration()
View source (opens new window)
Arguments
$class$plugin(null (opens new window))
Returns
mixed
Throws
Signature
public mixed instantiateMigration ( $class, $plugin = null )
# migrateUp()
Signature
public boolean, null migrateUp ( $class, $plugin = null )
# runToTop()
View source (opens new window)
Arguments
$plugin(Craft\BasePlugin, null (opens new window))
Returns
mixed
Signature
public mixed runToTop ( $plugin = null )
← MigrationRecord Model →