mod_kandandamassemail

Description

This project builds a module called Kandanda Mass Email for the content management system Joomla.

The module requires in Joomla an installation of the Kandanda-Component.

Using this module, it is possible to send emails to Kandanda members assigned to specific Kandanda groups, or where appropriate Kandanda field values are assigned to.

Folder structure

• .release -> contains the installation archive of joomla module and the corresponding update XML
• .vscode -> contains the VSCode task file for creating joomla archive
• language -> contains the language specific translations
• tmpl -> contains the module template which generates the HTML to be displayed on the page

Joomla packaging

For packaging the Joomla module a powershell script _CreateArchive.ps1 exists. This script packs all needed files into a zip archive and updates the version information in the update XML file corresponding to the version information in the module manifest file mod_kandandamassemail.xml

Joomla coding style

In order to fullfil Joomla coding standard PHP Codesniffer has been used for formatting php source files. For installation Composer is used. After installation of Composer create file composer.json in user directory and add the following lines:

{
    "require": {
        "squizlabs/php_codesniffer": "~2.8"
    },
    
    "require-dev": {
        "joomla/coding-standards": "~2.0@alpha"
    }
}

On Command line execute

composer update

Installation is done in <Userdir>\vendor
and also in <Userdir>\AppData\Roaming\Composer\vendor but Joomla coding style is only installed at <Userdir>\vendor\joomla

Hint Since php codesniffer 2.8 is not optimized for php 7.4, several deprecated warnings are emitted, which leads to a not working sniffer output. Therefore adapt <Userdir>\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\CodeSniffer.php and add

$errorlevel = error_reporting();
$errorlevel = error_reporting($errorlevel & ~E_DEPRECATED);

Visual Studio Code

Since Visual Studio Code is used as IDE install there extension phpcs. In settings adapt the following options

• executable path for phpcs <Userdir>\AppData\Roaming\Composer\vendor\bin\phpcs
• phpcs: Standard -> settings.json "phpcs.standard": "<Userdir>\vendor\joomla\coding-standards\Joomla"