PHPackages                             auroras-live/suncalc-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. auroras-live/suncalc-php

ActiveLibrary[Utility & Helpers](/categories/utility)

auroras-live/suncalc-php
========================

Sun and moon calculations for PHP

6915.0k↑106.8%20[15 issues](https://github.com/gregseth/suncalc-php/issues)[1 PRs](https://github.com/gregseth/suncalc-php/pulls)PHP

Since Feb 1Pushed 3y ago5 watchersCompare

[ Source](https://github.com/gregseth/suncalc-php)[ Packagist](https://packagist.org/packages/auroras-live/suncalc-php)[ RSS](/packages/auroras-live-suncalc-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

SunCalc PHP
===========

[](#suncalc-php)

SunCalc is a tiny PHP library for calculating sun position, sunlight phases (times for sunrise, sunset, dusk, etc.), moon position and lunar phase for the given location and time, based on the JavaScript library created by [Vladimir Agafonkin](http://agafonkin.com/en) ([@mourner](https://github.com/mourner)).

Most calculations are based on the formulas given in the excellent Astronomy Answers articles about [position of the sun](http://aa.quae.nl/en/reken/zonpositie.html)and [the planets](http://aa.quae.nl/en/reken/hemelpositie.html). You can read about different twilight phases calculated by SunCalc in the [Twilight article on Wikipedia](http://en.wikipedia.org/wiki/Twilight).

Usage example
-------------

[](#usage-example)

```
// initialise library class with date and coordinates today's sunlight times for Paris
$sc = new AurorasLive\SunCalc(new DateTime(), 48.85, 2.35);

// format sunrise time from the DateTime object
$sunTimes = $sc->getSunTimes();
$sunriseStr = $sunTimes['sunrise']->format('H:i');

// get position of the sun (azimuth and altitude) at today's sunrise
$sunrisePos = $sc->getPosition($sunTimes['sunrise']);

// get sunrise azimuth in degrees
$sunriseAzimuth = $sunrisePos->azimuth * 180 / M_PI;
```

Reference
---------

[](#reference)

### Sunlight times

[](#sunlight-times)

```
AurorasLive\SunCalc :: getSunTimes()
```

Returns an array with the following indexes (each is a `DateTime` object):

PropertyDescription`sunrise`sunrise (top edge of the sun appears on the horizon)`sunriseEnd`sunrise ends (bottom edge of the sun touches the horizon)`goldenHourEnd`morning golden hour (soft light, best time for photography) ends`solarNoon`solar noon (sun is in the highest position)`goldenHour`evening golden hour starts`sunsetStart`sunset starts (bottom edge of the sun touches the horizon)`sunset`sunset (sun disappears below the horizon, evening civil twilight starts)`dusk`dusk (evening nautical twilight starts)`nauticalDusk`nautical dusk (evening astronomical twilight starts)`night`night starts (dark enough for astronomical observations)`nadir`nadir (darkest moment of the night, sun is in the lowest position)`nightEnd`night ends (morning astronomical twilight starts)`nauticalDawn`nautical dawn (morning nautical twilight starts)`dawn`dawn (morning nautical twilight ends, morning civil twilight starts)`SunCalc::times` property contains all currently defined times.

### Sun position

[](#sun-position)

```
AurorasLive\SunCalc :: getSunPosition(/*DateTime*/ $timeAndDate)
```

Returns an object with the following properties:

- `altitude`: sun altitude above the horizon in radians, e.g. `0` at the horizon and `PI/2` at the zenith (straight over your head)
- `azimuth`: sun azimuth in radians (direction along the horizon, measured from south to west), e.g. `0` is south and `M_PI * 3/4` is northwest

### Moon position

[](#moon-position)

```
AurorasLive\SunCalc :: getMoonPosition(/*DateTime*/ $timeAndDate)
```

Returns an object with the following properties:

- `altitude`: moon altitude above the horizon in radians
- `azimuth`: moon azimuth in radians
- `distance`: distance to moon in kilometers

### Moon illumination

[](#moon-illumination)

```
AurorasLive\SunCalc :: getMoonIllumination()
```

Returns an array with the following properties:

- `fraction`: illuminated fraction of the moon; varies from `0.0` (new moon) to `1.0` (full moon)
- `phase`: moon phase; varies from `0.0` to `1.0`, described below
- `angle`: midpoint angle in radians of the illuminated limb of the moon reckoned eastward from the north point of the disk; the moon is waxing if the angle is negative, and waning if positive

Moon phase value should be interpreted like this:

PhaseName0New MoonWaxing Crescent0.25First QuarterWaxing Gibbous0.5Full MoonWaning Gibbous0.75Last QuarterWaning Crescent### Moon rise and set times

[](#moon-rise-and-set-times)

```
AurorasLive\SunCalc :: getMoonTimes($inUTC)
```

Returns an object with the following indexes:

- `rise`: moonrise time as `DateTime`
- `set`: moonset time as `DateTime`
- `alwaysUp`: `true` if the moon never rises/sets and is always *above* the horizon during the day
- `alwaysDown`: `true` if the moon is always *below* the horizon

By default, it will search for moon rise and set during local user's day (from 0 to 24 hours). If `$inUTC` is set to true, it will instead search the specified date from 0 to 24 UTC hours.

Changelog
---------

[](#changelog)

#### 0.0.2 — 21 Aug, 2018

[](#002--21-aug-2018)

- Make this into a class and add a composer.json file to allow use with things like Laravel

#### 0.0.1 — 29 Jul, 2017

[](#001--29-jul-2017)

- Preserve original timezone when passing in dates

#### 0.0.0 — 30 Dec, 2015

[](#000--30-dec-2015)

- First commit.

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance16

Infrequent updates — may be unmaintained

Popularity43

Moderate usage in the ecosystem

Community14

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/520e66020cf41205fcf79dcc544a43393fa3d97f0eed4bb6307bc0e470287149?d=identicon)[seasiri](/maintainers/seasiri)

---

Top Contributors

[![Grayda](https://avatars.githubusercontent.com/u/4891563?v=4)](https://github.com/Grayda "Grayda (5 commits)")

### Embed Badge

![Health badge](/badges/auroras-live-suncalc-php/health.svg)

```
[![Health](https://phpackages.com/badges/auroras-live-suncalc-php/health.svg)](https://phpackages.com/packages/auroras-live-suncalc-php)
```

###  Alternatives

[highideas/laravel-users-online

This package will provide an online users management.

203113.2k1](/packages/highideas-laravel-users-online)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)