RDFMapping class variables should not be accessed directly. Functions should be use to access the variable. For instance use getDescription() and setDescription($description) for the protected class variable description. For a boolean variable the getter function becomes isVariableName(). In object-oriented programming this is called encapsulation.

Remaining tasks

  • Update the class variables and make them protected.
  • Create getters and setters for frequently used get and set functionality.
  • Update drupal to use the getters and setters instead of accessing variables directly.
  • There are no tests required because the added functions are only getters and setters.

For more info over what should be done see the issue summary of #2016679: Expand Entity Type interfaces to provide methods, protect the properties.

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug because properties should not be public, API methods should not be allowed to be sidestepped.
Issue priority Major because this meta goes across the entire system. But each child will be a normal bug.
Prioritized changes Prioritized since it is a bug and it reduces fragility.
Disruption Somewhat disruptive for core as well as contributed and custom modules:
  • BC break for anything using the public properties: code will need to convert to the methods
  • BC break for anything (mis)using properties that should not really be public: will require minor refactoring
  • BC break for alternate implementations of a given entity interface (rare/probably nonexistent): they will need to implement the new methods

But impact will be greater than the disruption, so it is allowed in the beta.

CommentFileSizeAuthor
#4 2384531-3.patch682 bytesdaffie
#3 2384531-3.patch682 bytesrpayanm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

daffie’s picture

daffie CreditAttribution: daffie commented

I would like to get this fixed. So I will do a good review for posted patches.

daffie’s picture

daffie CreditAttribution: daffie commented
Issue summary: View changes

The class variables $id, $targetEntityType and $bundle need to become protected.

rpayanm’s picture

rpayanm
he/him
Primary language Spanish
CreditAttribution: rpayanm commented
Title: Make the class variables protected for RDFMapping » Make the class variables protected for RdfMapping
Status: Active » Needs review
FileSize
2384531-3.patch682 bytes
daffie’s picture

daffie CreditAttribution: daffie commented
FileSize
2384531-3.patch682 bytes

There was a problem with the testbot and I cannot restart testing the patch from comment #3. So, I re-upload the patch from comment #3.

daffie’s picture

daffie CreditAttribution: daffie commented
Status: Needs review » Reviewed & tested by the community

All the class variables are protected.
There are already getter functions available, so no need for new ones.
The test-server give it green.
It all looks good to me, so for me it is RTBC.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Fixed

Committed 4bdc684 and pushed to 8.0.x. Thanks!

Thanks for adding the beta evaluation for to the issue summary.

  • alexpott committed 4bdc684 on 8.0.x 
    Issue #2384531 by daffie, rpayanm: Make the class variables protected...

The last submitted patch, 3: 2384531-3.patch, failed testing.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.