class UserBadgesListBuilder in User Badges 8

Class UserBadgesListBuilder.

@package Drupal\user_badges\Controller

View source

class UserBadgesListBuilder extends ControllerBase implements FormInterface {

  /**
   * The form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * User object of currently being edited user.
   *
   * @var \Drupal\user\User
   */
  protected $user;

  /**
   * The term storage handler.
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $storageController;

  /**
   * Constructs a new BlockListBuilder object.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The form builder.
   */
  public function __construct(FormBuilderInterface $form_builder, EntityTypeManagerInterface $entity_type_manager) {
    $this->formBuilder = $form_builder;
    $this->storageController = $entity_type_manager
      ->getStorage('badge');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('form_builder'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Provides listing of user badges.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user account.
   *
   * @return array
   *   The block list as a renderable array.
   */
  public function badgesListing(UserInterface $user) {
    $this->user = $user;
    return $this->formBuilder
      ->getForm($this);
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'badge_display_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {

    /** @var \Drupal\user\Entity\User $user */
    $user = $this->user;
    $form['badge'] = array(
      '#type' => 'table',
      '#header' => array(
        t('Label'),
        t('Weight'),
        t('Select Weight'),
      ),
      '#empty' => t('There are no badges yet'),
    );
    $field_item_list = $user
      ->get('field_user_badges');
    foreach ($field_item_list
      ->filterEmptyItems() as $index => $item) {

      /** @var \Drupal\user_badges\Entity\Badge $badge */
      $badge = $item
        ->get('entity')
        ->getValue();
      $form['badge'][$badge
        ->id()]['#attributes']['class'][] = 'draggable';
      $form['badge'][$badge
        ->id()]['#weight'] = $badge
        ->getBadgeWeight();

      // Some table columns containing raw markup.
      $form['badge'][$badge
        ->id()]['label'] = array(
        '#plain_text' => $badge
          ->label(),
      );
      $form['badge'][$badge
        ->id()]['id'] = array(
        '#plain_text' => $badge
          ->getBadgeWeight(),
      );

      // TableDrag: Weight column element.
      $form['badge'][$badge
        ->id()]['weight'] = array(
        '#type' => 'weight',
        '#title' => t('Weight for @title', array(
          '@title' => $badge
            ->label(),
        )),
        '#title_display' => 'invisible',
        '#default_value' => $badge
          ->getBadgeWeight(),
        '#attributes' => array(
          'class' => array(
            'user-badges-order-weight',
          ),
        ),
      );
    }
    $form['badge']['#tabledrag'][] = array(
      'action' => 'order',
      'relationship' => 'sibling',
      'group' => 'user-badges-order-weight',
    );
    $form['actions'] = array(
      '#tree' => FALSE,
      '#type' => 'actions',
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this
        ->t('Save Badges'),
      '#button_type' => 'primary',
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // No validation.
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $badge_ids = array_keys($form_state
      ->getValue('badge'));

    /** @var \Drupal\user\Entity\User $user */
    $user = $this->user;
    $user
      ->set('field_user_badges', $badge_ids);
    $user
      ->save();
  }

}

Members

Name	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::$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.
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.
UserBadgesListBuilder::$formBuilder	protected	property	The form builder. Overrides ControllerBase::$formBuilder
UserBadgesListBuilder::$storageController	protected	property	The term storage handler.
UserBadgesListBuilder::$user	protected	property	User object of currently being edited user.
UserBadgesListBuilder::badgesListing	public	function	Provides listing of user badges.
UserBadgesListBuilder::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
UserBadgesListBuilder::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
UserBadgesListBuilder::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
UserBadgesListBuilder::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
UserBadgesListBuilder::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm
UserBadgesListBuilder::__construct	public	function	Constructs a new BlockListBuilder object.

You are here

class UserBadgesListBuilder in User Badges 8

Hierarchy

File

Namespace

Members

API Navigation