Beispiel Integer Variable im CSS Code

             p{ 
                display:none;
                font-size:{{plugin_xobor_config_font_size}}px;
                margin:20px auto;
                width:100px;
               }
          

Beispiel Boolean Konfigurationsvariable im Java Script Code

                var k = {{plugin_xobor_cansee_textarea==true.start}}
                            1
                        {{plugin_xobor_cansee_textarea==true.else}}
                            0
                        {{plugin_xobor_cansee_textarea==true.end}};

                 if(k==false){
                       $("#text_area").hide(400);
                    }
                  else {
                       $("#text_area").show(400); 
                    } 
               

Beispiel Text-Variablen im HTML Code

 
                

                    
{{plugin_xobor_config_text_test}}
                
               

Beispiel Html-Color Konfigurationsvariable im Css Code

 
                .one{
                        width:200px;
                        height:200px;
                        border: 1px solid #000000;
                        background-color:{{plugin_xobor_config_background_color}};
                        color:{{plugin_xobor_config_text_color}};     
                    }

               

Beispiel Chars Konfigurationsvariable im Html Code

                    

                        

                        
{{plugin_xobor_config_chars_title}}
                             
                                Hier steht weiterer Text 
                            
                        

                    
    
               

Beispiel Fileurl Konfigurationsvariable im Css Code

                .text-test{
                      position:absolute;
                      left:871px;
                      top:300px;
                      width:200px;
                      margin:0px;
                      background-color:#000000;
                      padding:10px;
                      background-image:url({{plugin_xobor_config_bgicon}});
                      color:{{plugin_xobor_config_fontcolor}};
                 }
               

Beispiel Globale Variable per Template Code lesen

 
                    

                        

                            {{plugin_xobor_global_testvar}}
                        
                        

                            

                                  ...
                            
                        
                    
    
               

Beispiel Globale Variable per Javascript lesen. Hier wird die Methode getGlob() der Javascript-API verwendet

 
                    

                        

                            
                        
                        

                            

                                  ...
                            
                        
                    
                    <script>
                        var heading = xobor.plugin("xobor").getGlob("testvar");
                        $("#headerplaceholder").html(heading);
                        
               

1) Globale Variable per Template Code in einem bestehenden Formular speichern
Hierzu kann in fast jedem Post-Formular ein Input-Feld mit dem Namen der Variablen definiert werden. Der Wert wird dann beim absenden der Form automatisch gespeichert.
Dieser Weg der Speicherung klappt in allen Formularen, bei denen entweder eine "UserAction" ausgelöst, oder der Suchindex geändert wird. Details entnhemen Sie bitte der Liste der User Actions

Im Beispiel wird wieder die Variable {{plugin_xobor_global_testvar}} gespeichert

 
                    

                        
                        Nachrichtentext                        
                        
                    
               

2) Globale Variable per Template Code in einem eigenen Formular speichern
Diese Funktion wird in einer späteren Version der API bereitgestellt

3) Speicherung per Javascript. Hier wird die setGlobal-Methode der Javascript-API verwendet. Das funktioniert auf jeder Seite des Forums

 
                    

                        
                        Nachrichtentext
                        
                    
                    <script>
                        function saveGlobal(){
                            var newval = $("#theglobal").val();
                            xobor.plugin("xobor").setGlob("testvar",newval);
                        }
                        
               

Beispiel Data Variable per Template Code lesen

 
                    

                        

                            Nachrichten
                        
                        

                            

                                 {{messages.starlist}}
                                 {{messages:plugin_xobor_testdatavar==true.start}}
                                    Zur Nachricht {{message:id}} wurden folgende Daten gespeichert:
                                    {{messages:plugin_xobor_testdatavar}}
                                 {{messages:plugin_xobor_testdatavar==true.end}}   
                                 {{messages.end}}
                            
                        
                    
    
               

