Banco de Dados e Models

O Banco de Dados
Agora que ns temos o mdulo Album configurado com controllers, aes e views, est na hora de olhar para a seo de models de nossa aplicao. Lembre-se que os models so a parte que lida com o proposito principal de uma aplicao (tambm chamado de "regras de negcio") e, em nosso caso, lida com o banco de dados. Ns iremos usar a classe
Zend\Db\TableGateway\TableGateway do Zend Framework que serve para procurar, inserir,

atualizar e deletar linhas do banco de dados. Tambm vamos usar MySQL, atravs do driver PDO do PHP, portanto crie um banco de dados com o nome de zf2tutorial , e rode as seguintes instrues SQL para criar a tabela de lbuns com alguns dados nela.
CREATE TABLE album ( id int(11) NOT NULL auto_increment, artist varchar(100) NOT NULL, title varchar(100) NOT NULL, PRIMARY KEY (id) ); INSERT INTO album (artist, title) VALUES ('The Military Wives', 'In My Dreams');

INSERT INTO album (artist, title) VALUES ('Adele', '21');

INSERT INTO album (artist, title) VALUES ('Bruce Springsteen', 'Wrecking Ball (Deluxe)');

INSERT INTO album (artist, title) VALUES ('Lana Del Rey', 'Born To Die');

INSERT INTO album (artist, title) VALUES ('Gotye', 'Making Mirrors');

(Os dados de teste escolhidos so os mais vendidos na Amazon UK no momento que esse tutorial foi escrito em sua verso original) Ns temos alguns dados em um banco de dados e podemos escrever um model bastante simples para eles.

Os Arquivos de Models
O Zend Framework no possui um componente Zend\Model por que os models so nossas regras de negcios e depende de voc decidir como quer que elas funcionem. Existem muitos componentes que voc pode usar para isso dependendo de suas necessidades. Um dos mtodos e ter uma classe model representando cada uma das entidades de sua aplicao e ento usar objetos mapeadores que carregam e salvam essas entidades no banco de dados. Outra abordagem pode ser utilizar um Object-relational mapping (ORM), como Doctrine ou Propel. Para esse tutorial ns vamos criar um model bastante simples atravs da criao de uma classe AlbumTable que usa a classe Zend\Db\TableGateway\TableGateway na qual cada um dos lbuns ser um Objeto Album (conhecido com entity). Essa a implementao do modelo padro Table Data Gateway que permite interao com os dados contidos na tabela do banco de dados. Esteja ciente de que esse modelo Table Data Gateway pode se tornar limitado em sistemas maiores. Tambm existe uma tentao por colocar o acesso ao banco de dados dentro das Vamos aes do controller comear j que essas so implementadas um pela arquivo classe Zend\Db\TableGateway\AbstractTableGateway . No Faa Isso! criando chamado Album.php em module/Album/src/Album/Model :
<?php namespace Album\Model;

class Album { public $id; public $artist; public $title;

public function exchangeArray($data) { $this->id = (!empty($data['id'])) ? $data['id'] : null;

$this->artist = (!empty($data['artist'])) ? $data['artist'] : null; $this->title } } = (!empty($data['title'])) ? $data['title'] : null;

Nosso objeto de entidade Album uma classe PHP simples. Para que ela funcione com a classe TableGateway do Zend\Db , ns precisamos implementar o mtodo exchangeArray(). Esse mtodo simplesmente copia os dados passados em um array para as propriedades de nossa entidade. Ns iremos implementar filtros para usar com os formulrios posteriormente. Em seguida ns criamos um arquivo AlbumTable.php no diretrio module/Album/src/Album/Model com o seguinte cdigo:
<?php namespace Album\Model;

use Zend\Db\TableGateway\TableGateway;

class AlbumTable { protected $tableGateway;

public function __construct(TableGateway $tableGateway) { $this->tableGateway = $tableGateway; }

public function fetchAll()

{ $resultSet = $this->tableGateway->select(); return $resultSet; }

public function getAlbum($id) { $id = (int) $id;

$rowset = $this->tableGateway->select(array('id' => $id)); $row = $rowset->current(); if (!$row) { throw new \Exception("Could not find row $id"); } return $row; }

public function saveAlbum(Album $album) { $data = array( 'artist' => $album->artist, 'title' ); => $album->title,

$id = (int)$album->id; if ($id == 0) { $this->tableGateway->insert($data); } else {

if ($this->getAlbum($id)) { $this->tableGateway->update($data, array('id' => $id)); } else { throw new \Exception('Album id does not exist'); } } }

public function deleteAlbum($id) { $this->tableGateway->delete(array('id' => $id)); } }

