Forem: Rahul Khan

User Create in Drupal 10 using REST API

Rahul Khan — Sat, 09 Sep 2023 20:59:43 +0000

Hello. Today we will be creating a custom module to create users using REST API in Drupal 10. We will be doing basic operations namely, user-registration, user-login, read and edit user details and user-logout.

Step 1: Addition three new text fields for the user (First Name, Last Name, City).

Step 2: Download and install HAL & REST UI module.

Step 3: Create a custom module named 'restapi' and add the info.yml file and create a folder structure in the 'restapi' module folder as 'src\Plugin\rest\resource'

Step 4: Create the php files for different operations.
UserRegistrationRest.php - For user registration



<?php

namespace Drupal\restapi\Plugin\rest\resource;
use Drupal\rest\Plugin\ResourceBase;
use Psr\Log\LoggerInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Drupal\user\Entity\User;

/**
* Provides a resource to get view modes by entity and bundle.
* @RestResource(
*   id = "user_registration_rest",
*   label = @Translation("User Registration API"),
*   uri_paths = {
*     "create" = "/api/user-registration",
*   }
* )
*/
class UserRegistrationRest extends ResourceBase {
    /**
    * A current user instance which is logged in the session.
    * @var \Drupal\Core\Session\AccountProxyInterface
    */
    protected $loggedUser;

    /**
    * Constructs a Drupal\rest\Plugin\ResourceBase object.
    *
    * @param array $config
    *   A configuration array which contains the information about the plugin instance.
    * @param string $module_id
    *   The module_id for the plugin instance.
    * @param mixed $module_definition
    *   The plugin implementation definition.
    * @param array $serializer_formats
    *   The available serialization formats.
    * @param \Psr\Log\LoggerInterface $logger
    *   A logger instance.
    * @param \Drupal\Core\Session\AccountProxyInterface $current_user
    *   A currently logged user instance.
    */
    public function __construct(array $config, $module_id, $module_definition, array $serializer_formats, LoggerInterface $logger, AccountProxyInterface $current_user) {
        parent::__construct($config, $module_id, $module_definition, $serializer_formats, $logger);
        $this->loggedUser = $current_user;
    }

    /**
    * {@inheritdoc}
    */
    public static function create(ContainerInterface $container, array $config, $module_id, $module_definition) {
        return new static(
            $config,
            $module_id,
            $module_definition,
            $container->getParameter('serializer.formats'),
            $container->get('logger.factory')->get('user_registration_api'),
            $container->get('current_user')
        );
    }

