Auto Entity label does not set entity labels and breaks contrib modules

Throws an error when used with the latest version of https://www.drupal.org/project/yamlform.

The website encountered an unexpected error. Please try again later.
Error: Call to undefined method Drupal\yamlform\Entity\YamlFormSubmission::getType() in auto_entitylabel_form_alter() (line 29 of modules/contrib/auto_entitylabel/auto_entitylabel.module).
auto_entitylabel_form_alter(Array, Object, 'yamlform_submission_newsletter_subscription_form') (Line: 501)
Drupal\Core\Extension\ModuleHandler->alter('form', Array, Object, 'yamlform_submission_newsletter_subscription_form') (Line: 816)
Drupal\Core\Form\FormBuilder->prepareForm('yamlform_submission_newsletter_subscription_form', Array, Object) (Line: 29)
Drupal\webprofiler\Form\FormBuilderWrapper->prepareForm('yamlform_submission_newsletter_subscription_form', Array, Object) (Line: 272)
Drupal\Core\Form\FormBuilder->buildForm('yamlform_submission_newsletter_subscription_form', Object) (Line: 48)
Drupal\Core\Entity\EntityFormBuilder->getForm(Object, 'default') (Line: 601)
Drupal\yamlform\Entity\YamlForm->getSubmissionForm(Array) (Line: 75)
Drupal\yamlform\Plugin\Block\YamlFormBlock->build() (Line: 203)
Drupal\block\BlockViewBuilder::preRender(Array)
call_user_func('Drupal\block\BlockViewBuilder::preRender', Array) (Line: 376)
Drupal\Core\Render\Renderer->doRender(Array, 1) (Line: 195)
Drupal\Core\Render\Renderer->render(Array, 1) (Line: 151)
Drupal\Core\Render\Renderer->Drupal\Core\Render\{closure}() (Line: 574)
Drupal\Core\Render\Renderer->executeInRenderContext(Object, Object) (Line: 152)
Drupal\Core\Render\Renderer->renderPlain(Array) (Line: 166)
Drupal\Core\Render\Renderer->renderPlaceholder('', Array) (Line: 659)
Drupal\Core\Render\Renderer->replacePlaceholders(Array) (Line: 544)
Drupal\Core\Render\Renderer->doRender(Array, 1) (Line: 195)
Drupal\Core\Render\Renderer->render(Array, 1) (Line: 139)
Drupal\Core\Render\Renderer->Drupal\Core\Render\{closure}() (Line: 574)
Drupal\Core\Render\Renderer->executeInRenderContext(Object, Object) (Line: 140)
Drupal\Core\Render\Renderer->renderRoot(Array) (Line: 258)
Drupal\Core\Render\HtmlResponseAttachmentsProcessor->renderPlaceholders(Object) (Line: 131)
Drupal\Core\Render\HtmlResponseAttachmentsProcessor->processAttachments(Object) (Line: 45)
Drupal\Core\EventSubscriber\HtmlResponseSubscriber->onRespond(Object, 'kernel.response', Object)
call_user_func(Array, Object, 'kernel.response', Object) (Line: 61)
Symfony\Component\EventDispatcher\Debug\WrappedListener->__invoke(Object, 'kernel.response', Object) (Line: 111)
Drupal\Component\EventDispatcher\ContainerAwareEventDispatcher->dispatch('kernel.response', Object) (Line: 140)
Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher->dispatch('kernel.response', Object) (Line: 184)
Symfony\Component\HttpKernel\HttpKernel->filterResponse(Object, Object, 1) (Line: 166)
Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object, 1) (Line: 64)
Symfony\Component\HttpKernel\HttpKernel->handle(Object, 1, 1) (Line: 57)
Drupal\Core\StackMiddleware\Session->handle(Object, 1, 1) (Line: 47)
Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object, 1, 1) (Line: 99)
Drupal\page_cache\StackMiddleware\PageCache->pass(Object, 1, 1) (Line: 78)
Drupal\page_cache\StackMiddleware\PageCache->handle(Object, 1, 1) (Line: 47)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object, 1, 1) (Line: 38)
Drupal\webprofiler\StackMiddleware\WebprofilerMiddleware->handle(Object, 1, 1) (Line: 50)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object, 1, 1) (Line: 23)
Stack\StackedHttpKernel->handle(Object, 1, 1) (Line: 652)
Drupal\Core\DrupalKernel->handle(Object) (Line: 19)

Seems to be related to this Issue

I have done some work on this and other aspects of the D8 port of Automatic Entity Labels. I've taken and repurposed a lot of @Sutharsan's auto_nodetitle code from https://github.com/Sutharsan/auto_nodetitle/. The attached patch works for nodes, taxonomy and other configuration entities, but there is still work to be done and it needs extensive testing.

There is a known issue with taxonomy: the Auto Label tab does not show up on the vocabulary overview page (admin/structure/taxonomy/manage/{vocabulary}/overview). The admin page does exist, however, and can be accessed at admin/structure/taxonomy/manage/{vocabulary}/auto-label. I'll raise a separate issue about that.

I've improved the patch by adding an automatic label operation to the entity's list of available operations. For example, on the Content types admin page (admin/structure/types) the list of available operations for each type now includes an Automatic entity label option.

Please test the patch and report back here whether or not it works for you so that we can get it committed.

Sorry, there was a permissions bug in the last patch. Use this one instead.

Looks good. Works well with Taxonomies and Yaml Forms.

Just fixing a typo in the issue title...

Thanks for reviewing @VladimirAus

Using patch from #12 with panels and page_manager modules getting this issue https://www.drupal.org/node/2828102 because 'Auto label' is added to 'page' entity type. Attaching possible fix by removing 'Auto label' for this entity type.

Attaching new patch because of some diff export issues.

Thanks @SurfinSpirit. I can confirm your patch fixes the Page Manager problem. I've extended the fix to include page_variant entities too, as that didn't work either.

Just noticed that 'admin/config/content/entity_browser' gives the same error, looks like the if statement in 'auto_entitylabel_entity_type_alter' needs improvements.

Thinking about it some more, I think the right way to do it is to have Auto Entity Label handle only core config entities. It should also provide a hook so that any contrib modules that want to use automatic labels can hook into it. There shouldn't be any hard-coded references to contrib providers in auto_entitylabel_entity_type_alter, so we should remove the specific handling of Page Manager added in the last patch. I'll open a new issue about providing a hook for contrib modules to use.

OK, I've updated the patch to work with core entity types only. I've opened a separate issue about providing a hook or service for contrib or custom modules that want to have automatic labels: #2829571: Provide a hook for contrib modules that want to implement automatic labels

A comment posted over here #2829571: Provide a hook for contrib modules that want to implement automatic labels reported another bug that surfaces for some contrib module. I've amended the patch to include a fix.

The new patch works well with the "Profile" module.
I'll let you know if I have any other problems.
Thank you for the good work.

Thanks for the patch, it seems to work well for us so far. I just noticed one issue regarding the token browser:

     // Display the list of available placeholders if token module is installed.
     if (\Drupal::moduleHandler()->moduleExists('token')) {
       $form['auto_entitylabel']['token_help'] = array(
         '#theme' => 'token_tree_link',
-        '#token_types' => array($entity_type),
+        '#token_types' => array($this->entity_type_provider),
         '#dialog' => TRUE,
       );
     }

This works, if the token type is the same as the module name of the module, that provides the entity type. However, this isn't always the case, e.g. the token type of the entity provided by media_entity module is media, not media_entity. Unfortunately, there doesn't seem to be an entity agnostic way to get the token type for an entity. At least I didn't find it. The best I came up with is this:

    // Display the list of available placeholders if token module is installed.
    $moduleHandler = \Drupal::moduleHandler();
    if ($moduleHandler->moduleExists('token')) {
      $tokenInfo = $moduleHandler->invoke($this->entity_type_provider, 'token_info');
      $tokenTypes = isset($tokenInfo['types']) ? array_keys($tokenInfo['types']) : [];

      $form['auto_entitylabel']['token_help'] = array(
        '#theme' => 'token_tree_link',
        '#token_types' => $tokenTypes,
        '#dialog' => TRUE,
      );
    }

This works for me for all entities, that I tested.

The patch in #22 works great for me.

Is the change suggested in #25 valid? @FeyP could you create a patch for this?

I've added @FeyP's fix into the patch and tested it on nodes and taxonomy. It works for me but I haven't tested it with media_entity. If @FeyP could give it a whirl that would be great. Thanks!

Hello,

Using the patch from #27, and also using Content Moderation module(core, experimental), throws an error when trying to enable moderation states for content types:

The website encountered an unexpected error. Please try again later.
Recoverable fatal error: Argument 1 passed to Drupal\auto_entitylabel\EntityDecorator::decorate() must be an instance of Drupal\Core\Entity\ContentEntityInterface, instance of Drupal\node\Entity\NodeType given, called in /var/www/docroot/modules/contrib/auto_entitylabel/auto_entitylabel.module on line 51 and defined in Drupal\auto_entitylabel\EntityDecorator->decorate() (line 74 of modules/contrib/auto_entitylabel/src/EntityDecorator.php). 

I hope this is helpful, Cheers.

Sorry guys, having a rough start of the week, appended the module name to the patch. And changed the numbers accordingly.

Please disregard the previous files attached, it seems I misunderstood some tutorials.

Attaching correct patch.

Thanks ... it works well :-)

This still works - great! (Git complained because there was no EOL in last line in auto_entity_label-2755445-30.patch - easy to fix.)

I suggest that the current patch (in comment 30) is committed to get the module in a working state. Any outstanding problems can be moved to separate issues.

+1 works fine.

Patch needs reroll

Here's a reroll, changing slightly the additional check added in #30 and adding back some code that was left out in #30. It'd be great to get this committed so please review and report back here whether or not it works for you.

I just tested #35 (starting with git from https://www.drupal.org/project/auto_entitylabel/git-instructions).
I tried Evaluate PHP in pattern and got

PHP Fatal error:  Call to undefined method Drupal\\auto_entitylabel\\AutoEntityLabelManager::evalTitle()
in [...]/auto_entitylabel/src/AutoEntityLabelManager.php on line 243

So I took a look and found in AutoEntityLabelManager::generateLabel():

// Evaluate PHP.
    if ($this->getConfig('php')) {
      $output = $this->evalTitle($output, $this->entity);
    }

The function is called evalLabel() not evalTitle().

Patch and interdiff to #35 attached.

I also think that evalLabel() should check if the eval'ed code goes wrong and raise an error - but that's left for another day ;)

Also the title field is not hidden (Automatically generate the label and hide the label field).

Before hiding the title field auto_entitylabel_form_alter() checks

    [...]
    $decorator = \Drupal::service('auto_entitylabel.entity_decorator');
    /** @var \Drupal\auto_entitylabel\AutoEntityLabelManager $entity */
    $entity = $decorator->decorate($form_state->getFormObject()->getEntity());

    if ($entity instanceof ContentEntityInterface) {
      [...]

$entitiy is an AutoEntityLabelManager which implements AutoEntityLabelManagerInterface.
Neither AutoEntityLabelManager nor AutoEntityLabelManagerInterface implement ContentEntityInterface, so the test instanceof ContentEntityInterface allways fails and the title field is not hidden.

So checking instanceof \Drupal\auto_entitylabel\AutoEntityLabelManagerInterface should do the trick (and does for me).

Thanks @gngn. Your patch works for me too.

Hi, it's the first time I comment!
So, the last patch works. It should be nice if this patch include this simple bug a fix.
I also want to allert about another bug:
When you have the option enabled: "Automatically generate the label and hide the label field" and you use translations, whenever you delete a translation an exception is arisen: InvalidArgumentException: The entity object refers to a removed translation (it) and cannot be manipulated. in Drupal\Core\Entity\ContentEntityBase->getTranslatedField() (line 464 of core/lib/Drupal/Core/Entity/ContentEntityBase.php). reported at the page url it/node/142/delete but anycase the translaction get eresed.
Hope this helps.
Regards.

@AndreaMaggi

• With "simple bug fix" you mean Some characters replaced with HTML entities, don't you?
  (You link to /node/node/2850962 instead of /node/2850962 - I think you missed the leading slash)
• That patch was just adjusted from 'Active' to 'Patch (to be ported)' without any discussion...
• Also I think it is a different issue, so I do not think it should be included here.
• IMHO the same applies to your other issue with translations - I think it would be better to open a new issue for that one.

@gngn
Thenks for the replay. Yes the patch was the one you have included. Sorry but I had uderstand that here were collected all the fixes for the actual release that won't work without this patch. I manually update my file (there are only two line to change).
For the other iusse with the translation I understand that I have to apen a new issue, but I do not have the experience to do that. I do not relly understand how to use this bug fixes iusse reports. My bad, but I have started wokink by my own with Drupal just two mouths ago.
Thans anyway.

@AndreaMaggi: You're doing fine :)
You can create a new issue from the project's issue page.
There is a link "Create a new issue" at the top.
Following it you will also get links to stuff like How to create a good issue.

And for me the module is working with patch #37.

Patch needs reroll.

OK, the recent commits messed things up a bit because a patch that depended on this one was committed #2822546: Auto Label tab not displayed for taxonomy. I've done a reroll which I think gets us back on track.

Interdiff threw an error, so I've done a simple diff between this new patch and the one from #37. Please review and let's try to get this committed soon.

Thanks a lot for all your valuable inputs. Now definitely we can create RC release.

Great we have this in! Rock on!

Great news! Thanks for committing!