src/CoreBundle/Service/CourseService.php
The method __construct has 11 parameters. Consider reducing the number of parameters to less than 10. Open
Open
public function __construct(
private readonly EntityManager $entityManager,
private readonly CourseRepository $courseRepository,
private readonly Security $security,
private readonly CourseCategoryRepository $courseCategoryRepository,- Exclude checks
The method registerCourse() has an NPath complexity of 257. The configured NPath complexity threshold is 200. Open
Open
public function registerCourse(array $rawParams): ?Course
{
try {
/** @var User $currentUser */
$currentUser = $this->security->getUser();- Read upRead up
- Exclude checks
NPathComplexity
Since: 0.1
The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.
Example
class Foo {
function bar() {
// lots of complicated code
}
}Source https://phpmd.org/rules/codesize.html#npathcomplexity
The class CourseService has a coupling between objects value of 35. Consider to reduce the number of dependencies under 13. Open
Open
class CourseService
{
public const MAX_COURSE_LENGTH_CODE = 40;
public function __construct(- Read upRead up
- Exclude checks
CouplingBetweenObjects
Since: 1.1.0
A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability
Example
class Foo {
/**
* @var \foo\bar\X
*/
private $x = null;
/**
* @var \foo\bar\Y
*/
private $y = null;
/**
* @var \foo\bar\Z
*/
private $z = null;
public function setFoo(\Foo $foo) {}
public function setBar(\Bar $bar) {}
public function setBaz(\Baz $baz) {}
/**
* @return \SplObjectStorage
* @throws \OutOfRangeException
* @throws \InvalidArgumentException
* @throws \ErrorException
*/
public function process(\Iterator $it) {}
// ...
}Source https://phpmd.org/rules/design.html#couplingbetweenobjects
The method defineCourseKeys uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
$keysAreUnique = true;
}- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}Source https://phpmd.org/rules/cleancode.html#elseexpression
The method insertExampleContent uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
$realPath = str_replace($defaultPath, '', $file->getRealPath());
$document = DocumentManager::addDocument(
$courseInfo,
$realPath,- Read upRead up
- Exclude checks
ElseExpression
Since: 1.4.0
An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.
Example
class Foo
{
public function bar($flag)
{
if ($flag) {
// one branch
} else {
// another branch
}
}
}Source https://phpmd.org/rules/cleancode.html#elseexpression
Avoid unused local variables such as '$currentUser'. Open
Open
$currentUser = $this->security->getUser();- Read upRead up
- Exclude checks
UnusedLocalVariable
Since: 0.2
Detects when a local variable is declared and/or assigned, but not used.
Example
class Foo {
public function doSomething()
{
$i = 5; // Unused
}
}Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable
Avoid unused parameters such as '$params'. Open
Open
public function fillCourse(Course $course, array $params): void- Read upRead up
- Exclude checks
UnusedFormalParameter
Since: 0.2
Avoid passing parameters to methods or constructors and then not using those parameters.
Example
class Foo
{
private function bar($howdy)
{
// $howdy is not used
}
}Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter
Missing function doc comment Open
Open
public function createCourse(array $params): ?Course- Exclude checks
Missing function doc comment Open
Open
public function registerCourse(array $rawParams): ?Course- Exclude checks
Variable "app_plugin" is not in valid camel caps format Open
Open
$app_plugin = new AppPlugin();- Exclude checks
Missing class doc comment Open
Open
class CourseService- Exclude checks
Missing function doc comment Open
Open
public function defineCourseKeys(- Exclude checks
Add a single space around assignment operators Open
Open
declare(strict_types=1);- Exclude checks
Variable "results_disabled" is not in valid camel caps format Open
Open
$exercise->results_disabled = 0;- Exclude checks
Variable "app_plugin" is not in valid camel caps format Open
Open
$app_plugin->install_course_plugins($courseId);- Exclude checks
Missing function doc comment Open
Open
public function __construct(- Exclude checks
Missing function doc comment Open
Open
public function sendEmailToAdmin(Course $course): void- Exclude checks
Missing function doc comment Open
Open
public function fillCourse(Course $course, array $params): void- Exclude checks
Declare public methods first,then protected ones and finally private ones Open
Open
public function useTemplateAsBasisIfRequired($courseCode, $courseTemplate): void- Exclude checks
Closing brace must be on a line by itself Open
Open
) {}- Exclude checks
Missing function doc comment Open
Open
public function useTemplateAsBasisIfRequired($courseCode, $courseTemplate): void- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly TranslatorInterface $translator,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly EntityManager $entityManager,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly UserRepository $userRepository,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly MailerInterface $mailer,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly EventLoggerService $eventLoggerService,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly CourseRepository $courseRepository,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly SettingsManager $settingsManager,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly Security $security,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly CourseCategoryRepository $courseCategoryRepository,- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly ParameterBagInterface $parameterBag,- Exclude checks
Closing brace must be on a line by itself Open
Open
) {}- Exclude checks
Line indented incorrectly; expected 4 spaces, found 8 Open
Open
private readonly RequestStack $requestStack- Exclude checks
The variable $app_plugin is not named in camelCase. Open
Open
private function installCoursePlugins(int $courseId): void
{
$app_plugin = new AppPlugin();
$app_plugin->install_course_plugins($courseId);
}- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}Source
The variable $app_plugin is not named in camelCase. Open
Open
private function installCoursePlugins(int $courseId): void
{
$app_plugin = new AppPlugin();
$app_plugin->install_course_plugins($courseId);
}- Read upRead up
- Exclude checks
CamelCaseVariableName
Since: 0.2
It is considered best practice to use the camelCase notation to name variables.
Example
class ClassName {
public function doSomething() {
$data_module = new DataModule();
}
}