<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class XmlCache extends Model
{
    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'document_xml_cache';
    public $timestamps = false;


    /**
     * primaryKey
     *
     * @var integer
     * @access protected
     */
    protected $primaryKey = null;
    public $incrementing = false;

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['document_id', 'xml_version', 'server_date_modified', 'xml_data'];

    /**
     * Get the dataset that owns the xml cache.
     */
    public function dataset()
    {
        return $this->belongsTo(\App\Dataset::class, 'document_id', 'id');
    }

    /**
     * Get dom document of 'xml_data' string
     *
     * @return \DOMDocument
     */
    public function getDomDocument()
    {
        $dom = new \DOMDocument('1.0', 'utf-8');
        $xmlData = $this->xml_data;
        $dom->loadXML($xmlData);
        return $dom;
    }

    /**
     * Check if a document in a specific xml version is already cached or not.
     *
     * @param mixed $datasetId
     * @param mixed $xmlVersion
     * @param mixed $serverDateModified
     * @return bool Returns true on cached hit else false.
     */
    //public function scopeHasValidEntry($query, $datasetId, $xmlVersion, $serverDateModified)
    //{
    //    //$select = $this->_table->select()->from($this->_table);
    //    $query->where('document_id = ?', $datasetId)
    //        ->where('xml_version = ?', $xmlVersion)
    //        ->where('server_date_modified = ?', $serverDateModified);

    //    $row = $query->get();

    //    if (null === $row)
    //    {
    //       return false;
    //    }
    //    else
    //    {
    //        return true;
    //    }
    //}
}