class BadgeController in User Badges 8

Class BadgeController.

@package Drupal\user_badges\Controller

View source

class BadgeController extends ControllerBase {

  /**
   * The Link Generator service.
   *
   * @var \Drupal\Core\Utility\LinkGeneratorInterface
   */
  protected $linkGenerator;

  /**
   * Constructs a BadgeController object.
   *
   * @param \Drupal\Core\Utility\LinkGeneratorInterface linkGenerator
   *   Link generator service.
   */
  public function __construct(LinkGeneratorInterface $linkGenerator) {
    $this->linkGenerator = $linkGenerator;
  }

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

  /**
   * Addpage.
   *
   * @return []
   *   Return links for badge creation.
   */
  public function addPage() {
    $build = [
      '#theme' => 'item_list',
    ];
    $content = [];
    $types = [];

    // Only use badge types the user has access to.
    foreach ($this
      ->entityTypeManager()
      ->getStorage('badge_type')
      ->loadMultiple() as $type) {
      $access = $this
        ->entityTypeManager()
        ->getAccessControlHandler('badge')
        ->createAccess($type
        ->id(), NULL, [], TRUE);
      if ($access
        ->isAllowed()) {
        $content[] = $this->linkGenerator
          ->generate($type
          ->label(), new Url('user_badges.badge_controller_add', [
          'badge_type' => $type
            ->id(),
        ]));
        $types[] = $type;
      }
    }

    // Bypass the /admin/structure/badge/add listing if only one content type is available.
    if (count($types) == 1) {
      $type = array_shift($types);
      return $this
        ->redirect('user_badges.badge_controller_add', [
        'badge_type' => $type
          ->id(),
      ]);
    }
    $build['#items'] = $content;
    return $build;
  }

  /**
   * Add.
   *
   * @return array
   *   Returns badge creation form.
   */
  public function add(BadgeTypeInterface $badge_type) {
    $badge = $this
      ->entityTypeManager()
      ->getStorage('badge')
      ->create([
      'type' => $badge_type
        ->id(),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($badge);
  }

  /**
   * The _title_callback for the user_badges.badge_controller_add route.
   *
   * @param \Drupal\user_badges\BadgeTypeInterface $badge_type
   *   The current node.
   *
   * @return string
   *   The page title.
   */
  public function addBadgeTitle(BadgeTypeInterface $badge_type) {
    return $this
      ->t('Create @name', [
      '@name' => $badge_type
        ->label(),
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BadgeController::$linkGenerator	protected	property	The Link Generator service. Overrides LinkGeneratorTrait::$linkGenerator
BadgeController::add	public	function	Add.
BadgeController::addBadgeTitle	public	function	The _title_callback for the user_badges.badge_controller_add route.
BadgeController::addPage	public	function	Addpage.
BadgeController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
BadgeController::__construct	public	function	Constructs a BadgeController object.
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::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.

You are here

class BadgeController in User Badges 8

Hierarchy

File

Namespace

Members

API Navigation