sonata-project / SonataAdminBundle

src/Controller/CRUDController.php

Doc Comments +4 added lines, -2 removed lines

@@ -72,6 +72,7 @@ 
      *
      * @param string               $view       The view name
      * @param array<string, mixed> $parameters An array of parameters to pass to the view
+     * @param Response $response
      */
     public function renderWithExtraParams($view, array $parameters = [], ?Response $response = null): Response
     {
@@ -711,8 +712,8 @@ 
     /**
      * Compare history revisions of object.
      *
-     * @param int|string|null $baseRevision
-     * @param int|string|null $compareRevision
+     * @param null|integer $baseRevision
+     * @param null|integer $compareRevision
      *
      * @throws AccessDeniedException If access is not granted
      * @throws NotFoundHttpException If the object or revision does not exist or the audit reader is not available
@@ -1408,6 +1409,7 @@ 
 
     /**
      * Sets the admin form theme to form view. Used for compatibility between Symfony versions.
+     * @param string[] $theme
      */
     private function setFormTheme(FormView $formView, ?array $theme = null): void
     {

src/Translator/Extractor/JMSTranslatorBundle/AdminExtractor.php

Doc Comments +5 added lines

@@ -196,6 +196,11 @@
         return $id;
     }
 
+    /**
+     * @param string $id
+     * @param integer $number
+     * @param string $domain
+     */
     public function transChoice($id, $number, array $parameters = [], ?string $domain = null, ?string $locale = null)
     {
         $this->addMessage($id, $domain);

src/Admin/BaseFieldDescription.php

Doc Comments +9 added lines

@@ -131,6 +131,9 @@ 
      */
     private static $fieldGetters = [];
 
+    /**
+     * @param string $fieldName
+     */
     public function setFieldName(?string $fieldName): void
     {
         $this->fieldName = $fieldName;
@@ -141,6 +144,9 @@ 
         return $this->fieldName;
     }
 
+    /**
+     * @param string $name
+     */
     public function setName(?string $name): void
     {
         $this->name = $name;
@@ -270,6 +276,9 @@ 
         return null !== $this->associationAdmin;
     }
 
+    /**
+     * @param string $fieldName
+     */
     public function getFieldValue(?object $object, ?string $fieldName)
     {
         if ($this->isVirtual() || null === $object) {

src/Admin/FieldDescriptionInterface.php

Doc Comments +16 added lines

@@ -20,6 +20,7 @@ 
 {
     /**
      * set the field name.
+     * @return void
      */
     public function setFieldName(?string $fieldName): void;
 
@@ -32,6 +33,7 @@ 
 
     /**
      * Set the name.
+     * @return void
      */
     public function setName(?string $name): void;
 
@@ -55,6 +57,7 @@ 
      * Define an option, an option is has a name and a value.
      *
      * @param mixed $value
+     * @return void
      */
     public function setOption(string $name, $value): void;
 
@@ -66,6 +69,7 @@ 
      * Then the value are copied across to the related property value.
      *
      * @param array<string, mixed> $options
+     * @return void
      */
     public function setOptions(array $options): void;
 
@@ -78,6 +82,7 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @return void
      */
     public function setTemplate(string $template): void;
 
@@ -91,21 +96,25 @@ 
     /**
      * Sets the field type. The type is a mandatory field as it's used to select the correct template
      * or the logic associated to the current FieldDescription object.
+     * @return void
      */
     public function setType(?string $type): void;
 
     /**
      * Returns the type.
+     * @return string
      */
     public function getType(): ?string;
 
     /**
      * set the parent Admin (only used in nested admin).
+     * @return void
      */
     public function setParent(AdminInterface $parent);
 
     /**
      * Returns the parent Admin (only used in nested admin).
+     * @return AdminInterface|null
      */
     public function getParent(): ?AdminInterface;
 
@@ -121,6 +130,7 @@ 
 
     /**
      * Returns the related Target Entity.
+     * @return string
      */
     public function getTargetEntity(): ?string;
 
@@ -152,11 +162,13 @@ 
      * set the association admin instance (only used if the field is linked to an Admin).
      *
      * @param AdminInterface $associationAdmin the associated admin
+     * @return void
      */
     public function setAssociationAdmin(AdminInterface $associationAdmin);
 
     /**
      * Returns the associated Admin instance (only used if the field is linked to an Admin).
+     * @return AdminInterface
      */
     public function getAssociationAdmin(): ?AdminInterface;
 
@@ -174,6 +186,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -186,11 +199,13 @@ 
      * merge option values related to the provided option name.
      *
      * @throws \RuntimeException
+     * @return void
      */
     public function mergeOption(string $name, array $options = []): void;
 
     /**
      * merge options values.
+     * @return void
      */
     public function mergeOptions(array $options = []): void;
 
@@ -198,6 +213,7 @@ 
      * set the original mapping type (only used if the field is linked to an entity).
      *
      * @param string|int $mappingType
+     * @return void
      */
     public function setMappingType($mappingType);
 

src/Admin/AbstractAdmin.php

Doc Comments +12 added lines

@@ -957,6 +957,7 @@ 
 
     /**
      * NEXT_MAJOR: remove this method.
+     * @param string $subClass
      */
     public function addSubClass($subClass): void
     {
@@ -1088,6 +1089,9 @@ 
         return $this->routeGenerator->hasAdminRoute($this, $name);
     }
 
+    /**
+     * @param string $adminCode
+     */
     public function isCurrentRoute(string $name, ?string $adminCode = null): bool
     {
         if (!$this->hasRequest()) {
@@ -1342,6 +1346,9 @@ 
         return $this->baseControllerName;
     }
 
+    /**
+     * @param string $label
+     */
     public function setLabel(?string $label): void
     {
         $this->label = $label;
@@ -2126,6 +2133,9 @@ 
         return $this->managerType;
     }
 
+    /**
+     * @param string $type
+     */
     public function setManagerType(?string $type): void
     {
         $this->managerType = $type;
@@ -2579,6 +2589,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param boolean $isShown
      */
     final public function showMosaicButton($isShown): void
     {
@@ -2726,6 +2737,7 @@ 
      * NEXT_MAJOR: remove this method.
      *
      * @deprecated Use configureTabMenu instead
+     * @param string $action
      */
     protected function configureSideMenu(ItemInterface $menu, $action, ?AdminInterface $childAdmin = null): void
     {