PHP - Data Explorer API Beispiel

Daten & Berichterstattung
1

Ich arbeite daran, Daten aus Discourse mit PHP und der Data Explorer API zu extrahieren. Hier ist das Grundgerüst meines PHP-Codes als Ausgangspunkt für andere.

PHP-Code

<?php
// API-Schlüssel festlegen
$api_key = '<dein Schlüssel hier>';
//
// 1. $url sollte auf die URL deines Discourse-Forums gesetzt werden
// 2. Rufe die Abfrage-Nr. ab, die du ausführen möchtest. Aktualisiere die URL für diese Abfrage
//    d. h. Abfrage Nr. 5 => .../queries/5/run
//    d. h. Abfrage Nr. 47 => .../queries/47/run
$url = 'https://discourse.com/admin/plugins/explorer/queries/7/run';
//
// Aktualisiere deine Parameter, die an die Abfrage übergeben werden sollen.
// Beispiel für einen Parameter - fest codiert
// $data = 'params={\"user\":\"fred_smith\"}';   
// Beispiel für einen Parameter - Übergabe einer Variablen
// $data = 'params={\"user\":\"'.$user.'\"}';   
// Beispiel für zwei oder mehr Parameter - Übergabe einer Variablen
$data = 'params={\"user\":\"'.$user.'\",\"term\":\"'.$term.'\"}';   
//
// Curl-Befehle
//
$headers = array("Content-Type: multipart/form-data;", "Api-Key: $api_key", "Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);

$result = curl_exec( $ch );
if ( curl_errno( $ch ) !== 0 ) {
   // Fehler behandeln, curl_close( $ch ) aufrufen und zurückkehren.
}
curl_close( $ch );
//
// Curl-Ergebnis in ein PHP-Array konvertieren, um programmatisch damit zu arbeiten
$result_array = json_decode( $result,true);

print($result_array);

?>

Data Explorer-Abfrage

Im Beispiel des Codes, der zwei übergebene Variablen verwendet, sah mein Data Explorer-Code so aus:

--[params]
-- string :term
-- string :user

SELECT users.username, posts.id, uploads.url, topics.title
     FROM upload_references
     JOIN uploads ON uploads.id = upload_references.upload_id
     JOIN posts   ON posts.id   = upload_references.target_id
     JOIN topics  ON topics.id  = posts.topic_id
     JOIN users   ON posts.user_id = users.id
    WHERE (posts.cooked like '%' || :term || '%' 
       OR topics.title like '%' || :term || '%') 
      AND users.username_lower like '%' || :user || '%'
      AND topics.archetype = 'regular'
 ORDER BY uploads.created_at DESC
 limit 10

Ich hoffe, das hilft jemandem, ein Projekt zu starten.

3 „Gefällt mir“
2

Ich würde die meisten Kommentare kürzen, um die Lesbarkeit zu verbessern :slight_smile:
Einige Kommentare sind unnötig, wie zum Beispiel:

// Ergebnis erhalten
//
$result = curl_exec( $ch );

oder

// curl-Sitzung schließen
curl_close( $ch );

Außerdem können Sie die Syntaxhervorhebung einstellen, indem Sie den Sprachnamen an die erste Zeile der Backticks anhängen:

```php
$headers = array("Content-Type: multipart/form-data;","Api-Key: $api_key","Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);
```

Wird gerendert als

$headers = array("Content-Type: multipart/form-data;","Api-Key: $api_key","Api-Username: system",);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers );
curl_setopt($ch, CURLOPT_POSTFIELDS,$data);
3

Danke für das Feedback. Ich habe die ersten Beiträge aktualisiert.