Refactoring/listener

src/Knp/DoctrineBehaviors/ORM/AbstractListener.php

@@ -0,0 +1,71 @@
+<?php
+
+/**
+ * This file is part of the KnpDoctrineBehaviors package.
+ *
+ * (c) KnpLabs <http://knplabs.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Knp\DoctrineBehaviors\ORM;
+
+use Doctrine\Common\EventSubscriber;
+
+abstract class AbstractListener implements EventSubscriber
+{
+
+    abstract public function getSubscribedEvents();
+
+    /**
+     * Return TRUE if the given entity use the given trait, FALSE if not
+     * @param ReflectionClass $class
+     * @param string $traitName
+     * @param boolean $isRecursive
+     */
+    protected function isEntityUseTrait(\ReflectionClass $class, $traitName, $isRecursive = false)
+    {
+        if (in_array($traitName, $class->getTraitNames())) {
+            return true;
+        }
+
+        $parentClass = $class->getParentClass();
+
+        if ((false === $isRecursive) || (false === $parentClass)) {
+            return false;
+        }
+
+        return $this->isEntityUseTrait($parentClass, $traitName, $isRecursive);
+    }
+
+    /**
+     * Return TRUE if the given entity has the given method, FALSE if not
+     * @param ReflectionClass $class
+     * @param string $methodName
+     */
+    protected function isEntityHasMethod(\ReflectionClass $class, $methodName)
+    {
+        return $class->hasMethod($methodName);
+    }
+
+    /**
+     * Return TRUE if the given entity has the given property, FALSE if not
+     * @param ReflectionClass $class
+     * @param string $propertyName
+     */
+    protected function isEntityHasProperty(\ReflectionClass $class, $propertyName, $isRecursive = false)
+    {
+        if ($class->hasProperty($propertyName)) {
+            return true;
+        }
+
+        $parentClass = $class->getParentClass();
+
+        if ((false === $isRecursive) || (false === $parentClass)) {
+            return false;
+        }
+
+        return $this->isEntityHasProperty($parentClass, $propertyName, $isRecursive);
+    }
+}

src/Knp/DoctrineBehaviors/ORM/Blameable/BlameableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Blameable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
 use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
 use Doctrine\ORM\Event\LifecycleEventArgs;
@@ -24,7 +26,7 @@
  * Adds class metadata depending of user type (entity or string)
  * Listens to prePersist and PreUpdate lifecycle events
  */
