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

Public Member Functions

 Site_Network ($assetid=0)
 
 _createAdditional (&$link)
 
 _getAllowedLinks ()
 
 canCreateLink (&$minor, $link_type, $exclusive)
 
 canMoveLink (&$minor, &$old_major, $link_type)
 
 getPrimaryURL ()
 
 unserialiseSessionFile ($session_file)
 
 serialiseSessionFile ($session_file, $session_contents)
 
 syncSessionFile ($pri_sessionid)
 
- 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 site_network.inc.

Member Function Documentation

_createAdditional ( $link)

Perform any additional processing required during the creation of this asset

Site Network's dont do anything, but Folder's do, so we need to override this method.

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

Definition at line 58 of file site_network.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 72 of file site_network.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

Site Network enforce the rule that a site can only belong to a signle network

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 111 of file site_network.inc.

canMoveLink ( $minor,
$old_major,
  $link_type 
)

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

Differs from canCreateLink() in that if we are being moved from a site network, we have to allow one network link, being the asset we are being moved from

Parameters
object&$minorthe minor asset that we are linking to
object&$old_majorthe major asset that we are being moved from
string$link_typethe type of link this is
Returns
mixed boolean|string public

Definition at line 142 of file site_network.inc.

getPrimaryURL ( )

Get the primary URL for this network, with the protocol

Returns
string public

Definition at line 167 of file site_network.inc.

serialiseSessionFile (   $session_file,
  $session_contents 
)

Serialises the specified session contents and writes it to the specified session file

Parameters
string$session_filethe session file to write to
array$session_contentsthe contents to write to file
Returns
boolean public

Definition at line 238 of file site_network.inc.

Site_Network (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file site_network.inc.

syncSessionFile (   $pri_sessionid)

Synchronises the specified primary session with the current (secondary) session

The current session will be overridden with the primary session if the primary's timestamp is the most recent, and vice versa. $_SESSION is used for the current session, and will be written to at script completion.

Parameters
string$pri_sessionidthe sessionid of the primary session
Returns
boolean public

Definition at line 278 of file site_network.inc.

unserialiseSessionFile (   $session_file)

Unserialises a session file

It breaks each of the session variables up and stores them as the key elements of an array with their values as the values of the array elements.

Parameters
string$session_filethe session file to unserialise
Returns
array public

Definition at line 209 of file site_network.inc.


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