Inheritance diagram for SOAP_Api:

Public Member Functions
	__construct ($assetid=0)

	getFunctionList ()

	array_get_index_restricted_value ($array, $index, $default_val)

	updateLookupsforAsset ($assetid)

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	getArgType ($type, $min=0, $max=1, $nillable=FALSE, $mixed=FALSE)

static	getComplexElements ($complex_elements=Array())

static	processSimpleRestrictedTypes ($simple_types=Array())

static	getSimpleRestrictedTypes ($simple_types=Array())

static	getComplexTypes ($func_list=Array())

static	getBooleanIndex ($array, $index, $default_val)

static	getNullIndex ($array, $index, $default_val)

Static Public Attributes
static	$string_non_optional

static	$string_optional

static	$string_optional_unbounded

static	$boolean_non_optional

static	$boolean_optional

static	$int_non_optional

static	$int_optional

Protected Member Functions
	_preCreateCheck (Array &$link)

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

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

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 91 of file soap_api.inc.

Member Function Documentation

_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 134 of file soap_api.inc.

_preCreateCheck ( Array & $link )

protected

Perform any pre-validation required during the creation of this asset

Pages ensure a name and short_name has been set before they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 109 of file soap_api.inc.

array_get_index_restricted_value	(	$array,
		$index,
		$default_val
	)

This function try to get an index from an array, this function will restrict the value being enter to the declared restricted values

Parameters

$array	array The array we are trying to access the index from
$index	string The index we are trying to get the data from
$default_val	mixed The default value

Returns: mixed

Definition at line 324 of file soap_api.inc.

static getArgType	(	$type,
		$min = `0`,
		$max = `1`,
		$nillable = `FALSE`,
		$mixed = `FALSE`
	)

static

This function will return an array about a particular input/output element for an operation

Parameters

$type
$min
$max
$nillable
$mixed

Returns: array public

Definition at line 178 of file soap_api.inc.

static getBooleanIndex	(	$array,
		$index,
		$default_val
	)

static

This function try to get an index from an array and cast it to boolean

Parameters

$array	array The array we are trying to access the index from
$index	string The index we are trying to get the data from
$default_val	mixed The default value

Returns: boolean

Definition at line 281 of file soap_api.inc.

static getComplexElements ( $complex_elements = Array() )

static

This function will return an array of all complex types for an API

Parameters

$complex_elements

Returns: array public

Definition at line 200 of file soap_api.inc.

static getComplexTypes ( $func_list = Array() )

static

getComplexTypes

Returns: array public

Definition at line 265 of file soap_api.inc.

getFunctionList ( )

Returns a function list of the asset let the children handle this

Returns: string private

See Also: Asset::_getName()

Definition at line 160 of file soap_api.inc.

static getNullIndex	(	$array,
		$index,
		$default_val
	)

static

This function try to get an index from an array, if it is empty return NULL

Parameters

$array	array The array we are trying to access the index from
$index	string The index we are trying to get the data from
$default_val	mixed The default value

Returns: mixed

Definition at line 304 of file soap_api.inc.

static getSimpleRestrictedTypes ( $simple_types = Array() )

static

This function will return an array of all simple types for an API

Parameters

$simple_types

Returns: array public

Definition at line 253 of file soap_api.inc.

static processSimpleRestrictedTypes ( $simple_types = Array() )

static

This function take in a list of simpleTypes from each child asset and merge them

Returns: array public

Definition at line 226 of file soap_api.inc.

updateLookupsforAsset ( $assetid )

updates the lookup of the assetid passed and all its childrens, (runs freestyle HIPO)

Returns: assetid public

Definition at line 347 of file soap_api.inc.

Field Documentation

$boolean_non_optional

static

Initial value:

= Array (
                                                'type'      => 'boolean',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 55 of file soap_api.inc.

$boolean_optional

static

Initial value:

= Array (
                                                'type'      => 'boolean',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 62 of file soap_api.inc.

$int_non_optional

static

Initial value:

= Array (
                                                'type'      => 'int',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 69 of file soap_api.inc.

$int_optional

static

Initial value:

= Array (
                                                'type'      => 'int',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 76 of file soap_api.inc.

$string_non_optional

static

Initial value:

= Array (
                                                'type'      => 'string',
                                                'min'       => 1,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 34 of file soap_api.inc.

$string_optional

static

Initial value:

= Array (
                                                'type'      => 'string',
                                                'min'       => 0,
                                                'max'       => 1,
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 41 of file soap_api.inc.

$string_optional_unbounded

static

Initial value:

= Array (
                                                'type'      => 'string',
                                                'min'       => 0,
                                                'max'       => 'unbounded',
                                                'nillable'  => FALSE,
                                                'mixed'     => FALSE,
                                              )

Definition at line 48 of file soap_api.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/web_services/api/soap_api/soap_api.inc

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation