codrasil / punchcard
A PHP Library for interacting with time records, time in, and time out.
v1.0.0
2019-03-16 00:58 UTC
Requires
- php: >=7.1
- nesbot/carbon: ^2.16
Requires (Dev)
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-10-21 21:52:21 UTC
README
A PHP Library for interacting with time records, time in, and time out.
Requirements
- php:
>=7.1
- nesbot/carbon:
^2.16
Installation
$ composer require codrasil/punchcard
{ "require": { "codrasil/punchcard": "^1.*" } }
Usage
use Codrasil\Punchcard\Punchcard; $punchcard = new Punchcard; $punchcard->setTimeIn('8:00 AM') // parses into 08:00:00 format ->setTimeOut('5 PM'); // uses Carbon\Carbon for parsing strings to \DateTime $punchcard->lunch($deductLunchHours = true); // calculate with lunch hours subtracted echo $punchcard->totalDuration()->toString(); // performs: $timeOut - $timeIn = $duration in 00:00:00 format. // outputs: 08:00:00 echo $punchcard->totalAM(); // outputs: 04:00:00 echo $punchcard->totalPM(); // outputs: 04:00:00 $punchcard->lunch(false); echo $punchcard->totalDuration()->toString(); // outputs: 09:00:00 // Other methods: $punchcard->setTimeIn('8:15 AM'); $punchcard->totalTardy()->toString(); $punchcard->totalTardyAM()->toString(); // this is the same with totalTardy // outputs: 00:15:00 // Assuming afternoon work resumes at 1PM: $punchcard->setTimeIn('1:15 PM'); $punchcard->totalTardyPM()->toString(); // outputs: 00:15:00 // Assuming work ends at 5PM $punchcard->setTimeOut('6:20 PM'); $punchcard->totalOvertime()->toString(); // outputs: 01:20:00 // Assuming work ends at 5PM $punchcard->setTimeOut('4:20 PM'); $punchcard->totalUndertime()->toString(); // outputs: 5:00PM - 4:20PM = 00:40:00 // AM undertime calculate against default_lunch_start $punchcard->totalUndertimeAM()->toString(); $punchcard->totalUndertimePM()->toString(); // this is the same with totalUndertime
Options
You may pass options upon initialization:
$options = [ 'default_time_in' => '09:00:00', // default is 08:00:00 'default_time_out' => '18:00:00', // default is 17:00:00 'default_lunch_start' => '12:00:00', // default 12:00:00 'default_lunch_end' => '13:00:00', // default 13:00:00 ]; $punchcard = new Punchcard($options);
Or via method setParams
:
$punchcard->setParams($options);
Documentation
coming soon
License
The Codrasil/Punchcard PHP library is open-source software licensed under the MIT license.