Fix coding standard related errors

Created on 9 July 2016, over 8 years ago
Updated 13 June 2023, over 1 year ago

When running the module code against Drupal coding standards based on Drupal standard, the module shows errors

phpcs  --standard=Drupal

FILE: .../drupal7/sites/all/modules/views_navigation/views_navigation.inc
----------------------------------------------------------------------
FOUND 27 ERRORS AFFECTING 27 LINES
----------------------------------------------------------------------
   3 | ERROR | [x] You must use "/**" style comments for a file
     |       |     comment
  28 | ERROR | [ ] Doc comment short description must be on a single
     |       |     line, further text should be a separate paragraph
  70 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
  73 | ERROR | [x] Case breaking statements must be followed by a
     |       |     single blank line
  74 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 135 | ERROR | [ ] The second argument to watchdog() should not be
     |       |     enclosed with t()
 151 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 157 | ERROR | [x] Case breaking statements must be followed by a
     |       |     single blank line
 158 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 173 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 176 | ERROR | [x] Case breaking statements must be followed by a
     |       |     single blank line
 177 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 183 | ERROR | [x] There must be no space before the colon in a
     |       |     DEFAULT statement
 259 | ERROR | [ ] Doc comment short description must be on a single
     |       |     line, further text should be a separate paragraph
 263 | ERROR | [x] No space found before comment text; expected "//
     |       |     TODO handle the case when the etid is in the
     |       |     result more than one" but found "//TODO handle the
     |       |     case when the etid is in the result more than one"
 271 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 273 | ERROR | [x] Case breaking statements must be followed by a
     |       |     single blank line
 274 | ERROR | [x] There must be no space before the colon in a CASE
     |       |     statement
 286 | ERROR | [x] No space found before comment text; expected "//
     |       |     Take care of pagination. Index of first item on
     |       |     second page must be" but found "//Take care of
     |       |     pagination. Index of first item on second page
     |       |     must be"
 307 | ERROR | [ ] Doc comment short description must be on a single
     |       |     line, further text should be a separate paragraph
 317 | ERROR | [x] Missing function doc comment
 322 | ERROR | [x] Missing function doc comment
 354 | ERROR | [ ] Doc comment short description must be on a single
     |       |     line, further text should be a separate paragraph
 368 | ERROR | [x] Use "elseif" in place of "else if"
 399 | ERROR | [x] Missing function doc comment
 404 | ERROR | [x] Missing function doc comment
 405 | ERROR | [x] No space found before comment text; expected "//
     |       |     TODO Have it work with search API." but found
     |       |     "//TODO Have it work with search API."
----------------------------------------------------------------------
PHPCBF CAN FIX THE 22 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...ws_navigation/views/views_navigation_handler_field_node_path.inc
----------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 5 | ERROR | [x] Missing function doc comment
 5 | ERROR | [ ] Visibility must be declared on method "render"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...navigation/views/views_navigation_handler_entity_field_field.inc
----------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 8 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_entity_field_field::render_entity_link"
   |       |     is not in lowerCamel format
 8 | ERROR | [ ] Visibility must be declared on method
   |       |     "render_entity_link"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...igation/views/views_navigation_plugin_entity_row_entity_view.inc
----------------------------------------------------------------------
FOUND 7 ERRORS AND 1 WARNING AFFECTING 5 LINES
----------------------------------------------------------------------
  1 | ERROR   | [x] Missing file doc comment
  3 | ERROR   | [ ] Class name must begin with a capital letter
  3 | ERROR   | [ ] Class name must use UpperCamel naming without
    |         |     underscores
  3 | ERROR   | [x] Missing class doc comment
  5 | ERROR   | [x] Missing function doc comment
  7 | WARNING | [ ] Line exceeds 80 characters; contains 81
    |         |     characters
 23 | ERROR   | [ ] Private method name
    |         |     "views_navigation_plugin_entity_row_entity_view::_replace_href"
    |         |     is not in lowerCamel format
 23 | ERROR   | [x] Missing function doc comment
----------------------------------------------------------------------
PHPCBF CAN FIX THE 4 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...s/views_navigation/views/views_navigation_handler_field_node.inc
----------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 5 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_field_node::render_link"
   |       |     is not in lowerCamel format
 5 | ERROR | [x] Missing function doc comment
 5 | ERROR | [ ] Visibility must be declared on method "render_link"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: .../views_navigation/views/views_navigation_handler_field_field.inc
