interface ConfigSourceInterface

Configuration Source Interface

@author Jordi Boggiano <j.boggiano@seld.be> @author Beau Simensen <beau@dflydev.com>

Hierarchy

interface \Composer\Config\ConfigSourceInterface

Expanded class hierarchy of ConfigSourceInterface

All classes that implement ConfigSourceInterface

1 file declares its use of ConfigSourceInterface

Config.php in vendor/composer/composer/src/Composer/Config.php

File

vendor/composer/composer/src/Composer/Config/ConfigSourceInterface.php, line 21

Namespace

Composer\Config

View source

interface ConfigSourceInterface {
    
    /**
     * Add a repository
     *
     * @param string        $name   Name
     * @param mixed[]|false $config Configuration
     * @param bool          $append Whether the repo should be appended (true) or prepended (false)
     */
    public function addRepository(string $name, $config, bool $append = true) : void;
    
    /**
     * Remove a repository
     */
    public function removeRepository(string $name) : void;
    
    /**
     * Add a config setting
     *
     * @param string $name  Name
     * @param mixed  $value Value
     */
    public function addConfigSetting(string $name, $value) : void;
    
    /**
     * Remove a config setting
     */
    public function removeConfigSetting(string $name) : void;
    
    /**
     * Add a property
     *
     * @param string $name  Name
     * @param string|string[] $value Value
     */
    public function addProperty(string $name, $value) : void;
    
    /**
     * Remove a property
     */
    public function removeProperty(string $name) : void;
    
    /**
     * Add a package link
     *
     * @param string $type  Type (require, require-dev, provide, suggest, replace, conflict)
     * @param string $name  Name
     * @param string $value Value
     */
    public function addLink(string $type, string $name, string $value) : void;
    
    /**
     * Remove a package link
     *
     * @param string $type Type (require, require-dev, provide, suggest, replace, conflict)
     * @param string $name Name
     */
    public function removeLink(string $type, string $name) : void;
    
    /**
     * Gives a user-friendly name to this source (file path or so)
     */
    public function getName() : string;

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
ConfigSourceInterface::addConfigSetting	public	function	Add a config setting	1
ConfigSourceInterface::addLink	public	function	Add a package link	1
ConfigSourceInterface::addProperty	public	function	Add a property	1
ConfigSourceInterface::addRepository	public	function	Add a repository	1
ConfigSourceInterface::getName	public	function	Gives a user-friendly name to this source (file path or so)	1
ConfigSourceInterface::removeConfigSetting	public	function	Remove a config setting	1
ConfigSourceInterface::removeLink	public	function	Remove a package link	1
ConfigSourceInterface::removeProperty	public	function	Remove a property	1
ConfigSourceInterface::removeRepository	public	function	Remove a repository	1