[#65] Deprecate "createdBy" and "lastModifiedBy" properties #74
Conversation
…e not returned by Hybrid and should not be relied upon.
… from tests and mock responses.
| @@ -38,6 +38,10 @@ trait CommonEntityPropertiesAwareTrait | |||
| /** | |||
| * Email address of the organization user who created the entity. | |||
| * | |||
| * @deprecated Not used in Hybrid orgs. | |||
There was a problem hiding this comment.
Can we used a similar, standardized format like Drupal 8 introduced which tells a deveoper which version XY was deprecated and when it will be removed? Also, if there is any replacement for the class/method/etc a developer can get information about it?
There was a problem hiding this comment.
I've changed it to:
@deprecated in 2.0.4, will be removed before 3.0.0. Unsupported in Hybrid.
@see https://github.com/apigee/apigee-client-php/issues/65
2.0.4 should be the next release.
There was a problem hiding this comment.
Unsupported in Hybrid.
What does it mean exactly? What happens if I call these methods on an object returned from a hybrid org? Do they return an empty string?
There was a problem hiding this comment.
@mxr576 The fields are empty so calling the methods would return NULL, as they are never initialized.
You are right, I've added them back. |
Closes #65 . Deprecate "createdBy" and "lastModifiedBy" properties, as they are not being used by the Drupal Edge module, and are not supported by Hybrid.
This PR adds deprecation comments and removes the properties from the test mock data as well.