Skip to content

Latest commit

 

History

History
391 lines (157 loc) · 4.43 KB

export.md

File metadata and controls

391 lines (157 loc) · 4.43 KB
title footer
\leantime\domain\controllers\canvas\export
false

export

Template class for exporting class as XML file

Constants

Constant Type Value
\leantime\domain\controllers\canvas\export::CANVAS_NAME '??'
\leantime\domain\controllers\canvas\export::CANVAS_TYPE 'canvas'

Methods

init

Extended Controller version of __construct()

public export::init(): void

Return Value:

run

run - Generate XML file

public export::run(): void

Return Value:

export

protected export::export(int $id): string

Parameters:

Parameter Type Description
id int

Return Value:

xmlExport

xmlExport - Generate XML for specific data

protected export::xmlExport(string $canvasKey, string $canvasTitle, array $recordsAry, int $indent): string

Parameters:

Parameter Type Description
canvasKey string Encoded canvas name
canvasTitle string
recordsAry array Array of canvas entry records
indent int Indent level to use;

Return Value:

XML data

Inherited methods

__construct

constructor - initialize private variables

public controller::__construct( $method,  $params): mixed

Parameters:

Parameter Type Description
method **** the method to be initialized
params **** parameters or body of the request

Return Value:

executeActions

Allows hooking into all controllers with events

private controller::executeActions(string $method, array|object $params): void

Parameters:

Parameter Type Description
method string
params **array object**

Return Value:

init

Extended Controller version of __construct()

protected controller::init(): void

Return Value:

run

Default function for all request types unless otherwise specified

protected controller::run(): void

Return Value:

dispatch_event

dispatches an event with context

public static eventhelpers::dispatch_event(string $hook, mixed $available_params = [], string|int $function = null): void
  • This method is static.

Parameters:

Parameter Type Description
hook string
available_params mixed
function **string int**

Return Value:

dispatch_filter

dispatches a filter with context

public static eventhelpers::dispatch_filter(string $hook, mixed $payload, mixed $available_params = [], string|int $function = null): mixed
  • This method is static.

Parameters:

Parameter Type Description
hook string
payload mixed
available_params mixed
function **string int**

Return Value:

get_event_context

Gets the context of the event

private static eventhelpers::get_event_context(mixed $function): string
  • This method is static.

Parameters:

Parameter Type Description
function mixed

Return Value:

set_class_context

Gets the class context based on path, this uses the same method as the autoloader Helps create unique strings for events/filters

private static eventhelpers::set_class_context(): string
  • This method is static.

Return Value:

get_function_context

Gets the caller function name

private static eventhelpers::get_function_context(mixed $functionInt = null): string

This way we don't have to use much memory by using debug_backtrace

  • This method is static.

Parameters:

Parameter Type Description
functionInt mixed

Return Value:

Automatically generated from source code comments on 2023-02-28 using phpDocumentor