Add asset methods for plugins #4989
Merged
Conversation
This file contains hidden or 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
Contributor
Author
|
hey, any update on this PR? is this something you generally don't want, or have you just not found the time to look at it yet? |
lukasbestle
reviewed
Jan 26, 2023
Member
lukasbestle
left a comment
lukasbestle
left a comment
There was a problem hiding this comment.
Sorry for the delay, we were indeed quite busy with 3.9 and 3.9.1. We haven't forgot about your other PR either, but it's going to take a bit of time to review.
I really like the idea of asset methods. I'd say they fit in quite well conceptually. Image methods would have an overlap with the existing file methods, but asset methods are really separate and useful on their own.
lukasbestle
previously approved these changes
Jan 26, 2023
lukasbestle
approved these changes
Jan 26, 2023
distantnative
approved these changes
Feb 12, 2023
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This PR …
Adds asset methods that work similar to file methods or page methods, just for use with the
Kirby/Filesystem/Assetclass that's e.g. used by theasset()helper.Why is this important?
There are many plugins out there that can e.g. apply image transforms such as johannschopplich/kirby-blurry-placeholder or my own kirby-blurhash that one might want to use on a static image, but they only work conveniently with Kirby files itself due to file methods not being supported for simple assets.
See also: johannschopplich/kirby-blurry-placeholder#15
This should also be in favor of Kirby, as the docs state: "Anything in your public path can be converted to an Asset object to use the same handy file methods as for any other Kirby files."
They obviously can't be allowed access to regular custom file methods, as those might access properties only available on the
Fileobject.What else to consider?
An alternative to this could be to allow
imageMethodswhich extend theKirby/Image/Imageclass. They would automatically inherit to assets and image files, but thus also allow less customization due to the lack of access to e.g.mediapath info.Breaking changes
None.
Ready?
For review team