Skip to main content

Naming Convention on drupal-8 module development,

Before going to start working on drupal 8, Today i will explain you the naming conventation of the drupal module development

 First Step:- to create a new folder for new D-8 module,

 sites/all/custom/{module_name} OR sites/all/modules/{module_name}

That is the standard way to create custom module and themes, now choose the name of the module , Always remember module machine name and module folder name both are different thing, and we can choose diffrent foldername rather than same module machine name, lets suppose, my module folder name is sites/all/custom/HelloWorld while my module machine name is hello_world, When we are going to choose the module machine name, there are some following rules to keep in mind, 1- module machine name always start with letters, 2- module machine name must contain only lower-case letters and underscores. 3- it should be unique , your module machine name may not have used in any module/theme or profile, 4- it may not have the some preserved keywords, like src,files.images,js,misc,drupal etc And don not use the upper case letters on module machine name,

When you create the drupal-8 module files the format would be like this,

module_name.info.yml ( module_name means module machine name)
module_machine_name.module 
module_machine_name.links.menu.yml
module_machine_name.routing.yml
module_machine_name.permissions.yml  etc


Naming conventation of Drupal-8

1- Classes and interfaces should use UpperCamel( pascal Case) naming, like
          ->  in which several words are joined together, and the first letter of every  word is capitalized  but subsequent first letters are uppercase. 
like:   ThisIsAnExample

2- Methods and class properties should use lowerCamel naming: (are those
where the first letter of the entire word is lowercase, but subsequent first letters are uppercase.  like   thisIsAnExample  )

3- Classes should not use underscores in class names unless absolutely necessary to derive names inherited class names dynamically. That is quite rare, especially as Drupal does not mandate a class-file naming match.

4- Names should not include "Drupal".
5- Class names should not have "Class" in the name.
6- Interfaces should always have the suffix "Interface".

7- Protected or private properties and methods should not use an underscore prefix.





































Comments

Popular posts from this blog

Get The field values of node in Drupal 8

use Drupal \ node \ NodeInterface ; /** * Implements hook_ENTITY_TYPE_insert() for node entities. * * This tests saving a node on node insert. * * @see \Drupal\node\Tests\NodeSaveTest::testNodeSaveOnInsert() */ function node_test_node_insert ( NodeInterface $node ) { // Set the node title to the node ID and save. if ( $node - > getTitle ( ) == 'new' ) { $node - > setTitle ( 'Node ' . $node - > id ( ) ) ; $node - > setNewRevision ( FALSE ) ; $node - > save ( ) ; } } Now There is so many functions are there to get the values, For All the functions available visit the API code, https://api.drupal.org/api/drupal/core%21modules%21node%21src%21NodeInterface.php/interface/NodeInterface/8.2.x Some of as below, Node edit form, Drupal 8 Automatically Load the whole object no need to load the entity like below, if ($event->getFormId() == 'node_alexa_audio_clips_edit_form') { $node = \Drupal::ro...

Drupal Setup with docker

Option 1:  docker pull mysql docker pull phpmyadmin docker pull drupal docker run -d --name MysqlClient -e MYSQL_ROOT_PASSWORD=drupal mysql Download the phpmyadmin image and Setup Container: docker run --name phpmyadmin -d --link MysqlClient:db -p 8083:80 phpmyadmin Download the Drupal image and Setup Container: docker run -d --name dweb2 --link MysqlClient -p 8082:80 -e MYSQL_USER:root -e MYSQL_PASSWORD:drupal drupal   We are using docker4 drupal and following below URL https://wodby.com/docs/1.0/stacks/drupal/local/ From Mount my codebase Download and unpack docker4drupal.tar.gz with hidden files in a new directory, also get the drupal code with in web directory composer create - project drupal / recommended - project my_site_name_dir It means with in new directory we have docker files and drupal files also has web folder for drupal. now run docker-compose up -d Now PROJECT_BASE_URL is mentioned in .env file open this url in the web with port, it will open the drupal page, ...