UsersServiceInterface
extends
CrudBaseServiceInterface
in
Interface UsersServiceInterface
Table of Contents
Methods
- checkAutoLogin() : User|false
- ログイン状態の保存確認
- create() : EntityInterface
- 新規登録する
- delete() : mixed
- 削除する
- get() : EntityInterface
- 単一データを取得する
- getIndex() : Query
- 複数データを取得
- getList() : array<string|int, mixed>
- リストデータを取得(コントロールソースに利用)
- getNew() : EntityInterface
- 新しいデータの初期値を取得する
- 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() : mixed
- 編集する
Methods
checkAutoLogin()
ログイン状態の保存確認
public
checkAutoLogin(ServerRequest $request, Response $response) : User|false
Parameters
- $request : ServerRequest
- $response : Response
Tags
Return values
User|falsecreate()
新規登録する
public
create(array<string|int, mixed> $postData) : EntityInterface
Parameters
- $postData : array<string|int, mixed>
Tags
Return values
EntityInterfacedelete()
削除する
public
delete(int $id) : mixed
Parameters
- $id : int
Tags
get()
単一データを取得する
public
get(int $id) : EntityInterface
Parameters
- $id : int
Tags
Return values
EntityInterfacegetIndex()
複数データを取得
public
getIndex([array<string|int, mixed> $queryParams = [] ]) : Query
Parameters
- $queryParams : array<string|int, mixed> = []
Tags
Return values
QuerygetList()
リストデータを取得(コントロールソースに利用)
public
getList() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getNew()
新しいデータの初期値を取得する
public
getNew() : EntityInterface
Tags
Return values
EntityInterfaceisAvailable()
ユーザーが有効化チェックする
public
isAvailable(int $id) : bool
Parameters
- $id : int
Tags
Return values
boollogin()
ログイン
public
login(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>|falseloginToAgent()
代理ログインを行う
public
loginToAgent(ServerRequest $request, Response $response, int $id[, string $referer = '' ]) : bool
Parameters
- $request : ServerRequest
- $response : Response
- $id : int
- $referer : string = ''
Tags
Return values
boollogout()
ログアウト
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>|falsereload()
ログイン情報をリロードする
public
reload(ServerRequest $request) : bool
Parameters
- $request : ServerRequest
Tags
Return values
boolreLogin()
再ログイン
public
reLogin(ServerRequest $request, Response $response) : array<string|int, mixed>|false
Parameters
- $request : ServerRequest
- $response : Response
Tags
Return values
array<string|int, mixed>|falseremoveLoginKey()
ログインキーを削除する
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|stringsetCookieAutoLoginKey()
ログイン状態の保存のキー送信
public
setCookieAutoLoginKey(mixed $response, int $id) : Response
Parameters
- $response : mixed
- $id : int
Tags
Return values
Responseupdate()
編集する
public
update(EntityInterface $target, array<string|int, mixed> $postData) : mixed
Parameters
- $target : EntityInterface
- $postData : array<string|int, mixed>