Add missing typehint

sonata-project · Dec 21, 2020 · e919db5 · e919db5
1 parent 1c08c17
commit e919db5
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 6 deletions.
diff --git a/src/Admin/AdminInterface.php b/src/Admin/AdminInterface.php
@@ -74,7 +74,6 @@
  * @method void                            defineFormBuilder(FormBuilderInterface $formBuilder)
  *
  * @phpstan-template T of object
- * @phpstan-extends TaggedAdminInterface<T>
  * @phpstan-extends AccessRegistryInterface<T>
  * @phpstan-extends UrlGeneratorInterface<T>
  * @phpstan-extends LifecycleHookProviderInterface<T>

diff --git a/src/DependencyInjection/Admin/AbstractTaggedAdmin.php b/src/DependencyInjection/Admin/AbstractTaggedAdmin.php
@@ -32,7 +32,6 @@
 
 /**
  * @phpstan-template T of object
- * @phpstan-implements TaggedAdminInterface<T>
  */
 abstract class AbstractTaggedAdmin implements TaggedAdminInterface
 {
@@ -69,7 +68,7 @@ abstract class AbstractTaggedAdmin implements TaggedAdminInterface
     /**
      * @var array<string, array<string, string>>
      *
-     * @phpstan-var array{list: array{class: string}, mosaic: array{class: string}}
+     * @phpstan-var array{list: array{class: string}, mosaic?: array{class: string}}
      */
     protected $listModes = [
         'list' => ['class' => 'fa fa-list fa-fw'],
@@ -248,6 +247,8 @@ public function setLabel($label)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return string|null
      */
     public function getLabel()
     {
@@ -257,14 +258,16 @@ public function getLabel()
     final public function showMosaicButton($isShown)
     {
         if ($isShown) {
-            $this->listModes['mosaic'] = ['class' => static::MOSAIC_ICON_CLASS];
+            $this->listModes['mosaic'] = ['class' => self::MOSAIC_ICON_CLASS];
         } else {
             unset($this->listModes['mosaic']);
         }
     }
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return array<string, array<string, string>>
      */
     public function getListModes()
     {
@@ -299,6 +302,8 @@ public function setManagerType($type)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return string|null // NEXT_MAJOR: Remove null
      */
     public function getManagerType()
     {
@@ -372,6 +377,8 @@ public function setModelManager(ModelManagerInterface $modelManager)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return ModelManagerInterface|null // NEXT_MAJOR: Remove null
      */
     public function getModelManager()
     {
@@ -401,6 +408,8 @@ public function setDataSource(DataSourceInterface $dataSource)
 
     /**
      * NEXT_MAJOR: Change typehint for DataSourceInterface.
+     *
+     * @return DataSourceInterface|null // NEXT_MAJOR: Remove null
      */
     public function getDataSource(): ?DataSourceInterface
     {
@@ -430,6 +439,8 @@ public function setFormContractor(FormContractorInterface $formBuilder)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return FormContractorInterface|null // NEXT_MAJOR: Remove null
      */
     public function getFormContractor()
     {
@@ -459,6 +470,8 @@ public function setShowBuilder(ShowBuilderInterface $showBuilder)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return ShowBuilderInterface|null // NEXT_MAJOR: Remove null
      */
     public function getShowBuilder()
     {
@@ -488,6 +501,8 @@ public function setListBuilder(ListBuilderInterface $listBuilder)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return ListBuilderInterface|null // NEXT_MAJOR: Remove null
      */
     public function getListBuilder()
     {
@@ -517,6 +532,8 @@ public function setDatagridBuilder(DatagridBuilderInterface $datagridBuilder)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return DatagridBuilderInterface|null // NEXT_MAJOR: Remove null
      */
     public function getDatagridBuilder()
     {
@@ -546,6 +563,8 @@ public function setTranslator(TranslatorInterface $translator)
 
     /**
      * @final since sonata-admin/admin-bundle 3.83
+     *
+     * @return TranslatorInterface|null // NEXT_MAJOR: Remove null
      */
     public function getTranslator()
     {
@@ -575,6 +594,8 @@ public function setConfigurationPool(Pool $configurationPool)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return Pool|null // NEXT_MAJOR: Remove null
      */
     public function getConfigurationPool()
     {
@@ -606,6 +627,8 @@ public function setRouteGenerator(RouteGeneratorInterface $routeGenerator)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return RouteGeneratorInterface|null // NEXT_MAJOR: Remove null
      */
     public function getRouteGenerator()
     {
@@ -647,6 +670,8 @@ public function setValidator($validator)
      * NEXT_MAJOR: Remove this method.
      *
      * @deprecated since sonata-project/admin-bundle 3.83 and will be removed in 4.0
+     *
+     * @return ValidatorInterface|null // NEXT_MAJOR: Remove null
      */
     public function getValidator()
     {
@@ -668,6 +693,8 @@ public function setSecurityHandler(SecurityHandlerInterface $securityHandler)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return SecurityHandlerInterface|null // NEXT_MAJOR: Remove null
      */
     public function getSecurityHandler()
     {
@@ -697,6 +724,8 @@ public function setMenuFactory(FactoryInterface $menuFactory)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return FactoryInterface|null // NEXT_MAJOR: Remove null
      */
     public function getMenuFactory()
     {
@@ -726,6 +755,8 @@ public function setRouteBuilder(RouteBuilderInterface $routeBuilder)
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return RouteBuilderInterface|null // NEXT_MAJOR: Remove null
      */
     public function getRouteBuilder()
     {
@@ -755,6 +786,8 @@ public function setLabelTranslatorStrategy(LabelTranslatorStrategyInterface $lab
 
     /**
      * @final since sonata-admin/admin-bundle 3.84
+     *
+     * @return LabelTranslatorStrategyInterface|null // NEXT_MAJOR: Remove null
      */
     public function getLabelTranslatorStrategy()
     {

diff --git a/src/DependencyInjection/Admin/TaggedAdminInterface.php b/src/DependencyInjection/Admin/TaggedAdminInterface.php
@@ -41,8 +41,6 @@
  *     - The first and third argument are automatically injected by the AddDependencyCallsCompilerPass.
  *     - The second one is used as a reference of the Admin in the Pool, with the `setAdminClasses` call.
  *
- * @phpstan-template T of object
- *
  * @method void initialize()
  * @method void setLabel(?string $label)
  * @method void showMosaicButton(bool $isShown)