cybercog / laravel-optimus

src/Traits/OptimusEncodedRouteKey.php

<?php

namespace Cog\Laravel\Optimus\Traits;

trait OptimusEncodedRouteKey
{
    /**
     * Get the value of the model's route key.
     *
     * @return mixed
     */
    public function getRouteKey()
    {
        $id = parent::getRouteKey();

        return $this->getOptimus()->encode($id);

The method encode() does not exist on Cog\Laravel\Optimus\OptimusManager. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * Retrieve the model for a bound value.
     *
     * @param mixed $value
     * @param string|null $field
     * @return \Illuminate\Database\Eloquent\Model|null
     */
    public function resolveRouteBinding($value, $field = null)
    {
        if ($field === null) {
            $field = $this->getRouteKeyName();

The method getRouteKeyName() does not exist on Cog\Laravel\Optimus\Traits\OptimusEncodedRouteKey. Did you maybe mean getRouteKey()?

        }

        if (is_string($value) && ctype_digit($value)) {
            $value = (int) $value;
        }

        if (is_int($value) && $field === $this->getRouteKeyName()) {
            $value = $this->getOptimus()->decode($value);

The method decode() does not exist on Cog\Laravel\Optimus\OptimusManager. Since you implemented __call, consider adding a @method annotation.

        }

        return $this->where($field, $value)->first();

It seems like where() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Retrieve the model for a bound value.
     *
     * @param  \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Relations\Relation  $query
     * @param  mixed  $value
     * @param  string|null  $field
     * @return \Illuminate\Database\Eloquent\Relations\Relation
     */
    public function resolveRouteBindingQuery($query, $value, $field = null)
    {
        if ($field === null) {
            $field = $query->getRouteKeyName();
        }

        if (is_string($value) && ctype_digit($value)) {
            $value = (int) $value;
        }

        if (is_int($value) && $field === $this->getRouteKeyName()) {
            $value = $this->getOptimus()->decode($value);
        }

        return $query->where($field, $value);

The expression return $query->where($field, $value) also could return the type Illuminate\Database\Eloquent\Builder|Illuminate\Database\Eloquent\PendingHasThroughRelationship which is incompatible with the documented return type Illuminate\Database\Eloquent\Relations\Relation.

    }

    /**
     * Get the Optimus instance.
     *
     * @return \Cog\Laravel\Optimus\OptimusManager
     */
    protected function getOptimus()
    {
        $connection = null;

        if (property_exists($this, 'optimusConnection')) {
            $connection = $this->optimusConnection;
        }

        return app('optimus')->connection($connection);
    }
}