J4.x:Gestión de Modificaciones Mejorada
From Joomla! Documentation
Revision as of 09:40, 17 December 2019 by Pdavila2709 (talk | contribs)
Gestión de Modificaciones Mejorada
Documentación
Introducción
Este proyecto agrega una función de comprobación de actualizaciones a Joomla para que si el archivo principal modificado de una plantilla se cambia o actualiza, se notifique al usuario de que uno de los archivos principales de su plantilla se modificó con la actualización, a fin de evitar problemas de seguridad o de funcionalidad, y pueda ajustar su anulación antes de que alguien pueda notarlo.
Enlace al repositorio del proyecto: https://github.com/joomla-projects/gsoc18_override_management
Obtener una ventaja inicial con la Gestión de Modificaciones Mejorada
Notas
Si eres nuevo en el desarrollo de Joomla, y no sabes mucho acerca del Gestor de Plantillas y las Modificaciones, por favor lee:
Ahora, debes familiarizarte con el uso del Gestor de Plantillas y los tipos de Modificaciones en Joomla. Después, veamos las características de este proyecto.
- Modificaciones Admitidas
- Vista Diferente
- Modificación - Complemento de Notificación de Icono Rápido
- Instalador - Complemento de Modificación
- Actualizado - Histórico de Modificación
Tipos de modificaciones soportados por esta característica
No es compatible con el Diseño Alternativo en el que el nombre de archivo se renombra a otra cosa y se modifica js, css. Esta característica admite los archivos modificados listados en la pestaña Crear Modificación. Ejemplo:
Vista diferente entre el núcleo y los archivos modificados
Esta característica muestra la diferencia entre el archivo del núcleo y el archivo modificado. Cuando abres cualquier archivo modificado para editar, verás dos botones o conmutadores en la esquina superior derecha de la página, si se sale del archivo principal de ese archivo.
Botones como este:
Aquí puedes controlar la opción de ocultar y mostrar la vista de diferencias y la vista de archivos del núcleo. En la siguiente imagen, puedes ver la ubicación del archivo del núcleo y la vista de diferencias en el gestor de plantillas.
No puedes editar el archivo del núcleo.
Cómo funciona la vista de diferencias
Cuando haces clic en cualquier archivo modificado para editarlo, se llama a un método de función getCoreFile que recibe los dos parámetros path del archivo modificado en la plantilla. Ejemplo: /html/layouts/joomla/form/field/user.php y la ruta cliente del archivo si pertenece al Site o Administrator. Luego, en función de esta información, devuelve la ruta del archivo principal si existe. Para mostrar la diferencia entre el núcleo y los archivos modificados, utilizamos la biblioteca jsdiff.
Modificación - Plugin de Notificación de Icono Rápido
Un plugin de notificación de icono rápido muestra la notificación en el cpanel, y muestra las modificaciones totales actualizadas de todas las plantillas. Cuando se actualizan las modificaciones, el ícono rápido muestra algo como en el siguiente ejemplo:
Cuando haces clic en él, te redireccionará a Plantillas, que contiene la lista de tus plantillas con su descripción. Verás un nuevo encabezado de columna Modificaciones que muestra el número de modificaciones actualizadas que pertenecen a la plantilla. Si no se ha actualizado nada en la modificación de la plantilla, se mostrará un símbolo Actualizado.
Cómo funciona un icono rápido
Realiza una llamada AJAX al TemplateController.php que devuelve la información y muestra una notificación cuando se actualizan dichas modificaciones.
Advertencia
El plugin de notificación de iconos rápidos solo funciona o puede recuperar datos si el plugin installer/override está habilitado. Si installer/override está deshabilitado, verás este mensaje de error en el icono rápido.
Si haces clic en el icono rápido, serás redirigido a la configuración del plugin installer/override donde puedes editar la configuración de dicho plugin.
Instalador - Plugin de Modificación
Este plugin es la parte principal de esta función. Permite encontrar las modificaciones correctas actualizadas durante la instalación o actualización de la extensión y la actualización de Joomla.
Cómo funciona el plugin de modificación del instalador
Este plugin funciona en 6 eventos:
- onExtensionBeforeUpdate
- onExtensionAfterUpdate
- onInstallerBeforeInstaller
- onInstallerAfterInstaller
- onJoomlaBeforeUpdate
- onJoomlaAfterUpdate
El cual recopila todas las anulaciones del hash del archivo principal md5_file() antes de la actualización y después de la actualización, luego compara ambos valores. Después, busca el archivo correcto modificado o actualizado. Y almacena información en la tabla #__templates_overrides.
Actualizado - Histórico de Modificación
Puedes acceder a esto desde la pestaña Archivos Actualizados en una plantilla. Esta es una vista de lista que muestra la lista de modificaciones actualizadas que pertenecen a esa plantilla.
Hay muchas opciones disponibles para administrar la lista. Donde puedes verificar el estado del historial de modificación de archivos, ya sea que esté marcado o no, la fecha de creación, la fecha de cambio y la acción de actualización como: si pertenece a (Actualización de Joomla, Actualización de extensión o Instalación de extensión).
Nota
Esta información es solo historia, por lo que si marcaste los cambios de modificación actualizados, puedes eliminar el historial, pues ya no es necesario.
Mira el siguiente video tutorial para aprender cómo utilizar esta característica.