Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaVirage Class Reference
Inheritance diagram for tariqaVirage:
Tariqa

Public Member Functions

 __construct ($config, $soap)
 VirageSearch ($token, $query)
 VirageSearch2 ($token, $query, $getImages=false)
 VirageGetDocument ($token, $document_id, $getImages)
 VirageGetDocumentImages ($token, $document_id)
 VirageGetFullText ($token, $document_id, $document=null)
 VirageGetWords ($token, $document_id, $complete=null, $document=null)
 GetVirageDocumentImage ($token, $document_id, $index, $type, $getContent=true, $cache=false, $document=null)
 VirageGetDocumentHeadlines ($token, $document_id, $document=null, $limit=10)
 VirageGetDocumentAllImages ($token, $document_id, $type, $getContent, $cache, $document=null)

Data Fields

 $soap

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

GetVirageDocumentImage ( token,
document_id,
index,
type,
getContent = true,
cache = false,
document = null 
)

Gets a single image from a Virage document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
int$indexThe image index
string$typeThe type of image to retrieve (small or big)
boolean$getContentIf set to false, do not retrieve the image content [OPTIONAL]
boolean$cacheIf set to true, also cache the image [OPTIONAL]
VirageDocument$documentThe Virage document [OPTIONAL] public
Returns:
VirageDocumentImage
VirageGetDocument ( token,
document_id,
getImages 
)

Get a Virage document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
boolean$getImagesIf true, then it also returns the document images
Returns:
VirageDocument
VirageGetDocumentAllImages ( token,
document_id,
type,
getContent,
cache,
document = null 
)

Gets all the images from a document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
string$typeThe type of image to retrieve (small or big)
boolean$getContentIf set to false, do not retrieve the image content [OPTIONAL]
boolean$cacheIf set to true, also cache the image [OPTIONAL]
VirageDocument$documentThe document [OPTIONAL] public
Returns:
VirageDocumentImage[]
VirageGetDocumentHeadlines ( token,
document_id,
document = null,
limit = 10 
)

Gets all the headlines of a video document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
VirageDocument$documentThe document [OPTIONAL]
int$limitThe limit of characters for a headline [OPTIONAL] public
Returns:
VirageHeadline[]
VirageGetDocumentImages ( token,
document_id 
)

Get a Virage document images by calling the private method _VirageGetDocumentImages (this does not require authentication)

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
Returns:
VirageDocumentImages
VirageGetFullText ( token,
document_id,
document = null 
)

Get the full text of a video document

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
VirageDocument$documentThe document [OPTIONAL] public
Returns:
string
VirageGetWords ( token,
document_id,
complete = null,
document = null 
)

Gets the list of words

Parameters:
string$tokenThe session identifier
string$document_idThe document identifier
boolean$completeIf set to true, get the words for the entire movie [OPTIONAL]
VirageDocument$documentThe document [OPTIONAL] public
Returns:
VirageWord[]
VirageSearch ( token,
query 
)

Search for a video in the database using Virage

Parameters:
string$tokenThe session identifier
VirageSearchQuery$queryThe query to be executed
Returns:
VirageSearchResult
VirageSearch2 ( token,
query,
getImages = false 
)

Search for a video in the database using Virage and returns the complete document without the images

Parameters:
string$tokenThe session identifier
VirageSearchQuery$queryThe query to be executed
boolean$getImagesIf set to true, get the images also [OPTIONAL]
Returns:
VirageSearchResult

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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