D-Net

<?php

defined('_JEXEC') or die('Access denied');

jimport('joomla.application.component.model');

jimport('joomla.base.object');

jimport('joomla.cache.cache');

jimport('joomla.http.http');

jimport('joomla.log.log');

// This model implements document searching using web search.

class OpenAireModelSearch extends JModelItem {

    const LOG = 'openaire';

    const CACHE_GROUP = 'openaire.search';

    const PUBLICATION_STATISTICS_CACHE_ID = 'statistics.publications';

    const DATASET_STATISTICS_CACHE_ID = 'statistics.datasets';

    const PROJECT_STATISTICS_CACHE_ID = 'statistics.projects';

    const PEOPLE_STATISTICS_CACHE_ID = 'statistics.people';

    const ORGANIZATION_STATISTICS_CACHE_ID = 'statistics.organizations';

    const DATASOURCE_STATISTICS_CACHE_ID = 'statistics.datasource';

    const SEARCH_PUBLICATIONS_CACHE_ID = 'search.publications';

    const SEARCH_DATASETS_CACHE_ID = 'search.datasets';

    const SEARCH_PROJECTS_CACHE_ID = 'search.projects';

    const SEARCH_PEOPLE_CACHE_ID = 'search.people';

    const SEARCH_ORGANIZATIONS_CACHE_ID = 'search.organizations';

    const SEARCH_DATASOURCES_CACHE_ID = 'search.datasources';

    const BROWSE_PUBLICATIONS_CACHE_ID = 'browse.publications';

    const BROWSE_DATASETS_CACHE_ID = 'browse.datasets';

    const BROWSE_PROJECTS_CACHE_ID = 'browse.projects';

    const BROWSE_PEOPLE_CACHE_ID = 'browse.people';

    const BROWSE_ORGANIZATIONS_CACHE_ID = 'browse.organizations';

    const BROWSE_DATASOURCES_CACHE_ID = 'browse.datasources';

    const ADVANCED_SEARCH_PUBLICATIONS_CACHE_ID = 'advanced.publications';

    const ADVANCED_SEARCH_PROJECTS_CACHE_ID = 'advanced.projects';

    const ADVANCED_SEARCH_PEOPLE_CACHE_ID = 'advanced.people';

    const ADVANCED_SEARCH_ORGANIZATIONS_CACHE_ID = 'advanced.organizations';

    const ADVANCED_SEARCH_DATASOURCES_CACHE_ID = 'advanced.datasources';

    const RESULT_CACHE_ID = 'result';

    const RESULT_DUP_ID = 'resultdupid';

    const PUBLICATION_CACHE_ID = 'publication';

    const DATASET_CACHE_ID = 'dataset';

    const PROJECT_CACHE_ID = 'project';

    const PUBLICATIONS_CACHE_ID = 'publications';

    const DATASETS_CACHE_ID = 'datasets';

    const PROJECTS_CACHE_ID = 'projects';

    const PROJECT_PUBLICATIONS_CACHE_ID = 'project.publications';

    const PERSON_CACHE_ID = 'person';

    const PERSON_PUBLICATIONS_CACHE_ID = 'person.publications';

    const ORGANIZATION_CACHE_ID = 'organization';

    const ORGANIZATION_DATASOURCES_CACHE_ID = 'organization.datasources';

    const DATASOURCE_CACHE_ID = 'datasource';

    const DATASOURCE_PUBLICATIONS_CACHE_ID = 'datasource.publications';

    const DATASOURCE_ORGANIZATIONS_CACHE_ID = 'datasource.organizations';

    const COMPATIBLE_DATASOURCES_CACHE_ID = 'compatible.datasources';

    const QUICK_SEARCH_PROJECTS_CACHE_ID = 'quick.search.projects';

    const QUICK_SEARCH_ORGANIZATIONS_CACHE_ID = 'quick.search.organizations';

    const RESULT_QUERY = '(oaftype exact result)';

    const RESULT_ID = 'objIdentifier';

    const PUBLICATION_QUERY = '(oaftype exact result) and (resulttypeid exact publication)';

