From: Hypolite Petovan Date: Wed, 8 May 2019 04:43:27 +0000 (-0400) Subject: [cookienotice] Move user addon settings to admin page X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=31e89b43feff000ba9fd5f3ff8571d982680b523;p=friendica-addons.git [cookienotice] Move user addon settings to admin page - Reformat code - Remove uninstall function which doesn't include any specific uninstalling code besides hooks --- diff --git a/cookienotice/README b/cookienotice/README index 74edd44a..247f53b1 100644 --- a/cookienotice/README +++ b/cookienotice/README @@ -2,6 +2,8 @@ Cookie Notice For server admins only. -Configure, show and handle a simple cookie usage notice. This absolute annoying but eventually necessary notification about the usage of cookies. This kind of things you klick ok on but don't read. +Configure, show and handle a simple cookie usage notice. +This absolute annoying but eventually necessary notification about the usage of cookies. +This kind of things you click ok on but don't read. -Author: Peter liebetrau +Author: Peter Liebetrau diff --git a/cookienotice/cookienotice.php b/cookienotice/cookienotice.php index 376de1ad..cc36bc29 100644 --- a/cookienotice/cookienotice.php +++ b/cookienotice/cookienotice.php @@ -5,70 +5,49 @@ * Description: Configure, show and handle a simple cookie notice * Version: 1.0 * Author: Peter Liebetrau - * */ -use Friendica\Core\Hook; + +use Friendica\App; use Friendica\Core\Config; +use Friendica\Core\Hook; use Friendica\Core\L10n; use Friendica\Core\Renderer; /** * cookienotice_install * registers hooks - * + * * @return void */ function cookienotice_install() { Hook::register('page_content_top', __FILE__, 'cookienotice_page_content_top'); Hook::register('page_end', __FILE__, 'cookienotice_page_end'); - Hook::register('addon_settings', __FILE__, 'cookienotice_addon_settings'); - Hook::register('addon_settings_post', __FILE__, 'cookienotice_addon_settings_post'); -} - -/** - * cookienotice_uninstall - * unregisters hooks - * - * @return void -*/ -function cookienotice_uninstall() -{ - Hook::unregister('page_content_top', __FILE__, 'cookienotice_page_content_top'); - Hook::unregister('page_end', __FILE__, 'cookienotice_page_end'); - Hook::unregister('addon_settings', __FILE__, 'cookienotice_addon_settings'); - Hook::unregister('addon_settings_post', __FILE__, 'cookienotice_addon_settings_post'); } /** - * cookienotice_addon_settings - * addon_settings hook + * cookienotice_addon_admin * creates the admins config panel - * - * @param \Friendica\App $a + * + * @param App $a * @param string $s The existing config panel html so far - * + * * @return void */ -function cookienotice_addon_settings(\Friendica\App $a, &$s) +function cookienotice_addon_admin(App $a, &$s) { if (!is_site_admin()) { return; } - /* Add our stylesheet to the page so we can make our settings look nice */ - $stylesheetPath = 'addon/cookienotice/cookienotice.css'; - $a->registerStylesheet($stylesheetPath); - $text = Config::get('cookienotice', 'text', L10n::t('This website uses cookies. If you continue browsing this website, you agree to the usage of cookies.')); $oktext = Config::get('cookienotice', 'oktext', L10n::t('OK')); - $t = Renderer::getMarkupTemplate("settings.tpl", "addon/cookienotice/"); + $t = Renderer::getMarkupTemplate('admin.tpl', __DIR__); $s .= Renderer::replaceMacros($t, [ - '$title' => L10n::t('"cookienotice" Settings'), '$description' => L10n::t('Configure your cookie usage notice. It should just be a notice, saying that the website uses cookies. It is shown as long as a user didnt confirm clicking the OK button.'), - '$text' => ['cookienotice-text', L10n::t('Cookie Usage Notice'), $text, L10n::t('The cookie usage notice')], - '$oktext' => ['cookienotice-oktext', L10n::t('OK Button Text'), $oktext, L10n::t('The OK Button text')], + '$text' => ['cookienotice-text', L10n::t('Cookie Usage Notice'), $text], + '$oktext' => ['cookienotice-oktext', L10n::t('OK Button Text'), $oktext], '$submit' => L10n::t('Save Settings') ]); @@ -76,16 +55,16 @@ function cookienotice_addon_settings(\Friendica\App $a, &$s) } /** - * cookienotice_addon_settings_post + * cookienotice_addon_admin_post * addon_settings_post hook * handles the post request from the admin panel - * - * @param \Friendica\App $a + * + * @param App $a * @param string $b - * + * * @return void */ -function cookienotice_addon_settings_post(\Friendica\App $a, &$b) +function cookienotice_addon_admin_post(App $a, &$b) { if (!is_site_admin()) { return; @@ -102,16 +81,16 @@ function cookienotice_addon_settings_post(\Friendica\App $a, &$b) * cookienotice_page_content_top * page_content_top hook * adds css and scripts to the section of the html - * - * @param \Friendica\App $a - * @param string $b unnused - the header html incl. nav - * + * + * @param App $a + * @param string $b unused - the header html incl. nav + * * @return void */ -function cookienotice_page_content_top(\Friendica\App $a, &$b) +function cookienotice_page_content_top(App $a, &$b) { - $stylesheetPath = 'addon/cookienotice/cookienotice.css'; - $footerscriptPath = 'addon/cookienotice/cookienotice.js'; + $stylesheetPath = __DIR__ . '/cookienotice.css'; + $footerscriptPath = __DIR__ . '/cookienotice.js'; $a->registerStylesheet($stylesheetPath); $a->registerFooterScript($footerscriptPath); @@ -121,18 +100,18 @@ function cookienotice_page_content_top(\Friendica\App $a, &$b) * cookienotice_page_end * page_end hook * ads our cookienotice box to the end of the html - * - * @param \Friendica\App $a + * + * @param App $a * @param string $b the page html - * + * * @return void */ -function cookienotice_page_end(\Friendica\App $a, &$b) +function cookienotice_page_end(App $a, &$b) { - $text = (string) Config::get('cookienotice', 'text', L10n::t('This website uses cookies to recognize revisiting and logged in users. You accept the usage of these cookies by continue browsing this website.')); - $oktext = (string) Config::get('cookienotice', 'oktext', L10n::t('OK')); + $text = (string)Config::get('cookienotice', 'text', L10n::t('This website uses cookies to recognize revisiting and logged in users. You accept the usage of these cookies by continue browsing this website.')); + $oktext = (string)Config::get('cookienotice', 'oktext', L10n::t('OK')); - $page_end_tpl = Renderer::getMarkupTemplate("cookienotice.tpl", "addon/cookienotice/"); + $page_end_tpl = Renderer::getMarkupTemplate('cookienotice.tpl', __DIR__); $page_end = Renderer::replaceMacros($page_end_tpl, [ '$text' => $text, diff --git a/cookienotice/templates/admin.tpl b/cookienotice/templates/admin.tpl new file mode 100644 index 00000000..b64b0377 --- /dev/null +++ b/cookienotice/templates/admin.tpl @@ -0,0 +1,6 @@ +

{{$description nofilter}}

+{{include file="field_textarea.tpl" field=$text}} +{{include file="field_input.tpl" field=$oktext}} +
+ +
diff --git a/cookienotice/templates/settings.tpl b/cookienotice/templates/settings.tpl deleted file mode 100644 index 99489b9c..00000000 --- a/cookienotice/templates/settings.tpl +++ /dev/null @@ -1,15 +0,0 @@ - -

{{$title}}

- - -