Build Body

public function onBuildBodyExportICS(mixed $handler) : string

Fires after creating the head of the ICS file.

Description

Trigger hook to allow the plugins to include custom options before the body of the ICS file.

It is possible to include new options by returning them or by using the helper methods provided by $handler instance.

// append through the ICS handler
$handler->addLine('X-VAP-CUSTOM', 'XYZ');
// append as return value
return "X-VAP-CUSTOM:XYZ\n";

Parameters

$handler

(VAPOrderExportDriverIcs)  The instance used to export the records. Provides some helper methods to encode the ICS lines.

Return Value

String. The rules to append at the beginning of the ICS body.

Example

/**
 * Trigger hook to allow the plugins to include custom options before
 * the body of the ICS file.
 *
 * @param   mixed   $handler  The current handler instance.
 *
 * @return  string  The rules to include within the head.
 */
public function onBuildBodyExportICS($handler)
{
    /**
     * @todo it is possible to manipulate here the ICS body
     */
}

Changelog