Documentation

SectionController extends ControllerBase
in package

Section controller.

Sections can be of two types:

  • Defined containers, e.g. those represented by actual "section" objects
  • Ad-hoc containers, e.g. those without actual "section" objects

Both types will return a section object, in the case of an ad-hoc section, section object will by dehydrated and will not have an ID.

Table of Contents

indexAction()  : mixed
Section view action, by default accepts URLs in the form of:
initialize()  : mixed
Initialize response headers
enableCompatibilityView()  : bool
Enables path to Gryphon compatible view, if the view exists AND enableCompatibility is on.
getHttpCodeDescription()  : mixed
getJsonData()  : array<string|int, mixed>
Fetch POSTed/PUTed json data
getRequestSegments()  : mixed
Return rewrite url segments
terminateWithView()  : mixed
Terminate the action with a view partial. Will dump output directly to browser, but return the action allowing process to continue.

Methods

indexAction()

Section view action, by default accepts URLs in the form of:

public indexAction() : mixed
  • section/SLUG

Returns the following items to the view:

Looks for templates in the following order:

  • gryphon/section/main.tpl - Compatibility mode
  • section/index.twig
Return values
mixed —

initialize()

Initialize response headers

public initialize() : mixed
Return values
mixed —

enableCompatibilityView()

Enables path to Gryphon compatible view, if the view exists AND enableCompatibility is on.

protected enableCompatibilityView(string $view) : bool

NOTE: This will mutate the internal view.

Parameters
$view : string
Return values
bool —

getHttpCodeDescription()

protected getHttpCodeDescription(mixed $code) : mixed
Parameters
$code : mixed
Return values
mixed —

getJsonData()

Fetch POSTed/PUTed json data

protected getJsonData() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getRequestSegments()

Return rewrite url segments

protected getRequestSegments([mixed $i = null ]) : mixed
Parameters
$i : mixed = null
Return values
mixed —

either all segments as array, or single segment

terminateWithView()

Terminate the action with a view partial. Will dump output directly to browser, but return the action allowing process to continue.

protected terminateWithView(string $view[, array<string|int, mixed> $params = [] ][, array<string|int, mixed> $headers = [] ]) : mixed
Parameters
$view : string

path

$params : array<string|int, mixed> = []

view params

$headers : array<string|int, mixed> = []

optional headers

Return values
mixed —

Search results