From 0adc94d7e0407a49b77c334e7694df9ab5f648a1 Mon Sep 17 00:00:00 2001
From: David Remer <webmaster@websupporter.net>
Date: Tue, 1 Sep 2020 10:24:10 +0300
Subject: [PATCH] add ppcp admin notices module

---
 .../ppcp-admin-notices/extensions.php         |  8 +-
 modules.local/ppcp-admin-notices/module.php   |  7 +-
 modules.local/ppcp-admin-notices/services.php | 23 +++---
 .../ppcp-admin-notices/src/AdminNotices.php   | 37 ---------
 .../ppcp-admin-notices/src/Entity/Message.php | 34 --------
 .../src/Entity/class-message.php              | 77 +++++++++++++++++++
 .../src/Renderer/Renderer.php                 | 31 --------
 .../src/Renderer/RendererInterface.php        | 11 ---
 .../src/Renderer/class-renderer.php           | 53 +++++++++++++
 .../src/Renderer/class-rendererinterface.php  | 23 ++++++
 .../src/Repository/Repository.php             | 26 -------
 .../src/Repository/RepositoryInterface.php    | 16 ----
 .../src/Repository/class-repository.php       | 37 +++++++++
 .../Repository/class-repositoryinterface.php  | 26 +++++++
 .../src/class-adminnotices.php                | 48 ++++++++++++
 15 files changed, 290 insertions(+), 167 deletions(-)
 delete mode 100644 modules.local/ppcp-admin-notices/src/AdminNotices.php
 delete mode 100644 modules.local/ppcp-admin-notices/src/Entity/Message.php
 create mode 100644 modules.local/ppcp-admin-notices/src/Entity/class-message.php
 delete mode 100644 modules.local/ppcp-admin-notices/src/Renderer/Renderer.php
 delete mode 100644 modules.local/ppcp-admin-notices/src/Renderer/RendererInterface.php
 create mode 100644 modules.local/ppcp-admin-notices/src/Renderer/class-renderer.php
 create mode 100644 modules.local/ppcp-admin-notices/src/Renderer/class-rendererinterface.php
 delete mode 100644 modules.local/ppcp-admin-notices/src/Repository/Repository.php
 delete mode 100644 modules.local/ppcp-admin-notices/src/Repository/RepositoryInterface.php
 create mode 100644 modules.local/ppcp-admin-notices/src/Repository/class-repository.php
 create mode 100644 modules.local/ppcp-admin-notices/src/Repository/class-repositoryinterface.php
 create mode 100644 modules.local/ppcp-admin-notices/src/class-adminnotices.php

diff --git a/modules.local/ppcp-admin-notices/extensions.php b/modules.local/ppcp-admin-notices/extensions.php
index 1f6a841dc..a834f4f2a 100644
--- a/modules.local/ppcp-admin-notices/extensions.php
+++ b/modules.local/ppcp-admin-notices/extensions.php
@@ -1,6 +1,10 @@
 <?php
+/**
+ * The extensions of the admin notice module.
+ *
+ * @package Inpsyde\PayPalCommerce\Button
+ */
 
 declare(strict_types=1);
 
-return [
-];
+return array();
diff --git a/modules.local/ppcp-admin-notices/module.php b/modules.local/ppcp-admin-notices/module.php
index 5b1a03a80..4e60bb99e 100644
--- a/modules.local/ppcp-admin-notices/module.php
+++ b/modules.local/ppcp-admin-notices/module.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * The admin notice module.
+ *
+ * @package Inpsyde\PayPalCommerce\Button
+ */
 
 declare(strict_types=1);
 
@@ -7,5 +12,5 @@ namespace Inpsyde\PayPalCommerce\AdminNotices;
 use Dhii\Modular\Module\ModuleInterface;
 
 return static function (): ModuleInterface {
-    return new AdminNotices();
+	return new AdminNotices();
 };
diff --git a/modules.local/ppcp-admin-notices/services.php b/modules.local/ppcp-admin-notices/services.php
index 3e77f00eb..79fe20cf9 100644
--- a/modules.local/ppcp-admin-notices/services.php
+++ b/modules.local/ppcp-admin-notices/services.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * The services of the admin notice module.
+ *
+ * @package Inpsyde\PayPalCommerce\Button
+ */
 
 declare(strict_types=1);
 
@@ -18,14 +23,14 @@ use Inpsyde\PayPalCommerce\Button\Endpoint\CreateOrderEndpoint;
 use Inpsyde\PayPalCommerce\Button\Endpoint\RequestData;
 use Inpsyde\PayPalCommerce\Button\Exception\RuntimeException;
 
