Added FormatterInterface::getSupportedFileExtensions() method, depr…

…ecated `getFileExtension()`
getgrav · Aug 3, 2018 · ca3cf2e · ca3cf2e
1 parent 76fb113
commit ca3cf2e
Show file tree

Hide file tree

Showing 7 changed files with 59 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 
 1. [](#new)
     * Added `Uri::method()` to get current HTTP method (GET/POST etc)
+    * Added `FormatterInterface::getSupportedFileExtensions()` method, deprecated `getFileExtension()`
 
 # 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
@@ -11,11 +11,11 @@
 interface FormatterInterface
 {
     /**
-     * Get file extension with dot.
+     * Get file extensions supported by current formatter (with dot).
      *
-     * @return string
+     * @return string[]
      */
-    public function getFileExtension();
+    public function getSupportedFileExtensions();
 
     /**
      * Encode data into a string.

diff --git a/system/src/Grav/Framework/File/Formatter/IniFormatter.php b/system/src/Grav/Framework/File/Formatter/IniFormatter.php
@@ -25,11 +25,20 @@ public function __construct(array $config = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated
+     * @internal
      */
     public function getFileExtension()
     {
-        return $this->config['file_extension'];
+        return $this->getSupportedFileExtensions()[0];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSupportedFileExtensions()
+    {
+        return (array) $this->config['file_extension'];
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/JsonFormatter.php b/system/src/Grav/Framework/File/Formatter/JsonFormatter.php
@@ -23,11 +23,20 @@ public function __construct(array $config = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated
+     * @internal
      */
     public function getFileExtension()
     {
-        return $this->config['file_extension'];
+        return $this->getSupportedFileExtensions()[0];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSupportedFileExtensions()
+    {
+        return (array) $this->config['file_extension'];
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php b/system/src/Grav/Framework/File/Formatter/MarkdownFormatter.php
@@ -29,11 +29,20 @@ public function __construct(array $config = [], FormatterInterface $headerFormat
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated
+     * @internal
      */
     public function getFileExtension()
     {
-        return $this->config['file_extension'];
+        return $this->getSupportedFileExtensions()[0];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSupportedFileExtensions()
+    {
+        return (array) $this->config['file_extension'];
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php b/system/src/Grav/Framework/File/Formatter/SerializeFormatter.php
@@ -25,11 +25,20 @@ public function __construct(array $config = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated
+     * @internal
      */
     public function getFileExtension()
     {
-        return $this->config['file_extension'];
+        return $this->getSupportedFileExtensions()[0];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSupportedFileExtensions()
+    {
+        return (array) $this->config['file_extension'];
     }
 
     /**

diff --git a/system/src/Grav/Framework/File/Formatter/YamlFormatter.php b/system/src/Grav/Framework/File/Formatter/YamlFormatter.php
@@ -30,11 +30,20 @@ public function __construct(array $config = [])
     }
 
     /**
-     * {@inheritdoc}
+     * @deprecated
+     * @internal
      */
     public function getFileExtension()
     {
-        return $this->config['file_extension'];
+        return $this->getSupportedFileExtensions()[0];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getSupportedFileExtensions()
+    {
+        return (array) $this->config['file_extension'];
     }
 
     /**