Index

  1. \com\setasign\SetaFramework
    1. Application
      1. AbstractApplication
      2. AbstractHttpApplication
      3. ApplicationConfig
      4. ApplicationDi
      5. ApplicationInterface
      6. ApplicationManager
      7. HttpApplicationInterface

com\setasign\SetaFramework\Application

ApplicationDi Class ApplicationDi

File: /SetaFramework/src/Application/ApplicationDi.php

Class hierarchy

Summary

Methods

Properties

Properties

$aliases

protected array \com\setasign\SetaFramework\Di\Di::$aliases = array()

An array of aliases configurations

$configures

protected array \com\setasign\SetaFramework\Di\Di::$configures = array()

An array of classes/interfaces configurations

$instances

protected array<string, null|object> \com\setasign\SetaFramework\Di\Di::$instances = array()

An internal cache of singleton instances


Methods

__construct()

public ApplicationDi::__construct ()

ApplicationDi constructor.

Parameters
$application : ApplicationInterface
 
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

__sleep()

public \com\setasign\SetaFramework\Di\Di::__sleep (
void
): array

__wakeup()

public \com\setasign\SetaFramework\Di\Di::__wakeup (
void
): void

addAlias()

public \com\setasign\SetaFramework\Di\Di::addAlias (
string $name,
string|callable $classNameOrCallback,
array $params = array ( ),
bool $singleton = true
): self

Add an alias configuration

Parameters
$name : string
 
$classNameOrCallback : string|callable
 
$params : array
 
$singleton : bool
 
Exceptions

Throws \com\setasign\SetaFramework\Di\AlreadyDefinedException

addAliasWithInstancedObject()

public \com\setasign\SetaFramework\Di\Di::addAliasWithInstancedObject (
string $name,
?object $instance
): self
Parameters
$name : string
 
$instance : ?object
 

call()

public \com\setasign\SetaFramework\Di\Di::call (
callable $callable,
array $parameters = array ( )
): ?mixed

Call the callable and autowire the params.

Parameters
$callable : callable
 
$parameters : array
 
Return Values

Result of the callable

Exceptions

Throws \ReflectionException

callNewInstance()

public \com\setasign\SetaFramework\Di\Di::callNewInstance (
\com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T> $className,
array $parameters = array ( )
): \com\setasign\SetaFramework\Di\T

Create a new instance of $className and autowire the params.

Parameters
$className : \com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T>
 
$parameters : array
 
Exceptions

Throws \ReflectionException

clearInstance()

public \com\setasign\SetaFramework\Di\Di::clearInstance (
string $classNameOrAlias
): self
Parameters
$classNameOrAlias : string
 

configure()

public \com\setasign\SetaFramework\Di\Di::configure (
string $className,
array $params = array ( ),
bool $singleton = true
): self

Add a class/interface configuration

Parameters
$className : string
 
$params : array
 
$singleton : bool
 
Exceptions

Throws \com\setasign\SetaFramework\Di\AlreadyDefinedException

createView()

protected ApplicationDi::createView (): \com\setasign\SetaFramework\View\View
Parameters
$application : HttpApplicationInterface
 

createViewTwigEnvironment()

protected ApplicationDi::createViewTwigEnvironment (): \com\setasign\SetaFramework\Controller\ViewTwigEnvironment
Parameters
$application : ApplicationInterface
 
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 
$applicationConfig : ApplicationConfig
 
$domainName : \com\setasign\SetaFramework\Bootstrap\DomainName
 

get()

public \com\setasign\SetaFramework\Di\Di::get (
string|\com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T> $classNameOrAlias,
array $params = array ( ),
?bool $singleton = null
): object|\com\setasign\SetaFramework\Di\T

Get an instance by class name or alias.

If singleton is false, Di will create everytime a new object.

Di will remember up to one instance of every class/alias (except $singleton is false).

If you use an alias or a class that has a configuration, $params will be merged with the params of the configuration or alias.

If the di has already an instance, the $params will be ignored because no new object is created.

Parameters
$classNameOrAlias : string|\com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T>
 
$params : array
 
$singleton : ?bool

Use null to use the configured value, or true/false to affect this behaviour

Exceptions

Throws \com\setasign\SetaFramework\Di\UnknownClassOrAliasException if alias wasn't found.

Throws \com\setasign\SetaFramework\Di\DiClassConstructionException if an exception occurs on constructing a new instance.

Throws \com\setasign\SetaFramework\Bootstrap\MaintenanceException

getArguments()

private \com\setasign\SetaFramework\Di\Di::getArguments (
array<string, \com\setasign\SetaFramework\Di\ReflectionParameter> $reflectionParameters,
array $parameters
): array
Parameters
$reflectionParameters : array<string, \com\setasign\SetaFramework\Di\ReflectionParameter>
 
$parameters : array
 

