A comprehensive Laravel package for calculating zakat on various assets including money, gold, silver, business assets, and agricultural products. This package follows Islamic principles and supports multiple calculation methods.
- Calculate zakat on multiple asset types:
- Cash and bank balances
- Gold (supports multiple karats)
- Silver
- Business assets (inventory, receivables, cash)
- Agricultural products
- Support for different calculation methods (Hanafi, Shafi'i, Maliki, Hanbali)
- Configurable nisab thresholds
- Real-time gold and silver price integration
- Detailed calculation breakdowns
- Caching support for better performance
- Comprehensive validation and error handling
You can install the package via composer:
composer require tawwfik/zakat-calculatorThe package will automatically register its service provider.
You can publish the configuration file using:
php artisan vendor:publish --provider="Tawfik\ZakatCalculator\ZakatServiceProvider" --tag="config"This will create a config/zakat.php file in your config directory.
use Tawfik\ZakatCalculator\ZakatCalculator;
class ZakatController extends Controller
{
protected $calculator;
public function __construct(ZakatCalculator $calculator)
{
$this->calculator = $calculator;
}
public function calculate(Request $request)
{
$result = $this->calculator
->setCash($request->cash)
->setGoldItems([
['weight' => 100, 'karat' => 24],
['weight' => 50, 'karat' => 18]
])
->setSilverWeight(500)
->setBusinessAssets([
'inventory' => 5000,
'receivables' => 2000,
'cash_at_bank' => 3000
])
->setAgriculturalProducts([
['value' => 10000, 'irrigated' => true],
['value' => 20000, 'irrigated' => false]
])
->calculate();
return response()->json($result);
}
}setCash(float $cash): Set cash amountsetGoldItems(array $goldItems): Set gold items with weight and karatsetSilverWeight(float $silverWeight): Set silver weightsetGoldPrice(float $goldPrice): Set gold price per gramsetSilverPrice(float $silverPrice): Set silver price per gramsetBusinessAssets(array $assets): Set business assetssetAgriculturalProducts(array $products): Set agricultural products
setCalculationMethod(string $method): Set calculation method (hanafi, shafi, maliki, hanbali)setNisabThreshold(float $threshold): Set custom nisab thresholdsetCacheEnabled(bool $enabled): Enable/disable cachingsetCacheTTL(int $ttl): Set cache time-to-live in seconds
calculate(): Calculate total zakatcalculateCashZakat(): Calculate zakat on cash onlycalculateGoldZakat(): Calculate zakat on gold onlycalculateSilverZakat(): Calculate zakat on silver onlycalculateBusinessZakat(): Calculate zakat on business assets onlycalculateAgriculturalZakat(): Calculate zakat on agricultural products only
The calculate() method returns an array with the following information:
[
'total_assets' => [
'cash' => float,
'gold' => float,
'silver' => float,
'business' => float,
'agricultural' => float
],
'nisab_value' => float,
'is_eligible' => boolean,
'total_zakat' => float,
'details' => [
'cash' => [
'amount' => float,
'zakat' => float
],
'gold' => [
'items' => array,
'total_weight' => float,
'total_value' => float,
'zakat' => float
],
'silver' => [
'weight' => float,
'value' => float,
'zakat' => float
],
'business' => [
'assets' => array,
'total_value' => float,
'zakat' => float
],
'agricultural' => [
'products' => array,
'total_value' => float,
'zakat' => float
]
],
'calculation_method' => string
]After publishing the configuration file, you can customize the following settings in config/zakat.php:
'default_prices' => [
'gold' => 0.00, // Set your default gold price per gram
'silver' => 0.00, // Set your default silver price per gram
],'nisab' => [
'gold' => 85, // grams of gold
'silver' => 595, // grams of silver
],'currency' => [
'code' => 'SAR', // Currency code
'symbol' => 'ر.س', // Currency symbol
'position' => 'before', // Symbol position: 'before' or 'after'
],'weight_unit' => 'gram', // 'gram' or 'ounce''precision' => 2, // Number of decimal places'supported_karats' => [24, 22, 21, 18, 14, 12, 10],'cache' => [
'enabled' => true,
'ttl' => 3600, // Cache time-to-live in seconds
],'calculation_methods' => [
'default' => 'hanafi', // Available: 'hanafi', 'shafi', 'maliki', 'hanbali'
],'business' => [
'inventory' => true, // Include inventory in calculation
'receivables' => true, // Include receivables in calculation
'cash_at_bank' => true, // Include bank cash in calculation
'cash_in_hand' => true, // Include cash in hand in calculation
],'agricultural' => [
'irrigated_rate' => 0.05, // 5% rate for irrigated crops
'non_irrigated_rate' => 0.1, // 10% rate for non-irrigated crops
],$result = $calculator
->setGoldItems([
['weight' => 100, 'karat' => 24],
['weight' => 50, 'karat' => 18]
])
->setGoldPrice(100) // Price per gram
->calculateGoldZakat();$result = $calculator
->setBusinessAssets([
'inventory' => 5000,
'receivables' => 2000,
'cash_at_bank' => 3000,
'cash_in_hand' => 1000
])
->calculateBusinessZakat();$result = $calculator
->setAgriculturalProducts([
['value' => 10000, 'irrigated' => true], // Irrigated crops (5%)
['value' => 20000, 'irrigated' => false] // Non-irrigated crops (10%)
])
->calculateAgriculturalZakat();$result = $calculator
->setCalculationMethod('shafi')
->setCash(10000)
->setGoldItems([['weight' => 100, 'karat' => 24]])
->calculate();The package throws specific exceptions for different error cases:
InvalidInputException: Thrown for invalid input valuesInvalidKaratException: Thrown for unsupported gold karatsConfigurationException: Thrown for missing or invalid configuration
Example error handling:
use Tawfik\ZakatCalculator\Exceptions\InvalidInputException;
try {
$result = $calculator->setCash(-1000)->calculate();
} catch (InvalidInputException $e) {
return response()->json(['error' => $e->getMessage()], 400);
}Run the tests using:
composer testPlease see CONTRIBUTING.md for details.
If you discover any security related issues, please email security@tawfik.com instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.