<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\Actions\Columns;

use Piwik\Tracker\Action;
use Piwik\Tracker\Request;
use Piwik\Tracker\Visitor;
use Piwik\Plugin\Dimension\ActionDimension;

class PageViewPosition extends ActionDimension
{
    protected $columnName = 'pageview_position';
    protected $nameSingular = 'Actions_ColumnPageViewPosition';
    protected $type = self::TYPE_NUMBER;

    /**
     * @return mixed|false
     */
    public function onNewAction(Request $request, Visitor $visitor, Action $action)
    {
        $shouldCount = VisitTotalInteractions::shouldCountInteraction($action);

        if ($shouldCount && $visitor->isNewVisit()) {
            return 1;
        } elseif ($shouldCount) {
            return VisitTotalInteractions::getNextInteractionPosition($request);
        }

        // we re-use same interaction position as last page view eg for events etc.
        $position = VisitTotalInteractions::getCurrentInteractionPosition($request);
        if ($position >= 1) {
            return $position;
        }

        return false;
    }
}
