aboutsummaryrefslogtreecommitdiffstats
path: root/lib/public/Migration/Attributes/MigrationAttribute.php
blob: 5b4550c4db564b3729bc4b6b424119af6aa84245 (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
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCP\Migration\Attributes;

use JsonSerializable;

/**
 * @since 30.0.0
 */
class MigrationAttribute implements JsonSerializable {
	/**
	 * @param string $table name of the database table
	 * @param string $description description of the migration
	 * @param array $notes notes about the migration
	 * @since 30.0.0
	 */
	public function __construct(
		private string $table,
		private string $description = '',
		private array $notes = [],
	) {
	}

	/**
	 * @param string $table
	 *
	 * @return $this
	 * @since 30.0.0
	 */
	public function setTable(string $table): self {
		$this->table = $table;
		return $this;
	}

	/**
	 * @return string
	 * @since 30.0.0
	 */
	public function getTable(): string {
		return $this->table;
	}

	/**
	 * @param string $description
	 *
	 * @return $this
	 * @since 30.0.0
	 */
	public function setDescription(string $description): self {
		$this->description = $description;
		return $this;
	}

	/**
	 * @return string
	 * @since 30.0.0
	 */
	public function getDescription(): string {
		return $this->description;
	}

	/**
	 * @param array $notes
	 *
	 * @return $this
	 * @since 30.0.0
	 */
	public function setNotes(array $notes): self {
		$this->notes = $notes;
		return $this;
	}

	/**
	 * @return array
	 * @since 30.0.0
	 */
	public function getNotes(): array {
		return $this->notes;
	}

	/**
	 * @return string
	 * @since 30.0.0
	 */
	public function definition(): string {
		return json_encode($this->jsonSerialize(), JSON_UNESCAPED_SLASHES);
	}

	/**
	 * @param array $data
	 *
	 * @return self
	 * @since 30.0.0
	 */
	public function import(array $data): self {
		return $this->setDescription($data['description'] ?? '')
					->setNotes($data['notes'] ?? []);
	}

	/**
	 * @return array
	 * @since 30.0.0
	 */
	public function jsonSerialize(): array {
		return [
			'class' => get_class($this),
			'table' => $this->getTable(),
			'description' => $this->getDescription(),
			'notes' => $this->getNotes()
		];
	}
}