Class: MaintenanceTask

Source Location: /modules/core/AdminMaintenance.inc

Class MaintenanceTask

Class Overview

Base class for all maintenance tasks

Located in /modules/core/AdminMaintenance.inc [line 241]

Author(s):

API Tags:

Abstract:

Methods

[ Top ]

Direct descendents

Child Class	Description
RewriteCheckConflictTask	This is a MaintenanceTask that will check the short style URL for file system conflicts through all Gallery items.
FlushDatabaseCacheTask	This is a MaintenanceTask that will delete all cached database information.
FlushTemplatesTask	This is a MaintenanceTask that will delete all the cached Smarty templates.
DeleteSessionsTask	This is a MaintenanceTask that removes all expired sessions from the database.
OptimizeDatabaseTask	This is a MaintenanceTask that will optimize all the Gallery tables in the database to make Gallery run smoothly.
SystemInfoTask	This is a MaintenanceTask that will return system details useful for posting in support forum.
BuildDerivativesTask	This is a MaintenanceTask that will ensure the data files for all derivatives (thumbnails, etc) have been built.
SetOriginationTimestampTask	This is a MaintenanceTask that will attempt to retrieve and set the origination timestamp for all items (usually from EXIF data).
ConvertDatabaseToUtf8Task	This is a MaintenanceTask that will optimize all the Gallery tables in the database to make Gallery run smoothly.
DatabaseBackupTask	This is a maintenance task that will back up the Gallery database.
AdminMaintenanceControllerTestTaskSuccess
AdminMaintenanceControllerTestTaskProgressBar
AdminMaintenanceControllerTestTaskFail
MaintenanceHelperTestTask
ResetFailureCountsTask	This is a MaintenanceTask that will clear all failure counts in the database.

[ Top ]

Method Summary

array('title'	getInfo()	Return internationalized text about this task
true	requiresMaintenanceMode()	This task requires that the administrator sets Gallery into maintenance mode.
true	requiresProgressBar()	Will this task run so long that it requires a progress bar?
array	run()	Execute the task

[ Top ]

Methods

getInfo [line 247]

array('title' getInfo(
)

Return internationalized text about this task

API Tags:

Return:

=> ..., 'description' => ..., 'l10Domain' => ...)

Redefined in descendants as:

[ Top ]

requiresMaintenanceMode [line 273]

true requiresMaintenanceMode(
)

This task requires that the administrator sets Gallery into maintenance mode.

API Tags:

Return:

or false

Redefined in descendants as:

[ Top ]

requiresProgressBar [line 265]

true requiresProgressBar(
)

Will this task run so long that it requires a progress bar?

API Tags:

Return:

or false

Redefined in descendants as:

[ Top ]

run [line 257]

array run(
)

Execute the task

API Tags:

Return:

GalleryStatus a status code boolean success or failure array string output text

Redefined in descendants as:

[ Top ]

Documentation generated on Fri, 08 Oct 2010 04:34:02 -0700 by phpDocumentor 1.3.0RC6

	GalleryCore UserInterface

[ class tree: GalleryCore ] [ index: GalleryCore ] [ all elements ]