File namer#1784 #2114

Nielsvanpach · 2020-10-16T13:02:00Z

It's already possible to use a custom file namer on conversions.
This PR allows responsive images to use a mutual custom file namer.

freekmurze

We're almost there!

freekmurze · 2020-10-19T07:13:10Z

docs/advanced-usage/naming-generated-files.md

+{original-file-name-without-extension}___{name-of-the-conversion}_{width}_{height}.{extension}
+```
+
+Just like the conversion file names, you can use another format for naming your files.


This is unclear. So getConversionFileName is used as the basis for the responsive image file names?

DefaultFileNamer needs 2 methods:

getFileName used by conversions and responsive images. For example, a timestamp prefix can be added here. This will affect both the conversion file names and the responsive image file names.

getConversionFileName is only used for conversions. For example file-name---thumb can be renamed to file-name_thumb. You could however also change the file name here and this will only apply on conversion files.

I still don't understand this fully. To me it seems strange that getFileName is also used for conversion files, as getConversionFileName already handles that. It might be best to add a couple very explicit examples to the docs.

I see what you mean. I'll have another look at a different solution

Updated:

getFileName is removed from the FileNamer. It needs these 2 methods (which do not interfere each other):

getConversionFileName

getResponsiveImageFileName

tests/TestSupport/TestFileNamer.php

tests/ResponsiveImages/ResponsiveImageTest.php

tests/ResponsiveImages/ResponsiveImageGeneratorFileNamerTest.php

tests/ResponsiveImages/ResponsiveImageFileNamerTest.php

freekmurze

One nitpick!

src/Support/FileNamer/DefaultFileNamer.php

freekmurze · 2020-10-27T18:42:12Z

Thanks!

* wip * wip * wip * wip * fix case * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * update javascript docs * update javascript docs * wip JS components documentation * wip javascript components documentation * wip * wip * wip * Update handling-uploads-with-vue-or-react.md * Fix styling * wip * wip * wip * wip * wip * wip * wip * wip * wip * Fix styling * remove translations * wip * wip * wip * Fix styling * update props * improve conversions (#2101) * wip * Fix styling * wip * wip * Fix styling * wip * wip * Fix styling * wip * wip * wip * wip * wip * wip * Fix styling * wip Co-authored-by: freekmurze <[email protected]> * update * document maxSizeForPreviewInBytes * wip * wip * Rework frontend docs * Rework frontend docs * Restore data code blocks * wip * wip * Update general upload guide * Words * Words * Doc updates * wip * Fix styling * wip * wip * wip * use v9 links * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * v9 * wip * wip * wip * wip * wip * wip * wip * correct year * wip * docs: css installation * wip * Custom CSS * Custom CSS * Custom CSS * Custom CSS * Custom CSS * docs: update JS UI components * wip js docs * wip * wip * update validation property name * update for Vue 3 * updates for Vue 3 * Set height attribute (#2132) * update naming * typo * wip * reorder sections * capitalize CSS * wip * wip * wip * add jsonSerialize to MediaCollection * update slot usage for Vue 3 * fix getting old values * Fix styling * fix last commit * File namer#1784 (#2114) * support a custom file namer for responsive images * Fix styling * apply code review suggestions * let conversions use a new file namer class * add documentation * cleanup last conversion file namer parts * apply code review suggestions * split up conversion & responsive file namer * remove get prefix on FileNamer methods * Update naming-generated-files.md * Update naming-generated-files.md Co-authored-by: Nielsvanpach <[email protected]> Co-authored-by: Freek Van der Herten <[email protected]> * wip * wip * update docs with new endpoints * wip * wip * drop laravel 6 * wip * update vapor config * wip * update upload endpoint * update paths * allow PHP 8 * wip * remove notice * add enable_vapor_uploads option + restructure config file * wip * wip * wip * find last occurence of starting characters (#2140) * find last occurence of starting characters if a filename ends with _, the responsive image will have four underscores in its name. We used to trim at the first occurence, so the collection name starts with an underscore. This way responsive image will not get rendered as expected. Now, we will trim on the last occurence and the collection name will not start with an underscore in this case. * fix test case Co-authored-by: Adriaan <[email protected]> Co-authored-by: freekmurze <[email protected]> Co-authored-by: Sebastian De Deyne <[email protected]> Co-authored-by: Willem Van Bockstal <[email protected]> Co-authored-by: Robin Cramer <[email protected]> Co-authored-by: AdrianMrn <[email protected]> Co-authored-by: Niels Vanpachtenbeke <[email protected]> Co-authored-by: Nielsvanpach <[email protected]>

* wip * wip * wip * wip * fix case * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * update javascript docs * update javascript docs * wip JS components documentation * wip javascript components documentation * wip * wip * wip * Update handling-uploads-with-vue-or-react.md * Fix styling * wip * wip * wip * wip * wip * wip * wip * wip * wip * Fix styling * remove translations * wip * wip * wip * Fix styling * update props * improve conversions (spatie#2101) * wip * Fix styling * wip * wip * Fix styling * wip * wip * Fix styling * wip * wip * wip * wip * wip * wip * Fix styling * wip Co-authored-by: freekmurze <[email protected]> * update * document maxSizeForPreviewInBytes * wip * wip * Rework frontend docs * Rework frontend docs * Restore data code blocks * wip * wip * Update general upload guide * Words * Words * Doc updates * wip * Fix styling * wip * wip * wip * use v9 links * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * wip * v9 * wip * wip * wip * wip * wip * wip * wip * correct year * wip * docs: css installation * wip * Custom CSS * Custom CSS * Custom CSS * Custom CSS * Custom CSS * docs: update JS UI components * wip js docs * wip * wip * update validation property name * update for Vue 3 * updates for Vue 3 * Set height attribute (spatie#2132) * update naming * typo * wip * reorder sections * capitalize CSS * wip * wip * wip * add jsonSerialize to MediaCollection * update slot usage for Vue 3 * fix getting old values * Fix styling * fix last commit * File namer#1784 (spatie#2114) * support a custom file namer for responsive images * Fix styling * apply code review suggestions * let conversions use a new file namer class * add documentation * cleanup last conversion file namer parts * apply code review suggestions * split up conversion & responsive file namer * remove get prefix on FileNamer methods * Update naming-generated-files.md * Update naming-generated-files.md Co-authored-by: Nielsvanpach <[email protected]> Co-authored-by: Freek Van der Herten <[email protected]> * wip * wip * update docs with new endpoints * wip * wip * drop laravel 6 * wip * update vapor config * wip * update upload endpoint * update paths * allow PHP 8 * wip * remove notice * add enable_vapor_uploads option + restructure config file * wip * wip * wip * find last occurence of starting characters (spatie#2140) * find last occurence of starting characters if a filename ends with _, the responsive image will have four underscores in its name. We used to trim at the first occurence, so the collection name starts with an underscore. This way responsive image will not get rendered as expected. Now, we will trim on the last occurence and the collection name will not start with an underscore in this case. * fix test case Co-authored-by: Adriaan <[email protected]> Co-authored-by: freekmurze <[email protected]> Co-authored-by: Sebastian De Deyne <[email protected]> Co-authored-by: Willem Van Bockstal <[email protected]> Co-authored-by: Robin Cramer <[email protected]> Co-authored-by: AdrianMrn <[email protected]> Co-authored-by: Niels Vanpachtenbeke <[email protected]> Co-authored-by: Nielsvanpach <[email protected]>

Nielsvanpach and others added 6 commits October 16, 2020 14:42

support a custom file namer for responsive images

bd1619d

Fix styling

b149286

apply code review suggestions

efac4a7

let conversions use a new file namer class

17a6d6c

add documentation

b758869

cleanup last conversion file namer parts

5c8eb83

Nielsvanpach marked this pull request as ready for review October 16, 2020 13:42

Nielsvanpach requested a review from freekmurze October 16, 2020 13:46

freekmurze requested changes Oct 19, 2020

View reviewed changes

Nielsvanpach added 2 commits October 19, 2020 22:38

apply code review suggestions

dd15977

split up conversion & responsive file namer

a130934

freekmurze requested changes Oct 27, 2020

View reviewed changes

src/Support/FileNamer/DefaultFileNamer.php Outdated Show resolved Hide resolved

Nielsvanpach and others added 3 commits October 27, 2020 13:55

remove get prefix on FileNamer methods

4b70d7e

Update naming-generated-files.md

dba532c

Update naming-generated-files.md

c5306a2

freekmurze merged commit f2c5a56 into v9 Oct 27, 2020

freekmurze deleted the file-namer#1784 branch October 27, 2020 18:42

Nielsvanpach linked an issue Oct 28, 2020 that may be closed by this pull request

Responsive file names don't follow conversion file names #1784

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File namer#1784 #2114

File namer#1784 #2114

Nielsvanpach commented Oct 16, 2020

freekmurze left a comment

freekmurze Oct 19, 2020

Nielsvanpach Oct 19, 2020 •

edited

Loading

freekmurze Oct 20, 2020

Nielsvanpach Oct 20, 2020

Nielsvanpach Oct 23, 2020

freekmurze left a comment

freekmurze commented Oct 27, 2020

File namer#1784 #2114

File namer#1784 #2114

Conversation

Nielsvanpach commented Oct 16, 2020

freekmurze left a comment

Choose a reason for hiding this comment

freekmurze Oct 19, 2020

Choose a reason for hiding this comment

Nielsvanpach Oct 19, 2020 • edited Loading

Choose a reason for hiding this comment

freekmurze Oct 20, 2020

Choose a reason for hiding this comment

Nielsvanpach Oct 20, 2020

Choose a reason for hiding this comment

Nielsvanpach Oct 23, 2020

Choose a reason for hiding this comment

freekmurze left a comment

Choose a reason for hiding this comment

freekmurze commented Oct 27, 2020

Nielsvanpach Oct 19, 2020 •

edited

Loading