PommProject\Cli\Command\SessionAwareCommand

Complexity

Total Complexity

7

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	execute()	0	5	1
A	configureRequiredArguments()	0	12	1
A	getSession()	0	12	2
A	mustBeModelManagerSession()	0	13	2
A	setSession()	0	6	1

<?php
/*
 * This file is part of Pomm's Cli package.
 *
 * (c) 2014 - 2015 Grégoire HUBERT <hubert.greg@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PommProject\Cli\Command;

use PommProject\Cli\Exception\GeneratorException;
use PommProject\Foundation\Inspector\InspectorPooler;
use PommProject\Foundation\Session\Session;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * SessionAwareCommand
 *
 * Base command for Cli commands that need a session.
 *
 * @package   Cli
 * @copyright 2014 - 2015 Grégoire HUBERT
 * @author    Grégoire HUBERT
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       Command
 */
class SessionAwareCommand extends PommAwareCommand
{
    private $session;

    protected $config_name;

    /**
     * execute
     *
     * Set pomm dependent variables.
     *
     * @see Command
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        parent::execute($input, $output);
        $this->config_name = $input->getArgument('config-name');
    }

    /**
     * configureRequiredArguments
     *
     * In order to keep the same argument order for all commands, it is
     * necessary to be able to declare base required fields before subcommands.
     *
     * @access protected
     * @return PommAwareCommand $this
     */
    protected function configureRequiredArguments()
    {
        $this
            ->addArgument(
                'config-name',
                InputArgument::REQUIRED,
                'Database configuration name to open a session.'
            )
            ;

        return $this;
    }

    /**
     * getSession
     *
     * Return a session.
     *
     * @access protected
     * @return Session
     */
    protected function getSession()
    {
        if ($this->session === null) {
            $this->session = $this
                ->getPomm()
                ->getSession($this->config_name)

It seems like $this->config_name can also be of type array<integer,string> or null; however, PommProject\Foundation\Pomm::getSession() does only seem to accept string, maybe add an additional type check?

                ->registerClientPooler(new InspectorPooler())
                ;
        }

        return $this->session;
    }

    /**
     * mustBeModelManagerSession
     *
     * Check if a session is a \PommProject\ModelManager\Session.
     *
     * @access protected
     * @param  Session $session
     * @throws GeneratorException
     * @return Session
     */
    protected function mustBeModelManagerSession(Session $session)
    {
        if (!$session instanceof \PommProject\ModelManager\Session) {
            throw new GeneratorException(
                sprintf(
                    "To generate models, you should use a '\PommProject\ModelManager\Session session' ('%s' used).",
                    get_class($session)
                )
            );
        }

        return $session;
    }

    /**
     * setSession
     *
     * When testing, it is useful to provide directly the session to be used.
     *
     * @access public
     * @param  Session          $session
     * @return PommAwareCommand
     */
    public function setSession(Session $session)
    {
        $this->session = $session;

        return $this;
    }
}