Forem: Dollar Dev

My First Steps to learning Wordpress (connection Accerdible Credential API)

Dollar Dev — Sun, 28 Jan 2024 23:09:10 +0000

I decided to fixate on this historical moment. I finally started learning WordPress from the developer side.

At the first I did some looking into:

1️⃣ Explored versioning. When I learnt that each version release is themed around one of the jazz musicians, I understand what the popularity of WordPress is all about.
2️⃣ Download and install WordPress.
3️⃣ Analyse the file structure. The most interesting thing to notice is the existence of files with the prefix wp-.
4️⃣ Introduced to the database. There were not very many tables in WordPress, it took a few minutes to study their contents.
5️⃣ Then I looked at the documentation a little bit 🧐

Next, I decided I was ready for development.

To do:

1️⃣ Create a template with a registration form (bootstrap).
2️⃣ Enable multi-language on the site and add a second language translation for the form.
3️⃣ Create a plugin to work with Accredible Credential API and with functionality:

display the list of badges in admin panel;
after user registration create a certificate in Accredible

I uploaded the code for my experiments to the repository.

Theme with registration form:

I also added a little bit of validation:

Theme code:

<?php
require_once(ABSPATH . WPINC . '/registration.php');
global $wpdb, $user_ID;

$success = false;
$errors = [];

if( $_POST ) {

    $username = $wpdb->escape($_POST['username']);
    if( username_exists( $username ) ) {
        $errors[] = esc_html__('Username already exists, try another one.');
    }

    $email = $wpdb->escape($_POST['email']);
    if( email_exists( $email ) ) {
        $errors['email'] = esc_html__('This email is already registered.');
    }

    if(0 !== strcmp($_POST['password'], $_POST['password_confirmation'])){
        $errors['password_confirmation'] = esc_html__('Password mismatch');
    }

    if( empty($errors) ) {
        $password = $_POST['password'];
        $new_user_id = wp_create_user( $username, $password, $email );
        $success = true;
    } else {
        $message = esc_html__('There are errors in completing the form:');
    }
}
?>

<?php get_header(); ?>

<?php if($success){ ?>
<div class="row mt-5">
    <div class="col">
        <div class="alert alert-success" role="alert">
            <?=esc_html__('User registered successfully')?>
        </div>
    </div>
</div>
<?php } else { ?>
<div class="row mt-5">
    <div class="col">
        <?php if(isset( $message )):?>
        <div class="alert alert-danger" role="alert" id="message">
            <?=$message?>
            <?php foreach( $errors as $error_message ){ ?>
                <br /><?=$error_message?>
            <?php } ?>
        </div>
        <?php endif;?>
        <form id="wp_signup_form" action="<?php echo $_SERVER['REQUEST_URI']; ?>" method="post" class="needs-validation" novalidate>
            <div class="col-md-4 control-group form-floating mb-4">
                <input id="username" type="text" name="username" class="form-control" placeholder="User Name" pattern="[0-9a-zA-Z!@#$%^&*\S]*" value="<?= isset( $_POST['username'] ) ? $_POST['username']  : '' ?>" required>
                <label for="username"><?php echo esc_html__( 'User Name', 'testpage' )?></label>
                <span class="error invalid-feedback"><?=esc_html__('Sorry, you can\'t use spaces in usernames')?></span>
            </div>
            <div class="col-md-4 control-group form-floating mb-4">
                <input id="email" type="text" name="email" class="form-control" pattern="[A-Za-z0-9._+\-']+@[A-Za-z0-9.\-]+\.[A-Za-z]{2,}$" value="<?= isset( $_POST['email'] ) ? $_POST['email']  : '' ?>" placeholder="Email" required>
                <label for="email"><?php echo esc_html__( 'Email', 'testpage' )?></label>
                <span class="error invalid-feedback"><?=esc_html__('Please enter a valid email.')?></span>
            </div>
            <div class="col-md-4 control-group form-floating mb-4">
                <input id="password" type="password" name="password" pattern="[0-9a-zA-Z!@#$%^&*]{6,}" class="form-control" value="<?= isset( $_POST['password'] ) ? $_POST['password']  : '' ?>" placeholder="Password" required>
                <label for="password"><?php echo esc_html__( 'Password', 'testpage' )?></label>
                <span class="error invalid-feedback"><?=esc_html__('The password must consist of at least six characters.')?></span>
            </div>
            <div class="col-md-4 control-group form-floating mb-4">
                <input id="password_confirmation" type="password" name="password_confirmation" pattern="[0-9a-zA-Z!@#$%^&*]{6,}" class="form-control" value="<?= isset( $_POST['password_confirmation'] ) ? $_POST['password_confirmation']  : '' ?>" placeholder="Confirm Password" required>
                <label for="password_confirmation"><?php echo esc_html__( 'Confirm password', 'testpage' )?></label>
                <span class="error invalid-feedback"><?=esc_html__('The password must consist of at least six characters.')?></span>
            </div>
            <div class="col-md-4 form-check mt-3 mb-3">
                <input id="terms" name="terms" class="form-check-input" type="checkbox" required>
                <label class="form-check-label" for="terms"><?php echo esc_html__( 'Agree to terms and conditions', 'testpage' )?></label>
                <span class="error invalid-feedback"><?=esc_html__('You must agree to the Terms of Use')?></span>
            </div>
            <div class="col-12">
                <button class="btn btn-primary py-2" id="submitbtn" type="button"><?php echo esc_html__( 'Registration', 'testpage' )?></button>
            </div>
        </form>
    </div>
</div>
<?php } 
get_footer();
?>

