class EmbedButtonEditorAccessCheck in Embed 8

Routing requirement access check for embed buttons and text editors.

Hierarchy

• class \Drupal\embed\Access\EmbedButtonEditorAccessCheck implements AccessInterface

1 string reference to 'EmbedButtonEditorAccessCheck'

embed.services.yml in ./embed.services.yml

embed.services.yml

1 service uses EmbedButtonEditorAccessCheck

access_check.embed_button_editor in ./embed.services.yml

Drupal\embed\Access\EmbedButtonEditorAccessCheck

File

src/Access/EmbedButtonEditorAccessCheck.php, line 16

Namespace

Drupal\embed\Access

class EmbedButtonEditorAccessCheck implements AccessInterface {

  /**
   * Checks whether the embed button is enabled for the given text editor.
   *
   * Returns allowed if the editor toolbar contains the embed button or neutral
   * otherwise.
   *
   * @code
   * pattern: '/foo/{editor}/{embed_button}'
   * requirements:
   *   _embed_button_editor_access: 'TRUE'
   * @endcode
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The current route match.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The currently logged in account.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function access(RouteMatchInterface $route_match, AccountInterface $account) {
    $parameters = $route_match
      ->getParameters();
    $access_result = AccessResult::allowedIf($parameters
      ->has('editor') && $parameters
      ->has('embed_button'))
      ->addCacheContexts([
      'route',
    ]);
    if ($access_result
      ->isAllowed()) {
      $editor = $parameters
        ->get('editor');
      $embed_button = $parameters
        ->get('embed_button');
      if ($editor instanceof EditorInterface && $embed_button instanceof EmbedButtonInterface) {
        return $access_result
          ->andIf($editor
          ->getFilterFormat()
          ->access('use', $account, TRUE))
          ->andIf($this
          ->checkButtonEditorAccess($embed_button, $editor));
      }
    }

    // No opinion, so other access checks should decide if access should be
    // allowed or not.
    return $access_result;
  }

  /**
   * Checks if the embed button is enabled in an editor configuration.
   *
   * @param \Drupal\embed\EmbedButtonInterface $embed_button
   *   The embed button entity to check.
   * @param \Drupal\editor\EditorInterface $editor
   *   The editor entity to check.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   *
   * @throws \Symfony\Component\HttpKernel\Exception\HttpException
   *   When the received Text Editor entity does not use CKEditor. This is
   *   currently only capable of detecting buttons used by CKEditor.
   */
  protected function checkButtonEditorAccess(EmbedButtonInterface $embed_button, EditorInterface $editor) {
    if ($editor
      ->getEditor() !== 'ckeditor') {
      throw new HttpException(500, 'Currently, only CKEditor is supported.');
    }
    $has_button = FALSE;
    $settings = $editor
      ->getSettings();
    foreach ($settings['toolbar']['rows'] as $row) {
      foreach ($row as $group) {
        if (in_array($embed_button
          ->id(), $group['items'])) {
          $has_button = TRUE;
          break 2;
        }
      }
    }
    return AccessResult::allowedIf($has_button)
      ->addCacheableDependency($embed_button)
      ->addCacheableDependency($editor);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EmbedButtonEditorAccessCheck::access	public	function	Checks whether the embed button is enabled for the given text editor.
EmbedButtonEditorAccessCheck::checkButtonEditorAccess	protected	function	Checks if the embed button is enabled in an editor configuration.