Zazu

mvc-cms framework


Plugin

Posted 2014-11-10 14:28 in Documentation by Admin

Definition av plugin

Ett plugin är något som kan existera i något annat som till exempel en region, en post eller ett tema. Det har initialt ingen egen vy som kan visas utan är beroende av att finnas som en den del av något annat

Flöde

  1. När ett plugin installeras måste dess namn läggas till i databasens tabell "plugins".
  2. I ett inlägg, en region eller tema-fil kan man sedan använda ett plugin genom att skriva ${plugin-name} där plugin-name motsvarar namnet på pluginet.
  3. När man går in på en sida där inlägget, regionen eller temat används så kollar cms-controller upp om inlägget innehåller ${plugin-name} och i så fall om pluginet finns registrerat.
    • Gör det det så laddas dess kontroller-fil in från mappen "plugins/plugin-name" och anropar dess kontroller och dess index-funktion, samt skickar med ramverkets config som parameter.
    • Finns det inte så hanteras texten inte som ett plugin.
  4. Det är också möjligt att definiera vilken funktion i kontrollern för pluginet som ska anropas genom att skriva ${plugin-name#plugin-funtion}.
  5. Om något grafiskt ska visas med hjälp av pluginet så måste den anropade funktionen returnera text, html eller javascript.
  6. ${plugin-name#plugin-funtion} i inlägget/regionen/temat ersätts därefter med det returnerade värdet.

Class diagram

Posted 2015-10-31 11:02 in Documentation by Admin

Class diagram