PHP Templating API: getVodAreas()
Posted by Mark [Elevated X Support], Last modified by Mark [Elevated X Support] on 30 October 2017 03:31 PM

Description:

The getVodAreas() function gets a list of areas that are present in the system which are VOD areas. Based on the arguments that are passed to it will determine which and how many areas are returned.

Sample Usage:

$areaobj = $api->getVodAreas();

$areaobj = $api->getVodAreas(["id" => 1]);

$areaobj = $api->getVodAreas([
"id" => 1,
"countonly" => 0,
]);

echo "\nNumber of areas returned: " . $areaobj->areacount;
echo "\nAreas:\n";
print_r($areaobj->area);

Returning Attributes:

This function call will return a StdObject object with the following attributes:

areas:

This is a multi-dimensional array that returns any areas that match search criteria.

areacount:

The number of areas returned.

Arguments:

id:

This filters the results by set id. If set, this will only return areas that have these specific sets.

examples:
"id" => "4,5"
"id" => [4,5]

This will show all VOD areas that either have set id 4 OR set id 5.

countonly:

If specified, only return the number of areas that fit the search criteria.



(0 vote(s))
Helpful
Not helpful

Comments (0)