PHP Interface Kraken\Channel\ChannelCompositeInterface

Inheritance: extends Kraken\Channel\ChannelInterface
Mostra file Open project: kraken-php/framework Interface Usage Examples

Public Methods

Method Description
existsBus ( string $name ) : boolean Check if bus exists in channel domain.
getBus ( string $name ) : Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface Return bus from channel domain or throw exception if it does not exist.
getBuses ( ) : Kraken\Channel\ChannelInterface[] | Kraken\Channel\ChannelCompositeInterface[] Return all buses existing in channel domain.
removeBus ( string $name ) : Kraken\Channel\ChannelCompositeInterface Remove bus from channel domain if it does exist.
setBus ( string $name, Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface $channel ) : Kraken\Channel\ChannelCompositeInterface Add or replace existing bus in channel domain.

Method Details

existsBus() public method

Check if bus exists in channel domain.
public existsBus ( string $name ) : boolean
$name string
return boolean

getBus() public method

Throws ResourceUndefinedException if bus is not found.
public getBus ( string $name ) : Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface
$name string
return Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface

getBuses() public method

Return all buses existing in channel domain.
public getBuses ( ) : Kraken\Channel\ChannelInterface[] | Kraken\Channel\ChannelCompositeInterface[]
return Kraken\Channel\ChannelInterface[] | Kraken\Channel\ChannelCompositeInterface[]

removeBus() public method

Remove bus from channel domain if it does exist.
public removeBus ( string $name ) : Kraken\Channel\ChannelCompositeInterface
$name string
return Kraken\Channel\ChannelCompositeInterface

setBus() public method

Add or replace existing bus in channel domain.
public setBus ( string $name, Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface $channel ) : Kraken\Channel\ChannelCompositeInterface
$name string
$channel Kraken\Channel\ChannelInterface | Kraken\Channel\ChannelCompositeInterface
return Kraken\Channel\ChannelCompositeInterface