Announce
- Full name:
\EnvisionPortal\Modules\Announce - This class implements:
\EnvisionPortal\ModuleInterface
Properties
fields
private $fields
Methods
__invoke
Invoke the module with an array of fields.
public __invoke(array $fields): mixed
Parameters:
| Parameter | Type | Description |
|---|---|---|
$fields | array | An array of fields to process. |
__toString
Convert the module to its HTML representation.
public __toString(): string
Return Value:
The HTML representation of the module.
getDefaultProperties
Get the default properties of the module.
public getDefaultProperties(): array
Return Value:
The default properties of the module.
Inherited methods
error
Generates an error message.
public error(string $type = 'error', string $error_type = 'general', bool $log_error = false): string
Parameters:
| Parameter | Type | Description |
|---|---|---|
$type | string | The type of error message. |
$error_type | string | The type of error. |
$log_error | bool | Whether to log the error. |
Return Value:
The error message.
captureOutput
Captures the output of a callback function.
private captureOutput(callable $callback, mixed $args): string
Parameters:
| Parameter | Type | Description |
|---|---|---|
$callback | callable | The callback function to execute. |
$args | mixed | Optional arguments to pass to the callback. |
Return Value:
The captured output.
Automatically generated on 2024-05-12