Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_getpostingthread_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:fo_getpostingthread_pu [11.01.2016 ]
engine:procedures:fo_getpostingthread_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== fo_GetPostingThread_Pu =====
 +
 +Liefert zu einem Posting eines Forums die Antworten, also den "​Thread",​ der mit diesem Beitrag beginnt.\\ ​
 +
 +Anmerkungen zum Parameter "​Visibility"​ :\\ 1. Sofern auch gelöschte Beiträge berücksichtigt werden sollen, muß die identifizierte Person (falls die Identifizierung fehlschlägt oder in "​UniqueID"​ der Wert "​defaultUniqueID"​ angegeben wird, wird die anonyme Person mit der speziellen "​PersonID = 0" gewählt) für das Forum mindestens eines der folgenden Rechte besitzen :\\ "​16"​ : "​löschen eigener Postings, sofern keine Replies vorhanden"​\\ "​32"​ : "​löschen eigener Postings (inkl. Replies)"​\\ "​128"​ : "​löschen aller Postings des Forums, sofern keine Replies vorhanden"​\\ "​256"​ : "​löschen aller Postings des Forums (inkl. Replies)"​\\ Besitzt die Person nur das Recht "​16"​ oder "​32"​ werden zudem nur die EIGENEN (Author entspricht der identifizierten Person) gelöschten Beiträge ausgegeben !\\ 2. Sollen nicht bestätigte Beiträge berücksichtigt werden, benötigt die identifizierte Person das Recht\\ "​64"​ : "​bestätigen von Postings des Forums"​\\ für das Forum.\\ ​
 +
 +Anmerkung zur Rückgabespalte "​AlreadyRead":​\\ In "​ForumSettings"​ gibt es einen Eintrag "​HoursAfterPostingsAreRegardedAsRead",​ der angibt, ab wann ein Posting IMMER als gelesen gilt (einfach weil es in einem gewissen Sinn "​alt"​ ist). Falls "​MaintainReadPostingsPerPerson"​ für das angegebene Forum (in "​ForumSettings"​) auf "​1"​ steht, wird von jeder Prozedur, die Postings inkl. "​Body"​ ausgibt, in der Tabelle "​ReadPostingsPerPerson"​ festgehalten,​ welche Person welches Posting schon gelesen hat.\\ => Wurde das Posting vor "​HoursAfterPostingsAreRegardedAsRead"​ Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in "​ReadPostingsPerPerson",​ ist "​AlreadyRead = 1"​.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[fo Get Posting Thread Pu]}}|
 +|Engine-Kategorie|forums |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^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)|3.5.0|
 +|__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|3.5.0|
 +|__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)|3.5.0|
 +|__ForumID__| |ID eines Forums\\ |smallint|3.5.0|
 +|__PostingID__| |ID eines Beitrags des Forums "​ForumID",​ zu dem der "​Thread"​ angezeigt werden soll\\ |integer|3.5.0|
 +|RootPostingID|NULL |Die Darstellung des "​Threads"​ beginnt standardmäßig mit der "​PostingID"​. Man kann aber durch diesen Parameter auch ein "​Vorgänger"​-Posting von "​PostingID"​ angeben, dann beginnt die Darstellung mit diesem Beitrag.\\ |integer|3.5.0|
 +|MaxNumberOfLevels|5 |Schränkt die Anzahl Ebenen, die im Thread (ab "​PostingID"​) angezeigt werden, ein. "​0"​ oder "​1"​ bedeutet, daß nur Beitrag selbst ausgegeben wird, "​2"​ liefert auch die DIREKTEN Antworten usw.\\ |tinyint|3.5.0|
 +|MaxNumberOfPostings|20 |Sobald auf einer Ebene des Threads (zusammen mit den Vorgängern natürlich) mehr als "​MaxNumberOfPostings"​ gefunden wurden, bricht die Prozedur ab und gibt die bisher ermittelten Postings zurück\\ |tinyint|3.5.0|
 +|IncludePostingBodies|0 |Gibt an, ob in der Rückgabemenge auch der "​Body"​ (d.h. der Beitrag selbst) des jeweiligen Postings ausgegeben werden soll\\ |bit|3.5.0|
 +|Visibility|12 |Nur Postings ausgeben, die einen bestimmten "​Sichtbarkeitsstatus"​ ("​Visible"​ in "​ForumPostings"​) haben; für eine Filterung nach mehreren "​Visible"​-Status gibt man einfach die entsprechende Summe an. Mögliche Werte : siehe [[dstoreproc>​fo_GetPostingVisibilities]].\\ |tinyint|3.5.9|
 +|OrderDesc|1 |Bestimmt die Reihenfolge der jeweiligen DIREKTEN Antworten zu einem Posting :\\ "​0"​ : AUFsteigend nach dem Datum der Beiträge\\ "​1"​ : ABsteigend nach dem Datum der Beiträge\\ |bit|3.5.14|
 +|GetOwnNotApprovedPostings|0 |Konnte eine Person identifiziert werden und wird hier "​1"​ übergeben, werden nicht nur "​Visibility"​ entsprechende Beiträge berücksichtigt,​ sondern auch eigene (d.h. Autor ist die identif. Person), unbestätigte Beiträge (dazu ist lesend. Zugr. erforderl.)\\ |bit|4.0.5|
 +|OutputIntoOneID|0 |"​0"​ : Nur eine Ergebnismenge liefern\\ "​1"​ : Anstelle einer Ergebnismenge werden die "​PostingID"​s in "​tempdb.dbo.OneID"​ eingefügt\\ "​2"​ : Es wird sowohl eine Ergebnismenge geliefert als auch die "​PostingID"​s in "​tempdb.dbo.OneID"​ eingefügt\\ |tinyint|4.0.16|
 +|SeparatorInIdentVals|'​¶'​ |Gibt an, durch welche Zeichen die Werte in "​PersonIdentificationValues"​ getrennt sind\\ |varchar(4)|5.5.0|
 +==== Rückgabe ====
 +
 +=== wenn OutputIntoOneID IN (0,2) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|PostingID|ID eines Postings\\ |integer|3.5.0 |
 +|ReplyToPostingID|ID des Postings, auf das "​PostingID"​ eine Antwort darstellt. Falls gleich "​PostingID",​ handelt es sich um einen Haupt-Beitrag,​ sprich "​MainPosting"​\\ |integer|3.5.0 |
 +|MainPostingID|ID des Haupt-Beitrages zu "​PostingID"​ (also sozusagen das Wurzel-Element des gesamten "​Threads"​ zu dem "​PostingID"​ gehört)\\ |integer|3.5.0 |
 +|LevelNo|Auf welcher "​Ebene"​ befindet sich "​PostingID"​ im zurückgegebenen "​Thread"​. (Für das Wurzel-Element steht hier "​1",​ für die direkten Antworten die "​2"​ usw.)\\ |tinyint|3.5.0 |
 +|PostDate|Wann wurde der Beitrag "​PostingID"​ erstellt ? (Format : "​15.03.2001 20:​48:​13"​)\\ |varchar(19)|3.5.0 |
 +|Author|Name des Verfassers des Beitrags "​PostingID"​\\ |varchar(100)|3.5.0 |
 +|PersonID|(Person)ID des Verfassers "​Author"​ - "​0"​ bedeutet, daß der Verfasser anonym ist\\ |integer|3.5.0 |
 +|EMailOfAuthor|eMail des Verfassers "​Author"​\\ |varchar(100)|3.5.0 |
 +|Subject|Der Titel des Beitrags "​PostingID"​\\ |varchar(255)|3.5.0 |
 +|Body|Der Beitrag selbst - immer "​NULL"​ falls "​IncludePostingBodies = 0" oder wenn "​SmallBody"​ NICHT "​NULL"​ ist\\ |text|3.5.0 |
 +|HasSuccessors|Gibt es wenigstens eine Antwort auf "​PostingID"​ ? Dabei zählen nur Beiträge, die einen "​Visibility"​ entsprechenden "​Sichtbarkeits-Status"​ haben bzw. unbestätigt sind, falls "​GetOwnNotApprovedPosting = 1" und der Autor die identifizierte Person ist !\\ |bit|3.5.0 |
 +|HasBinaries|Sind "​Binaries"​ zu dem Posting "​PostingID"​ vorhanden ?\\ |bit|3.5.0 |
 +|IsExpanded|Ist der "​Teil-Baum",​ der mit "​PostingID"​ beginnt "​aufgeklappt",​ d.h. werden Nachfolger (sprich "​Antworten"​) angezeigt ?\\ |bit|3.5.0 |
 +|AlreadyRead|Wurde das Posting vor "​HoursAfterPostingsAreRegardedAsRead"​ (Eintrag in "​ForumSettings"​) Stunden verfaßt ODER gibt es zur Person, die diese Prozedur aufruft, einen Eintrag in "​ReadPostingsPerPerson",​ steht hier der Wert "​1"​\\ |bit|3.5.4 |
 +|PostingsInThread|Wieviele Antworten hat "​PostingID"​ (inkl. Antworten auf Antworten usw.). Dabei zählen nur Beiträge, die einen "​Visibility"​ entsprechenden "​Sichtbarkeits-Status"​ haben bzw. (falls "​GetOwnNotApprovedPosting = 1") deren Autor die identifizierte Person ist!\\ |integer|3.5.4 |
 +|NewPostingsInThread|Wieviele (für die identif. Person) "​neue"​ (s. "​AlreadyRead"​) Postings gibt es im Thread. Es zählen nur Beiträge, die einen "​Visibility"​ entspr. "​Sichtbarkeits-Status"​ haben bzw. (falls "​GetOwnNotApprovedPosting = 1") deren Autor die identif. Person ist!\\ |integer|3.5.4 |
 +|SmallBody|Hier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND "​UseSmallBody"​ in "​ForumSettings"​ auf "​1"​ gesetzt UND "​IncludePostingBodies = 1" ist. D.h. mindestens EINE der Rückgabespalten "​SmallBody"​ und "​Body"​ ist IMMER "​NULL"​.\\ |varchar(255)|3.5.19 |
 +|Visible|Sichtbarkeits-Status des Postings "​PostingID"​ - mögliche Werte : siehe [[dstoreproc>​fo_GetPostingVisibilities]]\\ |tinyint|3.5.20 |
 +==== Output-Parameter ====
 +
 +Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-805|Keine Berechtigung zum Löschen von Postings|nur direkt|
 +|-802|Keine Berechtigung zum Bestätigen von Postings des Forums|nur direkt|
 +|-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 [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|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\\ [[dstoreproc>​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\\ ​ |
 +|5.1.0 |2006-02-08|Ab jetzt wird explizit auf "​lesendes Recht" ["​AccessLevelID = 1"] geprüft\\ ​ |
 +|4.0.16 |2004-08-31|1. Neuer Parameter "​OutputIntoOneID"​\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ 3. Konsequente Fehlerbehandlung\\ ​ |
 +|4.0.15 |2004-07-30|Sicherheitsloch : Es wurde bisher nicht überprüft,​ ob "​PostingID"​ auch zum Forum "​ForumID"​ paßt. Daher konnte theoretisch ein Forum angegeben werden, für das lesende Rechte bestehen, aber eine "​PostingID"​ für das eigentlich kein Leserecht besteht !\\  |
 +|4.0.5 |2003-10-04|Neuer Parameter "​GetOwnNotApprovedPostings"​\\ ​ |
 +|4.0.3 |2003-07-10|1. Fehler bzgl. Initialisierung von internen Variablen anhand von "​Settings"​-Einträgen\\ 2. Parameter-Check für "​Visibility"​ geändert ("​Visibility = 0" gibt jetzt auch "​-500"​)\\ ​ |
 +|4.0.1 |2003-05-16|Fehler bzgl. der "​Visible"​-Status-Überprüfung ["​Visibility"​ entsprechend],​ falls man AUCH gelöschte Beiträge sehen möchte [aber nicht nur !], also falls "​Visibility & 1 = 1" UND "​Visibility > 1"​\\ ​ |
 +|4.0.0 |2003-04-03|Nur Fehler in der Doku behoben\\ ​ |
 +|3.5.21 |2002-08-06|\\ ​ |
 +|3.5.20 |2002-07-22|\\ ​ |
 +|3.5.19 |2002-06-17|\\ ​ |
 +|3.5.18 |2002-05-15|\\ ​ |
 +|3.5.17 |2002-05-02|\\ ​ |
 +|3.5.14 |2002-01-23|\\ ​ |
 +|3.5.9 |2001-06-16|\\ ​ |
 +|3.5.5 |2001-03-30|\\ ​ |
 +|3.5.4 |2001-03-11|\\ ​ |
 +|3.5.0 |2000-11-23|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:
 +  * [[http://​playground.dstore.de/​index.php?​proc=fo_GetPostingThread_Pu|fo_GetPostingThread_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_GetPostingThread_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​ForumID=<​value>&​PostingID=<​value>'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_GetPostingThread_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​ForumID=<​value>&​PostingID=<​value>'​ | xmllint --format -</​code>​== dStore_php ==
 +<code 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_GetPostingThread_Pu',​
 + array(
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​PersonTypeID'​ => <​value>,​
 + '​UniqueID'​ => '<​value>',​
 + '​ForumID'​ => <​value>,​
 + '​PostingID'​ => <​value>,​
 + // '​RootPostingID'​ => NULL,
 + // '​MaxNumberOfLevels'​ => 5,
 + // '​MaxNumberOfPostings'​ => 20,
 + // '​IncludePostingBodies'​ => 0,
 + // '​Visibility'​ => 12,
 + // '​OrderDesc'​ => 1,
 + // '​GetOwnNotApprovedPostings'​ => 0,
 + // '​OutputIntoOneID'​ => 0,
 + // '​SeparatorInIdentVals'​ => '​¶'​
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​fo_GetPostingThread_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​PersonIdentificationValues"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PersonTypeID"><​!-- tinyint value --></​Parameter>​
 + <​Parameter Name="​UniqueID"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​ForumID"><​!-- smallint value --></​Parameter>​
 + <​Parameter Name="​PostingID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​RootPostingID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaxNumberOfLevels">​5</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaxNumberOfPostings">​20</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludePostingBodies">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​Visibility">​12</​Parameter>​ -->
 + <!-- <​Parameter Name="​OrderDesc">​1</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetOwnNotApprovedPostings">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputIntoOneID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/fo_getpostingthread_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)