sprocketbox / eloquent-identity

src/IdentityManager.php

<?php

namespace Sprocketbox\Eloquent\Identity;

use Illuminate\Database\Eloquent\Model;

/**
 * Eloquence
 *
 * @package Sprocketbox\Eloquent\Identity
 */
class IdentityManager
{
    /**
     * The current instance.
     *
     * @var \Sprocketbox\Eloquent\Identity\IdentityManager
     */
    protected static IdentityManager $instance;

This code did not parse for me. Apparently, there is an error somewhere around this line:

Syntax error, unexpected T_STRING, expecting T_FUNCTION or T_CONST

    /**
     * Get the current Eloquence instance.
     *
     * @return \Sprocketbox\Eloquent\Identity\IdentityManager
     */
    public static function getInstance(): IdentityManager
    {
        if (! isset(self::$instance)) {
            self::$instance = new static;
        }

        return self::$instance;
    }

    /**
     * The identity map for models, mapped as identity => model
     *
     * @var array<string, Model>
     */
    protected array $models = [];

    /**
     * Check if the identity is already stored.
     *
     * @param \Sprocketbox\Eloquent\Identity\ModelIdentity $identity
     *
     * @return bool
     */
    public function hasIdentity(ModelIdentity $identity): bool
    {
        return isset($this->models[$this->getStringIdentity($identity)]);
    }

    /**
     * Get the stored model for the given identity.
     *
     * @param \Sprocketbox\Eloquent\Identity\ModelIdentity $identity
     *
     * @return \Illuminate\Database\Eloquent\Model|null
     */
    public function getIdentity(ModelIdentity $identity): ?Model
    {
        return $this->models[$this->getStringIdentity($identity)] ?? null;
    }

    /**
     * Set the model for the current identity.
     *
     * @param \Sprocketbox\Eloquent\Identity\ModelIdentity $identity
     * @param \Illuminate\Database\Eloquent\Model          $model
     *
     * @return $this
     */
    public function storeIdentity(ModelIdentity $identity, Model $model): IdentityManager
    {
        $this->models[$this->getStringIdentity($identity)] = $model;

        return $this;
    }

    /**
     * Remove a model from the identity map.
     *
     * @param \Sprocketbox\Eloquent\Identity\ModelIdentity $identity
     *
     * @return $this
     */
    public function removeIdentity(ModelIdentity $identity): IdentityManager
    {
        if ($this->hasIdentity($identity)) {
            unset($this->models[$this->getStringIdentity($identity)]);
        }

        return $this;
    }

    /**
     * Remove all models from the identity map.
     *
     * @return $this
     */
    public function flushIdentities(): IdentityManager
    {
        $this->models = [];

        return $this;
    }

    /**
     * Get all stored identities.
     *
     * @return array
     */
    public function allIdentities(): array
    {
        return $this->models;
    }

    /**
     * Turn the model identity into a string.
     *
     * @param \Sprocketbox\Eloquent\Identity\ModelIdentity $identity
     *
     * @return string
     */
    protected function getStringIdentity(ModelIdentity $identity): string
    {
        return (string) $identity;
    }
}