Tenside\Core\Task\Composer\UpgradeTask

Complexity

Total Complexity

8

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	3
Bugs	0	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getPackages()	0	4	1
A	isSelectiveUpgrade()	0	4	1
A	getHome()	0	4	1
A	getDataDir()	0	4	1
A	getType()	0	4	1
A	prepareCommand()	0	9	1
A	prepareInput()	0	13	2

<?php

/**
 * This file is part of tenside/core.
 *
 * (c) Christian Schiffler <c.schiffler@cyberspectrum.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * This project is provided in good faith and hope to be usable by anyone.
 *
 * @package    tenside/core
 * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @copyright  2015 Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @license    https://github.com/tenside/core/blob/master/LICENSE MIT
 * @link       https://github.com/tenside/core
 * @filesource
 */

namespace Tenside\Core\Task\Composer;

use Composer\Command\UpdateCommand;
use Composer\Factory;
use Symfony\Component\Console\Input\ArrayInput;
use Tenside\Core\Util\RuntimeHelper;

/**
 * This class holds the information for an upgrade of some or all packages.
 */
class UpgradeTask extends AbstractComposerCommandTask
{
    /**
     * The packages to upgrade.
     */
    const SETTING_PACKAGES = 'packages';

    /**
     * The home path of tenside.
     */
    const SETTING_HOME = 'home';

    /**
     * The data directory of tenside.
     */
    const SETTING_DATA_DIR = 'data-dir';

    /**
     * Retrieve the names of the packages to upgrade or null if none.
     *
     * @return string[]|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getPackages()
    {
        return $this->file->get(self::SETTING_PACKAGES);
    }

    /**
     * Check if the upgrade is selective or for all packages.
     *
     * @return bool
     */
    public function isSelectiveUpgrade()
    {
        return (null !== $this->getPackages());
    }

    /**
     * Retrieve the home path of tenside.
     *
     * @return string
     */
    public function getHome()
    {
        return (string) $this->file->get(self::SETTING_HOME);
    }

    /**
     * Retrieve the data path of tenside.
     *
     * @return string
     */
    public function getDataDir()
    {
        return (string) $this->file->get(self::SETTING_DATA_DIR);
    }

    /**
     * Returns 'upgrade'.
     *
     * {@inheritdoc}
     */
    public function getType()
    {
        return 'upgrade';
    }

    /**
     * {@inheritDoc}
     */
    protected function prepareCommand()
    {
        RuntimeHelper::setupHome($this->getHome());

        $command = new UpdateCommand();
        $command->setComposer(Factory::create($this->getIO()));

        return $command;
    }

    /**
     * {@inheritDoc}
     */
    protected function prepareInput()
    {
        $arguments = [];

        if ($this->isSelectiveUpgrade()) {
            $arguments['packages'] = $this->getPackages();
        }

        $input = new ArrayInput($arguments);
        $input->setInteractive(false);

        return $input;
    }
}