a-blog cms PHP API Reference

Engine
in package

Table of Contents

Properties

$payload  : mixed
$whiteList  : array<string|int, mixed>

Methods

__construct()  : mixed
Engine constructor.
call()  : mixed
validateUrlScheme()  : bool
URLのスキーマが http or https か確認する
validateUrlWhiteList()  : bool
URLのホストがホワイトリストに含まれるか確認
buildPayload()  : mixed
getHooks()  : mixed
getPayload()  : false|mixed
saveLog()  : mixed
send()  : mixed

Properties

$payload

protected mixed $payload
Tags
@var

\Acms\Services\Webhook\Payload;

$whiteList

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

Methods

__construct()

Engine constructor.

public __construct(mixed $payload, mixed $whiteList) : mixed
Parameters
$payload : mixed
$whiteList : mixed

call()

public call(int $bid, string $type, array<string|int, mixed>|string $events[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$bid : int
$type : string
$events : array<string|int, mixed>|string
$args : array<string|int, mixed> = []

validateUrlScheme()

URLのスキーマが http or https か確認する

public validateUrlScheme(string $url) : bool
Parameters
$url : string
Return values
bool

validateUrlWhiteList()

URLのホストがホワイトリストに含まれるか確認

public validateUrlWhiteList(string $url) : bool
Parameters
$url : string
Return values
bool

buildPayload()

protected buildPayload(mixed $payload, mixed $tpl) : mixed
Parameters
$payload : mixed
$tpl : mixed

getHooks()

protected getHooks(int $bid, string $type, array<string|int, mixed> $events) : mixed
Parameters
$bid : int
$type : string
$events : array<string|int, mixed>

getPayload()

protected getPayload(string $type, array<string|int, mixed> $events[, array<string|int, mixed> $args = [] ]) : false|mixed
Parameters
$type : string
$events : array<string|int, mixed>
$args : array<string|int, mixed> = []
Return values
false|mixed

saveLog()

protected saveLog(mixed $curl, mixed $response, mixed $id, mixed $endpoint, mixed $events, mixed $requestHeader, mixed $requestBody) : mixed
Parameters
$curl : mixed
$response : mixed
$id : mixed
$endpoint : mixed
$events : mixed
$requestHeader : mixed
$requestBody : mixed

send()

protected send(array<string|int, mixed> $hook, string $payload, array<string|int, mixed> $events) : mixed
Parameters
$hook : array<string|int, mixed>
$payload : string
$events : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results