server/src/app/Services/BnfResolverInterface.php
author ymh <ymh.work@gmail.com>
Thu, 25 Feb 2016 21:26:15 +0100
changeset 133 821253d361d1
permissions -rw-r--r--
add bnf resolver
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
133
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
namespace CorpusParole\Services;
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
interface BnfResolverInterface {
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
    /**
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
     * Get name from Viaf id
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
     * @param string $id The id to resolve. Can be an url starting with http://data.bnf.fr/ or http://ark.bnf.fr/
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
     * @return a string with the name
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
     */
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
    public function getLabel($id);
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
    /**
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
     * Get a list of names from an array of viaf ids.
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
     * @param array $ids The array of ids to resolve.
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
     *                   Each id can be an url starting with http://data.bnf.fr/ or http://ark.bnf.fr/
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
     */
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
    public function getLabels(array $ids);
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
821253d361d1 add bnf resolver
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
}