PHP Yii Framework: Trabalhando com banco de dados na pr�tica

Para iniciar o desenvolvimento desse artigo, precisamos ter em mente o conceito do modelo de arquitetura MVC (Model-View-Controller) em PHP e ter instalado em nossa m�quina a �ltima vers�o est�vel do Yii Framework, que � a 1.1.

Cen�rio da aplicaç�o

Para este tutorial ser� criado o portal fict�cio de not�cias Portal News, no qual ser�o cadastradas not�cias diariamente. Estas not�cias ser�o publicadas apenas por usu�rios administradores e devem possuir apenas uma categoria.

Nota: O sistema operacional utilizado neste exemplo � o Ubuntu 14.04 LTS, com o visual alterado e aplicado o tema Macbuntu. Trataremos aqui tamb�m dos passos para quem tem o sistema operacional Windows. Os passos diferenciados em cada sistema ser�o explicitados.

Para iniciar a aplicaç�o, abra o terminal (no caso do Windows � o prompt de comando no modo de administrador) e navegue at� o diret�rio onde est� localizado a pasta do Yii.

Crie a aplicaç�o pelo utilit�rio Yiic. Para isso, digite o seguinte c�digo presente na Listagem 1.

Listagem 1. Criando aplicaç�o em sistemas operacionais Linux.


  sudo ./yiic webapp ../../PortalNews/

Ap�s criar o projeto ser� exibido uma mensagem semelhante � apresentada na Figura 1.

Figura 1. Aplicaç�o criada com sucesso.

Se o sistema operacional da m�quina for o Windows, digite o c�digo presente na Listagem 2.

Listagem 2. Criando aplicaç�o em sistemas operacionais Windows.


  yiic webapp ../../PortalNews/

Estrutura do banco de dados

Este � o ponto crucial do projeto, o banco de dados. � imprescind�vel para um sistema a modelagem l�gica, pois � com ela que ser� criado todo o fluxo e aç�es do projeto. Ainda que n�o seja obrigat�rio criar o modelo l�gico para sua aplicaç�o, � de boa pr�tica faz�-lo. Isso faz com que o software seja bastante denso e coeso. Para este artigo ser� utilizado o banco de dados MySQL, na vers�o 5.5.37-0ubuntu0.14.04.1, com o utilit�rio de gerenciamento PHPMyAdmin.

Nota: Com o intuito de facilitar a did�tica desta mat�ria, os assuntos mais espec�ficos relacionados � modelagem e banco de dados ter�o uma vis�o superficial.

Na Figura 2 segue o modelo l�gico aplicado ao site fict�cio �PortalNews�. A partir dele ser� implementado o modelo f�sico, onde ao inv�s de entidades t�m-se tabelas. A seguir � explicado como devemos criar o modelo l�gico corretamente.

Figura 2. Modelo l�gico PortalNews.

Na Figura 2 acima � representada a modelagem dos dados que ser�o utilizados na aplicaç�o. A seguir temos um pequeno resumo sobre o gr�fico acima:

Na entidade ADMINISTRADOR s�o atribu�das as propriedades: id, nome, e-mail, login e senha; al�m do fato de que um usu�rio com n�vel de administrador do PortalNews publicar� artigos para o site. Devido � possibilidade do usu�rio publicar nenhum ou in�meros artigos e um artigo ser necessariamente publicado por um usu�rio(administrador), a cardinalidade final entre as entidades ADMINISTRADOR e NOT�CIA � definida como N:N.
A entidade NOT�CIA � a chave do modelo e por ela � baseada que todas as outras entidades nela presentes agem. Ela possui as propriedades: id, autor, t�tulo, data, conteudo. Esta entidade possui dois relacionamentos com outras entidades: a not�cia � publicada por pelo menos um e no m�ximo um administrador, ent�o podemos considerar o relacionamento 1:1 (NOT�CIA->ADMINISTRADOR) e 0:N(ADMINISTRADOR->NOT�CIA), caracterizando assim a cardinalidade final, j� citada, N:N (muitos-para-muitos).
NOT�CIA possui tamb�m um relacionamento com a entidade CATEGORIA. Devido ao fato de a not�cia possuir no m�nimo uma e no m�ximo uma categoria, assim como a categoria � �possu�da� por pelo menos uma ou mais not�cias, a cardinalidade final � 1:N (um-para-muitos).

Modelo f�sico

