Bristol SU Support Package
Public Member Functions | List of all members
BristolSU\Support\Connection\Contracts\ConnectorStore Interface Reference
Inheritance diagram for BristolSU\Support\Connection\Contracts\ConnectorStore:
Inheritance graph
[legend]

Public Member Functions

 registerConnector (RegisteredConnector $connector)
 
 register (string $name, string $description, string $alias, string $service, string $connector)
 
 get (string $alias)
 
 all ()
 

Detailed Description

Stores information about registered connectors

Definition at line 10 of file ConnectorStore.php.

Member Function Documentation

◆ all()

BristolSU\Support\Connection\Contracts\ConnectorStore::all ( )

Return all registered connectors

Returns
RegisteredConnector[]

Implemented in BristolSU\Support\Connection\ConnectorStore.

◆ get()

BristolSU\Support\Connection\Contracts\ConnectorStore::get ( string  $alias)

Get a registered connector by alias

Parameters
string$aliasAlias of the registered connector
Returns
RegisteredConnector
Exceptions

Implemented in BristolSU\Support\Connection\ConnectorStore.

◆ register()

BristolSU\Support\Connection\Contracts\ConnectorStore::register ( string  $name,
string  $description,
string  $alias,
string  $service,
string  $connector 
)

Register a new connector

Parameters
string$nameName of the connector
string$descriptionDescription for the connector
string$aliasUnique alias of the connector
string$serviceAlias of the service
string$connectorConnector class name

Implemented in BristolSU\Support\Connection\ConnectorStore.

◆ registerConnector()

BristolSU\Support\Connection\Contracts\ConnectorStore::registerConnector ( RegisteredConnector  $connector)

Register a new connector from a RegisteredConnector class

Parameters
RegisteredConnector$connectorRegistered connector

Implemented in BristolSU\Support\Connection\ConnectorStore.


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