Use factory methods to create GEDCOM records

1 files changed, 63 insertions, 0 deletions

diff --git a/app/Contracts/HeaderFactoryInterface.php b/app/Contracts/HeaderFactoryInterface.php
new file mode 100644
index 0000000000..f14b2fa94e
--- /dev/null
+++ b/app/Contracts/HeaderFactoryInterface.php
@@ -0,0 +1,63 @@
+<?php
+
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2019 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU 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 General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace Fisharebest\Webtrees\Contracts;
+
+use Closure;
+use Fisharebest\Webtrees\Header;
+use Fisharebest\Webtrees\Tree;
+
+/**
+ * Make a header object.
+ */
+interface HeaderFactoryInterface
+{
+    /**
+     * Create a header.
+     *
+     * @param string      $xref
+     * @param Tree        $tree
+     * @param string|null $gedcom
+     *
+     * @return Header|null
+     */
+    public function make(string $xref, Tree $tree, string $gedcom = null): ?Header;
+
+    /**
+     * Create a header from a row in the database.
+     *
+     * @param Tree $tree
+     *
+     * @return Closure
+     */
+    public function mapper(Tree $tree): Closure;
+
+    /**
+     * Create a header from raw GEDCOM data.
+     *
+     * @param string      $xref
+     * @param string      $gedcom  an empty string for new/pending records
+     * @param string|null $pending null for a record with no pending edits,
+     *                             empty string for records with pending deletions
+     * @param Tree        $tree
+     *
+     * @return Header
+     */
+    public function new(string $xref, string $gedcom, ?string $pending, Tree $tree): Header;
+}