<?php

/*
 * This file is part of the Ivory Google Map package.
 *
 * (c) Eric GELOEN <geloen.eric@gmail.com>
 *
 * For the full copyright and license information, please read the LICENSE
 * file that was distributed with this source code.
 */

namespace Ivory\GoogleMap\Exception;

/**
 * Ivory google map exception.
 *
 * @author GeLo <geloen.eric@gmail.com>
 */
class MapException extends Exception
{
    /**
     * Gets the "INVALID ASYNC" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID ASYNC" exception.
     */
    public static function invalidAsync()
    {
        return new static('The asynchronous load of a map must be a boolean value.');
    }

    /**
     * Gets the "INVALID AUTO ZOOM" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID AUTO ZOOM" exception.
     */
    public static function invalidAutoZoom()
    {
        return new static('The auto zoom of a map must be a boolean value.');
    }

    /**
     * Gets the "INVALID BOUND" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID BOUND" exception.
     */
    public static function invalidBound()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The bound setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setBound(Ivory\GoogleMap\Base\Bound $bound)',
            ' - function setBount('.
            'Ivory\GoogleMap\Base\Coordinate $southWest, '.
            'Ivory\GoogleMap\Base\Coordinate $northEast'.
            ')',
            ' - function setBound('.
            'double $southWestLatitude, '.
            'double $southWestLongitude, '.
            'double $northEastLatitude, '.
            'double $northEastLongitude, '.
            'boolean southWestNoWrap = true, '.
            'boolean $northEastNoWrap = true'.
            ')'
        ));
    }

    /**
     * Gets the "INVALID CENTER" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID CENTER" exception.
     */
    public static function invalidCenter()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The center setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setCenter(Ivory\GoogleMap\Base\Coordinate $center)',
            ' - function setCenter(double $latitude, double $longitude, boolean $noWrap = true)'
        ));
    }

    /**
     * Gets the "INVALID HTML CONTAINER ID" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID HTML CONTAINER ID" exception.
     */
    public static function invalidHtmlContainerId()
    {
        return new static('The html container id of a map must be a string value.');
    }

    /**
     * Gets the "INVALID MAP OPTION" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID MAP OPTION" exception.
     */
    public static function invalidMapOption()
    {
        return new static('The map option property of a map must be a string value.');
    }

    /**
     * Gets the "INVALID MAP TYPE CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INAVLID MAP TYPE CONTROL" exception.
     */
    public static function invalidMapTypeControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The map type control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setMapTypeControl(Ivory\GoogleMap\Controls\MapTypeControl $mapTypeControl = null)',
            ' - function setMaptypeControl(array $mapTypeIds, string $controlPosition, string $mapTypeControlStyle)'
        ));
    }

    /**
     * Gets the "INVALID OVERVIEW MAP CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID OVERVIEW MAP CONTROL" exception.
     */
    public static function invalidOverviewMapControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The overview map control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setOverviewMapControl(Ivory\GoogleMap\Controls\OverviewMapControl $overviewMapControl = null)',
            ' - function setOverviewMapControl(boolean $opened)'
        ));
    }

    /**
     * Gets the "INVALID PAN CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID PAN CONTROL" exception.
     */
    public static function invalidPanControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The pan control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setPanControl(Ivory\GoogleMap\Controls\PanControl $panControl = null)',
            ' - function setPanControl(string $controlPosition)'
        ));
    }

    /**
     * Gets the "INVALID ROTATE CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID ROTATE CONTROL" exception.
     */
    public static function invalidRotateControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The rotate control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setRotateControl(Ivory\GoogleMap\Controls\RotateControl $rotateControl = null)',
            ' - function setRotateControl(string $controlPosition)'
        ));
    }

    /**
     * Gets the "INVALID SCALE CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID SCALE CONTROL" exception.
     */
    public static function invalidScaleControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The scale control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setScaleControl(Ivory\GoogleMap\Controls\ScaleControl $scaleControl = null)',
            ' - function setScaleControl(string $controlPosition, string $scaleControlStyle)'
        ));
    }

    /**
     * Gets the "INVALID STREET VIEW CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID STREET VIEW CONTROL" exception.
     */
    public static function invalidStreetViewControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The street view control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setStreetViewControl(Ivory\GoogleMap\Controls\StreetViewControl $streetViewControl = null)',
            ' - function setStreetViewControl(string $controlPosition)'
        ));
    }

    /**
     * Gets the "INVALID ZOOM CONTROL" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INVALID ZOOM CONTROL" exception.
     */
    public static function invalidZoomControl()
    {
        return new static(sprintf(
            '%s'.PHP_EOL.'%s'.PHP_EOL.'%s'.PHP_EOL.'%s',
            'The zoom control setter arguments is invalid.',
            'The available prototypes are :',
            ' - function setZoomControl(Ivory\GoogleMap\Controls\ZoomControl $zoomControl = null)',
            ' - function setZoomControl(string $controlPosition, string $zoomControlStyle)'
        ));
    }

    /**
     * Gets the "INVALID STYLESHEET OPTION" exception.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "INAVLID STYLESHEET OPTION" exception.
     */
    public static function invalidStylesheetOption()
    {
        return new static('The stylesheet option property of a map must be a string value.');
    }

    /**
     * Gets the "MAP OPTION DOES NOT EXIST" exception.
     *
     * @param string $mapOption The map option.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "MAP OPTION DOES NOT EXIST" exception.
     */
    public static function mapOptionDoesNotExist($mapOption)
    {
        return new static(sprintf('The map option "%s" does not exist.', $mapOption));
    }

    /**
     * Gets the "STYLESHEET OPTION DOES NOT EXIST" exception.
     *
     * @param string $stylesheetOption The stylesheet option.
     *
     * @return \Ivory\GoogleMap\Exception\MapException The "STYLESHEET OPTION DOES NOT EXIST" exception.
     */
    public static function stylesheetOptionDoesNotExist($stylesheetOption)
    {
        return new static(sprintf('The stylesheet option "%s" does not exist.', $stylesheetOption));
    }
}