Eve.php

<?php

/*
 * This file is part of SeAT
 *
 * Copyright (C) 2015 to present Leon Jacobs
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

namespace Seat\Services\Image;

use Seat\Services\Exceptions\EveImageException;

/**
 * Class Eve.
 *
 * @package Seat\Services\Image
 */
class Eve
{
    /**
     * @var string
     */
    protected $type;

    /**
     * @var string
     */
    protected $variation;

    /**
     * @var int
     */
    protected $id;

    /**
     * @var int
     */
    protected $size;

    /**
     * @var array
     */
    protected $attributes;

    /**
     * @var bool
     */
    protected $lazy;

    /**
     * @var array
     */
    protected $known_types = [
        'characters', 'corporations', 'alliances', 'factions', 'types', 'render', 'auto', ];

    /**
     * @var string
     */
    protected $img_server = '//images.evetech.net';

    /**
     * Eve constructor.
     *
     * @param  string  $type
     * @param  string  $variation
     * @param  int  $id
     * @param  int  $size
     * @param  array  $attr
     * @param  bool  $lazy
     *
     * @throws \Seat\Services\Exceptions\EveImageException
     */
    public function __construct(string $type, string $variation, ?int $id, int $size, array $attr = [], bool $lazy = true)
    {
        // Validate the arguments
        if (! in_array($type, $this->known_types))
            throw new EveImageException($type . ' is not a valid image type.');

        if (! (is_int($id) || $id === null))
            throw new EveImageException('id must be an integer or null.');

        if (! is_int($size))
            throw new EveImageException('size must be an integer');

        if (! in_array($size, [32, 64, 128, 256, 512, 1024]))
            throw new EveImageException('unsupported size');

        // Check if we should detect the type based on id
        if ($type == 'auto') {
            $type = $this->detect_type($id);

            switch ($type) {
                case 'characters':
                    $this->variation = 'portrait';
                    break;
                case 'corporations':
                case 'alliances':
                case 'factions':
                    $this->variation = 'logo';
                    break;
                case 'unknown':
                    $this->variation = 'unknown';
                    break;
                default:
                    $this->variation = 'icon';
            }
        }

        // ccp trick - http://eveonline-third-party-documentation.readthedocs.io/en/latest/imageserver/intro.html#faction-images
        if ($type == 'factions')
            $type = 'alliances';

        $this->type = $type;
        $this->variation = $variation;
        $this->id = $id;
        $this->attributes = $attr;
        $this->lazy = $lazy;
        $this->size = $size;
    }

    /**
     * Attempt to detect the image type based on the
     * range in which an integer falls.
     *
     * @param  $id
     * @return string
     */
    public function detect_type($id)
    {
        if ($id === null)
            return 'unknown';

        if ($id > 90000000 && $id < 98000000)
            return 'characters';

        elseif (($id > 98000000 && $id < 99000000) || ($id > 1000000 && $id < 2000000))
            return 'corporations';

        elseif (($id > 99000000 && $id < 100000000) || ($id > 0 && $id < 1000000))
            return 'alliances';

        return 'characters';
    }

    /**
     * @return string
     */
    public function html()
    {

        // make new IMG tag
        $html = '<img ';

        //if the id is unknown, we don't even need to generate the image server url
        if ($this->id === null){
            //there might be a better asset for this, or maybe we should create one
            $html .= 'src="' . asset('web/img/bg.png') . '" ';
        } else {
            if ($this->lazy) {
                // images are lazy loaded. prepare the the data-src attributes with the
                // location for the image.
                $html .= 'src="' . asset('web/img/bg.png') . '" ';
                $html .= 'data-src="' . $this->url($this->size) . '" ';

                // Item Type images can be max 64?
                // http://imageserver.eveonline.com/Type/670_128.png goes 404
                // In case requested size is greater than 32, lock size to 64
                $html .= 'data-src-retina="' . $this->url($this->size == 1024 ? 1024 : $this->size * 2) . '" ';

                // put class on images to lazy load them
                if (! isset($this->attributes['class']))
                    $this->attributes['class'] = '';

                $this->attributes['class'] .= ' img-lazy-load';

            } else {

                // no lazy loaded image
                $html .= 'src="' . $this->url($this->size) . '" ';
            }
        }

        // unset already built attributes
        unset(
            $this->attributes['src'],
            $this->attributes['data-src='],
            $this->attributes['data-src-retina']
        );

        // render other attributes
        foreach ($this->attributes as $name => $value)
            $html .= "{$name}=\"{$value}\" ";

        // close IMG tag
        $html .= ' />';

        // return completed img tag
        return $html;
    }

    /**
     * @param  $size
     * @return string
     */
    public function url($size)
    {
        return sprintf('%s/%s/%d/%s?size=%d', $this->img_server, $this->type, $this->id, $this->variation, $size);
    }
}