blob: 50edabb47ffa994839d480bbeef236b7ed6bd8c7 (
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
|
<?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 OC\AppFramework\Http\Request;
use OCP\AppFramework\Http\Response;
use OCP\DataCollector\IDataCollector;
/**
* This interface allows to interact with the built-in Nextcloud profiler.
* @since 24.0.0
*/
interface IProfiler {
/**
* Add a new data collector to the profiler. This allows to later on
* collect all the data from every registered collector.
*
* @see IDataCollector
* @since 24.0.0
*/
public function add(IDataCollector $dataCollector): void;
/**
* Load a profile from a response object
* @since 24.0.0
*/
public function loadProfileFromResponse(Response $response): ?IProfile;
/**
* Load a profile from the response token
* @since 24.0.0
*/
public function loadProfile(string $token): ?IProfile;
/**
* Save a profile on the disk. This allows to later load it again in the
* profiler user interface.
* @since 24.0.0
*/
public function saveProfile(IProfile $profile): bool;
/**
* Find a profile from various search parameters
* @since 24.0.0
*/
public function find(?string $url, ?int $limit, ?string $method, ?int $start, ?int $end, ?string $statusCode = null): array;
/**
* Get the list of data providers by identifier
* @return string[]
* @since 24.0.0
*/
public function dataProviders(): array;
/**
* Check if the profiler is enabled.
*
* If it is not enabled, data provider shouldn't be created and
* shouldn't collect any data.
* @since 24.0.0
*/
public function isEnabled(): bool;
/**
* Set if the profiler is enabled.
* @see isEnabled
* @since 24.0.0
*/
public function setEnabled(bool $enabled): void;
/**
* Collect all the information from the current request and construct
* a IProfile from it.
* @since 24.0.0
*/
public function collect(Request $request, Response $response): IProfile;
/**
* Clear the stored profiles
* @since 25.0.0
*/
public function clear(): void;
}
|
