timegridio/concierge

<?php

namespace Timegridio\Concierge\Models;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model as EloquentModel;
use McCool\LaravelAutoPresenter\HasPresenter;
use Timegridio\Concierge\Presenters\ContactPresenter;

/**
 * @property int $id
 * @property string $firstname
 * @property string $lastname
 * @property string $nin
 * @property string $email
 * @property \Carbon\Carbon $birthdate
 * @property string $mobile
 * @property string $mobile_country
 * @property string $gender
 * @property string $occupation
 * @property string $martial_status
 * @property string $postal_address
 * @property Illuminate\Support\Collection $businesses
 * @property Illuminate\Support\Collection $appointments
 * @property mixed $user
 * @property int $appointmentsCount
 */
class Contact extends EloquentModel implements HasPresenter
{
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'firstname',
        'lastname',
        'nin',
        'email',
        'birthdate',
        'mobile',
        'mobile_country',
        'gender',
        'occupation',
        'martial_status',
        'postal_address',
        ];

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

    //////////////////
    // Relationship //
    //////////////////

    /**
     * is profile of User.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo Relationship Contact belongs to User query
     */
    public function user()
    {
        return $this->belongsTo(config('auth.providers.users.model'));
    }

    /**
     * belongs to Business.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany Relationship Contact is part of Businesses addressbooks query
     */
    public function businesses()
    {
        return $this->belongsToMany(Business::class);
    }

    /**
     * has Appointments.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany Relationship Contact has booked Appointments query
     */
    public function appointments()
    {
        return $this->hasMany(Appointment::class);
    }

    /////////////////////
    // Soft Attributes //
    /////////////////////

    /**
     * has Appointment.
     *
     * @return bool Check if Contact has at least one Appointment booked
     */
    public function hasAppointment()
    {
        return $this->appointmentsCount > 0;
    }

    /**
     * Appointments Count.
     *
     * This method is used to optimize the relationship counting performance
     *
     * @return Illuminate\Database\Query Relationship Contact x Appointment count(*) query
     */
    public function appointmentsCount()
    {
        return $this
            ->hasMany(Appointment::class)
            ->selectRaw('contact_id, count(*) as aggregate')
            ->groupBy('contact_id');
    }

    /**
     * get AppointmentsCount.
     *
     * @return int Count of Appointments held by this Contact
     */
    public function getAppointmentsCountAttribute()
    {
        // If relation is not loaded already, let's do it first
        if (!array_key_exists('appointmentsCount', $this->relations)) {
            $this->load('appointmentsCount');
        }

        $related = $this->getRelation('appointmentsCount');

        // Return the count directly
        return ($related->count() > 0) ? (int) $related->first()->aggregate : 0;
    }

    ///////////////
    // Presenter //
    ///////////////

    /**
     * get presenter.
     *
     * @return ContactPresenter Presenter class
     */
    public function getPresenterClass()
    {
        return ContactPresenter::class;
    }

    //////////////
    // Mutators //
    //////////////

    /**
     * set Mobile.
     *
     * Expected phone number is international format numeric only
     *
     * @param string $mobile Mobile phone number
     */
    public function setMobileAttribute($mobile)
    {
        return $this->attributes['mobile'] = trim($mobile) ?: null;
    }

    /**
     * set Mobile Country.
     *
     * @param string $country Country ISO Code ALPHA-2
     */
    public function setMobileCountryAttribute($country)
    {
        return $this->attributes['mobile_country'] = trim($country) ?: null;
    }

    /**
     * set Birthdate.
     *
     * @param Carbon $birthdate Carbon parseable birth date
     */
    public function setBirthdateAttribute(Carbon $birthdate = null)
    {
        if ($birthdate === null) {
            return $this->attributes['birthdate'] = null;
        }

        return $this->attributes['birthdate'] = $birthdate;
    }

    /**
     * set Email.
     *
     * @param string $email Valid email address
     */
    public function setEmailAttribute($email)
    {
        return $this->attributes['email'] = empty(trim($email)) ? null : $email;
    }

    /**
     * TODO: Check if possible to handle in a more structured way
     *       NIN record is currently too flexible.
     *
     * set NIN: National Identity Number
     *
     * @param string $nin The national identification number in any format
     */
    public function setNinAttribute($nin)
    {
        return $this->attributes['nin'] = empty(trim($nin)) ? null : $nin;
    }

    ///////////////
    // ACCESSORS //
    ///////////////

    public function getEmailAttribute()
    {
        if ($email = array_get($this->attributes, 'email')) {
            return $email;
        }

        if ($this->user) {
            return $this->user->email;
        }

        return;
    }

    /////////////////////
    // Soft Attributes //
    /////////////////////

    /**
     * is Subscribed To Business.
     *
     * @param int $businessId Business of inquiry
     *
     * @return bool The Contact belongs to the inquired Business' addressbook
     */
    public function isSubscribedTo($businessId)
    {
        return $this->businesses->contains($businessId);
    }

    /**
     * is Profile of User.
     *
     * @param int $userId User of inquiry
     *
     * @return bool The Contact belongs to the inquired User
     */
    public function isProfileOf($userId)
    {
        return $this->user ? $this->user->id == $userId : false;
    }
}