Documentation

MediaController extends ControllerBase
in package

Media controller is a polymorphic controller that responds differently in different situations depending on the URL.

Table of Contents

embedAction()  : mixed
indexAction()  : mixed
initialize()  : mixed
Initialize response headers
viewAction()  : mixed
Media view action, by default accepts URLs in the form of:
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.
_galleryIndexCompat()  : mixed
_multimediaIndexCompat()  : mixed

Methods

embedAction()

public embedAction(mixed $uuid) : mixed
Parameters
$uuid : mixed
Return values
mixed —

initialize()

Initialize response headers

public initialize() : mixed
Return values
mixed —

viewAction()

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

public viewAction() : mixed
  • media/SLUG
  • multimedia/SLUG
  • gallery/SLUG

Returns the following items to the view:

Looks for templates in the following order:

IF URL IS 'media':

  • media/index.twig

IF URL IS 'multimedia':

  • multimedia/index.twig
  • media/index.twig

IF URL IS 'gallery':

  • gallery/index.twig
  • media/index.twig
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 —

_galleryIndexCompat()

private _galleryIndexCompat() : mixed
Return values
mixed —

_multimediaIndexCompat()

private _multimediaIndexCompat() : mixed
Return values
mixed —

Search results