Overview

Packages

  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Datatype
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • Solr
  • SolrIndexer
  • SolrSearcherAbstract
  • SolrSearcherSimple
  • SolrSearchModule

Exceptions

  • SolrException
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class Solr

Helper class for this plugin.

Package: Plugin\SearchSolr
Copyright: four for business AG
Author: marcus.gnass
Located at plugins/search_solr/includes/config.plugin.php
Methods summary
public static
# log( mixed $whatever, mixed $file = NULL, mixed $line = NULL )

Parameters

$whatever
mixed
$whatever
$file
$line
public static
# getName( )
public static string
# getPath( )

Return path to this plugins folder.

Return path to this plugins folder.

Returns

string
public static string
# i18n( string $key )

Parameters

$key
string
$key

Returns

string
public static array
# getClientOptions( )

Returns array of options used to create a SolClient object.

Returns array of options used to create a SolClient object.

The option values are read from system or client settings. Required settings are solr/hostname, solr/port, solr/path, solr/login, solr/password.

Returns

array
public static
# validateClientOptions( array $options )

Check if required options exist.

Check if required options exist.

Parameters

$options
array
$options

Throws

SolrWarning
when required options don't exist
public static
# logException( Exception $e )

Parameters

$e
Exception
$e
public static
# displayException( Exception $e, boolean $showTrace = false )

TODO build method to display erro & info box and just call it from here

TODO build method to display erro & info box and just call it from here

Parameters

$e
Exception
$e
$showTrace
boolean
$showTrace if trace should be displayed too
public static string
# notifyException( Exception $e )

Creates a notification widget in order to display an exception message in backend.

Creates a notification widget in order to display an exception message in backend.

Parameters

$e
Exception
$e

Returns

string
Properties summary
private static string $_name 'search_solr'
#

name of this plugin

name of this plugin

CMS CONTENIDO 4.9.1 API documentation generated by ApiGen 2.8.0