    const PUBLICATION_TYPE = 'instancetypename';

    const PUBLICATION_LANGUAGE = 'resultlanguagename';

    const PUBLICATION_CONTEXT = 'community';

    const PUBLICATION_FUNDER = 'relfunder';

    const PUBLICATION_FUNDING_STREAM = 'relfundinglevel0_id';

    const PUBLICATION_SCIENTIFIC_AREA = 'relfundinglevel1_id';

    const PUBLICATION_FUNDING_STREAM_LEVEL2 = 'relfundinglevel2_id';

    const PUBLICATION_YEAR = 'resultacceptanceyear';

    const PUBLICATION_ACCESS_MODE = 'resultbestlicense';

    const RESULT_HOSTING_DATASOURCE = 'resulthostingdatasource';

    const RESULT_HOSTING_DATASOURCE_ID = 'resulthostingdatasourceid';

    const RESULT_COLLECTED_FROM_DATASOURCE = 'collectedfrom';

    const RESULT_COLLECTED_FROM_DATASOURCE_ID = 'collectedfromdatasourceid';

    const PUBLICATION_PROJECT = 'relproject';

    const PUBLICATION_PROJECT_ID = 'relprojectid';

    const PUBLICATION_AUTHOR_ID = 'relpersonid';

    const PUBLICATION_ARTICLE = '0001';

    const PUBLICATION_PREPRINT = '0016';

    const PUBLICATION_BOOK = '0002';

    const PUBLICATION_BOOK_PART = '0013';

    const PUBLICATION_PHD_THESIS = '0006';

    const PUBLICATION_MASTER_THESIS = '0007';

    const PUBLICATION_BACHELOR_THESIS = '0008';

    const PUBLICATION_REPORT = '0017';

    const PUBLICATION_INTERNAL_REPORT = '0011';

    const PUBLICATION_EXTERNAL_REPORT = '0009';

    const PUBLICATION_TITLE = 'resulttitle';

    const PUBLICATION_AUTHOR = 'relperson';

    const PUBLICATION_PUBLISHER = 'resultpublisher';

    const PUBLICATION_SUBJECT = 'resultsubject';

    const PUBLICATION_DATE = 'resultdateofacceptance';

    const PUBLICATION_ID = 'objIdentifier';

    const DATASET_QUERY = '(oaftype exact result) and (resulttypeid exact dataset)';

    const DATASET_TYPE = 'instancetypename';

    const DATASET_LANGUAGE = 'resultlanguagename';

    const DATASET_FUNDER = 'relfunder';

    const DATASET_FUNDING_STREAM = 'relfundinglevel0_id';

    const DATASET_SCIENTIFIC_AREA = 'relfundinglevel1_id';

    const DATASET_FUNDING_STREAM_LEVEL2 = 'relfundinglevel2_id';

    const DATASET_YEAR = 'resultacceptanceyear';

    const DATASET_ACCESS_MODE = 'resultbestlicense';

    const DATASET_PROJECT = 'relproject';

    const DATASET_PROJECT_ID = 'relprojectid';

    const DATASET_AUTHOR_ID = 'relpersonid';

    const DATASET_ID = 'objIdentifier';

    const PROJECT_QUERY = '(oaftype exact project)';

    const PROJECT = 'project';

    const PROJECT_FUNDER = 'funder';

    const PROJECT_FUNDING_STREAM = 'fundinglevel0_id';

    const PROJECT_SCIENTIFIC_AREA = 'fundinglevel1_id';

    const PROJECT_FUNDING_STREAM_LEVEL2 = 'fundinglevel2_id';

    const PROJECT_START_YEAR = 'projectstartyear';

    const PROJECT_END_YEAR = 'projectendyear';

    const PROJECT_SC39 = 'projectecsc39';

    const PROJECT_ACRONYM = 'projectacronym';

    const PROJECT_TITLE = 'projecttitle';

    const PROJECT_KEYWORDS = 'projectkeywords';

    const PROJECT_START_DATE = 'projectstartdate';

