PHP Coupé

Aprendendo

Mais sobre Módulos

O PHP Coupé é um programa de desenvolvimento modular. Ou seja, tudo é separado de tudo. O conteúdo das páginas é separado de layout, assim como a programação também é separada dos demais textos e layouts dos projetos.

Sendo assim, Módulos é o nome dado aos arquivos que contém scrips PHP, e são utilizados em projetos dentro do PHP Coupé.

Cada módulo distribuído é básicamente um programa PHP que retorna o resultado de sua função para o conteúdo da página, exatamente no lugar onde foi chamado.

O objetivo é facilitar a manutenção dos códigos, sua distribuição, e consequentemente seu reaproveitamento em outros projetos.

Como utilizar os Módulos?

Módulos são distribuidos em arquivos únicos. Baixe (ou crie) o Módulo desejado, e coloque-o dentro da pasta 'modules/' do seu projeto.

Agora o Módulo já poderá ser invocado em suas páginas, modelos ou blocos de conteúdo, através da marcação [[nome_do_modulo]] ou [!nome_do_modulo!]. Sendo que 'nome_do_modulo' é o mesmo nome do arquivo do módulo.

Os Módulos chamados com a marcação [[ ]] serão sempre executados a cada visita à sua página. Já Módulos invocados entre [! !] tem seus resultados salvos no formato HTML para que não seja necessário executar os mesmos scripts para retornar sempre os mesmos resultados.

Chamar Módulos com a marcação [! !] é ideal para aquelas tarefas repetitivas que sempre geram os mesmo resultados. Como um gerador de menus dinâmicos onde suas seções não mudam constantemente. Ou até mesmo uma consulta ao banco de dados na qual os resultados não irão mudar com frequência (relatórios mensais).

É importante observar que, assim como a cláusula GET, Módulos também podem receber parâmetros durante sua chamada. Exemplo:

[[nome_do_modulo?parametro1=x¶metro2=y]]

Aviso: Frequentemente você encontrará Módulos que nos obrigam a invocá-los com a opção [[...?mode=valor]]. A opção 'mode' é um padrão escolhido para referenciar o "modo" como o Módulo deve ser executado (seu comportamento).

Desenvolvendo Módulos

Módulos do PHP Coupé são códigos PHP comuns.

Basta que sejam separados dentro da pasta 'modules/', em arquivos com a extensão .mdl.php.

Apenas recomendo para quem for desenvolver um Módulo, que procure fazê-lo seguindo uma metodologia que o torne realmente MODULAR e configurável (assim como são as classes), podendo então ser utilizado por pessoas e projetos diferentes.

Também busque utilizar o cabeçalho padrão estabelecido no início do código para que quem for utiliza-lo possa saber como.

Cabeçalho padrão:

Exemplo de módulo (randomBlockLines.mdl.php)

<?php

/**
* NOME: Random Block Lines
* VERSAO: 0.1 (0.4+)
* AUTOR: Samuel Corradi
* LICENCA: http://creativecommons.org/licenses/by-nd/2.5/br/ [(CC) by-nd]
* DATA: 2009/05/19
* CATEGORIA: Conteudo
* DESCRICAO: Retorna as linhas de um bloco de conteudo de forma randomica.
* DEPENDENCIA: Sem dependencias
* MAIS INFORMACOES:
*/

// ***** CONFIGURACOES ***** //
if (!isset($block)) $block='';
if (!isset($remove_tags)) $remove_tags='yes';
// *** FIM CONFIGURACOES *** //

$return = FALSE;

if($block!='')
{
$filename = $Coupe->config['DIR_BLOCK'] . $block . $Coupe->config['EXT_BLOCK'];
if(is_file($filename))
{
	if($file = file($filename))
	{
		$rand = array_rand($file);
		$return = $file[$rand];
		if ($remove_tags=='yes') $return = strip_tags($return);
	}
}
else $return = 'O bloco indicado não existe.'; 
}
else $return = 'Defina o nome do bloco.';

return $return;

?>