Wie man ein super einfaches Thema benutzerdefiniertes Feld hinzufügt

JQ331 · 23. März 2021 um 19:56

Ich versuche zu verstehen, wie man ein benutzerdefiniertes Feld zu Themen hinzufügt, und arbeite mich durch ein sehr einfaches Beispiel durch. Ziel: Ein benutzerdefiniertes Feld namens “sample_field” zu jedem erstellten Thema hinzufügen, mit einem einfachen String-Wert.

Ich habe verschiedene Beispiele durchgesehen, wie das Poll-Plugin und das solved-Plugin sowie diese Diskussion, aber diese Plugins machen mit ihren benutzerdefinierten Feldern so viel mehr, dass ich den grundlegenden Code, den man dafür braucht, noch nicht ganz durchschaut habe.

Also bin ich noch nicht so weit – meine Datei plugin.rb fehlt etwas (glaube ich), und ich habe noch nicht herausgefunden, wie man den String-Wert zum Zeitpunkt der Erstellung des Themas an das benutzerdefinierte Feld bindet.

Was muss ich tun, damit das funktioniert?

Jede Hilfe wird geschätzt. Danke!

Hier ist, was ich bisher habe:

plugin.rb:
//Erstelle das benutzerdefinierte Feld:

  after_initialize do
     Topic.register_custom_field_type('sample_field', :string)
     add_to_serializer(:topic_view, :custom_fields) { object.custom_fields } //Wenn ich das benutzerdefinierte Feld auf der Client-Seite anzeigen möchte
  end

assets/javascripts/initializers/topic-custom-field.js.es6:
//Initialisiere das benutzerdefinierte Feld-Objekt und stelle sicher, dass es an den Server gesendet werden kann:

import { withPluginApi } from 'discourse/lib/plugin-api';

export default {
  name: 'topic-custom-field',
  initialize() {
    withPluginApi('0.8.31', api => {
      api.modifyClass('model:topic', {
        custom_fields: {},
        asJSON() {
          return Object.assign(this._super(), {
            custom_fields: this.custom_fields
          });
        }
      })
    })
  }
}

Wie füge ich dann den Wert des benutzerdefinierten Feldes zum Zeitpunkt des Speicherns zum Thema hinzu?

Ich glaube, die Schlüsselaktion “save” für ein Thema findet hier im Codebase statt:

