A documentação dos módulos é válida a partir da versão 2.3.2

Os módulos GrowCRM usam a base de código do framework PHP do Codeigniter, como controladores, modelos, arquivos de linguagem, bibliotecas, visualizações, etc. Se você já estiver familiarizado com o framework Codeigniter, poderá começar facilmente. Caso contrário, recomendamos que você visite o site oficial   e a documentação.

Além disso, adicionamos um monte de funções auxiliares, recursos, ganchos de ação e filtros que tornarão o processo de criação e integração de módulos mais fácil.

Localização dos módulos e Nome

Todos os módulos devem ser adicionados na pasta módulos  no diretório raiz onde o GrowCRM está instalado e cada módulo deve ter um nome de pasta exclusivo e um arquivo init com o mesmo nome da pasta do seu módulo.

Criando seu primeiro módulo

Antes de começar a desenvolver um módulo, certifique-se de definir o modo de desenvolvimento para ver quaisquer erros e avisos de descontinuação de funções/ganchos.

Para começar e criar seu primeiro módulo, siga as etapas abaixo.

• Navegue até a instalação do GrowCRM e abra o diretório módulos .
• Crie um novo diretório e nomeie-o com o nome do seu módulo (por exemplo,sample_module).
• Crie um novo PHP arquivo com o mesmo nome do diretório do módulo, neste caso, sample_module.php, este arquivo atuará como “arquivo init” para este módulo.

Neste caso, o módulo já foi criado e registrado, mas ainda não faz nada nem tem nenhum nome ou descrição adicionada. Adicionaremos os metadados do módulo, como nome, descrição, URL e autor, por meio de um comentário em bloco PHP, que atuará como cabeçalhos do módulo.

Os cabeçalhos do módulo devem ser adicionados somente no arquivo do módulo init.

Agora abra o arquivo sample_module.php que criamos antes e adicione o seguinte comentário no topo do arquivo:

Após salvar o arquivo, navegue até a área de administração do GrowCRM em Configuração -> Módulos e você poderá ver seu módulo listado.

O comentário funcionará como um cabeçalho de arquivo para o módulo. Você deve consultar o guia de cabeçalhos de arquivo se quiser se familiarizar mais.

Certifique-se de sempre adicionar o cabeçalho Nome do Módulo

É muito importante certificar-se de que o nome da pasta do seu módulo e o nome do arquivo .php sejam iguais, caso contrário, seu módulo não será exibido na lista de módulos

Ganchos básicos

Você precisará implementar alguns ganchos básicos ao criar um novo módulo, como register_activation_hook(), register_deactivation_hook() e register_uninstall_hook()

Se você conhece o WordPress, provavelmente conhece o trabalho que esses ganchos fazem.

Adicionando ganchos

Você pode adicionar ganchos nos arquivos .php do seu módulo com:

Você pode adicionar seus próprios filtros e ações para usá-los também na implementação do seu módulo. Adicionar ações e filtros ajudará outros módulos a interagir com o seu módulo e estender as funcionalidades do módulo.

Funções personalizadas de prefixo

Você deve sempre prefixar quaisquer funções e classes personalizadas para evitar conflitos com funções ou classes padrão do GrowCRM ou com quaisquer outros módulos.

Usando a instância do Codeigniter em arquivos de módulo

Provavelmente você vai querer usar a instância do framework Codeigniter no seu arquivo init do módulo ou em qualquer outro arquivo de módulo que não estenda as classes base do framework.

$this, funciona apenas dentro dos seus controladores, modelos ou visualizações.

Você pode fazer isso em qualquer lugar dos seus arquivos com o seguinte código:

Primeiro, atribua o objeto CodeIgniter a um variável:

Depois de atribuir o objeto a uma variável, você usará essa variável em vez de $this

Prefixo do banco de dados

A partir da versão 2.3.0, o GrowCRM tem a opção de definir um prefixo personalizado para tabelas de banco de dados.

O prefixo de tabela padrão no GrowCRM é tbl

Você deve sempre usar nossa função personalizada db_prefix() para obter o prefixo do banco de dados ao consultá-lo. Isso garantirá que, caso o usuário altere o prefixo do banco de dados, seu módulo ainda funcionará com o novo prefixo do usuário.

Aqui está um exemplo do módulo Acompanhamento de Metas arquivo install.php.

Criar opções de módulo

O GrowCRM tem uma tabela no banco de dadosopções para armazenar várias configurações para uso interno e configurações que são usadas em recursos. Desenvolvemos funções PHP personalizadas que realizarão consultas para buscar opções no banco de dados.

Os nomes das opções são strings e devem ser exclusivos para que não entrem em conflito com o GrowCRM ou outros módulos.

$name
Obrigatório (string). O nome da opção a ser adicionada. Certifique-se de que seja único e prefixado com E.q. o nome do seu módulo.

$value
O valor da opção (string)

$autoload
(inteiro) 1 ou 0
Se esta opção deve ser carregada automaticamente com todas as outras opções, se você estiver usando a opção por muito tempo na exibição, o melhor é carregá-la automaticamente para evitar várias consultas para obter a opção. O padrão é 1

Lembre-se de que a função add_option não criará a opção se o nome da opção já existir na tabela de opções.

Recupere uma opção do banco de dados, $option_name (string) o nome da sua opção.

A função update_option  atualizará o valor da opção. Desde a versão 2.3.3, quando você chama update_option, se a opção não existir, o GrowCRM criará essa opção.