View file vendor/php-di/php-di/src/FactoryInterface.php

File size: 0.98Kb
<?php

declare(strict_types=1);

namespace DI;

/**
 * Describes the basic interface of a factory.
 *
 * @api
 *
 * @since 4.0
 * @author Matthieu Napoli <[email protected]>
 */
interface FactoryInterface
{
    /**
     * Resolves an entry by its name. If given a class name, it will return a new instance of that class.
     *
     * @param string $name       Entry name or a class name.
     * @param array  $parameters Optional parameters to use to build the entry. Use this to force specific
     *                           parameters to specific values. Parameters not defined in this array will
     *                           be automatically resolved.
     *
     * @throws \InvalidArgumentException The name parameter must be of type string.
     * @throws DependencyException       Error while resolving the entry.
     * @throws NotFoundException         No entry or class found for the given name.
     * @return mixed
     */
    public function make($name, array $parameters = []);
}