Add 'file/append' action

Core/Executor/FileExecutor.php

@@ -8,7 +8,7 @@
 class FileExecutor extends AbstractExecutor
 {
     protected $supportedStepTypes = array('file');
-    protected $supportedActions = array('load', 'save', 'copy', 'move', 'delete');
+    protected $supportedActions = array('load', 'save', 'copy', 'move', 'delete', 'append');
 
     /** @var PrefixBasedResolverInterface $referenceResolver */
     protected $referenceResolver;
@@ -93,6 +93,33 @@ protected function save($dsl, $context)
         return $return;
     }
 
+    /**
+     * @param array $dsl
+     * @param array $context
+     * @return int
+     * @throws \Exception
+     */
+    protected function append($dsl, $context)
+    {
+        if (!isset($dsl['file']) || !isset($dsl['body'])) {
+            throw new \Exception("Can not append to file: name or body missing");
+        }
+
+        if (is_string($dsl['body'])) {
+            $contents = $this->resolveReferencesInText($dsl['body']);
+        } else {
+            throw new \Exception("Can not append to file: body tag must be a string");
+        }
+
+        $fileName = $this->referenceResolver->resolveReference($dsl['file']);
+
+        $return = file_put_contents($fileName, $contents, FILE_APPEND);
+
+        $this->setReferences($fileName, $dsl);
+
+        return $return;
+    }
+
     /**
      * @param array $dsl
      * @param array $context

Resources/doc/DSL/Files.yml

@@ -26,6 +26,20 @@
             attribute: attributeId # An attribute to get the value of for the reference.
                                    # Supports: size, uid, gid, ctime, mtime, atime, body
 
+-
+    type: file
+    mode: append
+    file: xxx # string. Filename including path. References will be resolved
+    body: "file contents" # string. References will be replaced as long as they are within square brackets
+                          # eg. to save to a file the value of reference 'abc', write: body: "[reference:abc]"
+    # The list in references tells the manager to store specific values for later use by other steps in the current migration.
+    # NB: these are NEW VARIABLES THAT YOU ARE CREATING. They are not used in the current migration step!
+    references: # Optional
+        -
+            identifier: referenceId # A string used to identify the reference
+            attribute: attributeId # An attribute to get the value of for the reference.
+                                   # Supports: size, uid, gid, ctime, mtime, atime, body
+
 -
     type: file
     mode: delete

WHATSNEW.md

@@ -1,3 +1,9 @@
+Version 4.0 RC-4 (unreleased)
+=============================
+
+* Added 'append' action to 'file' executor
+
+
 Version 4.0 RC-3
 ================