PHP Class Phue\Schedule

Afficher le fichier Open project: sqmk/phue

Protected Properties

Свойство	Type	Description
$attributes	stdClass	Schedule attributes
$client	Client	Phue client
$id	integer	Id

Méthodes publiques

Méthode	Description
__construct ( integer $id, stdClass $attributes, Client $client )	Construct a Phue Schedule object
__toString ( ) : string	__toString
delete ( )	Delete schedule
getCommand ( ) : array	Get command
getDescription ( ) : string	Get description
getId ( ) : integer	Get schedule Id
getName ( ) : string	Get assigned name of Schedule
getStatus ( ) : string	Get status
getTime ( ) : string	Get scheduled time
isAutoDeleted ( ) : boolean	Is auto deleted?
isEnabled ( ) : boolean	Is schedule enabled.
setAutoDelete ( boolean $flag ) : self	Set auto delete
setCommand ( Phue\Command\ActionableInterface $command ) : self	Set command
setDescription ( string $description ) : self	Set description
setName ( string $name ) : self	Set name of schedule
setStatus ( string $status ) : self	Set status.
setTime ( string $time ) : self	Set time

Method Details

__construct() public méthode

Construct a Phue Schedule object

public __construct ( integer $id, stdClass $attributes, Client $client )
$id	integer	Id
$attributes	stdClass	Schedule attributes
$client	Client	Phue client

__toString() public méthode

__toString

public __toString ( ) : string
Résultat	string	Schedule Id

delete() public méthode

Delete schedule

public delete ( )

getCommand() public méthode

Get command

public getCommand ( ) : array
Résultat	array	Command attributes

getDescription() public méthode

Get description

public getDescription ( ) : string
Résultat	string	Description of Schedule

getId() public méthode

Get schedule Id

public getId ( ) : integer
Résultat	integer	Schedule id

getName() public méthode

Get assigned name of Schedule

public getName ( ) : string
Résultat	string	Name of Schedule

getStatus() public méthode

Get status

public getStatus ( ) : string
Résultat	string	Get status.

getTime() public méthode

Get scheduled time

public getTime ( ) : string
Résultat	string	Time of schedule

isAutoDeleted() public méthode

Is auto deleted?

public isAutoDeleted ( ) : boolean
Résultat	boolean	True if auto delete, false if not

isEnabled() public méthode

Is schedule enabled.

public isEnabled ( ) : boolean
Résultat	boolean	True if enabled, false if not.

setAutoDelete() public méthode

Set auto delete

public setAutoDelete ( boolean $flag ) : self
$flag	boolean	True to auto delete, false if not
Résultat	self	This object

setCommand() public méthode

Set command

public setCommand ( Phue\Command\ActionableInterface $command ) : self
$command	Phue\Command\ActionableInterface	Actionable command
Résultat	self	This object

setDescription() public méthode

Set description

public setDescription ( string $description ) : self
$description	string
Résultat	self	This object

setName() public méthode

Set name of schedule

public setName ( string $name ) : self
$name	string
Résultat	self	This object

setStatus() public méthode

Set status.

public setStatus ( string $status ) : self
$status	string	Status.
Résultat	self	This object

setTime() public méthode

Set time

public setTime ( string $time ) : self
$time	string	Time
Résultat	self	This object

Property Details

$attributes protected_oe property

Schedule attributes

protected stdClass $attributes
Résultat	stdClass

$client protected_oe property

Phue client

protected Client,phue $client
Résultat	Client

$id protected_oe property

protected int $id
Résultat	integer