Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/koolreport/instant
Create KoolReport's report or widget instantly everywhere without setting up a full report
https://github.com/koolreport/instant
data-visualization koolreport reporting-engine reporting-tool
Last synced: 3 months ago
JSON representation
Create KoolReport's report or widget instantly everywhere without setting up a full report
- Host: GitHub
- URL: https://github.com/koolreport/instant
- Owner: koolreport
- Created: 2019-05-08T08:10:06.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-11-10T10:43:36.000Z (about 4 years ago)
- Last Synced: 2024-11-06T08:45:49.741Z (3 months ago)
- Topics: data-visualization, koolreport, reporting-engine, reporting-tool
- Language: PHP
- Homepage: https://www.koolreport.com/
- Size: 9.77 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Introduction
Sometimes, we need to show some tables or charts in our page but setting up the whole KoolReport, despite of ease, causes trouble and is not convenient. The `Instant` package allows us to create report or widget instantly everywhere without setting up a full report.
Beside `Instant` package can help you to export any file whether it is `html` or `php` to PDF and other formats.
# Installation
1. Download and unzip the zipped file
2. Copy `instant` folder into `koolreport\instant` folder
# Documentation
## Widget
|name|return|description|
|---|---|---|
|create(*string* $widgetClassName, *array* $widgetParams)|null|Render the widget. This static function requires `$widgetClassName` which is the name of widget you want to create and `$widgetParams` which is any parameters you want to pass to the widget|
## Examples
### Create KoolPHP Table
Below are example of how to create Table on your PHP page
```
Instant Table
array(
array("name"=>"Peter","age"=>35),
array("name"=>"Karl","age"=>32),
)
));
?>
```
As you see, you do not need to setup the whole KoolReport class and the view in order to use our `Widget`. With the `Instance` package, you can create any widgets you want.
### Create Google BarChart
```
Instant Table
array(
array("name"=>"Peter","age"=>35),
array("name"=>"Karl","age"=>32),
)
));
?>
```
### Create PieChart
```
Instant Table
array(
array("browser"=>"Chrome","usage"=>44.5),
array("browser"=>"Safari","usage"=>25.4),
array("browser"=>"Internet Explorer","usage"=>15.5),
array("browser"=>"Firefox","usage"=>7.4),
array("browser"=>"Others","usage"=>7.2),
)
));
?>
```
## Assets Folder
### Automatically create assets folder
By default, Instant package will create `koolreport_assets` folder automatically to hold the resources of widgets. This will assure that all widgets work seamlessly.
### Manually create assets folder
If you want to organize all koolreport widget's resources into a pre-created assets folder of your own, you may do so. For example, you have `assets` folder created, you can do like below:
```
array(
array("name"=>"Peter","age"=>35),
array("name"=>"Karl","age"=>32),
)
),array(
"path"=>"../../assets"
"url"=>"/assets",
));
?>
```
The third parameter of `create` function is optional settings for assets folder. This `assets` settings is necessary if browser can not access to the folder containing resources of Widget. By specifying the `path` and `url`, we let KoolReport know where to put Widget's resources and how to access those resources.
### Turn off this feature
If you put KoolReport library in folder that can be accessed by browser, there will not be need for create `assets` folder. So you may tell instant package not to create any `assets` folder. Just input `false` value into the third parameter like below
```
array(
array("name"=>"Peter","age"=>35),
array("name"=>"Karl","age"=>32),
)
),false);
?>
```
## Exporter
`Exporter` helps you to ulilize the `Export` package (if you have) to export any HTML or PHP code file to PDF and other formats.
```
pdf(array(
"format"=>"A4",
"orientation"=>"portrait"
))
->toBrowser("myfile.pdf");
```
or you can save file
```
Exporter::export("/full/path/to/your/file.php")
->pdf(array(
"format"=>"A4",
"orientation"=>"portrait"
))
->saveAs("myfile.pdf");
```
## SinglePage
As you may know, to start a report, we normally need 3 files: a controller class file(ex.`MyReport.php`), a view file (ex. `MyReport.view.php`) and a initiation file (`index.php`). The `SinglePage` allows us to create report in just one file, bundling all the controller, view and initiation file into one. Please view below example:
```
array(
"automaker"=>array(
"connectionString"=>"mysql:host=localhost;dbname=automaker",
"username"=>"root",
"password"=>"",
"charset"=>"utf8"
),
),
);
}
function setup()
{
$this->src('automaker')->query(
DB::table("customers")->select("customerNumber","customerName")
)
->pipe($this->dataStore("mydata"));
}
}
$report = new MyReport;
$report->start();
?>
Test
Testing
$report->dataStore('mydata')
));
?>
end(); ?>
```
As you may see from above example, we only have 1 file `index.php` containing controller classes `MyReport` and the view inside the `start()` and `end()` methods of report. We declare `use \koolreport\instant\SinglePage;` inside `MyReport` to provide two important methods above.
## Support
Please use our forum if you need support, by this way other people can benefit as well. If the support request need privacy, you may send email to us at [email protected]__.