Abstract Class AbstractModule in namespace com\setasign\SetaSite\Module in SetaSite API Reference

Index

\com\setasign\SetaSite
1. Module

com\setasign\SetaSite\Module

AbstractModule Interface ModuleInterface

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

Class hierarchy

AbstractModule

Implements

ModuleInterface

Summary

Constants

PROVIDED_FILES

protected const AbstractModule::PROVIDED_FILES = array ( )

Properties

$config

private \com\setasign\SetaFramework\Config\Config AbstractModule::$config

$session

private ?\com\setasign\SetaFramework\Session\Session AbstractModule::$session

$setasite

protected \com\setasign\SetaSite\SetaSite AbstractModule::$setasite

Methods

__construct()

public AbstractModule::__construct (

\com\setasign\SetaSite\SetaSite $setasite,
\com\setasign\SetaFramework\Config\Config $config

)

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

Parameters

$setasite : \com\setasign\SetaSite\SetaSite
$config : \com\setasign\SetaFramework\Config\Config

Exceptions

Throws ModuleDisabledException

getConfig()

public AbstractModule::getConfig (

void

): \com\setasign\SetaFramework\Config\Config

getControllerName()

public AbstractModule::getControllerName (

string $controllerName

): string

Parameters

$controllerName : string

getModuleDirectory()

abstract public ModuleInterface::getModuleDirectory (

void

): string

Path to module dir, usally equal to DIR

getSession()

public AbstractModule::getSession (

void

): \com\setasign\SetaFramework\Session\SessionInterface

lookupFile()

public AbstractModule::lookupFile (

string $file

): \com\setasign\SetaFramework\FileSystem\File

Parameters

$file : string

Exceptions

Throws \com\setasign\SetaSite\FileSystem\InvalidPathException