spatie / sun
Get information on the position of the sun
Fund package maintenance!
spatie
spatie.be/open-source/support-us
Installs: 106 463
Dependents: 2
Suggesters: 0
Security: 0
Stars: 70
Watchers: 5
Forks: 12
Open Issues: 0
Requires
- php: ^8.0|^7.4
- nesbot/carbon: ^2.32
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.16
- pestphp/pest: ^1.0
- spatie/test-time: ^1.2
- symfony/var-dumper: ^4.3
README
Get information on the position of the sun
This package can determine several things on the position of the sun.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.
We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.
Installation
You can install the package via composer:
composer require spatie/sun
Usage
When instantiating Spatie\Sun\Sun
you should pass it coordinates.
$coordinatesOfAntwerp = ['lat' => 51.260197, 'lng' => 4.402771]; $sun = new Sun($coordinatesOfAntwerp['lat'], $coordinatesOfAntwerp['lng']);
Get the time of sunrise
You can get the time of the sunrise.
$sun->sunrise(); // returns an instance of \Carbon\Carbon
You can get the time of the sunrise on a specific date by passing in instance of Carbon\Carbon
to sunrise
$sun->sunrise($carbon); // returns an instance of \Carbon\Carbon
Get the time of zenith
You can get the time of the zenith.
$sun->zenith(); // returns an instance of \Carbon\Carbon
You can get the time of the zenith on a specific date by passing in instance of Carbon\Carbon
to zenith
$sun->zenith($carbon); // returns an instance of \Carbon\Carbon
Get the time of sunset
You can get the time of the sunset.
$sun->sunset(); // returns an instance of \Carbon\Carbon
You can get the time of the sunset on a specific date by passing in instance of Carbon\Carbon
to sunset
$sun->sunset($carbon); // returns an instance of \Carbon\Carbon
Determine if the sun is up
This is how you can determine if the sun is up:
$sun->sunIsUp(); // returns a boolean
You can get determine if the sun is up at a specific moment by passing in instance of Carbon\Carbon
to sunIsUp
$sun->sunIsUp($carbon); // returns a boolean
Testing
composer test
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you've found a bug regarding security please mail security@spatie.be instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.