Initial commit

application/Espo/ORM/Repository/Repository.php

@@ -0,0 +1,70 @@
+<?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\Repository;
+
+use Espo\ORM\Entity;
+
+/**
+ * An access point for record fetching and storing.
+ *
+ * @template TEntity of Entity
+ */
+interface Repository
+{
+    /**
+     * Get a new entity.
+     *
+     * @return TEntity
+     */
+    public function getNew(): Entity;
+
+    /**
+     * Fetch an entity by ID.
+     *
+     * @return ?TEntity
+     */
+    public function getById(string $id): ?Entity;
+
+    /**
+     * Store an entity.
+     *
+     * @param TEntity $entity
+     * @param array<string, mixed> $options
+     */
+    public function save(Entity $entity, array $options = []): void;
+
+    /**
+     * Remove an entity.
+     *
+     * @param TEntity $entity
+     * @param array<string, mixed> $options
+     */
+    public function remove(Entity $entity, array $options = []): void;
+}