AlbumController
extends ApiController
in package
Class AlbumController.
Tags
Table of Contents
Properties
- $repository : AlbumRepositoryInterface
- $metadata : array<string|int, mixed>
- $metamessage : string|null
Methods
- __construct() : mixed
- addMetadata() : mixed
- alert() : mixed
- approve() : JsonResponse
- create() : mixed
- destroy() : JsonResponse
- Remove the specified resource from storage.
- edit() : mixed
- error() : JsonResponse
- Error Response.
- feature() : JsonResponse
- getUser() : User
- index() : JsonResource
- Display a listing of the resource.
- info() : JsonResponse
- Info Response.
- items() : JsonResponse
- Display a listing of the resource.
- keepCacheSuccess() : JsonResponse
- Tell client keep its cache and does not response data.
- message() : mixed
- navigate() : mixed
- show() : JsonResponse
- Display the specified resource.
- sponsor() : JsonResponse
- sponsorInFeed() : JsonResponse
- store() : JsonResponse
- Store a newly created resource in storage.
- success() : JsonResponse
- Success Response.
- update() : JsonResponse
- Update the specified resource in storage.
- uploadMedias() : JsonResponse
- warning() : JsonResponse
- Warning Response.
- handleUploadMediasMessage() : string
- processReturn() : JsonResponse
Properties
$repository
public
AlbumRepositoryInterface
$repository
$metadata
private
array<string|int, mixed>
$metadata
= []
$metamessage
private
string|null
$metamessage
= null
Methods
__construct()
public
__construct(AlbumRepositoryInterface $repository) : mixed
Parameters
- $repository : AlbumRepositoryInterface
addMetadata()
public
addMetadata([array<string|int, mixed>|null $meta = [] ]) : mixed
Parameters
- $meta : array<string|int, mixed>|null = []
alert()
public
alert(mixed $alert) : mixed
Parameters
- $alert : mixed
approve()
public
approve(int $id) : JsonResponse
Parameters
- $id : int
Tags
Return values
JsonResponsecreate()
public
create() : mixed
destroy()
Remove the specified resource from storage.
public
destroy(int $id) : JsonResponse
Parameters
- $id : int
Tags
Return values
JsonResponseedit()
public
edit(int $id) : mixed
Parameters
- $id : int
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
JsonResponsefeature()
public
feature(FeatureRequest $request, int $id) : JsonResponse
Parameters
- $request : FeatureRequest
- $id : int
Tags
Return values
JsonResponsegetUser()
public
getUser() : User
Return values
Userindex()
Display a listing of the resource.
public
index(IndexRequest $request) : JsonResource
Parameters
- $request : IndexRequest
Tags
Return values
JsonResourceinfo()
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
JsonResponseitems()
Display a listing of the resource.
public
items(ItemsRequest $request, int $id) : JsonResponse
Parameters
- $request : ItemsRequest
- $id : int
Tags
Return values
JsonResponsekeepCacheSuccess()
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
JsonResponsemessage()
public
message(mixed $message) : mixed
Parameters
- $message : mixed
navigate()
public
navigate(string $url[, bool $replace = false ]) : mixed
Parameters
- $url : string
- $replace : bool = false
show()
Display the specified resource.
public
show(int $id) : JsonResponse
Parameters
- $id : int
Tags
Return values
JsonResponsesponsor()
public
sponsor(SponsorRequest $request, int $id) : JsonResponse
Parameters
- $request : SponsorRequest
- $id : int
Tags
Return values
JsonResponsesponsorInFeed()
public
sponsorInFeed(SponsorInFeedRequest $request, int $id) : JsonResponse
Parameters
- $request : SponsorInFeedRequest
- $id : int
Tags
Return values
JsonResponsestore()
Store a newly created resource in storage.
public
store(StoreRequest $request) : JsonResponse
Parameters
- $request : StoreRequest
Tags
Return values
JsonResponsesuccess()
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
JsonResponseupdate()
Update the specified resource in storage.
public
update(UpdateRequest $request, int $id) : JsonResponse
Parameters
- $request : UpdateRequest
- $id : int
Tags
Return values
JsonResponseuploadMedias()
public
uploadMedias(UploadPhotosRequest $request) : JsonResponse
Parameters
- $request : UploadPhotosRequest
Tags
Return values
JsonResponsewarning()
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
JsonResponsehandleUploadMediasMessage()
protected
handleUploadMediasMessage(array<string|int, mixed> $result) : string
Parameters
- $result : array<string|int, mixed>
Return values
stringprocessReturn()
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> = []