You are here

Home » API reference » Organic Groups Menu (OG Menu) 8 » OgMenuInstanceController.php

class OgMenuInstanceController in Organic Groups Menu (OG Menu) 8

Class OgMenuInstanceController.

@package Drupal\og_menu\Controller

Hierarchy

Expanded class hierarchy of OgMenuInstanceController

File

src/Controller/OgMenuInstanceController.php, line 28
Contains Drupal\og_menu\Controller\OgMenuInstanceController.

Namespace

Drupal\og_menu\Controller
View source 
class OgMenuInstanceController extends ControllerBase {

  /**
   * The OG membership manager service.
   *
   * @var \Drupal\og\MembershipManagerInterface
   */
  protected $membershipManager;

  /**
   * Constructs an OgMenuInstanceController object.
   *
   * @param \Drupal\og\MembershipManagerInterface $membership_manager
   *   The OG membership manager service.
   */
  public function __construct(MembershipManagerInterface $membership_manager) {
    $this->membershipManager = $membership_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('og.membership_manager'));
  }

  /**
   * Controller for the create menu instance form.
   *
   * Depending on whether the menu instance already exists, the user will be
   * redirected to the entity create or edit form.
   *
   * @param \Drupal\og_menu\Entity\OgMenu $ogmenu
   *   The OG Menu that is associated with the menu instance.
   * @param \Drupal\Core\Entity\EntityInterface $og_group
   *   The group that is associated with the menu instance.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   The response.
   */
  public function createMenuInstance(OgMenu $ogmenu, EntityInterface $og_group) {
    $values = [
      'type' => $ogmenu
        ->id(),
      OgGroupAudienceHelperInterface::DEFAULT_FIELD => $og_group
        ->id(),
    ];

    // Menu exists, redirect to edit form.
    $instances = $this
      ->entityTypeManager()
      ->getStorage('ogmenu_instance')
      ->loadByProperties($values);
    if ($instances) {
      $instance = array_pop($instances);
      return $this
        ->redirect('entity.ogmenu_instance.edit_form', [
        'ogmenu_instance' => $instance
          ->id(),
      ]);
    }

    // Create new menu instance.
    $entity = OgMenuInstance::create($values);
    $entity
      ->save();
    if ($entity
      ->id()) {
      return $this
        ->redirect('entity.ogmenu_instance.edit_form', [
        'ogmenu_instance' => $entity
          ->id(),
      ]);
    }
    throw new Exception('Unable to save menu instance.');
  }

  /**
   * Provides the menu link creation form.
   *
   * @param \Drupal\og_menu\OgMenuInstanceInterface $ogmenu_instance
   *   An entity representing a custom menu.
   *
   * @return array
   *   Returns the menu link creation form.
   */
  public function addLink(OgMenuInstanceInterface $ogmenu_instance) {
    $menu_link = $this
      ->entityTypeManager()
      ->getStorage('menu_link_content')
      ->create(array(
      'id' => '',
      'parent' => '',
      'menu_name' => 'ogmenu-' . $ogmenu_instance
        ->id(),
      'bundle' => 'menu_link_content',
    ));
    return $this
      ->entityFormBuilder()
      ->getForm($menu_link);
  }

  /**
   * Route title callback.
   *
   * @param \Drupal\og_menu\OgMenuInstanceInterface $ogmenu_instance
   *   The OG Menu instance that is being edited.
   *
   * @return array
   *   The title as a render array.
   */
  public function editFormTitle(OgMenuInstanceInterface $ogmenu_instance) {
    return [
      '#markup' => t('Edit menu %menu of %group', [
        '%menu' => $ogmenu_instance
          ->bundle(),
        '%group' => $ogmenu_instance
          ->label(),
      ]),
      '#allowed_tags' => Xss::getHtmlTagList(),
    ];
  }

  /**
   * Access callback for the "add link" route.
   *
   * @param \Drupal\og_menu\Entity\OgMenuInstance $ogmenu_instance
   *   The OG Menu instance for which to determine access.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The user for which to determine access.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function addLinkAccess(OgMenuInstance $ogmenu_instance, AccountInterface $account) {

    // @todo Add per-bundle permissions. You might want to give users access to
    //   add links to a particular OG Menu, but not all of them.
    $permission = 'add new links to og menu instance entities';

    // If the user has the global permission, allow access immediately.
    if ($account
      ->hasPermission($permission)) {
      return AccessResult::allowed();
    }

    // Retrieve the associated group from the menu instance.
    $og_groups = $this->membershipManager
      ->getGroups($ogmenu_instance);

    // A menu should only be associated with a single group.
    $group_entity_type = key($og_groups);
    $og_group = reset($og_groups[$group_entity_type]);

    // If the group could not be found, access could not be determined.
    if (empty($og_group)) {
      return AccessResult::neutral();
    }
    $membership = $this->membershipManager
      ->getMembership($og_group, $account
      ->id());

    // If the membership can not be found, access can not be determined.
    if (empty($membership)) {
      return AccessResult::neutral();
    }
    return AccessResult::allowedIf($membership
      ->hasPermission($permission));
  }

}

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::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.
OgMenuInstanceController::$membershipManager protected property The OG membership manager service.
OgMenuInstanceController::addLink public function Provides the menu link creation form.
OgMenuInstanceController::addLinkAccess public function Access callback for the "add link" route.
OgMenuInstanceController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
OgMenuInstanceController::createMenuInstance public function Controller for the create menu instance form.
OgMenuInstanceController::editFormTitle public function Route title callback.
OgMenuInstanceController::__construct public function Constructs an OgMenuInstanceController object.
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.