Protect the config array by allowing only valid configuration keys to be defined.

Author: na2axl

src/Annotations/Annotations.php

@@ -21,9 +21,10 @@
  */
 
 namespace ElementaryFramework\Annotations;
+use ElementaryFramework\Annotations\Exceptions\AnnotationException;
 
 /**
- * Thin, static class with shortcut methods for inspection of Annotations
+ * Thin, static class with shortcut methods for inspection of annotations
  *
  * Using this static wrapper is optional - if your application uses a service container
  * or a dependency injection container, you most likely want to configure an instance
@@ -34,29 +35,53 @@ abstract class Annotations
     /**
      * @var array Configuration for any public property of AnnotationManager.
      */
-    public static $config;
+    private static $_config;
 
     /**
      * @var AnnotationManager Singleton AnnotationManager instance
      */
-    private static $manager;
+    private static $_manager;
+
+    /**
+     * Sets a config value.
+     *
+     * @param string $key   The config key.
+     * @param mixed  $value The config value.
+     *
+     * @throws AnnotationException
+     */
+    public static function setConfig(string $key, $value)
+    {
+        switch ($key) {
+            case "autoload":
+            case "cache":
+            case "suffix":
+            case "namespace":
+            case "debug":
+                self::$_config[$key] = $value;
+                break;
+
+            default:
+                throw new AnnotationException("Invalid config key.");
+        }
+    }
 
     /**
      * @return AnnotationManager a singleton instance
      */
     public static function getManager()
     {
-        if (!isset(self::$manager)) {
-            self::$manager = new AnnotationManager;
+        if (!isset(self::$_manager)) {
+            self::$_manager = new AnnotationManager;
         }
 
-        if (\is_array(self::$config)) {
-            foreach (self::$config as $key => $value) {
-                self::$manager->$key = $value;
+        if (\is_array(self::$_config)) {
+            foreach (self::$_config as $key => $value) {
+                self::$_manager->$key = $value;
             }
         }
 
-        return self::$manager;
+        return self::$_manager;
     }
 
     /**
@@ -76,7 +101,7 @@ public static function getUsage(string $class): UsageAnnotation
     }
 
     /**
-     * Inspects class Annotations
+     * Inspects class annotations
      *
      * @see AnnotationManager::getClassAnnotations()
      *
@@ -93,7 +118,7 @@ public static function ofClass($class, string $type = null): array
     }
 
     /**
-     * Inspects method Annotations
+     * Inspects method annotations
      *
      * @see AnnotationManager::getMethodAnnotations()
      *

src/Annotations/UsageAnnotation.php

@@ -23,32 +23,32 @@
 namespace ElementaryFramework\Annotations;
 
 /**
- * This Annotation is mandatory, and must be applied to all Annotations.
+ * This Annotation is mandatory, and must be applied to all annotations.
  */
 class UsageAnnotation extends Annotation
 {
     /**
-     * @var boolean Set this to TRUE for Annotations that may be applied to classes.
+     * @var boolean Set this to TRUE for annotations that may be applied to classes.
      */
     public $class = false;
 
     /**
-     * @var boolean Set this to TRUE for Annotations that may be applied to properties.
+     * @var boolean Set this to TRUE for annotations that may be applied to properties.
      */
     public $property = false;
 
     /**
-     * @var boolean Set this to TRUE for Annotations that may be applied to methods.
+     * @var boolean Set this to TRUE for annotations that may be applied to methods.
      */
     public $method = false;
 
     /**
-     * @var boolean $multiple Set this to TRUE for Annotations that allow multiple instances on the same member.
+     * @var boolean $multiple Set this to TRUE for annotations that allow multiple instances on the same member.
      */
     public $multiple = false;
 
     /**
-     * @var boolean $inherited Set this to TRUE for Annotations that apply to members of child classes.
+     * @var boolean $inherited Set this to TRUE for annotations that apply to members of child classes.
      */
     public $inherited = false;
 }