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

Class: MaintenanceHelper_simple

Source Location: /modules/core/classes/helpers/MaintenanceHelper_simple.class

Class MaintenanceHelper_simple

Class Overview

A collection of useful maintenance related methods

Located in /modules/core/classes/helpers/MaintenanceHelper_simple.class [line 35]



		
		
		
		

Methods

[ Top ]
Method Summary
GalleryStatus   addRun()   Add a new task run to the maintenance map.
array   fetchLastRun()   Return information about the last run of this task.
array   fetchTasks()   Fetch all the available maintenance tasks
void   setMaintenanceMode()  

[ Top ]
Methods
addRun  [line 102]

  GalleryStatus addRun( string $taskId, int $timestamp, bool $success, array $details  )

Add a new task run to the maintenance map.

Parameters:
string   $taskId: 
int   $timestamp:  when the run happened
bool   $success:  task success/failure
array   $details:  string task details

API Tags:
Return:  a status code


[ Top ]
fetchLastRun  [line 73]

  array fetchLastRun( string $taskId  )

Return information about the last run of this task.

Parameters:
string   $taskId: 

API Tags:
Return:  GalleryStatus a status code array(runId => int, timestamp => int, success => bool, details => string)


[ Top ]
fetchTasks  [line 42]

  array fetchTasks( )

Fetch all the available maintenance tasks


API Tags:
Return:  GalleryStatus a status code array(taskId => MaintenanceTask, ...)


[ Top ]
setMaintenanceMode  [line 128]

  void setMaintenanceMode( $mode  )

Parameters:
   $mode: 

API Tags:
See:  GalleryCoreApi::setMaintenanceMode


[ Top ]

Documentation generated on Fri, 08 Oct 2010 05:32:00 -0700 by phpDocumentor 1.3.0RC6