<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */

namespace PrestaShop\PrestaShop\Adapter\Product;

use Context;
use Image;
use Product;
use StockAvailable;

/**
 * @deprecated since 8.1 and will be removed in next major.
 *
 * This class will provide data from DB / ORM about Product, for both Front and Admin interfaces.
 */
class ProductDataProvider
{
    /**
     * Get a new ProductCore instance.
     *
     * @param int|null $idProduct
     *
     * @return Product
     */
    public function getProductInstance($idProduct = null)
    {
        if ($idProduct) {
            return new Product($idProduct);
        }

        return new Product();
    }

    /**
     * Get a product.
     *
     * @param int $id_product
     * @param bool $full
     * @param int|null $id_lang
     * @param int|null $id_shop
     * @param object|null $context
     *
     * @throws \LogicException If the product id is not set
     *
     * @return Product $product
     */
    public function getProduct($id_product, $full = false, $id_lang = null, $id_shop = null, $context = null)
    {
        if (!$id_product) {
            throw new \LogicException('You need to provide a product id', 5002);
        }

        $product = new Product($id_product, $full, $id_lang, $id_shop, $context);

        if (!is_array($product->link_rewrite)) {
            $linkRewrite = $product->link_rewrite;
        } else {
            $linkRewrite = $product->link_rewrite[$id_lang ? $id_lang : key($product->link_rewrite)];
        }

        $cover = Product::getCover($product->id);
        $product->image = Context::getContext()->link->getImageLink($linkRewrite, $cover ? $cover['id_image'] : '', 'home_default');

        return $product;
    }

    /**
     * Get default taxe rate product.
     *
     * @return int id tax rule group
     */
    public function getIdTaxRulesGroup()
    {
        $product = new Product();

        return $product->getIdTaxRulesGroup();
    }

    /**
     * Get product quantity.
     *
     * @param int $id_product
     * @param int|null $id_product_attribute
     * @param bool|null $cache_is_pack
     *
     * @return int stock
     */
    public function getQuantity($id_product, $id_product_attribute = null, $cache_is_pack = null)
    {
        return Product::getQuantity($id_product, $id_product_attribute, $cache_is_pack);
    }

    /**
     * @param int $id_product
     * @param int $id_product_attribute Optional
     *
     * @return string
     */
    public function getLocation($id_product, $id_product_attribute = 0)
    {
        return StockAvailable::getLocation($id_product, $id_product_attribute);
    }

    /**
     * Get associated images to product.
     *
     * @param int $id_product
     * @param int $id_lang
     *
     * @return array
     */
    public function getImages($id_product, $id_lang)
    {
        $id_shop = (int) Context::getContext()->shop->id;
        $data = [];
        foreach (Image::getImages($id_lang, $id_product, null, $id_shop) as $image) {
            $data[] = $this->getImage($image['id_image']);
        }

        return $data;
    }

    /**
     * Get an image.
     *
     * @param int $id_image
     *
     * @return array()
     */
    public function getImage($id_image)
    {
        $imageData = new Image((int) $id_image);

        return [
            'id' => $imageData->id,
            'id_product' => $imageData->id_product,
            'position' => $imageData->position,
            'cover' => $imageData->cover ? true : false,
            'legend' => $imageData->legend,
            'format' => $imageData->image_format,
            'base_image_url' => _THEME_PROD_DIR_ . $imageData->getImgPath(),
        ];
    }
}