[CLEANUP] Review comment and sig of addMountPointParameterToPage() 77/52877/4
authorElmar Hinz <t3elmar@gmail.com>
Sat, 20 May 2017 13:03:14 +0000 (15:03 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 20 May 2017 22:56:26 +0000 (00:56 +0200)
Releases: master, 8.7
Resolves: #81280
Change-Id: I8689827c9e33202e7659a39bb55e7a9bfd792aa2
Reviewed-on: https://review.typo3.org/52877
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/frontend/Classes/Page/PageRepository.php

index 8c69419..1b019b1 100644 (file)
@@ -731,12 +731,21 @@ class PageRepository
     }
 
     /**
-     * Add the mount point parameter to the page if needed
+     * Replaces the given page record with mounted page if required
      *
-     * @param array $page The page to check
-     * @return array
+     * If the given page record is a mount point in overlay mode, the page
+     * record is replaced by the record of the overlaying page. The overlay
+     * record is enriched by setting the mount point mapping into the field
+     * _MP_PARAM as string for example '23-14'.
+     *
+     * In all other cases the given page record is returned as is.
+     *
+     * @todo Find a better name. The current doesn't hit the point.
+     *
+     * @param array $page The page record to handle.
+     * @return array The given page record or it's replacement.
      */
-    protected function addMountPointParameterToPage(array $page)
+    protected function addMountPointParameterToPage(array $page): array
     {
         if (empty($page)) {
             return [];
@@ -745,7 +754,7 @@ class PageRepository
         // $page MUST have "uid", "pid", "doktype", "mount_pid", "mount_pid_ol" fields in it
         $mountPointInfo = $this->getMountPointInfo($page['uid'], $page);
 
-        // There is a valid mount point.
+        // There is a valid mount point in overlay mode.
         if (is_array($mountPointInfo) && $mountPointInfo['overlay']) {
 
             // Using "getPage" is OK since we need the check for enableFields AND for type 2