PommProject\Foundation\Tester\VanillaSessionAtoum

Complexity

Total Complexity

4

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
	initializeSession()	0	1	?
A	buildSession()	0	7	1
A	getSessionBuilder()	0	8	2
A	createSessionBuilder()	0	4	1

<?php
/*
 * This file is part of the PommProject/Foundation package.
 *
 * (c) 2014 - 2017 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\Foundation\Tester;

use PommProject\Foundation\Session\Session;
use PommProject\Foundation\Session\SessionBuilder;
use Atoum;

/**
 * VanillaSessionAtoum
 *
 * This is a Session aware Atoum class. It uses the vanilla session builder
 * hence produce session with no poolers nor clients.
 * It is intended to be overloaded by each package to add their own poolers.
 *
 * @package   Foundation
 * @copyright 2014 - 2017 Grégoire HUBERT
 * @author    Grégoire HUBERT
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       Atoum
 */
abstract class VanillaSessionAtoum extends Atoum
{
    private $session_builder;

    /**
     * buildSession
     *
     * A short description here
     *
     * @param  string       $stamp
     * @return Session
     */
    protected function buildSession($stamp = null)
    {
        $session = $this->getSessionBuilder()->buildSession($stamp);
        $this->initializeSession($session);

        return $session;
    }

    /**
     * getSessionBuilder
     *
     * Return a SessionBuilder.
     *
     * @return SessionBuilder
     */
    private function getSessionBuilder()
    {
        if ($this->session_builder === null) {
            $this->session_builder = $this->createSessionBuilder($GLOBALS['pomm_db1']);
        }

        return $this->session_builder;
    }

    /**
     * createSessionBuilder
     *
     * Instantiate a new SessionBuilder. This method is to be overloaded by
     * each package to instantiate their own SessionBuilder if any.
     *
     * @param  array $configuration
     * @return SessionBuilder
     */
    protected function createSessionBuilder(array $configuration)
    {
        return new SessionBuilder($configuration);
    }

    /**
     * initializeSession
     *
     * If the test needs special poolers and/or client configuration, it goes
     * here.
     *
     * @param   Session $session
     * @return  null
     */
    abstract protected function initializeSession(Session $session);
}