shawe / FSConsoleTools

src/Console/ConsoleAbstract.php

<?php
/**
 * This file is part of FSConsoleTools
 * Copyright (C) 2018 Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace FacturaScriptsUtils\Console;

use FacturaScripts\Core\Base\DataBase;

The type FacturaScripts\Core\Base\DataBase was not found. Maybe you did not declare it correctly or list all dependencies?

const DS = DIRECTORY_SEPARATOR;

if (!\defined('FS_FOLDER')) {
    \define('FS_FOLDER', __DIR__ . DS . '..' . DS . '..' . DS . '..' . DS . '..' . DS . '..' . DS);
}

if (!\defined('FS_DEBUG')) {
    \define('FS_DEBUG', true);
}

/**
 * Class ConsoleAbstract
 *
 * @author Francesc Pineda Segarra <francesc.pineda.segarra@gmail.com>
 */
abstract class ConsoleAbstract
{
    /**
     * Arguments received from command execution.
     *
     * @var array
     */
    protected $argv;

    /**
     * DataBase object.
     *
     * @var DataBase
     */
    protected $dataBase;

    /**
     * Developer name.
     *
     * @var string
     */
    private $devName;

    /**
     * Developer email.
     *
     * @var string
     */
    private $devMail;

    /**
     * Auto reply it enabled.
     *
     * @var bool
     */
    public $autoReply = false;

    /**
     * Auto hide messages if enabled.
     *
     * @var bool
     */
    public $autoHide = false;

    /**
     * Start point to run the command.
     *
     * @param array $params
     *
     * @return int
     */
    abstract public function run(...$params): int;

    /**
     * Return description about this class.
     *
     * @return string
     */
    abstract public function getDescription(): string;

    /**
     * Print help information to the user.
     *
     * @return string
     */
    abstract public function getHelpMsg(): string;

    /**
     * ConsoleAbstract constructor.
     */
    public function __construct()
    {
        $this->setDevName('YOUR NAME');
        $this->setDevMail('YOUR@EMAIL');
    }

    /**
     * Initialize.
     */
    public function init()
    {
        if (\DB_CONNECTION) {
            if (!isset($this->dataBase)) {
                $this->dataBase = new DataBase();
                $this->dataBase->connect();
            }
        } else {
            trigger_error('A database connection is needed. Do you set your config.php file?');
        }
    }

    /**
     * Terminate.
     */
    public function terminate()
    {
        $this->dataBase->close();
    }

    /**
     * Returns an associative array of available methods for the user.
     * Add more options if you want to add support for custom methods.
     *      [
     *          '-h'        => 'getHelpMsg',
     *          '--help'    => 'getHelpMsg',
     *      ]
     *
     * @return array
     */
    public function getUserMethods(): array
    {
        return [
            '-h' => 'getHelpMsg',
            '--help' => 'getHelpMsg',
        ];
    }

    /**
     * Ask user to continue and return a boolean.
     *
     * @param bool $autoReply
     *
     * @return bool
     */
    public function areYouSure($autoReply = false)
    {
        $this->showMessage(\PHP_EOL . 'Are you sure? [y/n] ');
        $stdin = $autoReply ? $autoReply : trim(fgets(STDIN));
        switch ($stdin) {
            case 'y':
            case 'Y':
            case 'yes':
            case 'Yes':
            case 'true':
            case true:

It seems like you are loosely comparing $stdin of type string to the boolean true. If you are specifically checking for a non-empty string, consider using the more explicit !== '' instead.

                return true;
            default:
                return $autoReply;
        }
    }

    /**
     * Set database.
     *
     * @param DataBase\Mysql|DataBase\Postgresql $dataBase

The type FacturaScripts\Core\Base\DataBase\Postgresql was not found. Maybe you did not declare it correctly or list all dependencies?

The type FacturaScripts\Core\Base\DataBase\Mysql was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function setDataBase($dataBase)
    {
        $this->dataBase = $dataBase;
    }

    /**
     * Return the DataBase object.
     *
     * @return DataBase
     */
    public function getDataBase()
    {
        return $this->dataBase;
    }

    /**
     * Returns developer name.
     *
     * @return string
     */
    public function getDevName(): string
    {
        return $this->devName;
    }

    /**
     * Sets developer name.
     *
     * @param string $devName
     */
    public function setDevName(string $devName)
    {
        $this->devName = $devName;
    }

    /**
     * Returns developer email.
     *
     * @return string
     */
    public function getDevMail(): string
    {
        return $this->devMail;
    }

    /**
     * Sets developer email
     *
     * @param string $devMail
     */
    public function setDevMail(string $devMail)
    {
        $this->devMail = $devMail;
    }

    /**
     * Save file.
     *
     * @param string $pathName
     * @param string $content
     *
     * @return bool|int
     */
    protected function saveFile(string $pathName, string $content)
    {
        return file_put_contents($pathName, $content);
    }

    /**
     * Print a message.
     *
     * @param string $msg
     */
    protected function showMessage($msg)
    {
        if ($this->autoHide) {
            trigger_error($msg);
        } else {
            echo $msg;
        }
    }
}