Documentation

Properties
in package
implements Countable, IteratorAggregate

Contains a map of names to Property objects. An instance of this class is returned by getProperties().

Tags
copyright

Copyright (c) DeviceAtlas Limited 2023. All Rights Reserved.

author

DeviceAtlas Limited

Table of Contents

Interfaces

Countable
IteratorAggregate

Properties

$properties  : mixed

Methods

__get()  : mixed
Returns the property value, the data type of the value is set proper data type as defined for the property. If property does not exist null will be returned
__isset()  : bool
Returns true if the Properties contains a mapping for the specified name.
__toString()  : string
Serialize properties to JSON.
contains()  : bool
Check if a property has a specific value.
containsKey()  : bool
Returns true if the Properties contains a mapping for the specified name.
count()  : int
get()  : Property
Returns the Property to which the specified name is mapped to, or null if there is no mapping for this name.
getIterator()  : Traversable
getOrDefaultBoolean()  : bool
The method returns the Boolean property value for the specified property name, otherwise the $defaultValue is returned instead.
getOrDefaultInteger()  : int
The method returns the Integer property value for the specified property name, otherwise the $defaultValue is returned instead.
getOrDefaultSet()  : array<string|int, mixed>
The method returns the Set property value for the specified property name, otherwise the defaultValue is returned instead.
getOrDefaultString()  : string
The method returns the String property value for the specified property name, otherwise the $defaultValue is returned instead.
isEmpty()  : bool
Returns true if there are no properties.
keySet()  : array<string|int, mixed>
Get the property names of the property set.
put()  : mixed
Associates the specified Property with the specified name. If a Property for this name currently exists it will be replaced by the new value.
putAll()  : mixed
size()  : int
Returns the number of Property objects in this Properties Map.
toString()  : string
Serialize properties to JSON.

Properties

Methods

__get()

Returns the property value, the data type of the value is set proper data type as defined for the property. If property does not exist null will be returned

public __get(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed —

The property typed value or null

__isset()

Returns true if the Properties contains a mapping for the specified name.

public __isset(mixed $name) : bool
Parameters
$name : mixed
Return values
bool —

true if a Property exists for the specified key.

__toString()

Serialize properties to JSON.

public __toString() : string
Return values
string —

A serialized string of the properties.

contains()

Check if a property has a specific value.

public contains(mixed $name, mixed $value) : bool
Parameters
$name : mixed
$value : mixed
Return values
bool —

true=the property value matched the expected value

containsKey()

Returns true if the Properties contains a mapping for the specified name.

public containsKey(mixed $name) : bool
Parameters
$name : mixed
Return values
bool —

true if a Property exists for the specified key.

get()

Returns the Property to which the specified name is mapped to, or null if there is no mapping for this name.

public get(mixed $name) : Property
Parameters
$name : mixed
Return values
Property —

The value to which the specified name is mapped to, or null if the map contains no mapping for this name.

getIterator()

public getIterator() : Traversable
Return values
Traversable

getOrDefaultBoolean()

The method returns the Boolean property value for the specified property name, otherwise the $defaultValue is returned instead.

public getOrDefaultBoolean( $name,  $defaultValue) : bool
Parameters
$name :
$defaultValue :
Return values
bool

getOrDefaultInteger()

The method returns the Integer property value for the specified property name, otherwise the $defaultValue is returned instead.

public getOrDefaultInteger( $name,  $defaultValue) : int
Parameters
$name :
$defaultValue :
Return values
int

getOrDefaultSet()

The method returns the Set property value for the specified property name, otherwise the defaultValue is returned instead.

public getOrDefaultSet( $name,  $defaultValue) : array<string|int, mixed>
Parameters
$name :
$defaultValue :
Return values
array<string|int, mixed>

getOrDefaultString()

The method returns the String property value for the specified property name, otherwise the $defaultValue is returned instead.

public getOrDefaultString( $name,  $defaultValue) : string
Parameters
$name :
$defaultValue :
Return values
string

isEmpty()

Returns true if there are no properties.

public isEmpty() : bool
Return values
bool —

true=if no properties exist.

keySet()

Get the property names of the property set.

public keySet() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Property names

put()

Associates the specified Property with the specified name. If a Property for this name currently exists it will be replaced by the new value.

public put(mixed $name, mixed $property) : mixed
Parameters
$name : mixed
$property : mixed

putAll()

public putAll(mixed $properties) : mixed
Parameters
$properties : mixed

size()

Returns the number of Property objects in this Properties Map.

public size() : int
Return values
int —

the number of mappings in this map.

toString()

Serialize properties to JSON.

public toString() : string
Return values
string —

A serialized string of the properties.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results