1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
declare(strict_types=1); |
4
|
|
|
|
5
|
|
|
/** |
6
|
|
|
* MyPoseo API Bundle |
7
|
|
|
* |
8
|
|
|
* @author Tristan Bessoussa <[email protected]> |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
namespace Tristanbes\MyPoseoBundle\Api; |
12
|
|
|
|
13
|
|
|
/** |
14
|
|
|
* @see http://fr.myposeo.com/nos-api/api-search/ |
15
|
|
|
*/ |
16
|
|
|
interface SearchInterface |
17
|
|
|
{ |
18
|
|
|
/** |
19
|
|
|
* Returns the identifiers of the search engine's extension |
20
|
|
|
* |
21
|
|
|
* @param string $searchEngine The search engine |
22
|
|
|
* @param int $ttl The time to live for the cache |
23
|
|
|
* |
24
|
|
|
* @return list<array{ id: int, name: string }> |
|
|
|
|
25
|
|
|
*/ |
26
|
|
|
public function getSearchEngineExtensions(string $searchEngine, ?int $ttl = null): array; |
27
|
|
|
|
28
|
|
|
/** |
29
|
|
|
* Get the town's code |
30
|
|
|
* |
31
|
|
|
* @param string $name The town name |
32
|
|
|
* @param string $country The country ISO |
33
|
|
|
* |
34
|
|
|
* @return list<array{ id: int, city_code: string, city_name: string, code_dep: string }> |
|
|
|
|
35
|
|
|
*/ |
36
|
|
|
public function getTownCode(string $name, string $country = 'FR'): array; |
37
|
|
|
|
38
|
|
|
/** |
39
|
|
|
* Retrieves the url position given a keyword |
40
|
|
|
* |
41
|
|
|
* @return list<array{ url_positioned: string, position: string, page: string, type: string, serp: string, nbr_results: int, top: string, keyword: string, url_search: string, searchEngine: string, location: int }> |
|
|
|
|
42
|
|
|
*/ |
43
|
|
|
public function getUrlRankByKeyword(string $keyword, string $url, string $searchEngine = 'google', ?string $callbackUrl = null, ?int $geolocId = null, int $location = 13, ?int $maxPage = null): array; |
44
|
|
|
|
45
|
|
|
/** |
46
|
|
|
* @return mixed |
47
|
|
|
*/ |
48
|
|
|
public function getNaturalSeoResult(); |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @return mixed |
52
|
|
|
*/ |
53
|
|
|
public function getSemResult(); |
54
|
|
|
} |
55
|
|
|
|
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.