Existe muita coisa acontecendo aqui. Primeiramente, ns configuramos uma propriedade protegida $tableGateway para a instncia de TableGateway que ser passada no construtor. Ns iremos usar isso para realizar operaes na tabela de nosso lbuns no banco de dados. Ns ento criamos alguns mtodos ajudantes que nossa aplicao ir utilizar para interagir com o table gateway. fetchAll() retorna todas as linhas de lbuns do banco de dados como um ResultSet , getAlbum() retorna uma nica linha como um objeto Album , saveAlbum() tanto cria uma nova linha no banco de dados quanto atualiza uma linha existente e deleteAlbum() remove completamente uma linha. O cdigo de cada um desses mtodos autoexplicativo.

Usando o ServiceManager para configurar o Table Gateway e injetar no AlbumTable

Com o objetivo de sempre termos a mesma instancia do nosso AlbumTable , ns iremos usar o ServiceManager para definir como criar um. Isso geralmente feito na classe Module onde ns criamos o mtodo chamado getServiceConfig() que automaticamente chamado

pelo ModuleManager e aplicado ao ServiceManager . Ns ento estaremos aptos a solicita-lo no nosso controller quando precisarmos dele. Para configurar o ServiceManager , ns podemos ou disponibilizar o nome da classe para ser instanciado ou uma factory (closure ou callback) que instancia o objeto quando o ServiceManager precisar dele. Ns vamos comear implementando o
getServiceConfig() para prover a factory que criar o AlbumTable . Adicione esse mtodo ao

final do arquivo Module.php no diretrio module/Album . Esse mtodo retorna de um serem array de factories que para iro ser mescladas A factory pelo ModuleManager antes passadas o ServiceManager .

para Album\Model\AlbumTable usa o ServiceManager para criar um AlbumTableGateway que ser passado para o AlbumTable . Ns tambm informamos ao ServiceManager que um
AlbumTableGateway

criado

solicitando

um Zend\Db\Adapter\Adapter (tambm

do ServiceManager ) e usando ele para criar o objeto TableGateway . Ao TableGateway dito para usar um objeto Album sempre que ele criar uma nova linha de resultado. A classe TableGateway use o padro de prototipagem para criar o conjunto de resultado e as entidades. Isso significa que ao invs de instanciar um novo object quando solicitado o sistema clona um objeto previamente solicitado. veja PHP Constructor Best Practices and the Prototype Pattern Para mais detalhes (N.T.: em ingls). Finalmente ns precisamos configurar o ServiceManager para que ele saiba como conseguir a classe
Zend\Db\Adapter\Adapter .

Isso

feito

usando

uma

factory

chamada Zend\Db\Adapter\AdapterServiceFactory a qual podemos configurar atravs do sistema de arquivos de configurao. O ModuleManager do Zend Framework 2 junta todas as configuraes de cada um dos arquivos module.config.php dos mdulos juntamente com os arquivos definidos em config/autoload (os arquivos *.global.php e depois *.local.php ). Ns vamos adicionar nossa configurao de banco de dados no arquivo global.php que voc deve enviar para seu sistema de controle de verso. Voc pode usar local.php (fora do VCS) para armazenar as credenciais do seu banco de dados caso queira. Modifique o arquivo
config/autoload/global.php (no diretrio raiz do Zend Skeleton, no dentro do mdulo Album)

com o seguinte cdigo:

<?php return array( 'db' => array( 'driver' 'dsn' => 'Pdo', => 'mysql:dbname=zf2tutorial;host=localhost',

'driver_options' => array( PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\'' ), ), 'service_manager' => array( 'factories' => array( 'Zend\Db\Adapter\Adapter' => 'Zend\Db\Adapter\AdapterServiceFactory', ), ), );

Voc deve ento inserir as credenciais de acesso ao seu banco de dados em config/autoload/local.php para que elas no estejam no seu repositrio pblico (j que local.php ignorado):
<?php return array( 'db' => array( 'username' => 'YOUR USERNAME HERE', 'password' => 'YOUR PASSWORD HERE', ), );

Voltando ao Controller
Agora que o ServiceManager consegue criar uma instancia de AlbumTable para ns, podemos adicionar um mtodo ao controller para requisita-lo. Inclua getAlbumTable() classe AlbumController :
// module/Album/src/Album/Controller/AlbumController.php:

public function getAlbumTable() { if (!$this->albumTable) { $sm = $this->getServiceLocator(); $this->albumTable = $sm->get('Album\Model\AlbumTable'); } return $this->albumTable; }

Voc tambm deve adicionar:

protected $albumTable;

No topo da classe. Ns agora podemos chamar getAlbumTable() a partir de nosso controller sempre que precisarmos de interao com nosso model. Caso o service locator tenha sido configurado corretamente em Module.php , nos devemos obter uma instancia de
Album\Model\AlbumTable quando

chamarmos getAlbumTable() .

Listando os lbuns
Para listar os lbuns nos precisamos solicita-los do model e passa-los para a view. Para fazer isso ns preenchemos a
indexAction() do AlbumController .

Atualize

a indexAction() do AlbumController como a seguir:

// module/Album/src/Album/Controller/AlbumController.php: // ... public function indexAction() { return new ViewModel(array( 'albums' => $this->getAlbumTable()->fetchAll(), ));

} // ...

Com o Zend Framework 2 para passar variveis para a view nos retornamos uma instancia de ViewModel que tem como primeiro parmetro do construtor um array contendo os dados que ns precisamos. Esses so automaticamente passados para o arquivo de view. O objeto ViewModel tambm permite que voc altere o arquivo de view que ser usando, mas por padro usado {nome do controller}/ {nome da ao} . Ns agora podemos preencher o arquivo index.phtml :
<?php // module/Album/view/album/album/index.phtml:

$title = 'My albums'; $this->headTitle($title); ?> <h1><?php echo $this->escapeHtml($title); ?></h1> <p> <a href="<?php echo $this->url('album', array('action'=>'add'));?>">Add new album</a> </p>

<table class="table"> <tr> <th>Title</th> <th>Artist</th> <th>&nbsp;</th> </tr> <?php foreach ($albums as $album) : ?> <tr> <td><?php echo $this->escapeHtml($album->title);?></td>

<td><?php echo $this->escapeHtml($album->artist);?></td> <td> <a href="<?php echo $this->url('album', array('action'=>'edit', 'id' => $album->id));?>">Edit</a> <a href="<?php echo $this->url('album', array('action'=>'delete', 'id' => $album->id));?>">Delete</a> </td> </tr> <?php endforeach; ?> </table>

A primeira coisa que fizemos foi configurar o titulo da nossa pgina (usado no layout) e tambm passar esse titulo para a seo <head> usando o view helper headTitle() que ir ser exibido no barra de ttulo do navegador. Ns ento criamos um link para adicionar um novo album. O Helper de view url() fornecido pelo Zend Framework 2 e usado para criar os links que ns precisamos. O primeiro parmetro de url() o nome da rota que queremos usar para a construo da url, e o segundo parmetro um array com todas as variveis que iro substituir os coringas dessa rota. Nesse caso ns usamos a nossa rota album que est configurada para aceitar duas variveis coringa: action e id . Ns ento iremos percorrer os $albums que forma passados pela ao do controller. O sistema de views do Zend Framework 2 garante automaticamente que essas variveis sejam extradas para o escopo do nosso arquivo de view, portanto ns no precisamos nos preocupar com prefixar elas com $this-> como fazamos com Zend Framework 1; mas voc usa-lo se assim desejar. Ns ento criamos uma tabela para exibir o titulo e artista de cada um dos lbuns e exibimos tambm links que possibilitam editar e excluir essas entradas. Um loop foreach: padro usado para percorrer a lista de lbuns, e ns usamos a forma alternativa atravs do uso de dois-pontos e endforeach; j que essa forma mais fcil de ser percebida do que tentar posicionar os colchetes. Novamente o helper de view url() usado para criar os links de edio e excluso. Note

Ns sempre usamos o helper escapeHtml() para ajudar na nossa proteo contra vulnerabilidades site_scripting). Se voc abrir http://zf2-tutorial.localhost/album voc deve ver isso: de Cross Site Scripting (XSS) (veja http://en.wikipedia.org/wiki/Cross-