functions.php

<?php

use Imagine\Image\Box;

/**
 * Форматирует число и добавляет в конце знак рубля
 * @param int $number Число для форматирования
 *
 * @return string Отформатированное число со знаком рубля
 */
function decorate_cost(int $number = 0)
{
    $price = ceil($number);
    return number_format($price, 0, ",", " ") . " ₽";
}

/**
 * Вычисляет оставшееся время и
 * возвращает данные в виде часов и минут
 * @param DateTime $value_date Дата
 *
 * @return array Часы и минуты
 */
function get_dt_range($value_date, $reverse = false)
{   
    if ($reverse) {
        $time_difference = strtotime($value_date) - time();
    }

    else {
       $time_difference = time() - strtotime($value_date);
    }
    return [floor($time_difference / 3600), floor(($time_difference % 3600) / 60)];
}

/**
 * Возвращает булевое true в случае
 * если входящая дата меньше текущей
 * @param DateTime $value_date дата
 *
 * @return bool
 */
function get_dt_end($value_date)
{
    if (time() > strtotime($value_date)) {
        return true;
    }
}

/**
 * Поиск максимальной цены или возвращние
 * текущей цены
 * @param array $prices Ставки с ценой
 * @param int $st_coast Стартовая цена
 *
 * @return mixed
 */
function get_max_price_bids(array $prices, int $st_coast)
{
    if (!isset($prices[0]["price"])) {
        return $st_coast;
    }
    $max_value = $prices[0]["price"];
    foreach ($prices as $price) {
        if ($max_value < $price["price"]) {
            $max_value = $price["price"];
        }
    }
    return $max_value;
}

/**
 * Возвращает значение из глобального массива $_POST
 * если оно не пустое или дефолтное значение
 * @param string $name Имя переменной
 * @param string|integer|null $default Дефолтное значение
 *
 * @return string|integer Текст
 */
function post_value(string $name, $default = null)
{
    return isset($_POST[$name]) ? trim($_POST[$name]) : $default;
}

/**
 * Возвращает объект из глобального массива $_FILES
 * если оно не пустое или дефолтное значение
 * @param string $name Имя переменной
 * @param null $default Дефолтное значение
 *
 * @return string|null Текст
 */
function get_file(string $name, $default = null)
{
    return $_FILES[$name] ?? $default;
}

/**
 * Возращает значение из глобального массива $_SESSION["user"]
 * относящегося к массиву с данными о клиенте
 * @param string $name Имя переменной
 * @param string|integer|null $default Дефолтное значение
 *
 * @return string|null Текст
 */
function get_value_from_user_session(string $name, $default = null)
{
    return $_SESSION["user"][$name] ?? $default;
}

/**
 * Возвращает значение из глобального массива $_GET
 * если оно не пустое или дефолтное значение
 * @param string $name Имя переменной
 * @param string|integer|null $default Дефолтное значение
 *
 * @return mixed|null Текст
 */
function get_value(string $name, $default = null)
{
    return isset($_GET[$name]) ? trim($_GET[$name]) : $default;
}

/**
 * Получает значение страницы и проверяет
 * чтобы оно было числом, если нет то
 * возращает страницу 1
 *
 * @return int Номер страницы
 */
function get_page_value()
{
    $number_page = get_value("page", 1);
    return is_numeric($number_page) ? (int)$number_page : 1;
}

/**
 * Ищет в БД информацию о пользователе и
 * возвращает её
 * @param mysqli $link Ресурс соединения
 * @param string $email_field Email адресс
 *
 * @return false|mysqli_result Данные о пользователе
 */
function get_data_user($link, $email_field)
{
    $sql_query_data = "SELECT * FROM `users` WHERE `email` = ? ";
    $stmt = db_get_prepare_stmt($link, $sql_query_data, [$email_field]);
    mysqli_stmt_execute($stmt);
    return mysqli_stmt_get_result($stmt);
}

/**
 * Функция создания html элемента <li> для
 * пагинации, применяется в функции render_pagination
 * @param string $path_button Путь url
 * @param string $text_button Текст на кнопке
 * @param string $class_important Дополнительный класс
 * @param bool $disable Состояние кнопки
 * @param null $text_search Текст для поиска (работает на поиске)
 * @param null $current_page Текущая страница
 *
 * @return string
 */
function render_pagination_button(
    $path_button,
    $text_button,
    $class_important = "",
    $disable = false,
    $text_search = null,
    $current_page = null
) {
    if ($disable) {
        $disable = "style='pointer-events: none;'";
    }
    $string_template = '<li %s class="pagination-item %s"><a href="%s%s&page=%d">%s</a></li>';
    return sprintf(
        $string_template, 
        $disable, 
        $class_important, 
        $path_button, 
        $text_search, 
        $current_page, 
        $text_button
    );
}

/**
 * Создание html элемента пагинации, если
 * количество элементов больше заданного количества
 * @param int $all_lots Количество элементов всего
 * @param $value_items Количество элементов на странице
 * @param int $current_page Текущая страница
 * @param int $pages Количество страниц
 * @param $str_search Строка с поиском
 * @param $path_search Путь url
 *
 * @return bool|string HTML element
 */
function render_pagination($all_lots, $value_items, $current_page, $pages, $str_search, $path_search)
{
    if ($all_lots > $value_items) {
        $pagination = "<ul class='pagination-list'>";

        if ($current_page === 1) {
            $pagination .= render_pagination_button("#", "Назад", "pagination-item-prev", true);
        } else {
            $pagination .= render_pagination_button(
                $path_search, 
                "Назад", 
                "pagination-item-prev", 
                false, 
                $str_search, 
                $current_page - 1
            );
        }

        for ($i = 1; $i <= $pages; $i++) {
            if ($current_page === $i) {
                $pagination .= render_pagination_button("#", $i, "pagination-item-active", true);
            } else {
                $pagination .= render_pagination_button($path_search, $i, "", false, $str_search, $i);
            }
        }

        if ($pages > $current_page) {
            $pagination .= render_pagination_button(
                $path_search, 
                "Вперед", 
                "pagination-item-next", 
                false, 
                $str_search, 
                $current_page + 1);
        } else {
            $pagination .= render_pagination_button("#", "Вперед", "pagination-item-next", true);
        }
        return $pagination . "</ul>";
    }
    return false;
}

/**
 * Возвращает экранированную строку
 * @param mysqli $connect Ресурс соединения
 * @param string $text Текст для экранирования
 *
 * @return string Экранированная строка
 */
function get_escape_string($connect, $text)
{
    return mysqli_real_escape_string($connect, $text);
}

/**
 * Возвращает значение отступа из расчета
 * количесвта элементов на странице
 * @param int $page Номер страницы
 * @param int $count_items Количество элементов на странице
 *
 * @return int Число
 */
function get_offset_items(int $page, int $count_items)
{
    return ($page - 1) * $count_items;
}

/**
 * Обрабатывает запрос с количеством лотов и
 * возращает данные для пагинации
 * @param mysqli $link Ресурс соединения
 * @param string $sql_query SQL запрос с количеством лотов
 * @param string/int $data Данные для запроса
 *
 * @return array Текущая страница, количество лотов, количество страниц, отступ
 */
function compute_pagination_offset_and_limit($link, string $sql_query, $data)
{
    $stmt_count = db_get_prepare_stmt($link, $sql_query, [$data]);
    mysqli_stmt_execute($stmt_count);
    $count_lots = mysqli_fetch_assoc(mysqli_stmt_get_result($stmt_count));
    $count_lots = $count_lots["count"];
    $page_count = ceil($count_lots / COUNT_ITEMS);
    return [$count_lots, $page_count];
}

/**
 * Вычисляет стоимость лота с учетом ставок и шагов
 * @param integer $max_price Максимальная цена ставки
 * @param integer $step Шаг ставки
 * @param integer $st_coast Стартовая цена лота
 *
 * @return integer $sum Итоговая сумма
 */
function get_max_price_lot($max_price, $step, $st_coast)
{
    if ($max_price !== null) {
        $sum = $max_price + $step;
    } else {
        $sum = $st_coast + $step;
    }
    return $sum;
}

/**
 * Обработка фотографии (изменения размера и
 * добавление знака нашей площадки внизу изображения)
 * @param string $file_name Имя файла
 */
function resize_and_watermark_image_of_lot($file_name) 
{
    /**
     * Обрезаем картинку лота
     */
    $imagine = new Imagine\Gd\Imagine();
    $img = $imagine->open(PATH_UPLOADS_IMAGE . $file_name);
    $img->resize(new Box(IMAGE_PARAMETERS["width"], IMAGE_PARAMETERS["height"]));
    /**
     * Добавляем watermark
     */
    $watermark = $imagine->open('img/logo.png');
    $size = $img->getSize();
    $wSize = $watermark->getSize();
    $bottomRight = new Imagine\Image\Point(
        $size->getWidth() - $wSize->getWidth(),
        $size->getHeight() - $wSize->getHeight()
    );
    $img->paste($watermark, $bottomRight);
    /**
     * Сохранение изображения
     */
    $img->save(PATH_UPLOADS_IMAGE . $file_name, IMAGE_QUALITY);
}

/**
 * Функция перемещает файл в папку,
 * указананя в атрибуте $folder
 * @param int $id_image Уникальный номер
 * @param array $file Файл
 * @param string $folder Имя папки
 */
function move_file_to_folder($id_image, $file, $folder) 
{
    $file_name = $id_image . $file["name"];
    move_uploaded_file($file["tmp_name"], $folder . $file_name);
}

/**
 * Записывает значение ставки в базу если оно
 * больше текущей цены или возращает ошибку
 * @param integer $bet_sum Сумма ставки
 * @param mysqli $link Ресурс соединения
 * @param integer $id_lot ID лота
 *
 * @return string $page_content Шаблон ошибки вставки
 */
function create_bet(int $bet_sum, $link, int $id_lot)
{
    $sql_insert_bids = "INSERT INTO `bids` (`dt_add`, `price`, `user_id`, `lot_id`) VALUES (NOW(), ?, ?, ?)";
    $stmt = db_get_prepare_stmt($link, $sql_insert_bids, [$bet_sum, $_SESSION["user"]["id"], $id_lot]);
    return mysqli_stmt_execute($stmt);
}

/** Если обнаружены ошибки то
 * останавливает работу приложения
 * @param mysqli $link Ресурс соединения
 */
function get_error($link)
{
    if (!empty(mysqli_error($link))) {
        echo "Получена ошибка " . mysqli_error($link);
        die();
    }
}