IAccountPropertyCollection
extends
JsonSerializable
in
Interface IAccountPropertyCollection
Tags
Table of Contents
Methods
- addProperty() : IAccountPropertyCollection
- adds a property to this collection
- addPropertyWithDefaults() : IAccountPropertyCollection
- adds a property to this collection with only specifying the value
- getName() : string
- returns the collection name
- getProperties() : array<string|int, IAccountProperty>
- getPropertyByValue() : IAccountProperty|null
- retrieves a property identified by its value. null, if none was found.
- removeProperty() : IAccountPropertyCollection
- removes a property of this collection
- removePropertyByValue() : IAccountPropertyCollection
- removes a property identified by its value
- setProperties() : IAccountPropertyCollection
- set properties of this collection
Methods
addProperty()
adds a property to this collection
public
addProperty(IAccountProperty $property) : IAccountPropertyCollection
Parameters
- $property : IAccountProperty
Tags
Return values
IAccountPropertyCollectionaddPropertyWithDefaults()
adds a property to this collection with only specifying the value
public
addPropertyWithDefaults(string $value) : IAccountPropertyCollection
Parameters
- $value : string
Tags
Return values
IAccountPropertyCollectiongetName()
returns the collection name
public
getName() : string
Tags
Return values
stringgetProperties()
public
getProperties() : array<string|int, IAccountProperty>
Tags
Return values
array<string|int, IAccountProperty>getPropertyByValue()
retrieves a property identified by its value. null, if none was found.
public
getPropertyByValue(string $value) : IAccountProperty|null
Returns only the first property if there are more with the same value.
Parameters
- $value : string
Tags
Return values
IAccountProperty|nullremoveProperty()
removes a property of this collection
public
removeProperty(IAccountProperty $property) : IAccountPropertyCollection
Parameters
- $property : IAccountProperty
Tags
Return values
IAccountPropertyCollectionremovePropertyByValue()
removes a property identified by its value
public
removePropertyByValue(string $value) : IAccountPropertyCollection
Parameters
- $value : string
Tags
Return values
IAccountPropertyCollectionsetProperties()
set properties of this collection
public
setProperties(array<string|int, IAccountProperty> $properties) : IAccountPropertyCollection
Parameters
- $properties : array<string|int, IAccountProperty>