Agavi\User\User

Complexity

Total Complexity

8

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getContext()	0	4	1
A	getStorageNamespace()	0	4	1
B	initialize()	0	22	4
A	startup()	0	3	1
A	shutdown()	0	5	1

<?php
namespace Agavi\User;

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// | Based on the Mojavi3 MVC Framework, Copyright (c) 2003-2005 Sean Kerr.    |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+
use Agavi\Core\Context;
use Agavi\Exception\InitializationException;
use Agavi\Util\AttributeHolder;

/**
 * AgaviUser wraps a client session and provides accessor methods for user
 * attributes. It also makes storing and retrieving multiple page form data
 * rather easy by allowing user attributes to be stored in namespaces, which
 * help organize data.
 *
 * @package    agavi
 * @subpackage user
 *
 * @author     Sean Kerr <skerr@mojavi.org>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.9.0
 *
 * @version    $Id$
 */
class User extends AttributeHolder
{
    /**
     * @var        Context A Context instance.
     */
    protected $context = null;

    /**
     * @var        string Storage namespace where user attributes are put.
     */
    protected $storageNamespace = 'org.agavi.user.User';

    /**
     * Retrieve the current application context.
     *
     * @return     Context A Context instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    final public function getContext()
    {
        return $this->context;
    }

    /**
     * Retrieve the Storage namespace
     *
     * @return     string The Storage namespace
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getStorageNamespace()
    {
        return $this->storageNamespace;
    }

    /**
     * Initialize this User.
     *
     * @param      Context $context An Context instance.
     * @param      array   $parameters An associative array of initialization parameters.
     *
     * @throws     InitializationException If an error occurs while
     *                                                 initializing this User.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.9.0
     */
    public function initialize(Context $context, array $parameters = array())
    {
        $this->context = $context;

        if (isset($parameters['default_namespace'])) {
            $this->defaultNamespace = $parameters['default_namespace'];
        }
        
        if (isset($parameters['storage_namespace'])) {
            $this->storageNamespace = $parameters['storage_namespace'];
        }

        $this->setParameters($parameters);
        
        // read data from storage
        $this->attributes = $context->getStorage()->read($this->storageNamespace);

It seems like $context->getStorage()->read($this->storageNamespace) of type * is incompatible with the declared type array of property $attributes.

        if ($this->attributes == null) {
            // initialize our attributes array
            $this->attributes = array();
        }
    }

    /**
     * Startup the user.
     *
     * You'd usually try to auth from a cookie here etc.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function startup()
    {
    }

    /**
     * Execute the shutdown procedure.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function shutdown()
    {
        // write attributes to the storage
        $this->getContext()->getStorage()->write($this->storageNamespace, $this->attributes);
    }
}