thephpleague / geotools

/*

 * This file is part of the Geotools library.

 *

 * (c) Antoine Corcy <[email protected]>

 *

 * For the full copyright and license information, please view the LICENSE

 * file that was distributed with this source code.

 */

namespace League\Geotools\CLI\Command\Geocoder;

/**

 * Command class

 *

 * @author Antoine Corcy <[email protected]>

 */

class Command extends \Symfony\Component\Console\Command\Command

{

    /**

     * Available caches.

     *

     * @var array

     */

    private $caches = [

        'memcached' => 'Memcached',

        'mongodb'   => 'MongoDB',

        'redis'     => 'Redis',

    ];

    /**

     * Available adapters.

     *

     * @var array

     */

    private $adapters = [

        'buzz'    => 'BuzzHttpAdapter',

        'curl'    => 'CurlHttpAdapter',

        'guzzle'  => 'GuzzleHttpAdapter',

        'socket'  => 'SocketHttpAdapter',

        'zend'    => 'ZendHttpAdapter',

    ];

    /**

     * Available providers.

     *

     * @var array

     */

    private $providers = [

        'free_geo_ip'          => 'FreeGeoIp',

        'host_ip'              => 'HostIp',

        'ip_info_db'           => 'IpInfoDb',

        'google_maps'          => 'GoogleMaps',

        'google_maps_business' => 'GoogleMapsBusiness',

        'bing_maps'            => 'BingMaps',

        'openstreetmaps'       => 'OpenStreetMap',

        'cloudmade'            => 'CloudMade',

        'geoip'                => 'Geoip',

        'map_quest'            => 'MapQuest',

        'oio_rest'             => 'OIORest',

        'geocoder_ca'          => 'GeocoderCa',

        'geocoder_us'          => 'GeocoderUs',

        'ign_openls'           => 'IGNOpenLS',

        'data_science_toolkit' => 'DataScienceToolkit',

        'yandex'               => 'Yandex',

        'geo_plugin'           => 'GeoPlugin',

        'geo_ips'              => 'GeoIPs',

        'maxmind'              => 'MaxMind',

        'geonames'             => 'Geonames',

        'ip_geo_base'          => 'IpGeoBase',

        'baidu'                => 'Baidu',

        'tomtom'               => 'TomTom',

        'arcgis_online'        => 'ArcGISOnline',

    ];

    /**

     * Available dumpers.

     *

     * @var array

     */

    private $dumpers = [

        'gpx'     => 'Gpx',

        'geojson' => 'GeoJson',

        'kml'     => 'Kml',

        'wkb'     => 'Wkb',

        'wkt'     => 'Wkt',

    ];

    /**

     * Returns the cache class name.

     * The default cache is Redis.

     *

     * @param  string $cache The name of the cache to use.

     *

     * @return string The name of the cache to use.

     */

    protected function getCache($cache)

    {

        $cache = $this->lowerize((trim($cache)));

        $cache = array_key_exists($cache, $this->caches)

            ? $this->caches[$cache]

            : $this->caches['redis'];

        return '\\League\\Geotools\\Cache\\' . $cache;

    }

    /**

     * Returns the list of available caches sorted by alphabetical order.

     *

     * @return string The list of available caches comma separated.

     */

    protected function getCaches()

    {

        ksort($this->caches);

        return implode(', ', array_keys($this->caches));

    }

    /**

     * Returns the adapter class name.

     * The default adapter is cURL.

     *

     * @param string $adapter The name of the adapter to use.

     *

     * @return string The name of the adapter class to use.

     */

    protected function getAdapter($adapter)

    {

        $adapter = $this->lowerize((trim($adapter)));

        $adapter = array_key_exists($adapter, $this->adapters)

            ? $this->adapters[$adapter]

            : $this->adapters['curl'];

        return '\\Ivory\\HttpAdapter\\' . $adapter;

    }

    /**

     * Returns the list of available adapters sorted by alphabetical order.

     *

     * @return string The list of available adapters comma separated.

     */

    protected function getAdapters()

    {

        ksort($this->adapters);

        return implode(', ', array_keys($this->adapters));

    }

    /**

     * Returns the provider class name.

     * The default provider is Google Maps.

     *

     * @param string $provider The name of the provider to use.

     *

     * @return string The name of the provider class to use.

     */

    protected function getProvider($provider)

    {

        $provider = $this->lowerize((trim($provider)));

        $provider = array_key_exists($provider, $this->providers)

            ? $this->providers[$provider]

            : $this->providers['google_maps'];

        return '\\Geocoder\\Provider\\' . $provider;

    }

    /**

     * Returns the list of available providers sorted by alphabetical order.

     *

     * @return string The list of available providers comma separated.

     */

    protected function getProviders()

    {

        ksort($this->providers);

        return implode(', ', array_keys($this->providers));

    }

    /**

     * Returns the dumper class name.

     * The default dumper is WktDumper.

     *

     * @param string $dumper The name of the dumper to use.

     *

     * @return string The name of the dumper class to use.

     */

    /**

     * Returns the list of available dumpers sorted by alphabetical order.

     *

     * @return string The list of available dumpers comma separated.

     */

    protected function getDumpers()

    {

        ksort($this->dumpers);

        return implode(', ', array_keys($this->dumpers));

    }

    /**

     * Make a string lowercase.

     *

     * @param string $string A string to lowercase.

     *

     * @return string The lowercased string.

     */

    private function lowerize($string)

    {

        return extension_loaded('mbstring') ? mb_strtolower($string, 'UTF-8') : strtolower($string);

    }

}