PHPackages bradietilley/carbon-zodiac - 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. bradietilley/carbon-zodiac ActiveLibrary[Utility & Helpers](/categories/utility) bradietilley/carbon-zodiac ========================== A Zodiac Carbon package v2.0.0(2y ago)2462[5 issues](https://github.com/bradietilley/carbon-zodiac/issues)MITPHP Since May 17Pushed 1y ago1 watchersCompare [ Source](https://github.com/bradietilley/carbon-zodiac)[ Packagist](https://packagist.org/packages/bradietilley/carbon-zodiac)[ RSS](/packages/bradietilley-carbon-zodiac/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (2)Dependencies (5)Versions (3)Used By (0) Carbon Zodiac ============= [](#carbon-zodiac) A simple package that provides an interface for converting dates to Zodiac signs and elements. ### Installation [](#installation) ``` composer require bradietilley/carbon-zodiac ``` ### Limitations [](#limitations) Currently, only dates between 1648 and 2644 are supported. If you'd like to utilise this package for dates beyond that range, please make a pull request which includes your requested updates to the `NewYears::THRESHOLDS` constant and please cite your source(s). ### Usage [](#usage) You may either use the `Carbon` macros, use the `BradieTilley\Zodiac\Zodiac` class, or use each class/enum directly. Here are a few examples: **Using Carbon Macros:** Laravel will auto boot the Carbon macros, but should you need to boot it yourself on non-Laravel projects that use `Carbon\Carbon`, it's really easy: ``` \BradieTilley\Zodiac\Zodiac::boot(); ``` Once booted, or in Laravel apps, you can leverage the `Carbon` macros to fetch the data you need: ``` use Carbon\Carbon; use BradieTilley\Zodiac\Zodiac; use BradieTilley\Zodiac\Sign; use BradieTilley\Zodiac\Element; /** Set up some dummy dates */ $date1 = Carbon::parse('1970-02-05'); $date2 = Carbon::parse('1970-02-06'); /** Convert a date to a zodiac year */ $date1->zodiacYear(); // 1969 $date2->zodiacYear(); // 1970 /** Convert a date to a zodiac sign */ $date1->zodiacSign(); // Sign::ROOSTER $date2->zodiacSign(); // Sign::DOG /** Convert a date to a zodiac element */ $date1->zodiacElement(); // Element::EARTH $date2->zodiacElement(); // Element::METAL ``` **Using Zodiac Helper:** Alternatively you may wish to not leverage the `Carbon` macros at all, which can be achieved via the `Zodiac` helper: ``` use Carbon\Carbon; use BradieTilley\Zodiac\Zodiac; use BradieTilley\Zodiac\Sign; use BradieTilley\Zodiac\Element; /** Set up some dummy dates */ $date1 = Carbon::parse('1970-02-05'); $date2 = Carbon::parse('1970-02-06'); /** Convert a date to a zodiac year */ Zodiac::yearFromDate($date1); // Year Zodiac::yearFromDate($date2); // Year /** Convert a date to a zodiac sign */ Zodiac::signFromDate($date1); // Sign::ROOSTER Zodiac::signFromDate($date2); // Sign::DOG /** Convert a date to a zodiac element */ Zodiac::elementFromDate($date1); // Element::EARTH Zodiac::elementFromDate($date2); // Element::METAL ``` For now, only Carbon instances are supported. Future releases might scale this back to be any `DateTimeInterface`. **Using Classes Directly:** ``` use Carbon\Carbon; use BradieTilley\Zodiac\Zodiac; use BradieTilley\Zodiac\Sign; use BradieTilley\Zodiac\Element; /** Set up some dummy dates */ $date1 = Carbon::parse('1970-02-05'); $date2 = Carbon::parse('1970-02-06'); /** Convert a date to a zodiac year */ Year::fromDate($date1); // Year Year::fromDate($date2); // Year /** Convert a date to a zodiac sign */ Sign::fromDate($date1); // Sign::ROOSTER Sign::fromDate($date2); // Sign::DOG /** Convert a date to a zodiac element */ Element::fromDate($date1); // Element::EARTH Element::fromDate($date2); // Element::METAL ``` Extended Usage -------------- [](#extended-usage) Given a zodiac `Sign` enum instance, you can then find more details of the sign by leveraging a few helper methods: ``` $rooster = Sign::fromDate(Carbon::parse('1970-02-05')): $dog = Sign::fromDate(Carbon::parse('1970-02-06')): $rooster->yinYang(); // Yin $rooster->direction(); // West $rooster->season(); // Mid-Autumn $rooster->fixedElement(); // Metal $rooster->trine(); // 2 $dog->yinYang(); // Yang $dog->direction(); // West $dog->season(); // Late Autumn $dog->fixedElement(); // Earth $dog->trine(); // 3 ``` The `Year` class ---------------- [](#the-year-class) The `Year` class is a DTO wrapping the integer year (e.g. `2024`) and includes helper methods to traverse through the years, fetch the associated `Sign` and `Element`, and determine the start / end date of the year. Example usage: ``` $year = Year::fromDate(Carbon::parse('2024-02-10')); $year = Year::fromYear(2024); // same as above $year->prev(); // Year $year->next(); // Year $year->sign(); // Sign::DRAGON $year->element(); // Element::WOOD json_encode($year->toArray()); /** * { * "year": 2024, * "start": "2024-02-10", * "end": "2025-01-28" * } */ ``` The `Sign` enum --------------- [](#the-sign-enum) The `Sign` enum is a PHP Enum object that contains the 12 signs, and can be resolved via the `from*` methods, amongst other approaches documented elsewhere. Example usage: ``` $sign = Sign::fromDate(Carbon::parse('2024-02-10')); $sign = Sign::fromYear(2024); // same as above $sign; // Sign::DRAGON $sign->value; // dragon $sign->label(); // Dragon json_encode($sign->toArray()); /** * { * "value": "dragon", * "label": "Dragon", * "data": { * "yin_yang": "Yang", * "direction": "East", * "season": "Late Spring", * "fixed_element": { * "value": "earth", * "label": "Earth" * }, * "trine": 1 * } * } */ ``` The `Element` enum ------------------ [](#the-element-enum) The `Element` enum is a PHP Enum object that contains the 5 elements, and can be resolved via the `from*` methods, amongst other approaches documented elsewhere. Example usage: ``` $element = Element::fromDate(Carbon::parse('2024-02-10')); $element = Element::fromYear(2024); // same as above $element; // Element::WOOD $element->value; // wood $element->label(); // Wood json_encode($element->toArray()); /** * { * "value": "wood", * "label": "Wood", * } */ ``` Other Usage ----------- [](#other-usage) There's probably more features or ways to interact with these objects so feel free to have a browse into the code see what's possible. Issues and Notice: ------------------ [](#issues-and-notice) There's no guarantee anything here is perfect, but it's so far gotten every date correct I have tried. If you spot any issues please open an issue in GitHub. Author ------ [](#author) - [Bradie Tilley](https://github.com/bradietilley) Source ------ [](#source) **Lunar New Year thresholds:** In the `NewYears` class I've noted the source. Huge thanks to them, and their source. **Element and Sign cycles:** Sourced from *various* online places to ensure the cycling of signs and elements are correct. No source cited for this, currently. **Element extra information** This refers to an Element's season, direction, fixed element, trine, etc. This data was sourced from... Wikipedia. Take it with a grain of salt, but from what I can tell, it's "correct" 🤷 License ------- [](#license) MIT... or whatever the "use it and have fun without needing to worry about anything" license is. If you use it and are happy to share your project name/URL, feel free to mention it in a PR and add it below or something. Where it's used; ---------------- [](#where-its-used) - Nowhere yet. lol. ### Health Score 22 — LowBetter than 22% of packages Maintenance10 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community7 Small or concentrated contributor base Maturity45 Maturing project, gaining track record 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. ### Release Activity Cadence Every ~268 days Total 2 Last Release 823d ago Major Versions 1.0.0 → v2.0.02024-02-10 ### Community Maintainers ![](https://www.gravatar.com/avatar/f93c7d77d882d4106664cca209c6dccc0e531f307f56dc2247937358d193ef0b?d=identicon)[bradietilley](/maintainers/bradietilley) --- Top Contributors [![bradietilley](https://avatars.githubusercontent.com/u/44430471?v=4)](https://github.com/bradietilley "bradietilley (55 commits)") ### Code Quality TestsPest Static AnalysisPHPStan Code StyleLaravel Pint Type Coverage Yes ### Embed Badge ![Health badge](/badges/bradietilley-carbon-zodiac/health.svg) ``` [![Health](https://phpackages.com/badges/bradietilley-carbon-zodiac/health.svg)](https://phpackages.com/packages/bradietilley-carbon-zodiac) ``` ### Alternatives [barryvdh/laravel-ide-helper Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion. 14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[orchestra/canvas Code Generators for Laravel Applications and Packages 21017.2M158](/packages/orchestra-canvas)[illuminate/pipeline The Illuminate Pipeline package. 9446.6M213](/packages/illuminate-pipeline)[illuminate/pagination The Illuminate Pagination package. 10532.5M862](/packages/illuminate-pagination)[spatie/laravel-pjax A pjax middleware for Laravel 5 513371.8k11](/packages/spatie-laravel-pjax)[spatie/laravel-mix-preload Add preload and prefetch links based your Mix manifest 169176.0k2](/packages/spatie-laravel-mix-preload) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)