Merge pull request #15 from sandrokeil/develop

merged Develop

Author: sandrokeil

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Z-Ray-Doctrine2 CHANGELOG
 
+## 1.1.0 (2015-07-27)
+
+* 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 expand text support (show more / show less)
+* Added query number
+* Added cache tab
+
 ## Version 1.0.0 (2015-05-07)
 
 * Added entities tab

README.md

@@ -1,57 +1,53 @@
 # Doctrine 2 plugin for Zend Server Z-Ray
 
-> Displays information about your Doctrine entities
+> Displays information about your Doctrine 2 entities
 
-> Displays information about your Doctrine queries
+> Displays information about your Doctrine 2 queries
+
+> 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.
 
- * **Every change is tracked**. Want to know whats new? Take a look at [CHANGELOG.md](CHANGELOG.md)
- * **Listen to your ideas.** Have a great idea? Bring your pull request or open a new issue. See [CONTRIBUTING.md](CONTRIBUTING.md)
+ * **Every change is tracked** Want to know whats new? Take a look at [CHANGELOG.md](CHANGELOG.md)
+ * **Listen to your ideas** Have a great idea? Bring your pull request or open a new issue. See [CONTRIBUTING.md](CONTRIBUTING.md)
+ * **Looking for a demo** You can use the [Demo Project](https://github.com/sandrokeil/Z-Ray-Doctrine2-Demo) to try out the Doctrine 2 Z-Ray plugin 
 
 ## Installation
+Simply install the Doctrine 2 Z-Ray plugin via the Zend Server plugin gallery.
 
-- Copy the content of `zray` directory to
-
-```
-    /usr/local/zend/var/zray/extensions/Doctrine2
-```
-
-Or equivalent install location on Windows. The `Doctrine2` directory on the server should look like this:
-
-```
-DoctrineOrm.php
-logo.png
-zray.php
-```
+![Zend Server Plugin Gallery](docs/img/plugin_gallery.png)
 
 ## Doctrine 2 Z-Ray in action
-
 After installation was successful, there are additional tabs in the Z-Ray toolbar.
 
 ### Tab Entities
-![Tab Doctrine 2 Entities](docs/img/tab_entities.jpg)
+![Tab Doctrine 2 Entities](docs/img/tab_entities.png)
 
-The `Entities` tab displays information about used entities of the current page. 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**: This is how many unique objects of this entity exist
- * **Number Of Referenced Entities**: This is how many references exist for this entity
+ * **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
-![Tab Doctrine 2 Queries](docs/img/tab_queries.jpg)
+![Tab Doctrine 2 Queries](docs/img/tab_queries.png)
 
 The `Queries` tab displays information about executed queries. There are the following columns:
 
- * **Query**: The executed query
- * **Number**: The number of executions e.g. with different parameters
+ * **Query**: The executed query with parameter
+ * **Number**: The number of executions
  * **Cached**: The number of cached queries
 
-Note that real queries are calculated with `Number - Cached`.
+Note: real queries are calculated as `Number - Cached`.
+
+### Tab Cache
+![Tab Doctrine 2 Queries](docs/img/tab_cache.png)
+
+The `Cache` tab displays information about Doctrine 2 caches.
 
 ## More Info
 Want to extend the Doctrine 2 Z-Ray extension? Looking for more information on Z-Ray? Try these links:
 
-- [Z-Ray Documentation](https://github.com/zend-server-extensions/Z-Ray-Documentation)
-- [Zend Server Online Help - Z-Ray overview](http://files.zend.com/help/Zend-Server/zend-server.htm#z-ray.htm)
+- [Z-Ray Documentation](https://github.com/zend-server-plugins/Documentation)
 - [Zend.com](http://www.zend.com/en/products/server/z-ray)

README.txt

@@ -1,17 +1,21 @@
 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 queries are used. Additional features are in the planning.
 
-## Tab Entities
-The `Entities` tab displays information about used entities of the current page. There are the following columns:
+### Tab Entities
+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.
+ * **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
+### Tab Queries
 The `Queries` tab displays information about executed queries. There are the following columns:
 
- * **Query**: The executed query.
- * **Number**: The number of executions e.g. with different parameters.
- * **Cached**: The number of cached queries.
+ * **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`.
+Note: real queries are calculated as `Number - Cached`.
+
+### Tab Cache
+The `Cache` tab displays information about Doctrine 2 caches.

deployment.json

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