UsersService
in package
implements
UsersServiceInterface
Class UsersService
Interfaces, Classes, Traits and Enums
- UsersServiceInterface
- Interface UsersServiceInterface
Table of Contents
- $LoginStores : LoginStoresTable
- $Users : UsersTable
- __construct() : mixed
- UsersService constructor.
- checkAutoLogin() : User|false
- ログイン状態の保存確認
- create() : EntityInterface
- ユーザー登録
- delete() : bool
- ユーザー情報を削除する 最後のシステム管理者でなければ削除
- get() : User
- ユーザーを取得する
- getIndex() : Query
- ユーザー管理の一覧用のデータを取得
- getList() : mixed
- ユーザーリストを取得する
- getNew() : User
- ユーザーの新規データ用の初期値を含んだエンティティを取得する
- isAvailable() : bool
- ユーザーが有効化チェックする
- login() : array<string|int, mixed>|false
- ログイン
- loginToAgent() : bool
- 代理ログインを行う
- logout() : array<string|int, mixed>|false
- ログアウト
- reload() : bool
- ログイン情報をリロードする
- reLogin() : array<string|int, mixed>|false
- 再ログイン
- removeLoginKey() : int
- ログインキーを削除する
- returnLoginUserFromAgent() : array<string|int, mixed>|mixed|string
- 代理ログインから元のユーザーに戻る
- setCookieAutoLoginKey() : Response
- ログイン状態の保存のキー送信
- update() : EntityInterface
- ユーザー情報を更新する
- getAuthSessionKey() : false|string
- 認証用のセッションキーを取得
Properties
$LoginStores
public
LoginStoresTable
$LoginStores
$Users
public
UsersTable
$Users
Methods
__construct()
UsersService constructor.
public
__construct() : mixed
Tags
Return values
mixed —checkAutoLogin()
ログイン状態の保存確認
public
checkAutoLogin(ServerRequest $request, Response $response) : User|false
Parameters
- $request : ServerRequest
- $response : Response
Tags
Return values
User|false —create()
ユーザー登録
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterface —delete()
ユーザー情報を削除する 最後のシステム管理者でなければ削除
public
delete(int $id) : bool
Parameters
- $id : int
Tags
Return values
bool —get()
ユーザーを取得する
public
get(int $id) : User
Parameters
- $id : int
Tags
Return values
User —getIndex()
ユーザー管理の一覧用のデータを取得
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
Query —getList()
ユーザーリストを取得する
public
getList([array<string|int, mixed> $queryParams = [] ]) : mixed
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
mixed —getNew()
ユーザーの新規データ用の初期値を含んだエンティティを取得する
public
getNew() : User
Tags
Return values
User —isAvailable()
ユーザーが有効化チェックする
public
isAvailable(int $id) : bool
status フィールドが false の場合は無効とみなす。
Parameters
- $id : int
Tags
Return values
bool —login()
ログイン
public
login(ServerRequest $request, Response $response, $id) : array<string|int, mixed>|false
Parameters
Tags
Return values
array<string|int, mixed>|false —loginToAgent()
代理ログインを行う
public
loginToAgent(ServerRequest $request, Response $response, int $id[, string $referer = '' ]) : bool
Parameters
- $request : ServerRequest
- $response : Response
- $id : int
- $referer : string = ''
Tags
Return values
bool —logout()
ログアウト
public
logout(ServerRequest $request, Response $response, mixed $id) : array<string|int, mixed>|false
Parameters
- $request : ServerRequest
- $response : Response
- $id : mixed
Tags
Return values
array<string|int, mixed>|false —reload()
ログイン情報をリロードする
public
reload(ServerRequest $request) : bool
Parameters
- $request : ServerRequest
Tags
Return values
bool —reLogin()
再ログイン
public
reLogin(ServerRequest $request, Response $response) : array<string|int, mixed>|false
Parameters
- $request : ServerRequest
- $response : Response
Tags
Return values
array<string|int, mixed>|false —removeLoginKey()
ログインキーを削除する
public
removeLoginKey(int $id) : int
Parameters
- $id : int
Tags
Return values
int —削除行数
returnLoginUserFromAgent()
代理ログインから元のユーザーに戻る
public
returnLoginUserFromAgent(ServerRequest $request, Response $response) : array<string|int, mixed>|mixed|string
Parameters
- $request : ServerRequest
- $response : Response
Tags
Return values
array<string|int, mixed>|mixed|string —setCookieAutoLoginKey()
ログイン状態の保存のキー送信
public
setCookieAutoLoginKey(mixed $response, int $id) : Response
Parameters
- $response : mixed
- $id : int
Tags
Return values
Response —update()
ユーザー情報を更新する
public
update(EntityInterface $target, array<string|int, mixed> $postData) : EntityInterface
Parameters
- $target : EntityInterface
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterface —getAuthSessionKey()
認証用のセッションキーを取得
private
getAuthSessionKey(string $prefix) : false|string
Parameters
- $prefix : string