-return [
-    'admin-notices.renderer' => static function (ContainerInterface $container): RendererInterface {
+return array(
+	'admin-notices.renderer'   => static function ( ContainerInterface $container ): RendererInterface {
 
-        $repository = $container->get('admin-notices.repository');
-        return new Renderer($repository);
-    },
-    'admin-notices.repository' => static function (ContainerInterface $container): RepositoryInterface {
+		$repository = $container->get( 'admin-notices.repository' );
+		return new Renderer( $repository );
+	},
+	'admin-notices.repository' => static function ( ContainerInterface $container ): RepositoryInterface {
 
-        return new Repository();
-    },
-];
+		return new Repository();
+	},
+);
diff --git a/modules.local/ppcp-admin-notices/src/AdminNotices.php b/modules.local/ppcp-admin-notices/src/AdminNotices.php
deleted file mode 100644
index 436fe118a..000000000
--- a/modules.local/ppcp-admin-notices/src/AdminNotices.php
+++ /dev/null
@@ -1,37 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices;
-
-
-use Dhii\Container\ServiceProvider;
-use Dhii\Modular\Module\ModuleInterface;
-use Interop\Container\ServiceProviderInterface;
-use Psr\Container\ContainerInterface;
-
-class AdminNotices implements ModuleInterface
-{
-
-
-    public function setup(): ServiceProviderInterface
-    {
-        return new ServiceProvider(
-            require __DIR__.'/../services.php',
-            require __DIR__.'/../extensions.php'
-        );
-    }
-
-    /**
-     * @inheritDoc
-     */
-    public function run(ContainerInterface $container)
-    {
-        add_action(
-            'admin_notices',
-            function() use ($container) {
-                $renderer = $container->get('admin-notices.renderer');
-                $renderer->render();
-            }
-        );
-    }
-}
\ No newline at end of file
diff --git a/modules.local/ppcp-admin-notices/src/Entity/Message.php b/modules.local/ppcp-admin-notices/src/Entity/Message.php
deleted file mode 100644
index 4c8ddad8c..000000000
--- a/modules.local/ppcp-admin-notices/src/Entity/Message.php
+++ /dev/null
@@ -1,34 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices\Entity;
-
-class Message
-{
-
-    private $message;
-    private $type;
-    private $dismissable;
-    public function __construct(string $message, string $type, bool $dismissable = true)
-    {
-        $this->type = $type;
-        $this->message = $message;
-        $this->dismissable = $dismissable;
-    }
-
-    public function message(): string
-    {
-        return $this->message;
-    }
-
-    public function type(): string
-    {
-        return $this->type;
-    }
-
-    public function isDismissable(): bool
-    {
-        return $this->dismissable;
-    }
-}
diff --git a/modules.local/ppcp-admin-notices/src/Entity/class-message.php b/modules.local/ppcp-admin-notices/src/Entity/class-message.php
new file mode 100644
index 000000000..3cd7c0329
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/Entity/class-message.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * The message entity.
+ *
+ * @package Inpsyde\PayPalCommerce\AdminNotices\Entity
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices\Entity;
+
+/**
+ * Class Message
+ */
+class Message {
+
+	/**
+	 * The messagte text.
+	 *
+	 * @var string
+	 */
+	private $message;
+
+	/**
+	 * The message type.
+	 *
+	 * @var string
+	 */
+	private $type;
+
+	/**
+	 * Whether the message is dismissable.
+	 *
+	 * @var bool
+	 */
+	private $dismissable;
+
+	/**
+	 * Message constructor.
+	 *
+	 * @param string $message The message text.
+	 * @param string $type The message type.
+	 * @param bool   $dismissable Whether the message is dismissable.
+	 */
+	public function __construct( string $message, string $type, bool $dismissable = true ) {
+		$this->type        = $type;
+		$this->message     = $message;
+		$this->dismissable = $dismissable;
+	}
+
+	/**
+	 * Returns the message text.
+	 *
+	 * @return string
+	 */
+	public function message(): string {
+		return $this->message;
+	}
+
+	/**
+	 * Returns the message type.
+	 *
+	 * @return string
+	 */
+	public function type(): string {
+		return $this->type;
+	}
+
+	/**
+	 * Returns whether the message is dismissable.
+	 *
+	 * @return bool
+	 */
+	public function is_dismissable(): bool {
+		return $this->dismissable;
+	}
+}
diff --git a/modules.local/ppcp-admin-notices/src/Renderer/Renderer.php b/modules.local/ppcp-admin-notices/src/Renderer/Renderer.php
deleted file mode 100644
index 3aa864500..000000000
--- a/modules.local/ppcp-admin-notices/src/Renderer/Renderer.php
+++ /dev/null
@@ -1,31 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices\Renderer;
-
-
-use Inpsyde\PayPalCommerce\AdminNotices\Repository\RepositoryInterface;
-
-class Renderer implements RendererInterface
-{
-    private $repository;
-    public function __construct(RepositoryInterface $repository)
-    {
-        $this->repository = $repository;
-    }
-
-    public function render(): bool
-    {
-        $messages = $this->repository->currentMessages();
-        foreach ($messages as $message) {
-            printf(
-                '<div class="notice notice-%s %s"><p>%s</p></div>',
-                $message->type(),
-                ($message->isDismissable()) ? 'is-dismissible' : '',
-                wp_kses_post($message->message())
-            );
-        }
-
-        return (bool) count($messages);
-    }
-}
\ No newline at end of file
diff --git a/modules.local/ppcp-admin-notices/src/Renderer/RendererInterface.php b/modules.local/ppcp-admin-notices/src/Renderer/RendererInterface.php
deleted file mode 100644
index d43cc7d14..000000000
--- a/modules.local/ppcp-admin-notices/src/Renderer/RendererInterface.php
+++ /dev/null
@@ -1,11 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices\Renderer;
-
-interface RendererInterface
-{
-
-    public function render(): bool;
-}
diff --git a/modules.local/ppcp-admin-notices/src/Renderer/class-renderer.php b/modules.local/ppcp-admin-notices/src/Renderer/class-renderer.php
new file mode 100644
index 000000000..8eae449d4
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/Renderer/class-renderer.php
@@ -0,0 +1,53 @@
+<?php
+/**
+ * The renderer.
+ *
+ * @package Inpsyde\PayPalCommerce\AdminNotices\Renderer
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices\Renderer;
+
+use Inpsyde\PayPalCommerce\AdminNotices\Repository\RepositoryInterface;
+
+/**
+ * Class Renderer
+ */
+class Renderer implements RendererInterface {
+
+	/**
+	 * The message repository.
+	 *
+	 * @var RepositoryInterface
+	 */
+	private $repository;
+
+	/**
+	 * Renderer constructor.
+	 *
+	 * @param RepositoryInterface $repository The message repository.
+	 */
+	public function __construct( RepositoryInterface $repository ) {
+		$this->repository = $repository;
+	}
+
+	/**
+	 * Renders the current messages.
+	 *
+	 * @return bool
+	 */
+	public function render(): bool {
+		$messages = $this->repository->current_message();
+		foreach ( $messages as $message ) {
+			printf(
+				'<div class="notice notice-%s %s"><p>%s</p></div>',
+				$message->type(),
+				( $message->is_dismissable() ) ? 'is-dismissible' : '',
+				wp_kses_post( $message->message() )
+			);
+		}
+
+		return (bool) count( $messages );
+	}
+}
diff --git a/modules.local/ppcp-admin-notices/src/Renderer/class-rendererinterface.php b/modules.local/ppcp-admin-notices/src/Renderer/class-rendererinterface.php
new file mode 100644
index 000000000..55ff86926
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/Renderer/class-rendererinterface.php
@@ -0,0 +1,23 @@
+<?php
+/**
+ * The renderer interface.
+ *
+ * @package Inpsyde\PayPalCommerce\AdminNotices\Renderer
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices\Renderer;
+
+/**
+ * Interface RendererInterface
+ */
+interface RendererInterface {
+
+	/**
+	 * Renders the messages.
+	 *
+	 * @return bool
+	 */
+	public function render(): bool;
+}
diff --git a/modules.local/ppcp-admin-notices/src/Repository/Repository.php b/modules.local/ppcp-admin-notices/src/Repository/Repository.php
deleted file mode 100644
index 13d4a61bd..000000000
--- a/modules.local/ppcp-admin-notices/src/Repository/Repository.php
+++ /dev/null
@@ -1,26 +0,0 @@
-<?php
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices\Repository;
-
-
-use Inpsyde\PayPalCommerce\AdminNotices\Entity\Message;
-
-class Repository implements RepositoryInterface
-{
-
-    const NOTICES_FILTER = 'ppcp.admin-notices.current-notices';
-
-    public function currentMessages(): array
-    {
-        return array_filter(
-            (array) apply_filters(
-                self::NOTICES_FILTER,
-                []
-            ),
-            function($element) : bool {
-                return is_a($element, Message::class);
-            }
-        );
-    }
-}
\ No newline at end of file
diff --git a/modules.local/ppcp-admin-notices/src/Repository/RepositoryInterface.php b/modules.local/ppcp-admin-notices/src/Repository/RepositoryInterface.php
deleted file mode 100644
index c9b1060a1..000000000
--- a/modules.local/ppcp-admin-notices/src/Repository/RepositoryInterface.php
+++ /dev/null
@@ -1,16 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Inpsyde\PayPalCommerce\AdminNotices\Repository;
-
-use Inpsyde\PayPalCommerce\AdminNotices\Entity\Message;
-
-interface RepositoryInterface
-{
-
-    /**
-     * @return Message[]
-     */
-    public function currentMessages(): array;
-}
diff --git a/modules.local/ppcp-admin-notices/src/Repository/class-repository.php b/modules.local/ppcp-admin-notices/src/Repository/class-repository.php
new file mode 100644
index 000000000..992fa4d22
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/Repository/class-repository.php
@@ -0,0 +1,37 @@
+<?php
+/**
+ * The message repository.
+ *
+ * @package Inpsyde\PayPalCommerce\AdminNotices\Repository
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices\Repository;
+
+use Inpsyde\PayPalCommerce\AdminNotices\Entity\Message;
+
+/**
+ * Class Repository
+ */
+class Repository implements RepositoryInterface {
+
+	const NOTICES_FILTER = 'ppcp.admin-notices.current-notices';
+
+	/**
+	 * Returns the current messages.
+	 *
+	 * @return Message[]
+	 */
+	public function current_message(): array {
+		return array_filter(
+			(array) apply_filters(
+				self::NOTICES_FILTER,
+				array()
+			),
+			function( $element ) : bool {
+				return is_a( $element, Message::class );
+			}
+		);
+	}
+}
diff --git a/modules.local/ppcp-admin-notices/src/Repository/class-repositoryinterface.php b/modules.local/ppcp-admin-notices/src/Repository/class-repositoryinterface.php
new file mode 100644
index 000000000..232104f94
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/Repository/class-repositoryinterface.php
@@ -0,0 +1,26 @@
+<?php
+/**
+ * The repository interface.
+ *
+ * @package Inpsyde\PayPalCommerce\AdminNotices\Repository
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices\Repository;
+
+use Inpsyde\PayPalCommerce\AdminNotices\Entity\Message;
+
+/**
+ * Interface RepositoryInterface
+ */
+interface RepositoryInterface {
+
+
+	/**
+	 * Returns the current messages.
+	 *
+	 * @return Message[]
+	 */
+	public function current_message(): array;
+}
diff --git a/modules.local/ppcp-admin-notices/src/class-adminnotices.php b/modules.local/ppcp-admin-notices/src/class-adminnotices.php
new file mode 100644
index 000000000..70f7a5347
--- /dev/null
+++ b/modules.local/ppcp-admin-notices/src/class-adminnotices.php
@@ -0,0 +1,48 @@
+<?php
+/**
+ * The admin notice module.
+ *
+ * @package Inpsyde\PayPalCommerce\Button
+ */
+
+declare(strict_types=1);
+
+namespace Inpsyde\PayPalCommerce\AdminNotices;
+
+use Dhii\Container\ServiceProvider;
+use Dhii\Modular\Module\ModuleInterface;
+use Interop\Container\ServiceProviderInterface;
+use Psr\Container\ContainerInterface;
+
+/**
+ * Class AdminNotices
+ */
+class AdminNotices implements ModuleInterface {
+
+	/**
+	 * Sets up the module.
+	 *
+	 * @return ServiceProviderInterface
+	 */
+	public function setup(): ServiceProviderInterface {
+		return new ServiceProvider(
+			require __DIR__ . '/../services.php',
+			require __DIR__ . '/../extensions.php'
+		);
+	}
+
+	/**
+	 * Runs the module.
+	 *
+	 * @param ContainerInterface $container The container.
+	 */
+	public function run( ContainerInterface $container ) {
+		add_action(
+			'admin_notices',
+			function() use ( $container ) {
+				$renderer = $container->get( 'admin-notices.renderer' );
+				$renderer->render();
+			}
+		);
+	}
+}