amenadiel/jpgraph

Composer Friendly, full refactor of JpGraph, library to make graphs and charts

v4.1.1 2021-04-27 19:09 UTC

README

68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f616d656e616469656c2f6a706772617068 68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f616d656e616469656c2f6a7067726170682e737667 68747470733a2f2f6170702e666f7373612e696f2f6170692f70726f6a656374732f6769742532426769746875622e636f6d253246487561736f466f756e64726965732532466a7067726170682e7376673f747970653d736869656c64 badge.svg

JpGraph Community Edition was created as a Composer friendly port of JpGraph v3.5. With time and through incremental refactorings, it became a whole different library, with PSR-1 and PSR-2 compliant codebase, namespaces and folder hierarchy enabling PSR-4 autoloading, and more.

We are now, at most, distant cousins with the current official release.

Refactoring is an ongoing effort and we ensure editions and additions don't hurt our (already poor) metrics

68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f66383562393165396138356562346234333035392f6d61696e7461696e6162696c697479 68747470733a2f2f6170702e636f646163792e636f6d2f70726f6a6563742f62616467652f47726164652f6562323961656232393865613433373961323831646233356435356464656231 Scrutinizer Code Quality 68747470733a2f2f636f6465636f762e696f2f67682f487561736f466f756e64726965732f6a7067726170682f6272616e63682f6d61737465722f67726170682f62616467652e7376673f746f6b656e3d564553624d5632725334

What is JPGraph Community Edition?

As can be seen in their releases section, there was a six year pause in JPGraph release cycle, during which some of us had no choice but to code our way out of PHP 5.x. And thus "Community Edition" was born. From then on, this library evolved on its own and completely diverged from the official packages.

In general terms, JPGraph CE relies in PHP's thriving ecosystem. We aim to be a simple dependency you can seamlessly integrate in your app. JPGraph CE aligns with PHP Standards Reccomendations as published by the PHP Framework Interoperability Group, and when presented with the choice, will always pick an agnostic implementation over custom ones that reinvent the wheel. A lot of code has been trimmed and refactored with this purpose and a lot more is waiting to undergo such a change.

  • Distrbution through PHP's popular Packagist Registry
  • Relies in Composer, so you don't need to manually download or copy anything, nor check for platform and dependency requirements yourself.
  • PSR-4: Autoloader compliant structure. No need to resort to require or include in your code.
  • Sensible fallbacks to handle missing fonts or particular GD version features availability.
  • IDE friendly, allowing for autocompletion and go-to-definition where supported.
  • Integration pipelines checking new releases compatibility against different PHP versions
  • New or refactored code is expected to observe PSR-1 and PSR-2 coding standards (Eventually PSR-12 as well).

Comparing against the original v3.5 codebase, we also stripped examples or incomplete implementation of graph types exclusive to v3.5 pro (e.g. Barcodes).

Things that JPGraph CE is NOT

  • This library is NOT an official JPGraph package. The offcial package can be downloaded at JPGraph's downloads section of their website. They have a full featured free version with support for current and olver PHP versions.
  • Endorsed in any way by JPGraph's creator company Asial
  • A composer enabled wrapper for the official package
  • A drop-in replacement for the official package. We do not claim nor offer any kind of feature parity with the official package.

Requirements And Installation

This version requires PHP v7.2.0+. If you need to install this library package in older PHP environments please try

  • Upgrading your PHP installation. (No, really, even PHP 7.2 is past its EOL)
  • for PHP v7.0+ please try release v4.0.x
  • for PHP v5.6+ please check release v3.6.x

Install it Using composer

composer require amenadiel/jpgraph:^4

How to use

See the examples folder for working samples.

The examples work the same way you should use this library:

  • run composer install

  • require vendor/autoload.php it the top of your script

  • generate a graph with a snippet like the following

   require_once 'PATH/TO/vendor/autoload.php';

   use Amenadiel\JpGraph\Graph;
   use Amenadiel\JpGraph\Plot;

   // Create the Pie Graph.
   $graph = new Graph\PieGraph(350, 250);
   $graph->title->Set("A Simple Pie Plot");
   $graph->SetBox(true);

   $data = array(40, 21, 17, 14, 23);
   $p1   = new Plot\PiePlot($data);
   $p1->ShowBorder();
   $p1->SetColor('black');
   $p1->SetSliceColors(array('#1E90FF', '#2E8B57', '#ADFF2F', '#DC143C', '#BA55D3'));

   $graph->Add($p1);
   $graph->Stroke();
  • important make sure to instance the Graph (or Graph child class) before its content (for example, Plots). Doing this will load the global configuration to the global scope. Yeah, we know we are polluting the global scope with dozens of constants, but we are still refactoring 🤷 .

See the examples working by performing the following steps:

  • run composer install
  • run make start or php -S localhost:8000 -t Examples
  • Open your browser at http://localhost:8000

Change the config

You can override some configs set on config.inc.php by creating a .env file in your project root. See .env.example as a reference.

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):


Sean Zhang

💻

Shawn McCool

💻

Vinicius Dias

💻

Paul van der Knaap

💻

Florent Morselli

💻

Tony Murray

💻

Andreas

💻

Corey Watts

💻

Alexander Rakushin

💻

Muhammad Abid

💻

WhileTrue

🐛

This project follows the all-contributors specification. Contributions of any kind welcome!

Wishlist

  • Get all the examples working (half of them have yet to be transformed from the old code to the new PSR-4 format)
  • Add more tests (We need to test more classes and methods besides the ones in the examples, as well as perform more assetions on the current tests)
  • Add alternative use of imagick

jpgraph_logo

Similar Projects

License

FOSSA Status