coarnotify\core\notify\NotifyPattern Class Reference

Inheritance diagram for coarnotify\core\notify\NotifyPattern:

Public Member Functions
	__construct ($stream=null, $validate_stream_on_construct=true, $validate_properties=true, $validators=null, $validation_context=null)
	getOrigin ()
	setOrigin ($value)
	getTarget ()
	setTarget ($value)
	getObject ()
	setObject ($value)
	getInReplyTo ()
	setInReplyTo ($value)
	getActor ()
	setActor ($value)
	getContext ()
	setContext ($value)
	validate ()
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::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

Base class for all notification patterns

Constructor & Destructor Documentation

__construct()

coarnotify\core\notify\NotifyPattern::__construct	(		$stream = null,
			$validate_stream_on_construct = true,
			$validate_properties = true,
			$validators = null,
			$validation_context = null )

Constructor for the NotifyPattern class.

Parameters

$stream
$validate_stream_on_construct
$validate_properties
$validators
$validation_context

Reimplemented from coarnotify\core\notify\NotifyBase.

Member Function Documentation

getContext()

coarnotify\core\notify\NotifyPattern::getContext

(

)

Reimplemented in coarnotify\patterns\announce_endorsement\AnnounceEndorsement, coarnotify\patterns\announce_review\AnnounceReview, and coarnotify\patterns\announce_service_result\AnnounceServiceResult.

getObject()

coarnotify\core\notify\NotifyPattern::getObject

(

)

Reimplemented in coarnotify\patterns\announce_relationship\AnnounceRelationship, coarnotify\patterns\announce_review\AnnounceReview, coarnotify\patterns\announce_service_result\AnnounceServiceResult, coarnotify\patterns\request_endorsement\RequestEndorsement, and coarnotify\patterns\request_review\RequestReview.

validate()

coarnotify\core\notify\NotifyPattern::validate

(

)

Base validator for all notification patterns. This extends the validate function on the superclass.

In addition to the base class's constraints, this applies the following validation:

The origin, target and object properties are required and must be valid The actor inReplyTo and context properties are optional, but if present must be valid

Returns

bool

Exceptions

ValidationError

coarnotify\exceptions\ValueError

Reimplemented from coarnotify\core\notify\NotifyBase.

Reimplemented in coarnotify\patterns\accept\Accept, coarnotify\patterns\announce_endorsement\AnnounceEndorsement, coarnotify\patterns\announce_relationship\AnnounceRelationship, coarnotify\patterns\announce_review\AnnounceReview, coarnotify\patterns\announce_service_result\AnnounceServiceResult, coarnotify\patterns\reject\Reject, coarnotify\patterns\tentatively_accept\TentativelyAccept, coarnotify\patterns\tentatively_reject\TentativelyReject, coarnotify\patterns\undo_offer\UndoOffer, and coarnotify\patterns\unprocessable_notification\UnprocessableNotification.

---

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

• src/core/notify/NotifyPattern.php