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

Public Member Functions

 Calendar_Event_Cancellation ($assetid=0)
 
 _preCreateCheck (&$link)
 
 _getAllowedLinks ()
 
 synchronizeWithParent (&$parent)
 
 addReplacement ($start_date, $end_date, $description)
 
 processEventAction ($action_name)
 
 saveAttributes ($dont_run_updated=FALSE)
 
 printBody ()
 
- Public Member Functions inherited from Calendar_Event
 Calendar_Event ($assetid=0)
 
 _preCreateCheck (&$link)
 
 _createAdditional (&$link)
 
 delete ($release_lock=TRUE)
 
 getAvailableKeywords ()
 
 _getAllowedLinks ()
 
 _getDeleteLink ()
 
 saveAttributes ($dont_run_updated=FALSE)
 
 cloneComponents (&$clone, $components, $override=FALSE)
 
 getStartDate ()
 
 getEndDate ()
 
 getStartTime ()
 
 getEndTime ()
 
 getDuration ()
 
 getFriendlyStart ()
 
 getFriendlyEnd ()
 
 getFriendlyDatesAndTimes ()
 
 printBody ()
 
 processEventAction ($action_name)
 
 cacheCalendarData ($updating=TRUE)
 
 getKeywordReplacement ($keyword)
 
 getAsset ($whole_assetid)
 
 getAssetInfo (Array $assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
 
 getAttributeValuesByName ($attr_name, $asset_type, $assetids, $contextid=NULL)
 
- 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

 getReplacementLink ($id=NULL)
 

Protected Member Functions

 _getName ($short_name=FALSE, $contextid=NULL)
 
- Protected Member Functions inherited from Calendar_Event
 _getName ($short_name=FALSE, $contextid=NULL)
 
- 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 32 of file calendar_event_cancellation.inc.

Member Function Documentation

_getAllowedLinks ( )

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

Returns
array private

Definition at line 121 of file calendar_event_cancellation.inc.

_getName (   $short_name = FALSE,
  $contextid = NULL 
)
protected

Returns name of the asset

Parameters
boolean$short_namewhether or not we are after the shortname or the full name
int$contextidwhat context to return the name from
Returns
string private
See Also
Asset::_getName()

Definition at line 93 of file calendar_event_cancellation.inc.

_preCreateCheck ( $link)

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

Cancellation events ensure their link data is correct and they are synchronized

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

Definition at line 59 of file calendar_event_cancellation.inc.

addReplacement (   $start_date,
  $end_date,
  $description 
)

Add a replacement single event linked under this cancellation event

Parameters
string$start_dateThe start date attr value of the replacement event
string$end_dateThe end date attr value of the replacement event
string$descriptionDescription for the replacement event
Returns
object public

Definition at line 174 of file calendar_event_cancellation.inc.

Calendar_Event_Cancellation (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 42 of file calendar_event_cancellation.inc.

getReplacementLink (   $id = NULL)
static

Gets the link details of the exception (cancellation or modification) event linked under this event for the date given

This function can be called statically (with both parameters) or on an object (with just the first parameter)

Parameters
int$idThe ID of the recurring event to test, or NULL to use the current object
Returns
mixed array|boolean public (optionally)

Definition at line 227 of file calendar_event_cancellation.inc.

printBody ( )

Called by the design to print the body of this asset

Returns
void public

Definition at line 346 of file calendar_event_cancellation.inc.

processEventAction (   $action_name)

Process the specified action on this event, and return whatever html the action wants to show

Parameters
string$action_nameThe action to perform, eg 'cancel'
Returns
string public

Definition at line 244 of file calendar_event_cancellation.inc.

saveAttributes (   $dont_run_updated = FALSE)

Save attributes set with setAttrValue to the database

Parameters
boolean$dont_run_updatedif true this->_updated() won't be run (THIS IS ONLY EVER CALLED FROM Asset::create())
Returns
boolean public
See Also
Asset::setAttrValue()

Definition at line 315 of file calendar_event_cancellation.inc.

synchronizeWithParent ( $parent)

Check the parent has an instance on the specified date and set our end time, end date, end time and name based on the parent

Parameters
object&$parentThe recurring event that we belong to
Returns
boolean public
See Also
Calendar_Event_Cancellation::create(), Calendar_Event_Cancellation::saveAttributes()

Definition at line 139 of file calendar_event_cancellation.inc.


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