Comments: on this page. Click to read or post your own.

Class BuildTask

Description
Description | Descendents | Vars (details) | Methods (details)

Interface for a generic build task. Does not support dependencies. This will simply run a chunk of code when called.

To disable the task (in the case of potentially destructive updates or deletes), declare the $Disabled property on the subclass.

  • todo: move from sapphire/testing to sapphire/dev or sapphire/development?
  • abstract:

Located in /sapphire/dev/BuildTask.php (line 14) 

Object
   |
   --BuildTask
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
MigrationTask A migration task is a build task that is reversible.
i18nTextCollectorTask
Variable Summary
Description | Descendents | Vars (details) | Methods (details)
string $description
bool $enabled
string $title
Method Summary
Description | Descendents | Vars (details) | Methods (details)
string getDescription ()
string getTitle ()
void isEnabled ()
void run ( $request)
Variables
Description | Descendents | Vars (details) | Methods (details)
string $description = 'No description available' (line 32)
  • var: Describe the implications the task has, and the changes it makes. Accepts HTML formatting.
  • access: protected
Redefined in descendants as:
bool $enabled = true (line 20)
  • var: If set to FALSE, keep it from showing in the list and from being executable through URL or CLI.
  • access: protected
string $title (line 26)
  • var: Shown in the overview on the TaskRunner HTML or CLI interface. Should be short and concise, no HTML allowed.
  • access: protected
Redefined in descendants as:

Inherited Variables

Inherited from Object

Object::$builtInMethods
 Object::$class
 Object::$classConstructed
 Object::$extensions
 Object::$extension_instances
 Object::$extraMethods
 Object::$extraStatics
 Object::$statics
 Object::$static_cached
Methods
Description | Descendents | Vars (details) Methods (details)
getDescription (line 50)
  • return: HTML formatted description
  • access: public
string getDescription ()
getTitle (line 43)
  • access: public
string getTitle ()
isEnabled (line 36)
  • access: public
void isEnabled ()
run (line 34)
  • abstract:
void run ( $request)
  • $request
Redefined in descendants as:

Inherited Methods

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:38:29 +1300 by phpDocumentor 1.3.2