121 lines
4.1 KiB
PHP
121 lines
4.1 KiB
PHP
<?php
|
|
/*
|
|
* $Id$
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* This software consists of voluntary contributions made by many individuals
|
|
* and is licensed under the LGPL. For more information, see
|
|
* <http://www.phpdoctrine.org>.
|
|
*/
|
|
|
|
/**
|
|
* Doctrine_Template_Versionable
|
|
*
|
|
* Add revisioning/audit log to your models
|
|
*
|
|
* @package Doctrine
|
|
* @subpackage Template
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.phpdoctrine.org
|
|
* @since 1.0
|
|
* @version $Revision$
|
|
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
|
|
*/
|
|
class Doctrine_Template_Versionable extends Doctrine_Template
|
|
{
|
|
/**
|
|
* Array of AuditLog Options
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $_options = array('version' => array('name' => 'version',
|
|
'alias' => null,
|
|
'type' => 'integer',
|
|
'length' => 8,
|
|
'options' => array()),
|
|
'generateRelations' => true,
|
|
'tableName' => false,
|
|
'generateFiles' => false,
|
|
'auditLog' => true,
|
|
'deleteVersions' => true);
|
|
|
|
/**
|
|
* __construct
|
|
*
|
|
* @param array $options
|
|
* @return void
|
|
*/
|
|
public function __construct(array $options = array())
|
|
{
|
|
parent::__construct($options);
|
|
$this->_plugin = new Doctrine_AuditLog($this->_options);
|
|
}
|
|
|
|
/**
|
|
* Setup the Versionable behavior for the template
|
|
*
|
|
* @return void
|
|
*/
|
|
public function setUp()
|
|
{
|
|
if ($this->_plugin->getOption('auditLog')) {
|
|
$this->_plugin->initialize($this->_table);
|
|
}
|
|
|
|
$version = $this->_options['version'];
|
|
$name = $version['name'] . (isset($version['alias']) ? ' as ' . $version['alias'] : '');
|
|
$this->hasColumn($name, $version['type'], $version['length'], $version['options']);
|
|
|
|
$this->addListener(new Doctrine_AuditLog_Listener($this->_plugin));
|
|
}
|
|
|
|
/**
|
|
* Get plugin for Versionable template
|
|
*
|
|
* @return void
|
|
*/
|
|
public function getAuditLog()
|
|
{
|
|
return $this->_plugin;
|
|
}
|
|
|
|
/**
|
|
* revert
|
|
* reverts this record to given version, this method only works if versioning plugin
|
|
* is enabled
|
|
*
|
|
* @throws Doctrine_Record_Exception if given version does not exist
|
|
* @param integer $version an integer > 1
|
|
* @return Doctrine_Record this object
|
|
*/
|
|
public function revert($version)
|
|
{
|
|
$auditLog = $this->_plugin;
|
|
|
|
if ( ! $auditLog->getOption('auditLog')) {
|
|
throw new Doctrine_Record_Exception('Audit log is turned off, no version history is recorded.');
|
|
}
|
|
|
|
$data = $auditLog->getVersion($this->getInvoker(), $version);
|
|
|
|
if ( ! isset($data[0])) {
|
|
throw new Doctrine_Record_Exception('Version ' . $version . ' does not exist!');
|
|
}
|
|
|
|
$this->getInvoker()->merge($data[0]);
|
|
|
|
|
|
return $this->getInvoker();
|
|
}
|
|
} |