Plugin Zammad para MapasCulturais

Plugin que integra o chat Zammad ao MapasCulturais, permitindo atendimento ao usuário em tempo real através de um widget de chat.

Visão Geral

O Zammad é uma plataforma de helpdesk e suporte que oferece chat ao vivo. Este plugin permite incorporar o widget de chat do Zammad em todas as páginas do MapasCulturais, exceto em páginas incorporadas (embeds).

---

Configuração

Método 1: Arquivo de Configuração

No arquivo de configuração do MapasCulturais (geralmente config.php):

'plugins' => [
    'Zammad' => [
        'namespace' => 'Zammad',
        'config' => [
            'enabled' => true,
            'url' => 'https://seu-servidor-zammad.com/assets/chat/chat.min.js',
            'background' => '#00bcd4',
            'title' => 'Dúvidas? Fale conosco',
            'chatId' => 1,
            'instacacão' => 'mapasculturais.example.com',
            'estado' => 'ES'
        ]
    ]
]

Método 2: Variáveis de Ambiente

Adicione no arquivo .env:

ZAMMAD_ENABLED=true
ZAMMAD_URL=https://seu-servidor-zammad.com/assets/chat/chat.min.js
ZAMMAD_BACKGROUD_COLLOR=#00bcd4
ZAMMAD_TITLE="Dúvidas? Fale conosco"
ZAMMAD_CHAT_ID=1
ZAMMAD_INSTACACAO=mapasculturais.example.com
ZAMMAD_ESTADO=ES

Parâmetros de Configuração

Parâmetro	Variável de Ambiente	Valor Padrão	Descrição
enabled	ZAMMAD_ENABLED	false	Habilita ou desabilita o plugin
url	ZAMMAD_URL	null	URL do script JavaScript do Zammad (obrigatório)
background	ZAMMAD_BACKGROUD_COLLOR	#121212	Cor de fundo do widget (hexadecimal)
title	ZAMMAD_TITLE	Duvidas? fale conosco	Título exibido no widget do chat
chatId	ZAMMAD_CHAT_ID	1	ID do chat configurado no Zammad
instacacão	ZAMMAD_INSTACACAO	meu_site.com.br	Identificação da instalação/origem
estado	ZAMMAD_ESTADO	meu_estado	Identificação do estado

---

Como Funciona

Estrutura do Plugin

1. Plugin.php - Classe Principal

Método __construct():

• Define as configurações padrão do plugin
• Mescla valores de variáveis de ambiente com valores padrão
• Permite sobrescrever configurações via arquivo de config

Método _init():

• Registra um hook no evento mapasculturais.body:after
• Injeta o widget de chat antes do fechamento da tag </body>
• Não exibe o chat em páginas incorporadas (embeds)
• Só renderiza se o plugin estiver habilitado (enabled = true)

Método register():

• Reservado para futuras implementações

2. layouts/parts/app-zammad.php - Template

• Verifica se a URL do Zammad está configurada
• Carrega a biblioteca jQuery (versão 2.1.4)
• Carrega o script JavaScript do Zammad
• Inicializa o widget ZammadChat com as configurações:
  • Título do chat
  • Cor de fundo
  • Tamanho da fonte (12px)
  • ID do chat
  • Origem e estado para identificação

Fluxo de Execução

1. Inicialização: MapasCulturais carrega o plugin e executa o construtor
2. Registro de Hook: Método _init() registra hook mapasculturais.body:after
3. Renderização: Quando uma página é carregada:
   • Verifica se NÃO é uma página embed
   • Verifica se o plugin está habilitado
   • Renderiza o template app-zammad.php
4. Exibição: Widget de chat é exibido na página

---

Dependências

• MapasCulturais: Framework base (compatível com hooks)
• jQuery: Biblioteca JavaScript (≥ 2.1.4)
• Servidor Zammad: Configurado e acessível via URL
• Script Zammad: Arquivo JavaScript disponível na URL configurada

---

Observações Importantes

• ⚠️ O plugin sempre carrega o jQuery 2.1.4, mesmo que já esteja presente no sistema
• ⚠️ O título no template está hardcoded e não usa a configuração $title do Plugin.php
• ⚠️ Existem erros de digitação nas variáveis: BACKGROUD_COLLOR e instacacão
• ✅ O chat não aparece em páginas embed para evitar conflitos
• ✅ É necessário configurar a URL do Zammad para o plugin funcionar

---

Licença

Veja o arquivo LICENSE incluído neste diretório.