SyntaxColoringEngine Class Reference

Inheritance diagram for SyntaxColoringEngine:

Public Member Functions
	__construct ($path_type)
	initialise ($text=null, $mode=null)
	display ($text='', $mode='')
	execute ($text='', $mode='', $params=array())
Public Member Functions inherited from Input
	__construct ($name, $path_type)
	Input ($name, $path_type)
	initialise ($params=array())
	display ()
	get_translation ($value, $data=null)
	set_selectedLayout ($layout='')
Public Member Functions inherited from Plugin
	__construct ($name, $plugin_type, $path_type)
	get_version ()
	load_library ($library='')
	load_file ($file='')
	load_varFile ($file='')
	load_engineFile ($file='')
	get_engineFileURL ($file='', $path=false)
	get_fileURL ($file='', $path=null, $default='')
	get_varFileURL ($file='', $path=false, $default='')
	get_filePath ($file='')
	get_varFilePath ($file='')
	add_JSFile ($file)
	add_JSEngineFile ($file)
	add_JSExternFile ($file)
	add_JSScript ($script, $unique=false)
	add_JSPreScript ($script, $unique=false)
	add_JSWindowEventScript ($event, $script, $unique=false)
	add_JSLoadScript ($script, $unique=false)
	add_JSUnloadScript ($script, $unique=false)
	add_styleFile ($file, $media='', $condition='')
	add_styleScript ($css)
	add_styleIncludedFile ($file)
	add_StyleExternFile ($file, $media='', $condition='')
	set_RSSFeed ($title, $url)
	add_headerExtra ($content='')
	install ()
	uninstall ()
	is_installed ()
	update ($version, $more='')
	add_translation ($more='', $lg=null)
	get_languages ()
	execute_onCaMykSInitialise ()
	execute_onCaMykSPageLoad ()
	execute_onCaMykSBodyOpen ()
	execute_onCaMykSBodyClose ()
	execute_onCaMykSAdminPageLoad ()
	execute_onCaMykSAdminBodyOpen ()
	execute_onCaMykSAdminBodyClose ()
	execute_onCaMykSTerminate ()
	get_requestLink ($params=array())
	get_requestJSLink ($params=array())
	execute_request ()
	get_varFile ($file)

Public Attributes
	$mode = 'none'
	Current syntax colouring mode. More...
	$content = ''
	Content to colourise. More...
Public Attributes inherited from Input
	$title
	Input title. More...
	$params = array()
	Input parameters. More...
	$selected_layout = 'input.html.inc'
	Input layout to use. More...
Public Attributes inherited from Plugin
	$name
	Plugin name. More...
	$version
	Plugin version. More...
	$active = false
	Plugin installation status. More...
	$plugin_package = ''
	Plugin package. More...
	$plugin_type
	Plugin type. More...
	$object_type
	Plugin type. More...
	$plugin_path
	Plugin path. More...
	$plugin_site_path
	Plugin site path (for element overwriting). More...
	$plugin_var_path
	Plugin var path. More...
	$plugin_url
	Plugin URL. More...
	$plugin_site_url
	Plugin site URL (for element overwriting). More...
	$plugin_var_url
	Plugin var URL. More...
	$path_type
	Plugin path type. More...
	$author_name
	Plugin author name. More...
	$author_mail
	Plugin author email. More...
	$author_group
	Plugin author group. More...
	$plugin_dependencies = array()
	Plugin dependencies. More...

Private Attributes
	$modes = array('none', 'javascript', 'css')
	Available syntax colouring modes. More...
	$loaded = array()
	Loaded modes. More...

Additional Inherited Members
Protected Member Functions inherited from Plugin
	set_redirect ($time, $url='')
	add_meta ($name, $content, $method='name')
	add_toHtaccess ($content='')
	add_dependency ($plugin, $type, $version='1.0', $mandatory=false)
	set_dependencies ()
	register_asSharedObject ($name)
&	get_sharedObject ($name)
	register_asExtension ($plugin)
	get_registeredExtensions ()
	register_asCaMykSEventHandler ($event)

Detailed Description

SyntaxColoringEngine Input class.

Constructor & Destructor Documentation

__construct()

SyntaxColoringEngine::__construct

(

$path_type

)

Class constructor.

Parameters

string

$path_type

Returns

void

Member Function Documentation

initialise()

SyntaxColoringEngine::initialise	(		$text = null,
			$mode = null
	)

Initialise input.

Parameters

string	$text
string	$mode

Returns

void

display()

SyntaxColoringEngine::display	(		$text = '',
			$mode = ''
	)

Display input.

Parameters

string	$text
string	$mode

Returns

void

execute()

SyntaxColoringEngine::execute	(		$text = '',
			$mode = '',
			$params = array()
	)

Execute colorisation.

Parameters

string	$text
string	$mode
array	$params

Returns

string

Member Data Documentation

$mode

SyntaxColoringEngine::$mode = 'none'

Current syntax colouring mode.

var string $mode

$content

SyntaxColoringEngine::$content = ''

Content to colourise.

var string $content

$modes

SyntaxColoringEngine::$modes = array('none', 'javascript', 'css')

private

Available syntax colouring modes.

var array $modes

$loaded

SyntaxColoringEngine::$loaded = array()

private

Loaded modes.

var array $loaded

---

The documentation for this class was generated from the following file:

• CaMykS/plugin/input/SyntaxColoringEngine/SyntaxColoringEngine.php.inc