Folosind interfața ajax în joomla!

Ce este interfața Joomla AJAX? (Com_ajax)

O componentă compactă, extensibilă care acționează ca un punct de intrare pentru cererile HTTP pentru module independente și plug-in-uri, oferindu-le astfel potențialul de funcționalitate AJAX. Com_ajax este utilizat în principal în cazurile în care nu sunt dezvoltatori ai componentei cu care interacționează modulul sau plug-in-ul.







NOTĂ. Dacă sunteți un dezvoltator de componente, atunci nu este nevoie să utilizați com_ajax în el pentru a implementa funcționalitatea AJAX. Puteți face acest lucru direct în componenta dvs.

  • Un modul care primește date de la un API extern.
  • Un modul care interacționează cu o componentă care nu a fost proiectată de dvs.
  • Un plugin care implementează o funcționalitate API similară pentru organizarea consumului de date de pe site-ul dvs.

Anatomia cererii AJAX

  • opțiune = com_ajax
  • [module | plugin] = nume
  • format = [json | debug | prime]

facultativ

  • method = [fragmentul personalizat] devine primit în mod implicit. dacă nu este specificat.

Toate cererile încep cu opțiunea = com_ajax. care solicită această extensie, trebuie să conțină tipul extensiei pentru apel și formatul datelor returnate.

Variabilele suplimentare și valorile utilizate de extensia dvs. pot fi, de asemenea, incluse în adresa URL.







De exemplu, solicitarea pentru opțiunea = opțiunea = com_ajaxmodule = sesiunea va apela mod_session cu rezultatele returnate în formatul implicit. Opțiunea = com_ajaxplugin = sessionformat = json va apela metoda onAjaxSession a pluginurilor cu ieșirea rezultatului în JSON.

Suport pentru module

Suportul pentru module este implementat prin apelarea metodei din fișierul helper.php al modulului.

Solicitările de module trebuie să includă o variabilă a modulelor în URL, asociată cu numele modulului (de exemplu: module = sesiune pentru mod_session)

Această valoare este de asemenea folosită pentru:

  • Numele directorului pentru verificarea fișierului helper, de exemplu /modules/mod_session/helper.php
  • Numele clasei pentru apel, de exemplu:

Opțional, variabila de metodă poate fi utilizată pentru a suprascrie prefixul implicit al metodei get.

"Notă": toate metodele trebuie să se încheie cu Ajax. De exemplu: method = mySuperAwesomeMethodToTrigger va suna mySuperAwesomeMethodToTriggerAjax

Modulul de sesiune Ajax este un exemplu de modul care demonstrează această funcționalitate.

Răspundeți la plugin-uri

Suportul pentru plug-inuri se realizează prin lansarea unui eveniment. plugin onAjax [Nume].

Cererile de pluginuri ar trebui să includă o variabilă de plugin în adresa URL asociată cu evenimentul plug-in, de exemplu, plugin = session pentru onAjaxSession.

Această valoare este de asemenea folosită pentru:

  • Numele clasei plugin care urmează plgAjax [Name]
  • Numele funcției care urmează după numele [Name] /
  • Grupul de plugin implicit este ajax. Puteți să o modificați specificând parametrul de interogare de grup (începând cu Joomla! 3.4).

Ajax Latest Articles plugin este un exemplu de plug-in care demonstrează această funcționalitate.

Răspundeți la Format

format = [json | debug] argument opțional pentru formatul rezultat.

  • json pentru formatul JSON
  • depanare pentru o ieșire lizibilă de om. / en / en / en






Articole similare

Trimiteți-le prietenilor: