Initial commit

application/Espo/ORM/Locker/Locker.php

@@ -0,0 +1,62 @@
+<?php
+/************************************************************************
+ * This file is part of EspoCRM.
+ *
+ * EspoCRM – Open Source CRM application.
+ * Copyright (C) 2014-2025 EspoCRM, Inc.
+ * Website: https://www.espocrm.com
+ *
+ * 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 <https://www.gnu.org/licenses/>.
+ *
+ * The interactive user interfaces in modified source and object code versions
+ * of this program must display Appropriate Legal Notices, as required under
+ * Section 5 of the GNU Affero General Public License version 3.
+ *
+ * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
+ * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
+ ************************************************************************/
+
+namespace Espo\ORM\Locker;
+
+/**
+ * Locks and unlocks tables.
+ * Wraps operations between lock and unlock into a transaction.
+ */
+interface Locker
+{
+    /**
+     * Whether any table has been locked.
+     */
+    public function isLocked(): bool;
+
+    /**
+     * Locks a table in an exclusive mode. Starts a transaction on first call.
+     */
+    public function lockExclusive(string $entityType): void;
+
+    /**
+     * Locks a table in a share mode. Starts a transaction on first call.
+     */
+    public function lockShare(string $entityType): void;
+
+    /**
+     * Commits changes and unlocks tables.
+     */
+    public function commit(): void;
+
+    /**
+     * Rollbacks changes and unlocks tables.
+     */
+    public function rollback(): void;
+}