baserCMS クラスリファレンス

UsersAdminService extends UsersService
in package

Application

implements UsersAdminServiceInterface Uses BcContainerTrait

UsersAdminService

Interfaces

UsersAdminServiceInterface: Interface UsersAdminServiceInterface

Properties

$LoginStores : LoginStoresTable|Table: LoginStores Table
$LoginStores : LoginStoresTable
$UserGroupsService : UserGroupsServiceInterface|UserGroupsService: UserGroups Service
$Users : UsersTable|Table: Users Table
$Users : UsersTable

Methods

__construct() : mixed: Pageservice constructor.
checkAutoLogin() : User|false: ログイン状態の保存確認
create() : EntityInterface: ユーザー登録
delete() : bool: ユーザー情報を削除する最後のシステム管理者でなければ削除
get() : User: ユーザーを取得する
getIndex() : Query: ユーザー管理の一覧用のデータを取得
getList() : mixed: ユーザーリストを取得する
getNew() : User: ユーザーの新規データ用の初期値を含んだエンティティを取得する
getService() : array<string|int, mixed>|mixed|object: Get Service
getViewVarsForAdd() : array<string|int, mixed>: 新規登録画面にに必要なデータを取得する
getViewVarsForEdit() : array<string|int, mixed>: 編集画面に必要なデータを取得する
getViewVarsForLogin() : array<string|int, mixed>: ログイン画面に必要なデータを取得する
hasService() : bool: Has Service
isAvailable() : bool: ユーザーが有効化チェックする
isDeletable() : bool: 削除ができるかどうか
isEditable() : bool: 更新ができるかどうか
isSelf() : bool: ログインユーザー自身のIDか確認
isUserGroupEditable() : 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: 認証用のセッションキーを取得

$LoginStores

LoginStores Table


    public
        LoginStoresTable|Table
    $LoginStores

$LoginStores


    public
        LoginStoresTable
    $LoginStores

$UserGroupsService

UserGroups Service


    public
        UserGroupsServiceInterface|UserGroupsService
    $UserGroupsService

$Users

Users Table


    public
        UsersTable|Table
    $Users

$Users


    public
        UsersTable
    $Users

__construct()

Pageservice constructor.


    public
                    __construct() : mixed

checkAutoLogin()

ログイン状態の保存確認


    public
                    checkAutoLogin(ServerRequest $request, Response $response) : User|false

Parameters

$request : ServerRequest
$response : Response

Return values

User|false

create()

ユーザー登録


    public
                    create(array<string|int, mixed> $postData) : EntityInterface

Parameters

$postData : array<string|int, mixed>

Return values

EntityInterface

delete()

ユーザー情報を削除する最後のシステム管理者でなければ削除


    public
                    delete(int $id) : bool

Parameters

$id : int

Return values

bool

get()

ユーザーを取得する


    public
                    get(int $id) : User

Parameters

$id : int

Return values

User

getIndex()

ユーザー管理の一覧用のデータを取得


    public
                    getIndex([array<string|int, mixed> $queryParams = [] ]) : Query

Parameters

$queryParams : array<string|int, mixed> = []

Return values

Query

getList()

ユーザーリストを取得する


    public
                    getList([array<string|int, mixed> $queryParams = [] ]) : mixed

Parameters

$queryParams : array<string|int, mixed> = []

getNew()

ユーザーの新規データ用の初期値を含んだエンティティを取得する


    public
                    getNew() : User

Return values

User

getService()

Get Service


    public
                    getService( $service) : array<string|int, mixed>|mixed|object

Parameters

$service :

Return values

array<string|int, mixed>|mixed|object

getViewVarsForAdd()

新規登録画面にに必要なデータを取得する


    public
                    getViewVarsForAdd(EntityInterface $user) : array<string|int, mixed>

Parameters

$user : EntityInterface

Return values

array<string|int, mixed>

getViewVarsForEdit()

編集画面に必要なデータを取得する


    public
                    getViewVarsForEdit(EntityInterface $user) : array<string|int, mixed>

Parameters

$user : EntityInterface

Return values

array<string|int, mixed>

getViewVarsForLogin()

ログイン画面に必要なデータを取得する


    public
                    getViewVarsForLogin(ServerRequest $request) : array<string|int, mixed>

