Code Coverage |
||||||||||
Classes and Traits |
Functions and Methods |
Lines |
||||||||
Total | |
0.00% |
0 / 1 |
|
75.00% |
6 / 8 |
CRAP | |
90.91% |
30 / 33 |
CompletionSearchProfileRepository | |
0.00% |
0 / 1 |
|
75.00% |
6 / 8 |
16.19 | |
90.91% |
30 / 33 |
fromFile | |
100.00% |
1 / 1 |
1 | |
100.00% |
2 / 2 |
|||
fromConfig | |
0.00% |
0 / 1 |
2.03 | |
80.00% |
4 / 5 |
|||
__construct | |
0.00% |
0 / 1 |
8.06 | |
90.48% |
19 / 21 |
|||
repositoryType | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
repositoryName | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
getProfile | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
hasProfile | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
|||
listExposedProfiles | |
100.00% |
1 / 1 |
1 | |
100.00% |
1 / 1 |
<?php | |
namespace CirrusSearch\Profile; | |
use CirrusSearch\SearchConfig; | |
/** | |
* Repository dedicated to completion queries | |
* This one cannot simply use existing implementation because | |
* we need to filter the profiles based on the availability of | |
* some fields in the index. | |
*/ | |
class CompletionSearchProfileRepository implements SearchProfileRepository { | |
/** | |
* @var SearchProfileRepository | |
*/ | |
private $wrapped; | |
/** | |
* @param string $repoType | |
* @param string $repoName | |
* @param string $phpFile | |
* @param SearchConfig $config | |
* @return CompletionSearchProfileRepository | |
*/ | |
public static function fromFile( $repoType, $repoName, $phpFile, SearchConfig $config ) { | |
// TODO: find a construct that does not require duplicating ArrayProfileRepository::fromFile | |
return new self( $repoType, $repoName, $config, static function () use ( $phpFile ) { | |
return require $phpFile; | |
} ); | |
} | |
/** | |
* @param string $repoType | |
* @param string $repoName | |
* @param string $configEntry | |
* @param SearchConfig $config | |
* @return CompletionSearchProfileRepository | |
*/ | |
public static function fromConfig( $repoType, $repoName, $configEntry, SearchConfig $config ) { | |
// TODO: find a construct that reuses ConfigProfileRepository | |
return new self( $repoType, $repoName, $config, static function () use ( $configEntry, $config ) { | |
$profiles = $config->get( $configEntry ); | |
if ( $profiles === null ) { | |
return []; | |
} | |
return $profiles; | |
} ); | |
} | |
/** | |
* @param string $repoType | |
* @param string $repoName | |
* @param SearchConfig $config | |
* @param callable $arrayLoader callable that resolves to an array of original profiles | |
*/ | |
private function __construct( $repoType, $repoName, SearchConfig $config, callable $arrayLoader ) { | |
$this->wrapped = ArrayProfileRepository::lazyLoaded( $repoType, $repoName, static function () use ( $arrayLoader, $config ) { | |
$profiles = []; | |
$allowedFields = [ 'suggest' => true, 'suggest-stop' => true ]; | |
// Check that we can use the subphrases FST | |
if ( $config->getElement( 'CirrusSearchCompletionSuggesterSubphrases', 'use' ) ) { | |
$allowedFields['suggest-subphrases'] = true; | |
} | |
$originalProfiles = call_user_func( $arrayLoader ); | |
if ( !is_array( $originalProfiles ) ) { | |
throw new SearchProfileException( "Expected an array but got a " . gettype( $originalProfiles ) ); | |
} | |
foreach ( $originalProfiles as $name => $settings ) { | |
$allowed = true; | |
if ( !isset( $settings['fst'] ) ) { | |
throw new SearchProfileException( "Completion profile $name must have a fst key defined" ); | |
} | |
foreach ( $settings['fst'] as $value ) { | |
if ( empty( $allowedFields[$value['field']] ) ) { | |
$allowed = false; | |
break; | |
} | |
} | |
if ( !$allowed ) { | |
continue; | |
} | |
$profiles[$name] = $settings; | |
} | |
return $profiles; | |
} ); | |
} | |
/** | |
* @return string | |
*/ | |
public function repositoryType() { | |
return $this->wrapped->repositoryType(); | |
} | |
/** | |
* @return string | |
*/ | |
public function repositoryName() { | |
return $this->wrapped->repositoryName(); | |
} | |
/** | |
* @param string $name | |
* @return array | |
*/ | |
public function getProfile( $name ) { | |
return $this->wrapped->getProfile( $name ); | |
} | |
/** | |
* @param string $name | |
* @return bool | |
*/ | |
public function hasProfile( $name ) { | |
return $this->wrapped->hasProfile( $name ); | |
} | |
/** | |
* @return array[] | |
*/ | |
public function listExposedProfiles() { | |
return $this->wrapped->listExposedProfiles(); | |
} | |
} |