Ego_User_Elastic Klassenreferenz

Klassendiagramm für Ego_User_Elastic:

Zusammengehörigkeiten von Ego_User_Elastic:

Öffentliche Methoden
	indexCreate ()
	updateUserIndex (string $id, User_SQL $user)
	updateUserBulk (User_Iterator $users, bool $verbose=false, $new_line="\n")
	searchUsers (array $search, int $limit=-1, string $type='', bool $checkRights=true, bool $filterSearch=true, bool $sortResult=true, int $from=0, bool $returnTotal=false, array $sort_order=[], string $rights='')
	getChars ($type='')
Öffentliche Methoden geerbt von Ego_Search_Elastic
	optimize ()
	__construct ($table='', $param=[], bool $checkHealthy=false)
	delete ($id)
	reset ()
	resetAll ()
	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)

Weitere Geerbte Elemente
Geschützte Methoden geerbt von Ego_Search_Elastic
	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 geerbt von Ego_Search_Elastic
	$client = null
	$maxClauseCount = 10000
Geschützte Attribute geerbt von Ego_Search
	$config = []
	$extraQuery = ''

Ausführliche Beschreibung

Definiert in Zeile 7 der Datei Ego_User_Elastic.php.

Dokumentation der Elementfunktionen

getChars()

getChars

(

$type = ''

)

Gibt die existierenden Anfangsbuchstaben für den angegebenen Typ an. Wenn für einen Buchstaben keine Benutzer existieren wird dieser nicht zurückgeliefert. Wenn für den Angegebenen Typ keine Benutzer existieren ein leeres Array.

Parameter

string

$type

Einer der folgenen Typen: admin, intranet, norelation, inactive

Rückgabe

array

Definiert in Zeile 378 der Datei Ego_User_Elastic.php.

indexCreate()

indexCreate

(

)

Erstellt den Index für die Elasticsearch-Suche, wenn dieser noch nicht existiert

Rückgabe

bool

Ausnahmebehandlung

Exception

Erneute Implementation von Ego_Search_Elastic.

Definiert in Zeile 14 der Datei Ego_User_Elastic.php.

Benutzt Ego_Search_Elastic\$maxClauseCount.

searchUsers()

searchUsers	(	array	$search,
		int	$limit = -1,
		string	$type = '',
		bool	$checkRights = true,
		bool	$filterSearch = true,
		bool	$sortResult = true,
		int	$from = 0,
		bool	$returnTotal = false,
		array	$sort_order = [],
		string	$rights = ''
	)

Suche durchführen

Parameter

array	$search	Suchparameter
int	$limit	Maximalanzahl an Suchergebnissen. (-1 => kein Limit)
string	$type	Einer der folgenden Typen: admin, intranet, norelation, inactive, trash
bool	$checkRights	Rechte nach der Suche überprüfen
bool	$filterSearch	Sollen die Suchparameter gefiltert werden?
bool	$sortResult	Soll das Ergebnis sortiert werden?
int	$from	Offset der Suche
bool	$returnTotal	Zusätzlich zu den Benutzern die Trefferzahl übergeben
array	$sort_order	Gibt an, nach welchen Feldern sortiert wird

Rückgabe

array Array aus Benutzern

Definiert in Zeile 252 der Datei Ego_User_Elastic.php.

updateUserBulk()

updateUserBulk	(	User_Iterator	$users,
		bool	$verbose = false,
			$new_line = "\n"
	)

Für mehrere Benutzer gleichzeitig den Suchindex updaten

Parameter

User_Iterator	$users
bool	$verbose	Ausgabe erzeugen
string	$new_line	Zeichen für eine neue Zeile

Rückgabe

void

Definiert in Zeile 175 der Datei Ego_User_Elastic.php.

Benutzt Ego_System\flush().

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

updateUserIndex()

updateUserIndex	(	string	$id,
		User_SQL	$user
	)

Suchindex updaten

Parameter

string	$id	Id im Index (User_Id)
User_SQL	$user	Benutzer der in den Index gespeichert wird

Rückgabe

bool

Definiert in Zeile 145 der Datei Ego_User_Elastic.php.

---

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

• /media/ssd/workspace/egocms/develop/lib/base/Ego_User_Elastic.php