MetaFox

GatewayController extends Controller
in package
Uses Fox4JsonResponse

Table of Contents

Properties

$container  : Container
$controllers  : array<string|int, string>
$dispatcher  : ControllerDispatcher
$request  : Request
$metadata  : array<string|int, mixed>
$metamessage  : string|null

Methods

__call()  : mixed
__construct()  : mixed
ApiGatewayController constructor.
__invoke()  : mixed
addMetadata()  : mixed
alert()  : mixed
callAction()  : mixed
error()  : JsonResponse
Error Response.
info()  : JsonResponse
Info Response.
keepCacheSuccess()  : JsonResponse
Tell client keep its cache and does not response data.
message()  : mixed
navigate()  : mixed
success()  : JsonResponse
Success Response.
warning()  : JsonResponse
Warning Response.
dispatchApiAction()  : mixed
getController()  : Controller
shouldBeCached()  : bool
getFallbackVersion()  : string
processReturn()  : JsonResponse

Properties

$controllers

protected array<string|int, string> $controllers = ['v1' => '', 'v1.1' => '']

Methods

__construct()

ApiGatewayController constructor.

public __construct(Request $request, ControllerDispatcher $dispatcher, Container $container) : mixed
Parameters
$request : Request
$dispatcher : ControllerDispatcher
$container : Container

addMetadata()

public addMetadata([array<string|int, mixed>|null $meta = [] ]) : mixed
Parameters
$meta : array<string|int, mixed>|null = []

callAction()

public callAction(mixed $method, mixed $parameters) : mixed
Parameters
$method : mixed
$parameters : mixed

error()

Error Response.

public error([string $error = '' ][, int $code = 400 ][, array<string|int, mixed> $headers = [] ][, int $options = 0 ]) : JsonResponse
Parameters
$error : string = ''
$code : int = 400
$headers : array<string|int, mixed> = []
$options : int = 0
Return values
JsonResponse

info()

Info Response.

public info([object|array<string|int, mixed>|null $data = [] ][, array<string, mixed> $extra = [] ][, array<string|int, mixed>|string|null $message = null ][, int $code = 200 ][, array<string, mixed> $headers = [] ][, int $options = 0 ]) : JsonResponse
Parameters
$data : object|array<string|int, mixed>|null = []
$extra : array<string, mixed> = []
$message : array<string|int, mixed>|string|null = null
$code : int = 200
$headers : array<string, mixed> = []
$options : int = 0
Return values
JsonResponse

keepCacheSuccess()

Tell client keep its cache and does not response data.

public keepCacheSuccess([array<string|int, mixed> $data = [] ]) : JsonResponse
Parameters
$data : array<string|int, mixed> = []
Return values
JsonResponse

message()

public message(mixed $message) : mixed
Parameters
$message : mixed

navigate()

public navigate(string $url[, bool $replace = false ]) : mixed
Parameters
$url : string
$replace : bool = false

success()

Success Response.

public success([object|array<string|int, mixed>|null $data = [] ][, array<string, mixed> $meta = [] ][, array<string|int, mixed>|string|null $message = null ][, int $code = 200 ][, array<string, mixed> $headers = [] ][, int $options = 0 ]) : JsonResponse
Parameters
$data : object|array<string|int, mixed>|null = []
$meta : array<string, mixed> = []
$message : array<string|int, mixed>|string|null = null
$code : int = 200
$headers : array<string, mixed> = []
$options : int = 0
Return values
JsonResponse

warning()

Warning Response.

public warning([object|array<string|int, mixed>|null $data = [] ][, array<string, mixed> $extra = [] ][, array<string|int, mixed>|string|null $message = null ][, int $code = 200 ][, array<string, mixed> $headers = [] ][, int $options = 0 ]) : JsonResponse
Parameters
$data : object|array<string|int, mixed>|null = []
$extra : array<string, mixed> = []
$message : array<string|int, mixed>|string|null = null
$code : int = 200
$headers : array<string, mixed> = []
$options : int = 0
Return values
JsonResponse

getFallbackVersion()

private getFallbackVersion() : string
Return values
string

processReturn()

private processReturn(string $status, mixed|object $data[, array<string|int, mixed>|string|null $message = null ][, string|null $error = null ][, int $code = 200 ][, array<string|int, mixed> $headers = [] ][, int $options = JSON_PRETTY_PRINT ][, array<string|int, mixed> $meta = [] ]) : JsonResponse
Parameters
$status : string
$data : mixed|object
$message : array<string|int, mixed>|string|null = null
$error : string|null = null
$code : int = 200
$headers : array<string|int, mixed> = []
$options : int = JSON_PRETTY_PRINT
$meta : array<string|int, mixed> = []
Return values
JsonResponse 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results