Documentation

ConfigSourceInterface

Configuration Source Interface

Tags
author

Jordi Boggiano j.boggiano@seld.be

author

Beau Simensen beau@dflydev.com

Table of Contents

addConfigSetting()  : mixed
Add a config setting
addLink()  : mixed
Add a package link
addProperty()  : mixed
Add a property
addRepository()  : mixed
Add a repository
getName()  : string
Gives a user-friendly name to this source (file path or so)
removeConfigSetting()  : mixed
Remove a config setting
removeLink()  : mixed
Remove a package link
removeProperty()  : mixed
Remove a property
removeRepository()  : mixed
Remove a repository

Methods

addConfigSetting()

Add a config setting

public addConfigSetting(string $name, string|array<string|int, mixed> $value) : mixed
Parameters
$name : string

Name

$value : string|array<string|int, mixed>

Value

Return values
mixed

Add a package link

public addLink(string $type, string $name, string $value) : mixed
Parameters
$type : string

Type (require, require-dev, provide, suggest, replace, conflict)

$name : string

Name

$value : string

Value

Return values
mixed

addProperty()

Add a property

public addProperty(string $name, string $value) : mixed
Parameters
$name : string

Name

$value : string

Value

Return values
mixed

addRepository()

Add a repository

public addRepository(string $name, array<string|int, mixed> $config) : mixed
Parameters
$name : string

Name

$config : array<string|int, mixed>

Configuration

Return values
mixed

getName()

Gives a user-friendly name to this source (file path or so)

public getName() : string
Return values
string

removeConfigSetting()

Remove a config setting

public removeConfigSetting(string $name) : mixed
Parameters
$name : string
Return values
mixed

Remove a package link

public removeLink(string $type, string $name) : mixed
Parameters
$type : string

Type (require, require-dev, provide, suggest, replace, conflict)

$name : string

Name

Return values
mixed

removeProperty()

Remove a property

public removeProperty(string $name) : mixed
Parameters
$name : string
Return values
mixed

removeRepository()

Remove a repository

public removeRepository(string $name) : mixed
Parameters
$name : string
Return values
mixed

Search results