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

Public Member Functions

 Trash_Folder ($assetid=0)
 
 create (&$link)
 
 _createAdditional (&$link)
 
 paintBackend (&$o)
 
 canClone ()
 
 morph ($new_type_code)
 
 setAttrValue ($name, $value)
 
 moveLinkPos ($linkid, $sort_order=-1)
 
 canCreateLink (&$minor, $link_type, $exclusive)
 
 readAccess ($assetids=Array())
 
 writeAccess ($lock_type='', $assetids=Array())
 
 purgeAccess ()
 
- Public Member Functions inherited from Folder
 Folder ($assetid=0)
 
 _getAllowedLinks ()
 
- 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

- 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 Folder
 _preCreateCheck (Array &$link)
 
 _createAdditional (Array &$link)
 
 _getName ($short_name=FALSE, $contextid=NULL)
 

Detailed Description

Definition at line 31 of file trash_folder.inc.

Member Function Documentation

_createAdditional ( $link)

Perform any additional processing required during the creation of this asset

Trash folder grants public read access when it is created

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

Definition at line 96 of file trash_folder.inc.

canClone ( )

returns FALSE always because we don't want to be able to clone a trash folder

Returns
boolean public

Definition at line 138 of file trash_folder.inc.

canCreateLink ( $minor,
  $link_type,
  $exclusive 
)

Returns TRUE if the passed minor asset can be linked to this asset, or a string with the error msg

Parameters
object&$minorthe minor asset that we are linking to
string$link_typethe type of link this is
int$exclusivethe exclusive status of the link (gets passed to canLinkToType)
Returns
mixed boolean|string public

Definition at line 213 of file trash_folder.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 59 of file trash_folder.inc.

morph (   $new_type_code)

Morph's this asset to either one of it's parent type or one of it's children types Only succeeds if $type_code asset's is 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 155 of file trash_folder.inc.

moveLinkPos (   $linkid,
  $sort_order = -1 
)

Moves a link from one place in this assets links order to another position

Parameters
int$linkidthe link id of the link to move about
string$sort_orderthe position in the links list that this link should take, if less than zero places at end of list
Returns
boolean public
See Also
Asset::moveLinkPos()

Definition at line 195 of file trash_folder.inc.

paintBackend ( $o)

Prints out the backend interface for the asset it's up to the kids to override

Parameters
object&$othe Backend Outputter object
Returns
void public

Definition at line 118 of file trash_folder.inc.

purgeAccess ( )

Returns TRUE if the current user can purge the trash

Returns
boolean public

Definition at line 265 of file trash_folder.inc.

readAccess (   $assetids = Array())

Returns TRUE if the passed assetid has read access to this asset

Parameters
array$assetidsAn array of user_group and/or user ids to check for read access If the array is empty, the current user will be checked
Returns
boolean public

Definition at line 233 of file trash_folder.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 172 of file trash_folder.inc.

Trash_Folder (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file trash_folder.inc.

writeAccess (   $lock_type = '',
  $assetids = Array() 
)

Returns TRUE if the passed assetid has write access to this asset

Parameters
string$lock_typethe type of write access required - if blank returns a plain check against permissions set for this asset, otherwise returns effective access based on locking and status
array$assetidsAn array of user_group and/or user ids to check for write access If the array is empty, the current user will be checked
Returns
boolean public

Definition at line 252 of file trash_folder.inc.


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