modResource.getProperty

modResource.getProperty¶

Reads a single value from the namespaced properties field of the Resource. Returns $default when either the namespace or the key is missing. An absent property and a property explicitly set to null cannot be distinguished.

The value lives on the object until save(); use setProperty() to write it.

Syntax¶

mixed getProperty ($key [, string $namespace = 'core' [, mixed $default = null]])

• $key (string) property name
• $namespace (string) namespace the property belongs to, by default 'core'
• $default (mixed) value returned when the property is not set, by default null

Example¶

$resource = $modx->getObject('modResource', array('id' => 5));
$color = $resource->getProperty('color', 'mycomponent', 'foobar');

See Also¶

• modResource
• modResource.setProperty
• modResource.getProperties