Download the PHP package ccuffs/auth-iduffs without Composer
On this page you can find all versions of the php package ccuffs/auth-iduffs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package auth-iduffs
auth-iduffs
Um pacote PHP para autenticação de usuários através do idUFFS da Universidade Federal da Fronteira Sul. Além de prover autenticação, ele oferece informações sobre o usuário autenticado, como nome completo, CPF, entre outros.
✨Features
- Autenticação com o endpoint id.uffs.edu.br via HTTPS;
- Não necessita de tokens ou autorizações de API;
- Obtem informações sobre o usuário (nome, CPF, etc);
🚀 Utilização
1. Adicione o pacote ao seu projeto
Na pasta raiz do seu projeto PHP, rode:
Todas as dependências serão instaladas.
2. Autenticando usuários
Para autenticar um usuário, você utilizará a classe AuthIdUFFS
informando os valores user
e password
, que são o idUFFS e senha do usuário, respecitivamente.
As informações são passadas ao método login()
através de um array associativo:
Se as credenciais informadas forem válidas, o método login()
retorna um objeto com as seguintes propriedades:
Se as credenciais não forem válidas (usuário ou senha incorretos), o método login()
retorna null
.
👩💻 Desenvolvimento
Se você pretende criar features novas, corrigir bugs ou afins, siga o passo a passo abaixo.
Clone o repositório:
Instale as dependências:
Implemente o que for necessário e rode os testes:
Um dos testes (de autenticação de usuário valido) necessita de um idUFFS e senha válidos. Você pode informar esses valores através das variáveis de ambiente AUTH_IDUFFS_TEST_USERNAME
e AUTH_IDUFFS_TEST_PASSWORD
, respectivamente.
Se essas variáveis de ambiente não forem informadas, somente um dos testes deve falhar. Os demais devem passar.
🤝 Contribua
Sua ajuda é muito bem-vinda, independente da forma! Confira o arquivo enviar um pull request, ou simplemente utilizar o projeto e comentar sua experiência.
🎫 Licença
Esse projeto é licenciado nos termos da licença open-source MIT e está disponível de graça.
🧬 Changelog
Veja todas as alterações desse projeto no arquivo CHANGELOG.md.