Merge pull request #306 from GrahamCampbell/refactoring

Broken up the loader, and made load() return the actual environment variables

Author: GrahamCampbell

src/Dotenv.php

@@ -10,7 +10,7 @@
  * This is the dotenv class.
  *
  * It's responsible for loading a `.env` file in the given directory and
- * setting the environment vars.
+ * setting the environment variables.
  */
 class Dotenv
 {
@@ -53,7 +53,6 @@ public static function create($path, $file = null, FactoryInterface $envFactory
         return new self($loader);
     }
 
-
     /**
      * Returns the full path to the file.
      *
@@ -76,17 +75,19 @@ private static function getFilePath($path, $file)
      *
      * @throws \Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return string[]
      */
     public function load()
     {
         return $this->loadData();
     }
 
     /**
-     * Load environment file in given directory, suppress InvalidPathException.
+     * Load environment file in given directory, silently failing if it doesn't exist.
+     *
+     * @throws \Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return string[]
      */
     public function safeLoad()
     {
@@ -103,7 +104,7 @@ public function safeLoad()
      *
      * @throws \Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return string[]
      */
     public function overload()
     {
@@ -117,7 +118,7 @@ public function overload()
      *
      * @throws \Dotenv\Exception\InvalidPathException|\Dotenv\Exception\InvalidFileException
      *
-     * @return array
+     * @return string[]
      */
     protected function loadData($overload = false)
     {

src/Lines.php

@@ -0,0 +1,111 @@
+<?php
+
+namespace Dotenv;
+
+class Lines
+{
+    /**
+     * Process the array of lines of environment variables.
+     *
+     * This will produce an array of entries, one per variable.
+     *
+     * @param string[] $lines
+     *
+     * @return string[]
+     */
+    public static function process(array $lines)
+    {
+        $output = [];
+        $multiline = false;
+        $multilineBuffer = [];
+
+        foreach ($lines as $line) {
+            list($multiline, $line, $multilineBuffer) = self::multilineProcess($multiline, $line, $multilineBuffer);
+
+            if (!$multiline && !self::isComment($line) && self::looksLikeSetter($line)) {
+                $output[] = $line;
+            }
+        }
+
+        return $output;
+    }
+
+    /**
+     * Used to make all multiline variable process.
+     *
+     * @param bool     $multiline
+     * @param string   $line
+     * @param string[] $buffer
+     *
+     * @return string[]
+     */
+    private static function multilineProcess($multiline, $line, array $buffer)
+    {
+        // check if $line can be multiline variable
+        if (self::looksLikeMultilineStart($line)) {
+            $multiline = true;
+        }
+
+        if ($multiline) {
+            array_push($buffer, $line);
+
+            if (self::looksLikeMultilineStop($line)) {
+                $multiline = false;
+                $line = implode("\n", $buffer);
+                $buffer = [];
+            }
+        }
+
+        return [$multiline, $line, $buffer];
+    }
+
+    /**
+     * Determine if the given line can be the start of a multiline variable.
+     *
+     * @param string $line
+     *
+     * @return bool
+     */
+    private static function looksLikeMultilineStart($line)
+    {
+        return strpos($line, '="') !== false && substr_count($line, '"') === 1;
+    }
+
+    /**
+     * Determine if the given line can be the start of a multiline variable.
+     *
+     * @param string $line
+     *
+     * @return bool
+     */
+    private static function looksLikeMultilineStop($line)
+    {
+        return strpos($line, '"') !== false && substr_count($line, '="') === 0;
+    }
+
+    /**
+     * Determine if the line in the file is a comment, e.g. begins with a #.
+     *
+     * @param string $line
+     *
+     * @return bool
+     */
+    private static function isComment($line)
+    {
+        $line = ltrim($line);
+
+        return isset($line[0]) && $line[0] === '#';
+    }
+
+    /**
+     * Determine if the given line looks like it's setting a variable.
+     *
+     * @param string $line
+     *
+     * @return bool
+     */
+    private static function looksLikeSetter($line)
+    {
+        return strpos($line, '=') !== false;
+    }
+}