PHP Class Phue\Scene

Show file Open project: sqmk/phue

Protected Properties

Property	Type	Description
$attributes	stdClass	Scene attributes
$client	Client	Phue client
$id	integer	Id

Public Methods

Method	Description
__construct ( string $id, stdClass $attributes, Client $client )	Construct a Phue Scene object
__toString ( ) : string	__toString
getId ( ) : integer	Get scene Id
getLightIds ( ) : array	Get light ids
getName ( ) : string	Get assigned name of scene
isActive ( ) : null	Is active

Method Details

__construct() public method

Construct a Phue Scene object

public __construct ( string $id, stdClass $attributes, Client $client )
$id	string	Id
$attributes	stdClass	Scene attributes
$client	Client	Phue client

__toString() public method

__toString

public __toString ( ) : string
return	string	Scene Id

getId() public method

Get scene Id

public getId ( ) : integer
return	integer	Scene id

getLightIds() public method

Get light ids

public getLightIds ( ) : array
return	array	List of light ids

getName() public method

Get assigned name of scene

public getName ( ) : string
return	string	Name of scene

isActive() public method

Is active

Deprecation:

public isActive ( ) : null
return	null	This is now deprecated

Property Details

$attributes protected property

Scene attributes

protected stdClass $attributes
return	stdClass

$client protected property

Phue client

protected Client,phue $client
return	Client

$id protected property

Id

protected int $id
return	integer