Beispiel Data Variable per Javascript lesen

 
               <script>var comments = [];
               
                    

                        

                            Nachrichten
                        
                        

                            
                            
                                {{messages.starlist}}
                                ...Hier Nachricht anzeigen...
                                  <script>xobor.plugin("xobor").getDataVar("testvar",function(res){comments.push(res)});
                                {{messages.end}}  
                            
                        
                    
                    
               

1) Data Variable per Template Code in einem bestehenden Formular speichern
Hierzu kann in fast jedem Post-Formular ein Input-Feld mit dem Namen der Variablen definiert werden.
Origin Type und Origin ID werden in diesem Fall von der Forensoftware ergänzt.
Der Wert wird dann beim absenden der Form automatisch gespeichert.
Dieser Weg der Speicherung klappt in allen Formularen, bei denen entweder eine "UserAction" ausgelöst, oder der Suchindex geändert wird. Details entnehmen Sie bitte der Liste der User Actions

Im Beispiel wird wieder die Variable {{plugin_xobor_testdatavar}} gespeichert

 
                    

                        
                        Nachrichtentext                        
                        
                    
               

2) Data Variable per Template Code in einem eigenen Formular speichern
Diese Funktion wird in einer späteren Version der API bereitgestellt

3) Speicherung per Javascript. Hier wird die setDataVar-Methode der Javascript-API verwendet. Das funktioniert auf jeder Seite des Forums
Wichtig ist, dass hier target_type und target_id als Parameter mit angegeben werden müssen
Soll zum Beispiel die Variable testvar zum Beitrag (=target_type 2) mit der ID 12345 gespeeichert werden, könnte der Code so aussehen:

 
                    

                        
                        Nachrichtentext
                        
                    
                    <script>
                        function saveVar(){
                            var newval = $("#thedatavar").val();
                            xobor.plugin("xobor").setDataVar("testvar",2,12345,newval);
                        }
                        
               

Beispiel Aufruf einer API-Funktion

            xobor.plugin("PluginID").funktionsname(parameter);
          

Aufruf der getDeep()-Funktion

            xobor.plugin("PluginID").getDeep(idata,returnfunction);
          
           Parameter: 

                idata = Objekt mit den Elementinformationen, die ergänzt werden sollen.
                        Es müssen mindestens die Werte target_id und target_type gesetzt werden.
                        returnfunction = hier wir die Funktion angegeben, die den Rückgabewert erhält.
                

     
                var idata = {target_id: "12345", target_type: "3"}
                xobor.plugin("modcomment").getDeep(idata,function(res){alert(res.uname);});
           

     
            //In diesem Beispiel werden die Daten zu vier Mitgliedern gleichzeitig abgerufen.
                var idata = {target_id: "[12345,54321,98765,56789]", target_type: "3"}
                xobor.plugin("modcomment").getDeep(idata,function(res){
                        $.each(res,function(){alert(this.uname)}));
                });
           

Aufruf der getDeepList()-Funktion aus dem modcomment-Plugin, um die Mitgliederliste abzurufen
Im Beispiel wird die Anzahl der Mitglieder des Forums in einem Popup angezeigt

            /*
            Optionale Parameter
                order (ASC|DESC)
                orderby (name|id|usertitle)
                limit (int,"all")
            */
            
            idata = {target_type : 3, limit : "all"}
            xobor.plugin("modcomment").getDeepList(idata,function(res){
                alert(Object.keys(res).length + " Mitglieder im Forum")
            });
          

Aufruf der setGlob()-Funktion aus dem modcomment-Plugin, um die Variable comment zu überschreiben

            var newval = $("#comment").val();
            xobor.plugin("modcomment").setGlob("comment",newval,function(res){
                alert("Kommentar gespeichert");
            });
          

Aufruf der getGlob()-Funktion aus dem modcomment-Plugin, um die Variable comment abzurufen

            xobor.plugin("modcomment").getGlob("comment",0,function(res){
                alert("Kommentar: " + res);
            });
          

Aufruf der getConf()-Funktion aus dem modcomment-Plugin, um die Variable comment_icon abzurufen.

            xobor.plugin("modcomment").getConf("comment_icon",function(res){
                $("<img src='"+res+"' />").appendTo($commentbox);
            });
          

