abstract class TeamMembersFormBase in Apigee Edge 8

Base team members 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

File

modules/apigee_edge_teams/src/Form/TeamMembersFormBase.php, line 31

Namespace

Drupal\apigee_edge_teams\Form

abstract class TeamMembersFormBase extends FormBase {

  /**
   * The team from the route.
   *
   * @var \Drupal\apigee_edge_teams\Entity\TeamInterface
   */
  protected $team;

  /**
   * Team role storage.
   *
   * @var \Drupal\apigee_edge_teams\Entity\Storage\TeamRoleStorageInterface
   */
  protected $teamRoleStorage;

  /**
   * Team member role storage.
   *
   * @var \Drupal\apigee_edge_teams\Entity\Storage\TeamMemberRoleStorage
   */
  protected $teamMemberRoleStorage;

  /**
   * TeamMembersFormBase constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->teamRoleStorage = $entity_type_manager
      ->getStorage('team_role');
    $this->teamMemberRoleStorage = $entity_type_manager
      ->getStorage('team_member_role');
  }

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

  /**
   * Returns an array of team role options keyed by team role id.
   *
   * @return array
   *   Role options.
   */
  protected function getRoleOptions() {
    $role_options = array_reduce($this->teamRoleStorage
      ->loadMultiple(), function (array $carry, TeamRoleInterface $role) {
      $carry[$role
        ->id()] = $role
        ->label();
      return $carry;
    }, []);
    return $role_options;
  }

  /**
   * Helper function to filter the value of a team roles checkboxes element.
   *
   * It will only leave selected items, and also remove the TEAM_MEMBER_ROLE,
   * as it is granted implicitly.
   *
   * @param array $team_roles_value
   *   The checkboxes element values.
   *
   * @return array
   *   The filtered result.
   */
  protected function filterSelectedRoles(array $team_roles_value) {
    $selected_roles = array_filter($team_roles_value, function ($role) {
      return $role && $role != TeamRoleInterface::TEAM_MEMBER_ROLE;
    });
    return $selected_roles;
  }

}

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
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
FormInterface::buildForm	public	function	Form constructor.	179
FormInterface::getFormId	public	function	Returns a unique string identifying the form.	236
FormInterface::submitForm	public	function	Form submission handler.	192
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.