From 675a85dfb64beb6291e3769c83af002c38275198 Mon Sep 17 00:00:00 2001 From: Naomi Date: Thu, 12 Nov 2020 17:13:28 +0000 Subject: [PATCH] generated Organisation entity --- .../schema/oc_organisation_type.schema.yml | 12 + .../oc_organisation.page.inc | 30 ++ .../opencase_entities.links.action.yml | 10 + .../opencase_entities.links.menu.yml | 17 ++ .../opencase_entities.links.task.yml | 22 ++ .../opencase_entities.module | 26 ++ .../opencase_entities.permissions.yml | 33 +++ .../Controller/OCOrganisationController.php | 209 ++++++++++++++ .../src/Entity/OCOrganisation.php | 268 ++++++++++++++++++ .../src/Entity/OCOrganisationInterface.php | 98 +++++++ .../src/Entity/OCOrganisationType.php | 58 ++++ .../Entity/OCOrganisationTypeInterface.php | 13 + .../src/Entity/OCOrganisationViewsData.php | 23 ++ .../src/Form/OCOrganisationDeleteForm.php | 15 + .../src/Form/OCOrganisationForm.php | 87 ++++++ .../Form/OCOrganisationRevisionDeleteForm.php | 108 +++++++ .../Form/OCOrganisationRevisionRevertForm.php | 137 +++++++++ ...anisationRevisionRevertTranslationForm.php | 97 +++++++ .../src/Form/OCOrganisationSettingsForm.php | 53 ++++ .../src/Form/OCOrganisationTypeDeleteForm.php | 51 ++++ .../src/Form/OCOrganisationTypeForm.php | 65 +++++ .../OCOrganisationAccessControlHandler.php | 116 ++++++++ .../src/OCOrganisationHtmlRouteProvider.php | 196 +++++++++++++ .../src/OCOrganisationListBuilder.php | 39 +++ .../src/OCOrganisationPermissions.php | 80 ++++++ .../src/OCOrganisationStorage.php | 58 ++++ .../src/OCOrganisationStorageInterface.php | 61 ++++ .../src/OCOrganisationTranslationHandler.php | 13 + .../OCOrganisationTypeHtmlRouteProvider.php | 26 ++ .../src/OCOrganisationTypeListBuilder.php | 32 +++ ...oc-organisation-content-add-list.html.twig | 23 ++ .../templates/oc_organisation.html.twig | 22 ++ 32 files changed, 2098 insertions(+) create mode 100644 modules/opencase_entities/config/schema/oc_organisation_type.schema.yml create mode 100644 modules/opencase_entities/oc_organisation.page.inc create mode 100644 modules/opencase_entities/src/Controller/OCOrganisationController.php create mode 100644 modules/opencase_entities/src/Entity/OCOrganisation.php create mode 100644 modules/opencase_entities/src/Entity/OCOrganisationInterface.php create mode 100644 modules/opencase_entities/src/Entity/OCOrganisationType.php create mode 100644 modules/opencase_entities/src/Entity/OCOrganisationTypeInterface.php create mode 100644 modules/opencase_entities/src/Entity/OCOrganisationViewsData.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationDeleteForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationRevisionDeleteForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationRevisionRevertForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationRevisionRevertTranslationForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationSettingsForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationTypeDeleteForm.php create mode 100644 modules/opencase_entities/src/Form/OCOrganisationTypeForm.php create mode 100644 modules/opencase_entities/src/OCOrganisationAccessControlHandler.php create mode 100644 modules/opencase_entities/src/OCOrganisationHtmlRouteProvider.php create mode 100644 modules/opencase_entities/src/OCOrganisationListBuilder.php create mode 100644 modules/opencase_entities/src/OCOrganisationPermissions.php create mode 100644 modules/opencase_entities/src/OCOrganisationStorage.php create mode 100644 modules/opencase_entities/src/OCOrganisationStorageInterface.php create mode 100644 modules/opencase_entities/src/OCOrganisationTranslationHandler.php create mode 100644 modules/opencase_entities/src/OCOrganisationTypeHtmlRouteProvider.php create mode 100644 modules/opencase_entities/src/OCOrganisationTypeListBuilder.php create mode 100644 modules/opencase_entities/templates/oc-organisation-content-add-list.html.twig create mode 100644 modules/opencase_entities/templates/oc_organisation.html.twig diff --git a/modules/opencase_entities/config/schema/oc_organisation_type.schema.yml b/modules/opencase_entities/config/schema/oc_organisation_type.schema.yml new file mode 100644 index 0000000..e861328 --- /dev/null +++ b/modules/opencase_entities/config/schema/oc_organisation_type.schema.yml @@ -0,0 +1,12 @@ +opencase_entities.oc_organisation_type.*: + type: config_entity + label: 'Organisation type config' + mapping: + id: + type: string + label: 'ID' + label: + type: label + label: 'Label' + uuid: + type: string diff --git a/modules/opencase_entities/oc_organisation.page.inc b/modules/opencase_entities/oc_organisation.page.inc new file mode 100644 index 0000000..e7cc6f0 --- /dev/null +++ b/modules/opencase_entities/oc_organisation.page.inc @@ -0,0 +1,30 @@ + ['content' => NULL], 'file' => 'oc_activity.page.inc', ]; + $theme['oc_organisation'] = [ + 'render element' => 'elements', + 'file' => 'oc_organisation.page.inc', + 'template' => 'oc_organisation', + ]; + $theme['oc_organisation_content_add_list'] = [ + 'render element' => 'content', + 'variables' => ['content' => NULL], + 'file' => 'oc_organisation.page.inc', + ]; return $theme; } @@ -139,3 +149,19 @@ function opencase_query_oc_activity_access_alter($query) { $query->addJoin('INNER', 'oc_case__actors_involved', 'access_filter', 'access_filter.entity_id = oc_activity_field_data.oc_case'); $query->condition('access_filter.actors_involved_target_id', $linked_actor_id); } + +/** + * Implements hook_theme_suggestions_HOOK(). + */ +function opencase_entities_theme_suggestions_oc_organisation(array $variables) { + $suggestions = []; + $entity = $variables['elements']['#oc_organisation']; + $sanitized_view_mode = strtr($variables['elements']['#view_mode'], '.', '_'); + + $suggestions[] = 'oc_organisation__' . $sanitized_view_mode; + $suggestions[] = 'oc_organisation__' . $entity->bundle(); + $suggestions[] = 'oc_organisation__' . $entity->bundle() . '__' . $sanitized_view_mode; + $suggestions[] = 'oc_organisation__' . $entity->id(); + $suggestions[] = 'oc_organisation__' . $entity->id() . '__' . $sanitized_view_mode; + return $suggestions; +} diff --git a/modules/opencase_entities/opencase_entities.permissions.yml b/modules/opencase_entities/opencase_entities.permissions.yml index 8244e87..c77dc97 100644 --- a/modules/opencase_entities/opencase_entities.permissions.yml +++ b/modules/opencase_entities/opencase_entities.permissions.yml @@ -72,3 +72,36 @@ revert all activity revisions: delete all activity revisions: title: 'Delete all revisions' description: 'Role requires permission to view Activity revisions and delete rights for activity entities in question or administer activity entities.' +add organisation entities: + title: 'Create new Organisation entities' + +administer organisation entities: + title: 'Administer Organisation entities' + description: 'Allow to access the administration form to configure Organisation entities.' + restrict access: true + +delete organisation entities: + title: 'Delete Organisation entities' + +edit organisation entities: + title: 'Edit Organisation entities' + +view published organisation entities: + title: 'View published Organisation entities' + +view unpublished organisation entities: + title: 'View unpublished Organisation entities' + +view all organisation revisions: + title: 'View all Organisation revisions' + +revert all organisation revisions: + title: 'Revert all Organisation revisions' + description: 'Role requires permission view Organisation revisions and edit rights for organisation entities in question or administer organisation entities.' + +delete all organisation revisions: + title: 'Delete all revisions' + description: 'Role requires permission to view Organisation revisions and delete rights for organisation entities in question or administer organisation entities.' + +permission_callbacks: + - \Drupal\opencase_entities\OCOrganisationPermissions::generatePermissions diff --git a/modules/opencase_entities/src/Controller/OCOrganisationController.php b/modules/opencase_entities/src/Controller/OCOrganisationController.php new file mode 100644 index 0000000..7146bb8 --- /dev/null +++ b/modules/opencase_entities/src/Controller/OCOrganisationController.php @@ -0,0 +1,209 @@ +dateFormatter = $container->get('date.formatter'); + $instance->renderer = $container->get('renderer'); + return $instance; + } + + /** + * Displays a Organisation revision. + * + * @param int $oc_organisation_revision + * The Organisation revision ID. + * + * @return array + * An array suitable for drupal_render(). + */ + public function revisionShow($oc_organisation_revision) { + $oc_organisation = $this->entityTypeManager()->getStorage('oc_organisation') + ->loadRevision($oc_organisation_revision); + $view_builder = $this->entityTypeManager()->getViewBuilder('oc_organisation'); + + return $view_builder->view($oc_organisation); + } + + /** + * Page title callback for a Organisation revision. + * + * @param int $oc_organisation_revision + * The Organisation revision ID. + * + * @return string + * The page title. + */ + public function revisionPageTitle($oc_organisation_revision) { + $oc_organisation = $this->entityTypeManager()->getStorage('oc_organisation') + ->loadRevision($oc_organisation_revision); + return $this->t('Revision of %title from %date', [ + '%title' => $oc_organisation->label(), + '%date' => $this->dateFormatter->format($oc_organisation->getRevisionCreationTime()), + ]); + } + + /** + * Generates an overview table of older revisions of a Organisation. + * + * @param \Drupal\opencase_entities\Entity\OCOrganisationInterface $oc_organisation + * A Organisation object. + * + * @return array + * An array as expected by drupal_render(). + */ + public function revisionOverview(OCOrganisationInterface $oc_organisation) { + $account = $this->currentUser(); + $oc_organisation_storage = $this->entityTypeManager()->getStorage('oc_organisation'); + + $langcode = $oc_organisation->language()->getId(); + $langname = $oc_organisation->language()->getName(); + $languages = $oc_organisation->getTranslationLanguages(); + $has_translations = (count($languages) > 1); + $build['#title'] = $has_translations ? $this->t('@langname revisions for %title', ['@langname' => $langname, '%title' => $oc_organisation->label()]) : $this->t('Revisions for %title', ['%title' => $oc_organisation->label()]); + + $header = [$this->t('Revision'), $this->t('Operations')]; + $revert_permission = (($account->hasPermission("revert all organisation revisions") || $account->hasPermission('administer organisation entities'))); + $delete_permission = (($account->hasPermission("delete all organisation revisions") || $account->hasPermission('administer organisation entities'))); + + $rows = []; + + $vids = $oc_organisation_storage->revisionIds($oc_organisation); + + $latest_revision = TRUE; + + foreach (array_reverse($vids) as $vid) { + /** @var \Drupal\opencase_entities\OCOrganisationInterface $revision */ + $revision = $oc_organisation_storage->loadRevision($vid); + // Only show revisions that are affected by the language that is being + // displayed. + if ($revision->hasTranslation($langcode) && $revision->getTranslation($langcode)->isRevisionTranslationAffected()) { + $username = [ + '#theme' => 'username', + '#account' => $revision->getRevisionUser(), + ]; + + // Use revision link to link to revisions that are not active. + $date = $this->dateFormatter->format($revision->getRevisionCreationTime(), 'short'); + if ($vid != $oc_organisation->getRevisionId()) { + $link = $this->l($date, new Url('entity.oc_organisation.revision', [ + 'oc_organisation' => $oc_organisation->id(), + 'oc_organisation_revision' => $vid, + ])); + } + else { + $link = $oc_organisation->link($date); + } + + $row = []; + $column = [ + 'data' => [ + '#type' => 'inline_template', + '#template' => '{% trans %}{{ date }} by {{ username }}{% endtrans %}{% if message %}

{{ message }}

{% endif %}', + '#context' => [ + 'date' => $link, + 'username' => $this->renderer->renderPlain($username), + 'message' => [ + '#markup' => $revision->getRevisionLogMessage(), + '#allowed_tags' => Xss::getHtmlTagList(), + ], + ], + ], + ]; + $row[] = $column; + + if ($latest_revision) { + $row[] = [ + 'data' => [ + '#prefix' => '', + '#markup' => $this->t('Current revision'), + '#suffix' => '', + ], + ]; + foreach ($row as &$current) { + $current['class'] = ['revision-current']; + } + $latest_revision = FALSE; + } + else { + $links = []; + if ($revert_permission) { + $links['revert'] = [ + 'title' => $this->t('Revert'), + 'url' => $has_translations ? + Url::fromRoute('entity.oc_organisation.translation_revert', [ + 'oc_organisation' => $oc_organisation->id(), + 'oc_organisation_revision' => $vid, + 'langcode' => $langcode, + ]) : + Url::fromRoute('entity.oc_organisation.revision_revert', [ + 'oc_organisation' => $oc_organisation->id(), + 'oc_organisation_revision' => $vid, + ]), + ]; + } + + if ($delete_permission) { + $links['delete'] = [ + 'title' => $this->t('Delete'), + 'url' => Url::fromRoute('entity.oc_organisation.revision_delete', [ + 'oc_organisation' => $oc_organisation->id(), + 'oc_organisation_revision' => $vid, + ]), + ]; + } + + $row[] = [ + 'data' => [ + '#type' => 'operations', + '#links' => $links, + ], + ]; + } + + $rows[] = $row; + } + } + + $build['oc_organisation_revisions_table'] = [ + '#theme' => 'table', + '#rows' => $rows, + '#header' => $header, + ]; + + return $build; + } + +} diff --git a/modules/opencase_entities/src/Entity/OCOrganisation.php b/modules/opencase_entities/src/Entity/OCOrganisation.php new file mode 100644 index 0000000..6cc6d25 --- /dev/null +++ b/modules/opencase_entities/src/Entity/OCOrganisation.php @@ -0,0 +1,268 @@ + \Drupal::currentUser()->id(), + ]; + } + + /** + * {@inheritdoc} + */ + protected function urlRouteParameters($rel) { + $uri_route_parameters = parent::urlRouteParameters($rel); + + if ($rel === 'revision_revert' && $this instanceof RevisionableInterface) { + $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId(); + } + elseif ($rel === 'revision_delete' && $this instanceof RevisionableInterface) { + $uri_route_parameters[$this->getEntityTypeId() . '_revision'] = $this->getRevisionId(); + } + + return $uri_route_parameters; + } + + /** + * {@inheritdoc} + */ + public function preSave(EntityStorageInterface $storage) { + parent::preSave($storage); + + foreach (array_keys($this->getTranslationLanguages()) as $langcode) { + $translation = $this->getTranslation($langcode); + + // If no owner has been set explicitly, make the anonymous user the owner. + if (!$translation->getOwner()) { + $translation->setOwnerId(0); + } + } + + // If no revision author has been set explicitly, + // make the oc_organisation owner the revision author. + if (!$this->getRevisionUser()) { + $this->setRevisionUserId($this->getOwnerId()); + } + } + + /** + * {@inheritdoc} + */ + public function getName() { + return $this->get('name')->value; + } + + /** + * {@inheritdoc} + */ + public function setName($name) { + $this->set('name', $name); + return $this; + } + + /** + * {@inheritdoc} + */ + public function getCreatedTime() { + return $this->get('created')->value; + } + + /** + * {@inheritdoc} + */ + public function setCreatedTime($timestamp) { + $this->set('created', $timestamp); + return $this; + } + + /** + * {@inheritdoc} + */ + public function getOwner() { + return $this->get('user_id')->entity; + } + + /** + * {@inheritdoc} + */ + public function getOwnerId() { + return $this->get('user_id')->target_id; + } + + /** + * {@inheritdoc} + */ + public function setOwnerId($uid) { + $this->set('user_id', $uid); + return $this; + } + + /** + * {@inheritdoc} + */ + public function setOwner(UserInterface $account) { + $this->set('user_id', $account->id()); + return $this; + } + + /** + * {@inheritdoc} + */ + public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { + $fields = parent::baseFieldDefinitions($entity_type); + + // Add the published field. + $fields += static::publishedBaseFieldDefinitions($entity_type); + + $fields['user_id'] = BaseFieldDefinition::create('entity_reference') + ->setLabel(t('Authored by')) + ->setDescription(t('The user ID of author of the Organisation entity.')) + ->setRevisionable(TRUE) + ->setSetting('target_type', 'user') + ->setSetting('handler', 'default') + ->setTranslatable(TRUE) + ->setDisplayOptions('view', [ + 'label' => 'hidden', + 'type' => 'author', + 'weight' => 0, + ]) + ->setDisplayOptions('form', [ + 'type' => 'entity_reference_autocomplete', + 'weight' => 5, + 'settings' => [ + 'match_operator' => 'CONTAINS', + 'size' => '60', + 'autocomplete_type' => 'tags', + 'placeholder' => '', + ], + ]) + ->setDisplayConfigurable('form', TRUE) + ->setDisplayConfigurable('view', TRUE); + + $fields['name'] = BaseFieldDefinition::create('string') + ->setLabel(t('Name')) + ->setDescription(t('The name of the Organisation entity.')) + ->setRevisionable(TRUE) + ->setSettings([ + 'max_length' => 50, + 'text_processing' => 0, + ]) + ->setDefaultValue('') + ->setDisplayOptions('view', [ + 'label' => 'above', + 'type' => 'string', + 'weight' => -4, + ]) + ->setDisplayOptions('form', [ + 'type' => 'string_textfield', + 'weight' => -4, + ]) + ->setDisplayConfigurable('form', TRUE) + ->setDisplayConfigurable('view', TRUE) + ->setRequired(TRUE); + + $fields['status']->setDescription(t('A boolean indicating whether the Organisation is published.')) + ->setDisplayOptions('form', [ + 'type' => 'boolean_checkbox', + 'weight' => -3, + ]); + + $fields['created'] = BaseFieldDefinition::create('created') + ->setLabel(t('Created')) + ->setDescription(t('The time that the entity was created.')); + + $fields['changed'] = BaseFieldDefinition::create('changed') + ->setLabel(t('Changed')) + ->setDescription(t('The time that the entity was last edited.')); + + $fields['revision_translation_affected'] = BaseFieldDefinition::create('boolean') + ->setLabel(t('Revision translation affected')) + ->setDescription(t('Indicates if the last edit of a translation belongs to current revision.')) + ->setReadOnly(TRUE) + ->setRevisionable(TRUE) + ->setTranslatable(TRUE); + + return $fields; + } + +} diff --git a/modules/opencase_entities/src/Entity/OCOrganisationInterface.php b/modules/opencase_entities/src/Entity/OCOrganisationInterface.php new file mode 100644 index 0000000..5d68fc5 --- /dev/null +++ b/modules/opencase_entities/src/Entity/OCOrganisationInterface.php @@ -0,0 +1,98 @@ +account = $container->get('current_user'); + return $instance; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state) { + /* @var \Drupal\opencase_entities\Entity\OCOrganisation $entity */ + $form = parent::buildForm($form, $form_state); + + if (!$this->entity->isNew()) { + $form['new_revision'] = [ + '#type' => 'checkbox', + '#title' => $this->t('Create new revision'), + '#default_value' => FALSE, + '#weight' => 10, + ]; + } + + return $form; + } + + /** + * {@inheritdoc} + */ + public function save(array $form, FormStateInterface $form_state) { + $entity = $this->entity; + + // Save as a new revision if requested to do so. + if (!$form_state->isValueEmpty('new_revision') && $form_state->getValue('new_revision') != FALSE) { + $entity->setNewRevision(); + + // If a new revision is created, save the current user as revision author. + $entity->setRevisionCreationTime($this->time->getRequestTime()); + $entity->setRevisionUserId($this->account->id()); + } + else { + $entity->setNewRevision(FALSE); + } + + $status = parent::save($form, $form_state); + + switch ($status) { + case SAVED_NEW: + $this->messenger()->addMessage($this->t('Created the %label Organisation.', [ + '%label' => $entity->label(), + ])); + break; + + default: + $this->messenger()->addMessage($this->t('Saved the %label Organisation.', [ + '%label' => $entity->label(), + ])); + } + $form_state->setRedirect('entity.oc_organisation.canonical', ['oc_organisation' => $entity->id()]); + } + +} diff --git a/modules/opencase_entities/src/Form/OCOrganisationRevisionDeleteForm.php b/modules/opencase_entities/src/Form/OCOrganisationRevisionDeleteForm.php new file mode 100644 index 0000000..be8fbfe --- /dev/null +++ b/modules/opencase_entities/src/Form/OCOrganisationRevisionDeleteForm.php @@ -0,0 +1,108 @@ +oCOrganisationStorage = $container->get('entity_type.manager')->getStorage('oc_organisation'); + $instance->connection = $container->get('database'); + return $instance; + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'oc_organisation_revision_delete_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return $this->t('Are you sure you want to delete the revision from %revision-date?', [ + '%revision-date' => format_date($this->revision->getRevisionCreationTime()), + ]); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('entity.oc_organisation.version_history', ['oc_organisation' => $this->revision->id()]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Delete'); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $oc_organisation_revision = NULL) { + $this->revision = $this->OCOrganisationStorage->loadRevision($oc_organisation_revision); + $form = parent::buildForm($form, $form_state); + + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $this->OCOrganisationStorage->deleteRevision($this->revision->getRevisionId()); + + $this->logger('content')->notice('Organisation: deleted %title revision %revision.', ['%title' => $this->revision->label(), '%revision' => $this->revision->getRevisionId()]); + $this->messenger()->addMessage(t('Revision from %revision-date of Organisation %title has been deleted.', ['%revision-date' => format_date($this->revision->getRevisionCreationTime()), '%title' => $this->revision->label()])); + $form_state->setRedirect( + 'entity.oc_organisation.canonical', + ['oc_organisation' => $this->revision->id()] + ); + if ($this->connection->query('SELECT COUNT(DISTINCT vid) FROM {oc_organisation_field_revision} WHERE id = :id', [':id' => $this->revision->id()])->fetchField() > 1) { + $form_state->setRedirect( + 'entity.oc_organisation.version_history', + ['oc_organisation' => $this->revision->id()] + ); + } + } + +} diff --git a/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertForm.php b/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertForm.php new file mode 100644 index 0000000..d394453 --- /dev/null +++ b/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertForm.php @@ -0,0 +1,137 @@ +oCOrganisationStorage = $container->get('entity_type.manager')->getStorage('oc_organisation'); + $instance->dateFormatter = $container->get('date.formatter'); + return $instance; + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'oc_organisation_revision_revert_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return $this->t('Are you sure you want to revert to the revision from %revision-date?', [ + '%revision-date' => $this->dateFormatter->format($this->revision->getRevisionCreationTime()), + ]); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('entity.oc_organisation.version_history', ['oc_organisation' => $this->revision->id()]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Revert'); + } + + /** + * {@inheritdoc} + */ + public function getDescription() { + return ''; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $oc_organisation_revision = NULL) { + $this->revision = $this->OCOrganisationStorage->loadRevision($oc_organisation_revision); + $form = parent::buildForm($form, $form_state); + + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + // The revision timestamp will be updated when the revision is saved. Keep + // the original one for the confirmation message. + $original_revision_timestamp = $this->revision->getRevisionCreationTime(); + + $this->revision = $this->prepareRevertedRevision($this->revision, $form_state); + $this->revision->revision_log = $this->t('Copy of the revision from %date.', [ + '%date' => $this->dateFormatter->format($original_revision_timestamp), + ]); + $this->revision->save(); + + $this->logger('content')->notice('Organisation: reverted %title revision %revision.', ['%title' => $this->revision->label(), '%revision' => $this->revision->getRevisionId()]); + $this->messenger()->addMessage(t('Organisation %title has been reverted to the revision from %revision-date.', ['%title' => $this->revision->label(), '%revision-date' => $this->dateFormatter->format($original_revision_timestamp)])); + $form_state->setRedirect( + 'entity.oc_organisation.version_history', + ['oc_organisation' => $this->revision->id()] + ); + } + + /** + * Prepares a revision to be reverted. + * + * @param \Drupal\opencase_entities\Entity\OCOrganisationInterface $revision + * The revision to be reverted. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * + * @return \Drupal\opencase_entities\Entity\OCOrganisationInterface + * The prepared revision ready to be stored. + */ + protected function prepareRevertedRevision(OCOrganisationInterface $revision, FormStateInterface $form_state) { + $revision->setNewRevision(); + $revision->isDefaultRevision(TRUE); + $revision->setRevisionCreationTime(REQUEST_TIME); + + return $revision; + } + +} diff --git a/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertTranslationForm.php b/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertTranslationForm.php new file mode 100644 index 0000000..438f170 --- /dev/null +++ b/modules/opencase_entities/src/Form/OCOrganisationRevisionRevertTranslationForm.php @@ -0,0 +1,97 @@ +languageManager = $container->get('language_manager'); + return $instance; + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'oc_organisation_revision_revert_translation_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return $this->t('Are you sure you want to revert @language translation to the revision from %revision-date?', [ + '@language' => $this->languageManager->getLanguageName($this->langcode), + '%revision-date' => $this->dateFormatter->format($this->revision->getRevisionCreationTime()), + ]); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $oc_organisation_revision = NULL, $langcode = NULL) { + $this->langcode = $langcode; + $form = parent::buildForm($form, $form_state, $oc_organisation_revision); + + $form['revert_untranslated_fields'] = [ + '#type' => 'checkbox', + '#title' => $this->t('Revert content shared among translations'), + '#default_value' => FALSE, + ]; + + return $form; + } + + /** + * {@inheritdoc} + */ + protected function prepareRevertedRevision(OCOrganisationInterface $revision, FormStateInterface $form_state) { + $revert_untranslated_fields = $form_state->getValue('revert_untranslated_fields'); + + /** @var \Drupal\opencase_entities\Entity\OCOrganisationInterface $default_revision */ + $latest_revision = $this->OCOrganisationStorage->load($revision->id()); + $latest_revision_translation = $latest_revision->getTranslation($this->langcode); + + $revision_translation = $revision->getTranslation($this->langcode); + + foreach ($latest_revision_translation->getFieldDefinitions() as $field_name => $definition) { + if ($definition->isTranslatable() || $revert_untranslated_fields) { + $latest_revision_translation->set($field_name, $revision_translation->get($field_name)->getValue()); + } + } + + $latest_revision_translation->setNewRevision(); + $latest_revision_translation->isDefaultRevision(TRUE); + $revision->setRevisionCreationTime(REQUEST_TIME); + + return $latest_revision_translation; + } + +} diff --git a/modules/opencase_entities/src/Form/OCOrganisationSettingsForm.php b/modules/opencase_entities/src/Form/OCOrganisationSettingsForm.php new file mode 100644 index 0000000..92423da --- /dev/null +++ b/modules/opencase_entities/src/Form/OCOrganisationSettingsForm.php @@ -0,0 +1,53 @@ +t('Are you sure you want to delete %name?', ['%name' => $this->entity->label()]); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('entity.oc_organisation_type.collection'); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Delete'); + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $this->entity->delete(); + + $this->messenger()->addMessage( + $this->t('content @type: deleted @label.', [ + '@type' => $this->entity->bundle(), + '@label' => $this->entity->label(), + ]) + ); + + $form_state->setRedirectUrl($this->getCancelUrl()); + } + +} diff --git a/modules/opencase_entities/src/Form/OCOrganisationTypeForm.php b/modules/opencase_entities/src/Form/OCOrganisationTypeForm.php new file mode 100644 index 0000000..5277dd2 --- /dev/null +++ b/modules/opencase_entities/src/Form/OCOrganisationTypeForm.php @@ -0,0 +1,65 @@ +entity; + $form['label'] = [ + '#type' => 'textfield', + '#title' => $this->t('Label'), + '#maxlength' => 255, + '#default_value' => $oc_organisation_type->label(), + '#description' => $this->t("Label for the Organisation type."), + '#required' => TRUE, + ]; + + $form['id'] = [ + '#type' => 'machine_name', + '#default_value' => $oc_organisation_type->id(), + '#machine_name' => [ + 'exists' => '\Drupal\opencase_entities\Entity\OCOrganisationType::load', + ], + '#disabled' => !$oc_organisation_type->isNew(), + ]; + + /* You will need additional form elements for your custom properties. */ + + return $form; + } + + /** + * {@inheritdoc} + */ + public function save(array $form, FormStateInterface $form_state) { + $oc_organisation_type = $this->entity; + $status = $oc_organisation_type->save(); + + switch ($status) { + case SAVED_NEW: + $this->messenger()->addMessage($this->t('Created the %label Organisation type.', [ + '%label' => $oc_organisation_type->label(), + ])); + break; + + default: + $this->messenger()->addMessage($this->t('Saved the %label Organisation type.', [ + '%label' => $oc_organisation_type->label(), + ])); + } + $form_state->setRedirectUrl($oc_organisation_type->toUrl('collection')); + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationAccessControlHandler.php b/modules/opencase_entities/src/OCOrganisationAccessControlHandler.php new file mode 100644 index 0000000..4e9e718 --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationAccessControlHandler.php @@ -0,0 +1,116 @@ +isPublished()) { + $permission = $this->checkOwn($entity, 'view unpublished', $account); + if (!empty($permission)) { + return AccessResult::allowed(); + } + + return AccessResult::allowedIfHasPermission($account, 'view unpublished organisation entities'); + } + + $permission = $this->checkOwn($entity, $operation, $account); + if (!empty($permission)) { + return AccessResult::allowed(); + } + + return AccessResult::allowedIfHasPermission($account, 'view published organisation entities'); + + case 'update': + + $permission = $this->checkOwn($entity, $operation, $account); + if (!empty($permission)) { + return AccessResult::allowed(); + } + return AccessResult::allowedIfHasPermission($account, 'edit organisation entities'); + + case 'delete': + + $permission = $this->checkOwn($entity, $operation, $account); + if (!empty($permission)) { + return AccessResult::allowed(); + } + return AccessResult::allowedIfHasPermission($account, 'delete organisation entities'); + } + + // Unknown operation, no opinion. + return AccessResult::neutral(); + } + + /** + * {@inheritdoc} + */ + protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) { + return AccessResult::allowedIfHasPermission($account, 'add organisation entities'); + } + + /** + * Test for given 'own' permission. + * + * @param \Drupal\Core\Entity\EntityInterface $entity + * @param $operation + * @param \Drupal\Core\Session\AccountInterface $account + * + * @return string|null + * The permission string indicating it's allowed. + */ + protected function checkOwn(EntityInterface $entity, $operation, AccountInterface $account) { + $status = $entity->isPublished(); + $uid = $entity->getOwnerId(); + + $is_own = $account->isAuthenticated() && $account->id() == $uid; + if (!$is_own) { + return; + } + + $bundle = $entity->bundle(); + + $ops = [ + 'create' => '%bundle add own %bundle entities', + 'view unpublished' => '%bundle view own unpublished %bundle entities', + 'view' => '%bundle view own entities', + 'update' => '%bundle edit own entities', + 'delete' => '%bundle delete own entities', + ]; + $permission = strtr($ops[$operation], ['%bundle' => $bundle]); + + if ($operation === 'view unpublished') { + if (!$status && $account->hasPermission($permission)) { + return $permission; + } + else { + return NULL; + } + } + if ($account->hasPermission($permission)) { + return $permission; + } + + return NULL; + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationHtmlRouteProvider.php b/modules/opencase_entities/src/OCOrganisationHtmlRouteProvider.php new file mode 100644 index 0000000..d7cbc15 --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationHtmlRouteProvider.php @@ -0,0 +1,196 @@ +id(); + + if ($history_route = $this->getHistoryRoute($entity_type)) { + $collection->add("entity.{$entity_type_id}.version_history", $history_route); + } + + if ($revision_route = $this->getRevisionRoute($entity_type)) { + $collection->add("entity.{$entity_type_id}.revision", $revision_route); + } + + if ($revert_route = $this->getRevisionRevertRoute($entity_type)) { + $collection->add("entity.{$entity_type_id}.revision_revert", $revert_route); + } + + if ($delete_route = $this->getRevisionDeleteRoute($entity_type)) { + $collection->add("entity.{$entity_type_id}.revision_delete", $delete_route); + } + + if ($translation_route = $this->getRevisionTranslationRevertRoute($entity_type)) { + $collection->add("{$entity_type_id}.revision_revert_translation_confirm", $translation_route); + } + + if ($settings_form_route = $this->getSettingsFormRoute($entity_type)) { + $collection->add("$entity_type_id.settings", $settings_form_route); + } + + return $collection; + } + + /** + * Gets the version history route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getHistoryRoute(EntityTypeInterface $entity_type) { + if ($entity_type->hasLinkTemplate('version-history')) { + $route = new Route($entity_type->getLinkTemplate('version-history')); + $route + ->setDefaults([ + '_title' => "{$entity_type->getLabel()} revisions", + '_controller' => '\Drupal\opencase_entities\Controller\OCOrganisationController::revisionOverview', + ]) + ->setRequirement('_permission', 'view all organisation revisions') + ->setOption('_admin_route', TRUE); + + return $route; + } + } + + /** + * Gets the revision route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getRevisionRoute(EntityTypeInterface $entity_type) { + if ($entity_type->hasLinkTemplate('revision')) { + $route = new Route($entity_type->getLinkTemplate('revision')); + $route + ->setDefaults([ + '_controller' => '\Drupal\opencase_entities\Controller\OCOrganisationController::revisionShow', + '_title_callback' => '\Drupal\opencase_entities\Controller\OCOrganisationController::revisionPageTitle', + ]) + ->setRequirement('_permission', 'view all organisation revisions') + ->setOption('_admin_route', TRUE); + + return $route; + } + } + + /** + * Gets the revision revert route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getRevisionRevertRoute(EntityTypeInterface $entity_type) { + if ($entity_type->hasLinkTemplate('revision_revert')) { + $route = new Route($entity_type->getLinkTemplate('revision_revert')); + $route + ->setDefaults([ + '_form' => '\Drupal\opencase_entities\Form\OCOrganisationRevisionRevertForm', + '_title' => 'Revert to earlier revision', + ]) + ->setRequirement('_permission', 'revert all organisation revisions') + ->setOption('_admin_route', TRUE); + + return $route; + } + } + + /** + * Gets the revision delete route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getRevisionDeleteRoute(EntityTypeInterface $entity_type) { + if ($entity_type->hasLinkTemplate('revision_delete')) { + $route = new Route($entity_type->getLinkTemplate('revision_delete')); + $route + ->setDefaults([ + '_form' => '\Drupal\opencase_entities\Form\OCOrganisationRevisionDeleteForm', + '_title' => 'Delete earlier revision', + ]) + ->setRequirement('_permission', 'delete all organisation revisions') + ->setOption('_admin_route', TRUE); + + return $route; + } + } + + /** + * Gets the revision translation revert route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getRevisionTranslationRevertRoute(EntityTypeInterface $entity_type) { + if ($entity_type->hasLinkTemplate('translation_revert')) { + $route = new Route($entity_type->getLinkTemplate('translation_revert')); + $route + ->setDefaults([ + '_form' => '\Drupal\opencase_entities\Form\OCOrganisationRevisionRevertTranslationForm', + '_title' => 'Revert to earlier revision of a translation', + ]) + ->setRequirement('_permission', 'revert all organisation revisions') + ->setOption('_admin_route', TRUE); + + return $route; + } + } + + /** + * Gets the settings form route. + * + * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type + * The entity type. + * + * @return \Symfony\Component\Routing\Route|null + * The generated route, if available. + */ + protected function getSettingsFormRoute(EntityTypeInterface $entity_type) { + if (!$entity_type->getBundleEntityType()) { + $route = new Route("/admin/structure/{$entity_type->id()}/settings"); + $route + ->setDefaults([ + '_form' => 'Drupal\opencase_entities\Form\OCOrganisationSettingsForm', + '_title' => "{$entity_type->getLabel()} settings", + ]) + ->setRequirement('_permission', $entity_type->getAdminPermission()) + ->setOption('_admin_route', TRUE); + + return $route; + } + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationListBuilder.php b/modules/opencase_entities/src/OCOrganisationListBuilder.php new file mode 100644 index 0000000..2ee42b5 --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationListBuilder.php @@ -0,0 +1,39 @@ +t('Organisation ID'); + $header['name'] = $this->t('Name'); + return $header + parent::buildHeader(); + } + + /** + * {@inheritdoc} + */ + public function buildRow(EntityInterface $entity) { + /* @var \Drupal\opencase_entities\Entity\OCOrganisation $entity */ + $row['id'] = $entity->id(); + $row['name'] = Link::createFromRoute( + $entity->label(), + 'entity.oc_organisation.edit_form', + ['oc_organisation' => $entity->id()] + ); + return $row + parent::buildRow($entity); + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationPermissions.php b/modules/opencase_entities/src/OCOrganisationPermissions.php new file mode 100644 index 0000000..8ccbc5a --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationPermissions.php @@ -0,0 +1,80 @@ +buildPermissions($type); + } + + return $perms; + } + + /** + * Returns a list of node permissions for a given node type. + * + * @param \Drupal\opencase_entities\Entity\OCOrganisation $type + * The OCOrganisation type. + * + * @return array + * An associative array of permission names and descriptions. + */ + protected function buildPermissions(OCOrganisation $type) { + $type_id = $type->id(); + $type_params = ['%type_name' => $type->label()]; + + return [ + "$type_id create entities" => [ + 'title' => $this->t('Create new %type_name entities', $type_params), + ], + "$type_id edit own entities" => [ + 'title' => $this->t('Edit own %type_name entities', $type_params), + ], + "$type_id edit any entities" => [ + 'title' => $this->t('Edit any %type_name entities', $type_params), + ], + "$type_id delete own entities" => [ + 'title' => $this->t('Delete own %type_name entities', $type_params), + ], + "$type_id delete any entities" => [ + 'title' => $this->t('Delete any %type_name entities', $type_params), + ], + "$type_id view revisions" => [ + 'title' => $this->t('View %type_name revisions', $type_params), + 'description' => t('To view a revision, you also need permission to view the entity item.'), + ], + "$type_id revert revisions" => [ + 'title' => $this->t('Revert %type_name revisions', $type_params), + 'description' => t('To revert a revision, you also need permission to edit the entity item.'), + ], + "$type_id delete revisions" => [ + 'title' => $this->t('Delete %type_name revisions', $type_params), + 'description' => $this->t('To delete a revision, you also need permission to delete the entity item.'), + ], + ]; + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationStorage.php b/modules/opencase_entities/src/OCOrganisationStorage.php new file mode 100644 index 0000000..c891ed0 --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationStorage.php @@ -0,0 +1,58 @@ +database->query( + 'SELECT vid FROM {oc_organisation_revision} WHERE id=:id ORDER BY vid', + [':id' => $entity->id()] + )->fetchCol(); + } + + /** + * {@inheritdoc} + */ + public function userRevisionIds(AccountInterface $account) { + return $this->database->query( + 'SELECT vid FROM {oc_organisation_field_revision} WHERE uid = :uid ORDER BY vid', + [':uid' => $account->id()] + )->fetchCol(); + } + + /** + * {@inheritdoc} + */ + public function countDefaultLanguageRevisions(OCOrganisationInterface $entity) { + return $this->database->query('SELECT COUNT(*) FROM {oc_organisation_field_revision} WHERE id = :id AND default_langcode = 1', [':id' => $entity->id()]) + ->fetchField(); + } + + /** + * {@inheritdoc} + */ + public function clearRevisionsLanguage(LanguageInterface $language) { + return $this->database->update('oc_organisation_revision') + ->fields(['langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED]) + ->condition('langcode', $language->getId()) + ->execute(); + } + +} diff --git a/modules/opencase_entities/src/OCOrganisationStorageInterface.php b/modules/opencase_entities/src/OCOrganisationStorageInterface.php new file mode 100644 index 0000000..479d3f6 --- /dev/null +++ b/modules/opencase_entities/src/OCOrganisationStorageInterface.php @@ -0,0 +1,61 @@ +t('Organisation type'); + $header['id'] = $this->t('Machine name'); + return $header + parent::buildHeader(); + } + + /** + * {@inheritdoc} + */ + public function buildRow(EntityInterface $entity) { + $row['label'] = $entity->label(); + $row['id'] = $entity->id(); + // You probably want a few more properties here... + return $row + parent::buildRow($entity); + } + +} diff --git a/modules/opencase_entities/templates/oc-organisation-content-add-list.html.twig b/modules/opencase_entities/templates/oc-organisation-content-add-list.html.twig new file mode 100644 index 0000000..771e316 --- /dev/null +++ b/modules/opencase_entities/templates/oc-organisation-content-add-list.html.twig @@ -0,0 +1,23 @@ +{# +/** + * @file + * Default theme implementation to present a list of custom content entity types/bundles. + * + * Available variables: + * - types: A collection of all the available custom entity types/bundles. + * Each type/bundle contains the following: + * - link: A link to add a content entity of this type. + * - description: A description of this content entity types/bundle. + * + * @see template_preprocess_oc_organisation_content_add_list() + * + * @ingroup themeable + */ +#} +{% spaceless %} +
+ {% for type in types %} +
{{ type.link }}
+ {% endfor %} +
+{% endspaceless %} diff --git a/modules/opencase_entities/templates/oc_organisation.html.twig b/modules/opencase_entities/templates/oc_organisation.html.twig new file mode 100644 index 0000000..151f6a9 --- /dev/null +++ b/modules/opencase_entities/templates/oc_organisation.html.twig @@ -0,0 +1,22 @@ +{# +/** + * @file oc_organisation.html.twig + * Default theme implementation to present Organisation data. + * + * This template is used when viewing Organisation pages. + * + * + * Available variables: + * - content: A list of content items. Use 'content' to print all content, or + * - attributes: HTML attributes for the container element. + * + * @see template_preprocess_oc_organisation() + * + * @ingroup themeable + */ +#} + + {% if content %} + {{- content -}} + {% endif %} +