php-casbin / php-casbin

src/Persist/FilteredAdapter.php

<?php

declare(strict_types=1);

namespace Casbin\Persist;

use Casbin\Model\Model;

/**
 * Interface FilteredAdapter.
 * the filtered file adapter for Casbin. It can load policy from file or save policy to file and supports loading of filtered policies.
 *
 * @author techlee@qq.com
 */
interface FilteredAdapter extends Adapter
{
    /**

Parameter $filter should have a doc-comment as per coding-style.

     * loads only policy rules that match the filter.
     *
     * @param Model $model

Expected 2 spaces after parameter type; 1 found

     * @param $filter

Missing parameter name

     */
    public function loadFilteredPolicy(Model $model, $filter): void;

    /**
     * returns true if the loaded policy has been filtered.
     *
     * @return bool
     */
    public function isFiltered(): bool;
}