horros / agavi2

src/model/Model.class.php

<?php
namespace Agavi\Model;

// +---------------------------------------------------------------------------+
// | 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;

/**
 * Model provides a convention for separating business logic from
 * application logic. When using a model you're providing a globally accessible
 * API for other modules to access, which will boost interoperability among
 * modules in your web application.
 *
 * @package    agavi
 * @subpackage model
 *
 * @author     Sean Kerr <skerr@mojavi.org>
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.9.0
 *
 * @version    $Id$
 */
abstract class Model implements ModelInterface
{
    /**
     * @var        Context A Context instance.
     */
    protected $context = null;

    /**
     * @var string The context name
     */
    protected $_contextName = null;
    /**
     * Retrieve the current application context.
     *
     * @return     Context The current Context instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    final public function getContext()
    {
        return $this->context;
    }

    /**
     * Initialize this model.
     *
     * @param      Context $context The current application context.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function initialize(Context $context, array $parameters = array())

The parameter $parameters is not used and could be removed.

    {
        $this->context = $context;
    }

    /**
     * Pre-serialization callback.
     *
     * Will set the name of the context and exclude the instance from serializing.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function __sleep()
    {
        $this->_contextName = $this->context->getName();
        $arr = get_object_vars($this);
        unset($arr['context']);
        return array_keys($arr);
    }

    /**
     * Post-unserialization callback.
     *
     * Will restore the context based on the names set by __sleep.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function __wakeup()
    {
        $this->context = Context::getInstance($this->_contextName);
        unset($this->_contextName);
    }
}