add a function insertIntoFile() (locate with an anchor and an offset)

Author: jetwaves

src/EditArrayInFileEditor.php

@@ -343,5 +343,41 @@ public static function endsWith($haystack, $needles)
         return false;
     }
 
+    /*
+     * Insert content (array of string or one string) into the selected file located by an anchor string and an offset value
+     *
+     * ATTENTION:  the EOL might be treated as a new line. So try avoid using offset value > 0
+     *
+     * */
+    public static function insertIntoFile($filename, $anchorString, $offset=0, $content)
+    {
+        if(!file_exists($filename)){
+            throw new \Exception('Target File '.$filename.' does not exists');
+        }
+        $fileLines = file($filename);
+        $resLines = [];
+        $foundAnchor = false;
+        foreach ($fileLines as $line) {
+            if(self::contains($line, $anchorString)){
+                $foundAnchor = true;
+                // decrease the offset value until 0 to locate the target line
+            } else {
+                if($foundAnchor){
+                    $offset = $offset - 1;
+                }
+            }
+            if($offset == 0 && $foundAnchor ){
+                if(is_array($content)){
+                    $resLines = array_merge($resLines, $content);
+                } else {
+                    $resLines[] = $content;
+                }
+            }
+            $resLines[] = $line;
+        }
+        $resLines = implode('',$resLines);
+        file_put_contents($filename, $resLines);
+    }
+
 
 }

src/Test/tt02_insertIntoFile.php

@@ -0,0 +1,31 @@
+<?php
+namespace Jetwaves\EditArrayInFile\Test;
+
+
+require('../EditArrayInFileEditor.php');
+use Jetwaves\EditArrayInFile\Editor as Editor;
+
+
+//###When the target is an array in the value of a Key-Value pair)
+// ======= exemple of insert one line into [aliases] array in file [app.php]
+//$editor = new Editor('../testSource/app.php');
+
+try {
+    $dataToInsert = "use Illuminate\Support\Facades\Schema;".PHP_EOL;
+    Editor::insertIntoFile('../testSource/AppServiceProvider.php',
+        "use Illuminate\Support\ServiceProvider;", 1, $dataToInsert);
+
+    $dataToInsert = "        Schema::defaultStringLength(191);".PHP_EOL;
+    Editor::insertIntoFile('../testSource/AppServiceProvider.php',
+        "public function register()", 3, $dataToInsert);
+
+} catch (\Exception $e) {
+    echo ''.__FILE__.'->'.__method__.'() line:'.__line__.PHP_EOL.'   $e->getMessage()  = '.print_r($e->getMessage(), true).PHP_EOL;
+    echo ''.__FILE__.'->'.__method__.'() line:'.__line__.PHP_EOL.'   $e->trace  = '.print_r($e->getTraceAsString(), true).PHP_EOL;
+}
+
+
+
+
+
+

src/testSource/AppServiceProvider.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace App\Providers;
+
+use Illuminate\Support\ServiceProvider;
+//1
+//2
+//3
+
+
+class AppServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        //a
+        //b
+        //1
+        //2
+        //3
+
+    }
+}