cognetif/poka-reporting

This package is abandoned and no longer maintained. The author suggests using the cognetif/report-generator package instead.

Poka Reporting - Generate Excel, CSV, HTML Reports

Maintainers

Details

gitlab.com/cognetif-os/poka-reporting

Issues

Installs: 105

Dependents: 0

Suggesters: 0

Security: 0

v0.2.0 2020-04-20 10:31 UTC

Requires

Requires (Dev)

MIT 9620f8771b3ee228b3c40fa5bd4f8f47f3746859

  • Jordin Brown <jbrown.woop@cognetif.com>

This package is auto-updated.

Last update: 2020-04-20 15:35:55 UTC

README

This library allows you to interact with the Poka API.

DEPRECATED

This library has been deprecated and development will continue with: cognetif-os/report-generator

Notice

This library has not been approved, licensed, commissioned or endorsed by Poka. It has been created and is maintained by a 3rd party: Cognetif.com

Installation

Installation with composer:

$ compose require cognetif/poka-reporting

Usage

  1. Create or extend theCognetif\PokaReporting\Report.
  2. Report::setHeaders($headers = []) function used to set the report headers.
  3. Report::addDataLine($line = []) function used to add a single line of data to the report body.
  4. Report::addDataSet($dataSet = []) function used to add the entire data set to the body.
  5. Report::makeCsv() or Report::makeHtml() or Report::makeExcel() functions used to control what type to output.
  6. Report::generate() to build and return the report.
  7. Report::clear() to clear the body dataset from the report. Headers are maintained.
  8. Report::setMaxMbMemory(int $mb = 5) to set the max number of megabytes used to generate a CSV report (Default: 5MB).

License

This library is protected under the MIT license. Please read the terms of the License.

Issues / Contributing

Contributions are welcome and encouraged. This library is open source but maintained by Cognetif.com. Please feel free to open an issue at: https://gitlab.com/cognetif-os/poka-api-client