This is the API documentation for concrete5 version 5.6 and earlier. View Current API Documentation

Class Concrete5_Model_Job

The job class is essentially sub-dispatcher for certain maintenance tasks that need to be run at specified intervals. Examples include indexing a search engine or generating a sitemap page.

Concrete5_Library_Object
Extended by Object
Extended by Concrete5_Model_Job

Direct known subclasses

Job

Abstract
Package: Utilities
License: MIT
Author: Andrew Embler andrew@concrete5.org
Author: Tony Trupp tony@concrete5.org
Link: http://www.concrete5.org
Located at core/models/job.php

Methods summary

abstract public
# run( )
abstract public
abstract public
public
public
# getJobID( )
public
public
public
# didFail( )
public
public
public static
public
public
public
public static
public static
public static
# exportList( $xml )
public static
# getList( $scheduledOnly = false )
public
# reset( )
public
public
# markCompleted( $resultCode = 0, $resultMsg = false )
public static
# getByID( $jID = 0 )
public static
# getByHandle( $jHandle = '' )
public static
# getJobObjByHandle( $jHandle = '', $jobData = array() )
public static
# getAvailableList( $includeConcreteDirJobs = 1 )
public
public
# setJobStatus( $jStatus = 'ENABLED' )
public
# installByHandle( $jHandle = '' )
public static
public
# installByPackage( $jHandle, $pkg )
public
# install( )
public
public static
# clearLog( )

Removes Job log entries

public
public
# setSchedule( $scheduled, $interval, $value )

Constants summary

integer JOB_SUCCESS
# 0
integer JOB_ERROR_EXCEPTION_GENERAL
# 1

Properties summary

protected array $jobClassLocations
# array()
public integer $jID
# 0
public string $jStatus
# 'ENABLED'
public array $availableJStatus
# array( 'ENABLED','RUNNING','ERROR','DISABLED_ERROR','DISABLED' )
public $jDateLastRun
#
public string $jHandle
# ''
public integer $jNotUninstallable
# 0
public integer $isScheduled
# 0
public string $scheduledInterval
# 'days'
public integer $scheduledValue
# 0

Properties inherited from Concrete5_Library_Object

$error