----------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 5 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_field_field::render_item"
   |       |     is not in lowerCamel format
 5 | ERROR | [x] Missing function doc comment
 5 | ERROR | [ ] Visibility must be declared on method "render_item"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...s_navigation/views/views_navigation_handler_entity_field_uri.inc
----------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 8 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_entity_field_uri::render_entity_link"
   |       |     is not in lowerCamel format
 8 | ERROR | [ ] Visibility must be declared on method
   |       |     "render_entity_link"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...ws_navigation/views/views_navigation_handler_field_node_link.inc
----------------------------------------------------------------------
FOUND 7 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 5 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_field_node_link::render_link"
   |       |     is not in lowerCamel format
 5 | ERROR | [x] Missing function doc comment
 5 | ERROR | [ ] Visibility must be declared on method "render_link"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ...ws/views_navigation_plugin_display_extender_views_navigation.inc
----------------------------------------------------------------------
FOUND 23 ERRORS AND 2 WARNINGS AFFECTING 15 LINES
----------------------------------------------------------------------
   1 | ERROR   | [x] Missing file doc comment
   3 | ERROR   | [ ] Class name must begin with a capital letter
   3 | ERROR   | [ ] Class name must use UpperCamel naming without
     |         |     underscores
   3 | ERROR   | [x] Missing class doc comment
   5 | ERROR   | [ ] Method name
     |         |     "views_navigation_plugin_display_extender_views_navigation::options_definition_alter"
     |         |     is not in lowerCamel format
   5 | ERROR   | [x] Missing function doc comment
   5 | ERROR   | [ ] Visibility must be declared on method
     |         |     "options_definition_alter"
  37 | ERROR   | [ ] Method name
     |         |     "views_navigation_plugin_display_extender_views_navigation::options_form"
     |         |     is not in lowerCamel format
  37 | ERROR   | [x] Missing function doc comment
  37 | ERROR   | [ ] Visibility must be declared on method
     |         |     "options_form"
  39 | ERROR   | [x] There must be no space before the colon in a
     |         |     CASE statement
  79 | ERROR   | [ ] Method name
     |         |     "views_navigation_plugin_display_extender_views_navigation::options_submit"
     |         |     is not in lowerCamel format
  79 | ERROR   | [x] Missing function doc comment
  79 | ERROR   | [ ] Visibility must be declared on method
     |         |     "options_submit"
  81 | ERROR   | [x] There must be no space before the colon in a
     |         |     CASE statement
  82 | ERROR   | [x] Expected 1 space before "?"; 0 found
  83 | ERROR   | [x] Expected 1 space before "?"; 0 found
  84 | ERROR   | [x] Expected 1 space before "?"; 0 found
  85 | ERROR   | [x] Expected 1 space before "?"; 0 found
  86 | ERROR   | [x] Expected 1 space before "?"; 0 found
  91 | ERROR   | [ ] Method name
     |         |     "views_navigation_plugin_display_extender_views_navigation::options_summary"
     |         |     is not in lowerCamel format
  91 | ERROR   | [x] Missing function doc comment
  91 | ERROR   | [ ] Visibility must be declared on method
     |         |     "options_summary"
 113 | WARNING | [ ] Translatable strings must not begin or end with
     |         |     white spaces, use placeholders with t() for
     |         |     variables
 121 | WARNING | [ ] Translatable strings must not begin or end with
     |         |     white spaces, use placeholders with t() for
     |         |     variables
----------------------------------------------------------------------
PHPCBF CAN FIX THE 13 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: ..._navigation/views/views_navigation_handler_entity_field_text.inc
----------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 3 LINES
----------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [ ] Class name must begin with a capital letter
 3 | ERROR | [ ] Class name must use UpperCamel naming without
   |       |     underscores
 3 | ERROR | [x] Missing class doc comment
 8 | ERROR | [ ] Method name
   |       |     "views_navigation_handler_entity_field_text::render_entity_link"
   |       |     is not in lowerCamel format
 8 | ERROR | [ ] Visibility must be declared on method
   |       |     "render_entity_link"
----------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------
📌 Task
Status

Fixed

Version

1.0

Component

Code

Created by

🇧🇷Brazil felribeiro

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024