public function GroupTypeForm::form in Group 2.0.x

Same name and namespace in other branches

1. 8 src/Entity/Form/GroupTypeForm.php \Drupal\group\Entity\Form\GroupTypeForm::form()

Gets the actual form array to be built.

Overrides EntityForm::form

See also

\Drupal\Core\Entity\EntityForm::processForm()

\Drupal\Core\Entity\EntityForm::afterBuild()

File

src/Entity/Form/GroupTypeForm.php, line 46

Class

GroupTypeForm

Form controller for group type forms.

Namespace

Drupal\group\Entity\Form

Code

public function form(array $form, FormStateInterface $form_state) {

  /** @var \Drupal\group\Entity\GroupTypeInterface $type */
  $form = parent::form($form, $form_state);
  $type = $this->entity;
  if ($this->operation === 'add') {
    $fields = $this->entityFieldManager
      ->getBaseFieldDefinitions('group');
  }
  else {
    $fields = $this->entityFieldManager
      ->getFieldDefinitions('group', $type
      ->id());
  }
  $form['label'] = [
    '#title' => $this
      ->t('Name'),
    '#type' => 'textfield',
    '#default_value' => $type
      ->label(),
    '#description' => $this
      ->t('The human-readable name of this group type. This text will be displayed as part of the list on the %group-add page. This name must be unique.', [
      '%group-add' => $this
        ->t('Add group'),
    ]),
    '#required' => TRUE,
    '#size' => 30,
  ];
  $form['id'] = [
    '#type' => 'machine_name',
    '#default_value' => $type
      ->id(),
    '#maxlength' => GroupTypeInterface::ID_MAX_LENGTH,
    '#machine_name' => [
      'exists' => [
        'Drupal\\group\\Entity\\GroupType',
        'load',
      ],
      'source' => [
        'label',
      ],
    ],
    '#description' => $this
      ->t('A unique machine-readable name for this group type. It must only contain lowercase letters, numbers, and underscores. This name will be used for constructing the URL of the %group-add page, in which underscores will be converted into hyphens.', [
      '%group-add' => $this
        ->t('Add group'),
    ]),
  ];
  $form['description'] = [
    '#title' => $this
      ->t('Description'),
    '#type' => 'textarea',
    '#default_value' => $type
      ->getDescription(),
    '#description' => $this
      ->t('This text will be displayed on the <em>Add group</em> page.'),
  ];
  $form['title_label'] = [
    '#title' => $this
      ->t('Title field label'),
    '#type' => 'textfield',
    '#default_value' => $fields['label']
      ->getLabel(),
    '#description' => $this
      ->t('Sets the label of the field that will be used for group titles.'),
    '#required' => TRUE,
  ];
  $form['new_revision'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Create a new revision when a group is modified'),
    '#default_value' => $type
      ->shouldCreateNewRevision(),
  ];
  $form['creator_membership'] = [
    '#title' => $this
      ->t('The group creator automatically becomes a member'),
    '#type' => 'checkbox',
    '#default_value' => $type
      ->creatorGetsMembership(),
    '#description' => $this
      ->t('This will make sure that anyone who creates a group of this type will automatically become a member of it.'),
  ];
  $form['creator_wizard'] = [
    '#title' => $this
      ->t('Group creator must complete their membership'),
    '#type' => 'checkbox',
    '#default_value' => $type
      ->creatorMustCompleteMembership(),
    '#description' => $this
      ->t('This will first show you the form to create the group and then a form to fill out your membership details.<br />You can choose to disable this wizard if you did not or will not add any fields to the membership.<br /><strong>Warning:</strong> If you do have fields on the membership and do not use the wizard, you may end up with required fields not being filled out.'),
    '#states' => [
      'visible' => [
        ':input[name="creator_membership"]' => [
          'checked' => TRUE,
        ],
      ],
    ],
  ];

  // Add-form specific elements.
  if ($this->operation == 'add') {
    $form['add_admin_role'] = [
      '#title' => $this
        ->t('Automatically configure an administrative role'),
      '#type' => 'checkbox',
      '#default_value' => 0,
      '#description' => $this
        ->t("This will create an 'Admin' role by default which will have all currently defined permissions."),
    ];
    $form['assign_admin_role'] = [
      '#title' => $this
        ->t('Automatically assign this administrative role to group creators'),
      '#type' => 'checkbox',
      '#default_value' => 0,
      '#description' => $this
        ->t("This will assign the 'Admin' role to the group creator membership."),
      '#states' => [
        'visible' => [
          ':input[name="creator_membership"]' => [
            'checked' => TRUE,
          ],
          ':input[name="add_admin_role"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
  }
  else {
    $options = [];
    foreach ($type
      ->getRoles(FALSE) as $group_role) {
      $options[$group_role
        ->id()] = $group_role
        ->label();
    }
    $form['creator_roles'] = [
      '#title' => $this
        ->t('Group creator roles'),
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $type
        ->getCreatorRoleIds(),
      '#description' => $this
        ->t('Please select which custom group roles a group creator will receive.'),
      '#states' => [
        'visible' => [
          ':input[name="creator_membership"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if (empty($options)) {
      $add_role_url = Url::fromRoute('entity.group_role.add_form', [
        'group_type' => $type
          ->id(),
      ]);
      $t_args = [
        '@url' => $add_role_url
          ->toString(),
      ];
      $description = $this
        ->t('You do not have any custom group roles yet, <a href="@url">create one here</a>.', $t_args);
      $form['creator_roles']['#description'] .= "<br /><em>{$description}</em>";
    }
  }
  return $this
    ->protectBundleIdElement($form);
}