minerva-framework/minerva-frontql

FrontQL é uma estrutura de queries para front-end para utilização com o Zend Framework.

v1.0.8 2017-11-08 18:29 UTC

Requires

• phpunit/phpunit: 5.6.5
• zendframework/zend-db: 2.8.2

proprietary

• Lucas A. de Araújo

README

composer require minerva-framework/minerva-frontql

FrontQL é uma estrutura simplificada de queries para front-end compatível com Zend Framework. Utilizando o FrontQL você ganha mais flexibilidade no momento de montar suas consultas e realizar implementações de API, além de poupar tempo de trabalho e evitar que sejam criados diversos condicionamentos em suas actions deixando seu código desorganizado ou então com diversas implementações de estratégias desnecessárias.

No front-end

No front-end você tem as opções de comands where, operadores where, seleção de colunas, limit e ordenamento. Nos comands where, o primeiro elemento da array é o nome do comando no Zend Framework, e os demais parâmetros são exigidos por este. Como operadores temos and, or, nest e unnest.

var select = {
   where  : [
      'nest',
      ['equalTo', 'Campanha.idcampanha', 11],
      'and',
      ['equalTo', 'Campanha.ativo', 1],
      'unnest',
      'or',
      ['equalTo', 'Campanha.idcampanha', 12]
   ],
   limit  : 5,
   offset : 0,
   order  : [
      [['Campanha.idcampanha'], 'DESC']
   ],
};
            
return ApiClient.post('/crm/api/v1/campanha/select', {fql: select});

No back-end

Quando o payload for recebido, basta instanciar o adapter, realizar a conversão, fazer os overrides se necessário, executar a query e construir a resposta.

// Query recebida do front-end
$payload = $this->params()->fromPost('fql');

// Conversão para Zend\Db\Sql\Select
$adapter = new SelectAdapter();
$adapter->setProtectedColumns(['name']);
$adapter->setSelectPayload(new SelectPayload($payload));
$query = $adapter->getSelect();

// Override
$query->limit(2);

// Consulta
$clientTable = new ClientTableGateway();
$resultSet = $clientTable->select($query);

// Resposta
$response = new JsonModel($resultSet->toArray());
return $response;

Resposta

Seguindo o esboço acima você receberá uma resposta nesse padrão.

[
   {
      email: '[e-mail]',
      idade: 21
   },
   {
      email: null,
      idade: 19
   }
]