first round of review

sonata-project · Aug 10, 2020 · bd85adf · bd85adf
1 parent 7baaa6e
commit bd85adf
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 3 deletions.
diff --git a/src/Admin/AbstractAdmin.php b/src/Admin/AbstractAdmin.php
@@ -1749,6 +1749,8 @@ public function isCurrentChild(): bool
 
     /**
      * Returns the current child admin instance.
+     *
+     * @return AdminInterface|null the current child admin instance
      */
     public function getCurrentChildAdmin(): ?AdminInterface
     {

diff --git a/src/Admin/AdminInterface.php b/src/Admin/AdminInterface.php
@@ -135,6 +135,9 @@ public function getSecurityInformation(): array;
 
     public function setParentFieldDescription(FieldDescriptionInterface $parentFieldDescription): void;
 
+    /**
+     * @throws \LogicException
+     */
     public function getParentFieldDescription(): FieldDescriptionInterface;
 
     /**

diff --git a/src/Datagrid/DatagridMapper.php b/src/Datagrid/DatagridMapper.php
@@ -118,15 +118,15 @@ final public function keys(): array
         return array_keys($this->datagrid->getFilters());
     }
 
-    public function remove(string $key): BaseMapper
+    public function remove(string $key): self
     {
         $this->admin->removeFilterFieldDescription($key);
         $this->datagrid->removeFilter($key);
 
         return $this;
     }
 
-    public function reorder(array $keys): BaseMapper
+    public function reorder(array $keys): self
     {
         $this->datagrid->reorderFilters($keys);
 

diff --git a/src/Mapper/BaseMapper.php b/src/Mapper/BaseMapper.php
@@ -51,7 +51,10 @@ abstract public function get(string $key);
 
     abstract public function has(string $key): bool;
 
-    abstract public function remove(string $key): self;
+    /**
+     * @return static
+     */
+    abstract public function remove(string $key);
 
     /**
      * Returns configured keys.
@@ -62,6 +65,8 @@ abstract public function keys(): array;
 
     /**
      * @param string[] $keys field names
+     *
+     * @return static
      */
     abstract public function reorder(array $keys): self;
 }