local_middag\middag | MIDDAG for Moodle

final class middag

Main Facade for the Middag plugin.

This class acts as a Static Proxy (Facade) to the underlying Kernel architecture. It provides a simplified, clean API for the rest of the Moodle ecosystem to interact with the plugin's Services, Routes, and Environment configuration.

Design goals:

Keep the "public" API small and stable (other code calls this class).
Keep the internal architecture flexible behind kernel/router/container.
Offer a single entry-point to bootstrap, handle requests, and resolve services.

Constants

COMPONENT_NAME	Component name used for cache definitions, logs, and file storage.
DOCS_URL	External resource URL: documentation site.
SITE_URL	External resource URL: main company website.
SUPPORT_URL	External resource URL: support portal.
MIDDAGPLUGINS_OVERVIEW_URL	External resource URL: plugins overview on docs.

Methods

static middag

get_instance()

Singleton Accessor (Factory Method).

static void

init()

Initialize the application kernel.

static void

shutdown()

Shutdown the kernel and reset the singleton.

static void

handle()

Handle the current HTTP request and dispatch it to the appropriate controller.

static object

get(string $id)

Retrieve a service from the DI container.

static router_interface

routing()

Access the Route Manager directly.

static moodle_url

url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a Moodle URL from a Symfony route name and parameters.

static moodle_url

webhook_url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a webhook URL (helper for callbacks).

static void

register_route(string $name, string $path, string $controller_class, string $method, array $requirements = [])

static void

register_routes_from_annotations(string $class_name)

static object

dispatch(object $event)

Dispatch an event or signal through the framework's event dispatcher.

static void

add_filter(string $tag, callable $callback, int $priority = 10, int $args = 1)

static mixed

apply_filters(string $tag, mixed $value, mixed ...$args)

Apply synchronous MIDDAG filter hooks.

static void

add_action(string $tag, callable $callback, int $priority = 10, int $args = 1)

static void

do_action(string $tag, mixed ...$args)

Execute synchronous MIDDAG action hooks.

static string

get_component_name()

Get the component name.

static string

get_docs_url()

Get the documentation URL.

static string

get_site_url()

Get the main site URL.

static string

get_support_url()

Get the support portal URL.

static string

get_middagplugins_overview_url()

Get the Middag Plugins overview URL.

static bool

is_testing()

Check if running in PHPUnit test environment.

static bool

is_development()

Check if running in development environment.

static bool

is_production()

Check if running in production environment.

Details

at line 90
`static middag get_instance()`

Singleton Accessor (Factory Method).

Used by the Container to register 'middag' as a service. This allows the facade to be injected (when desired) while remaining static-friendly.

Return Value

middag

at line 104
`static void init()`

Initialize the application kernel.

Idempotent: safe to call multiple times.

Return Value

void

at line 114
`static void shutdown()`

Shutdown the kernel and reset the singleton.

Useful for testing isolation.

Return Value

void

at line 129
`static void handle()`

Handle the current HTTP request and dispatch it to the appropriate controller.

In practice, this delegates to the router/controller pipeline inside the kernel. Typical call site: entrypoints (index.php, webhook.php, etc.).

Return Value

void

at line 146
`static object get(string $id)`

Retrieve a service from the DI container.

This is the primary escape hatch for the outside world to interact with your DI-managed services without coupling to the container directly.

Parameters

string

$id

Service ID or Class Name

Return Value

object

at line 162
`static router_interface routing()`

Access the Route Manager directly.

Exposes the router to allow:

manual route registration
attribute/annotation scanning (before compilation)
URL generation through router abstraction

Return Value

router_interface

at line 179
`static moodle_url url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)`

Generate a Moodle URL from a Symfony route name and parameters.

This method bridges your Symfony-style routing (route name + params) to Moodle's moodle_url, keeping the rest of your codebase free from direct moodle_url construction logic.

Parameters

string	$route	The route name
array	$parameters	Route parameters
int	$reference_type	URL generation type (Absolute/Relative)

Return Value

moodle_url

at line 200
`static moodle_url webhook_url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)`

Generate a webhook URL (helper for callbacks).

This is a specialized helper that:

generates the base route URL (usually pointing to index.php)
rewrites it to point to webhook.php
returns a moodle_url for consistent handling inside Moodle

Parameters

string	$route
array	$parameters
int	$reference_type

Return Value

moodle_url

Exceptions

moodle_exception

at line 218
`static void register_route(string $name, string $path, string $controller_class, string $method, array $requirements = [])`

This is useful when you want to define routes procedurally (e.g. in bootstrap), instead of attribute scanning.

Parameters

string	$name	Route name (e.g., 'my_route').
string	$path	URL path (e.g., '/my/path/{id}').
string	$controller_class	FQCN of the controller
string	$method	method name
array	$requirements	regex requirements for parameters

Return Value

void

at line 240
`static void register_routes_from_annotations(string $class_name)`

Note: This must be called BEFORE the container is compiled (usually in bootstrap.php).

Why the container constraint matters:

In "build" time, ContainerBuilder is mutable, so services/routes can be added.
After compilation, the container becomes immutable for performance.

Parameters

string

$class_name

the class to scan

Return Value

void

at line 255
`static object dispatch(object $event)`

Dispatch an event or signal through the framework's event dispatcher.

This is the primary mechanism for reactive communication within the framework, following ADR-0005.

Parameters

object

$event

The event object (signal) to dispatch

Return Value

object

The dispatched event object

at line 263
`static void add_filter(string $tag, callable $callback, int $priority = 10, int $args = 1)`

Parameters

string	$tag
callable	$callback
int	$priority
int	$args

Return Value

void

at line 271
`static mixed apply_filters(string $tag, mixed $value, mixed ...$args)`

Apply synchronous MIDDAG filter hooks.

Parameters

string	$tag
mixed	$value
mixed	...$args

Return Value

mixed

at line 279
`static void add_action(string $tag, callable $callback, int $priority = 10, int $args = 1)`

Parameters

string	$tag
callable	$callback
int	$priority
int	$args

Return Value

void

at line 287
`static void do_action(string $tag, mixed ...$args)`

Execute synchronous MIDDAG action hooks.

Parameters

string	$tag
mixed	...$args

at line 367
`static bool is_production()`

Check if running in production environment.

Return Value

bool

middag

Constants

Methods

Details

at line 90 static middag get_instance()

Return Value

at line 104 static void init()

Return Value

at line 114 static void shutdown()

Return Value

at line 129 static void handle()

Return Value

at line 146 static object get(string $id)

Parameters

Return Value

at line 162 static router_interface routing()

Return Value

at line 179 static moodle_url url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Parameters

Return Value

at line 200 static moodle_url webhook_url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

Parameters

Return Value

Exceptions

at line 218 static void register_route(string $name, string $path, string $controller_class, string $method, array $requirements = [])

Parameters

Return Value

at line 240 static void register_routes_from_annotations(string $class_name)

Parameters

Return Value

at line 255 static object dispatch(object $event)

Parameters

Return Value

at line 263 static void add_filter(string $tag, callable $callback, int $priority = 10, int $args = 1)

Parameters

Return Value

at line 271 static mixed apply_filters(string $tag, mixed $value, mixed ...$args)

Parameters

Return Value

at line 279 static void add_action(string $tag, callable $callback, int $priority = 10, int $args = 1)

Parameters

Return Value

at line 287 static void do_action(string $tag, mixed ...$args)

Parameters

Return Value

at line 297 static string get_component_name()

Return Value

at line 307 static string get_docs_url()

Return Value

at line 317 static string get_site_url()

Return Value

at line 327 static string get_support_url()

Return Value

at line 337 static string get_middagplugins_overview_url()

Return Value

at line 347 static bool is_testing()

Return Value

at line 357 static bool is_development()

Return Value

at line 367 static bool is_production()

Return Value

at line 90
`static middag get_instance()`

at line 104
`static void init()`

at line 114
`static void shutdown()`

at line 129
`static void handle()`

at line 146
`static object get(string $id)`

at line 162
`static router_interface routing()`

at line 179
`static moodle_url url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)`

at line 200
`static moodle_url webhook_url_generator(string $route, array $parameters = [], int $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)`

at line 218
`static void register_route(string $name, string $path, string $controller_class, string $method, array $requirements = [])`

at line 240
`static void register_routes_from_annotations(string $class_name)`

at line 255
`static object dispatch(object $event)`

at line 263
`static void add_filter(string $tag, callable $callback, int $priority = 10, int $args = 1)`

at line 271
`static mixed apply_filters(string $tag, mixed $value, mixed ...$args)`

at line 279
`static void add_action(string $tag, callable $callback, int $priority = 10, int $args = 1)`

at line 287
`static void do_action(string $tag, mixed ...$args)`

at line 297
`static string get_component_name()`

at line 307
`static string get_docs_url()`

at line 317
`static string get_site_url()`

at line 327
`static string get_support_url()`

at line 337
`static string get_middagplugins_overview_url()`

at line 347
`static bool is_testing()`

at line 357
`static bool is_development()`

at line 367
`static bool is_production()`