Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions | Static Public Member Functions
Soap_Api_File_Retrieval_Service Class Reference
Inheritance diagram for Soap_Api_File_Retrieval_Service:

Public Member Functions

 __construct ($assetid=0)
 
 getFunctionList ()
 
 Download ($request)
 
 GetFileInformation ($request)
 
 GetImageInformation ($request)
 
 Upload ($request)
 

Static Public Member Functions

static getRandomFilename ($file_name)
 
static getComplexElements ($func_list=Array())
 
static getSimpleRestrictedTypes ($func_list=Array())
 

Detailed Description

Definition at line 31 of file soap_api_file_retrieval_service.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 41 of file soap_api_file_retrieval_service.inc.

Member Function Documentation

Download (   $request)

Description: This operation allow transfer of file with content base64 encoded

Parameters
array$requestThe request information 
Array (
     'AssetID'   => [The AssetID of the file to download],
       )
Returns
void public

Definition at line 80 of file soap_api_file_retrieval_service.inc.

static getComplexElements (   $func_list = Array())
static

getComplexElements

Returns
array public

Definition at line 305 of file soap_api_file_retrieval_service.inc.

GetFileInformation (   $request)

Description: This operation return the information about the file based on the assetid

Parameters
array$requestThe request information 
Array (
     'AssetID'   => [The AssetID of the file to get information for],
       )
Returns
void public

Definition at line 142 of file soap_api_file_retrieval_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 55 of file soap_api_file_retrieval_service.inc.

GetImageInformation (   $request)

Description: This operation return the information about the image on the assetid

Parameters
array$requestThe request information 
Array (
       'AssetID'   => [The AssetID of the image to get information for],
       )
Returns
void public

Definition at line 182 of file soap_api_file_retrieval_service.inc.

static getRandomFilename (   $file_name)
static

getRandomFileName get a random filename for the file being uploaded

Parameters
string$file_nameThe original name of the file
Returns
string public

Definition at line 288 of file soap_api_file_retrieval_service.inc.

static getSimpleRestrictedTypes (   $func_list = Array())
static

getSimpleRestrictedTypes

Returns
array public

Definition at line 375 of file soap_api_file_retrieval_service.inc.

Upload (   $request)

Description: This operation allow upload of file into an existing File Asset

Parameters
array$requestThe request information 
Array (
    'AssetID'           => [The AssetID of the file asset to upload the file into],
        'FileContentBase64' => [The content of the file base64 encoded],
        'FileName'          => [The name of the file being uploaded],
       )
Returns
void public

Definition at line 223 of file soap_api_file_retrieval_service.inc.

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