    /*
    * User Registration API
    */
    public function post(Request $data) {
        global $base_url;
        try {
            $content = $data->getContent();
            $params = json_decode($content, TRUE);

            $message_string = "";
            $message_string .= empty($params['email']) ? "Email ID. " : "";
            $message_string .= empty($params['password']) ? "Password. " : "";
            $message_string .= empty($params['first_name']) ? "First Name. " : "";
            $message_string .= empty($params['last_name']) ? "Last Name. " : "";
            $message_string .= empty($params['city']) ? "City. " : "";
            if($message_string) {
                $final_api_reponse = array(
                    "status" => "Error",
                    "message" => "Mandatory Fields Missing",
                    "result" => "Required fields: ".$message_string
                );
            }
            else {
                $user_name = strtolower($params['first_name'].'.'.$params['last_name']);
                $user_full_name = ucfirst($params['first_name']).' '.ucfirst($params['last_name']);
                $user_email = $params['email'];

                // Checking for duplicate user entries
                $email_check = \Drupal::entityQuery('user')->accessCheck(TRUE)->condition('mail', $user_email)->execute();
                $username_check = \Drupal::entityQuery('user')->accessCheck(TRUE)->condition('name', $user_name)->execute();
                if (!empty($email_check) || !empty($username_check)) {
                    $final_api_reponse = array(
                        "status" => "Error",
                        "message" => "Registration Failed",
                        "result" => "User details already exists. Please try with different Name or Email-ID."
                    );
                }
                else {
                    // Create new user
                    $new_user = User::create([
                        'name' => $user_name,
                        'pass' => $params['password'],
                        'mail' => $user_email,
                        'roles' => array('general', 'authenticated'),
                        'field_first_name' => ucfirst($params['first_name']),
                        'field_last_name' => ucfirst($params['last_name']),
                        'field_city' => $params['city'],
                        'status' => 1,
                    ])->save();

                    $final_api_reponse = array(
                        "status" => "Success",
                        "message" => "Registration Successful",
                        "result" => "Thank You. Account for ".$user_full_name." has been created."
                    );
                }
            }
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }
}

UserLoginRest.php - For user login



<?php

namespace Drupal\restapi\Plugin\rest\resource;
use Drupal\rest\Plugin\ResourceBase;
use Drupal\Core\Session\AccountProxyInterface;
use Drupal\Core\Access\CsrfTokenGenerator;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\user\UserAuthInterface;
use Drupal\user\UserFloodControlInterface;
use Drupal\user\UserInterface;
use Drupal\user\UserStorageInterface;
use Psr\Log\LoggerInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\Serializer\Encoder\JsonEncoder;
use Symfony\Component\Serializer\Serializer;
use Drupal\user\Entity\User;

/**
* Provides a resource to get view modes by entity and bundle.
* @RestResource(
*   id = "user_login_rest",
*   label = @Translation("User Login API"),
*   uri_paths = {
*     "create" = "/api/user-login",
*   }
* )
*/
class UserLoginRest extends ResourceBase {
    /**
    * String sent in responses, to describe the user as being logged in.
    * @var string
    */
    const LOGGED_IN = 1;
    /**
    * String sent in responses, to describe the user as being logged out.
    * @var string
    */
    const LOGGED_OUT = 0;
    /**
    * The user flood control service.
    * @var \Drupal\user\UserFloodControl
    */
    protected $userFloodControl;
    /**
    * The user storage.
    * @var \Drupal\user\UserStorageInterface
    */
    protected $userStorage;
    /**
    * The CSRF token generator.
    * @var \Drupal\Core\Access\CsrfTokenGenerator
    */
    protected $csrfToken;
    /**
    * The user authentication.
    * @var \Drupal\user\UserAuthInterface
    */
    protected $userAuth;
    /**
    * The route provider.
    * @var \Drupal\Core\Routing\RouteProviderInterface
    */
    protected $routeProvider;
    /**
    * The serializer.
    * @var \Symfony\Component\Serializer\Serializer
    */
    protected $serializer;
    /**
    * The available serialization formats.
    * @var array
    */
    protected $serializerFormats = [];
    /**
    * A logger instance.
    * @var \Psr\Log\LoggerInterface
    */
    protected $logger;
    /**
    * Constructs a new UserAuthenticationController object.
    *
    * @param \Drupal\user\UserFloodControlInterface $user_flood_control
    *   The user flood control service.
    * @param \Drupal\user\UserStorageInterface $user_storage
    *   The user storage.
    * @param \Drupal\Core\Access\CsrfTokenGenerator $csrf_token
    *   The CSRF token generator.
    * @param \Drupal\user\UserAuthInterface $user_auth
    *   The user authentication.
    * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
    *   The route provider.
    * @param \Symfony\Component\Serializer\Serializer $serializer
    *   The serializer.
    * @param array $serializer_formats
    *   The available serialization formats.
    * @param \Psr\Log\LoggerInterface $logger
    *   A logger instance.
    */
    public function __construct(array $config, $module_id, $module_definition, array $serializer_formats, UserStorageInterface $user_storage, CsrfTokenGenerator $csrf_token, UserAuthInterface $user_auth, RouteProviderInterface $route_provider, LoggerInterface $logger, AccountProxyInterface $current_user) {
        parent::__construct($config, $module_id, $module_definition, $serializer_formats, $logger);
        $this->loggedUser = $current_user;
        $this->userStorage = $user_storage;
        $this->csrfToken = $csrf_token;
        $this->userAuth = $user_auth;
        $this->routeProvider = $route_provider;
    }

    /**
    * {@inheritdoc}
    */
    public static function create(ContainerInterface $container, array $config, $module_id, $module_definition) {
        return new static(
            $config,
            $module_id,
            $module_definition,
            $container->getParameter('serializer.formats'),
            $container->get('entity_type.manager')->getStorage('user'),
            $container->get('csrf_token'),
            $container->get('user.auth'),
            $container->get('router.route_provider'),
            $container->get('logger.factory')->get('user_login_api'),
            $container->get('current_user')
        );
    }

    /**
    * Logs in a user.
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request.
    * @return \Symfony\Component\HttpFoundation\Response
    *   A response which contains the ID and CSRF token.
    */
    public function post(Request $data) {
        global $base_url;
        try {
            $content = $data->getContent();
            $params = json_decode($content, TRUE);
            $email = $params['email'];
            $password = $params['pass'];
            if (empty($email) || empty($password)) {
                $final_api_reponse = array(
                    "status" => "Error",
                    "message" => "Missing Credentials"
                );
            }
            else {
                $user = user_load_by_mail($email);
                if(empty($user)) {
                    $final_api_reponse = array(
                        "status" => "Error",
                        "message" => "User Not Found",
                        "result" => "No user registered with ".$email
                    );
                }
                else {
                    $user_name = $user->get('name')->value;
                    if ($uid = $this->userAuth->authenticate($user_name, $password)) {
                        $user = $this->userStorage->load($uid);
                        $this->userLoginFinalize($user);
                        $response_data = array();
                        if ($user->get('uid')->access('view', $user)) {
                            $response_data['current_user']['uid'] = $user->id();
                        }
                        if ($user->get('name')->access('view', $user)) {
                            $response_data['current_user']['name'] = $user->getAccountName();
                        }
                        $response_data['csrf_token'] = $this->csrfToken->get('rest');
                        $logout_route = $this->routeProvider->getRouteByName('user.logout.http');
                        $logout_path = ltrim($logout_route->getPath(), '/');
                        $response_data['logout_token'] = $this->csrfToken->get($logout_path);
                        $final_api_reponse = array(
                            "status" => "Success",
                            "message" => "Login Success",
                            "result" => $response_data
                        );
                    }
                    else {
                        $final_api_reponse = array(
                            "status" => "Error",
                            "message" => "Invalid Credentials"
                        );
                    }
                }
            }
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }

    /**
    * Finalizes the user login.
    * @param \Drupal\user\UserInterface $user
    * The user.
    */
    protected function userLoginFinalize(UserInterface $user) {
        user_login_finalize($user);
    }
}

UserAccountRest.php - For fetching and editing user details



<?php

namespace Drupal\restapi\Plugin\rest\resource;
use Drupal\rest\Plugin\ResourceBase;
use Psr\Log\LoggerInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Drupal\user\Entity\User;

/**
* Provides a resource to get view modes by entity and bundle.
* @RestResource(
*   id = "user_account_rest",
*   label = @Translation("User Account API"),
*   uri_paths = {
*     "canonical" = "/api/user-account",
*     "create" = "/api/edit-account",
*   }
* )
*/

class UserAccountRest extends ResourceBase {
    /**
    * A current user instance which is logged in the session.
    * @var \Drupal\Core\Session\AccountProxyInterface
    */
    protected $loggedUser;