    const PROJECT_END_DATE = 'projectenddate';

    const PROJECT_ID = 'objIdentifier';

    const PROJECT_CODE = 'projectcode';

    const PERSON_QUERY = '(oaftype exact person)';

    // const PERSON_COUNTRY = 'personcountryid';

    const PERSON_LAST_NAME = 'personsecondnames';

    const PERSON_FIRST_NAME = 'personfirstname';

    const PERSON_FULL_NAME = 'personfullname';

    const PERSON_ID = 'objIdentifier';

    const ORGANIZATION_QUERY = '(oaftype exact organization)';

    const ORGANIZATION_QUERY_COMPATIBILITY = 'oaftype exact organization and

(reldatasourcecompatibilityid=driver or reldatasourcecompatibilityid=driver-openaire2.0 or

reldatasourcecompatibilityid=openaire2.0 or reldatasourcecompatibilityid=openaire3.0 or

reldatasourcecompatibilityid=openaire2.0_data or reldatasourcecompatibilityid=hostedBy

or relproject=*)';

    const ORGANIZATION_COUNTRY = 'organizationcountryname';

    const ORGANIZATION_LEGAL_BODY = 'organizationeclegalbody';

    const ORGANIZATION_LEGAL_PERSON = 'organizationeclegalperson';

    const ORGANIZATION_NON_PROFIT = 'organizationecnonprofit';

    const ORGANIZATION_RESEARCH = 'organizationecresearchorganization';

    const ORGANIZATION_EU_INTERESTS = 'organizationecinternationalorganizationeurinterests';

    const ORGANIZATION_INTERNATIONAL = 'organizationecinternationalorganization';

    const ORGANIZATION_ENTERPRISE = 'organizationecenterprise';

    const ORGANIZATION_SMALL_MEDIUM_ENTERPRISE = 'organizationecsmevalidated';

    const ORGANIZATION_NAME = 'organizationlegalname';

    const ORGANIZATION_SHORT_NAME = 'organizationlegalshortname';

    const ORGANIZATION_ID = 'objIdentifier';

//    const DATASOURCE_QUERY = '(oaftype exact datasource) and (datasourcecompatibilityid <> "UNKNOWN") and (datasourcecompatibilityid <> "hostedBy")';

    const DATASOURCE_QUERY = '(oaftype exact datasource) and (datasourcecompatibilityid <> "UNKNOWN")';

    const DATASOURCE_QUERY_COMPATIBILITY = '(oaftype exact datasource)';

    const DATASOURCE_TYPE = 'datasourcetypeuiname';

    const DATASOURCE_LANGUAGE = 'datasourceodlanguages';

    const DATASOURCE_CONTENT = 'datasourceodcontenttypes';

    const DATASOURCE_COMPATIBILITY = 'datasourcecompatibilityname';

    const DATASOURCE_NAME = 'datasourceofficialname';

    const DATASOURCE_ENGLISH_NAME = 'datasourceenglishname';

    const DATASOURCE_SUBJECT = 'datasourceodsubjects';

    const DATASOURCE_ORGANIZATION = 'relorganizationid';

    const DATASOURCE_ID = 'objIdentifier';

    const DATASOURCE_COMPATIBILITY_NOT_COMPATIBLE = 'notCompatible';

    const DATASOURCE_ACCESS_OPEN = 'OPEN';

    const DATASOURCE_ACCESS_EMBARGO = 'EMBARGO';

    const DATASOURCE_ACCESS_RESTRICTED = 'RESTRICTED';

    const DATASOURCE_ACCESS_CLOSED = 'CLOSED';

    const UNKNOWN = 'UNKNOWN';

    const UNDETERMINED = 'Undetermined';

    const PUBLICATION = 'publication';

    const DATASET = 'dataset';

    const HTTP_OK = 200;

    private $searchService;

    private $publicationStatisticsExistUrl;

    private $publicationStatisticsChartUrl;

    private $datasourceStatisticsExistUrl;

    private $datasourceStatisticsChartUrl;

    private $projectStatisticsChartUrl;

