aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/EventDispatcher/JsonSerializer.php
blob: d05367b746d20da9f617e8090774752ce5e1c350 (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCP\EventDispatcher;

use OC\Files\Node\NonExistingFile;
use OC\Files\Node\NonExistingFolder;
use OCP\Files\FileInfo;
use OCP\IUser;

/**
 * Contains helper static methods to serialize OCP classes into arrays to pass json_encode.
 * Useful for events implementing \JsonSerializable.
 *
 * @since 30.0.0
 */

final class JsonSerializer {
	/**
	 * @since 30.0.0
	 */
	public static function serializeFileInfo(FileInfo $node): array {
		if ($node instanceof NonExistingFile || $node instanceof NonExistingFolder) {
			return [
				'path' => $node->getPath(),
			];
		} else {
			return [
				'id' => $node->getId(),
				'path' => $node->getPath(),
			];
		}
	}

	/**
	 * @since 30.0.0
	 */
	public static function serializeUser(IUser $user): array {
		return [
			'uid' => $user->getUID(),
			'displayName' => $user->getDisplayName(),
		];
	}
}