A partir deste momento toda a l�gica do software est� pronta, ent�o � hora de partir para o modelo f�sico. O modelo f�sico � basicamente a �convers�o� dos dados l�gicos (entidades) em dados f�sicos (tabelas). O recurso respons�vel por armazenar estes dados f�sicos � o banco de dados.

Ent�o, para criar a base de dados digite o seguinte c�digo presente na Listagem 3.

Listagem 3. Criando base de dados PortalNews.


  CREATE DATABASE PortalNews;

Uma vez criada a base de dados, � hora de colocar o modelo f�sico em pr�tica. Antes de começar a escrever as querys (comandos) SQL para criar as tabelas, veja a seguir quais ser�o as alteraç�es necess�rias, sempre baseado no modelo l�gico criado anteriormente:

A entidade ADMINISTRADOR torna-se uma tabela pr�pria, contendo como campos (colunas): id, nome, e-mail, login e senha. O campo id ser� chave prim�ria, com autoincremento. Os campos: nome, e-mail, login e senha ser�o todos do tipo VARCHAR(300), ou seja, contendo no m�ximo 300 caracteres.
Nota: N�o � uma boa pr�tica armazenar senhas no banco de dados. O aconselh�vel � criptografar a senha antes de grav�-la no banco. Para uso did�tico, neste artigo, as senhas ser�o gravadas diretamente na base de dados.
A entidade NOT�CIA tamb�m se tornar� uma tabela, onde nela possuir� os campos (colunas): id, idAutor, idCategoria, titulo, data, conteudo. Assim como em ADMINISTRADOR, o campo id ser� chave prim�ria, com autoincremento. O campo titulo ser� do tipo VARCHAR(400), ou seja, poder� possuir no m�ximo 400 caracteres, enquanto que o campo conteudo ser� do tipo TEXT.
O atributo autor e a entidade CATEGORIA, presentes no modelo l�gico, transformam-se aqui em idAutor e idCategoria, respectivamente. Estes dois ser�o chaves estrangeira, que se referenciam �s tabela de Administradores e Categorias, respectivamente. Por �ltimo, o campo data ser� do tipo TIMESTAMP, com o valor default (padr�o) e o atributo on update CURRENT_TIMESTAMP. Isso quer dizer que ao inserir ou atualizar alguma linha na tabela esse campo ser� alterado para o hor�rio atual, no formato TIMESTAMP.
A entidade CATEGORIA ser� uma tabela simples, que conter� apenas dois campos: id e nome. O campo id, como em todas as outras tabelas, ser� chave prim�ria, com autoincremento. O campo nome ser� do tipo VARCHAR(200) e poder� possuir no m�ximo 200 caracteres.

Agora que j� est� clara a maneira com a qual cada entidade ser� representada no modelo f�sico, vamos � codificaç�o. Veja o c�digo da Listagem 4 para criar a tabela de usu�rios administradores do PortalNews.

Nota: � de suma import�ncia seguir a ordem cronol�gica obedecida aqui para criar-se as tabelas. Devido ao fato de uma delas possuir chave(s) estrangeira(s), ocorrer� problemas ao executar suas querys (comandos) SQL em ordem inversa a proposta aqui.

Listagem 4. Criando tabela de Administradores.


  CREATE TABLE IF NOT EXISTS `Administrador` (
   
    `id` int(11) NOT NULL AUTO_INCREMENT,
   
    `nome` varchar(300) NOT NULL,
   
    `email` varchar(300) NOT NULL,
   
    `login` varchar(300) NOT NULL,
   
    `senha` varchar(300) NOT NULL,
   
    PRIMARY KEY (`id`)
   
  ) ENGINE=InnoDB DEFAULT CHARSET=latin1 AUTO_INCREMENT=1 ;

Agora, siga o c�digo da Listagem 5 para criar a tabela de Categorias.

Listagem 5. Criando tabela de Categorias.


  CREATE TABLE IF NOT EXISTS `Categoria` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `nome` varchar(200) NOT NULL,
    PRIMARY KEY (`id`)
  ) ENGINE=InnoDB DEFAULT CHARSET=latin1 AUTO_INCREMENT=1 ;

Por �ltimo, � hora de criar a tabela de Not�cias. Confira na Listagem 6.

Listagem 6. Criando tabela de Not�cias.


  CREATE TABLE IF NOT EXISTS `Noticia` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `idAutor` int(11) NOT NULL,
    `idCategoria` int(11) NOT NULL,
    `data` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    `titulo` varchar(400) NOT NULL,
    `conteudo` text NOT NULL,
    PRIMARY KEY (`id`),
    KEY `idAutor` (`idAutor`,`idCategoria`),
    KEY `idCategoria` (`idCategoria`)
  ) ENGINE=InnoDB DEFAULT CHARSET=latin1 AUTO_INCREMENT=1 ;

Ativaç�o dos utilit�rios Gii, MySQL e URL personalizada

Agora que a aplicaç�o e o modelo de dados est�o criados, faz-se necess�rio o uso do utilit�rio Gii, que � um script do Yii respons�vel por gerar models, controllers, CRUDs e modules. Primeiramente acesse localhost/PortalNews para ver se a aplicaç�o est� rodando sem problemas. Confira na Figura 3.

Figura 3. P�gina inicial do site.

Se a aplicaç�o estiver funcionando corretamente, v� at� o diret�rio do projeto e abra o arquivo main.php, presente na pasta protected/config. Utilize o editor de texto de sua prefer�ncia, aqui ser� utilizado o Sublime Text 2, que pode ser baixado em seu site oficial (http://www.sublimetext.com/2).

Pesquise pelo trecho �uncomment the following to enable the Gii tool�. Ap�s ach�-lo descomente o trecho de c�digo correspondente. Atente-se para alterar a senha atrav�s do par�metro password. Aqui a senha utilizada ser� 123. O c�digo descomentado ficar� como na Listagem 7.

Listagem 7. Ativando utilit�rio Gii.


  'gii'=>array(
    'class'=>'system.gii.GiiModule',
    'password'=>'123',
    // If removed, Gii defaults to localhost only. Edit carefully to taste.
    'ipFilters'=>array('127.0.0.1','::1'),
  ),

Agora ative o MySQL descomentando as linhas referentes � ele. Veja na Listagem 8 como fica o c�digo descomentado.

Listagem 8. Ativando o serviço MySQL.


  'db'=>array(
     'connectionString' => 'mysql:host=localhost;dbname=PortalNews',
     'emulatePrepare' => true,
     'username' => 'root',
     'password' => '123',
     'charset' => 'utf8',
   ),

Para ativar a URL estilo �controller/action�, descomente o c�digo da Listagem 9.

Listagem 9: Ativando URL estilo �controller/action�.


  'urlManager'=>array(
   
   'urlFormat'=>'path',
   
    'rules'=>array(
   
    '<controller:\w+>/<id:\d+>'=>'<controller>/view',
   
    '<controller:\w+>/<action:\w+>/<id:\d+>'=>'<controller>/<action>',
   
    '<controller:\w+>/<action:\w+>'=>'<controller>/<action>',
   ),
   
 ),

Criaç�o dos Models

Acesse localhost/PortalNews/index.php/gii para acessar o Gii e criar os models. Confira na Figura 4 como � a p�gina de login do Gii.

Figura 4. Tela inicial Gii.

Ap�s logar-se no Gii com a senha definida anteriormente, clique em �Model Generator�, localizado � esquerda da tela. Confira na Figura 5 a p�gina carregada.

Figura 5. P�gina �Model Generator� carregada.

No Gii � muito simples gerar models, basta colocar o nome da tabela em �Table Name�, automaticamente o nome da classe modelo (model) � preenchido. Ap�s isso, basta clicar em �preview� e depois em �generate�. Uma mensagem semelhante � Figura 6 ser� exibida.

Figura 6. Model Administrador gerado com sucesso.

Execute este passo mais duas vezes e crie os models Noticia e Categoria, de acordo com as tabelas gravadas no banco de dados.

Criaç�o dos Controllers e CRUD

Para criar os Controllers e CRUD, os passos s�o praticamente os mesmos. Preencha o �Controller ID� com o nome desejado. � uma boa pŕatica dar o nome ao Controller o mesmo nome da classe modelo (model), haja visto que o Yii adiciona automaticamente o sufixo �Controller� ao arquivo controlador.

Realize este passo mais duas vezes para gerar os controladores e CRUDs Categoria e Noticia. Ap�s gerar o controller ser� exibida uma mensagem como na Figura 7.

Figura 7. Controller Administrador gerado com sucesso.

Cadastro de Usu�rios Administradores

Uma vez gerado os models, controllers e views necess�rios para rodar a aplicaç�o, cadastre um novo usu�rio no sistema. Acesse localhost/PortalNews/index.php/administrador/create, entre com o login e senha para cadastrar um novo usu�rio.

Nota: A autenticaç�o dos usu�rios por login e senha n�o ser� visto neste artigo, pois causaria uma larga extens�o deste. Utilize o login padr�o do Yii para se logar: admin/admin ou demo/demo.

Ap�s logar-se no sistema, ser� carregada a p�gina de cadastro de usu�rios e posteriormente a tela com usu�rio cadastrado. Confira nas Figuras 8 e 9.

Figura 8. Formul�rio de cadastro do Administrador.

Figura 9. Usu�rio de teste cadastrado como Administrador.

Cadastro de Categorias

Para cadastrar novas categorias no sistema acesse localhost/PortalNews/index.php/categoria/create, d� um nome � categoria e ent�o clique em �Create�. Confira na Figura 10 a p�gina de categoria cadastrada.

Figura 10. Categoria cadastrada com sucesso.

Cadastro de Not�cias

Aqui est� um dos pontos mais importantes desta mat�ria, pois � neste momento que ser� aplicado o relacionamento entre as entidades (tabelas). Ao acessar a p�gina de cadastro de not�cias ser� visualizado a seguinte p�gina presente na Figura 11.

Figura 11. Formul�rio para cadastrar not�cias.

Para tornar o formul�rio mais intuitivo e f�cil de se cadastrar not�cia, ser� colocado dois checkboxes com os nomes dos Autores e Categorias cadastradas, ao inv�s de mandar os textboxes criadas pelo padr�o do Yii. Veja o c�digo das Listagens 10, 11 e 12.

Com o intuito de tornar mais din�mico os formul�rios da sua aplicaç�o, o Yii cria o arquivo CREATE (localizado em protected/views/nomeDoControlador), que � o respons�vel por renderizar uma Vis�o Parcial, ou seja, � renderizado uma view �dentro� da outra. Esta aç�o ocorre atrav�s do m�todo renderPartial(), da classe Controller. Devido a isso, � necess�rio primeiro passar os dados para o CREATE e depois encaminh�-los at� o _form.php .

Listagem 10. Passando os Autores e Categorias para o arquivo CREATE, do cadastro de not�cias.


  // Action CREATE do model Noticia, arquivo NoticiaController.php
  public function actionCreate()
   
   {
   
      $model=new Noticia;
   
      $categorias = Categoria::model()->findAll();
   
      $autores = Administrador::model()->findAll();
   
      // Uncomment the following line if AJAX validation is needed
   
      // $this->performAjaxValidation($model);
   
   
   
     if(isset($_POST['Noticia']))
   
       {
   
         $model->attributes=$_POST['Noticia'];
   
     if($model->save())
   
        $this->redirect(array('view','id'=>$model->id));
   
     }
   
   
      // Passando os dados pegos da actionCreate para a View Create.
      $this->render('create',array(
   
         'model'=>$model,
     
         'categorias'=>$categorias,
   
         'autores'=>$autores,
   
     ));
   
 }

Listagem 11. Passando os dados resgatados na view Create.


  // O c�digo acima foi omitido para melhor visualizaç�o
  <h1>Create Noticia</h1>
  <?php $this->renderPartial('_form', array('model'=>$model, 'autores'=>$autores, 'categorias'=>$categorias)); ?>

Listagem 12. Formul�rio com as checkboxes inseridas.


  // Vari�veis autores e categorias s�o adindas da view Create.
  <div class="row">
   
                          <select name="Noticia[idAutor]">
   
                                     <?php for ($i=0; $i < count($autores); $i++): ?>
   
                                                 <option value="<?php echo $autores[$i]['id']; ?>"><?php echo $autores[$i]['nome']; ?></option>
   
                                     <?php endfor; ?>
   
                          </select>
   
              </div>
   
   
   
              <div class="row">
   
                          <select name="Noticia[idCategoria]">
   
                                     <?php for ($i=0; $i < count($categorias); $i++): ?>
   
                                                 <option value="<?php echo $categorias[$i]['id']; ?>"><?php echo $categorias[$i]['nome']; ?></option>
   
                                     <?php endfor; ?>
   
                          </select>
   
              </div>

Com isso o formul�rio ficou conforme o mostrado na Figura 12.

Figura 12. Formul�rio para cadastrar not�cias.

Esta foi uma breve introduç�o sobre como funcionam os bancos de dados relacionais e como o Yii Framework tratam estes dados.

Gostou do artigo? Quer dar sua opini�o? Deixe seu coment�rio e at� a pr�xima!