Gibt definierte Sortier-Kriterien für Hauptbeiträge von Foren aus.

Hintergrund :
fo_GetMainPostings_Pu liefert Hauptbeiträge eines Forums zurück. Dabei kann man angeben, nach welcher Sortierung die Ergebnismenge gebildet werden soll.

Die Konfiguration eines Sortier-Kriteriums kann mit fo_ModifyMainPostSortCrit_Ad vorgenommen werden.

Grundsätzliches zu Sortier-Kriterien :

1. Ist für ein Forum mindestens ein Sortier-Kriterium definiert und aktiv, wird bei jeglicher Änderung im Forum, die Hauptbeiträge betreffen (u.U. auch Antworten, je nach Konfigurierung der Optionen des Kriteriums), die Sortierung aktualisiert.
2. Ein Sortier-Kriterium kann aus maximal 3 Einzel-Kriterien bestehen. Zwei Hauptbeiträge werden anhand des ersten Kriteriums verglichen, und nur falls der Vergleich „unentschieden“ ausfällt, wird das evtl. vorhandene zweite Kriterium herangezogen. Nur wenn auch der zweite Vergleich nicht eindeutig ist, wird (sofern konfiguriert) das dritte Kriterium beachtet.
3. Wenn der Vergleich zweier Hauptbeiträge nicht eindeutig (trotz Anwendung aller Einzel-Kriterien) ist, wird willkürlich einer der beiden Beiträge „höher priorisiert“ - es gibt keine eindeutige Regel hierfür, die Entscheidung ist mehr oder weniger „zufällig“.
4. Zur Zeit gibt es zwei Arten von Einzel-Kriterien : Entweder die Eigenschaft zu einem Merkmal oder das Anlagedatum („PostDate“). Einzelheiten zum Vergleich (z.B. auf- oder absteigende Sortierung) sind durch die jeweiligen Options-Spalten („SortingOptions_…“) geregelt. Es handelt sich jeweils um die „Summe“ von folgenden einzelnen Optionen :

• „1“ : AUFsteigende Sortierung nach der Eigenschaft bzw. dem „PostDate“
• „2“ : ABsteigende Sortierung nach der Eigenschaft bzw. dem „PostDate“
• „4“ : „NULL“-Werte haben NIEDRIGSTE Priorität
• „8“ : „NULL“-Werte haben HÖCHSTE Priorität

(Die Optionen „1“ und „2“ sowie „4“ und „8“ schließen sich natürlich aus, es muß aber ENTWEDER „1“ ODER „2“ bzw. „4“ ODER „8“ als Option gewählt sein !)

• „16“ : Es sollen bei der Ermittlung des für die Sortierung relevanten Wertes alle Beiträge des gesamten „Threads“ berücksichtigt werden

(Die folgenden Optionen regeln, ob bei der Ermittlung des für die Sortierung relevanten Wertes nur Beiträge beachtet werden sollen, die in einem bestimmten „Visible“-Status sind. Ist keine dieser Optionen angegeben, bedeutet dies, daß keine Filterung hinsichtlich des „Visible“-Status stattfindet !)

• „32“ : Ist der „Visible“-Status gleich „4“, wird der Beitrag beachtet
• „64“ : Ist der „Visible“-Status gleich „8“, wird der Beitrag beachtet
• „128“ : Ist der „Visible“-Status gleich „0“, wird der Beitrag beachtet
• „256“ : Ist der „Visible“-Status gleich „1“, wird der Beitrag beachtet

5. Es werden garantiert alle Hauptbeiträge des Forums bei einer Sortierung berücksichtigt. D.h. auch wenn z.B. durch die Optionen „32“ bis „256“ ein Hauptbeitrag quasi durch seinen „Visible“-Status herausfällt, bedeutet dies ja lediglich, daß der Wert zum Kriterium „NULL“ ist, und dies wird durch Option „4“ oder „8“ geregelt !

(parameterunabängige Sortierung)

• SortingCriteriaNo (aufsteigend)

Die Prozedur hat keine Output-Parameter.

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

• fo_GetMainPostSortCriteria_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetMainPostSortCriteria_Ad?ForumID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetMainPostSortCriteria_Ad?ForumID=<value>' | xmllint --format -

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'fo_GetMainPostSortCriteria_Ad',
		array(
			'ForumID' => <value>,
			// 'SortingCriteriaNo' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="fo_GetMainPostSortCriteria_Ad">
			<Parameters>
				<Parameter Name="ForumID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="SortingCriteriaNo">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>