monica/app/SpecialDate.php

<?php

namespace App;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

/**
 * A special date is a date that is not necessarily based on a year that we know.
 * This happens when we add a birthdate for instance. It can be based:
 *     * on a real date, where we know the day, month and year
 *     * on a date where we just know the day and the month but not the year
 *     * on an age (we know this person is 33 but we don't know his birthdate,
 *       so we'll give an estimation).
 *
 * Instead of adding a lot of logic in the Contact table, we've decided to
 * create this class that will deal with this complexity.
 */
class SpecialDate extends Model
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'special_dates';

    /**
     * The attributes that aren't mass assignable.
     *
     * @var array
     */
    protected $guarded = ['id'];

    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = ['date'];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'is_age_based' => 'boolean',
        'is_year_unknown' => 'boolean',
    ];

    /**
     * Get the account record associated with the gift.
     *
     * @return BelongsTo
     */
    public function account()
    {
        return $this->belongsTo(Account::class);
    }

    /**
     * Get the contact record associated with the reminder.
     *
     * @return BelongsTo
     */
    public function contact()
    {
        return $this->belongsTo(Contact::class);
    }

    /**
     * Get the contact record associated with the reminder.
     *
     * @return BelongsTo
     */
    public function reminder()
    {
        return $this->belongsTo(Reminder::class);
    }

    /**
     * Mutator for the reminder id attribute.
     * @return int
     */
    public function getReminderIdAttribute($value)
    {
        return $value;
    }

    /**
     * Returns a short version of the date, taking into account if the year is
     * unknown or not. This will return either `July 21` or `July 21, 2017`.
     */
    public function toShortString()
    {
        if ($this->is_year_unknown) {
            return \App\Helpers\DateHelper::getShortDateWithoutYear($this->date);
        }

        return \App\Helpers\DateHelper::getShortDate($this->date);
    }

    /**
     * Sets a reminder for this date. If a reminder is already defined for this
     * date, it will delete it first and recreate one.
     *
     * @param string $frequency The frequency the reminder will be set. Can be 'year', 'month', 'day'.
     * @param int $frequencyNumber
     * @return Reminder
     */
    public function setReminder(string $frequency, int $frequencyNumber, string $title)
    {
        $this->deleteReminder();

        $reminder = new Reminder;
        $reminder->frequency_type = $frequency;
        $reminder->frequency_number = $frequencyNumber;
        $reminder->next_expected_date = $this->date;
        $reminder->special_date_id = $this->id;
        $reminder->account_id = $this->account_id;
        $reminder->contact_id = $this->contact_id;
        $reminder->title = $title;
        $reminder->save();

        $reminder->calculateNextExpectedDate($reminder->account->timezone())->save();

        $this->reminder_id = $reminder->id;
        $this->save();

        $reminder->scheduleNotifications();

        return $reminder;
    }

    /**
     * Deletes the reminder for this date, if it exists.
     * @return int
     */
    public function deleteReminder()
    {
        if (! $this->reminder_id) {
            return;
        }

        if (! $this->reminder) {
            return;
        }

        $reminder = $this->reminder;

        // Unlink the reminder so we can delete it
        // (otherwise we still depend on it, thus the delete will fail
        // due to a foreign key constraint)
        $this->reminder_id = null;
        $this->save();

        $reminder->purgeNotifications();

        return $reminder->delete();
    }

    /**
     * Returns the age that the date represents, if the date is set and if it's
     * not based on a year we don't know.
     * @return int
     */
    public function getAge()
    {
        if (is_null($this->date)) {
            return;
        }

        if ($this->is_year_unknown) {
            return;
        }

        return $this->date->diffInYears(now());
    }

    /**
     * Create a SpecialDate from an age.
     * @param  int $age
     */
    public function createFromAge(int $age)
    {
        $this->is_age_based = true;
        $this->date = now()->subYears($age)->month(1)->day(1);
        $this->save();

        return $this;
    }

    /**
     * Create a SpecialDate from an actual date, that might not contain a year.
     * @param  int    $year
     * @param  int    $month
     * @param  int    $day
     */
    public function createFromDate(int $year, int $month, int $day)
    {
        // year 0 represents the `unknown` choice in the dropdown representing
        // the years
        if ($year != 0) {
            $date = Carbon::createFromDate($year, $month, $day);
        } else {
            $date = Carbon::createFromDate(now()->year, $month, $day);
            $this->is_year_unknown = true;
        }

        $this->date = $date;
        $this->save();

        return $this;
    }

    /**
     * Associates a special date to a contact.
     * @param Contact $contact
     */
    public function setToContact(Contact $contact)
    {
        $this->account_id = $contact->account_id;
        $this->contact_id = $contact->id;
        $this->save();

        return $this;
    }

    /**
     * Returns the age that a contact died assuming we know when they were born
     * and died.
     * @return int
     */
    public function getAgeAtDeath()
    {
        if (is_null($this->date)) {
            return;
        }

        if ($this->is_year_unknown) {
            return;
        }

        $contact = $this->contact;

        if (is_null($contact->birthdate)) {
            return;
        }

        return $contact->birthdate->date->diffInYears($this->date);
    }
}