silverstripe-framework/dev/MigrationTask.php

71 lines
1.7 KiB
PHP
Raw Normal View History

<?php
/**
* A migration task is a build task that is reversible.
2014-08-15 08:53:05 +02:00
*
* <b>Creating Migration Tasks</b>
2014-08-15 08:53:05 +02:00
*
* To create your own migration task all you need to do is define your own subclass of MigrationTask and define the
* following functions
2014-08-15 08:53:05 +02:00
*
* <i>mysite/code/MyMigrationTask.php</i>
2014-08-15 08:53:05 +02:00
*
* <code>
* class MyMigrationTask extends BuildTask {
2014-08-15 08:53:05 +02:00
*
* protected $title = "My Database Migrations"; // title of the script
* protected $description = "Description"; // description of what it does
2014-08-15 08:53:05 +02:00
*
* public function run($request) {
* if ($request->getVar('Direction') == 'down') {
* $this->down();
* } else {
* $this->up();
* }
* }
2014-08-15 08:53:05 +02:00
*
* public function up() {
* // do something when going from old -> new
* }
2014-08-15 08:53:05 +02:00
*
* public function down() {
* // do something when going from new -> old
2014-08-15 08:53:05 +02:00
* }
* }
* </code>
2014-08-15 08:53:05 +02:00
*
* <b>Running Migration Tasks</b>
2014-08-15 08:53:05 +02:00
* To run any tasks you can find them under the dev/ namespace. To run the above script you would need to run
* the following and note - Either the site has to be in [devmode](debugging) or you need to add ?isDev=1 to the URL
2014-08-15 08:53:05 +02:00
*
* <code>
* // url to visit if in dev mode.
* http://www.yoursite.com/dev/tasks/MyMigrationTask
2014-08-15 08:53:05 +02:00
*
* // url if you are in live mode but need to run this
* http://www.yoursite.com/dev/tasks/MyMigrationTask?isDev=1
* </code>
2014-08-15 08:53:05 +02:00
*
* @package framework
* @subpackage dev
*/
class MigrationTask extends BuildTask {
2014-08-15 08:53:05 +02:00
protected $title = "Database Migrations";
2014-08-15 08:53:05 +02:00
protected $description = "Provide atomic database changes (not implemented yet)";
2014-08-15 08:53:05 +02:00
public function run($request) {
if ($request->param('Direction') == 'down') {
$this->down();
} else {
$this->up();
}
}
2014-08-15 08:53:05 +02:00
public function up() {}
2014-08-15 08:53:05 +02:00
public function down() {}
2014-08-15 08:53:05 +02:00
}