AbstractConfigOption.php 1.63 KB
Newer Older
Ketan's avatar
Ketan committed
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
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Framework\Setup\Option;

use Symfony\Component\Console\Input\InputOption;

/**
 * Abstract Option class in deployment configuration tool
 */
abstract class AbstractConfigOption extends InputOption
{
    /**
     * Frontend input type
     *
     * @var string
     */
    private $frontendType;

    /**
     * Config path
     *
     * @var string
     */
    private $configPath;

    /**
     * Constructor
     *
     * @param string $name
     * @param string $frontendType
     * @param int $mode
     * @param string $configPath
     * @param string $description
     * @param string|array|null $defaultValue
     * @param string|array|null $shortcut
     */
    public function __construct(
        $name,
        $frontendType,
        $mode,
        $configPath,
        $description = '',
        $defaultValue = null,
        $shortcut = null
    ) {
        $this->frontendType = $frontendType;
        $this->configPath = $configPath;
        parent::__construct($name, $shortcut, $mode, $description, $defaultValue);
    }

    /**
     * Get frontend input type
     *
     * @return string
     */
    public function getFrontendType()
    {
        return $this->frontendType;
    }

    /**
     * Get config path
     *
     * @return string
     */
    public function getConfigPath()
    {
        return $this->configPath;
    }

    /**
     * No base validation
     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
     * @param mixed $data
     * @return void
     */
    public function validate($data)
    {
    }
}