sonata-project / SonataAdminBundle

src/Security/Handler/SecurityHandlerInterface.php

Doc Comments +2 added lines

@@ -44,6 +44,7 @@ 
      * Create object security, fe. make the current user owner of the object.
      *
      * @param object $object
+     * @return void
      */
     public function createObjectSecurity(AdminInterface $admin, $object);
 
@@ -51,6 +52,7 @@ 
      * Remove object security.
      *
      * @param object $object
+     * @return void
      */
     public function deleteObjectSecurity(AdminInterface $admin, $object);
 }

src/Controller/CRUDController.php

Doc Comments +7 added lines, -2 removed lines

@@ -59,6 +59,9 @@ 
      */
     private $templateRegistry;
 
+    /**
+     * @param ContainerInterface $container
+     */
     public function setContainer(?ContainerInterface $container = null): void
     {
         $this->container = $container;
@@ -71,6 +74,7 @@ 
      *
      * @param string               $view       The view name
      * @param array<string, mixed> $parameters An array of parameters to pass to the view
+     * @param Response $response
      *
      * @return Response A Response instance
      */
@@ -713,8 +717,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
@@ -1410,6 +1414,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
     {

tests/Show/ShowMapperTest.php

Doc Comments +4 added lines

@@ -586,6 +586,10 @@
         $this->admin->setShowBuilder(new ShowBuilder());
     }
 
+    /**
+     * @param string $name
+     * @param string $label
+     */
     private function getFieldDescriptionMock(?string $name = null, ?string $label = null): BaseFieldDescription
     {
         $fieldDescription = $this->getMockForAbstractClass(BaseFieldDescription::class);

src/Twig/Extension/SonataAdminExtension.php

Doc Comments +6 added lines, -5 removed lines

@@ -182,7 +182,7 @@ 
     /**
      * render a view element.
      *
-     * @param object $object
+     * @param \stdClass $object
      *
      * @return string
      */
@@ -221,8 +221,8 @@ 
     /**
      * render a compared view element.
      *
-     * @param mixed $baseObject
-     * @param mixed $compareObject
+     * @param \stdClass $baseObject
+     * @param \stdClass $compareObject
      *
      * @return string
      */
@@ -343,7 +343,8 @@ 
     /**
      * Get the identifiers as a string that is safe to use in a url.
      *
-     * @param object $model
+     * @param \stdClass $model
+     * @param AdminInterface $admin
      *
      * @return string string representation of the id that is safe to use in a url
      */
@@ -365,7 +366,7 @@ 
     }
 
     /**
-     * @return string|bool
+     * @return string|false
      */
     public function getXEditableType($type)
     {

tests/Datagrid/ListMapperTest.php

Doc Comments +4 added lines

@@ -414,6 +414,10 @@
         );
     }
 
+    /**
+     * @param string $name
+     * @param string $label
+     */
     private function getFieldDescriptionMock(?string $name = null, ?string $label = null): BaseFieldDescription
     {
         $fieldDescription = $this->getMockForAbstractClass(BaseFieldDescription::class);

src/Admin/AbstractAdmin.php

Doc Comments +7 added lines

@@ -1236,6 +1236,9 @@ 
         return $this->baseControllerName;
     }
 
+    /**
+     * @param string $label
+     */
     public function setLabel(?string $label): void
     {
         $this->label = $label;
@@ -1877,6 +1880,9 @@ 
         return $this->managerType;
     }
 
+    /**
+     * @param string $type
+     */
     public function setManagerType(?string $type): void
     {
         $this->managerType = $type;
@@ -2311,6 +2317,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param boolean $isShown
      */
     final public function showMosaicButton($isShown): void
     {

Unused Use Statements -1 removed lines

@@ -45,7 +45,6 @@
 use Sonata\Form\Validator\Constraints\InlineConstraint;
 use Sonata\Form\Validator\ErrorElement;
 use Symfony\Component\Form\Extension\Core\Type\HiddenType;
-use Symfony\Component\Form\Form;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\Form\FormEvent;
 use Symfony\Component\Form\FormEvents;

src/Route/RouteCollection.php

Doc Comments +3 added lines

@@ -62,6 +62,9 @@
         $this->baseControllerName = $baseControllerName;
     }
 
+    /**
+     * @param string $pattern
+     */
     public function add(
         string $name,
         ?string $pattern = null,

tests/Fixtures/Admin/CommentAdmin.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
 
 class CommentAdmin extends AbstractAdmin
 {
+    /**
+     * @param string $label
+     */
     public function setClassnameLabel($label): void
     {
         $this->classnameLabel = $label;

src/Admin/FieldDescriptionInterface.php

Doc Comments +15 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,8 @@ 
 
     /**
      * Sets the template used to render the field.
+     * @param string $template
+     * @return void
      */
     public function setTemplate(?string $template): void;
 
@@ -91,16 +97,19 @@ 
     /**
      * 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);
 
@@ -123,6 +132,7 @@ 
 
     /**
      * Returns the related Target object model.
+     * @return string
      */
     public function getTargetModel(): ?string;
 
@@ -154,6 +164,7 @@ 
      * 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);
 
@@ -178,6 +189,7 @@ 
 
     /**
      * set the admin class linked to this FieldDescription.
+     * @return void
      */
     public function setAdmin(AdminInterface $admin);
 
@@ -192,11 +204,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;
 
@@ -204,6 +218,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);