Cron_Job Class Reference

Inheritance diagram for Cron_Job:

Public Member Functions
	__construct ($assetid=0)
	_getAllowedLinks ()
	canClone ()
	morph ($new_type_code)
	moveLinkPos ($linkid, $sort_order=-1)
	canForceablyAcquireLock ($lock_type)
	setAttrValue ($name, $value)
	canDelete ()
	getRunningUser ()
	readableWhen ($inc_type=TRUE)
	run ()
	_errorHandler ($err_no, $err_msg, $err_file, $err_line)
	getNextRun ($when_str, $start_ts=NULL)
	setNextRun ()
	removeJob ()
Public Member Functions inherited from Asset
	Asset ($assetid=0)
	create (Array &$link)
	load ($assetid)
	_loadDataPaths ()
	reload ()
	canDelete ()
	delete ($release_lock=TRUE, $check_locked=TRUE)
	useSystemVersion ()
	loadSystemVersion ()
	saveSystemVersion ()
	clearSystemVersion ()
	revertToSystemVersion ()
	revertNoticeLinksToSystemVersion ()
	_updated ($update_parents=TRUE)
	type ()
	getTypeAncestors ($include_asset=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	getLanguages ()
	setLanguages (Array $languages)
	setCharset ($charset)
	setForceSecure ($force_secure)
	remapAssetids (Array $map)
	morph ($new_type_code)
	_morphCleanup ($new_type_code)
	onRequestKeywords (Asset $broadcaster, Array $vars=Array())
	canClone ()
	cloneComponents (Asset $clone, Array $components, $override=FALSE)
	cloneComponentsAdditional (Asset $clone, Array $components)
	cloneLinks (Asset $clone)
	getStatus ()
	getAvailableStatii ()
	getStatusDescription ()
	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
	setDate ($date_type, $time=NULL, $userid=NULL)
	lockTypes ()
	canForceablyAcquireLock ($lock_type)
	getEditingLocks ($keywords)
	_getAllowedLinks ()
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	canCreateLink (Asset $minor, $link_type, $exclusive)
	canMoveLink (Asset $minor, Asset $old_major, $link_type)
	describeLink ($linkid)
	isDeletableLink ($linkid)
	canDeleteLink ($linkid)
	deleteLink ($linkid, $check_locked=TRUE)
	linksUpdated ()
	canCloneLink ()
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	setAttrValue ($name, $value)
	attr ($name)
&	attrByRef ($name)
	getAttribute ($name, $mute_errors=FALSE)
	getAssetKeywords ($descriptions=FALSE)
	getAvailableKeywords ()
	getKeywordReplacement ($keyword)
	getAssetWebPathKeywordReplacement ()
	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
	processCustomKeywords ($keywords=Array())
	getContent ()
	setContent ()
	getEffectiveLastUpdatedTime ($assetids)
	readAccess (Array $assetids=Array())
	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
	adminAccess ($lock_type='', Array $assetids=Array())
	backendAccess ()
	liveEditAccess ($lock_type)
	canliveEdit ($lock_type)
	effectiveUnrestricted ()
	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
	accessEffective ()
	permissionsUpdated ()
	printFrontend ()
	printFrontendAsset (Asset $asset, $design=NULL)
	getValidProtocols ()
	printHead ()
	printBody ()
	getCurrentPaintLayoutName ()
	getCurrentDesignName ()
	printBodyWithPaintLayout ($layout_id='')
	initLimbo ()
	printLimbo ()
	paintBackend (Backend_Outputter $o)
	getPrefix ()
	processBackend (Backend_Outputter $o, Array &$link)
	getEI ()
	getEditFns ()
	getBackendHref ($screen='', $backend_page=TRUE)
	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
	getURLs ()
	getHref ($base_url=NULL, $ignore_rollback=FALSE)
	getWebDataPath ()
	getWebPaths ()
	saveWebPaths ($paths, $auto_add_remaps=TRUE)
	getLookups ($field='')
	getDesignLookups ()
	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
	deleteLookupValue ($layout_name, $layout_value)
	setPaintLayouts ($layouts)
	updateLookups ($auto_add_remaps=TRUE)
	setLookupValues (Array $values)
	getAssetStatusDescriptionKeywordReplacement ()
	getAssetStatusColourKeywordReplacement ()
	replaceKeywordsInString ($string)
	fastTrack ($tasks)
	unFastTrack ($tasks)
	shouldFastTrack ($task, $assetid=NULL)
	getFaskTrackedTaskAssetids ($task)
	getDependantParentsURL ()
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Static Public Member Functions
static	whenTypeName ($type)
static	whenWeekDayName ($wday)
static	getWhenArr ($when_str)

Protected Member Functions
	_preCreateCheck (Array &$link)
	_exec (&$msg)
Protected Member Functions inherited from Asset
	_preCreateCheck (Array &$link)
	_createAdditional (Array &$link)
	_abortCreate ($trigger_level_changed=FALSE, $linkid=0)
	_loadVars ()
	_getName ($short_name=FALSE, $contextid=NULL)
	_getKeywordReplacement ($keyword)
	_checkPermissionAccess ($perm, $assetids=Array(), $only_workflow=TRUE)
	makeAndSaveInitialWebPath ($path, $parent_link=NULL)

Additional Inherited Members
Data Fields inherited from Asset
	$id = 0
	$version = ''
	$name = ''
	$short_name = ''
	$status
	$languages = ''
	$charset = ''
	$force_secure = '0'
	$created
	$created_userid
	$updated
	$updated_userid
	$published
	$published_userid
	$status_changed
	$status_changed_userid
	$_is_cacheable = FALSE
	$vars = Array()
	$_available_keywords = Array()
	$data_path_suffix = ''
	$data_path = ''
	$data_path_public = ''
	$_ser_attrs = FALSE

Detailed Description

Definition at line 39 of file cron_job.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 49 of file cron_job.inc.

Member Function Documentation

_errorHandler	(		$err_no,
			$err_msg,
			$err_file,
			$err_line
	)

This function captures all errors and warnings that occur during the execution of a job

Parameters

int	$err_no	The type of error (E_*)
string	$err_msg	The error message
string	$err_file	The file the error occured in
string	$err_line	The line the error occured on

Returns

void private

See Also

run()

Definition at line 739 of file cron_job.inc.

_exec ( &  $msg )

protected

Actually executes the functionality for this job, called by run()

Returns a bitmask of the SQ_CRON_JOB_* constants to tell the cron manager what to do eg: SQ_CRON_JOB_ERROR | SQ_CRON_JOB_RETRY means an error occured, but can I please be re-tried, SQ_CRON_JOB_COMPLETED means everything is done correctly, but I can't be removed, SQ_CRON_JOB_COMPLETED | SQ_CRON_JOB_REMOVE means everything is done correctly and I can be removed

Parameters

string

&$msg

used to return any messages about completion etc from _exec

Returns

int private

See Also

run()

Definition at line 838 of file cron_job.inc.

_getAllowedLinks

(

)

Returns an array of all the permitted links type, the type asset and the cardinality

Returns

array private

See Also

Asset::_getAllowLinks()

Definition at line 87 of file cron_job.inc.

_preCreateCheck ( Array &  $link )

protected

Perform any pre-validation required during the creation of this asset

Cron jobs ensure a type and time has been set before they are created

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 66 of file cron_job.inc.

canClone

(

)

returns FALSE always because we don't want to be able to clone a cron job

Returns

boolean public

Definition at line 105 of file cron_job.inc.

canDelete

(

)

Can this asset have its last significant link removed (putting it in the trash)? For Cron Jobs this can only be done by the running user or a sys admin, and only if the Cron Job is not read-only

Returns

boolean public

Definition at line 329 of file cron_job.inc.

canForceablyAcquireLock

(

$lock_type

)

Can the current user forceably acquire the current lock on this asset?

Parameters

string

$lock_type

any valid lock type for this asset's type, plus 'all' which will attempt to acquire all locks that this asset has

Returns

boolean public

Definition at line 158 of file cron_job.inc.

getNextRun	(		$when_str,
			$start_ts = NULL
	)

When given a when string value and a start time returns the timestamp for the first time after the start time that this when string represents

Parameters

string	$when_str	the encoded 'when' str
int	$start_ts	the starting timestamp

Returns

int public

Definition at line 857 of file cron_job.inc.

getRunningUser

(

)

Gets the user that this cron job is to run as while executing

Returns

mixed object|NULL public

Definition at line 360 of file cron_job.inc.

static getWhenArr (   $when_str )

static

Returns the 'when' string attribute split up into the different types

Parameters

string

$when_str

the encoded 'when' str

Returns

array public

Definition at line 504 of file cron_job.inc.

morph

(

$new_type_code

)

Morph's this asset to either one of it's parent type or one of it's children types Only succeeds if $type_code asset's is allowed to link to all children that this asset has

Parameters

string

$new_type_code

the new type_code to attempt to cast this asset to

Returns

boolean public

See Also

Asset::morph()

Definition at line 122 of file cron_job.inc.

moveLinkPos	(		$linkid,
			$sort_order = -1
	)

Moves a link from one place in this assets links order to another position

Parameters

int	$linkid	the link id of the link to move about
string	$sort_order	the position in the links list that this link should take, if less than zero places at end of list

Returns

boolean public

See Also

Asset::moveLinkPos()

Definition at line 141 of file cron_job.inc.

readableWhen

(

$inc_type = TRUE

)

Readable version of the 'when' time

Parameters

boolean

$inc_type

whether or not to include the job type with the string

Returns

string public

Definition at line 435 of file cron_job.inc.

removeJob

(

)

Called when a link to this job is removed. If that was it's last significant link, the job should be moved to the trash.

Returns

boolean public

Definition at line 1056 of file cron_job.inc.

run

(

)

Runs this job and returns bitmask of the constants to tell cron manager what to do eg: SQ_CRON_JOB_ERROR | SQ_CRON_JOB_RETRY means an error occured, but can I please be re-tried, SQ_CRON_JOB_COMPLETED means everything is done correctly, but I can't be removed, SQ_CRON_JOB_COMPLETED | SQ_CRON_JOB_REMOVE means everything is done correctly and I can be removed

Returns

int public

Definition at line 589 of file cron_job.inc.

setAttrValue	(		$name,
			$value
	)

Set the value for the passed variable to the passed value

Parameters

string	$name	the name of the attribute
string	$value	the new value of the attribute

Returns

boolean public

Definition at line 174 of file cron_job.inc.

setNextRun

(

)

Set the next run time in the encoded 'when' str

Only for a repeating cron job with time interval (TI)

Returns

void public

Definition at line 988 of file cron_job.inc.

static whenTypeName (   $type )

static

Returns a text version of the type names to used for the when attr

Parameters

string

$type

two char type name from the when attr

Returns

string public

Definition at line 381 of file cron_job.inc.

static whenWeekDayName (   $wday )

static

Returns a text version of the week day

Parameters

int

$wday

the wday value (0-6)

Returns

string public

Definition at line 409 of file cron_job.inc.

---

The documentation for this class was generated from the following file:

• /Users/webmaster/Desktop/squiz_matrix/core/assets/system/cron/cron_job/cron_job.inc