Documentation

JsonConfigSource
in package

Application

implements ConfigSourceInterface

JSON Configuration Source

Interfaces, Classes and Traits

ConfigSourceInterface: Configuration Source Interface

$authConfig : bool
$file : JsonFile
__construct() : mixed: Constructor
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
manipulateJson() : mixed
arrayUnshiftRef() : array<string|int, mixed>: Prepend a reference to an element to the beginning of an array.

$authConfig


    private
        bool
    $authConfig

$file


    private
        JsonFile
    $file

__construct()

Constructor


    public
                __construct(JsonFile $file[, bool $authConfig = false ]) : mixed

Parameters

$file : JsonFile
$authConfig : bool = false

Return values

mixed —

addConfigSetting()

Add a config setting


    public
                addConfigSetting(mixed $name, mixed $value) : mixed

Parameters

$name : mixed: Name
$value : mixed: Value

Return values

mixed —

addLink()

Add a package link


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

Parameters

$type : mixed: Type (require, require-dev, provide, suggest, replace, conflict)
$name : mixed: Name
$value : mixed: Value

Return values

mixed —

addProperty()

Add a property


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

Parameters

$name : mixed: Name
$value : mixed: Value

Return values

mixed —

addRepository()

Add a repository


    public
                addRepository(mixed $name, mixed $config) : mixed

Parameters

$name : mixed: Name
$config : 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(mixed $name) : mixed

Parameters

$name : mixed

Return values

mixed —

removeLink()

Remove a package link


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

Parameters

$type : mixed: Type (require, require-dev, provide, suggest, replace, conflict)
$name : mixed: Name

Return values

mixed —

removeProperty()

Remove a property


    public
                removeProperty(mixed $name) : mixed

Parameters

$name : mixed

Return values

mixed —

removeRepository()

Remove a repository


    public
                removeRepository(mixed $name) : mixed

Parameters

$name : mixed

Return values

mixed —

manipulateJson()


    protected
                manipulateJson(mixed $method, mixed $args, mixed $fallback) : mixed

Parameters

$method : mixed
$args : mixed
$fallback : mixed

Return values

mixed —

arrayUnshiftRef()

Prepend a reference to an element to the beginning of an array.


    private
                arrayUnshiftRef(array<string|int, mixed> &$array, mixed &$value) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —