Inheritance diagram for Soap_Api_Asset_Service:

Public Member Functions
	__construct ($assetid=0)

	getFunctionList ()

	CreateAsset ($request)

	GetAsset ($request)

	GetAssetURLs ($request)

	GetAssetFromURL ($request)

	GetAssetAvailableStatuses ($request)

	SetAttributeValue ($request)

	TrashAsset ($request)

	CloneAsset ($request)

	GetAssetTypeAttribute ($request)

	GetAssetTypeDescendants ($request)

	GetAssetsInfo ($request)

	GetAssetAvailableKeywords ($request)

	GetAssetWebPaths ($request)

	GetPageContents ($request)

	GetAttributeValuesByName ($request)

	SetTag ($request)

	GetAllStatuses ($request)

	LoginUser ($request)

	GetUserIdByUsername ($request)

	SetAssetStatus ($request)

	SetAssetWebPaths ($request)

Static Public Member Functions
static	getComplexElements ($func_list=Array())

static	getComplexTypes ($func_list=Array())

static	getSimpleRestrictedTypes ($func_list=Array())

Detailed Description

Definition at line 33 of file soap_api_asset_service.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 43 of file soap_api_asset_service.inc.

Member Function Documentation

CloneAsset ( $request )

Description: This operation will clone an asset to a specified location

Parameters

string $request The request information

Array (
    'AssetID'           => [The ID of the asset in query],
    'NumberOfClone'     => [How many new clone assets]
    'NewParentID'       => [The new parent]
    'NumberOfClone'     => [Number of asset to be cloned],
       )

Returns: void public

Definition at line 524 of file soap_api_asset_service.inc.

CreateAsset ( $request )

Description: This operation will create an asset of a specific type under a specific location

Parameters

array

$request

The request information

Array (
       'TypeCode'               => [type code of new asset],
       'Name'                   => [name for new asset],
       'ParentID'               => [parentid of the new parent],
       'LinkType'               => [LinkType],
       'LinkValue'          => [link value],
       'SortOrder'          => [link sort order],
       'IsDependant'            => [0|1],
       'IsExclusive'            => [0|1],
       'FileName'               => [name of the file],
       'FileContentBase64'  => [base64 encoded file content],
       'AttributeInfo'      => [attribute name/value pairs]
       )

Returns: void public

Definition at line 109 of file soap_api_asset_service.inc.

GetAllStatuses ( $request )

Description: This operation will return all statuses of the asset in Matrix

Parameters

string $request The request information

Returns: void public

Definition at line 1034 of file soap_api_asset_service.inc.

GetAsset ( $request )

Description: This operation will return an asset object based on assetid

Parameters

array

$request

The request information

Array (
     'AssetID'      => [Asset ID of the asset in query],
       )

Returns: void public

Definition at line 223 of file soap_api_asset_service.inc.

GetAssetAvailableKeywords ( $request )

Description: This operation will return all available keywords of an asset

Parameters

string $request The request information

Array (
    'AssetID' => [The ID of the asset in query],
        'TypeCode' => [The type code of asset],
      )

Returns: void public

Definition at line 795 of file soap_api_asset_service.inc.

GetAssetAvailableStatuses ( $request )

Description: This operation will return all available statuses of an asset based on assetid

Parameters

string $request The request information

Array (
     'AssetID'   => [The ID of the asset in query],
       )

Returns: void public

Definition at line 395 of file soap_api_asset_service.inc.

GetAssetFromURL ( $request )

Description: This operation will return an asset object based on a URL

Parameters

string $request The request information

Array (
     'URL'   => [The URL belongs to the asset being searched for],
       )

Returns: void public

Definition at line 356 of file soap_api_asset_service.inc.

GetAssetsInfo ( $request )

This function return the asset information (name, typecode, children assets, lineage) about the requested asset.

Parameters

$request

Returns: void

Definition at line 688 of file soap_api_asset_service.inc.

GetAssetTypeAttribute ( $request )

Description: This operation will return all attributes belong to an asset type

Parameters

string $request The request information

Array (
    'TypeCode'          => [The ID of the asset in query],
    'AttributeDetail'   => [The Details of the attribute],
       )

