Merge pull request sitegeist#128 from sitegeist/feature/removeLocalFileImage

[FEATURE] Deprecate LocalFile/LocalImage, use Fal instead

Author: s2b

Classes/Domain/Model/File.php

@@ -79,7 +79,8 @@ public static function fromString(string $value): ?self
         try {
             return new RemoteFile($value);
         } catch (InvalidRemoteFileException $e) {
-            return new LocalFile($value);
+            $file = GeneralUtility::makeInstance(ResourceFactory::class)->retrieveFileOrFolderObject($value);
+            return ($file) ? new FalFile($file) : null;
         }
     }
 

Classes/Domain/Model/Image.php

@@ -52,7 +52,8 @@ public static function fromString(string $value): ?self
         try {
             return new RemoteImage($value);
         } catch (InvalidRemoteImageException $e) {
-            return new LocalImage($value);
+            $file = GeneralUtility::makeInstance(ResourceFactory::class)->retrieveFileOrFolderObject($value);
+            return ($file) ? new FalImage($file) : null;
         }
     }
 

Classes/Domain/Model/LocalFile.php

@@ -8,6 +8,7 @@
 
 /**
  * Data structure for a local file resource to be passed to a component
+ * @deprecated, use FalFile instead
  */
 class LocalFile extends File
 {

Classes/Domain/Model/LocalImage.php

@@ -8,6 +8,7 @@
 
 /**
  * Data structure for a local image resource to be passed to a component
+ * @deprecated, use FalImage instead
  */
 class LocalImage extends Image
 {

Classes/Domain/Model/RemoteImage.php

@@ -27,7 +27,7 @@ class RemoteImage extends Image
      * Creates an image object for a remote image resource
      *
      * @param string $uri
-     * @throws InvalidFilePathException
+     * @throws InvalidRemoteImageException
      */
     public function __construct(string $uri)
     {

Classes/Exception/InvalidFilePathException.php

@@ -2,6 +2,9 @@
 
 namespace SMS\FluidComponents\Exception;
 
+/**
+ * @deprecated, only used in deprecated LocalFile and LocalImage
+ */
 class InvalidFilePathException extends \Exception
 {
 }

Documentation/DataStructures.md

@@ -110,17 +110,15 @@ files from inside extensions or even external image urls. This is what the File/
 for images:
 
 * `SMS\FluidComponents\Domain\Model\Image` (alias: `Image`) is the base class of all image types as well as a factory
-* `SMS\FluidComponents\Domain\Model\LocalImage` wraps a local image resource, e. g. from an extension
 * `SMS\FluidComponents\Domain\Model\RemoteImage` wraps a remote image uri
-* `SMS\FluidComponents\Domain\Model\FalImage` wraps existing FAL objects, such as `File` and `FileReference`
+* `SMS\FluidComponents\Domain\Model\FalImage` wraps existing FAL objects and local image resources, such as `File` and `FileReference` or an image from an extension
 * `SMS\FluidComponents\Domain\Model\PlaceholderImage` generates a placeholder image via placeholder.com
 
 for files:
 
 * `SMS\FluidComponents\Domain\Model\File` (alias: `File`) is the base class of all file types as well as a factory
-* `SMS\FluidComponents\Domain\Model\LocalFile` wraps a local file, e. g. from an extension
 * `SMS\FluidComponents\Domain\Model\RemoteFile` wraps a remote file uri
-* `SMS\FluidComponents\Domain\Model\FalFile` wraps existing FAL objects, such as `File` and `FileReference`
+* `SMS\FluidComponents\Domain\Model\FalFile` wraps existing FAL objects and local files, such as `File` and `FileReference` or a file from an extension
 
 This is how it could look like in the `Atom.Image` component: