Colligator\Cover

Complexity

Total Complexity

20

Size/Duplication

Total Lines	165
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	document()	0	4	1
A	getCachedAttribute()	0	8	1
A	getCreatedAttribute()	0	4	2
A	getModifiedAttribute()	0	4	2
A	getThumbAttribute()	0	8	2
A	invalidateCache()	0	12	3
A	setUrlAttribute()	0	8	2
A	isCached()	0	4	1
B	cache()	0	35	6

<?php

namespace Colligator;

use Illuminate\Database\Eloquent\Model;

class Cover extends Model
{
    /**
     * Default thumbnail height.
     *
     * @var array
     */
    public $defaultThumbHeight = 600;

    /**
     * The attributes that should be visible in arrays.
     *
     * @var array
     */
    protected $visible = ['url', 'cached', 'thumb', 'created', 'modified'];

    /**
     * The accessors to append to the model's array form.
     *
     * @var array
     */
    protected $appends = ['cached', 'thumb', 'created', 'modified'];

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

    /**
     * The document the cover belongs to.
     *
     * @return Document
     */
    public function document()
    {
        return $this->belongsTo('Colligator\Document');
    }

    /**
     * Returns the URL to the cached image.
     *
     * @return array
     */
    public function getCachedAttribute()
    {
        return [
            'url'    => \CoverCache::url($this->cache_key),
            'width'  => $this->width,
            'height' => $this->height,
        ];
    }

    /**
     * Get date part of ISO date-time
     */
    public function getCreatedAttribute()
    {
        return isset($this->created_at) ? substr($this->created_at, 0, 10) : null;
    }

    /**
     * Get date part of ISO date-time
     */
    public function getModifiedAttribute()
    {
        return isset($this->modified_at) ? substr($this->modified_at, 0, 10) : null;
    }

    /**
     * Returns the URL to the cached thumb image.
     *
     * @return array
     */
    public function getThumbAttribute()
    {
        return !is_null($this->thumb_key) ? [
            'url'    => \CoverCache::url($this->thumb_key),
            'width'  => $this->thumb_width,
            'height' => $this->thumb_height,
        ] : $this->cached;
    }

    /**
     * Invalidate cache.
     */
    public function invalidateCache()
    {
        if (!is_null($this->width) && !is_null($this->height)) {
            \Log::debug('[Cover] Invalidating cache. Old version was ' . $this->width . ' x ' . $this->height);
        }
        $this->width = null;
        $this->height = null;
        $this->cache_key = null;
        $this->thumb_width = null;
        $this->thumb_height = null;
        $this->thumb_key = null;
    }

    /**
     * Mutuator for the url attribute. Invalidates cache when the paramter changes.
     *
     * @param $value
     */
    public function setUrlAttribute($value)
    {
        if (array_get($this->attributes, 'url') == $value) {
            return;
        }
        $this->attributes['url'] = $value;
        $this->invalidateCache();
    }

    /**
     * Checks if the cover is cached.
     *
     * @return bool
     */
    public function isCached()
    {
        return !is_null($this->width);
    }

    /**
     * Cache the cover and create thumbnail.
     *
     * @throws \ErrorException
     */
    public function cache($blob = null)
    {
        if (is_null($blob) && !isset($this->url)) {
            throw new \ErrorException('[Cover] Cannot cache when no URL or blob is set.');
        }
        if ($this->isCached()) {
            \Log::debug('[Cover] Already cached');

            return;
        }

        if (!is_null($blob)) {
            \Log::debug('[Cover] Add to cache from blob');
            $orig = \CoverCache::putBlob($blob);

        } else {
            \Log::debug('[Cover] Add to cache from url: ' . $this->url);
            $orig = \CoverCache::putUrl($this->url);
        }


        $this->width = $orig->width();
        $this->height = $orig->height();
        $this->mime = $orig->mime();
        $this->cache_key = $orig->cacheKey;

        if ($orig->height() > $this->defaultThumbHeight) {
            \Log::debug("[Cover] Making cover thumbnail since height exceeds {$this->defaultThumbHeight}px");

            $thumb = $orig->thumb($this->defaultThumbHeight);
            $this->thumb_width = $thumb->width();
            $this->thumb_height = $thumb->height();
            $this->thumb_key = $thumb->cacheKey;
        }
    }
}