[CLEANUP] Rename AbstractContentObject::getContentObject()
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / ContentObject / AbstractContentObject.php
1 <?php
2 namespace TYPO3\CMS\Frontend\ContentObject;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 use TYPO3\CMS\Core\Page\PageRenderer;
18 use TYPO3\CMS\Core\Utility\GeneralUtility;
19
20 /**
21 * Contains an abstract class for all tslib content class implementations.
22 */
23 abstract class AbstractContentObject
24 {
25 /**
26 * @var ContentObjectRenderer
27 */
28 protected $cObj;
29
30 /**
31 * @var PageRenderer
32 */
33 protected $pageRenderer = null;
34
35 /**
36 * Default constructor.
37 *
38 * @param ContentObjectRenderer $cObj
39 */
40 public function __construct(ContentObjectRenderer $cObj)
41 {
42 $this->cObj = $cObj;
43 }
44
45 /**
46 * Renders the content object.
47 *
48 * @param array $conf
49 * @return string
50 */
51 abstract public function render($conf = array());
52
53 /**
54 * Getter for current ContentObjectRenderer
55 *
56 * @return ContentObjectRenderer
57 * @deprecated since TYPO3 v8, will be removed with TYPO3 v9. Use getContentObjectRenderer() instead.
58 */
59 public function getContentObject()
60 {
61 GeneralUtility::logDeprecatedFunction();
62 return $this->getContentObjectRenderer();
63 }
64
65 /**
66 * Getter for current ContentObjectRenderer
67 *
68 * @return ContentObjectRenderer
69 */
70 public function getContentObjectRenderer()
71 {
72 return $this->cObj;
73 }
74
75 /**
76 * @return PageRenderer
77 */
78 protected function getPageRenderer()
79 {
80 if ($this->pageRenderer === null) {
81 $this->pageRenderer = GeneralUtility::makeInstance(PageRenderer::class);
82 }
83
84 return $this->pageRenderer;
85 }
86 }