Inheritance diagram for Funnelback_Manager:

Public Member Functions
	__construct ($assetid=0)

	create (Array &$link)

	_getName ($short_name=FALSE)

	canDelete ()

	canClone ()

	onAssetUpdate (&$broadcaster, $vars=Array())

	onAssetStatusUpdate (&$broadcaster, $vars=Array())

	onAttributeChange (&$broadcaster, $vars=Array())

	onContentsUpdated (&$broadcaster, $vars=Array())

	onAssetDeleted (&$broadcaster, $vars=Array())

	onPermissionChange (&$broadcaster, $vars=Array())

	onLookupsUpdated (&$broadcaster, $vars=Array())

	onMetadataDeleted (&$broadcaster, $vars=Array())

	onMetadataUpdate (&$broadcaster, $vars=Array())

	updateAsset (&$asset, $vars=Array())

	_generateXML ($url, $asset)

	getAccessLocks ($asset)

	_addEntry ($url, $assetid, $root_url, $root_urlid, $live, $xml, $original_url)

	generateXMLCache ($url=NULL, $assetid=0, $public=TRUE)

	getXMLCache ($url=Array(), $assetid=0, $public=TRUE, $excludes=Array())

	isCollectionValid ($collection_id)

	getCollections ()

	getCollectionName ($collection_id)

	getCollectionDataPath ($collection_id, $sub_dir='')

	getCollectionConfigFiles ($collection_id)

	createCollectionConfig ($file, $config)

	_getCollectionTypes ()

	getIndexingOptions ()

	readConfiguration ($config, $type='thesaurus', $delimiter='=', $system=FALSE)

	writeConfiguration ($config, $data=Array(), $type='thesaurus', $delimiter='=')

	runCommand ($command, &$output, $input=NULL, $log_file=NULL, $cwd=NULL, $environment=Array())

	encodeText ($text)

	decodeText ($text)

	getMetadataAliases ()

	getFunnelbackPath ()

	getNullQueryKeyword ()

	checkInstalled ()

	getRequiredFiles ($path=FALSE)

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

Protected Member Functions
	_getSiteURL ($root_urlid='0', &$asset, $asset_url)

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 funnelback_manager.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 41 of file funnelback_manager.inc.

Member Function Documentation

_addEntry	(	$url,
		$assetid,
		$root_url,
		$root_urlid,
		$live,
		$xml,
		$original_url
	)

Add an entry for the url and assetid

Parameters

string	$url	The url of the broadcasting asset
int	$assetid	The assetid of the broadcasting asset
string	$root_url	The root url of the asset
int	$root_urlid	The root url id of the asset
boolean	$live	Is the broadcasting asset live?
string	$xml	The xml ready for the sitemap
string	$original_url	the original_url the __data url points to

Returns: boolean private

Make sure the url we're looking at starts with the right root_url If it doesn't, the site may have multiple urls and we're looking at the wrong one. In which case we can ignore this one.

We check for the root_url first. If that's not found, strip a "sub-dir" off and try again. This is required if you have a matrix site like http://www.example.com/mysite and the url we're trying to add is http://www.example.com/__data/..../file.pdf

