Project

General

Profile

Actions

Task #74404

closed

Rename cObj to contentObjectRenderer

Added by Elmar Hinz about 8 years ago. Updated over 6 years ago.

Status:
Closed
Priority:
Could have
Assignee:
-
Category:
-
Target version:
-
Start date:
2016-03-07
Due date:
% Done:

0%

Estimated time:
TYPO3 Version:
8
PHP Version:
Tags:
Complexity:
medium
Sprint Focus:

Description

To modernise TYPO3 CMS cryptic names should go in favour of speaking names. The cryptic names cObj and cObject are used as variable names all over core and extensions to name different classes of objects.

Rename cObj to contentObjectRenderer, where it addresses a ContentObjectRenderer. Keep the names cObj or cObject, were the names are directly related to TypoScript.

Historically the ContentObjectRenderer and the content objects was all one class. Now theses are separated classes and the separation should be expressed in the naming of variables containing the objects.

As this variable names are used in hundreds of places I think it difficult to improve it in one patch. I suggest as migration path in four steps:

1. Introduce the modern name, while keeping the old name as a valid aliases.

This is easy to do and enables updating the API without pressure of deprecation. Moreover it gives to time to figure out, where to use the new names and where to keep TypoScript related old names.

2. Deprecate the aliases.

Once this has been done and it is clear, what and how to rename deprecate the aliases.

3. Remove the aliases

Consider function names

There are also function names containing the part cObj or cObject. Like with the variables this may either be justified by names of TypoScript or could be improved to a more speaking wording.

I suggest to separate the topic of function names.

Actions #1

Updated by Gerrit Code Review about 8 years ago

  • Status changed from New to Under Review

Patch set 3 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/47143

Actions #2

Updated by Riccardo De Contardi over 6 years ago

  • Status changed from Under Review to Closed

I close this issue for now as there has been no progress on this cleanup activity for more than 1 year (the patch on Gerrit has been abandoned).

If this is the wrong decision, please reopen it or open a new ticket with a reference to this issue. Thank you.

Actions

Also available in: Atom PDF