class tree: xoopseditor | index: xoopseditor | all elements
xoopseditor

Packages:

Files:
dhtmltextarea.php
editor_registry.php
english.php
formtinymce.php
tinymce.php
xoopseditor.inc.php
xoopseditor.php

Interfaces:
Classes:
form
FormDhtmlTextArea
XoopsFormTinymce
TinyMCE
XoopsEditorHandler

Class: XoopsEditorHandler

Source Location: /class/xoopseditor.php

Class XoopsEditorHandler

Class Overview
Class Overview | Property Summary | Properties Detail | Method Summary | Methods Detail

Editor framework for XOOPS

Located in /class/xoopseditor.php [line 12] 



		
				Author(s):
		
		
		

Information Tags:



				
Version:  $Id: xoopseditor.php,v 1.3 2007/10/20 20:33:16 marcan Exp $

				
Copyright:  The XOOPS project http://www.xoops.org/

				
Since:  1.00

				
License:  GNU public license

	

				

				
		
Properties

		
				
		
				
		
Methods

		
				
		
		

		
[ Top ]

	







	
	

		
Property Summary

		

			Class Overview
									| Property Summary | Properties Detail
												| Method Summary | Methods Detail
							    				

		

			

			

					

					

					

																															
mixed  
					$allowed_editors  
					

				
													
mixed  
					$nohtml  
					

				
													
mixed  
					$root_path  
					

				
										

			

			
[ Top ]

		

	


	
	

		
Method Summary

		

			Class Overview
																		| Property Summary | Properties Detail
							    					| Method Summary | Methods Detail
		

		

			

				

					

											

											

											

											

											

											

																												
static
											object  
					
					&getInstance()  
					Access the only instance of this class

				
																																																				
XoopsEditorHandler  
										XoopsEditorHandler()  
					

				
																
void  
										&get()  
					

				
																								
void  
										&getList()  
					

				
																
void  
										render()  
					

				
																
void  
										setConfig()  
					

				
																
void  
										&_loadEditor()  
					

				
												

			

			
[ Top ]

		

	


	
	

		
Properties

		

			Class Overview
													| Property Summary | Properties Detail
															| Method Summary | Methods Detail
												

		

			




	

		
			mixed  
			$allowed_editors
			 = array()			[line 16]
		
	


	
	


	
		

	
[ Top ]







	

		
			mixed  
			$nohtml
			 =  false			[line 15]
		
	


	
	


	
		

	
[ Top ]







	

		
			mixed  
			$root_path
			 =  ""			[line 14]
		
	


	
	


	
		

	
[ Top ]



		

	


	
	

		
Methods

		

			Class Overview
																		| Property Summary | Properties Detail
																	| Method Summary | Methods Detail
					

		

			







	static method getInstance  [line 32]





	

    

    
 
		static object &getInstance(
)
    

    



	

Access the only instance of this class



	

	
API Tags:



  

    Staticvar:  object $instance: 
  







		
		

	
[ Top ]










	Constructor XoopsEditorHandler  [line 18]





	

    

    
 
		XoopsEditorHandler XoopsEditorHandler(
)
    

    



	

	

	


		
		

	
[ Top ]









	get  [line 47]





	

    

    
 
		void &get(
[string
$name = ""], [array
$options = null], [bool
$noHtml = false], [string
$OnFailure = ""] 
)
    

    



	

			Parameters:

			

					

				string  
				
				$name: 
				
				 Editor name which is actually the folder name			

					

				array  
				
				$options: 
				
				 editor options: $key => $val			

					

				string  
				
				$OnFailure: 
				
				 a pre-validated editor that will be used if the required editor is failed to create			

					

				bool  
				
				$noHtml: 
				
				 dohtml disabled			

				


	

	


		
		

	
[ Top ]









	getList  [line 67]





	

    

    
 
		void &getList(
[
$noHtml = false] 
)
    

    



	

			Parameters:

			

					

				  
				
				$noHtml: 
				
							

				


	

	


		
		

	
[ Top ]









	render  [line 106]





	

    

    
 
		void render(

&$editor 
)
    

    



	

			Parameters:

			

					

				  
				
				&$editor: 
				
							

				


	

	


		
		

	
[ Top ]









	setConfig  [line 111]





	

    

    
 
		void setConfig(

&$editor, 
$options 
)
    

    



	

			Parameters:

			

					

				  
				
				&$editor: 
				
							

					

				  
				
				$options: 
				
							

				


	

	


		
		

	
[ Top ]









	_loadEditor  [line 122]





	

    

    
 
		void &_loadEditor(

$name, [
$options = null] 
)
    

    



	

			Parameters:

			

					

				  
				
				$name: 
				
							

					

				  
				
				$options: 
				
							

				


	

	


		
		

	
[ Top ]



		

	




        

		    

		    Documentation generated on Sat, 15 Nov 2008 14:30:09 -0600 by phpDocumentor 1.4.1