@ -1,7 +1,8 @@
<?php <?php
/** /**
* EBSCO EDS API class * @file
* The EBSCO EDS API class.
* *
* PHP version 5 * PHP version 5
* *
@ -19,47 +20,48 @@
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*
*/ */
require_once 'EBSCOConnector.php'; require_once 'EBSCOConnector.php';
require_once 'EBSCOResponse.php'; require_once 'EBSCOResponse.php';
/** /**
* EBSCO API class * EBSCO API class.
*/ */
class EBSCOAPI class EBSCOAPI {
{
/** /**
* The authentication token used for API transactions * The authentication token used for API transactions.
*
* @global string * @global string
*/ */
private $authenticationToken; private $authenticationToken;
/** /**
* The session token for API transactions * The session token for API transactions.
*
* @global string * @global string
*/ */
private $sessionToken; private $sessionToken;
/** /**
* The EBSCOConnector object used for API transactions * The EBSCOConnector object used for API transactions.
*
* @global object EBSCOConnector * @global object EBSCOConnector
*/ */
private $connector; private $connector;
/** /**
* Configuration options * Configuration options.
*/ */
private $config; private $config;
/** /**
* VuFind search types mapped to EBSCO search types * VuFind search types mapped to EBSCO search types
* used for urls in search results / detailed result * used for urls in search results / detailed result.
*
* @global array * @global array
*/ */
private static $search_tags = array( private static $search_tags = array(
@ -71,25 +73,27 @@ class EBSCOAPI
'Subject' => 'SU', 'Subject' => 'SU',
'Title' => 'TI', 'Title' => 'TI',
'ISBN' => 'IB', 'ISBN' => 'IB',
'ISSN' => 'IS' 'ISSN' => 'IS',
); );
/** /**
* EBSCO sort options * EBSCO sort options .
*
* @global array * @global array
*/ */
private static $sort_options = array( private static $sort_options = array(
'relevance', 'relevance',
'date', 'date',
'date2', 'date2',
'source' 'source',
); );
/** /**
* VuFind sort types mapped to EBSCO sort types * VuFind sort types mapped to EBSCO sort types
* used for urls in Search results / Detailed view * used for urls in Search results / Detailed view.
*
* @global array * @global array
*/ */
private static $mapped_sort_options = array( private static $mapped_sort_options = array(
@ -101,136 +105,134 @@ class EBSCOAPI
'date_desc' => 'date', 'date_desc' => 'date',
'callnumber' => 'date', 'callnumber' => 'date',
'author' => 'author', 'author' => 'author',
'title' => 'date' 'title' => 'date',
); );
/** /**
* Constructor * Constructor.
*
* *
* @param array config * @param array config
* *
* @access public * @access public
*/ */
public function __construct($config) public function __construct($config) {
{
$this->config = $config; $this->config = $config;
} }
/** /**
* Setter / Getter for authentication token * Setter / Getter for authentication token.
* *
* @param string The authentication token * @param string The authentication token
* *
* @return string or none * @return string or none
*
* @access public * @access public
*/ */
public function authenticationToken($token = null) public function authenticationToken($token = NULL) {
{
if (empty($token)) { if (empty($token)) {
$token = $this->readSession('authenticationToken'); $token = $this->readSession('authenticationToken');
return !empty($token) ? $token : $this->authenticationToken; return !empty($token) ? $token : $this->authenticationToken;
} else { }
else {
$this->authenticationToken = $token; $this->authenticationToken = $token;
$this->writeSession('authenticationToken', $token); $this->writeSession('authenticationToken', $token);
} }
} }
/** /**
* Setter / Getter for session token * Setter / Getter for session token.
* *
* @param string The session token * @param string The session token
* *
* @return string or none * @return string or none
*
* @access public * @access public
*/ */
public function sessionToken($token = null) public function sessionToken($token = NULL) {
{
if (empty($token)) { if (empty($token)) {
$token = $this->readSession('sessionToken'); $token = $this->readSession('sessionToken');
return !empty($token) ? $token : $this->sessionToken; return !empty($token) ? $token : $this->sessionToken;
} else { }
else {
$this->sessionToken = $token; $this->sessionToken = $token;
$this->writeSession('sessionToken', $token); $this->writeSession('sessionToken', $token);
} }
} }
/** /**
* Getter for isGuest * Getter for isGuest.
* *
* @param string 'y' or 'n' * @param string 'y' or 'n'
* *
* @return string or none * @return string or none
*
* @access public * @access public
*/ */
public function isGuest($boolean = null) public function isGuest($boolean = NULL) {
{
if (empty($boolean)) { if (empty($boolean)) {
return $this->readSession('isGuest'); return $this->readSession('isGuest');
} else { }
else {
$this->writeSession('isGuest', $boolean); $this->writeSession('isGuest', $boolean);
} }
} }
/** /**
* Create a new EBSCOConnector object or reuse an existing one * Create a new EBSCOConnector object or reuse an existing one.
* *
* @param none * @param none
* *
* @return EBSCOConnector object * @return EBSCOConnector object
*
* @access public * @access public
*/ */
public function connector() public function connector() {
{
if (empty($this->connector)) { if (empty($this->connector)) {
$this->connector = new EBSCOConnector($this->config); $this->connector = new EBSCOConnector($this->config);
} }
return $this->connector; return $this->connector;
} }
/** /**
* Create a new EBSCOResponse object * Create a new EBSCOResponse object.
* *
* @param object $response * @param object $response
* *
* @return EBSCOResponse object * @return EBSCOResponse object
*
* @access public * @access public
*/ */
public function response($response) public function response($response) {
{
$responseObj = new EBSCOResponse($response); $responseObj = new EBSCOResponse($response);
return $responseObj; return $responseObj;
} }
/** /**
* Request authentication and session tokens, then send the API request. * Request authentication and session tokens, then send the API request.
* Retry the request if authentication errors occur * Retry the request if authentication errors occur.
* *
* @param string $action The EBSCOConnector method name * @param string $action
* @param array $params The parameters of the HTTP request * The EBSCOConnector method name.
* @param integer $attempts The number of retries * @param array $params
* The parameters of the HTTP request.
* @param int $attempts
* The number of retries.
* *
* @return object SimpleXml DOM or PEAR Error * @return object SimpleXml DOM or PEAR Error
*
* @access protected * @access protected
*/ */
protected function request($action, $params = null, $attempts = 5) protected function request($action, $params = NULL, $attempts = 5) {
{
$authenticationToken = $this->authenticationToken(); $authenticationToken = $this->authenticationToken();
$sessionToken = $this->sessionToken(); $sessionToken = $this->sessionToken();
// If authentication token is missing then the session token is missing too, so get both tokens // If authentication token is missing then the session token is missing too, so get both tokens
// If session token is missing then the authentication token may be invalid, so get both tokens // If session token is missing then the authentication token may be invalid, so get both tokens.
if (empty($authenticationToken) || empty($sessionToken)) { if (empty($authenticationToken) || empty($sessionToken)) {
$result = $this->apiAuthenticationAndSessionToken(); $result = $this->apiAuthenticationAndSessionToken();
if ($this->isError($result)) { if ($this->isError($result)) {
// Any error should terminate the request immediately // Any error should terminate the request immediately
// in order to prevent infinite recursion // in order to prevent infinite recursion.
return $result; return $result;
} }
} }
@ -244,165 +246,183 @@ class EBSCOAPI
$headers = array( $headers = array(
'x-authenticationToken' => $this->authenticationToken(), 'x-authenticationToken' => $this->authenticationToken(),
'x-sessionToken' => $this->sessionToken() 'x-sessionToken' => $this->sessionToken(),
); );
$response = call_user_func_array(array($this->connector(), "request{$action}"), array($params, $headers)); $response = call_user_func_array(array($this->connector(), "request{$action}"), array($params, $headers));
if ($this->isError($response)) { if ($this->isError($response)) {
// Retry the request if there were authentication errors // Retry the request if there were authentication errors.
$code = $response->getCode(); $code = $response->getCode();
switch ($code) { switch ($code) {
// If authentication token is invalid then the session token is invalid too, so get both tokens // If authentication token is invalid then the session token is invalid too, so get both tokens
// If session token is invalid then the authentication token may be invalid too, so get both tokens // If session token is invalid then the authentication token may be invalid too, so get both tokens.
case EBSCOConnector::EDS_AUTH_TOKEN_INVALID: case EBSCOConnector::EDS_AUTH_TOKEN_INVALID:
$result = $this->apiAuthenticationToken(); $result = $this->apiAuthenticationToken();
if ($this->isError($result)) { if ($this->isError($result)) {
// Any error should terminate the request immediately // Any error should terminate the request immediately
// in order to prevent infinite recursion // in order to prevent infinite recursion.
return $result; return $result;
} }
if ($attempts > 0) { if ($attempts > 0) {
$result = $this->request($action, $params, --$attempts); $result = $this->request($action, $params, --$attempts);
} }
break; break;
case EBSCOConnector::EDS_SESSION_TOKEN_INVALID: case EBSCOConnector::EDS_SESSION_TOKEN_INVALID:
$result = $this->apiAuthenticationAndSessionToken(); $result = $this->apiAuthenticationAndSessionToken();
if ($this->isError($result)) { if ($this->isError($result)) {
// Any error should terminate the request immediately // Any error should terminate the request immediately
// in order to prevent infinite recursion // in order to prevent infinite recursion.
return $result; return $result;
} }
if ($attempts > 0) { if ($attempts > 0) {
$result = $this->request($action, $params, --$attempts); $result = $this->request($action, $params, --$attempts);
} }
break; break;
default: default:
$result = $this->handleError($response); $result = $this->handleError($response);
break; break;
} }
} else { }
else {
$result = $this->response($response)->result(); $result = $this->response($response)->result();
} }
return $result; return $result;
} }
/** /**
* Wrapper for authentication API call * Wrapper for authentication API call.
* *
* @param none * @param none
* *
* @access public * @access public
*/ */
public function apiAuthenticationToken() public function apiAuthenticationToken() {
{
$response = $this->connector()->requestAuthenticationToken(); $response = $this->connector()->requestAuthenticationToken();
if ($this->isError($response)) { if ($this->isError($response)) {
return $response; return $response;
} else { }
else {
$result = $this->response($response)->result(); $result = $this->response($response)->result();
if (isset($result['authenticationToken'])) { if (isset($result['authenticationToken'])) {
$this->authenticationToken($result['authenticationToken']); $this->authenticationToken($result['authenticationToken']);
return $result['authenticationToken']; return $result['authenticationToken'];
} else { }
else {
return new EBSCOException("No authentication token was found in the response."); return new EBSCOException("No authentication token was found in the response.");
} }
} }
} }
/** /**
* Wrapper for session API call * Wrapper for session API call.
* *
* @param none * @param none
* *
* @access public * @access public
*/ */
public function apiSessionToken() public function apiSessionToken() {
{ // Add authentication tokens to headers.
// Add authentication tokens to headers
$headers = array( $headers = array(
'x-authenticationToken' => $this->authenticationToken() 'x-authenticationToken' => $this->authenticationToken(),
); );
$response = $this->connector()->requestSessionToken($headers); $response = $this->connector()->requestSessionToken($headers);
// Raise the exception so that any code running this method should exit immediately // Raise the exception so that any code running this method should exit immediately.
if ($this->isError($response)) { if ($this->isError($response)) {
return $response; return $response;
} else { }
else {
$result = $this->response($response)->result(); $result = $this->response($response)->result();
if (is_string($result)) { if (is_string($result)) {
$this->sessionToken($result); $this->sessionToken($result);
return $result; return $result;
} else { }
else {
return new EBSCOException("No session token was found in the response."); return new EBSCOException("No session token was found in the response.");
} }
} }
} }
/** /**
* Initialize the authentication and session tokens * Initialize the authentication and session tokens.
* *
* @param none * @param none
* *
* @access public * @access public
*/ */
public function apiAuthenticationAndSessionToken() public function apiAuthenticationAndSessionToken() {
{
$authenticationToken = $this->apiAuthenticationToken(); $authenticationToken = $this->apiAuthenticationToken();
if ($this->isError($authenticationToken)) { if ($this->isError($authenticationToken)) {
// An authentication error should terminate the request immediately // An authentication error should terminate the request immediately.
return $authenticationToken; return $authenticationToken;
} }
$sessionToken = $this->apiSessionToken(); $sessionToken = $this->apiSessionToken();
if ($this->isError($sessionToken)) { if ($this->isError($sessionToken)) {
// A session error should terminate the request immediately // A session error should terminate the request immediately.
return $sessionToken; return $sessionToken;
} }
// We don't have to return anything, both tokens can be accessed using the getters // We don't have to return anything, both tokens can be accessed using the getters.
return true ; return TRUE ;
} }
/** /**
* Wrapper for search API call * Wrapper for search API call.
* *
* @param array $search The search terms * @param array $search
* @param array $filters The facet filters * The search terms.
* @param string $start The page to start with * @param array $filters
* @param string $limit The number of records to return * The facet filters.
* @param string $sortBy The value to be used by for sorting * @param string $start
* @param string $amount The amount of data to be returned * The page to start with.
* @param string $mode The search mode * @param string $limit
* The number of records to return.
* @param string $sortBy
* The value to be used by for sorting.
* @param string $amount
* The amount of data to be returned.
* @param string $mode
* The search mode.
* *
* @throws object PEAR Error * @throws object PEAR Error
*
* @return array An array of query results * @return array An array of query results
*
* @access public * @access public
*/ */
public function apiSearch($search, $filters, public function apiSearch($search,
$start = 1, $limit = 10, $sortBy = 'relevance', $amount = 'detailed', $mode = 'all', $rs=false, $emp=false,$autosuggest=false) { $filters,
$start = 1,
$limit = 10,
$sortBy = 'relevance',
$amount = 'detailed',
$mode = 'all',
$rs = FALSE,
$emp = FALSE,
$autosuggest = FALSE) {
$query = array(); $query = array();
// Basic search // Basic search.
if(!empty($search['lookfor'])) { if (!empty($search['lookfor'])) {
$lookfor = $search['lookfor']; $lookfor = $search['lookfor'];
$type = isset($search['index']) & & !empty($search['index']) ? $search['index'] : 'AllFields'; $type = isset($search['index']) & & !empty($search['index']) ? $search['index'] : 'AllFields';
// escape some characters from lookfor term // Escape some characters from lookfor term.
$term = str_replace(array(',', ':', '(', ')'), array('\,', '\:', '\(', '\)'), $lookfor); $term = str_replace(array(',', ':', '(', ')'), array('\,', '\:', '\(', '\)'), $lookfor);
// r eplace multiple consecutive empty spaces with one empty space // R eplace multiple consecutive empty spaces with one empty space.
$term = preg_replace("/\s+/", ' ', $term); $term = preg_replace("/\s+/", ' ', $term);
// s earch terms // S earch terms
// Complex search term // Complex search term.
if (preg_match('/(.*) (AND|OR) (.*)/i', $term)) { if (preg_match('/(.*) (AND|OR) (.*)/i', $term)) {
$query['query'] = $term; $query['query'] = $term;
} else { }
else {
$tag = self::$search_tags[$type]; $tag = self::$search_tags[$type];
$op = 'AND'; $op = 'AND';
$query_str = implode(',', array($op, $tag)); $query_str = implode(',', array($op, $tag));
@ -410,9 +430,9 @@ class EBSCOAPI
$query['query-1'] = $query_str; $query['query-1'] = $query_str;
} }
// Advanced search // Advanced search.
} }
else if (!empty($search['group'])) { elseif (!empty($search['group'])) {
$counter = 1; $counter = 1;
foreach ($search['group'] as $group) { foreach ($search['group'] as $group) {
@ -422,9 +442,9 @@ class EBSCOAPI
$op = $group['bool']; $op = $group['bool'];
$tag = $type & & isset(self::$search_tags[$type]) ? self::$search_tags[$type] : ''; $tag = $type & & isset(self::$search_tags[$type]) ? self::$search_tags[$type] : '';
// escape some characters from lookfor term // Escape some characters from lookfor term.
$term = str_replace(array(',', ':', '(', ')'), array('\,', '\:', '\(', '\)'), $term); $term = str_replace(array(',', ':', '(', ')'), array('\,', '\:', '\(', '\)'), $term);
// r eplace multiple consecutive empty spaces with one empty space // R eplace multiple consecutive empty spaces with one empty space.
$term = preg_replace("/\s+/", ' ', $term); $term = preg_replace("/\s+/", ' ', $term);
if (!empty($term)) { if (!empty($term)) {
$query_str = implode(',', array($op, $tag)); $query_str = implode(',', array($op, $tag));
@ -435,177 +455,185 @@ class EBSCOAPI
} }
} }
// No search term, return an empty array // No search term, return an empty array.
} else { }
else {
$results = array( $results = array(
'recordCount' => 0, 'recordCount' => 0,
'numFound' => 0, 'numFound' => 0,
'start' => 0, 'start' => 0,
'documents' => array(), 'documents' => array(),
'facets' => array() 'facets' => array(),
); );
return $results; return $results;
} }
// Add filters // Add filters.
$limiters = array(); $expanders = array(); $facets = array(); $limiters = array(); $expanders = array(); $facets = array();
foreach ($filters as $filter) { foreach ($filters as $filter) {
if (preg_match('/addlimiter/', $filter)) { if (preg_match('/addlimiter/', $filter)) {
list($action, $str) = explode('(', $filter, 2); list($action, $str) = explode('(', $filter, 2);
$field_and_value = substr($str, 0, -1); // e.g. FT:y or GZ:Student Research, Projects and Publications // e.g. FT:y or GZ:Student Research, Projects and Publications.
$field_and_value = substr($str, 0, -1);
list($field, $value) = explode(':', $field_and_value, 2); list($field, $value) = explode(':', $field_and_value, 2);
$limiters[$field][] = $value; $limiters[$field][] = $value;
} else if (preg_match('/addexpander/', $filter)) { }
elseif (preg_match('/addexpander/', $filter)) {
list($action, $str) = explode('(', $filter, 2); list($action, $str) = explode('(', $filter, 2);
$field = substr($str, 0, -1); // expanders don't have value // Expanders don't have value.
$field = substr($str, 0, -1);
$expanders[] = $field; $expanders[] = $field;
} else if (preg_match('/addfacetfilter/', $filter)) { }
elseif (preg_match('/addfacetfilter/', $filter)) {
list($action, $str) = explode('(', $filter, 2); list($action, $str) = explode('(', $filter, 2);
$field_and_value = substr($str, 0, -1); // e.g. ZG:FRANCE // e.g. ZG:FRANCE.
$field_and_value = substr($str, 0, -1);
list($field, $value) = explode(':', $field_and_value, 2); list($field, $value) = explode(':', $field_and_value, 2);
$facets[$field][] = $field_and_value; $facets[$field][] = $field_and_value;
} }
} }
if (!empty($limiters)) { if (!empty($limiters)) {
foreach($limiters as $field => $limiter) { foreach ($limiters as $field => $limiter) {
$query['limiter'][] = $field . ':' . implode(',', $limiter); // e.g. LA99:English,French,German // e.g. LA99:English,French,German.
$query['limiter'][] = $field . ':' . implode(',', $limiter);
} }
} }
if (!empty($expanders)) { if (!empty($expanders)) {
$query['expander'] = implode(',', $expanders); // e.g. fulltext, thesaurus // e.g. fulltext, thesaurus.
$query['expander'] = implode(',', $expanders);
} }
if (!empty($facets)) { if (!empty($facets)) {
$groupId = 1; $groupId = 1;
foreach($facets as $field => $facet) { foreach ($facets as $field => $facet) {
$query['facetfilter'][] = $groupId . ',' . implode(',', $facet); // e.g. 1,DE:Math,DE:History // e.g. 1,DE:Math,DE:History.
$query['facetfilter'][] = $groupId . ',' . implode(',', $facet);
$groupId += 1; $groupId += 1;
} }
} }
//2014-03-26 - new action to jump to page // 2014-03-26 - new action to jump to page.
if ($start> 1) { if ($start > 1) {
$query['action']="GoToPage(".$start. ")"; $query['action'] = "GoToPage(" . $start . ")";
} }
// Add the sort option.
// Add the sort option
$sortBy = in_array($sortBy, self::$sort_options) ? $sortBy : self::$mapped_sort_options[$sortBy]; $sortBy = in_array($sortBy, self::$sort_options) ? $sortBy : self::$mapped_sort_options[$sortBy];
// Add the HTTP query params // Add the HTTP query params.
$params = array( $params = array(
// Specifies the sort. Valid options are: // Specifies the sort. Valid options are:
// relevance, date, date2 // relevance, date, date2
// date = Date descending // date = Date descending
// date2 = Date ascending // date2 = Date ascending.
'sort' => $sortBy, 'sort' => $sortBy,
// Specifies the search mode. Valid options are: // Specifies the search mode. Valid options are:
// bool, any, all, smart // bool, any, all, smart.
'searchmode' => $mode, 'searchmode' => $mode,
// Specifies the amount of data to return with the response // Specifies the amount of data to return with the response
// Valid options are: // Valid options are:
// title: Title only // title: Title only
// brief: Title + Source, Subjects // brief: Title + Source, Subjects
// detailed: Brief + full abstract // detailed: Brief + full abstract.
'view' => $amount, 'view' => $amount,
/ // Specifies whether or not to include facets // Specifies whether or not to include facets.
'includefacets' => 'y', 'includefacets' => 'y',
'resultsperpage' => $limit, 'resultsperpage' => $limit,
//2014-03-26 RF // 2014-03-26 RF.
'pagenumber' => $start, 'pagenumber' => $start,
// 'pagenumber' => 1, // 'pagenumber' => 1,
// Specifies whether or not to include highlighting in the search results // Specifies whether or not to include highlighting in the search results.
'highlight' => 'y' 'highlight' => 'y',
); );
if($autosuggest==true ) { if ($autosuggest == TRUE ) {
$params["autosuggest"]= "y"; $params["autosuggest"] = "y";
} }
if ($rs==true) { if ($rs == TRUE) {
$params["relatedcontent"]= "rs"; $params["relatedcontent"] = "rs";
} }
if ($emp==true) { if ($emp == TRUE) {
if (isset($params["relatedcontent"])) { if (isset($params["relatedcontent"])) {
$params["relatedcontent"].= ",emp"; $params["relatedcontent"] .= ",emp";
} }
else else {
{ $params["relatedcontent"] = "emp";
$params["relatedcontent"]="emp";
} }
} }
$params = array_merge($params, $query); $params = array_merge($params, $query);
$result = $this->request('Search', $params); $result = $this->request('Search', $params);
return $result; return $result;
} }
/** /**
* Wrapper for retrieve API call * Wrapper for retrieve API call.
* *
* @param array $an The accession number * @param array $an
* @param string $start The short database name * The accession number.
* @param string $start
* The short database name.
* *
* @throws object PEAR Error * @throws object PEAR Error
*
* @return array An associative array of data * @return array An associative array of data
*
* @access public * @access public
*/ */
public function apiRetrieve($an, $db) public function apiRetrieve($an, $db) {
{ // Add the HTTP query params.
// Add the HTTP query params
$params = array( $params = array(
'an' => $an, 'an' => $an,
'dbid' => $db, 'dbid' => $db,
'highlight' => 'y' 'highlight' => 'y',
); );
$result = $this->request('Retrieve', $params); $result = $this->request('Retrieve', $params);
return $result; return $result;
} }
/** /**
* Wrapper for info API call * Wrapper for info API call.
* *
* @throws object PEAR Error * @throws object PEAR Error
*
* @return array An associative array of data * @return array An associative array of data
*
* @access public * @access public
*/ */
public function apiInfo() public function apiInfo() {
{
if ($result = $this->readSession('info')) { if ($result = $this->readSession('info')) {
return $result; return $result;
} }
$result = $this->request('Info'); $result = $this->request('Info');
if(!$this->isError($result)) { if (!$this->isError($result)) {
$this->writeSession('info', $result); $this->writeSession('info', $result);
} }
return $result; return $result;
} }
/** /**
* Handle a PEAR_Error. Return : * Handle a PEAR_Error. Return :
* - if the error is critical : an associative array with the current error message * - if the error is critical : an associative array with the current error message
* - if the error is not critical : the error message * - if the error is not critical : the error message .
* *
* @param Pear_Error $exception * @param Pear_Error $exception
* *
* @return array or the Pear_Error exception * @return array or the Pear_Error exception
*
* @access protected * @access protected
*/ */
private function handleError($error) { private function handleError($error) {
$errorCode = $error->getCode(); $errorCode = $error->getCode();
switch($errorCode) { switch ($errorCode) {
// This kind of error was generated by user , so display it to user // This kind of error was generated by user , so display it to user.
case EBSCOConnector::EDS_INVALID_ARGUMENT_VALUE: case EBSCOConnector::EDS_INVALID_ARGUMENT_VALUE:
// Any other errors are system errors, don't display them to user // Any other errors are system errors, don't display them to user.
default: default:
$errorMessage = 'An error occurred when getting the data.'; $errorMessage = 'An error occurred when getting the data.';
break; break;
@ -616,58 +644,55 @@ class EBSCOAPI
'numFound' => 0, 'numFound' => 0,
'start' => 0, 'start' => 0,
'documents' => array(), 'documents' => array(),
'facets' => array() 'facets' => array(),
); );
return $result; return $result;
} }
/** /**
* Store the given object into session * Store the given object into session.
* *
* @param string $key The key used for reading the value * @param string $key
* @param object $value The object stored in session * The key used for reading the value.
* @param object $value
* The object stored in session.
* *
* @return none * @return none
*
* @access protected * @access protected
*/ */
protected function writeSession($key, $value) protected function writeSession($key, $value) {
{ if (!empty($key) & & !empty($value)) {
if(!empty($key) & & !empty($value)) {
$_SESSION['EBSCO'][$key] = $value; $_SESSION['EBSCO'][$key] = $value;
} }
} }
/** /**
* Read from session the object having the given key * Read from session the object having the given key.
* *
* @param string $key The key used for reading the object * @param string $key
* The key used for reading the object.
* *
* @return object * @return object
*
* @access protected * @access protected
*/ */
protected function readSession($key) protected function readSession($key) {
{
$value = isset($_SESSION['EBSCO'][$key]) ? $_SESSION['EBSCO'][$key] : ''; $value = isset($_SESSION['EBSCO'][$key]) ? $_SESSION['EBSCO'][$key] : '';
return $value; return $value;
} }
/** /**
* Check if given object is an EBSCOException object * Check if given object is an EBSCOException object.
* *
* @param object $object * @param object $object
* *
* @return boolean * @return bool
*
* @access protected * @access protected
*/ */
protected function isError($object) protected function isError($object) {
{
return is_a($object, 'EBSCOException'); return is_a($object, 'EBSCOException');
} }
} }
?>
Rui Francisco
8 years ago
committed by