[impressum] Update config file style/name
authorHypolite Petovan <hypolite@mrpetovan.com>
Sun, 25 Nov 2018 07:12:44 +0000 (02:12 -0500)
committerHypolite Petovan <hypolite@mrpetovan.com>
Sun, 25 Nov 2018 07:12:44 +0000 (02:12 -0500)
impressum/README.md
impressum/config/impressum.config.php [new file with mode: 0644]
impressum/config/impressum.ini.php [deleted file]
impressum/impressum.php

index 0d0aa51..ca78d9a 100644 (file)
@@ -16,13 +16,14 @@ Simply fill in the fields in the impressium settings page in the addons area of
 
 Manual Configuration
 --------------------
-If you for any reason you prefer to use a configuration file instead, you can set the following variables in the config/addon.ini.php file
+If you for any reason you prefer to use a configuration file instead, you can set the following variables in the `config/addon.config.php` file
 
-       [impressum]
-       owner =           this is the Name of the Operator
-       ownerprofile =    this is an optional Friendica account where the above owner name will link to
-       email =           a contact email address (optional)
-                                         will be displayed slightly obfuscated as name(at)example(dot)com
-       postal =          should contain a postal address where you can be reached at (optional)
-       notes =           additional informations that should be displayed in the Impressum block
-       footer_text =     Text that will be displayed at the bottom of the pages.
+       'impressum' => [
+        'owner' => '',           This is the Name of the Operator
+        'ownerprofile' => '',    This is an optional Friendica account where the above owner name will link to
+        'email' => '',           A contact email address (optional)
+                                 Will be displayed slightly obfuscated as name(at)example(dot)com
+        'postal' => '',          Should contain a postal address where you can be reached at (optional)
+        'notes' => '',           Additional informations that should be displayed in the Impressum block
+        'footer_text' => '',     Text that will be displayed at the bottom of the pages.
+    ],
diff --git a/impressum/config/impressum.config.php b/impressum/config/impressum.config.php
new file mode 100644 (file)
index 0000000..9fe672f
--- /dev/null
@@ -0,0 +1,33 @@
+<?php
+
+// Warning: Don't change this file! It only holds the default config values for this addon.
+// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+
+return [
+       'impressum' => [
+               // owner (String)
+               // This is the Name of the Operator
+               'owner' => '',
+
+               // ownerprofile (String)
+               // This is an optional Friendica account where the above owner name will link to
+               'ownerprofile' => '',
+
+               // email (String)
+               // A contact email address (optional)
+               // Will be displayed slightly obfuscated as name(at)example(dot)com
+               'email' => '',
+
+               // postal (String)
+               // Should contain a postal address where you can be reached at (optional)
+               'postal' => '',
+
+               // notes (String)
+               // Additional informations that should be displayed in the Impressum block
+               'notes' => '',
+
+               // footer_text (String)
+               // Text that will be displayed at the bottom of the pages.
+               'footer_text' => '',
+       ],
+];
diff --git a/impressum/config/impressum.ini.php b/impressum/config/impressum.ini.php
deleted file mode 100644 (file)
index 1de4468..0000000
+++ /dev/null
@@ -1,33 +0,0 @@
-<?php return <<<INI
-
-; Warning: Don't change this file! It only holds the default config values for this addon.
-; Instead overwrite these config values in config/addon.ini.php in your Friendica directory
-
-[impressum]
-; owner (String)
-; This is the Name of the Operator
-owner =
-
-; ownerprofile (String)
-; This is an optional Friendica account where the above owner name will link to
-ownerprofile =
-
-; email (String)
-; A contact email address (optional)
-; Will be displayed slightly obfuscated as name(at)example(dot)com
-email =
-
-; postal (String)
-; Should contain a postal address where you can be reached at (optional)
-postal =
-
-; notes (String)
-; Additional informations that should be displayed in the Impressum block
-notes =
-
-; footer_text (String)
-; Text that will be displayed at the bottom of the pages.
-footer_text =
-
-INI;
-//Keep this line
\ No newline at end of file
index 3e04c64..6300efc 100644 (file)
@@ -54,7 +54,7 @@ function impressum_footer($a, &$b) {
 
 function impressum_load_config(\Friendica\App $a)
 {
-       $a->loadConfigFile(__DIR__. '/config/impressum.ini.php');
+       $a->loadConfigFile(__DIR__ . '/config/impressum.config.php');
 }
 
 function impressum_show($a,&$b) {