Référence de la classe ApiApplication

Graphe d'héritage de ApiApplication:

Fonctions membres publiques
	__construct (JInputJson $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
	addFormatMap ($contentHeader, $format)
	getTemplate ($params=false)
	getApiRouter ()
	dispatch ($component=null)
Fonctions membres publiques hérités de CMSApplication
	__construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
	checkSession ()
	enqueueMessage ($msg, $type=self::MSG_INFO)
	getCfg ($varname, $default=null)
	getClientId ()
	getMenu ($name=null, $options=array())
	getMessageQueue ($clear=false)
	getName ()
	getPathway ()
	getTemplate ($params=false)
	getUserState ($key, $default=null)
	getUserStateFromRequest ($key, $request, $default=null, $type='none')
	isHttpsForced ($clientId=null)
	isClient ($identifier)
	login ($credentials, $options=array())
	logout ($userid=null, $options=array())
	redirect ($url, $status=303)
	setUserState ($key, $value)
	toString ($compress=false)
	isCli ()
	setMenuFactory (MenuFactoryInterface $menuFactory)
Fonctions membres publiques hérités de WebApplication
	__construct (Input $input=null, Registry $config=null, WebClient $client=null, ResponseInterface $response=null)
	execute ()
	getDocument ()
	getLanguage ()
	flushAssets ()
	loadDocument (Document $document=null)
	loadLanguage (Language $language=null)
	loadSession (Session $session=null)
	afterSessionStart (SessionEvent $event)
	getConfig ()
Fonctions membres publiques hérités de AbstractWebApplication
	__construct (Input $input=null, Registry $config=null, Web\WebClient $client=null, ResponseInterface $response=null)
	__get ($name)
	execute ()
	getInput ()
	redirect ($url, $status=303)
	allowCache ($allow=null)
	setHeader ($name, $value, $replace=false)
	getHeaders ()
	clearHeaders ()
	sendHeaders ()
	setBody ($content)
	prependBody ($content)
	appendBody ($content)
	getBody ()
	getResponse ()
	isValidHttpStatus ($code)
	setResponse (ResponseInterface $response)
	isSslConnection ()
Fonctions membres publiques hérités de AbstractApplication
	__construct (Registry $config=null)
	close ($code=0)
	execute ()
	get ($key, $default=null)
	getLogger ()
	set ($key, $value=null)
	setConfiguration (Registry $config)
Fonctions membres publiques hérités de LoggerAwareInterface
	setLogger (LoggerInterface $logger)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de ContainerAwareInterface
	setContainer (Container $container)
Fonctions membres publiques hérités de CMSWebApplicationInterface
	getDocument ()
Fonctions membres publiques hérités de SessionAwareWebApplicationInterface
	getSession ()
	setSession (SessionInterface $session)
	checkToken ($method='post')
	getFormToken ($forceNew=false)
Fonctions membres publiques hérités de CMSApplicationInterface
	getMessageQueue ()
	getIdentity ()
	getInput ()
	getLanguage ()
	loadIdentity (User $identity=null)
Fonctions membres publiques hérités de ExtensionManagerInterface
	bootComponent ($component)
	bootModule ($module, $applicationName)
	bootPlugin ($plugin, $type)
Fonctions membres publiques hérités de EventAwareInterface
	getDispatcher ()
	triggerEvent ($eventName, $args=[])

Fonctions membres protégées
	doExecute ()
	render ()
	respond ($options=array())
	handlePreflight ($method, $router)
Fonctions membres protégées hérités de CMSApplication
	checkUserRequireReset ($option, $view, $layout, $tasks)
	initialiseApp ($options=array())
	loadLibraryLanguage ()
	render ()
	route ()
	isTwoFactorAuthenticationRequired ()
Fonctions membres protégées hérités de WebApplication
	render ()
	loadSystemUris ($requestUri=null)
Fonctions membres protégées hérités de AbstractWebApplication
	compress ()
	respond ()
	getHttpStatusValue ($value)
	checkConnectionAlive ()
	checkHeadersSent ()
	detectRequestUri ()
	header ($string, $replace=true, $code=null)
	isRedirectState ($state)
	loadSystemUris ($requestUri=null)
Fonctions membres protégées hérités de AbstractApplication
	dispatchEvent (string $eventName, ?EventInterface $event=null)
	doExecute ()
	initialise ()

Attributs protégés
	$formatMapper = array()
	$authenticationPluginType = 'api-authentication'
Attributs protégés hérités de CMSApplication
	$docOptions = array()
	$clientId = null
	$messageQueue = array()
	$name = null
	$profiler = null
	$template = null
	$pathway = null
	$authenticationPluginType = 'authentication'
	$menus = []
Attributs protégés hérités de WebApplication
	$document
	$language
Attributs protégés hérités de AbstractWebApplication
	$input
	$response
Attributs protégés hérités de AbstractApplication
	$config

Membres hérités additionnels
Fonctions membres publiques statiques hérités de CMSApplication
static	getInstance ($name=null, $prefix='\JApplication', Container $container=null)
static	getRouter ($name=null, array $options=array())
Fonctions membres publiques statiques hérités de WebApplication
static	getInstance ($name=null)
Fonctions membres publiques statiques hérités de AbstractWebApplication
static	isAscii ($str)
Champs de données hérités de CMSApplication
	$scope = null
Champs de données hérités de AbstractWebApplication
	$charSet = 'utf-8'
	$mimeType = 'text/html'
	$httpVersion = '1.1'
	$modifiedDate
	$client
Champs de données hérités de CMSApplicationInterface
const	MSG_EMERGENCY = 'emergency'
const	MSG_ALERT = 'alert'
const	MSG_CRITICAL = 'critical'
const	MSG_ERROR = 'error'
const	MSG_WARNING = 'warning'
const	MSG_NOTICE = 'notice'
const	MSG_INFO = 'info'
const	MSG_DEBUG = 'debug'
Attributs protégés statiques hérités de CMSApplication
static	$instances = array()
Attributs protégés statiques hérités de WebApplication
static	$instance

Description détaillée

Joomla! API Application class

Depuis

4.0.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	JInputJson	$input = null,
		Registry	$config = null,
		WebClient	$client = null,
		Container	$container = null
	)

