1	<?php
2
3	/**
4	* This program is free software; you can redistribute it and/or
5	* modify it under the terms of the GNU General Public License
6	* as published by the Free Software Foundation; under version 2
7	* of the License (non-upgradable).
8	*
9	* This program is distributed in the hope that it will be useful,
10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12	* GNU General Public License for more details.
13	*
14	* You should have received a copy of the GNU General Public License
15	* along with this program; if not, write to the Free Software
16	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17	*
18	* Copyright (c) 2014 (original work) Open Assessment Technologies SA;
19	*
20	*
21	*/
22
23	namespace oat\generis\model\data\permission;
24
25	use oat\oatbox\user\User;
26
27	/**
28	* Rdf interface to access the ontology
29	* This is an experimental interface that has not been implemented yet
30	*
31	* @author Joel Bout, <joel@taotesting.com>
32	* @package generis
33
34	*/
35	interface PermissionInterface
36	{
37	public const SERVICE_ID = 'generis/permissions';
38
39	/**
40	* All unsupported rigths will be mapped to this right
41	*
42	* @var string
43	*/
44	public const RIGHT_UNSUPPORTED = 'unsupported';
45	public const RIGHT_READ = 'READ';
46	public const RIGHT_WRITE = 'WRITE';
47
48	/**
49	* Return the permissions a specified user has on the resources
50	* specified by their ids
51	*
52	* This function should return an associativ array with the resourceIds
53	* as keys an the permission arrays as values
54	*
55	* @param User $user
56	* @param array $resourceIds
57	* @return array
58	*/
59	public function getPermissions(User $user, array $resourceIds);
60
61	/**
62	* Hook to set initial permissions
63	*/
64	public function onResourceCreated(\core_kernel_classes_Resource $resource);
65
66	/**
67	* Returns a list of rights ids
68	*
69	* @return array
70	*/
71	public function getSupportedRights();
72	}