Merge pull request #18 from sandrokeil/develop

added events panel and improved query parameter detection

Author: sandrokeil

CHANGELOG.md

@@ -1,19 +1,21 @@
 # Z-Ray-Doctrine2 CHANGELOG
 
-## 1.2.0 TBA
+## 1.2.0 (2015-08-17)
+* [3](https://github.com/sandrokeil/Z-Ray-Doctrine2/issues/3): Added events panel with Doctrine 2 and Symfony Doctrine 2 Bridge events
+* Improved query parameter detection
 * fixed wrong cache detection
 
 ## 1.1.0 (2015-07-27)
 
-* All entity mappings now displayed
+* [1](https://github.com/sandrokeil/Z-Ray-Doctrine2/issues/1): All entity mappings now displayed
 * Added count of executed queries with cache info
 * Added parameters to queries
 * Added SQL transaction tracking
 * Added query syntax highlighting and expand text support (show more / show less)
 * Added query number
-* Added cache tab
+* [4](https://github.com/sandrokeil/Z-Ray-Doctrine2/issues/4): Added cache tab
 
-## Version 1.0.0 (2015-05-07)
+## 1.0.0 (2015-05-07)
 
 * Added entities tab
 * Added queries tab

README.md

@@ -4,6 +4,8 @@
 
 > Displays information about your Doctrine 2 queries
 
+> Displays information about your Doctrine 2 events
+
 > Displays information about your Doctrine 2 caches
 
 This is a plugin to add functionality to the Zend Server Z-Ray. It will result in additional tab(s) to be presented in the browser.
@@ -33,18 +35,34 @@ There are the following columns:
 ### Tab Queries
 ![Tab Doctrine 2 Queries](docs/img/tab_queries.png)
 
-The `Queries` tab displays information about executed queries. There are the following columns:
+The `Queries` tab displays information about executed queries. 
+There are the following columns:
 
+ * **#**: Query number
  * **Query**: The executed query with parameter
  * **Number**: The number of executions
  * **Cached**: The number of cached queries
 
 Note: real queries are calculated as `Number - Cached`.
 
+### Tab Events
+![Tab Doctrine 2 Queries](docs/img/tab_events.png)
+
+The `Events` tab displays information about Doctrine 2 events with `Symfony\Bridge\Doctrine` support.
+There are the following columns:
+
+ * **Event**: The event name
+ * **Number**: The Number of occurrences
+ * **Listeners**: Listener classes
+
 ### Tab Cache
 ![Tab Doctrine 2 Queries](docs/img/tab_cache.png)
 
-The `Cache` tab displays information about Doctrine 2 caches.
+The `Cache` tab displays information about Doctrine 2 caches and which cache driver is used.
+There are the following columns:
+
+ * **Type**: The cache type
+ * **Status**: Which cache driver is used
 
 ## More Info
 Want to extend the Doctrine 2 Z-Ray extension? Looking for more information on Z-Ray? Try these links:

README.txt

@@ -1,23 +1,37 @@
-The Doctrine 2 plugin for Zend Server Z-Ray provides various information about the usage of Doctrine 2 in your application. Get a deeper look how entities and entity mappings, queries with parameter and caches are used.
-
+The Doctrine 2 plugin for Zend Server Z-Ray provides various information about the usage of Doctrine 2 in your
+application. Get a deeper look how entities and entity mappings, queries with parameter, events and caches are used.
 
 ## Tab Entities
-The `Entities` tab displays information about used entities of the current page and entity mappings. There are the following columns:
+The `Entities` tab displays information about used entities of the current page and entity mappings.
+There are the following columns:
 
  * **Entity**: FCQN of the entity class
  * **Number Of Unique Entities**: How many unique objects of this entity exist
  * **Number Of Referenced Entities**: How many references exist for this entity
 
 
 ## Tab Queries
-The `Queries` tab displays information about executed queries. There are the following columns:
+The `Queries` tab displays information about executed queries.
+There are the following columns:
 
+ * **#**: Query number
  * **Query**: The executed query with parameter
  * **Number**: The number of executions
  * **Cached**: The number of cached queries
 
 Note: real queries are calculated as `Number - Cached`.
 
+### Tab Events
+The `Events` tab displays information about Doctrine 2 events with `Symfony\Bridge\Doctrine` support.
+There are the following columns:
+
+ * **Event**: The event name
+ * **Number**: The Number of occurrences
+ * **Listeners**: Listener classes
+
+### Tab Cache
+The `Cache` tab displays information about Doctrine 2 caches and which cache driver is used.
+There are the following columns:
 
-## Tab Cache
-The `Cache` tab displays information about Doctrine 2 caches.
+ * **Type**: The cache type
+ * **Status**: Which cache driver is used

deployment.json

@@ -2,7 +2,7 @@
 {
   "name" : "doctrine2",
   "display_name" : "Doctrine 2",
-  "version" : "1.1.0",
+  "version" : "1.2.0",
   "type": ["zray"],
   "logo": "docs/img/doctrine.png",
   "eula": "LICENSE.txt",

docs/img/plugin_gallery.png

@@ -22,9 +22,6 @@
  */
 class DoctrineOrm
 {
-    const INDEX_ENTITIES_UNIQUE = 'unique_entities';
-    const INDEX_ENTITIES_REFERENCE = 'referenced_entities';
-
     /**
      * Entities
      *
@@ -46,13 +43,6 @@ class DoctrineOrm
      */
     protected $queryNumber = 0;
 
-    /**
-     * Last query to set parameters from persister
-     *
-     * @var string
-     */
-    protected $lastQuery = '';
-
     /**
      * Cache settings
      */
@@ -79,6 +69,11 @@ class DoctrineOrm
         ],
     ];
 
+    /**
+     * Events
+     */
+    protected $events = [];
+
     /**
      * Collects queries from \Doctrine\ORM\Persisters\Entity\BasicEntityPersister
      *
@@ -172,36 +167,6 @@ public function cache($context, &$storage)
         }
     }
 
-    /**
-     * Collects queries from \Doctrine\ORM\Persisters\Entity\BasicEntityPersister
-     *
-     * @param array $context
-     * @param array $storage
-     */
-    public function persister($context, &$storage)
-    {
-        // dont break z-ray
-        if (empty($context['functionArgs'][0])
-            || !$this->lastQuery
-            || empty($context['returnValue'])
-        ) {
-            $this->lastQuery = '';
-            return;
-        }
-
-        $params = [];
-
-        foreach ($context['returnValue'] as &$values) {
-            $params += $values;
-        }
-
-        $this->queries[$this->lastQuery]['query'] = $this->formatQuery(
-            $this->queries[$this->lastQuery]['query'],
-            $params
-        );
-        $this->lastQuery = '';
-    }
-
     /**
      * Collects all queries from Doctrine\DBAL\Connection
      *
@@ -264,6 +229,9 @@ public function statement($context, &$storage)
             return;
         }
 
+        $query = '';
+        $queryId = '';
+
         switch ($context['functionName']) {
             case 'Doctrine\DBAL\Connection::beginTransaction':
                 $query = 'Begin Transaction';
@@ -280,15 +248,45 @@ public function statement($context, &$storage)
                 $this->queryNumber++;
                 $queryId = $query . $this->queryNumber;
                 break;
-            case 'Doctrine\DBAL\Statement::__construct':
+            case 'Doctrine\DBAL\Statement::execute':
+                $reflection = new \ReflectionObject($context['this']);
+
+                if (!$reflection->hasProperty('params')
+                    || !$reflection->hasProperty('types')
+                    || !$reflection->hasProperty('sql')
+                ) {
+                    break;
+                }
+
+                if (empty($context['functionArgs'][0])) {
+                    $params = $reflection->getProperty('params');
+                    $params->setAccessible(true);
+                    $params = $params->getValue($context['this']);
+                } else {
+                    $params = $context['functionArgs'][0];
+                }
+
+                $types = $reflection->getProperty('types');
+                $types->setAccessible(true);
+                $types = $types->getValue($context['this']);
+
+                $query = $reflection->getProperty('sql');
+                $query->setAccessible(true);
+                $query = $query->getValue($context['this']);
+
+                # doctrine does it right
+                list($queryWithParams, $params, $types) = \Doctrine\DBAL\SQLParserUtils::expandListParameters(
+                    $query,
+                    $params,
+                    $types
+                );
+
+                $query = $this->formatQuery($queryWithParams, $params);
                 $this->queryNumber++;
-                $query = isset($context['locals']['sql']) ? $context['locals']['sql'] : 'NO QUERY';
                 $queryId = $query . $this->queryNumber;
-                $this->lastQuery = $this->getQueryId($queryId);
                 break;
             default:
-                $query = '';
-                $queryId = '';
+                // nothing to do
                 break;
         }
 
@@ -365,6 +363,74 @@ public function entityMapping($context, &$storage)
         }
     }
 
+    /**
+     * Collects events from Doctrine EventManager
+     *
+     * @param array $context
+     * @param array $storage
+     */
+    public function eventManagerDispatch($context, &$storage)
+    {
+        // dont break z-ray
+        if (empty($context['functionArgs'][0])) {
+            return;
+        }
+
+        $eventName = $context['functionArgs'][0];
+
+        if (empty($this->events[$eventName])) {
+            $this->events[$eventName] = [
+                'name' => $eventName,
+                'number' => 0,
+                'listeners' => [],
+            ];
+        }
+
+        $this->events[$eventName]['number']++;
+
+        if (empty($context['locals']['listener'])) {
+            return;
+        }
+        $listener = get_class($context['locals']['listener']);
+        $this->events[$eventName]['listeners'][$listener] = true;
+    }
+
+    /**
+     * Collects listener from Doctrine EventManager
+     *
+     * @param array $context
+     * @param array $storage
+     */
+    public function eventManagerAddListener($context, &$storage)
+    {
+        // dont break z-ray
+        if (empty($context['functionArgs'][0])
+            || empty($context['functionArgs'][1])
+        ) {
+            return;
+        }
+
+        $events = (array) $context['functionArgs'][0];
+
+        $listener = $context['functionArgs'][1];
+
+        if (is_object($listener)) {
+            $listener = get_class($listener);
+        }
+
+        foreach ($events as $event) {
+            if (empty($this->events[$event])) {
+                $this->events[$event] = [
+                    'name' => $event,
+                    'number' => 0,
+                    'listeners' => [$listener => true],
+                ];
+            } else {
+                $this->events[$event]['listeners'][$listener] = true;
+            }
+        }
+    }
+
     /**
      * Collects all data from other functions to display information in Z-Ray
      *
@@ -398,6 +464,38 @@ public function collectAllData($context, &$storage)
 
         // collect cache
         $storage['cache'] = $this->cache;
+
+        $events = [
+            'onClear',
+            'onFlush',
+            'postFlush',
+            'postLoad',
+            'postPersist',
+            'postRemove',
+            'postUpdate',
+            'preFlush',
+            'prePersist',
+            'preRemove',
+            'preUpdate',
+            'loadClassMetadata',
+            'onClassMetadataNotFound',
+        ];
+
+        foreach ($events as $event) {
+            $storage['events'][$event] = [
+                'name' => $event,
+                'number' => 0,
+                'listeners' => '',
+            ];
+        }
+
+        foreach ($this->events as $event => $data) {
+            $storage['events'][$event] = [
+                'name' => $data['name'],
+                'number' => $data['number'],
+                'listeners' => implode("\n", array_keys($data['listeners'])),
+            ];
+        }
     }
 
     /**

docs/img/tab_cache.png

@@ -24,6 +24,8 @@ public function config()
             'defaultPanels' => array(
                 'queries' => true,
                 'entities' => true,
+                'cache' => true,
+                'events' => true,
             ),
             'panels' => array(
                 'cache' => array(
@@ -34,6 +36,14 @@ public function config()
                     'searchId' => 'doctrine-cache-search',
                     'pagerId' => 'doctrine-cache-pager',
                 ),
+                'events' => array(
+                    'display' => true,
+                    'logo' => 'logo.png',
+                    'menuTitle' => 'Events',
+                    'panelTitle' => 'Doctrine 2 Events',
+                    'searchId' => 'doctrine-events-search',
+                    'pagerId' => 'doctrine-events-pager',
+                ),
                 'entities' => array(
                     'display' => true,
                     'logo' => 'logo.png',