AuditController::listAuditsAction() now includes disabled entities (#58)

DamienHarper · Apr 14, 2019 · 54f364f · 54f364f
1 parent 2e2ef20
commit 54f364f
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 2 deletions.
diff --git a/src/DoctrineAuditBundle/AuditConfiguration.php b/src/DoctrineAuditBundle/AuditConfiguration.php
@@ -72,6 +72,26 @@ public function setEntities(array $entities): void
         $this->entities = $entities;
     }
 
+    /**
+     * Returns true if $entity is audited.
+     *
+     * @param object|string $entity
+     *
+     * @return bool
+     */
+    public function isAuditable($entity): bool
+    {
+        $class = DoctrineHelper::getRealClass($entity);
+
+        // is $entity part of audited entities?
+        if (!array_key_exists($class, $this->entities)) {
+            // no => $entity is not audited
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * Returns true if $entity is audited.
      *

diff --git a/src/DoctrineAuditBundle/Controller/AuditController.php b/src/DoctrineAuditBundle/Controller/AuditController.php
@@ -14,7 +14,6 @@ class AuditController extends AbstractController
     public function listAuditsAction(): Response
     {
         $reader = $this->container->get('dh_doctrine_audit.reader');
-        $reader->getEntities();
 
         return $this->render('@DHDoctrineAudit/Audit/audits.html.twig', [
             'audited' => $reader->getEntities(),

diff --git a/src/DoctrineAuditBundle/Reader/AuditReader.php b/src/DoctrineAuditBundle/Reader/AuditReader.php
@@ -93,7 +93,7 @@ public function getEntities(): array
         }
         $audited = [];
         foreach ($entities as $entity) {
-            if ($this->configuration->isAudited($entity)) {
+            if ($this->configuration->isAuditable($entity)) {
                 $audited[$entity] = $this->getEntityTableName($entity);
             }
         }

diff --git a/tests/DoctrineAuditBundle/AuditConfigurationTest.php b/tests/DoctrineAuditBundle/AuditConfigurationTest.php
@@ -107,6 +107,23 @@ public function testIsAudited(): void
         $this->assertFalse($configuration->isAudited(Comment::class), 'entity "'.Comment::class.'" is not audited.');
     }
 
+    public function testIsAuditable(): void
+    {
+        $entities = [
+            Post::class => [
+                'enabled' => false,
+            ],
+        ];
+
+        $configuration = $this->getAuditConfiguration([
+            'entities' => $entities,
+        ]);
+
+        $this->assertFalse($configuration->isAudited(Post::class), 'entity "'.Post::class.'" is not audited.');
+        $this->assertTrue($configuration->isAuditable(Post::class), 'entity "'.Post::class.'" is auditable.');
+        $this->assertFalse($configuration->isAudited(Comment::class), 'entity "'.Comment::class.'" is not audited.');
+    }
+
     /**
      * @depends testIsAudited
      */