38ccc8c044da72f0ebc0bf29e3163dd78d1b952e
[Packages/TYPO3.CMS.git] / typo3 / sysext / frontend / Classes / Plugin / AbstractPlugin.php
1 <?php
2 namespace TYPO3\CMS\Frontend\Plugin;
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 Doctrine\DBAL\Driver\Statement;
18 use TYPO3\CMS\Core\Database\Connection;
19 use TYPO3\CMS\Core\Database\ConnectionPool;
20 use TYPO3\CMS\Core\Database\Query\QueryHelper;
21 use TYPO3\CMS\Core\Database\Query\Restriction\FrontendRestrictionContainer;
22 use TYPO3\CMS\Core\Localization\Locales;
23 use TYPO3\CMS\Core\Localization\LocalizationFactory;
24 use TYPO3\CMS\Core\Service\MarkerBasedTemplateService;
25 use TYPO3\CMS\Core\Utility\ArrayUtility;
26 use TYPO3\CMS\Core\Utility\GeneralUtility;
27 use TYPO3\CMS\Core\Utility\MathUtility;
28 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
29 use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
30
31 /**
32 * Base class for frontend plugins
33 * Most modern frontend plugins are extension classes of this one.
34 * This class contains functions which assists these plugins in creating lists, searching, displaying menus, page-browsing (next/previous/1/2/3) and handling links.
35 * Functions are all prefixed "pi_" which is reserved for this class. Those functions can of course be overridden in the extension classes (that is the point...)
36 */
37 class AbstractPlugin
38 {
39 /**
40 * The backReference to the mother cObj object set at call time
41 *
42 * @var ContentObjectRenderer
43 */
44 public $cObj;
45
46 /**
47 * Should be same as classname of the plugin, used for CSS classes, variables
48 *
49 * @var string
50 */
51 public $prefixId;
52
53 /**
54 * Path to the plugin class script relative to extension directory, eg. 'pi1/class.tx_newfaq_pi1.php'
55 *
56 * @var string
57 */
58 public $scriptRelPath;
59
60 /**
61 * Extension key.
62 *
63 * @var string
64 */
65 public $extKey;
66
67 /**
68 * This is the incoming array by name $this->prefixId merged between POST and GET, POST taking precedence.
69 * Eg. if the class name is 'tx_myext'
70 * then the content of this array will be whatever comes into &tx_myext[...]=...
71 *
72 * @var array
73 */
74 public $piVars = [
75 'pointer' => '',
76 // Used as a pointer for lists
77 'mode' => '',
78 // List mode
79 'sword' => '',
80 // Search word
81 'sort' => ''
82 ];
83
84 /**
85 * Local pointer variabe array.
86 * Holds pointer information for the MVC like approach Kasper
87 * initially proposed
88 *
89 * @var array
90 */
91 public $internal = ['res_count' => 0, 'results_at_a_time' => 20, 'maxPages' => 10, 'currentRow' => [], 'currentTable' => ''];
92
93 /**
94 * Local Language content
95 *
96 * @var array
97 */
98 public $LOCAL_LANG = [];
99
100 /**
101 * Contains those LL keys, which have been set to (empty) in TypoScript.
102 * This is necessary, as we cannot distinguish between a nonexisting
103 * translation and a label that has been cleared by TS.
104 * In both cases ['key'][0]['target'] is "".
105 *
106 * @var array
107 */
108 protected $LOCAL_LANG_UNSET = [];
109
110 /**
111 * Flag that tells if the locallang file has been fetch (or tried to
112 * be fetched) already.
113 *
114 * @var bool
115 */
116 public $LOCAL_LANG_loaded = false;
117
118 /**
119 * Pointer to the language to use.
120 *
121 * @var string
122 */
123 public $LLkey = 'default';
124
125 /**
126 * Pointer to alternative fall-back language to use.
127 *
128 * @var string
129 */
130 public $altLLkey = '';
131
132 /**
133 * You can set this during development to some value that makes it
134 * easy for you to spot all labels that ARe delivered by the getLL function.
135 *
136 * @var string
137 */
138 public $LLtestPrefix = '';
139
140 /**
141 * Save as LLtestPrefix, but additional prefix for the alternative value
142 * in getLL() function calls
143 *
144 * @var string
145 */
146 public $LLtestPrefixAlt = '';
147
148 /**
149 * @var string
150 */
151 public $pi_isOnlyFields = 'mode,pointer';
152
153 /**
154 * @var int
155 */
156 public $pi_alwaysPrev = 0;
157
158 /**
159 * @var int
160 */
161 public $pi_lowerThan = 5;
162
163 /**
164 * @var string
165 */
166 public $pi_moreParams = '';
167
168 /**
169 * @var string
170 */
171 public $pi_listFields = '*';
172
173 /**
174 * @var array
175 */
176 public $pi_autoCacheFields = [];
177
178 /**
179 * @var bool
180 */
181 public $pi_autoCacheEn = false;
182
183 /**
184 * If set, then links are
185 * 1) not using cHash and
186 * 2) not allowing pages to be cached. (Set this for all USER_INT plugins!)
187 *
188 * @var bool
189 */
190 public $pi_USER_INT_obj = false;
191
192 /**
193 * If set, then caching is disabled if piVars are incoming while
194 * no cHash was set (Set this for all USER plugins!)
195 *
196 * @var bool
197 */
198 public $pi_checkCHash = false;
199
200 /**
201 * Should normally be set in the main function with the TypoScript content passed to the method.
202 *
203 * $conf[LOCAL_LANG][_key_] is reserved for Local Language overrides.
204 * $conf[userFunc] reserved for setting up the USER / USER_INT object. See TSref
205 *
206 * @var array
207 */
208 public $conf = [];
209
210 /**
211 * internal, don't mess with...
212 *
213 * @var ContentObjectRenderer
214 */
215 public $pi_EPtemp_cObj;
216
217 /**
218 * @var int
219 */
220 public $pi_tmpPageId = 0;
221
222 /**
223 * Property for accessing TypoScriptFrontendController centrally
224 *
225 * @var TypoScriptFrontendController
226 */
227 protected $frontendController;
228
229 /**
230 * @var MarkerBasedTemplateService
231 */
232 protected $templateService;
233
234 /**
235 * Class Constructor (true constructor)
236 * Initializes $this->piVars if $this->prefixId is set to any value
237 * Will also set $this->LLkey based on the config.language setting.
238 *
239 * @param null $_ unused,
240 * @param TypoScriptFrontendController $frontendController
241 */
242 public function __construct($_ = null, TypoScriptFrontendController $frontendController = null)
243 {
244 $this->frontendController = $frontendController ?: $GLOBALS['TSFE'];
245 $this->templateService = GeneralUtility::makeInstance(MarkerBasedTemplateService::class);
246 // Setting piVars:
247 if ($this->prefixId) {
248 $this->piVars = GeneralUtility::_GPmerged($this->prefixId);
249 // cHash mode check
250 // IMPORTANT FOR CACHED PLUGINS (USER cObject): As soon as you generate cached plugin output which
251 // depends on parameters (eg. seeing the details of a news item) you MUST check if a cHash value is set.
252 // Background: The function call will check if a cHash parameter was sent with the URL because only if
253 // it was the page may be cached. If no cHash was found the function will simply disable caching to
254 // avoid unpredictable caching behaviour. In any case your plugin can generate the expected output and
255 // the only risk is that the content may not be cached. A missing cHash value is considered a mistake
256 // in the URL resulting from either URL manipulation, "realurl" "grayzones" etc. The problem is rare
257 // (more frequent with "realurl") but when it occurs it is very puzzling!
258 if ($this->pi_checkCHash && !empty($this->piVars)) {
259 $this->frontendController->reqCHash();
260 }
261 }
262 if (!empty($this->frontendController->config['config']['language'])) {
263 $this->LLkey = $this->frontendController->config['config']['language'];
264 if (empty($this->frontendController->config['config']['language_alt'])) {
265 /** @var $locales Locales */
266 $locales = GeneralUtility::makeInstance(Locales::class);
267 if (in_array($this->LLkey, $locales->getLocales())) {
268 $this->altLLkey = '';
269 foreach ($locales->getLocaleDependencies($this->LLkey) as $language) {
270 $this->altLLkey .= $language . ',';
271 }
272 $this->altLLkey = rtrim($this->altLLkey, ',');
273 }
274 } else {
275 $this->altLLkey = $this->frontendController->config['config']['language_alt'];
276 }
277 }
278 }
279
280 /**
281 * Recursively looks for stdWrap and executes it
282 *
283 * @param array $conf Current section of configuration to work on
284 * @param int $level Current level being processed (currently just for tracking; no limit enforced)
285 * @return array Current section of configuration after stdWrap applied
286 */
287 protected function applyStdWrapRecursive(array $conf, $level = 0)
288 {
289 foreach ($conf as $key => $confNextLevel) {
290 if (strpos($key, '.') !== false) {
291 $key = substr($key, 0, -1);
292
293 // descend into all non-stdWrap-subelements first
294 foreach ($confNextLevel as $subKey => $subConfNextLevel) {
295 if (is_array($subConfNextLevel) && strpos($subKey, '.') !== false && $subKey !== 'stdWrap.') {
296 $conf[$key . '.'] = $this->applyStdWrapRecursive($confNextLevel, $level + 1);
297 }
298 }
299
300 // now for stdWrap
301 foreach ($confNextLevel as $subKey => $subConfNextLevel) {
302 if (is_array($subConfNextLevel) && $subKey === 'stdWrap.') {
303 $conf[$key] = $this->cObj->stdWrap($conf[$key], $conf[$key . '.']['stdWrap.']);
304 unset($conf[$key . '.']['stdWrap.']);
305 if (empty($conf[$key . '.'])) {
306 unset($conf[$key . '.']);
307 }
308 }
309 }
310 }
311 }
312 return $conf;
313 }
314
315 /**
316 * If internal TypoScript property "_DEFAULT_PI_VARS." is set then it will merge the current $this->piVars array onto these default values.
317 */
318 public function pi_setPiVarDefaults()
319 {
320 if (isset($this->conf['_DEFAULT_PI_VARS.']) && is_array($this->conf['_DEFAULT_PI_VARS.'])) {
321 $this->conf['_DEFAULT_PI_VARS.'] = $this->applyStdWrapRecursive($this->conf['_DEFAULT_PI_VARS.']);
322 $tmp = $this->conf['_DEFAULT_PI_VARS.'];
323 ArrayUtility::mergeRecursiveWithOverrule($tmp, is_array($this->piVars) ? $this->piVars : []);
324 $this->piVars = $tmp;
325 }
326 }
327
328 /***************************
329 *
330 * Link functions
331 *
332 **************************/
333 /**
334 * Get URL to some page.
335 * Returns the URL to page $id with $target and an array of additional url-parameters, $urlParameters
336 * Simple example: $this->pi_getPageLink(123) to get the URL for page-id 123.
337 *
338 * The function basically calls $this->cObj->getTypoLink_URL()
339 *
340 * @param int $id Page id
341 * @param string $target Target value to use. Affects the &type-value of the URL, defaults to current.
342 * @param array|string $urlParameters As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
343 * @return string The resulting URL
344 * @see pi_linkToPage()
345 * @see ContentObjectRenderer->getTypoLink()
346 */
347 public function pi_getPageLink($id, $target = '', $urlParameters = [])
348 {
349 return $this->cObj->getTypoLink_URL($id, $urlParameters, $target);
350 }
351
352 /**
353 * Link a string to some page.
354 * Like pi_getPageLink() but takes a string as first parameter which will in turn be wrapped with the URL including target attribute
355 * Simple example: $this->pi_linkToPage('My link', 123) to get something like <a href="index.php?id=123&type=1">My link</a>
356 *
357 * @param string $str The content string to wrap in <a> tags
358 * @param int $id Page id
359 * @param string $target Target value to use. Affects the &type-value of the URL, defaults to current.
360 * @param array|string $urlParameters As an array key/value pairs represent URL parameters to set. Values NOT URL-encoded yet, keys should be URL-encoded if needed. As a string the parameter is expected to be URL-encoded already.
361 * @return string The input string wrapped in <a> tags with the URL and target set.
362 * @see pi_getPageLink(), ContentObjectRenderer::getTypoLink()
363 */
364 public function pi_linkToPage($str, $id, $target = '', $urlParameters = [])
365 {
366 return $this->cObj->getTypoLink($str, $id, $urlParameters, $target);
367 }
368
369 /**
370 * Link string to the current page.
371 * Returns the $str wrapped in <a>-tags with a link to the CURRENT page, but with $urlParameters set as extra parameters for the page.
372 *
373 * @param string $str The content string to wrap in <a> tags
374 * @param array $urlParameters Array with URL parameters as key/value pairs. They will be "imploded" and added to the list of parameters defined in the plugins TypoScript property "parent.addParams" plus $this->pi_moreParams.
375 * @param bool $cache If $cache is set (0/1), the page is asked to be cached by a &cHash value (unless the current plugin using this class is a USER_INT). Otherwise the no_cache-parameter will be a part of the link.
376 * @param int $altPageId Alternative page ID for the link. (By default this function links to the SAME page!)
377 * @return string The input string wrapped in <a> tags
378 * @see pi_linkTP_keepPIvars(), ContentObjectRenderer::typoLink()
379 */
380 public function pi_linkTP($str, $urlParameters = [], $cache = false, $altPageId = 0)
381 {
382 $conf = [];
383 $conf['useCacheHash'] = $this->pi_USER_INT_obj ? 0 : $cache;
384 $conf['no_cache'] = $this->pi_USER_INT_obj ? 0 : !$cache;
385 $conf['parameter'] = $altPageId ? $altPageId : ($this->pi_tmpPageId ? $this->pi_tmpPageId : $this->frontendController->id);
386 $conf['additionalParams'] = $this->conf['parent.']['addParams'] . GeneralUtility::implodeArrayForUrl('', $urlParameters, '', true) . $this->pi_moreParams;
387 return $this->cObj->typoLink($str, $conf);
388 }
389
390 /**
391 * Link a string to the current page while keeping currently set values in piVars.
392 * Like pi_linkTP, but $urlParameters is by default set to $this->piVars with $overrulePIvars overlaid.
393 * This means any current entries from this->piVars are passed on (except the key "DATA" which will be unset before!) and entries in $overrulePIvars will OVERRULE the current in the link.
394 *
395 * @param string $str The content string to wrap in <a> tags
396 * @param array $overrulePIvars Array of values to override in the current piVars. Contrary to pi_linkTP the keys in this array must correspond to the real piVars array and therefore NOT be prefixed with the $this->prefixId string. Further, if a value is a blank string it means the piVar key will not be a part of the link (unset)
397 * @param bool $cache If $cache is set, the page is asked to be cached by a &cHash value (unless the current plugin using this class is a USER_INT). Otherwise the no_cache-parameter will be a part of the link.
398 * @param bool $clearAnyway If set, then the current values of piVars will NOT be preserved anyways... Practical if you want an easy way to set piVars without having to worry about the prefix, "tx_xxxxx[]
399 * @param int $altPageId Alternative page ID for the link. (By default this function links to the SAME page!)
400 * @return string The input string wrapped in <a> tags
401 * @see pi_linkTP()
402 */
403 public function pi_linkTP_keepPIvars($str, $overrulePIvars = [], $cache = false, $clearAnyway = false, $altPageId = 0)
404 {
405 if (is_array($this->piVars) && is_array($overrulePIvars) && !$clearAnyway) {
406 $piVars = $this->piVars;
407 unset($piVars['DATA']);
408 ArrayUtility::mergeRecursiveWithOverrule($piVars, $overrulePIvars);
409 $overrulePIvars = $piVars;
410 if ($this->pi_autoCacheEn) {
411 $cache = $this->pi_autoCache($overrulePIvars);
412 }
413 }
414 return $this->pi_linkTP($str, [$this->prefixId => $overrulePIvars], $cache, $altPageId);
415 }
416
417 /**
418 * Get URL to the current page while keeping currently set values in piVars.
419 * Same as pi_linkTP_keepPIvars but returns only the URL from the link.
420 *
421 * @param array $overrulePIvars See pi_linkTP_keepPIvars
422 * @param bool $cache See pi_linkTP_keepPIvars
423 * @param bool $clearAnyway See pi_linkTP_keepPIvars
424 * @param int $altPageId See pi_linkTP_keepPIvars
425 * @return string The URL ($this->cObj->lastTypoLinkUrl)
426 * @see pi_linkTP_keepPIvars()
427 */
428 public function pi_linkTP_keepPIvars_url($overrulePIvars = [], $cache = false, $clearAnyway = false, $altPageId = 0)
429 {
430 $this->pi_linkTP_keepPIvars('|', $overrulePIvars, $cache, $clearAnyway, $altPageId);
431 return $this->cObj->lastTypoLinkUrl;
432 }
433
434 /**
435 * Wraps the $str in a link to a single display of the record (using piVars[showUid])
436 * Uses pi_linkTP for the linking
437 *
438 * @param string $str The content string to wrap in <a> tags
439 * @param int $uid UID of the record for which to display details (basically this will become the value of [showUid]
440 * @param bool $cache See pi_linkTP_keepPIvars
441 * @param array $mergeArr Array of values to override in the current piVars. Same as $overrulePIvars in pi_linkTP_keepPIvars
442 * @param bool $urlOnly If TRUE, only the URL is returned, not a full link
443 * @param int $altPageId Alternative page ID for the link. (By default this function links to the SAME page!)
444 * @return string The input string wrapped in <a> tags
445 * @see pi_linkTP(), pi_linkTP_keepPIvars()
446 */
447 public function pi_list_linkSingle($str, $uid, $cache = false, $mergeArr = [], $urlOnly = false, $altPageId = 0)
448 {
449 if ($this->prefixId) {
450 if ($cache) {
451 $overrulePIvars = $uid ? ['showUid' => $uid] : [];
452 $overrulePIvars = array_merge($overrulePIvars, (array)$mergeArr);
453 $str = $this->pi_linkTP($str, [$this->prefixId => $overrulePIvars], $cache, $altPageId);
454 } else {
455 $overrulePIvars = ['showUid' => $uid ?: ''];
456 $overrulePIvars = array_merge($overrulePIvars, (array)$mergeArr);
457 $str = $this->pi_linkTP_keepPIvars($str, $overrulePIvars, $cache, 0, $altPageId);
458 }
459 // If urlOnly flag, return only URL as it has recently be generated.
460 if ($urlOnly) {
461 $str = $this->cObj->lastTypoLinkUrl;
462 }
463 }
464 return $str;
465 }
466
467 /**
468 * Will change the href value from <a> in the input string and turn it into an onclick event that will open a new window with the URL
469 *
470 * @param string $str The string to process. This should be a string already wrapped/including a <a> tag which will be modified to contain an onclick handler. Only the attributes "href" and "onclick" will be left.
471 * @param string $winName Window name for the pop-up window
472 * @param string $winParams Window parameters, see the default list for inspiration
473 * @return string The processed input string, modified IF a <a> tag was found
474 */
475 public function pi_openAtagHrefInJSwindow($str, $winName = '', $winParams = 'width=670,height=500,status=0,menubar=0,scrollbars=1,resizable=1')
476 {
477 if (preg_match('/(.*)(<a[^>]*>)(.*)/i', $str, $match)) {
478 $aTagContent = GeneralUtility::get_tag_attributes($match[2]);
479 $onClick = 'vHWin=window.open('
480 . GeneralUtility::quoteJSvalue($this->frontendController->baseUrlWrap($aTagContent['href'])) . ','
481 . GeneralUtility::quoteJSvalue($winName ?: md5($aTagContent['href'])) . ','
482 . GeneralUtility::quoteJSvalue($winParams) . ');vHWin.focus();return false;';
483 $match[2] = '<a href="#" onclick="' . htmlspecialchars($onClick) . '">';
484 $str = $match[1] . $match[2] . $match[3];
485 }
486 return $str;
487 }
488
489 /***************************
490 *
491 * Functions for listing, browsing, searching etc.
492 *
493 **************************/
494 /**
495 * Returns a results browser. This means a bar of page numbers plus a "previous" and "next" link. For each entry in the bar the piVars "pointer" will be pointing to the "result page" to show.
496 * Using $this->piVars['pointer'] as pointer to the page to display. Can be overwritten with another string ($pointerName) to make it possible to have more than one pagebrowser on a page)
497 * Using $this->internal['res_count'], $this->internal['results_at_a_time'] and $this->internal['maxPages'] for count number, how many results to show and the max number of pages to include in the browse bar.
498 * Using $this->internal['dontLinkActivePage'] as switch if the active (current) page should be displayed as pure text or as a link to itself
499 * Using $this->internal['showFirstLast'] as switch if the two links named "<< First" and "LAST >>" will be shown and point to the first or last page.
500 * Using $this->internal['pagefloat']: this defines were the current page is shown in the list of pages in the Pagebrowser. If this var is an integer it will be interpreted as position in the list of pages. If its value is the keyword "center" the current page will be shown in the middle of the pagelist.
501 * Using $this->internal['showRange']: this var switches the display of the pagelinks from pagenumbers to ranges f.e.: 1-5 6-10 11-15... instead of 1 2 3...
502 * Using $this->pi_isOnlyFields: this holds a comma-separated list of fieldnames which - if they are among the GETvars - will not disable caching for the page with pagebrowser.
503 *
504 * The third parameter is an array with several wraps for the parts of the pagebrowser. The following elements will be recognized:
505 * disabledLinkWrap, inactiveLinkWrap, activeLinkWrap, browseLinksWrap, showResultsWrap, showResultsNumbersWrap, browseBoxWrap.
506 *
507 * If $wrapArr['showResultsNumbersWrap'] is set, the formatting string is expected to hold template markers (###FROM###, ###TO###, ###OUT_OF###, ###FROM_TO###, ###CURRENT_PAGE###, ###TOTAL_PAGES###)
508 * otherwise the formatting string is expected to hold sprintf-markers (%s) for from, to, outof (in that sequence)
509 *
510 * @param int $showResultCount Determines how the results of the page browser will be shown. See description below
511 * @param string $tableParams Attributes for the table tag which is wrapped around the table cells containing the browse links
512 * @param array $wrapArr Array with elements to overwrite the default $wrapper-array.
513 * @param string $pointerName varname for the pointer.
514 * @param bool $hscText Enable htmlspecialchars() on language labels
515 * @param bool $forceOutput Forces the output of the page browser if you set this option to "TRUE" (otherwise it's only drawn if enough entries are available)
516 * @return string Output HTML-Table, wrapped in <div>-tags with a class attribute (if $wrapArr is not passed,
517 */
518 public function pi_list_browseresults($showResultCount = 1, $tableParams = '', $wrapArr = [], $pointerName = 'pointer', $hscText = true, $forceOutput = false)
519 {
520 if (isset($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::class]['pi_list_browseresults'])
521 && is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::class]['pi_list_browseresults'])
522 ) {
523 foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS'][self::class]['pi_list_browseresults'] as $classRef) {
524 $hookObj = GeneralUtility::makeInstance($classRef);
525 if (method_exists($hookObj, 'pi_list_browseresults')) {
526 $pageBrowser = $hookObj->pi_list_browseresults($showResultCount, $tableParams, $wrapArr, $pointerName, $hscText, $forceOutput, $this);
527 if (is_string($pageBrowser) && trim($pageBrowser) !== '') {
528 return $pageBrowser;
529 }
530 }
531 }
532 }
533 // example $wrapArr-array how it could be traversed from an extension
534 /* $wrapArr = array(
535 'browseBoxWrap' => '<div class="browseBoxWrap">|</div>',
536 'showResultsWrap' => '<div class="showResultsWrap">|</div>',
537 'browseLinksWrap' => '<div class="browseLinksWrap">|</div>',
538 'showResultsNumbersWrap' => '<span class="showResultsNumbersWrap">|</span>',
539 'disabledLinkWrap' => '<span class="disabledLinkWrap">|</span>',
540 'inactiveLinkWrap' => '<span class="inactiveLinkWrap">|</span>',
541 'activeLinkWrap' => '<span class="activeLinkWrap">|</span>'
542 );*/
543 // Initializing variables:
544 $pointer = (int)$this->piVars[$pointerName];
545 $count = (int)$this->internal['res_count'];
546 $results_at_a_time = MathUtility::forceIntegerInRange($this->internal['results_at_a_time'], 1, 1000);
547 $totalPages = ceil($count / $results_at_a_time);
548 $maxPages = MathUtility::forceIntegerInRange($this->internal['maxPages'], 1, 100);
549 $pi_isOnlyFields = $this->pi_isOnlyFields($this->pi_isOnlyFields);
550 if (!$forceOutput && $count <= $results_at_a_time) {
551 return '';
552 }
553 // $showResultCount determines how the results of the pagerowser will be shown.
554 // If set to 0: only the result-browser will be shown
555 // 1: (default) the text "Displaying results..." and the result-browser will be shown.
556 // 2: only the text "Displaying results..." will be shown
557 $showResultCount = (int)$showResultCount;
558 // If this is set, two links named "<< First" and "LAST >>" will be shown and point to the very first or last page.
559 $showFirstLast = !empty($this->internal['showFirstLast']);
560 // If this has a value the "previous" button is always visible (will be forced if "showFirstLast" is set)
561 $alwaysPrev = $showFirstLast ? 1 : $this->pi_alwaysPrev;
562 if (isset($this->internal['pagefloat'])) {
563 if (strtoupper($this->internal['pagefloat']) === 'CENTER') {
564 $pagefloat = ceil(($maxPages - 1) / 2);
565 } else {
566 // pagefloat set as integer. 0 = left, value >= $this->internal['maxPages'] = right
567 $pagefloat = MathUtility::forceIntegerInRange($this->internal['pagefloat'], -1, $maxPages - 1);
568 }
569 } else {
570 // pagefloat disabled
571 $pagefloat = -1;
572 }
573 // Default values for "traditional" wrapping with a table. Can be overwritten by vars from $wrapArr
574 $wrapper['disabledLinkWrap'] = '<td class="nowrap"><p>|</p></td>';
575 $wrapper['inactiveLinkWrap'] = '<td class="nowrap"><p>|</p></td>';
576 $wrapper['activeLinkWrap'] = '<td' . $this->pi_classParam('browsebox-SCell') . ' class="nowrap"><p>|</p></td>';
577 $wrapper['browseLinksWrap'] = rtrim('<table ' . $tableParams) . '><tr>|</tr></table>';
578 $wrapper['showResultsWrap'] = '<p>|</p>';
579 $wrapper['browseBoxWrap'] = '
580 <!--
581 List browsing box:
582 -->
583 <div ' . $this->pi_classParam('browsebox') . '>
584 |
585 </div>';
586 // Now overwrite all entries in $wrapper which are also in $wrapArr
587 $wrapper = array_merge($wrapper, $wrapArr);
588 // Show pagebrowser
589 if ($showResultCount != 2) {
590 if ($pagefloat > -1) {
591 $lastPage = min($totalPages, max($pointer + 1 + $pagefloat, $maxPages));
592 $firstPage = max(0, $lastPage - $maxPages);
593 } else {
594 $firstPage = 0;
595 $lastPage = MathUtility::forceIntegerInRange($totalPages, 1, $maxPages);
596 }
597 $links = [];
598 // Make browse-table/links:
599 // Link to first page
600 if ($showFirstLast) {
601 if ($pointer > 0) {
602 $label = $this->pi_getLL('pi_list_browseresults_first', '<< First');
603 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($hscText ? htmlspecialchars($label) : $label, [$pointerName => null], $pi_isOnlyFields), $wrapper['inactiveLinkWrap']);
604 } else {
605 $label = $this->pi_getLL('pi_list_browseresults_first', '<< First');
606 $links[] = $this->cObj->wrap($hscText ? htmlspecialchars($label) : $label, $wrapper['disabledLinkWrap']);
607 }
608 }
609 // Link to previous page
610 if ($alwaysPrev >= 0) {
611 if ($pointer > 0) {
612 $label = $this->pi_getLL('pi_list_browseresults_prev', '< Previous');
613 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($hscText ? htmlspecialchars($label) : $label, [$pointerName => ($pointer - 1) ?: ''], $pi_isOnlyFields), $wrapper['inactiveLinkWrap']);
614 } elseif ($alwaysPrev) {
615 $label = $this->pi_getLL('pi_list_browseresults_prev', '< Previous');
616 $links[] = $this->cObj->wrap($hscText ? htmlspecialchars($label) : $label, $wrapper['disabledLinkWrap']);
617 }
618 }
619 // Links to pages
620 for ($a = $firstPage; $a < $lastPage; $a++) {
621 if ($this->internal['showRange']) {
622 $pageText = ($a * $results_at_a_time + 1) . '-' . min($count, ($a + 1) * $results_at_a_time);
623 } else {
624 $label = $this->pi_getLL('pi_list_browseresults_page', 'Page');
625 $pageText = trim(($hscText ? htmlspecialchars($label) : $label) . ' ' . ($a + 1));
626 }
627 // Current page
628 if ($pointer == $a) {
629 if ($this->internal['dontLinkActivePage']) {
630 $links[] = $this->cObj->wrap($pageText, $wrapper['activeLinkWrap']);
631 } else {
632 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($pageText, [$pointerName => $a ?: ''], $pi_isOnlyFields), $wrapper['activeLinkWrap']);
633 }
634 } else {
635 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($pageText, [$pointerName => $a ?: ''], $pi_isOnlyFields), $wrapper['inactiveLinkWrap']);
636 }
637 }
638 if ($pointer < $totalPages - 1 || $showFirstLast) {
639 // Link to next page
640 if ($pointer >= $totalPages - 1) {
641 $label = $this->pi_getLL('pi_list_browseresults_next', 'Next >');
642 $links[] = $this->cObj->wrap($hscText ? htmlspecialchars($label) : $label, $wrapper['disabledLinkWrap']);
643 } else {
644 $label = $this->pi_getLL('pi_list_browseresults_next', 'Next >');
645 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($hscText ? htmlspecialchars($label) : $label, [$pointerName => $pointer + 1], $pi_isOnlyFields), $wrapper['inactiveLinkWrap']);
646 }
647 }
648 // Link to last page
649 if ($showFirstLast) {
650 if ($pointer < $totalPages - 1) {
651 $label = $this->pi_getLL('pi_list_browseresults_last', 'Last >>');
652 $links[] = $this->cObj->wrap($this->pi_linkTP_keepPIvars($hscText ? htmlspecialchars($label) : $label, [$pointerName => $totalPages - 1], $pi_isOnlyFields), $wrapper['inactiveLinkWrap']);
653 } else {
654 $label = $this->pi_getLL('pi_list_browseresults_last', 'Last >>');
655 $links[] = $this->cObj->wrap($hscText ? htmlspecialchars($label) : $label, $wrapper['disabledLinkWrap']);
656 }
657 }
658 $theLinks = $this->cObj->wrap(implode(LF, $links), $wrapper['browseLinksWrap']);
659 } else {
660 $theLinks = '';
661 }
662 $pR1 = $pointer * $results_at_a_time + 1;
663 $pR2 = $pointer * $results_at_a_time + $results_at_a_time;
664 if ($showResultCount) {
665 if ($wrapper['showResultsNumbersWrap']) {
666 // This will render the resultcount in a more flexible way using markers (new in TYPO3 3.8.0).
667 // The formatting string is expected to hold template markers (see function header). Example: 'Displaying results ###FROM### to ###TO### out of ###OUT_OF###'
668 $markerArray['###FROM###'] = $this->cObj->wrap($this->internal['res_count'] > 0 ? $pR1 : 0, $wrapper['showResultsNumbersWrap']);
669 $markerArray['###TO###'] = $this->cObj->wrap(min($this->internal['res_count'], $pR2), $wrapper['showResultsNumbersWrap']);
670 $markerArray['###OUT_OF###'] = $this->cObj->wrap($this->internal['res_count'], $wrapper['showResultsNumbersWrap']);
671 $markerArray['###FROM_TO###'] = $this->cObj->wrap(($this->internal['res_count'] > 0 ? $pR1 : 0) . ' ' . $this->pi_getLL('pi_list_browseresults_to', 'to') . ' ' . min($this->internal['res_count'], $pR2), $wrapper['showResultsNumbersWrap']);
672 $markerArray['###CURRENT_PAGE###'] = $this->cObj->wrap($pointer + 1, $wrapper['showResultsNumbersWrap']);
673 $markerArray['###TOTAL_PAGES###'] = $this->cObj->wrap($totalPages, $wrapper['showResultsNumbersWrap']);
674 // Substitute markers
675 $resultCountMsg = $this->templateService->substituteMarkerArray($this->pi_getLL('pi_list_browseresults_displays', 'Displaying results ###FROM### to ###TO### out of ###OUT_OF###'), $markerArray);
676 } else {
677 // Render the resultcount in the "traditional" way using sprintf
678 $resultCountMsg = sprintf(str_replace('###SPAN_BEGIN###', '<span' . $this->pi_classParam('browsebox-strong') . '>', $this->pi_getLL('pi_list_browseresults_displays', 'Displaying results ###SPAN_BEGIN###%s to %s</span> out of ###SPAN_BEGIN###%s</span>')), $count > 0 ? $pR1 : 0, min($count, $pR2), $count);
679 }
680 $resultCountMsg = $this->cObj->wrap($resultCountMsg, $wrapper['showResultsWrap']);
681 } else {
682 $resultCountMsg = '';
683 }
684 $sTables = $this->cObj->wrap($resultCountMsg . $theLinks, $wrapper['browseBoxWrap']);
685 return $sTables;
686 }
687
688 /**
689 * Returns a mode selector; a little menu in a table normally put in the top of the page/list.
690 *
691 * @param array $items Key/Value pairs for the menu; keys are the piVars[mode] values and the "values" are the labels for them.
692 * @param string $tableParams Attributes for the table tag which is wrapped around the table cells containing the menu
693 * @return string Output HTML, wrapped in <div>-tags with a class attribute
694 */
695 public function pi_list_modeSelector($items = [], $tableParams = '')
696 {
697 $cells = [];
698 foreach ($items as $k => $v) {
699 $cells[] = '
700 <td' . ($this->piVars['mode'] == $k ? $this->pi_classParam('modeSelector-SCell') : '') . '><p>' . $this->pi_linkTP_keepPIvars(htmlspecialchars($v), ['mode' => $k], $this->pi_isOnlyFields($this->pi_isOnlyFields)) . '</p></td>';
701 }
702 $sTables = '
703
704 <!--
705 Mode selector (menu for list):
706 -->
707 <div' . $this->pi_classParam('modeSelector') . '>
708 <' . rtrim('table ' . $tableParams) . '>
709 <tr>
710 ' . implode('', $cells) . '
711 </tr>
712 </table>
713 </div>';
714 return $sTables;
715 }
716
717 /**
718 * Returns the list of items based on the input SQL result pointer
719 * For each result row the internal var, $this->internal['currentRow'], is set with the row returned.
720 * $this->pi_list_header() makes the header row for the list
721 * $this->pi_list_row() is used for rendering each row
722 * Notice that these two functions are typically ALWAYS defined in the extension class of the plugin since they are directly concerned with the specific layout for that plugins purpose.
723 *
724 * @param Statement $statement Result pointer to a SQL result which can be traversed.
725 * @param string $tableParams Attributes for the table tag which is wrapped around the table rows containing the list
726 * @return string Output HTML, wrapped in <div>-tags with a class attribute
727 * @see pi_list_row(), pi_list_header()
728 */
729 public function pi_list_makelist($statement, $tableParams = '')
730 {
731 // Make list table header:
732 $tRows = [];
733 $this->internal['currentRow'] = '';
734 $tRows[] = $this->pi_list_header();
735 // Make list table rows
736 $c = 0;
737 while ($this->internal['currentRow'] = $statement->fetch()) {
738 $tRows[] = $this->pi_list_row($c);
739 $c++;
740 }
741 $out = '
742
743 <!--
744 Record list:
745 -->
746 <div' . $this->pi_classParam('listrow') . '>
747 <' . rtrim('table ' . $tableParams) . '>
748 ' . implode('', $tRows) . '
749 </table>
750 </div>';
751 return $out;
752 }
753
754 /**
755 * Returns a list row. Get data from $this->internal['currentRow'];
756 * (Dummy)
757 * Notice: This function should ALWAYS be defined in the extension class of the plugin since it is directly concerned with the specific layout of the listing for your plugins purpose.
758 *
759 * @param int $c Row counting. Starts at 0 (zero). Used for alternating class values in the output rows.
760 * @return string HTML output, a table row with a class attribute set (alternative based on odd/even rows)
761 */
762 public function pi_list_row($c)
763 {
764 // Dummy
765 return '<tr' . ($c % 2 ? $this->pi_classParam('listrow-odd') : '') . '><td><p>[dummy row]</p></td></tr>';
766 }
767
768 /**
769 * Returns a list header row.
770 * (Dummy)
771 * Notice: This function should ALWAYS be defined in the extension class of the plugin since it is directly concerned with the specific layout of the listing for your plugins purpose.
772 *
773 * @return string HTML output, a table row with a class attribute set
774 */
775 public function pi_list_header()
776 {
777 return '<tr' . $this->pi_classParam('listrow-header') . '><td><p>[dummy header row]</p></td></tr>';
778 }
779
780 /***************************
781 *
782 * Stylesheet, CSS
783 *
784 **************************/
785 /**
786 * Returns a class-name prefixed with $this->prefixId and with all underscores substituted to dashes (-)
787 *
788 * @param string $class The class name (or the END of it since it will be prefixed by $this->prefixId.'-')
789 * @return string The combined class name (with the correct prefix)
790 */
791 public function pi_getClassName($class)
792 {
793 return str_replace('_', '-', $this->prefixId) . ($this->prefixId ? '-' : '') . $class;
794 }
795
796 /**
797 * Returns the class-attribute with the correctly prefixed classname
798 * Using pi_getClassName()
799 *
800 * @param string $class The class name(s) (suffix) - separate multiple classes with commas
801 * @param string $addClasses Additional class names which should not be prefixed - separate multiple classes with commas
802 * @return string A "class" attribute with value and a single space char before it.
803 * @see pi_getClassName()
804 */
805 public function pi_classParam($class, $addClasses = '')
806 {
807 $output = '';
808 $classNames = GeneralUtility::trimExplode(',', $class);
809 foreach ($classNames as $className) {
810 $output .= ' ' . $this->pi_getClassName($className);
811 }
812 $additionalClassNames = GeneralUtility::trimExplode(',', $addClasses);
813 foreach ($additionalClassNames as $additionalClassName) {
814 $output .= ' ' . $additionalClassName;
815 }
816 return ' class="' . trim($output) . '"';
817 }
818
819 /**
820 * Wraps the input string in a <div> tag with the class attribute set to the prefixId.
821 * All content returned from your plugins should be returned through this function so all content from your plugin is encapsulated in a <div>-tag nicely identifying the content of your plugin.
822 *
823 * @param string $str HTML content to wrap in the div-tags with the "main class" of the plugin
824 * @return string HTML content wrapped, ready to return to the parent object.
825 */
826 public function pi_wrapInBaseClass($str)
827 {
828 $content = '<div class="' . str_replace('_', '-', $this->prefixId) . '">
829 ' . $str . '
830 </div>
831 ';
832 if (!$this->frontendController->config['config']['disablePrefixComment']) {
833 $content = '
834
835
836 <!--
837
838 BEGIN: Content of extension "' . $this->extKey . '", plugin "' . $this->prefixId . '"
839
840 -->
841 ' . $content . '
842 <!-- END: Content of extension "' . $this->extKey . '", plugin "' . $this->prefixId . '" -->
843
844 ';
845 }
846 return $content;
847 }
848
849 /***************************
850 *
851 * Frontend editing: Edit panel, edit icons
852 *
853 **************************/
854 /**
855 * Returns the Backend User edit panel for the $row from $tablename
856 *
857 * @param array $row Record array.
858 * @param string $tablename Table name
859 * @param string $label A label to show with the panel.
860 * @param array $conf TypoScript parameters to pass along to the EDITPANEL content Object that gets rendered. The property "allow" WILL get overridden/set though.
861 * @return string Returns FALSE/blank if no BE User login and of course if the panel is not shown for other reasons. Otherwise the HTML for the panel (a table).
862 * @see ContentObjectRenderer::EDITPANEL()
863 */
864 public function pi_getEditPanel($row = [], $tablename = '', $label = '', $conf = [])
865 {
866 $panel = '';
867 if (!$row || !$tablename) {
868 $row = $this->internal['currentRow'];
869 $tablename = $this->internal['currentTable'];
870 }
871 if ($this->frontendController->beUserLogin) {
872 // Create local cObj if not set:
873 if (!is_object($this->pi_EPtemp_cObj)) {
874 $this->pi_EPtemp_cObj = GeneralUtility::makeInstance(ContentObjectRenderer::class);
875 $this->pi_EPtemp_cObj->setParent($this->cObj->data, $this->cObj->currentRecord);
876 }
877 // Initialize the cObj object with current row
878 $this->pi_EPtemp_cObj->start($row, $tablename);
879 // Setting TypoScript values in the $conf array. See documentation in TSref for the EDITPANEL cObject.
880 $conf['allow'] = 'edit,new,delete,move,hide';
881 $panel = $this->pi_EPtemp_cObj->cObjGetSingle('EDITPANEL', $conf, 'editpanel');
882 }
883 if ($panel) {
884 if ($label) {
885 return '<!-- BEGIN: EDIT PANEL --><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td valign="top">' . $label . '</td><td valign="top" align="right">' . $panel . '</td></tr></table><!-- END: EDIT PANEL -->';
886 }
887 return '<!-- BEGIN: EDIT PANEL -->' . $panel . '<!-- END: EDIT PANEL -->';
888 }
889 return $label;
890 }
891
892 /**
893 * Adds edit-icons to the input content.
894 * ContentObjectRenderer::editIcons used for rendering
895 *
896 * @param string $content HTML content to add icons to. The icons will be put right after the last content part in the string (that means before the ending series of HTML tags)
897 * @param string $fields The list of fields to edit when the icon is clicked.
898 * @param string $title Title for the edit icon.
899 * @param array $row Table record row
900 * @param string $tablename Table name
901 * @param array $oConf Conf array
902 * @return string The processed content
903 * @see ContentObjectRenderer::editIcons()
904 */
905 public function pi_getEditIcon($content, $fields, $title = '', $row = [], $tablename = '', $oConf = [])
906 {
907 if ($this->frontendController->beUserLogin) {
908 if (!$row || !$tablename) {
909 $row = $this->internal['currentRow'];
910 $tablename = $this->internal['currentTable'];
911 }
912 $conf = array_merge([
913 'beforeLastTag' => 1,
914 'iconTitle' => $title
915 ], $oConf);
916 $content = $this->cObj->editIcons($content, $tablename . ':' . $fields, $conf, $tablename . ':' . $row['uid'], $row, '&viewUrl=' . rawurlencode(GeneralUtility::getIndpEnv('REQUEST_URI')));
917 }
918 return $content;
919 }
920
921 /***************************
922 *
923 * Localization, locallang functions
924 *
925 **************************/
926 /**
927 * Returns the localized label of the LOCAL_LANG key, $key
928 * Notice that for debugging purposes prefixes for the output values can be set with the internal vars ->LLtestPrefixAlt and ->LLtestPrefix
929 *
930 * @param string $key The key from the LOCAL_LANG array for which to return the value.
931 * @param string $alternativeLabel Alternative string to return IF no value is found set for the key, neither for the local language nor the default.
932 * @return string The value from LOCAL_LANG.
933 */
934 public function pi_getLL($key, $alternativeLabel = '')
935 {
936 $word = null;
937 if (!empty($this->LOCAL_LANG[$this->LLkey][$key][0]['target'])
938 || isset($this->LOCAL_LANG_UNSET[$this->LLkey][$key])
939 ) {
940 $word = $this->LOCAL_LANG[$this->LLkey][$key][0]['target'];
941 } elseif ($this->altLLkey) {
942 $alternativeLanguageKeys = GeneralUtility::trimExplode(',', $this->altLLkey, true);
943 $alternativeLanguageKeys = array_reverse($alternativeLanguageKeys);
944 foreach ($alternativeLanguageKeys as $languageKey) {
945 if (!empty($this->LOCAL_LANG[$languageKey][$key][0]['target'])
946 || isset($this->LOCAL_LANG_UNSET[$languageKey][$key])
947 ) {
948 // Alternative language translation for key exists
949 $word = $this->LOCAL_LANG[$languageKey][$key][0]['target'];
950 break;
951 }
952 }
953 }
954 if ($word === null) {
955 if (!empty($this->LOCAL_LANG['default'][$key][0]['target'])
956 || isset($this->LOCAL_LANG_UNSET['default'][$key])
957 ) {
958 // Get default translation (without charset conversion, english)
959 $word = $this->LOCAL_LANG['default'][$key][0]['target'];
960 } else {
961 // Return alternative string or empty
962 $word = isset($this->LLtestPrefixAlt) ? $this->LLtestPrefixAlt . $alternativeLabel : $alternativeLabel;
963 }
964 }
965 return isset($this->LLtestPrefix) ? $this->LLtestPrefix . $word : $word;
966 }
967
968 /**
969 * Loads local-language values from the file passed as a parameter or
970 * by looking for a "locallang" file in the
971 * plugin class directory ($this->scriptRelPath).
972 * Also locallang values set in the TypoScript property "_LOCAL_LANG" are
973 * merged onto the values found in the "locallang" file.
974 * Supported file extensions xlf, xml
975 *
976 * @param string $languageFilePath path to the plugin language file in format EXT:....
977 */
978 public function pi_loadLL($languageFilePath = '')
979 {
980 if ($this->LOCAL_LANG_loaded) {
981 return;
982 }
983
984 if ($languageFilePath === '' && $this->scriptRelPath) {
985 $languageFilePath = 'EXT:' . $this->extKey . '/' . dirname($this->scriptRelPath) . '/locallang.xlf';
986 }
987 if ($languageFilePath !== '') {
988 /** @var $languageFactory LocalizationFactory */
989 $languageFactory = GeneralUtility::makeInstance(LocalizationFactory::class);
990 $this->LOCAL_LANG = $languageFactory->getParsedData($languageFilePath, $this->LLkey);
991 $alternativeLanguageKeys = GeneralUtility::trimExplode(',', $this->altLLkey, true);
992 foreach ($alternativeLanguageKeys as $languageKey) {
993 $tempLL = $languageFactory->getParsedData($languageFilePath, $languageKey);
994 if ($this->LLkey !== 'default' && isset($tempLL[$languageKey])) {
995 $this->LOCAL_LANG[$languageKey] = $tempLL[$languageKey];
996 }
997 }
998 // Overlaying labels from TypoScript (including fictitious language keys for non-system languages!):
999 if (isset($this->conf['_LOCAL_LANG.'])) {
1000 // Clear the "unset memory"
1001 $this->LOCAL_LANG_UNSET = [];
1002 foreach ($this->conf['_LOCAL_LANG.'] as $languageKey => $languageArray) {
1003 // Remove the dot after the language key
1004 $languageKey = substr($languageKey, 0, -1);
1005 // Don't process label if the language is not loaded
1006 if (is_array($languageArray) && isset($this->LOCAL_LANG[$languageKey])) {
1007 foreach ($languageArray as $labelKey => $labelValue) {
1008 if (!is_array($labelValue)) {
1009 $this->LOCAL_LANG[$languageKey][$labelKey][0]['target'] = $labelValue;
1010 if ($labelValue === '') {
1011 $this->LOCAL_LANG_UNSET[$languageKey][$labelKey] = '';
1012 }
1013 }
1014 }
1015 }
1016 }
1017 }
1018 }
1019 $this->LOCAL_LANG_loaded = true;
1020 }
1021
1022 /***************************
1023 *
1024 * Database, queries
1025 *
1026 **************************/
1027 /**
1028 * Executes a standard SELECT query for listing of records based on standard input vars from the 'browser' ($this->internal['results_at_a_time'] and $this->piVars['pointer']) and 'searchbox' ($this->piVars['sword'] and $this->internal['searchFieldList'])
1029 * Set $count to 1 if you wish to get a count(*) query for selecting the number of results.
1030 * Notice that the query will use $this->conf['pidList'] and $this->conf['recursive'] to generate a PID list within which to search for records.
1031 *
1032 * @param string $table The table name to make the query for.
1033 * @param bool $count If set, you will get a "count(*)" query back instead of field selecting
1034 * @param string $addWhere Additional WHERE clauses (should be starting with " AND ....")
1035 * @param mixed $mm_cat If an array, then it must contain the keys "table", "mmtable" and (optionally) "catUidList" defining a table to make a MM-relation to in the query (based on fields uid_local and uid_foreign). If not array, the query will be a plain query looking up data in only one table.
1036 * @param string $groupBy If set, this is added as a " GROUP BY ...." part of the query.
1037 * @param string $orderBy If set, this is added as a " ORDER BY ...." part of the query. The default is that an ORDER BY clause is made based on $this->internal['orderBy'] and $this->internal['descFlag'] where the orderBy field must be found in $this->internal['orderByList']
1038 * @param string $query If set, this is taken as the first part of the query instead of what is created internally. Basically this should be a query starting with "FROM [table] WHERE ... AND ...". The $addWhere clauses and all the other stuff is still added. Only the tables and PID selecting clauses are bypassed. May be deprecated in the future!
1039 * @return Statement
1040 */
1041 public function pi_exec_query($table, $count = false, $addWhere = '', $mm_cat = '', $groupBy = '', $orderBy = '', $query = '')
1042 {
1043 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
1044 $queryBuilder->from($table);
1045
1046 // Begin Query:
1047 if (!$query) {
1048 // This adds WHERE-clauses that ensures deleted, hidden, starttime/endtime/access records are NOT
1049 // selected, if they should not! Almost ALWAYS add this to your queries!
1050 $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
1051
1052 // Fetches the list of PIDs to select from.
1053 // TypoScript property .pidList is a comma list of pids. If blank, current page id is used.
1054 // TypoScript property .recursive is an int+ which determines how many levels down from the pids in the pid-list subpages should be included in the select.
1055 $pidList = GeneralUtility::intExplode(',', $this->pi_getPidList($this->conf['pidList'], $this->conf['recursive']), true);
1056 if (is_array($mm_cat)) {
1057 $queryBuilder->from($mm_cat['table'])
1058 ->from($mm_cat['mmtable'])
1059 ->where(
1060 $queryBuilder->expr()->eq($table . '.uid', $queryBuilder->quoteIdentifier($mm_cat['mmtable'] . '.uid_local')),
1061 $queryBuilder->expr()->eq($mm_cat['table'] . '.uid', $queryBuilder->quoteIdentifier($mm_cat['mmtable'] . '.uid_foreign')),
1062 $queryBuilder->expr()->in(
1063 $table . '.pid',
1064 $queryBuilder->createNamedParameter($pidList, Connection::PARAM_INT_ARRAY)
1065 )
1066 );
1067 if (strcmp($mm_cat['catUidList'], '')) {
1068 $queryBuilder->andWhere(
1069 $queryBuilder->expr()->in(
1070 $mm_cat['table'] . '.uid',
1071 $queryBuilder->createNamedParameter(
1072 GeneralUtility::intExplode(',', $mm_cat['catUidList'], true),
1073 Connection::PARAM_INT_ARRAY
1074 )
1075 )
1076 );
1077 }
1078 } else {
1079 $queryBuilder->where(
1080 $queryBuilder->expr()->in(
1081 'pid',
1082 $queryBuilder->createNamedParameter($pidList, Connection::PARAM_INT_ARRAY)
1083 )
1084 );
1085 }
1086 } else {
1087 // Restrictions need to be handled by the $query parameter!
1088 $queryBuilder->getRestrictions()->removeAll();
1089
1090 // Split the "FROM ... WHERE" string so we get the WHERE part and TABLE names separated...:
1091 list($tableListFragment, $whereFragment) = preg_split('/WHERE/i', trim($query), 2);
1092 foreach (QueryHelper::parseTableList($tableListFragment) as $tableNameAndAlias) {
1093 list($tableName, $tableAlias) = $tableNameAndAlias;
1094 $queryBuilder->from($tableName, $tableAlias);
1095 }
1096 $queryBuilder->where(QueryHelper::stripLogicalOperatorPrefix($whereFragment));
1097 }
1098
1099 // Add '$addWhere'
1100 if ($addWhere) {
1101 $queryBuilder->andWhere(QueryHelper::stripLogicalOperatorPrefix($addWhere));
1102 }
1103 // Search word:
1104 if ($this->piVars['sword'] && $this->internal['searchFieldList']) {
1105 $queryBuilder->andWhere(
1106 QueryHelper::stripLogicalOperatorPrefix(
1107 $this->cObj->searchWhere($this->piVars['sword'], $this->internal['searchFieldList'], $table)
1108 )
1109 );
1110 }
1111
1112 if ($count) {
1113 $queryBuilder->count('*');
1114 } else {
1115 // Add 'SELECT'
1116 $fields = $this->pi_prependFieldsWithTable($table, $this->pi_listFields);
1117 $queryBuilder->select(...GeneralUtility::trimExplode(',', $fields, true));
1118
1119 // Order by data:
1120 if (!$orderBy && $this->internal['orderBy']) {
1121 if (GeneralUtility::inList($this->internal['orderByList'], $this->internal['orderBy'])) {
1122 $sorting = $this->internal['descFlag'] ? ' DESC' : 'ASC';
1123 $queryBuilder->orderBy($table . '.' . $this->internal['orderBy'], $sorting);
1124 }
1125 } elseif ($orderBy) {
1126 foreach (QueryHelper::parseOrderBy($orderBy) as $fieldNameAndSorting) {
1127 list($fieldName, $sorting) = $fieldNameAndSorting;
1128 $queryBuilder->addOrderBy($fieldName, $sorting);
1129 }
1130 }
1131
1132 // Limit data:
1133 $pointer = (int)$this->piVars['pointer'];
1134 $results_at_a_time = MathUtility::forceIntegerInRange($this->internal['results_at_a_time'], 1, 1000);
1135 $queryBuilder->setFirstResult($pointer * $results_at_a_time)
1136 ->setMaxResults($results_at_a_time);
1137
1138 // Grouping
1139 if (!empty($groupBy)) {
1140 $queryBuilder->groupBy(...QueryHelper::parseGroupBy($groupBy));
1141 }
1142 }
1143
1144 return $queryBuilder->execute();
1145 }
1146
1147 /**
1148 * Returns the row $uid from $table
1149 * (Simply calling $this->frontendEngine->sys_page->checkRecord())
1150 *
1151 * @param string $table The table name
1152 * @param int $uid The uid of the record from the table
1153 * @param bool $checkPage If $checkPage is set, it's required that the page on which the record resides is accessible
1154 * @return array If record is found, an array. Otherwise FALSE.
1155 */
1156 public function pi_getRecord($table, $uid, $checkPage = false)
1157 {
1158 return $this->frontendController->sys_page->checkRecord($table, $uid, $checkPage);
1159 }
1160
1161 /**
1162 * Returns a commalist of page ids for a query (eg. 'WHERE pid IN (...)')
1163 *
1164 * @param string $pid_list A comma list of page ids (if empty current page is used)
1165 * @param int $recursive An integer >=0 telling how deep to dig for pids under each entry in $pid_list
1166 * @return string List of PID values (comma separated)
1167 */
1168 public function pi_getPidList($pid_list, $recursive = 0)
1169 {
1170 if (!strcmp($pid_list, '')) {
1171 $pid_list = $this->frontendController->id;
1172 }
1173 $recursive = MathUtility::forceIntegerInRange($recursive, 0);
1174 $pid_list_arr = array_unique(GeneralUtility::trimExplode(',', $pid_list, true));
1175 $pid_list = [];
1176 foreach ($pid_list_arr as $val) {
1177 $val = MathUtility::forceIntegerInRange($val, 0);
1178 if ($val) {
1179 $_list = $this->cObj->getTreeList(-1 * $val, $recursive);
1180 if ($_list) {
1181 $pid_list[] = $_list;
1182 }
1183 }
1184 }
1185 return implode(',', $pid_list);
1186 }
1187
1188 /**
1189 * Having a comma list of fields ($fieldList) this is prepended with the $table.'.' name
1190 *
1191 * @param string $table Table name to prepend
1192 * @param string $fieldList List of fields where each element will be prepended with the table name given.
1193 * @return string List of fields processed.
1194 */
1195 public function pi_prependFieldsWithTable($table, $fieldList)
1196 {
1197 $list = GeneralUtility::trimExplode(',', $fieldList, true);
1198 $return = [];
1199 foreach ($list as $listItem) {
1200 $return[] = $table . '.' . $listItem;
1201 }
1202 return implode(',', $return);
1203 }
1204
1205 /**
1206 * Will select all records from the "category table", $table, and return them in an array.
1207 *
1208 * @param string $table The name of the category table to select from.
1209 * @param int $pid The page from where to select the category records.
1210 * @param string $whereClause Optional additional WHERE clauses put in the end of the query. DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
1211 * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
1212 * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
1213 * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
1214 * @return array The array with the category records in.
1215 */
1216 public function pi_getCategoryTableContents($table, $pid, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '')
1217 {
1218 $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable($table);
1219 $queryBuilder->setRestrictions(GeneralUtility::makeInstance(FrontendRestrictionContainer::class));
1220 $queryBuilder->select('*')
1221 ->from($table)
1222 ->where(
1223 $queryBuilder->expr()->eq(
1224 'pid',
1225 $queryBuilder->createNamedParameter($pid, \PDO::PARAM_INT)
1226 ),
1227 QueryHelper::stripLogicalOperatorPrefix($whereClause)
1228 );
1229
1230 if (!empty($orderBy)) {
1231 foreach (QueryHelper::parseOrderBy($orderBy) as $fieldNameAndSorting) {
1232 list($fieldName, $sorting) = $fieldNameAndSorting;
1233 $queryBuilder->addOrderBy($fieldName, $sorting);
1234 }
1235 }
1236
1237 if (!empty($groupBy)) {
1238 $queryBuilder->groupBy(...QueryHelper::parseGroupBy($groupBy));
1239 }
1240
1241 if (!empty($limit)) {
1242 $limitValues = GeneralUtility::intExplode(',', $limit, true);
1243 if (count($limitValues) === 1) {
1244 $queryBuilder->setMaxResults($limitValues[0]);
1245 } else {
1246 $queryBuilder->setFirstResult($limitValues[0])
1247 ->setMaxResults($limitValues[1]);
1248 }
1249 }
1250
1251 $result = $queryBuilder->execute();
1252 $outArr = [];
1253 while ($row = $result->fetch()) {
1254 $outArr[$row['uid']] = $row;
1255 }
1256 return $outArr;
1257 }
1258
1259 /***************************
1260 *
1261 * Various
1262 *
1263 **************************/
1264 /**
1265 * Returns TRUE if the piVars array has ONLY those fields entered that is set in the $fList (commalist) AND if none of those fields value is greater than $lowerThan field if they are integers.
1266 * Notice that this function will only work as long as values are integers.
1267 *
1268 * @param string $fList List of fields (keys from piVars) to evaluate on
1269 * @param int $lowerThan Limit for the values.
1270 * @return bool|NULL Returns TRUE (1) if conditions are met.
1271 */
1272 public function pi_isOnlyFields($fList, $lowerThan = -1)
1273 {
1274 $lowerThan = $lowerThan == -1 ? $this->pi_lowerThan : $lowerThan;
1275 $fList = GeneralUtility::trimExplode(',', $fList, true);
1276 $tempPiVars = $this->piVars;
1277 foreach ($fList as $k) {
1278 if (!MathUtility::canBeInterpretedAsInteger($tempPiVars[$k]) || $tempPiVars[$k] < $lowerThan) {
1279 unset($tempPiVars[$k]);
1280 }
1281 }
1282 if (empty($tempPiVars)) {
1283 //@TODO: How do we deal with this? return TRUE would be the right thing to do here but that might be breaking
1284 return 1;
1285 }
1286 return null;
1287 }
1288
1289 /**
1290 * Returns TRUE if the array $inArray contains only values allowed to be cached based on the configuration in $this->pi_autoCacheFields
1291 * Used by ->pi_linkTP_keepPIvars
1292 * This is an advanced form of evaluation of whether a URL should be cached or not.
1293 *
1294 * @param array $inArray An array with piVars values to evaluate
1295 * @return bool|NULL Returns TRUE (1) if conditions are met.
1296 * @see pi_linkTP_keepPIvars()
1297 */
1298 public function pi_autoCache($inArray)
1299 {
1300 if (is_array($inArray)) {
1301 foreach ($inArray as $fN => $fV) {
1302 if (!strcmp($inArray[$fN], '')) {
1303 unset($inArray[$fN]);
1304 } elseif (is_array($this->pi_autoCacheFields[$fN])) {
1305 if (is_array($this->pi_autoCacheFields[$fN]['range']) && (int)$inArray[$fN] >= (int)$this->pi_autoCacheFields[$fN]['range'][0] && (int)$inArray[$fN] <= (int)$this->pi_autoCacheFields[$fN]['range'][1]) {
1306 unset($inArray[$fN]);
1307 }
1308 if (is_array($this->pi_autoCacheFields[$fN]['list']) && in_array($inArray[$fN], $this->pi_autoCacheFields[$fN]['list'])) {
1309 unset($inArray[$fN]);
1310 }
1311 }
1312 }
1313 }
1314 if (empty($inArray)) {
1315 //@TODO: How do we deal with this? return TRUE would be the right thing to do here but that might be breaking
1316 return 1;
1317 }
1318 return null;
1319 }
1320
1321 /**
1322 * Will process the input string with the parseFunc function from ContentObjectRenderer based on configuration
1323 * set in "lib.parseFunc_RTE" in the current TypoScript template.
1324 *
1325 * @param string $str The input text string to process
1326 * @return string The processed string
1327 * @see ContentObjectRenderer::parseFunc()
1328 */
1329 public function pi_RTEcssText($str)
1330 {
1331 $parseFunc = $this->frontendController->tmpl->setup['lib.']['parseFunc_RTE.'];
1332 if (is_array($parseFunc)) {
1333 $str = $this->cObj->parseFunc($str, $parseFunc);
1334 }
1335 return $str;
1336 }
1337
1338 /*******************************
1339 *
1340 * FlexForms related functions
1341 *
1342 *******************************/
1343 /**
1344 * Converts $this->cObj->data['pi_flexform'] from XML string to flexForm array.
1345 *
1346 * @param string $field Field name to convert
1347 */
1348 public function pi_initPIflexForm($field = 'pi_flexform')
1349 {
1350 // Converting flexform data into array:
1351 if (!is_array($this->cObj->data[$field]) && $this->cObj->data[$field]) {
1352 $this->cObj->data[$field] = GeneralUtility::xml2array($this->cObj->data[$field]);
1353 if (!is_array($this->cObj->data[$field])) {
1354 $this->cObj->data[$field] = [];
1355 }
1356 }
1357 }
1358
1359 /**
1360 * Return value from somewhere inside a FlexForm structure
1361 *
1362 * @param array $T3FlexForm_array FlexForm data
1363 * @param string $fieldName Field name to extract. Can be given like "test/el/2/test/el/field_templateObject" where each part will dig a level deeper in the FlexForm data.
1364 * @param string $sheet Sheet pointer, eg. "sDEF
1365 * @param string $lang Language pointer, eg. "lDEF
1366 * @param string $value Value pointer, eg. "vDEF
1367 * @return string|NULL The content.
1368 */
1369 public function pi_getFFvalue($T3FlexForm_array, $fieldName, $sheet = 'sDEF', $lang = 'lDEF', $value = 'vDEF')
1370 {
1371 $sheetArray = is_array($T3FlexForm_array) ? $T3FlexForm_array['data'][$sheet][$lang] : '';
1372 if (is_array($sheetArray)) {
1373 return $this->pi_getFFvalueFromSheetArray($sheetArray, explode('/', $fieldName), $value);
1374 }
1375 return null;
1376 }
1377
1378 /**
1379 * Returns part of $sheetArray pointed to by the keys in $fieldNameArray
1380 *
1381 * @param array $sheetArray Multidimensiona array, typically FlexForm contents
1382 * @param array $fieldNameArr Array where each value points to a key in the FlexForms content - the input array will have the value returned pointed to by these keys. All integer keys will not take their integer counterparts, but rather traverse the current position in the array an return element number X (whether this is right behavior is not settled yet...)
1383 * @param string $value Value for outermost key, typ. "vDEF" depending on language.
1384 * @return mixed The value, typ. string.
1385 * @access private
1386 * @see pi_getFFvalue()
1387 */
1388 public function pi_getFFvalueFromSheetArray($sheetArray, $fieldNameArr, $value)
1389 {
1390 $tempArr = $sheetArray;
1391 foreach ($fieldNameArr as $k => $v) {
1392 if (MathUtility::canBeInterpretedAsInteger($v)) {
1393 if (is_array($tempArr)) {
1394 $c = 0;
1395 foreach ($tempArr as $values) {
1396 if ($c == $v) {
1397 $tempArr = $values;
1398 break;
1399 }
1400 $c++;
1401 }
1402 }
1403 } else {
1404 $tempArr = $tempArr[$v];
1405 }
1406 }
1407 return $tempArr[$value];
1408 }
1409 }