abstract class Job extends Object (View source)

Constants

JOB_SUCCESS

JOB_ERROR_EXCEPTION_GENERAL

Properties

$error from  Object
protected $jobClassLocations
$jID
$jStatus
$availableJStatus
$jDateLastRun
$jHandle
$jNotUninstallable
$isScheduled
$scheduledInterval
$scheduledValue

Methods

loadError($error)

No description

from  Object
isError()

No description

from  Object
getError()

No description

from  Object
setPropertiesFromArray($arr)

No description

from  Object
static 
camelcase($file)

No description

from  Object
static 
uncamelcase($string)

No description

from  Object
run()

No description

getJobName()

No description

getJobDescription()

No description

getJobHandle()

No description

getJobID()

No description

getPackageHandle()

No description

getJobLastStatusCode()

No description

didFail()

No description

canUninstall()

No description

supportsQueue()

No description

static 
jobClassLocations()

No description

getJobDateLastRun()

No description

getJobStatus()

No description

getJobLastStatusText()

No description

static 
authenticateRequest($auth)

No description

static 
generateAuth()

No description

static 
exportList($xml)

No description

static Job[]
getList(bool $scheduledOnly = false)

No description

reset()

No description

markStarted()

No description

markCompleted($resultCode = 0, $resultMsg = false)

No description

static 
getByID($jID = 0)

No description

static 
getByHandle($jHandle = '')

No description

static 
getJobObjByHandle($jHandle = '', $jobData = array())

No description

static 
getClassName($jHandle, $pkgHandle = null)

No description

static 
getAvailableList($includeConcreteDirJobs = 1)

No description

executeJob()

No description

setJobStatus($jStatus = 'ENABLED')

No description

static 
installByHandle($jHandle = '')

No description

static 
getListByPackage($pkg)

No description

static 
installByPackage($jHandle, $pkg)

No description

install()

No description

uninstall()

No description

static 
clearLog()

Removes Job log entries.

isScheduledForNow()

No description

setSchedule($scheduled, $interval, $value)

No description

Details

loadError($error)

No description

Parameters

$error

isError()

No description

getError()

No description

setPropertiesFromArray($arr)

No description

Parameters

$arr

static camelcase($file)

No description

Parameters

$file

static uncamelcase($string)

No description

Parameters

$string

abstract run()

No description

abstract getJobName()

No description

abstract getJobDescription()

No description

getJobHandle()

No description

getJobID()

No description

getPackageHandle()

No description

getJobLastStatusCode()

No description

didFail()

No description

canUninstall()

No description

supportsQueue()

No description

static jobClassLocations()

No description

getJobDateLastRun()

No description

getJobStatus()

No description

getJobLastStatusText()

No description

static authenticateRequest($auth)

No description

Parameters

$auth

static generateAuth()

No description

static exportList($xml)

No description

Parameters

$xml

static Job[] getList(bool $scheduledOnly = false)

No description

Parameters

bool $scheduledOnly

Return Value

Job[]

reset()

No description

markStarted()

No description

markCompleted($resultCode = 0, $resultMsg = false)

No description

Parameters

$resultCode
$resultMsg

static getByID($jID = 0)

No description

Parameters

$jID

static getByHandle($jHandle = '')

No description

Parameters

$jHandle

static getJobObjByHandle($jHandle = '', $jobData = array())

No description

Parameters

$jHandle
$jobData

static protected getClassName($jHandle, $pkgHandle = null)

No description

Parameters

$jHandle
$pkgHandle

static getAvailableList($includeConcreteDirJobs = 1)

No description

Parameters

$includeConcreteDirJobs

executeJob()

No description

setJobStatus($jStatus = 'ENABLED')

No description

Parameters

$jStatus

static installByHandle($jHandle = '')

No description

Parameters

$jHandle

static getListByPackage($pkg)

No description

Parameters

$pkg

static installByPackage($jHandle, $pkg)

No description

Parameters

$jHandle
$pkg

install()

No description

uninstall()

No description

static clearLog()

Removes Job log entries.

isScheduledForNow()

No description

setSchedule($scheduled, $interval, $value)

No description

Parameters

$scheduled
$interval
$value