Class constructor.

Paramètres

JInputJson	$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.
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.
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.
Container	$container	Dependency injection container.

Depuis

4.0.0

Références $client, $config, $container, $input, Symfony\Contracts\Service\__construct(), Uri\base(), name, null, et Uri\root().

Documentation des fonctions membres

addFormatMap()

addFormatMap	(		$contentHeader,
			$format
	)

Adds a mapping from a content type to the format stored. Note the format type cannot be overwritten.

Paramètres

string	$contentHeader	The content header
string	$format	The content type format

Renvoie

void

Depuis

4.0.0

Références $format.

dispatch()

dispatch

(

$component = null

)

Dispatch the application

Paramètres

string

$component

The component which is being rendered.

Renvoie

void

Depuis

4.0.0

Références $component, $document, Factory\$document, Factory\getDocument(), PluginHelper\importPlugin(), null, et Joomla\CMS\Application\triggerEvent().

doExecute()

doExecute ( )

protected

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.

Renvoie

void

Depuis

4.0.0

Références JDEBUG, et null.

getApiRouter()

getApiRouter

(

)

Returns the application Router object.

Renvoie

ApiRouter

Depuis

4.0.0

Obsolète:

5.0 Inject the router or load it from the dependency injection container

Références class, et Joomla\DI\getContainer().

getTemplate()

getTemplate

(

$params = false

)

Gets the name of the current template.

Paramètres

boolean

$params

True to return the template parameters

Renvoie

string|

Depuis

4.0.0

Références $params, et $template.

handlePreflight()

handlePreflight (   $method,   $router  )

protected

Handles preflight requests.

Paramètres

String	$method	The REST verb
ApiRouter	$router	The API Routing object

Renvoie

void

Depuis

4.0.0

If not an OPTIONS request or CORS is not enabled, there's nothing useful to do here.

Obtain allowed CORS origin from Global Settings. Set to * (=all) if not set.

Obtain allowed CORS headers from Global Settings. Set to sensible default if not set.

Obtain allowed CORS methods from Global Settings. Set to methods exposed by current route if not set.

Références $method, et $route.

render()

render ( )

protected

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.

Renvoie

void

Depuis

4.0.0

Note

Rendering should be overridden to get rid of the theme files.

Références $this.

respond()

respond (   $options = array() )

protected

Method to send the application response to the client. All headers will be sent prior to the main application output data.

Paramètres

array

$options

An optional argument to enable CORS. (Temporary)

Renvoie

void

Depuis

4.0.0

Enable CORS (Cross-origin resource sharing) Obtain allowed CORS origin from Global Settings. Set to * (=all) if not set.

Références null.

Documentation des champs

$authenticationPluginType

$authenticationPluginType = 'api-authentication'

protected

$formatMapper

$formatMapper = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• ApiApplication.php