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
Member Function Documentation
Count the number of available Records from the video archive
- Parameters:
-
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] |
- Returns:
- int
Get the list of available Channels from the video archive (channels that have records)
- Parameters:
-
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] |
- 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 | $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] |
- 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_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] |
- Returns:
- string
Field Documentation
$config = null [protected] |
The documentation for this class was generated from the following file: