\MiotApi\Contract\SpecificationServiceSpecification

服务是一个独立的有意义的功能组,描述一个服务,需要说清楚: 是什么服务? 有什么方法可以操作? 有什么事件可能会发生? 有哪些属性?

Class ServiceSpecification

Summary

Methods
Properties
Constants
__construct()
init()
getUrn()
getType()
getDescription()
toContext()
toCollection()
toJson()
toArray()
__get()
__call()
getRequiredActions()
getOptionalActions()
getRequiredEvents()
getOptionalEvents()
getRequiredProperties()
getOptionalProperties()
No public properties found
No constants found
No protected methods found
$collection
$urn
$description
$requiredActions
$optionalActions
$requiredEvents
$optionalEvents
$requiredProperties
$optionalProperties
N/A
No private methods found
No private properties found
N/A

Properties

$collection

$collection : 

Type

$urn

$urn : 

Type

$description

$description : 

描述: 纯文本字段.

Type

$requiredActions

$requiredActions : 

必选方法列表.

Type

$optionalActions

$optionalActions : 

可选方法列表.

Type

$requiredEvents

$requiredEvents : 

必选事件列表.

Type

$optionalEvents

$optionalEvents : 

可选事件列表.

Type

$requiredProperties

$requiredProperties : 

必选属性列表.

Type

$optionalProperties

$optionalProperties : 

可选属性列表.

Type

Methods

__construct()

__construct(  $urn) 

Specification constructor.

Parameters

$urn

Throws

\MiotApi\Exception\SpecificationErrorException

init()

init() 

Throws

\MiotApi\Exception\SpecificationErrorException

getUrn()

getUrn() 

getType()

getType() 

getDescription()

getDescription() 

toContext()

toContext() 

toCollection()

toCollection() 

toJson()

toJson() 

toArray()

toArray() 

__get()

__get(  $key) 

Parameters

$key

__call()

__call(string  $method, array  $parameters) : mixed

Proxy a method call onto the collection items.

Parameters

string $method
array $parameters

Returns

mixed

getRequiredActions()

getRequiredActions() : mixed

Returns

mixed

getOptionalActions()

getOptionalActions() : mixed

Returns

mixed

getRequiredEvents()

getRequiredEvents() : mixed

Returns

mixed

getOptionalEvents()

getOptionalEvents() : mixed

Returns

mixed

getRequiredProperties()

getRequiredProperties() : mixed

Returns

mixed

getOptionalProperties()

getOptionalProperties() : mixed

Returns

mixed