Parameters

$request : ServerRequest

Return values

array<string|int, mixed>

hasService()

Has Service


    public
                    hasService( $service) : bool

Parameters

$service :

Return values

bool

isAvailable()

ユーザーが有効化チェックする


    public
                    isAvailable(int $id) : bool

status フィールドが false の場合は無効とみなす。

Parameters

$id : int

Return values

bool

isDeletable()

削除ができるかどうか


    public
                    isDeletable(int $id) : bool

Parameters

$id : int

Return values

bool

isEditable()

更新ができるかどうか


    public
                    isEditable(int $id) : bool

Parameters

$id : int

Return values

bool

isSelf()

ログインユーザー自身のIDか確認


    public
                    isSelf(int $id) : bool

Parameters

$id : int

Return values

bool

isUserGroupEditable()

ユーザーグループが更新可能かどうか


    public
                    isUserGroupEditable( $id) : bool

ログインユーザーがシステム管理ユーザーの場合可
自身に対しての編集でない場合可

Parameters

$id :

Return values

bool

login()

ログイン


    public
                    login(ServerRequest $request, Response $response,  $id) : array<string|int, mixed>|false

Parameters

$request : ServerRequest
$response : Response
$id :

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 = ''

Return values

bool

logout()

ログアウト


    public
                    logout(ServerRequest $request, Response $response, mixed $id) : array<string|int, mixed>|false

Parameters

$request : ServerRequest
$response : Response
$id : mixed

Return values

array<string|int, mixed>|false

reload()

ログイン情報をリロードする


    public
                    reload(ServerRequest $request) : bool

Parameters

$request : ServerRequest

Return values

bool

reLogin()

再ログイン


    public
                    reLogin(ServerRequest $request, Response $response) : array<string|int, mixed>|false

Parameters

$request : ServerRequest
$response : Response

Return values

array<string|int, mixed>|false

removeLoginKey()

ログインキーを削除する


    public
                    removeLoginKey(int $id) : int

Parameters

$id : int

Return values

int —

削除行数

returnLoginUserFromAgent()

代理ログインから元のユーザーに戻る


    public
                    returnLoginUserFromAgent(ServerRequest $request, Response $response) : array<string|int, mixed>|mixed|string

Parameters

$request : ServerRequest
$response : Response

Return values

array<string|int, mixed>|mixed|string

setCookieAutoLoginKey()

ログイン状態の保存のキー送信


    public
                    setCookieAutoLoginKey(mixed $response, int $id) : Response

Parameters

$response : mixed
$id : int

Return values

Response

update()

ユーザー情報を更新する


    public
                    update(EntityInterface $target, array<string|int, mixed> $postData) : EntityInterface

Parameters

$target : EntityInterface
$postData : array<string|int, mixed>

Return values

EntityInterface

getAuthSessionKey()

認証用のセッションキーを取得


    private
                    getAuthSessionKey(string $prefix) : false|string

Parameters

$prefix : string

Return values

false|string

UsersAdminService extends UsersService in package Application implements UsersAdminServiceInterface Uses BcContainerTrait

Table of Contents

Interfaces

Properties

Methods

Properties

$LoginStores

$LoginStores

$UserGroupsService

$Users

$Users

Methods

__construct()

Tags

checkAutoLogin()

Parameters

Tags

Return values

create()

Parameters

Tags

Return values

delete()

Parameters

Tags

Return values

get()

Parameters

Tags

Return values

getIndex()

Parameters

Tags

Return values

getList()

Parameters

Tags

getNew()

Tags

Return values

getService()

Parameters

Tags

Return values

getViewVarsForAdd()

Parameters

Tags

Return values

getViewVarsForEdit()

Parameters

Tags

Return values

getViewVarsForLogin()

Parameters

Tags

Return values

hasService()

Parameters

Tags

Return values

isAvailable()

Parameters

Tags

Return values

isDeletable()

Parameters

Tags

Return values

isEditable()

Parameters

Tags

Return values

isSelf()

Parameters

Tags

Return values

isUserGroupEditable()

Parameters

Tags

Return values

UsersAdminService extends UsersService
in package

Application

implements UsersAdminServiceInterface Uses BcContainerTrait