PHP Класс Phue\Client

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$host string Host address
$transport Phue\Transport\TransportInterface Transport
$username string Username

Открытые методы

Метод Описание
__construct ( string $host, string $username = null ) Construct a Phue Client
getBridge ( ) : Bridge Get bridge
getGroups ( ) : Group[] Get groups
getHost ( ) : string Get host
getLights ( ) : Light[] Get lights
getRules ( ) : Rule[] Get rules
getScenes ( ) : Scene[] Get scenes
getSchedules ( ) : Schedule[] Get schedules
getSensors ( ) : Sensor[] Get sensors
getTimezones ( ) : array Get timezones
getTransport ( ) : Phue\Transport\TransportInterface Get transport
getUsername ( ) : string Get username
getUsers ( ) : User[] Get users
sendCommand ( Phue\Command\CommandInterface $command ) : mixed Send command to server
setHost ( string $host ) : self Set host
setTransport ( Phue\Transport\TransportInterface $transport ) : self Set transport
setUsername ( string $username ) : self Set username

Описание методов

__construct() публичный Метод

Construct a Phue Client
public __construct ( string $host, string $username = null )
$host string Host address
$username string Username

getBridge() публичный Метод

Get bridge
public getBridge ( ) : Bridge
Результат Bridge Bridge object

getGroups() публичный Метод

Get groups
public getGroups ( ) : Group[]
Результат Group[] List of Group objects

getHost() публичный Метод

Get host
public getHost ( ) : string
Результат string Host address

getLights() публичный Метод

Get lights
public getLights ( ) : Light[]
Результат Light[] List of Light objects

getRules() публичный Метод

Get rules
public getRules ( ) : Rule[]
Результат Rule[] List of Rule objects

getScenes() публичный Метод

Get scenes
public getScenes ( ) : Scene[]
Результат Scene[] List of Scene objects

getSchedules() публичный Метод

Get schedules
public getSchedules ( ) : Schedule[]
Результат Schedule[] List of Schedule objects

getSensors() публичный Метод

Get sensors
public getSensors ( ) : Sensor[]
Результат Sensor[] List of Sensor objects

getTimezones() публичный Метод

Get timezones
public getTimezones ( ) : array
Результат array List of timezones

getTransport() публичный Метод

Get transport
public getTransport ( ) : Phue\Transport\TransportInterface
Результат Phue\Transport\TransportInterface Transport

getUsername() публичный Метод

Get username
public getUsername ( ) : string
Результат string Username

getUsers() публичный Метод

Get users
public getUsers ( ) : User[]
Результат User[] List of User objects

sendCommand() публичный Метод

Send command to server
public sendCommand ( Phue\Command\CommandInterface $command ) : mixed
$command Phue\Command\CommandInterface Phue command
Результат mixed Command result

setHost() публичный Метод

Set host
public setHost ( string $host ) : self
$host string Host
Результат self This object

setTransport() публичный Метод

Set transport
public setTransport ( Phue\Transport\TransportInterface $transport ) : self
$transport Phue\Transport\TransportInterface Transport
Результат self This object

setUsername() публичный Метод

Set username
public setUsername ( string $username ) : self
$username string Username
Результат self This object

Описание свойств

$host защищенное свойство

Host address
protected string $host
Результат string

$transport защищенное свойство

Transport
protected TransportInterface,Phue\Transport $transport
Результат Phue\Transport\TransportInterface

$username защищенное свойство

Username
protected string $username
Результат string