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

Class: DatabaseBackupTask

Source Location: /modules/core/classes/DatabaseBackupTask.class

Class DatabaseBackupTask

Class Overview

This is a maintenance task that will back up the Gallery database.

Located in /modules/core/classes/DatabaseBackupTask.class [line 37]

MaintenanceTask
   |
   --DatabaseBackupTask

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From MaintenanceTask

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

[ Top ]
Method Summary
void   getInfo()  
void   progressCallBack()   Callback function to recieve notifications of database backup progess
void   requiresMaintenanceMode()  
void   requiresProgressBar()  
void   run()  

[ Top ]
Methods
getInfo  [line 41]

  void getInfo( )


API Tags:
See:  MaintenanceTask::getInfo


Redefinition of:
MaintenanceTask::getInfo()
Return internationalized text about this task

[ Top ]
progressCallBack  [line 109]

  void progressCallBack( $percentage, float $percentComplete  )

Callback function to recieve notifications of database backup progess

Parameters:
float   $percentComplete:  from 0 to 1
   $percentage: 


[ Top ]
requiresMaintenanceMode  [line 101]

  void requiresMaintenanceMode( )


API Tags:
See:  MaintenanceTask::requiresMaintenanceMode


Redefinition of:
MaintenanceTask::requiresMaintenanceMode()
This task requires that the administrator sets Gallery into maintenance mode.

[ Top ]
requiresProgressBar  [line 94]

  void requiresProgressBar( )


API Tags:
See:  MaintenanceTask::requiresProgressBar


Redefinition of:
MaintenanceTask::requiresProgressBar()
Will this task run so long that it requires a progress bar?

[ Top ]
run  [line 56]

  void run( )


API Tags:
See:  MaintenanceTask::run


Redefinition of:
MaintenanceTask::run()
Execute the task

[ Top ]

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