Skip to content

Commit

Permalink
allow unprefixed params, some refactoring, allow specifying query pa…
Browse files Browse the repository at this point in the history 
…rameter name
  • Loading branch information
@JoeZ99
JoeZ99 committed May 12, 2015
1 parent 2bd27f8 commit 3bbc916
Show file tree
Hide file tree
Showing 2 changed files with 95 additions and 18 deletions.
8 changes: 5 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,8 @@ $df = new DoofinderApi('6a9abc4dc17351123b1e0198af92e6e9', //hashid
'eu1-384fd8a73c7ff0859a5891f9f4083b1b9727f9c3', // api_key
true, // get params from request
array(
'prefix' => 'sp_df_df_', // prefix to use with toQuerystring. CAN'T USE EMPTY STRINGS
'prefix' => 'sp_df_df_', // prefix to use with toQuerystring.
'queryParameter' => 'q', // parameter name to use for the query parameter (default: 'query')
'apiVersion' => '3.0', // api version of the search server
'restrictedRequest' => 'post' // use only params from 'post' or 'get' methods.
));
Expand Down Expand Up @@ -344,14 +345,15 @@ One quick example
````html
<?php
include('lib/doofinder_api.php');
$df = new DoofinderApi('6azzz04dc173514cab1e0xxxxf92e6e9',true);
$dfResults = $df->query(); // if no dfParam_query,
$df = new DoofinderApi('6azzz04dc173514cab1e0xxxxf92e6e9', 'eu1-384fd8a73c7ff0859a5891f9f4083b1b9727f9c3', true);
$dfResults = $df->query(null, null, array('transformer'=>'dflayer')); // if no dfParam_query,
// fetch all the results, to fetch all possible facets
?>

<form method="get" action="">
<input type="text" name="dfParam_query" onchange="emptyQueryName()" value="<?php echo $dfResults->getProperty('query')?>">
<input type="hidden" name="dfParam_rpp" value="3">
<input type="hidden" name="dfParam_transformer" value="dflayer">
<!-- this has to be removed via javascript if we want doofinder to find the best search for us. -->
<input type="hidden" id="query_name" name="dfParam_query_name" value="<?php echo $dfResults->getProperty('query_name')?>">

