class EditTeamMemberForm in Apigee Edge 8

Edit team member form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\apigee_edge_teams\Form\TeamMembersFormBase
  - class \Drupal\apigee_edge_teams\Form\EditTeamMemberForm

Expanded class hierarchy of EditTeamMemberForm

1 file declares its use of EditTeamMemberForm

TeamRouteProvider.php in modules/apigee_edge_teams/src/Entity/TeamRouteProvider.php

File

modules/apigee_edge_teams/src/Form/EditTeamMemberForm.php, line 32

Namespace

Drupal\apigee_edge_teams\Form

View source

class EditTeamMemberForm extends TeamMembersFormBase {

  /**
   * The developer from the route.
   *
   * @var \Drupal\apigee_edge\Entity\DeveloperInterface
   */
  protected $developer;

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, TeamInterface $team = NULL, DeveloperInterface $developer = NULL) {
    $this->team = $team;
    $this->developer = $developer;
    $role_options = $this
      ->getRoleOptions();
    $team_member_roles = $this->teamMemberRoleStorage
      ->loadByDeveloperAndTeam($developer
      ->getOwner(), $team);
    if ($team_member_roles) {
      $current_role_options = array_keys($team_member_roles
        ->getTeamRoles());
    }
    else {
      $current_role_options = [];
    }

    // Add TEAM_MEMBER_ROLE to current role options so it's always displayed.
    $current_role_options[] = TeamRoleInterface::TEAM_MEMBER_ROLE;
    $form['team_roles'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Roles'),
      '#options' => $role_options,
      '#default_value' => $current_role_options,
      '#multiple' => TRUE,
      '#required' => FALSE,
    ];

    // Special handling for the inevitable team member role.
    $form['team_roles'][TeamRoleInterface::TEAM_MEMBER_ROLE] = [
      '#default_value' => TRUE,
      '#disabled' => TRUE,
    ];
    $form['team_roles']['description'] = [
      '#markup' => $this
        ->t('Modify roles of %developer in the %team_label @team.', [
        '%developer' => $this->developer
          ->getOwner()
          ->label(),
        '%team_label' => $this->team
          ->label(),
        '@team' => mb_strtolower($this->team
          ->getEntityType()
          ->getSingularLabel()),
      ]),
    ];
    $form['actions'] = [
      '#type' => 'actions',
      'submit' => [
        '#type' => 'submit',
        '#value' => $this
          ->t('Save'),
        '#button_type' => 'primary',
      ],
      'cancel' => [
        '#type' => 'link',
        '#title' => $this
          ->t('Cancel'),
        '#attributes' => [
          'class' => [
            'button',
          ],
        ],
        '#url' => $this->team
          ->toUrl('members'),
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $logger = $this
      ->logger('apigee_edge_teams');
    $selected_roles = $this
      ->filterSelectedRoles($form_state
      ->getValue('team_roles', []));
    $new_roles = array_diff($selected_roles, $form['team_roles']['#default_value']);
    $removed_roles = array_diff($form['team_roles']['#default_value'], $selected_roles);
    $success = TRUE;
    try {
      if ($new_roles) {
        $this->teamMemberRoleStorage
          ->addTeamRoles($this->developer
          ->getOwner(), $this->team, $new_roles);
      }
      if ($removed_roles) {
        $this->teamMemberRoleStorage
          ->removeTeamRoles($this->developer
          ->getOwner(), $this->team, $removed_roles);
      }
    } catch (\Exception $exception) {
      $success = FALSE;
      $context = [
        '%developer' => $this->developer
          ->getEmail(),
        '%team_id' => $this->team
          ->id(),
      ];
      $context += Error::decodeException($exception);
      $logger
        ->error('Failed to modify %developer developer roles in %team_id team. @message %function (line %line of %file). <pre>@backtrace_string</pre>', $context);
    }
    if ($success) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Changes successfully saved.'));
    }
    else {
      $this
        ->messenger()
        ->addWarning($this
        ->t('There was an error meanwhile saving the changes.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
EditTeamMemberForm::$developer	protected	property	The developer from the route.
EditTeamMemberForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
EditTeamMemberForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
EditTeamMemberForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	62
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.
TeamMembersFormBase::$team	protected	property	The team from the route.
TeamMembersFormBase::$teamMemberRoleStorage	protected	property	Team member role storage.
TeamMembersFormBase::$teamRoleStorage	protected	property	Team role storage.
TeamMembersFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	1
TeamMembersFormBase::filterSelectedRoles	protected	function	Helper function to filter the value of a team roles checkboxes element.
TeamMembersFormBase::getRoleOptions	protected	function	Returns an array of team role options keyed by team role id.
TeamMembersFormBase::__construct	public	function	TeamMembersFormBase constructor.	1
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 EditTeamMemberForm in Apigee Edge 8

Hierarchy

File

Namespace

Members

API Navigation