README

Pure domain logic for leave management operations

Features

• Leave application and approval
• Leave balance calculation
• Accrual strategies (monthly, fixed allocation, custom law-adjusted)
• Carry-forward processing
• Proration calculations
• Leave encashment
• Overlap detection
• Policy validation

Installation

composer require azaharizaman/nexus-leave-management

Key Concepts

Contracts

• LeaveRepositoryInterface - Leave data access
• LeaveBalanceRepositoryInterface - Balance tracking
• LeaveCalculatorInterface - Balance calculations
• AccrualStrategyInterface - Accrual strategy contract
• LeavePolicyInterface - Policy enforcement

Entities

• Leave - Leave record entity
• LeaveType - Leave type definition
• LeaveBalance - Employee leave balance
• LeaveEntitlement - Leave entitlement rules

Services

• LeaveBalanceCalculator - Balance computation
• LeaveAccrualEngine - Accrual processing
• LeavePolicyValidator - Policy compliance
• LeaveOverlapDetector - Overlap detection
• CarryForwardProcessor - Year-end carry-forward

Architecture

This is a framework-agnostic domain package:

• Pure PHP 8.3+
• No framework dependencies
• Contract-driven design
• All dependencies via interfaces

Documentation

Comprehensive documentation is available in the docs/ folder:

• Getting Started Guide - Quick start guide with prerequisites, core concepts, and first integration
• API Reference - Complete documentation of all interfaces, services, enums, and exceptions
• Integration Guide - Framework-specific integration examples for Laravel and Symfony
• Examples - Working code examples:
  • Basic Usage - Fundamental operations (balance checks, leave applications)
  • Advanced Usage - Advanced scenarios (custom strategies, proration, carry-forward)

Quick Links

Contributing

See IMPLEMENTATION_SUMMARY.md for current implementation status and pending tasks.

License

MIT