primo commit

administrator/modules/mod_messages/mod_messages.xml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<extension type="module" client="administrator" method="upgrade">
+	<name>mod_messages</name>
+	<author>Joomla! Project</author>
+	<creationDate>2019-07</creationDate>
+	<copyright>(C) 2019 Open Source Matters, Inc.</copyright>
+	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
+	<authorEmail>admin@joomla.org</authorEmail>
+	<authorUrl>www.joomla.org</authorUrl>
+	<version>4.0.0</version>
+	<description>MOD_MESSAGES_XML_DESCRIPTION</description>
+	<namespace path="src">Joomla\Module\Messages</namespace>
+	<files>
+		<folder module="mod_messages">services</folder>
+		<folder>src</folder>
+		<folder>tmpl</folder>
+	</files>
+	<languages>
+		<language tag="en-GB">language/en-GB/mod_messages.ini</language>
+		<language tag="en-GB">language/en-GB/mod_messages.sys.ini</language>
+	</languages>
+	<help key="Admin_Modules:_Messages" />
+	<config>
+		<fields name="params">
+			<fieldset name="advanced">
+				<field
+					name="layout"
+					type="modulelayout"
+					label="JFIELD_ALT_LAYOUT_LABEL"
+					class="form-select"
+				/>
+
+				<field
+					name="moduleclass_sfx"
+					type="textarea"
+					label="COM_MODULES_FIELD_MODULECLASS_SFX_LABEL"
+					rows="3"
+					validate="CssIdentifier"
+				/>
+			</fieldset>
+		</fields>
+	</config>
+</extension>

administrator/modules/mod_messages/services/provider.php

@@ -0,0 +1,43 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_messages
+ *
+ * @copyright   (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+use Joomla\CMS\Extension\Service\Provider\HelperFactory;
+use Joomla\CMS\Extension\Service\Provider\Module;
+use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory;
+use Joomla\DI\Container;
+use Joomla\DI\ServiceProviderInterface;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * The messages module service provider.
+ *
+ * @since  5.1.0
+ */
+return new class () implements ServiceProviderInterface {
+    /**
+     * Registers the service provider with a DI container.
+     *
+     * @param   Container  $container  The DI container.
+     *
+     * @return  void
+     *
+     * @since   5.1.0
+     */
+    public function register(Container $container)
+    {
+        $container->registerServiceProvider(new ModuleDispatcherFactory('\\Joomla\\Module\\Messages'));
+        $container->registerServiceProvider(new HelperFactory('\\Joomla\\Module\\Messages\\Administrator\\Helper'));
+
+        $container->registerServiceProvider(new Module());
+    }
+};

administrator/modules/mod_messages/src/Dispatcher/Dispatcher.php

@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_messages
+ *
+ * @copyright   (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\Messages\Administrator\Dispatcher;
+
+use Joomla\CMS\Dispatcher\AbstractModuleDispatcher;
+use Joomla\CMS\Helper\HelperFactoryAwareInterface;
+use Joomla\CMS\Helper\HelperFactoryAwareTrait;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Dispatcher class for mod_messages
+ *
+ * @since   5.1.0
+ */
+class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
+{
+    use HelperFactoryAwareTrait;
+
+    /**
+     * Runs the dispatcher.
+     *
+     * @return  void
+     *
+     * @since   5.1.0
+     */
+    public function dispatch()
+    {
+        // Check permissions.
+        if (
+            !$this->getApplication()->getIdentity()->authorise('core.login.admin')
+            || !$this->getApplication()->getIdentity()->authorise('core.manage', 'com_messages')
+        ) {
+            return;
+        }
+
+        parent::dispatch();
+    }
+
+    /**
+     * Returns the layout data.
+     *
+     * @return  array
+     *
+     * @since   5.1.0
+     */
+    protected function getLayoutData()
+    {
+        $data = parent::getLayoutData();
+
+        $data['countUnread'] = $this->getHelperFactory()->getHelper('MessagesHelper')->getUnreadMessagesCount($data['params'], $this->getApplication());
+
+        return $data;
+    }
+}

administrator/modules/mod_messages/src/Helper/MessagesHelper.php

@@ -0,0 +1,58 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_messages
+ *
+ * @copyright   (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\Module\Messages\Administrator\Helper;
+
+use Joomla\CMS\Application\AdministratorApplication;
+use Joomla\Registry\Registry;
+
+// phpcs:disable PSR1.Files.SideEffects
+\defined('_JEXEC') or die;
+// phpcs:enable PSR1.Files.SideEffects
+
+/**
+ * Helper for mod_messages
+ *
+ * @since  5.1.0
+ */
+class MessagesHelper
+{
+    /**
+     * Get count of unread messages.
+     *
+     * @param   Registry                  $params  Object holding the module parameters
+     * @param   AdministratorApplication  $app     The application
+     *
+     * @return  integer
+     *
+     * @since   5.1.0
+     */
+    public function getUnreadMessagesCount(Registry $params, AdministratorApplication $app)
+    {
+        // Try to get the items from the messages model
+        try {
+            /**
+             *  @var \Joomla\Component\Messages\Administrator\Model\MessagesModel $messagesModel
+             *
+             */
+            $messagesModel = $app->bootComponent('com_messages')->getMVCFactory()
+                ->createModel('Messages', 'Administrator', ['ignore_request' => true]);
+            $messagesModel->setState('filter.state', 0);
+            $messages = $messagesModel->getItems();
+
+            return \count($messages);
+        } catch (\RuntimeException $e) {
+            // Still render the error message from the Exception object
+            $app->enqueueMessage($e->getMessage(), 'error');
+
+            return 0;
+        }
+    }
+}

administrator/modules/mod_messages/tmpl/default.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * @package     Joomla.Administrator
+ * @subpackage  mod_messages
+ *
+ * @copyright   (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license     GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+defined('_JEXEC') or die;
+
+use Joomla\CMS\Language\Text;
+use Joomla\CMS\Router\Route;
+
+$hideLinks = $app->getInput()->getBool('hidemainmenu');
+
+if ($hideLinks || $countUnread < 1) {
+    return;
+}
+
+$route = 'index.php?option=com_messages&view=messages';
+?>
+<a class="header-item-content" href="<?php echo Route::_($route); ?>" title="<?php echo Text::_('MOD_MESSAGES_PRIVATE_MESSAGES'); ?>">
+    <div class="header-item-icon">
+        <div class="w-auto">
+            <span class="icon-envelope icon-fw" aria-hidden="true"></span>
+            <small class="header-item-count"><?php echo $countUnread; ?></small>
+        </div>
+    </div>
+    <div class="header-item-text">
+        <?php echo Text::_('MOD_MESSAGES_PRIVATE_MESSAGES'); ?>
+    </div>
+</a>