Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Theme/ThemeNegotiatorInterface.php

	Code Coverage
	Classes and Traits		Functions and Methods				Lines
Total	100.00% covered (success)	0 / 0	100.00% covered (success)	100.00%	0 / 0	CRAP	100.00% covered (success)	100.00%	0 / 0

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Theme\ThemeNegotiatorInterface.
6	*/
7
8	namespace Drupal\Core\Theme;
9
10	use Drupal\Core\Routing\RouteMatchInterface;
11
12	/**
13	* Defines an interface for classes which determine the active theme.
14	*
15	* To set the active theme, create a new service tagged with 'theme_negotiator'
16	* (see user.services.yml for an example). The only method this service needs
17	* to implement is determineActiveTheme. Return the name of the theme, or NULL
18	* if other negotiators like the configured default one should kick in instead.
19	*
20	* If you are setting a theme which is closely tied to the functionality of a
21	* particular page or set of pages (such that the page might not function
22	* correctly if a different theme is used), make sure to set the priority on
23	* the service to a high number so that it is not accidentally overridden by
24	* other theme negotiators. By convention, a priority of "1000" is used in
25	* these cases; see \Drupal\Core\Theme\AjaxBasePageNegotiator and
26	* core.services.yml for an example.
27	*/
28	interface ThemeNegotiatorInterface {
29
30	/**
31	* Whether this theme negotiator should be used to set the theme.
32	*
33	* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
34	* The current route match object.
35	*
36	* @return bool
37	* TRUE if this negotiator should be used or FALSE to let other negotiators
38	* decide.
39	*/
40	public function applies(RouteMatchInterface $route_match);
41
42	/**
43	* Determine the active theme for the request.
44	*
45	* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
46	* The current route match object.
47	*
48	* @return string\|null
49	* Returns the active theme name, else return NULL.
50	*/
51	public function determineActiveTheme(RouteMatchInterface $route_match);
52
53	}