Aufruf der getDataVar()-Funktion aus dem modcomment-Plugin, um die Variable comment abzurufen, die einem Beitrag zugeordnet ist.

          var origin_id = 12345; //ID des Beitrags
          var origin_type = 2; //siehe target_type Tabelle
            xobor.plugin("modcomment").getDataVar("comment",origin_type,origin_id,function(res){
                alert("Kommentar: " + res);
            });
          

Aufruf der setDataVar()-Funktion aus dem modcomment-Plugin, um die Variable comment für einen bestimmten Beitrag anzupassen.

          var beitrags_id = 12345; //ID des Beitrags
          var origin_type = 2; //siehe target_type Tabelle
          var newval = "Ich bin ein Kommentar";
            xobor.plugin("modcomment").setDataVar("comment",origin_type,beitrags_id,newval,function(res){
                alert("Kommentar: " + res);
            });
          

Aufruf der delDataVar()-Funktion aus dem modcomment-Plugin, um die Variable comment für einen bestimmten Beitrag zu löschen.

          var beitrags_id = 12345; //ID des Beitrags
          var origin_type = 2; //siehe target_type Tabelle          
            xobor.plugin("modcomment").setDataVar("comment",origin_type,beitrags_id,function(res){
                alert("Kommentar gelöscht");
            });
          

Die sendmail()-Funktion ermöglich es Administratoren, Emails über die Plugin-API zu versenden.

            /*
            Parameter
                userid (Mitglied an das die Nachricht gesendet werden soll)
                mailtitle (Betreffzeile der Email)
                mailboy (Inhalt der Email)
                
                Tipp: Um Leerzeilen im Mailbody zu erzeugen, muss der Javascript Zeilenumbruch \n verwendet werden.
            */
            
            maildata = {    
                userid : 1234, 
                mailtitle : "Neue Leserechte", 
                mailbody : "Hallo Peter\n\nDu bist nun in der Gruppe "Dauergäste" und hast weitere Leserechte bekommen"};
                            
            xobor.plugin("modcomment").call("sendmail",maildata,function(res){
                alert("Email versendet");
            });
          

Die setUserTitle()-Funktion ermöglicht es Administratoren Benutzertitel einzelner Mitglieder zu ändern. So können zum Beispiel aus einem Plugin heraus neue Benutzertitel für bestimmte Aktionen vergeben werden

            /*
            Parameter
                uid (Mitglied dessen Benutzertitel angepasst werden soll)
                title (Der neue Titel - darf auch HTML-Code enthalten)
                getcurrent (Ist dieser Wert auf true, gibt die Funktion den aktuellen Titel als Rückgabewert "oldtitle" zurück)
                fixed (Soll ein statischer Titel verwendet werden, muss dieser Parameter auf true stehen. Wird hier ein false übertragen, wird der Titel automatisch nach der Punktezahl des Mitglieds berechnet)                               
            */
            
            titledata = {    
                userid : 1234, 
                title : "Vielschreiber",
                getcurrent : 1
                fixed : 1
            }    
                            
            xobor.plugin("modcomment").call("setUserTitle",titledata,function(res){
                alert("Titel geändert. Alt:"+res.oldtitle+" Neu: " + titledata.title);
            });
          

Die bbcodeLive()-Funktion wandelt unter Berücksichtigung der Forencodes BBCode in HTML um

            /*
            Parameter
                text (BB-Code zum Umwandeln)                
            */
            
            translate = {    
                text : "[b]Ich bin eine Überschrift[/b]", 
            }    
                            
            xobor.plugin("modcomment").call("bbcodeLive",translate,function(res){
                $("#preview").html(res);
            });
          

Die setModerator()-Funktion ermöglicht es, neue Moderatoren zu ernennen

            /*
            Parameter
                newModID (der Nutzer, der Moderator werden soll)                
                templateModID (ID eines Moderators, von dem die Rechte übernommen werden sollen)
            */
            
            moddata = {    
                newModID : 12345, 
                templateModID : 54321
            }    
                            
            xobor.plugin("modcomment").call("setModerator",moddata,function(res){
                alert("Moderator hinzugefügt");
            });
          

