Verbeterd Override management
From Joomla! Documentation
Verbeterd Override management
Documentatie
Inleiding
Dit project voegt een updatecontrole functie toe aan Joomla. Hierdoor ontvangt de gebruiker een melding wanneer, tijdens een update, een core-bestand is aangepast waarvoor een override is gemaakt in hun template. Om veiligheid- en functionaliteitsproblemen te voorkomen kunnen zij hun overrides aanpassen voor iemand het in de gaten heeft.
Project repository link: https://github.com/joomla-projects/gsoc18_override_management
Krijg een voorsprong door Verbeterd override management
Opmerkingen
Wanneer u nog geen ervaring hebt in Joomla ontwikkeling en nog niet zo veel weet over de Template manager en overrides, lees:
Nu u bekend bent met hoe de Templatebeheer werkt en de verschillende override types in Joomla kunnen we de project kenmerken bespreken.
- Ondersteunde overrides
- Verschillen weergave
- Override - Quick Icon notificatie Plug-in
- Installeren - Override Plug-in
- Geüpdatet - Override Geschiedenis
Soorten overrides die ondersteund worden door deze functie
Niet ondersteund worden: Alternatieve Layouts (waarbij de bestandsnaam wordt gewijzigd), js en css overrides. Deze functie ondersteund de override bestanden die in de lijst staan in de Maak Overrride tab. Voorbeelden:
Verschillen weergave tussen core en override bestanden
Deze functie toont de verschillen tussen het core bestand en het override bestand. Wanneer u een override bestand opent om aan te passen, ziet u twee knoppen of schakelaars in de rechterbovenhoek van de pagina wanneer het core bestand is afgesloten.
Knoppen zoals deze:
Hier kunt u bepalen of u de vergelijkingsweergave of weergave van het core bestand wilt tonen of verbergen. In de volgende afbeelding ziet u de locatie van het core bestand en de vergelijkingsweergave in het template beheer.
U kunt het core bestand niet wijzigen.
Hoe de vergelijkingsweergave werkt
Wanneer u op een override bestand klikt om dit aan te passen wordt de functie methode getCoreFile aangeroepen. Deze krijgt twee parameters path van het override bestand in de template mee. Voorbeeld: /html/layouts/joomla/form/field/user.php en de client path van het bestand waar het bij hoort Site of Administrator. Vervolgens wordt, op basis van deze informatie, het pad naar het core bestand terug gegeven als het bestaat. Voor het tonen van de vergelijkingsweergave tussen het core- en het override bestand wordt de jsdiff bibliotheek gebruikt.
Override - Quick Icon notificatie Plug-in
Een quick icon notificatie plug-in die de notificatie in het Controlepaneel toont en aangeeft hoeveel geüpdatete overrides er voor alle templates zijn. Wanneer er updates zijn voor overrides zal de quick icon er ongeveer uitzien zoals in het voorbeeld hieronder:
Wanneer u op het icoon klikt wordt u naar de Templates gestuurd waar een lijst met alle templates wordt getoond met hun omschrijving. U zult een nieuwe kolom zien met de titel Overrides. Hier wordt het aantal override updates weergegeven die bij die template horen. Als er niets geüpdatet is in de template override ziet u een Up-to-date label.
Hoe de quick icon werkt
Het maakt een AJAX oproep naar TemplateController.php wat de informatie teruggeeft en een notificatie laat zien wanneer er updates zijn van overrides.
Waarschuwing
De quick icon notificatie plug-in werkt alleen en kan alleen data ophalen wanneer de installer/override plug-in geactiveerd is. Wanneer installer/override is uitgeschakeld zult u deze foutmelding in het quick icoon zien.
Wanneer u op het quick icoon klikt wordt u doorgestuurd naar de installer/override plug-in instellingen waar u deze kunt aanpassen.
Installeren - Override Plug-in
Deze plug-in is het belangrijkste onderdeel van deze functie. Het maakt het mogelijk de juiste geüpdatete overrides te vinden tijdens de installatie of update van de extensie en de Joomla update.
Hoe installeren override plug-in werkt
De plug-in werkt op 6 gebeurtenissen:
- onExtensionBeforeUpdate
- onExtensionAfterUpdate
- onInstallerBeforeInstaller
- onInstallerAfterInstaller
- onJoomlaBeforeUpdate
- onJoomlaAfterUpdate
Welke alle override core bestanden md5_file() hash verzamelt voor en na de update en vervolgens beide waardes vergelijkt. Vervolgens vindt het het correcte gewijzigde of bijgewerkte bestand en slaat die infromatie op in de #__templates_overrides tabel.
Geüpdatet - Override geschiedenis
U kunt dit vinden op de Geüpdatet bestanden tab in een template. Het is een lijstweergave die de geüpdatete overrides laat zien die bij de template horen.
Er zijn veel opties beschikbaar om deze lijst te beheren. U kunt de status van de override bestandsgeschiedenis zien, de aanmaakdatum, datum van de wijziging en update acties als: of het hoort bij Joomla update, extensie update of een extensie installatie.
Operkingen
Deze informatie is alleen een geschiedenis, dus als u de bijgewerkte overrides hebt aangevinkt, kunt u de geschiedenis verwijderen wanneer deze niet meer nodig is.
Bekijk de video uitleg en leer hoe u deze functie kunt gebruiken.