Inheritance diagram for Squiz_Suite_System_Search:

Public Member Functions
	__construct ($assetid=0)

	getSitemapXml ($urls, $excludes)

	getPageContent ($url)

Public Member Functions inherited from Squiz_Suite_System
	__construct ($assetid=0)

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

Static Public Member Functions
static	getAssetInfo (array $urls)

static	getFileIndexingComponents ($urls)

static	changeStatusFunnelbackUser ($userid, $set_to='activate')

static	validateActiveUser ($username, $password='', $return_keys=FALSE)

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 Squiz_Suite_System
	_preCreateCheck (Array &$link)

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

Detailed Description

Definition at line 31 of file squiz_suite_system_search.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 41 of file squiz_suite_system_search.inc.

Member Function Documentation

static changeStatusFunnelbackUser	(	$userid,
		$set_to = `'activate'`
	)

static

The API function for Funnelback system to activate (set LIVE) or deactivate (set UNDER CONSTRUCTION) the funnelback user configured on funnelback manager

Parameters

string	$userid	Id of user funnelback manager is configured
string	$set_to	activate/deactivate string

Returns: boolean

Definition at line 346 of file squiz_suite_system_search.inc.

static getAssetInfo ( array $urls )

static

The API function for returning the asset info.

Parameters

array $urls An array of the URLs to get the info for.

Returns: array

Definition at line 226 of file squiz_suite_system_search.inc.

static getFileIndexingComponents ( $urls )

static

The API function for returning the following for the passed url of the file type asset:

metadata information
security keys (see funnelback_manager.inc::getAccessLocks)
author name, Matrix file asset title, actualy file name

Parameters

string/array $urls An array of the URLs to get the info for.

Returns: json

Definition at line 270 of file squiz_suite_system_search.inc.

getPageContent ( $url )

Returns the page content of a url

Parameters

string $url The url to get the page content for.

Returns: string public

Definition at line 145 of file squiz_suite_system_search.inc.

getSitemapXml	(	$urls,
		$excludes
	)

Returns a list of sitemap xml for use with Funnelback.

Parameters

array	$urls	An array of urls to get the sitemap for.
array	$excludes	An array of urls to exclude from the sitemap.

Returns: string public

Definition at line 58 of file squiz_suite_system_search.inc.

static validateActiveUser	(	$username,
		$password = `''`,
		$return_keys = `FALSE`
	)

static

The API function to validate if the user is active or not by passing in the username and optionally password. If the flag to return user keys is set will return array or returns boolean

Parameters

string	$username	username to validate
string	$password	password to validate the username against (optional)
boolean	$return_keys	flag option if userkeys are to be returned (optional)

Returns: mixed

Definition at line 411 of file squiz_suite_system_search.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/squiz_suite/systems/squiz_suite_system_search/squiz_suite_system_search.inc

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation