vasek-purchart/phing-symfony-command-task

This Phing task allows you to call commands from a Symfony Console Application comfortably.

1.3 2015-01-20 16:39 UTC

README

This Phing task allows you to call commands from a Symfony Console Application comfortably.

There is a built in SymfonyConsoleTask in Phing, but with this custom task you can:

  • see the output as soon as it is ready (displaying progress bars)
  • configure default Symfony Application Console location
  • configure the executable with which the Console is run (environments on Windows usually require running the console trough PHP binary, not executing directly), again with a configurable default value
  • escaping argument values and paths as in the ExecTask

Usage

To call the commands in the simplest possible way like this:

<symfony-cmd cmd="test:test"/>

you have to configure the default values:

<property name="symfony-command.default.app" value="path/to/console"/>
<property name="symfony-command.default.executable" value="php"/>

Of course you can set these properties in any other regular way.

If you do not want to use the defaults, or you want to override them you can always specify both or one of them:

<symfony-cmd executable="php-cgi" app="path/to/another/console" cmd="test:test"/>

If you want to pass any additional parameters, you can use <arg> elements to do so (as in ExecTask):

<symfony-cmd cmd="test:test">
  <arg value="--strict"/>
  <arg path="path/to/tests"/>
</symfony-cmd>

Installation

Install package vasek-purchart/phing-symfony-command-task with Composer:

composer require vasek-purchart/phing-symfony-command-task

You have to register this task under a name of your choosing. There are several ways how to register a task, see the TaskDefTask docummentation. The recommended way is putting this in your build.xml.

<taskdef name="symfony-cmd" classname="SymfonyCommand"/>

You can pick any other name for the command if you would like to.