Die delModerator()-Funktion entzieht einem Mitglied die Moderatorenrechte

            /*
            Parameter
                userid (der Moderator, dessen Rechte entfernt werden)                                
            */
            
            moddata = {    
                userid : 12345,                 
            }    
                            
            xobor.plugin("modcomment").call("delModerator",moddata,function(res){
                alert("Moderator entfernt");
            });
          

Die checkRights()-Funktion gibt die Lese und Schreibrechte für eine Data-Variable zurück

            /*
            Parameter
                origintype (Element Type, dem die Variable zugeordnet ist)                                
                originid (Element, dem die Variable zugeordnet ist)                                
                varname (Name der Variablen)                                
                seperatedid (User, dem die Variable zugeordnet ist (optional))                                
            Rückgabe
                array("read","write","create")
            */
            
            vardata = {    
                origintype : 1, //Beitrag
                originid : 123456 //Beitrags-Id
                varname : "comment" //
            }    
                            
            xobor.plugin("modcomment").call("checkRights",vardata,function(res){
                if(res.read){alert("Leserechte vorhanden");}
            });
          

Die moveToGroup()-Funktion verschiebt ein Mitglied in eine andere Gruppe. Kann nur mit Administrationsrechten aufgerufen werden.

            /*
            Parameter
                userid (Id des Mitglieds, dass verschoben werden soll)                                
                targetgroup (Id der gruppe, in die das Mitglied verschoben werden soll)                                                
            */
            
            vardata = {    
                userid : 12345,
                targetgroup : 54321
            }    
                            
            xobor.plugin("modcomment").call("moveToGroup",vardata,function(res){
                alert("benutzer verschoben");
            });
          

Die userDataVarList()-Funktion ermöglicht es, Data-Variablen von verschiedenen Mitgliedern abzurufen (sofern Rechte vorhanden sind).

            /*
            Parameter
                varname (Name der Variablen)                                
                origin_type (Element Typ, dem die Variable zugeordnet ist)
                origin_id (Id des Elements, dem die Variable zugeordnet ist)
            */
            
            vardata = {    
                varname : "comment",
                origin_type : "2" //Beitrag
                origin_id : 123454 //Beitrags-Id                
            }    
                            
            xobor.plugin("modcomment").call("userDataVarList",vardata,function(res){
                alert("Wert der Variablen " +vardata.varname+ ": " + res);
            });
          

Die getmeta()-Funktion ruft einige Metadaten des Plugins ab.

            /*
            Parameter
                keine
            Rückgabewerte:
                title : Titel des Plugins
                logourl : URL des Pluginlogos
                description : Beschreibung des Plugins
                author_name : Name des Erstellers
                author_link : Homepage des Erstellers
                version : Plugin-Version
                installedfrom : Id des Admins, der das Plugin installiert hat
                installdate : Datum der Installation
            */
            
                            
            xobor.plugin("modcomment").call("getmeta",function(res){
                createPluginCopyright(res);
            });
          

Aufruf der log()-Funktion aus dem modcomment-Plugin, um den Text "Fehler - Variablendaten können nicht geladen werden" auszugeben.

      
            var text = "Fehler - Variablendaten können nicht geladen werden";
            xobor.plugin("modcomment").log(text);
            
            Konsolen Ausgabe:
            >>Plugin modcomment meldet: Fehler - Variablendaten können nicht geladen werden
          

Gibt die aktuelle UserID zurück.

Gibt true zurück, wenn die Aufrufe asynchron verlaufen.

                  
            var async = xobor.global.ajaxAsync             
          

   
            //momentane Einstllung abfragen
            var async = xobor.global.ajaxAsync;             
            
            //Falls nicht asynchron, Einstellung ändern
            if(!async){xobor.config.setAjaxAsync(true);}