dev-think-one / laravel-notification-tracker

src/NotificationTracker.php

<?php

namespace NotificationTracker;

use Illuminate\Database\Eloquent\Model;
use NotificationTracker\Models\TrackedChannel;
use NotificationTracker\Models\TrackedNotification;

class NotificationTracker
{
    public static bool $runsMigrations = true;

    public static bool $registersRoutes = true;

    public static array $classMap = [];

    protected static array $models = [
        'notification' => TrackedNotification::class,
        'channel'      => TrackedChannel::class,
    ];


    public static function ignoreMigrations(): static
    {
        static::$runsMigrations = false;

        return new static;
    }

    public static function ignoreRoutes(): static
    {
        static::$registersRoutes = false;

        return new static;
    }

    /**
     * @param array|null $map
     * @param bool $merge Merge or replace class map.
     * @return array
     */
    public static function classMap(array $map = null, bool $merge = true): array
    {
        if (is_array($map)) {
            static::$classMap = $merge && static::$classMap
                ? $map + static::$classMap : $map;
        }

        return static::$classMap;
    }

    /**
     * @param string $alias
     * @return string|null
     */
    public static function getMappedClass(string $alias): ?string
    {
        return static::$classMap[$alias] ?? null;
    }

    /**
     * @param string $class
     * @return string
     */
    public static function getMapAlias(string $class): string
    {
        $morphMap = static::$classMap;

        if (
            !empty($morphMap) &&
            ($found = array_search($class, $morphMap, true))
        ) {
            return $found;
        }

        return $class;
    }

    /**
     * @param string $key
     * @param string $modelClass
     * @return class-string<static>

The doc comment class-string<static> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<static>.

     * @throws \Exception
     */
    public static function useModel(string $key, string $modelClass): string
    {
        if (!in_array($key, array_keys(static::$models))) {
            throw new \Exception(
                "Incorrect model key [{$key}], allowed keys are: " . implode(', ', array_keys(static::$models))
            );
        }
        if (!is_subclass_of($modelClass, Model::class)) {
            throw new \Exception("Class should be a model [{$modelClass}]");
        }

        static::$models[$key] = $modelClass;

        return static::class;
    }

    /**
     * @param string $key
     * @return class-string<Model|TrackedNotification|TrackedChannel>

The doc comment class-string<Model|TrackedNotification|TrackedChannel> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Model|TrackedNotification|TrackedChannel>.

     * @throws \Exception
     */
    public static function modelClass(string $key): string
    {
        return static::$models[$key] ?? throw new \Exception(
            "Incorrect model key [{$key}], allowed keys are: " . implode(', ', array_keys(static::$models))
        );
    }

    /**
     * @param string $key
     * @param array $attributes
     * @return Model|TrackedNotification|TrackedChannel
     * @throws \Exception
     */
    public static function model(string $key, array $attributes = []): Model
    {
        $modelClass = static::modelClass($key);

        /** @var Model $model */
        $model = new $modelClass($attributes);

        return $model;
    }

    public static function trackHeaderName(): string
    {
        return 'X-Notification-Track';
    }

    public static function clickTrackerUrlParameterName(): string
    {
        return 'u';
    }

    public static function pixelFilePath(): string
    {
        return __DIR__ . '/../resources/images/pixel.gif';
    }
}