1. interface
  2. gossi
  3. codegen
  4. model
  5. PropertiesInterface

PropertiesInterface

interface PropertiesInterface

Methods

$this
setProperties(array $properties)

Sets a collection of properties

$this
setProperty(PhpProperty $property)

Adds a property

$this
removeProperty(PhpProperty|string $nameOrProperty)

Removes a property

bool
hasProperty(PhpProperty|string $nameOrProperty)

Checks whether a property exists

PhpProperty
getProperty(string $nameOrProperty)

Returns a property

Map
getProperties()

Returns a collection of properties

Set
getPropertyNames()

Returns all property names

$this
clearProperties()

Clears all properties

Details

at line line 12
$this setProperties(array $properties)

Sets a collection of properties

Parameters

array $properties

Return Value

$this

at line line 20
$this setProperty(PhpProperty $property)

Adds a property

Parameters

PhpProperty $property

Return Value

$this

at line line 29
$this removeProperty(PhpProperty|string $nameOrProperty)

Removes a property

Parameters

PhpProperty|string $nameOrProperty property name or instance

Return Value

$this

Exceptions

InvalidArgumentException If the property cannot be found

at line line 37
bool hasProperty(PhpProperty|string $nameOrProperty)

Checks whether a property exists

Parameters

PhpProperty|string $nameOrProperty property name or instance

Return Value

bool true if a property exists and false if not

at line line 46
PhpProperty getProperty(string $nameOrProperty)

Returns a property

Parameters

string $nameOrProperty property name

Return Value

PhpProperty

Exceptions

InvalidArgumentException If the property cannot be found

at line line 53
Map getProperties()

Returns a collection of properties

Return Value

Map

at line line 60
Set getPropertyNames()

Returns all property names

Return Value

Set

at line line 67
$this clearProperties()

Clears all properties

Return Value

$this