Algo-Web / POData-Laravel

src/Interfaces/AuthInterface.php

<?php

declare(strict_types=1);

namespace AlgoWeb\PODataLaravel\Interfaces;

use AlgoWeb\PODataLaravel\Enums\ActionVerb;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Relation;

interface AuthInterface
{

    /**
     * Is the requester permitted to perform the requested action on the model class (and instance, if supplied)?
     *
     * @param ActionVerb          $verb
     * @param class-string|null   $modelname Model class to access

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

     * @param Model|Relation|null $model     Specific eloquent model to access
     *
     * @return bool
     */
    public function canAuth(ActionVerb $verb, $modelname, $model = null);
}