app/templates/composer.hbs:

  <div class="save-or-cancel">
            {{#unless model.viewFullscreen}}
              {{composer-save-button action=(action "save")
                                     icon=saveIcon
                                     label=saveLabel
                                     disableSubmit=disableSubmit}}
...

Wie mache ich etwas (in diesem Fall einen Wert zum benutzerdefinierten Feld hinzufügen), wenn diese “save”-Aktion auftritt?

Ich habe versucht, eine JS-Datei unter initializers zu erstellen, in der ich etwas wie folgendes tun könnte:

api.modifyClass('component:composer-save-button', {
   actions: {
       topic.set('custom_fields.sample_field', 'here's a value for the sample_field')
   }
}

Aber ich muss in der Lage sein, dieses “topic.set” mit der “save”-Aktion in composer.hbs zu verknüpfen, und ich weiß nicht, wie ich das mache.

Und falls es einen einfacheren Weg gibt, dies zu tun, würde ich mich freuen, davon zu hören!

pfaffman · 24. März 2021 um 11:56

Mir ist kein perfektes Beispiel bekannt, aber ich werde vielleicht irgendwann versuchen, eines zu entwickeln.

Du könntest dir einige andere Plugins ansehen, um Beispiele zu finden. Ich bin mir im Moment nicht sicher, welches genau. Es gibt ein Discourse-Repository mit einem Namen wie „all-the-plugins“, das ich oft durchsuche, um nach bestimmten Dingen zu suchen.

Ich wette, dass das Reaktionen-Plugin, das derzeit hier getestet wird, ein gutes Beispiel ist. Schau dir das Banner an und wirf einen Blick darauf.

merefield · 24. März 2021 um 11:57

Ja, schauen Sie sich immer bestehende Plugins an.

Hier ist ein Beispiel:

github.com/merefield/discourse-locations

plugin.rb

af2bb17c1


      
          
            def include_geo_location?
              SiteSetting.location_users_map
            end
          end
          
          public_user_custom_fields = SiteSetting.public_user_custom_fields.split('|')
          public_user_custom_fields.push('geo_location') unless public_user_custom_fields.include?('geo_location')
          SiteSetting.public_user_custom_fields = public_user_custom_fields.join('|')
          
          PostRevisor.track_topic_field(:location) do |tc, location|
            if location.present? && 
               location = Locations::Helper.parse_location(location.to_unsafe_hash)
              
              tc.record_change('location', tc.topic.custom_fields['location'], location)
              tc.topic.custom_fields['location'] = location
              tc.topic.custom_fields['has_geo_location'] = location['geo_location'].present?
            else
              tc.topic.custom_fields['location'] = {}
              tc.topic.custom_fields['has_geo_location'] = false
            end

Dieses setzt auf diesen Connector und diese Komponente:

github.com/merefield/discourse-locations

assets/javascripts/discourse/connectors/edit-topic/edit-location-details.hbs

af2bb17c1


      
          {{#if model.showLocationControls}}
            {{add-location-controls location=buffered.location categoryId=buffered.category.id}}
          {{/if}}

JQ331 · 24. März 2021 um 11:58

Danke an alle – ich werde mir das ansehen. Ich habe im ursprünglichen Beitrag erwähnt, dass ich bereits eine Reihe anderer Beispiele geprüft habe. Habt ihr Gedanken zum Code, den ich bereitgestellt habe?

pfaffman · 24. März 2021 um 12:01

Entschuldigung. Ich habe keine offensichtlichen (für mich) Probleme festgestellt. Obwohl ich mich bei der Plugin-Entwicklung immer besser auskenne, habe ich oft das Gefühl, nur gerade so viel zu wissen, um gefährlich zu sein.

merefield · 24. März 2021 um 12:12

Möglicherweise zu kompliziert, wenn du dich mit der „Discourse-Art des Vorgehens

merefield · 24. März 2021 um 12:16

Hier ist ein weiteres Beispiel mit einem leicht anderen Eingabeszenario, das jedoch dieselben Mechanismen und Hooks nutzt:

https://github.com/paviliondev/discourse-topic-previews/blob/master/assets/javascripts/discourse/connectors/edit-topic/select-thumbnail-connector.hbs

github.com/merefield/discourse-topic-previews-sidecar

plugin.rb

6064a5940


      
            "topic_list_default_thumbnail",
            "topic_list_thumbnail_width",
            "topic_list_thumbnail_height",
            "topic_list_featured_images"
          ].each do |key|
            Site.preloaded_category_custom_fields << key if Site.respond_to? :preloaded_category_custom_fields
            add_to_serializer(:basic_category, key.to_sym, false) { object.custom_fields[key] }
          end
          
          TopicList.preloaded_custom_fields << "user_chosen_thumbnail_url" if TopicList.respond_to? :preloaded_custom_fields
          PostRevisor.track_topic_field("user_chosen_thumbnail_url".to_sym) do |tc, tf|
            tc.record_change("user_chosen_thumbnail_url", tc.topic.custom_fields["user_thumbnail_choice"], tf)
            tc.topic.custom_fields["user_chosen_thumbnail_url"] = tf
          end
          PostRevisor.track_topic_field("image_upload_id".to_sym) do |tc, tf|
            tc.record_change("image_upload_id", tc.topic.image_upload_id, tf)
            tc.topic.image_upload_id = tf
          end
          
          Discourse::Application.routes.append do
            mount ::TopicPreviews::Engine, at: '/topic-previews'

JQ331 · 24. März 2021 um 14:32

Danke. Ich bin mit PostRevisor nicht vertraut. Ich schaue mir das gerade an.

Ich bin mir nicht sicher, was du mit dem Bereich Topic Meta meinst. Ist das eine Datei, die du im Sinn hast? (Was die Benutzeroberfläche angeht, kenne ich den Composer zum Erstellen mit dem d-Editor darin und dann die Topic-Ansicht selbst. Ich bin mir nicht sicher, wo sich dort der Bereich “Meta” befindet.)

merefield · 24. März 2021 um 14:43

Ich betrachte die Informationen zu Kategorien und Tags als Metadaten.

JQ331 · 24. März 2021 um 20:31

Hier ist ein aktuell funktionierendes Basisbeispiel zum Erstellen eines benutzerdefinierten Themenfelds und zum Setzen dieses Felds. Dies setzt das Feld, wenn der Benutzer auf einen bestimmten Button auf der Themenansichtseite klickt.

Ich stelle fest, dass in Plugins, die benutzerdefinierte Themenfelder verwenden, in plugin.rb häufig PostRevisor (wie PostRevisor.track_topic_field) und DiscourseEvent.on(:topic_created) do |topic|... zum Einsatz kommen. Diese könnten es ermöglichen, das benutzerdefinierte Feld ohne Buttonklick zu setzen – beispielsweise beim Erstellen des Themas. Das habe ich jedoch noch nicht herausgefunden.

[EDIT: Falls jemand Code für plugin.rb vorschlagen möchte, um den Wert des benutzerdefinierten Felds zum Zeitpunkt der Themenerstellung hinzuzufügen (anstatt einen separaten Button zu benötigen, der geklickt werden muss), dann bitte gerne! ]

Hier ist also ein einfaches Beispiel, das ohne diese ausgefallenen Dinge funktioniert:

plugin.rb

Topic.register_custom_field_type('sample_field', :string)
add_to_class(:topic, :sample_field) { self.custom_fields['sample_field'] } ##vielleicht nicht notwendig, basierend auf Zeile 83 der plugin.rb von discourse-locations
	
add_to_serializer(:topic_view, :sample_field, false) { object.topic.sample_field } ##wahrscheinlich nur notwendig, wenn Sie das Ergebnis des benutzerdefinierten Felds dem Benutzer anzeigen möchten

connector/[add-button].hbs

//Beispiel hier: Der Connector ist topic-above-post-stream, der ein Modell (topic) im Plugin-Ausgang übergibt

<button {{action "setThatTopic" model}}>Hier klicken</button>

connector/[add-button].js.es6

import Topic from 'discourse/models/topic';  //vielleicht nicht notwendig

export default {			
    actions: {
       setThatTopic(model){
           model.set('custom_fields.sample_field', 'newValue123')
           console.log('Test, ob das benutzerdefinierte Feld vorhanden ist = ' + JSON.stringify(model.custom_fields))
        }
     }
}

assets/javascripts/initializers/topic-custom-field.js.es6

//Dies ist vielleicht nicht notwendig. Die Idee ist jedoch, das Objekt für benutzerdefinierte Felder zu initialisieren und sicherzustellen, dass es an den Server gesendet werden kann:

import { withPluginApi } from 'discourse/lib/plugin-api';

export default {
    name: 'topic-custom-field',
     initialize() {
	   withPluginApi('0.8.31', api => {
		 api.modifyClass('model:topic', {
			custom_fields: {},
			asJSON() {
			    return Object.assign(this._super(), {
				custom_fields: this.custom_fields
			   });
			}
	     })
	   })
    }
}

angus · 26. März 2021 um 07:54

Ich habe gerade ein „Bildungs-Plugin

JQ331 · 26. März 2021 um 11:40

Danke, @angus. Das ist unglaublich hilfreich und genau das Richtige, um die Arbeit mit Discourse zu erleichtern. Ich würde persönlich gerne mehr von dieser Art von Ressource sehen – klare, minimalistische Codebeispiele zur schrittweisen Implementierung einzelner Funktionen – für verschiedene Aufgaben mit Discourse. Zum Beispiel auch für benutzerdefinierte Felder bei Kategorien und Gruppen. Eine solche Ressource spart enorm viel Zeit.

Thema		Antworten	Aufrufe
How to add custom field to topic? Development	6	4259	24. April 2018
Create multiple custom fields for a topic Development	2	953	28. Juni 2023
Customizing create topic form to add more custom fields, what does add_to_serializer or register_custom_field_type do? Extras	2	6811	23. Februar 2017
Adding Topic custom fields in the topic creation form Development	1	1348	1. November 2016
How to add custom fields to models Extras pavilion	48	8373	30. September 2025

Wie man ein super einfaches Thema benutzerdefiniertes Feld hinzufügt

plugin.rb

connector/[add-button].hbs

connector/[add-button].js.es6

assets/javascripts/initializers/topic-custom-field.js.es6

Verwandte Themen