COAR Notify
 
Loading...
Searching...
No Matches
coarnotify\patterns\announce_service_result\AnnounceServiceResultObject Class Reference
Inheritance diagram for coarnotify\patterns\announce_service_result\AnnounceServiceResultObject:
coarnotify\core\notify\NotifyObject coarnotify\core\notify\NotifyPatternPart coarnotify\core\notify\NotifyBase

Public Member Functions

 validate ()
 
- Public Member Functions inherited from coarnotify\core\notify\NotifyObject
 getCiteAs ()
 
 setCiteAs (string $value)
 
 getItem ()
 
 setItem ($value)
 
 getTriple ()
 
 setTriple (array $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)
 
 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

Custom object class for Announce Service Result to apply the custom validation

Member Function Documentation

◆ validate()

coarnotify\patterns\announce_service_result\AnnounceServiceResultObject::validate ( )

Extend the base validation to include the following constraints:

The object type is required and must validate

Returns
bool
Exceptions
ValidationError

coarnotify\exceptions\ValueError

Reimplemented from coarnotify\core\notify\NotifyObject.


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