Collect deprecated methods/classes to be removed in 3.0

[Jako]

Summary

Collect deprecated methods/classes to be removed in 3.0 in the MODX core code and add logging code in those methods/classes.

This should be done before the release of 2.6 to have some warning time for extra authors.

This issue could be used to collect those methods/classes. Please add the methods/classes with the filename, classname and method name in a new comment.

Filename	Classname	Method
core/model/modx/rest/modrestclient.class.php	modRestClient	-
core/model/modx/rest/modrestcurlclient.class.php	modRestCurlClient	-
core/model/modx/rest/modrestserver.class.php	modRestServer	-
core/model/modx/rest/modrestsockclient.class.php	modRestSockClient	-
core/xpdo/xpdo.class.php	xPDO	toJson
core/xpdo/xpdo.class.php	xPDO	fromJson

modRestClient is used in core for Package Management. So the core methods have to be changed to use modRestService or the deprecated notice has to be removed.

Unsure:

Filename	Classname	Method	Reason
core/model/modx/rest/modrest.class.php	modRest	-	Is it replaced by modRestService?

Update (19/10/2021): I've gone through the topic and marked all things that have been addressed as crossed off. If not crossed off, that means it may require further discussion. ^Mark

[Mark-H]

I didn't realise the modRest utils were going to be removed? Got a source for that, or are you just proposing we do?

[Jako]

All the classes mentioned above have a line like this:
https://github.com/modxcms/revolution/blob/2.x/core/model/modx/rest/modrestclient.class.php#L11

modRestService, modRestController etc. are not touched by this.

[Mark-H]

Ah.. don't think I noticed that before :D Makes me wonder what other code we have that is marked as deprecated in that way from years ago, and how we feel about those things today. Some deprecations will be logical as things are refactored, but there might also be things that we want to take out just because it's not something MODX should provide.

[Jako]

The classes of the first table seemed to be improved a lot in modRestService, so they could be deprecated. But I have no code using these classes, so I am maybe wrong.

[Jako]

modRestClient is used in core. ^Mark: Not anymore!

[Jako]

According to @theboxer the S3 Media Source code in the core can't be upgraded to the newest S3 API. So that part should be marked as deprecated. ^Mark: Has been upgraded to Flysystem 2.

[OptimusCrime]

Can't as in the S3 Media Source library dependency has changed, or some other reason? Does the S3 Media Source require some adjustments or a rewrite? ^Mark: has been addressed.

[Jako]

There is an extra package available: https://github.com/modxcms/aws-s3-media-source

[Mark-H]

@opengeek mentioned on the MAB call that he had a list of "hundreds" deprecations.

[whitebyte]

Consider adding $modx->toJSON to the list. Can't recall when I've seen PHP withiut JSON enabled by default. ^Mark: as that's part of xPDO, I've created an issue there: modxcms/xpdo#212

[OptimusCrime]

I agree @whitebyte . That method made sense in the past, but no longer. ^Mark: see above

[Mark-H]

The ability to use flat file processors (2.1-style) should also be removed in 3.0, in favour of the class based processors only. I believe that logic is located in the modConnectorRequest and/or modConnectorResponse class. ^Mark: Done!

[gpsietzema]

System settings to be removed: ^Mark: have been removed!

• filemanager_url
• filemanager_url_relative

[JoshuaLuckers]

Are we still going to remove those in 3.x? ^Mark: yes, we did!

[meshkov]

System setting to remove "server_protocol" #13269 ^Mark: removed!

[Mark-H]

#14057 removes the legacy contentType (not content_type), should be documented/marked as deprecated in 2.7. ^Mark: replaced with #15822

[alroniks]

I guess modparser095.class.php yet one candidate for deleting in 3.0 ^Mark: it's gone!

[Mark-H]

I'd be in favour of removing that as well. It probably makes sense to also remove modTranslate095 and modTranslator in that case, which is the only core usage of modParser095 and designed as a one-time conversion utility. The only usage of modParser095 that I can find is Provisioner, which could be updated to include its own copy of the parser class if there's still demand for that. ^Mark: all gone!

[Jako]

