Skip to content

Add documentation for event example properties #180

@romm

Description

@romm

See:

/**
* Interface that can be implemented by an event to give example properties that
* will be used in the backend module to show a preview of a notification bound
* to this event.
*
* Example:
*
* ```
* class MyEvent implements Event, ProvidesExampleProperties
* {
* protected $someValue;
*
* public function getExampleProperties()
* {
* return [
* 'someValue' => 'Some value example',
* ];
* }
* }
* ```
*/
interface ProvidesExampleProperties
{
/**
* Returns an array in which the key of an entry is the name of a property
* and its value is a human-readable example value.
*
* @return array
*/
public function getExampleProperties();
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions