<?php

/**
 * @noinspection PhpInconsistentReturnPointsInspection
 * @noinspection PhpReturnDocTypeMismatchInspection
 */

namespace bff\img;

use Component;
use bff\contracts\DestroyAfterRequest;

/**
 * Компонент управляющий сохранением/удалением одного изображения
 *
 * Информация о загруженном изображении сохраняется в таблицу {$table} в
 * поля:
 *  {$fieldImage} - имя загруженного файла (без префикса)
 *  {$fieldCrop} - координаты выбранной области изображения (jcrop)
 *
 * @copyright Tamaranga
 */
abstract class ImageUploader extends Component implements DestroyAfterRequest
{
    /** @var int ID записи */
    protected $recordID = 0;

    /** @var string Название таблицы */
    protected $table = '';
    /** @var string Название поля для хранения ID записи */
    protected $fieldID = 'id';
    /** @var string Название поля для хранения имени файла */
    protected $fieldImage = 'img';
    /** @var string Название поля для хранения параметров кропа */
    protected $fieldCrop = 'img_crop';
    /** @var string Путь к изображениям */
    protected $path = '';
    /** @var string Путь ко временным изображениям */
    protected $pathTmp = '';
    /** @var string URL к изображениям */
    protected $url = '';
    /** @var string URL ко временным изображениям */
    protected $urlTmp = '';
    /** @var bool сообщать об ошибках */
    protected $assignErrors = true;

    /**
     * Максимально допустимый размер файла изображения
     * @var int
     * @example: 5242880 - 5мб, 4194304 - 4мб, 3145728 - 3мб, 2097152 - 2мб
     */
    protected $maxSize = 4194304;

    /**
     * Минимально допустимый размер изображения по ширине/высоте
     * @vars int
     */
    protected $minWidth = 0; // ширина (0 - не выполнять проверку)
    protected $minHeight = 0; // высота (0 - не выполнять проверку)

    /**
     * Максимально допустимый размер изображения по ширине/высоте
     * @vars int
     */
    protected $maxWidth = 0; // ширина (0 - не выполнять проверку)
    protected $maxHeight = 0; // высота (0 - не выполнять проверку)

    /**
     * Размеры изображений
     * @example array(
     *      key => array(
     *          'o'=> @param bool - сохранять ли в оригинальных размерах,
     *          'width'=> @param int - ширина,
     *          'height'=> @param int - высота,
     *          ... параметры для bff\img\Thumbnail
     *      ), ...
     * )
     * @var array
     */
    protected $sizes = array();

    /**
     * Кол-во символов в названии сохранямого файла
     * @var int
     */
    protected $filenameLetters = 6;

    /**
     * Допустимые расширения файлов
     * Обязательно указывать 'jpg' и 'jpeg'
     * @var array
     */
    protected $extensionsAllowed = ['jpg', 'jpeg', 'gif', 'png'];

    /**
     * Качество конечного изображения (1-100)
     * @var int
     */
    protected $quality = 90;

    /**
     * Раскладывать ли файлы в зависимости от recordID
     * по папкам folder = (recordID / 1000)
     */
    protected $folderByID = false;
    protected $folderByID_RecordsLimit = 1000;

    /**
     * Используется внешний источник хранения
     * false - хранение выполняется на этом же сервере
     * true - на другом сервере, меняется логика загрузки временных файлов
     * @var bool
     */
    protected $externalSave = false;

    public function __construct($nRecordID = 0)
    {
    }

    public function setRecordID($nRecordID)
    {
    }

    abstract protected function initSettings();

    /**
     * Загрузка(сохранение/обновление) изображения, методом $_FILES
     * @param string $sInput input file name
     * @param bool $bDeletePrevious удалять предыдущее изображение
     * @param bool $bDoUpdateQuery сохранить изменения в БД
     * @return array информация об успешно загруженном файле изображения или FALSE в случае ошибки
     */
    public function uploadFILES($sInput, $bDeletePrevious = true, $bDoUpdateQuery = false)
    {
    }

