<?php

namespace Akeneo\Tool\Bundle\ApiBundle\Checker;

use Akeneo\Channel\Infrastructure\Component\Model\ChannelInterface;
use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
use Symfony\Component\HttpKernel\Exception\UnprocessableEntityHttpException;

/**
 * @author    Olivier Soulet <olivier.soulet@akeneo.com>
 * @copyright 2017 Akeneo SAS (http://www.akeneo.com)
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 */
interface QueryParametersCheckerInterface
{
    /**
     * Checks $localeCodes if they exist.
     * Throws an exception if one of them does not exist or, if there is a $channel, one of them does not belong to it.
     *
     * @param array                 $localeCodes
     * @param ChannelInterface|null $channel
     *
     * @throws UnprocessableEntityHttpException
     */
    public function checkLocalesParameters(array $localeCodes, ChannelInterface $channel = null);

    /**
     * Checks $attributeCodes if they exist. Thrown an exception if one of them does not exist.
     *
     * @param array $attributeCodes
     *
     * @throws UnprocessableEntityHttpException
     */
    public function checkAttributesParameters(array $attributeCodes);

    /**
     * Checks $categories if they exist. Thrown an exception if one of them does not exist.
     *
     * @param array $categories
     *
     * @throws UnprocessableEntityHttpException
     */
    public function checkCategoriesParameters(array $categories);

    /**
     * Prepares criterias from search parameters
     * It throws exceptions if search parameters are not correctly filled
     *
     * @param string $searchString
     *
     * @throws UnprocessableEntityHttpException
     * @throws BadRequestHttpException
     *
     * @return array
     */
    public function checkCriterionParameters(string $searchString);

    /**
     * Checks if the property is valid.
     *
     * @param string $property
     * @param string $operator
     *
     * @throws UnprocessableEntityHttpException
     */
    public function checkPropertyParameters(string $property, string $operator);
}