\MiotApi\ContractRemoteSpec

load()

load(  $file) : boolean|\MiotApi\Util\Jsoner\Jsoner

读取json文件里的内容为数组.

Parameters

Returns

fill()

fill(  $data,   $file) : boolean|\MiotApi\Util\Jsoner\Jsoner

json数据存储成json文件.

Parameters

Returns

fillArray()

fillArray(  $array,   $file) : boolean|\MiotApi\Util\Jsoner\Jsoner

数组缓存成json文件.

Parameters

Returns

getCacheDir()

getCacheDir() : string

取缓存文件路径.

Returns

__construct()

__construct(mixed  $items = array()) 

Create a new collection.

Parameters

make()

make(mixed  $items = array()) : static

Create a new collection instance if the value isn't one already.

Parameters

Returns

wrap()

wrap(mixed  $value) : static

Wrap the given value in a collection if applicable.

Parameters

Returns

unwrap()

unwrap(array|static  $value) : array

Get the underlying items from the given collection if applicable.

Parameters

Returns

times()

times(integer  $number, callable  $callback = null) : static

Create a new collection by invoking the callback a given amount of times.

Parameters

Returns

all()

all() : array

Get all of the items in the collection.

Returns

avg()

avg(callable|string|null  $callback = null) : mixed

Get the average value of a given key.

Parameters

Returns

average()

average(callable|string|null  $callback = null) : mixed

Alias for the "avg" method.

Parameters

Returns

mode()

mode(mixed  $key = null) : array|null

Get the mode of a given key.

Parameters

Returns

collapse()

collapse() : static

Collapse the collection of items into a single array.

Returns

contains()

contains(mixed  $key, mixed  $operator = null, mixed  $value = null) : boolean

Determine if an item exists in the collection.

Parameters

Returns

containsStrict()

containsStrict(mixed  $key, mixed  $value = null) : boolean

Determine if an item exists in the collection using strict comparison.

Parameters

Returns

crossJoin()

crossJoin(mixed  ...$lists) : static

Cross join with the given lists, returning all possible permutations.

Parameters

Returns

dd()

dd(  $args) : void

Dump the collection and end the script.

Parameters

dump()

dump() : $this

Dump the collection.

Returns

diff()

diff(mixed  $items) : static

Get the items in the collection that are not present in the given items.

Parameters

Returns

diffAssoc()

diffAssoc(mixed  $items) : static

Get the items in the collection whose keys and values are not present in the given items.

Parameters

Returns

diffKeys()

diffKeys(mixed  $items) : static

Get the items in the collection whose keys are not present in the given items.

Parameters

Returns

each()

each(callable  $callback) : $this

Execute a callback over each item.

Parameters

Returns

eachSpread()

eachSpread(callable  $callback) : static

Execute a callback over each nested chunk of items.

Parameters

Returns

every()

every(string|callable  $key, mixed  $operator = null, mixed  $value = null) : boolean

Determine if all items in the collection pass the given test.

Parameters

Returns

except()

except(  $keys) : static

Get all items except for those with the specified keys.

Parameters

Returns

filter()

filter(callable|null  $callback = null) : static

Run a filter over each of the items.

Parameters

Returns

when()

when(boolean  $value, callable  $callback, callable  $default = null) : mixed

Apply the callback if the value is truthy.

Parameters

Returns

unless()

unless(boolean  $value, callable  $callback, callable  $default = null) : mixed

Apply the callback if the value is falsy.

Parameters

Returns

where()

where(string  $key, mixed  $operator, mixed  $value = null) : static

Filter items by the given key value pair.

Parameters

Returns

whereStrict()

whereStrict(string  $key, mixed  $value) : static

Filter items by the given key value pair using strict comparison.

Parameters

Returns

whereIn()

whereIn(string  $key, mixed  $values, boolean  $strict = false) : static

Filter items by the given key value pair.

Parameters

Returns

whereInStrict()

whereInStrict(string  $key, mixed  $values) : static

Filter items by the given key value pair using strict comparison.

Parameters

Returns

whereNotIn()

whereNotIn(string  $key, mixed  $values, boolean  $strict = false) : static

Filter items by the given key value pair.

Parameters

Returns

whereNotInStrict()

whereNotInStrict(string  $key, mixed  $values) : static

Filter items by the given key value pair using strict comparison.

Parameters

Returns

first()

first(callable|null  $callback = null, mixed  $default = null) : mixed

Get the first item from the collection.

Parameters

Returns

firstWhere()

firstWhere(string  $key, mixed  $operator, mixed  $value = null) : static

Get the first item by the given key value pair.

Parameters

Returns

flatten()

flatten(integer  $depth = INF) : static

Get a flattened array of the items in the collection.

Parameters

Returns

flip()

flip() : static

Flip the items in the collection.

Returns

forget()

forget(string|array  $keys) : $this

Remove an item from the collection by key.

Parameters

Returns

get()

get(mixed  $key, mixed  $default = null) : mixed

Get an item from the collection by key.

Parameters

Returns

groupBy()

groupBy(callable|string  $groupBy, boolean  $preserveKeys = false) : static

Group an associative array by a field or using a callback.

Parameters

Returns

keyBy()

keyBy(callable|string  $keyBy) : static

Key an associative array by a field or using a callback.

Parameters

Returns

has()

has(mixed  $key) : boolean

Determine if an item exists in the collection by key.

Parameters

Returns

implode()

implode(string  $value, string  $glue = null) : string

Concatenate values of a given key as a string.

Parameters

Returns

intersect()

intersect(mixed  $items) : static

Intersect the collection with the given items.

Parameters

Returns

intersectByKeys()

intersectByKeys(mixed  $items) : static

Intersect the collection with the given items by key.

Parameters

Returns

isEmpty()

isEmpty() : boolean

Determine if the collection is empty or not.

Returns

isNotEmpty()

isNotEmpty() : boolean

Determine if the collection is not empty.

Returns

keys()

keys() : static

Get the keys of the collection items.

Returns

last()

last(callable|null  $callback = null, mixed  $default = null) : mixed

Get the last item from the collection.

Parameters

Returns

pluck()

pluck(string|array  $value, string|null  $key = null) : static

Get the values of a given key.

Parameters

Returns

map()

map(callable  $callback) : static

Run a map over each of the items.

Parameters

Returns

mapSpread()

mapSpread(callable  $callback) : static

Run a map over each nested chunk of items.

Parameters

Returns

mapToDictionary()

mapToDictionary(callable  $callback) : static

Run a dictionary map over the items.

The callback should return an associative array with a single key/value pair.

Parameters

Returns

mapToGroups()

mapToGroups(callable  $callback) : static

Run a grouping map over the items.

The callback should return an associative array with a single key/value pair.

Parameters

Returns

mapWithKeys()

mapWithKeys(callable  $callback) : static

Run an associative map over each of the items.

The callback should return an associative array with a single key/value pair.

Parameters

Returns

flatMap()

flatMap(callable  $callback) : static

Map a collection and flatten the result by a single level.

Parameters

Returns

mapInto()

mapInto(string  $class) : static

Map the values into a new class.

Parameters

Returns

max()

max(callable|string|null  $callback = null) : mixed

Get the max value of a given key.

Parameters

Returns

merge()

merge(mixed  $items) : static

Merge the collection with the given items.

Parameters

Returns

combine()

combine(mixed  $values) : static

Create a collection by using this collection for keys and another for its values.

Parameters

Returns

union()

union(mixed  $items) : static

Union the collection with the given items.

Parameters

Returns

min()

min(callable|string|null  $callback = null) : mixed

Get the min value of a given key.

Parameters

Returns

nth()

nth(integer  $step, integer  $offset) : static

Create a new collection consisting of every n-th element.

