{{ title }}{% if description or warning %}
{% if warning %}{{ warning }} {% endif %}{{ description }}
{% endif %}
',
+ '#context' => [
+ 'title' => $perm_item['title'],
+ ],
+ ];
+
+ // Show the permission description.
+ if (!$hide_descriptions) {
+ $form['permissions'][$permission_name]['description']['#context']['description'] = $perm_item['description'];
+ $form['permissions'][$permission_name]['description']['#context']['warning'] = $perm_item['warning'];
+ }
+
+ foreach ($roles as $rid => $role) {
+ $rid_simple = $role->getName();
+
+ // The roles property indicates which roles the permission applies to.
+ $permission_applies = TRUE;
+ if ($permission instanceof GroupPermission) {
+ $target_roles = $permission->getApplicableRoles();
+ $permission_applies = empty($target_roles) || in_array($rid_simple, $target_roles);
+ }
+
+ if ($permission_applies) {
+ $form['permissions'][$permission_name][$rid] = [
+ '#title' => $role->getName() . ': ' . $perm_item['title'],
+ '#title_display' => 'invisible',
+ '#wrapper_attributes' => [
+ 'class' => ['checkbox'],
+ ],
+ '#type' => 'checkbox',
+ '#default_value' => $role->hasPermission($permission_name) ? 1 : 0,
+ '#attributes' => ['class' => ['rid-' . $rid, 'js-rid-' . $rid]],
+ '#parents' => [$rid, $permission_name],
+ ];
+
+ // Show a column of disabled but checked checkboxes.
+ // Only applies to admins or default roles.
+ if ($roles[$rid]->get('is_admin') ||
+ in_array($rid_simple, $permission->getDefaultRoles())) {
+ $form['permissions'][$permission_name][$rid]['#disabled'] = TRUE;
+ $form['permissions'][$permission_name][$rid]['#default_value'] = TRUE;
+ }
+ }
+ else {
+ $form['permissions'][$permission_name][$rid] = [
+ '#title' => $role->getName() . ': ' . $perm_item['title'],
+ '#title_display' => 'invisible',
+ '#wrapper_attributes' => [
+ 'class' => ['checkbox'],
+ ],
+ '#markup' => '-',
+ ];
+ }
+ }
+ }
+ }
+
+ $form['actions'] = ['#type' => 'actions'];
+ $form['actions']['submit'] = [
+ '#type' => 'submit',
+ '#value' => $this->t('Save permissions'),
+ '#button_type' => 'primary',
+ ];
+
+ $form['#attached']['library'][] = 'user/drupal.user.permissions';
+
+ return $form;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function submitForm(array &$form, FormStateInterface $form_state) {
+ /** @var \Drupal\og\Entity\OgRole $roles */
+ foreach ($this->roles as $rid => $role) {
+ if (!$form_state->hasValue($rid)) {
+ continue;
+ }
+
+ $permissions = $form_state->getValue($rid);
+ foreach ($permissions as $permission => $grant) {
+ if ($grant) {
+ $role->grantPermission($permission);
+ }
+ else {
+ $role->revokePermission($permission);
+ }
+ }
+
+ $role->save();
+ }
+
+ $this->messenger()->addMessage($this->t('The changes have been saved.'));
+ }
+
+}
diff --git a/og_ui/src/Form/OgRoleDeleteForm.php b/og_ui/src/Form/OgRoleDeleteForm.php
new file mode 100644
index 000000000..196a2fb57
--- /dev/null
+++ b/og_ui/src/Form/OgRoleDeleteForm.php
@@ -0,0 +1,35 @@
+getEntity();
+
+ return Url::fromRoute('entity.og_role.collection', [
+ 'entity_type_id' => $role->getGroupType(),
+ 'bundle_id' => $role->getGroupBundle(),
+ ]);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function getRedirectUrl() {
+ return $this->getCancelUrl();
+ }
+
+}
diff --git a/og_ui/src/Form/OgRoleForm.php b/og_ui/src/Form/OgRoleForm.php
new file mode 100644
index 000000000..e1c3d854b
--- /dev/null
+++ b/og_ui/src/Form/OgRoleForm.php
@@ -0,0 +1,143 @@
+entity;
+
+ if ($og_role->isNew()) {
+ // Return a 404 error when this is not a group.
+ if (!Og::isGroup($entity_type_id, $bundle_id)) {
+ throw new NotFoundHttpException();
+ }
+
+ $og_role->setGroupType($entity_type_id);
+ $og_role->setGroupBundle($bundle_id);
+ }
+
+ $form['label'] = [
+ '#type' => 'textfield',
+ '#title' => $this->t('Role name'),
+ '#default_value' => $og_role->label(),
+ '#size' => 30,
+ '#required' => TRUE,
+ '#maxlength' => 64,
+ '#description' => $this->t('The name for this role. Example: "Moderator", "Editorial board", "Site architect".'),
+ ];
+
+ $form['name'] = [
+ '#type' => 'machine_name',
+ '#default_value' => $og_role->getName(),
+ '#required' => TRUE,
+ '#disabled' => !$og_role->isNew(),
+ '#size' => 30,
+ '#maxlength' => 64,
+ '#machine_name' => [
+ 'exists' => [$this, 'exists'],
+ ],
+ '#field_prefix' => $og_role->getGroupType() . '-' . $og_role->getGroupBundle() . '-',
+ ];
+ $form['weight'] = [
+ '#type' => 'value',
+ '#value' => $og_role->getWeight(),
+ ];
+
+ $form['role_type'] = [
+ '#type' => 'value',
+ '#value' => OgRoleInterface::ROLE_TYPE_STANDARD,
+ ];
+
+ return parent::buildForm($form, $form_state, $og_role);
+ }
+
+ /**
+ * Machine name callback.
+ *
+ * Cannot use OgRole::load as the #machine_name callback as we are only
+ * allowing editing the role name.
+ *
+ * @param string $role_name
+ * The role name.
+ *
+ * @return \Drupal\og\Entity\OgRole|null
+ * The OG role if it exists. NULL otherwise.
+ */
+ public function exists($role_name) {
+ $og_role = $this->entity;
+ return OgRole::getRole($og_role->getGroupType(), $og_role->getGroupBundle(), $role_name);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function save(array $form, FormStateInterface $form_state) {
+ $og_role = $this->entity;
+
+ // Prevent leading and trailing spaces in role names.
+ $og_role->set('label', trim($og_role->label()));
+ $og_role->set('name', trim($og_role->get('name')));
+ $status = $og_role->save();
+
+ $edit_link = $this->entity->toLink($this->t('Edit'))->toString();
+ if ($status == SAVED_UPDATED) {
+ $this->messenger()->addMessage($this->t('OG role %label has been updated.', ['%label' => $og_role->label()]));
+ $this->logger('user')->notice('OG role %label has been updated.', [
+ '%label' => $og_role->label(),
+ 'link' => $edit_link,
+ ]);
+ }
+ else {
+ $this->messenger()->addMessage($this->t('OG role %label has been added.', ['%label' => $og_role->label()]));
+ $this->logger('user')->notice('OG role %label has been added.', [
+ '%label' => $og_role->label(),
+ 'link' => $edit_link,
+ ]);
+ }
+ // Cannot use $og_role->url() because we need to pass mandatory parameters.
+ $form_state->setRedirect('entity.og_role.collection', [
+ 'entity_type_id' => $og_role->getGroupType(),
+ 'bundle_id' => $og_role->getGroupBundle(),
+ ]);
+ }
+
+ /**
+ * Title callback for the edit form for an OG role.
+ *
+ * @param \Drupal\og\Entity\OgRole $og_role
+ * The OG role being edited.
+ *
+ * @return \Drupal\Core\StringTranslation\TranslatableMarkup
+ * An object that, when cast to a string, returns the translated title
+ * callback.
+ */
+ public function editRoleTitleCallback(OgRole $og_role) {
+ return $this->t('Edit OG role %label', [
+ '%label' => $og_role->getLabel(),
+ ]);
+ }
+
+}
diff --git a/og_ui/src/Form/OgRolePermissionsForm.php b/og_ui/src/Form/OgRolePermissionsForm.php
new file mode 100644
index 000000000..6ddb94edf
--- /dev/null
+++ b/og_ui/src/Form/OgRolePermissionsForm.php
@@ -0,0 +1,79 @@
+t('@bundle roles - @role permissions', [
+ '@bundle' => $this->entityTypeBundleInfo->getBundleInfo($entity_type_id)[$bundle_id]['label'],
+ '@role' => $role->getLabel(),
+ ]);
+ }
+
+ /**
+ * The group role permissions form constructor.
+ *
+ * @param array $form
+ * An associative array containing the structure of the form.
+ * @param \Drupal\Core\Form\FormStateInterface $form_state
+ * The current state of the form.
+ * @param string $entity_type_id
+ * The group entity type id.
+ * @param string $bundle_id
+ * The group bundle id.
+ * @param string $role_name
+ * The group role name.
+ *
+ * @return array
+ * The form structure.
+ */
+ public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = '', $bundle_id = '', $role_name = '') {
+ $role_id = implode('-', [
+ $entity_type_id,
+ $bundle_id,
+ $role_name,
+ ]);
+
+ if ($role = OgRole::load($role_id)) {
+ $this->roles = [$role->id() => $role];
+ }
+
+ return parent::buildForm($form, $form_state, $entity_type_id, $bundle_id);
+ }
+
+}
diff --git a/src/Entity/OgRole.php b/src/Entity/OgRole.php
index 89361ad41..0b015c26a 100644
--- a/src/Entity/OgRole.php
+++ b/src/Entity/OgRole.php
@@ -18,12 +18,34 @@
* @ConfigEntityType(
* id = "og_role",
* label = @Translation("OG role"),
+ * label_singular = @Translation("OG role"),
+ * label_plural = @Translation("OG roles"),
+ * label_count = @PluralTranslation(
+ * singular = "@count OG role",
+ * plural = "@count OG roles"
+ * ),
+ * handlers = {
+ * "access" = "Drupal\og\OgRoleAccessControlHandler",
+ * "form" = {
+ * "default" = "Drupal\og_ui\Form\OgRoleForm",
+ * "delete" = "Drupal\og_ui\Form\OgRoleDeleteForm",
+ * "edit" = "Drupal\og_ui\Form\OgRoleForm",
+ * },
+ * "list_builder" = "Drupal\og\Entity\OgRoleListBuilder",
+ * },
+ * admin_permission = "administer organic groups",
* static_cache = TRUE,
* entity_keys = {
* "id" = "id",
* "label" = "label",
* "weight" = "weight"
* },
+ * links = {
+ * "collection" = "/admin/config/group/roles/{entity_type_id}/{bundle_id}",
+ * "add-form" = "/admin/config/group/roles/{entity_type_id}/{bundle_id}/add",
+ * "edit-form" = "/admin/config/group/role/{og_role}/edit",
+ * "delete-form" = "/admin/config/group/role/{og_role}/delete",
+ * },
* config_export = {
* "id",
* "label",
@@ -137,6 +159,13 @@ public function setRoleType($role_type) {
return $this->set('role_type', $role_type);
}
+ /**
+ * {@inheritdoc}
+ */
+ public function isLocked() {
+ return $this->get('role_type') !== OgRoleInterface::ROLE_TYPE_STANDARD;
+ }
+
/**
* {@inheritdoc}
*/
diff --git a/src/Entity/OgRoleListBuilder.php b/src/Entity/OgRoleListBuilder.php
new file mode 100644
index 000000000..7bac7b5b5
--- /dev/null
+++ b/src/Entity/OgRoleListBuilder.php
@@ -0,0 +1,167 @@
+get('entity_type.manager')->getStorage($entity_type->id()),
+ $container->get('current_route_match')
+ );
+ }
+
+ /**
+ * Constructs a new OgRoleListBuilder object.
+ *
+ * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
+ * The entity type definition.
+ * @param \Drupal\Core\Entity\EntityStorageInterface $storage
+ * The entity storage class.
+ * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
+ * The route matcher.
+ */
+ public function __construct(EntityTypeInterface $entity_type, EntityStorageInterface $storage, RouteMatchInterface $route_match) {
+ parent::__construct($entity_type, $storage);
+
+ // When on the default og_role list route,
+ // we should have a group entity type and bundle.
+ if ($route_match->getRouteName() == 'entity.og_role.collection') {
+ $parameters = $route_match->getParameters();
+
+ // Check if the route had a group type parameter.
+ if ($parameters->has('entity_type_id')) {
+ $this->groupType = $parameters->get('entity_type_id');
+ }
+ if ($parameters->has('bundle_id')) {
+ $this->groupBundle = $parameters->get('bundle_id');
+ }
+ }
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function getEntityIds() {
+ $query = $this->getStorage()->getQuery()
+ ->condition('group_type', $this->groupType, '=')
+ ->condition('group_bundle', $this->groupBundle, '=')
+ ->sort($this->entityType->getKey('weight'));
+
+ // Only add the pager if a limit is specified.
+ if ($this->limit) {
+ $query->pager($this->limit);
+ }
+
+ return array_values($query->execute());
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getFormId() {
+ return 'og_roles_admin';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function buildHeader() {
+ $header['label'] = $this->t('Name');
+ return $header + parent::buildHeader();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function buildRow(EntityInterface $entity) {
+ $row['label'] = $entity->label();
+ return $row + parent::buildRow($entity);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDefaultOperations(EntityInterface $role) {
+ $operations = parent::getDefaultOperations($role);
+
+ // @todo If ($entity->hasLinkTemplate('edit-permissions-form')).
+ $operations['permissions'] = [
+ 'title' => $this->t('Edit permissions'),
+ 'weight' => 20,
+ 'url' => Url::fromRoute('og_ui.permissions_edit_form', [
+ 'entity_type_id' => $this->groupType,
+ 'bundle_id' => $this->groupBundle,
+ 'role_name' => $role->getName(),
+ ]),
+ ];
+
+ if ($role->isLocked()) {
+ if (isset($operations['edit'])) {
+ unset($operations['edit']);
+ }
+
+ if (isset($operations['delete'])) {
+ unset($operations['delete']);
+ }
+ }
+
+ return $operations;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function render() {
+ // Return a 404 error when this is not a group.
+ if (!Og::isGroup($this->groupType, $this->groupBundle)) {
+ throw new NotFoundHttpException();
+ }
+
+ $build = parent::render();
+ $build['entities']['#empty'] = $this->t('There are no OG roles available yet.