Inheritance diagram for coarnotify\core\notify\NotifyActor:

Public Member Functions
	getName ()

	setName (string $value)

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)

	validate ()

	validateProperty ($prop_name, $value, $force_validate=false, $raise_error=true)

	toJSONLD ()

Public Attributes
const	DEFAULT_TYPE = ActivityStreamsTypes::SERVICE

const	ALLOWED_TYPES

Public Attributes inherited from coarnotify\core\notify\NotifyPatternPart
const	DEFAULT_TYPE = null

const	ALLOWED_TYPES = []

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

Deafult class to represents an actor in the COAR Notify pattern. Actors are used to represent the actor property in the notification patterns

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

Member Function Documentation

◆ getName()

coarnotify\core\notify\NotifyActor::getName ( )

Get the name property of the actor

Returns: string

◆ setName()

coarnotify\core\notify\NotifyActor::setName ( string $value )

Set the name property of the actor

Parameters

string $value The name of the actor

Member Data Documentation

◆ ALLOWED_TYPES

const coarnotify\core\notify\NotifyActor::ALLOWED_TYPES

Initial value:

= [
        self::DEFAULT_TYPE,
        ActivityStreamsTypes::APPLICATION,
        ActivityStreamsTypes::GROUP,
        ActivityStreamsTypes::ORGANIZATION,
        ActivityStreamsTypes::PERSON
    ]

◆ DEFAULT_TYPE

const coarnotify\core\notify\NotifyActor::DEFAULT_TYPE = ActivityStreamsTypes::SERVICE

Default type is Service, but can also be set as any one of the other allowed types

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

src/core/notify/NotifyActor.php

Public Member Functions

Public Attributes