Arcanedev\LaravelPolicies\Contracts\Ability

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	key()	0	1	?
	setKey()	0	1	?
	method()	0	1	?
	methodName()	0	1	?
	className()	0	1	?
	callback()	0	1	?
	setMethod()	0	1	?
	metas()	0	1	?
	setMetas()	0	1	?
	meta()	0	1	?
	setMeta()	0	1	?
	isClosure()	0	1	?

<?php

declare(strict_types=1);

namespace Arcanedev\LaravelPolicies\Contracts;

use Illuminate\Contracts\Support\{Arrayable, Jsonable};
use Closure;
use JsonSerializable;

/**
 * Interface  Ability
 *
 * @author    ARCANEDEV <arcanedev.maroc@gmail.com>
 */
interface Ability extends Arrayable, JsonSerializable, Jsonable
{
    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get the ability's key.
     *
     * @return string
     */
    public function key(): string;

    /**
     * Set the ability's key.
     *
     * @param  string  $key
     *
     * @return $this
     */
    public function setKey(string $key);

    /**
     * Get the ability's method.
     *
     * @return \Closure|string
     */
    public function method();

    /**
     * Get the ability's method name.
     *
     * @return string|null
     */
    public function methodName();

    /**
     * Get the ability's class name.
     *
     * @param  bool  $fqn
     *
     * @return  string|null
     */
    public function className(bool $fqn = true);

    /**
     * Set the callback as method.
     *
     * @param  \Closure  $callback
     *
     * @return $this
     */
    public function callback(Closure $callback);

    /**
     * Set the ability's method.
     *
     * @param  \Closure|string  $method
     *
     * @return $this
     */
    public function setMethod($method);

    /**
     * Get the ability's meta.
     *
     * @return array
     */
    public function metas(): array;

    /**
     * Set the ability's meta.
     *
     * @param  array  $metas
     * @param  bool   $keepMetas
     *
     * @return $this
     */
    public function setMetas(array $metas, bool $keepMetas = true);

    /**
     * Get a meta.
     *
     * @param  string      $key
     * @param  mixed|null  $default
     *
     * @return mixed
     */
    public function meta(string $key, $default = null);

    /**
     * Set a meta.
     *
     * @param  string  $key
     * @param  mixed   $value
     *
     * @return $this
     */
    public function setMeta(string $key, $value);

    /* -----------------------------------------------------------------
     |  Check Methods
     | -----------------------------------------------------------------
     */

    /**
     * Check if the ability is a callback method.
     *
     * @return bool
     */
    public function isClosure(): bool;
}