summaryrefslogtreecommitdiffstats
path: root/lib/public/DirectEditing/ACreateEmpty.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/public/DirectEditing/ACreateEmpty.php')
-rw-r--r--lib/public/DirectEditing/ACreateEmpty.php71
1 files changed, 71 insertions, 0 deletions
diff --git a/lib/public/DirectEditing/ACreateEmpty.php b/lib/public/DirectEditing/ACreateEmpty.php
new file mode 100644
index 00000000000..79684e33b80
--- /dev/null
+++ b/lib/public/DirectEditing/ACreateEmpty.php
@@ -0,0 +1,71 @@
+<?php
+/**
+ * @copyright Copyright (c) 2019 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\DirectEditing;
+
+
+use OCP\Files\File;
+
+/**
+ * @since 18.0.0
+ */
+abstract class ACreateEmpty {
+
+ /**
+ * Unique id for the creator to filter templates
+ *
+ * e.g. document/spreadsheet/presentation
+ *
+ * @since 18.0.0
+ * @return string
+ */
+ abstract public function getId(): string;
+
+ /**
+ * Descriptive name for the create action
+ *
+ * e.g Create a new document
+ *
+ * @since 18.0.0
+ * @return string
+ */
+ abstract public function getName(): string;
+
+ /**
+ * Default file extension for the new file
+ *
+ * @since 18.0.0
+ * @return string
+ */
+ abstract public function getExtension(): string;
+
+ /**
+ * Add content when creating empty files
+ *
+ * @since 18.0.0
+ * @param File $file
+ */
+ public function create(File $file, string $creatorId = null, string $templateId = null): void {
+
+ }
+}