src/CoreBundle/Controller/TemplateController.php
The class TemplateController has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13. Open
Open
class TemplateController extends AbstractController
{
#[Route('/document-templates/create', methods: ['POST'])]
public function createDocumentTemplate(Request $request, EntityManagerInterface $entityManager, UserHelper $userHelper): Response
{- 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 createDocumentTemplate uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
return $this->json(['error' => 'Document not found.'], Response::HTTP_NOT_FOUND);
}- 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 deleteDocumentTemplate uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them. Open
Open
} else {
return $this->json(['error' => 'Document not found.'], Response::HTTP_NOT_FOUND);
}- 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
You must use "/**" style comments for a function comment Open
Open
public function isDocumentTemplate(int $documentId, EntityManagerInterface $entityManager): Response- Exclude checks
You must use "/**" style comments for a function comment Open
Open
public function deleteDocumentTemplate(int $documentId, EntityManagerInterface $entityManager): Response- Exclude checks
Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Open
Open
#[Route('/all-templates/{courseId}', name: 'all-templates')]- Exclude checks
Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Open
Open
#[Route('/document-templates/create', methods: ['POST'])]- Exclude checks
Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Open
Open
#[Route('/document-templates/{documentId}/is-template', methods: ['GET'])]- Exclude checks
Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Open
Open
#[Route('/document-templates/{documentId}/delete', methods: ['POST'])]- Exclude checks
You must use "/**" style comments for a class comment Open
Open
class TemplateController extends AbstractController- Exclude checks
Perl-style comments are not allowed. Use "// Comment." or "/* comment */" instead. Open
Open
#[Route('/template')]- Exclude checks
Add a single space around assignment operators Open
Open
declare(strict_types=1);- Exclude checks
You must use "/**" style comments for a function comment Open
Open
public function createDocumentTemplate(Request $request, EntityManagerInterface $entityManager, UserHelper $userHelper): Response- Exclude checks
You must use "/**" style comments for a function comment Open
Open
public function getAllTemplates($courseId, SystemTemplateRepository $systemTemplateRepository, TemplatesRepository $templatesRepository, CourseRepository $courseRepository, AssetRepository $assetRepository, CDocumentRepository $documentRepository): JsonResponse- Exclude checks