XML_User_Bridge Class Reference

Inheritance diagram for XML_User_Bridge:

Public Member Functions
	__construct ($assetid=0)
	loadFromFile ()
	getAsset ($assetid, $type_code='', $mute_errors=FALSE)
	getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL, $dependant=NULL, $exclusive=NULL)
	getParents ($assetid, $type_code='', $strict_type_code=TRUE)
	getChildren ($assetid, $type_code='', $strict_type_code=TRUE, $dependant=NULL, $sort_by=NULL)
	getLink ($assetid, $link_type=NULL, $type_code='', $strict_type_code=TRUE, $value=NULL, $side_of_link='major', $exclusive=NULL)
	getLinkById ($linkid, $assetid=0, $side_of_link='major')
	getAssetInfo ($assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
	assetExists ($assetids)
	getPermission ($assetid, $permission, $granted=null, $and_greater=true, $expand_groups=false, $all_info=false)
	getLineageFromURL ($assetid, $protocol, $url)
	countLinks ($assetid, $side_of_link='major', $link_types=0, $type_code='', $strict_type_code=TRUE, $ignore_linkid=0)
	deleteAssetLink ($linkid, $moving=FALSE)
	getAssetMapAssetInfo ($assetid)
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 ()
Public Member Functions inherited from Bridge
	getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL)

Data Fields
	$groups = NULL
	$group_members = NULL
	$user_memberships = NULL
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
Data Fields inherited from MySource_Object
	$_tmp

Protected Member Functions
	_getName ($short_name=FALSE, $contextid=NULL)
	canCreateLink (&$minor, $link_type, $exclusive)
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)

Detailed Description

Definition at line 34 of file xml_user_bridge.inc.

Constructor & Destructor Documentation

__construct

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Returns

object public

Definition at line 50 of file xml_user_bridge.inc.

Member Function Documentation

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

protected

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the shortname or the full name
int	$contextid	what context to return the name from

Returns

string private

See Also

Asset::_getName()

Definition at line 69 of file xml_user_bridge.inc.

assetExists

(

$assetids

)

Determine if the passed assetid or assetids refer(s) to a valid asset in the system

Parameters

mixed

$assetids

the ID of the asset we are going to the check for existence or an array of assetids we want to check

Returns

mixed boolean|array public

Definition at line 561 of file xml_user_bridge.inc.

canCreateLink ( &  $minor,   $link_type,   $exclusive  )

protected

Returns TRUE if the supplied assets can be linked in the specified way

Parameters

object	&$major	the major asset in the proposed link
object	&$minor	the minor asset in the proposed link
string	$link_type	the type of link that is proposed
int	$exclusive	(0|1) whether this will be the only significant link with $minor as the minor asset

Returns

mixed boolean|string public

Definition at line 476 of file xml_user_bridge.inc.

countLinks	(		$assetid,
			$side_of_link = 'major',
			$link_types = 0,
			$type_code = '',
			$strict_type_code = TRUE,
			$ignore_linkid = 0
	)

Return the number of links in the system that involve the specified asset

Can be restricted by either link type afnd/or asset type code

Parameters

int	$assetid	id of the the $side_of_link asset
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) (can be a string or an array of strings) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
int	$ignore_linkid	ignore the link represented by this link id when returning the count

Returns

int public

Implements Bridge.

Definition at line 651 of file xml_user_bridge.inc.

deleteAssetLink	(		$linkid,
			$moving = FALSE
	)

Remove a link by id

Parameters

int	$linkid	the link id of the link to remove
boolean	$moving	TRUE if this delete is part of a move operation

Returns

boolean public

Implements Bridge.

Definition at line 667 of file xml_user_bridge.inc.

getAsset	(		$assetid,
			$type_code = '',
			$mute_errors = FALSE
	)

Returns a reference to the asset represented by the passed assetid

Parameters

int	$assetid	the shadow part asset id to be loaded (i.e part after the ':')
string	$type_code	if this exists then this object is used to load the asset, if not then the DB is queried to find out the asset type
boolean	$mute_errors	stops the outputting of errors in this fn, needed because you can't use the '@' operator when returning by reference

Returns

mixed object|NULL public

See Also

Asset_Manager::&getAsset()

Implements Bridge.

Definition at line 154 of file xml_user_bridge.inc.

getAssetInfo	(		$assetids,
			$type_code = Array(),
			$strict_type_code = TRUE,
			$field = ''
	)

Returns an array of information about assets of the passed codes

If one value in $field then the return value is Array(assetid => '[field]'), otherwise Array(assetid => Array())

Parameters

array	$assetids	an array of assets to limit
mixed	$type_code	an asset type code, or array of typecodes, to limit results to
boolean	$strict_type_code	ensure returned assets are of the passed type codes
string	$field	single field from the asset table to return (along with the assetid) Default is all fields

Returns

array public

Definition at line 497 of file xml_user_bridge.inc.

getAssetMapAssetInfo

(

$assetid

)

Get asset info for use by asset map

Parameters

string

$assetid

Full Asset id to get information for

