* Feature/Cleanup: Acronym plugin of htmlArea RTE using new plugin API and enabled...
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / Acronym / class.tx_rtehtmlarea_acronym.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008 Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>
6 * All rights reserved
7 *
8 * This script is part of the Typo3 project. The Typo3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 *
17 * This script is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * This copyright notice MUST APPEAR in all copies of the script!
23 ***************************************************************/
24 /**
25 * Acronym extension for htmlArea RTE
26 *
27 * @author Stanislas Rolland <stanislas.rolland(arobas)fructifor.ca>
28 *
29 * TYPO3 SVN ID: $Id$
30 *
31 */
32
33 require_once(t3lib_extMgm::extPath('rtehtmlarea').'class.tx_rtehtmlareaapi.php');
34
35 class tx_rtehtmlarea_acronym extends tx_rtehtmlareaapi {
36
37 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
38 protected $pluginName = 'Acronym'; // The name of the plugin registered by the extension
39 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
40 protected $relativePathToSkin = 'extensions/Acronym/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir
41 protected $htmlAreaRTE; // Reference to the invoking object
42 protected $thisConfig; // Reference to RTE PageTSConfig
43 protected $toolbar; // Reference to RTE toolbar array
44 protected $LOCAL_LANG; // Frontend language array
45
46 protected $pluginButtons = 'acronym';
47 protected $convertToolbarForHtmlAreaArray = array (
48 'acronym' => 'Acronym',
49 );
50
51 public function main($parentObject) {
52 return parent::main($parentObject) && !($this->htmlAreaRTE->client['BROWSER'] == 'msie' && $this->htmlAreaRTE->client['VERSION'] < 7);
53
54 }
55
56 /**
57 * Return tranformed content
58 *
59 * @param string $content: The content that is about to be sent to the RTE
60 *
61 * @return string the transformed content
62 */
63 public function transformContent($content) {
64
65 // <abbr> was not supported by IE before verison 7
66 if ($this->htmlAreaRTE->client['BROWSER'] == 'msie' && $this->htmlAreaRTE->client['VERSION'] < 7) {
67 // change <abbr> to <acronym>
68 $content = preg_replace('/<(\/?)abbr/i', "<$1acronym", $content);
69 }
70
71 return $content;
72 }
73
74 /**
75 * Return JS configuration of the htmlArea plugins registered by the extension
76 *
77 * @param integer Relative id of the RTE editing area in the form
78 *
79 * @return string JS configuration for registered plugins, in this case, JS configuration of block elements
80 *
81 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
82 * Each of the instructions should be of the form:
83 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
84 */
85 public function buildJavascriptConfiguration($RTEcounter) {
86
87 $registerRTEinJavascriptString = '';
88 $button = 'acronym';
89 if (in_array($button, $this->toolbar)) {
90 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
91 $registerRTEinJavascriptString .= '
92 RTEarea['.$RTEcounter.']["buttons"]["'. $button .'"] = new Object();';
93 }
94 $registerRTEinJavascriptString .= '
95 RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathAcronymModule = "../../mod2/acronym.php";
96 RTEarea['.$RTEcounter.'].buttons.'. $button .'.acronymUrl = "' . $this->htmlAreaRTE->writeTemporaryFile('', 'acronym_'.$this->htmlAreaRTE->contentLanguageUid, 'js', $this->buildJSAcronymArray($this->htmlAreaRTE->contentLanguageUid)) . '";';
97 }
98
99 return $registerRTEinJavascriptString;
100 }
101
102 /**
103 * Return an acronym array for the Acronym plugin
104 *
105 * @return string acronym Javascript array
106 */
107 function buildJSAcronymArray($languageUid) {
108 global $TYPO3_CONF_VARS, $TYPO3_DB;
109
110 $linebreak = $TYPO3_CONF_VARS['EXTCONF'][$this->htmlAreaRTE->ID]['enableCompressedScripts'] ? '' : chr(10);
111 $acronymIndex = 0;
112 $abbraviationIndex = 0;
113 $JSAcronymArray .= 'acronyms = { ' . $linebreak;
114 $JSAbbreviationArray .= 'abbreviations = { ' . $linebreak;
115 $table = 'tx_rtehtmlarea_acronym';
116 if ($languageUid > -1) {
117 $whereClause = '(sys_language_uid=' . $languageUid . ' OR sys_language_uid=-1)';
118 } else {
119 $whereClause = '1 = 1';
120 }
121 $whereClause .= t3lib_BEfunc::BEenableFields($table);
122 $whereClause .= t3lib_BEfunc::deleteClause($table);
123 $res = $TYPO3_DB->exec_SELECTquery('type,term,acronym', $table, $whereClause);
124 while($acronymRow = $TYPO3_DB->sql_fetch_assoc($res)) {
125 if($acronymRow['type'] == 1) $JSAcronymArray .= (($acronymIndex++)?',':'') . '"' . $acronymRow['acronym'] . '":"' . $acronymRow['term'] . '"' . $linebreak;
126 if($acronymRow['type'] == 2) $JSAbbreviationArray .= (($AbbreviationIndex++)?',':'') . '"' . $acronymRow['acronym'] . '":"' . $acronymRow['term'] . '"' . $linebreak;
127 }
128 $JSAcronymArray .= '};' . $linebreak;
129 $JSAbbreviationArray .= '};' . $linebreak;
130
131 return $JSAcronymArray . $JSAbbreviationArray;
132 }
133
134 } // end of class
135
136 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/Acronym/class.tx_rtehtmlarea_acronym.php']) {
137 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/Acronym/class.tx_rtehtmlarea_acronym.php']);
138 }
139
140 ?>