ApiVideo / php-sdk

src/Api/AnalyticsVideo.php

<?php


namespace ApiVideo\Client\Api;

use ApiVideo\Client\Model\Analytic\AnalyticData;
use ApiVideo\Client\Model\Analytic\AnalyticEvent;
use ApiVideo\Client\Model\Analytic\AnalyticVideo;
use DateTime;
use Exception;

class AnalyticsVideo extends BaseApi
{
    /**
     * @param $videoId
     * @param string|null $period
     * @return AnalyticVideo|null
     */
    public function get($videoId, $period = null, array $metadata = null)
    {
        $parameters = array();
        if (null !== $period) {
            $parameters['period'] = $period;
        }


        if(null !== $metadata){
            if(!is_array($metadata)){

The condition is_array($metadata) is always true.

                throw new \InvalidArgumentException('Metadata argument must be an array');
            }

            $parameters['metadata'] = $metadata;
        }

        $response = $this->browser->get("/analytics/videos/$videoId?".http_build_query($parameters));
        if (!$response->isSuccessful()) {
            $this->registerLastError($response);

            return null;
        }

        return $this->unmarshal($response);
    }

    /**
     * @param array $parameters
     * @return AnalyticVideo[]|null
     */
    public function search(array $parameters = array())
    {
        $params             = $parameters;
        $currentPage        = isset($parameters['currentPage']) ? $parameters['currentPage'] : 1;
        $params['pageSize'] = isset($parameters['pageSize']) ? $parameters['pageSize'] : 100;
        $allAnalytics       = array();

        do {
            $params['currentPage'] = $currentPage;

            var_dump("/analytics/videos?".http_build_query($parameters));

var_dump('/analytics/videos?' . http_build_query($parameters)) looks like debug code. Are you sure you do not want to remove it?

            $response              = $this->browser->get('/analytics/videos?'.http_build_query($parameters));

            if (!$response->isSuccessful()) {
                $this->registerLastError($response);

                return null;
            }

            $json           = json_decode($response->getContent(), true);
            $analytics      = $json['data'];
            $allAnalytics[] = $this->castAll($analytics);

            if (isset($parameters['currentPage'])) {
                break;
            }

            $pagination = $json['pagination'];
            $pagination['currentPage']++;
        } while ($pagination['pagesTotal'] > $pagination['currentPage']);

        $allAnalytics = call_user_func_array('array_merge', $allAnalytics);

        return $allAnalytics;
    }

    /**
     * @param array $data
     * @return AnalyticVideo
     * @throws Exception
     */
    protected function cast(array $data)
    {
        $analytic             = new AnalyticVideo();
        $analytic->videoId    = $data['video']['video_id'];
        $analytic->videoTitle = $data['video']['title'];
        $analytic->metadata   = $data['video']['metadata'];
        $analytic->period     = $data['period'];
        // Build Analytic Data
        foreach ($data['data'] as $playerSession) {
            $analyticData = new AnalyticData();

            // Build Analytic Session
            $analyticData->session->sessionId = $playerSession['session']['session_id'];
            $analyticData->session->loadedAt  = new DateTime($playerSession['session']['loaded_at']);
            $analyticData->session->endedAt   = new DateTime($playerSession['session']['ended_at']);
            if(isset($playerSession['session']['metadatas'])){
                $analyticData->session->metadata = $playerSession['session']['metadatas'];
            }

            // Build Analytic Location
            $analyticData->location->country = $playerSession['location']['country'];
            $analyticData->location->city    = $playerSession['location']['city'];

            // Build Analytic Referrer
            $analyticData->referrer->url         = $playerSession['referrer']['url'];
            $analyticData->referrer->medium      = $playerSession['referrer']['medium'];
            $analyticData->referrer->source      = $playerSession['referrer']['source'];
            $analyticData->referrer->search_term = $playerSession['referrer']['search_term'];

            // Build Analytic Device
            $analyticData->device->type   = $playerSession['device']['type'];
            $analyticData->device->vendor = $playerSession['device']['vendor'];
            $analyticData->device->model  = $playerSession['device']['model'];

            // Build Analytic Os
            $analyticData->os->name      = $playerSession['os']['name'];
            $analyticData->os->shortname = $playerSession['os']['shortname'];
            $analyticData->os->version   = $playerSession['os']['version'];

            // Build Analytic Client
            $analyticData->client->type    = $playerSession['client']['type'];
            $analyticData->client->name    = $playerSession['client']['name'];
            $analyticData->client->version = $playerSession['client']['version'];

            // Build Analytic Events
            $analyticData->events = self::buildAnalyticEventsData($playerSession['events']);

            $analytic->data[] = $analyticData;
        }

        return $analytic;
    }

    /**
     * @param array $events
     * @return array
     * @throws Exception
     */
    private static function buildAnalyticEventsData(array $events)
    {
        $eventsBuilded = array();

        foreach ($events as $event) {
            $analyticEvent            = new AnalyticEvent();
            $analyticEvent->type      = $event['type'];
            $analyticEvent->emittedAt = new DateTime($event['emitted_at']);
            $analyticEvent->at        = isset($event['at']) ? $event['at'] : null;
            $analyticEvent->from      = isset($event['from']) ? $event['from'] : null;
            $analyticEvent->to        = isset($event['to']) ? $event['to'] : null;

            $eventsBuilded[] = $analyticEvent;
        }

        return $eventsBuilded;
    }

}