Returns

array public

Implements Bridge.

Definition at line 682 of file xml_user_bridge.inc.

getChildren	(		$assetid,
			$type_code = '',
			$strict_type_code = TRUE,
			$dependant = NULL,
			$sort_by = NULL
	)

Get all asset ids that are below the passed assetid in the various trees in which it exists

Parameters

int	$assetid	the id of the asset to get its children for
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
boolean	$dependant	if TRUE, results will be filtered to assets that are dependants. If FALSE, results will all not be dependants. If NULL, results will not be filtered
string	$sort_by	a field in the asset table you would like the results sorted by (eg. name, short_name etc)

Returns

array public

See Also

Asset_Manager::getChildren()

Implements Bridge.

Definition at line 385 of file xml_user_bridge.inc.

getLineageFromURL	(		$assetid,
			$protocol,
			$url
	)

Returns an array of assetid's + info in the order that they propogate out from THIS BRIDGE'S url

Parameters

string	$assetid	the id of the last asset in the lineage
string	$protocol	the protocol to match -> NULL means it is ignored
string	$url	the url to check for -> NULL defaults it to current url

Returns

array public

Implements Bridge.

Definition at line 624 of file xml_user_bridge.inc.

getLink	(		$assetid,
			$link_type = NULL,
			$type_code = '',
			$strict_type_code = TRUE,
			$value = NULL,
			$side_of_link = 'major',
			$exclusive = NULL
	)

Get details of a link with the specified characteristics

Parameters

int	$assetid	id of the the $side_of_link asset
int	$link_type	integer that should be a single integer of the SQ_LINK_* constants
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding an asset that is just a $type_code or potentially an inherited type or $type_code and any of it's sub-classes
string	$value	the value that is associated with this link
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
boolean	$exclusive	The exclusive status for the link must be this (if not NULL)

Returns

array public

Definition at line 436 of file xml_user_bridge.inc.

getLinkById	(		$linkid,
			$assetid = 0,
			$side_of_link = 'major'
	)

Get details of the link with specified linkid

Parameters

int	$linkid	id of the link were returning
int	$assetid	id of the the $side_of_link asset if zero no check is made and both major and minor information is returned
string	$side_of_link	Which side of the link the asset represented by $assetid is on ('major' or 'minor')

Returns

array public

Definition at line 455 of file xml_user_bridge.inc.

getLinks	(		$assetid,
			$link_types,
			$type_code = '',
			$strict_type_code = TRUE,
			$side_of_link = 'major',
			$sort_by = NULL,
			$dependant = NULL,
			$exclusive = NULL
	)

Return all links that this asset has to other assets

The bulk user system only deals with significant, non-dependant and non-exclusive links. Sorting is ignored.

Parameters

int	$assetid	id of the the $side_of_link asset
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
mixed	$type_code	the type of asset that is linked (eg 'Page', 'File', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes
string	$side_of_link	Which side of the link this (the current) asset is on ('major' or 'minor')
string	$sort_by	a field in the asset table you would like the results sorted by (eg. name, short_name etc)
boolean	$dependant	Whether we want dependant links, non-dependent or (NULL) don't care
boolean	$exclusive	Whether we want exclusive links, non-exclusive or (NULL) don't care

Returns

array public

See Also

Asset_Manager::getLinks()

Definition at line 218 of file xml_user_bridge.inc.

getParents	(		$assetid,
			$type_code = '',
			$strict_type_code = TRUE
	)

Get all asset ids that are above the passed assetid in the various trees in which it exists

Parameters

int	$assetid	the id of the asset to get its parents for
mixed	$type_code	the type of asset that is linked (eg 'bulkmail_user', 'User_Group', etc) if an array returns link if matches any of the array values
boolean	$strict_type_code	whether we are finding assets that are just a $type_code or $type_code and any of it's sub-classes

Returns

array public

See Also

Asset_Manager::getParents()

Implements Bridge.

Definition at line 339 of file xml_user_bridge.inc.

getPermission	(		$assetid,
			$permission,
			$granted = null,
			$and_greater = true,
			$expand_groups = false,
			$all_info = false
	)

Returns an array of all user or user_group assets that have the passed permission for the passed asset

Parameters

int	$assetid	the assetid for asset whose permissions to get
string	$permission	the permission code you are getting
boolean	$granted	type of Access : null = all, true = granted, false = denied
boolean	$and_greater	get effective permission (eg read access = read or write or admin)
boolean	$expand_groups	expand user groups so only user ids get returned (NOTE: only valid if $all_info is false)
boolean	$all_info	when false fn just returns an array of userids for those that have permission When true fn returns all info about the permission in the form of Array(userid => granted) (NOTE: TRUE is only valid if $and_greater and $expand_groups are false)

Returns

array public

Definition at line 607 of file xml_user_bridge.inc.

loadFromFile

(

)

Load the user data from the XML file, refreshing the file if it's too old

Returns

void public

Definition at line 93 of file xml_user_bridge.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/packages/data/xml_user_bridge/xml_user_bridge.inc