Inheritance diagram for TRIM_Saved_Search:

Public Member Functions
	__construct ($assetid=0)

	_getAllowedLinks ()

&	getResultSet ()

	getCachedResults ($hash_key)

	cacheResult ($result, $hash_key)

	updateCachedResult ($forced=FALSE)

	resultUris ($result)

	getAttachedFile ($uri)

	getTRIMRecords ($connection)

	getHashKey ()

	getConnection ()

	getRecordSearchOptions ()

	storeDocumentList ($connection, &$record_info)

	getDynamicVariableValue ($variable_name)

	printFrontend ()

	setAttrValue ($name, $value)

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

	getRetrievedFields ($type= 'all')

	getRetrievedFieldType ($field)

Public Member Functions inherited from Data_Source
	__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
	getParents ($assetid, $type_code='', $strict_type_code=TRUE)

Protected Member Functions
	_createAdditional (Array &$link, $args=Array())

Protected Member Functions inherited from Data_Source
	_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 36 of file trim_saved_search.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid assetid for the asset

Definition at line 46 of file trim_saved_search.inc.

Member Function Documentation

_createAdditional	(	Array &	$link,
			$args = `Array()`
	)

protected

Perform any additional processing required during the creation of this asset

Standard pages create a bodycopy asset when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 66 of file trim_saved_search.inc.

_getAllowedLinks ( )

Returns an array of all the permitted links type, the type asset and the cardinality In the form

Returns: array private

Definition at line 90 of file trim_saved_search.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: object public

See Also: Asset_Manager::getAsset()

Implements Bridge.

Definition at line 789 of file trim_saved_search.inc.

getAttachedFile ( $uri )

This function get attached file(s) for a particular URI

Returns: void public

Definition at line 330 of file trim_saved_search.inc.

getConnection ( )

This function return the connection details

Returns: array public

Definition at line 578 of file trim_saved_search.inc.

getDynamicVariableValue ( $variable_name )

Get a value of a dynamic variable

Parameters

string $variable_name Name of variable

Returns: string public

Definition at line 671 of file trim_saved_search.inc.

getHashKey ( )

This function return the hash string for a particular search settings

Returns: string string

Definition at line 547 of file trim_saved_search.inc.

getRecordSearchOptions ( )

This function populate the search options.

Returns: array public

Definition at line 612 of file trim_saved_search.inc.

& getResultSet ( )

Returns an array of the result of query execution

Returns: array public

Definition at line 112 of file trim_saved_search.inc.

getRetrievedFields ( $type = 'all' )

Returns retrieved fields info from TRIM server

Parameters

string $type what kind of fields to return? additional fields, standard fields or all

Returns: array public

Definition at line 815 of file trim_saved_search.inc.

getRetrievedFieldType ( $field )

Returns the type of a retrieved field

Parameters

string $field name of the retrieved field

Returns: string public

Definition at line 839 of file trim_saved_search.inc.

getTRIMRecords ( $connection )

This function return all the TRIM records based on the preconfigured settings

Returns: array public

Definition at line 396 of file trim_saved_search.inc.

printFrontend ( )

Function printFrontend

Returns: void public

Definition at line 696 of file trim_saved_search.inc.

resultUris ( $result )

This function return an array of Uris

Definition at line 312 of file trim_saved_search.inc.

setAttrValue	(	$name,
		$value
	)

Queue the setting of the value of an attribute

This function sets the value of the attribute locally, but does not database updating. The change is queued awaiting the call of saveAttributes()

Parameters

string	$name	the name of the attribute
string	$value	the new value of the attribute

Returns: boolean public

See Also: saveAttributes()

Definition at line 763 of file trim_saved_search.inc.

storeDocumentList	(		$connection,
		&	$record_info
	)

This function updates all the documents.

Returns: void public

Definition at line 636 of file trim_saved_search.inc.

updateCachedResult ( $forced = FALSE )

This function update only records which has the version has been changed

Returns: void public

Definition at line 187 of file trim_saved_search.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/trim/trim_saved_search/trim_saved_search.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation