Class BuildTask

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.

Object

Extended by

BuildTask

Direct known subclasses

AddSubsiteTask, ClearHistoryTask, FolderRenameTask, i18nTextCollectorTask, ImageResizeTask, MigrateSiteTreeLinkingTask, MigrateTranslatableTask, MigrationTask, SaveFileSizeTask, SetMainSiteHomePageTypeTask, UpgradeSiteTreePermissionSchemaTask, ConvertFrom26Task, DeleteOldAssociatedFoldersTask, DeleteUnusedCustomerFilesTask, EncryptAllPasswordsTask, FilesystemSyncTask, FillLinkTrackingTask, FindBadLinksTask, FlushGeneratedImagesTask

Indirect known subclasses

FillOldLogDataTask, PhotoGalleryMigrationTask, UserFormsVersionedTask

Abstract
Package: sapphire\dev
Located at sapphire/dev/BuildTask.php

Methods summary

`abstract public`	# `run( mixed $request )` Implement this method in the task subclass to execute via the TaskRunner Implement this method in the task subclass to execute via the TaskRunner
`public`	# `isEnabled( )`
`public string`	# `getTitle( )` Returns `string` string
`public string`	# `getDescription( )` Returns `string` HTML formatted description

Methods inherited from Object

__call(), __construct(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), defineMethods(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected boolean`	`$enabled`	# $enabled If set to FALSE, keep it from showing in the list and from being executable through URL or CLI. $enabled If set to FALSE, keep it from showing in the list and from being executable through URL or CLI.
`protected string`	`$title`	# $title Shown in the overview on the `TaskRunner` HTML or CLI interface. Should be short and concise, no HTML allowed. $title Shown in the overview on the `TaskRunner` HTML or CLI interface. Should be short and concise, no HTML allowed.
`protected string`	`$description`	# $description Describe the implications the task has, and the changes it makes. Accepts HTML formatting. $description Describe the implications the task has, and the changes it makes. Accepts HTML formatting.

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -