Áú»¢¶Ä²©

manifest.json

Qualsevol ³¾¨°»å³Ü±ô necessita el fitxer manifest.json. El fitxer s'ha d'ubicar al directori principal del ³¾¨°»å³Ü±ô (per exemple, ui/modules/module_name/manifest.json).

Com a m¨ªnim, manifest.json hauria d'especificar aquests camps:

{
           "manifest_version": 2.0,
           "id": "la_meva_adre?a_ip",
           "name": "La meva adre?a IP",
           "namespace": "LaMevaAdre?aIP",
           "version": "1.0"
       }

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ðs admesos a manifest.json (premeu al nom del par¨¤metre per veure una »å±ð²õ³¦°ù¾±±è³¦¾±¨® detallada):

manifest_version

Versi¨® manifest del ³¾¨°»å³Ü±ô. Actualment, la ±¹±ð°ù²õ¾±¨® suportada ¨¦²õ la 2.0.

Tipus: Doble

Exemple:

"manifest_version": 2.0

id

ID del ³¾¨°»å³Ü±ô. Ha de ser ¨²nic. Per evitar futurs conflictes de noms, es recomana emprar el prefix per als ³¾¨°»å³Ü±ôs (nom de l'autor o de l'empresa, o qualsevol altre). Per exemple, si un ³¾¨°»å³Ü±ô ¨¦²õ un exemple per a les lli?ons i el nom del ³¾¨°»å³Ü±ô ¨¦²õ "El meu ³¾¨°»å³Ü±ô", l'ID ser¨¤ "example_my_module".

Tipus: Cadena

Exemple:

"id": "example_my_module"

nom

Nom del ³¾¨°»å³Ü±ô que es veur¨¤ a la secci¨® Administraci¨®.

Tipus: Cadena

Exemple:

"nom": "El meu ³¾¨°»å³Ü±ô&±ç³Ü´Ç³Ù;

namespace

Namespace PHP per els ³¾¨°»å³Ü±ôs de classes.

Tipus: Cadena

Exemple:

"namespace": "ClockWidget"

±¹±ð°ù²õ¾±¨®

Versi¨® del ³¾¨°»å³Ü±ô, que es veur¨¤ a la secci¨® Administraci¨®.

Tipus: Cadena

Exemple:

"±¹±ð°ù²õ¾±¨®": "1.0"

tipus

Tipus del ³¾¨°»å³Ü±ô. Obligatori per ginys i ha de ser igual a "giny".

Tipus: Cadena

Per defecte: "module"

Exemple:

"tipus": "giny"

accions

Accions per registrar-se al ³¾¨°»å³Ü±ô. Cal definir la clau d'objecte classe per a cada acci¨®, les altres claus d'acci¨® s¨®n opcionals.

Tipus: Objecte

Tecles d'objecte admeses si tipus ¨¦²õ ³¾¨°»å³Ü±ô:

• write.your.action.name (objecte) - nom de l'acci¨®, s'ha d'escriure en min¨²scula [a-z], separant les paraules amb punts. Admet les tecles:
  • classe (cadena; obligatori) - nom de la classe d'acci¨®.
  • »å¾±²õ±è´Ç²õ¾±³¦¾±¨® (cadena) - disseny d'acci¨®. Valors admesos: layout.json, layout.htmlpage (per defecte), null.
  • layout (cadena) - vista d'acci¨®.

Exemple:

"actions": {
           "module.example.list": {
               "class": "ExampleList",
               "view": "example.list",
               "layout": "layout.htmlpage"
               }
           }

Tecles d'objecte admeses si tipus ¨¦²õ giny:

• widget.{id}.view (objecte) - nom de fitxer i classe per a la vista de widget. Substitu?u {id} pel valor id del giny (per exemple, widget.example_clock.view). Admet les tecles:
  • classe (cadena; obligatori) - nom de classe d'acci¨® per al mode de ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® de widgets per ampliar la classe CControllerDashboardWidgetView predeterminada. El fitxer font de la classe s'ha d'ubicar al directori accions.
  • ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® (cadena) - vista de giny. S'ha d'ubicar al directori views. Si el fitxer de ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® ¨¦²õ widget.view.php, que s'espera per defecte, aquest par¨¤metre potser s'omet. Si empreu un nom diferent, especifiqueu-lo aqu¨ª.
• widget.{id}.edit (objecte) - nom del fitxer per a la vista de ³¦´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨® del giny. Substitu?u {id} pel valor id del giny (per exemple, widget.example_clock.edit). Admet les claus:
  • classe (cadena; obligatori) - nom de la classe d'acci¨® per al mode de ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® de ³¦´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨® del widget. El fitxer font de la classe s'ha d'ubicar al directori actions.
  • ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® (cadena) - vista de ³¦´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨® del widget. S'ha d'ubicar al directori views. Si el fitxer de ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® ¨¦²õ widget.edit.php, que s'espera per defecte, aquest par¨¤metre potser s'omet. Si empreu un nom diferent, especifiqueu-lo aqu¨ª.

