Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
Total | n/a |
0 / 0 |
n/a |
0 / 0 |
CRAP | n/a |
0 / 0 |
1 | <?php |
2 | |
3 | namespace CirrusSearch\Profile; |
4 | |
5 | /** |
6 | * A repository of search profiles |
7 | * |
8 | */ |
9 | interface SearchProfileRepository { |
10 | |
11 | /** |
12 | * The repository type |
13 | * @return string |
14 | */ |
15 | public function repositoryType(); |
16 | |
17 | /** |
18 | * The repository name |
19 | * @return string |
20 | */ |
21 | public function repositoryName(); |
22 | |
23 | /** |
24 | * Load a profile named $name |
25 | * @param string $name |
26 | * @return array|null the profile data or null if not found |
27 | */ |
28 | public function getProfile( $name ); |
29 | |
30 | /** |
31 | * Check if a profile named $name exists in this repository |
32 | * @param string $name |
33 | * @return bool |
34 | */ |
35 | public function hasProfile( $name ); |
36 | |
37 | /** |
38 | * Get the list of profiles that we want to expose to the user. |
39 | * |
40 | * @return array[] list of profiles indexed by name |
41 | */ |
42 | public function listExposedProfiles(); |
43 | } |