-class BlameableListener implements EventSubscriber
+class BlameableListener extends AbstractListener
 {
     /**
      * @var callable
@@ -237,16 +239,9 @@ public function getUser()
      */
     private function isEntitySupported(\ReflectionClass $reflClass, $isRecursive = false)
     {
-        $isSupported = in_array('Knp\DoctrineBehaviors\Model\Blameable\Blameable', $reflClass->getTraitNames())
-            || in_array('Knp\DoctrineBehaviors\Model\Blameable\BlameableMethods', $reflClass->getTraitNames())
+        return $this->isEntityUseTrait($reflClass, 'Knp\DoctrineBehaviors\Model\Blameable\Blameable', $isRecursive)
+            || $this->isEntityUseTrait($reflClass, 'Knp\DoctrineBehaviors\Model\Blameable\BlameableMethods', $isRecursive)
         ;
-
-        while ($isRecursive and !$isSupported and $reflClass->getParentClass()) {
-            $reflClass = $reflClass->getParentClass();
-            $isSupported = $this->isEntitySupported($reflClass, true);
-        }
-
-        return $isSupported;
     }
 
     public function getSubscribedEvents()

src/Knp/DoctrineBehaviors/ORM/Geocodable/GeocodableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Geocodable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Knp\DoctrineBehaviors\ORM\Geocodable\Type\Point;
 
 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
@@ -27,7 +29,7 @@
  * GeocodableListener handle Geocodable entites
  * Adds doctrine point type
  */
-class GeocodableListener implements EventSubscriber
+class GeocodableListener extends AbstractListener
 {
     /**
      * @var callable
@@ -140,7 +142,7 @@ public function getLocation($entity)
      */
     private function isEntitySupported(\ReflectionClass $reflClass)
     {
-        return $reflClass->hasMethod('getLocation');
+        return $this->isEntityHasMethod($reflClass, 'getLocation');
     }
 
     public function getSubscribedEvents()

src/Knp/DoctrineBehaviors/ORM/Loggable/LoggableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Loggable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\ORM\Event\LifecycleEventArgs;
 
 use Doctrine\Common\EventSubscriber,
@@ -21,7 +23,7 @@
  * LoggableListener handle Loggable entites
  * Listens to lifecycle events
  */
-class LoggableListener implements EventSubscriber
+class LoggableListener extends AbstractListener
 {
     /**
      * @var callable
@@ -96,7 +98,7 @@ public function setLoggerCallable(callable $callable)
      */
     private function isEntitySupported(\ReflectionClass $reflClass)
     {
-        return in_array('Knp\DoctrineBehaviors\Model\Loggable\Loggable', $reflClass->getTraitNames());
+        return $this->isEntityUseTrait($reflClass, 'Knp\DoctrineBehaviors\Model\Loggable\Loggable');
     }
 
     public function getSubscribedEvents()

src/Knp/DoctrineBehaviors/ORM/Sluggable/SluggableListener.php

@@ -6,6 +6,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Sluggable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\ORM\Event\LoadClassMetadataEventArgs,
     Doctrine\Common\EventSubscriber,
     Doctrine\ORM\Events,
@@ -16,7 +18,7 @@
  *
  * Adds mapping to sluggable entities.
  */
-class SluggableListener implements EventSubscriber
+class SluggableListener extends AbstractListener
 {
     public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
     {
@@ -48,10 +50,8 @@ public function getSubscribedEvents()
      *
      * @return Boolean
      */
-    private function isEntitySupported(ClassMetadata $classMetadata)
+    protected function isEntitySupported(ClassMetadata $classMetadata)
     {
-        $traitNames = $classMetadata->reflClass->getTraitNames();
-
-        return in_array('Knp\DoctrineBehaviors\Model\Sluggable\Sluggable', $traitNames);
+        return $this->isEntityUseTrait($classMetadata->reflClass, 'Knp\DoctrineBehaviors\Model\Sluggable\Sluggable');
     }
 }

src/Knp/DoctrineBehaviors/ORM/SoftDeletable/SoftDeletableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\SoftDeletable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\Common\Persistence\Mapping\ClassMetadata,
     Doctrine\Common\EventSubscriber,
     Doctrine\ORM\Event\OnFlushEventArgs,
@@ -22,7 +24,7 @@
  * Listens to onFlush event and marks SoftDeletable entities
  * as deleted instead of really removing them.
  */
-class SoftDeletableListener implements EventSubscriber
+class SoftDeletableListener extends AbstractListener
 {
     /**
      * Listens to onFlush event.
@@ -59,9 +61,7 @@ public function onFlush(OnFlushEventArgs $args)
      */
     private function isEntitySupported(ClassMetadata $classMetadata)
     {
-        $traitNames = $classMetadata->reflClass->getTraitNames();
-
-        return in_array('Knp\DoctrineBehaviors\Model\SoftDeletable\SoftDeletable', $traitNames);
+        return $this->isEntityUseTrait($classMetadata->reflClass, 'Knp\DoctrineBehaviors\Model\SoftDeletable\SoftDeletable');
     }
 
     /**

src/Knp/DoctrineBehaviors/ORM/Timestampable/TimestampableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Timestampable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\ORM\Event\LoadClassMetadataEventArgs,
     Doctrine\Common\EventSubscriber,
     Doctrine\ORM\Events,
@@ -21,7 +23,7 @@
  *
  * Adds mapping to the timestampable entites.
  */
-class TimestampableListener implements EventSubscriber
+class TimestampableListener extends AbstractListener
 {
     public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
     {
@@ -53,8 +55,6 @@ public function getSubscribedEvents()
      */
     private function isEntitySupported(ClassMetadata $classMetadata)
     {
-        $traitNames = $classMetadata->reflClass->getTraitNames();
-
-        return in_array('Knp\DoctrineBehaviors\Model\Timestampable\Timestampable', $traitNames);
+        return $this->isEntityUseTrait($classMetadata->reflClass, 'Knp\DoctrineBehaviors\Model\Timestampable\Timestampable');
     }
 }

src/Knp/DoctrineBehaviors/ORM/Translatable/TranslatableListener.php

@@ -11,6 +11,8 @@
 
 namespace Knp\DoctrineBehaviors\ORM\Translatable;
 
+use Knp\DoctrineBehaviors\ORM\AbstractListener;
+
 use Doctrine\Common\EventSubscriber,
     Doctrine\ORM\Mapping\ClassMetadata,
     Doctrine\ORM\Event\LoadClassMetadataEventArgs,
@@ -22,7 +24,7 @@
  *
  * Provides mapping for translatable entities and their translations.
  */
-class TranslatableListener implements EventSubscriber
+class TranslatableListener extends AbstractListener
 {
     private $currentLocaleCallable;
 
@@ -44,7 +46,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
             return;
         }
 
-        if ($this->isTranslatable($classMetadata->reflClass)) {
+        if ($this->isTranslatable($classMetadata)) {
             $this->mapTranslatable($classMetadata);
         }
 
@@ -113,16 +115,9 @@ private function hasUniqueTranslationConstraint(ClassMetadata $classMetadata, $n
      *
      * @return boolean
      */
-    private function isTranslatable(\ReflectionClass $reflClass, $isRecursive = false)
+    private function isTranslatable(ClassMetadata $classMetadata, $isRecursive = false)
     {
-        $isSupported = $reflClass->hasProperty('translations');
-
-        while ($isRecursive and !$isSupported and $reflClass->getParentClass()) {
-            $reflClass = $reflClass->getParentClass();
-            $isSupported = $this->isTranslatable($reflClass, true);
-        }
-
-        return $isSupported;
+        return $this->isEntityHasProperty($classMetadata->reflClass, 'translations', $isRecursive);
     }
 
     private function isTranslation(ClassMetadata $classMetadata)
@@ -136,7 +131,7 @@ public function postLoad(LifecycleEventArgs $eventArgs)
         $entity        = $eventArgs->getEntity();
         $classMetadata = $em->getClassMetadata(get_class($entity));
 
-        if (!$classMetadata->reflClass->hasMethod('setCurrentLocale')) {
+        if (!$this->isEntityHasMethod($classMetadata->reflClass, 'setCurrentLocale', false)) {
             return;
         }