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

Public Member Functions

 Remap_Manager ($assetid=0)
 
 create (Array &$link)
 
 _getAllowedLinks ()
 
 canDelete ()
 
 canClone ()
 
 describeLink ($linkid)
 
 addRemapURL ($old_url, $new_url, $expires=NULL, $never_delete=NULL, $auto=TRUE)
 
 getRemapURLs (Asset $asset)
 
 remapAllURLs ($assetid, $new_url, $expires=NULL)
 
 loadRemapFromCurrentURL ()
 
 loadRemapFromURL ($protocol=NULL, $url=NULL, $parameters='')
 
 getRemapFromURL ($protocol=NULL, $url=NULL)
 
 getPageNotFoundAsset ()
 
 paintPageNotFoundRemap ()
 
 getDesign (Asset $asset, $url=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 ()
 

Protected Member Functions

 _getName ($short_name=FALSE)
 
- 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 30 of file remap_manager.inc.

Member Function Documentation

_getAllowedLinks ( )

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

Returns
array private
See Also
Asset::_getAllowLinks()

Definition at line 108 of file remap_manager.inc.

_getName (   $short_name = FALSE)
protected

Returns 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 94 of file remap_manager.inc.

addRemapURL (   $old_url,
  $new_url,
  $expires = NULL,
  $never_delete = NULL,
  $auto = TRUE 
)

Add a URL remap to the system

Returns 0 on failed insert, 1 on success, -1 if URL already exists

Parameters
string$old_urlthe broken URL
string$new_urlthe URL to redirect to
int$expirestimestamp for when remap expires (NULL for no expiry)
Returns
int public

Definition at line 179 of file remap_manager.inc.

canClone ( )

returns FALSE always because we don't want to be able to clone a remap manager

Returns
boolean public

Definition at line 137 of file remap_manager.inc.

canDelete ( )

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

Returns
boolean public

Definition at line 124 of file remap_manager.inc.

create ( Array &  $link)

Create this asset

Returns 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 58 of file remap_manager.inc.

describeLink (   $linkid)

Return a human readable description of the passed link

Parameters
int$linkidthe link ID of the link to describe
Returns
string public

Definition at line 152 of file remap_manager.inc.

getDesign ( Asset  $asset,
  $url = NULL 
)

Returns the design that this asset currently has applied to it.

Pass in NULL as $url to return the first design asset associated with the asset's id

Parameters
Asset$assetthe asset to get the design for
string$urlthe url of the asset
Returns
object public

Definition at line 661 of file remap_manager.inc.

getPageNotFoundAsset ( )

Returns the asset that has been chosen to delegate 404 Not found requests

Returns
mixed object|NULL public

Definition at line 589 of file remap_manager.inc.

getRemapFromURL (   $protocol = NULL,
  $url = NULL 
)

Attempts to get remap from url

Parameters
string$protocolthe protocol that the url is using
string$urlthe url to remap from
Returns
string|FALSE public

Definition at line 547 of file remap_manager.inc.

getRemapURLs ( Asset  $asset)

Get all remap URLs for an asset's current URLs

Parameters
object&$assetthe asset to get the remaps for
Returns
array public

Definition at line 270 of file remap_manager.inc.

loadRemapFromCurrentURL ( )

Attempts to redirect user from current URL

Returns
boolean public

Definition at line 405 of file remap_manager.inc.

loadRemapFromURL (   $protocol = NULL,
  $url = NULL,
  $parameters = '' 
)

Attempts to redirect a url to its remapped url If the remap manager is unsuccessful in doing so, it will return FALSE

Parameters
string$protocolthe protocol that the url is using
string$urlthe url to remap from
string$parametersparamters string to preserve
Returns
boolean public

Definition at line 458 of file remap_manager.inc.

paintPageNotFoundRemap ( )

Paints the page not found asset

If a design can be found for the asset, it will be painted as well, otherwise justs the contents of the asset are painted.

Returns
boolean public

Definition at line 615 of file remap_manager.inc.

Remap_Manager (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 40 of file remap_manager.inc.

remapAllURLs (   $assetid,
  $new_url,
  $expires = NULL 
)

Remap all the URLs of an asset to a new URL

Parameters
string$assetidthe ID of the asset we are adding remaps for
string$new_urlthe URL to redirect to
int$expirestimestamp for when remap expires (NULL for no expiry)
Returns
boolean public

Definition at line 332 of file remap_manager.inc.


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