Expand Down
105 changes: 90 additions & 15 deletions lib/doofinder_api.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ class DoofinderApi{
private $maxScore = null;
private $paramsPrefix = self::DEFAULT_PARAMS_PREFIX;
private $serializationArray = null;
private $queryParameter = 'query'; // the parameter used for querying
private $allowedParameters = array('page', 'rpp', 'timeout', 'types', 'filter', 'query_name', 'transformer'); // request parameters that doofinder handle

/**
* Constructor. account's hashid and api version set here
Expand All @@ -56,13 +58,13 @@ class DoofinderApi{
* @param boolean $fromParams if set, the object is unserialized from GET or POST params
* @param array $init_options. associative array with some options:
* -'prefix' (default: 'dfParam_')=> the prefix to use when serializing.
* -'queryParameter' (default: 'query') => the parameter used for querying
* -'apiVersion' (default: '4')=> the api of the search server to query
* -'restrictedRequest'(default: $_REQUEST): =>restrict request object
* to look for params when unserializing. either 'get' or 'post'
* @throws DoofinderException if $hashid is not a md5 hash or api is no 4, 3.0 or 1.0
*/
function __construct($hashid, $api_key, $fromParams=false, $init_options = array()){

$zone_key_array = explode('-', $api_key);

if(2 === count($zone_key_array)){
Expand All @@ -74,13 +76,20 @@ function __construct($hashid, $api_key, $fromParams=false, $init_options = array
}

if(array_key_exists('prefix', $init_options)){
if($init_options['prefix'] != ''){
$this->paramsPrefix = $init_options['prefix'];
} else {
throw new DoofinderException("Can't set empty params prefix");
}
$this->paramsPrefix = $init_options['prefix'];
}


$this->allowedParameters = array_map(array($this, 'addprefix'), $this->allowedParameters);


if(array_key_exists('queryParameter', $init_options)){
$this->queryParameter = $init_options['queryParameter'];
} else {
$this->queryParameter = $this->paramsPrefix.$this->queryParameter;
}


$this->apiVersion = array_key_exists('apiVersion', $init_options) ?
$init_options['apiVersion'] : self::DEFAULT_API_VERSION;
$this->serializationArray = $_REQUEST;
Expand Down Expand Up @@ -112,6 +121,34 @@ function __construct($hashid, $api_key, $fromParams=false, $init_options = array

}

private function addprefix($value){
return $this->paramsPrefix.$value;
}

/*
* translateFilter
*
* translates a range filter to the new ES format
* 'from'=>9, 'to'=>20 to 'gte'=>9, 'lte'=>20
*
* @param array $filter
* @return array the translated filter
*/
private function translateFilter($filter){
$translated = array();
foreach($filter as $keey => $value){
if($keey == 'from'){
$t_key = 'gte';
} else if($keey == 'to'){
$t_key = 'lte';
} else {
$t_key = $keey;
}
$translated[$t_key] = $value;
}
return $translated;
}

private function reqHeaders(){
$headers = array();
$headers[] = 'Expect:'; //Fixes the HTTP/1.1 417 Expectation Failed
Expand All @@ -121,7 +158,7 @@ private function reqHeaders(){

private function apiCall($params){
$params['hashid'] = $this->hashid;
$args = http_build_query(array_filter($params)); // remove any null value from the array
$args = http_build_query($this->sanitize($params)); // remove any null value from the array
$url = $this -> url . '/' . $this->apiVersion . '/search?' . $args;
$session = curl_init($url);
curl_setopt($session, CURLOPT_CUSTOMREQUEST, 'GET');
Expand Down Expand Up @@ -166,6 +203,11 @@ public function query($query=null, $page=null, $options = array()){

$params = $this->search_options;

// translate filters
foreach($params['filter'] as $filterName => $filterValue){
$params['filter'][$filterName] = $this->translateFilter($filterValue);
}

// no query? then match all documents
if(!$this->optionExists('query') || !trim($this->search_options['query'])){
$params['query_name'] = 'match_all';
Expand Down Expand Up @@ -336,8 +378,13 @@ public function setRange($filterName, $from=null, $to=null){
* @param int $page the pagenumber. defaults to the current page
*/
public function toQuerystring($page=null){

foreach($this->search_options as $paramName => $paramValue){
$toParams[$this->paramsPrefix.$paramName] = $paramValue;
if($paramName == 'query'){
$toParams[$this->queryParameter] = $paramValue;
} else {
$toParams[$this->paramsPrefix.$paramName] = $paramValue;
}
}
if($page){
$toParams[$this->paramsPrefix.'page'] = $page;
Expand All @@ -356,12 +403,37 @@ public function toQuerystring($page=null){
public function fromQuerystring(){
$doofinderReqParams = array_filter(array_keys($this->serializationArray),
array($this, 'belongsToDoofinder'));

foreach($doofinderReqParams as $dfReqParam){
$this->search_options[substr($dfReqParam, strlen($this->paramsPrefix))] =
$this->serializationArray[$dfReqParam];
if($dfReqParam == $this->queryParameter){
$keey = 'query';
} else {
$keey = substr($dfReqParam, strlen($this->paramsPrefix));
}
$this->search_options[$keey] = $this->serializationArray[$dfReqParam];
}
}

/**
* sanitize
*
* Clean array of keys with empty values
*
* @param array $params array to be cleaned
* @return array array with no empty keys
*/
private function sanitize($params){
$result = array();
foreach($params as $name => $value){
if (is_array($value)){
$result[$name] = $this->sanitize($value);
} else if (trim($value)){
$result[$name] = $value;
}
}
return $result;
}

/**
* belongsToDoofinder
*
Expand All @@ -371,7 +443,10 @@ public function fromQuerystring(){
* @return boolean true or false.
*/
private function belongsToDoofinder($paramName){
return strpos($paramName, $this->paramsPrefix) === 0;
if($pos = strpos($paramName, '[')){
$paramName = substr($paramName, 0, $pos);
}
return in_array($paramName, $this->allowedParameters) || $paramName == $this->queryParameter;
}

/**
Expand Down Expand Up @@ -565,11 +640,11 @@ function __construct($jsonString){
foreach($facetProperties['ranges'] as $pos => $range){
$this->facets[$facetName]['ranges'][$pos]['selected_from'] = false;
$this->facets[$facetName]['ranges'][$pos]['selected_to'] = false;
if(isset($this->filter[$facetName]) && isset($this->filter[$facetName]['from'])){
$this->facets[$facetName]['ranges'][$pos]['selected_from'] = $this->filter[$facetName]['from'];
if(isset($this->filter[$facetName]) && isset($this->filter[$facetName]['gte'])){
$this->facets[$facetName]['ranges'][$pos]['selected_from'] = $this->filter[$facetName]['gte'];
}
if(isset($this->filter[$facetName]) && isset($this->filter[$facetName]['to'])){
$this->facets[$facetName]['ranges'][$pos]['selected_to'] = $this->filter[$facetName]['to'];
if(isset($this->filter[$facetName]) && isset($this->filter[$facetName]['lte'])){
$this->facets[$facetName]['ranges'][$pos]['selected_to'] = $this->filter[$facetName]['lte'];
}

}
Expand Down

0 comments on commit 3bbc916

Please sign in to comment.