This package is a lightweight solution to record and view the statistics for the dashboard or reports. Sometimes we need KPI / Metrics / Statistics in our Dashboard Or Reports, to create those statistics we need to go through lots of calculation, queries etc. But this package may helps you to make statistics in nicer way, the statistics stored in a single db table, so it would be faster or easier to retrieve.
Lots of dashboard or reports have statistic widget like total customer, total user, total pending orders, total sales etc. For these statistic widgets we applied query across tables, rows along with mathematical equation to get the single unified numeric value. For small database the approach is ok but for large database the calculation may hamper the performance or create complexity. So what if we could calculate the statistics during the CRUD operation.
Total User Counting:
Increase a user whenever a new user is store, Decrease a user whenever user delete.
use RadiateCode\DaStats\Facades\Stats;
.......
public function storeUser(Request $request){
// stores statements
............
Stats::title('User count')->key('total-user')->increase();
}
public function deleteUser($id){
// delete statements
............
Stats::key('total-user')->decrease();
}Total Pending Orders:
Increase or count total pending order whenever a new pending order placed, Decrease total pending order whenever an order successfully delivered.
use RadiateCode\DaStats\Facades\Stats;
.......
public function orderStore(Request $request){
// pending order placement statements
............
Stats::title('Pending order count')->key('total-pending-order')->increase();
}
public function orderDeliver(Request $request){
// order delivery statements
............
Stats::key('total-pending-order')->decrease();
} Product Stocks:
Increase product stock whenever new products purchased,
use RadiateCode\DaStats\Facades\Stats;
.......
public function purchaseStore(Request $request){
// other statements
............
foreach($purchaseProducts as $product){ // multiple products
// purchase products save statements
..............
// increase stock for a product
Stats::title('Live stock')->key($product->id)->increase($product->quantity);
}
}Update product stock: sometime we need to update purchase product quantity for example quantity add or subtract in the same view, in that case our product stock also need to reflect accordingly.
use RadiateCode\DaStats\Facades\Stats;
.......
public function purchaseUpdate(Request $request){
// other statement
............
foreach($purchaseProducts as $product){
// purchase products update statements
..............
..............
//live stock
$variation = (int) $newQty - $oldQty;
Stats::when($variation > 0,function ($stats) use ($product,$variation){
$stats->title('Live stock')->key($product->id)->increase($variation);
});
Stats::when($variation < 0,function ($stats) use ($product,$variation){
$stats->title('Live stock')->key($product->id)->decrease(abs($variation));
});
}
}Decrease product stock whenever a purchase product is delete.
use RadiateCode\DaStats\Facades\Stats;
.......
public function productDelete($id){
// other statement
............
// find product
$purchaseProduct = PurchaseProduct::findOrFail($id);
// decrese value for this product
Stats::title('Live stock')->key($purchaseProduct->id)->decrease($purchaseProduct->quantity);
$purchaseProduct->delete(); // purchase product delete
}Above examples have shown us that how we can create stats by placing increase(), decrease() inside data CRUD operations.
Now let's get or view our stats.
$stats = Stats::key('total-pending-order')->find();
$stats = Stats::key('total-user')->find();
$stock = Stats::title('Live stock')->get();or
$stats = Stats::inKeys('total-pending-order','total-user')->get();
// get stock by product ids
$stocks = Stats::inKeys(1,22,55,66)->get(); or
$stats = Stats::contains('pending')->get();You can install the package via composer:
composer require radiatecode/dastats
Migrate the stats table
php artisan dastats:table
php artisan migrate
You can publish config file (optional)
php artisan vendor:publish --provider="RadiateCode\DaStats\StatsServiceProvider" --tag="dastats-config"
Increase stats for given key and title.
Stats::title('Your Title')->key('your-key')->increase(); Increase by default 1, But you can pass any specific numerical value.
Under the hood increase() check is there any stats exits for the given key & title, if yes it will increment, if not it will create new record
Decrease stats value for given key.
Stats::key('your-key')->decrease();or
Stats::title('Your Title')->key('your-key')->decrease();Decrease method decrease a stats by 1 (default), But you can decrease by any specific value.
Under the hood decrease() checks stats existence, if found it will decrement otherwise return null. During decrement if the decrement comes at zero it will delete the stats record from the storage.
In some cases we need to replace our existing stats value in those cases replace() can be used
Stats::key('your-key')->replace($value);or
Stats::title('Your Title')->key('your-key')->replace($value);Stats::inKeys('key-1','key-2')->get();Stats::inKeys('key-1','key-2')->paginate(10);Stats::title('Title 1')->key('key-1')->find();or
Stats::key('key-1')->find();Stats::title('Title 1')->key('key-1')->exists(); // return true/falseor
// based on existence do stats operation
Stats::title('Title')->key('key-1')->exists(
function ($stats){ // if exists
$stats->replace(300);
},function ($stats){ // if not exists
$stats->increase(25);
}
);Stats::contain('partOfkey')->get();
example:
// key name is `total-registered-user`
// we can get stats by the key part `registered`
Stats::contain('registered')->get();$stats = Stats::key('key-1')->remove();or
Stats::inKeys('key-1','key-2','key-3')->remove();Join stats table with other db tables
joinWith used to join a db table with stats table
Stats::joinWith('products', 'id') // joining products table
->title('inventory')
->get(['products.product_name', 'products.product_unit']);join as many tables as you want like regular laravel db join
Stats::joinWith('products', 'id') // joining products table
->join('categories','categories.id','=','products.category_id') // join categories table with products
->join('units','units.id','=','products.unit_id') // join units table with products
->title('inventory')
->get(['products.product_name', 'products.product_unit','categories.category_name','units.unit_name']);Note: get() method accept an array as an argument where it executes as db 'select' statement
Isolation can be useful for SaaS applications, certain stats can be stored for individual user or organisation or tenant.
Stats::isolate('Tenant',101)->title('Total Order')->key('order-count')->increment();
Stats::isolate('Tenant',101)->key('order-count')->find();or
Stats::isolate('User',202)->title('Complete Project')->key('project-completion')->increment();
Stats::isolate('User',202)->key('project-completion')->find();Stats::when($some_condition,function($stats){
return $stats->title('Title 1')->key('key-1')->increase(8000);
});or
Stats::title('Title 1')->key('key-1')
->when($some_condition,
function($stats){ // when condition true
return $stats->decrease(2500);
},function(){ // when condition false
return $stats->increase(500);
}
);or
Stats::when($has_tenant,function($stats) use ($tenantId){
return $stats->isolate('Tenant', $tenantId);
})->all();For multiple increase or decrease we can use doMany()
use RadiateCode\DaStats\Enum\StatsAction;
...........
// data format
$data = [
['key' => 'key-1','value' = 40],
['key' => 'key-2','value' = 25],
['key' => 'key-3','value' = 35],
]
// action (ex: StatsAction::INCREASE, StatsAction::DECREASE, StatsAction::REPLACE)
$action = StatsAction::INCREASE
Stats::title('Live stock')->doMany($action,$data);when required isolation
// data format
$data = [
['key' => 'key-1','value' = 40],
['key' => 'key-2','value' = 25],
['key' => 'key-3','value' = 35],
]
Stats::isolate('Organisation',$organisaiton->id)->title('Live stock')->doMany(StatsAction::INCREASE,$data);Note: Data format should be followed as the example.
So In example 3 we see that increase operation used inside purchase products loop, but now we can use doMany() to do multiple increase by passing an array which contain product id and quantity
Stats::title('Live stock')->doMany(
StatsAction::INCREASE,
[
['key' => 1,'value' = 500], // key => product id and value => quantity
['key' => 5,'value' = 152],
['key' => 35,'value' = 7569],
['key' => 7,'value' = 900],
['key' => 9,'value' = 25],
]
);Sometimes we need to queue our stats so that it can run in the background without delaying user response, so in that case we can use predefined jobs.
Note: make sure we have configured Laravel Queue and run the queue worker
Single stats job:
use RadiateCode\DaStats\Jobs\SingleStatsJob;
use RadiateCode\DaStats\Enum\StatsAction;
..........
// dispatch the job to increase a stats
dispatch(new SingleStatsJob(StatsAction::INCREASE,'Title','key',$value));
or
// dispatch the job to decrease a stats
dispatch(new SingleStatsJob(StatsAction::DECREASE,'Title','key',$value));
// dispatch the job to replace a stats
dispatch(new SingleStatsJob(StatsAction::REPLACE,'Title','key',$value));Multiple stats job:
use RadiateCode\DaStats\Jobs\MultiStatsJob;
use RadiateCode\DaStats\Enum\StatsAction;
..........
$data = [
['key' => 1,'value' = 500],
['key' => 5,'value' = 152],
];
// dispatch the job to decrease multiple stats value
dispatch(new MultiStatsJob(StatsAction::DECREASE,'Title',$data));or
// dispatch the job to increase multiple stats value
dispatch(new MultiStatsJob(StatsAction::INCREASE,'Title',$data));when required isolation
use RadiateCode\DaStats\Jobs\MultiStatsJob;
use RadiateCode\DaStats\Enum\StatsAction;
..........
$data = [
['key' => 1,'value' = 500],
['key' => 5,'value' = 152],
];
$job = new MultiStatsJob(StatsAction::DECREASE,'Title',$data);
$job->withIsolation('Tenant',1001);
dispatch($job);
Stats can be call either by Stats Facade or new Stats() class
Here are available methods
| Methods | Return | Note |
|---|---|---|
isolate(string $name,int $id) |
return stats object | used for stats isolation |
title(string $title) |
return stats object | set stats title |
key(string $key) |
return stats object | set stats key |
contain(string $key) |
return stats object | set part of key |
increase(int value = 1) |
return bool | increase by default 1, can be pass specific numerical value |
decrease(int value = 1) |
return bool | decrease by default 1, can be pass any numerical value |
replace(int value) |
return bool | replace existing stats value |
doMany(string $action, array $data) |
return bool | increase, decrease or replace multiple data |
inKeys(...$key) |
return stats object | find stats by multiple keys |
find() |
return mixed or eloquent collection | find specific stats |
paginate(int $perPage = 10) |
return mixed or eloquent collection | get stats by paginate |
get(array $columns = []) |
return mixed or eloquent collection | get stats data, argument used to select table columns |
exists(callable $existsCallback = null,callable $notExistsCallback = null) |
return true/false if args empty | we can apply stats operation based on exist condition by passing args, 1st arg works when stats exists, 2nd arg works when stats not exists. If no args pass then it simply return true/false. |
remove() |
return true or false | remove particular stats |
when(bool $value,callable $callback,callable $default = null) |
return stats object | conditionally apply stats operation |
joinWith(string $table,string $pk = 'id') |
return stats object | join the table with stats table |
join($table, $first, $operator = null, $second = null) |
return stats object | join more than one table with stats |
Please see CONTRIBUTING for details.
If you discover any security related issues, please email radiate126@gmail.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.