    /**
    * Constructs a Drupal\rest\Plugin\ResourceBase object.
    *
    * @param array $config
    *   A configuration array which contains the information about the plugin instance.
    * @param string $module_id
    *   The module_id for the plugin instance.
    * @param mixed $module_definition
    *   The plugin implementation definition.
    * @param array $serializer_formats
    *   The available serialization formats.
    * @param \Psr\Log\LoggerInterface $logger
    *   A logger instance.
    * @param \Drupal\Core\Session\AccountProxyInterface $current_user
    *   A currently logged user instance.
    */
    public function __construct(array $config, $module_id, $module_definition, array $serializer_formats, LoggerInterface $logger, AccountProxyInterface $current_user) {
        parent::__construct($config, $module_id, $module_definition, $serializer_formats, $logger);
        $this->loggedUser = $current_user;
    }

    /**
    * {@inheritdoc}
    */
    public static function create(ContainerInterface $container, array $config, $module_id, $module_definition) {
        return new static(
            $config,
            $module_id,
            $module_definition,
            $container->getParameter('serializer.formats'),
            $container->get('logger.factory')->get('user_account_api'),
            $container->get('current_user')
        );
    }

    /*
    * Fetch User Account Details API
    */
    public function get() {
        global $base_url;
        try {
            $logged_user = User::load(\Drupal::currentUser()->id());
            $user_id = $logged_user->get('uid')->value;
            $role = $logged_user->get('roles')->getValue();
            $user_role = $role[0]['target_id'];

            $user_data['user_id'] = $user_id;
            $user_data['role'] = ucfirst($user_role);
            $user_data['first_name'] = $logged_user->get('field_first_name')->value;
            $user_data['last_name'] = $logged_user->get('field_last_name')->value;
            $user_data['email'] = $logged_user->get('mail')->value;
            $user_data['city'] = $logged_user->get('field_city')->value;

            $final_api_reponse = array(
                "status" => "Success",
                "message" => "User Account",
                "result" => $user_data
            );
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }

    /*
    * Edit User Details API
    */
    public function post(Request $data) {
        global $base_url;
        try {
            $logged_user = User::load(\Drupal::currentUser()->id());
            $user_id = $logged_user->get('uid')->value;
            $content = $data->getContent();
            $params = json_decode($content, TRUE);

            if($params['first_name'] != "") {
                $logged_user->set('field_first_name', $params['first_name']);
            }
            if($params['last_name'] != "") {
                $logged_user->set('field_last_name', $params['last_name']);
            }
            if($params['city'] != "") {
                $logged_user->set('field_city', $params['city']);
            }
            $logged_user->save();

            $final_api_reponse = array(
                "status" => "Success",
                "message" => "User Details Updated",
                "result" => "Your details have been updated."
            );
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }
}

UserLogoutRest.php - For user logout



<?php

namespace Drupal\restapi\Plugin\rest\resource;
use Drupal\rest\Plugin\ResourceBase;
use Psr\Log\LoggerInterface;
use Drupal\Core\Session\AccountProxyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Drupal\user\Entity\User;

/**
* Provides a resource to get view modes by entity and bundle.
* @RestResource(
*   id = "user_logout_rest",
*   label = @Translation("User Logout API"),
*   uri_paths = {
*     "create" = "/api/user-logout",
*   }
* )
*/

class UserLogoutRest extends ResourceBase {
    /**
    * A current user instance which is logged in the session.
    * @var \Drupal\Core\Session\AccountProxyInterface
    */
    protected $loggedUser;

    /**
    * Constructs a Drupal\rest\Plugin\ResourceBase object.
    *
    * @param array $config
    *   A configuration array which contains the information about the plugin instance.
    * @param string $module_id
    *   The module_id for the plugin instance.
    * @param mixed $module_definition
    *   The plugin implementation definition.
    * @param array $serializer_formats
    *   The available serialization formats.
    * @param \Psr\Log\LoggerInterface $logger
    *   A logger instance.
    * @param \Drupal\Core\Session\AccountProxyInterface $current_user
    *   A currently logged user instance.
    */
    public function __construct(array $config, $module_id, $module_definition, array $serializer_formats, LoggerInterface $logger, AccountProxyInterface $current_user) {
        parent::__construct($config, $module_id, $module_definition, $serializer_formats, $logger);
        $this->loggedUser = $current_user;
    }

    /**
    * {@inheritdoc}
    */
    public static function create(ContainerInterface $container, array $config, $module_id, $module_definition) {
        return new static(
            $config,
            $module_id,
            $module_definition,
            $container->getParameter('serializer.formats'),
            $container->get('logger.factory')->get('user_logout_api'),
            $container->get('current_user')
        );
    }

    /*
    * User Logout API
    */
    public function post(Request $data) {
        global $base_url;
        try {
            $content = $data->getContent();
            $params = json_decode($content, TRUE);
            $user_id = $params['user_id'];

            $logged_user = User::load(\Drupal::currentUser()->id());
            $current_id = $logged_user->get('uid')->value;
            if(empty($user_id) || ($current_id != $user_id)) {
                $final_api_reponse = array(
                    "status" => "Error",
                    "message" => "Logout Error",
                    "result" => "Please provide valid User-ID"
                );
            }
            else {
                user_logout();
                $final_api_reponse = array(
                    "status" => "Success",
                    "message" => "Logout Success",
                    "result" => "You have successfully logged out from your account."
                );
            }
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }
}

Step 5: Enable the 'restapi' custom module and then enable the APIs from REST UI interface.

Step 6: Set the permissions for each individual APIs.

Step 7: Now we can test these APIs in postman.

Registration
Login

User Details

Edit Details

Logout

So, in this way we can do basic operations using REST API in Drupal. I hope you find this simple use of REST API helpful.

Sending mails using Cron in Drupal 8

Rahul Khan — Thu, 15 Sep 2022 09:21:38 +0000

In this post, we will be sending a simple birthday greeting email to the users using cron.

First, we have to create a module file in our custom module folder. We will name it as 'MODULE_NAME.module'. Using the hook_cron(), we will call a function to send the emails to the users where the mail-body is defined.

function MODULE_NAME_cron() {
    user_birthday_mails();
}

Now we will fetch the details of the users, namely User-Name, Email-ID & Date of Birth.

In this scenario, I'm fetching the user details from a custom table.

<?php
function user_birthday_mails() {
    // this is used to send HTML emails
    $send_mail = new \Drupal\Core\Mail\Plugin\Mail\PhpMail();

    $current_m_d = date('m-d', \Drupal::time()->getRequestTime());
    $fetch_query = \Drupal::database()->query("SELECT `firstname`, `email`, `dob` FROM `TABLE_NAME`");
    $query_result = $fetch_query->fetchAll();

    foreach($query_result as $result){
        $birthday = explode('-', $result->dob);
        $birth_m_d = $birthday[1].'-'.$birthday[2];

        $user_name = $result->firstname;
        $user_mail = $result->email;

        if($birth_m_d == $current_m_d){
            $from = 'sitename@example.com';
            $to = $user_mail;
            $message['headers'] = array(
                'content-type' => 'text/html',
                'MIME-Version' => '1.0',
                'reply-to' => $from,
                'from' => 'Site Admin <'.$from.'>'
            );
            $message['to'] = $to;
            $message['subject'] = "Happy Birthday ".$user_name."!!!";

            $message['body'] = 'Dear '.$user_name.',
            <br><br>
            We value your special day just as much as we value you. On your birthday, we send you our warmest and most heartfelt wishes..
            <br><br>
            Regards,<br>
            Site Admin';

            $send_mail->mail($message);
            \Drupal::logger('userinfo')->notice('Birthday mail sent to '.$user_name);
        };
    }
}

I hope you find this simple use of cron helpful.

Custom Module & DB Table in Drupal 9

Rahul Khan — Fri, 22 Apr 2022 13:15:20 +0000

We will be creating a custom module in Drupal 9 to build a custom form & store the data in a custom table in the database.

Step 1: Name of the Module
We need to create a custom module under 'modules/custom' folder. We will name the folder as 'userinfo'

Step 2: Creating the info.yml file
We have to create a yaml file with the machine name of our module for Drupal to be able recognize the module. We will name the file as 'userinfo.info.yml'

name: User Info
type: module
description: A custom module to enter user information
package: Custom
version: 1.0
core_version_requirement: ^8 || ^9

Step 3: Creating the routing.yml file
Next step is to add a userinfo.routing.yml file under the 'userinfo' directory.
Under path, we specify the URL path for adding user information.

userinfo.form:
 path: '/add-user-info'
 defaults:
  _title: 'Add User Info'
  _form: '\Drupal\userinfo\Form\UserinfoForm'
 requirements:
  _permission: 'access content'

Step 4: Adding the form
We will create a form named 'UserinfoForm.php' under 'modules/custom/userinfo/src/Form'. In this file, we will create a custom form to validate & submit user information.

<?php

/**
 * @file
 * Contains \Drupal\userinfo\Form\UserinfoForm.
*/

namespace Drupal\userinfo\Form;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Database\Database;
use Drupal\Core\Url;
use Drupal\Core\Routing;

class UserinfoForm extends FormBase {
    /**
    * {@inheritdoc}
    */
    public function getFormId() {
        return 'userinfo_form';
    }

    /**
    * {@inheritdoc}
    */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['form_info'] = array(
            '#markup' => '<h4>Saving User Info in a custom table in the database</h4><br>',
        );
        $form['first_name'] = array(
            '#type' => 'textfield',
            '#title' => t('First Name'),
            '#required' => TRUE,
            '#maxlength' => 50,
            '#default_value' => '',
        );
        $form['last_name'] = array(
            '#type' => 'textfield',
            '#title' => t('Last Name'),
            '#required' => TRUE,
            '#maxlength' => 50,
            '#default_value' => '',
        );
        $form['user_email'] = array(
            '#type' => 'textfield',
            '#title' => t('Email-ID'),
            '#required' => TRUE,
            '#maxlength' => 50,
            '#default_value' => '',
        );
        $form['user_age'] = [
            '#type' => 'textfield',
            '#title' => t('Age'),
            '#required' => TRUE,
            '#maxlength' => 20,
            '#default_value' => '',
        ];
        $form['user_city'] = array(
            '#type' => 'textfield',
            '#title' => t('City'),
            '#required' => TRUE,
            '#maxlength' => 50,
            '#default_value' => '',
        );

        $form['actions']['#type'] = 'actions';
        $form['actions']['submit'] = array(
            '#type' => 'submit',
            '#value' => $this->t('Save Info'),
            '#button_type' => 'primary',
        );
        return $form;
    }

    /**
    * {@inheritdoc}
    */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        if ($form_state->getValue('first_name') == '') {
            $form_state->setErrorByName('first_name', $this->t('Please Enter First Name'));
        }
        if ($form_state->getValue('last_name') == '') {
            $form_state->setErrorByName('last_name', $this->t('Please Enter Last Name'));
        }
        if ($form_state->getValue('user_email') == '') {
            $form_state->setErrorByName('user_email', $this->t('Please Enter Email-ID'));
        }
        if ($form_state->getValue('user_age') == '') {
            $form_state->setErrorByName('user_age', $this->t('Please Enter Age'));
        }
        if ($form_state->getValue('user_city') == '') {
            $form_state->setErrorByName('user_city', $this->t('Please Enter City'));
        }
    }

    /**
    * {@inheritdoc}
    */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        try{
            $conn = Database::getConnection();
            $field = $form_state->getValues();

            $fields["first_name"] = $field['first_name'];
            $fields["last_name"] = $field['last_name'];
            $fields["user_email"] = $field['user_email'];
            $fields["user_age"] = $field['user_age'];
            $fields["user_city"] = $field['user_city'];

            $conn->insert('user_info')
            ->fields($fields)->execute();
            \Drupal::messenger()->addMessage(t("User info has been succesfully saved"));
        }
        catch(Exception $ex){
            \Drupal::logger('userinfo')->error($ex->getMessage());
        }
    }
}

Step 5: Creating table schema
Now, we will create a database table schema in 'userinfo.install' file to store the user information. We will place this file in the module root folder.
The table name is 'user_info' with the following fields: user_id, first_name, last_name, user_email, user_age & user_city.

<?php
use Drupal\Core\Database\Database;

/**
 * Implements hook_schema().
 */
function userinfo_schema(){
    $schema['user_info'] = array(
        'description' => 'The table for storing the user information',
        'fields' => array(
            'user_id' => array(
                'description' => 'Primary identifier for User',
                'type' => 'serial',
                'not null' => TRUE,
                'unsigned' => TRUE,
            ),
            'first_name' => array(
                'description' => 'User First Name',
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
            ),
           'last_name' => array(
                'description' => 'User Last Name.',
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
            ),
            'user_email' => array(
                'description' => 'User Email ID',
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
            ),
            'user_age' => array(
                'description' => 'Age of User',
                'type' => 'int',
                'length' => 100,
                'not null' => TRUE,
            ),
            'user_city' => array(
                'description' => 'User City',
                'type' => 'varchar',
                'length' => 255,
                'not null' => TRUE,
                'default' => '',
            ),
        ),
        'primary key' => array('user_id'),
    );
    return $schema;
}

Once everything is done, we can enable the module & hit the URL mentioned in the routing file.

Reset Drupal Admin Password using Drush

Rahul Khan — Thu, 24 Mar 2022 13:22:52 +0000

This article describes how to reset the Drupal administrator password using Drush. We can use the Drush command line tool to reset the administrator password (or the password of any other user).

To do this, we have to first log in with our account using SSH & enter the following commands:

C:\Users\user_name>ssh site_name.dev@site_name.ssh.dev.acquia-sites.com
site_name@dev-1234:~$ cd ..
site_name@dev-1234:/home$ cd ..
site_name@dev-1234:/$ cd var/www/html/site_name/docroot
site_name@dev-1234:/var/www/html/site_name/docroot$ drush --uri=site_name.com upwd admin --password=Password123
Changes password for admin
site_name@dev-1234:/var/www/html/site_name/docroot$ exit
logout
Connection to site_name.ssh.dev.acquia-sites.com closed.

I did this for my project in DEV environment. I hope this is helpful & I would appreciate if any better solution is available.

Custom CRUD API in Drupal 9

Rahul Khan — Sun, 09 Jan 2022 14:43:25 +0000

We will be creating a custom API for our custom module in Drupal 9 to perform basic CRUD operations using API. We will perform the operations on our custom content type.

Step 1: Creating new folders in the Custom Module
We will create a new folder in our custom module folder (candidates) as the following structure. We will place the API codes in this folder.

Step 2: Creating CandidatesController.php file
In this folder, we will create a new file called 'CandidatesController.php'.

<?php
/**
* @file
* Contains \Drupal\candidates\Controller\CandidatesController.
*/
namespace Drupal\candidates\Controller;
use Drupal\Core\Controller\ControllerBase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Drupal\user\Entity\User;
use Drupal\node\Entity\Node;
use Drupal\Core\Entity;
use Drupal\taxonomy\Entity\Term;

//Controller routines for candidates routes

class CandidatesController extends ControllerBase {
}

Step 3: Writing the APIs for CRUD operations
Now, we will write the different APIs for adding, fetching, editing & deleting the records.
Get All Candidates Details API: get_candidate_detail
Add Candidates Details API: add_candidate_detail
Fetch Single Candidate Details after adding: fetch_candidate_detail
Edit Candidates Details API: edit_candidate_detail
Delete Candidates Details API: delete_candidate

<?php
/**
* @file
* Contains \Drupal\candidates\Controller\CandidatesController.
*/
namespace Drupal\candidates\Controller;
use Drupal\Core\Controller\ControllerBase;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\JsonResponse;
use Drupal\user\Entity\User;
use Drupal\node\Entity\Node;
use Drupal\Core\Entity;
use Drupal\taxonomy\Entity\Term;

//Controller routines for candidates routes

class CandidatesController extends ControllerBase {
    /**
    * Get All Candidates Details API
    */
    public function get_candidate_detail(Request $request) {
        global $base_url;
        try{
            $content = $request->getContent();
            $params = json_decode($content, TRUE);
            $uid = $params['uid'];
            $user = User::load($uid);
            $all_candidates = array();

            $query_string = "SELECT node_field_data.langcode AS node_field_data_langcode, node_field_data.created AS node_field_data_created, node_field_data.nid AS nid
            FROM {node_field_data} node_field_data
            WHERE (node_field_data.status = '1') AND (node_field_data.type IN ('candidate'))
            ORDER BY node_field_data_created ASC";
            $candidate_fetch_details = \Drupal::database()->query($query_string)->fetchAll();

            foreach($candidate_fetch_details as $key => $node_id){
                $nodeid = $node_id->nid;
                $node = Node::load($nodeid);

                $candidate_details['candidate_id'] = $nodeid;
                $candidate_details['candidate_name'] = $node->get('title')->value;
                $date = date_create($node->get('field_birth_date')->value);
                $birth_date = date_format($date, "d/m/Y");
                $candidate_details['candidate_dob'] = $birth_date;
                $candidate_details['candidate_gender'] = $node->get('field_gender')->value;
                $candidate_details['candidate_mobile'] = $node->get('field_mobile')->value;
                $candidate_details['candidate_email'] = $node->get('field_email_id')->value;
                $candidate_details['candidate_city'] = $node->get('field_city')->value;
                $candidate_details['candidate_country'] = $node->get('field_country')->value;
                $candidate_details['candidate_description'] = $node->get('field_description')->value;
                array_push($all_candidates, $candidate_details);
            }
            $final_api_reponse = array(
                "status" => "OK",
                "message" => "All Candidate Details",
                "result" => $all_candidates
            );
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }

    /**
    * Add Candidates Details API
    */
    public function add_candidate_detail(Request $request){
        global $base_url;
        try{
            $content = $request->getContent();
            $params = json_decode($content, TRUE);

            $uid = $params['uid'];
            $user = User::load($uid);

            $date = explode('/', $params['candidate_dob']);
            $birth_date = $date[2] . "-" . $date[1] . "-" . $date[0];

            $newCandidate = Node::create([
                'type' => 'candidate',
                'uid' => 1,
                'title' => array('value' => $params['candidate_name']),
                'field_birth_date' => array('value' => $birth_date),
                'field_gender' => array('value' => $params['candidate_gender']),
                'field_mobile' => array('value' => $params['candidate_mobile']),
                'field_email_id' => array('value' => $params['candidate_email']),
                'field_city' => array('value' => $params['candidate_city']),
                'field_country' => array('value' => $params['candidate_country']),
                'field_description' => array('value' => $params['candidate_description']),
            ]);

            // Makes sure this creates a new node
            $newCandidate->enforceIsNew();

            // Saves the node, can also be used without enforceIsNew() which will update the node if a $newCandidate->id() already exists
            $newCandidate->save();
            $nid = $newCandidate->id();
            $new_candidate_details = $this->fetch_candidate_detail($nid);
            $final_api_reponse = array(
                "status" => "OK",
                "message" => "Candidate Details Added Successfully",
                "result" => $new_candidate_details,
            );
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }

    public function fetch_candidate_detail($nid){
        if(!empty($nid)){
            $node = Node::load($nid);

            $date = date_create($node->get('field_birth_date')->value);
            $birth_date = date_format($date, "d/m/Y");
            $candidate_details['candidate_name'] = $node->get('title')->value;
            $candidate_details['candidate_dob'] = $birth_date;
            $candidate_details['candidate_gender'] = $node->get('field_gender')->value;
            $candidate_details['candidate_mobile'] = $node->get('field_mobile')->value;
            $candidate_details['candidate_email'] = $node->get('field_email_id')->value;
            $candidate_details['candidate_city'] = $node->get('field_city')->value;
            $candidate_details['candidate_country'] = $node->get('field_country')->value;
            $candidate_details['candidate_description'] = $node->get('field_description')->value;

            $final_api_reponse = array(
                'candidate_detail' => $candidate_details
            );
            return $final_api_reponse;
        }
        else{
            $this->exception_error_msg("Candidate details not found.");
        }
    }

    /**
    * Edit Candidates Details API
    */
    public function edit_candidate_detail(Request $request){
        global $base_url;
        try{
            $content = $request->getContent();/* reads json input from login API callback */
            $params = json_decode($content, TRUE);

            $uid = $params['uid'];
            $user = User::load($uid);

            $nid = $params['nid'];
            $date = explode('/', $params['candidate_dob']);
            $date_of_birth = $date[2] . "-" . $date[1] . "-" . $date[0];

            if(!empty($nid)){
                $node = Node::load($nid);
                $node->set("field_birth_date", array('value' => $date_of_birth));
                $node->set("field_gender", array('value' => $params['candidate_gender']));
                $node->set("field_mobile", array('value' => $params['candidate_mobile']));
                $node->set("field_email_id", array('value' => $params['candidate_email']));
                $node->set("field_city", array('value' => $params['candidate_city']));
                $node->set("field_country", array('value' => $params['candidate_country']));
                $node->set("field_description", array('value' => $params['candidate_description']));
                $node->save();
                $final_api_reponse = array(
                    "status" => "OK",
                    "message" => "Candidate Details Updated Successfully",
                );
            }
            else{
                $final_api_reponse = array(
                    "status" => "FAIL",
                    "message" => "Candidate ID is reqired",
                );
            }
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $this->exception_error_msg($exception->getMessage());
        }
    }

    /**
    * Delete Candidates Details API
    */
    public function delete_candidate(Request $request){
        global $base_url;
        try{
            $content = $request->getContent();
            $params = json_decode($content, TRUE);
            $nid = $params['nid'];
            if(!empty($nid)){
                $node = \Drupal::entityTypeManager()->getStorage('node')->load($nid);
                $node->delete();
                $final_api_reponse = array(
                    "status" => "OK",
                    "message" => "Candidate record has been deleted successfully",
                );
            }
            return new JsonResponse($final_api_reponse);
        }
        catch(Exception $exception) {
            $web_service->error_exception_msg($exception->getMessage());
        }
    }
}

Step 4: Adding the API in routing.yml
Now we will add the API paths in the candidates.routing.yml file

get_candidate_detail:
 path: 'api/get_candidate_detail'
 defaults: { _controller: '\Drupal\candidates\Controller\CandidatesController::get_candidate_detail' }
 methods: [POST]
 requirements:
  _permission: 'access content'

add_candidate_detail:
 path: 'api/add_candidate_detail'
 defaults: { _controller: '\Drupal\candidates\Controller\CandidatesController::add_candidate_detail' }
 methods: [POST]
 requirements:
   _permission: 'access content'

edit_candidate_detail:
 path: 'api/edit_candidate_detail'
 defaults: { _controller: '\Drupal\candidates\Controller\CandidatesController::edit_candidate_detail' }
 methods: [POST]
 requirements:
   _permission: 'access content'

delete_candidate :
 path: 'api/delete_candidate'
 defaults: { _controller: '\Drupal\candidates\Controller\CandidatesController::delete_candidate' }
 methods: [POST]
 requirements:
   _permission: 'access content'

Step 5: Using the APIs
Using Postman, we can use the different APIs to add, edit, delete & fetch data from our custom content type.
We will have to set the header Content-Type as application/json & method POST.
The following params can be used to add candidate data:

{
    "candidate_name" : "Rahul Khan",
    "candidate_dob" : "10/12/1990",
    "candidate_gender" : "male",
    "candidate_mobile" : "9876543210",
    "candidate_email" : "rahul@khan.com",
    "candidate_city": "Bangalore",
    "candidate_country" : "India",
    "candidate_description" : "Hello. Test description."
}

For editing, we can use the above params to edit data. For deleting a record, we will need to pass candidate_id (nid).

Custom Module in Drupal 9

Rahul Khan — Mon, 03 Jan 2022 06:21:27 +0000

We will be creating a custom module in Drupal 9 to build a custom form & store the data in a custom content type.

Step 1: Name of the Module
We need to create a custom module under 'modules/custom' folder. We will name the folder as 'candidates'

Step 2: Creating the info.yml file
We have to create a yaml file with the machine name of our module for Drupal to be able recognize the module. We will name the file as 'candidates.info.yml'

name: Candidates Data
type: module
description: A custom module to enter candidate details
package: Custom
version: 1.0
core_version_requirement: ^8 || ^9

Step 3: Creating the routing.yml file
Next step is to add a candidates.routing.yml file under the 'candidates' directory.
Under path, we specify the URL path for adding Candidate data.
Under defaults, the _controller which references a method on the CandidatesController class and the _title specifies the default page title.
Under requirements, we specify the permission to view the page.

candidates.form:
 path: '/add-candidate'
 defaults:
  _title: 'Add Candidates'
  _form: '\Drupal\candidates\Form\CandidatesForm'
 requirements:
  _permission: 'access content'

Step 4: Adding the controller
We will create a controller file named 'CandidatesController.php' under 'modules/custom/candidates/src/Controller'. In this file, we will create a custom form to validate & submit candidate data. We will store the data into a custom content type named 'candidate'.

<?php

/**
 * @file
 * Contains \Drupal\candidates\Form\CandidatesForm.
*/

namespace Drupal\candidates\Form;
use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\node\Entity\Node;

class CandidatesForm extends FormBase {
    /**
    * {@inheritdoc}
    */
    public function getFormId() {
        return 'candidates_form';
    }

    /**
    * {@inheritdoc}
    */
    public function buildForm(array $form, FormStateInterface $form_state) {
        $form['candidate_name'] = array(
            '#type' => 'textfield',
            '#title' => t('Candidate Name'),
            '#required' => TRUE,
        );
        $form['candidate_dob'] = array(
            '#type' => 'date',
            '#title' => t('Birth Date'),
            '#required' => TRUE,
        );
        $form['candidate_gender'] = array(
            '#type' => 'select',
            '#title' => ('Gender'),
            '#required' => TRUE,
            '#options' => array(
                'male' => t('Male'),
                'female' => t('Female'),
                'other' => t('Other'),
            ),
        );
        $form['candidate_mobile'] = array(
            '#type' => 'textfield',
            '#title' => t('Mobile'),
            '#required' => TRUE,
            '#maxlength' => 10,
        );
        $form['candidate_email'] = array(
            '#type' => 'email',
            '#title' => t('Email-ID'),
            '#required' => TRUE,
        );
        $form['candidate_city'] = array(
            '#type' => 'textfield',
            '#title' => t('City'),
            '#required' => TRUE,
        );
        $form['candidate_country'] = array(
            '#type' => 'textfield',
            '#title' => t('Country'),
            '#required' => TRUE,
        );
        $form['candidate_description'] = array(
            '#type' => 'textarea',
            '#title' => t('Description'),
            '#required' => TRUE,
        );
        $form['actions']['#type'] = 'actions';
        $form['actions']['submit'] = array(
            '#type' => 'submit',
            '#value' => $this->t('Save Candidate Data'),
            '#button_type' => 'primary',
        );
        return $form;
    }

    /**
    * {@inheritdoc}
    */
    public function validateForm(array &$form, FormStateInterface $form_state) {
        if ($form_state->getValue('candidate_name') == '') {
            $form_state->setErrorByName('candidate_name', $this->t('Please Enter Name'));
        }
        if ($form_state->getValue('candidate_dob') == '') {
            $form_state->setErrorByName('candidate_dob', $this->t('Please Enter Birth Date'));
        }
        if ($form_state->getValue('candidate_gender') == '') {
            $form_state->setErrorByName('candidate_gender', $this->t('Please Select Gender'));
        }
        if ($form_state->getValue('candidate_mobile') == '') {
            $form_state->setErrorByName('candidate_mobile', $this->t('Please Enter Mobile'));
        }
        if ($form_state->getValue('candidate_email') == '') {
            $form_state->setErrorByName('candidate_email', $this->t('Please Enter Email-ID'));
        }
        if ($form_state->getValue('candidate_city') == '') {
            $form_state->setErrorByName('candidate_city', $this->t('Please Enter City'));
        }
        if ($form_state->getValue('candidate_country') == '') {
            $form_state->setErrorByName('candidate_country', $this->t('Please Enter Country'));
        }
        if ($form_state->getValue('candidate_description') == '') {
            $form_state->setErrorByName('candidate_description', $this->t('Please Enter Description'));
        }
    }

    /**
    * {@inheritdoc}
    */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $node = Node::create(['type' => 'candidate']);
        $node->langcode = "en";
        $node->uid = 1;
        $node->promote = 0;
        $node->sticky = 0;
        $node->title= $form_state->getValue('candidate_name');
        $node->field_birth_date = $form_state->getValue('candidate_dob');
        $node->field_gender = $form_state->getValue('candidate_gender');
        $node->field_mobile = $form_state->getValue('candidate_mobile');
        $node->field_email_id = $form_state->getValue('candidate_email');
        $node->field_city = $form_state->getValue('candidate_city');
        $node->field_country = $form_state->getValue('candidate_country');
        $node->field_description = $form_state->getValue('candidate_description');
        $node->save();

        \Drupal::messenger()->addMessage(t("Candidate Data Save Successful"));
    }
}

Step 5: Creating custom content type
Create a custom content type named 'candidate' to store the data