\duncan3dc\Sonos\DevicesCollection

Summary

Methods

Properties

Constants

__construct()
addDevice()
addIp()
getDevices()
clear()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$factory
$devices

N/A

final

File: Devices/Collection.php
Package: Default
Class hierarchy: \duncan3dc\Sonos\Devices\Collection
Implements: \duncan3dc\Sonos\Interfaces\Devices\CollectionInterface
Uses traits: \duncan3dc\Log\LoggerAwareTrait

Properties

$factory

$factory : \duncan3dc\Sonos\Interfaces\Devices\FactoryInterface

Type

\duncan3dc\Sonos\Interfaces\Devices\FactoryInterface — The factory to create new devices from

$devices

$devices : array<mixed,\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface>

Type

array<mixed,\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface> — The devices that are in this collection.

Methods

__construct()

__construct(\duncan3dc\Sonos\Interfaces\Devices\FactoryInterface  $factory)

Create a new instance.

Parameters

\duncan3dc\Sonos\Interfaces\Devices\FactoryInterface

$factory

The factory to create new devices from

addDevice()

addDevice(\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface  $device) : $this

Add a device to this collection.

Parameters

\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface

$device

The device to add

Returns

$this

addIp()

addIp(string  $address) : $this

Add a device to this collection using its IP address

Parameters

string

$address

The IP address of the device to add

Returns

$this

getDevices()

getDevices() : array<mixed,\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface>

Get all of the devices in this collection.

Returns

array<mixed,\duncan3dc\Sonos\Interfaces\Devices\DeviceInterface>

clear()

clear() : $this

Remove all devices from this collection.

Returns

$this