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

Post a Comment

Popular posts from this blog

Drupal 8 : Link actions,Link menus,Link Tasks,Routings

Drupal 8 : Link actions,Link menus,Link Tasks,Routings Link actions Local actions have also been moved out of the hook_menu() system in Drupal 8 .Use actions to define local operations such as adding new items to an administrative list (menus, contact categories, etc). Local actions are defined in a YAML format, named after the module they are defined by. Such as menu_ui.links.action.yml for this example from menu_ui module: menu_ui.link_add:   route_name: menu_ui.link_add   title: 'Add link'   appears_on:     - menu_ui.menu_edit Here, menu_ui.link_add: It is the Unique name of the link action Most likely start with module name, route_name : Name of the route it means when click the link it redirect to this route, appears_on :  An array of route names for this action to be display on. Now how to know the Route name of any internal/external admin pages like below, By through the drupal console we achieve it, drupal debug:router...
Post a Comment
Read more

Mysql Interview Questions

Current mysql version : 8 ( last was 5.7 ,  5.7 to directly 8 ) SHOW FULL PROCESSLIST is used to see all the query executing when refresh the site. 1 second == 1000 mili second, 0-500 ms responce time of any query is ok How to Read the MySQL Slow Query Log :   The MySQL slow query log is where the MySQL database server registers all queries that exceed a given threshold of execution time. This can often be a good starting place to see which queries are slowest and how often they are slow. MySQL on your server is configured to log all queries taking longer than 0.1 seconds. /var/log/mysql/mysql-slow.log Use EXPLAIN or EXPLAIN EXTENDED to explain the query how it is executed. MySQL  describe  or  ANALYZE  command shows the structure of the table. Best practice in respect of performance : 1 - always use index, 2 - index types , primary index and combined field index like fname & lname in one index not two index, 3 - one index sc...
Post a Comment
Read more

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...
Post a Comment
Read more