suminagashi/figures

Statistics for your symfony app, simply.

dev-master 2020-08-02 11:14 UTC

Requires

• php: >=7.1
• ext-ctype: *
• ext-iconv: *
• doctrine/annotations: ^1.0
• doctrine/orm: ^2.7
• symfony/asset: 5.1.*
• symfony/console: 5.1.*
• symfony/dotenv: 5.1.*
• symfony/finder: 5.1.*
• symfony/flex: ^1.3.1
• symfony/framework-bundle: 5.1.*
• symfony/property-access: 5.1.*
• symfony/property-info: 5.1.*
• symfony/twig-bundle: 5.1.*
• symfony/webpack-encore-bundle: ^1.7
• symfony/yaml: 5.1.*
• twig/extra-bundle: ^2.12|^3.0
• twig/twig: ^2.12|^3.0

MIT

• Louis Harang

• annotations
• symfony
• statistics

README

#Figures

Statistics for your symfony app, simply.

Install the bundle :

Flex recipe incoming...

Register the bundle :

// config/bundles.php

return [
    ...
    Suminagashi\FiguresBundle\FiguresBundle::class => ['all' => true],
];

Add the Figure entity to your database :

php bin/console doctrine:schema:update --force

Setup your entities :

First you need to import Suminagashi\FiguresBundle\Annotation\Watch annotation. Then you have to write add the key of your stat, the type (cumul or count) and the lifecycle (at which lifecycle you want the stat to register).

use Suminagashi\FiguresBundle\Annotation\Watch;

class Product
{
    //...

    /**
     *
     * @ORM\Column(type="integer")
     *
     * @Watch(key="product:price", type="cumul", lifecycle="update")
     * @Watch(key="product:sell", type="count", lifecycle="create")
     */
    private $price;

    //***

How does this works :

There is two mode of stats calculation :

• count is for counting the number of sales (e.g).
• cumul is for calculating the amount of sales (e.g).

How to get a specific stats :

First you need to import Suminagashi\FiguresBundle\Tools\Figures in your code. Then you can autowire the class and start using it. We provide few methods to help you :

$figures = new Figures();

$figures->all('key');
$figures->getToday('key');
$figures->getLastweek('key');
$figures->getLastmonth('key');
$figures->getLastyear('key');
$figures->get('key', 'start', 'end');

Coming :

• Stat percentages calculations.
• Statut type
• Better exception handling
• Handle delete (cascade)