Vous êtes sur la page 1sur 7

Introduo

Mdulos de atividades residir no / mod diretrio. Cada mdulo em um subdiretrio separado e consiste de uma srie de " arquivos obrigatrias " e outros arquivos o desenvolvedor vai utilizar. A imagem abaixo um exemplo do mdulo filestructure certificado. Por favor note, qualquer referncia a <modname> nesta documentao deve ser substitudo pelo nome do seu mdulo. Abaixo est um exemplo da estrutura de arquivos para o plugin certificado.

Arquivos padro e suas funes Existem vrios arquivos que so cruciais para o Moodle. Esses arquivos so usados para instalar o mdulo e depois integr-lo no sistema Moodle. Cada arquivo tem uma funo particular, alguns dos arquivos no so necessrios e so criados apenas quando querem usar a funcionalidade que oferece. Abaixo est a lista de arquivos mais comumente usados.

Pasta de backup Este o local para colocar os arquivos que definem como o seu mdulo vai se comportar quando um backup de curso ou de restaurao realizada. Voc pode ter adicionado um monte de informaes para o banco de dados para um mdulo especfico que voc no deseja entrar novamente na restaurao de um curso, este o lugar onde voc define o que deve ser guardado durante um backup e como em seguida, restaurar essas informaes do Moodle backup. Para ler mais sobre isso visite Backup_2.0_for_developers e Restore_2.0_for_developers .

Pasta DB
access.php Este onde voc define quais capacidades o seu plugin ir criar. Note que, se voc adicionar novos recursos para este arquivo aps o seu plugin foi instalado, voc vai precisar aumentar o nmero de verso no seu arquivo version.php (discutido mais tarde), a fim de que eles sejam instalados. Um exemplo do ficheiro inferior a $capabilities = array( 'mod/certificate:addinstance' => array( 'riskbitmask' => RISK_XSS, 'captype' => 'write', 'contextlevel' => CONTEXT_COURSE, 'archetypes' => array( 'editingteacher' => CAP_ALLOW, 'manager' => CAP_ALLOW ), 'clonepermissionsfrom' => 'moodle/course:manageactivities' ), ); Em Moodle 2,3 um novo recurso chamado "addinstance 'foi acrescentado para todos os mdulos principais. Moodle vai olhar para essa capacidade atravs da procura de 'mod / <modname>: addinstance "e se no for criado ento assumido que o usurio no tem esta capacidade, com uma mensagem de depurao que est sendo exibido que a capacidade est faltando. Para evitar essa situao, bom adicionar isso ao seu mdulo. Para mais informaes sobre o que cada atributo em que a matriz capacidades significa visita NEWMODULE_Adding_capabilities .

install.xml Este arquivo usado na instalao do seu mdulo. Ele inclui as tabelas e campos que o mdulo estar criando. Se o mdulo no necessita de quaisquer novas tabelas em seguida, esse arquivo no necessrio. A fim de criar este arquivo XML, por favor, ver XMLDB_editor . Por favor note, no arquivo XML os nomes de tabela so listados sem o prefixo config.php, este usado automaticamente ao criar as tabelas e no precisa ser especificado. Um exemplo deste arquivo est abaixo < ? verso xml = "1.0" encoding = "UTF-8" ?> < XMLDB PATH = "mod / certificados / db" VERSO = "20120925" COMMENT = "file XMLDB para Moodle NOME = "certificado" COMMENT = "Define os certificados" PRXIMO = "certificate_issues" > < CAMPOS > < CAMPO NOME = "primrio" TYPE = "primrias" CAMPOS = "ID" COMMENT = "chave primria para o certificado" /> </ TECLAS > </ TABLE > < nome da tabela = "certificate_issues" COMMENT = "Informaes sobre certificados emitidos" ANTERIOR = "certificado" > < CAMPOS > < CAMPO NOME = "primrio" TYPE = "primrias" CAMPOS = "ID" COMMENT = "chave primria para certificate_issues" PRXIMO = "certificado" /> < KEY O exemplo acima contm a estrutura da tabela e certificate_issues certificado. Cada tabela de campo, e as listas de chave que elemento antes e depois dele (se houver algum presente). Este automaticamente criada pelo XMLDB_editor . Seu mdulo deve sempre ter uma tabela com o mesmo nome que o mdulo com os campos id, nome e curso, como mostrado acima. upgrade.php Este arquivo controla a atualizao do mdulo para coincidir com a verso mais recente. Depois de criar um mdulo e usando extensivamente em seu site (e outros), voc pode querer estender a funcionalidade do seu mdulo. Usando o exemplo do certificado, uma sugesto que foi feito um nico cdigo pode ser gerada para cada certificado emitido e apresentado se um ajuste foi selecionado. Isto requer dois campos de banco de dados, um para armazenar se o criador do certificado tenha escolhido para exibir o cdigo do certificado e outro para armazenar o cdigo real para cada aluno. Este o lugar onde o script upgrade.php se acostume. O arquivo install.xml s executado uma vez, que quando o mdulo instalado pela primeira vez, assim que adicionar essas duas colunas extra para este arquivo no altera a estrutura de banco de dados para os usurios que j instalaram o mdulo. Assim, para realizar a atualizao que voc precisa fazer trs coisas.

