Add get/set functions

Author: K-Adam

src/EnvFile.php

@@ -4,6 +4,7 @@
 
 use EnvEditor\EnvFile\Visitor;
 use EnvEditor\EnvFile\EOLType;
+use EnvEditor\EnvFile\Block\Variable as VariableBlock;
 
 class EnvFile {
 
@@ -23,6 +24,66 @@ public function visitBlocks(Visitor $visitor) {
     }
   }
 
+  /**
+   * @return VariableBlock[]
+   */
+  public function getVariableBlocks(): array {
+    return array_values(array_filter($this->blocks, function($block){
+      return $block instanceof \EnvEditor\EnvFile\Block\Variable;
+    }));
+  }
+
+  public function findVariable(string $key): ?VariableBlock {
+    foreach($this->getVariableBlocks() as $block) {
+      if($block->key == $key) {
+        return $block;
+      }
+    }
+
+    return null;
+  }
+
+  public function putVariable(VariableBlock $variable) {
+    foreach($this->blocks as $i => $block) {
+
+      if(!$block instanceof \EnvEditor\EnvFile\Block\Variable) continue;
+
+      if($block->key->content == $variable->key->content) {
+        $this->blocks[$i] = $variable;
+        return;
+      }
+    }
+
+    $this->blocks[] = $variable;
+  }
+
+  public function removeVariableKey(string $key): ?VariableBlock {
+    $variable = $this->findVariable($key);
+    if(!$variable) return null;
+
+    $index = array_search($variable, $this->blocks);
+    array_splice($this->blocks, $index, 1);
+    return $variable;
+  }
+
+  public function getValue(string $key): string {
+    $variable = $this->findVariable($key);
+
+    return $variable ? $variable->value->content : "";
+  }
+
+  public function setValue(string $key, string $content) {
+    $variable = $this->findVariable($key);
+    if(!$variable) {
+      $variable = new VariableBlock();
+      $variable->key->content = $key;
+
+      $this->blocks[] = $variable;
+    }
+
+    $variable->value->setContent($content);
+  }
+
   // Utility methods
 
   public static function loadFrom(string $path): EnvFile {
@@ -39,4 +100,7 @@ public function saveTo(string $path): void {
     file_put_contents($path, $content);
   }
 
+  // Private methods
+
+
 }

src/EnvFile/Block/Variable.php

@@ -15,9 +15,9 @@ class Variable extends Block {
   /** @var Value */
   public $value;
 
-  function __construct() {
-    $this->key = new Key();
-    $this->value = new Value();
+  function __construct(Key $key = null, Value $value = null) {
+    $this->key = $key ?? new Key();
+    $this->value = $value ?? new Value();
   }
 
   public function visit(Visitor $visitor) {

src/EnvFile/Block/Variable/Value.php

@@ -12,14 +12,23 @@ class Value {
   /** @var string */
   public $quote="";
 
-  function __construct($content = "") {
-    $this->content = $content;
+  function __construct(string $content = "") {
+    $this->setContent($content);
   }
 
   public function __toString() {
     return $this->content;
   }
 
+  /** Adds quotes if necessary */
+  public function setContent(string $content) {
+    $this->content = $content;
+
+    if(preg_match('/\s/s', $content)) {
+      $this->quote = '"';
+    }
+  }
+
   public function getContentWithQuotes(): string {
     return "{$this->quote}{$this->content}{$this->quote}";
   }

tests/Unit/EnvFileTest.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Tests\Unit;
+
+use Tests\TestCase;
+
+use EnvEditor\EnvFile;
+use EnvEditor\EnvFile\Block\Variable as VariableBlock;
+use EnvEditor\EnvFile\Block\Variable\Key;
+use EnvEditor\EnvFile\Block\Variable\Value;
+
+class EnvFileTest extends TestCase {
+
+  public function testFindVariable() {
+
+    $file = new EnvFile();
+
+    $v1 = new VariableBlock(new Key("A"), new Value("B"));
+    $v2 = new VariableBlock(new Key("C"), new Value("D"));
+
+    $file->blocks = [$v1, $v2];
+
+    $this->assertEquals($v1, $file->findVariable("A"));
+    $this->assertEquals($v2, $file->findVariable("C"));
+    $this->assertEquals(null, $file->findVariable("X"));
+
+  }
+
+  /**
+   * @depends testFindVariable
+   */
+  public function testPutVariable() {
+
+    $file = new EnvFile();
+
+    $v1 = new VariableBlock(new Key("A"), new Value("B"));
+    $file->putVariable($v1);
+    $this->assertEquals($v1, $file->findVariable("A"));
+
+    $v2 = new VariableBlock(new Key("A"), new Value("C"));
+    $file->putVariable($v2);
+    $this->assertEquals($v2, $file->findVariable("A"));
+    $this->assertEquals(1, count($file->blocks));
+
+  }
+
+  /**
+   * @depends testFindVariable
+   */
+  public function testRemoveVariable() {
+
+    $file = new EnvFile();
+
+    $v1 = new VariableBlock(new Key("A"), new Value("B"));
+    $v2 = new VariableBlock(new Key("C"), new Value("D"));
+
+    $file->blocks = [$v1, $v2];
+
+    $file->removeVariableKey("A");
+
+    $this->assertEquals(null, $file->findVariable("A"));
+    $this->assertEquals($v2, $file->findVariable("C"));
+    $this->assertEquals(1, count($file->blocks));
+
+  }
+
+  /**
+   * @depends testFindVariable
+   */
+  public function testGetValue() {
+
+    $file = new EnvFile();
+
+    $v1 = new VariableBlock(new Key("A"), new Value("B"));
+    $v2 = new VariableBlock(new Key("C"), new Value("D"));
+
+    $file->blocks = [$v1, $v2];
+
+    $this->assertEquals("D", $file->getValue("C"));
+    $this->assertEquals("", $file->getValue("X"));
+
+  }
+
+  /**
+   * @depends testPutVariable
+   */
+  public function testSetValue() {
+
+    $file = new EnvFile();
+
+    $file->setValue("A", "B");
+    $this->assertEquals("B", $file->getValue("A"));
+    $file->setValue("A", "C");
+    $this->assertEquals("C", $file->getValue("A"));
+
+  }
+
+  /**
+   * @depends testSetValue
+   */
+  public function testSetValueQuoted() {
+
+    $file = new EnvFile();
+
+    $file->setValue("A", "foo bar");
+    $v1 = $file->findVariable("A");
+    $this->assertNotEquals("", $v1->value->quote);
+
+    $file->setValue("B", "foo\nbar");
+    $v2 = $file->findVariable("B");
+    $this->assertEquals('"', $v2->value->quote);
+
+  }
+}