1. class
  2. local_middag
  3. \
  4. framework
  5. \
  6. kernel
  7. \
  8. moodle
  9. \
  10. abstract_block

abstract_block

abstract class abstract_block implements block_interface

internal  
 

Base class for internal UI Blocks/Widgets.

NOTE: This is NOT a standard Moodle Block (block_base). It is a reusable UI component/driver used by block_middag or middag pages.

This allows the 'local' plugin to drive content dynamically into 'block_middag' without modifying the block plugin itself.

Constants

TEMPLATE

The template associated with this block.

This constant holds the name the template used to render the output of the block. If empty, a default template might be used.

Override in child classes.

Properties

protected string $title
protected array<string,mixed> $content
protected array<string,string> $attributes

Methods

void
set_title()

Logic to determine and set the block title.

string
get_title()

Get the block title, lazily loading it if empty.

array
process_content()

Main logic to fetch data for the block.

array
get_content()

Retrieves all the content of the block with memoization.

void
set_attribute(string $key, string $value)

Sets an HTML attribute for the block wrapper.

string
render()

Renders the widget using the specified template and processed content.

string
get_attributes()

Gets the attributes string safely using Moodle's html_writer.

Details

at line 66
abstract void set_title()

Logic to determine and set the block title.

Called automatically by get_title() if needed.

Return Value

void

at line 73
string get_title()

Get the block title, lazily loading it if empty.

Return Value

string

at line 87
abstract array process_content()

Main logic to fetch data for the block.

Return Value

array

at line 97
array get_content()

Retrieves all the content of the block with memoization.

Using a boolean flag ($processed) is safer than checking for empty array, as the content might legitimately be empty after processing.

Return Value

array

at line 113
void set_attribute(string $key, string $value)

Sets an HTML attribute for the block wrapper.

Parameters

string $key
string $value

Return Value

void

at line 123
string render()

Renders the widget using the specified template and processed content.

Return Value

string

Rendered HTML fragment

at line 153
protected string get_attributes()

Gets the attributes string safely using Moodle's html_writer.

This handles escaping and boolean attributes correctly.

Return Value

string

the attributes formatted for HTML