Extend configuration for renaming files functionality

Author: wagnert

src/ConfigurationInterface.php

@@ -428,10 +428,42 @@ public function getSubjects(array $filters = array());
      */
     public function getMoveFilesPrefix();
 
+    /**
+     * Set's the first subject of the actual import with a prefix defined.
+     *
+     * @param \TechDivision\Import\Configuration\SubjectConfigurationInterface $firstPrefixedSubject The subject configuration
+     *
+     * @return void
+     */
+    public function setFirstPrefixedSubject(SubjectConfigurationInterface $firstPrefixedSubject);
+
+    /**
+     * Return's the first subject of the actual import with a prefix defined.
+     *
+     * @return \TechDivision\Import\Configuration\SubjectConfigurationInterface|null The subject configuration
+     */
+    public function getFirstPrefixedSubject();
+
     /**
      * Get the definition from an empty value
      *
      * @return string A string with constant for empty attribute value
      */
     public function getEmptyAttributeValueConstant();
+
+    /**
+     * Sets the explict name of a file that has to be imported.
+     *
+     * @param string $filename The explicit filename
+     *
+     * @return void
+     */
+    public function setFilename($filename);
+
+    /**
+     * Load the explicit name of the file that has to be imported.
+     *
+     * @return string The explicit filename
+     */
+    public function getFilename();
 }

src/Subject/FileResolverConfigurationInterface.php

@@ -6,7 +6,7 @@
  * PHP version 7
  *
  * @author    Tim Wagner <[email protected]>
- * @copyright 2020 TechDivision GmbH <[email protected]>
+ * @copyright 2021 TechDivision GmbH <[email protected]>
  * @license   https://opensource.org/licenses/MIT
  * @link      https://github.com/techdivision/import-configuration
  * @link      http://www.techdivision.com
@@ -18,27 +18,69 @@
  * The interface for a file resolver's configuration.
  *
  * @author    Tim Wagner <[email protected]>
- * @copyright 2020 TechDivision GmbH <[email protected]>
+ * @copyright 2021 TechDivision GmbH <[email protected]>
  * @license   https://opensource.org/licenses/MIT
  * @link      https://github.com/techdivision/import-configuration
  * @link      http://www.techdivision.com
  */
 interface FileResolverConfigurationInterface
 {
 
+   /**
+    * The default prefix sequence of the import files.
+    *
+    * @var string
+    */
+    const DEFAULT_PREFIX = '.*';
+
+    /**
+     * The default filename sequence of the import files.
+     *
+     * @var string
+     */
+    const DEFAULT_FILENAME = '.*';
+
+    /**
+     * The counter sequence of the import files.
+     *
+     * @var string
+     */
+    const DEFAULT_COUNTER = '\d+';
+
+    /**
+     * The file suffix for import files.
+     *
+     * @var string
+     */
+    const DEFAULT_SUFFIX = 'csv';
+
+    /**
+     * The file suffix for OK file.
+     *
+     * @var string
+     */
+    const DEFAULT_OK_FILE_SUFFIX = 'ok';
+
+    /**
+     * The separator char for the elements of the file.
+     *
+     * @var string
+     */
+    const DEFAULT_ELEMENT_SEPARATOR = '_';
+
     /**
      * Returns the file resolver's unique DI identifier.
      *
      * @return string The file resolver's unique DI identifier
      */
-    public function getId();
+    public function getId() : string;
 
     /**
      * Returns the prefix/meta sequence for the import files.
      *
      * @return string The prefix
      */
-    public function getPrefix();
+    public function getPrefix() : string;
 
     /**
      * Query's whether or not a custom prefix has been configured for the
@@ -48,14 +90,24 @@ public function getPrefix();
      *
      * @return boolean TRUE if the file resolver has a custom prefix, else FALSE
      */
-    public function hasPrefix($defaultPrefix = '.*');
+    public function hasPrefix($defaultPrefix = FileResolverConfigurationInterface::DEFAULT_PREFIX) : bool;
 
     /**
      * Returns the filename/meta sequence of the import files.
      *
      * @return string The suffix
      */
-    public function getFilename();
+    public function getFilename() : string;
+
+    /**
+     * Query's whether or not a custom filename has been configured for the
+     * file resolver.
+     *
+     * @param string $defaultFilename The default filename to match against
+     *
+     * @return boolean TRUE if the file resolver has a custom filename, else FALSE
+     */
+    public function hasFilename($defaultFilename = FileResolverConfigurationInterface::DEFAULT_FILENAME);
 
     /**
      * Returns the counter/meta sequence of the import files.
@@ -64,31 +116,50 @@ public function getFilename();
      */
     public function getCounter();
 
+    /**
+     * Query's whether or not a custom counter has been configured for the
+     * file resolver.
+     *
+     * @param string $defaultCounter The default counter to match against
+     *
+     * @return boolean TRUE if the file resolver has a custom counter, else FALSE
+     */
+    public function hasCounter($defaultCounter = FileResolverConfigurationInterface::DEFAULT_COUNTER);
+
     /**
      * Returns the suffix for the import files.
      *
      * @return string The suffix
      */
-    public function getSuffix();
+    public function getSuffix() : string;
 
     /**
      * Return's the suffix for the OK file.
      *
      * @return string The OK file suffix
      */
-    public function getOkFileSuffix();
+    public function getOkFileSuffix() : string;
 
     /**
      * Returns the delement separator char.
      *
      *  @return string The element separator char
      */
-    public function getElementSeparator();
+    public function getElementSeparator() : string;
 
     /**
      * Returns the elements the filenames consists of.
      *
      * @return array The array with the filename elements
      */
-    public function getPatternElements();
+    public function getPatternElements() : array;
+
+    /**
+     * Set's the the elements the filenames consists of.
+     *
+     * @param array $patternElements The array with the filename elements
+     *
+     * @return void
+     */
+    public function setPatternElements(array $patternElements) : void;
 }