Documentação

Encontre o que você precisa para explorar o máximo dessa nova experiência de gerenciamento de conteúdo realmente moderna.

Parâmetros dos módulos

Paramentos para criação dos módulos 

name: Nome do módulo, este nome deve ser único; *
title: Título do módulo, que será exibido no ícone do módulo; *
description: Descrição do módulo;  *
version: Versão do módulo, sempre inicia em 1.0.0; *
icon: Ícone do módulo; *
default_field: campo padrão, na listagem dos registros será exibido o valor do campo; *

Fields:

name: nome do campo, este campo deve ser único; *
description: Descrição do campo; *

null
Descrição do campo 

placeholder: Placeholder do campo; 

null
Placeholder é uma dica para o usuário de como preencher o campo 

modal: true ou false, padrão false;  

null
Modal, com opção "true" o usuário seleciona a opção pelo modal 

display: true ou false, padrão true;
readonly: true ou false, padrão false; 
mask: Nesta opção você deve informar a mascará do campo, caso o mesmo necessite. Exemplo, você irá colocar o campo telefone a mascará seria (99) 9999-9999. 
a – Representa um caractere alfabético (AZ, az);
9 – Representa um carácter numérico (0-9);
* – Representa um caractere alfanumérico (AZ, az ,0-9).
type: tipo do campo, neste campo você também poderá fazer o link de dados de outros módulos. 

a) Dados: 

varchar: tipo texto; 
integer: valor inteiro; 
tinyint: valor tinyint 0-999; 
string: tipo texto; 
float: tito ponto flutuante; 
bigint: tipo bigint; 
html: tipo texto, porém exibe para o usuário um editor html;
date: tipo data;
datetime: tipo data e hora;
text: tipo texto;

b) Arquivos:

 

Neste parâmetro também é possível informar que o campo é do tipo arquivo, com o tipo arquivo o sistema possibilita fazer download de arquivos. A estrutura deste parâmetro é file([tipo]):[modo].
[tipo]: image, movie, audio, file;
[modo]: unique, multiple. 
o tipo e modo não são obrigatórios, caso não informe o valor deste parâmetro será equivalente à "file(file):unique"

c) Módulos: 

Com essa tipagem do campo, você pode fazer o relacionamento entre os módulos. Por exemplo, você tem o módulo de seções e notícias, cada notícia possui uma seção (select) ou se for o caso a notícia poderá ter uma ou mais seções (checkbox).  

i) Caso 1: (uma notícia possui uma seção):
secao():select

ii) Caso 2: (uma notícia possui uma seção):
secao():checkbox

secao = nome do módulo de soções 
= o nome do campo contido no módulo de seções entre { } (chaves), pode ter um ou mais campos. Além dos campos você pode colocar outros valores como: : . Neste caso será exibido para o usuário o id, : (dois pontos) e título, imaginemos que o título seja "Seção Exemplo"  e o id seja "1" será exibido "1: Seção Exemplo". 

* Para os campos de módulos podemos utilizar o parâmetro "modal" o que permite o usuário visualizar os dados em "popup" ao invés de ser em um select ou checkbox. 

b) Estáticos:

Com este tipo de campo é possível definirmos valores estáticos para única opção (select) ou múltiplas opções (checkbox). Para este tipo de campo precisamos definir os valores estáticos com o parâmetro "values". Por exemplo, queremos fazer um módulo que possibilite o usuário informar a situação do post da notícia, sendo que ele pode esta Ativo e Inativo. Para isso, utilizamos o tipo opção única "select" e definirmos os valores ["Ativo", "Inativo"].

Labels: 

title_insert: Título que será exibido na tela de inserção; 
title_update: Título que será exibido na tela de edição; 
title_record_list: Título da listagem dos registros do módulo. 

Flags:  

allow_draft: true ou false, padrão false;  

callback: true ou false, padrão false;
com a opção em "true", toda ação de insert, update e delete é realizada uma chamada no servidor do cliente. Esta opção é utilizada quando é necessário realizarmos procedimentos específicos para cada ação. Por exemplo, em um determinado site é necessário limpar o cache toda vez que houver inserção ou edição de um determinado registro, para solucionar este problema você pode utilizar os callbacks saiba mais.   
 
report: true ou false, padrão false;
com esta flag "true", será exibido um botão no administração do módulo pelo usuário para relatório. Esta opção é utilizada quando é necessário fazer relatórios personalizados para o módulo saiba mais

* paramentos obrigatórios