Exemple:

"actions": {
           "widget.tophosts.view": {
               "class": "WidgetView"
           },
           "widget.tophosts.column.edit": {
               "class": "ColumnEdit",
               "view": "column.edit",
               "layout": "layout.json"
           }
       }

actius

Estils CSS i fitxers JavaScript a incloure.

Tipus: Objecte

Claus d'objectes admeses:

• css (matriu) - Fitxers CSS a incloure. Els fitxers s'han d'ubicar a assets/css.
• js (matriu) - Fitxers JavaScript a incloure. Els fitxers s'han d'ubicar a assets/js.

Exemple:

"assets": {
           "css": ["widget.css"],
           "js": ["widget.js"]
       }

autor

²Ñ¨°»å³Ü±ô autor. L'autor es veur¨¤ a la secci¨® Administraci¨®.

Tipus: Cadena

Exemple:

"autor": &±ç³Ü´Ç³Ù;´¡³Ü²õ¾±¨¤²õ March"

³¦´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨®

Valors per defecte per a les opcions del ³¾¨°»å³Ü±ô. L'objecte pot contindre qualsevol clau personalitzada. Si s'especifiquen, aquests valors s'escriuran a la base de dades durant el registre del ³¾¨°»å³Ü±ô. Les variables noves que s'afegeixin m¨¦²õ tard s'escriuran a la primera crida. Despr¨¦²õ, els valors de les variables nom¨¦²õ es poden canviar directament a la base de dades.

Tipus: Objecte

Exemple:

"config": {
           "username": "Admin",
           "password": "",
           "auth_url": "https://example.com/auth"
       }

»å±ð²õ³¦°ù¾±±è³¦¾±¨®

²Ñ¨°»å³Ü±ô »å±ð²õ³¦°ù¾±±è³¦¾±¨®.

Tipus: Cadena

Exemple:

"»å±ð²õ³¦°ù¾±±è³¦¾±¨®": &±ç³Ü´Ç³Ù;´¡¾±³æ¨° ¨¦²õ un giny de rellotge."

giny

°ä´Ç²Ô´Ú¾±²µ³Ü°ù²¹³¦¾±¨® del giny. S'empra si el tipus s'estableix a giny.

Tipus: Objecte

Claus d'objecte admeses:

• nom (cadena) - s'empra a la llista de ginys i com a cap?alera predeterminada. Si ¨¦²õ buit, s'emprar¨¤ el par¨¤metre "nom" del ³¾¨°»å³Ü±ô.

• mida (objecte) - dimensions del giny predeterminades. Admet les claus:

  • amplada (enter) - amplada del giny predeterminada.
  • al?ada (enter) - al?ada del giny predeterminada.

• form_class (cadena) - formulari de classe amb camps de giny. S'ha d'ubicar al directori include. Si la classe ¨¦²õ WidgetForm.php, que s'espera per defecte, aquest par¨¤metre potser s'omet. Si empreu un nom diferent, especifiqueu-lo aqu¨ª.

• js_class (cadena) - nom d'una classe JavaScript per al mode de ±¹¾±²õ³Ü²¹±ô¾±³Ù³ú²¹³¦¾±¨® de ginys per ampliar la classe CWidget predeterminada. La classe es carregar¨¤ amb el tauler. El fitxer font de la classe s'ha d'ubicar al directori assets/js. Veieu tamb¨¦: actius.

• use_time_selector (boole¨¤): determina si el giny requereix un selector de temps del tauler. Valors admesos: cert, fals (per defecte).

• refresh_rate (enter) - taxa d'actualitzaci¨® del giny en segons (per defecte: 60).

Exemple:

"widget": {
           "name": "",                       
           "template_support": true,      
           "size": {                       
               "width": 12,
               "height": 5
           },
           "form_class": "WidgetForm", 
           "js_class": "CWidget",         
           "use_time_selector": false,    
           "refresh_rate": 60             
       }

url

Enlla? a la »å±ð²õ³¦°ù¾±±è³¦¾±¨® del ³¾¨°»å³Ü±ô. Per als ginys, aquest enlla? s'obrir¨¤ en fer clic a la icona d'ajuda a la finestra Afegir giny o Editar giny. Si url no ¨¦²õ especificat, fent clic a la icona d'ajuda s'obrir¨¤ la p¨¤gina general Ginys del tauler.

Tipus: Cadena

Exemple:

"url": "http://exemple.cat"