ilRendererConfig Interface Reference

Inheritance diagram for ilRendererConfig:

Collaboration diagram for ilRendererConfig:

Public Member Functions
	addConfigElementsToForm (\ilPropertyFormGUI $form, $service, $purpose)
	populateConfigElementsInForm (\ilPropertyFormGUI $form, $service, $purpose, $config)
	validateConfigInForm (\ilPropertyFormGUI $form, $service, $purpose)
	getConfigFromForm (\ilPropertyFormGUI $form, $service, $purpose)
	getDefaultConfig ($service, $purpose)

Detailed Description

Definition at line 3 of file interface.ilRendererConfig.php.

Member Function Documentation

addConfigElementsToForm()

ilRendererConfig::addConfigElementsToForm	(	\ilPropertyFormGUI	$form,
			$service,
			$purpose
	)

Parameters

\ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

The config form

Implemented in ilPhantomJSRenderer, and ilTCPDFRenderer.

getConfigFromForm()

ilRendererConfig::getConfigFromForm	(	\ilPropertyFormGUI	$form,
			$service,
			$purpose
	)

Parameters

\ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

array KV-array with config

Implemented in ilPhantomJSRenderer, and ilTCPDFRenderer.

getDefaultConfig()

ilRendererConfig::getDefaultConfig	(		$service,
			$purpose
	)

Parameters

string	$service	Service Title
string	$purpose	Purpose Title

Returns

array KV-array with config

Implemented in ilPhantomJSRenderer, and ilTCPDFRenderer.

populateConfigElementsInForm()

ilRendererConfig::populateConfigElementsInForm	(	\ilPropertyFormGUI	$form,
			$service,
			$purpose,
			$config
	)

Parameters

\ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title
array	$config	KV-array with config

Returns

The config form

Implemented in ilPhantomJSRenderer, and ilTCPDFRenderer.

validateConfigInForm()

ilRendererConfig::validateConfigInForm	(	\ilPropertyFormGUI	$form,
			$service,
			$purpose
	)

Parameters

\ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title

Returns

boolean True, if the form holds a valid config

Implemented in ilPhantomJSRenderer, and ilTCPDFRenderer.

---

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

• Services/PDFGeneration/interfaces/interface.ilRendererConfig.php