README

Biblioteca para manipular acesso de usuário a sistemas

USO

Instalação

composer require toneladas/acl

Configurando

Você pode usar a biblioteca usando uma conexão PDO "pura"* ou usando uma entidade da Doctrine.

A biblioteca utiliza as funções password_hash e password_verify, então ao salvar os dados do usuário no banco, utilize essas funções.

Usando PDO "pura"

Configure a conexão usando setWithDatabase:

<?php

$conn = new \PDO('sqlite::memory:');

$acl = new \Toneladas\Acl();
$acl->setWithDatabase($conn); // Objeto da PDO usado para conexão no banco de dados
$acl->setTable('usuarios'); // Nome da tabela usada no banco para guardar os usuários
$acl->setFieldUser('email'); // Nome do campo na tabela usado como o nome do usuário
$acl->setFieldPassword('senha'); // Nome do campo na tabela usado como a senha do usuário

Usando uma entidade Doctrine

Configure a conexão usando setWithDoctrine:

<?php

$acl = new \Toneladas\Acl();
$this->acl->setWithDoctrine($entityManager); // Instancia do EntityManager do Doctrine
$this->acl->setEntity('\tests\Entities\User'); // Nome da entidade que refere-se a tabela de usuarios
$this->acl->setFieldUser('user'); // Nome no campo na tabela usado como o nome do usuário
$this->acl->setMethodPassword('getPassword'); // Metodo da entidade para pegar a senha

Você também pode configurar que o usuário é um email, assim a biblioteca irá verificar se o email vindo do formulário é válido:

<?php

$acl->isEmail();

$acl->verify('usuario', '123'); // Irá jogar uma exception, pois 'usuario' não é um endereço de email válido

Verificando

Para verificar se o usuário e senha estão corretos, passe os dados vindo do formulários como parametros do método verify:

<?php

try {
  $acl->verify($usuario, $senha);

  // Deu tudo certo, seguimos em frente
} catch (\Exception $exp) {
  // Alguma coisa deu errada
}

Ele pode retornar três Exceptions:

\Toneladas\Exceptions\UserWrongException: Usuário passado não foi encontrado no banco
\Toneladas\Exceptions\PasswordWrongException: A senha informada está errada
\Toneladas\Exceptions\EmailInvalidException: Caso tenha configurado a verificação de usuário como um email

Você pode ainda tratar as exceptions diferente para cada situação:

<?php

try {
  $acl->verify($usuario, $senha);

  // Deu tudo certo, seguimos em frente
} catch (\Toneladas\Exceptions\UserWrongException $exp) {
  // O usuário não foi encontrado, então faço alguma coisa
} catch (\Toneladas\Exceptions\PasswordWrongException $exp) {
  // A senha está incorreta, então faço outra coisa
}

Lembrando que é boa prática não informar ao usuário qual dos dois deu errado, mas só informar que ocorreu um erro

* Eu sei que o Doctrine também usa a PDO para conexão com o banco

Licença

Licenciado sobre a licença MIT

Veja o arquivo LICENSE para mais detalhes.

toneladas / acl

Maintainers

Details