[v5] @todo items in codes

[afbora]

Todo List in v5

• deprecated: name => value, flipping, start throwing in warning in v5
  Basti: I think it would be helpful to start cleaning this up.
  

  kirby/config/fields/color.php

  Line 86 in 2e572e6

  // TODO: start throwing in warning in v5

• Add return type declaration
  Basti: Those are unfortunately all for the collection() feature and I know that some users "abuse" this to not just return Collections. If we add return types here, we would break that. Not sure if it's worth it and if we gain much from the return type.
  

  kirby/config/helpers.php

  Line 56 in d2eb35f

  * @todo 5.0 Add return type declaration

  
  

  kirby/src/Cms/App.php

  Line 378 in 2acb9a1

  * @todo 5.0 Add return type declaration

  
  

  kirby/src/Cms/Collections.php

  Line 44 in af1da17

  * @todo 5.0 Add return type declaration

• Add deprecation warning when anything else than a Collection is returned
  Basti: see above
  

  kirby/src/Cms/Collections.php

  Line 55 in af1da17

  * @todo 5.0 Add deprecation warning when anything else than a Collection is returned

• remove this check when read option deprecated in v5
  

  kirby/src/Cms/File.php

  Line 316 in 464c09e

  // TODO: remove this check when `read` option deprecated in v5

  
  

  kirby/src/Cms/File.php

  Line 335 in 464c09e

  // TODO: remove this check when `read` option deprecated in v5

  
  

  kirby/src/Cms/File.php

  Line 356 in 464c09e

  * @todo Deprecate `read` option in v5 and make the necessary changes for `access` and `list` options.

  
  

  kirby/src/Cms/Page.php

  Line 520 in 05d31fa

  // TODO: remove this check when `read` option deprecated in v5

  
  

  kirby/src/Cms/Page.php

  Line 682 in 05d31fa

  // TODO: remove this check when `read` option deprecated in v5

  
  

  kirby/src/Cms/Page.php

  Line 746 in 05d31fa

  * @todo Deprecate `read` option in v5 and make the necessary changes for `access` and `list` options.

• Remove acceptMime method
  

  kirby/src/Cms/FileBlueprint.php

  Line 63 in f850de8

  * @todo 5.0.0 Remove method

• Consider more descriptive name and maybe move to a different class
  

  kirby/src/Content/Storage.php

  Line 33 in fa87fc8

  * @todo 5.0.0 Consider more descriptive name and maybe move to a different class

• Deprecate url option in v5, use href option instead, Deprecate rel usage as array key in v5, use rel option instead
  

  kirby/src/Panel/Assets.php

  Lines 122 to 123 in af1da17

  	* @todo Deprecate `url` option in v5, use `href` option instead
  	* @todo Deprecate `rel` usage as array key in v5, use `rel` option instead

• use actual in-memory page in v5
  

  kirby/src/Panel/PageCreateDialog.php

  Line 259 in af1da17

  // TODO: use actual in-memory page in v5

• Check if case-sensitive can become the default mode, see Deprecate Collection::$caseSensitive #5635
  

  kirby/src/Toolkit/Collection.php

  Line 34 in af1da17

  * @todo 5.0 Check if case-sensitive can become the

Unit tests

• Remove backward compatibility part test in v5
  

  kirby/tests/Panel/AssetsTest.php

  Line 339 in fddd1d7

  * @todo Remove backward compatibility part test in v5

  
  

  kirby/tests/Panel/AssetsTest.php

  Line 373 in fddd1d7

  * @todo Remove backward compatibility part test in v5

[afbora]

Feel free to add, edit, update, delete or assign yourself for the tasks.

[distantnative]

@afbora Thanks for collecting these!

I think we should re-evaluate each of them. Just because we added the to-do during v4 to have the breaking change in v5 doesn't mean we must do it. There might be cases where it would be better to wait for another major version (v6) with not much downside, but to spare developers of another breaking change.

But that's probably a case by case decision.

[afbora]

I totally agree. The reason I created the issue is so that we don't miss it.

[bastianallgeier]

I've started adding inline comments. Not the ideal format, but I think it's readable enough :)

[afbora]

@bastianallgeier We can move the issue into Notion if you want. The discussion will proceed better in there.

[johannschopplich]

I have a wish for the todo list:

• Remove deprecated legacy Panel aliases. I think it would make sense for v5 to clean up the aliases and prefer, e.g. this.$panel.t over this.$panel.$t.
• The window.panel.$vue alias for kirbyup can be removed as well, since kirbyup uses window.panel.app since the last major version.

[jirichlebus]

I have one wish for 5.0.0-beta.2 update:

Panel view buttons should be able to translate text field to another languages, for example:

buttons:
  - preview
  - languages
  analytics:
    icon: chart
    text:
      cs: Analytika
      en: Analytics
    link: https://my-analytics.com/for/this/page
    theme: aqua-icon