API Documentation
\
unikent
LibrarySearch

\unikent\LibrarySearchURL

Represents a Library Search URL.

Examples

Simple URL Example.

<?php
/**
 * LibrarySearch API.
 *
 * @package    LibrarySearch
 * @copyright  2014 Skylar Kelty <S.Kelty@kent.ac.uk>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once("vendor/autoload.php");

$url = new \unikent\LibrarySearch\URL();
$url->set_search_term("Example");
echo $url->get_search_url();

Summary

Methods
Properties
Constants
__construct()
set_search_term()
get_base_url()
add_raw_scope()
add_scope()
get_url_params()
get_search_url()
__toString()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(string  $campus = 'canterbury')

Constructor.

Parameters

string $campus

The name of the campus (canterbury/medway).

set_search_term()

set_search_term(string  $searchterm)

Set the search term.

Parameters

string $searchterm

Search term

get_base_url()

get_base_url()

Returns the base URL.

add_raw_scope()

add_raw_scope(string  $scope)

Add a raw scope.

Parameters

string $scope

A valid library search scope.

add_scope()

add_scope(string  $scope)

Add a standard scope.

Parameters

string $scope

A valid library search scope.

get_url_params()

get_url_params()

Returns the URL params.

get_search_url()

get_search_url()

Returns a URL to library search.

__toString()

__toString()

To String!