Prozedur zum Anlegen, Ändern und Löschen von Forum-Kategorien.

Anmerkungen zum Parameter „MoveSortNo“ :
1. Ein positiver Wert bedeutet, daß die interne „SortNo“ (die die Reihenfolge bestimmt) um den Wert „MoveSortNo“ ERHÖHT wird, d.h. die Kategorie („ForumCategoryID“) „rückt nach unten“. Ein negativer Wert ERNIEDRIGT die „SortNo“ entsprechend, d.h. die Kategorie „steigt nach oben“.
2. „MoveSortNo“ wird ignoriert, wenn „ForumCategoryID“ eine „Hauptkategorie“ (Erkl. s.o.) ist (die „SortNo“ für diese Kategorien ist immer „0“) !
3. Würde der Wert von „MoveSortNo“ dazu führen, daß die neue „SortNo“ kleiner als „1“ oder größer als die bisherige größte „SortNo“ aller Kategorien (die die gleiche übergeordnete Kategorie wie „ForumCategoryID“ besitzen) wäre, gibt es keinen Fehler, sondern die „SortNo“ wird dann auf „1“ gesetzt bzw. so geändert, daß „ForumCategoryID“ die größte „SortNo“ innerhalb aller Kategorien der übergeordneten Kategorie (von „ForumCategoryID“) besitzt.

Anmerkungen zum Parameter „PredecessorCategoryID“ :
Wird ein Wert angegeben, der eine andere Kategorie darstellt, als die aktuelle übergeordnete Kategorie von „ForumCategoryID“, wird „ForumCategoryID“ quasi „verschoben“, d.h. der angegebenen Kategorie untergeordnet.
1. In diesem Fall werden „CategoryDescription“ und „MoveSortNo“ NICHT beachtet !
2. Die Kategorie wird in der neuen Hauptkategorie ganz „nach unten“ eingeordnet, d.h. sie besitzt die größte „SortNo“ aller „PredecessorCategoryID“ zugeordneten Kategorien.
ACHTUNG : Es gibt einen Fehler („-500“), wenn „PredecessorCategoryID“ eine UNTER-geordnete Kategorie von „ForumCategoryID“ ist.

Anmerkung zum Parameter „CategoryDescription“ :
Ist eine „ForumCategoryID“ angegeben, aber keine „PredecessorCategoryID“ (bzw. ist „PredecessorCategoryID“ die aktuell übergeordnete Kategorie), wird nur die „CategoryDescription“ geändert UND/ODER die Reihenfolge innerhalb aller der gleichen übergeordneten Kategorie zugehörigen Kategorien verändert (→ „MoveSortNo“).
Möchte man die „CategoryDescription“ nicht verändern, kann man die bereits vorhandene „CategoryDescription“ oder „NULL“ im Parameter „CategoryDescription“ angeben !

Allgemeine Hinweise :
1. Einer Kategorie können MAXIMAL 255 Kategorien untergeordnet sein
2. Eine Kategorie kann nur gelöscht werden, wenn sie KEINE untergeordneten Kategorien mehr besitzt

Die Prozedur hat keine Rückgaben.

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_ModifyForumCategories_Ad im Engine Playground öffnen

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyForumCategories_Ad?ForumCategoryID=<value>&CategoryDescription=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/fo_ModifyForumCategories_Ad?ForumCategoryID=<value>&CategoryDescription=<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_ModifyForumCategories_Ad',
		array(
			'ForumCategoryID' => <value>,
			'CategoryDescription' => '<value>',
			// 'PredecessorCategoryID' => NULL,
			// 'MoveSortNo' => NULL,
			// 'DeleteCategory' => 0
		)
);
 
$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_ModifyForumCategories_Ad">
			<Parameters>
				<Parameter Name="ForumCategoryID"><!-- smallint value --></Parameter>
				<Parameter Name="CategoryDescription"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="PredecessorCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="MoveSortNo">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteCategory">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>