Parameters

Returns

only()

only(mixed  $keys) : static

Get the items with the specified keys.

Parameters

Returns

forPage()

forPage(integer  $page, integer  $perPage) : static

"Paginate" the collection by slicing it into a smaller collection.

Parameters

Returns

partition()

partition(callable|string  $key, mixed  $operator = null, mixed  $value = null) : static

Partition the collection into two arrays using the given callback or key.

Parameters

Returns

pipe()

pipe(callable  $callback) : mixed

Pass the collection to the given callback and return the result.

Parameters

Returns

pop()

pop() : mixed

Get and remove the last item from the collection.

Returns

prepend()

prepend(mixed  $value, mixed  $key = null) : $this

Push an item onto the beginning of the collection.

Parameters

Returns

push()

push(mixed  $value) : $this

Push an item onto the end of the collection.

Parameters

Returns

concat()

concat(\Traversable  $source) : $this

Push all of the given items onto the collection.

Parameters

Returns

pull()

pull(mixed  $key, mixed  $default = null) : mixed

Get and remove an item from the collection.

Parameters

Returns

put()

put(mixed  $key, mixed  $value) : $this

Put an item in the collection by key.

Parameters

Returns

random()

random(integer|null  $number = null) : mixed

Get one or a specified number of items randomly from the collection.

Parameters

Throws

\InvalidArgumentException

Returns

reduce()

reduce(callable  $callback, mixed  $initial = null) : mixed

Reduce the collection to a single value.

Parameters

Returns

reject()

reject(callable|mixed  $callback) : static

Create a collection of all elements that do not pass a given truth test.

Parameters

Returns

reverse()

reverse() : static

Reverse items order.

Returns

search()

search(mixed  $value, boolean  $strict = false) : mixed

Search the collection for a given value and return the corresponding key if successful.

Parameters

Returns

shift()

shift() : mixed

Get and remove the first item from the collection.

Returns

shuffle()

shuffle(integer  $seed = null) : static

Shuffle the items in the collection.

Parameters

Returns

slice()

slice(integer  $offset, integer  $length = null) : static

Slice the underlying collection array.

Parameters

Returns

split()

split(integer  $numberOfGroups) : static

Split a collection into a certain number of groups.

Parameters

Returns

chunk()

chunk(integer  $size) : static

Chunk the underlying collection array.

Parameters

Returns

sort()

sort(callable|null  $callback = null) : static

Sort through each item with a callback.

Parameters

Returns

sortBy()

sortBy(callable|string  $callback, integer  $options = SORT_REGULAR, boolean  $descending = false) : static

Sort the collection using the given callback.

Parameters

Returns

sortByDesc()

sortByDesc(callable|string  $callback, integer  $options = SORT_REGULAR) : static

Sort the collection in descending order using the given callback.

Parameters

Returns

splice()

splice(integer  $offset, integer|null  $length = null, mixed  $replacement = array()) : static

Splice a portion of the underlying collection array.

Parameters

Returns

sum()

sum(callable|string|null  $callback = null) : mixed

Get the sum of the given values.

Parameters

Returns

take()

take(integer  $limit) : static

Take the first or last {$limit} items.

Parameters

Returns

tap()

tap(callable  $callback) : $this

Pass the collection to the given callback and then return it.

Parameters

Returns

transform()

transform(callable  $callback) : $this

Transform each item in the collection using a callback.

Parameters

Returns

unique()

unique(string|callable|null  $key = null, boolean  $strict = false) : static

Return only unique items from the collection array.

Parameters

Returns

uniqueStrict()

uniqueStrict(string|callable|null  $key = null) : static

Return only unique items from the collection array using strict comparison.

Parameters

Returns

values()

values() : static

Reset the keys on the underlying array.

Returns

zip()

zip(mixed  ...$items) : static

Zip the collection together with one or more arrays.

e.g. new Collection([1, 2, 3])->zip([4, 5, 6]); => [[1, 4], [2, 5], [3, 6]]

Parameters

Returns

pad()

pad(integer  $size, mixed  $value) : static

Pad collection to the specified length with a value.

Parameters

Returns

toArray()

toArray() : array

Get the collection of items as a plain array.

Returns

jsonSerialize()

jsonSerialize() : array

Convert the object into something JSON serializable.

Returns

toJson()

toJson(integer  $options) : string

Get the collection of items as JSON.

Parameters

Returns

getIterator()

getIterator() : \ArrayIterator

Get an iterator for the items.

Returns

getCachingIterator()

getCachingIterator(integer  $flags = \CachingIterator::CALL_TOSTRING) : \CachingIterator

Get a CachingIterator instance.

Parameters

Returns

count()

count() : integer

Count the number of items in the collection.

Returns

toBase()

toBase() : \MiotApi\Util\Collection\Collection

Get a base Support collection instance from this collection.

Returns

offsetExists()

offsetExists(mixed  $key) : boolean

Determine if an item exists at an offset.

Parameters

Returns

offsetGet()

offsetGet(mixed  $key) : mixed

Get an item at a given offset.

Parameters

Returns

offsetSet()

offsetSet(mixed  $key, mixed  $value) : void

Set the item at a given offset.

Parameters

offsetUnset()

offsetUnset(string  $key) : void

Unset the item at a given offset.

Parameters

__toString()

__toString() : string

Convert the collection to its string representation.

Returns

proxy()

proxy(string  $method) : void

Add a method to the list of proxied methods.

Parameters

__get()

__get(string  $key) : mixed

Dynamically access collection proxies.

Parameters

Throws

\Exception

Returns

macro()

macro(string  $name, object|callable  $macro) : void

Register a custom macro.

Parameters

mixin()

mixin(object  $mixin) : void

Mix another object into the class.

Parameters

Throws

\ReflectionException

hasMacro()

hasMacro(string  $name) : boolean

Checks if macro is registered.

Parameters

Returns

__callStatic()

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

Dynamically handle calls to the class.

Parameters

Throws

\BadMethodCallException

Returns

__call()

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

Dynamically handle calls to the class.

Parameters

Throws

\BadMethodCallException

Returns

instances()

instances() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有设备实例列表.

Returns

properties()

properties() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有的PropertyType.

Returns

actions()

actions() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有的ActionType.

Returns

events()

events() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有的EventType.

Returns

services()

services() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有的ServiceType.

Returns

devices()

devices() : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有的DeviceType.

Returns

instance()

instance(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取某个实例的详细定义.

Parameters

Returns

property()

property(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取一个PropertyType的具体定义.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

action()

action(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取一个ActionType的具体定义.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

event()

event(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取一个EventType的具体定义.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

service()

service(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取一个ServiceType的具体定义.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

device()

device(  $type) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取一个DeviceType的具体定义.

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns

fetch()

fetch(  $uri, array  $params = array()) : boolean

Parameters

Returns

operatorForWhere()

operatorForWhere(string  $key, string  $operator, mixed  $value = null) : \Closure

Get an operator checker callback.

Parameters

Returns

useAsCallable()

useAsCallable(mixed  $value) : boolean

Determine if the given value is callable, but not a string.

Parameters

Returns

valueRetriever()

valueRetriever(string  $value) : callable

Get a value retrieving callback.

Parameters

Returns

getArrayableItems()

getArrayableItems(mixed  $items) : array

Results array of items from Collection or Arrayable.

Parameters

Returns

__instances()

__instances(  $file) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取所有实例列表.

Parameters

Returns

__instance()

__instance(  $file,   $uri,   $params) : boolean|\MiotApi\Util\Jsoner\Jsoner|null

读取某个实例的详细定义.

Parameters

Returns

getBaseType()

getBaseType(  $type) : mixed

Parameters

Throws

\MiotApi\Exception\SpecificationErrorException

Returns