Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Cron_Job_Metadata_Triggers Class Reference
Inheritance diagram for Cron_Job_Metadata_Triggers:
Cron_Job Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 create (&$link)
 
 canDelete ()
 
 _getName ($short_name=FALSE)
 
 run ()
 
 _exec (&$msg)
 
- 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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Cron_Job
static whenTypeName ($type)
 
static whenWeekDayName ($wday)
 
static getWhenArr ($when_str)
 
- 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
 
- Protected Member Functions inherited from Cron_Job
 _preCreateCheck (Array &$link)
 
 _exec (&$msg)
 

Detailed Description

Definition at line 36 of file cron_job_metadata_triggers.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
string$assetidthe asset id to be loaded

Definition at line 45 of file cron_job_metadata_triggers.inc.

Member Function Documentation

_exec ( $msg)

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

Broadcast a trigger event for all assets which date is expired

Parameters
string$msgaccepted by reference, used to return any messages about completion etc from _exec
Returns
int bitmask of the SQ_CRON_JOB_* constants to tell the cron manager what to do
See Also
Cron_Job::_exec(), Cron_Job::run() private

Definition at line 153 of file cron_job_metadata_triggers.inc.

_getName (   $short_name = FALSE)

Returns name of the asset

Parameters
bool$short_namewhether or not we are after the shortname or the full name
See Also
Asset::_getName() private

Definition at line 113 of file cron_job_metadata_triggers.inc.

canDelete ( )

Can this asset have its last significant link removed (putting it in the trash)?

For the expired workflow cron job, NO! There must always be exactly one of these here.

Returns
boolean public

Definition at line 98 of file cron_job_metadata_triggers.inc.

create ( $link)

Create this asset

Return either the linkid or FALSE on failure

Parameters
array&$linkinformation used to create the initial link
Returns
mixed int|boolean public
See Also
Asset::create()

Definition at line 63 of file cron_job_metadata_triggers.inc.

run ( )

Runs this job

This method is overridden because we want to make sure the cron manager never deletes this cron job Returns a bitmask of the SQ_CRON_JOB_* constants to tell the cron manager what to do

Returns
int public

Definition at line 130 of file cron_job_metadata_triggers.inc.


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