    /**
     * Загрузка(сохранение/обновление) изображения при помощи QQ-загрузчика
     * @param string $sInput input file name
     * @param bool $bDeletePrevious удалять предыдущее изображение
     * @param bool $bDoUpdateQuery сохранить изменения в БД
     * @return array информация об успешно загруженном файле изображения или FALSE в случае ошибки
     */
    public function uploadQQ($bDeletePrevious = true, $bDoUpdateQuery = false)
    {
    }

    /**
     * Загрузка(сохранение/обновление) изображения по URL ссылке
     * @param string $sURL ссылка на изображение
     * @param bool $bDeletePrevious удалять предыдущее изображение
     * @param bool $bDoUpdateQuery сохранить изменения в БД
     * @return array информация об успешно загруженном файле изображения или FALSE в случае ошибки
     */
    public function uploadURL($sURL, $bDeletePrevious = true, $bDoUpdateQuery = false)
    {
    }

    /**
     * Переносим temp-изображения в постоянную папку
     * @param string $sFilename имя файла temp-изображения
     * @param bool $bDoUpdateQuery сохранить изменения в БД
     * @return bool
     */
    public function untemp($sFilename, $bDoUpdateQuery = false)
    {
    }

    /**
     * Удаление изображения
     * @param bool $bUpdateRecord обновлять запись в БД
     * @param string $sFilename имя файла или FALSE(берется из БД)
     * @return bool
     */
    public function delete($bUpdateRecord = true, $sFilename = false)
    {
    }

    /**
     * Удаление tmp изображения
     * @param string $sFilename имя файла
     * @return bool
     */
    public function deleteTmp($sFilename)
    {
    }

    /**
     * Установка допустимых размеров изображения по ширине/высоте
     * @param int $nMinWidth минимальная ширина изображения или FALSE
     * @param int $nMaxWidth максимальная ширина изображения или FALSE
     * @param int $nMinHeight минимальная высота изображения или FALSE
     * @param int $nMaxHeight максимальная высота изображения или FALSE
     */
    public function setDimensions($nMinWidth = false, $nMaxWidth = false, $nMinHeight = false, $nMaxHeight = false)
    {
    }

    /**
     * Сообщать об ошибках
     * @param bool $bAssign
     */
    public function setAssignErrors($bAssign)
    {
    }

    /**
     * Формирование URL изображения
     * @param string $sFilename имя файла
     * @param string|array $sSize префикс размера или массив префиксов размеров
     * @param bool $bTmp tmp-изображение
     * @return string URL
     */
    public function getURL($sFilename, $sSize, $bTmp = false)
    {
    }

    /**
     * Установка названия поля для хранения имени файла
     * @param string $sField
     */
    public function setFieldImage($sField)
    {
    }

    /**
     * Установка максимально допустимого размера файла
     * @param int $nMaxSize размер в байтах
     */
    public function setMaxSize($nMaxSize)
    {
    }

    /**
     * Получение максимально допустимого размера файла
     * @param bool $bFormat применить форматирование
     * @param bool $bFormatExtTitle полное название объема данных (при форматировании)
     * @return mixed
     */
    public function getMaxSize($bFormat = false, $bFormatExtTitle = false)
    {
    }

    /**
     * Возвращаем результат загрузки
     * @param string $sUploadType тип загрузки: 'files','qq','swf','url'
     * @param array|bool $aUploadResult результат загрузки, ответ полученный от upload_ метода
     * @param array $aSizes размеры (в для которых необходимо сформировать URL изображения)
     */
    public function doResponse($sUploadType, $aUploadResult, array $aSizes)
    {
    }

    /**
     * Используется внешний источник хранения
     * @return bool
     */
    public function isExternalSave()
    {
        return $this->externalSave;
    }
}