server/src/app/Services/GeonamesResolverInterface.php
author ymh <ymh.work@gmail.com>
Mon, 12 Jun 2017 22:33:23 +0200
changeset 539 bb12d638cb9f
parent 304 20071981ba2a
permissions -rw-r--r--
improve documentation on proxy

<?php
namespace CorpusParole\Services;

interface GeonamesResolverInterface {

    /**
     * Get label from Geonames id
     * @param string $id The id to resolve. Can be an url starting with http(s)://(wwww|sws).geonames.org
     * @return a string with the label
     */
    public function getLabel($id);

    /**
     * Get a list of labels from an array of geonames ids.
     * @param array $ids The array of ids to resolve.
     *                   Each id can be an url starting with http(s)://(wwww|sws).geonames.org
     */
    public function getLabels(array $ids);

}