tao-test/app/taoRevision/model/RepositoryInterface.php

68 lines
1.9 KiB
PHP

<?php
/**
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; under version 2
* of the License (non-upgradable).
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Copyright (c) 2015 (original work) Open Assessment Technologies SA;
*
*/
namespace oat\taoRevision\model;
use core_kernel_classes_Resource as Resource;
interface RepositoryInterface
{
public const SERVICE_ID = 'taoRevision/repository';
/**
* Returns an array of Revision objects for a given resource
*
* @param string $resourceId
* @return Revision[]
*/
public function getAllRevisions(string $resourceId);
/**
* Returns revision, a specific version of changes
*
* @param string $resourceId
* @param int $version
* @throws RevisionNotFoundException
* @return Revision
*/
public function getRevision(string $resourceId, int $version);
/**
* Stores changes in the history
*
* @param Resource $resource
* @param string $message
* @param int|null $version
* @param string|null $userId
*
* @return Revision
*/
public function commit(Resource $resource, string $message, int $version = null, string $userId = null);
/**
* Restore a previous version
*
* @param Revision $revision
* @return bool
*/
public function restore(Revision $revision);
}