Files failing PHPCS

[ukmadlz]

PHP Code Sniffer is the standard linter of choice for PHP development. We ignore it in a lot of files (we shouldn't) and in the files we don't ignore we fail it.

$ ddev composer lint
> ./vendor/bin/phpcs ./Infobip

FILE: /var/www/html/Infobip/ApiException.php
-----------------------------------------------------------------------------------------------------
FOUND 4 ERRORS AND 6 WARNINGS AFFECTING 10 LINES
-----------------------------------------------------------------------------------------------------
  8 | ERROR   | Content of the @author tag must be in the form "Display Name <[email protected]>"
 10 | ERROR   | Missing @license tag in file comment
 15 | WARNING | Line exceeds 85 characters; contains 87 characters
 19 | WARNING | Line exceeds 85 characters; contains 215 characters
 21 | WARNING | Line exceeds 85 characters; contains 120 characters
 33 | ERROR   | Content of the @author tag must be in the form "Display Name <[email protected]>"
 35 | ERROR   | Missing @license tag in class comment
 65 | WARNING | Line exceeds 85 characters; contains 123 characters
 67 | WARNING | Line exceeds 85 characters; contains 102 characters
 87 | WARNING | Line exceeds 85 characters; contains 99 characters
-----------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/Configuration.php
-----------------------------------------------------------------------------------------------------
FOUND 9 ERRORS AND 3 WARNINGS AFFECTING 12 LINES
-----------------------------------------------------------------------------------------------------
  8 | ERROR   | Content of the @author tag must be in the form "Display Name <[email protected]>"
 10 | ERROR   | Missing @license tag in file comment
 15 | WARNING | Line exceeds 85 characters; contains 87 characters
 19 | WARNING | Line exceeds 85 characters; contains 215 characters
 21 | WARNING | Line exceeds 85 characters; contains 120 characters
 26 | ERROR   | Missing doc comment for class Configuration
 31 | ERROR   | Missing doc comment for function __construct()
 41 | ERROR   | Missing doc comment for function getHost()
 46 | ERROR   | Missing doc comment for function getApiKeyHeader()
 51 | ERROR   | Missing doc comment for function getApiKey()
 56 | ERROR   | Missing doc comment for function getUserAgent()
 61 | ERROR   | Missing doc comment for function getTempFolderPath()
-----------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/DeprecationChecker.php
--------------------------------------------------------------------------------------------------------------
FOUND 12 ERRORS AND 10 WARNINGS AFFECTING 16 LINES
--------------------------------------------------------------------------------------------------------------
  12 | ERROR   | Content of the @author tag must be in the form "Display Name <[email protected]>"
  14 | ERROR   | Missing @license tag in file comment
  19 | WARNING | Line exceeds 85 characters; contains 87 characters
  23 | WARNING | Line exceeds 85 characters; contains 215 characters
  25 | WARNING | Line exceeds 85 characters; contains 120 characters
  35 | ERROR   | Missing doc comment for class DeprecationChecker
  44 | ERROR   | Missing doc comment for function __construct()
  48 | ERROR   | Missing short description in doc comment
  48 | ERROR   | Doc comment for parameter "$request" missing
  48 | ERROR   | Doc comment for parameter "$response" missing
  50 | ERROR   | Missing @return tag in function comment
  51 | WARNING | Line exceeds 85 characters; contains 87 characters
  63 | WARNING | Line exceeds 85 characters; contains 91 characters
  83 | ERROR   | Missing doc comment for function logGone()
  83 | ERROR   | Private method name "DeprecationChecker::logGone" must be prefixed with an underscore
  83 | WARNING | Line exceeds 85 characters; contains 86 characters
  90 | WARNING | Line exceeds 85 characters; contains 91 characters
  99 | ERROR   | Missing doc comment for function logDeprecation()
  99 | ERROR   | Private method name "DeprecationChecker::logDeprecation" must be prefixed with an underscore
  99 | WARNING | Line exceeds 85 characters; contains 101 characters
 104 | WARNING | Line exceeds 85 characters; contains 87 characters
 112 | WARNING | Line exceeds 85 characters; contains 95 characters
--------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/EnumNormalizer.php
---------------------------------------------------------------------------------------------------------
FOUND 25 ERRORS AND 8 WARNINGS AFFECTING 20 LINES
---------------------------------------------------------------------------------------------------------
 10 | ERROR   | [ ] Content of the @author tag must be in the form "Display Name <[email protected]>"
 12 | WARNING | [ ] PHP version not specified
 12 | ERROR   | [ ] Missing @license tag in file comment
 17 | WARNING | [ ] Line exceeds 85 characters; contains 87 characters
 21 | WARNING | [ ] Line exceeds 85 characters; contains 215 characters
 23 | WARNING | [ ] Line exceeds 85 characters; contains 120 characters
 35 | ERROR   | [ ] Missing doc comment for class EnumNormalizer
 37 | ERROR   | [ ] Missing short description in doc comment
 37 | ERROR   | [ ] Doc comment for parameter "$object" missing
 37 | ERROR   | [ ] Doc comment for parameter "$format" missing
 37 | ERROR   | [ ] Doc comment for parameter "$context" missing
 39 | ERROR   | [x] Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1
 40 | ERROR   | [ ] Missing @return tag in function comment
 41 | WARNING | [ ] Line exceeds 85 characters; contains 96 characters
 44 | WARNING | [ ] Line exceeds 85 characters; contains 90 characters
 50 | ERROR   | [ ] Missing short description in doc comment
 50 | ERROR   | [ ] Doc comment for parameter "$data" missing
 50 | ERROR   | [ ] Doc comment for parameter "$format" missing
 52 | ERROR   | [ ] Missing @return tag in function comment
 58 | ERROR   | [ ] Missing short description in doc comment
 58 | ERROR   | [ ] Doc comment for parameter "$data" missing
 58 | ERROR   | [ ] Doc comment for parameter "$type" missing
 58 | ERROR   | [ ] Doc comment for parameter "$format" missing
 58 | ERROR   | [ ] Doc comment for parameter "$context" missing
 60 | ERROR   | [x] Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1
 61 | ERROR   | [ ] Missing @return tag in function comment
 62 | WARNING | [ ] Line exceeds 85 characters; contains 117 characters
 77 | ERROR   | [ ] Missing short description in doc comment
 77 | ERROR   | [ ] Doc comment for parameter "$data" missing
 77 | ERROR   | [ ] Doc comment for parameter "$type" missing
 77 | ERROR   | [ ] Doc comment for parameter "$format" missing
 79 | ERROR   | [ ] Missing @return tag in function comment
 80 | WARNING | [ ] Line exceeds 85 characters; contains 99 characters
---------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/Model/EnumInterface.php
---------------------------------------------------------------------------------------------------------
FOUND 8 ERRORS AND 4 WARNINGS AFFECTING 9 LINES
---------------------------------------------------------------------------------------------------------
  3 | ERROR   | [ ] Missing short description in doc comment
  4 | ERROR   | [x] Tag value for @package tag indented incorrectly; expected 1 spaces but found 2
  5 | ERROR   | [ ] Content of the @author tag must be in the form "Display Name <[email protected]>"
  5 | ERROR   | [x] Tag value for @author tag indented incorrectly; expected 2 spaces but found 3
  6 | ERROR   | [x] Tag value for @link tag indented incorrectly; expected 4 spaces but found 5
  7 | WARNING | [ ] PHP version not specified
  7 | ERROR   | [ ] Missing @category tag in file comment
  7 | ERROR   | [ ] Missing @license tag in file comment
 14 | WARNING | [ ] Line exceeds 85 characters; contains 87 characters
 18 | WARNING | [ ] Line exceeds 85 characters; contains 215 characters
 20 | WARNING | [ ] Line exceeds 85 characters; contains 120 characters
 27 | ERROR   | [ ] Missing doc comment for interface EnumInterface
---------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/Model/ModelInterface.php
---------------------------------------------------------------------------------------------------------
FOUND 10 ERRORS AND 4 WARNINGS AFFECTING 11 LINES
---------------------------------------------------------------------------------------------------------
  5 | ERROR   | [ ] Missing short description in doc comment
  6 | ERROR   | [x] Tag value for @package tag indented incorrectly; expected 1 spaces but found 2
  7 | ERROR   | [ ] Content of the @author tag must be in the form "Display Name <[email protected]>"
  7 | ERROR   | [x] Tag value for @author tag indented incorrectly; expected 2 spaces but found 3
  8 | ERROR   | [x] Tag value for @link tag indented incorrectly; expected 4 spaces but found 5
  9 | WARNING | [ ] PHP version not specified
  9 | ERROR   | [ ] Missing @category tag in file comment
  9 | ERROR   | [ ] Missing @license tag in file comment
 14 | WARNING | [ ] Line exceeds 85 characters; contains 87 characters
 18 | WARNING | [ ] Line exceeds 85 characters; contains 215 characters
 20 | WARNING | [ ] Line exceeds 85 characters; contains 120 characters
 25 | ERROR   | [ ] Missing doc comment for interface ModelInterface
 29 | ERROR   | [ ] Missing doc comment for function getModelName()
 31 | ERROR   | [ ] Missing doc comment for function getDiscriminator()
---------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
---------------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/ObjectSerializer.php
----------------------------------------------------------------------------------------------------------------------
FOUND 52 ERRORS AND 11 WARNINGS AFFECTING 41 LINES
----------------------------------------------------------------------------------------------------------------------
   9 | ERROR   | [ ] Content of the @author tag must be in the form "Display Name <[email protected]>"
  11 | ERROR   | [ ] Missing @license tag in file comment
  16 | WARNING | [ ] Line exceeds 85 characters; contains 87 characters
  20 | WARNING | [ ] Line exceeds 85 characters; contains 215 characters
  22 | WARNING | [ ] Line exceeds 85 characters; contains 120 characters
  49 | ERROR   | [ ] Missing doc comment for class ObjectSerializer
  53 | ERROR   | [ ] Private member variable "serializer" must be prefixed with an underscore
  54 | ERROR   | [ ] Private member variable "validator" must be prefixed with an underscore
  56 | ERROR   | [ ] Missing doc comment for function __construct()
  59 | WARNING | [ ] Line exceeds 85 characters; contains 107 characters
  60 | WARNING | [ ] Line exceeds 85 characters; contains 107 characters
  68 | WARNING | [ ] Line exceeds 85 characters; contains 90 characters
  92 | ERROR   | [ ] Missing doc comment for function serialize()
  92 | WARNING | [ ] Line exceeds 85 characters; contains 88 characters
 101 | ERROR   | [ ] Missing doc comment for function deserialize()
 121 | ERROR   | [ ] Missing short description in doc comment
 121 | ERROR   | [ ] Doc comment for parameter "$data" missing
 121 | ERROR   | [ ] Doc comment for parameter "$context" missing
 123 | ERROR   | [ ] Missing @return tag in function comment
 129 | ERROR   | [ ] Missing short description in doc comment
 129 | ERROR   | [ ] Doc comment for parameter "$data" missing
 129 | ERROR   | [ ] Doc comment for parameter "$type" missing
 129 | ERROR   | [ ] Doc comment for parameter "$context" missing
 131 | ERROR   | [ ] Missing @return tag in function comment
 132 | WARNING | [ ] Line exceeds 85 characters; contains 86 characters
 141 | ERROR   | [ ] Missing short description in doc comment
 141 | ERROR   | [ ] Doc comment for parameter "$value" missing
 145 | ERROR   | [ ] Missing @return tag in function comment
 151 | ERROR   | [ ] Missing short description in doc comment
 151 | ERROR   | [ ] Doc comment for parameter "$object" missing
 157 | ERROR   | [ ] Missing @return tag in function comment
 167 | ERROR   | [ ] Missing short description in doc comment
 167 | ERROR   | [ ] Doc comment for parameter "$value" missing
 172 | ERROR   | [ ] Missing @return tag in function comment
 184 | ERROR   | [ ] Missing short description in doc comment
 184 | ERROR   | [ ] Doc comment for parameter "$value" missing
 186 | ERROR   | [ ] Missing @return tag in function comment
 196 | ERROR   | [ ] Missing short description in doc comment
 196 | ERROR   | [ ] Doc comment for parameter "$value" missing
 198 | ERROR   | [ ] Missing @return tag in function comment
 210 | ERROR   | [ ] Missing short description in doc comment
 210 | ERROR   | [ ] Doc comment for parameter "$collection" missing
 211 | ERROR   | [ ] Tag @internal cannot be grouped with parameter tags in a doc comment
 213 | ERROR   | [ ] Doc comment for parameter $style does not match actual variable name $collection
 213 | ERROR   | [x] Expected 22 spaces after parameter name; 1 found
 213 | ERROR   | [x] Tag value for @param tag indented incorrectly; expected 4 spaces but found 1
 213 | WARNING | [ ] Line exceeds 85 characters; contains 97 characters
 214 | ERROR   | [x] Expected 8 spaces after parameter type; 1 found
 214 | ERROR   | [ ] Doc comment for parameter $allowCollectionFormatMulti does not match actual variable name $style
 214 | ERROR   | [x] Tag value for @param tag indented incorrectly; expected 4 spaces but found 1
 214 | WARNING | [ ] Line exceeds 85 characters; contains 103 characters
 215 | ERROR   | [ ] Missing @return tag in function comment
 222 | WARNING | [ ] Line exceeds 85 characters; contains 97 characters
 233 | ERROR   | [ ] Missing short description in doc comment
 233 | ERROR   | [ ] Doc comment for parameter "$data" missing
 234 | ERROR   | [ ] Tag @internal cannot be grouped with parameter tags in a doc comment
 235 | ERROR   | [ ] Missing parameter comment
 235 | ERROR   | [ ] Doc comment for parameter $constraints does not match actual variable name $data
 235 | ERROR   | [x] Tag value for @param tag indented incorrectly; expected 4 spaces but found 1
 236 | ERROR   | [ ] Tag @throws cannot be grouped with parameter tags in a doc comment
 236 | ERROR   | [x] Tag value for @throws tag indented incorrectly; expected 3 spaces but found 1
 237 | ERROR   | [ ] Missing @return tag in function comment
 245 | ERROR   | [ ] Missing short description in doc comment
----------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------------------------------------------------------


FILE: /var/www/html/Infobip/SplFileObjectNormalizer.php
-------------------------------------------------------------------------------------------------------------------------
FOUND 33 ERRORS AND 11 WARNINGS AFFECTING 29 LINES
-------------------------------------------------------------------------------------------------------------------------
   8 | ERROR   | [ ] Content of the @author tag must be in the form "Display Name <[email protected]>"
  10 | WARNING | [ ] PHP version not specified
  10 | ERROR   | [ ] Missing @license tag in file comment
  17 | WARNING | [ ] Line exceeds 85 characters; contains 87 characters
  21 | WARNING | [ ] Line exceeds 85 characters; contains 215 characters
  23 | WARNING | [ ] Line exceeds 85 characters; contains 120 characters
  36 | ERROR   | [ ] Missing doc comment for class SplFileObjectNormalizer
  43 | ERROR   | [ ] Private member variable "defaultContext" must be prefixed with an underscore
  52 | ERROR   | [ ] Missing doc comment for function __construct()
  57 | ERROR   | [ ] Missing doc comment for function setDefaultContext()
  62 | ERROR   | [ ] Missing short description in doc comment
  62 | ERROR   | [ ] Doc comment for parameter "$object" missing
  62 | ERROR   | [ ] Doc comment for parameter "$format" missing
  62 | ERROR   | [ ] Doc comment for parameter "$context" missing
  64 | ERROR   | [x] Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1
  65 | ERROR   | [ ] Missing @return tag in function comment
  66 | WARNING | [ ] Line exceeds 85 characters; contains 96 characters
  69 | WARNING | [ ] Line exceeds 85 characters; contains 98 characters
  75 | ERROR   | [ ] Missing short description in doc comment
  75 | ERROR   | [ ] Doc comment for parameter "$data" missing
  75 | ERROR   | [ ] Doc comment for parameter "$format" missing
  77 | ERROR   | [ ] Missing @return tag in function comment
  83 | ERROR   | [ ] Missing short description in doc comment
  83 | ERROR   | [ ] Doc comment for parameter "$type" missing
  83 | ERROR   | [ ] Doc comment for parameter "$format" missing
  83 | ERROR   | [ ] Doc comment for parameter "$context" missing
  84 | ERROR   | [ ] Tag @inheritdoc cannot be grouped with parameter tags in a doc comment
  85 | ERROR   | [ ] Missing parameter comment
  85 | ERROR   | [x] Tag value for @param tag indented incorrectly; expected 6 spaces but found 1
  86 | ERROR   | [ ] Tag @throws cannot be grouped with parameter tags in a doc comment
  86 | ERROR   | [x] Tag value for @throws tag indented incorrectly; expected 5 spaces but found 1
  87 | ERROR   | [ ] Missing @return tag in function comment
  88 | WARNING | [ ] Line exceeds 85 characters; contains 117 characters
 100 | WARNING | [ ] Line exceeds 85 characters; contains 101 characters
 107 | WARNING | [ ] Line exceeds 85 characters; contains 99 characters
 125 | ERROR   | [ ] Missing short description in doc comment
 125 | ERROR   | [ ] Doc comment for parameter "$data" missing
 125 | ERROR   | [ ] Doc comment for parameter "$type" missing
 125 | ERROR   | [ ] Doc comment for parameter "$format" missing
 127 | ERROR   | [ ] Missing @return tag in function comment
 128 | WARNING | [ ] Line exceeds 85 characters; contains 99 characters
 130 | WARNING | [ ] Line exceeds 85 characters; contains 91 characters
 133 | ERROR   | [ ] Missing doc comment for function sanitizeFilename()
 133 | ERROR   | [ ] Private method name "SplFileObjectNormalizer::sanitizeFilename" must be prefixed with an underscore
-------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------------------------------------------

[dnumicmesa]

Hi! It appears to us that default linter in PHPCS is not configured to latest PHP coding standards (PSR12). We are also planning new release soon with which only few warnings/errors would remain detected with PSR12 standard.