PHP Класс Phue\Schedule

Показать файл Открыть проект

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

Свойство Тип Описание
$attributes stdClass Schedule attributes
$client Client Phue client
$id integer Id

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

Метод Описание
__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

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

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

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() публичный Метод

__toString
public __toString ( ) : string
Результат string Schedule Id

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

Delete schedule
public delete ( )

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

Get command
public getCommand ( ) : array
Результат array Command attributes

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

Get description
public getDescription ( ) : string
Результат string Description of Schedule

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

Get schedule Id
public getId ( ) : integer
Результат integer Schedule id

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

Get assigned name of Schedule
public getName ( ) : string
Результат string Name of Schedule

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

Get status
public getStatus ( ) : string
Результат string Get status.

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

Get scheduled time
public getTime ( ) : string
Результат string Time of schedule

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

Is auto deleted?
public isAutoDeleted ( ) : boolean
Результат boolean True if auto delete, false if not

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

Is schedule enabled.
public isEnabled ( ) : boolean
Результат boolean True if enabled, false if not.

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

Set auto delete
public setAutoDelete ( boolean $flag ) : self
$flag boolean True to auto delete, false if not
Результат self This object

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

Set command
public setCommand ( Phue\Command\ActionableInterface $command ) : self
$command Phue\Command\ActionableInterface Actionable command
Результат self This object

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

Set description
public setDescription ( string $description ) : self
$description string
Результат self This object

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

Set name of schedule
public setName ( string $name ) : self
$name string
Результат self This object

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

Set status.
public setStatus ( string $status ) : self
$status string Status.
Результат self This object

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

Set time
public setTime ( string $time ) : self
$time string Time
Результат self This object

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

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

Schedule attributes
protected stdClass $attributes
Результат stdClass

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

Phue client
protected Client,phue $client
Результат Client

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

Id
protected int $id
Результат integer