Inheritance diagram for Data_Source_Xml:

Public Member Functions
	__construct ($assetid=0)

	_getAllowedLinks ()

	getResultSet ()

	getItems ()

	openFeed ($url)

	parseXML ()

	getXMLContent ()

	_createParser ($content)

	_checkRootTag ($name)

	startElement ($parser, $name, $attributes=FALSE)

	characterData ($parser, $data)

	endElement ($parser, $name)

	_getRequiredTags ()

	_getRequiredAttributes ()

	_getFeedURL ()

	getURLString ()

	getDynamicVariableValue ($variable_name)

	_addCDATA ($content)

	printFrontend ()

	printBody ()

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

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

Protected Attributes
	$_tree_level = 0

	$_record_tree_level = 0

	$_non_empty_record = FALSE

	$_result = Array()

	$_inside_relevant_tag = FALSE

	$_inside_root_tag = FALSE

	$_current_tag_name = ''

	$_current_attributes = Array()

	$_record_set_index = 0

	$_new_teg = FALSE

	$_complex_elements = Array()

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 Data_Source
	_createAdditional (Array &$link)

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

	_getDummyAsset ($shadowid)

Detailed Description

Definition at line 33 of file data_source_xml.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 130 of file data_source_xml.inc.

Member Function Documentation

_addCDATA ( $content )

Encloses the selected XML elements with CDATA term

Parameters

string $content XML content

Returns: string private

Definition at line 623 of file data_source_xml.inc.

_checkRootTag ( $name )

Determines whether the parser is inside the specified root tag or not

Parameters

string $name Name of the element

Returns: void private

Definition at line 345 of file data_source_xml.inc.

_createParser ( $content )

Creates the xml parser which will then go off and parse our feed

Parameters

string $content The XML content to parse

Returns: mixed array|boolean public

Definition at line 296 of file data_source_xml.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 144 of file data_source_xml.inc.

_getFeedURL ( )

Processes and returns the XML Feed URL for the XML datasource

Returns: string private

Definition at line 546 of file data_source_xml.inc.

_getRequiredAttributes ( )

Returns all requested attributes and their corresponding tag names from the XML feed

Returns: array private

Definition at line 533 of file data_source_xml.inc.

_getRequiredTags ( )

Returns all tags requested from the XML feed

Returns: array private

Definition at line 520 of file data_source_xml.inc.

characterData	(	$parser,
		$data
	)

Handles the data

Parameters

object	$parser	the xml parser
string	$data	data inside the element

Returns: void public

Definition at line 445 of file data_source_xml.inc.

endElement	(	$parser,
		$name
	)

Handles the end of an element

Parameters

object	$parser	the xml parser
string	$name	name of the element

Returns: void public

Definition at line 495 of file data_source_xml.inc.

getDynamicVariableValue ( $variable_name )

Get a value of a dynamic variable

Parameters

string $variable_name Name of variable

Returns: string public

Definition at line 597 of file data_source_xml.inc.

getItems ( )

Returns an array of the result by parsing the XML feed

Returns: array public

Definition at line 202 of file data_source_xml.inc.

getResultSet ( )

Returns an array of the result of XML parsing either from cache or by parsing the file again

Returns: array public

Definition at line 166 of file data_source_xml.inc.

getURLString ( )

Returns the XML Feed URL for the XML datasource

Returns: string public

Definition at line 582 of file data_source_xml.inc.

getXMLContent ( )

Returns the processed content of XML feed

Returns: string public

Definition at line 278 of file data_source_xml.inc.

openFeed ( $url )

Uses HTTP_Client to send a GET request to the URL provided

Parameters

string $url The url where the feed is located

Returns: mixed array|boolean public

if (preg_match('/^[45].*?/', $result)) { trigger_localised_error('CMS0064', E_USER_WARNING, $result, $url); unset($HTTP_Client); return FALSE; }

Definition at line 218 of file data_source_xml.inc.

parseXML ( )

Sends GET request and calls the parsing process

Returns: mixed array|boolean public

Definition at line 260 of file data_source_xml.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 671 of file data_source_xml.inc.

printFrontend ( )

Prints out the Frontend for this asset

Returns: void public

Definition at line 648 of file data_source_xml.inc.

startElement	(	$parser,
		$name,
		$attributes = `FALSE`
	)

Handles the start of an element

Parameters

object	$parser	the xml parser
string	$name	name of the element
array	$attributes	the attributes

Returns: void public

Definition at line 381 of file data_source_xml.inc.

Field Documentation

$_complex_elements = Array()

protected

Array to store info about if the element nests other non-text elements

Definition at line 121 of file data_source_xml.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/data/data_source_xml/data_source_xml.inc

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation