Difference between revisions of "Drupal/C4/Creating-a-simple-custom-module/English"

Creating a simple custom module

• Create a basic module
• Add a basic controller
• add a routing file

• Create a basic module
• Add a basic controller and
• Add a routing file

System requirement

To record this tutorial, I am using

• Ubuntu Linux 16.04 OS
• Drupal 8
• Firefox web browser
• Gedit text editor

• Ubuntu Linux 16.04
• Drupal 8
• Firefox web browser and
• Gedit text editor

You can use any text editor and web browser of your choice.

• You should have basic knowledge of Drupal
• If not, for relevant Drupal tutorials please visit http://spoken-tutorial.org

If not, for relevant Drupal tutorials, please visit the link shown.

• Object oriented programming terminology
• Programming in PHP
• Namespacing in PHP
• Symfony 2

For more details, please see the “Additional reading material” link

• Object oriented programming terminology
• Programming in PHP
• Namespacing in PHP and
• Symfony 2

For details of pre-requisites, please see the “Additional reading material” link of this tutorial.

Now we will learn to create a simple custom module.

The Request is what we request to the website.

Router determines what should be done with the request.

The controller builds the response for the given request.

The View creates the response.

The response is what the website returns.

Open your File browser.

Point to modules folder

We have to always create our custom modules inside this modules folder.

This will separate our custom modules from the contributed modules.

It will be used by core Drupal programmatically, to refer to this module.

• It must contain only lower-case letters, underscores and no spaces
• It must be unique and can not have the same short name
• It should not be any reserved terms such as src, lib, vendor, templates, includes, fixtures

• It must contain only lower-case letters, underscores but no spaces.
• It must be unique and cannot have the same short name as any other module or theme
• It cannot have any reserved terms such as src, lib, vendor, templates, includes, fixtures, etc.

<<PAUSE>>

Highlight the folder name and file name

Here, we will create a file called hello_world with info.yml extension.

The name of the info.yml file and the name of the module folder should be the same.

• Yml is the file extension of YAML
• YAML is a unicode based data serialization standard for all programming languages
• It is a human-readable language.

YAML is a unicode based data serialization standard for all programming languages.

It is a human-readable language.

name: Hello World

description: A page displaying "Hello World"

package: Custom

type: module

core: 8.x

In this file, we will store the metadata of our module.

So type the following metadata.

<<PAUSE>>

<?php

/**

* @file

* Hello World module.

*/

But we just need to create this file.

In this file, type the following.

<<PAUSE>>

Open our local Drupal website.

To do that, click on the Configuration menu.

You can see that the caches are cleared.

It is compulsory to clear the caches every time we modify our website.

Our custom module is enabled now.

<<PAUSE>>

• This is to tell Drupal where the module can be accessed from.
• The router determines what should be done with the request.
• The router also checks if the access is permitted.

This is to tell Drupal where the module can be accessed from.

The router determines what should be done with the request.

The router also checks if the access is permitted.

hello_world.content:

path: '/hello'

defaults:

_controller: '\Drupal\hello_world\Controller\HelloWorldController::content'

requirements:

_permission: 'access content'

Let us understand the code.

Highlight path: '/hello'

Highlight _controller: '\Drupal\hello_world\Controller\HelloController::content'

Highlight _permission: 'access content'

This indicates what path will be used to access our module.

This is to tell Drupal where to get the content from.

Here content is the function which we will create in the controller file.

This is to ensure only users who can access content, will be able to see our Hello World page.

<<PAUSE>>

This is done by adding a controller.

• Controller is a PHP function
• It takes information from the HTTP request and constructs and returns an HTTP response

Controller is a PHP function.

It takes information from the HTTP request and constructs and returns an HTTP response.

namespace Drupal\hello_world\Controller;

use Drupal\Core\Controller\ControllerBase;

class HelloWorldController extends ControllerBase {

public function content() {

return array (

'#title' => 'Hello World',

'#markup' => 'Welcome to the Drupal Development World!'),

);

}

}

namespace Drupal\hello_world\Controller;

Highlight use Drupal\Core\Controller\ControllerBase;

Highlight class HelloWorldController

'#title' => 'Hello World',

'#markup' => 'Welcome to the Drupal Development World!'),

This use statement will import the ControllerBase class.

We have a class HelloWorldController with the function content.

It will return the markup text when the routing system invokes the page.

<<PAUSE>>

Highlight /hello in the routing.yml file

This is the path we created in the routing file to access our module.

Now press Enter.

We can see our custom page which we created just now. This is the response.

<<PAUSE>>

Summary

In this tutorial, we have learnt to-

• Create a basic module
• Add a basic controller
• Add a route file

In this tutorial, we have learnt to-

• Create a basic module
• Add a basic controller
• Add a routing file

Assignment

Create a custom module for “About us” page of your website

Acknowledgement

Please download and watch it.

Spoken Tutorial Workshops

For more details, please write to us.

Acknowledgement

• NMEICT, Ministry of Human Resource Development and
• NVLI, Ministry of Culture

Government of India.