BristolSU\Support\Connection\Contracts\ServiceRequest Interface Reference

Inheritance diagram for BristolSU\Support\Connection\Contracts\ServiceRequest:

Public Member Functions
	required (string $alias, array $services=[])
	optional (string $alias, array $services=[])
	getRequired (string $alias)
	getOptional (string $alias)
	getAllRequired ()
	getAllOptional ()

Detailed Description

An object for making requests to get a service

Definition at line 8 of file ServiceRequest.php.

Member Function Documentation

getAllOptional()

BristolSU\Support\Connection\Contracts\ServiceRequest::getAllOptional

(

)

Get all optional services from all modules

Returns

array ['module_alias' => ['typeform', 'facebook', ...], ...]

Implemented in BristolSU\Support\Connection\ServiceRequest.

getAllRequired()

BristolSU\Support\Connection\Contracts\ServiceRequest::getAllRequired

(

)

Get all required services from all modules

Returns

array ['module_alias' => ['typeform', 'facebook', ...], ...]

Implemented in BristolSU\Support\Connection\ServiceRequest.

getOptional()

BristolSU\Support\Connection\Contracts\ServiceRequest::getOptional

(

string

$alias

)

Get all optional services for a module

Parameters

string

$alias

Alias of the module

Returns

array Array of optional services e.g. ['typeform', 'facebook']

Implemented in BristolSU\Support\Connection\ServiceRequest.

getRequired()

BristolSU\Support\Connection\Contracts\ServiceRequest::getRequired

(

string

$alias

)

Get all required services for a module

Parameters

string

$alias

Alias of the module

Returns

array Array of services required e.g. ['typeform', 'facebook']

Implemented in BristolSU\Support\Connection\ServiceRequest.

optional()

BristolSU\Support\Connection\Contracts\ServiceRequest::optional	(	string	$alias,
		array	$services = []
	)

Request an optional service.

Parameters

string	$alias	Alias of the module requesting the service
array	$services	An array of services that are optional but useable

Returns

void

Implemented in BristolSU\Support\Connection\ServiceRequest.

required()

BristolSU\Support\Connection\Contracts\ServiceRequest::required	(	string	$alias,
		array	$services = []
	)

Request a required service.

Parameters

string	$alias	Alias of the module requesting the service
array	$services	An array of services that are required

Returns

void

Implemented in BristolSU\Support\Connection\ServiceRequest.

---

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

• src/Connection/Contracts/ServiceRequest.php