You are here

Home » API reference » Real-time SEO for Drupal 8 » YoastSeoController.php

class YoastSeoController in Real-time SEO for Drupal 8

YoastSeoController.

Hierarchy

Expanded class hierarchy of YoastSeoController

File

src/Controller/YoastSeoController.php, line 13

Namespace

Drupal\yoast_seo\Controller
View source 
class YoastSeoController extends ControllerBase {

  /**
   * Returns a set of tokens' values.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request of the page.
   *   * data The context to use to retrieve the tokens value,
   *     see Drupal\Core\Utility\token::replace()
   *   * tokens An array of tokens to get the values for.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   The JSON response.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
   *   In case of AccessDeniedException.
   * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
   *   In case of NotFoundHttpException.
   */
  public function tokens(Request $request) {

    /** @var MetatagToken $metatag_token */
    $metatag_token = \Drupal::service('metatag.token');
    $token_values = array();
    $tokens = $request->request
      ->get('tokens');
    $data = $request->request
      ->get('data');
    if (is_null($data)) {
      $data = array();
    }

    // Retrieve the tokens values.
    // Use the metatag token service, which use either core or token module
    // regarding if this one is installed.
    foreach ($tokens as $token) {
      $token_values[$token] = $metatag_token
        ->replace($token, $data);
    }
    return new JsonResponse($token_values);
  }

  /**
   * Settings page.
   *
   * @return array
   *   The configuration form.
   */
  public function settings() {
    $form = [];
    $xmlsitemap_enabled = \Drupal::moduleHandler()
      ->moduleExists('xmlsitemap');
    $simple_sitemap_enabled = \Drupal::moduleHandler()
      ->moduleExists('simple_sitemap');

    // Check if a sitemap module is installed and enabled.
    if ($xmlsitemap_enabled && $simple_sitemap_enabled) {

      // Discourage users from enabling both sitemap modules as they
      // might interfere.
      $xmlsitemap_description = $this
        ->t('It looks like you have both the XML Sitemap and Simple XML Sitemap module enabled. Please uninstall one of them as they could interfere with each other.');
    }
    elseif ($xmlsitemap_enabled) {

      // Inform the user about altering the XML Sitemap configuration on the
      // module configuration page if he has access to do so.
      if (\Drupal::currentUser()
        ->hasPermission('administer xmlsitemap')) {
        $xmlsitemap_description = $this
          ->t('You can configure the XML Sitemap settings at the <a href="@url">configuration page</a>', [
          '@url' => Url::fromRoute('xmlsitemap.admin_search')
            ->toString(),
        ]);
      }
      else {
        $xmlsitemap_description = $this
          ->t('You do not have the permission to administer the XML Sitemap.');
      }
    }
    elseif (\Drupal::moduleHandler()
      ->moduleExists('simple_sitemap')) {

      // Inform the user about altering the XML Sitemap configuration on the
      // module configuration page if he has access to do so.
      if (\Drupal::currentUser()
        ->hasPermission('administer simple_sitemap')) {
        $xmlsitemap_description = $this
          ->t('You can configure the Simple XML Sitemap settings at the <a href="@url">configuration page</a>.', [
          '@url' => Url::fromRoute('simple_sitemap.settings')
            ->toString(),
        ]);
      }
      else {
        $xmlsitemap_description = $this
          ->t('You do not have the permission to administer the Simple XML Sitemap.');
      }
    }
    else {

      // XML Sitemap is not enabled, inform the user he should think about
      // installing and enabling it.
      $xmlsitemap_description = $this
        ->t('You currently do not have a sitemap module enabled. We strongly recommend you to install a sitemap module. You can download the <a href="@project1-url">@project1-name</a> or <a href="@project2-url">@project2-name</a> module to use as sitemap generator.', [
        '@project1-url' => 'https://www.drupal.org/project/simple_sitemap',
        '@project1-name' => 'Simple Sitemap',
        '@project2-url' => 'https://www.drupal.org/project/xmlsitemap',
        '@project2-name' => 'XML Sitemap',
      ]);
    }
    $form['xmlsitemap'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Sitemap'),
      '#markup' => $xmlsitemap_description,
      '#open' => TRUE,
    ];

    // Inform the user about altering the Metatag configuration on the module
    // configuration page if he has access to do so.
    // We do not check if the module is enabled since it is our dependency.
    if (\Drupal::currentUser()
      ->hasPermission('administer meta tags')) {
      $metatag_description = $this
        ->t('You can configure and override the Metatag title & description default settings at the <a href="@url">Metatag configuration page</a>.', [
        '@url' => Url::fromRoute('entity.metatag_defaults.collection')
          ->toString(),
      ]);
    }
    else {
      $metatag_description = $this
        ->t('You currently do not have the permission to administer Metatag.');
    }
    $form['metatag'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Configure Metatag default templates'),
      '#markup' => $metatag_description,
      '#open' => TRUE,
    ];

    // Add to the page the Yoast SEO form which allows the administrator
    // to enable/disable Yoast SEO by bundles.
    $config_form = \Drupal::formBuilder()
      ->getForm('Drupal\\yoast_seo\\Form\\YoastSeoConfigForm');
    $form['yoast_seo'] = [
      '#type' => 'details',
      '#title' => 'Configure Real-time SEO by bundles',
      '#description' => 'Select the bundles Real-time SEO will be enabled for',
      '#markup' => render($config_form),
      '#open' => TRUE,
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
YoastSeoController::settings public function Settings page.
YoastSeoController::tokens public function Returns a set of tokens' values.