Class tariqaVideoArchive

Description

Located in /Tariqa.code/tariqaVideoArchive.class.php (line 2)

Tariqa
   |
   --tariqaVideoArchive
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
int countVideoArchiveRecords (string $token, [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
string[] listVideoArchiveChannels (string $token, [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
VideoArchiveRecord[] listVideoArchiveRecords (string $token, [int $first_record = null], [int $record_count = null], [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
string videoArchiveBuildSQLQuery ([int $first_record = null], [int $record_count = null], [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
Variables
array $config = null (line 7)

Configuration array

  • access: protected
boolean $soap (line 13)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 20)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
countVideoArchiveRecords (line 122)

Count the number of available Records from the video archive

  • access: public
int countVideoArchiveRecords (string $token, [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
  • string $token: The session identifier
  • string $channel: Channel name (* wildcard supported) [OPTIONAL]
  • int $start_date: Start date (unix timestamp) [OPTIONAL]
  • int $end_date: End date (unix timestamp) [OPTIONAL]
  • string $title: Program title (* wildcard supported) [OPTIONAL]
listVideoArchiveChannels (line 35)

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

  • access: public
string[] listVideoArchiveChannels (string $token, [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
  • string $token: The session identifier
  • string $channel: Channel name (* wildcard supported) [OPTIONAL]
  • int $start_date: Start date (unix timestamp) [OPTIONAL]
  • int $end_date: End date (unix timestamp) [OPTIONAL]
  • string $title: Program title (* wildcard supported) [OPTIONAL]
listVideoArchiveRecords (line 75)

Get the list of available Records from the video archive

  • access: public
VideoArchiveRecord[] listVideoArchiveRecords (string $token, [int $first_record = null], [int $record_count = null], [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
  • string $token: The session identifier
  • int $first_record: Number of the first record to return (default 0) [OPTIONAL]
  • int $record_count: Number of records to return (default all) [OPTIONAL]
  • string $channel: Channel name (* wildcard supported) [OPTIONAL]
  • int $start_date: Start date (unix timestamp) [OPTIONAL]
  • int $end_date: End date (unix timestamp) [OPTIONAL]
  • string $title: Program title (* wildcard supported) [OPTIONAL]
videoArchiveBuildSQLQuery (line 159)

Build the SQL query for Vide Archive Access

  • access: protected
string videoArchiveBuildSQLQuery ([int $first_record = null], [int $record_count = null], [string $channel = null], [int $start_date = null], [int $end_date = null], [string $title = null])
  • int $first_record: Number of the first record to return (default 0) [OPTIONAL]
  • int $record_count: Number of records to return (default all) [OPTIONAL]
  • string $channel: Channel name (* wildcard supported) [OPTIONAL]
  • int $start_date: Start date (unix timestamp) [OPTIONAL]
  • int $end_date: End date (unix timestamp) [OPTIONAL]
  • string $title: Program title (* wildcard supported) [OPTIONAL]

Documentation generated on Thu, 10 Dec 2009 15:21:53 +0100 by phpDocumentor 1.4.1