> For the complete documentation index, see [llms.txt](https://docs.chamilo.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.chamilo.org/3.x/pt-br/guia-do-desenvolvedor/developer-guide/plugins/plugin-architecture.md).

# Arquitetura de Plugins

## Localização dos Plugins

Os plugins são armazenados em `public/plugin/`. Cada plugin possui o seu próprio diretório:

```
public/plugin/
├── Bbb/                    # BigBlueButton integration
├── Zoom/                   # Zoom integration
├── Onlyoffice/             # OnlyOffice document editing
├── XApi/                   # xAPI/Tin Can
├── ...                     # bundled plugins ship under public/plugin/
```

## Estrutura do Plugin

Um diretório típico de plugin contém:

```
public/plugin/MyPlugin/
├── plugin.php              # REQUIRED — assigns $plugin_info
├── install.php             # Installation script
├── uninstall.php           # Uninstallation script
├── index.php               # Region rendering entry point (if applicable)
├── admin.php               # Admin interface (optional)
├── lang/                   # Translation files (locale codes: en_US.php, fr_FR.php, …)
├── src/
│   ├── MyPluginPlugin.php        # Main plugin class (extends Plugin)
│   ├── Entity/                   # Doctrine entities (auto-discovered)
│   ├── Repository/               # Doctrine repositories
│   └── EventSubscriber/          # Symfony event subscribers (auto-registered)
├── templates/              # Twig templates
└── resources/              # CSS/JS assets
```

## Classe do Plugin

Cada plugin estende a classe base `Plugin` (`public/main/inc/lib/plugin.class.php`) e segue o padrão singleton:

```php
class MyPluginPlugin extends Plugin
{
    protected function __construct()
    {
        $settings = ['api_key' => 'text', 'enabled' => 'boolean'];
        parent::__construct('1.0', 'Author Name', $settings);
    }

    public static function create(): static
    {
        static $instance = null;
        return $instance ??= new static();
    }
}
```

### Propriedades-chave da Classe

| Propriedade        | Tipo  | Efeito                                          |
| ------------------ | ----- | ----------------------------------------------- |
| `$isCoursePlugin`  | bool  | Registra o plugin como uma ferramenta de curso  |
| `$isAdminPlugin`   | bool  | Adiciona uma página de interface administrativa |
| `$isMailPlugin`    | bool  | Integra-se ao sistema de e-mail                 |
| `$addCourseTool`   | bool  | Adiciona um ícone à página inicial do curso     |
| `$course_settings` | array | Define campos de configuração por curso         |

## Ciclo de Vida do Plugin

1. **Instalação** — O administrador ativa o plugin, o que executa `install.php`
2. **Configuração** — As configurações são definidas e gerenciadas pelo painel administrativo; armazenadas em `access_url_rel_plugin` (suporta multi-tenant)
3. **Execução** — O plugin injeta conteúdo nas regiões de exibição ou reage a eventos da plataforma
4. **Desativação** — O plugin é desabilitado, mas os seus dados são preservados
5. **Desinstalação** — Executa `uninstall.php` para limpar dados e tabelas

## Regiões de Exibição

Os plugins injetam HTML em 18 regiões predefinidas do frontend Vue, sobrescrevendo `renderRegion()`:

```php
public function renderRegion(string $region): string
{
    if ('footer_left' !== $region) {
        return '';
    }
    return '<p>My Plugin footer content</p>';
}
```

Regiões disponíveis: `content_bottom`, `content_top`, `course_tool_plugin`, `footer_center`, `footer_left`, `footer_right`, `header_center`, `header_left`, `header_main`, `header_right`, `login_bottom`, `login_top`, `main_bottom`, `main_top`, `menu_administrator`, `menu_bottom`, `menu_top`, `pre_footer`.

## Integração com Symfony

### Event Subscribers

Arquivos que terminam em `EventSubscriber.php` colocados em `src/EventSubscriber/` são registrados automaticamente via `PluginEventSubscriberPass`. Eles implementam `EventSubscriberInterface` e reagem a eventos definidos em `src/CoreBundle/Event/Events.php`.

Como a classe do plugin (`MyPluginPlugin`) não é um serviço Symfony, ela não pode ser injetada por autowiring no construtor do subscriber. Utilize o singleton `create()`:

```php
class MyPluginEventSubscriber implements EventSubscriberInterface
{
    private MyPluginPlugin $plugin;

    public function __construct()
    {
        $this->plugin = MyPluginPlugin::create();
    }
}
```

### Entidades Doctrine

Entidades Doctrine colocadas em `src/Entity/` são descobertas automaticamente por `PluginEntityPass`. Utilize atributos do PHP 8 para o mapeamento. O namespace deve seguir `Chamilo\PluginBundle\{PluginName}`. Use prefixos de nome de tabela únicos (por exemplo, `my_plugin_*`) para evitar colisões.

### Serviço PluginHelper

Para acessar o estado de um plugin a partir de serviços Symfony do núcleo, injete `PluginHelper` em vez de instanciar a classe do plugin diretamente:

```php
use Chamilo\CoreBundle\Helpers\PluginHelper;

class SomeService
{
    public function __construct(private readonly PluginHelper $pluginHelper) {}

    public function doSomething(): void
    {
        if ($this->pluginHelper->isPluginEnabled('MyPlugin')) {
            $value = $this->pluginHelper->getPluginSetting('MyPlugin', 'api_key');
        }
    }
}
```

Métodos disponíveis:

| Método                                               | Finalidade                                                                                    |
| ---------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `isPluginEnabled(string $name): bool`                | Verificar se um plugin está instalado e ativo para a URL de acesso atual                      |
| `loadLegacyPlugin(string $name): ?object`            | Instanciar e retornar o singleton do plugin                                                   |
| `getPluginSetting(string $name, string $key): mixed` | Ler o valor de uma única configuração do plugin                                               |
| `getPluginOverrides(string $name): array`            | Obter as substituições de `plugin.yaml` (padrões + específicas da URL de acesso) de um plugin |

## Referências de arquivos do núcleo

| Arquivo                                   | Finalidade                  |
| ----------------------------------------- | --------------------------- |
| `public/main/inc/lib/plugin.class.php`    | Classe base de plugin       |
| `public/main/inc/lib/plugin.lib.php`      | Gerenciador de plugins      |
| `src/CoreBundle/Entity/Plugin.php`        | Entidade Doctrine de plugin |
| `src/CoreBundle/Helpers/PluginHelper.php` | Serviço PluginHelper        |
| `src/CoreBundle/Event/Events.php`         | Constantes de eventos       |
| `public/plugin/HelloWorld/`               | Plugin de exemplo mínimo    |
| `public/plugin/TopLinks/`                 | Plugin de exemplo simples   |