summaryrefslogtreecommitdiff
path: root/modules_v4
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@webtrees.net>2019-03-19 16:48:27 +0000
committerGreg Roach <fisharebest@webtrees.net>2019-03-20 07:23:00 +0000
commit9af6b024736711ef85eba12979344b0241b8b348 (patch)
treec209814bc3e24ee9d234d4bfec7b09b46632e531 /modules_v4
parent516bb6de6b63cdc70de4d6bbfbe053eb8f922923 (diff)
downloadwebtrees-9af6b024736711ef85eba12979344b0241b8b348.tar.gz
webtrees-9af6b024736711ef85eba12979344b0241b8b348.tar.bz2
webtrees-9af6b024736711ef85eba12979344b0241b8b348.zip
Add example report
Diffstat (limited to 'modules_v4')
-rw-r--r--modules_v4/example-report.disable/module.php46
-rw-r--r--modules_v4/example-report.disable/resources/report.xml11
2 files changed, 57 insertions, 0 deletions
diff --git a/modules_v4/example-report.disable/module.php b/modules_v4/example-report.disable/module.php
new file mode 100644
index 0000000000..cef8f2df3b
--- /dev/null
+++ b/modules_v4/example-report.disable/module.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace MyCustomNamespace;
+
+use Fisharebest\Webtrees\Module\AbstractModule;
+use Fisharebest\Webtrees\Module\ModuleCustomInterface;
+use Fisharebest\Webtrees\Module\ModuleCustomTrait;
+use Fisharebest\Webtrees\Module\ModuleReportInterface;
+use Fisharebest\Webtrees\Module\ModuleReportTrait;
+
+/**
+ * Example report.
+ */
+return new class extends AbstractModule implements ModuleCustomInterface, ModuleReportInterface {
+ use ModuleCustomTrait;
+ use ModuleReportTrait;
+
+ /**
+ * @return string
+ */
+ public function title(): string
+ {
+ return 'Custom report';
+ }
+
+ /**
+ * Where does this module store its resources
+ *
+ * @return string
+ */
+ public function resourcesFolder(): string
+ {
+ return __DIR__ . '/resources/';
+ }
+
+ /**
+ * Name of the XML report file, relative to the resources folder.
+ *
+ * @return string
+ */
+ public function xmlFilename(): string
+ {
+ return $this->resourcesFolder() . 'report.xml';
+
+ }
+};
diff --git a/modules_v4/example-report.disable/resources/report.xml b/modules_v4/example-report.disable/resources/report.xml
new file mode 100644
index 0000000000..cd4ba0cd5f
--- /dev/null
+++ b/modules_v4/example-report.disable/resources/report.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<Report>
+ <Title><var var="I18N::translate('Report')" /></Title>
+ <Description><var var="I18N::translate('Report')" /></Description>
+
+ <Style name="text" size="10"/>
+ <Doc>
+ <Body>
+ </Body>
+ </Doc>
+</Report>