PommProject\Foundation\Client\ClientTrait

Complexity

Total Complexity

4

Size/Duplication

Total Lines	43
Duplicated Lines	30.23 %

Coupling/Cohesion

Components	1
Dependencies	1

3 Methods

Rating	Name	Duplication	Size	Complexity
A	initialize()	0	4	1
A	shutdown()	0	3	1
A	getSession()	13	13	2

<?php
/*
 * This file is part of the Pomm's Foundation 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\Foundation\Client;

use PommProject\Foundation\Session\Session;
use PommProject\Foundation\Exception\FoundationException;

/**
 * ClientTrait
 *
 * Abstract class for Session clients.
 *
 * @package   Foundation
 * @copyright 2014 - 2015 Grégoire HUBERT
 * @author    Grégoire HUBERT
 * @license   X11 {@link http://opensource.org/licenses/mit-license.php}
 * @see       ClientInterface
 * @abstract
 */
trait ClientTrait
{
    private $session;

    /**
     * @see ClientInterface
     */
    public function initialize(Session $session)
    {
        $this->session = $session;
    }

    /**
     * Most of the time, there is nothing to be done at shutdown.
     * @see ClientInterface
     */
    public function shutdown()
    {
    }

    /**
     * getSession
     *
     * All subclasses of Client have to use this method to access the session.
     *
     * @access protected
     * @throws  FoundationException if Session is not set.
     * @return Session
     */
    protected function getSession()
    {
        if ($this->session === null) {
            throw new FoundationException(
                sprintf(
                    "Client '%s' is not initialized hence does not have a session.",
                    get_class($this)
                )
            );
        }

        return $this->session;
    }
}