Apix\Session

Complexity

Total Complexity

12

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	getUsername()	0	4	1
A	getGroup()	0	4	1
A	setGroup()	0	4	1
A	getTrustedIps()	0	4	1
A	setTrustedIps()	0	4	1
A	hasTrustedIps()	0	4	1
A	addData()	0	4	1
A	hasData()	0	4	1
A	getData()	0	6	3

<?php

/**
 *
 * This file is part of the Apix Project.
 *
 * (c) Franck Cassedanne <franck at ouarz.net>
 *
 * @license     http://opensource.org/licenses/BSD-3-Clause  New BSD License
 *
 */

namespace Apix;

class Session
{

    /**
     * Holds the session's username.
     * @var string
     */
    protected $username;

    /**
     * Holds this user's group.
     * @var string
     */
    protected $group;

    /**
     * Holds the user's trusted IPs.
     * @var array
     */
    protected $ips = null;

    /**
     * Holds some user's arbitrary data.
     * @var array
     */
    protected $data = array();

    /**
     * Constructor will set the session for the given username.
     *
     * @param string      $username
     * @param string|null $group
     */
    public function __construct($username, $group = null)
    {
        $this->username = $username;
        $this->group = $group;

        // session_start();
    }

    /**
     * Returns the username.
     *
     * @return string
     */
    public function getUsername()
    {
        return $this->username;
    }

    /**
     * Returns the user's group.
     *
     * @return string
     */
    public function getGroup()
    {
        return $this->group;
    }

    /**
     * Sets the user's group.
     *
     * @param  string $group
     * @return void
     */
    public function setGroup($group)
    {
        $this->group = $group;
    }

    /**
     * Returns the trusted IPs.
     *
     * @return array
     */
    public function getTrustedIps()
    {
        return $this->ips;
    }

    /**
     * Sets the trusted IPs.
     *
     * @param  array $ips
     * @return void
     */
    public function setTrustedIps(array $ips=null)
    {
        $this->ips = $ips;

It seems like $ips can be null. However, the property $ips is declared as array. Maybe change the type of the property to array|null or add a type check?

    }

    /**
     * Check if the specified user data is set.
     *
     * @param  string  $group

There is no parameter named $group. Was it maybe removed?

     * @return boolean
     */
    public function hasTrustedIps()
    {
        return null !== $this->ips;
    }

    /**
     * Adds arbitrary session data.
     *
     * @param  string $group

There is no parameter named $group. Was it maybe removed?

     * @return void
     */
    public function addData($key, $value)
    {
        $this->data[$key] = $value;
    }

    /**
     * Checks wether the specified key is set in the session dataset.
     *
     * @param  string  $group

There is no parameter named $group. Was it maybe removed?

     * @return boolean
     */
    public function hasData($key)
    {
        return isset($this->data[$key]);
    }

    /**
     * Returns the specified data -- or the whole dataset if null.
     *
     * @param  string     $key
     * @return mixed|null
     */
    public function getData($key=null)
    {
        if(null === $key) return $this->data;

        return isset($this->data[$key]) ? $this->data[$key] : null;
    }

}