fo_GetPredValsForCharacs_Pu [dstore]

Inhaltsverzeichnis

fo_GetPredValsForCharacs_Pu

fo_GetPredValsForCharacs_Pu

Gibt alle vordefinierten Werte eines Posting-Merkmals zurück - sofern die identifizierte Person lesenden Zugriff auf das angegebene Forum (→ „ForumID“) hat.
Anmerkung : Falls die Identifizierung fehlschlägt oder in „UniqueID“ der Wert „defaultUniqueID“ angegeben wird, werden die Rechte für die anonyme Person (mit der speziellen „PersonID = 0“) gecheckt !

Hintergrund : Zu Forum-Beiträgen können Eigenschaften hinterlegt werden. Diese Eigenschaften gehören immer zu sogenannten Merkmalen (die quasi die Eigenschaften charakterisieren). Bestimmte Merkmale zeichnen sich dadurch aus, daß die Beiträge nur Eigenschaften zugewiesen bekommen können, die in einer Liste von vordefinierten Werten vorkommen.

Anmerkung zur Sortierung der Ergebnismenge :
Es wird immer „alphanumerisch“ nach „Value“ sortiert, es sei denn, es handelt es sich um Datumsangaben.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	fo_GetPredefinedValuesForPostingCharacteristics_Pu
Tags	[fo, Get, Predefined, Values, For, Posting, Characteristics, Pu]
Engine-Kategorie	forums
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	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.16
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.	tinyint	4.0.16
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.16
ForumID		ID eines Forums, dem das Merkmal „PostingCharacteristicID“ zugeordnet sein muß. Die identifizierte Person muß natürlich mindestens lesenden Zugriff haben. Schlägt die Identifizierung fehl, werden die Rechte der anonymen Person herangezogen.	integer	4.0.16
PostingCharacteristicID		ID des Posting-Merkmals, zu dem die vordefinierten Werte zurückgegeben werden sollen. Ist für das angegebene Merkmal nicht „PredefinedValues = 1“ konfiguriert (s. Rückgabemenge von pm_GetPostingCharacs_Ad), liefert die Prozedur „-500“ !	smallint	4.0.16
DateFormat	'german'	Bestimmt das Format der Ausgabe von Datums-Werten. Falls „german“ oder „germany“ (Groß- und Kleinschreibung wird nicht beachtet) übergeben wird, sind Datums-Eigenschaften im Format „Tag-Monat-Jahr“, sonst „Monat-Tag-Jahr“.	varchar(10)	4.0.16
SeparatorInIdentVals	'¶'	Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind	varchar(4)	5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value	Vordefinierter Wert zum Merkmal „PostingCharacteristicID“	varchar(250)	4.0.16
ValueInInternalFormat	Immer „NULL“, es sei denn, „Value“ ist ein Datums-Wert und es wurde (durch „DateFormat“) eine Ausgabe im Format „Tag-Monat-Jahr“ gewünscht. (Hintergrund sind Änderungen von vordefinierten Werten durch fo_ModifyPredValsForCharacs_Ad.)	varchar(250)	4.0.16

Sortierung der Rückgabe

(parameterunabängige Sortierung)

Value (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-801	Kein lesender Zugriff auf das Forum	nur direkt
-660	Identifikation fehlgeschlagen	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-602	Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werden	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	nur indirekt
-569	Der Benutzer hat kein Ausführungsrecht für die Prozedur	nur indirekt
-567	Die Prozedur darf z. Zt. nicht ausgeführt werden	nur indirekt
-566	Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden	nur indirekt
-550	Fehlender oder falscher Eintrag in Settings	nur indirekt
-535	Das Datum liegt nicht in der Vergangenheit	nur indirekt
-530	Der Wert ist nicht konvertierbar	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-504	Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen	nur indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	nur indirekt
-500	Falsche Parameter	direkt 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-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.5.0	2012-09-17	Holger 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-07	1. Neuer Parameter „SeparatorInIdentVals“ 2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
5.1.0	2006-02-08	Ab jetzt wird explizit auf „lesendes Recht“ [„AccessLevelID = 1“] geprüft
4.0.16	2004-08-31	Erstmalig 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:

fo_GetPredValsForCharacs_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/fo_GetPredValsForCharacs_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&ForumID=<value>&PostingCharacteristicID=<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_GetPredValsForCharacs_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			'ForumID' => <value>,
			'PostingCharacteristicID' => <value>,
			// 'DateFormat' => 'german',
			// '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_GetPredValsForCharacs_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="ForumID"><!-- integer value --></Parameter>
				<Parameter Name="PostingCharacteristicID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="DateFormat">'german'</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis