a-blog cms PHP API Reference

EngineV1 extends Api
in package

Table of Contents

Properties

$allowOriginDomains  : array<string|int, mixed>
$apiInfo  : array<string|int, mixed>
$apiKey  : string
$restrictionAddress  : array<string|int, mixed>
$restrictionReferrer  : array<string|int, mixed>

Methods

__construct()  : mixed
Constructor
get()  : mixed
addAllowOriginHeader()  : void
Add Allow Origin Header
buildResponse()  : string
APIのレスポンスを組み立て
exec()  : never
GET APIを実行
getModuleName()  : string
jsonValidate()  : bool
文字列が有効なJSONかどうかを検証する
logging()  : void
ロギング
notFound()  : void
404 Not Found
response()  : never
レスポンス
validateAddress()  : void
Validate Remote Address
validateApiKey()  : void
Validate API Key
validateReferrer()  : void
Validate Http Referrer

Properties

$allowOriginDomains

protected array<string|int, mixed> $allowOriginDomains = []

$apiInfo

protected array<string|int, mixed> $apiInfo = []

$apiKey

protected string $apiKey = ''

$restrictionAddress

protected array<string|int, mixed> $restrictionAddress = []

$restrictionReferrer

protected array<string|int, mixed> $restrictionReferrer = []

Methods

__construct()

Constructor

public __construct() : mixed

get()

public get(string $identifier) : mixed
Parameters
$identifier : string

addAllowOriginHeader()

Add Allow Origin Header

protected addAllowOriginHeader() : void

buildResponse()

APIのレスポンスを組み立て

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

exec()

GET APIを実行

protected exec(array<string|int, mixed> $apiInfo) : never
Parameters
$apiInfo : array<string|int, mixed>
Return values
never

getModuleName()

protected getModuleName(string $identifier) : string
Parameters
$identifier : string
Tags
throws
NotFoundModuleException
Return values
string

jsonValidate()

文字列が有効なJSONかどうかを検証する

protected jsonValidate(string $json) : bool
Parameters
$json : string
Return values
bool

logging()

ロギング

protected logging(Exception $e, array<string|int, mixed> $info) : void
Parameters
$e : Exception
$info : array<string|int, mixed>

notFound()

404 Not Found

protected notFound(string $message) : void
Parameters
$message : string

response()

レスポンス

protected response(string $json) : never
Parameters
$json : string
Return values
never

validateApiKey()

Validate API Key

protected validateApiKey() : void
Tags
throws
ApiKeyException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results