<?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\ProfessionalServices;

use Piwik\Piwik;
use Piwik\Plugins\ProfessionalServices\Widgets\DismissibleWidget;
use Piwik\Request;

/**
 * Provides API methods for Professional Services widgets and prompts.
 *
 * @method static \Piwik\Plugins\ProfessionalServices\API getInstance()
 */
class API extends \Piwik\Plugin\API
{
    /**
     * @var PromoWidgetDismissal
     */
    private $promoWidgetDismissal;

    public function __construct(PromoWidgetDismissal $promoWidgetDismissal)
    {
        $this->promoWidgetDismissal = $promoWidgetDismissal;
    }

    /**
     * Dismisses a Professional Services promo widget for the current user.
     *
     * @internal
     * @return bool Returns `true` when the widget dismissal was recorded.
     */
    public function dismissWidget(): bool
    {
        Piwik::checkUserIsNotAnonymous();

        $widgetName = Request::fromRequest()->getStringParameter('widgetName');

        if (!DismissibleWidget::exists($widgetName)) {
            throw new \Exception('Can\'t dismiss unknown widget ' . $widgetName);
        }

        $this->promoWidgetDismissal->dismissPromoWidget($widgetName);

        return true;
    }
}
