<?php

namespace Esensi\Model;

use Esensi\Model\Contracts\EncryptingModelInterface;
use Esensi\Model\Contracts\HashingModelInterface;
use Esensi\Model\Contracts\JugglingModelInterface;
use Esensi\Model\Contracts\PurgingModelInterface;
use Esensi\Model\Contracts\RelatingModelInterface;
use Esensi\Model\Contracts\ValidatingModelInterface;
use Esensi\Model\Traits\BackwardCompatibleDatesTrait;
use Esensi\Model\Traits\DatesToCastsTrait;
use Esensi\Model\Traits\EncryptingModelTrait;
use Esensi\Model\Traits\HashingModelTrait;
use Esensi\Model\Traits\JugglingModelTrait;
use Esensi\Model\Traits\PurgingModelTrait;
use Esensi\Model\Traits\RelatingModelTrait;
use Esensi\Model\Traits\ValidatingModelTrait;
use Illuminate\Contracts\Support\MessageProvider;
use Illuminate\Database\Eloquent\Model as Eloquent;

/**
 * Base Model.
 *
 */
abstract class Model extends Eloquent implements
    EncryptingModelInterface,
    HashingModelInterface,
    JugglingModelInterface,
    MessageProvider,
    PurgingModelInterface,
    RelatingModelInterface,
    ValidatingModelInterface
{
    /*
     * Make model validate attributes.
     *
     * This comes first even though it is out of alphabetical
     * order because it is important that it is booted before
     * hashing and purging traits.
     *
     * @see Esensi\Model\Traits\ValidatingModelTrait
     */
    use ValidatingModelTrait;

    /*
     * Make model encrypt attributes.
     *
     * @see Esensi\Model\Traits\EncryptingModelTrait
     */
    use EncryptingModelTrait;

    /*
     * Make model hash attributes.
     *
     * @see Esensi\Model\Traits\HashingModelTrait
     */
    use HashingModelTrait;

    /*
     * Make the model juggle attributes when setting and getting
     *
     * @see Esensi\Model\Contracts\JugglingModelInterface
     */
    use JugglingModelTrait;

    /*
     * Make model purge attributes.
     *
     * @see Esensi\Model\Traits\PurgingModelTrait
     */
    use PurgingModelTrait;

    /*
     * Make model use properties for model relationships.
     *
     * @see Esensi\Model\Traits\RelatingModelTrait
     */
    use RelatingModelTrait;

    /*
     * This trait is designed for automatic conversion of the $dates property to the $casts property in Laravel Eloquent models.
     * When a model is being saved, updated, or retrieved from the database, the trait checks for the presence of the $dates property
     * and adds corresponding values to the $casts array if they are not already defined.
     *
     * @see Esensi\Model\Traits\DatesToCastsTrait
     */
    use DatesToCastsTrait;

    /*
     * Get the attributes that should be converted to dates.
     *
     * @see Esensi\Model\Traits\BackwardCompatibleDatesTrait
     */
    use BackwardCompatibleDatesTrait;

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

    /**
     * The default rules that the model will validate against.
     *
     * @var array
     */
    protected $rules = [];

    /**
     * The rulesets that the model will validate against.
     *
     * @deprecated watson/validating 0.10.9
     *
     * @var array
     */
    protected $rulesets = [];

    /**
     * The attributes to encrypt when set and
     * decrypt when gotten.
     *
     * @var array
     */
    protected $encryptable = [];

    /**
     * The attributes to hash before saving.
     *
     * @var array
     */
    protected $hashable = [];

    /**
     * Attributes to cast to a different type.
     *
     * @var array
     */
    protected $jugglable = [];

    /**
     * The attributes to purge before saving.
     *
     * @var array
     */
    protected $purgeable = [];

    /**
     * Relationships that the model should set up.
     *
     * @var array
     */
    protected $relationships = [];

    /**
     * Extra attributes to be added to pivot relationships.
     *
     * @var array
     */
    protected $relationshipPivots = [];

    /**
     * Dynamically retrieve attributes.
     *
     * @param  string  $key
     * @return mixed
     */
    public function __get($key)
    {
        // Resolve relationship dynamically
        if ($relationship = $this->getDynamicRelationship($key)) {
            return $relationship;
        }

        // Dynamically retrieve the encryptable attribute
        $value = $this->getDynamicEncrypted($key);
        if (is_null($value) || ! is_string($value)) {
            // Fallback to the default Eloquent dynamic getter
            $value = parent::__get($key);
        }

        // Dynamically juggle the attribute.
        // This is always called so that even decrypted values
        // can be casted after decrypting.
        return $this->getDynamicJuggle($key, $value);
    }

    /**
     * Dynamically set attributes.
     *
     * @param string  $key
     * @param mixed  $value
     */
    public function __set($key, $value)
    {
        // Dynamically set the encryptable attribute
        if (! empty($value) && $this->setDynamicEncryptable($key, $value)) {
            return;
        }

        // Fallback to the default Eloquent dynamic setter
        parent::__set($key, $value);

        // Dynamically juggle the attribute.
        $this->setDynamicJuggle($key, $value);
    }

    /**
     * Get the messages for the instance.
     *
     * @return Illuminate\Contracts\Support\MessageBag
     */
    public function getMessageBag()
    {
        return $this->getErrors();
    }
}