magallanes/src/Task/BuiltIn/FS/RemoveTask.php

<?php

/*
 * This file is part of the Magallanes package.
 *
 * (c) Andrés Montañez <andres@andresmontanez.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Mage\Task\BuiltIn\FS;

use Symfony\Component\Process\Process;

/**
 * File System Task - Remove a File
 *
 * @author Andrés Montañez <andresmontanez@gmail.com>
 */
class RemoveTask extends AbstractFileTask
{
    public function getName(): string
    {
        return 'fs/remove';
    }

    public function getDescription(): string
    {
        try {
            return sprintf('[FS] Remove "%s"', $this->getFile('file'));
        } catch (\Exception $exception) {
            return '[FS] Remove [missing parameters]';
        }
    }

    public function execute(): bool
    {
        $file = $this->getFile('file');
        $flags = $this->options['flags'];

        $cmd = sprintf('rm %s "%s"', $flags, $file);

        /** @var Process $process */
        $process = $this->runtime->runCommand($cmd);

        return $process->isSuccessful();
    }

    protected function getParameters(): array
    {
        return ['file', 'flags'];
    }

    public function getDefaults(): array
    {
        return ['flags' => null];
    }
}