Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getforumcategories_pu

fo_GetForumCategories_Pu

Gibt alle Forum-Kategorien zurück, die einer bestimmten Kategorie (→ „ForumCategoryID“) untergeordnet sind.

Es werden nur die Kategorien berücksichtigt, die mindestens ein Forum enthalten (direkt oder indirekt, d.h. in einer Unter-Unter-…-Kategorie), auf das die identifizierte Person lesenden Zugriff besitzt; außerdem werden die Kategorien berücksichtigt, denen weder eine Kategorie untergeordnet noch ein Forum zugeordnet ist.
Anmerkung : Falls die Identifizierung fehlschlägt oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, werden die Rechte für die anonyme Person („PersonID = 0“) herangezogen.

Hinweise :
1. Möchte man (aus Performance-Gründen) einfach alle Kategorien unterhalb von „ForumCategoryID“ ausgegeben bekommen, ohne daß auf lesenden Zugriff geprüft wird, ist der Parameter „DoNotCheckAccessRights“ auf „1“ zu setzen. In diesem Fall wird auch keine Identifizierung durchgeführt.
2. Der erste Datensatz der Ergebnismenge enthält immer die Kategorie „ForumCategoryID“ selbst - mit „0“ als „SortNo“.

Anmerkungen zur Rückgabespalte „ContainsCategoriesOrForums“ :
1. Der Wert „3“ bedeutet, daß die Kategorie sowohl Foren als auch Unterkategorien enthält. Ob die identifizierte Person auf wenigstens ein Forum, das der Kategorie direkt zugeordnet ist, lesenden Zugriff hat, geht allerdings nicht daraus hervor (d.h. es kann sein, daß die Person z.B. nur auf ein Forum, das einer der Unterkategorien zugeordnet ist, Zugriff hat) !
2. Der Wert „4“ kann nur im Fall „DoNotCheckAccessRights = 0“ auftreten.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieforums
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PersonIdentificationValues Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.
varchar(255)4.0.4
PersonTypeID ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.
tinyint4.0.4
UniqueID Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zur „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ „NULL“ sein.
varchar(50)4.0.4
ForumCategoryID ID einer Forum-Kategorie, zu der die untergeordneten Kategorien ermittelt werden sollen
smallint4.0.4
DoNotCheckAccessRights0 „0“ : Identifizierung durchgeführen. Nur die Kategorien werden ausgegeben, die mindestens ein Forum enthalten, auf das die identifizierte Person lesenden Zugriff hat.
„1“ : Keine Identifizierung durchführen. Alle untegeordneten Kategorien ausgeben.
bit4.0.4
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichen die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
ForumCategoryIDID einer Forum-Kategorie, die „ForumCategoryID“ untergeordnet ist (oder „ForumCategoryID“ selbst)
smallint4.0.4
CategoryDescriptionBezeichnung der Kategorie „ForumCategoryID“
varchar(100)4.0.4
SortNoBestimmt die Reihenfolge von „ForumCategoryID“ innerhalb aller Kategorien, die „ForumCategoryID“ untergeordnet sind („0“ für „ForumCategoryID“ selbst)
tinyint4.0.4
ContainsCategoriesOrForumsGibt an, was „ForumCategoryID“ enthält :
„0“ : Weder Unterkategorien noch Foren
„1“ : Nur Unterkategorien
„2“ : Nur Foren
„3“ : Sowohl Foren als auch Unterkategorien
„4“ : Nur Unterkategorien, die wiederum auch keine Foren enthalten
(s.Beschreibung)
tinyint4.0.4
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (aufsteigend)
  • ForumCategoryID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

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

Historie

7.0.7 2015-01-29„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.0 2012-09-17Holger Wies : Wird in „UniqueID“ die „DefaultUniqueID“ angegeben, wird nun [ohne Aufruf von
pm_CheckPersonIdentity_Pu] der Aufrufer als „anonyme Person“ [„PersonID = 0“] identifiziert
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält
5.1.0 2006-02-08Fehler bei der Sortierung im Fall „DoNotCheckAccessRights = 1“
4.0.11 2004-03-311. Behebung diverser Fehler
2. Bug im ASE führte zu falscher Rückgabemenge in manchen Fällen
3. Konsequente Fehlerbehandlung
4. „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn
4.0.4 2003-08-26Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

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

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumCategories_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumCategoryID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetForumCategories_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumCategoryID=<value>' | xmllint --format -
dStore_php
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_GetForumCategories_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'ForumCategoryID' => <value>,
			// 'DoNotCheckAccessRights' => 0,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

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_GetForumCategories_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="ForumCategoryID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="DoNotCheckAccessRights">0</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/fo_getforumcategories_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)