PerlDoc

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

Perl Module:

---

Parent package: Foswiki::Plugins::SolrPlugin
Child packages:

More ...Less ...

internal package Foswiki::Plugins::SolrPlugin::Base

Base class for indexer and searcher holding shared stuff

ClassMethod new() → $core

constructor base

ObjectMethod finish()

called at the end of the session

ObjectMethod getSizeOfTopic($web, $topic) → $bytes

returns the size of a topic if WebStatisticsPlugin is installed, zero otherwise

ObjectMethod ua() → $ua

returns a LWP::UserAgent delegate used to contact the solr backend

ObjectMethod connect()

establish a connection to the solr backend

ObjectMethod log($logSting, $noNewLine)

log data to STDERR

ObjectMethod isDateField($name) → $boolean

returns true if the named field is a date field

ObjectMethod isImage($name) → $boolean

returns true if the named file is an image file

ObjectMethod isSkippedWeb($web) → $boolean

returns true if the named web is to be excluded from indexing

ObjectMethod isSkippedTopic($web, $topic) → $boolean

returns true if the given web.topic is excluded from indexing

ObjectMethod isSkippedAttachment($web, $topic, $attachment) → $boolean

returns true if the given attachment is excluded from indexing

ObjectMethod skipWebs() → $hash

hash of webs that shall not be indexed

ObjectMethod skipAttachments() → $hash

hash of attachments to be skipped

ObjectMethod skipTopics() → $hash

hash of topics to be skipped.

ObjectMethod inlineError(text) → $html

returns an htmlized error message

ObjectMethod entityDecode($in) > $out

entity encoded string

ObjectMethod urlDecode($in) → $out

url encoded string

ObjectMethod normalizeWebTopicName($web, $topic) → ($web, $topic)

wrapper to Foswiki::Func::normalizeWebTopicName() adding normalized web names by translating slashes with dots

ObjectMethod takeOutBlocks()

compatibility wrapper for Foswiki::takeOutBlocks()

ObjectMethod putBackBlocks()

compatibility wrapper for Foswiki::putBackBlocks()

ObjectMethod mapToIconFileName($typeOrFileName) → $icon

returns an icon representation for the given type or filename

ObjectMethod getTopicSummary($web, $topic, $meta, $text) → $string

this returns the content of one of the following fields in the given precedense:

1. Summary formfield
2. Teaser formfield
3. SUMMARY preference

the returned string will be plainified removing special chars

solrRequest($path, $params)

low-level solr request

ObjectMethod translate($string, $web, $topic) → $string

translate string to user's current language

ObjectMethod getSolrFieldNameOfFormfield($fieldDef, $default) → $fieldName

translate a foswiki formfield name to a solr field name