SruResponse
in package
Description of SruResponse
Tags
Table of Contents
Constants
- COUNT_PREC_CURRENT = 'current'
- COUNT_PREC_ESTIMATE = 'estimate'
- COUNT_PREC_EXACT = 'exact'
- COUNT_PREC_MAXIMUM = 'maximum'
- COUNT_PREC_MINIMUM = 'minimum'
- COUNT_PREC_UNKNOWN = 'unknown'
- DIAGNOSTICS_NMSP_1 = 'http://www.loc.gov/zing/srw/diagnostic/'
- DIAGNOSTICS_NMSP_2 = 'http://docs.oasis-open.org/ns/search-ws/diagnostic'
- RECORD_SCHEMA = 'http://explain.z3950.org/dtd/2.1/'
- SRU_MAX_VERSION = '2.0'
- SRU_NMSP_1 = 'http://www.loc.gov/zing/srw/'
- SRU_NMSP_2 = 'http://docs.oasis-open.org/ns/search-ws/sruResponse'
- SRU_NMSP_SCAN_2 = 'http://docs.oasis-open.org/ns/search-ws/scan'
- ZEEREX_NMSP = 'http://explain.z3950.org/dtd/2.1/'
Properties
- $doc : mixed
- $nmsp : mixed
- $numberOfRecords : mixed
- $recordRoot : mixed
- $resultCountPrecision : mixed
- $root : mixed
- $version : mixed
Methods
- __construct() : mixed
- __toString() : string
- addDiagnostics() : void
- addExtraResponseData() : void
- addNextRecordPosition() : void
- addRecord() : void
- createElementNs() : DOMElement
- setNumberOfRecords() : void
Constants
COUNT_PREC_CURRENT
public
mixed
COUNT_PREC_CURRENT
= 'current'
COUNT_PREC_ESTIMATE
public
mixed
COUNT_PREC_ESTIMATE
= 'estimate'
COUNT_PREC_EXACT
public
mixed
COUNT_PREC_EXACT
= 'exact'
COUNT_PREC_MAXIMUM
public
mixed
COUNT_PREC_MAXIMUM
= 'maximum'
COUNT_PREC_MINIMUM
public
mixed
COUNT_PREC_MINIMUM
= 'minimum'
COUNT_PREC_UNKNOWN
public
mixed
COUNT_PREC_UNKNOWN
= 'unknown'
DIAGNOSTICS_NMSP_1
public
mixed
DIAGNOSTICS_NMSP_1
= 'http://www.loc.gov/zing/srw/diagnostic/'
DIAGNOSTICS_NMSP_2
public
mixed
DIAGNOSTICS_NMSP_2
= 'http://docs.oasis-open.org/ns/search-ws/diagnostic'
RECORD_SCHEMA
public
mixed
RECORD_SCHEMA
= 'http://explain.z3950.org/dtd/2.1/'
SRU_MAX_VERSION
public
mixed
SRU_MAX_VERSION
= '2.0'
SRU_NMSP_1
public
mixed
SRU_NMSP_1
= 'http://www.loc.gov/zing/srw/'
SRU_NMSP_2
public
mixed
SRU_NMSP_2
= 'http://docs.oasis-open.org/ns/search-ws/sruResponse'
SRU_NMSP_SCAN_2
public
mixed
SRU_NMSP_SCAN_2
= 'http://docs.oasis-open.org/ns/search-ws/scan'
ZEEREX_NMSP
public
mixed
ZEEREX_NMSP
= 'http://explain.z3950.org/dtd/2.1/'
Properties
$doc
private
mixed
$doc
$nmsp
private
mixed
$nmsp
$numberOfRecords
private
mixed
$numberOfRecords
$recordRoot
private
mixed
$recordRoot
$resultCountPrecision
private
mixed
$resultCountPrecision
= self::COUNT_PREC_UNKNOWN
$root
private
mixed
$root
$version
private
mixed
$version
Methods
__construct()
public
__construct(string $responseType, string $version) : mixed
Parameters
- $responseType : string
- $version : string
__toString()
public
__toString() : string
Return values
stringaddDiagnostics()
public
addDiagnostics(SruException $e) : void
Parameters
- $e : SruException
addExtraResponseData()
public
addExtraResponseData(DOMNode $extra) : void
Parameters
- $extra : DOMNode
addNextRecordPosition()
public
addNextRecordPosition(int $position) : void
Parameters
- $position : int
addRecord()
public
addRecord(DOMNode|null $content, string $schema[, string|null $id = null ][, int|null $position = null ]) : void
Parameters
- $content : DOMNode|null
- $schema : string
- $id : string|null = null
- $position : int|null = null
createElementNs()
public
createElementNs(string $ns, string $el[, string|null $value = null ]) : DOMElement
Parameters
- $ns : string
- $el : string
- $value : string|null = null
Return values
DOMElementsetNumberOfRecords()
public
setNumberOfRecords(int $n[, string $countPrecision = self::COUNT_PREC_UNKNOWN ]) : void
Parameters
- $n : int
- $countPrecision : string = self::COUNT_PREC_UNKNOWN