atelierspierrot/library

<?php
/**
 * This file is part of the Library package.
 *
 * Copyleft (ↄ) 2013-2016 Pierre Cassat <me@e-piwi.fr> and contributors
 * 
 * This program 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.
 * 
 * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * The source code of this package is available online at 
 * <http://github.com/atelierspierrot/library>.
 */

namespace Library\CommandLine;

/**
 * CommandLine controller interface
 *
 * @author  piwi <me@e-piwi.fr>
 */
interface CommandLineControllerInterface
{

    /**
     * Adding a method in the collection of done methods
     * @param   string  $method_name    The name of the method
     */
    public function addDoneMethod($method_name);

    /**
     * Get the collection of done methods
     * @return  array
     */
    public function getDoneMethods();

    /**
     * Set the current command line script called
     * @param   string  $script_name    The script name
     */
    public function setScript($script_name);

    /**
     * Get the current command line script called
     * @return  string|null
     */
    public function getScript();

    /**
     * Set the command line parameters
     * @param   array   $params     The collection of parameters
     */
    public function setParameters(array $params);

    /**
     * Get the parameters collection
     * @return  array
     */
    public function getParameters();

}