repository

Documentation

Index

• type Department
• type Dictionary
• type File
• type Job
• type Menu
• type Rbac
• type Resource
• type Role
• type System
• type User

Types

type Department

type Department interface {
	// GetDepartment 获取指定的部门信息
	GetDepartment(ctx kratosx.Context, id uint32) (*entity.Department, error)

	// GetDepartmentByKeyword 获取指定的部门信息
	GetDepartmentByKeyword(ctx kratosx.Context, keyword string) (*entity.Department, error)

	// ListDepartment 获取部门信息列表
	ListDepartment(ctx kratosx.Context, req *types.ListDepartmentRequest) ([]*entity.Department, error)

	// CreateDepartment 创建部门信息
	CreateDepartment(ctx kratosx.Context, req *entity.Department) (uint32, error)

	// UpdateDepartment 更新部门信息
	UpdateDepartment(ctx kratosx.Context, req *entity.Department) error

	// DeleteDepartment 删除部门信息
	DeleteDepartment(ctx kratosx.Context, id uint32) error

	// GetDepartmentDataScope 获取指定用户的部门权限
	GetDepartmentDataScope(ctx kratosx.Context, uid uint32) (bool, []uint32, error)

	// HasDepartmentPurview 是否具有指定的部门权限
	HasDepartmentPurview(ctx kratosx.Context, uid uint32, did uint32) (bool, error)
}

type Dictionary

type Dictionary interface {
	// ListDictionary 获取字典目录列表
	ListDictionary(ctx kratosx.Context, req *types.ListDictionaryRequest) ([]*entity.Dictionary, uint32, error)

	// CreateDictionary 创建字典目录
	CreateDictionary(ctx kratosx.Context, req *entity.Dictionary) (uint32, error)

	// UpdateDictionary 更新字典目录
	UpdateDictionary(ctx kratosx.Context, req *entity.Dictionary) error

	// DeleteDictionary 删除字典目录
	DeleteDictionary(ctx kratosx.Context, id uint32) error

	// ListDictionaryValue 获取字典值目录列表
	ListDictionaryValue(ctx kratosx.Context, req *types.ListDictionaryValueRequest) ([]*entity.DictionaryValue, uint32, error)

	// AllDictionaryValue 获取全部字典值目录列表
	AllDictionaryValue(ctx kratosx.Context, req *types.AllDictionaryValueRequest) ([]*entity.DictionaryValue, error)

	// GetDictionaryValue 获取字典值
	GetDictionaryValue(ctx kratosx.Context, id uint32) (*entity.DictionaryValue, error)

	// CreateDictionaryValue 创建字典值目录
	CreateDictionaryValue(ctx kratosx.Context, req *entity.DictionaryValue) (uint32, error)

	// UpdateDictionaryValue 更新字典值目录
	UpdateDictionaryValue(ctx kratosx.Context, req *entity.DictionaryValue) error

	// UpdateDictionaryValueStatus 更新字典值目录状态
	UpdateDictionaryValueStatus(ctx kratosx.Context, id uint32, status bool) error

	// DeleteDictionaryValue 删除字典值目录
	DeleteDictionaryValue(ctx kratosx.Context, id uint32) error

	// GetDictionary 获取指定的字典目录
	GetDictionary(ctx kratosx.Context, id uint32) (*entity.Dictionary, error)

	// GetDictionaryByKeyword 获取指定的字典目录
	GetDictionaryByKeyword(ctx kratosx.Context, keyword string) (*entity.Dictionary, error)

	// ListDictionaryValues 批量获取字典
	ListDictionaryValues(ctx kratosx.Context, keywords []string) ([]*types.DictionaryValue, error)
}

type File

type File interface {
	// GetFileURL 获取指定文件的url
	GetFileURL(ctx kratosx.Context, sha string) string
}

type Job

type Job interface {
	// ListJob 获取职位信息列表
	ListJob(ctx kratosx.Context, req *types.ListJobRequest) ([]*entity.Job, uint32, error)

	// CreateJob 创建职位信息
	CreateJob(ctx kratosx.Context, req *entity.Job) (uint32, error)

	// UpdateJob 更新职位信息
	UpdateJob(ctx kratosx.Context, req *entity.Job) error

	// DeleteJob 删除职位信息
	DeleteJob(ctx kratosx.Context, id uint32) error

	// GetJob 获取指定的职位信息
	GetJob(ctx kratosx.Context, id uint32) (*entity.Job, error)

	// GetJobByKeyword 获取指定的职位信息
	GetJobByKeyword(ctx kratosx.Context, keyword string) (*entity.Job, error)
}

type Menu

type Menu interface {
	// GetMenu 获取自定菜单信息
	GetMenu(ctx kratosx.Context, id uint32) (*entity.Menu, error)

	// ListMenuApi 获取菜单api信息列表
	ListMenuApi(ctx kratosx.Context) ([]*types.MenuApi, error)

	// ListMenu 获取菜单信息列表
	ListMenu(ctx kratosx.Context, req *types.ListMenuRequest) ([]*entity.Menu, error)

	// ListMenuByRoleId 获取指定角色的菜单列表
	ListMenuByRoleId(ctx kratosx.Context, id uint32) ([]*entity.Menu, error)

	// ListMenuChildrenApi 获取指定目录下的所有api
	ListMenuChildrenApi(ctx kratosx.Context, id uint32) ([]*entity.Menu, error)

	// CreateMenu 创建菜单信息
	CreateMenu(ctx kratosx.Context, req *entity.Menu) (uint32, error)

	// UpdateMenu 更新菜单信息
	UpdateMenu(ctx kratosx.Context, req *entity.Menu) error

	// DeleteMenu 删除菜单信息
	DeleteMenu(ctx kratosx.Context, id uint32) error

	// InitBasicMenu 初始化基础菜单api
	InitBasicMenu(ctx kratosx.Context)

	// SetHome 设置菜单首页
	SetHome(ctx kratosx.Context, id uint32) error
}