1. Adicione as novas colunas para o arquivo install.xml para que todos os usurios que instalarem o mdulo aps este ponto dada a nova estrutura de tabela. 2. Adicione as instrues para os arquivos upgrade.php. 3. Atualizar o nmero de verso no seu arquivo version.php. Neste exemplo, estamos apenas adicionando duas novas colunas no banco de dados, para que possamos usar o XMLDB_editor para alterar o arquivo install.xml e criar o caminho de atualizao. Um exemplo do ficheiro de upgrade.php como se segue funo xmldb_certificate_upgrade ( $ OldVersion = 0 ) { se ( $ OldVersion < 2012091800 ) { / / Adicionar novos campos ao certificado Adicionar novos campos para certificate_issues Certificado savepoint alcanado. upgrade_mod_savepoint ( verdadeiro , 2012091800 , 'certificado' ) ; } } Sempre que voc alterar a verso no seu Moodle mdulo version.php vai olhar para ver se algo precisa ser feito. A verso que armazenado no banco de dados transmitido para a funo _upgrade xmldb_ <modname> como o OldVersion $ varivel neste caso. Neste exemplo, vamos dizer que a verso inicial era 2012091600, uma vez que este inferior a 2012091800 (o novo valor que colocamos no arquivo version.php), vamos executar o cdigo na declarao se que, ento, atualizar a verso armazenada no banco de dados significando isto se declarao nunca executado novamente. Para detalhes mais amplos sobre este consulte Upgrade_API .

Pasta Lang
Isto onde voc armazenar quaisquer cordas que voc vai usar em seu plugin. Cada lngua tem uma pasta especfica que precisa ser criado para que ele seja usado com o seu mdulo. Neste caso vamos usar o idioma Ingls (desde infelizmente, o nico que eu sei). Uma pasta chamada en criado na pasta lang que contm um arquivo chamado <modname>. Php que lista as tradues de sua sequncia. Por exemplo, o mdulo pode ter uma configurao chamada "As preferncias do usurio", ao invs de codificar esse termo em sua forma, voc pode usar um espao reservado que ir recuperar a sequncia apropriada, dependendo do idioma que est sendo utilizado em seu site Moodle. H um espao reservado para os mdulos obrigatrios chamados 'pluginname' que o Moodle vai usar ao listar este mdulo como uma opo para adicionar a um curso e outras vrias pginas. Para manter com os padres do Moodle voc deve ordenar as cordas em ordem alfabtica pelo nome do espao reservado.

$ String [ 'pluginname' ] = 'Certificado' ; $ string [ 'userpreferences' ] = 'As preferncias do usurio " ; Se voc quiser adicionar a traduo em francs que voc crie uma pasta chamada fr e adicione o <modname> arquivo. Php para ele. $ String [ 'pluginname' ] = 'Certificat' ; $ string [ 'userpreferences' ] = 'Preferncias d \ ' utilisateur ' ; Agora, quando se usa 'As preferncias do usurio "a corda, vamos utilizar o get_string funo Moodle vez, que vai ter a seqncia apropriada, dependendo do idioma que est sendo usado. get_string ( 'userpreferences' , 'certificado' ) ;

