[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Application/ -> ApiApplication.php (summary)

Joomla! Content Management System

Copyright: (C) 2019 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 412 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 10 functions

  __construct()
  doExecute()
  addFormatMap()
  render()
  respond()
  getTemplate()
  route()
  handlePreflight()
  getApiRouter()
  dispatch()

Functions
Functions that are not part of a class:

__construct(JInputJson $input = null, Registry $config = null, WebClient $client = null, Container $container = null)   X-Ref
Class constructor.

param: JInputJson  $input      An optional argument to provide dependency injection for the application's input
param: Registry    $config     An optional argument to provide dependency injection for the application's config
param: WebClient   $client     An optional argument to provide dependency injection for the application's client
param: Container   $container  Dependency injection container.

doExecute()   X-Ref
Method to run the application routines.

Most likely you will want to instantiate a controller and execute it, or perform some sort of task directly.

return: void

addFormatMap($contentHeader, $format)   X-Ref
Adds a mapping from a content type to the format stored. Note the format type cannot be overwritten.

param: string  $contentHeader  The content header
param: string  $format         The content type format
return: void

render()   X-Ref
Rendering is the process of pushing the document buffers into the template
placeholders, retrieving data from the document and pushing it into
the application response buffer.

return: void

respond($options = array()   X-Ref
Method to send the application response to the client.  All headers will be sent prior to the main application output data.

param: array  $options  An optional argument to enable CORS. (Temporary)
return: void

getTemplate($params = false)   X-Ref
Gets the name of the current template.

param: boolean  $params  True to return the template parameters
return: string|\stdClass

route()   X-Ref
Route the application.

Routing is the process of examining the request environment to determine which
component should receive the request. The component optional parameters
are then set in the request object to be processed when the application is being
dispatched.

return: void

handlePreflight($method, $router)   X-Ref
Handles preflight requests.

param: String     $method  The REST verb
param: ApiRouter  $router  The API Routing object
return: void

getApiRouter()   X-Ref
No description

dispatch($component = null)   X-Ref
Dispatch the application

param: string  $component  The component which is being rendered.
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer