Problem/Motivation

I want to figure out what ConfigEntityInterface::getConfigDependencyName does. I look up the documentation for it.

Expected Result

I learn what this method does.

Actual Result

I learn the obvious.

Gets the configuration dependency name.

Proposed resolution

Document this method better.

Remaining tasks

Figure out what the method does.
Write it down.

CommentFileSizeAuthor
Screen Shot 2014-04-13 at 2.07.26 PM.png25.34 KBGaelan

Comments

Gaelan’s picture

Gaelan commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Good idea to document this. I have no idea either.

Gaelan’s picture

Gaelan commented

It looks like this function returns the name of the configuration file that the ConfigEntity will be stored in, with out the .info.yml.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Yes. How about a patch then?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Although... The purpose is something else. It seems to be mostly used in ConfigDependencyManager, so while that is what the default implementation does return, I don't think that is what we should document. ViewsUI overrides it to return an empty string.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Related issues: +#2235363: Document config dependencies
Anonymous’s picture

Anonymous (not verified) commented
Status: Active » Needs review

Additional information for this method was added in #2282519: Add content dependency information to configuration entities. I think that is sufficient?

+++ b/core/lib/Drupal/Core/Entity/EntityInterface.php
@@ -404,4 +404,18 @@ public function getTypedData();
+  /**
+   * Gets the configuration dependency name.
+   *
+   * Configuration entities can depend on content and configuration entities.
+   * They store an array of content and config dependency names in their
+   * "dependencies" key.
+   *
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Closed (cannot reproduce)

Agreed, this problem has vanished.