Documentation

Flex
in package
implements PluginInterface, EventSubscriberInterface

Tags
author

Fabien Potencier fabien@symfony.com

author

Nicolas Grekas p@tchwork.com

Interfaces, Classes and Traits

PluginInterface
EventSubscriberInterface

Table of Contents

$storedOperations  : mixed
$activated  : mixed
$aliasResolveCommands  : mixed
$cacheDirPopulated  : mixed
$composer  : Composer
$config  : mixed
$configurator  : mixed
$displayThanksReminder  : mixed
$downloader  : mixed
$dryRun  : mixed
$filter  : mixed
$installer  : Installer
$io  : IOInterface
$lock  : mixed
$operations  : mixed
$options  : mixed
$postInstallOutput  : mixed
$progress  : mixed
$reinstall  : mixed
$repoReadingCommands  : mixed
$rfs  : mixed
activate()  : void
configureInstaller()  : mixed
configureProject()  : mixed
deactivate()  : void
enableThanksReminder()  : mixed
executeAutoScripts()  : mixed
fetchRecipes()  : array<string|int, Recipe>
finish()  : void
getComposerJsonHash()  : string
getLock()  : Lock
getSubscribedEvents()  : array<string|int, mixed>
install()  : mixed
onFileDownload()  : mixed
populateFilesCacheDir()  : mixed
populateProvidersCacheDir()  : mixed
record()  : mixed
recordFlexInstall()  : mixed
recordOperations()  : mixed
truncatePackages()  : mixed
uninstall()  : void
update()  : mixed
doesRecipeConflict()  : bool
formatOrigin()  : string
initOptions()  : Options
populateRepoCacheDir()  : mixed
reinstall()  : mixed
shouldRecordOperation()  : bool
synchronizePackageJson()  : mixed
unpack()  : mixed
updateComposerLock()  : mixed

Properties

$storedOperations

public static mixed $storedOperations = []

$activated

private static mixed $activated = true

$aliasResolveCommands

private static mixed $aliasResolveCommands = ['require' => true, 'update' => false, 'remove' => false, 'unpack' => true]

$cacheDirPopulated

private mixed $cacheDirPopulated = false

$composer

private Composer $composer

$config

private mixed $config

$configurator

private mixed $configurator

$displayThanksReminder

private mixed $displayThanksReminder = 0

$downloader

private mixed $downloader

$dryRun

private mixed $dryRun = false

$filter

private mixed $filter

$installer

private Installer $installer

$io

private IOInterface $io

$lock

private mixed $lock

$operations

private mixed $operations = []

$options

private mixed $options

$postInstallOutput

private mixed $postInstallOutput = ['']

$progress

private mixed $progress = true

$reinstall

private mixed $reinstall

$repoReadingCommands

private static mixed $repoReadingCommands = ['create-project' => true, 'outdated' => true, 'require' => true, 'update' => true, 'install' => true]

Methods

activate()

public activate(Composer $composer, IOInterface $io) : void
Parameters
$composer : Composer
$io : IOInterface
Return values
void

configureInstaller()

public configureInstaller() : mixed
Return values
mixed

configureProject()

public configureProject(Event $event) : mixed
Parameters
$event : Event
Return values
mixed

deactivate()

public deactivate(Composer $composer, IOInterface $io) : void
Parameters
$composer : Composer
$io : IOInterface
Return values
void

enableThanksReminder()

public enableThanksReminder() : mixed
Return values
mixed

executeAutoScripts()

public executeAutoScripts(Event $event) : mixed
Parameters
$event : Event
Return values
mixed

fetchRecipes()

public fetchRecipes(array<string|int, mixed> $operations, bool $reset) : array<string|int, Recipe>
Parameters
$operations : array<string|int, mixed>
$reset : bool
Return values
array<string|int, Recipe>

finish()

public finish(string $rootDir[, string $originalComposerJsonHash = null ]) : void
Parameters
$rootDir : string
$originalComposerJsonHash : string = null
Return values
void

getComposerJsonHash()

public getComposerJsonHash() : string
Return values
string

getSubscribedEvents()

public static getSubscribedEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>

install()

public install(Event $event) : mixed
Parameters
$event : Event
Return values
mixed

onFileDownload()

public onFileDownload(PreFileDownloadEvent $event) : mixed
Parameters
$event : PreFileDownloadEvent
Return values
mixed

populateFilesCacheDir()

public populateFilesCacheDir(InstallerEvent $event) : mixed
Parameters
$event : InstallerEvent
Return values
mixed

populateProvidersCacheDir()

public populateProvidersCacheDir(InstallerEvent $event) : mixed
Parameters
$event : InstallerEvent
Return values
mixed

record()

public record(PackageEvent $event) : mixed
Parameters
$event : PackageEvent
Return values
mixed

recordFlexInstall()

public recordFlexInstall(PackageEvent $event) : mixed
Parameters
$event : PackageEvent
Return values
mixed

recordOperations()

public recordOperations(InstallerEvent $event) : mixed
Parameters
$event : InstallerEvent
Return values
mixed

truncatePackages()

public truncatePackages(PrePoolCreateEvent $event) : mixed
Parameters
$event : PrePoolCreateEvent
Return values
mixed

uninstall()

public uninstall(Composer $composer, IOInterface $io) : void
Parameters
$composer : Composer
$io : IOInterface
Return values
void

update()

public update(Event $event[, mixed $operations = [] ]) : mixed
Parameters
$event : Event
$operations : mixed = []
Return values
mixed

doesRecipeConflict()

private doesRecipeConflict(array<string|int, mixed> $recipeData, OperationInterface $operation) : bool
Parameters
$recipeData : array<string|int, mixed>
$operation : OperationInterface
Return values
bool

formatOrigin()

private formatOrigin(Recipe $recipe) : string
Parameters
$recipe : Recipe
Return values
string

populateRepoCacheDir()

private populateRepoCacheDir() : mixed
Return values
mixed

reinstall()

private reinstall(Event $event, bool $update) : mixed
Parameters
$event : Event
$update : bool
Return values
mixed

shouldRecordOperation()

private shouldRecordOperation(OperationInterface $operation, bool $isDevMode[, Composer $composer = null ]) : bool
Parameters
$operation : OperationInterface
$isDevMode : bool
$composer : Composer = null
Return values
bool

synchronizePackageJson()

private synchronizePackageJson(string $rootDir) : mixed
Parameters
$rootDir : string
Return values
mixed

unpack()

private unpack(Event $event) : mixed
Parameters
$event : Event
Return values
mixed

updateComposerLock()

private updateComposerLock() : mixed
Return values
mixed

Search results