diff --git a/src/Controller/AdminPages/AttachmentTypeController.php b/src/Controller/AdminPages/AttachmentTypeController.php index 949bd89a..7af39cb9 100644 --- a/src/Controller/AdminPages/AttachmentTypeController.php +++ b/src/Controller/AdminPages/AttachmentTypeController.php @@ -50,9 +50,12 @@ class AttachmentTypeController extends BaseAdminController /** * @Route("/{id}", name="attachment_type_delete", methods={"DELETE"}) * + * @param Request $request + * @param AttachmentType $entity + * @param StructuralElementRecursionHelper $recursionHelper * @return RedirectResponse */ - public function delete(Request $request, AttachmentType $entity, StructuralElementRecursionHelper $recursionHelper) + public function delete(Request $request, AttachmentType $entity, StructuralElementRecursionHelper $recursionHelper): RedirectResponse { return $this->_delete($request, $entity, $recursionHelper); } @@ -61,9 +64,12 @@ class AttachmentTypeController extends BaseAdminController * @Route("/{id}/edit", requirements={"id"="\d+"}, name="attachment_type_edit") * @Route("/{id}", requirements={"id"="\d+"}) * + * @param AttachmentType $entity + * @param Request $request + * @param EntityManagerInterface $em * @return Response */ - public function edit(AttachmentType $entity, Request $request, EntityManagerInterface $em) + public function edit(AttachmentType $entity, Request $request, EntityManagerInterface $em): Response { return $this->_edit($entity, $request, $em); } @@ -72,9 +78,12 @@ class AttachmentTypeController extends BaseAdminController * @Route("/new", name="attachment_type_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -82,9 +91,12 @@ class AttachmentTypeController extends BaseAdminController /** * @Route("/export", name="attachment_type_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -92,9 +104,12 @@ class AttachmentTypeController extends BaseAdminController /** * @Route("/{id}/export", name="attachment_type_export") * + * @param AttachmentType $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request) + public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/BaseAdminController.php b/src/Controller/AdminPages/BaseAdminController.php index f3d7e475..657c398a 100644 --- a/src/Controller/AdminPages/BaseAdminController.php +++ b/src/Controller/AdminPages/BaseAdminController.php @@ -40,7 +40,9 @@ use InvalidArgumentException; use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; use Symfony\Component\Form\FormInterface; use Symfony\Component\HttpFoundation\File\UploadedFile; +use Symfony\Component\HttpFoundation\RedirectResponse; use Symfony\Component\HttpFoundation\Request; +use Symfony\Component\HttpFoundation\Response; use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface; use Symfony\Component\Validator\ConstraintViolationList; use Symfony\Contracts\Translation\TranslatorInterface; @@ -75,7 +77,8 @@ abstract class BaseAdminController extends AbstractController $this->attachmentSubmitHandler = $attachmentSubmitHandler; } - protected function _edit(AbstractNamedDBElement $entity, Request $request, EntityManagerInterface $em) + + protected function _edit(AbstractNamedDBElement $entity, Request $request, EntityManagerInterface $em) : Response { $this->denyAccessUnlessGranted('read', $entity); @@ -234,7 +237,7 @@ abstract class BaseAdminController extends AbstractController ]); } - protected function _delete(Request $request, AbstractNamedDBElement $entity, StructuralElementRecursionHelper $recursionHelper) + protected function _delete(Request $request, AbstractNamedDBElement $entity, StructuralElementRecursionHelper $recursionHelper) : RedirectResponse { $this->denyAccessUnlessGranted('delete', $entity); @@ -270,7 +273,7 @@ abstract class BaseAdminController extends AbstractController return $this->redirectToRoute($this->route_base.'_new'); } - protected function _exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + protected function _exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { $entity = new $this->entity_class(); @@ -281,7 +284,7 @@ abstract class BaseAdminController extends AbstractController return $exporter->exportEntityFromRequest($entities, $request); } - protected function _exportEntity(AbstractNamedDBElement $entity, EntityExporter $exporter, Request $request) + protected function _exportEntity(AbstractNamedDBElement $entity, EntityExporter $exporter, Request $request): \Symfony\Component\HttpFoundation\Response { $this->denyAccessUnlessGranted('read', $entity); diff --git a/src/Controller/AdminPages/CategoryController.php b/src/Controller/AdminPages/CategoryController.php index 4582a6eb..437fe599 100644 --- a/src/Controller/AdminPages/CategoryController.php +++ b/src/Controller/AdminPages/CategoryController.php @@ -50,9 +50,12 @@ class CategoryController extends BaseAdminController /** * @Route("/{id}", name="category_delete", methods={"DELETE"}) * + * @param Request $request + * @param Category $entity + * @param StructuralElementRecursionHelper $recursionHelper * @return RedirectResponse */ - public function delete(Request $request, Category $entity, StructuralElementRecursionHelper $recursionHelper) + public function delete(Request $request, Category $entity, StructuralElementRecursionHelper $recursionHelper): RedirectResponse { return $this->_delete($request, $entity, $recursionHelper); } @@ -61,9 +64,12 @@ class CategoryController extends BaseAdminController * @Route("/{id}/edit", requirements={"id"="\d+"}, name="category_edit") * @Route("/{id}", requirements={"id"="\d+"}) * + * @param Category $entity + * @param Request $request + * @param EntityManagerInterface $em * @return Response */ - public function edit(Category $entity, Request $request, EntityManagerInterface $em) + public function edit(Category $entity, Request $request, EntityManagerInterface $em): Response { return $this->_edit($entity, $request, $em); } @@ -72,9 +78,12 @@ class CategoryController extends BaseAdminController * @Route("/new", name="category_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -82,9 +91,12 @@ class CategoryController extends BaseAdminController /** * @Route("/export", name="category_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -92,9 +104,12 @@ class CategoryController extends BaseAdminController /** * @Route("/{id}/export", name="category_export") * + * @param Category $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Category $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Category $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/CurrencyController.php b/src/Controller/AdminPages/CurrencyController.php index 42d61cf8..2c04cdad 100644 --- a/src/Controller/AdminPages/CurrencyController.php +++ b/src/Controller/AdminPages/CurrencyController.php @@ -52,9 +52,12 @@ class CurrencyController extends BaseAdminController /** * @Route("/{id}", name="currency_delete", methods={"DELETE"}) * + * @param Request $request + * @param Currency $entity + * @param StructuralElementRecursionHelper $recursionHelper * @return RedirectResponse */ - public function delete(Request $request, Currency $entity, StructuralElementRecursionHelper $recursionHelper) + public function delete(Request $request, Currency $entity, StructuralElementRecursionHelper $recursionHelper): RedirectResponse { return $this->_delete($request, $entity, $recursionHelper); } @@ -63,9 +66,12 @@ class CurrencyController extends BaseAdminController * @Route("/{id}/edit", requirements={"id"="\d+"}, name="currency_edit") * @Route("/{id}", requirements={"id"="\d+"}) * + * @param Currency $entity + * @param Request $request + * @param EntityManagerInterface $em * @return Response */ - public function edit(Currency $entity, Request $request, EntityManagerInterface $em) + public function edit(Currency $entity, Request $request, EntityManagerInterface $em): Response { return $this->_edit($entity, $request, $em); } @@ -74,9 +80,12 @@ class CurrencyController extends BaseAdminController * @Route("/new", name="currency_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -84,9 +93,12 @@ class CurrencyController extends BaseAdminController /** * @Route("/export", name="currency_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -94,9 +106,12 @@ class CurrencyController extends BaseAdminController /** * @Route("/{id}/export", name="currency_export") * + * @param Currency $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Currency $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Currency $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/DeviceController.php b/src/Controller/AdminPages/DeviceController.php index 5afcad08..7cc69c61 100644 --- a/src/Controller/AdminPages/DeviceController.php +++ b/src/Controller/AdminPages/DeviceController.php @@ -50,9 +50,12 @@ class DeviceController extends BaseAdminController /** * @Route("/{id}", name="device_delete", methods={"DELETE"}) * + * @param Request $request + * @param Device $entity + * @param StructuralElementRecursionHelper $recursionHelper * @return RedirectResponse */ - public function delete(Request $request, Device $entity, StructuralElementRecursionHelper $recursionHelper) + public function delete(Request $request, Device $entity, StructuralElementRecursionHelper $recursionHelper): RedirectResponse { return $this->_delete($request, $entity, $recursionHelper); } @@ -61,9 +64,12 @@ class DeviceController extends BaseAdminController * @Route("/{id}/edit", requirements={"id"="\d+"}, name="device_edit") * @Route("/{id}", requirements={"id"="\d+"}) * + * @param Device $entity + * @param Request $request + * @param EntityManagerInterface $em * @return Response */ - public function edit(Device $entity, Request $request, EntityManagerInterface $em) + public function edit(Device $entity, Request $request, EntityManagerInterface $em): Response { return $this->_edit($entity, $request, $em); } @@ -72,9 +78,12 @@ class DeviceController extends BaseAdminController * @Route("/new", name="device_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -82,9 +91,12 @@ class DeviceController extends BaseAdminController /** * @Route("/export", name="device_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -92,9 +104,12 @@ class DeviceController extends BaseAdminController /** * @Route("/{id}/export", name="device_export") * + * @param Device $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Device $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Device $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/FootprintController.php b/src/Controller/AdminPages/FootprintController.php index 9d3b91e0..9d2e5f89 100644 --- a/src/Controller/AdminPages/FootprintController.php +++ b/src/Controller/AdminPages/FootprintController.php @@ -49,6 +49,10 @@ class FootprintController extends BaseAdminController /** * @Route("/{id}", name="footprint_delete", methods={"DELETE"}) + * @param Request $request + * @param Footprint $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, Footprint $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -58,6 +62,10 @@ class FootprintController extends BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="footprint_edit") * @Route("/{id}", requirements={"id"="\d+"}) + * @param Footprint $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response */ public function edit(Footprint $entity, Request $request, EntityManagerInterface $em) { @@ -68,9 +76,12 @@ class FootprintController extends BaseAdminController * @Route("/new", name="footprint_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -78,9 +89,12 @@ class FootprintController extends BaseAdminController /** * @Route("/export", name="footprint_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -88,9 +102,12 @@ class FootprintController extends BaseAdminController /** * @Route("/{id}/export", name="footprint_export") * + * @param AttachmentType $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request) + public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/ManufacturerController.php b/src/Controller/AdminPages/ManufacturerController.php index 71a0fa5d..893e07e8 100644 --- a/src/Controller/AdminPages/ManufacturerController.php +++ b/src/Controller/AdminPages/ManufacturerController.php @@ -26,7 +26,6 @@ namespace App\Controller\AdminPages; use App\Entity\Attachments\ManufacturerAttachment; use App\Entity\Parts\Manufacturer; -use App\Entity\Parts\Supplier; use App\Form\AdminPages\CompanyForm; use App\Services\EntityExporter; use App\Services\EntityImporter; @@ -49,6 +48,10 @@ class ManufacturerController extends BaseAdminController /** * @Route("/{id}", name="manufacturer_delete", methods={"DELETE"}) + * @param Request $request + * @param Manufacturer $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, Manufacturer $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -58,6 +61,10 @@ class ManufacturerController extends BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="manufacturer_edit") * @Route("/{id}", requirements={"id"="\d+"}) + * @param Manufacturer $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response */ public function edit(Manufacturer $entity, Request $request, EntityManagerInterface $em) { @@ -68,9 +75,12 @@ class ManufacturerController extends BaseAdminController * @Route("/new", name="manufacturer_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -78,9 +88,12 @@ class ManufacturerController extends BaseAdminController /** * @Route("/export", name="manufacturer_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -88,11 +101,13 @@ class ManufacturerController extends BaseAdminController /** * @Route("/{id}/export", name="manufacturer_export") * - * @param Manufacturer $entity + * @param Manufacturer $entity * + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Manufacturer $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Manufacturer $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/MeasurementUnitController.php b/src/Controller/AdminPages/MeasurementUnitController.php index f536f596..93f1b2d0 100644 --- a/src/Controller/AdminPages/MeasurementUnitController.php +++ b/src/Controller/AdminPages/MeasurementUnitController.php @@ -49,6 +49,10 @@ class MeasurementUnitController extends BaseAdminController /** * @Route("/{id}", name="measurement_unit_delete", methods={"DELETE"}) + * @param Request $request + * @param MeasurementUnit $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, MeasurementUnit $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -58,6 +62,10 @@ class MeasurementUnitController extends BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="measurement_unit_edit") * @Route("/{id}", requirements={"id"="\d+"}) + * @param MeasurementUnit $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response */ public function edit(MeasurementUnit $entity, Request $request, EntityManagerInterface $em) { @@ -68,9 +76,12 @@ class MeasurementUnitController extends BaseAdminController * @Route("/new", name="measurement_unit_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -78,9 +89,12 @@ class MeasurementUnitController extends BaseAdminController /** * @Route("/export", name="measurement_unit_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -88,9 +102,12 @@ class MeasurementUnitController extends BaseAdminController /** * @Route("/{id}/export", name="measurement_unit_export") * + * @param AttachmentType $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request) + public function exportEntity(AttachmentType $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/StorelocationController.php b/src/Controller/AdminPages/StorelocationController.php index 69d7de29..3a768f46 100644 --- a/src/Controller/AdminPages/StorelocationController.php +++ b/src/Controller/AdminPages/StorelocationController.php @@ -24,7 +24,6 @@ declare(strict_types=1); namespace App\Controller\AdminPages; -use App\Entity\Attachments\AttachmentType; use App\Entity\Parts\Storelocation; use App\Form\AdminPages\StorelocationAdminForm; use App\Services\EntityExporter; @@ -48,6 +47,10 @@ class StorelocationController extends BaseAdminController /** * @Route("/{id}", name="store_location_delete", methods={"DELETE"}) + * @param Request $request + * @param Storelocation $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, Storelocation $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -57,6 +60,10 @@ class StorelocationController extends BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="store_location_edit") * @Route("/{id}", requirements={"id"="\d+"}) + * @param Storelocation $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response */ public function edit(Storelocation $entity, Request $request, EntityManagerInterface $em) { @@ -67,9 +74,12 @@ class StorelocationController extends BaseAdminController * @Route("/new", name="store_location_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -77,9 +87,12 @@ class StorelocationController extends BaseAdminController /** * @Route("/export", name="store_location_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -87,11 +100,13 @@ class StorelocationController extends BaseAdminController /** * @Route("/{id}/export", name="store_location_export") * - * @param Storelocation $entity + * @param Storelocation $entity * + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Storelocation $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Storelocation $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AdminPages/SupplierController.php b/src/Controller/AdminPages/SupplierController.php index 4330a8fb..68c2efc2 100644 --- a/src/Controller/AdminPages/SupplierController.php +++ b/src/Controller/AdminPages/SupplierController.php @@ -48,6 +48,10 @@ class SupplierController extends BaseAdminController /** * @Route("/{id}", name="supplier_delete", methods={"DELETE"}) + * @param Request $request + * @param Supplier $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, Supplier $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -57,6 +61,10 @@ class SupplierController extends BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="supplier_edit") * @Route("/{id}", requirements={"id"="\d+"}) + * @param Supplier $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response */ public function edit(Supplier $entity, Request $request, EntityManagerInterface $em) { @@ -67,9 +75,12 @@ class SupplierController extends BaseAdminController * @Route("/new", name="supplier_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -77,9 +88,12 @@ class SupplierController extends BaseAdminController /** * @Route("/export", name="supplier_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -87,9 +101,12 @@ class SupplierController extends BaseAdminController /** * @Route("/{id}/export", name="supplier_export") * + * @param Supplier $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Supplier $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Supplier $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/AttachmentFileController.php b/src/Controller/AttachmentFileController.php index 6ed81cd7..70c7e99b 100644 --- a/src/Controller/AttachmentFileController.php +++ b/src/Controller/AttachmentFileController.php @@ -46,9 +46,11 @@ class AttachmentFileController extends AbstractController * * @Route("/attachment/{id}/download", name="attachment_download") * + * @param Attachment $attachment + * @param AttachmentManager $helper * @return BinaryFileResponse */ - public function download(Attachment $attachment, AttachmentManager $helper) + public function download(Attachment $attachment, AttachmentManager $helper): BinaryFileResponse { $this->denyAccessUnlessGranted('read', $attachment); @@ -74,11 +76,12 @@ class AttachmentFileController extends AbstractController * * @Route("/attachment/{id}/view", name="attachment_view") * + * @param Attachment $attachment + * @param AttachmentManager $helper * @return BinaryFileResponse * - * @throws Exception */ - public function view(Attachment $attachment, AttachmentManager $helper) + public function view(Attachment $attachment, AttachmentManager $helper): BinaryFileResponse { $this->denyAccessUnlessGranted('read', $attachment); @@ -102,6 +105,8 @@ class AttachmentFileController extends AbstractController /** * @Route("/attachment/list", name="attachment_list") * + * @param DataTableFactory $dataTable + * @param Request $request * @return JsonResponse|Response */ public function attachmentsTable(DataTableFactory $dataTable, Request $request) diff --git a/src/Controller/GroupController.php b/src/Controller/GroupController.php index 1215d273..88349893 100644 --- a/src/Controller/GroupController.php +++ b/src/Controller/GroupController.php @@ -52,9 +52,12 @@ class GroupController extends BaseAdminController * @Route("/{id}/edit", requirements={"id"="\d+"}, name="group_edit") * @Route("/{id}/", requirements={"id"="\d+"}) * + * @param Group $entity + * @param Request $request + * @param EntityManagerInterface $em * @return Response */ - public function edit(Group $entity, Request $request, EntityManagerInterface $em) + public function edit(Group $entity, Request $request, EntityManagerInterface $em): Response { return $this->_edit($entity, $request, $em); } @@ -63,9 +66,12 @@ class GroupController extends BaseAdminController * @Route("/new", name="group_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } @@ -73,9 +79,12 @@ class GroupController extends BaseAdminController /** * @Route("/{id}", name="group_delete", methods={"DELETE"}) * + * @param Request $request + * @param Group $entity + * @param StructuralElementRecursionHelper $recursionHelper * @return RedirectResponse */ - public function delete(Request $request, Group $entity, StructuralElementRecursionHelper $recursionHelper) + public function delete(Request $request, Group $entity, StructuralElementRecursionHelper $recursionHelper): RedirectResponse { return $this->_delete($request, $entity, $recursionHelper); } @@ -83,9 +92,12 @@ class GroupController extends BaseAdminController /** * @Route("/export", name="group_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -93,9 +105,12 @@ class GroupController extends BaseAdminController /** * @Route("/{id}/export", name="group_export") * + * @param Group $entity + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(Group $entity, EntityExporter $exporter, Request $request) + public function exportEntity(Group $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } diff --git a/src/Controller/HomepageController.php b/src/Controller/HomepageController.php index 96b2a34f..9c22d2b5 100644 --- a/src/Controller/HomepageController.php +++ b/src/Controller/HomepageController.php @@ -57,8 +57,10 @@ class HomepageController extends AbstractController /** * @Route("/", name="homepage") + * @param GitVersionInfo $versionInfo + * @return \Symfony\Component\HttpFoundation\Response */ - public function homepage(GitVersionInfo $versionInfo) + public function homepage(GitVersionInfo $versionInfo): \Symfony\Component\HttpFoundation\Response { return $this->render('homepage.html.twig', [ 'banner' => $this->getBanner(), diff --git a/src/Controller/LogController.php b/src/Controller/LogController.php index f3a867cf..e227217a 100644 --- a/src/Controller/LogController.php +++ b/src/Controller/LogController.php @@ -40,6 +40,8 @@ class LogController extends AbstractController /** * @Route("/", name="log_view") * + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showLogs(Request $request, DataTableFactory $dataTable) diff --git a/src/Controller/PartController.php b/src/Controller/PartController.php index 26585075..ee0b7281 100644 --- a/src/Controller/PartController.php +++ b/src/Controller/PartController.php @@ -50,9 +50,13 @@ class PartController extends AbstractController * @Route("/{id}/info", name="part_info") * @Route("/{id}", requirements={"id"="\d+"}) * + * @param Part $part + * @param AttachmentManager $attachmentHelper + * @param PricedetailHelper $pricedetailHelper + * @param PartPreviewGenerator $previewGenerator * @return Response */ - public function show(Part $part, AttachmentManager $attachmentHelper, PricedetailHelper $pricedetailHelper, PartPreviewGenerator $previewGenerator) + public function show(Part $part, AttachmentManager $attachmentHelper, PricedetailHelper $pricedetailHelper, PartPreviewGenerator $previewGenerator): Response { $this->denyAccessUnlessGranted('read', $part); @@ -70,10 +74,16 @@ class PartController extends AbstractController /** * @Route("/{id}/edit", name="part_edit") * + * @param Part $part + * @param Request $request + * @param EntityManagerInterface $em + * @param TranslatorInterface $translator + * @param AttachmentManager $attachmentHelper + * @param AttachmentSubmitHandler $attachmentSubmitHandler * @return Response */ public function edit(Part $part, Request $request, EntityManagerInterface $em, TranslatorInterface $translator, - AttachmentManager $attachmentHelper, AttachmentSubmitHandler $attachmentSubmitHandler) + AttachmentManager $attachmentHelper, AttachmentSubmitHandler $attachmentSubmitHandler): Response { $this->denyAccessUnlessGranted('edit', $part); @@ -120,9 +130,11 @@ class PartController extends AbstractController /** * @Route("/{id}/delete", name="part_delete", methods={"DELETE"}) * + * @param Request $request + * @param Part $part * @return RedirectResponse */ - public function delete(Request $request, Part $part) + public function delete(Request $request, Part $part): RedirectResponse { $this->denyAccessUnlessGranted('delete', $part); @@ -144,10 +156,15 @@ class PartController extends AbstractController /** * @Route("/new", name="part_new") * + * @param Request $request + * @param EntityManagerInterface $em + * @param TranslatorInterface $translator + * @param AttachmentManager $attachmentHelper + * @param AttachmentSubmitHandler $attachmentSubmitHandler * @return Response */ public function new(Request $request, EntityManagerInterface $em, TranslatorInterface $translator, - AttachmentManager $attachmentHelper, AttachmentSubmitHandler $attachmentSubmitHandler) + AttachmentManager $attachmentHelper, AttachmentSubmitHandler $attachmentSubmitHandler): Response { $new_part = new Part(); @@ -206,6 +223,10 @@ class PartController extends AbstractController /** * @Route("/{id}/clone", name="part_clone") * + * @param Part $part + * @param Request $request + * @param EntityManagerInterface $em + * @param TranslatorInterface $translator * @return RedirectResponse|Response */ public function clone(Part $part, Request $request, EntityManagerInterface $em, TranslatorInterface $translator) diff --git a/src/Controller/PartListsController.php b/src/Controller/PartListsController.php index bdf3c9fc..a895222a 100644 --- a/src/Controller/PartListsController.php +++ b/src/Controller/PartListsController.php @@ -42,6 +42,9 @@ class PartListsController extends AbstractController /** * @Route("/category/{id}/parts", name="part_list_category") * + * @param Category $category + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showCategory(Category $category, Request $request, DataTableFactory $dataTable) @@ -62,6 +65,9 @@ class PartListsController extends AbstractController /** * @Route("/footprint/{id}/parts", name="part_list_footprint") * + * @param Footprint $footprint + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showFootprint(Footprint $footprint, Request $request, DataTableFactory $dataTable) @@ -82,6 +88,9 @@ class PartListsController extends AbstractController /** * @Route("/manufacturer/{id}/parts", name="part_list_manufacturer") * + * @param Manufacturer $manufacturer + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showManufacturer(Manufacturer $manufacturer, Request $request, DataTableFactory $dataTable) @@ -102,6 +111,9 @@ class PartListsController extends AbstractController /** * @Route("/store_location/{id}/parts", name="part_list_store_location") * + * @param Storelocation $storelocation + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showStorelocation(Storelocation $storelocation, Request $request, DataTableFactory $dataTable) @@ -122,6 +134,9 @@ class PartListsController extends AbstractController /** * @Route("/supplier/{id}/parts", name="part_list_supplier") * + * @param Supplier $supplier + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showSupplier(Supplier $supplier, Request $request, DataTableFactory $dataTable) @@ -142,6 +157,9 @@ class PartListsController extends AbstractController /** * @Route("/parts/by_tag/{tag}", name="part_list_tags") * + * @param string $tag + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showTag(string $tag, Request $request, DataTableFactory $dataTable) @@ -161,6 +179,9 @@ class PartListsController extends AbstractController /** * @Route("/parts/search", name="parts_search") + * @param Request $request + * @param DataTableFactory $dataTable + * @return JsonResponse|Response */ public function showSearch(Request $request, DataTableFactory $dataTable) { @@ -182,6 +203,8 @@ class PartListsController extends AbstractController /** * @Route("/parts", name="parts_show_all") * + * @param Request $request + * @param DataTableFactory $dataTable * @return JsonResponse|Response */ public function showAll(Request $request, DataTableFactory $dataTable) diff --git a/src/Controller/RedirectController.php b/src/Controller/RedirectController.php index 18160deb..70f668ca 100644 --- a/src/Controller/RedirectController.php +++ b/src/Controller/RedirectController.php @@ -52,9 +52,10 @@ class RedirectController extends AbstractController * This function is called whenever a route was not matching the localized routes. * The purpose is to redirect the user to the localized version of the page. * + * @param Request $request * @return RedirectResponse */ - public function addLocalePart(Request $request) + public function addLocalePart(Request $request): RedirectResponse { //By default we use the global default locale $locale = $this->default_locale; @@ -85,7 +86,7 @@ class RedirectController extends AbstractController * * @return bool */ - public function checkIfModRewriteAvailable() + public function checkIfModRewriteAvailable(): bool { if (! function_exists('apache_get_modules')) { //If we can not check for apache modules, we just hope for the best and assume url rewriting is available diff --git a/src/Controller/SecurityController.php b/src/Controller/SecurityController.php index 566b31de..ce96a3be 100644 --- a/src/Controller/SecurityController.php +++ b/src/Controller/SecurityController.php @@ -53,8 +53,10 @@ class SecurityController extends AbstractController /** * @Route("/login", name="login", methods={"GET", "POST"}) + * @param AuthenticationUtils $authenticationUtils + * @return \Symfony\Component\HttpFoundation\Response */ - public function login(AuthenticationUtils $authenticationUtils) + public function login(AuthenticationUtils $authenticationUtils): \Symfony\Component\HttpFoundation\Response { // get the login error if there is one $error = $authenticationUtils->getLastAuthenticationError(); @@ -70,6 +72,9 @@ class SecurityController extends AbstractController /** * @Route("/pw_reset/request", name="pw_reset_request") + * @param PasswordResetManager $passwordReset + * @param Request $request + * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response */ public function requestPwReset(PasswordResetManager $passwordReset, Request $request) { @@ -112,6 +117,11 @@ class SecurityController extends AbstractController /** * @Route("/pw_reset/new_pw/{user}/{token}", name="pw_reset_new_pw") + * @param PasswordResetManager $passwordReset + * @param Request $request + * @param string|null $user + * @param string|null $token + * @return \Symfony\Component\HttpFoundation\RedirectResponse|\Symfony\Component\HttpFoundation\Response */ public function pwResetNewPw(PasswordResetManager $passwordReset, Request $request, ?string $user = null, ?string $token = null) { diff --git a/src/Controller/TreeController.php b/src/Controller/TreeController.php index 4d6434c0..632231e3 100644 --- a/src/Controller/TreeController.php +++ b/src/Controller/TreeController.php @@ -52,8 +52,10 @@ class TreeController extends AbstractController /** * @Route("/tools", name="tree_tools") + * @param ToolsTreeBuilder $builder + * @return JsonResponse */ - public function tools(ToolsTreeBuilder $builder) + public function tools(ToolsTreeBuilder $builder): JsonResponse { $tree = $builder->getTree(); @@ -63,8 +65,10 @@ class TreeController extends AbstractController /** * @Route("/category/{id}", name="tree_category") * @Route("/categories") + * @param Category|null $category + * @return JsonResponse */ - public function categoryTree(?Category $category = null) + public function categoryTree(?Category $category = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Category::class, $category); @@ -74,8 +78,10 @@ class TreeController extends AbstractController /** * @Route("/footprint/{id}", name="tree_footprint") * @Route("/footprints") + * @param Footprint|null $footprint + * @return JsonResponse */ - public function footprintTree(?Footprint $footprint = null) + public function footprintTree(?Footprint $footprint = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Footprint::class, $footprint); @@ -85,8 +91,10 @@ class TreeController extends AbstractController /** * @Route("/location/{id}", name="tree_location") * @Route("/locations") + * @param Storelocation|null $location + * @return JsonResponse */ - public function locationTree(?Storelocation $location = null) + public function locationTree(?Storelocation $location = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Storelocation::class, $location); @@ -96,8 +104,10 @@ class TreeController extends AbstractController /** * @Route("/manufacturer/{id}", name="tree_manufacturer") * @Route("/manufacturers") + * @param Manufacturer|null $manufacturer + * @return JsonResponse */ - public function manufacturerTree(?Manufacturer $manufacturer = null) + public function manufacturerTree(?Manufacturer $manufacturer = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Manufacturer::class, $manufacturer); @@ -107,8 +117,10 @@ class TreeController extends AbstractController /** * @Route("/supplier/{id}", name="tree_supplier") * @Route("/suppliers") + * @param Supplier|null $supplier + * @return JsonResponse */ - public function supplierTree(?Supplier $supplier = null) + public function supplierTree(?Supplier $supplier = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Supplier::class, $supplier); @@ -118,8 +130,10 @@ class TreeController extends AbstractController /** * @Route("/device/{id}", name="tree_device") * @Route("/devices") + * @param Device|null $device + * @return JsonResponse */ - public function deviceTree(?Device $device = null) + public function deviceTree(?Device $device = null): JsonResponse { $tree = $this->treeGenerator->getTreeView(Device::class, $device, ''); diff --git a/src/Controller/TypeaheadController.php b/src/Controller/TypeaheadController.php index 3e9b5801..866fa023 100644 --- a/src/Controller/TypeaheadController.php +++ b/src/Controller/TypeaheadController.php @@ -43,6 +43,10 @@ class TypeaheadController extends AbstractController { /** * @Route("/builtInResources/search/{query}", name="typeahead_builtInRessources", requirements={"query"= ".+"}) + * @param Request $request + * @param string $query + * @param BuiltinAttachmentsFinder $finder + * @return JsonResponse */ public function builtInResources(Request $request, string $query, BuiltinAttachmentsFinder $finder) { @@ -62,6 +66,9 @@ class TypeaheadController extends AbstractController /** * @Route("/tags/search/{query}", name="typeahead_tags", requirements={"query"= ".+"}) + * @param string $query + * @param TagFinder $finder + * @return JsonResponse */ public function tags(string $query, TagFinder $finder) { diff --git a/src/Controller/UserController.php b/src/Controller/UserController.php index 8cd4a4aa..b3c6ae39 100644 --- a/src/Controller/UserController.php +++ b/src/Controller/UserController.php @@ -24,7 +24,6 @@ declare(strict_types=1); namespace App\Controller; -use App\Entity\Attachments\AttachmentType; use App\Entity\Attachments\UserAttachment; use App\Entity\UserSystem\User; use App\Form\Permissions\PermissionsType; @@ -54,6 +53,11 @@ class UserController extends AdminPages\BaseAdminController /** * @Route("/{id}/edit", requirements={"id"="\d+"}, name="user_edit") * @Route("/{id}/", requirements={"id"="\d+"}) + * @param User $entity + * @param Request $request + * @param EntityManagerInterface $em + * @return Response + * @throws \Exception */ public function edit(User $entity, Request $request, EntityManagerInterface $em) { @@ -87,15 +91,22 @@ class UserController extends AdminPages\BaseAdminController * @Route("/new", name="user_new") * @Route("/") * + * @param Request $request + * @param EntityManagerInterface $em + * @param EntityImporter $importer * @return Response */ - public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer) + public function new(Request $request, EntityManagerInterface $em, EntityImporter $importer): Response { return $this->_new($request, $em, $importer); } /** * @Route("/{id}", name="user_delete", methods={"DELETE"}, requirements={"id"="\d+"}) + * @param Request $request + * @param User $entity + * @param StructuralElementRecursionHelper $recursionHelper + * @return \Symfony\Component\HttpFoundation\RedirectResponse */ public function delete(Request $request, User $entity, StructuralElementRecursionHelper $recursionHelper) { @@ -109,9 +120,12 @@ class UserController extends AdminPages\BaseAdminController /** * @Route("/export", name="user_export_all") * + * @param EntityManagerInterface $em + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request) + public function exportAll(EntityManagerInterface $em, EntityExporter $exporter, Request $request): Response { return $this->_exportAll($em, $exporter, $request); } @@ -119,11 +133,13 @@ class UserController extends AdminPages\BaseAdminController /** * @Route("/{id}/export", name="user_export") * - * @param User $entity + * @param User $entity * + * @param EntityExporter $exporter + * @param Request $request * @return Response */ - public function exportEntity(User $entity, EntityExporter $exporter, Request $request) + public function exportEntity(User $entity, EntityExporter $exporter, Request $request): Response { return $this->_exportEntity($entity, $exporter, $request); } @@ -131,12 +147,19 @@ class UserController extends AdminPages\BaseAdminController /** * @Route("/info", name="user_info_self") * @Route("/{id}/info", name="user_info") + * @param User|null $user + * @param Packages $packages + * @return Response */ - public function userInfo(?User $user, Packages $packages) + public function userInfo(?User $user, Packages $packages): Response { //If no user id was passed, then we show info about the current user if (null === $user) { - $user = $this->getUser(); + $tmp = $this->getUser(); + if(!$tmp instanceof User) { + throw new InvalidArgumentException('Userinfo only works for database users!'); + } + $user = $tmp; } else { //Else we must check, if the current user is allowed to access $user $this->denyAccessUnlessGranted('read', $user); @@ -176,7 +199,7 @@ class UserController extends AdminPages\BaseAdminController * @return string containing either just a URL or a complete image tag * @source https://gravatar.com/site/implement/images/php/ */ - public function getGravatar(?string $email, int $s = 80, string $d = 'mm', string $r = 'g', bool $img = false, array $atts = []) + public function getGravatar(?string $email, int $s = 80, string $d = 'mm', string $r = 'g', bool $img = false, array $atts = []): string { if (null === $email) { return ''; diff --git a/src/Controller/UserSettingsController.php b/src/Controller/UserSettingsController.php index a2911bbf..3211680a 100644 --- a/src/Controller/UserSettingsController.php +++ b/src/Controller/UserSettingsController.php @@ -84,9 +84,12 @@ class UserSettingsController extends AbstractController /** * @Route("/u2f_delete", name="u2f_delete", methods={"DELETE"}) * + * @param Request $request + * @param EntityManagerInterface $entityManager + * @param BackupCodeManager $backupCodeManager * @return RedirectResponse */ - public function removeU2FToken(Request $request, EntityManagerInterface $entityManager, BackupCodeManager $backupCodeManager) + public function removeU2FToken(Request $request, EntityManagerInterface $entityManager, BackupCodeManager $backupCodeManager): RedirectResponse { if ($this->demo_mode) { throw new RuntimeException('You can not do 2FA things in demo mode'); @@ -134,6 +137,9 @@ class UserSettingsController extends AbstractController /** * @Route("/invalidate_trustedDevices", name="tfa_trustedDevices_invalidate", methods={"DELETE"}) + * @param Request $request + * @param EntityManagerInterface $entityManager + * @return RuntimeException|RedirectResponse */ public function resetTrustedDevices(Request $request, EntityManagerInterface $entityManager) { @@ -163,6 +169,12 @@ class UserSettingsController extends AbstractController /** * @Route("/settings", name="user_settings") + * @param Request $request + * @param EntityManagerInterface $em + * @param UserPasswordEncoderInterface $passwordEncoder + * @param GoogleAuthenticator $googleAuthenticator + * @param BackupCodeManager $backupCodeManager + * @return RedirectResponse|\Symfony\Component\HttpFoundation\Response */ public function userSettings(Request $request, EntityManagerInterface $em, UserPasswordEncoderInterface $passwordEncoder, GoogleAuthenticator $googleAuthenticator, BackupCodeManager $backupCodeManager) { @@ -186,7 +198,7 @@ class UserSettingsController extends AbstractController $form->handleRequest($request); - if ($form->isSubmitted() && $form->isValid() && ! $this->demo_mode) { + if (! $this->demo_mode && $form->isSubmitted() && $form->isValid()) { //Check if user theme setting has changed if ($user->getTheme() !== $em->getUnitOfWork()->getOriginalEntityData($user)['theme']) { $page_need_reload = true; @@ -246,7 +258,7 @@ class UserSettingsController extends AbstractController $pw_form->handleRequest($request); //Check if password if everything was correct, then save it to User and DB - if ($pw_form->isSubmitted() && $pw_form->isValid() && ! $this->demo_mode) { + if (! $this->demo_mode && $pw_form->isSubmitted() && $pw_form->isValid()) { $password = $passwordEncoder->encodePassword($user, $pw_form['new_password']->getData()); $user->setPassword($password); @@ -261,13 +273,13 @@ class UserSettingsController extends AbstractController //Handle 2FA things $google_form = $this->createForm(TFAGoogleSettingsType::class, $user); $google_enabled = $user->isGoogleAuthenticatorEnabled(); - if (! $form->isSubmitted() && ! $google_enabled) { + if (! $google_enabled && ! $form->isSubmitted()) { $user->setGoogleAuthenticatorSecret($googleAuthenticator->generateSecret()); $google_form->get('googleAuthenticatorSecret')->setData($user->getGoogleAuthenticatorSecret()); } $google_form->handleRequest($request); - if ($google_form->isSubmitted() && $google_form->isValid() && ! $this->demo_mode) { + if ( ! $this->demo_mode && $google_form->isSubmitted() && $google_form->isValid()) { if (! $google_enabled) { //Save 2FA settings (save secrets) $user->setGoogleAuthenticatorSecret($google_form->get('googleAuthenticatorSecret')->getData()); @@ -296,7 +308,7 @@ class UserSettingsController extends AbstractController ])->getForm(); $backup_form->handleRequest($request); - if ($backup_form->isSubmitted() && $backup_form->isValid() && ! $this->demo_mode) { + if (! $this->demo_mode && $backup_form->isSubmitted() && $backup_form->isValid()) { $backupCodeManager->regenerateBackupCodes($user); $em->flush(); $this->addFlash('success', 'user.settings.2fa.backup_codes.regenerated'); diff --git a/src/Entity/Attachments/Attachment.php b/src/Entity/Attachments/Attachment.php index cf59efec..1e289547 100644 --- a/src/Entity/Attachments/Attachment.php +++ b/src/Entity/Attachments/Attachment.php @@ -351,7 +351,10 @@ abstract class Attachment extends AbstractNamedDBElement /***************************************************************************************************** * Setters - ****************************************************************************************************/ + *************************************************************************************************** + * @param bool $show_in_table + * @return Attachment + */ public function setShowInTable(bool $show_in_table): self { @@ -363,6 +366,7 @@ abstract class Attachment extends AbstractNamedDBElement /** * Sets the element that is associated with this attachment. * + * @param AttachmentContainingDBElement $element * @return $this */ public function setElement(AttachmentContainingDBElement $element): self @@ -391,6 +395,7 @@ abstract class Attachment extends AbstractNamedDBElement } /** + * @param AttachmentType $attachement_type * @return $this */ public function setAttachmentType(AttachmentType $attachement_type): self @@ -404,6 +409,7 @@ abstract class Attachment extends AbstractNamedDBElement * Sets the url associated with this attachment. * If the url is empty nothing is changed, to not override the file path. * + * @param string|null $url * @return Attachment */ public function setURL(?string $url): self diff --git a/src/Entity/Attachments/AttachmentContainingDBElement.php b/src/Entity/Attachments/AttachmentContainingDBElement.php index 52b25264..6edf703a 100644 --- a/src/Entity/Attachments/AttachmentContainingDBElement.php +++ b/src/Entity/Attachments/AttachmentContainingDBElement.php @@ -25,6 +25,7 @@ namespace App\Entity\Attachments; use App\Entity\Base\MasterAttachmentTrait; use App\Entity\Base\AbstractNamedDBElement; +use App\Entity\Contracts\HasAttachmentsInterface; use App\Entity\Contracts\HasMasterAttachmentInterface; use Doctrine\Common\Collections\ArrayCollection; use Doctrine\Common\Collections\Collection; @@ -33,7 +34,7 @@ use Doctrine\ORM\Mapping as ORM; /** * @ORM\MappedSuperclass() */ -abstract class AttachmentContainingDBElement extends AbstractNamedDBElement implements HasMasterAttachmentInterface +abstract class AttachmentContainingDBElement extends AbstractNamedDBElement implements HasMasterAttachmentInterface, HasAttachmentsInterface { use MasterAttachmentTrait; @@ -86,6 +87,7 @@ abstract class AttachmentContainingDBElement extends AbstractNamedDBElement impl /** * Removes the given attachment from this element. * + * @param Attachment $attachment * @return $this */ public function removeAttachment(Attachment $attachment): self diff --git a/src/Entity/Base/AbstractCompany.php b/src/Entity/Base/AbstractCompany.php index 57d7d48e..94590d87 100644 --- a/src/Entity/Base/AbstractCompany.php +++ b/src/Entity/Base/AbstractCompany.php @@ -174,7 +174,9 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement /** * Set the addres. * - * @param string $new_address the new address (with "\n" as line break) + * @param string $new_address the new address (with "\n" as line break) + * + * @return $this */ public function setAddress(string $new_address): self { @@ -187,6 +189,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement * Set the phone number. * * @param string $new_phone_number the new phone number + * @return $this */ public function setPhoneNumber(string $new_phone_number): self { @@ -199,6 +202,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement * Set the fax number. * * @param string $new_fax_number the new fax number + * @return $this */ public function setFaxNumber(string $new_fax_number): self { @@ -211,6 +215,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement * Set the e-mail address. * * @param string $new_email_address the new e-mail address + * @return $this */ public function setEmailAddress(string $new_email_address): self { @@ -223,6 +228,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement * Set the website. * * @param string $new_website the new website + * @return $this */ public function setWebsite(string $new_website): self { @@ -235,6 +241,7 @@ abstract class AbstractCompany extends AbstractPartsContainingDBElement * Set the link to the website of an article. * * @param string $new_url the new URL with the placeholder %PARTNUMBER% for the part number + * @return $this */ public function setAutoProductUrl(string $new_url): self { diff --git a/src/Entity/Base/AbstractStructuralDBElement.php b/src/Entity/Base/AbstractStructuralDBElement.php index 46ea08ea..758398ca 100644 --- a/src/Entity/Base/AbstractStructuralDBElement.php +++ b/src/Entity/Base/AbstractStructuralDBElement.php @@ -328,6 +328,7 @@ abstract class AbstractStructuralDBElement extends AttachmentContainingDBElement } /** + * @param bool $not_selectable * @return AbstractStructuralDBElement */ public function setNotSelectable(bool $not_selectable): self diff --git a/src/Entity/Base/MasterAttachmentTrait.php b/src/Entity/Base/MasterAttachmentTrait.php index 63d74cae..a07dd8aa 100644 --- a/src/Entity/Base/MasterAttachmentTrait.php +++ b/src/Entity/Base/MasterAttachmentTrait.php @@ -54,9 +54,10 @@ trait MasterAttachmentTrait /** * Sets the new master picture for this part. * + * @param Attachment|null $new_master_attachment * @return $this */ - public function setMasterPictureAttachment(?Attachment $new_master_attachment) + public function setMasterPictureAttachment(?Attachment $new_master_attachment): self { $this->master_picture_attachment = $new_master_attachment; diff --git a/src/Entity/LogSystem/AbstractLogEntry.php b/src/Entity/LogSystem/AbstractLogEntry.php index 432bea5e..b4334902 100644 --- a/src/Entity/LogSystem/AbstractLogEntry.php +++ b/src/Entity/LogSystem/AbstractLogEntry.php @@ -169,6 +169,7 @@ abstract class AbstractLogEntry extends AbstractDBElement /** * Sets the user that caused the event. * + * @param User $user * @return $this */ public function setUser(User $user): self @@ -191,6 +192,7 @@ abstract class AbstractLogEntry extends AbstractDBElement /** * Sets the timestamp when the event happened. * + * @param DateTime $timestamp * @return $this */ public function setTimestamp(DateTime $timestamp): self @@ -219,6 +221,7 @@ abstract class AbstractLogEntry extends AbstractDBElement /** * Sets the new level of this log entry. * + * @param int $level * @return $this */ public function setLevel(int $level): self @@ -244,6 +247,7 @@ abstract class AbstractLogEntry extends AbstractDBElement /** * Sets the priority level of this log entry as PSR3 compatible string. * + * @param string $level * @return $this */ public function setLevelString(string $level): self diff --git a/src/Entity/LogSystem/ConfigChangedLogEntry.php b/src/Entity/LogSystem/ConfigChangedLogEntry.php index c94d3b2a..e7abdb86 100644 --- a/src/Entity/LogSystem/ConfigChangedLogEntry.php +++ b/src/Entity/LogSystem/ConfigChangedLogEntry.php @@ -36,6 +36,7 @@ class ConfigChangedLogEntry extends AbstractLogEntry public function __construct() { + parent::__construct(); throw new LogEntryObsoleteException(); } } diff --git a/src/Entity/LogSystem/ExceptionLogEntry.php b/src/Entity/LogSystem/ExceptionLogEntry.php index bdd08a88..5b36913f 100644 --- a/src/Entity/LogSystem/ExceptionLogEntry.php +++ b/src/Entity/LogSystem/ExceptionLogEntry.php @@ -36,6 +36,7 @@ class ExceptionLogEntry extends AbstractLogEntry public function __construct() { + parent::__construct(); throw new LogEntryObsoleteException(); } diff --git a/src/Entity/LogSystem/UserNotAllowedLogEntry.php b/src/Entity/LogSystem/UserNotAllowedLogEntry.php index 617565dc..66a42023 100644 --- a/src/Entity/LogSystem/UserNotAllowedLogEntry.php +++ b/src/Entity/LogSystem/UserNotAllowedLogEntry.php @@ -36,6 +36,7 @@ class UserNotAllowedLogEntry extends AbstractLogEntry public function __construct() { + parent::__construct(); //Obsolete, use server log now. throw new LogEntryObsoleteException(); } diff --git a/src/Entity/Parts/Category.php b/src/Entity/Parts/Category.php index 6b9db3f4..9485bb63 100644 --- a/src/Entity/Parts/Category.php +++ b/src/Entity/Parts/Category.php @@ -122,6 +122,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param string $partname_hint * @return Category */ public function setPartnameHint(string $partname_hint): self @@ -137,6 +138,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param string $partname_regex * @return Category */ public function setPartnameRegex(string $partname_regex): self @@ -152,6 +154,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param bool $disable_footprints * @return Category */ public function setDisableFootprints(bool $disable_footprints): self @@ -167,6 +170,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param bool $disable_manufacturers * @return Category */ public function setDisableManufacturers(bool $disable_manufacturers): self @@ -182,6 +186,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param bool $disable_autodatasheets * @return Category */ public function setDisableAutodatasheets(bool $disable_autodatasheets): self @@ -197,6 +202,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param bool $disable_properties * @return Category */ public function setDisableProperties(bool $disable_properties): self @@ -212,6 +218,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param string $default_description * @return Category */ public function setDefaultDescription(string $default_description): self @@ -227,6 +234,7 @@ class Category extends AbstractPartsContainingDBElement } /** + * @param string $default_comment * @return Category */ public function setDefaultComment(string $default_comment): self diff --git a/src/Entity/Parts/MeasurementUnit.php b/src/Entity/Parts/MeasurementUnit.php index d3d1d11d..a5b0f332 100644 --- a/src/Entity/Parts/MeasurementUnit.php +++ b/src/Entity/Parts/MeasurementUnit.php @@ -121,6 +121,7 @@ class MeasurementUnit extends AbstractPartsContainingDBElement } /** + * @param bool $isInteger * @return MeasurementUnit */ public function setIsInteger(bool $isInteger): self @@ -136,6 +137,7 @@ class MeasurementUnit extends AbstractPartsContainingDBElement } /** + * @param bool $usesSIPrefixes * @return MeasurementUnit */ public function setUseSIPrefix(bool $usesSIPrefixes): self diff --git a/src/Entity/Parts/PartLot.php b/src/Entity/Parts/PartLot.php index df383401..24fd233a 100644 --- a/src/Entity/Parts/PartLot.php +++ b/src/Entity/Parts/PartLot.php @@ -26,7 +26,6 @@ namespace App\Entity\Parts; use App\Entity\Base\AbstractDBElement; use App\Entity\Base\TimestampTrait; -use App\Entity\Parts\PartTraits\InstockTrait; use App\Validator\Constraints\Selectable; use App\Validator\Constraints\ValidPartLot; use DateTime; @@ -143,6 +142,7 @@ class PartLot extends AbstractDBElement /** * Sets the description of the part lot. * + * @param string $description * @return PartLot */ public function setDescription(string $description): self @@ -165,6 +165,7 @@ class PartLot extends AbstractDBElement /** * Sets the comment for this part lot. * + * @param string $comment * @return PartLot */ public function setComment(string $comment): self @@ -211,6 +212,7 @@ class PartLot extends AbstractDBElement /** * Sets the storage location, where this part lot is stored. * + * @param Storelocation|null $storage_location * @return PartLot */ public function setStorageLocation(?Storelocation $storage_location): self @@ -257,6 +259,7 @@ class PartLot extends AbstractDBElement /** * Set the unknown instock status of this part lot. * + * @param bool $instock_unknown * @return PartLot */ public function setInstockUnknown(bool $instock_unknown): self @@ -294,6 +297,7 @@ class PartLot extends AbstractDBElement } /** + * @param bool $needs_refill * @return PartLot */ public function setNeedsRefill(bool $needs_refill): self diff --git a/src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php b/src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php index e26d93a0..5bada604 100644 --- a/src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php +++ b/src/Entity/Parts/PartTraits/AdvancedPropertyTrait.php @@ -88,6 +88,7 @@ trait AdvancedPropertyTrait * Sets a comma separated list of tags, that are assigned to this part. * * @param string $tags The new tags + * @return $this */ public function setTags(string $tags): self { @@ -110,6 +111,7 @@ trait AdvancedPropertyTrait * Sett to null, if the mass is unknown. * * @param float|null $mass the new mass + * @return $this */ public function setMass(?float $mass): self { diff --git a/src/Entity/Parts/PartTraits/BasicPropertyTrait.php b/src/Entity/Parts/PartTraits/BasicPropertyTrait.php index 5380e17c..12501602 100644 --- a/src/Entity/Parts/PartTraits/BasicPropertyTrait.php +++ b/src/Entity/Parts/PartTraits/BasicPropertyTrait.php @@ -146,6 +146,7 @@ trait BasicPropertyTrait * Sets the description of this part. * * @param string $new_description the new description + * @return $this */ public function setDescription(?string $new_description): self { @@ -158,6 +159,7 @@ trait BasicPropertyTrait * Sets the comment property of this part. * * @param string $new_comment the new comment + * @return $this */ public function setComment(string $new_comment): self { @@ -171,6 +173,7 @@ trait BasicPropertyTrait * The category property is required for every part, so you can not pass null like the other properties (footprints). * * @param Category $category The new category of this part + * @return $this */ public function setCategory(Category $category): self { @@ -184,6 +187,7 @@ trait BasicPropertyTrait * * @param Footprint|null $new_footprint The new footprint of this part. Set to null, if this part should not have * a footprint. + * @return $this */ public function setFootprint(?Footprint $new_footprint): self { @@ -197,6 +201,7 @@ trait BasicPropertyTrait * * @param bool $new_favorite_status The new favorite status, that should be applied on this part. * Set this to true, when the part should be a favorite. + * @return $this */ public function setFavorite(bool $new_favorite_status): self { diff --git a/src/Entity/Parts/PartTraits/InstockTrait.php b/src/Entity/Parts/PartTraits/InstockTrait.php index 5f495e0c..a1ff560a 100644 --- a/src/Entity/Parts/PartTraits/InstockTrait.php +++ b/src/Entity/Parts/PartTraits/InstockTrait.php @@ -72,6 +72,8 @@ trait InstockTrait /** * Adds the given part lot, to the list of part lots. * The part lot is assigned to this part. + * @param PartLot $lot + * @return $this */ public function addPartLot(PartLot $lot): self { @@ -85,6 +87,7 @@ trait InstockTrait * Removes the given part lot from the list of part lots. * * @param PartLot $lot the part lot that should be deleted + * @return $this */ public function removePartLot(PartLot $lot): self { @@ -105,6 +108,8 @@ trait InstockTrait /** * Sets the measurement unit in which the part's amount should be measured. * Set to null, if the part should be measured in quantities. + * @param MeasurementUnit|null $partUnit + * @return $this */ public function setPartUnit(?MeasurementUnit $partUnit): self { @@ -149,6 +154,7 @@ trait InstockTrait * Part Lots that have unknown value or are expired, are not used for this value. * * @return float The amount of parts given in partUnit + * */ public function getAmountSum(): float { @@ -175,6 +181,7 @@ trait InstockTrait * See getPartUnit() for the associated unit. * * @param float $new_minamount the new count of parts which should be in stock at least + * @return $this */ public function setMinAmount(float $new_minamount): self { diff --git a/src/Entity/Parts/PartTraits/ManufacturerTrait.php b/src/Entity/Parts/PartTraits/ManufacturerTrait.php index 34dbc843..99cab160 100644 --- a/src/Entity/Parts/PartTraits/ManufacturerTrait.php +++ b/src/Entity/Parts/PartTraits/ManufacturerTrait.php @@ -118,6 +118,7 @@ trait ManufacturerTrait * Sets the manufacturing status for this part * See getManufacturingStatus() for valid values. * + * @param string $manufacturing_status * @return Part */ public function setManufacturingStatus(string $manufacturing_status): self @@ -148,6 +149,7 @@ trait ManufacturerTrait /** * Sets the manufacturer product number (MPN) for this part. * + * @param string $manufacturer_product_number * @return Part */ public function setManufacturerProductNumber(string $manufacturer_product_number): self @@ -162,6 +164,7 @@ trait ManufacturerTrait * Set to "" if this part should use the automatically URL based on its manufacturer. * * @param string $new_url The new url + * @return $this */ public function setManufacturerProductURL(string $new_url): self { @@ -175,6 +178,7 @@ trait ManufacturerTrait * * @param Manufacturer|null $new_manufacturer The new Manufacturer of this part. Set to null, if this part should * not have a manufacturer. + * @return $this */ public function setManufacturer(?Manufacturer $new_manufacturer): self { diff --git a/src/Entity/Parts/Storelocation.php b/src/Entity/Parts/Storelocation.php index 7be25944..92965999 100644 --- a/src/Entity/Parts/Storelocation.php +++ b/src/Entity/Parts/Storelocation.php @@ -144,6 +144,7 @@ class Storelocation extends AbstractPartsContainingDBElement } /** + * @param bool $only_single_part * @return Storelocation */ public function setOnlySinglePart(bool $only_single_part): self @@ -164,6 +165,7 @@ class Storelocation extends AbstractPartsContainingDBElement } /** + * @param bool $limit_to_existing_parts * @return Storelocation */ public function setLimitToExistingParts(bool $limit_to_existing_parts): self @@ -182,6 +184,7 @@ class Storelocation extends AbstractPartsContainingDBElement } /** + * @param MeasurementUnit|null $storage_type * @return Storelocation */ public function setStorageType(?MeasurementUnit $storage_type): self diff --git a/src/Entity/Parts/Supplier.php b/src/Entity/Parts/Supplier.php index 9cb340da..01098ce7 100644 --- a/src/Entity/Parts/Supplier.php +++ b/src/Entity/Parts/Supplier.php @@ -126,6 +126,7 @@ class Supplier extends AbstractCompany /** * Sets the default currency. * + * @param Currency|null $default_currency * @return Supplier */ public function setDefaultCurrency(?Currency $default_currency): self diff --git a/src/Entity/PriceInformations/Orderdetail.php b/src/Entity/PriceInformations/Orderdetail.php index 95954dad..805d5b36 100644 --- a/src/Entity/PriceInformations/Orderdetail.php +++ b/src/Entity/PriceInformations/Orderdetail.php @@ -228,6 +228,7 @@ class Orderdetail extends AbstractDBElement /** * Removes an pricedetail from this orderdetail. * + * @param Pricedetail $pricedetail * @return Orderdetail */ public function removePricedetail(Pricedetail $pricedetail): self @@ -275,6 +276,7 @@ class Orderdetail extends AbstractDBElement /** * Sets a new part with which this orderdetail is associated. * + * @param Part $part * @return Orderdetail */ public function setPart(Part $part): self @@ -287,6 +289,7 @@ class Orderdetail extends AbstractDBElement /** * Sets the new supplier associated with this orderdetail. * + * @param Supplier $new_supplier * @return Orderdetail */ public function setSupplier(Supplier $new_supplier): self diff --git a/src/Entity/PriceInformations/Pricedetail.php b/src/Entity/PriceInformations/Pricedetail.php index 4221274a..91f5f939 100644 --- a/src/Entity/PriceInformations/Pricedetail.php +++ b/src/Entity/PriceInformations/Pricedetail.php @@ -230,6 +230,7 @@ class Pricedetail extends AbstractDBElement /** * Sets the orderdetail to which this pricedetail belongs to. * + * @param Orderdetail $orderdetail * @return $this */ public function setOrderdetail(Orderdetail $orderdetail): self @@ -243,6 +244,7 @@ class Pricedetail extends AbstractDBElement * Sets the currency associated with the price informations. * Set to null, to use the global base currency. * + * @param Currency|null $currency * @return Pricedetail */ public function setCurrency(?Currency $currency): self @@ -260,6 +262,7 @@ class Pricedetail extends AbstractDBElement * * This is the price for "price_related_quantity" parts!! * * Example: if "price_related_quantity" is '10', * you have to set here the price for 10 parts! + * @return $this */ public function setPrice(string $new_price): self { @@ -306,6 +309,7 @@ class Pricedetail extends AbstractDBElement * So the orderdetails would have three Pricedetails for one supplier.) * * @param float $new_min_discount_quantity the minimum discount quantity + * @return $this */ public function setMinDiscountQuantity(float $new_min_discount_quantity): self { diff --git a/src/Entity/UserSystem/U2FKey.php b/src/Entity/UserSystem/U2FKey.php index c77af17c..449c5ecb 100644 --- a/src/Entity/UserSystem/U2FKey.php +++ b/src/Entity/UserSystem/U2FKey.php @@ -26,7 +26,6 @@ namespace App\Entity\UserSystem; use App\Entity\Base\TimestampTrait; use Doctrine\ORM\Mapping as ORM; -use R\U2FTwoFactorBundle\Model\U2F\TwoFactorInterface; use R\U2FTwoFactorBundle\Model\U2F\TwoFactorKeyInterface; use u2flib_server\Registration; @@ -176,6 +175,7 @@ class U2FKey implements TwoFactorKeyInterface /** * Sets the user this U2F key belongs to. * + * @param User $new_user * @return $this */ public function setUser(User $new_user): self diff --git a/src/Entity/UserSystem/User.php b/src/Entity/UserSystem/User.php index 74e04437..66a6218c 100644 --- a/src/Entity/UserSystem/User.php +++ b/src/Entity/UserSystem/User.php @@ -87,7 +87,7 @@ use Symfony\Component\Validator\Constraints as Assert; */ class User extends AttachmentContainingDBElement implements UserInterface, HasPermissionsInterface, TwoFactorInterface, BackupCodeInterface, TrustedDeviceInterface, U2FTwoFactorInterface, PreferredProviderInterface { - use MasterAttachmentTrait; + //use MasterAttachmentTrait; /** * The User id of the anonymous user. @@ -339,6 +339,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Sets the password hash for this user. * + * @param string $password * @return User */ public function setPassword(string $password): self @@ -378,6 +379,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Sets the currency the users prefers to see prices in. * + * @param Currency|null $currency * @return User */ public function setCurrency(?Currency $currency): self @@ -440,6 +442,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Set the status, if the user needs a password change. * + * @param bool $need_pw_change * @return User */ public function setNeedPwChange(bool $need_pw_change): self @@ -462,6 +465,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Sets the encrypted password reset token. * + * @param string|null $pw_reset_token * @return User */ public function setPwResetToken(?string $pw_reset_token): self @@ -484,6 +488,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Sets the datetime when the password reset token expires. * + * @param DateTime $pw_reset_expires * @return User */ public function setPwResetExpires(DateTime $pw_reset_expires): self @@ -667,6 +672,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Change the timezone of this user. * + * @param string|null $timezone * @return $this */ public function setTimezone(?string $timezone): self @@ -759,6 +765,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Sets the secret used for Google Authenticator. Set to null to disable Google Authenticator. * + * @param string|null $googleAuthenticatorSecret * @return $this */ public function setGoogleAuthenticatorSecret(?string $googleAuthenticatorSecret): self @@ -875,6 +882,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Add a U2F key to this user. + * @param TwoFactorKeyInterface $key */ public function addU2FKey(TwoFactorKeyInterface $key): void { @@ -883,6 +891,7 @@ class User extends AttachmentContainingDBElement implements UserInterface, HasPe /** * Remove a U2F key from this user. + * @param TwoFactorKeyInterface $key */ public function removeU2FKey(TwoFactorKeyInterface $key): void { diff --git a/src/Repository/LogEntryRepository.php b/src/Repository/LogEntryRepository.php index 48c07719..27a0b4f8 100644 --- a/src/Repository/LogEntryRepository.php +++ b/src/Repository/LogEntryRepository.php @@ -53,7 +53,7 @@ class LogEntryRepository extends EntityRepository * * @return AbstractLogEntry[] */ - public function getElementHistory(AbstractDBElement $element, $order = 'DESC', $limit = null, $offset = null) + public function getElementHistory(AbstractDBElement $element, $order = 'DESC', $limit = null, $offset = null): array { return $this->findBy(['element' => $element], ['timestamp' => $order], $limit, $offset); } @@ -67,7 +67,7 @@ class LogEntryRepository extends EntityRepository * * @return array */ - public function getLogsOrderedByTimestamp($order = 'DESC', $limit = null, $offset = null) + public function getLogsOrderedByTimestamp($order = 'DESC', $limit = null, $offset = null): array { return $this->findBy([], ['timestamp' => $order], $limit, $offset); } @@ -75,8 +75,12 @@ class LogEntryRepository extends EntityRepository /** * Gets the target element associated with the logentry. * + * @param AbstractLogEntry $logEntry * @return AbstractDBElement|null Returns the associated DBElement or null if the log either has no target or the element * was deleted from DB. + * @throws \Doctrine\ORM\ORMException + * @throws \Doctrine\ORM\OptimisticLockException + * @throws \Doctrine\ORM\TransactionRequiredException */ public function getTargetElement(AbstractLogEntry $logEntry): ?AbstractDBElement {