Descubra como criar e instalar plugins no Moodle para otimizar suas tarefas
No universo open source, Moodle pode ser considerado um sinônimo de plataforma de ensino à distância (EAD) e se tratando de um software de código aberto, cedo ou tarde temos a necessidade de implementar funcionalidades para adequá-los à características únicas de nossas aplicações. Com o objetivo de facilitar essas alterações, sem que fosse preciso alterar o núcleo do sistema, muitas ferramentas fornecem a possibilidade de adicionar pequenos módulos – plugins – e com o Moodle isso não é diferente.
Uma das possibilidades que podemos destacar é poder criar plugins que funcionam como uma espécie de crontab – agendador de tarefas – no próprio Moodle. Pode ser um plugin que verifica uma API para inserir alunos, um plugin que extraí estatísticas em determinados horários ou ainda um plugin que de tempos em tempos sincroniza um pequeno backup.
Antes de mais nada, é preciso entender que a instalação de plugins do Moodle se dá pelos diretórios que foram compactados em um arquivo .zip e então enviados pelo painel ou simplesmente copiado no seu respectivo diretório sem compactação alguma.
Vamos criar um simples plugin chamado pulso que a cada 1 minuto escreve a data atual em um arquivo no diretório /tmp.
Estrutura de diretórios:
Um plugin consiste de um diretório com seu próprio nome e algumas pastas obrigatórias, formando a seguinte árvore:
- pulso
- classes
- task
pulso.php
- db
tasks.php
- lang
- en
local_pulso.php
version.phppulso/version.php
O arquivo da raíz, version.php é um arquivo muito simples contento apenas informações sobre a versão, o tipo e o estado do desenvolvimento:
1 | <?php defined('MOODLE_INTERNAL') || die(); $plugin->version = 2018091000; |
2 | $plugin->requires = 2014051200; |
4 | $plugin->component = 'local_pulso'; |
5 | $plugin->maturity = MATURITY_STABLE; |
pulso/lang/en/local_pulso.php
De baixo para cima, dentro de lang existem subdiretórios para cada linguagem, vamos criar apenas o en, o arquivo precisa ter o tipo do plugin, seguido de um “_” (underscore) e seu nome, neste caso local_pulso.php:
3 | $string['pluginname'] = 'Pulso'; |
4 | $string['pluginname_desc'] = 'Plugin local que grava em arquivo de log.'; |
pulso/db/tasks.php
Dentro do diretório db existe o arquivo tasks.php que definirá os valores que serão inseridos na crontab:
1 | <?php defined('MOODLE_INTERNAL') || die(); $tasks = array( array( 'classname' => 'local_pulso\task\pulso', |
3 | 'minute' => '*/1', # A cada 1 minuto |
pulso/classes/task/pulso.php
No diretório classes/task reside o arquivo pulso.php que controla o que será executado dado o intervalo de tempo especificado. Este arquivo é uma classe e possuí um namespace, ambos estes nomes precisam coincidir com o que foi definido nos arquivos anteriores e com o tipo do plugin:
01 | <?php namespace local_pulso\task; |
02 | defined('MOODLE_INTERNAL') || die(); |
04 | class pulso extends \core\task\scheduled_task { |
05 | # Nome exibido para os admins no painel |
06 | public function get_name() { |
07 | return get_string('pluginname', 'local_pulso'); |
09 | public function execute() { |
10 | file_put_contents('/tmp/pulso.log', date('Y-m-d h:i:s'), FILE_APPEND); |
Verificar instalação
Feito isso você pode copiar a pasta pulso para dentro do diretório local de onde o Moodle foi instalado, por exemplo /var/www/local, caso você não tenha acesso, pode compactar a pasta em formato .zip e instalar pelo painel. Uma vez instalado, você pode verificar se a tarefa está agendada:
1 – Administração do Site
Clicar em administrar site
2 – Servidor
Clicar em servidor
3 – Tarefas Agendadas
Clicar em tarefas agendadas
4 – Verificar pelo plugin na lista
Verificar se tarefa existe
Exemplo no github
Este código pode ser baixado pelo github para melhor compreensão no seguinte repositório: https://github.com/hector-vido/exemplo-task-moodle.
CURSOSCONSULTORIA CONTATO
