[Process] tagged the guaranteed BC API

This commit is contained in:
Fabien Potencier 2011-03-24 09:13:58 +01:00
parent 639d93cbbf
commit b2a8e35900
2 changed files with 30 additions and 0 deletions

View File

@ -19,6 +19,8 @@ namespace Symfony\Component\Process;
* print $p->getOutput()."\n";
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class PhpProcess extends Process
{
@ -30,6 +32,8 @@ class PhpProcess extends Process
* @param array $env The environment variables
* @param integer $timeout The timeout in seconds
* @param array $options An array of options for proc_open
*
* @api
*/
public function __construct($script, $cwd = null, array $env = array(), $timeout = 60, array $options = array())
{
@ -38,6 +42,8 @@ class PhpProcess extends Process
/**
* Sets the path to the PHP binary to use.
*
* @api
*/
public function setPhpBinary($php)
{
@ -51,6 +57,8 @@ class PhpProcess extends Process
* output available on STDOUT or STDERR
*
* @return integer The exit status code
*
* @api
*/
public function run($callback = null)
{

View File

@ -16,6 +16,8 @@ namespace Symfony\Component\Process;
* start independent PHP processes.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class Process
{
@ -41,6 +43,8 @@ class Process
* @param array $options An array of options for proc_open
*
* @throws \RuntimeException When proc_open is not installed
*
* @api
*/
public function __construct($commandline, $cwd = null, array $env = array(), $stdin = null, $timeout = 60, array $options = array())
{
@ -75,6 +79,8 @@ class Process
* @return integer The exit status code
*
* @throws \RuntimeException When process can't be launch or is stopped
*
* @api
*/
public function run($callback = null)
{
@ -165,6 +171,8 @@ class Process
* to the run() method.
*
* @return string The process output
*
* @api
*/
public function getOutput()
{
@ -178,6 +186,8 @@ class Process
* to the run() method.
*
* @return string The process error output
*
* @api
*/
public function getErrorOutput()
{
@ -188,6 +198,8 @@ class Process
* Returns the exit code returned by the process.
*
* @return integer The exit status code
*
* @api
*/
public function getExitCode()
{
@ -198,6 +210,8 @@ class Process
* Checks if the process ended successfully.
*
* @return Boolean true if the process ended successfully, false otherwise
*
* @api
*/
public function isSuccessful()
{
@ -210,6 +224,8 @@ class Process
* It always returns false on Windows.
*
* @return Boolean
*
* @api
*/
public function hasBeenSignaled()
{
@ -222,6 +238,8 @@ class Process
* It is only meaningful if hasBeenSignaled() returns true.
*
* @return integer
*
* @api
*/
public function getTermSignal()
{
@ -234,6 +252,8 @@ class Process
* It always returns false on Windows.
*
* @return Boolean
*
* @api
*/
public function hasBeenStopped()
{
@ -246,6 +266,8 @@ class Process
* It is only meaningful if hasBeenStopped() returns true.
*
* @return integer
*
* @api
*/
public function getStopSignal()
{