Trabalhando com JSON no CakePHP 1.2

Juan Basso — Fri, 12 Sep 2008 01:13:44 +0000

Com o crescimento do uso de AJAX, da maioria dos frameworks de JavaScript (jQuery, Prototype, mooTools, YUI, ExtJS, …) e de uma dúvida no Groups do Google (Action que renderize apenas o layout, sem necessidade de uma view), resolvi escrever um post falando sobre como usar JSON no CakePHP de forma automática para retorno dos dados, sem precisar gerar um arquivo de view para cada action e que não fere o MVC.
A Solução

Para solucionar o caso, achei que o melhor jeito seria criando uma classe de View nova. A classe View do CakePHP ela sempre procura um arquivo de view, além do template. Com a nova classe, seria feita a renderização ali mesmo, sem a necessidade de novos arquivos.

A classe que criei (JsonView) pode ser baixada aqui. Ela deve ser colocada na pasta views de da sua aplicação (nenhuma sub-pasta) com o nome de json.php. Ou seja, no final, você terá o caminho app/views/json.php.
Como Usar

Para usar é bem simples. No seu controller, quando você for retornar um código em JSON, basta alterar a variável $view do controller para usar a nova classe. Além disso, os dados que você quer que retorne, devem ser setados com o nome ‘json‘ no seu controller. Caso não seja, ele vai renderizar normalmente. Exemplo de uso no controller:

^?View Code PHP

class UsuariosController extends AppController {
	var $uses = array('Usuario', 'Grupo');
 
	function index($json = false) {
		$this->set('usuarios', $this->Usuario->find('list'));
		if ($json) {
			$this->view = 'Json';
			$this->set('json', 'usuarios');
		}
	}
 
	function multilista($json = false) {
		$this->set('usuarios', $this->Usuario->find('list'));
		$this->set('grupos', $this->Grupo->find('list'));
		if ($json) {
			$this->view = 'Json';
			$this->set('json', array('usuarios', 'grupos'));
		}
	}
}

Neste caso, quando o parâmetro de index não for true, ele vai renderizar como se fosse uma requisição normal. Caso passe como true, ele irá renderizar como JSON. Já no método multilista, além do parâmetro para verificar se é JSON, ele passa um array de variáveis para a view JSON, assim a classe irá renderizar mais de uma variável.

Outra maneira de se fazer é definir a variável $view da classe diretamente com ‘Json’ (assim como foi feito com $uses no exemplo). Assim, sempre que você der um set na variável ‘json’, a classe da View se liga e renderiza em json, caso contrário mantém o normal.

Conclusão

Este é um método fácil e rápido de renderizar as requisições JSON, sem precisar criar um arquivo para cada requisição e sem precisar de muito código (tanto no controller, quanto na view).

O código que fiz, é compatível com PHP 4 e 5, então é possível usar com o CakePHP sem medo em qualquer versão de PHP.

Abraços e bom uso. Dicas são sempre bem vindas.

Usando jQuery com CakePHP

Juan Basso — Mon, 19 May 2008 23:59:03 +0000

Vendo o questionamento de muitas pessoas no Google Groups, vou explicar como usar o jQuery juntamente com o CakePHP.

A primeira coisa que você tem que fazer é baixar o código do jQuery e colocá-lo na pasta vendors\js (tanto faz ser na vendors dentro de app ou fora). Depois disso, nos controllers que você for utilizar o jQuery, inclua o helper Javascript:

^?View Code PHP

1
2
3

class SeuController extends AppController {
  var $helpers = array('Javascript');
}

Se você usa em todas as páginas, pode colocar isto no seu AppController.

Feito isso, você pode usar na sua view (ou layout) o seguinte código:

^?View Code PHP


// Incluir o jQuery ao projeto
// Neste exemplo estou importando a jquery.tablesorter também
// O segundo parâmetro (false) é para indicar que vai no  e não no local onde está sendo executado
$javascript->link(array('jquery', 'jquery.tablesorter'), false);
 
// Aqui vou definir alguns comandos de jQuery
$javascript->codeBlock('
  $(document).ready(function(){
    $("#detalhe_compra").tablesorter({decimal: ",", dateFormat: "uk"});
    $("#resumo_compras").tablesorter({decimal: ",", dateFormat: "uk"});
  });', array('inline' => false));
?>
Minha view normalmente...

Com isso, você faz que o código javascript vá para o do seu HTML e não fique no meio das suas views, o que é deselegante e fora do padrão W3C.

Num próximo post explico como usar jQuery e AJAX.

CakePHP Brasil » javascript

Trabalhando com JSON no CakePHP 1.2

Usando jQuery com CakePHP