Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class ApiApplication - list of methods

Joomla! API Application class

Extends

CMSApplication
Package: Joomla\CMS\Application
Copyright: (C) 2019 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
Located at: Joomla/Application/ApiApplication.php
Project: Joomla

Method Summary

public
__construct
(\Joomla\Input\Json $input = null, \Joomla\Registry\Registry $config = null, \Joomla\Application\Web\WebClient $client = null, \Joomla\DI\Container $container = null)

Class constructor.
Parameters
  • \Joomla\Input\Json $input An optional argument to provide dependency injection for the application's input object. If the argument is a JInput object that object will become the application's input object, otherwise a default input object is created.
  • \Joomla\Registry\Registry $config An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.
  • \Joomla\Application\Web\WebClient $client An optional argument to provide dependency injection for the application's client object. If the argument is a WebClient object that object will become the application's client object, otherwise a default client object is created.
  • \Joomla\DI\Container $container Dependency injection container.
Since
  • 4.0.0
Show source code of this method: __construct Source Code

protected void
()

Method to run the application routines.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: doExecute Source Code

public void
(mixed $contentHeader, mixed $format)

Adds a mapping from a content type to the format stored. Note the format type cannot be overwritten.
Parameters
  • string $contentHeader The content header
  • string $format The content type format
Returns
  • void
Since
  • 4.0.0
Show source code of this method: addFormatMap Source Code

protected void
()

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.
Returns
  • void
Since
  • 4.0.0
-
  • Rendering should be overridden to get rid of the theme files.
Show source code of this method: render Source Code

protected void
(mixed $options = array())

Method to send the application response to the client. All headers will be sent prior to the main application output data.
Parameters
  • array $options An optional argument to enable CORS. (Temporary)
Returns
  • void
Since
  • 4.0.0
Show source code of this method: respond Source Code

public string|\stdClass
(mixed $params = false)

Gets the name of the current template.
Parameters
  • bool $params True to return the template parameters
Returns
  • string|\stdClass
Since
  • 4.0.0
Show source code of this method: getTemplate Source Code

protected void
()

Route the application.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: route Source Code

protected void
(mixed $method, mixed $router)

Handles preflight requests.
Parameters
  • string $method The REST verb
  • \Joomla\CMS\Router\ApiRouter $router The API Routing object
Returns
  • void
Since
  • 4.0.0
Show source code of this method: handlePreflight Source Code

public \Joomla\CMS\Router\ApiRouter
()

Returns the application Router object.
Returns
  • \Joomla\CMS\Router\ApiRouter
Since
  • 4.0.0
Show source code of this method: getApiRouter Source Code

public void
(mixed $component = null)

Dispatch the application
Parameters
  • string $component The component which is being rendered.
Returns
  • void
Since
  • 4.0.0
Show source code of this method: dispatch Source Code

Properties Summary

protected array
$formatMapper
Maps extension types to their
Since
  • 4.0.0
protected string
$authenticationPluginType
The authentication plugin type
Since
  • 4.0.0

Tags Summary

Since
4.0.0