#58 - Mark the classes not meant to be extended @final and the infrastructure classes @internal

CHANGELOG.md

@@ -2,6 +2,7 @@ Latest
 ------
 
 ### Changes
+* [#58](https://github.com/cleverage/flysystem-process-bundle/issues/58) Define the public API (Symfony BC promise, as [cleverage/process-bundle#279](https://github.com/cleverage/process-bundle/issues/279)): `FileFetchTask`, `ListContentTask`, `RemoveFileTask` and `CleverAgeFlysystemProcessBundle` are marked `@final since 3.3`, they will be `final` in 4.0: extending them triggers a deprecation with the Symfony `DebugClassLoader`. `CleverAgeFlysystemProcessExtension` is marked `@internal`.
 * [#57](https://github.com/cleverage/flysystem-process-bundle/issues/57) `CleverAgeFlysystemProcessExtension::findServices()` loads the service definition files with a glob pattern instead of a `Finder` (same files, as [cleverage/process-bundle#271](https://github.com/cleverage/process-bundle/issues/271)), `symfony/finder` is no longer required. Add tests.
 * [#55](https://github.com/cleverage/flysystem-process-bundle/issues/55) Use the PHP 8.3 to 8.5 functions through the Symfony polyfills ([cleverage/process-bundle#299](https://github.com/cleverage/process-bundle/issues/299)): require `symfony/polyfill-php83`, `symfony/polyfill-php84` and `symfony/polyfill-php85`. Configure Rector for the minimum PHP version (`withPhpVersion(PHP_82)` instead of `PHP_85`, `withPhpSets()` read from `composer.json` instead of the `php81` leftover, which also enables the polyfill rules; `UP_TO_PHP_82` set removed): no change proposed on the current code. Document the PHP version policy in CONTRIBUTING.
 * [#51](https://github.com/cleverage/flysystem-process-bundle/issues/51) Give a code to the tasks ([cleverage/process-bundle#91](https://github.com/cleverage/process-bundle/issues/91)): `flysystem_file_fetch`, `flysystem_list_content` and `flysystem_remove_file` (`task: flysystem_file_fetch`, with `cleverage/process-bundle` 5.4 or later, referencing them by `service` being deprecated there). The tasks have their class name as service id; fetching them directly from the service container is deprecated (`container.private`), they will be private in 4.0. The former ids `cleverage_flysystem_process.task.file_fetch` / `cleverage_flysystem_process.task.list_content` / `cleverage_flysystem_process.task.remove_file` are deprecated aliases, removed in 4.0. Update documentation, add tests.

src/CleverAgeFlysystemProcessBundle.php

@@ -15,6 +15,9 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
+/**
+ * @final since 3.3
+ */
 class CleverAgeFlysystemProcessBundle extends Bundle
 {
     #[\Override]

src/DependencyInjection/CleverAgeFlysystemProcessExtension.php

@@ -22,6 +22,8 @@
  * This is the class that loads and manages your bundle configuration.
  *
  * @see https://symfony.com/doc/current/bundles/extension.html
+ *
+ * @internal
  */
 class CleverAgeFlysystemProcessExtension extends Extension
 {

src/Task/FileFetchTask.php

@@ -24,6 +24,8 @@
 /**
  * Copy (or move) file from one filesystem to another, using Flysystem
  * Either get files using a file regexp, or take files from input.
+ *
+ * @final since 3.3
  */
 class FileFetchTask extends AbstractConfigurableTask implements IterableTaskInterface
 {
@@ -148,7 +150,7 @@ protected function findMatchingFiles(ProcessState $state): array
      * @throws \InvalidArgumentException
      * @throws FilesystemException
      */
-    protected function doFileCopy(ProcessState $state, string $filename, bool $removeSource): bool|string|null
+    protected function doFileCopy(ProcessState $state, string $filename, bool $removeSource): bool|string|null // @phpstan-ignore return.unusedType, return.unusedType (protected: narrowed when the class becomes final, in 4.0)
     {
         $buffer = $this->sourceFS->readStream($filename);
 

src/Task/ListContentTask.php

@@ -23,6 +23,8 @@
 
 /**
  * Iterate over the content of a filesystem.
+ *
+ * @final since 3.3
  */
 class ListContentTask extends AbstractConfigurableTask implements IterableTaskInterface
 {

src/Task/RemoveFileTask.php

@@ -23,6 +23,8 @@
 
 /**
  * Remove files from a filesystem.
+ *
+ * @final since 3.3
  */
 class RemoveFileTask extends AbstractConfigurableTask
 {