This piece introduces yet another new addition to the Zend Server plugin family – the CakePHP plugin for Z-Ray.
Zend Server plugins are pieces of code that extend Zend Server’s functionality in a variety of ways. Z-Ray plugins result in adding specific information in Z-Ray on the app/framework/platform you’re developing.
There are already more than 20 Z-Ray plugins for some of the popular PHP apps and frameworks such as WordPress, Drupal, Magento, Joomla, Zend Framework, Symfony, Laravel and more, and now – also for CakePHP, courtesy of Mark Story (@mark_story).
More and more plugins are being developed and it is truly incredible to see contributions coming from all the different segments comprising the PHP community. A big applause and thanks for this effort!
Installing the Plugin
The CakePHP plugin can be installed via the Zend Gallery, from within the Zend Server UI.
Once you’ve accessed the UI, go to the Plugins | Gallery page, locate the plugin and click the Install button. Complete the short deployment wizard, and you’ll be up and running with the new plugin in no time.
To start using Z-Ray and the plugin to introspect your code, simply open your CakePHP app in a browser!
The plugin code can be found here: https://github.com/markstory/Z-Ray-CakePHP
Introducing the Plugin
So, what info does this plugin give CakePHP developers?
Let’s start from left to right:
- Events – this panel gives you a list of all the CakePHP events that were fired during the request, including their name, and the time and memory they consumed.
- Plugins – the Plugins panel lists all the loaded CakePHP plugins, and provides you with the path to the source files themselves and the plugin class and configuration files
- Configure – details all the various app configuration data, including the application’s URL, root directory, and version.
- Request – the Request panel gives you information on the current request and the response.
- Env – provides you with general setup information, such as the application path and CakePHP version
- Views – shows information on the CakePHP view templates that were loaded and processed during execution.
Develop your Own Plugin
If you’ve got an idea for a plugin, there are some useful resources available that will help you get started:
- Official plugin documentation: https://github.com/zend-server-plugins/Documentation
- A brief tutorial on how to develop a Z-Ray plugin, showing how the WordPress plugin was developed – Develop Your First Zend Server Plugin – Part 1
- Another example of how to develop a plugin – http://andrewembler.com/2015/07/creating-z-ray-plugin-zend-server-85/
Once you’re finished with your plugin, be sure to submit it to the Gallery, and take part in the Plugin Contest, more details here: https://www.zend.com/en/products/server/plugins/plugin-contest