UserFrosting API

CoreController extends SimpleController

CoreController Class.

Implements some common sitewide routes.

Tags
author

Alex Weissman (https://alexanderweissman.com)

see
http://www.userfrosting.com/navigating/#structure

Table of Contents

$ci ContainerInterface
pageIndex() Renders the default home page for UserFrosting. mixed
pageAbout() Renders a sample "about" page for UserFrosting. mixed
pageLegal() Renders terms of service page. mixed
pagePrivacy() Renders privacy page. mixed
jsonAlerts() Render the alert stream as a JSON object. mixed
getAsset() Handle all requests for raw assets. mixed
__construct() Constructor. mixed

Properties

Methods

pageIndex()

Renders the default home page for UserFrosting.

public pageIndex( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

By default, this is the page that non-authenticated users will first see when they navigate to your website's root. Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Return values
mixed

pageAbout()

Renders a sample "about" page for UserFrosting.

public pageAbout( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Tags
codeCoverageIgnore
Return values
mixed

pageLegal()

Renders terms of service page.

public pageLegal( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Tags
codeCoverageIgnore
Return values
mixed

pagePrivacy()

Renders privacy page.

public pagePrivacy( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Tags
codeCoverageIgnore
Return values
mixed

jsonAlerts()

Render the alert stream as a JSON object.

public jsonAlerts( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

The alert stream contains messages which have been generated by calls to MessageStream::addMessage and MessageStream::addMessageTranslated. Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Return values
mixed

getAsset()

Handle all requests for raw assets.

public getAsset( $request : ServerRequestInterface , $response : ResponseInterface , $args : array ) : mixed

Request type: GET.

Parameters
$request : ServerRequestInterface
$response : ResponseInterface
$args : array
Return values
mixed

__construct()

Constructor.

public __construct( $ci : ContainerInterface ) : mixed
Parameters
$ci : ContainerInterface

The global container object, which holds all your services.

Return values
mixed

Search results