    private $cache;

    private $http;

    // Construct a new OpenAireModelSearch.

    // $configuration the configuration to use

    public function __construct($configuration = array()) {

        parent :: __construct($configuration);

        $parameters = JComponentHelper :: getParams('com_openaire');

        $this->searchService = $parameters->get('searchServiceUrl');

        $this->publicationStatisticsExistUrl = $parameters->get('statisticsDocumentExistUrl');

        $this->publicationStatisticsChartUrl = $parameters->get('statisticsDocumentChartUrl');

        $this->datasourceStatisticsExistUrl = $parameters->get('statisticsRepositoryExistUrl');

        $this->datasourceStatisticsChartUrl = $parameters->get('statisticsRepositoryChartUrl');

        $this->projectStatisticsChartUrl = $parameters->get('statisticsProjectChartUrl');

        $this->cache = JCache :: getInstance();

        $this->http = new JHttp();

    }

    // Retrieve the statistics exist URL for a publication.

    // return the URL to use in order to check whether statistics exist for a publication

    public function getPublicationStatisticsExistUrl() {

        return $this->publicationStatisticsExistUrl;

    }

    // Retrieve the statistics chart URL for a publication.

    // return the URL to use in order to retrieve statistics chart for a publication

    public function getPublicationStatisticsChartUrl() {

        return $this->publicationStatisticsChartUrl;

    }

    // Retrieve the statistics exist URL for a datasource.

    // return the URL to use in order to check whether statistics exist for a datasource

    public function getDatasourceStatisticsExistUrl() {

        return $this->datasourceStatisticsExistUrl;

    }

    // Retrieve the statistics chart URL for a datasource.

    // return the URL to use in order to retrieve statistics chart for a datasource

    public function getDatasourceStatisticsChartUrl() {

        return $this->datasourceStatisticsChartUrl;

    }

    // Retrieve the statistics chart URL for a project.

    // return the URL to use in order to retrieve statistics chart for a project

    public function getProjectStatisticsChartUrl() {

        return $this->projectStatisticsChartUrl;

    }

    // Retrieve publication statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getPublicationStatistics($locale,$allFunders) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: PUBLICATION_STATISTICS_CACHE_ID . '.' . $locale.'.'.$allFunders;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getPublicationStatistics($locale,$allFunders);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getPublicationStatistics($locale,$allFunders);

