coarnotify\core\notify\NotifyObject Class Reference

Inheritance diagram for coarnotify\core\notify\NotifyObject:

Public Member Functions
	getCiteAs ()
	setCiteAs (string $value)
	getItem ()
	setItem ($value)
	getTriple ()
	setTriple (array $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

Deafult class to represent an object in the COAR Notify pattern. Objects can be used for object or context properties in notify patterns

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

Member Function Documentation

getItem()

coarnotify\core\notify\NotifyObject::getItem

(

)

Reimplemented in coarnotify\patterns\announce_endorsement\AnnounceEndorsementContext, coarnotify\patterns\announce_review\AnnounceReviewContext, coarnotify\patterns\announce_service_result\AnnounceServiceResultContext, coarnotify\patterns\request_endorsement\RequestEndorsementObject, and coarnotify\patterns\request_review\RequestReviewObject.

validate()

coarnotify\core\notify\NotifyObject::validate

(

)

Validate the object. 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_relationship\AnnounceRelationshipObject, coarnotify\patterns\announce_review\AnnounceReviewObject, and coarnotify\patterns\announce_service_result\AnnounceServiceResultObject.

---

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

• src/core/notify/NotifyObject.php