silverstripe-framework/dev/BuildTask.php

71 lines
1.5 KiB
PHP
Raw Normal View History

<?php
/**
* Interface for a generic build task. Does not support dependencies. This will simply
* run a chunk of code when called.
2014-08-15 08:53:05 +02:00
*
* To disable the task (in the case of potentially destructive updates or deletes), declare
* the $Disabled property on the subclass.
2014-08-15 08:53:05 +02:00
*
* @package framework
* @subpackage dev
*/
2017-11-30 18:49:46 +01:00
abstract class BuildTask extends SS_Object {
2014-08-15 08:53:05 +02:00
2017-01-25 10:22:20 +01:00
/**
* Set a custom url segment (to follow dev/tasks/)
*
* @config
* @var string
*/
private static $segment = null;
/**
* @var bool $enabled If set to FALSE, keep it from showing in the list
* and from being executable through URL or CLI.
*/
protected $enabled = true;
2014-08-15 08:53:05 +02:00
/**
* @var string $title Shown in the overview on the {@link TaskRunner}
* HTML or CLI interface. Should be short and concise, no HTML allowed.
*/
protected $title;
2014-08-15 08:53:05 +02:00
/**
* @var string $description Describe the implications the task has,
* and the changes it makes. Accepts HTML formatting.
*/
protected $description = 'No description available';
2014-08-15 08:53:05 +02:00
/**
* Implement this method in the task subclass to
* execute via the TaskRunner
*
* @param SS_HTTPRequest $request
*/
abstract public function run($request);
2014-08-15 08:53:05 +02:00
/**
* @return bool
*/
public function isEnabled() {
return $this->enabled;
}
2014-08-15 08:53:05 +02:00
/**
* @return string
*/
public function getTitle() {
return ($this->title) ? $this->title : $this->class;
}
2014-08-15 08:53:05 +02:00
/**
* @return string HTML formatted description
*/
public function getDescription() {
return $this->description;
}
2014-08-15 08:53:05 +02:00
}