Repeat that until base_url is back to a '.' (which of course means it won't match).

Well, we tried. They don't match. Don't add the entry.

Definition at line 624 of file funnelback_manager.inc.

_generateXML	(	$url,
		$asset
	)

Generate the Sitemap XML for this asset based on the info provided

Parameters

string	$url	The url of the broadcasting asset. This is just a placeholder url to make it easier to fill in later. It also saves calling the same function multiple times and only change the one attribute.
object	$asset	The broadcasting asset

Returns: string public

Definition at line 493 of file funnelback_manager.inc.

_getCollectionTypes ( )

Returns the types of collections allowed

Returns: array private

Definition at line 1147 of file funnelback_manager.inc.

_getName ( $short_name = FALSE )

Returns name of the asset

Parameters

boolean $short_name whether or not we are after the shortname or the full name

Returns: string private

See Also: Asset::_getName()

Definition at line 94 of file funnelback_manager.inc.

_getSiteURL	(		$root_urlid = `'0'`,
		&	$asset,
			$asset_url
	)

protected

Get the site URL based on the root_urlid

Parameters

string	$root_urlid	The root urlid
object	&$asset	The current asset, only used when the $root_urlid=0

Returns: string protected

Definition at line 884 of file funnelback_manager.inc.

canClone ( )

returns FALSE always because we don't want to be able to clone a funnelback manager

Returns: boolean public

Definition at line 120 of file funnelback_manager.inc.

canDelete ( )

Can this asset have its last significant link removed (putting it in the trash)?

Returns: boolean public

Definition at line 107 of file funnelback_manager.inc.

checkInstalled ( )

Check that funnelback is installed

Returns: boolean public

Definition at line 1733 of file funnelback_manager.inc.

create ( Array & $link )

Create this asset

Parameters

array &$link information used to create the initial link

Returns: mixed int|boolean public

See Also: Asset::create()

Definition at line 58 of file funnelback_manager.inc.

createCollectionConfig	(	$file,
		$config
	)

Create a collection config file, based on a default

Parameters

string	$file	The file to create
string	$config	The config file to create eg. fluster, metamap etc.

Returns: void public

Definition at line 1081 of file funnelback_manager.inc.

decodeText ( $text )

Decode a key or lock Reverse the effect of encoding

Parameters

string $text The text to decode

Returns: string public

Definition at line 1609 of file funnelback_manager.inc.

encodeText ( $text )

Encode a key or lock Funnelback strongly advise to stick to ASCII characters and not use control characters. More specifically, Word Smart Quotes are removed and ASCII single and double quote have no meaning except for escaping. Furthermore, single and double quote can be used but messy, so we are just going to escape them as HTML.

Parameters

string $text The text to encode

Returns: string public

Definition at line 1561 of file funnelback_manager.inc.

generateXMLCache	(	$url = `NULL`,
		$assetid = `0`,
		$public = `TRUE`
	)

Generate the XML Cache and saves to the file specified

Parameters

string	$url	The url of the Cache to generate
string	$assetid	The assetid of the site this cache is
boolean	$public	Return only public results

Returns: string public

Definition at line 736 of file funnelback_manager.inc.

getAccessLocks ( $asset )

generates the comma seperated list for all the permission the passed asset has

Parameters

object $asset The broadcasting asset

Returns: string public

Definition at line 566 of file funnelback_manager.inc.

getCollectionConfigFiles ( $collection_id )

Get the config files of a collection

Parameters

string $collection_id The ID of the collection to get the data path for

Returns: string public

Definition at line 1055 of file funnelback_manager.inc.

getCollectionDataPath	(	$collection_id,
		$sub_dir = `''`
	)

Get the data path of the collection

Parameters

string	$collection_id	The ID of the collection to get the data path for
string	$sub_dir	The name of a sub directory if needed

Returns: string public

Definition at line 1021 of file funnelback_manager.inc.

getCollectionName ( $collection_id )

Get the collection name of the collection passed in

Parameters

string $collection_id The id of the collection to find the name for

Returns: string public

Definition at line 1003 of file funnelback_manager.inc.

getCollections ( )

Get all collections on this install

Returns: array public

Definition at line 986 of file funnelback_manager.inc.

getFunnelbackPath ( )

Check that funnelback is installed

Returns: boolean public

Definition at line 1706 of file funnelback_manager.inc.

getIndexingOptions ( )

Get the indexing options

Returns: array public

Definition at line 1166 of file funnelback_manager.inc.

getMetadataAliases ( )

Get the metadata mapping aliases

Returns: array public

Definition at line 1629 of file funnelback_manager.inc.

getNullQueryKeyword ( )

Return the keyword to perform a NULL query search (Bascially, a long gobbly-gook word with a NOT operator)

Returns: string public

Definition at line 1720 of file funnelback_manager.inc.

getRequiredFiles ( $path = FALSE )

Get the required files

Parameters

boolean $path Include the relative path in the results

Returns: array public

Definition at line 1756 of file funnelback_manager.inc.

getXMLCache	(	$url = `Array()`,
		$assetid = `0`,
		$public = `TRUE`,
		$excludes = `Array()`
	)

Get the xml from the index table

Parameters

string	$url	The url of the Cache to generate
string	$assetid	The assetid of the site this cache is
boolean	$public	Return only public results
array	$excludes	An array of URLs to be excluded (including their children)

Returns: array public

Definition at line 766 of file funnelback_manager.inc.

isCollectionValid ( $collection_id )

Is the passed collection id valid or not

Parameters

string $collection_id The collection id to verify

Returns: boolean public

Definition at line 967 of file funnelback_manager.inc.

onAssetDeleted	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset gets deleted. We want to flush any key data in the index table

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 223 of file funnelback_manager.inc.

onAssetStatusUpdate	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset has its status changed

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 161 of file funnelback_manager.inc.

onAssetUpdate	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset is updated

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 140 of file funnelback_manager.inc.

onAttributeChange	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an assets atrtributes have changed

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	a list of attributes that have changed

Returns: boolean public

Definition at line 181 of file funnelback_manager.inc.

onContentsUpdated	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset is created

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 202 of file funnelback_manager.inc.

onLookupsUpdated	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset's lookups are updated. We want to flush any key data in the index table

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 265 of file funnelback_manager.inc.

onMetadataDeleted	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset metadata gets deleted. We want to flush any key data in the index table

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 286 of file funnelback_manager.inc.

onMetadataUpdate	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset metadata gets updated.

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 307 of file funnelback_manager.inc.

onPermissionChange	(	&	$broadcaster,
			$vars = `Array()`
	)

Event fired when an asset's permission gets changed. We want to flush any key data in the index table

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster Component is set as $vars['component']

Returns: boolean public

Definition at line 244 of file funnelback_manager.inc.

readConfiguration	(	$config,
		$type = `'thesaurus'`,
		$delimiter = `'='`,
		$system = `FALSE`
	)

Read a configuration file

Parameters

string	$config	The file to read
string	$type	The type of configuration to read
string	$delimiter	The delimiter of each line
boolean	$system	Used currently for metamap, to pass in the attribute

Returns: array public

Definition at line 1223 of file funnelback_manager.inc.

runCommand	(		$command,
		&	$output,
			$input = `NULL`,
			$log_file = `NULL`,
			$cwd = `NULL`,
			$environment = `Array()`
	)

Run a command line program

Parameters

string	$command	The command to run
string	&$output	The output to return
string	$input	The input to pass into $command (NULL if none)
string	$log_file	Where to log
string	$cwd	The current working directory (NULL to use current)
array	$environment	Any environment settings to use at run time

Returns: integer public

Definition at line 1486 of file funnelback_manager.inc.

updateAsset	(	&	$asset,
			$vars = `Array()`
	)

Asset has been changed in some way, update the funnelback table to suit

Parameters

object	&$asset	the asset to update
array	$vars	the components to update

Returns: boolean public

Definition at line 330 of file funnelback_manager.inc.

writeConfiguration	(	$config,
		$data = `Array()`,
		$type = `'thesaurus'`,
		$delimiter = `'='`
	)

Write a configuration file

Parameters

string	$config	The file to write
array	$data	The data to write
string	$type	The type of configuration to write
string	$delimiter	The delimiter of each line

Returns: array public

Definition at line 1384 of file funnelback_manager.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/funnelback/funnelback_manager/funnelback_manager.inc

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation