Added FormatterInterface::getDefaultFileExtension()

getgrav · Aug 3, 2018 · 34fa50f · 34fa50f
1 parent ca3cf2e
commit 34fa50f
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,7 @@
 
 1. [](#new)
     * Added `Uri::method()` to get current HTTP method (GET/POST etc)
-    * Added `FormatterInterface::getSupportedFileExtensions()` method, deprecated `getFileExtension()`
+    * `FormatterInterface`: Added `getSupportedFileExtensions()` and `getDefaultFileExtension()` methods
 
 # v1.5.0-rc.1
 ## 07/31/2018

diff --git a/system/src/Grav/Framework/File/Formatter/FormatterInterface.php b/system/src/Grav/Framework/File/Formatter/FormatterInterface.php
@@ -10,6 +10,15 @@
 
 interface FormatterInterface
 {
+    /**
+     * Get default file extension from current formatter (with dot).
+     *
+     * Default file extension is the first defined extension.
+     *
+     * @return string File extension (can be empty).
+     */
+    public function getDefaultFileExtension();
+
     /**
      * Get file extensions supported by current formatter (with dot).
      *

diff --git a/system/src/Grav/Framework/File/Formatter/IniFormatter.php b/system/src/Grav/Framework/File/Formatter/IniFormatter.php
@@ -25,12 +25,21 @@ public function __construct(array $config = [])
     }
 
     /**
-     * @deprecated
-     * @internal
+     * @deprecated 1.5 Use $formatter->getDefaultFileExtension() instead.
      */
     public function getFileExtension()
     {
-        return $this->getSupportedFileExtensions()[0];
+        return $this->getDefaultFileExtension();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultFileExtension()
+    {
+        $extensions = $this->getSupportedFileExtensions();
+
+        return (string) reset($extensions);
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/JsonFormatter.php b/system/src/Grav/Framework/File/Formatter/JsonFormatter.php
@@ -23,12 +23,21 @@ public function __construct(array $config = [])
     }
 
     /**
-     * @deprecated
-     * @internal
+     * @deprecated 1.5 Use $formatter->getDefaultFileExtension() instead.
      */
     public function getFileExtension()
     {
-        return $this->getSupportedFileExtensions()[0];
+        return $this->getDefaultFileExtension();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultFileExtension()
+    {
+        $extensions = $this->getSupportedFileExtensions();
+
+        return (string) reset($extensions);
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php b/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php
@@ -29,12 +29,21 @@ public function __construct(array $config = [], FormatterInterface $headerFormat
     }
 
     /**
-     * @deprecated
-     * @internal
+     * @deprecated 1.5 Use $formatter->getDefaultFileExtension() instead.
      */
     public function getFileExtension()
     {
-        return $this->getSupportedFileExtensions()[0];
+        return $this->getDefaultFileExtension();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultFileExtension()
+    {
+        $extensions = $this->getSupportedFileExtensions();
+
+        return (string) reset($extensions);
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php b/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php
@@ -25,12 +25,21 @@ public function __construct(array $config = [])
     }
 
     /**
-     * @deprecated
-     * @internal
+     * @deprecated 1.5 Use $formatter->getDefaultFileExtension() instead.
      */
     public function getFileExtension()
     {
-        return $this->getSupportedFileExtensions()[0];
+        return $this->getDefaultFileExtension();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultFileExtension()
+    {
+        $extensions = $this->getSupportedFileExtensions();
+
+        return (string) reset($extensions);
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/YamlFormatter.php b/system/src/Grav/Framework/File/Formatter/YamlFormatter.php
@@ -30,12 +30,21 @@ public function __construct(array $config = [])
     }
 
     /**
-     * @deprecated
-     * @internal
+     * @deprecated 1.5 Use $formatter->getDefaultFileExtension() instead.
      */
     public function getFileExtension()
     {
-        return $this->getSupportedFileExtensions()[0];
+        return $this->getDefaultFileExtension();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getDefaultFileExtension()
+    {
+        $extensions = $this->getSupportedFileExtensions();
+
+        return (string) reset($extensions);
     }
 
     /**