API Add new Owner relation for handling permissions #127
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Dec 4, 2023
Closed
GuySartorelli
force-pushed
the
pulls/4/ownership-model
branch
2 times, most recently
from
cd50e9b
to
6d1453d
Compare
GuySartorelli
commented
Dec 5, 2023
src/Models/Link.php
Outdated
Comment on lines
38
to
47
| private static array $has_one = [ | ||
| // Note that this handles one-to-many relations AND one-to-one relations. | ||
| // Any has_one pointing at Link will be intentionally double handled - this allows us to use the owner | ||
| // for permission checks and to link back to the owner from reports, etc. | ||
| // See also the Owner method. | ||
| 'Owner' => [ | ||
| 'class' => DataObject::class, | ||
| DataObjectSchema::HASONE_IS_MULTIRECIPROCAL => true, | ||
| ], | ||
| ]; |
There was a problem hiding this comment.
See the associated framework PR and docs PR for more about this weird has_one syntax.
GuySartorelli
commented
Dec 5, 2023
src/Models/Link.php
Outdated
Comment on lines
295
to
313
| /** | ||
| * Get the owner of this link, if there is one. | ||
| * | ||
| * Returns null if the reciprocal relation is a has_one which no longer contains this link. | ||
| */ | ||
| public function Owner(): ?DataObject | ||
| { | ||
| $owner = $this->getComponent('Owner'); | ||
| // Since the has_one is being stored in two places, double check the owner | ||
| // actually still owns this record. If not, return null. | ||
| $ownerRelationType = $owner->getRelationType($this->OwnerRelation); | ||
| if ($ownerRelationType === 'has_one') { | ||
| $idField = "{$this->OwnerRelation}ID"; | ||
| if ($owner->$idField !== $this->ID) { | ||
| return null; | ||
| } | ||
| } | ||
| return $owner; | ||
| } |
There was a problem hiding this comment.
We're double handling has_one relations to link by storing the has_one in the link as well.
This allows us to use the Owner relation to check permissions, and to link to the owner in reports, etc.
The double handling is mitigated here by returning null if the owner says it doesn't know about the link.
GuySartorelli
force-pushed
the
pulls/4/ownership-model
branch
3 times, most recently
from
34646cf
to
974f6f8
Compare
emteknetnz
requested changes
Dec 7, 2023
src/Models/Link.php
Outdated
| // See also the Owner method. | ||
| 'Owner' => [ | ||
| 'class' => DataObject::class, | ||
| DataObjectSchema::HASONE_IS_MULTIRECIPROCAL => true, |
There was a problem hiding this comment.
I've suggested changing this in the framework PR
GuySartorelli
force-pushed
the
pulls/4/ownership-model
branch
from
974f6f8
to
03b67c8
Compare
emteknetnz
approved these changes
Dec 11, 2023
GuySartorelli
force-pushed
the
pulls/4/ownership-model
branch
from
03b67c8
to
8991e41
Compare
|
Rebased and conflicts resolved |
emteknetnz
approved these changes
Dec 12, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Dependencies
This PR requires silverstripe/silverstripe-framework#11084 to function and for tests to go green but an installer CI run is linked in the issue.
Issues