I used the same library for connecting to the API that I used for Joomla

I have separated the list in the Admin Panel into a New Menu Item:

Code for displaying the list:

<?php
/**
 * Accredible Certificate administration panel
 *
 * @package WordPress
 * @subpackage Administration
 * @since 1.0.0
 */

$title = __( 'Accredible Credentials' );
global $wpdb;
$items = $wpdb->get_results("SELECT * FROM `wp_accrediblecertificate` order by id desc");

?>
<div class="wrap">
    <h1 class="wp-heading-inline">
        <?php echo esc_html( $title ); ?>
    </h1>

    <div class="row">
        <div class="col-md-12">
            <div id="j-main-container" class="j-main-container">
                <?php if (empty($items)) : ?>
                    <div class="alert alert-info">
                        <span class="icon-info-circle" aria-hidden="true"></span><span class="visually-hidden"><?php echo __('INFO'); ?></span>
                        <?php echo __('No data'); ?>
                    </div>
                <?php else : ?>
                    <table class="table wp-list-table widefat fixed striped table-view-list" id="bannerList">
                        <thead>
                            <tr>
                                <th scope="col" class="column-language_">
                                    <?= __( 'Id', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="w-10">
                                    <?= __( 'User ID', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="w-10">
                                    <?= __( 'Group ID', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="column-response">
                                    <?= __( 'Url image', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="column-response">
                                    <?= __( 'Url badge', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="column-response">
                                    <?= __( 'Date created', 'testpage' ); ?>
                                </th>
                                <th scope="col" class="w-5 d-none d-md-table-cell">
                                    <?= __( 'Published', 'testpage' ); ?>
                                </th>
                            </tr>
                        </thead>
                        <tbody>
                            <?php foreach ($items as $i => $item) : ?>
                                <tr class="row<?php echo $i % 2; ?>" data-draggable-group="<?php echo $item->id; ?>">
                                    <td class="text-center">
                                        <?php echo $item->id; ?>

                                    </td>
                                    <th scope="row" class="has-context">
                                        <?php echo $item->user_id; ?>
                                    </th>
                                    <td class="">
                                        <?php echo $item->group_id; ?>
                                    </td>
                                    <td class="">
                                        <?php echo $item->url_image; ?>
                                    </td>
                                    <td class="">
                                        <?php echo $item->url_badge; ?>
                                    </td>
                                    <td class="">
                                        <?php echo $item->created; ?>
                                    </td>
                                    <td class="d-none d-md-table-cell">
                                        <?= $item->published; ?>
                                    </td>
                                </tr>
                            <?php endforeach; ?>
                        </tbody>
                    </table>
                <?php endif; ?>
            </div>
        </div>
    </div>

    <div class="clear"></div>
</div><!-- .wrap -->
<?php

require_once ABSPATH . 'wp-admin/admin-footer.php';

I hope this Post will be useful to those wishing to know about WordPress development.

Thanks in advance for the 💖 🦄 🤯 🙌 🔥 if you enjoyed it!

Component Accredible Credential for Joomla 5 (Part 2)

Dollar Dev — Fri, 26 Jan 2024 08:37:27 +0000

Hello! 👋
And finally, a continuation to the part 1
The component code can be downloaded from the repository

It probably looks a little horrible, but there's nothing difficult here.

On the administration side it looks like this:

And settings for Accredible Credential API:

Group settings are necessary because the certificate or badge design is implemented in the group. You can create a group through the API, but then you will need to additionally draw a design on the Accredible side.

I will describe the implementation of the component for Joomla in the following posts. Here I will only describe the points for working with the API.

The main file for working with the API Accredible Credential is found at:
src\Helper\AccrediblecertificateHelper.php

namespace Joomla\Component\Accrediblecertificate\Administrator\Helper;

use Joomla\CMS\Helper\ContentHelper;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Accredible Certificate component helper.
 *
 * @since  1.6
 */
class AccrediblecertificateHelper extends ContentHelper
{
    private $api_key;

    private $api_endpoint = "https://api.accredible.com/v1/";

    /**
     * Set API Key
     * @param String $key
     * @return null
     */
    public function setAPIKey($key) {
        $this->api_key = $key;
    }

    /**
     * Get API Key
     * @return String
     */
    public function getAPIKey() {
        return $this->api_key;
    }

    /**
     * Contruct API instance
     * @param String $api_key
     * @param boolean|null $test
     * @return null
     */
    public function __construct($api_key, $test = null){
        $this->setAPIKey($api_key);

        if (null !== $test) {
            //$this->api_endpoint = "https://staging.accredible.com/v1/";
        }
    }

    /**
     * Creates a Credential given an existing Group
     * @param String $recipient_name
     * @param String $recipient_email
     * @param String $course_id
     * @param Date|null $issued_on
     * @param Date|null $expired_on
     * @param stdObject|null $custom_attributes
     * @return stdObject
     */
    public function create_credential($recipient_name, $recipient_email, $course_id, $issued_on = null, $expired_on = null, $custom_attributes = null){

        $data = array(
            "credential" => array(
                "group_id" => $course_id,
                "recipient" => array(
                    "name" => $recipient_name,
                    "email" => $recipient_email
                ),
                "issued_on" => $issued_on,
                "expired_on" => $expired_on,
                "custom_attributes" => $custom_attributes
            )
        );

        return json_decode($this->execAccredible($this->getAPIKey(), 'credentials', json_encode($data)), true);
    }

    public function execAccredible($key, $url, $params=array()){

        $ch = curl_init();

        curl_setopt($ch, CURLOPT_URL, $this->api_endpoint.$url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
        curl_setopt($ch, CURLOPT_HEADER, FALSE);

        if(!empty($params)){
            curl_setopt($ch, CURLOPT_POST, TRUE);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
        }

        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
          "Content-Type: application/json",
          "Authorization: Token token=".$key
        ));
        $response = curl_exec($ch);
        curl_close($ch);

        return $response;
    }
}

To connect, I use a regular curl, so that there is no need to connect additional libraries.
The API Accredible feature set is very large, but the certificate creation function is enough for me at the moment.

I use this file (AccrediblecertificateHelper.php) in the plugin to create the Certificate:

<?php

namespace Joomla\Plugin\User\Accregistration\Extension;

use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Date\Date;
use Joomla\Database\DatabaseAwareTrait;
use Joomla\Component\Accrediblecertificate\Administrator\Helper\AccrediblecertificateHelper;
use Joomla\CMS\Component\ComponentHelper;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects


final class Accregistration extends CMSPlugin
{
    use DatabaseAwareTrait;

    public function onUserAfterSave($data, $isNew, $result, $error): void
    {
        if ($isNew && $result ) {
        $config   = ComponentHelper::getParams('com_accrediblecertificate');
        $default_group_id = $config->get('default_group_id', '546130');

        $api = new AccrediblecertificateHelper($config->get('api_key', 'ade377f959a7f522c67a948772f02bc6'), true);
        $new_credential = $api->create_credential($data['username'], $data['email1'], $default_group_id);

        $db = $this->getDatabase();
        $query = $db->getQuery(true)->insert($db->quoteName('#__accrediblecertificate'));

        $query->columns([
                $db->quoteName('user_id'), 
                $db->quoteName('group_id'), 
                $db->quoteName('url_image'),
                $db->quoteName('url_badge'),
                $db->quoteName('created'),
                $db->quoteName('published')
            ])
        ->values(
                $db->quote($data['id']) . ', ' . 
                $db->quote($default_group_id) . ', ' .                  $db->quote($new_credential['credential']['seo_image']) . ', ' . 
                $db->quote($new_credential['credential']['badge']['image']['preview']) . ', "' .                    date('Y-m-d H:i:s'). '", ' . 
                ( !empty($new_credential['credential']['seo_image']) ? 1 : 0 )
            );

            $db->setQuery($query);
            $db->execute();
        }
    }
}

The code is very simple, in order to review it in detail.
This is just one example for adding a Certificate and this is not the final version of the plugin yet, I will be finalizing situations when the service is not available.
Also, I would like to create a script (for cron) that will automatically create badges for users for specified accomplishments on the site, similar to how it is implemented on this portal. 😉

I hope this material was useful...

Thanks in advance for the "💖 🦄 🤯 🙌 🔥" if you enjoyed it!

Component Accredible Credential for Joomla 5 (Part 1)

Dollar Dev — Mon, 22 Jan 2024 11:59:40 +0000

This component 🛠️ (set of extensions) for Joomla 5 and Accreditation integration I developed for use on my portal, but I'm willing to share it.
In this post I will transcribe the design scheme and make a development plan, which usually helps to estimate more accurately the time to be used for development.
But first a few words about what Accreditable is and why I need it.

Accredible is a platform that provides digital credentialing and certificate services. It allows organizations, educational institutions, and businesses to create, manage, and issue digital certificates, badges, and credentials to individuals. These digital credentials can represent achievements, skills, or certifications earned by individuals in various fields.

✨I plan to use these certificates for my users who will successfully complete the training and tasks on the site. But in the starter pack I will demonstrate only the creation of badges for users who have registered on the site. These badges will be displayed using a module on the User Profile page.

📝In general, the scheme of interaction between extensions looks as follows:

With the diagram, I made a development plan:
1️⃣ Create a component:
1.1 Administer the customization of the
➡️ API KEY
➡️ default group ID (since it is not possible to create a badge or certificate in Accreditable without a group).
1.2 Administer the component:
➡️ DB table for keeping data and certificates
➡️ page with displaying data from the table
➡️ main backend class for interaction with Accredible Credential API

2️⃣ Create a plugin with a trigger onUserAfterSave(). In the plugin settings, it should be possible to edit the Group from Accredible.

3️⃣ Create a module that will be located on the User Profile page and display the user's current badges.

But before you start realization, you need to register at https://www.accredible.com. Create Api Key, for this there is a very good instruction in the help center https://help.accredible.com/how-do-i-find-my-integration-api-key.

Thanks in advance for the "💖 🦄 🤯 🙌 🔥" if you enjoyed it!

Part 2 coming soon ...

Readme to the Module Contact me for Joomla 5

Dollar Dev — Wed, 17 Jan 2024 13:59:05 +0000

Even though there are already a lot of modules written for Joomla, I have not been able to find a Contact module that is suitable for me.
Most probably - this is only the first version of the module. I plan to improve it to perfection.
You can see the current version of the working module on my CV site, the module code in the repository.
File structure + Language files:

A short description of the file assignments:

mod_sta_contact.xml - File for installation and configuration of the module in joomla

<?xml version="1.0" encoding="UTF-8"?>
<extension type="module" client="site" method="upgrade">
    <name>mod_sta_contact</name>
    <author>Joomla! Project</author>
    <creationDate>2024-01</creationDate>
    <copyright>(C) 2024 Open Source Tatsiana, Inc.</copyright>
    <license>GNU General Public License version 2 or later; see LICENSE.txt</license>
    <authorEmail>dollar2901@gmail.com</authorEmail>
    <authorUrl>www.joomla.org</authorUrl>
    <version>1.0.0</version>
    <description>MOD_STA_CONTACT_XML_DESCRIPTION</description>
    <namespace path="src">Joomla\Module\StaContact</namespace>
    <files>
        <filename module="mod_sta_contact">mod_sta_contact.php</filename>
        <folder>forms</folder>
        <folder>src</folder>
        <folder>tmpl</folder>
    </files>
    <languages>
        <language tag="en-GB">language/en-GB/mod_sta_contact.ini</language>
        <language tag="en-GB">language/en-GB/mod_sta_contact.sys.ini</language>
        <language tag="pl-PL">language/pl-PL/mod_sta_contact.ini</language>
        <language tag="pl-PL">language/pl-PL/mod_sta_contact.sys.ini</language>
    </languages>

</extension>

mod_sta_contact.php - Module controller

<?php

\defined('_JEXEC') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Form\Form;
use Joomla\CMS\Helper\AuthenticationHelper;
use Joomla\CMS\Helper\ModuleHelper;
use Joomla\Module\StaContact\Site\Helper\StaContactHelper;

$data = Factory::getApplication()->input->post->get('jform', [], 'array');

Form::addFormPath(JPATH_SITE . '/modules/mod_sta_contact/forms');

$form = Form::getInstance('mod_sta_contact.sendmessage', 'sendmessage',['control' => 'jform']);

if(isset($data['contact_sta_send_mail'])){
    $staContact = new StaContactHelper();
    $staContact->submit();
}

require ModuleHelper::getLayoutPath('mod_sta_contact');

forms\sendmessage.xml - Xml file for configuring form fields

<?xml version="1.0" encoding="UTF-8"?>
<form>
    <fieldset name="stacontact" label="MOD_STA_CONTACT_DEFAULT_LABEL">
        <field
            name="contact_name"
            type="text"
            label="MOD_STA_CONTACT_EMAIL_NAME_LABEL"
            id="contact-name"
            size="30"
            filter="string"
            required="true"
            hint="MOD_STA_CONTACT_EMAIL_NAME_LABEL"
        />

        <field
            name="contact_email"
            type="email"
            label="MOD_STA_CONTACT_EMAIL_LABEL"
            id="contact-email"
            size="30"
            filter="string"
            autocomplete="email"
            required="true"
            hint="MOD_STA_CONTACT_EMAIL_LABEL"
        />

        <field
            name="contact_subject"
            type="text"
            label="MOD_STA_CONTACT_MESSAGE_SUBJECT_LABEL"
            id="contact-emailmsg"
            size="60"
            filter="string"
            required="true"
            hint="MOD_STA_CONTACT_MESSAGE_SUBJECT_LABEL"
        />

        <field
            name="contact_message"
            type="textarea"
            label="MOD_STA_CONTACT_ENTER_MESSAGE_LABEL"
            cols="20"
            rows="5"
            id="contact-message"
            filter="safehtml"
            hint="MOD_STA_CONTACT_ENTER_MESSAGE_LABEL"
        />

        <field
            name="contact_sta_send_mail"
            type="hidden"
            default="1"
        />
    </fieldset>

    <fieldset name="captcha">
        <field
            name="captcha"
            type="captcha"
            label="MOD_STA_CONTACT_CAPTCHA_LABEL"
            validate="captcha"
            required="true"
            namespace="contact"
        />
    </fieldset>

</form>

tmpl\default.php - Main module template. Here for now you need to manually change the *action * to the one you need. It will be improved in the next versions - *action * can be customized in the module administration.

<?php
defined('_JEXEC') or die;

use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Factory;

$document  = Factory::getDocument();
$app->getDocument()->getWebAssetManager()
    ->useScript('core')
    ->useScript('keepalive')
    ->useScript('form.validate');

// Get the message queue
$messages = Factory::getApplication()->getMessageQueue();
$list_messages = [];
// Build the sorted message list
if (\is_array($messages) && !empty($messages)) {
    foreach ($messages as $msg) {
        if (isset($msg['type']) && isset($msg['message'])) {
            $list_messages[$msg['type']][] = $msg['message'];
        }
    }
}
?>
<form id="sta-contact-form" class="mod-sta-contact needs-validation" novalidate action="<?php echo Route::_('index.php#contact'); ?>" method="post">
    <h1 style="color:#013F4E" class="h3 mb-3 fw-normal">Contact me</h1>
    <?php if (is_array($list_messages) && !empty($list_messages)) {
        echo $list_messages["info"][0];
    }else{ ?>
    <p><?=Text::_('MOD_STA_CONTACT_ADD_MESSAGE_TEXT')?></p>

    <?php foreach ($form->getFieldsets() as $fieldset) : ?>
            <?php if ($fieldset->name === 'captcha') : ?>
                <?php continue; ?>
            <?php endif; ?>
            <?php $fields = $form->getFieldset($fieldset->name); ?>
            <?php if (count($fields)) : ?>
                <fieldset class="m-0 text-start">
                    <?php foreach ($fields as $field) : ?>
                        <div class="control-group form-floating">
                        <?php echo $field->input; ?>
                        <?php echo $field->label; ?>
                        </div>
                    <?php endforeach; ?>
                </fieldset>
            <?php endif; ?>
        <?php endforeach; ?>

    <?php echo $form->renderFieldset('captcha'); ?>
    <?php echo HTMLHelper::_('form.token'); ?>
    <button class="btn btn-primary w-100 py-2" id="contact-send" type="button"><?= Text::_('MOD_STA_CONTACT_SEND'); ?></button>
</form>
<?php 
Factory::getDocument()->addScriptDeclaration('
    window.onload = function(){

  document.getElementById("contact-send").addEventListener("click",function (){
    var form = document.getElementById("sta-contact-form");
    if (!form.checkValidity()) {
          event.preventDefault();
          event.stopPropagation();
          form.classList.add("was-validated");
        }else{
            document.getElementById("sta-contact-form").submit();
        }
   });
};');
}?>

src\Helper\StaContactHelper.php - Helper file with module functions

<?php
/**
 * @package     Joomla.Site
 * @subpackage  mod_sta_contact
 *
 */
namespace Joomla\Module\StaContact\Site\Helper;

use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Language\Multilanguage;
use Joomla\CMS\String\PunycodeHelper;
use Joomla\CMS\Mail\MailTemplate;
use Joomla\CMS\Uri\Uri;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

/**
 * Helper for mod_sta_contact
 *
 * @since  1.5
 */
class StaContactHelper
{
    public function submit()
    {
        // Check for request forgeries.
        Factory::getApplication()->checkToken();
        $app    = Factory::getApplication();

        // Get the data from POST
        $data = $app->input->post->get('jform', [], 'array');
        $msg = '';
        $sent = false;

        $sent = $this->_sendEmail($data);

        // Set the success message if it was a success
        if ($sent) {
            $msg = Text::_('MOD_STA_CONTACT_EMAIL_THANKS');
        }
        $app->enqueueMessage($msg);

        return true;
    }

    private function _sendEmail($data)
    {
        $app = Factory::getApplication();

        $templateData = [
            'sitename'     => $app->get('sitename'),
            'name'         => $data['contact_name'],
            'contactname'  => 'Contact me form',
            'email'        => PunycodeHelper::emailToPunycode($data['contact_email']),
            'subject'      => $data['contact_subject'],
            'body'         => stripslashes($data['contact_message']),
            'url'          => Uri::base(),
            'customfields' => '',
        ];

        try {
            $mailer = new MailTemplate('com_contact.mail', $app->getLanguage()->getTag());
            $mailer->addRecipient($app->get('mailfrom'));
            $mailer->setReplyTo($templateData['email'], $templateData['name']);
            $mailer->addTemplateData($templateData);
            $sent = $mailer->send();

        } catch (MailDisabledException | phpMailerException $exception) {
            try {
                Log::add(Text::_($exception->getMessage()), Log::WARNING, 'jerror');

                $sent = false;
            } catch (\RuntimeException $exception) {
                $app->enqueueMessage(Text::_($exception->errorMessage()), 'warning');

                $sent = false;
            }
        }
        return $sent;
    }
}

You can install the module in the standard method:
System -> Install Extensions -> Upload Package File.
In the module settings add a position for module output and published it:

As a result, a form should appear on the selected position:

I planned to add the ability to customize in the Joomla admin: the choice of fields, which to display in the module, adding styles for fields, email to which to send emails, perhaps a few more settings.

Connecting the collapse to the menu - Joomla 4+

Dollar Dev — Mon, 08 Jan 2024 17:57:27 +0000

Maybe it will be useful to someone how to connect collapse menu in Cassiopea template.

Log in to the Joomla Administrator
Go to the System -> Manage Site Modules
Edit a module with the Menu type. In my case it Main Menu:
On the advanced options tab, you need to change the Layout value Select Collapsible Dropdown in Cassiopea template and save changes to the module

The module template is located in the folder

templates\cassiopeia\html\mod_menu\collapse-metismenu.php

Maybe I haven't reviewed something, please ask in comments.

First steps to secure your site (Part 1)

Dollar Dev — Fri, 05 Jan 2024 19:19:01 +0000

Securing your website is crucial to protect it from potential threats and ensure the safety of your users and data. Here are some essential first steps to secure your site:

🧐1. Keep Software Updated and Remove Unused Plugins and Themes:
Regularly update your website's CMS (Content Management System), plugins, themes, and any other software you use. Updates often include security patches.
Delete or disable any plugins or themes that are not actively in use. Unused extensions can be a security risk if not regularly updated.

2. Use Strong Passwords and Limit Login Attempts:
Use complex and unique passwords for all accounts associated with your website, including hosting, CMS, and database accounts. Consider using a password manager.
Implement measures to limit the number of login attempts to prevent brute force attacks. This can include account lockouts after a certain number of failed attempts.

3. Monitor User Permissions:
Regularly review and audit user roles and permissions. Ensure that users have the minimum necessary access required for their roles.

4. Secure File Uploads:
If your website allows file uploads, ensure that only authorized file types are accepted. Set strict permissions on uploaded files and validate file types and sizes.

5. Secure Database Access:
Use strong passwords for database accounts. Restrict database access to specific IP addresses and avoid using default database prefixes.

6. Protect Against SQL Injection:
Sanitize and validate user inputs to prevent SQL injection attacks. Use prepared statements and parameterized queries when interacting with databases.

7. Enable HTTPS:
Use HTTPS to encrypt data transmitted between your website and users. Obtain an SSL/TLS certificate for your domain. Many hosting providers offer free certificates through Let's Encrypt.

8. Backup Regularly:
Set up regular backups of your website, including databases and files. Store backups in a secure location, separate from your hosting server. Test your backups to ensure they can be restored.

9. Implement Web Application Firewall (WAF):
Use a WAF to filter and monitor HTTP traffic between a web application and the Internet. WAFs can help protect against common web application attacks.

10. Cross-Site Scripting (XSS) Protection:
Validate and sanitize user inputs to prevent cross-site scripting attacks. Avoid echoing user-input directly into HTML or JavaScript.

11. Security Headers:
Implement security headers in your website's HTTP responses. Common headers include Content Security Policy (CSP), Strict Transport Security (HSTS), and X-Content-Type-Options.

12. Monitor and Audit Logs:
Regularly review server logs, CMS logs, and security logs for suspicious activities. Set up alerts for unusual or suspicious events.

13. Educate Users and Team:
Educate your team and users about security best practices. This includes avoiding common pitfalls like clicking on suspicious links and using strong passwords.

14. Security Audits:
Conduct regular security audits or hire a professional to assess your website's security. Identify and address vulnerabilities before they can be exploited.

15. Stay Informed:
Keep yourself informed about the latest security threats and best practices. Subscribe to security newsletters, follow security blogs, and stay connected with your CMS community.

By implementing these first steps, you establish a foundation for a more secure website. Security is an ongoing process, so regularly review and update your security measures to stay ahead of potential threats.

Top 10 PHP coding standards

Dollar Dev — Thu, 04 Jan 2024 11:48:44 +0000

PHP coding standards are a set of guidelines and best practices that developers follow to ensure consistency, readability, and maintainability of code. Adhering to coding standards is essential for collaborative development, as it promotes a uniform coding style across a project or organization. Here are common PHP coding standards:

1.PSR Standards
Many PHP projects and frameworks follow the standards defined by the PHP-FIG (PHP Framework Interop Group). Notable PSRs include PSR-1, PSR-2, PSR-4, and PSR-12.

2.Indentation
Use spaces for indentation instead of tabs. PSR-2 recommends using four spaces for each level of indentation.

3.Line Length
Limit lines to a maximum length, commonly 80 or 120 characters per line. This enhances code readability, especially in side-by-side comparisons.

4.Opening and Closing PHP Tags
Use <?php for opening PHP tags, and avoid using the short tags (<?). For files that contain only PHP code, omit the closing tag ?> to prevent unintended whitespace.

5.Namespace and Class Naming
Use a namespace, and follow an autoloader-friendly directory structure. Class names should be declared in StudlyCaps (PascalCase).

namespace Vendor\Package;

class ClassName
{
    // Class implementation
}

6.Class Constants, Properties, and Methods
Constants should be declared in uppercase with underscores as separators. Properties and methods should use camelCase.

const MAX_ATTEMPTS = 3;

class MyClass
{
    private $myProperty;

    public function myMethod()
    {
        // Method implementation
    }
}

7.Control Structures
Place control structure keywords (if, else, for, while, etc.) on a new line with an indentation. Use braces even for single-line statements.

if ($condition) {
    // Code block
} else {
    // Code block
}

8.Function and Method Calls
Do not use spaces between the function or method name and the opening parenthesis. Add a space after commas in argument lists.

myFunction($arg1, $arg2);

$object->myMethod($arg1, $arg2);

9.Array Declaration
Use the array() syntax for array declaration rather than the short [] syntax. Add a space after the comma.

$myArray = array('apple', 'banana', 'orange');

10.Doc Comments
Use doc comments to document classes, methods, and properties. Follow the PHPDoc format for consistency and clarity.

/**
 * Short description.
 *
 * @param  string $param1 Description of param1
 * @param  int    $param2 Description of param2
 * @return bool   Description of the return value
 */
public function myMethod($param1, $param2)
{
    // Method implementation
}

And one more additional recommendation:
Integrate tools like PHP_CodeSniffer and follow the predefined coding standards (e.g., PSR-2) by creating configuration files. Automate the process of code checking within your development workflow.

# Example usage of PHP_CodeSniffer
phpcs --standard=PSR2 path/to/your/code

These coding standards help create a unified coding style across PHP projects and facilitate collaboration among developers. It's essential to choose and consistently follow a set of coding standards that align with the project's requirements and the wider PHP community.

The main components of a good website

Dollar Dev — Thu, 04 Jan 2024 08:50:49 +0000

A good website is a combination of various elements that work together to provide a positive user experience, convey information effectively, and achieve its intended goals. Here are the main components of a good website:

Clear Purpose and Goals:
Clearly define the purpose and goals of the website. Understand the target audience and what actions you want visitors to take.

User-Friendly Design:
Intuitive and easy-to-navigate design with a clear hierarchy of information. Use consistent navigation menus, readable fonts, and an uncluttered layout.

Responsive Design:
Ensure the website is responsive and adapts to different devices and screen sizes. Mobile-friendly design is essential for a positive user experience.

Compelling Visuals:
High-quality and relevant images, graphics, and multimedia elements that enhance the visual appeal and engage users.

Clear Call-to-Action (CTA):
Strategically place clear and compelling CTAs to guide users toward desired actions, whether it's making a purchase, signing up, or contacting the business.

Effective Copywriting:
Well-written and concise content that communicates the brand message, value proposition, and key information. Use headings, subheadings, and bullet points for easy readability.

Optimized Loading Speed:
Optimize the website for fast loading times. Users expect pages to load quickly, and a slow website can lead to high bounce rates.

Search Engine Optimization (SEO):
Implement SEO best practices to improve the website's visibility in search engine results. This includes using relevant keywords, meta tags, and creating a sitemap.

Security Measures:
Implement security protocols, especially if the website handles sensitive information. Use HTTPS, keep software updated, and regularly perform security audits.

Contact Information:
Provide clear and accessible contact information, including a contact form, email address, phone number, and physical address if applicable.

Social Media Integration:
Incorporate social media buttons and links to encourage social sharing and connect with users on other platforms.

Analytics and Tracking:
Implement analytics tools, such as Google Analytics, to track website performance, user behavior, and traffic sources. Use data to make informed decisions.

Consistent Branding:
Maintain consistent branding elements, including logos, colors, and typography, to reinforce brand identity across the website.

Accessibility Features:
Ensure the website is accessible to users with disabilities by following web accessibility standards. This includes providing alternative text for images and ensuring keyboard navigation is smooth.

Content Management System (CMS):
Use a reliable and user-friendly CMS to manage and update website content efficiently. Popular CMS options include WordPress, Joomla, and Drupal.

Feedback Mechanism:
Incorporate feedback forms, surveys, or contact options to gather user opinions and address concerns. This helps improve the website based on user input.

Legal Compliance:
Include necessary legal components, such as privacy policies, terms of service, and disclaimers, to comply with regulations and build trust with users.

Regular Updates and Maintenance:
Regularly update content, check for broken links, and perform routine maintenance to keep the website current and functioning optimally.

By focusing on these components, you can create a website that not only looks appealing but also effectively serves its purpose and meets the needs of both users and the business or organization it represents.

Review of new string functions in PHP 8.1

Dollar Dev — Wed, 03 Jan 2024 08:28:19 +0000

Hi,
I decided to start my first post specifically with the new PHP string functions. I work with many lines of code every day and thanks to these functions the code will be more pleasant.
Please support this post with reactions and I will continue to please the DEV community with new posts about the PHP backend.
I'll start, perhaps, with how it was in previous versions of PHP and what were the options for checking for the content of a substring in a string - str_contains().

Using strstr():

$fullstr = "It is a nice day today.";
$needle = "nice";

if (strstr($fullstr , $needle) !== false) {
    echo "The fullstr contains the needle.";
} else {
    echo "The fullstr does not contain the needle.";
}

The strstr() function returns the portion of the string starting from the first occurrence of the needle to the end of the string. If the needle is not found, it returns false.

Using preg_match():

$fullstr = "It is a nice day today.";
$needle = "/nice/";

if (preg_match($needle, $fullstr)) {
    echo "The fullstr contains the needle.";
} else {
    echo "The fullstr does not contain the needle.";
}

In this example, preg_match() is using a regular expression to match the needle in the fullstr. The preg_match() function returns 1 if the pattern is found, 0 if no match is found, and false on error.
While these alternatives are available, the choice between them depends on the specific requirements and patterns you are working with. It's essential to consider factors like performance, flexibility, and the nature of the data you're handling.

Using strpos():

$fullstr = "It is a nice day today.";
$needle = "nice";

if (strpos($fullstr , $needle) !== false) {
    echo "The fullstr contains the needle.";
} else {
    echo "The fullstr does not contain the needle.";
}

In PHP 7.4, you may also use the null coalescing assignment operator (??=) to provide a default value in case the substring is not found. Here's an example:

$fullstr = "It is a nice day today.";
$needle = "nice";

$result = strpos($fullstr , $needle) ?? -1;

if ($result !== -1) {
    echo "The fullstr contains the needle.";
} else {
    echo "The fullstr does not contain the needle.";
}

In this example, if strpos() returns false (needle not found), the null coalescing operator sets the value of $result to -1. You can then check against this value to determine if the needle is present.
Remember that PHP 7.4 and later versions offer a range of improvements and new features, so it's generally recommended to use the latest stable version for security and performance reasons.

And finally using str_contains():

$fullstr = "It is a nice day today.";
$needle= "nice";

if (str_contains($fullstr , $needle)) {
    echo "The fullstr contains the needle.";
} else {
    echo "The fullstr does not contain the needle.";
}

The str_contains() function in PHP is used to check if a string contains another substring. It returns true if the substring is found, and false otherwise.

Personally, I like the last string search option the most :)
Thank you for your attention and I hope this material will be useful.