Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Container

Fonctions membres publiques

 __construct (Container $parent=null)
 
 alias ($alias, $key)
 
 buildObject ($key, $shared=false)
 
 buildSharedObject ($key)
 
 createChild ()
 
 extend ($key, \Closure $callable)
 
 set ($key, $value, $shared=false, $protected=false)
 
 protect ($key, $callback, $shared=false)
 
 share ($key, $callback, $protected=false)
 
 get ($key, $forceNew=false)
 
 exists ($key)
 
 getNewInstance ($key)
 
 registerServiceProvider (ServiceProviderInterface $provider)
 

Fonctions membres protégées

 resolveAlias ($key)
 
 getMethodArgs (\ReflectionMethod $method)
 
 getRaw ($key)
 

Attributs protégés

 $aliases = array()
 
 $instances = array()
 
 $dataStore = array()
 
 $parent
 

Description détaillée

The Container class.

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Container  $parent = null)

Constructor for the DI Container

Paramètres
Container$parentParent for hierarchical containers.
Depuis
1.0

Références Container\$parent, et parent.

Documentation des fonctions membres

◆ alias()

alias (   $alias,
  $key 
)

Create an alias for a given key for easy access.

Paramètres
string$aliasThe alias name
string$keyThe key to alias
Renvoie
Container This object for chaining.
Depuis
1.0

Références $key.

◆ buildObject()

buildObject (   $key,
  $shared = false 
)

Build an object of class $key;

Paramètres
string$keyThe class name to build.
boolean$sharedTrue to create a shared resource.
Renvoie
object|false Instance of class specified by $key with all dependencies injected. Returns an object if the class exists and false otherwise
Depuis
1.0

Références $key, Container\getMethodArgs(), et null.

Référencé par Container\buildSharedObject(), et Container\getMethodArgs().

◆ buildSharedObject()

buildSharedObject (   $key)

Convenience method for building a shared object.

Paramètres
string$keyThe class name to build.
Renvoie
object|false Instance of class specified by $key with all dependencies injected. Returns an object if the class exists and false otherwise
Depuis
1.0

Références $key, et Container\buildObject().

◆ createChild()

createChild ( )

Create a child Container with a new property scope that that has the ability to access the parent scope when resolving.

Renvoie
Container This object for chaining.
Depuis
1.0

◆ exists()

exists (   $key)

Method to check if specified dataStore key exists.

Paramètres
string$keyName of the dataStore key to check.
Renvoie
boolean True for success
Depuis
1.0

Références $key, Container\getRaw(), et Container\resolveAlias().

◆ extend()

extend (   $key,
\Closure  $callable 
)

Extend a defined service Closure by wrapping the existing one with a new Closure. This works very similar to a decorator pattern. Note that this only works on service Closures that have been defined in the current Provider, not parent providers.

Paramètres
string$keyThe unique identifier for the Closure or property.
\Closure$callableA Closure to wrap the original service Closure.
Renvoie
void
Depuis
1.0
Exceptions

Références $key, Container\getRaw(), null, et Container\resolveAlias().

◆ get()

get (   $key,
  $forceNew = false 
)

Method to retrieve the results of running the $callback for the specified $key;

Paramètres
string$keyName of the dataStore key to get.
boolean$forceNewTrue to force creation and return of a new instance.
Renvoie
mixed Results of running the $callback for the specified $key.
Depuis
1.0
Exceptions

Références $key, Container\getRaw(), null, et Container\resolveAlias().

◆ getMethodArgs()

getMethodArgs ( \ReflectionMethod  $method)
protected

Build an array of constructor parameters.

Paramètres
\ReflectionMethod$methodMethod for which to build the argument array.
Renvoie
array Array of arguments to pass to the method.
Depuis
1.0
Exceptions
DependencyResolutionException

Références $param, Container\buildObject(), Container\getRaw(), et null.

Référencé par Container\buildObject().

◆ getNewInstance()

getNewInstance (   $key)

Method to force the container to return a new instance of the results of the callback for requested $key.

Paramètres
string$keyName of the dataStore key to get.
Renvoie
mixed Results of running the $callback for the specified $key.
Depuis
1.0

Références $key.

◆ getRaw()

getRaw (   $key)
protected

Get the raw data assigned to a key.

Paramètres
string$keyThe key for which to get the stored item.
Renvoie
mixed
Depuis
1.0

Références $key, null, parent, et Container\resolveAlias().

Référencé par Container\exists(), Container\extend(), Container\get(), et Container\getMethodArgs().

◆ protect()

protect (   $key,
  $callback,
  $shared = false 
)

Convenience method for creating protected keys.

Paramètres
string$keyName of dataStore key to set.
callable$callbackCallable function to run when requesting the specified $key.
bool$sharedTrue to create and store a shared instance.
Renvoie
Container This object for chaining.
Depuis
1.0

Références $key.

◆ registerServiceProvider()

registerServiceProvider ( ServiceProviderInterface  $provider)

Register a service provider to the container.

Paramètres
ServiceProviderInterface$providerThe service provider to register.
Renvoie
Container This object for chaining.
Depuis
1.0

Références ServiceProviderInterface\register().

◆ resolveAlias()

resolveAlias (   $key)
protected

Search the aliases property for a matching alias key.

Paramètres
string$keyThe key to search for.
Renvoie
string
Depuis
1.0

Références $key, et parent.

Référencé par Container\exists(), Container\extend(), Container\get(), et Container\getRaw().

◆ set()

set (   $key,
  $value,
  $shared = false,
  $protected = false 
)

Method to set the key and callback to the dataStore array.

Paramètres
string$keyName of dataStore key to set.
mixed$valueCallable function to run or string to retrive when requesting the specified $key.
boolean$sharedTrue to create and store a shared instance.
boolean$protectedTrue to protect this item from being overwritten. Useful for services.
Renvoie
Container This object for chaining.
Exceptions

Références $key, et $value.

◆ share()

share (   $key,
  $callback,
  $protected = false 
)

Convenience method for creating shared keys.

Paramètres
string$keyName of dataStore key to set.
callable$callbackCallable function to run when requesting the specified $key.
bool$protectedTrue to create and store a shared instance.
Renvoie
Container This object for chaining.
Depuis
1.0

Références $key.

Documentation des champs

◆ $aliases

array $aliases = array()
protected

Holds the key aliases.

Depuis
1.0

◆ $dataStore

array $dataStore = array()
protected

Holds the keys, their callbacks, and whether or not the item is meant to be a shared resource.

Depuis
1.0

◆ $instances

array $instances = array()
protected

Holds the shared instances.

Depuis
1.0

◆ $parent

$parent
protected

Référencé par Container\__construct().


La documentation de cette classe a été générée à partir du fichier suivant :