blob: fad19c60aadc7fc6a96dbbee1d5b84c4d5eb3614 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
|
<?php
/**
* SPDX-FileCopyrightText: 2019 ownCloud GmbH
* SPDX-License-Identifier: AGPL-3.0-only
*/
namespace OCP\Share;
/**
* Interface IAttributes
*
* @package OCP\Share
* @since 25.0.0
*/
interface IAttributes {
/**
* Sets an attribute. If the key did not exist before it will be created.
*
* @param string $scope scope
* @param string $key key
* @param bool|string|array|null $value value
* @return IAttributes The modified object
* @since 25.0.0
*/
public function setAttribute(string $scope, string $key, mixed $value): IAttributes;
/**
* Returns the attribute for given scope id and key.
* If attribute does not exist, returns null
*
* @param string $scope scope
* @param string $key key
* @return bool|string|array|null
* @since 25.0.0
*/
public function getAttribute(string $scope, string $key): mixed;
/**
* Formats the IAttributes object to array with the following format:
* [
* 0 => [
* "scope" => <string>,
* "key" => <string>,
* "value" => <bool|string|array|null>,
* ],
* ...
* ]
*
* @return array formatted IAttributes
* @since 25.0.0
* @since 30.0.0, `enabled` was renamed to `value`
*/
public function toArray(): array;
}
|
