Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions
Cron_Job_Future_Permission Class Reference
Inheritance diagram for Cron_Job_Future_Permission:
Cron_Job Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 _getAllowedLinks ()
 
 canDelete ()
 
 setAttrValue ($name, $value)
 
 permissionName ()
 
 getGrantedUsers ($grant=TRUE)
 
 actionName ()
 
 setAssetToUpdate (Asset $asset)
 
 getAssetToUpdate ()
 
- 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 getAllPermissionDescs ()
 
static & getActiveJobs (Asset $asset)
 
- 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)
 
- 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)
 

Static Protected Member Functions

static _getAllPermissions ()
 

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_permission.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file cron_job_future_permission.inc.

Member Function Documentation

_createAdditional ( Array &  $link)
protected

Perform any additional processing required during the creation of this asset

Parameters
array&$linkinformation used to create the initial link
Returns
boolean private

Definition at line 57 of file cron_job_future_permission.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&$msgused to return any messages about completion etc from _exec
Returns
int private
See Also
Cron_Job::_exec(), Cron_Job::run()

Definition at line 339 of file cron_job_future_permission.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 112 of file cron_job_future_permission.inc.

static _getAllPermissions ( )
staticprotected

Return an array of all permissions that a future asset permission can be set to of the form Array('[code_name]' => '[value]')

Returns
array private

Definition at line 188 of file cron_job_future_permission.inc.

_getName (   $short_name = FALSE)
protected

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 91 of file cron_job_future_permission.inc.

actionName ( )

Return the name of the action of the cron job. It is either 'Add' or 'Remove'.

Returns
string public

Definition at line 263 of file cron_job_future_permission.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 Permission Jobs, admins of the asset to update can also remove jobs

Returns
boolean public

Definition at line 135 of file cron_job_future_permission.inc.

static& getActiveJobs ( Asset  $asset)
static

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

Parameters
Asset$assetthe asset to get the future permission jobs for
Returns
array public

Definition at line 400 of file cron_job_future_permission.inc.

static getAllPermissionDescs ( )
static

Return an array of all descriptions of permissions in the system in the form Array('[value]' => '[description]')

Used for the drop down boxes

Returns
array private

Definition at line 204 of file cron_job_future_permission.inc.

getAssetToUpdate ( )

Get the asset that this cron job will be altering the permission on

Returns
mixed object|NULL public

Definition at line 311 of file cron_job_future_permission.inc.

getGrantedUsers (   $grant = TRUE)

Return the list of userids that will be granted permissions

Parameters
boolean$grantTRUE to get grant list, FALSE to get deny list
Returns
array public

Definition at line 242 of file cron_job_future_permission.inc.

permissionName ( )

Return the name of the permission that this future permission object is going to change the asset to

Returns
string public

Definition at line 226 of file cron_job_future_permission.inc.

setAssetToUpdate ( Asset  $asset)

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

Parameters
Asset$asseta reference to the asset
Returns
boolean public

Definition at line 277 of file cron_job_future_permission.inc.

setAttrValue (   $name,
  $value 
)

Set the value for the passed variable to the passed value

Parameters
string$namethe name of the attribute
string$valuethe new value of the attribute
Returns
boolean public

Definition at line 158 of file cron_job_future_permission.inc.

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