Download the PHP package mesd/jasper-report-bundle without Composer
On this page you can find all versions of the php package mesd/jasper-report-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package jasper-report-bundle
Overview
The Jasper Report Bundle serves as a layer on top of the vanilla PHP MESD Jasper Client library to make it easier to integrate with Symfony applications. The bundle also contains extra features on top of the client library that make use of some of Symfon'y features and to provide extra tools when adding Jasper Report support to an application. Also, the report bundle is built to be compatible with an optional report viewer bundle that provides the views and controller to handle most of the common report bundle.
Features
The report bundle and the client currently offer the following features:
- Ability to get a list of reports from the Jasper Server
- Report execution, with report output being saved to a local directory for later retrieval
- Input control option management that makes it easy to lock down options for particular input controls based on the user
- Converts report input to Symfony forms
- Save and retrieve past reports
Todo List
- Add support for Jasper Server Pro, currently only the community version is supported
- Add more tools to help with managing the report store
Installation
Add Packages to Project via Composer
After these have been added, perform a composer update to install the packages in your vendor directory. Register the Bundle in the App Kernel As with all other bundles, the report bundle will need to be registered in the application's app kernel.
Configuring Report History
Issue console command
... to review, and then ...
to add the history table to your schema. You may need to add a mapping to your doctrine orm configuration if you have multiple entity managers.
Important: add /report-store (or other parent specified in the cache_dir field of configuration) to .gitignore to avoid adding myriad reports to the repo.
Connecting to the Jasper Report Server
The next step is to add in the connection details to the config file so that the bundle can establish a connection with the report server
Link to the Bundle's Routing File The report bundle uses some internal routes to handle the processing of report assets (images, charts, and graphs) and for exporting reports saved in the report store. Since Symfony's autoloader does not handle routing automatically, you must import the bundle's routing.yml file for it to function. To do so, add the following to your routing.yml in the app/config directory.
Setting the Configuration Options
Finally, all that is left is to set the configuration options for the report bundle. Most options have a default value. There is only one required option that needs to be set: the bundle's configuration the name of the options handler service that was set up in the last step. Visit the configuration section later to get a list of the configuration settings the report bundle has.
Usage
Creating an Options Handler
To allow application specific control of the options for select parameters, an options handler service can be created to handle this. To create a basic option handler, extend the AbstractOptionsHandler class from Mesd\Jasper\ReportBundle\Interfaces\AbstractOptionsHandler and implement the method 'registerFunctions' that set the internal method an array that is a function that returns an array of options keyed by the input control id. For example:
Once the class is created, it needs to be made into a service in service configuration file which will look something like the following
Getting a List of Resources from the Report Server
To get a list of resources from the report server, use the client service method getResourceList to return an array of resource objects. If report security is on, this will only return resources the current user has the roles to view. Resource List
Getting the Input Controls
To build a new report, we need to first get the input controls for a report and display them. This can be easily done through the bundle which will build a Symfony form from the input controls of a report and will make use of the options handler if the input option source is set to 'Custom' or 'Fallback' mode. Example follows:
Running a Report
Once the input controls have been filled out, they need to be given back to the report and then we can run the report. When the report is run via the report builder's runReport method, the report will be stored into the report store directory (in all of its requested formats, which by default are html, pdf, and xls) and a record entry will be inserted into the database. Each instance of a report have a request id that serve as their unique identifier. Example follows:
With the request id for the report, it can be loaded from the report store at anytime, either right away for display or brought up later for reference.
Getting a Report from the Report Store
To get a report from the report store, just call the loader service and give it the request id and the page number to retrieve when displaying html reports
You can get the report in other formats by changing the html to pdf or xls, though non-html formats do not accept the page option.
Role Based Report Security
The Report Security Yaml File By creating a report security yaml and setting the option in the config setting, the client service will automatically limit what reports a user can view based on their roles. These roles can be set on a directory or report based instance.
The Jasper Report Bundle includes a command (mesd_jasper_report:security::generate-yaml) that can help in generating a base report security file for you. Run the following for more information app/console mesd_jasper_report:security::generate-yaml --help
Configuration Settings
The report bundle has a wide array of configuration settings. Following is a list of possible options, their default value, and their functionality. The default values are represented in brackets([])
Displaying Input Options Based on User
One of the most common purposes for overriding the input options and having the options handler service is to provide a way to limit options to users, such that a user can only run a report for data that they have permission to view. The following is an example that limits users to only view reports for their department.
Using the Remove Broken Report History Records Command
It's possible over time that the report history records in the database will point to reports that are no longer saved in the store. The app/console mesd_jasper_report:history:delete_broken_records command will delete all those records that no longer point to a report in the store. Add the --dry-run command to see which records will try to delete, and then run without to delete them.
API Documentation
Generated documentation exists in the bundle under the docs directory.
License
This project is licensed under the MIT license. See the LICENSE.md file for more information.
