blob: 1831496a5a760fc7acace93ebcf5a61d0b638046 (
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
<?php
declare(strict_types=1);
/**
* @copyright 2022 Carl Schwan <carl@carlschwan.eu>
*
* @author Carl Schwan <carl@carlschwan.eu>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCP\Profiler;
use OCP\DataCollector\IDataCollector;
/**
* This interface store the results of the profiling of one
* request. You can get the saved profiles from the @see IProfiler.
*
* ```php
* <?php
* $profiler = \OC::$server->get(IProfiler::class);
* $profiles = $profiler->find('/settings/users', 10);
* ```
*
* This interface is meant to be used directly and not extended.
* @since 24.0.0
*/
interface IProfile {
/**
* Get the token of the profile
* @since 24.0.0
*/
public function getToken(): string;
/**
* Set the token of the profile
* @since 24.0.0
*/
public function setToken(string $token): void;
/**
* Get the time of the profile
* @since 24.0.0
*/
public function getTime(): ?int;
/**
* Set the time of the profile
* @since 24.0.0
*/
public function setTime(int $time): void;
/**
* Get the url of the profile
* @since 24.0.0
*/
public function getUrl(): ?string;
/**
* Set the url of the profile
* @since 24.0.0
*/
public function setUrl(string $url): void;
/**
* Get the method of the profile
* @since 24.0.0
*/
public function getMethod(): ?string;
/**
* Set the method of the profile
* @since 24.0.0
*/
public function setMethod(string $method): void;
/**
* Get the status code of the profile
* @since 24.0.0
*/
public function getStatusCode(): ?int;
/**
* Set the status code of the profile
* @since 24.0.0
*/
public function setStatusCode(int $statusCode): void;
/**
* Add a data collector to the profile
* @since 24.0.0
*/
public function addCollector(IDataCollector $collector);
/**
* Get the parent profile to this profile
* @since 24.0.0
*/
public function getParent(): ?IProfile;
/**
* Set the parent profile to this profile
* @since 24.0.0
*/
public function setParent(?IProfile $parent): void;
/**
* Get the parent token to this profile
* @since 24.0.0
*/
public function getParentToken(): ?string;
/**
* Get the profile's children
* @return IProfile[]
* @since 24.0.0
**/
public function getChildren(): array;
/**
* Set the profile's children
* @param IProfile[] $children
* @since 24.0.0
*/
public function setChildren(array $children): void;
/**
* Add the child profile
* @since 24.0.0
*/
public function addChild(IProfile $profile): void;
/**
* Get all the data collectors
* @return IDataCollector[]
* @since 24.0.0
*/
public function getCollectors(): array;
/**
* Set all the data collectors
* @param IDataCollector[] $collectors
* @since 24.0.0
*/
public function setCollectors(array $collectors): void;
/**
* Get a data collector by name
* @since 24.0.0
*/
public function getCollector(string $collectorName): ?IDataCollector;
}
|
