class KalturaReportService in Kaltura 6.2

Hierarchy

• class \KalturaServiceBase
  • class \KalturaReportService

File

kaltura_client/KalturaClient.php, line 5028

class KalturaReportService extends KalturaServiceBase {
  function __construct(KalturaClient $client) {
    parent::__construct($client);
  }
  function getGraph() {
    $kparams = array();
    $this->client
      ->queueServiceActionCall("report", "getGraph", $kparams);
    if ($this->client
      ->isMultiRequest()) {
      return null;
    }
    $resultObject = $this->client
      ->doQueue();
    $this->client
      ->throwExceptionIfError($resultObject);
    $this->client
      ->validateObjectType($resultObject, "KalturaReportGraph");
    return $resultObject;
  }
  function getGraphs($reportType, KalturaReportInputFilter $reportInputFilter, $dimension = null, $objectIds = null) {
    $kparams = array();
    $this->client
      ->addParam($kparams, "reportType", $reportType);
    $this->client
      ->addParam($kparams, "reportInputFilter", $reportInputFilter
      ->toParams());
    $this->client
      ->addParam($kparams, "dimension", $dimension);
    $this->client
      ->addParam($kparams, "objectIds", $objectIds);
    $this->client
      ->queueServiceActionCall("report", "getGraphs", $kparams);
    if ($this->client
      ->isMultiRequest()) {
      return null;
    }
    $resultObject = $this->client
      ->doQueue();
    $this->client
      ->throwExceptionIfError($resultObject);
    $this->client
      ->validateObjectType($resultObject, "array");
    return $resultObject;
  }
  function getTotal($reportType, KalturaReportInputFilter $reportInputFilter, $objectIds = null) {
    $kparams = array();
    $this->client
      ->addParam($kparams, "reportType", $reportType);
    $this->client
      ->addParam($kparams, "reportInputFilter", $reportInputFilter
      ->toParams());
    $this->client
      ->addParam($kparams, "objectIds", $objectIds);
    $this->client
      ->queueServiceActionCall("report", "getTotal", $kparams);
    if ($this->client
      ->isMultiRequest()) {
      return null;
    }
    $resultObject = $this->client
      ->doQueue();
    $this->client
      ->throwExceptionIfError($resultObject);
    $this->client
      ->validateObjectType($resultObject, "KalturaReportTotal");
    return $resultObject;
  }
  function getTable($reportType, KalturaReportInputFilter $reportInputFilter, KalturaFilterPager $pager, $order = null, $objectIds = null) {
    $kparams = array();
    $this->client
      ->addParam($kparams, "reportType", $reportType);
    $this->client
      ->addParam($kparams, "reportInputFilter", $reportInputFilter
      ->toParams());
    $this->client
      ->addParam($kparams, "pager", $pager
      ->toParams());
    $this->client
      ->addParam($kparams, "order", $order);
    $this->client
      ->addParam($kparams, "objectIds", $objectIds);
    $this->client
      ->queueServiceActionCall("report", "getTable", $kparams);
    if ($this->client
      ->isMultiRequest()) {
      return null;
    }
    $resultObject = $this->client
      ->doQueue();
    $this->client
      ->throwExceptionIfError($resultObject);
    $this->client
      ->validateObjectType($resultObject, "KalturaReportTable");
    return $resultObject;
  }
  function getUrlForReportAsCsv($reportTitle, $reportText, $headers, $reportType, KalturaReportInputFilter $reportInputFilter, $dimension = null, KalturaFilterPager $pager = null, $order = null, $objectIds = null) {
    $kparams = array();
    $this->client
      ->addParam($kparams, "reportTitle", $reportTitle);
    $this->client
      ->addParam($kparams, "reportText", $reportText);
    $this->client
      ->addParam($kparams, "headers", $headers);
    $this->client
      ->addParam($kparams, "reportType", $reportType);
    $this->client
      ->addParam($kparams, "reportInputFilter", $reportInputFilter
      ->toParams());
    $this->client
      ->addParam($kparams, "dimension", $dimension);
    if ($pager !== null) {
      $this->client
        ->addParam($kparams, "pager", $pager
        ->toParams());
    }
    $this->client
      ->addParam($kparams, "order", $order);
    $this->client
      ->addParam($kparams, "objectIds", $objectIds);
    $this->client
      ->queueServiceActionCall("report", "getUrlForReportAsCsv", $kparams);
    if ($this->client
      ->isMultiRequest()) {
      return null;
    }
    $resultObject = $this->client
      ->doQueue();
    $this->client
      ->throwExceptionIfError($resultObject);
    $this->client
      ->validateObjectType($resultObject, "string");
    return $resultObject;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
KalturaReportService::getGraph		function
KalturaReportService::getGraphs		function
KalturaReportService::getTable		function
KalturaReportService::getTotal		function
KalturaReportService::getUrlForReportAsCsv		function
KalturaReportService::__construct		function	* Initialize the service keeping reference to the KalturaClient * * Overrides KalturaServiceBase::__construct
KalturaServiceBase::$client	protected	property	*