https://github.com/koolreport/codeigniter4-example
https://github.com/koolreport/codeigniter4-example
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/koolreport/codeigniter4-example
- Owner: koolreport
- License: mit
- Created: 2021-07-22T08:15:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-27T08:11:59.000Z (almost 5 years ago)
- Last Synced: 2025-01-13T20:49:57.423Z (over 1 year ago)
- Language: CSS
- Size: 4.26 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# How to use KoolReport in CodeIgniter 4?
CodeIgniter is a PHP full-stack web framework that is light, fast, flexible and secure.
KoolReport is reporting framework and can be integrated into CodeIgniter 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 CodeIgniter.
# Guide
## Installation
Run `composer` command in your CodeIgniter directory to install `koolreport/core` and `koolreport/codeigniter`
```
composer require koolreport/core
composer require koolreport/codeigniter
```
or install `koolreport/pro` if you have a license for it
```
composer require koolreport/pro
```
## Step to make reports
1. Inside `app` directory, create `reports` subdirectory to hold your reports.
2. Create `MyReport.php` and `MyReport.view.php` inside `reports` directory. Assign `App\reports` namespace for the report if you want it be autoloaded. Otherwise, you could include the report file directly in your controller. Please see the contents of two files in our repository.
3. Add \koolreport\codeigniter\Friendship trait to your report like following:
```
class MyReport extends \koolreport\KoolReport
{
use \koolreport\codeigniter\Friendship;
...
```
This trait would help the report to publish js, css assets to CodeIgniter's `public` directory in a subdirectory called `asset/koolreport_assets` as well as allow using CodeIgniter's database settings in the report.
### Create route and action
In `app/Config/Routes.php`, create a route to your report and its action with a controller:
```
$routes->get('/customReport', 'Home::customReport');
```
In the `Home` controller (`app/Controllers/Home.php`), create the action method:
```
public function customReport()
{
$report = new \App\reports\MyReport();
//or if your report doesn't have a namespace:
//include APPPATH . "reports/MyReport.php";
//$report = new \MyReport();
$report_content = $report->run()->render(true);
return view("customReport", ["report_content" => $report_content]);
}
```
Create the report view `app/Views/customReport.php` and put your report content anywhere you like:
```
...
```
All done!
## View result
First start the PHP built-in server in your CodeIgniter directory:
```
php spark serve
```
Then you can access after running
```
http://locahost:8080/customReport
```
you will see
# Summary
KoolReport is a great php reporting framework. You can use KoolReport alone with pure php or inside any modern MVC frameworks like CodeIgniter, CakePHP, Laravel, Symfony, 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!__