Add some extra type checks on names (#351)

vlucas · Mar 6, 2019 · dbcc609 · dbcc609
1 parent e57f2fc
commit dbcc609
Show file tree

Hide file tree

Showing 4 changed files with 68 additions and 1 deletion.
diff --git a/src/Environment/AbstractVariables.php b/src/Environment/AbstractVariables.php
@@ -47,7 +47,7 @@ public function isImmutable()
      */
     public function has($name)
     {
-        return $this->get($name) !== null;
+        return is_string($name) && $this->get($name) !== null;
     }
 
     /**

diff --git a/src/Environment/DotenvVariables.php b/src/Environment/DotenvVariables.php
@@ -2,6 +2,8 @@
 
 namespace Dotenv\Environment;
 
+use InvalidArgumentException;
+
 /**
  * The default implementation of the environment variables interface.
  */
@@ -35,10 +37,16 @@ public function __construct(array $adapters, $immutable)
      *
      * @param string $name
      *
+     * @throws \InvalidArgumentException
+     *
      * @return string|null
      */
     public function get($name)
     {
+        if (!is_string($name)) {
+            throw new InvalidArgumentException('Expected name to be a string.');
+        }
+
         foreach ($this->adapters as $adapter) {
             $result = $adapter->get($name);
             if ($result->isDefined()) {
@@ -53,10 +61,16 @@ public function get($name)
      * @param string      $name
      * @param string|null $value
      *
+     * @throws \InvalidArgumentException
+     *
      * @return void
      */
     public function set($name, $value = null)
     {
+        if (!is_string($name)) {
+            throw new InvalidArgumentException('Expected name to be a string.');
+        }
+
         // Don't overwrite existing environment variables if we're immutable
         // Ruby's dotenv does this with `ENV[key] ||= value`.
         if ($this->isImmutable() && $this->get($name) !== null) {
@@ -73,10 +87,16 @@ public function set($name, $value = null)
      *
      * @param string $name
      *
+     * @throws \InvalidArgumentException
+     *
      * @return void
      */
     public function clear($name)
     {
+        if (!is_string($name)) {
+            throw new InvalidArgumentException('Expected name to be a string.');
+        }
+
         // Don't clear anything if we're immutable.
         if ($this->isImmutable()) {
             return;

diff --git a/src/Environment/VariablesInterface.php b/src/Environment/VariablesInterface.php
@@ -30,6 +30,8 @@ public function has($name);
      *
      * @param string $name
      *
+     * @throws \InvalidArgumentException
+     *
      * @return string|null
      */
     public function get($name);
@@ -40,6 +42,8 @@ public function get($name);
      * @param string      $name
      * @param string|null $value
      *
+     * @throws \InvalidArgumentException
+     *
      * @return void
      */
     public function set($name, $value = null);
@@ -49,6 +53,8 @@ public function set($name, $value = null);
      *
      * @param string $name
      *
+     * @throws \InvalidArgumentException
+     *
      * @return void
      */
     public function clear($name);

diff --git a/tests/Dotenv/EnvironmentVariablesTest.php b/tests/Dotenv/EnvironmentVariablesTest.php
@@ -25,13 +25,32 @@ public function testCheckingWhetherVariableExists()
         $this->assertFalse($envVars->has('NON_EXISTING_VARIABLE'));
     }
 
+    public function testCheckingHasWithBadType()
+    {
+        $envVars = $this->envFactory->create();
+
+        $this->assertFalse($envVars->has(123));
+        $this->assertFalse($envVars->has(null));
+    }
+
     public function testGettingVariableByName()
     {
         $envVars = $this->envFactory->create();
 
         $this->assertSame('bar', $envVars->get('FOO'));
     }
 
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Expected name to be a string.
+     */
+    public function testGettingBadVariable()
+    {
+        $envVars = $this->envFactory->create();
+
+        $envVars->get(null);
+    }
+
     public function testSettingVariable()
     {
         $envVars = $this->envFactory->create();
@@ -43,6 +62,17 @@ public function testSettingVariable()
         $this->assertSame('new', $envVars->get('FOO'));
     }
 
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Expected name to be a string.
+     */
+    public function testSettingBadVariable()
+    {
+        $envVars = $this->envFactory->create();
+
+        $envVars->set(null, 'foo');
+    }
+
     public function testClearingVariable()
     {
         $envVars = $this->envFactory->create();
@@ -52,6 +82,17 @@ public function testClearingVariable()
         $this->assertFalse($envVars->has('FOO'));
     }
 
+    /**
+     * @expectedException \InvalidArgumentException
+     * @expectedExceptionMessage Expected name to be a string.
+     */
+    public function testClearingBadVariable()
+    {
+        $envVars = $this->envFactory->create();
+
+        $envVars->clear(null);
+    }
+
     public function testCannotSetVariableOnImmutableInstance()
     {
         $envVars = $this->envFactory->createImmutable();