ilRendererConfig Interface Reference

Inheritance diagram for ilRendererConfig:

Collaboration diagram for ilRendererConfig:

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

Detailed Description

Deprecated:

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

Member Function Documentation

addConfigElementsToForm()

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

Parameters

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

Returns

void

Implemented in ilWkhtmlToPdfRenderer, and ilTCPDFRenderer.

getConfigFromForm()

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

Parameters

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

Returns

array<string, mixed> KV-array with config

Implemented in ilTCPDFRenderer, and ilWkhtmlToPdfRenderer.

getDefaultConfig()

ilRendererConfig::getDefaultConfig	(	string	$service,
		string	$purpose
	)

Parameters

string	$service	Service Title
string	$purpose	Purpose Title

Returns

mixed KV-array with config or an config instance

Implemented in ilTCPDFRenderer, and ilWkhtmlToPdfRenderer.

populateConfigElementsInForm()

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

Parameters

ilPropertyFormGUI	$form	The config form for the administration
string	$service	Service Title
string	$purpose	Purpose Title
	array<string,mixed>	$config KV-array with config

Returns

void

Implemented in ilTCPDFRenderer.

validateConfigInForm()

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

Parameters

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

Returns

bool True, if the form holds a valid config

Implemented in ilTCPDFRenderer, and ilWkhtmlToPdfRenderer.

---

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

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