# metricool/2.1.1/app/Features/Onboarding/OnboardingService.php

Metricool – Social media and site statistics, version 2.1.1. 105 lines.

- Page: https://pluginprobe.com/plugins/metricool/2.1.1/code/app/Features/Onboarding/OnboardingService.php
- Raw: https://pluginprobe.com/plugins/metricool/2.1.1/raw/app/Features/Onboarding/OnboardingService.php
- Modified: 2026-08-20T14:08:30+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/metricool/2.1.1/code/app/Features/Onboarding/OnboardingService.php#L10-L20`.

```php
<?php

namespace Metricool\Features\Onboarding;

use Metricool\Http\Metricool\Exceptions\ApiException;
use Metricool\Features\Onboarding\Exceptions\BrandAccessDeniedException;
use Metricool\Http\Metricool\MetricoolApi;
use Metricool\Services\DashboardService;
use Metricool\Services\MetricoolAccountService;
use Metricool\Services\TrackingScriptService;

class OnboardingService
{
    private MetricoolApi $api;
    private TrackingScriptService $tracking;
    private DashboardService $dashboard;
    private MetricoolAccountService $account;

    public function __construct(MetricoolApi $api, TrackingScriptService $tracking, DashboardService $dashboard, MetricoolAccountService $account)
    {
        $this->api = $api;
        $this->tracking = $tracking;
        $this->dashboard = $dashboard;
        $this->account = $account;
    }

    /**
     * Attempt to finish the onboarding process. When the necessary information is provided or retrieved,
     * set the onboarding as completed.
     *
     * @throws BrandAccessDeniedException
     * @throws ApiException
     */
    public function finalizeOnboarding(?string $blogId = null): bool
    {
        if ($blogId !== null) {
            // When a blogId is provided, try to connect to the brand
            $this->connectBrand($blogId);
        }

        // If the blogId is not set, the onboarding is not completed
        if ($this->api->hasBlogId() === false) {
            return false;
        }

        // Update the metricool user data from the API
        $this->account->fetch();

        // When all the necessary information is retrieved, set the onboarding as completed
        return $this->dashboard->setOnboardingCompleted();
    }

    /**
     * A brand is connected when it's retrieved from the API and the tracking hash is activated. The blogId is stored for future API calls.
     *
     * @throws BrandAccessDeniedException
     * @throws ApiException
     */
    private function connectBrand(string $blogId): void
    {
        try {
            $brand = $this->api->brands()->get($blogId);
        } catch (ApiException $e) {
            if ($e->getCode() === 403) {
                throw new BrandAccessDeniedException();
            }
            throw $e;
        }

        if (!$this->brandCanBeConnected($brand)) {
            throw new BrandAccessDeniedException();
        }

        $this->activateTrackingHash($brand);
        $this->api->storeBlogId($blogId);
    }

    /**
     * A brand can only be connected by its owner or by a user whose brand
     * role includes the editBrand permission. This is the same capability
     * the Metricool API validates when linking a site to a brand.
     */
    private function brandCanBeConnected(array $brand): bool
    {
        if (isset($brand['ownerUserId']) && (string) $brand['ownerUserId'] === $this->api->getUserId()) {
            return true;
        }

        return isset($brand['brandRole']['actions']['editBrand']) && $brand['brandRole']['actions']['editBrand'] === true;
    }

    /**
     * Activate the tracking hash for the given brand and store it in the database
     */
    private function activateTrackingHash(array $brand): void
    {
        $trackingId = isset($brand['hash']) ? (string) $brand['hash'] : null;

        if ($trackingId !== null) {
            $this->tracking->storeTrackingHash($trackingId)
                ->activateTrackingWidget();
        }
    }
}

```