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

Public Member Functions

 __construct ($config, $soap)
 listVideoArchiveChannels ($token, $channel=null, $start_date=null, $end_date=null, $title=null)
 listVideoArchiveRecords ($token, $first_record=null, $record_count=null, $channel=null, $start_date=null, $end_date=null, $title=null)
 countVideoArchiveRecords ($token, $channel=null, $start_date=null, $end_date=null, $title=null)

Data Fields

 $soap

Protected Member Functions

 videoArchiveBuildSQLQuery ($first_record=null, $record_count=null, $channel=null, $start_date=null, $end_date=null, $title=null)

Protected Attributes

 $config = null

Constructor & Destructor Documentation

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

countVideoArchiveRecords ( token,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Count the number of available Records from the video archive

Parameters:
string$tokenThe session identifier
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
int
listVideoArchiveChannels ( token,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Get the list of available Channels from the video archive (channels that have records)

Parameters:
string$tokenThe session identifier
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
string[]
listVideoArchiveRecords ( token,
first_record = null,
record_count = null,
channel = null,
start_date = null,
end_date = null,
title = null 
)

Get the list of available Records from the video archive

Parameters:
string$tokenThe session identifier
int$first_recordNumber of the first record to return (default 0) [OPTIONAL]
int$record_countNumber of records to return (default all) [OPTIONAL]
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
VideoArchiveRecord[]
videoArchiveBuildSQLQuery ( first_record = null,
record_count = null,
channel = null,
start_date = null,
end_date = null,
title = null 
) [protected]

Build the SQL query for Vide Archive Access

Parameters:
int$first_recordNumber of the first record to return (default 0) [OPTIONAL]
int$record_countNumber of records to return (default all) [OPTIONAL]
string$channelChannel name (* wildcard supported) [OPTIONAL]
int$start_dateStart date (unix timestamp) [OPTIONAL]
int$end_dateEnd date (unix timestamp) [OPTIONAL]
string$titleProgram title (* wildcard supported) [OPTIONAL]
Returns:
string

Field Documentation

$config = null [protected]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


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