Commit b5c1adc8 authored by Christian Kuhn's avatar Christian Kuhn
Browse files

[TASK] Improve some property & method comments

Add some more comments to TemplateService related
properties and fix typos.

Resolves: #97796
Releases: main
Change-Id: I131e141e0d1acce57ded287348c7ed0e2ab8a983
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/74964

Tested-by: core-ci's avatarcore-ci <typo3@b13.com>
Tested-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
Tested-by: Simon Schaufelberger's avatarSimon Schaufelberger <simonschaufi+typo3@gmail.com>
Tested-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Stefan Bürk's avatarStefan Bürk <stefan@buerk.tech>
Reviewed-by: Simon Schaufelberger's avatarSimon Schaufelberger <simonschaufi+typo3@gmail.com>
Reviewed-by: Christian Kuhn's avatarChristian Kuhn <lolli@schwarzbu.ch>
parent 82b2f671
...@@ -1573,7 +1573,7 @@ class PageRepository implements LoggerAwareInterface ...@@ -1573,7 +1573,7 @@ class PageRepository implements LoggerAwareInterface
* usage might produce undesired results and that should be evaluated on * usage might produce undesired results and that should be evaluated on
* individual basis. * individual basis.
* *
* Principle; Record online! => Find offline? * Principle: Record online! => Find offline?
* *
* @param string $table Table name * @param string $table Table name
* @param array $row Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_state" fields must exist! The record MAY be set to FALSE in which case the calling function should act as if the record is forbidden to access! * @param array $row Record array passed by reference. As minimum, the "uid", "pid" and "t3ver_state" fields must exist! The record MAY be set to FALSE in which case the calling function should act as if the record is forbidden to access!
......
...@@ -156,14 +156,21 @@ class TemplateService ...@@ -156,14 +156,21 @@ class TemplateService
protected $rootId; protected $rootId;
/** /**
* The rootline from current page to the root page * The rootline from current page to the root page.
* This is exactly the same as $absoluteRootLine, just in reversed order, so
* first entry with key 0 is site-root page, last node is requested page with
* the highest key.
* This is set up by runThroughTemplates().
* *
* @var array * @var array
*/ */
public $rootLine; public $rootLine;
/** /**
* Rootline all the way to the root. Set but runThroughTemplates * Rootline all the way to the root. Set by runThroughTemplates.
* This is basically the direct output of RootlineUtility: First node
* has the highest key and is the deepest page (typically the uid of the requested page),
* the last node is the root node of the site and has key 0.
*/ */
protected array $absoluteRootLine = []; protected array $absoluteRootLine = [];
......
...@@ -313,7 +313,7 @@ class PathUtility ...@@ -313,7 +313,7 @@ class PathUtility
* @see \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName() * @see \TYPO3\CMS\Core\Utility\GeneralUtility::getFileAbsFileName()
* *
* Resolves all dots and slashes between that paths of both files. * Resolves all dots and slashes between that paths of both files.
* Whether the result is absolute or not, depends of the base file name. * Whether the result is absolute or not, depends on the base file name.
* *
* If the include file goes higher than a relative base file, then the result * If the include file goes higher than a relative base file, then the result
* will contain dots as a relative part. * will contain dots as a relative part.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment