Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ContainerResource

Fonctions membres publiques

 __construct (Container $container, $value, int $mode=0)
 
 isShared ()
 
 isProtected ()
 
 getInstance ()
 
 getFactory ()
 
 reset ()
 

Champs de données

const NO_SHARE = 0
 
const SHARE = 1
 
const NO_PROTECT = 0
 
const PROTECT = 2
 

Attributs privés

 $container
 
 $instance
 
 $factory
 
 $shared = false
 
 $protected = false
 

Description détaillée

Defines the representation of a resource.

Depuis
2.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Container  $container,
  $value,
int  $mode = 0 
)

Create a resource representation

Paramètres
Container$containerThe container
mixed$valueThe resource or its factory closure
integer$modeResource mode, defaults to Resource::NO_SHARE | Resource::NO_PROTECT
Depuis
2.0.0

Références ContainerResource\$container, $mode, et $value.

Documentation des fonctions membres

◆ getFactory()

getFactory ( )

Get the factory

Renvoie
callable
Depuis
2.0.0

Références ContainerResource\$factory.

◆ getInstance()

getInstance ( )

Get an instance of the resource

If a factory was provided, the resource is created and - if it is a shared resource - cached internally. If the resource was provided directly, that resource is returned.

Renvoie
mixed
Depuis
2.0.0

Références ContainerResource\$factory, ContainerResource\$instance, ContainerResource\isShared(), et null.

◆ isProtected()

isProtected ( )

Check whether the resource is protected

Renvoie
boolean
Depuis
2.0.0

Références ContainerResource\$protected.

Référencé par ContainerResource\reset().

◆ isShared()

isShared ( )

Check whether the resource is shared

Renvoie
boolean
Depuis
2.0.0

Références ContainerResource\$shared.

Référencé par ContainerResource\getInstance(), et ContainerResource\reset().

◆ reset()

reset ( )

Reset the resource

The instance cache is cleared, so that the next call to get() returns a new instance. This has an effect on shared, non-protected resources only.

Renvoie
boolean True if the resource was reset, false otherwise
Depuis
2.0.0

Références ContainerResource\isProtected(), ContainerResource\isShared(), et null.

Documentation des champs

◆ $container

$container
private

◆ $factory

$factory
private

◆ $instance

$instance
private

◆ $protected

$protected = false
private

◆ $shared

$shared = false
private

Référencé par ContainerResource\isShared().

◆ NO_PROTECT

const NO_PROTECT = 0

Defines the resource as non-protected

integer

Depuis
2.0.0

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

◆ NO_SHARE

const NO_SHARE = 0

Defines the resource as non-shared

integer

Depuis
2.0.0

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

◆ PROTECT

const PROTECT = 2

Defines the resource as protected

integer

Depuis
2.0.0

Référencé par Container\getResource(), et Container\set().

◆ SHARE

const SHARE = 1

Defines the resource as shared

integer

Depuis
2.0.0

Référencé par Container\getResource(), et Container\set().


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