class SearchController extends BaseController

Search 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

array
getHeaders()

Return current headers

string
getPayload()

Return payload

setStatusCode(int $code)

Set status code

setHeaders(string $key, string $value)

Set header value

setPayload(string $payload)

Set payload

static 
startBatchMode()

Static method to enable batch mode return handling

static 
endBatchMode()

Static method to disable batch mode return handling

Dispatcher
indexAction()

Forwards to search action

Response
searchAction($type = null)

Search

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 30
Dispatcher indexAction()

Forwards to search action

Return Value

Dispatcher

at line line 60
Response searchAction($type = null)

Search

Current runs a sphinx search and paginates against the DB This could change in the future.

Valid search parameters:

  • keywords - freeform key words
  • slug - item slug
  • type - currently only accepts 'content', 'container', 'user', 'author', 'tag'
  • filters - key/value array of filter params:
    • attachment_type - 'image', 'pdf', etc
    • attachment_name - file name
    • content_type - 'article', 'post', 'page', etc
  • has_attachment - 1 for items with attachments, 0 for items without. Leave out if you want any

Parameters

$type

Return Value

Response