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

Public Member Functions

 __construct ($assetid=0)
 
 create (&$link)
 
 _getName ($short_name=FALSE)
 
 canClone ()
 
 morph ($new_type_code)
 
 canDelete ()
 
 _exec (&$msg)
 
 run ()
 
- 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 47 of file cron_job_manage_incomplete_submissions.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 57 of file cron_job_manage_incomplete_submissions.inc.

Member Function Documentation

_exec ( $msg)

Run this cron job

Does these things:

  • First, gets its cache of submissions that have had warning emails sent out, and clears those that are completed (whether they exist or not)
  • Then, works out which submissions need to have their warning emails sent this run, and stores them in the cache

Returns a bitmask of the SQ_CRON_JOB_* constants to tell the cron manager what to do

Parameters
string&$msgused to return any messages about completion etc from _exec
Returns
int private
See Also
Cron_Job::_exec(), Cron_Job::run()

Definition at line 183 of file cron_job_manage_incomplete_submissions.inc.

_getName (   $short_name = FALSE)

Return name of the asset

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

Definition at line 111 of file cron_job_manage_incomplete_submissions.inc.

canClone ( )

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

Returns
boolean public

Definition at line 124 of file cron_job_manage_incomplete_submissions.inc.

canDelete ( )

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

Well, not for this asset... if the CMS package is there, there'll always be one of these in the system.

Returns
boolean public

Definition at line 159 of file cron_job_manage_incomplete_submissions.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 75 of file cron_job_manage_incomplete_submissions.inc.

morph (   $new_type_code)

Morphs this asset to either one of its parent types or one of its children types.

Only succeeds if $new_type_code assets are allowed to link to all children that this asset has

Parameters
string$new_type_codethe new type_code to attempt to cast this asset to
Returns
boolean public
See Also
Asset::morph()

Definition at line 142 of file cron_job_manage_incomplete_submissions.inc.

run ( )

Runs this job

This method is overridden because we want to make sure the cron manager never deletes the expired_workflow 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 396 of file cron_job_manage_incomplete_submissions.inc.


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