[stacked 2] Move Import & Parameters DTO (LycheeOrg#2365)

RockyLucky · Apr 11, 2024 · e7b45ac · e7b45ac
1 parent a887a5f
commit e7b45ac
Show file tree

Hide file tree

Showing 14 changed files with 29 additions and 23 deletions.
diff --git a/app/Actions/Import/Exec.php b/app/Actions/Import/Exec.php
@@ -4,9 +4,9 @@
 
 use App\Actions\Album\Create as AlbumCreate;
 use App\Actions\Photo\Create as PhotoCreate;
-use App\Actions\Photo\Strategies\ImportMode;
 use App\DTO\BaseImportReport;
 use App\DTO\ImportEventReport;
+use App\DTO\ImportMode;
 use App\DTO\ImportProgressReport;
 use App\Exceptions\FileOperationException;
 use App\Exceptions\Handler;

diff --git a/app/Actions/Import/FromServer.php b/app/Actions/Import/FromServer.php
@@ -2,7 +2,7 @@
 
 namespace App\Actions\Import;
 
-use App\Actions\Photo\Strategies\ImportMode;
+use App\DTO\ImportMode;
 use App\Models\Album;
 use function Safe\ini_get;
 use Symfony\Component\HttpFoundation\StreamedResponse;

diff --git a/app/Actions/Import/FromUrl.php b/app/Actions/Import/FromUrl.php
@@ -3,7 +3,7 @@
 namespace App\Actions\Import;
 
 use App\Actions\Photo\Create;
-use App\Actions\Photo\Strategies\ImportMode;
+use App\DTO\ImportMode;
 use App\Exceptions\Handler;
 use App\Exceptions\MassImportException;
 use App\Image\Files\BaseMediaFile;

diff --git a/app/Actions/Photo/Create.php b/app/Actions/Photo/Create.php
@@ -5,12 +5,12 @@
 use App\Actions\Photo\Strategies\AddDuplicateStrategy;
 use App\Actions\Photo\Strategies\AddPhotoPartnerStrategy;
 use App\Actions\Photo\Strategies\AddStandaloneStrategy;
-use App\Actions\Photo\Strategies\AddStrategyParameters;
 use App\Actions\Photo\Strategies\AddVideoPartnerStrategy;
-use App\Actions\Photo\Strategies\ImportMode;
 use App\Actions\User\Notify;
 use App\Contracts\Exceptions\LycheeException;
 use App\Contracts\Models\AbstractAlbum;
+use App\DTO\ImportMode;
+use App\DTO\ImportParam;
 use App\Exceptions\ExternalComponentFailedException;
 use App\Exceptions\ExternalComponentMissingException;
 use App\Exceptions\Internal\IllegalOrderOfOperationException;
@@ -31,12 +31,12 @@
 
 class Create
 {
-	/** @var AddStrategyParameters the strategy parameters prepared and compiled by this class */
-	protected AddStrategyParameters $strategyParameters;
+	/** @var ImportParam the strategy parameters prepared and compiled by this class */
+	protected ImportParam $strategyParameters;
 
 	public function __construct(?ImportMode $importMode, int $intendedOwnerId)
 	{
-		$this->strategyParameters = new AddStrategyParameters($importMode, $intendedOwnerId);
+		$this->strategyParameters = new ImportParam($importMode, $intendedOwnerId);
 	}
 
 	/**
@@ -116,7 +116,7 @@ public function add(NativeLocalFile $sourceFile, ?AbstractAlbum $album, ?int $fi
 
 	/**
 	 * Extracts the meta-data of the source file and initializes
-	 * {@link AddStrategyParameters::$exifInfo} of {@link Create::$strategyParameters}.
+	 * {@link ImportParam::$exifInfo} of {@link Create::$strategyParameters}.
 	 *
 	 * @param NativeLocalFile $sourceFile           the source file
 	 * @param int             $fileLastModifiedTime the timestamp to use if there's no creation date in Exif

diff --git a/app/Actions/Photo/Strategies/AbstractAddStrategy.php b/app/Actions/Photo/Strategies/AbstractAddStrategy.php
@@ -2,6 +2,7 @@
 
 namespace App\Actions\Photo\Strategies;
 
+use App\DTO\ImportParam;
 use App\Exceptions\MediaFileOperationException;
 use App\Exceptions\ModelDBException;
 use App\Exceptions\UnauthenticatedException;
@@ -10,7 +11,7 @@
 abstract class AbstractAddStrategy
 {
 	protected function __construct(
-		protected AddStrategyParameters $parameters,
+		protected ImportParam $parameters,
 		protected Photo $photo
 	) {
 	}
@@ -25,8 +26,8 @@ abstract public function do(): Photo;
 
 	/**
 	 * Hydrates meta-info of the media file from the
-	 * {@link AddStrategyParameters::$exifInfo} attribute of the associated
-	 * {@link AddStrategyParameters} object into the associated {@link Photo}
+	 * {@link ImportParam::$exifInfo} attribute of the associated
+	 * {@link ImportParam} object into the associated {@link Photo}
 	 * object.
 	 *
 	 * Meta information is conditionally copied if and only if the target

diff --git a/app/Actions/Photo/Strategies/AddDuplicateStrategy.php b/app/Actions/Photo/Strategies/AddDuplicateStrategy.php
@@ -2,6 +2,7 @@
 
 namespace App\Actions\Photo\Strategies;
 
+use App\DTO\ImportParam;
 use App\Exceptions\ModelDBException;
 use App\Exceptions\PhotoResyncedException;
 use App\Exceptions\PhotoSkippedException;
@@ -11,7 +12,7 @@
 
 class AddDuplicateStrategy extends AbstractAddStrategy
 {
-	public function __construct(AddStrategyParameters $parameters, Photo $existing)
+	public function __construct(ImportParam $parameters, Photo $existing)
 	{
 		parent::__construct($parameters, $existing);
 	}

diff --git a/app/Actions/Photo/Strategies/AddPhotoPartnerStrategy.php b/app/Actions/Photo/Strategies/AddPhotoPartnerStrategy.php
@@ -3,6 +3,8 @@
 namespace App\Actions\Photo\Strategies;
 
 use App\Contracts\Exceptions\LycheeException;
+use App\DTO\ImportMode;
+use App\DTO\ImportParam;
 use App\Image\Files\NativeLocalFile;
 use App\Models\Photo;
 
@@ -21,7 +23,7 @@ class AddPhotoPartnerStrategy extends AddStandaloneStrategy
 {
 	protected Photo $existingVideo;
 
-	public function __construct(AddStrategyParameters $parameters, NativeLocalFile $photoSourceFile, Photo $existingVideo)
+	public function __construct(ImportParam $parameters, NativeLocalFile $photoSourceFile, Photo $existingVideo)
 	{
 		parent::__construct($parameters, $photoSourceFile);
 		$this->existingVideo = $existingVideo;
@@ -46,7 +48,7 @@ public function do(): Photo
 		// "steals away" the stored video file from the existing video entity
 		// and moves it to the correct destination of a live partner for the
 		// photo.
-		$parameters = new AddStrategyParameters(
+		$parameters = new ImportParam(
 			new ImportMode(deleteImported: true),
 			$this->parameters->intendedOwnerId
 		);

diff --git a/app/Actions/Photo/Strategies/AddStandaloneStrategy.php b/app/Actions/Photo/Strategies/AddStandaloneStrategy.php
@@ -9,6 +9,7 @@
 use App\Contracts\Models\AbstractSizeVariantNamingStrategy;
 use App\Contracts\Models\SizeVariantFactory;
 use App\DTO\ImageDimension;
+use App\DTO\ImportParam;
 use App\Enum\SizeVariantType;
 use App\Exceptions\ConfigurationException;
 use App\Exceptions\Handler;
@@ -34,7 +35,7 @@ class AddStandaloneStrategy extends AbstractAddStrategy
 	/**
 	 * @throws FrameworkException
 	 */
-	public function __construct(AddStrategyParameters $parameters, NativeLocalFile $sourceFile)
+	public function __construct(ImportParam $parameters, NativeLocalFile $sourceFile)
 	{
 		try {
 			parent::__construct($parameters, new Photo());

diff --git a/app/Actions/Photo/Strategies/AddVideoPartnerStrategy.php b/app/Actions/Photo/Strategies/AddVideoPartnerStrategy.php
@@ -4,6 +4,7 @@
 
 use App\Actions\Diagnostics\Pipes\Checks\BasicPermissionCheck;
 use App\Contracts\Models\AbstractSizeVariantNamingStrategy;
+use App\DTO\ImportParam;
 use App\Exceptions\ConfigurationException;
 use App\Exceptions\Handler;
 use App\Exceptions\Internal\LycheeAssertionError;
@@ -28,7 +29,7 @@ class AddVideoPartnerStrategy extends AbstractAddStrategy
 {
 	protected BaseMediaFile $videoSourceFile;
 
-	public function __construct(AddStrategyParameters $parameters, BaseMediaFile $videoSourceFile, Photo $existingPhoto)
+	public function __construct(ImportParam $parameters, BaseMediaFile $videoSourceFile, Photo $existingPhoto)
 	{
 		parent::__construct($parameters, $existingPhoto);
 		$this->videoSourceFile = $videoSourceFile;

diff --git a/app/Console/Commands/Sync.php b/app/Console/Commands/Sync.php
@@ -3,8 +3,8 @@
 namespace App\Console\Commands;
 
 use App\Actions\Import\Exec;
-use App\Actions\Photo\Strategies\ImportMode;
 use App\Contracts\Exceptions\ExternalLycheeException;
+use App\DTO\ImportMode;
 use App\Exceptions\ConfigurationKeyMissingException;
 use App\Exceptions\UnexpectedException;
 use App\Models\Album;

diff --git a/app/Actions/Photo/Strategies/ImportMode.php → app/DTO/ImportMode.php b/app/Actions/Photo/Strategies/ImportMode.php → app/DTO/ImportMode.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Actions\Photo\Strategies;
+namespace App\DTO;
 
 /**
  * Define import mode.

diff --git a/...hoto/Strategies/AddStrategyParameters.php → app/DTO/ImportParam.php b/...hoto/Strategies/AddStrategyParameters.php → app/DTO/ImportParam.php
@@ -1,11 +1,11 @@
 <?php
 
-namespace App\Actions\Photo\Strategies;
+namespace App\DTO;
 
 use App\Metadata\Extractor;
 use App\Models\Album;
 
-class AddStrategyParameters
+final class ImportParam
 {
 	public ImportMode $importMode;
 

diff --git a/app/Http/Requests/Import/ImportServerRequest.php b/app/Http/Requests/Import/ImportServerRequest.php
@@ -2,10 +2,10 @@
 
 namespace App\Http\Requests\Import;
 
-use App\Actions\Photo\Strategies\ImportMode;
 use App\Contracts\Http\Requests\HasAlbum;
 use App\Contracts\Http\Requests\RequestAttribute;
 use App\Contracts\Models\AbstractAlbum;
+use App\DTO\ImportMode;
 use App\Http\Requests\BaseApiRequest;
 use App\Http\Requests\Traits\HasAlbumTrait;
 use App\Http\RuleSets\Import\ImportServerRuleSet;

diff --git a/app/Jobs/ProcessImageJob.php b/app/Jobs/ProcessImageJob.php
@@ -3,8 +3,8 @@
 namespace App\Jobs;
 
 use App\Actions\Photo\Create;
-use App\Actions\Photo\Strategies\ImportMode;
 use App\Contracts\Models\AbstractAlbum;
+use App\DTO\ImportMode;
 use App\Enum\JobStatus;
 use App\Factories\AlbumFactory;
 use App\Image\Files\ProcessableJobFile;