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