getByAlias()

private \com\setasign\SetaFramework\Di\Di::getByAlias (
string $name,
array $params,
?bool $singleton
): ?object

Get an instance by an alias

If the alias is definied to be a singleton the $params array is ignored if the instance was already created.

Parameters
$name : string
 
$params : array
 
$singleton : ?bool

Use null to use the configured value, or true/false to affect this behaviour

Exceptions

Throws \com\setasign\SetaFramework\Di\UnknownClassOrAliasException if alias wasn't found.

Throws \com\setasign\SetaFramework\Di\DiClassConstructionException if an exception occurs on constructing a new instance.

Throws \com\setasign\SetaFramework\Bootstrap\MaintenanceException

getByClassName()

private \com\setasign\SetaFramework\Di\Di::getByClassName (
\com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T> $className,
array $params,
?bool $singleton
): \com\setasign\SetaFramework\Di\T

Get an instance by a class name

If the class is definied to be a singleton the $params array is ignored if the instance was already created.

Parameters
$className : \com\setasign\SetaFramework\Di\class-string<\com\setasign\SetaFramework\Di\T>
 
$params : array
 
$singleton : ?bool

Use null to use the configured value, or true/false to affect this behaviour

Exceptions

Throws \com\setasign\SetaFramework\Di\UnknownClassOrAliasException if alias wasn't found.

Throws \com\setasign\SetaFramework\Di\DiClassConstructionException if an exception occurs on constructing a new instance.

Throws \com\setasign\SetaFramework\Bootstrap\MaintenanceException

getDatabaseConnectionManager()

protected ApplicationDi::getDatabaseConnectionManager (): \com\setasign\SetaFramework\Database\DatabaseConnectionManager
Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

getEventManager()

protected ApplicationDi::getEventManager (): \com\setasign\SetaFramework\EventManager\EventManager
Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

getReflectionParameters()

private \com\setasign\SetaFramework\Di\Di::getReflectionParameters (
array{0: \com\setasign\SetaFramework\Di\class-string|object, 1: string}|callable $callable
): array
Parameters
$callable : array{0: \com\setasign\SetaFramework\Di\class-string|object, 1: string}|callable
 
Exceptions

Throws \ReflectionException

hasAlias()

public \com\setasign\SetaFramework\Di\Di::hasAlias (
string $name
): bool

Checks whether the di contains a alias with this name

Parameters
$name : string
 

hasConfiguration()

public \com\setasign\SetaFramework\Di\Di::hasConfiguration (
string $className
): bool

Checks whether the di has a configuration for this class

Parameters
$className : string
 

hasInstance()

public \com\setasign\SetaFramework\Di\Di::hasInstance (
string $aliasOrClassname
): bool

Checks whether the di has an instance for this alias or className

Parameters
$aliasOrClassname : string
 

init()

protected ApplicationDi::init (
void
): void

parentInjections()

public \com\setasign\SetaFramework\Di\Di::parentInjections (
string $parentClassName,
array $parameters = array ( )
): array
Parameters
$parentClassName : string
 
$parameters : array
 
Exceptions

Throws \ReflectionException

prepareParams()

private \com\setasign\SetaFramework\Di\Di::prepareParams (
array $params,
array $defaultParams = array ( )
): array

Prepares inject parameters

Internally aliases will be automatically resolved.

Parameters
$params : array
 
$defaultParams : array
 
Exceptions

Throws \com\setasign\SetaFramework\Di\UnknownClassOrAliasException

purgeName()

protected \com\setasign\SetaFramework\Di\Di::purgeName (
string $name
): string
Parameters
$name : string
 

remove()

public \com\setasign\SetaFramework\Di\Di::remove (
string $classNameOrAlias
): self

Removes all added configurations, aliases and instances with this name.

Parameters
$classNameOrAlias : string
 

setupApplicationCacheHandler()

protected ApplicationDi::setupApplicationCacheHandler (): \com\setasign\SetaFramework\SimpleCache\ApplicationCacheHandler
Parameters
$cacheHandler : \com\setasign\SetaFramework\SimpleCache\CacheHandler
 
$application : HttpApplicationInterface
 

setupApplicationLogHandler()

protected ApplicationDi::setupApplicationLogHandler (): \com\setasign\SetaFramework\Log\ApplicationLogHandler
Parameters
$logHandler : \com\setasign\SetaFramework\Log\LogHandler
 
$application : HttpApplicationInterface
 

setupCacheHandler()

protected ApplicationDi::setupCacheHandler (): \com\setasign\SetaFramework\SimpleCache\CacheHandler
Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

setupLogHandler()

protected ApplicationDi::setupLogHandler (): \com\setasign\SetaFramework\Log\LogHandler
Parameters
$bootstrap : \com\setasign\SetaFramework\Bootstrap\Bootstrap
 

© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)