Source of file SearchInterface.php

<?php

/**

 * Copyright 2016 University of Liverpool

 *

 * Licensed under the Apache License, Version 2.0 (the "License");

 * you may not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

namespace pgb_liv\php_ms\Search;

use pgb_liv\php_ms\Search\Parameters\SearchParametersInterface;

/**

 * Generic interface to search engine controls

 *

 * @author Andrew Collins

 */

interface SearchInterface

{

    /**

     * Perform a search on this objects connected search engine

     *

     * @param SearchParametersInterface $parameters

     *            The parameters to search with

     * @return string An identifier that can be passed to getResults for retrieving the search results data

     */

    public function search(SearchParametersInterface $parameters);

    /**

     * Retrieve the results from a previously run search

     *

     * @param string $searchIdentifier

     *            The search identifier return by Search()

     * @param array $additionalParamaters

     *            (Optional) Additional parameters to be passed when retreiving the results

     * @return string The results data

     */

    public function getResults($searchIdentifier, $additionalParamaters = null);

}