Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / rtehtmlarea / extensions / TYPO3Link / class.tx_rtehtmlarea_typo3link.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2008-2011 Stanislas Rolland <typo3(arobas)sjbr.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 * TYPO3Link plugin for htmlArea RTE
26 *
27 * @author Stanislas Rolland <typo3(arobas)sjbr.ca>
28 *
29 * TYPO3 SVN ID: $Id$
30 *
31 */
32 class tx_rtehtmlarea_typo3link extends tx_rtehtmlarea_api {
33
34 protected $extensionKey = 'rtehtmlarea'; // The key of the extension that is extending htmlArea RTE
35 protected $pluginName = 'TYPO3Link'; // The name of the plugin registered by the extension
36 protected $relativePathToLocallangFile = ''; // Path to this main locallang file of the extension relative to the extension dir.
37 protected $relativePathToSkin = 'extensions/TYPO3Link/skin/htmlarea.css'; // Path to the skin (css) file relative to the extension dir.
38 protected $htmlAreaRTE; // Reference to the invoking object
39 protected $thisConfig; // Reference to RTE PageTSConfig
40 protected $toolbar; // Reference to RTE toolbar array
41 protected $LOCAL_LANG; // Frontend language array
42
43 protected $pluginButtons = 'link, unlink';
44 protected $convertToolbarForHtmlAreaArray = array (
45 'link' => 'CreateLink',
46 'unlink' => 'UnLink',
47 );
48
49 public function main($parentObject) {
50 // Check if this should be enabled based on Page TSConfig
51 return parent::main($parentObject) && !$this->thisConfig['disableTYPO3Browsers']
52 && !(is_array( $this->thisConfig['buttons.']) && is_array($this->thisConfig['buttons.']['link.']) && is_array($this->thisConfig['buttons.']['link.']['TYPO3Browser.']) && $this->thisConfig['buttons.']['link.']['TYPO3Browser.']['disabled']);
53 }
54
55 /**
56 * Return JS configuration of the htmlArea plugins registered by the extension
57 *
58 * @param integer Relative id of the RTE editing area in the form
59 *
60 * @return string JS configuration for registered plugins, in this case, JS configuration of block elements
61 *
62 * The returned string will be a set of JS instructions defining the configuration that will be provided to the plugin(s)
63 * Each of the instructions should be of the form:
64 * RTEarea['.$RTEcounter.']["buttons"]["button-id"]["property"] = "value";
65 */
66 public function buildJavascriptConfiguration($RTEcounter) {
67
68 $registerRTEinJavascriptString = '';
69 $button = 'link';
70 if (in_array($button, $this->toolbar)) {
71 if (!is_array( $this->thisConfig['buttons.']) || !is_array( $this->thisConfig['buttons.'][$button.'.'])) {
72 $registerRTEinJavascriptString .= '
73 RTEarea['.$RTEcounter.'].buttons.'. $button .' = new Object();';
74 }
75 $registerRTEinJavascriptString .= '
76 RTEarea['.$RTEcounter.'].buttons.'. $button .'.pathLinkModule = "' . $this->htmlAreaRTE->extHttpPath . 'mod3/browse_links.php";';
77
78 if ($this->htmlAreaRTE->is_FE()) {
79 $RTEProperties = $this->htmlAreaRTE->RTEsetup;
80 } else {
81 $RTEProperties = $this->htmlAreaRTE->RTEsetup['properties'];
82 }
83 if (is_array($RTEProperties['classesAnchor.'])) {
84 $registerRTEinJavascriptString .= '
85 RTEarea['.$RTEcounter.'].buttons.'. $button .'.classesAnchorUrl = "' . $this->htmlAreaRTE->writeTemporaryFile('', 'classesAnchor_'.$this->htmlAreaRTE->contentLanguageUid, 'js', $this->buildJSClassesAnchorArray()) . '";';
86 }
87 $registerRTEinJavascriptString .= '
88 RTEarea['.$RTEcounter.'].buttons.'. $button .'.additionalAttributes = "external' . ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extensionKey]['plugins'][$this->pluginName]['additionalAttributes'] ? (',' . $GLOBALS['TYPO3_CONF_VARS']['EXTCONF'][$this->extensionKey]['plugins'][$this->pluginName]['additionalAttributes']) : '') . '";';
89 }
90 return $registerRTEinJavascriptString;
91 }
92
93 /**
94 * Return a JS array for special anchor classes
95 *
96 * @return string classesAnchor array definition
97 */
98 public function buildJSClassesAnchorArray() {
99 global $LANG, $TYPO3_CONF_VARS;
100
101 $linebreak = $TYPO3_CONF_VARS['EXTCONF'][$this->htmlAreaRTE->ID]['enableCompressedScripts'] ? '' : LF;
102 $JSClassesAnchorArray .= 'HTMLArea.classesAnchorSetup = [ ' . $linebreak;
103 $classesAnchorIndex = 0;
104 foreach ($this->htmlAreaRTE->RTEsetup['properties']['classesAnchor.'] as $label => $conf) {
105 if (is_array($conf) && $conf['class']) {
106 $JSClassesAnchorArray .= (($classesAnchorIndex++)?',':'') . ' { ' . $linebreak;
107 $index = 0;
108 $JSClassesAnchorArray .= (($index++)?',':'') . 'name : "' . $conf['class'] . '"' . $linebreak;
109 if ($conf['type']) {
110 $JSClassesAnchorArray .= (($index++)?',':'') . 'type : "' . $conf['type'] . '"' . $linebreak;
111 }
112 if (trim(str_replace('\'', '', str_replace('"', '', $conf['image'])))) {
113 $JSClassesAnchorArray .= (($index++)?',':'') . 'image : "' . $this->htmlAreaRTE->siteURL . t3lib_div::resolveBackPath(TYPO3_mainDir . $this->htmlAreaRTE->getFullFileName(trim(str_replace('\'', '', str_replace('"', '', $conf['image']))))) . '"' . $linebreak;
114 }
115 $JSClassesAnchorArray .= (($index++)?',':'') . 'addIconAfterLink : ' . ($conf['addIconAfterLink']?'true':'false') . $linebreak;
116 if (trim($conf['altText'])) {
117 $string = $this->htmlAreaRTE->getLLContent(trim($conf['altText']));
118 $JSClassesAnchorArray .= (($index++)?',':'') . 'altText : ' . str_replace('"', '\"', str_replace('\\\'', '\'', $string)) . $linebreak;
119 }
120 if (trim($conf['titleText'])) {
121 $string = $this->htmlAreaRTE->getLLContent(trim($conf['titleText']));
122 $JSClassesAnchorArray .= (($index++)?',':'') . 'titleText : ' . str_replace('"', '\"', str_replace('\\\'', '\'', $string)) . $linebreak;
123 }
124 if (trim($conf['target'])) {
125 $JSClassesAnchorArray .= (($index++)?',':'') . 'target : "' . trim($conf['target']) . '"' . $linebreak;
126 }
127 $JSClassesAnchorArray .= '}' . $linebreak;
128 }
129 }
130 $JSClassesAnchorArray .= '];' . $linebreak;
131 return $JSClassesAnchorArray;
132 }
133
134 /**
135 * Return an updated array of toolbar enabled buttons
136 *
137 * @param array $show: array of toolbar elements that will be enabled, unless modified here
138 *
139 * @return array toolbar button array, possibly updated
140 */
141 public function applyToolbarConstraints($show) {
142 // We will not allow unlink if link is not enabled
143 if (!in_array('link', $show)) {
144 return array_diff($show, t3lib_div::trimExplode(',', $this->pluginButtons));
145 } else {
146 return $show;
147 }
148 }
149 }
150 if (defined('TYPO3_MODE') && isset($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Link/class.tx_rtehtmlarea_typo3link.php'])) {
151 include_once($GLOBALS['TYPO3_CONF_VARS'][TYPO3_MODE]['XCLASS']['ext/rtehtmlarea/extensions/TYPO3Link/class.tx_rtehtmlarea_typo3link.php']);
152 }
153 ?>