        return $statistics;

    }

    // Retrieve dataset statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getDatasetStatistics($locale) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: DATASET_STATISTICS_CACHE_ID . '.' . $locale.'.'. $allFunders;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getDatasetStatistics($locale,  $allFunders);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getDatasetStatistics($locale, $allFunders);

        return $statistics;

    }

    // Retrieve project statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getProjectStatistics($locale,  $allFunders) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: PROJECT_STATISTICS_CACHE_ID . '.' . $locale.'.'. $allFunders;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getProjectStatistics($locale,  $allFunders);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getProjectStatistics($locale, $allFunders);

        return $statistics;

    }

    // Retrieve people statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getPeopleStatistics($locale) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: PEOPLE_STATISTICS_CACHE_ID . '.' . $locale;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getPeopleStatistics($locale);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getPeopleStatistics($locale);

        return $statistics;

    }

    // Retrieve organization statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getOrganizationStatistics($locale) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: ORGANIZATION_STATISTICS_CACHE_ID . '.' . $locale;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getOrganizationStatistics($locale);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getOrganizationStatistics($locale);

        return $statistics;

    }

    // Retrieve datasource statistics using cache if enabled.

    // $locale the locale to use

    // return statistics (object)

    public function getDatasourceStatistics($locale) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: DATASOURCE_STATISTICS_CACHE_ID . '.' . $locale;

            $statistics = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($statistics === FALSE) {

                $statistics = $this->_getDatasourceStatistics($locale);

                if ($statistics !== NULL)

                    $this->cache->store($statistics, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $statistics = $this->_getDatasourceStatistics($locale);

        return $statistics;

    }

    // Perform a simple search for publications using cache if enabled.

    // $keyword the keyword to search for

    // $articles flag to limit searching on articles; if all flags are FALSE no limits apply

    // $books flag to limit searching on books; if all flags are FALSE no limits apply

    // $theses flag to limit searching on books; if all flags are FALSE no limits apply

    // $reports flag to limit searching on reports; if all flags are FALSE no limits apply

    // $type the ID of the publication type to use as filter or NULL for no publication type filtering

    // $language the ID of the language to use as filter or NULL for no language filtering

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $year the year of publication to use as filter or NULL for no year filtering

    // $accessMode the ID of the access mode to use as a filter or NULL for no access mode filtering

    // $datasource the ID of the datasource to use as filter or NULL for no datasource filtering

    // $community the ID of the community to use as filter or NULL for no community filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing publications and statistics

    public function searchPublications($keyword, $articles, $books, $theses, $reports, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_PUBLICATIONS_CACHE_ID . '.' . $keyword . '.' . $articles . '.' . $books . '.' . $theses . '.' . $reports . '.' . $type . '.' . $language . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea . '.' . $fundingStreamLevel2 . '.' . $year . '.' . $accessMode . '.' . $datasource . '.' . $community . '.' . $page . '.' . $size . '.' . $locale . '.' . $project.'.'.$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchPublications($keyword, $articles, $books, $theses, $reports, $type, $language, $funder, $fundingStream, $scientificArea,$fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else {

            $result = $this->_searchPublications($keyword, $articles, $books, $theses, $reports, $type, $language, $funder, $fundingStream, $scientificArea,$fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $isRefine);

        }

        return $result;

    }

    // Perform a simple search for datasets using cache if enabled.

    // $keyword the keyword to search for

    // $type the ID of the dataset type to use as filter or NULL for no dataset type filtering

    // $language the ID of the language to use as filter or NULL for no language filtering

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $year the year of publication to use as filter or NULL for no year filtering

    // $accessMode the ID of the access mode to use as a filter or NULL for no access mode filtering

    // $datasource the ID of the datasource to use as filter or NULL for no datasource filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing datasets and statistics

    public function searchDatasets($keyword, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale,$isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_DATASETS_CACHE_ID . '.' . $keyword . '.' . $type . '.' . $language . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea .  '.' . $fundingStreamLevel2 . '.' . $year . '.' . $accessMode . '.' . $datasource . '.' . $page . '.' . $size . '.' . $locale.'.'.$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchDatasets($keyword, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_searchDatasets($keyword, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a simple search for projects using cache if enabled.

    // $keyword the keyword to search for

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $startYear the start year to use as filter or NULL for no start year filtering

    // $endYear the end year to suse as filter or NULL for no end year filtering

    // $sc39 the SC-39 status to use as filter or NULL for no SC-39 status filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing projects and statistics

    public function searchProjects($keyword, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $startYear, $endYear, $sc39, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_PROJECTS_CACHE_ID . '.' . $keyword . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea .  '.' . $fundingStreamLevel2 .'.' . $startYear . '.' . $endYear . '.' . (($sc39 === NULL) ? '' : (($sc39) ? 'true' : 'false')) . '.' . $page . '.' . $size . '.' . $locale . '.' .$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchProjects($keyword, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2 ,$startYear, $endYear, $sc39, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_searchProjects($keyword, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $startYear, $endYear, $sc39, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a simple search for people using cache if enabled.

    // $keyword the keyword to search for

    // $country the ID of the country to use as filter or NULL for no country filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing people and statistics

    public function searchPeople($keyword, $country, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_PEOPLE_CACHE_ID . '.' . $keyword . '.' . $country . '.' . $page . '.' . $size . '.' . $locale . '.' . $isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchPeople($keyword, $country, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_searchPeople($keyword, $country, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a simple search for organizations using cache if enabled.

    // $keyword the keyword to search for

    // $country the ID of the country to use as filter or NULL for no country filtering

    // $type the ID of the organization type to use as filter or NULL for no organization type filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing organizations and statistics

    public function searchOrganizations($keyword, $country, $type, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_ORGANIZATIONS_CACHE_ID . '.' . $keyword . '.' . $country . '.' . $type . '.' . $page . '.' . $size . '.' . $locale . '.' .$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchOrganizations($keyword, $country, $type, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_searchOrganizations($keyword, $country, $type, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a simple search for datasources using cache if enabled.

    // $keyword the keyword to search for

    // $type the ID of the datasource type to use as filter or NULL for no datasource type filtering

    // $language ID of the datasource language to use as filter or NULL for no datasource language filtering

    // $content the ID of the content to use as filter or NULL for no project filtering

    // $compatibility the ID of the compatibility level to use as filter or NULL for no compatibility level filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing datasources and statistics

    public function searchDatasources($keyword, $type, $language, $content, $compatibility, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: SEARCH_DATASOURCES_CACHE_ID . '.' . $keyword . '.' . $type . '.' . $language . '.' . $content . '.' . $compatibility . '.' . $page . '.' . $size . '.' . $locale . '.' .$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_searchDatasources($keyword, $type, $language, $content, $compatibility, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_searchDatasources($keyword, $type, $language, $content, $compatibility, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a browse for publications using cache if enabled.

    // $type the ID of the publication type to use as filter or NULL for no publication type filtering

    // $language the ID of the language to use as filter or NULL for no language filtering

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $year the year of publication to use as filter or NULL for no year filtering

    // $accessMode the ID of the access mode to use as filter or NULL for no access mode filtering

    // $datasource the ID of the datasource to use as filter or NULL for no datasource filtering

    // $community the ID of the community to use as filter or NULL for no datasource filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // $project the ID of the project to use as filter or NULL for no project filtering

    // $author the ID of the author to use as filter or NULL for no author filtering

    // return a result (object) containing publications and statistics

    public function browsePublications($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $author, $isRefine,$refineFields = NULL) {

         if ($this->cache->getCaching()) {

             $cacheId = self :: BROWSE_PUBLICATIONS_CACHE_ID . '.' . $type . '.' . $language . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea . '.' . $fundingStreamLevel2. '.' . $year . '.' . $accessMode . '.' . $datasource . '.' . $community . '.' . $page . '.' . $size . '.' . $locale . '.' . $project . '.' . $author.'.'.$isRefine.'.'.$refineFields;

             $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

             if ($result === FALSE) {

                 $result = $this->_browsePublications($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $author,$isRefine,$refineFields);

                 if ($result !== NULL)

                     $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

          } else

          $result = $this->_browsePublications($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $community, $page, $size, $locale, $project, $author,$isRefine,$refineFields);

        return $result;

    }

    // Perform a browse for datasets using cache if enabled.

    // $type the ID of the dataset type to use as filter or NULL for no dataset type filtering

    // $language the ID of the language to use as filter or NULL for no language filtering

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $year the year of publication to use as filter or NULL for no year filtering

    // $accessMode the ID of the access mode to use as filter or NULL for no access mode filtering

    // $datasource the ID of the datasource to use as filter or NULL for no datasource filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // $project the ID of the project to use as filter or NULL for no project filtering

    // $author the ID of the author to use as filter or NULL for no author filtering

    // return a result (object) containing datasets and statistics

    public function browseDatasets($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale, $project, $author, $isRefine, $refineFields = NULL) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: BROWSE_DATASETS_CACHE_ID . '.' . $type . '.' . $language . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea . '.' . $fundingStreamLevel2 . '.' . $year . '.' . $accessMode . '.' . $datasource . '.' . $page . '.' . $size . '.' . $locale . '.' . $project . '.' . $author.'.'.$isRefine.'.'.$refineFields;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_browseDatasets($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale, $project, $author, $isRefine,$refineFields);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_browseDatasets($type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale, $project, $author, $isRefine,$refineFields);

        return $result;

    }

    // Perform a browse for projects using cache if enabled.

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $startYear the start year to use as filter or NULL for no start year filtering

    // $endYear the end year to use as filter or NULL for no end year filtering

    // $sc39 the SC-39 status to use as filter or NULL for no SC-39 status filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing projects and statistics

    public function browseProjects($funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $startYear, $endYear, $sc39, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: BROWSE_PROJECTS_CACHE_ID . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea . '.' . $fundingStreamLevel2 . '.' . $startYear . '.' . '.' . $endYear . '.' . $sc39 . '.' . $page . '.' . $size . '.' . $locale. '.' . $isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_browseProjects($funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $startYear, $endYear, $sc39, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_browseProjects($funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $startYear, $endYear, $sc39, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a browse for people using cache if enabled.

    // $country the ID of the country to use as filter or NULL for no country filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing people and statistics

    public function browsePeople($country, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: BROWSE_PEOPLE_CACHE_ID . '.' . $country . '.' . $page . '.' . $size . '.' . $locale .'.'. $isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_browsePeople($country, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_browsePeople($country, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a browse for organizations using cache if enabled.

    // $country the ID of the country to use as filter or NULL for no country filtering

    // $type the ID of the organization type to use as filter or NULL for no organization type filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing organizations and statistics

    public function browseOrganizations($country, $type, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: BROWSE_ORGANIZATIONS_CACHE_ID . '.' . $country . '.' . $type . '.' . $page . '.' . $size . '.' . $locale.'.'.$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_browseOrganizations($country, $type, $page, $size, $locale, $isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_browseOrganizations($country, $type, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform a browse for datasources using cache if enabled.

    // $type the ID of the datasource type to use as filter or NULL for no datasource type filtering

    // $language the ID of the datasource language to use as filter or NULL for no datasource language filtering

    // $content the ID of the content to use as filter or NULL for no content filtering

    // $compatibility the ID of the compatibility level to use as filter or NULL for no compatibility status filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing datasources and statistics

    public function browseDatasources($type, $language, $content, $compatibility, $page, $size, $locale, $isRefine) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: BROWSE_DATASOURCES_CACHE_ID . '.' . $type . '.' . $language . '.' . $content . '.' . $compatibility . '.' . $page . '.' . $size . '.' . $locale.'.'.$isRefine;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_browseDatasources($type, $language, $content, $compatibility, $page, $size, $locale,$isRefine);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_browseDatasources($type, $language, $content, $compatibility, $page, $size, $locale, $isRefine);

        return $result;

    }

    // Perform an advanced search for publications using cache if enabled.

    // $keywords the keywords to search for (array)

    // $fields the fields to match keywords with (array - possible values are TITLE, AUTHOR, PUBLISHER and SUBJECT)

    // $constraints the constraints to apply to keywords (array - possible values are ALL and ANY)

    // $types the IDs of the publication types to search for

    // $languages the IDs of the publication languages to search for

    // $funders the IDs of the funders to search for

    // $fundingStreams the IDs of the funding streams to search for

    // $scientificAreas the IDs of the scientific areas to search for

    // $date the publication date range to search for expressed in months before current date (if -1 search for any publication date, if 0 search explicitly using $fromMonth, $fromYear, $toMonth and $toYear)

    // $fromMonth start month of the publication date range to search for if $date has value 0

    // $fromYear start year of the publication date range to search for if $date has value 0

    // $toMonth end month of the publication date range to search for if $date has value 0

    // $toYear end year of the publication date range to search for if $date has value 0

    // $accessModes the IDs of the access modes to search for

    // $datasources the IDs of the datasources to search for

    // $type the ID of the publication type to use as filter or NULL for no publication type filtering

    // $language the ID of the publication language to use as filter or NULL for no publication language filtering

    // $funder the ID of the funder to use as filter or NULL for no funder filtering

    // $fundingStream the ID of the funding stream to use as filter or NULL for no funding stream filtering

    // $scientificArea the ID of the scientific area to use as filter or NULL for no scientific area filtering

    // $year the publication year to use as filter or NULL for no publication year filtering

    // $accessMode the ID of the access mode to use as filter or NULL for no access mode filtering

    // $datasource the ID of the datasource to use as filter or NULL for no datasource filtering

    // $page the page of results to retrieve

    // $size the size of the page of results to retrieve

    // $locale the locale to use

    // return a result (object) containing publications and statistics

    public function advancedSearchPublications($keywords, $fields, $constraints, $types, $languages, $funders, $fundingStreams, $scientificAreas, $fundingStreamsLevel2, $date, $fromMonth, $fromYear, $toMonth, $toYear, $accessModes, $datasources, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale) {

        if ($this->cache->getCaching()) {

            $cacheId = self :: ADVANCED_SEARCH_PUBLICATIONS_CACHE_ID . '.' . implode('.', $keywords) . '.' . implode('.', $fields) . '.' . implode('.', $constraints) . '.' . implode('.', $types) . '.' . implode('.', $languages) . '.' . implode('.', $funders) . '.' . implode('.', $fundingStreams) . '.' . implode('.', $scientificAreas) .'.' . implode('.', $fundingStreamsLevel2) . '.' . $date . '.' . $fromMonth . '.' . $fromYear . '.' . $toMonth . '.' . $toYear . '.' . implode('.', $accessModes) . '.' . implode('.', $datasources) . '.' . $type . '.' . $language . '.' . $funder . '.' . $fundingStream . '.' . $scientificArea . '.'.$fundingStreamLevel2.'.' . $year . '.' . $accessMode . '.' . $datasource . '.' . $page . '.' . $size . '.' . $locale;

            $result = $this->cache->get($cacheId, self :: CACHE_GROUP);

            if ($result === FALSE) {

                $result = $this->_advancedSearchPublications($keywords, $fields, $constraints, $types, $languages, $funders, $fundingStreams, $scientificAreas, $fundingStreamsLevel2, $date, $fromMonth, $fromYear, $toMonth, $toYear, $accessModes, $datasources, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2,  $year, $accessMode, $datasource, $page, $size, $locale);

                if ($result !== NULL)

                    $this->cache->store($result, $cacheId, self :: CACHE_GROUP);

            }

        } else

            $result = $this->_advancedSearchPublications($keywords, $fields, $constraints, $types, $languages, $funders, $fundingStreams, $scientificAreas, $fundingStreamsLevel2, $date, $fromMonth, $fromYear, $toMonth, $toYear, $accessModes, $datasources, $type, $language, $funder, $fundingStream, $scientificArea, $fundingStreamLevel2, $year, $accessMode, $datasource, $page, $size, $locale);

        return $result;

    }

    // Perform an advanced search for projects using cache if enabled.

    // $keywords the keywords to search for (array)

    // $fields the fields to match keywords with (array - possible values are ACRONYM, TITLE and KEYWORDS)

    // $constraints the constraints to apply to keywords (array - possible values are ALL and ANY)

    // $funders the IDs of the funders to search for

    // $fundingStreams the IDs of the funding streams to search for

    // $scientificAreas the IDs of the scientific areas to search for

    // $startDate the start date range to search for expressed in months before current date (if -1 search for any start date, if 0 search explicitly using $startFromMonth, $startFromYear, $startToMonth and $startToYear)

    // $startFromMonth start month of the start date range to search for if $startDate has value 0

    // $startFromYear start year of the start date range to search for if $startDate has value 0

    // $startToMonth end month of the start date range to search for if $startDate has value 0

    // $startToYear end year of the start date range to search for if $startDate has value 0

    // $endDate the end date range to search for expressed in months before current date (if -1 search for any end date, if 0 search explicitly using $endFromMonth, $endFromYear, $endToMonth and $endToYear)

    // $endFromMonth start month of the end date range to search for if $endDate has value 0

    // $endFromYear start year of the end date range to search for if $endDate has value 0

    // $endToMonth end month of the end date range to search for if $endDate has value 0

    // $endToYear end year of the end date range to search for if $endDate has value 0

    // $sc39 the SC-39 statuses to search for

    // $funder the ID of the funder to use as filter or NULL for no funder filtering