Name

enable -- Install phppdflib extension for use

Synopsis

bool enable ( string extension_name )

Description

This method makes the extension methods named by extension_name available for use.

All extensions are enabled as a subobject of the main phppdflib object. Thus, enabling an extension called 'foo' will make its methods available as $pdf->x['foo']->methodname().

Extensions that ship with phppdflib also have aliases directly off the phppdflib object (the example above would be $pdf->foo->methodname). Either method of access is acceptable, as the two variables are references to the same object.

Examples

$pdf->enable('chart');
$pdf->x['chart']->new_chart();
$pdf->enable('template');
$pdf->template->new();

See Also

The documentation for the extension you are enabling.

History

This function was added in version 2.1, and was called enable_chart().

The more flexible enable('extension_name') replaced that syntax in 2.2.

The universal $pdf->x['extensionname'] syntax was added in 2.4.

Bugs

None known.