modClassMap is deprecated with 2.2. I am not sure, if that could be logged. Would $xpdo contain $modx methods in __construct? ^Mark: removed!

[JoshuaLuckers]

"Role" in "Access Control Lists". In my opinion, it is not used by anyone, and it is not clear how it works :)

Why do you think it's not being used by anyone? There are a lot of features in MODX you and I might not use because we don't know about them or don't understand them, that doesn't mean they are not being used.

See for more info about Roles the docs.

[ghost]

Well, it would take a complete reworking of the entire permissions system, including all the permissions checks to get rid of them, so it's not really worth the bother. Easy enough to simply ignore them, or else give everybody 0. Then those who do use them can continue to happily do so.

In some ways, they resemble contexts in that regard. Except for situations like multiple domains using a single Manager, you can get the basic resource structure to do anything that contexts can be used for.

[Ruslan-Aleev]

"Recent Resources" tab in the "Account" section.

This tab is superfluous in my opinion. Firstly, there is a widget on the "Home" section, and secondly, there is a section "Manager log" to which, by the way, the widget refers on the "Home" section.

[alroniks]

"Recent Resources" tab in the "Account" section.

But in the widget general information, when here only related to this specific user.

[Ruslan-Aleev]

But in the widget general information...

It's strange, is access control taken into account in the widget? For example, some user should not see some resources, but he will see all of them in the widget? And can he start editing? The same question to the "Manager log" section, there is a filter by users.

[Ruslan-Aleev]

... when here only related to this specific user.

If it works like that, then there is logic in it. Although, I thought that only the current user is shown in the widget.

[alroniks]

In both cases, it calls GetRecentlyEditedResources processor with limit by the current user.

[wshawn]

Flash in the manager. Not a method / class, but it needs to be added to the list for removal.

[JoshuaLuckers]

Flash in the manager. Not a method / class, but it needs to be added to the list for removal.

Can you be more specific? I believe the swf files are removed already.

[wshawn]

/manager/assets/ext3/resources {expressinstall.swf, charts.swf}
/core/packages/core/MODX/Revolution

Also in the packages:
/core/packages/core/MODX/Revolution/modContext/e74fa3f7bc1acb8b732de8e70427c6e4/0/assets/ext3/resources

The affects MODX 2 and MODX 3. Firefox throws a warning (in the address bar) to use the outdated version of Flash. As I do not have Flash installed.

I believe they are called in /manager/assets/ext3/ {ext-all-debug.js, exct-all.js} :

Ext.chart.Chart.CHART_URL = 'http:/' + '/yui.yahooapis.com/2.8.2/build/charts/assets/charts.swf';
...

Ext.FlashComponent.EXPRESS_INSTALL_URL = 'http:/' + '/swfobject.googlecode.com/svn/trunk/swfobject/expressInstall.swf';

[JoshuaLuckers]

Good catch, those are ExtJS dependencies and I'm not sure if we can remove them.

[wshawn]

I heard at one point, that sites running any Flash will be actively blocked by Chrome. If that is the case, that would be a huge problem.

[Jako]

If we don't use the 'chart', 'piechart', 'cartesianchart' and the derived xtypes, we are safe. The code of those components could be stripped away in ext-all-debug.js and be minified again in ext-all.js

[ghost]

Having two "deprecated" errors every time you use the Installer is just annoying, and embarrassing that it should still be an issue after four years. Is there someone, anyone, who can look at it and see if, at the least, the errors can be removed? Are they actually not working correctly? Are they actually going to be removed in MODX 3? ^Mark: deprecated logging has been removed to a separate table so package installer wont show them anymore #15002

[Ruslan-Aleev]

By the way, there is also a "Recent Documents" tab in "System Information" section, in addition to #13199 (comment)

[Mark-H]

I've gone through the topic and edited everyone's comments to cross things off that have been addressed. Only a few things remain which I don't think are necessarily blockers for beta, or need more discussion to reach a consensus. I've removed importing resources in the process, and opened an issue in the xPDO repository about toJSON/fromJSON.

I'm tempted to close the issue now (and request others to open new issues for things we should further cleanup) but will leave it open a little longer.