TYPO3\Surf\Task\Composer\InstallTask

class InstallTask

Installs the composer packages based on a composer.json file in the projects root folder

It takes the following options:

  • composerCommandPath - The path where composer is located.
  • nodeName - The name of the node where composer should install the packages.
  • useApplicationWorkspace (optional) - If true Surf uses the workspace path, else it uses the release path of the application.
Example:
$workflow
->setTaskOptions(‘TYPO3SurfTaskComposerInstallTask’, [
‘composerCommandPath’ => ‘/usr/bin/composer’, ‘nodeName’ => ‘outerSpace’, ‘useApplicationWorkspace’ => ‘true’

]

);

property command

protected string

Command to run

property arguments

protected array

Arguments for the command

property suffix

protected array

Suffix for the command

property shell

protected ShellCommandService

execute(Node $node, Application $application, Deployment $deployment, $options = [])
Parameters:
simulate(Node $node, Application $application, Deployment $deployment, $options = [])

Simulate this task

Parameters:
buildComposerCommands($manifestPath, $options)

Build the composer command in the given $path.

Parameters:
  • $manifestPath (string) –
  • $options (array) –
Returns:

array

composerManifestExists($path, Node $node, Deployment $deployment)

Checks if a composer manifest exists in the directory at the given path.

If no manifest exists, a log message is recorded.

Parameters:
Returns:

bool

resolveOptions(OptionsResolver $resolver)
Parameters:
  • $resolver (OptionsResolver) –
setShellCommandService(ShellCommandService $shellCommandService)
Parameters:
rollback(Node $node, Application $application, Deployment $deployment, $options = [])

Rollback this task

Parameters:
configureOptions($options = [])
Parameters:
  • $options (array) –
Returns:

array