Psi\Component\Description\DescriptionInterface

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	get()	0	1	?
	has()	0	1	?
	all()	0	1	?
	set()	0	1	?

<?php

declare(strict_types=1);

namespace Psi\Component\Description;

/**
 * Descriptive metadata for objects.
 */
interface DescriptionInterface
{
    /**
     * Return the descriptors value for the given descriptor.
     *
     * @param string $descriptor

There is no parameter named $descriptor. Did you maybe mean $descriptorKey?

     *
     * @return mixed
     */
    public function get($descriptorKey): DescriptorInterface;

    /**
     * Return true if the given descriptor has been set.
     *
     * @param string $descriptor
     *
     * @return bool
     */
    public function has($descriptor): bool;

    /**
     * Return all of the descriptors.
     *
     * @return array
     */
    public function all(): array;

    /**
     * Set value for descriptors descriptor.
     *
     * Note that:
     *
     * - It is possible to overwrite existing descriptors.
     *
     * - Where possible the descriptor should be the value of one of the constants
     *   defined in the Descriptor class.
     *
     * @param string $key
     * @param string $descriptor
     * @param int    $priority
     */
    public function set(string $key, DescriptorInterface $descriptor, int $priority = 0);
}