ExternModule Class Reference

Inheritance diagram for ExternModule:

Public Member Functions
	__construct ($range_id, $module_name, $config_id=NULL, $set_config=NULL, $global_id=NULL)
	getType ()
	getName ()
&	getConfig ()
	getDefaultConfig ()
	getRangeDefaultConfig ($range_id= 'global')
	getAllElements ()
	getValue ($attribute)
	setValue ($attribute, $value)
	getAttributes ($element_name, $tag_name)
	getArgs ()
	toString ($args)
	toStringEdit ($open_elements="", $post_vars="", $faulty_values="", $anker="")
	printout ($args)
	printoutEdit ($element_name="", $post_vars="", $faulty_values="", $anker="")
	checkFormValues ($element_name="")
	store ($element_name= '', $values= '')
	getDescription ()
	executeCommand ($element, $command, $value)
	checkRangeId ($range_id)
	getModuleLink ($module_name, $config_id, $sri_link)
	setup ()
	updateGenericDatafields ($element_name, $object_type)
	insertDatafieldMarkers ($object_type, &$markers, $element_name)
	insertPluginMarkers ($plugin_type, &$markers, $element_name)
	getLinkToModule ($linked_element_name=null, $params=null, $with_module_params=false, $self=false)
	getLinkToSelf ($params=null, $with_module_params=false, $linked_element_name=null)
	getModuleParams ($params=null)

Static Public Member Functions
static	GetInstance ($range_id, $module_name, $config_id=NULL, $set_config=NULL, $global_id=NULL)
static	printError ()
static	SetRawOutput ($raw=TRUE)
static	ExtHtmlReady ($text, $allow_links=FALSE)
static	ExtFormatReady ($text)
static	ExtWikiReady ($text, $show_comments= 'all')
static	GetOrderedModuleTypes ()
static	HaveAccessModuleType ($view, $module_id=NULL, $module_name=NULL)

Data Fields
	$type = NULL
	$name
	$config
	$registered_elements = []
	$elements = []
	$field_names = []
	$data_fields = []
	$args = []

Constructor & Destructor Documentation

__construct	(		$range_id,
			$module_name,
			$config_id = NULL,
			$set_config = NULL,
			$global_id = NULL
	)

The constructor of a child class has to call this parent constructor!

Member Function Documentation

checkFormValues

(

$element_name = ""

)

checkRangeId

(

$range_id

)

executeCommand	(		$element,
			$command,
			$value
	)

static ExtFormatReady (   $text )

static

static ExtHtmlReady (   $text,   $allow_links = FALSE  )

static

static ExtWikiReady (   $text,   $show_comments = 'all'  )

static

getAllElements

(

)

getArgs

(

)

getAttributes	(		$element_name,
			$tag_name
	)

& getConfig

(

)

getDefaultConfig

(

)

getDescription

(

)

static GetInstance (   $range_id,   $module_name,   $config_id = NULL,   $set_config = NULL,   $global_id = NULL  )

static

getLinkToModule	(		$linked_element_name = null,
			$params = null,
			$with_module_params = false,
			$self = false
	)

getLinkToSelf	(		$params = null,
			$with_module_params = false,
			$linked_element_name = null
	)

getModuleLink	(		$module_name,
			$config_id,
			$sri_link
	)

getModuleParams

(

$params = null

)

getName

(

)

static GetOrderedModuleTypes ( )

static

getRangeDefaultConfig

(

$range_id = 'global'

)

getType

(

)

getValue

(

$attribute

)

static HaveAccessModuleType (   $view,   $module_id = NULL,   $module_name = NULL  )

static

Checks access for a module in a given view.of the admin area.

Parameters

string	$view	view in the admin area ('extern_inst' or 'extern_global')
int	$module_id	(optional) ID of the module (see extern_config.inc.php)
string	$module_name	(optional) name of the module (see extern_config.inc.php)

Returns

bool access granted

insertDatafieldMarkers	(		$object_type,
		&	$markers,
			$element_name
	)

insertPluginMarkers	(		$plugin_type,
		&	$markers,
			$element_name
	)

static printError ( )

static

printout

(

$args

)

printoutEdit	(		$element_name = "",
			$post_vars = "",
			$faulty_values = "",
			$anker = ""
	)

static SetRawOutput (   $raw = TRUE )

static

setup

(

)

setValue	(		$attribute,
			$value
	)

store	(		$element_name = '',
			$values = ''
	)

toString

(

$args

)

toStringEdit	(		$open_elements = "",
			$post_vars = "",
			$faulty_values = "",
			$anker = ""
	)

updateGenericDatafields	(		$element_name,
			$object_type
	)

Field Documentation

$args = []

$config

$data_fields = []

$elements = []

$field_names = []

$name

$registered_elements = []

$type = NULL

---

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

• lib/extern/lib/ExternModule.class.php