Merge pull request #121 from analogueorm/feature/add-cache-clear

Add ability to clear the EntityCache
analogueorm · Aug 4, 2016 · 64105d1 · 64105d1
2 parents 9105b9a + 5f5624b
commit 64105d1
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/src/System/EntityCache.php b/src/System/EntityCache.php
@@ -24,7 +24,7 @@ class EntityCache
 
     /**
      * Entity Map for the current Entity Type
-     * @var [type]
+     * @var \Analogue\ORM\EntityMap
      */
     protected $entityMap;
 
@@ -143,9 +143,9 @@ public function cacheLoadedRelationResult($parent, $relation, $results, Relation
     /**
      * Create a cachedRelationship instance which will hold related entity's hash and pivot attributes, if any.
      *
-     * @param               $parentKey
+     * @param  string       $parentKey
      * @param  string       $relation
-     * @param               $result
+     * @param  array        $result
      * @param  Relationship $relationship
      * @throws MappingException
      * @return CachedRelationship
@@ -295,7 +295,9 @@ protected function transform(Aggregate $aggregatedEntity)
     }
 
     /**
-     * @param                     $relation
+     * Get pivot attributes for a relation
+     * 
+     * @param  string             $relation
      * @param  InternallyMappable $entity
      * @return array
      */
@@ -315,4 +317,17 @@ protected function getPivotValues($relation, InternallyMappable $entity)
 
         return $values;
     }
+
+    /**
+     * Clear the entity Cache. Use with caution as it could result
+     * in impredictable behaviour if the cached entities are stored
+     * after the cache clear operation. 
+     * 
+     * @return void
+     */
+    public function clear()
+    {   
+        $this->cache = [];
+        $this->pivotAttributes = [];
+    }
 }