Calculator

• Instantiation
  • Constructor
  • Static Factory Method
• Calculation
  • From String Dates
  • From Date Objects
  • From Unix Timestamps
• Compatibility
  • Compare Zodiac Signs

Instantiation

Constructor

public Calculator::__construct(Astrology $astrology = Astrology::WESTERN): void

Create the calculator using the constructor. It is possible to specify the calculation type, which outputs Western zodiac signs by default.

The calculation method defined here serves as the default; it can be overridden in the following calculation calls, as you will see later.

Parameters

Name	Type	Description
astrology	Astrology	Optional astrology on which the calculation is based. Western by default.

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;

// create calculator (western by default)
$calculator = new Calculator();

// create calculator for chinese signs
$calculator = new Calculator(Astrology::CHINESE);

Static Factory Method

public Calculator::withAstrology(Astrology $astrology): CalculatorInterface

Create the calculator using the static factory method. You can specify the astrology type, which defines the calculation method for all following calls but can be overridden in the following calculation calls, as you will see later.

Parameters

Name	Type	Description
astrology	Astrology	Astrology type on which the calculation is based

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;

// create calculator for chinese signs
$calculator = Calculator::withAstrology(Astrology::CHINESE);

Calculation

The calculator class can read dates from integer types (unix timestamp) as well as text strings, which can represent a relative time, an absolute time or an unix timestamp as string. It is also possible to read from date objects.

From String Dates

public Calculator::fromString(string|Stringable $date, null|Astrology $astrology = null): SignInterface

Create zodiac signs based on the given strings, which can represent a relative date (last monday, tomorrow or last day of next month) or an absolute time like 2011-11-16, first day of june 2015.

Parameters

Name	Type	Description
date	string or Stringable	String representation of a date
astrology	null or Astrology	Optional astrology enum value on which the calculation is based

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;

// create from iso date
$sign = Calculator::fromString('1992-03-19');

// create from relative date
$sign = Calculator::fromString('first day of June 2008');

// calculate chinese zodiac sign from relative date by overriding the default
$sign = Calculator::fromString('first day of June 2008', Astrology::CHINESE);

From Date Objects

public Calculator::fromDate(DateTimeInterface $date, null|Astrology $astrology = null): SignInterface

Pass date objects (DateTime or Carbon\Carbon) to instantiate new zodiac objects.

Parameters

Name	Type	Description
date	DateTimeInterface	Date object to calculate the zodiac sing from
astrology	null or Astrology	Optional astrology enum value on which the calculation is based

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;
use DateTime;
use Carbon\Carbon;

// create western calculator
$calculator = Calculator::withAstrology(Astrology::WESTERN);

// create sign from datetime object
$sign = $calculator->fromDate(new DateTime('1977-03-15'));

// create chinese sign from datetime object
$sign = $calculator->fromDate(new DateTime('1977-03-15'), Astrology::CHINESE);

// create western zodiac sign from carbon object
$zodiac = $calculator->fromDate(Carbon::yesterday());

From Unix Timestamps

public Calculator::fromUnix(int|string $date, null|Astrology $astrology = null): SignInterface

Calculate zodiac from given unix timestamp date, which can be either an integer or a numeric string.

Parameters

Name	Type	Description
date	int	string
astrology	null or Astrology	Optional astrology enum value on which the calculation is based

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;

// create calculator (western by default)
$calculator = new Calculator();

// create sign from unix timestamp integer
$sign = $calculator->fromUnix(228268800);

// create sign from unix timestamp string
$sign = $calculator->fromUnix('228268800');

// create chinese zodiac sign from unix timestamp
$sign = $calculator->fromUnix(209262190, Astrology::CHINESE);

Compatibility

Compare Zodiac Signs

public Calculator::compare(SignInterface $sign, SignInterface $with): float

It is said that zodiac signs have a certain type of relationship with each other. While some combinations are said to be compatible, others tend to cause problems (if you believe in it).

Intervention Zodiac lets you explore this astrological compatibility by comparing two signs with each other and calculating a compatibility which ranges from 0 (bad) to 1 (very good).

Parameters

Name	Type	Description
sign	SignInterface	Sign for comparision
with	SignInterface	Zodiac sign to compare with first sign

Example

use Intervention\Zodiac\Calculator;
use Intervention\Zodiac\Astrology;

// create calculator
$calculator = new Calculator();

// calculate two different birthdays
$joe = $calculator->fromString('1994-08-03');
$jane = $calculator->fromString('1997-03-01');

// calculate compatibility
$compatibility = $calculator->compare($joe, $jane); // .3

Continue reading to learn what you can do with the zodiac objects.