Skip to content

Pdledit_gui

Base controller class for Modules.

Modules should extend this class, and override the methods needed. Emtpy default implementations allow Modules to only override the methods they need.

The methods defined by this class is invoked in order:

  • init()
  • post() -- only for POST requests
  • get()

Modules which emit other serialisations besides HTML (XML,JSON, etc.) should do so within the module init and/or post functions and then invoke killme() to terminate further processing.

Methods

post

Process POST requests.

public post(): mixed

This method is called if the incoming request is a POST request. It is invoked after the theme has been loaded. This method should not normally render HTML output, as processing will fall through to the GET processing if this method completes without error or stopping processing in other ways.


get

Process GET requests or the body part of POST requests.

public get(): string

This method is called directly for GET requests, and immediately after the post() method for POST requests.

It will return the module content as a HTML string.

Return Value:

HTML content for the module.


get_templates

public get_templates(): mixed

get_modules

public get_modules(): mixed

get_widgets

public get_widgets(mixed $module): mixed

Parameters:

Parameter Type Description
$module mixed

get_menus

public get_menus(): mixed

get_blocks

public get_blocks(): mixed

get_template

public get_template(mixed $pdl): mixed

Parameters:

Parameter Type Description
$pdl mixed

get_regions

public get_regions(mixed $pdl): mixed

Parameters:

Parameter Type Description
$pdl mixed

parse_region

public parse_region(mixed $pdl): mixed

Parameters:

Parameter Type Description
$pdl mixed

get_template_info

public get_template_info(string $template): array

Parameters:

Parameter Type Description
$template string the name of the template

Return Value:

with the information


get_pdl

public get_pdl(mixed $module): mixed

Parameters:

Parameter Type Description
$module mixed

Inherited methods

init

Initialize request processing.

public init(): mixed

This method is called before any other request processing, and regardless of the request method. The theme is not yet loaded when this method is invoked.


post

Process POST requests.

public post(): mixed

This method is called if the incoming request is a POST request. It is invoked after the theme has been loaded. This method should not normally render HTML output, as processing will fall through to the GET processing if this method completes without error or stopping processing in other ways.


get

Process GET requests or the body part of POST requests.

public get(): string

This method is called directly for GET requests, and immediately after the post() method for POST requests.

It will return the module content as a HTML string.

Return Value:

HTML content for the module.



Automatically generated on 2025-03-19