XOOPS  2.6.0
Xoops\Core\Service\Provider Class Reference
Inheritance diagram for Xoops\Core\Service\Provider:
Inheritance graph

Public Member Functions

 __construct (Manager $manager, $service)
 
 __call ($name, $arguments)
 
 getProviderMode ()
 
getRegistered ()
 
 isAvailable ()
 
 register ($object)
 
 sortProviders ()
 

Static Public Member Functions

static __callStatic ($name, $arguments)
 

Protected Attributes

 $manager = null
 
 $providers = array()
 
 $service = null
 

Detailed Description

Definition at line 51 of file Provider.php.

Constructor & Destructor Documentation

Xoops\Core\Service\Provider::__construct ( Manager  $manager,
  $service 
)

__construct

Parameters
Manager$managerManager instance
string$serviceservice name (case sensitive)

Definition at line 65 of file Provider.php.

References Xoops\Core\Service\Provider\$manager, Xoops\Core\Service\Provider\$service, and Xoops\service().

Here is the call graph for this function:

Member Function Documentation

Xoops\Core\Service\Provider::__call (   $name,
  $arguments 
)

All contract specified methods go here

Parameters
type$namemethod to call
type$argumentsany arguments
Returns
Response Response

Definition at line 159 of file Provider.php.

References $name, $response, Xoops\Core\Events\getInstance(), and Xoops\Core\Service\Provider\getProviderMode().

Here is the call graph for this function:

static Xoops\Core\Service\Provider::__callStatic (   $name,
  $arguments 
)
static

All static methods go here and will return null

Parameters
type$namenot used
type$argumentsnot used
Returns
null

Definition at line 190 of file Provider.php.

Xoops\Core\Service\Provider::getProviderMode ( )

getProviderMode

Returns
Manager MODE constant

Definition at line 76 of file Provider.php.

References Xoops\Core\Service\Manager\MODE_EXCLUSIVE.

Referenced by Xoops\Core\Service\Provider\__call().

Here is the caller graph for this function:

& Xoops\Core\Service\Provider::getRegistered ( )

getRegistered - access list of registered providers

Returns
array of registered providers managed by this instance

Definition at line 114 of file Provider.php.

References Xoops\Core\Service\Provider\$providers.

Xoops\Core\Service\Provider::isAvailable ( )

isAvailable - indicate the availability of an actual provider

In many cases a null provider can be called without changing the flow of the calling program. In some cases, the availability of a provider may need to be reflected in the caller, i.e. adding a UI button or menu item.

Returns
boolean true if actual provider is available, otherwise false

Definition at line 146 of file Provider.php.

Xoops\Core\Service\Provider::register (   $object)

registerProvider - register a provider of a named service

Parameters
string$objectinstantiated object that provides the service
Returns
void

Definition at line 97 of file Provider.php.

References Xoops\service().

Referenced by GravatarsPreload\eventCoreServiceLocateAvatar(), AvatarsPreload\eventCoreServiceLocateAvatar(), SystemPreload\eventCoreServiceLocateCountryflag(), PdfPreload\eventCoreServiceLocateHtmlToPdf(), QrcodePreload\eventCoreServiceLocateQrcode(), and ThumbsPreload\eventCoreServiceLocateThumbnail().

Here is the call graph for this function:

Here is the caller graph for this function:

Xoops\Core\Service\Provider::sortProviders ( )

sortProviders - sort providers into priority order

Returns
void

Definition at line 124 of file Provider.php.

References Xoops\Core\Service\Provider\$providers.

Member Data Documentation

Xoops\Core\Service\Provider::$manager = null
protected

Definition at line 53 of file Provider.php.

Referenced by Xoops\Core\Service\Provider\__construct().

Xoops\Core\Service\Provider::$providers = array()
protected
Xoops\Core\Service\Provider::$service = null
protected

The documentation for this class was generated from the following file: