From 7ac39fc385ce0e5ccbf8e186c5e28bc59edf7ec4 Mon Sep 17 00:00:00 2001 From: naomi Date: Thu, 5 Apr 2018 20:05:00 +0200 Subject: [PATCH] Gennerated Profile entity --- .../config/schema/profile_type.schema.yml | 12 + modules/zencrm_entities/profile.page.inc | 30 ++ .../src/Controller/ProfileController.php | 163 ++++++++++ .../zencrm_entities/src/Entity/Profile.php | 281 ++++++++++++++++++ .../src/Entity/ProfileInterface.php | 116 ++++++++ .../src/Entity/ProfileType.php | 58 ++++ .../src/Entity/ProfileTypeInterface.php | 13 + .../src/Entity/ProfileViewsData.php | 24 ++ .../src/Form/ProfileDeleteForm.php | 15 + .../zencrm_entities/src/Form/ProfileForm.php | 71 +++++ .../src/Form/ProfileRevisionDeleteForm.php | 123 ++++++++ .../src/Form/ProfileRevisionRevertForm.php | 149 ++++++++++ .../ProfileRevisionRevertTranslationForm.php | 115 +++++++ .../src/Form/ProfileSettingsForm.php | 53 ++++ .../src/Form/ProfileTypeDeleteForm.php | 53 ++++ .../src/Form/ProfileTypeForm.php | 65 ++++ .../src/ProfileAccessControlHandler.php | 47 +++ .../src/ProfileHtmlRouteProvider.php | 196 ++++++++++++ .../src/ProfileListBuilder.php | 40 +++ .../zencrm_entities/src/ProfileStorage.php | 58 ++++ .../src/ProfileStorageInterface.php | 61 ++++ .../src/ProfileTranslationHandler.php | 14 + .../src/ProfileTypeHtmlRouteProvider.php | 28 ++ .../src/ProfileTypeListBuilder.php | 32 ++ .../profile-content-add-list.html.twig | 23 ++ .../templates/profile.html.twig | 22 ++ .../zencrm_entities.links.action.yml | 11 + .../zencrm_entities.links.menu.yml | 18 ++ .../zencrm_entities.links.task.yml | 23 ++ .../zencrm_entities/zencrm_entities.module | 34 ++- .../zencrm_entities.permissions.yml | 30 ++ 31 files changed, 1974 insertions(+), 4 deletions(-) create mode 100644 modules/zencrm_entities/config/schema/profile_type.schema.yml create mode 100644 modules/zencrm_entities/profile.page.inc create mode 100644 modules/zencrm_entities/src/Controller/ProfileController.php create mode 100644 modules/zencrm_entities/src/Entity/Profile.php create mode 100644 modules/zencrm_entities/src/Entity/ProfileInterface.php create mode 100644 modules/zencrm_entities/src/Entity/ProfileType.php create mode 100644 modules/zencrm_entities/src/Entity/ProfileTypeInterface.php create mode 100644 modules/zencrm_entities/src/Entity/ProfileViewsData.php create mode 100644 modules/zencrm_entities/src/Form/ProfileDeleteForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileRevisionDeleteForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileRevisionRevertForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileRevisionRevertTranslationForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileSettingsForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileTypeDeleteForm.php create mode 100644 modules/zencrm_entities/src/Form/ProfileTypeForm.php create mode 100644 modules/zencrm_entities/src/ProfileAccessControlHandler.php create mode 100644 modules/zencrm_entities/src/ProfileHtmlRouteProvider.php create mode 100644 modules/zencrm_entities/src/ProfileListBuilder.php create mode 100644 modules/zencrm_entities/src/ProfileStorage.php create mode 100644 modules/zencrm_entities/src/ProfileStorageInterface.php create mode 100644 modules/zencrm_entities/src/ProfileTranslationHandler.php create mode 100644 modules/zencrm_entities/src/ProfileTypeHtmlRouteProvider.php create mode 100644 modules/zencrm_entities/src/ProfileTypeListBuilder.php create mode 100644 modules/zencrm_entities/templates/profile-content-add-list.html.twig create mode 100644 modules/zencrm_entities/templates/profile.html.twig diff --git a/modules/zencrm_entities/config/schema/profile_type.schema.yml b/modules/zencrm_entities/config/schema/profile_type.schema.yml new file mode 100644 index 0000000..ef343e5 --- /dev/null +++ b/modules/zencrm_entities/config/schema/profile_type.schema.yml @@ -0,0 +1,12 @@ +zencrm_entities.profile_type.*: + type: config_entity + label: 'Profile type config' + mapping: + id: + type: string + label: 'ID' + label: + type: label + label: 'Label' + uuid: + type: string diff --git a/modules/zencrm_entities/profile.page.inc b/modules/zencrm_entities/profile.page.inc new file mode 100644 index 0000000..8bbf578 --- /dev/null +++ b/modules/zencrm_entities/profile.page.inc @@ -0,0 +1,30 @@ +entityManager()->getStorage('profile')->loadRevision($profile_revision); + $view_builder = $this->entityManager()->getViewBuilder('profile'); + + return $view_builder->view($profile); + } + + /** + * Page title callback for a Profile revision. + * + * @param int $profile_revision + * The Profile revision ID. + * + * @return string + * The page title. + */ + public function revisionPageTitle($profile_revision) { + $profile = $this->entityManager()->getStorage('profile')->loadRevision($profile_revision); + return $this->t('Revision of %title from %date', ['%title' => $profile->label(), '%date' => format_date($profile->getRevisionCreationTime())]); + } + + /** + * Generates an overview table of older revisions of a Profile . + * + * @param \Drupal\zencrm_entities\Entity\ProfileInterface $profile + * A Profile object. + * + * @return array + * An array as expected by drupal_render(). + */ + public function revisionOverview(ProfileInterface $profile) { + $account = $this->currentUser(); + $langcode = $profile->language()->getId(); + $langname = $profile->language()->getName(); + $languages = $profile->getTranslationLanguages(); + $has_translations = (count($languages) > 1); + $profile_storage = $this->entityManager()->getStorage('profile'); + + $build['#title'] = $has_translations ? $this->t('@langname revisions for %title', ['@langname' => $langname, '%title' => $profile->label()]) : $this->t('Revisions for %title', ['%title' => $profile->label()]); + $header = [$this->t('Revision'), $this->t('Operations')]; + + $revert_permission = (($account->hasPermission("revert all profile revisions") || $account->hasPermission('administer profile entities'))); + $delete_permission = (($account->hasPermission("delete all profile revisions") || $account->hasPermission('administer profile entities'))); + + $rows = []; + + $vids = $profile_storage->revisionIds($profile); + + $latest_revision = TRUE; + + foreach (array_reverse($vids) as $vid) { + /** @var \Drupal\zencrm_entities\ProfileInterface $revision */ + $revision = $profile_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 = \Drupal::service('date.formatter')->format($revision->getRevisionCreationTime(), 'short'); + if ($vid != $profile->getRevisionId()) { + $link = $this->l($date, new Url('entity.profile.revision', ['profile' => $profile->id(), 'profile_revision' => $vid])); + } + else { + $link = $profile->link($date); + } + + $row = []; + $column = [ + 'data' => [ + '#type' => 'inline_template', + '#template' => '{% trans %}{{ date }} by {{ username }}{% endtrans %}{% if message %}

{{ message }}

{% endif %}', + '#context' => [ + 'date' => $link, + 'username' => \Drupal::service('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.profile.translation_revert', ['profile' => $profile->id(), 'profile_revision' => $vid, 'langcode' => $langcode]) : + Url::fromRoute('entity.profile.revision_revert', ['profile' => $profile->id(), 'profile_revision' => $vid]), + ]; + } + + if ($delete_permission) { + $links['delete'] = [ + 'title' => $this->t('Delete'), + 'url' => Url::fromRoute('entity.profile.revision_delete', ['profile' => $profile->id(), 'profile_revision' => $vid]), + ]; + } + + $row[] = [ + 'data' => [ + '#type' => 'operations', + '#links' => $links, + ], + ]; + } + + $rows[] = $row; + } + } + + $build['profile_revisions_table'] = [ + '#theme' => 'table', + '#rows' => $rows, + '#header' => $header, + ]; + + return $build; + } + +} diff --git a/modules/zencrm_entities/src/Entity/Profile.php b/modules/zencrm_entities/src/Entity/Profile.php new file mode 100644 index 0000000..f6094fc --- /dev/null +++ b/modules/zencrm_entities/src/Entity/Profile.php @@ -0,0 +1,281 @@ + \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 profile 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 function isPublished() { + return (bool) $this->getEntityKey('status'); + } + + /** + * {@inheritdoc} + */ + public function setPublished($published) { + $this->set('status', $published ? TRUE : FALSE); + return $this; + } + + /** + * {@inheritdoc} + */ + public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { + $fields = parent::baseFieldDefinitions($entity_type); + + $fields['user_id'] = BaseFieldDefinition::create('entity_reference') + ->setLabel(t('Authored by')) + ->setDescription(t('The user ID of author of the Profile 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 Profile 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'] = BaseFieldDefinition::create('boolean') + ->setLabel(t('Publishing status')) + ->setDescription(t('A boolean indicating whether the Profile is published.')) + ->setRevisionable(TRUE) + ->setDefaultValue(TRUE) + ->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/zencrm_entities/src/Entity/ProfileInterface.php b/modules/zencrm_entities/src/Entity/ProfileInterface.php new file mode 100644 index 0000000..382bd0a --- /dev/null +++ b/modules/zencrm_entities/src/Entity/ProfileInterface.php @@ -0,0 +1,116 @@ +entity->isNew()) { + $form['new_revision'] = [ + '#type' => 'checkbox', + '#title' => $this->t('Create new revision'), + '#default_value' => FALSE, + '#weight' => 10, + ]; + } + + $entity = $this->entity; + + 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(REQUEST_TIME); + $entity->setRevisionUserId(\Drupal::currentUser()->id()); + } + else { + $entity->setNewRevision(FALSE); + } + + $status = parent::save($form, $form_state); + + switch ($status) { + case SAVED_NEW: + drupal_set_message($this->t('Created the %label Profile.', [ + '%label' => $entity->label(), + ])); + break; + + default: + drupal_set_message($this->t('Saved the %label Profile.', [ + '%label' => $entity->label(), + ])); + } + $form_state->setRedirect('entity.profile.canonical', ['profile' => $entity->id()]); + } + +} diff --git a/modules/zencrm_entities/src/Form/ProfileRevisionDeleteForm.php b/modules/zencrm_entities/src/Form/ProfileRevisionDeleteForm.php new file mode 100644 index 0000000..6d38c90 --- /dev/null +++ b/modules/zencrm_entities/src/Form/ProfileRevisionDeleteForm.php @@ -0,0 +1,123 @@ +ProfileStorage = $entity_storage; + $this->connection = $connection; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + $entity_manager = $container->get('entity.manager'); + return new static( + $entity_manager->getStorage('profile'), + $container->get('database') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'profile_revision_delete_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return 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.profile.version_history', ['profile' => $this->revision->id()]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return t('Delete'); + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $profile_revision = NULL) { + $this->revision = $this->ProfileStorage->loadRevision($profile_revision); + $form = parent::buildForm($form, $form_state); + + return $form; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $this->ProfileStorage->deleteRevision($this->revision->getRevisionId()); + + $this->logger('content')->notice('Profile: deleted %title revision %revision.', ['%title' => $this->revision->label(), '%revision' => $this->revision->getRevisionId()]); + drupal_set_message(t('Revision from %revision-date of Profile %title has been deleted.', ['%revision-date' => format_date($this->revision->getRevisionCreationTime()), '%title' => $this->revision->label()])); + $form_state->setRedirect( + 'entity.profile.canonical', + ['profile' => $this->revision->id()] + ); + if ($this->connection->query('SELECT COUNT(DISTINCT vid) FROM {profile_field_revision} WHERE id = :id', [':id' => $this->revision->id()])->fetchField() > 1) { + $form_state->setRedirect( + 'entity.profile.version_history', + ['profile' => $this->revision->id()] + ); + } + } + +} diff --git a/modules/zencrm_entities/src/Form/ProfileRevisionRevertForm.php b/modules/zencrm_entities/src/Form/ProfileRevisionRevertForm.php new file mode 100644 index 0000000..e43516c --- /dev/null +++ b/modules/zencrm_entities/src/Form/ProfileRevisionRevertForm.php @@ -0,0 +1,149 @@ +ProfileStorage = $entity_storage; + $this->dateFormatter = $date_formatter; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('entity.manager')->getStorage('profile'), + $container->get('date.formatter') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'profile_revision_revert_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return 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.profile.version_history', ['profile' => $this->revision->id()]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return t('Revert'); + } + + /** + * {@inheritdoc} + */ + public function getDescription() { + return ''; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state, $profile_revision = NULL) { + $this->revision = $this->ProfileStorage->loadRevision($profile_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 = t('Copy of the revision from %date.', ['%date' => $this->dateFormatter->format($original_revision_timestamp)]); + $this->revision->save(); + + $this->logger('content')->notice('Profile: reverted %title revision %revision.', ['%title' => $this->revision->label(), '%revision' => $this->revision->getRevisionId()]); + drupal_set_message(t('Profile %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.profile.version_history', + ['profile' => $this->revision->id()] + ); + } + + /** + * Prepares a revision to be reverted. + * + * @param \Drupal\zencrm_entities\Entity\ProfileInterface $revision + * The revision to be reverted. + * @param \Drupal\Core\Form\FormStateInterface $form_state + * The current state of the form. + * + * @return \Drupal\zencrm_entities\Entity\ProfileInterface + * The prepared revision ready to be stored. + */ + protected function prepareRevertedRevision(ProfileInterface $revision, FormStateInterface $form_state) { + $revision->setNewRevision(); + $revision->isDefaultRevision(TRUE); + $revision->setRevisionCreationTime(REQUEST_TIME); + + return $revision; + } + +} diff --git a/modules/zencrm_entities/src/Form/ProfileRevisionRevertTranslationForm.php b/modules/zencrm_entities/src/Form/ProfileRevisionRevertTranslationForm.php new file mode 100644 index 0000000..66c672d --- /dev/null +++ b/modules/zencrm_entities/src/Form/ProfileRevisionRevertTranslationForm.php @@ -0,0 +1,115 @@ +languageManager = $language_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('entity.manager')->getStorage('profile'), + $container->get('date.formatter'), + $container->get('language_manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'profile_revision_revert_translation_confirm'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return 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, $profile_revision = NULL, $langcode = NULL) { + $this->langcode = $langcode; + $form = parent::buildForm($form, $form_state, $profile_revision); + + $form['revert_untranslated_fields'] = [ + '#type' => 'checkbox', + '#title' => $this->t('Revert content shared among translations'), + '#default_value' => FALSE, + ]; + + return $form; + } + + /** + * {@inheritdoc} + */ + protected function prepareRevertedRevision(ProfileInterface $revision, FormStateInterface $form_state) { + $revert_untranslated_fields = $form_state->getValue('revert_untranslated_fields'); + + /** @var \Drupal\zencrm_entities\Entity\ProfileInterface $default_revision */ + $latest_revision = $this->ProfileStorage->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/zencrm_entities/src/Form/ProfileSettingsForm.php b/modules/zencrm_entities/src/Form/ProfileSettingsForm.php new file mode 100644 index 0000000..e077fc7 --- /dev/null +++ b/modules/zencrm_entities/src/Form/ProfileSettingsForm.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.profile_type.collection'); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Delete'); + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + $this->entity->delete(); + + drupal_set_message( + $this->t('content @type: deleted @label.', + [ + '@type' => $this->entity->bundle(), + '@label' => $this->entity->label(), + ] + ) + ); + + $form_state->setRedirectUrl($this->getCancelUrl()); + } + +} diff --git a/modules/zencrm_entities/src/Form/ProfileTypeForm.php b/modules/zencrm_entities/src/Form/ProfileTypeForm.php new file mode 100644 index 0000000..091b9fa --- /dev/null +++ b/modules/zencrm_entities/src/Form/ProfileTypeForm.php @@ -0,0 +1,65 @@ +entity; + $form['label'] = [ + '#type' => 'textfield', + '#title' => $this->t('Label'), + '#maxlength' => 255, + '#default_value' => $profile_type->label(), + '#description' => $this->t("Label for the Profile type."), + '#required' => TRUE, + ]; + + $form['id'] = [ + '#type' => 'machine_name', + '#default_value' => $profile_type->id(), + '#machine_name' => [ + 'exists' => '\Drupal\zencrm_entities\Entity\ProfileType::load', + ], + '#disabled' => !$profile_type->isNew(), + ]; + + /* You will need additional form elements for your custom properties. */ + + return $form; + } + + /** + * {@inheritdoc} + */ + public function save(array $form, FormStateInterface $form_state) { + $profile_type = $this->entity; + $status = $profile_type->save(); + + switch ($status) { + case SAVED_NEW: + drupal_set_message($this->t('Created the %label Profile type.', [ + '%label' => $profile_type->label(), + ])); + break; + + default: + drupal_set_message($this->t('Saved the %label Profile type.', [ + '%label' => $profile_type->label(), + ])); + } + $form_state->setRedirectUrl($profile_type->toUrl('collection')); + } + +} diff --git a/modules/zencrm_entities/src/ProfileAccessControlHandler.php b/modules/zencrm_entities/src/ProfileAccessControlHandler.php new file mode 100644 index 0000000..0eac19c --- /dev/null +++ b/modules/zencrm_entities/src/ProfileAccessControlHandler.php @@ -0,0 +1,47 @@ +isPublished()) { + return AccessResult::allowedIfHasPermission($account, 'view unpublished profile entities'); + } + return AccessResult::allowedIfHasPermission($account, 'view published profile entities'); + + case 'update': + return AccessResult::allowedIfHasPermission($account, 'edit profile entities'); + + case 'delete': + return AccessResult::allowedIfHasPermission($account, 'delete profile entities'); + } + + // Unknown operation, no opinion. + return AccessResult::neutral(); + } + + /** + * {@inheritdoc} + */ + protected function checkCreateAccess(AccountInterface $account, array $context, $entity_bundle = NULL) { + return AccessResult::allowedIfHasPermission($account, 'add profile entities'); + } + +} diff --git a/modules/zencrm_entities/src/ProfileHtmlRouteProvider.php b/modules/zencrm_entities/src/ProfileHtmlRouteProvider.php new file mode 100644 index 0000000..de8faf0 --- /dev/null +++ b/modules/zencrm_entities/src/ProfileHtmlRouteProvider.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\zencrm_entities\Controller\ProfileController::revisionOverview', + ]) + ->setRequirement('_permission', 'access profile 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\zencrm_entities\Controller\ProfileController::revisionShow', + '_title_callback' => '\Drupal\zencrm_entities\Controller\ProfileController::revisionPageTitle', + ]) + ->setRequirement('_permission', 'access profile 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\zencrm_entities\Form\ProfileRevisionRevertForm', + '_title' => 'Revert to earlier revision', + ]) + ->setRequirement('_permission', 'revert all profile 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\zencrm_entities\Form\ProfileRevisionDeleteForm', + '_title' => 'Delete earlier revision', + ]) + ->setRequirement('_permission', 'delete all profile 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\zencrm_entities\Form\ProfileRevisionRevertTranslationForm', + '_title' => 'Revert to earlier revision of a translation', + ]) + ->setRequirement('_permission', 'revert all profile 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\zencrm_entities\Form\ProfileSettingsForm', + '_title' => "{$entity_type->getLabel()} settings", + ]) + ->setRequirement('_permission', $entity_type->getAdminPermission()) + ->setOption('_admin_route', TRUE); + + return $route; + } + } + +} diff --git a/modules/zencrm_entities/src/ProfileListBuilder.php b/modules/zencrm_entities/src/ProfileListBuilder.php new file mode 100644 index 0000000..93ae336 --- /dev/null +++ b/modules/zencrm_entities/src/ProfileListBuilder.php @@ -0,0 +1,40 @@ +t('Profile ID'); + $header['name'] = $this->t('Name'); + return $header + parent::buildHeader(); + } + + /** + * {@inheritdoc} + */ + public function buildRow(EntityInterface $entity) { + /* @var $entity \Drupal\zencrm_entities\Entity\Profile */ + $row['id'] = $entity->id(); + $row['name'] = Link::createFromRoute( + $entity->label(), + 'entity.profile.edit_form', + ['profile' => $entity->id()] + ); + return $row + parent::buildRow($entity); + } + +} diff --git a/modules/zencrm_entities/src/ProfileStorage.php b/modules/zencrm_entities/src/ProfileStorage.php new file mode 100644 index 0000000..0be322b --- /dev/null +++ b/modules/zencrm_entities/src/ProfileStorage.php @@ -0,0 +1,58 @@ +database->query( + 'SELECT vid FROM {profile_revision} WHERE id=:id ORDER BY vid', + [':id' => $entity->id()] + )->fetchCol(); + } + + /** + * {@inheritdoc} + */ + public function userRevisionIds(AccountInterface $account) { + return $this->database->query( + 'SELECT vid FROM {profile_field_revision} WHERE uid = :uid ORDER BY vid', + [':uid' => $account->id()] + )->fetchCol(); + } + + /** + * {@inheritdoc} + */ + public function countDefaultLanguageRevisions(ProfileInterface $entity) { + return $this->database->query('SELECT COUNT(*) FROM {profile_field_revision} WHERE id = :id AND default_langcode = 1', [':id' => $entity->id()]) + ->fetchField(); + } + + /** + * {@inheritdoc} + */ + public function clearRevisionsLanguage(LanguageInterface $language) { + return $this->database->update('profile_revision') + ->fields(['langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED]) + ->condition('langcode', $language->getId()) + ->execute(); + } + +} diff --git a/modules/zencrm_entities/src/ProfileStorageInterface.php b/modules/zencrm_entities/src/ProfileStorageInterface.php new file mode 100644 index 0000000..96a7d6f --- /dev/null +++ b/modules/zencrm_entities/src/ProfileStorageInterface.php @@ -0,0 +1,61 @@ +t('Profile 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/zencrm_entities/templates/profile-content-add-list.html.twig b/modules/zencrm_entities/templates/profile-content-add-list.html.twig new file mode 100644 index 0000000..e0e7f1d --- /dev/null +++ b/modules/zencrm_entities/templates/profile-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_profile_content_add_list() + * + * @ingroup themeable + */ +#} +{% spaceless %} +
+ {% for type in types %} +
{{ type.link }}
+ {% endfor %} +
+{% endspaceless %} diff --git a/modules/zencrm_entities/templates/profile.html.twig b/modules/zencrm_entities/templates/profile.html.twig new file mode 100644 index 0000000..e244ec6 --- /dev/null +++ b/modules/zencrm_entities/templates/profile.html.twig @@ -0,0 +1,22 @@ +{# +/** + * @file profile.html.twig + * Default theme implementation to present Profile data. + * + * This template is used when viewing Profile 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_profile() + * + * @ingroup themeable + */ +#} + + {% if content %} + {{- content -}} + {% endif %} + diff --git a/modules/zencrm_entities/zencrm_entities.links.action.yml b/modules/zencrm_entities/zencrm_entities.links.action.yml index 13b90f7..142652b 100644 --- a/modules/zencrm_entities/zencrm_entities.links.action.yml +++ b/modules/zencrm_entities/zencrm_entities.links.action.yml @@ -3,3 +3,14 @@ entity.person.add_form: title: 'Add Person' appears_on: - entity.person.collection +entity.profile.add_form: + route_name: entity.profile.add_page + title: 'Add Profile' + appears_on: + - entity.profile.collection +entity.profile_type.add_form: + route_name: entity.profile_type.add_form + title: 'Add Profile type' + appears_on: + - entity.profile_type.collection + diff --git a/modules/zencrm_entities/zencrm_entities.links.menu.yml b/modules/zencrm_entities/zencrm_entities.links.menu.yml index e55e04e..c3f4d63 100644 --- a/modules/zencrm_entities/zencrm_entities.links.menu.yml +++ b/modules/zencrm_entities/zencrm_entities.links.menu.yml @@ -12,3 +12,21 @@ person.admin.structure.settings: description: 'Configure Person entities' route_name: person.settings parent: system.admin_structure + +# Profile menu items definition +entity.profile.collection: + title: 'Profile list' + route_name: entity.profile.collection + description: 'List Profile entities' + parent: system.admin_structure + weight: 100 + + +# Profile type menu items definition +entity.profile_type.collection: + title: 'Profile type' + route_name: entity.profile_type.collection + description: 'List Profile type (bundles)' + parent: system.admin_structure + weight: 99 + diff --git a/modules/zencrm_entities/zencrm_entities.links.task.yml b/modules/zencrm_entities/zencrm_entities.links.task.yml index b0f95d1..6ce894f 100644 --- a/modules/zencrm_entities/zencrm_entities.links.task.yml +++ b/modules/zencrm_entities/zencrm_entities.links.task.yml @@ -25,3 +25,26 @@ entity.person.delete_form: title: Delete weight: 10 +# Profile routing definition + +entity.profile.canonical: + route_name: entity.profile.canonical + base_route: entity.profile.canonical + title: 'View' + +entity.profile.edit_form: + route_name: entity.profile.edit_form + base_route: entity.profile.canonical + title: 'Edit' + +entity.profile.version_history: + route_name: entity.profile.version_history + base_route: entity.profile.canonical + title: 'Revisions' + +entity.profile.delete_form: + route_name: entity.profile.delete_form + base_route: entity.profile.canonical + title: Delete + weight: 10 + diff --git a/modules/zencrm_entities/zencrm_entities.module b/modules/zencrm_entities/zencrm_entities.module index be031b1..985f2fd 100644 --- a/modules/zencrm_entities/zencrm_entities.module +++ b/modules/zencrm_entities/zencrm_entities.module @@ -27,9 +27,35 @@ function zencrm_entities_help($route_name, RouteMatchInterface $route_match) { * Implements hook_theme(). */ function zencrm_entities_theme() { - return [ - 'zencrm_entities' => [ - 'render element' => 'children', - ], + $theme = []; + $theme['zencrm_entities'] = [ + 'render element' => 'children', ]; + $theme['profile'] = [ + 'render element' => 'elements', + 'file' => 'profile.page.inc', + 'template' => 'profile', + ]; + $theme['profile_content_add_list'] = [ + 'render element' => 'content', + 'variables' => ['content' => NULL], + 'file' => 'profile.page.inc', + ]; + return $theme; +} + +/** +* Implements hook_theme_suggestions_HOOK(). +*/ +function zencrm_entities_theme_suggestions_profile(array $variables) { + $suggestions = []; + $entity = $variables['elements']['#profile']; + $sanitized_view_mode = strtr($variables['elements']['#view_mode'], '.', '_'); + + $suggestions[] = 'profile__' . $sanitized_view_mode; + $suggestions[] = 'profile__' . $entity->bundle(); + $suggestions[] = 'profile__' . $entity->bundle() . '__' . $sanitized_view_mode; + $suggestions[] = 'profile__' . $entity->id(); + $suggestions[] = 'profile__' . $entity->id() . '__' . $sanitized_view_mode; + return $suggestions; } diff --git a/modules/zencrm_entities/zencrm_entities.permissions.yml b/modules/zencrm_entities/zencrm_entities.permissions.yml index 9e60c2f..5e56d93 100644 --- a/modules/zencrm_entities/zencrm_entities.permissions.yml +++ b/modules/zencrm_entities/zencrm_entities.permissions.yml @@ -28,3 +28,33 @@ revert all person revisions: delete all person revisions: title: 'Delete all revisions' description: 'Role requires permission to view Person revisions and delete rights for person entities in question or administer person entities.' +add profile entities: + title: 'Create new Profile entities' + +administer profile entities: + title: 'Administer Profile entities' + description: 'Allow to access the administration form to configure Profile entities.' + restrict access: true + +delete profile entities: + title: 'Delete Profile entities' + +edit profile entities: + title: 'Edit Profile entities' + +view published profile entities: + title: 'View published Profile entities' + +view unpublished profile entities: + title: 'View unpublished Profile entities' + +view all profile revisions: + title: 'View all Profile revisions' + +revert all profile revisions: + title: 'Revert all Profile revisions' + description: 'Role requires permission view Profile revisions and edit rights for profile entities in question or administer profile entities.' + +delete all profile revisions: + title: 'Delete all revisions' + description: 'Role requires permission to view Profile revisions and delete rights for profile entities in question or administer profile entities.'