Minor fixes

Sogl · Dec 16, 2021 · 0f85b83 · 0f85b83
1 parent 89acc59
commit 0f85b83
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 8 deletions.
diff --git a/system/src/Grav/Common/Flex/Types/Pages/PageObject.php b/system/src/Grav/Common/Flex/Types/Pages/PageObject.php
@@ -641,8 +641,7 @@ public function exists(): bool
         return $this->root ?: parent::exists();
     }
 
-    // TODO: Disabled because this slows down exception handling on missing Twig template files
-    /* *
+    /**
      * @return array
      * /
     public function __debugInfo(): array
@@ -654,7 +653,6 @@ public function __debugInfo(): array
             '_content:private' => $this->getRawContent()
         ];
     }
-   */
 
     /**
      * @param array $elements

diff --git a/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php b/system/src/Grav/Common/Page/Interfaces/PageContentInterface.php
@@ -11,6 +11,7 @@
 
 use Grav\Common\Data\Blueprint;
 use Grav\Common\Media\Interfaces\MediaCollectionInterface;
+use Grav\Common\Page\Header;
 
 /**
  * Methods currently implemented in Flex Page emulation layer.
@@ -21,7 +22,7 @@ interface PageContentInterface
      * Gets and Sets the header based on the YAML configuration at the top of the .md file
      *
      * @param  object|array|null $var a YAML object representing the configuration for the file
-     * @return object      the current YAML configuration
+     * @return \stdClass|Header      The current YAML configuration
      */
     public function header($var = null);
 

diff --git a/system/src/Grav/Common/Page/Page.php b/system/src/Grav/Common/Page/Page.php
@@ -388,7 +388,7 @@ public function frontmatter($var = null)
      * Gets and Sets the header based on the YAML configuration at the top of the .md file
      *
      * @param  object|array|null $var a YAML object representing the configuration for the file
-     * @return object      the current YAML configuration
+     * @return \stdClass      the current YAML configuration
      */
     public function header($var = null)
     {

diff --git a/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php b/system/src/Grav/Framework/Flex/Pages/Traits/PageContentTrait.php
@@ -100,6 +100,7 @@ public static function normalizeRoute($route): string
 
     /**
      * @inheritdoc
+     * @return Header
      */
     public function header($var = null)
     {

diff --git a/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php b/system/src/Grav/Framework/Flex/Traits/FlexMediaTrait.php
@@ -286,8 +286,7 @@ public function deleteMediaFile(string $filename): void
         $this->clearMediaCache();
     }
 
-    // TODO: Disabled because this slows down exception handling on missing Twig template files
-    /* *
+    /**
      * @return array
      * /
     #[\ReturnTypeWillChange]
@@ -297,7 +296,6 @@ public function __debugInfo()
                 'uploads:private' => $this->getUpdatedMedia()
             ];
     }
-    */
 
     /**
      * @param array $files

diff --git a/tests/phpstan/plugins.neon b/tests/phpstan/plugins.neon
@@ -38,6 +38,7 @@ parameters:
         - Grav\Common\GPM\Common\Package
         - Grav\Common\GPM\Local\Package
         - Grav\Common\GPM\Remote\Package
+        - Grav\Common\Page\Header
         - Grav\Common\Session
         - Gantry\Component\Config\Config
     dynamicConstantNames:
-Original file line number
+Diff line change
@@ Expand Up / @@ -100,6 +100,7 @@ public static function normalizeRoute($route): string @@
         /**
          * @inheritdoc
+         * @return Header
          */
         public function header($var = null)
         {
@@ Expand Down @@