QueryBuilder
in package
WorldCat QueryBuilder.
Tags
Table of Contents
- $oclcCodeToExclude : string
- OCLC code to exclude from results
- __construct() : mixed
- Constructor
- build() : ParamBag
- Return WorldCat search parameters based on a user query and params.
- abstractQueryToString() : string
- Convert an AbstractQuery object to a query string.
- queryGroupToString() : string
- Convert a QueryGroup object to a query string.
- queryToString() : string
- Convert a single Query object to a query string.
Properties
$oclcCodeToExclude
OCLC code to exclude from results
protected
string
$oclcCodeToExclude
Methods
__construct()
Constructor
public
__construct([string $exclude = null ]) : mixed
Parameters
- $exclude : string = null
-
OCLC code to exclude from results
Return values
mixed —build()
Return WorldCat search parameters based on a user query and params.
public
build(AbstractQuery $query[, ParamBag|null $params = null ]) : ParamBag
Parameters
- $query : AbstractQuery
-
User query
- $params : ParamBag|null = null
-
Search backend parameters
Tags
Return values
ParamBag —abstractQueryToString()
Convert an AbstractQuery object to a query string.
protected
abstractQueryToString(AbstractQuery $query) : string
Parameters
- $query : AbstractQuery
-
Query to convert
Return values
string —queryGroupToString()
Convert a QueryGroup object to a query string.
protected
queryGroupToString(QueryGroup $query) : string
Parameters
- $query : QueryGroup
-
QueryGroup to convert
Return values
string —queryToString()
Convert a single Query object to a query string.
protected
queryToString(Query $query) : string
Parameters
- $query : Query
-
Query to convert