Pasta Pix
Aqui voc simplesmente armazenar o cone que pretende Moodle para exibir ao lado do nome do seu mdulo. O nome do arquivo deve ser icon.gif e exibido com a resoluo de 16 * 16. Sinta-se livre para usar esta pasta para guardar imagens que voc pode usar. Update: Desde 2,4 arquivos SVG foram introduzidos com todas as atividades de ncleo do Moodle. Por favor, veja Moodle_icons_2.4 para mais detalhes sobre isso. lib.php A lista de funes que so possveis para substituir no lib.php esto listados aqui NEWMODULE_Documentation # lib.php . As essenciais esto listados abaixo function certificate_add_instance($certificate); function certificate_update_instance($certificate); function certificate_delete_instance($id); O <modname> funo _add_instance passado as variveis do arquivo mod_form.php (discutido mais tarde) como um objeto quando voc cria uma atividade e clique em enviar. Este o lugar onde voc pode tomar esses dados, fazer o que quiser com ele e, em seguida, insira-o no banco de dados se desejar. Isso s chamado uma vez quando a instncia mdulo criado pela primeira vez, de modo que este o lugar onde voc deve colocar a lgica para adicionar a atividade. <modname> A funo _update_instance passado as variveis do arquivo mod_form.php como um objeto sempre que voc atualizar um atividade e clique em enviar. O ID da instncia que voc est editando

passado como o exemplo de atributo e pode ser usado para editar os valores existentes no banco de dados para essa instncia. <modname> A funo _delete_instance passado o ID do seu mdulo que voc pode usar para eliminar o registros de todas as tabelas associadas com essa ID. Por exemplo, no mdulo de certificado do id na tabela certificado passado, e ento usado para eliminar o certificado do banco de dados, todas as questes deste certificado e todos os arquivos associados no sistema de arquivos. mod_form.php Este arquivo usado para adicionar / editar um mdulo de um curso. Ele contm os elementos que sero exibidos no formulrio responsvel pela criao / instalao de uma instncia de seu mdulo. A classe no arquivo deve ser chamada mod_ <modname> _mod_form. se ( ! definido ( "MOODLE_INTERNAL ' ) ) { die ( 'Acesso direto a esse script proibido. " ) ; um Moodle

/ / / Deve ser includa a partir de

O exemplo acima no contm o arquivo completo, apenas o suficiente para lhe fornecer uma ideia. Primeiro vamos criar um elemento de texto chamado "nome" que necessrio, este obviamente o nome da instncia. Criei ento outro elemento que armazena se o usurio deseja exibir o cdigo nico emitido para um usurio quando ele receber o certificado ou no com um valor padro de 0 e um boto de ajuda explicando o que esta configurao faz. Os standard_coursemodule_elements funo adicionam os elementos comuns a todos os mdulos, tais como os campos condicionais. A funo add_action_buttons acrescenta os botes de envio e cancelar ao formulrio. Estes dados sero passados para tanto <modname> _add_instance ou _update_instance <modname> dependendo se voc est adicionando uma nova instncia ou atualizao de um atual. Voc tambm pode adicionar a esta forma de validao, assim como qualquer outra forma no Moodle. Para mais informaes sobre como criar formulrios no Moodle S Form_API . index.php Esta pgina usada pelo Moodle ao listar todas as instncias do seu mdulo de que esto em um curso particular com o ID de curso que est sendo passado para este script. O incio da pgina deve conter o seguinte require_once ( '/ config.php /....' ) ; $ id = required_param ( 'id' , PARAM_INT ) ; / Curso / ID

/ / Garante que o curso especificado vlido se ( ! $ curso = $ DB -> get_record ( 'curso' , matriz ( 'id' => $ id ) ) ) { print_error ( 'ID Curso incorreto' ) ; } Ento voc est livre para apresentar a lista de instncias como voc deseja. view.php Quando um curso torna seu layout de pgina e as atividades que gera os links para vlos usando o script view.php, ento as ligaes ser semelhante <wwwrootofyoursite> / mod / <modname> / view.php? Id = 4, onde 4 o mdulo de ID de curso. Para o exemplo de certificado do incio da pgina view.php tem a seguinte aparncia require_once ( '/ config.php /....' ) ; require_once ( 'lib.php' ) ; $ id = required_param ( 'id' , PARAM_INT ) ; ID Mdulo / Curso /

se ( ! $ centmetros = get_coursemodule_from_id ( ' certificado ' , $ id ) ) { print_error ( 'ID curso Mdulo estava incorreto' ) ; } se ( ! curso $ = $ DB -> get_record ( 'curso' , matriz ( 'id' => $ centmetros -> Claro ) )) { print_error ( 'curso

mdulo incorreto ' ) ; } O ID de mdulo do curso passado para este script e definir como $ id, que ento usado para recuperar os dados do curso e as informaes do certificado de mesa que podemos usar mais tarde como ns desejou. version.php O arquivo version.php mantm o controle da verso do seu mdulo, e outros atributos, como a verso do Moodle que requer. Para obter uma lista completa dos atributos consulte version.php .

Vous aimerez peut-être aussi