https://github.com/koolreport/examples-cakephp
KoolReport examples in CakePHP
https://github.com/koolreport/examples-cakephp
Last synced: 11 months ago
JSON representation
KoolReport examples in CakePHP
- Host: GitHub
- URL: https://github.com/koolreport/examples-cakephp
- Owner: koolreport
- Created: 2025-05-22T07:27:50.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-18T04:37:47.000Z (about 1 year ago)
- Last Synced: 2025-06-18T05:33:09.643Z (about 1 year ago)
- Language: PHP
- Size: 3.93 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# KoolReport in CakePHP
CakePHP is an open-source web, rapid development framework that makes building web applications simpler, faster and require less code.
KoolReport is reporting framework and can be integrated into CakePHP or any other MVC framework. KoolReport help you to create data report faster and easier.
In this repository, we would like to demonstrate how KoolReport can be used in CakePHP.
# Installation
Run `composer` command in your CakePHP directory to install `koolreport/core`
```
composer require koolreport/core
```
or install `koolreport/pro` if you have a license for it
```
composer require koolreport/pro
```
# Create reports
1. Inside `src` directory, create `reports` subdirectory to hold your reports.
2. Create `MyReport.php` and `MyReport.view.php` inside `reports` directory. Assign `src\reports` namespace for the report if you want it can be autoloaded. Otherwise, you could load the report directly in your controller when using it. Please see the contents of two files in our repository.
```
namespace App\reports;
class MyReport extends \koolreport\KoolReport
{
...
```
## Create route and action
In `config/routes.php`, create a route to your report and its action with a controller:
```
$routes->scope('/', function (RouteBuilder $builder): void {
$builder->connect('/customReport', [ 'controller' => 'Home', 'action' => 'customReport']);
```
In the `HomeController` controller (`src/Controllers/HomeController.php`), create the action method:
```
public function customReport()
{
$report = new \App\reports\MyReport();
$report_content = $report->run()->render(true);
$this->set('report_content', $report_content);
return $this->render('custom_report');
}
```
Create the report view `templates/Home/customReport.php` and put your report content anywhere you like:
```
...
```
All done!
## View result
Put your CodeIgniter app on your server/localhost. Then you can access after running
```
http://locahost/examples-cakephp/customReport
```
## CSRF field/token in form submissions and xhr requests
In reports with form submission or xhr request users need to add csrf field/token to the form and request for server response to work.
For example, adding csrf field to form:
```
```
or add csrf token to request:
```
subReport.update("SaleByCountriesReport", {
csrfToken:'<?php echo \Cake\Routing\Router::getRequest()->getAttribute('csrfToken'); ?>'
});
```
or set csrf token in jQuery's ajax setup:
```
<meta name="csrfToken" content="<?= \Cake\Routing\Router::getRequest()->getAttribute('csrfToken') ?>" />
...
<script type="text/javascript">
$.ajaxSetup({
headers: {
'X-CSRF-TOKEN': $('meta[name="csrfToken"]').attr('content')
}
});
```
# Summary
KoolReport is a great php reporting framework. You can use KoolReport alone with pure php or inside any modern MVC frameworks like CakePHP, CakePHP, CodeIgniter, Yii2. If you have any questions regarding KoolReport, free free to contact us at [our forum](https://www.koolreport.com/forum/topics) or email to [support@koolreport.com](mailto:support@koolreport.com).
__Happy Reporting!__