Documentation

Endpoint
in package

Description of Endpoint

Tags
author

zozlak

Table of Contents

Constants

CPBLT_BASIC_SEARCH  = 'http://clarin.eu/fcs/capability/basic-search'
DB_TMP_TBL_NAME  = 'matches'
FTS_HIT_DELIMITER  = '@~$`'
FTS_HIT_TAG_END  = '</@>'
FTS_HIT_TAG_START  = '<@>'
ID_DATA_VIEW_CMDI  = 'cmdi'
ID_DATA_VIEW_HITS  = 'hits'
MIME_CMDI  = 'application/x-cmdi+xml'
MIME_FCS_HITS  = 'application/x-clarin-fcs-hits+xml'
NMSP_FCS_ENDPOINT_DESC  = 'http://clarin.eu/fcs/endpoint-description'
NMSP_FCS_HITS  = 'http://clarin.eu/fcs/dataview/hits'
NMSP_FCS_RESOURCE  = 'http://clarin.eu/fcs/resource'
POLICY_DATA_VIEW_DEFAULT  = 'send-by-default'
POLICY_DATA_VIEW_REQUEST  = 'need-to-request'

Properties

$cfg  : object
$cmdiCache  : array<string|int, DOMNode>

Methods

__construct()  : mixed
handleRequest()  : void
appendSearchHitXml()  : void
explainDescribeResources()  : void
findMatchingRepoResources()  : void
Creates the temporary table containing repository resources matching the searchRetrieve query.
getDbHandle()  : PDO
getHighlightingOpts()  : string
getTsquery()  : string
handleExplain()  : SruResponse
handleScan()  : SruResponse
handleSearch()  : SruResponse
sanitizeParam()  : void

Constants

CPBLT_BASIC_SEARCH

public mixed CPBLT_BASIC_SEARCH = 'http://clarin.eu/fcs/capability/basic-search'

DB_TMP_TBL_NAME

public mixed DB_TMP_TBL_NAME = 'matches'

FTS_HIT_DELIMITER

public mixed FTS_HIT_DELIMITER = '@~$`'

FTS_HIT_TAG_END

public mixed FTS_HIT_TAG_END = '</@>'

FTS_HIT_TAG_START

public mixed FTS_HIT_TAG_START = '<@>'

ID_DATA_VIEW_CMDI

public mixed ID_DATA_VIEW_CMDI = 'cmdi'

ID_DATA_VIEW_HITS

public mixed ID_DATA_VIEW_HITS = 'hits'

MIME_CMDI

public mixed MIME_CMDI = 'application/x-cmdi+xml'

MIME_FCS_HITS

public mixed MIME_FCS_HITS = 'application/x-clarin-fcs-hits+xml'

NMSP_FCS_ENDPOINT_DESC

public mixed NMSP_FCS_ENDPOINT_DESC = 'http://clarin.eu/fcs/endpoint-description'

NMSP_FCS_HITS

public mixed NMSP_FCS_HITS = 'http://clarin.eu/fcs/dataview/hits'

NMSP_FCS_RESOURCE

public mixed NMSP_FCS_RESOURCE = 'http://clarin.eu/fcs/resource'

POLICY_DATA_VIEW_DEFAULT

public mixed POLICY_DATA_VIEW_DEFAULT = 'send-by-default'

POLICY_DATA_VIEW_REQUEST

public mixed POLICY_DATA_VIEW_REQUEST = 'need-to-request'

Properties

$cmdiCache

private array<string|int, DOMNode> $cmdiCache = []

Methods

__construct()

public __construct(object $cfg) : mixed
Parameters
$cfg : object

handleRequest()

public handleRequest() : void

appendSearchHitXml()

private appendSearchHitXml(string $hit, SruResponse $resp, object $repoResource[, array<string|int, mixed> $dataViews = [] ]) : void
Parameters
$hit : string
$resp : SruResponse
$repoResource : object
$dataViews : array<string|int, mixed> = []

explainDescribeResources()

private explainDescribeResources(DOMNode $container, SruResponse $resp) : void
Parameters
$container : DOMNode
$resp : SruResponse

findMatchingRepoResources()

Creates the temporary table containing repository resources matching the searchRetrieve query.

private findMatchingRepoResources(PDO $pdo, SruParameters $param, string $tsquery) : void
Parameters
$pdo : PDO
$param : SruParameters
$tsquery : string

getDbHandle()

private getDbHandle() : PDO
Return values
PDO

getHighlightingOpts()

private getHighlightingOpts() : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results