com\setasign\SetaSite\Module

ModuleInterface Interface ModuleInterface

File: /SetaSite/src/Module/ModuleInterface.php

You mustn't inject Users, Pages or SessionContext in the constructor and the last arguments must be: [Config $config]

Implemented in

Summary

Methods

getConfig()

abstract public ModuleInterface::getConfig (
void
): \com\setasign\SetaFramework\Config\Config

Returns the configuration of the module.

getControllerName()

abstract public ModuleInterface::getControllerName (
string $controllerName
): string

Must resolve $controllerName to a fully qualified class name. It doesn't matter whether the controller really exists.

Parameters
$controllerName : string
 

getModuleDirectory()

abstract public ModuleInterface::getModuleDirectory (
void
): string

Path to module dir, usally equal to DIR

getSession()

abstract public ModuleInterface::getSession (
void
): \com\setasign\SetaFramework\Session\SessionInterface

Returns the session for the module.

lookupFile()

abstract public ModuleInterface::lookupFile (
string $filePath
): \com\setasign\SetaFramework\FileSystem\File

Lookup a file for external access like css files.

Parameters
$filePath : string
 
Exceptions

Throws \com\setasign\SetaSite\FileSystem\InvalidPathException