README

🔑 maestro/accounts

管理系统内的身份和账户认证。

内容

• 简介
• 基本用法
  • 账户类型
    • 创建新类型
    • 查询类型
• 模块结构

简介

负责创建和管理账户，并确保系统内实体的身份。
使用它，每个与模块关联的实体都拥有一个唯一的账户，该账户可以作为认证使用或不用。

基本用法

账户类型

创建新类型

通过指定其名称和关联的账户是否需要认证来创建新的账户类型。默认情况下，所有账户不进行认证。

$typeName = 'App/Models/User'

$isAuthenticable = true;

Accounts::type()->create($typeName, $isAuthenticable); // Retorna Type

根据对象创建一个新的账户类型。类型的名称将是对象的类名。

$user = new User();

Accounts::type()->create($user, true); // Retorna Type

查询类型

返回所有账户类型。

Accounts::type()->all(); // Retorna Collection

通过ID查询账户类型

Accounts::type()->find(1); // Retorna Type

通过名称查询账户类型

Accounts::type()->find('App/User'); // Retorna Type

通过对象查询账户类型

$user = new User();

Accounts::type()->find($user); // Retorna Collection

尝试找到一个账户类型。如果没有找到，则需要创建。

Accounts::type()->findOrCreate('App/Models/User'); // Retorna Type

检查是否已注册账户类型。

Accounts::type()->isExists('App/Models/User'); // Retorna Collection

将具有 trait HasAccount 的两个对象关联起来。
对象需要预先创建两个账户。

Accounts::relation()->relate($childObjectWithAccount, $parentObjectWithAccount);

返回账户类型的工厂

Accounts::type()->factory(); // Retorna Type

账户

创建新账户

模块结构

模块的目录结构组织如下

.
|_ Database                 // Estrutura relacionada à banco de dados
|  |_ Factories             // Criação de mocks para testes em bancos       
|  |_ Migrations            // Criação das tabelas no banco de dados         
|  |_ Models                // Modelagem das entidades das tabelas no banco de dados     
|  |_ Seeders               // Inserção de registros no banco de dados
|_ Exceptions               // Arquivos de disparo de erros   
|_ Entities                 // Classes de ligação entre serviços do módulo e as entradas da aplicação  
|_ Http                     // Estrutura relacionada à entradas via Http
|  |_ Controllers           // Classes de controllers       
|  |_ Middleware            // Funcionalidades que devem ser executads entre a requisição e o controller
|  |_ Requests              // Validação de requisições Http     
|  |_ Routes                // Arquivos de configuração de rotas   
|_ Resources                // Estrutura relacionada à arquivos HTML e seus complementares 
|  |_ assets                // Arquivos JS, CSS ou imagens   
|  |_ config                // Arquivos de configurações do módulo
|  |_ lang                  // Arquivos de mensagens e suas traduções
|  |_ views                 // Arquivos de view Blade   
|  |_ docs                  // Arquivos de documentação markdown (.md)   
|_ Services                 // Estrutura relacionada à execução de serviços, rotinas e funcionalidades do módulo  
|  |_ Providers             // Classes que disponibiliza e iniciaa o módulo para a aplicação Laravel
|  |_ Fundamentals          // Classes com serviços de funcionalidades básicas do módulo (eg: CRUD)     
|_ Support                  // Estrutura relacionada à fornecimento de serviços a módulos terceiros 
|  |_ Facade                // Classe de faixada para disponibilizar serviços para outros módulos     
|  |_ Concerns              // Funcionalidades que são atribuidas em outras classes     
|  |_ Helpers               // Funções avulsas que podem ser chamadas globalmente     
|_ Tests                    // Estrutura de testes do módulo