1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 

<?php
namespace Nethgui\System;

/*
 * Copyright (C) 2011 Nethesis S.r.l.
 * 
 * This script is part of NethServer.
 * 
 * NethServer is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * NethServer is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with NethServer.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Brings the output and exit status of an external command.
 *
 * Deprecated since version 1.6: use Symfony/Process component API. Where possible
 * the old interface methods are mapped to equivalent Symfony/Process methods.
 *
 * @author Davide Principi <davide.principi@nethesis.it>
 * @see \Nethgui\System\PlatformInterface::exec()
 * @since 1.0
 * @api
 * @deprecated since version 1.6
 */
interface ProcessInterface extends \Nethgui\Utility\DisposableInterface
{
    const STATE_NEW = 0;
    const STATE_RUNNING = 1;
    const STATE_EXITED = 2;

    /**
     * The command output
     *
     * @api
     * @return string
     */
    public function getOutput();

    /**
     * The lines of the command output
     *
     * @api
     * @return array
     */
    public function getOutputArray();

    /**
     * Peek the running process output
     *
     * @api
     * @return string|bool An output chunk, if more data is available, FALSE otherwise.
     */
    public function readOutput();

    /**
     * The exit status code
     *
     * @api
     * @return mixed The process exit code (integer) or FALSE if the process has not exited yet.
     */
    public function getExitCode();

    /**
     *
     * @api
     * @param string
     */
    public function addArgument($arg);

    /**
     * Execute the command
     *
     * @api
     * @return ProcessInterface
     */
    public function exec();

    /**
     * Kills a RUNNING command
     *
     * @api
     * @return FALSE on error, TRUE if the command was RUNNING
     */
    public function kill();

    /**
     * Read and returns the execution state, one of NEW, RUNNING, EXITED
     *
     * @api
     * @return integer
     */
    public function readExecutionState();

    /**
     * Give an identity to the process object to retrieve it later.
     *
     * @api
     * @param string Unique identifier of the process 
     * @return ProcessInterface
     */
    public function setIdentifier($identifier);

    /**
     * Obtain the process identifier.
     *
     * If the identifier has not been set this method returns a random string
     *
     * @api
     * @return string The process unique identifier
     */
    public function getIdentifier();

    /**
     *
     * @api
     * @return array Timing informations
     */
    public function getTimes();


   
}