coarnotify\core\notify\NotifyItem Class Reference

Inheritance diagram for coarnotify\core\notify\NotifyItem:

Public Member Functions
	getMediaType ()
	setMediaType (string $value)
	validate ()
Public Member Functions inherited from coarnotify\core\notify\NotifyPatternPart
	__construct ($stream=null, $validate_stream_on_construct=true, $validate_properties=true, $validators=null, $validation_context=null)
	setType ($types)
Public Member Functions inherited from coarnotify\core\notify\NotifyBase
	getValidateProperties ()
	getValidateStreamOnConstruct ()
	getValidators ()
	getDoc ()
	getId ()
	setId ($value)
	getType ()
	getProperty ($prop_name)
	setProperty ($prop_name, $value)
	validateProperty ($prop_name, $value, $force_validate=false, $raise_error=true)
	toJSONLD ()

Additional Inherited Members
Public Attributes inherited from coarnotify\core\notify\NotifyPatternPart
const	DEFAULT_TYPE = null
const	ALLOWED_TYPES = []
Protected Member Functions inherited from coarnotify\core\notify\NotifyBase
	_registerPropertyValidationError (ValidationError $ve, $prop_name, $value)
	required (ValidationError $ve, $prop_name, $value)
	requiredAndValidate (ValidationError $ve, $prop_name, $value)
	optionalAndValidate (ValidationError $ve, $prop_name, $value)
Static Protected Member Functions inherited from coarnotify\core\notify\NotifyBase
static	deepCopy ($array)
Protected Attributes inherited from coarnotify\core\notify\NotifyBase
	$validateStreamOnConstruct
	$validateProperties
	$validators
	$validationContext
	$stream

Detailed Description

Defult class to represent an item in the COAR Notify pattern. Items are used to represent the ietf:item property in the notification patterns

Specific patterns may need to extend this class to provide their specific behaviours and validation

Member Function Documentation

validate()

coarnotify\core\notify\NotifyItem::validate

(

)

Validate the item. This overrides the base validation, as objects only absolutely require an id property, so the base requirement for a type is relaxed.

Returns

bool

Exceptions

ValidationError

coarnotify\exceptions\ValueError

Reimplemented from coarnotify\core\notify\NotifyBase.

Reimplemented in coarnotify\patterns\announce_endorsement\AnnounceEndorsementItem, coarnotify\patterns\announce_review\AnnounceReviewItem, coarnotify\patterns\announce_service_result\AnnounceServiceResultItem, coarnotify\patterns\request_endorsement\RequestEndorsementItem, and coarnotify\patterns\request_review\RequestReviewItem.

---

The documentation for this class was generated from the following file:

• src/core/notify/NotifyItem.php