coarnotify\patterns\announce_service_result\AnnounceServiceResult Class Reference

Inheritance diagram for coarnotify\patterns\announce_service_result\AnnounceServiceResult:

Public Member Functions
	getObject ()
	getContext ()
	validate ()
Public Member Functions inherited from coarnotify\core\notify\NotifyPattern
	__construct ($stream=null, $validate_stream_on_construct=true, $validate_properties=true, $validators=null, $validation_context=null)
	getOrigin ()
	setOrigin ($value)
	getTarget ()
	setTarget ($value)
	setObject ($value)
	getInReplyTo ()
	setInReplyTo ($value)
	getActor ()
	setActor ($value)
	setContext ($value)
Public Member Functions inherited from coarnotify\core\notify\NotifyBase
	getValidateProperties ()
	getValidateStreamOnConstruct ()
	getValidators ()
	getDoc ()
	getId ()
	setId ($value)
	getType ()
	setType ($types)
	getProperty ($prop_name)
	setProperty ($prop_name, $value)
	validateProperty ($prop_name, $value, $force_validate=false, $raise_error=true)
	toJSONLD ()

Public Attributes
const	TYPE = ActivityStreamsTypes::ANNOUNCE
Public Attributes inherited from coarnotify\core\notify\NotifyPattern
const	TYPE = ActivityStreamsTypes::OBJECT

Additional Inherited Members
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

Pattern to represent the Announce Service Result notification https://coar-notify.net/specification/1.0.1/announce-resource/

Member Function Documentation

getContext()

coarnotify\patterns\announce_service_result\AnnounceServiceResult::getContext

(

)

Custom getter to retrieve the context property as an AnnounceServiceResultContext

Returns

AnnounceServiceResultContext|null

Reimplemented from coarnotify\core\notify\NotifyPattern.

getObject()

coarnotify\patterns\announce_service_result\AnnounceServiceResult::getObject

(

)

Custom getter to retrieve the object property as an AnnounceServiceResultObject

Returns

AnnounceServiceResultObject|null

Reimplemented from coarnotify\core\notify\NotifyPattern.

validate()

coarnotify\patterns\announce_service_result\AnnounceServiceResult::validate

(

)

Extends the base validation to make context required

Returns

bool

Exceptions

ValidationError

coarnotify\exceptions\ValueError

Reimplemented from coarnotify\core\notify\NotifyPattern.

Member Data Documentation

TYPE

const coarnotify\patterns\announce_service_result\AnnounceServiceResult::TYPE = ActivityStreamsTypes::ANNOUNCE

Announce Service Result type, the ActivityStreams Announce type

---

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

• src/patterns/announce_service_result/AnnounceServiceResult.php