a-blog cms PHP API Reference

Repository
in package

Table of Contents

Properties

$types  : array<string|int, string>
ショートカットに登録できるリソースのタイプ一覧

Methods

__construct()  : mixed
初期化処理
authorizationExists()  : bool
指定したブログにおけるショートカットの存在チェック
delete()  : void
ショートカットの削除
findAll()  : array<string|int, Shortcut>
指定したブログのShortcutを配列で取得
findByAuthorities()  : array<string|int, Shortcut>
指定したブログのShortcutを権限で絞り込んで取得
findOneByKey()  : Shortcut|null
ショートカットの取得
nextSort()  : int
指定したブログにおける次のソート順を取得する
save()  : void
ショートカットの保存
fixRows()  : array<string|int, mixed>
レコードの整形
parseShortcutKey()  : array{bid?: int|null, cid?: int|null, rid?: int|null, mid?: int|null, scid?: int|null, setid?: int|null, admin: string, key: string, type: string}
ショートカットキーの解析

Properties

$types

ショートカットに登録できるリソースのタイプ一覧

private array<string|int, string> $types = []

Methods

__construct()

初期化処理

public __construct(array<string|int, string> $types) : mixed
Parameters
$types : array<string|int, string>

ショートカットに登録できるリソースのタイプ一覧

authorizationExists()

指定したブログにおけるショートカットの存在チェック

public authorizationExists(string $key[, array<string|int, mixed> $authorities = [] ][, int $blogId = BID ]) : bool
Parameters
$key : string
$authorities : array<string|int, mixed> = []
$blogId : int = BID
Return values
bool

findAll()

指定したブログのShortcutを配列で取得

public findAll([int $blogId = BID ]) : array<string|int, Shortcut>
Parameters
$blogId : int = BID
Return values
array<string|int, Shortcut>

findByAuthorities()

指定したブログのShortcutを権限で絞り込んで取得

public findByAuthorities([array<string|int, mixed> $authorities = [] ][, int $blogId = BID ]) : array<string|int, Shortcut>
Parameters
$authorities : array<string|int, mixed> = []
$blogId : int = BID
Return values
array<string|int, Shortcut>

findOneByKey()

ショートカットの取得

public findOneByKey(string $shortcutKey[, int $blogId = BID ]) : Shortcut|null
Parameters
$shortcutKey : string
$blogId : int = BID
Return values
Shortcut|null

nextSort()

指定したブログにおける次のソート順を取得する

public nextSort([int $blogId = BID ]) : int
Parameters
$blogId : int = BID
Return values
int

fixRows()

レコードの整形

protected fixRows(array<string|int, mixed> $rows) : array<string|int, mixed>
Parameters
$rows : array<string|int, mixed>
Return values
array<string|int, mixed>

parseShortcutKey()

ショートカットキーの解析

protected parseShortcutKey(string $key) : array{bid?: int|null, cid?: int|null, rid?: int|null, mid?: int|null, scid?: int|null, setid?: int|null, admin: string, key: string, type: string}
Parameters
$key : string
Return values
array{bid?: int|null, cid?: int|null, rid?: int|null, mid?: int|null, scid?: int|null, setid?: int|null, admin: string, key: string, type: string}

        
On this page

Search results