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: 

<?php

/*
 * This file is part of the webmozart/console package.
 *
 * (c) Bernhard Schussek <bschussek@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webmozart\Console\Api\Command;

use Exception;
use RuntimeException;

/**
 * Thrown when two commands have the same name.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class CannotAddCommandException extends RuntimeException
{
    /**
     * Code: A command with the same name exists.
     */
    const NAME_EXISTS = 1;

    /**
     * Code: An option with the same name exists.
     */
    const OPTION_EXISTS = 2;

    /**
     * Code: The command name is empty.
     */
    const NAME_EMPTY = 3;

    /**
     * Creates an exception for the code {@link NAME_EXISTS}.
     *
     * @param string    $name  The command name.
     * @param Exception $cause The exception that caused this exception.
     *
     * @return static The created exception.
     */
    public static function nameExists($name, Exception $cause = null)
    {
        return new static(sprintf(
            'A command named "%s" exists already.',
            $name
        ), self::NAME_EXISTS, $cause);
    }

    /**
     * Creates an exception for the code {@link OPTION_EXISTS}.
     *
     * @param string    $name  The command name.
     * @param Exception $cause The exception that caused this exception.
     *
     * @return static The created exception.
     */
    public static function optionExists($name, Exception $cause = null)
    {
        return new static(sprintf(
            'An option named "%s%s" exists already.',
            strlen($name) > 1 ? '--' : '-',
            $name
        ), self::OPTION_EXISTS, $cause);
    }

    /**
     * Creates an exception for the code {@link NAME_EMPTY}.
     *
     * @param Exception $cause The exception that caused this exception.
     *
     * @return static The created exception.
     */
    public static function nameEmpty(Exception $cause = null)
    {
        return new static('The command name must be set.', self::NAME_EMPTY, $cause);
    }
}