Returns: void public

Definition at line 589 of file soap_api_asset_service.inc.

GetAssetTypeDescendants ( $request )

Description: This operation will return all the type descendants of an asset type.

Returns: void

Definition at line 665 of file soap_api_asset_service.inc.

GetAssetURLs ( $request )

Description: This operation will return all URLs associated with an asset

Parameters

string $request The request information

Array (
     'AssetID'   => [The asset id we are trying to get url for],
       )

Returns: void public

Definition at line 306 of file soap_api_asset_service.inc.

GetAssetWebPaths ( $request )

Description: This operation will return all webpaths belong to an asset

Parameters

string $request The request information

Array (
    'AssetID'           => [The ID of the asset in query],
       )

Returns: void public

Definition at line 838 of file soap_api_asset_service.inc.

GetAttributeValuesByName ( $request )

Description: This operation will return all attributes belong to an asset type classified by attribute name

Parameters

string $request The request information

Array (
    'AssetIDs'          => [The ID of the asset in query],
    'AttributeName'     => [The Name of the attribute in query],
    'TypeCode'          => [The Type Code of the asset],
       )

Returns: array public

Definition at line 924 of file soap_api_asset_service.inc.

static getComplexElements ( $func_list = Array() )

static

getComplexElements

Returns: array public

Definition at line 1247 of file soap_api_asset_service.inc.

static getComplexTypes ( $func_list = Array() )

static

getComplexTypes: return all the complex types used by the API

Returns: array public

Definition at line 1485 of file soap_api_asset_service.inc.

getFunctionList ( )

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

Returns: string private

See Also: Asset::_getName()

Definition at line 57 of file soap_api_asset_service.inc.

GetPageContents ( $request )

This function return the page contents for

Returns: array public

Definition at line 861 of file soap_api_asset_service.inc.

static getSimpleRestrictedTypes ( $func_list = Array() )

static

getSimpleRestrictedTypes

Returns: array public

Definition at line 1558 of file soap_api_asset_service.inc.

GetUserIdByUsername ( $request )

Description: This operation will return the user asset ID of the request username

Parameters

string $request The request information

Returns: void public

Definition at line 1119 of file soap_api_asset_service.inc.

LoginUser ( $request )

Description: This operation will return all statuses of the asset in Matrix

Parameters

string $request The request information

Returns: void public

Definition at line 1061 of file soap_api_asset_service.inc.

SetAssetStatus ( $request )

Description: This operation will set status for an asset

Parameters

string $request The request information

Array (
    'AssetID'           => [The ID of the asset in query],
    'StatusValue'       => [The asset status to be set],
    'DependantsOnly'    => [Cascade the change to children or just dependants?],
       )

Returns: void public

Definition at line 1169 of file soap_api_asset_service.inc.

SetAssetWebPaths ( $request )

Description: This operation will set multiple paths for an asset

Parameters

string $request The request information

Array (
        'AssetID'           => [The ID of the asset in query],
       )

Returns: void public

Definition at line 1220 of file soap_api_asset_service.inc.

SetAttributeValue ( $request )

Description: This operation will return set the attribute value of an asset based on assetid and attribute name

Parameters

string $request The request information

Array (
    'AssetID'           => [The ID of the asset in query],
        'AttributeName'     => [The name of the attribute],
        'AttributeValue'    => [The new value of the attribute],
       )

Returns: void public

Definition at line 436 of file soap_api_asset_service.inc.

SetTag ( $request )

Description: This operation will set tag for an asset

Parameters

string $request The request information

Array (
    'AssetIDs'          => [The ID of the asset in query],
    'ThesaurusID'       => [The ID of the thesaurus where the tag is from],
    'TagName'           => [The tag name]
    'Weight'            => [Weight of the tag on the asset]
    'CascadeTagChange   => [Cascade the tag to all children]
       )

Returns: void public

Definition at line 968 of file soap_api_asset_service.inc.

TrashAsset ( $request )

Description: This operation will send an asset to the trash

Parameters

string $request The request information

Array (
    'AssetID'           => [The ID of the asset in query],
       )

Returns: void public

Definition at line 477 of file soap_api_asset_service.inc.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation