Klassendiagramm für Ego_Search_Elastic:

Zusammengehörigkeiten von Ego_Search_Elastic:

Öffentliche Methoden
	optimize ()

	__construct ($table='', $param=[], bool $checkHealthy=false)

	delete ($id)

	reset ()

	resetAll ()

	indexCreate ()

	indexExists ()

	indexDelete ($all)

	updateBulk ($pages, $recursive=true)

	update ($index, $page, $count=[], $recursive=true)

	search ($search, $relation, $query, $filter='', $fuzzy=false)

	globalSearch ($search, $sites=[], $query=[], $param=[], $sort=[], $filter='')

	getSuggestions ($query, $sites=[], $max=5)

	getCorrections ($query, $sites=[], $max=3)

	setExtraQuery ($query, $bind=[])

	getConfig ()

	clearCache ()

Öffentliche Methoden geerbt von Ego_Search
	update ($index, $page)

	search ($search, $relation, $query)

	filterContent ($content, $k='extra')

	filterExtra ($page)

Geschützte Methoden
	indexFile (Page $page, $path)

Geschützte Methoden geerbt von Ego_Search
	sortPages ($pages, $order='', $sort=array())

	_getContent ($page, $k)

	_getExtra ($page, $clean=false)

	prepareSearch ($search, $filter='', $original=false, $fuzzy=false)

	checkSearch ($search)

Geschützte Attribute
	$client = null

	$maxClauseCount = 10000

Geschützte Attribute geerbt von Ego_Search
	$config = []

	$extraQuery = ''

Ausführliche Beschreibung

Verwaltet den Suchindex mit Elastic und führt eine Suche darin durch.

Autor: ps

Id: Ego_Search_Elastic.php 64587 2013-11-26 11:03:01Z dg

Definiert in Zeile 16 der Datei Ego_Search_Elastic.php.

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

__construct	(		$table = `''`,
			$param = `[]`,
		bool	$checkHealthy = `false`
	)

Ego_Search_Elastic constructor.

Parameter

string	$table
array	$param

Ausnahmebehandlung

Exception

Definiert in Zeile 58 der Datei Ego_Search_Elastic.php.

Benutzt Ego_System\checkLicence() und indexCreate().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

◆ clearCache()

clearCache ( )

Cache leeren

Rückgabe: void

Erneute Implementation von Ego_Search.

Definiert in Zeile 1519 der Datei Ego_Search_Elastic.php.

◆ delete()

delete ( $id )

Einen Eintrag löschen

Parameter

integer $id

Rückgabe: boolean

Erneute Implementation von Ego_Search.

Definiert in Zeile 129 der Datei Ego_Search_Elastic.php.

◆ getConfig()

getConfig ( )

Konfiguration ermitteln

Rückgabe: array

Definiert in Zeile 1510 der Datei Ego_Search_Elastic.php.

◆ getCorrections()

getCorrections	(	$query,
		$sites = `[]`,
		$max = `3`
	)

Korrekturen für ein Suchmuster ermitteln

Parameter

string	$query	Suchmuster
array	$sites	Liste von Site Objekten oder Mandantennamen (Standard: aktueller Mandant)
integer	$max	Maximale Anzahl an Vorschläge

Rückgabe: array

Erneute Implementation von Ego_Search.

Definiert in Zeile 1330 der Datei Ego_Search_Elastic.php.

◆ getSuggestions()

getSuggestions	(	$query,
		$sites = `[]`,
		$max = `5`
	)

Vorschläge für ein Suchmuster ermitteln

Parameter

string	$query	Suchmuster
array	$sites	Liste von Site Objekten oder Mandantennamen (Standard: aktueller Mandant)
integer	$max	Maximale Anzahl an Vorschläge

Rückgabe: array

Erneute Implementation von Ego_Search.

Definiert in Zeile 1264 der Datei Ego_Search_Elastic.php.

Benutzt Page\hasRights().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ globalSearch()

globalSearch	(	$search,
		$sites = `[]`,
		$query = `[]`,
		$param = `[]`,
		$sort = `[]`,
		$filter = `''`
	)

Mandantenübergreifende Suche

Parameter

string	$search	Suchbegriff
array	$sites	Liste von Site Objekten oder Mandantennamen (Standard: alle Mandanten)
array	$query	Ein Query Array für die Datenbank
array	$param	Site Parameter
array	$sort	Direkte Sortierung ansonsten über Query Order, falls angegeben
string	$filter	Elastic Filter

Rückgabe: array

Erneute Implementation von Ego_Search.

Definiert in Zeile 1172 der Datei Ego_Search_Elastic.php.

Benutzt Ego_System\getAllSites().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ indexCreate()

indexCreate ( )

einen Index je Installation anlegen

Rückgabe: boolean

Ausnahmebehandlung

Exception

Felder, nach denen sortiert werden kann, müssen als "*.keyword" existieren

Rückgabe: array

Erneute Implementation in Ego_User_Elastic.

Definiert in Zeile 180 der Datei Ego_Search_Elastic.php.

Benutzt $maxClauseCount.

Wird benutzt von __construct() und reset().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ indexDelete()

indexDelete ( $all )

einen Index löschen

Parameter

$all	'komplett löschen'

Rückgabe: boolean

Definiert in Zeile 371 der Datei Ego_Search_Elastic.php.

Wird benutzt von reset() und resetAll().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ indexExists()

indexExists ( )

Prüft, ob ein Suchindex existiert

Rückgabe: bool

Definiert in Zeile 358 der Datei Ego_Search_Elastic.php.

◆ indexFile()

indexFile	(	Page	$page,
			$path
	)

protected

lädt ein dokument hoch lässt es indizieren und löscht es im anshcluss wieder

Parameter

Page	$page
	$path

Rückgabe: string "content || null"

Definiert in Zeile 1004 der Datei Ego_Search_Elastic.php.

Benutzt Ego_System\file_exists(), Ego_System\file_get_contents(), Page\getIdentity(), Page\getSite() und Ego_System\stringEncode().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ optimize()

optimize ( )

Definiert in Zeile 46 der Datei Ego_Search_Elastic.php.

◆ reset()

reset ( )

Den kompletten Index löschen (für Mandant und Sprache)

Rückgabe: boolean

Erneute Implementation von Ego_Search.

Definiert in Zeile 146 der Datei Ego_Search_Elastic.php.

Benutzt indexCreate() und indexDelete().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ resetAll()

resetAll ( )

Den kompletten Index (eines Auftritts) löschen

Rückgabe: boolean

Definiert in Zeile 166 der Datei Ego_Search_Elastic.php.

Benutzt indexDelete().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ search()

search	(	$search,
		$relation,
		$query,
		$filter = `''`,
		$fuzzy = `false`
	)

Eine Suche durchführen

Parameter

string	$search	Suchbegriff
string	$relation	Tabellenbezeichnung
array	$query	Ein Query Array für die Datenbank
string	$filter	Elastic Filter
boolean	$fuzzy	Ähnlichkeitssuche aktivieren

Rückgabe: array

Definiert in Zeile 1107 der Datei Ego_Search_Elastic.php.

◆ setExtraQuery()

setExtraQuery	(	$query,
		$bind = `[]`
	)

Die Fulltext Query mit der Extra Suche erweitern

Parameter

string	$query
array	$bind

Rückgabe: void

Erneute Implementation von Ego_Search.

Definiert in Zeile 1422 der Datei Ego_Search_Elastic.php.

◆ update()

update	(	$index,
		$page,
		$count = `[]`,
		$recursive = `true`
	)

Einen Eintrag einfügen

Parameter

integer	$index
Page	$page
array	$count
boolean	$recursive

Rückgabe: boolean

Definiert in Zeile 427 der Datei Ego_Search_Elastic.php.

◆ updateBulk()

updateBulk	(	$pages,
		$recursive = `true`
	)

Definiert in Zeile 384 der Datei Ego_Search_Elastic.php.

Dokumentation der Felder

◆ $client

$client = null

protected

Definiert in Zeile 23 der Datei Ego_Search_Elastic.php.

◆ $maxClauseCount

$maxClauseCount = 10000

protected

Definiert in Zeile 37 der Datei Ego_Search_Elastic.php.

Wird benutzt von indexCreate() und Ego_User_Elastic\indexCreate().

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/media/ssd/workspace/egocms/develop/lib/base/Ego_Search_Elastic.php

Öffentliche Methoden

Geschützte Methoden

Geschützte Attribute

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

Dokumentation der Elementfunktionen

◆ clearCache()

◆ delete()

◆ getConfig()

◆ getCorrections()

◆ getSuggestions()

◆ globalSearch()

◆ indexCreate()

◆ indexDelete()

◆ indexExists()

◆ indexFile()

◆ optimize()

◆ reset()

◆ resetAll()

◆ search()

◆ setExtraQuery()

◆ update()

◆ updateBulk()

Dokumentation der Felder

◆ $client

◆ $maxClauseCount