phpDocumentor

Module
in

Interface Module

Table of Contents

adminMiddleware()  : array<string|int, mixed>|null
List of additions middleware for the admin.
apiMiddleware()  : array<string|int, mixed>|null
List of additions middleware for the REST API v3.
dependsOn()  : array<string|int, mixed>|null
List of external dependencies.
eventListeners()  : array<string|int, mixed>|null
List of event listeners.
shopMiddleware()  : array<string|int, mixed>|null
List of additions middleware for the shop.

Methods

adminMiddleware()

List of additions middleware for the admin.

public adminMiddleware() : array<string|int, mixed>|null

The list must be a one dimensional array with fqn middleware class names. (Fqn means full qualified class name). Example:

use Vendor\Library\MiddlewareOne;
use Vendor\Library\MiddlewareTwo;

$middleware = [
    MiddlewareOne::class,
    MiddlewareTwo::class,
]
Return values
array<string|int, mixed>|null —

apiMiddleware()

List of additions middleware for the REST API v3.

public apiMiddleware() : array<string|int, mixed>|null

The list must be a one dimensional array with fqn middleware class names. (Fqn means full qualified class name). Example:

use Vendor\Library\MiddlewareOne;
use Vendor\Library\MiddlewareTwo;

$middleware = [
    MiddlewareOne::class,
    MiddlewareTwo::class,
]
Return values
array<string|int, mixed>|null —

dependsOn()

List of external dependencies.

public dependsOn() : array<string|int, mixed>|null

If the module depends on any external dependencies, the must be declared here. Todo: Refine documentation.

Return values
array<string|int, mixed>|null —

eventListeners()

List of event listeners.

public eventListeners() : array<string|int, mixed>|null

The list must be a multidimensional array in the following format: (Fqn means full qualified class name). key = Fqn event class name value = numeric, one dimensional array with fqn event listener names

Example:

use Vendor\Library\FooEvent;
use Vendor\Library\FooEventListenerOne;
use Vendor\Library\FooEventListenerTwo;

$eventListeners = [
     FooEvent::class =>
         [
             FooEventListenerOne::class,
             FooEventListenerTwo::class,
         ]
]
Return values
array<string|int, mixed>|null —

shopMiddleware()

List of additions middleware for the shop.

public shopMiddleware() : array<string|int, mixed>|null

The list must be a one dimensional array with fqn middleware class names. (Fqn means full qualified class name). Example:

use Vendor\Library\MiddlewareOne;
use Vendor\Library\MiddlewareTwo;

$middleware = [
    MiddlewareOne::class,
    MiddlewareTwo::class,
]
Return values
array<string|int, mixed>|null —

Search results