type Rbac

type Rbac interface {
	// CreateRbacRolesApi 批量添加角色所属菜单权限
	CreateRbacRolesApi(ctx kratosx.Context, roles []string, api types.MenuApi) error

	// DeleteRbacApi 删除指定的菜单权限
	DeleteRbacApi(ctx kratosx.Context, api, method string) error

	// UpdateRbacApi 更新指定的菜单权限
	UpdateRbacApi(ctx kratosx.Context, old types.MenuApi, now types.MenuApi) error

	// DeleteRbacRoles 删除指定的角色列表
	DeleteRbacRoles(ctx kratosx.Context, roles []string) error

	// UpdateRbacRoleApis 更新指定角色的菜单列表
	UpdateRbacRoleApis(ctx kratosx.Context, role string, apis []*types.MenuApi) error
}

type Resource

type Resource interface {
	// GetResourceScopes 获取指定用户的资源权限
	GetResourceScopes(ctx kratosx.Context, req *types.GetResourceScopesRequest) ([]uint32, error)

	// GetResource 获取资源权限
	GetResource(ctx kratosx.Context, req *types.GetResourceRequest) ([]uint32, error)

	// DeleteResource 删除资源权限
	DeleteResource(ctx kratosx.Context, req *types.DeleteResourceRequest) error

	// CreateResources 添加资源权限
	CreateResources(ctx kratosx.Context, list []*entity.Resource) error
}

type Role

type Role interface {
	// GetRole 获取指定的角色信息
	GetRole(ctx kratosx.Context, id uint32) (*entity.Role, error)

	// GetRoleByKeyword 获取指定的角色信息
	GetRoleByKeyword(ctx kratosx.Context, keyword string) (*entity.Role, error)

	// GetRoleChildrenKeywords 获取指定角色的下级所有keyword
	GetRoleChildrenKeywords(ctx kratosx.Context, id uint32) ([]string, error)

	// ListRole 获取角色信息列表
	ListRole(ctx kratosx.Context, req *types.ListRoleRequest) ([]*entity.Role, error)

	// CreateRole 创建角色信息
	CreateRole(ctx kratosx.Context, req *entity.Role) (uint32, error)

	// UpdateRole 更新角色信息
	UpdateRole(ctx kratosx.Context, req *entity.Role) error

	// UpdateRoleStatus 更新角色信息状态
	UpdateRoleStatus(ctx kratosx.Context, id uint32, status bool) error

	// DeleteRole 删除角色信息
	DeleteRole(ctx kratosx.Context, id uint32) error

	// GetRoleMenuIds 获取指定角色的菜单id列表
	GetRoleMenuIds(ctx kratosx.Context, id uint32) ([]uint32, error)

	// UpdateRoleMenu 更新角色的菜单
	UpdateRoleMenu(ctx kratosx.Context, id uint32, menuIds []uint32) error

	// GetRoleDataScope 获取指定用户的角色权限
	GetRoleDataScope(ctx kratosx.Context, rid uint32) (bool, []uint32, error)

	// HasRolePurview 是否具有指定的角色权限
	HasRolePurview(ctx kratosx.Context, uid uint32, rid uint32) (bool, error)

	// AllRoleKeywordByMenuId 获取指定菜单id的所有角色keyword
	AllRoleKeywordByMenuId(ctx kratosx.Context, id uint32) ([]string, error)
}

type System

type System interface {
}

type User

type User interface {
	// GetUser 获取指定的用户信息
	GetUser(ctx kratosx.Context, id uint32) (*entity.User, error)

	// GetBaseUser 获取指定的用户基础信息
	GetBaseUser(ctx kratosx.Context, id uint32) (*entity.User, error)

	// GetUserByPhone 获取指定的用户信息
	GetUserByPhone(ctx kratosx.Context, phone string) (*entity.User, error)

	// GetUserByEmail 获取指定的用户信息
	GetUserByEmail(ctx kratosx.Context, email string) (*entity.User, error)

	// GetUserRoleIds 获取用户的角色id
	GetUserRoleIds(ctx kratosx.Context, id uint32) ([]uint32, error)

	// ListUser 获取用户信息列表
	ListUser(ctx kratosx.Context, req *types.ListUserRequest) ([]*entity.User, uint32, error)

	// CreateUser 创建用户信息
	CreateUser(ctx kratosx.Context, req *entity.User) (uint32, error)

	// UpdateUser 更新用户信息
	UpdateUser(ctx kratosx.Context, req *entity.User) error

	// UpdateUserStatus 更新用户信息状态
	UpdateUserStatus(ctx kratosx.Context, id uint32, status bool) error

	// DeleteUser 删除用户信息
	DeleteUser(ctx kratosx.Context, id uint32) error

	// ListLoginLog 获取登陆信息列表
	ListLoginLog(ctx kratosx.Context, req *types.ListLoginLogRequest) ([]*entity.LoginLog, uint32, error)

	// CreateLoginLog 创建登陆信息
	CreateLoginLog(ctx kratosx.Context, req *entity.LoginLog) (uint32, error)
}