Cron_Job_Future_Lineage Class Reference

Inheritance diagram for Cron_Job_Future_Lineage:

Public Member Functions
	__construct ($assetid=0)
	_getAllowedLinks ()
	canDelete ()
	setAttrValue ($name, $value)
	setAssetInLink (Asset $asset, $side_of_link)
	getAssetInLink ($side_of_link)
	readableDescription ()
	_readableDescriptionReverse ()
Public Member Functions inherited from Cron_Job
	__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 &	getActiveJobs (Asset $asset, $reverse_mode=FALSE)
Static Public Member Functions inherited from Cron_Job
static	whenTypeName ($type)
static	whenWeekDayName ($wday)
static	getWhenArr ($when_str)

Protected Member Functions
	_createAdditional (Array &$link)
	_getName ($short_name=FALSE)
	_exec (&$msg)
	_execDeleteLink ($linkid)
	_canSafeTrash ($minor, $exclude_self=FALSE)
Protected Member Functions inherited from Cron_Job
	_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 31 of file cron_job_future_lineage.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 43 of file cron_job_future_lineage.inc.

Member Function Documentation

_canSafeTrash (   $minor,   $exclude_self = FALSE  )

protected

Given the $minor asset, check if this asset can be safe trashed

Parameters

Asset	$minor	the asset to be checked
Boolean	$exclude_self	exclude the asset itself while checking safe trash status

Returns

boolean protected

Definition at line 572 of file cron_job_future_lineage.inc.

_createAdditional ( Array &  $link )

protected

Perform any additional processing required during the creation of this asset

Parameters

array

&$link

information used to create the initial link

Returns

boolean private

Definition at line 59 of file cron_job_future_lineage.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

Parameters

string

&$msg

used to return any messages about completion etc from _exec

Returns

int private

See Also

Cron_Job::_exec(), Cron_Job::run()

Definition at line 343 of file cron_job_future_lineage.inc.

_execDeleteLink (   $linkid )

protected

Given the ID of a link, attempts to delete it.

Parameters

int

$linkid

The ID of the link to delete

Returns

boolean private

Definition at line 494 of file cron_job_future_lineage.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 114 of file cron_job_future_lineage.inc.

_getName (   $short_name = FALSE )

protected

Returns name of the asset

Parameters

boolean

$short_name

whether or not we are after the shortname or the full name

Returns

string private

See Also

Asset::_getName()

Definition at line 93 of file cron_job_future_lineage.inc.

_readableDescriptionReverse

(

)

Returns a description of what this future lineage job is going to do for reverse mode

Returns

string public

Definition at line 294 of file cron_job_future_lineage.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 For Future Lineage Jobs, admins of the minor asset to update can also remove jobs

Returns

boolean public

Definition at line 136 of file cron_job_future_lineage.inc.

static& getActiveJobs ( Asset  $asset,   $reverse_mode = FALSE  )

static

Returns an array of active future lineage jobs that are to be run on the passed asset returned in chronological order

Parameters

Asset	$asset	the asset to get the future status jobs for
Boolean	$reverse_mode	get active jobs for linked parents or children

Returns

array public

Definition at line 531 of file cron_job_future_lineage.inc.

getAssetInLink

(

$side_of_link

)

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

Parameters

string

$side_of_link

the side of the link that this asset is to be - [major|minor]

Returns

mixed object|NULL public

Definition at line 222 of file cron_job_future_lineage.inc.

readableDescription

(

)

Returns a description of what this future lineage job is going to do

Returns

string public

Definition at line 248 of file cron_job_future_lineage.inc.

setAssetInLink	(	Asset	$asset,
			$side_of_link
	)

Sets the asset that this cron job will be altering the status on

Parameters

Asset	$asset	a reference to the asset
string	$side_of_link	the side of the link that this asset is to be - [major|minor]

Returns

boolean public

Definition at line 189 of file cron_job_future_lineage.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 156 of file cron_job_future_lineage.inc.

---

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

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