internal package Foswiki::Store::Interfaces::SearchAlgorithm

See Published API for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

    internal package Foswiki::Store::Interfaces::SearchAlgorithm is a Foswiki::Store::Interfaces::QueryAlgorithm

    DEPRECATED - all Search Algorithm and Query Algorithm use the same calling convention.

    Interface to search algorithms. Implementations of this interface are found in Foswiki/Store/SearchAlgorithms.

    StaticMethod query( $query, $webs, $inputTopicSet, $session, $options ) → $infoCache

    • $query - A Foswiki::Search::Node object. The tokens() method of this object returns the list of search tokens.
    • $web - name of the web being searched, or may be an array reference to a set of webs to search
    • $inputTopicSet - iterator over names of topics in that web to search
    • $session - reference to the store object
    • $options - hash of requested options
    This is the top-level interface to a search algorithm.

    Return a Foswiki::Search::ResultSet.

    This topic: System > Category > DeveloperDocumentationCategory > PerlDoc
    Topic revision: 21 Nov 2014, ProjectContributor
     
    This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
    Ideas, requests, problems regarding Foswiki? Send feedback