mirror of
https://github.com/nextcloud/server.git
synced 2025-02-24 17:06:50 +00:00
60 lines
2 KiB
PHP
60 lines
2 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
/**
|
|
* @copyright Copyright (c) 2023 Julius Härtl <jus@bitgrid.net>
|
|
*
|
|
* @author Julius Härtl <jus@bitgrid.net>
|
|
*
|
|
* @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\DB\Events;
|
|
|
|
/**
|
|
* Event to allow apps to register information about missing database primary keys
|
|
*
|
|
* This event will be dispatched for checking on the admin settings and when running
|
|
* occ db:add-missing-primary-keys which will then create those keys
|
|
*
|
|
* @since 28.0.0
|
|
*/
|
|
class AddMissingPrimaryKeyEvent extends \OCP\EventDispatcher\Event {
|
|
/** @var array<array-key, array{tableName: string, primaryKeyName: string, columns: string[], formerIndex: null|string}> */
|
|
private array $missingPrimaryKeys = [];
|
|
|
|
/**
|
|
* @param string[] $columns
|
|
* @since 28.0.0
|
|
*/
|
|
public function addMissingPrimaryKey(string $tableName, string $primaryKeyName, array $columns, ?string $formerIndex = null): void {
|
|
$this->missingPrimaryKeys[] = [
|
|
'tableName' => $tableName,
|
|
'primaryKeyName' => $primaryKeyName,
|
|
'columns' => $columns,
|
|
'formerIndex' => $formerIndex,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @since 28.0.0
|
|
* @return array<array-key, array{tableName: string, primaryKeyName: string, columns: string[], formerIndex: null|string}>
|
|
*/
|
|
public function getMissingPrimaryKeys(): array {
|
|
return $this->missingPrimaryKeys;
|
|
}
|
|
}
|