nystudio107 / craft-instantanalytics-ga4

src/ga4/events/PageViewEvent.php

<?php
/**
 * User: Damian Zamojski (br33f)
 * Date: 25.06.2021
 * Time: 13:33
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace nystudio107\instantanalyticsGa4\ga4\events;

use Br33f\Ga4\MeasurementProtocol\Dto\Event\BaseEvent;
use Br33f\Ga4\MeasurementProtocol\Dto\Parameter\AbstractParameter;
use Br33f\Ga4\MeasurementProtocol\Enum\ErrorCode;
use Br33f\Ga4\MeasurementProtocol\Exception\ValidationException;

/**
 * Class PageViewEvent
 *
 * @method string getPageTitle()
 * @method string getPageLocation()
 * @method PageViewEvent setPageTitle(string $title)
 * @method PageViewEvent setPageLocation(string $url)
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class PageViewEvent extends BaseEvent
{
    private $eventName = 'page_view';

Private member variable "eventName" must be prefixed with an underscore

    /**
     * PageViewEvent constructor.
     * @param AbstractParameter[] $paramList

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

     */
    public function __construct(array $paramList = [])
    {
        parent::__construct($this->eventName, $paramList);
    }

    public function validate()

Missing doc comment for function validate()

    {
        parent::validate();

        if (empty($this->getPageTitle())) {
            throw new ValidationException('Field "page_title" is required.', ErrorCode::VALIDATION_FIELD_REQUIRED, 'page_title');
        }

        if (empty($this->getPageLocation())) {
            throw new ValidationException('Field "page_location" is required if "value" is set', ErrorCode::VALIDATION_FIELD_REQUIRED, 'page_location');
        }

        return true;
    }
}