timegridio/timegrid

<?php

namespace App\Models;

use App\Traits\HasRoles;
use App\Traits\Preferenceable;
use Illuminate\Notifications\Notifiable;
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Database\Eloquent\Model as EloquentModel;
use Illuminate\Foundation\Auth\Access\Authorizable;
use Timegridio\Concierge\Models\Business;

/**
 * @property int $id
 * @property string $name
 * @property string $email
 * @property string $username
 * @property string $password
 * @property string $last_ip
 * @property Carbon\Carbon $last_login_at
 * @property Illuminate\Support\Collection $businesses
 * @property Illuminate\Support\Collection $contacts
 * @property Illuminate\Support\Collection $appointments
 */
class User extends EloquentModel implements AuthenticatableContract, AuthorizableContract, CanResetPasswordContract
{
    use Authenticatable, Authorizable, CanResetPassword, HasRoles, Notifiable, Preferenceable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name', 'email', 'username', 'password'];

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = ['password', 'remember_token', 'last_ip', 'last_login_at'];

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

    ///////////////////
    // Relationships //
    ///////////////////

    /**
     * owns Business.
     *
     * @return Illuminate\Database\Query Relationship Business belongs to User query
     */
    public function businesses()
    {
        return $this->belongsToMany(\Timegridio\Concierge\Models\Business::class)->withTimestamps();
    }

    /**
     * has Contacts.
     *
     *      Contacts are the different profiles for different Businesses the User may have
     *
     * @return Illuminate\Database\Query Relationship User has Contacts query
     */
    public function contacts()
    {
        return $this->hasMany(\Timegridio\Concierge\Models\Contact::class);
    }

    /**
     * holds Appointments through Contacts.
     *
     * The Appointments are the Contact reservations held by this User
     *
     * @return Illuminate\Database\Query Relationship User has Appointments through Contacts query
     */
    public function appointments()
    {
        return $this->hasManyThrough(
            \Timegridio\Concierge\Models\Appointment::class,
            \Timegridio\Concierge\Models\Contact::class
        );
    }

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

    /**
     * TODO: Rename to isOwnerOf().
     *
     * is Owner of Business
     *
     * @param int $businessId Business to inquiry against
     *
     * @return bool The User is Owner of the inquired Business
     */
    public function isOwnerOf($businessId)
    {
        return $this->businesses()->withTrashed()->get()->contains($businessId);
    }

    /**
     * has Business.
     *
     * @return bool The User is Owner of at least one Business
     */
    public function hasBusiness()
    {
        return $this->businesses->count() > 0;
    }

    /**
     * has Contacts.
     *
     * @return bool The User has at least one Contact profile set
     */
    public function hasContacts()
    {
        return $this->contacts->count() > 0;
    }

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

    /**
     * set Username.
     *
     * @param string $username The desired username
     */
    public function setUsernameAttribute($username)
    {
        $username = strtolower(trim($username));

        return $this->attributes['username'] = $username == '' ? md5(time().uniqid()) : $username;
    }

    /**
     * set Name.
     *
     * @param string $string The first name of the User
     */
    public function setNameAttribute($name)
    {
        return $this->attributes['name'] = ucwords(strtolower($name));
    }

    /**
     * Get Subscribed Contact to Business.
     *
     * @param Business $business Business of inquiry
     *
     * @return Contact User profile Contact subscribed to the inquired Business
     */
    public function getContactSubscribedTo($businessId)
    {
        return $this->contacts->filter(function ($contact) use ($businessId) {
            return $contact->isSubscribedTo($businessId);
        })->first();
    }
}