Fix the warnings/errors reported by PHP_CodeSniffer

Kindly review patch.

The patch is applying cleanly and issues mentioned are getting resolved by it. Moving it to RTBC.

Let me check on it.

+2. Place the module directory in the "modules" folder of your Drupal 
+installation.

-7. The custom links will be associated with the corresponding user roles and used when rendering the menu.
+7. The custom links will be associated with the corresponding user roles
+and used when rendering the menu.

+- The "menu_link_by_role_form_alter" function alters the menu link content form
+and adds custom link fields for each role.

Since that text is part of a list, the second line must be indented.

+This module is licensed under the [GNU General Public License version 2
+or later](https://www.gnu.org/licenses/gpl-2.0.html).

A link markup cannot be split in two lines.

Addressed #6. Updated patch.

Patch seems to be applying cleanly, moving to RTBC.

-        // Fetch the stored custom link and set as the default value if it exists.
+        // Fetch the stored custom link and set as the default
+        // value if it exists.

Since that comment is changed, and set as needs to be corrected (and set it as).

 /**
- *
+ * Form submission handler for menu_link_by_role form.
  */

A definite article is missing before menu_link_by_role.

Hello arti_parmar,
Your patch #2 is working fine.

Addressed #11.

 /**
- *
+ * Implements hook_link_by_role_load_custom_link().
  */
-function menu_link_by_role_loadCustomLink($menu_link_plugin_id, $user_role) {

Looking at the module code, I gather that is not a hook implementation; otherwise, it would not be called directly.

-      // Assume loadCustomLink is a function that fetches the custom links based on the menu link and role.
-      $custom_link = menu_link_by_role_loadCustomLink($item['original_link']->getPluginId(), $user_role);
+      // Assume loadCustomLink is a function that fetches the custom links
+      // based on the menu link and role.
+      $custom_link = menu_link_by_role_load_custom_link($item['original_link']->getPluginId(), $user_role);

I would rather remove that comment, simply because it does not make sense. Assume loadCustomLink is a function is referring to a function this very module implements. There is no need to assume that function exists: The module knows it exists.

Changes suggested in #19 have been fixed in this patch.

 /**
- *
+ * Function fetches the custom links based on the menu link and role.
  */
-function menu_link_by_role_loadCustomLink($menu_link_plugin_id, $user_role) {
+function menu_link_by_role_load_custom_link($menu_link_plugin_id, $user_role) {

Without Function at the beginning, that description would be fine.
The parameter and the return value descriptions are missing.

For the rest, the patch would be good to go.

I am working on it.

Updated the MR with fixes commit and addressed #21. Please review

Hi @bharath-kondeti,

Applied the changes you committed on MR!4 and these are the reported errors. Please see below:

➜  menu_link_by_role git:(1.0.x) curl https://git.drupalcode.org/project/menu_link_by_role/-/merge_requests/1.diff | patch -p1
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  6574    0  6574    0     0  17814      0 --:--:-- --:--:-- --:--:-- 18261
patching file README.txt
patching file menu_link_by_role.module
➜  menu_link_by_role git:(1.0.x) ✗ ..
➜  contrib git:(master) ✗ phpcs --standard=Drupal,DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml,twig menu_link_by_role

FILE: /Users/PrometInterns/Demo-site/drupal-orgissue-v9/web/modules/contrib/menu_link_by_role/menu_link_by_role.module
----------------------------------------------------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------------------------------------------------------
 116 | ERROR | [x] Whitespace found at end of line
 121 | ERROR | [x] Whitespace found at end of line
 122 | ERROR | [x] Return type must not contain variable name "$result"
----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------

Time: 146ms; Memory: 10MB

Kindly check

Thanks,
Jake

There are still PHP_CodeSniffer errors to fix.

avpaderno → changed the visibility of the branch 3367850-gitlab-ci-reports to hidden.