Arcanedev\LaravelPolicies\Contracts\PolicyManager

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
	policies()	0	1	?
	abilities()	0	1	?
	parsePolicies()	0	1	?
	parsePolicy()	0	1	?
	registerClass()	0	1	?
	register()	0	1	?

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelPolicies\Contracts;

use Illuminate\Support\Collection;

/**
 * Interface  PolicyManager
 *
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface PolicyManager
{
    /* -----------------------------------------------------------------
     |  Getters
     | -----------------------------------------------------------------
     */

    /**
     * Get the registered policies.
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\Policy[]|\Illuminate\Support\Collection
     */
    public function policies(): Collection;

    /**
     * Get the registered abilities.
     *
     * @return \Arcanedev\LaravelPolicies\Ability[]|\Illuminate\Support\Collection
     */
    public function abilities(): Collection;

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * @param  array  $classes
     *
     * @return \Illuminate\Support\Collection
     */
    public function parsePolicies(array $classes): Collection;

    /**
     * Parse the class into a policy instance.
     *
     * @param  string  $class
     *
     * @return \Arcanedev\LaravelPolicies\Contracts\Policy
     */
    public function parsePolicy(string $class): Policy;

    /**
     * Register a policy class.
     *
     * @param  string  $class
     *
     * @return \Arcanedev\LaravelPolicies\PolicyManager
     */
    public function registerClass(string $class): self;

    /**
     * Register a policy instance.
     *
     * @param  \Arcanedev\LaravelPolicies\Contracts\Policy  $policy
     *
     * @return $this
     */
    public function register(Policy $policy): self;
}