1. class
  2. Ceo
  3. Api
  4. Controllers
  5. UserController

UserController

class UserController extends BaseController

User controller

Properties

static boolean $batchMode Controller is in batch mode from BaseController
static array $batchedResponses Stack for batched responses from BaseController

Methods

int
getStatusCode()

Return status code

from BaseController
array
getHeaders()

Return current headers

from BaseController
string
getPayload()

Return payload

from BaseController
setStatusCode(int $code)

Set status code

from BaseController
setHeaders(string $key, string $value)

Set header value

from BaseController
setPayload(string $payload)

Set payload

from BaseController
static 
startBatchMode()

Static method to enable batch mode return handling

from BaseController
static 
endBatchMode()

Static method to disable batch mode return handling

from BaseController
Dispatcher
indexAction()

Forwards to list action

array
listAction()

Return users

array
getAction(string $uuid)

Get single user by UUID

array
createAction()

Create new user

array
updateAction(string $uuid)

Update existing user.

array
updateMeAction()

Update the API user, just like update, but only works on current user

array
deleteAction(string $uuid)

Delete user

Details

in BaseController at line line 60
int getStatusCode()

Return status code

Return Value

int

in BaseController at line line 69
array getHeaders()

Return current headers

Return Value

array

in BaseController at line line 78
string getPayload()

Return payload

Return Value

string

in BaseController at line line 87
setStatusCode(int $code)

Set status code

Parameters

int $code HTTP status code

in BaseController at line line 97
setHeaders(string $key, string $value)

Set header value

Parameters

string $key Header name
string $value Header value

in BaseController at line line 106
setPayload(string $payload)

Set payload

Parameters

string $payload

in BaseController at line line 294
static startBatchMode()

Static method to enable batch mode return handling

in BaseController at line line 302
static endBatchMode()

Static method to disable batch mode return handling

at line line 23
Dispatcher indexAction()

Forwards to list action

Return Value

Dispatcher

at line line 32
array listAction()

Return users

Return Value

array

at line line 80
array getAction(string $uuid)

Get single user by UUID

Parameters

string $uuid User UUID

Return Value

array

at line line 101
array createAction()

Create new user

Return Value

array

at line line 132
array updateAction(string $uuid)

Update existing user.

Parameters

string $uuid User UUID

Return Value

array

at line line 165
array updateMeAction()

Update the API user, just like update, but only works on current user

Return Value

array

at line line 210
array deleteAction(string $uuid)

Delete user

Parameters

string $uuid User UUID

Return Value

array