class AmpContext in Accelerated Mobile Pages (AMP) 8.3

Provides a helper class to determine whether the route is an amp one.

Hierarchy

• class \Drupal\Core\DependencyInjection\ServiceProviderBase implements ServiceModifierInterface, ServiceProviderInterface
  • class \Drupal\amp\Routing\AmpContext

4 files declare their use of AmpContext

AmpEventSubscriber.php in src/EventSubscriber/AmpEventSubscriber.php

AmpHtmlResponseAttachmentsProcessor.php in src/Render/AmpHtmlResponseAttachmentsProcessor.php

AmpNegotiator.php in src/Theme/AmpNegotiator.php

AMPService.php in src/Service/AMPService.php

1 string reference to 'AmpContext'

amp.services.yml in ./amp.services.yml

amp.services.yml

1 service uses AmpContext

router.amp_context in ./amp.services.yml

Drupal\amp\Routing\AmpContext

File

src/Routing/AmpContext.php, line 17

Namespace

Drupal\amp\Routing

class AmpContext extends ServiceProviderBase {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManager
   */
  protected $themeManager;

  /**
   * Information about AMP-enabled content types.
   *
   * @var \Drupal\amp\EntityTypeInfo
   */
  protected $entityTypeInfo;

  /**
   * The route match.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * The admin context.
   *
   * @var \Drupal\Core\Routing\AdminContext
   */
  protected $adminContext;

  /**
   * Construct a new amp context helper instance.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\Core\Theme\ThemeManager $themeManager
   *   The theme manager.
   * @param \Drupal\amp\EntityTypeInfo $entity_type_info
   *   Information about AMP-enabled content types.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param \Drupal\Core\Routing\AdminContext $adminContext
   *   The admin route context.
   */
  public function __construct(ConfigFactoryInterface $configFactory, ThemeManager $themeManager, EntityTypeInfo $entityTypeInfo, RouteMatchInterface $routeMatch, AdminContext $adminContext) {
    $this->configFactory = $configFactory;
    $this->themeManager = $themeManager;
    $this->entityTypeInfo = $entityTypeInfo;
    $this->routeMatch = $routeMatch;
    $this->adminContext = $adminContext;
  }

  /**
   * Determines whether the active route is an AMP route.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param mixed $entity
   *   The entity to assess, if any.
   * @param boolean $checkTheme
   *   Whether or not to check the active theme as a part of the test.
   *
   * @return bool
   *   Returns TRUE if the route is an AMP route, otherwise FALSE.
   */
  public function isAmpRoute(RouteMatchInterface $routeMatch = NULL, $entity = NULL, $checkTheme = TRUE) {
    if (!$routeMatch) {
      $routeMatch = $this->routeMatch;
    }

    // Some routes cannot be AMP.
    if ($route_is_not_amp = $this
      ->routeIsNotAmp($routeMatch)) {
      return FALSE;
    }

    // Some routes must be AMP.
    if ($route_is_amp = $this
      ->routeIsAmp($routeMatch)) {
      return TRUE;
    }

    // If we have an entity, we can test it.
    $route_entity = $this
      ->routeEntity($routeMatch);
    if ($entity instanceof \Drupal\node\NodeInterface || $route_entity instanceof \Drupal\node\NodeInterface) {
      $entity_is_amp = $this
        ->entityIsAmp($entity);
      $route_entity_is_amp = $this
        ->entityIsAmp($route_entity);
      return $entity_is_amp || $route_entity_is_amp;
    }

    // Otherwise, check the active theme.
    if ($checkTheme) {
      return $this
        ->routeThemeisAmp($routeMatch);
    }
    return FALSE;
  }

  /**
   * See if this route uses the AMP theme.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return boolean
   */
  public function routeThemeisAmp(RouteMatchInterface $routeMatch) {
    $current_theme = $this->themeManager
      ->getActiveTheme($routeMatch)
      ->getName();
    $amp_theme = $this->configFactory
      ->get('amp.theme')
      ->get('amptheme');
    if ($amp_theme == $current_theme) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Definitely an AMP route?
   *
   * Some routes must be AMP.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return boolean
   */
  public function routeIsAmp(RouteMatchInterface $routeMatch) {
    $route = $routeMatch
      ->getRouteObject();
    if (!$route instanceof Route) {
      return FALSE;
    }

    // Check if the globally-defined AMP status has been changed to TRUE (it
    // is FALSE by default).
    if ($route
      ->getOption('_amp_route')) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Not an AMP route?
   *
   * Check off things that indicate this can't be an AMP route. TRUE means it
   * can't be an AMP route, FALSE means we can't tell.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return boolean
   */
  public function routeIsNotAmp(RouteMatchInterface $routeMatch) {

    // Is this an admin route?
    if ($this->adminContext
      ->isAdminRoute()) {
      return TRUE;
    }

    // Only path with amp in the query string or amp _wrapper_format, unless all pages are AMP.
    $everywhere = $this->configFactory
      ->get('amp.settings')
      ->get('amp_everywhere');
    $amp_wrapper_format = isset($_GET['_wrapper_format']) && $_GET['_wrapper_format'] == 'amp';
    $amp = isset($_GET['amp']);
    if (!$everywhere && !$amp_wrapper_format && !$amp) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * Get the entity from the route.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   *
   * @return mixed
   *   Either an entity or FALSE.
   */
  public function routeEntity(RouteMatchInterface $routeMatch) {
    if ($node = $routeMatch
      ->getParameter('node')) {
      return $node;
    }
    return FALSE;
  }

  /**
   * See if this entity is AMP.
   *
   * @param mixed $entity
   *   An entity
   *
   * @return boolean
   */
  public function entityIsAmp($entity) {
    if ($entity instanceof \Drupal\node\NodeInterface) {
      $type = $entity
        ->getType();
      return $this->entityTypeInfo
        ->isAmpEnabledType($type);
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AmpContext::$adminContext	protected	property	The admin context.
AmpContext::$configFactory	protected	property	The config factory.
AmpContext::$entityTypeInfo	protected	property	Information about AMP-enabled content types.
AmpContext::$routeMatch	protected	property	The route match.
AmpContext::$themeManager	protected	property	Theme manager.
AmpContext::entityIsAmp	public	function	See if this entity is AMP.
AmpContext::isAmpRoute	public	function	Determines whether the active route is an AMP route.
AmpContext::routeEntity	public	function	Get the entity from the route.
AmpContext::routeIsAmp	public	function	Definitely an AMP route?
AmpContext::routeIsNotAmp	public	function	Not an AMP route?
AmpContext::routeThemeisAmp	public	function	See if this route uses the AMP theme.
AmpContext::__construct	public	function	Construct a new amp context helper instance.
ServiceProviderBase::alter	public	function	Modifies existing service definitions. Overrides ServiceModifierInterface::alter	5
ServiceProviderBase::register	public	function	Registers services to the container. Overrides ServiceProviderInterface::register	1