aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/DataCollector/AbstractDataCollector.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/DataCollector/AbstractDataCollector.php')
-rw-r--r--lib/public/DataCollector/AbstractDataCollector.php69
1 files changed, 69 insertions, 0 deletions
diff --git a/lib/public/DataCollector/AbstractDataCollector.php b/lib/public/DataCollector/AbstractDataCollector.php
new file mode 100644
index 00000000000..ffb3cbe7b79
--- /dev/null
+++ b/lib/public/DataCollector/AbstractDataCollector.php
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\DataCollector;
+
+/**
+ * Children of this class must store the collected data in
+ * the data property.
+ *
+ * @author Fabien Potencier <fabien@symfony.com>
+ * @author Bernhard Schussek <bschussek@symfony.com>
+ * @author Carl Schwan <carl@carlschwan.eu>
+ * @since 24.0.0
+ */
+abstract class AbstractDataCollector implements IDataCollector, \JsonSerializable {
+ /** @var array */
+ protected $data = [];
+
+ /**
+ * @since 24.0.0
+ */
+ public function getName(): string {
+ return static::class;
+ }
+
+ /**
+ * Reset the state of the profiler. By default it only empties the
+ * $this->data contents, but you can override this method to do
+ * additional cleaning.
+ * @since 24.0.0
+ */
+ public function reset(): void {
+ $this->data = [];
+ }
+
+ /**
+ * @since 24.0.0
+ */
+ public function __sleep(): array {
+ return ['data'];
+ }
+
+ /**
+ * @internal to prevent implementing \Serializable
+ * @since 24.0.0
+ */
+ final protected function serialize() {
+ }
+
+ /**
+ * @internal to prevent implementing \Serializable
+ * @since 24.0.0
+ */
+ final protected function unserialize(string $data) {
+ }
+
+ /**
+ * @since 24.0.0
+ */
+ #[\ReturnTypeWillChange]
+ public function jsonSerialize() {
+ return $this->data;
+ }
+}