Documentation

UpdateHelper

UpdateHelper
in package

Application

$composer : Composer
$composerFilePath : string
$dependencies : array<string|int, mixed>
$event : Event
$file : JsonFile
$io : IOInterface|null
__construct() : mixed
check() : mixed
getComposer() : Composer
getComposerFilePath() : string
getDependencies() : array<string|int, mixed>
getDevDependencies() : array<string|int, mixed>
getEvent() : Event
getFile() : JsonFile
getFlattenDependencies() : array<string|int, mixed>
getIo() : IOInterface|null
getProdDependencies() : array<string|int, mixed>
hasAsDependency() : bool
hasAsDevDependency() : bool
hasAsProdDependency() : bool
isDependencyAtLeast() : bool
isDependencyLesserThan() : bool
isInteractive() : bool
setDependencyVersion() : $this
setDependencyVersions() : $this
update() : $this
write() : mixed
appendConfig() : mixed
checkFileHelpers() : mixed
checkHelper() : mixed
getErrorMessage() : mixed
getUpdateHelperConfig() : mixed

$composer


    private
        Composer
    $composer

$composerFilePath


    private
        string
    $composerFilePath

$dependencies


    private
        array<string|int, mixed>
    $dependencies
     = array()

$event


    private
        Event
    $event

$file


    private
        JsonFile
    $file

$io


    private
        IOInterface|null
    $io

__construct()


    public
                __construct(Event $event[, IOInterface $io = null ][, Composer $composer = null ]) : mixed

Parameters

$event : Event
$io : IOInterface = null
$composer : Composer = null

Return values

mixed —

check()


    public
            static    check(Event $event) : mixed

Parameters

$event : Event

Return values

mixed —

getComposer()


    public
                getComposer() : Composer

Return values

Composer —

getComposerFilePath()


    public
                getComposerFilePath() : string

Return values

string —

getDependencies()


    public
                getDependencies() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getDevDependencies()


    public
                getDevDependencies() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getEvent()


    public
                getEvent() : Event

Return values

Event —

getFile()


    public
                getFile() : JsonFile

Return values

JsonFile —

getFlattenDependencies()


    public
                getFlattenDependencies() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getIo()


    public
                getIo() : IOInterface|null

Return values

IOInterface|null —

getProdDependencies()


    public
                getProdDependencies() : array<string|int, mixed>

Return values

array<string|int, mixed> —

hasAsDependency()


    public
                hasAsDependency(string $dependency) : bool

Parameters

$dependency : string

Return values

bool —

hasAsDevDependency()


    public
                hasAsDevDependency(string $dependency) : bool

Parameters

$dependency : string

Return values

bool —

hasAsProdDependency()


    public
                hasAsProdDependency(string $dependency) : bool

Parameters

$dependency : string

Return values

bool —

isDependencyAtLeast()


    public
                isDependencyAtLeast(string $dependency, string $version) : bool

Parameters

$dependency : string
$version : string

Return values

bool —

isDependencyLesserThan()


    public
                isDependencyLesserThan(string $dependency, string $version) : bool

Parameters

$dependency : string
$version : string

Return values

bool —

isInteractive()


    public
                isInteractive() : bool

Return values

bool —

setDependencyVersion()


    public
                setDependencyVersion(string $dependency, string $version[, array<string|int, mixed> $environments = array('require', 'require-dev') ]) : $this

Parameters

$dependency : string
$version : string
$environments : array<string|int, mixed> = array('require', 'require-dev')

Return values

$this —

setDependencyVersions()


    public
                setDependencyVersions(array<string|int, mixed> $dependencies[, array<string|int, mixed> $environments = array('require', 'require-dev') ]) : $this

Parameters

$dependencies : array<string|int, mixed>
$environments : array<string|int, mixed> = array('require', 'require-dev')

Return values

$this —

update()


    public
                update() : $this

Return values

$this —

write()


    public
                write(string|array<string|int, mixed> $text) : mixed

Parameters

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

Return values

mixed —

appendConfig()


    protected
            static    appendConfig(mixed &$classes, mixed $directory[, mixed $key = null ]) : mixed

Parameters

$classes : mixed
$directory : mixed
$key : mixed = null

Return values

mixed —

checkFileHelpers()


    protected
            static    checkFileHelpers(string $file, Event $event, IOInterface $io, Composer $composer, array<string|int, string> $subClasses) : mixed

Parameters

$file : string
$event : Event
$io : IOInterface
$composer : Composer
$subClasses : array<string|int, string>

Return values

mixed —

checkHelper()


    protected
            static    checkHelper(Event $event, IOInterface $io, Composer $composer, mixed $class) : mixed

Parameters

$event : Event
$io : IOInterface
$composer : Composer
$class : mixed

Return values

mixed —

getErrorMessage()


    protected
            static    getErrorMessage(InvalidArgumentException $exception, mixed $file, mixed $class) : mixed

Parameters

$exception : InvalidArgumentException
$file : mixed
$class : mixed

Return values

mixed —

getUpdateHelperConfig()


    protected
            static    getUpdateHelperConfig(Composer $composer[, mixed $key = null ]) : mixed

Parameters

$composer : Composer
$key : mixed = null

Return values

mixed —