Inheritance diagram for Data_Source:

Public Member Functions
	__construct ($assetid=0)

	_getAllowedLinks ()

	getFieldNamesFromRecordSet ()

	getResultSet ($result_id='')

	getCachedResultSet ($cache_key='')

	setResultSet (Array $result, $result_id='')

	cacheResultSet (Array $result, $cache_key='')

	getPermission ($assetid, $permission, $granted=NULL, $and_greater=TRUE, $expand_groups=FALSE, $all_info=FALSE)

	setPermission ($assetid, $data_source_record_setid, $permission, $granted)

	deletePermission ($assetid, $data_source_record_setid, $permission)

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

	assetExists ($assetids)

	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')

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

	getLinkByAsset ($assetid, $other_assetid, $link_types=NULL, $value=NULL, $side_of_link='major', $force_array=FALSE, $dependant=NULL, $exclusive=NULL)

	getAllChildLinks ($assetid, $link_type=0)

	getBinaryDataAttributes ()

	updateLink ($linkid, $link_type=NULL, $value=NULL, $sort_order=NULL)

	deleteAssetLink ($linkid, $moving=FALSE)

	createAssetLink (Asset $major, Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE)

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

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

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

	getParents ($assetid, $type_code='', $strict_type_code=TRUE, $sort_by=NULL, $access=NULL)

	getAssetMapAssetInfo ($assetid)

	getLineageFromURL ($assetid, $protocol, $url)

	filterResultSet ($result)

	getDatasourceFilters ()

	getDynamicVariableValue ($variable_name)

	delete ($release_lock)

	_deleteStoredContents ()

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
	getAsset ($shadowid, $type_code='', $mute_errors=FALSE)

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

Protected Member Functions
	_createAdditional (Array &$link)

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

	_getDummyAsset ($shadowid)

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 31 of file data_source.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 41 of file data_source.inc.

Member Function Documentation

_createAdditional ( Array & $link )

protected

Perform any additional processing required during the creation of this asset

Pages add a default web path when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 59 of file data_source.inc.

_deleteStoredContents ( )

Deletes the contents of the database for this LDAP

Returns: boolean private

Definition at line 951 of file data_source.inc.

_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 data_source.inc.

_getDummyAsset ( $shadowid )

protected

Used by Data_Source::getAsset() to return a dummy asset when it fails to load the data record.

Parameters

string $shadowid

Returns: mixed object|NULL protected

Definition at line 691 of file data_source.inc.

_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 83 of file data_source.inc.

assetExists ( $assetids )

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

Note that this will always return FALSE if you pass it a shadow asset

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 332 of file data_source.inc.

cacheResultSet	(	Array	$result,
			$cache_key = `''`
	)

Accepts an array of info and saves it to cache

Parameters

array	$result	the result set that has to be cached
string	$cache_key	the cache key for this entry

Returns: void public

Definition at line 192 of file data_source.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) 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 406 of file data_source.inc.

createAssetLink	(	Asset	$major,
		Asset	$minor,
			$link_type,
			$value = `''`,
			$sort_order = `NULL`,
			$dependant = `'0'`,
			$exclusive = `'0'`,
			$moving = `FALSE`
	)

Create a link between the two supplied assets

Parameters

Asset	$major	the major asset that we are linking from
Asset	$minor	the minor asset that we are linking to
string	$link_type	the type of link this is
string	$value	the value that is to be associated with this link
string	$sort_order	the position in the links list that this link should take, if NULL or less than zero places at end of list
string	$dependant	'0' / '1' - whether the minor asset is dependant on the major
string	$exclusive	'0' / '1' - whether the major asset is to be the minor's only parent
boolean	$moving	whether or not this asset is being moved

Returns: int public

Definition at line 523 of file data_source.inc.

delete ( $release_lock )

Delete Asset

Parameters

boolean $release_lock TRUE, to release lock

Returns: boolean public

Definition at line 933 of file data_source.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 500 of file data_source.inc.

deletePermission	(	$assetid,
		$data_source_record_setid,
		$permission
	)

Deletes a permission with the passed data_source_record_set

Parameters

int	$assetid	the assetid for asset whose permissions to delete
int	$data_source_record_setid	the id of the data_source_record_set to remove the permission from
string	$permission	the permission code you are deleting

Returns: boolean public

Definition at line 259 of file data_source.inc.

filterResultSet ( $result )

Filter the record set based on the filter settings

Parameters

array $result Datasoruce's record sets

Returns: array public

Definition at line 774 of file data_source.inc.

getAllChildLinks	(	$assetid,
		$link_type = `0`
	)

Get details of the links from the specified asset to all its children

Parameters

string	$assetid	the assetid of the asset to find the child links for
int	$link_type	the type of links to get

Returns: array public

Definition at line 449 of file data_source.inc.

getAsset	(	$assetid,
		$type_code = `''`,
		$mute_errors = `FALSE`,
		$return_null = `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
boolean	$return_null	returns NULL if no data found

Returns: object public

See Also: Asset_Manager::getAsset()

Definition at line 656 of file data_source.inc.

getAssetInfo	(	Array	$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 280 of file data_source.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 742 of file data_source.inc.

getBinaryDataAttributes ( )

Returns name of attributes/fields defined by this datasoruce as a binary data

Returns: array public

Definition at line 463 of file data_source.inc.

getCachedResultSet ( $cache_key = '' )

Returns an array of the result of query execution

Parameters

string $cache_key the cache key for this entry

Returns: array public

Definition at line 151 of file data_source.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
string	$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 622 of file data_source.inc.

getDatasourceFilters ( )

Get the Filters data for this datasoruce asset

Returns: array public

Definition at line 871 of file data_source.inc.

getDynamicVariableValue ( $variable_name )

Get a value of a dynamic variable

Parameters

string $variable_name Name of variable

Returns: string public

Definition at line 909 of file data_source.inc.

getFieldNamesFromRecordSet ( )

Returns an array of the column names of the result set. Upto kids to override this

Returns: array public

Definition at line 121 of file data_source.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 759 of file data_source.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 360 of file data_source.inc.

getLinkByAsset	(	$assetid,
		$other_assetid,
		$link_types = `NULL`,
		$value = `NULL`,
		$side_of_link = `'major'`,
		$force_array = `FALSE`,
		$dependant = `NULL`,
		$exclusive = `NULL`
	)

Get details of the link(s) between the two specified assets

Parameters

int	$assetid	id of the the $side_of_link asset
int	$other_assetid	the asset on the other side of the link
int	$link_types	integer that can be the product of bitwise operations on the SQ_LINK_* constants
string	$value	the value that is associated with this link
string	$side_of_link	Which side of the link the first assetid is on ('major' or 'minor')
boolean	$force_array	force the results to return an array of links even if there is only one link
boolean	$dependant	The dependant status for all the links must be this (if not NULL)
boolean	$exclusive	The exclusive status for all the links must be this (if not NULL)

Returns: array public

Definition at line 433 of file data_source.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 378 of file data_source.inc.

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

Return all links that this asset has to other assets

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
string	$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)

Returns: array public

See Also: Asset_Manager::getLinks()

Implements Bridge.

Definition at line 551 of file data_source.inc.

getParents	(	$assetid,
		$type_code = `''`,
		$strict_type_code = `TRUE`,
		$sort_by = `NULL`,
		$access = `NULL`
	)

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

Returns an array of assetids and their type code

Parameters

int	$assetid	the id of the asset to get its parents for
string \| array	$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	$sort_by	a field in the asset table you would like the results sorted by (eg. name, short_name etc)
int	$access	SQ_PERMISSION_READ\|SQ_PERMISSION_WRITE\|SQ_PERMISSION_ADMIN Specify that links should be returned for assets the user has read, write, or admin access for. Leave NULL to ignore permissions.

Returns: array public

See Also: generateGetParentsQuery()

Definition at line 722 of file data_source.inc.

getPermission	(	$assetid,
		$permission,
		$granted = `NULL`,
		$and_greater = `TRUE`,
		$expand_groups = `FALSE`,
		$all_info = `FALSE`
	)

Returns an array of all data_source_record_set 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 data_source_record_set so only data_source_record_set ids get returned (NOTE: only valid if $all_info is FALSE)
boolean	$all_info	when FALSE fn just returns an array of data_source_record_setids for those that have permission When TRUE fn returns all info about the permission in the form of Array(data_source_record_setid => granted) (NOTE: TRUE is only valid if $and_greater and $expand_groups are FALSE)

Returns: array public

Definition at line 224 of file data_source.inc.

getResultSet ( $result_id = '' )

Returns an array of the result of query execution

Parameters

string $result_id the id to uniquely identify this result

Returns: array public

Definition at line 136 of file data_source.inc.

setPermission	(	$assetid,
		$data_source_record_setid,
		$permission,
		$granted
	)

Sets a permission for the passed data_source_record_set

Parameters

int	$assetid	the assetid for asset whose permissions to set
int	$data_source_record_setid	the id of the data_source_record_set to add the permission for
string	$permission	the permission code you are adding
boolean	$granted	whether this permission grants access or not

Returns: boolean public

Definition at line 242 of file data_source.inc.

setResultSet	(	Array	$result,
			$result_id = `''`
	)

Accepts an array of info and saves it to cache

Parameters

array	$result	the result set that has to be cached
string	$result_id	the id to uniquely identify this result

Deprecated:

Returns: void public

Definition at line 176 of file data_source.inc.

updateLink	(	$linkid,
		$link_type = `NULL`,
		$value = `NULL`,
		$sort_order = `NULL`
	)

Update the details of an existing link

If any of the detail vars are NULL they are not updated.

Parameters

int	$linkid	the link id of the link to update
int	$link_type	the type of the link (one of the SQ_LINK_* constants)
string	$value	the value to place on the link
int	$sort_order	the position in the links list that this link should take, if less than zero places at end of list

Returns: boolean public

Definition at line 484 of file data_source.inc.

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

/Users/webmaster/Desktop/squiz_matrix/core/assets/data_source/data_source/data_source.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation