include/SugarTinyMCE.php

Show:

inherited

Classes
- \SugarTinyMCE

Table of Contents

\SugarTinyMCE
jump to top

Package: SugarCRM

PHP wrapper class for Javascript driven TinyMCE WYSIWYG HTML editor

Properties


                 $buttonConfigs= 'array(
			'default' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "cut,copy,paste,pastetext,pasteword,selectall,separator,search,replace,separator,bullist,numlist,separator,outdent,
	                     					indent,separator,ltr,rtl,separator,undo,redo,separator, link,unlink,anchor,image,separator,sub,sup,separator,charmap,
	                     					visualaid",
	                    'buttonConfig3' => "tablecontrols,separator,advhr,hr,removeformat,separator,insertdate,inserttime,separator,preview"),
	        'email_compose' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "",
	                    'buttonConfig3' => ""),
	        'email_compose_light' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "",
	                    'buttonConfig3' => ""),
	)'

Default value

array(
			'default' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "cut,copy,paste,pastetext,pasteword,selectall,separator,search,replace,separator,bullist,numlist,separator,outdent,
	                     					indent,separator,ltr,rtl,separator,undo,redo,separator, link,unlink,anchor,image,separator,sub,sup,separator,charmap,
	                     					visualaid",
	                    'buttonConfig3' => "tablecontrols,separator,advhr,hr,removeformat,separator,insertdate,inserttime,separator,preview"),
	        'email_compose' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "",
	                    'buttonConfig3' => ""),
	        'email_compose_light' => array(
						'buttonConfig' => "code,help,separator,bold,italic,underline,strikethrough,separator,bullist,numlist,separator,justifyleft,justifycenter,justifyright,
	                     					justifyfull,separator,forecolor,backcolor,separator,styleselect,formatselect,fontselect,fontsizeselect,",
	                    'buttonConfig2' => "",
	                    'buttonConfig3' => ""),
	)

Details

Type: n/a


                 $customConfigFile= ''custom/include/tinyButtonConfig.php''

Default value'custom/include/tinyButtonConfig.php'Details

Type: n/a


                 $customDefaultConfigFile= ''custom/include/tinyMCEDefaultConfig.php''

Default value'custom/include/tinyMCEDefaultConfig.php'Details

Type: n/a


                 $defaultConfig= 'array(
	    'convert_urls' => false,
        'valid_children' => '+body[style]',
	    'height' => 300,
		'width'	=> '100%',
		'theme'	=> 'advanced',
		'theme_advanced_toolbar_align' => "left",
		'theme_advanced_toolbar_location'	=> "top",
		'theme_advanced_buttons1'	=> "",
		'theme_advanced_buttons2'	=> "",
		'theme_advanced_buttons3'	=> "",
		'strict_loading_mode'	=> true,
		'mode'	=> 'exact',
		'language' => 'en',
	    'plugins' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality',
		'elements'	=> '',
        'extended_valid_elements' => 'style[dir|lang|media|title|type],hr[class|width|size|noshade],@[class|style]',
        'content_css' => 'include/javascript/tiny_mce/themes/advanced/skins/default/content.css',

	)'

Default value

array(
	    'convert_urls' => false,
        'valid_children' => '+body[style]',
	    'height' => 300,
		'width'	=> '100%',
		'theme'	=> 'advanced',
		'theme_advanced_toolbar_align' => "left",
		'theme_advanced_toolbar_location'	=> "top",
		'theme_advanced_buttons1'	=> "",
		'theme_advanced_buttons2'	=> "",
		'theme_advanced_buttons3'	=> "",
		'strict_loading_mode'	=> true,
		'mode'	=> 'exact',
		'language' => 'en',
	    'plugins' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality',
		'elements'	=> '',
        'extended_valid_elements' => 'style[dir|lang|media|title|type],hr[class|width|size|noshade],@[class|style]',
        'content_css' => 'include/javascript/tiny_mce/themes/advanced/skins/default/content.css',

	)

Details

Type: n/a


                 $jsroot= '"include/javascript/tiny_mce/"'

Default value"include/javascript/tiny_mce/"Details

Type: n/a


                 $pluginsConfig= 'array(
	    'email_compose_light' => 'insertdatetime,paste,directionality,safari',
        'email_compose' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality,fullpage',
	)'

Default value

array(
	    'email_compose_light' => 'insertdatetime,paste,directionality,safari',
        'email_compose' => 'advhr,insertdatetime,table,preview,paste,searchreplace,directionality,fullpage',
	)

Details

Type: n/a

Methods

SugarTinyMCE(
          
          )
        
        :
          void

Sole constructor

cleanEncodedMCEHtml(
           $html
          )
        
        :
          \$html

This function takes in html code that has been produced (and somewhat mauled) by TinyMCE and returns a cleaned copy of it.

Parameters

Name	Type	Description
$html

Returns

Type	Description
\$html	with all the tinyMCE specific html removed

getConfig(
           $type
              =
              'default'
          )
        
        :
          void

Parameters

Name	Type	Description
$type

getInstance(
          string $targets
              =
              ""
          )
        
        :
          string

Returns the Javascript necessary to initialize a TinyMCE instance for a given or <div></p></div> <div class="code-tabs"> <div class="long-description"></div> <strong>Parameters</strong><table class="argument-info"> <thead><tr> <th>Name</th> <th>Type</th> <th>Description</th> </tr></thead> <tr> <th>$targets</th> <td>string</td> <td><em><p>target Comma delimited list of DOM ID's, <textarea id='someTarget'></p> </em></td> </tr> </table> <strong>Returns</strong><table class="argument-info"> <thead><tr> <th>Type</th> <th>Description</th> </tr></thead> <tr> <td>string</td> <td></td> </tr> </table> </div> <div class="clear"></div> </div> <a id="\SugarTinyMCE::overloadButtonConfigs()" class="anchor"></a><div class="method private"> <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private"><span class="highlight">overloadButtonConfigs</span><span class="nb-faded-text">( ) </span> : void</code><div class="description"><p class="short_description">Reload the default button configs by allowing admins to specify which tinyMCE buttons will be displayed in a separate config file.</p></div> <div class="code-tabs"><div class="long-description"></div></div> <div class="clear"></div> </div> <a id="\SugarTinyMCE::overloadDefaultConfigs()" class="anchor"></a><div class="method private"> <a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private"><span class="highlight">overloadDefaultConfigs</span><span class="nb-faded-text">( ) </span> : void</code><div class="description"><p class="short_description">Reload the default tinyMCE config, preserving our default extended allowable tag set.</p></div> <div class="code-tabs"><div class="long-description"></div></div> <div class="clear"></div> </div> </div> </div> </div> <small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.18.1</a>. </small></body></html>

include/SugarTinyMCE.php

\SugarTinyMCEjump to top

Properties

Methods

\SugarTinyMCE
jump to top