Documentation

BaseJsonPage extends BasePage
in package

AbstractYes

Base for pages rendering a JSON response

Table of Contents

Properties

$translators  : array<string|int, mixed>
$container  : ContainerInterface
$request  : Request|null
$response  : Response
$route_info  : RouteInfo|null

Methods

__call()  : mixed
{@inheritdoc}
__construct()  : mixed
BasePage constructor.
__toString()  : string
toString magic method
canBeFPC()  : bool
specifies if this controller is eligible for full page cache
containerCall()  : mixed
call method through container
containerMake()  : mixed
create object through container
getApp()  : App
gets app object
getAppRouteInfo()  : RouteInfo|null
gets route info
getAppWebsite()  : Website|null
gets current website
getAssets()  : Manager
gets assets manager
getCache()  : Manager
get cache manager
getContainer()  : ContainerInterface
gets container object
getControllerUrl()  : string
gets current controller url
getCrudRouter()  : Crud
gets crud service
getDb()  : Database
gets db object
getDebugbar()  : StandardDebugBar
gets debugbar object
getDestParam()  : string
gets the destination param
getEnv()  : mixed
gets env variable
getEventManager()  : SharedEventEmitter
gets events manager service
getGoogleAuthenticator()  : PHPGangsta_GoogleAuthenticator
gets google authenticator service
getGuzzle()  : Client
gets guzzle service
getHtmlRenderer()  : HtmlPartsRenderer
gets html renderer service
getIcons()  : Icons
gets icons service
getImagine()  : Imagine
gets imagine service
getLog()  : Logger
gets log object
getMailer()  : Mailer
gets mailer service
getPageRouteName()  : string
gets controller route name
getPdo()  : PDO
gets PDO object
getRedis()  : Manager
gets redis service
getRequest()  : Request
get request object
getRouteInfo()  : RouteInfo|null
get route_info
getRouteName()  : string
gets current route name
getRouters()  : array<string|int, mixed>
gets routers
getSchema()  : Schema
gets schema object
getSearch()  : Manager
gets search service
getSesMailer()  : SesClient
gets SES mailer service
getSiteData()  : SiteData
gets site data service
getSmtpMailer()  : Swift_Mailer
gets SMTP mailer service
getTemplates()  : Engine
gets plates engine object
getTranslator()  : Translator
gets translator
getUrl()  : string
gets url by route_name and params
getUtils()  : Globals
gets global utils service
getWebhooksRouter()  : Webhooks
gets webhooks service
getWebRouter()  : Web
gets routing service
getZip()  : Zip
gets zip service
isEnabled()  : bool
determines if route is available for router
process()  : Response
controller action
renderPage()  : Response|self
controller entrypoint
requestUrl()  : string|bool
executes an http request
setRouteInfo()  : BasePage
set route info
beforeRender()  : Response|self
before render hook
doRedirect()  : RedirectResponse
returns a redirect object
getJsonData()  : mixed
gets JSON data
getResponse()  : Response
get response object
getRouteData()  : mixed
gets route data
getService()  : mixed
gets registered service

Properties

$translators

public static array<string|int, mixed> $translators = []

translators

$response

protected Response $response

response object

Methods

__construct()

BasePage constructor.

public __construct(ContainerInterface $container[, Request $request = null ][, RouteInfo $route_info = null ]) : mixed
Parameters
$container : ContainerInterface
$request : Request = null
$route_info : RouteInfo = null
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException

__toString()

toString magic method

public __toString() : string
Return values
string —

the form html

canBeFPC()

specifies if this controller is eligible for full page cache

public canBeFPC() : bool
Return values
bool

containerCall()

call method through container

public containerCall(callable $callable[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$callable : callable
$arguments : array<string|int, mixed> = []

containerMake()

create object through container

public containerMake(string $className[, array<string|int, mixed> $arguments = [] ]) : mixed
Parameters
$className : string
$arguments : array<string|int, mixed> = []

getContainer()

gets container object

public getContainer() : ContainerInterface
Return values
ContainerInterface

getControllerUrl()

gets current controller url

public getControllerUrl() : string
Tags
throws
BasicException
Return values
string

getDb()

gets db object

public getDb() : Database
Tags
throws
BasicException
Return values
Database

getDebugbar()

gets debugbar object

public getDebugbar() : StandardDebugBar
Tags
throws
BasicException
Return values
StandardDebugBar

getDestParam()

gets the destination param

public getDestParam([null $destination_url = null ]) : string
Parameters
$destination_url : null = null
Tags
throws
BasicException
Return values
string

getEnv()

gets env variable

public getEnv(string $variable[, mixed $default = null ]) : mixed
Parameters
$variable : string
$default : mixed = null
Tags
throws
BasicException

getEventManager()

gets events manager service

public getEventManager() : SharedEventEmitter
Tags
throws
BasicException
Return values
SharedEventEmitter

getGoogleAuthenticator()

gets google authenticator service

public getGoogleAuthenticator() : PHPGangsta_GoogleAuthenticator
Tags
throws
BasicException
Return values
PHPGangsta_GoogleAuthenticator

getGuzzle()

gets guzzle service

public getGuzzle() : Client
Tags
throws
BasicException
Return values
Client

getIcons()

gets icons service

public getIcons() : Icons
Tags
throws
BasicException
Return values
Icons

getImagine()

gets imagine service

public getImagine() : Imagine
Tags
throws
BasicException
Return values
Imagine

getLog()

gets log object

public getLog() : Logger
Tags
throws
BasicException
Return values
Logger

getPageRouteName()

gets controller route name

public static getPageRouteName() : string
Return values
string

getPdo()

gets PDO object

public getPdo() : PDO
Tags
throws
BasicException
Return values
PDO

getRequest()

get request object

public getRequest() : Request
Return values
Request

getRouteName()

gets current route name

public getRouteName() : string
Return values
string

getRouters()

gets routers

public getRouters() : array<string|int, mixed>
Tags
throws
BasicException
Return values
array<string|int, mixed>

getSchema()

gets schema object

public getSchema() : Schema
Tags
throws
BasicException
Return values
Schema

getSesMailer()

gets SES mailer service

public getSesMailer() : SesClient
Tags
throws
BasicException
Return values
SesClient

getSmtpMailer()

gets SMTP mailer service

public getSmtpMailer() : Swift_Mailer
Tags
throws
BasicException
Return values
Swift_Mailer

getTemplates()

gets plates engine object

public getTemplates() : Engine
Tags
throws
BasicException
Return values
Engine

getTranslator()

gets translator

public getTranslator([string|null $locale_code = null ]) : Translator
Parameters
$locale_code : string|null = null
Tags
throws
DependencyException
throws
NotFoundException
Return values
Translator

getUrl()

gets url by route_name and params

public getUrl(string $route_name[, array<string|int, mixed> $route_params = [] ]) : string
Parameters
$route_name : string
$route_params : array<string|int, mixed> = []
Tags
throws
BasicException
Return values
string

isEnabled()

determines if route is available for router

public static isEnabled() : bool
Return values
bool

process()

controller action

public process([RouteInfo|null $route_info = null ][, array<string|int, mixed> $route_data = [] ]) : Response
Parameters
$route_info : RouteInfo|null = null
$route_data : array<string|int, mixed> = []
Tags
throws
BasicException
throws
DependencyException
throws
NotFoundException
throws
PhpfastcacheSimpleCacheException
Return values
Response

renderPage()

controller entrypoint

public renderPage([RouteInfo|null $route_info = null ][, array<string|int, mixed> $route_data = [] ]) : Response|self
Parameters
$route_info : RouteInfo|null = null
$route_data : array<string|int, mixed> = []
Tags
throws
PermissionDeniedException
Return values
Response|self

requestUrl()

executes an http request

public requestUrl(string $url[, string $method = 'GET' ][, array<string|int, mixed> $options = [] ]) : string|bool
Parameters
$url : string
$method : string = 'GET'
$options : array<string|int, mixed> = []
Tags
throws
Exception
throws
GuzzleException
Return values
string|bool

doRedirect()

returns a redirect object

protected doRedirect(mixed $url[, array<string|int, mixed> $additional_headers = [] ]) : RedirectResponse
Parameters
$url : mixed
$additional_headers : array<string|int, mixed> = []
Return values
RedirectResponse

getJsonData()

gets JSON data

protected abstract getJsonData() : mixed

getResponse()

get response object

protected getResponse() : Response
Return values
Response

getRouteData()

gets route data

protected getRouteData([null $var_name = null ]) : mixed
Parameters
$var_name : null = null

getService()

gets registered service

protected getService(string $service_key) : mixed
Parameters
$service_key : string
Tags
throws
BasicException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results